Post 2026 07 Order Orderid Cancel

Cancel Order

POST/2026-07/order/{orderId}:cancel

Use it in a workflow

Add a step and choose the ShipBob connector.
Pick the Post 2026 07 Order Orderid Cancel action (under ShipBob).
Fill in the fields below, then reference the result from later steps as {{post202607OrderOrderidCancel.response.data}}.

Request

Path parameters

orderIdinteger (int32)required

The order ID to cancel

Headers

shipbob_channel_idinteger (int32)required

Channel ID for Operation

Response

Returns 200 with an object. Read it in later steps with {{post202607OrderOrderidCancel.response.data.<field>}}.

canceled_shipment_resultsarray<object>

Results of canceling the shipments associated with the order

actionstring

One ofCleanSweepReassignReleaseOrderHoldMoveToOnHoldAndKeepInventoryMoveToOnHoldAndReleaseInventoryCancelAddLineItemRemoveLineItemUpdateShipOption

is_successboolean

If the cancel action was successful

reasonstring

The reason the cancellation result

shipment_idinteger (int64)

The ID of the shipment

orderobject

channelobject2 fields

Created by channel metadata

created_datestring (date-time)

Date this order was created

financialsobject1 fields

gift_messagestring

Gift message associated with the order

idinteger (int32)

Unique id of the order

order_numberstring

User friendly orderId or store order number that will be shown on the Orders Page. If not provided, referenceId will be used

productsarray<object>9 fields

List of products included in the order

purchase_datestring (date-time)

Date this order was purchase by the end user

recipientobject4 fields

Information about the recipient of an order

reference_idstring

Client-defined external unique id of the order

retailer_program_dataobject9 fields

Contains properties that needs to be used for fulfilling B2B/Dropship orders.

shipmentsarray<object>26 fields

Shipments affiliated with the order

shipping_methodstring

Client-defined shipping method

shipping_termsobject2 fields

Contains shipping properties that need to be used for fulfilling an order.

statusstring

One ofProcessingExceptionPartiallyFulfilledFulfilledCancelledImportReview

tagsarray<object>2 fields

Client-defined order tags

typestring

Order type. DTC is a direct to consumer order. DropShip and B2B are retailer program order types.

One ofDTCDropShipB2B

order_idinteger (int32)

The ID of the canceled order

statusstring

One ofSuccessFailurePartialSuccess

json

{
  "canceled_shipment_results": [
    {
      "action": "CleanSweep",
      "is_success": false,
      "reason": "string",
      "shipment_id": 0
    }
  ],
  "order": {
    "channel": {
      "id": 0,
      "name": "ShipBobs-Shopify-Store"
    },
    "created_date": "2025-01-01T00:00:00Z",
    "financials": {
      "total_price": 0
    },
    "gift_message": "string",
    "id": 0,
    "order_number": "string",
    "products": [
      {
        "external_line_id": 0,
        "gtin": "string",
        "id": 0,
        "quantity": 0,
        "quantity_unit_of_measure_code": "string",
        "reference_id": "TShirtBlueM",
        "sku": "TShirtBlueM",
        "unit_price": 0,
        "upc": "string"
      }
    ],
    "purchase_date": "2025-01-01T00:00:00Z",
    "recipient": {
      "address": null,
      "name": "John Doe",
      "email": "john@example.com",
      "phone_number": "555-555-5555"
    },
    "reference_id": "string",
    "retailer_program_data": {
      "purchase_order_number": "string",
      "retailer_program_type": "string",
      "addresses": [
        {
          "type": "MarkFor"
        }
      ],
      "customer_ticket_number": "string",
      "delivery_date": "2025-01-01T00:00:00Z",
      "department": "string",
      "do_not_ship_before_date": "2025-01-01T00:00:00Z",
      "mark_for_store": "string",
      "ship_by_date": "2025-01-01T00:00:00Z"
    },
    "shipments": [
      {
        "actual_fulfillment_date": "2025-01-01T00:00:00Z",
        "created_date": "2025-01-01T00:00:00Z",
        "delivery_date": "2025-01-01T00:00:00Z",
        "estimated_fulfillment_date": "2025-01-01T00:00:00Z",
        "estimated_fulfillment_date_status": "AwaitingInventoryAllocation",
        "gift_message": "string",
        "id": 0,
        "insurance_value": 0,
        "invoice_amount": 0,
        "invoice_currency_code": "string",
        "is_tracking_uploaded": false,
        "last_tracking_update_at": "2025-01-01T00:00:00Z"
      }
    ]
  },
  "order_id": 0,
  "status": "Success"
}

Need more? See the ShipBob guide for connection setup and behaviour shared by every action.

Was this page helpful?