Skip to main content

Reverse Sales Order Fulfillment Recorded Against Canceled Quantity

POST 

/api/sales-order-fulfillments/:salesOrderFulfillment/reverse-canceled-quantity

Reverses a shipment that was recorded from the sales channel against quantity the order has canceled, for example a line canceled and replaced by other lines that shipped in its place, which the channel then reported as shipped. The shipment is voided: its inventory movements are reversed and any inventory debt it created is unwound, while the sales channel's own fulfillment is kept. Nothing is credited, because the units were canceled. When the order owes nothing afterwards, any open fulfillment order the void reopened is cancelled so the canceled items cannot be dispatched. A note is added to the order. A shipment reversed this way cannot be restored.

Required scope: orders:write

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

Use fulfills_canceled_quantity on the order's shipments (List Order Shipments) to find shipments this applies to.

Authentication: Requires Bearer token with the sales_orders.fulfill permission.

Path parameters:

  • salesOrderFulfillment (integer): Sales order fulfillment ID.

Refused (422) when: the shipment was dispatched through SKU.io rather than recorded from the sales channel; it is already voided or cancelled; it is part of a merged shipment; any line it records is still within the order's open (not canceled) quantity; or its date falls in a locked inventory period.

Response reversal fields: sales_order_id, sales_order_number, sales_order_fulfillment_id, reversed_units, product_ids.

Request​

Responses​

OK

Response Headers
    Content-Type