Skip to main content

Restore Voided Shipment

POST 

/api/sales-order-fulfillments/:salesOrderFulfillmentId/restore

Restore (un-void) a previously voided shipment. No request body.

Required scope: orders:write

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

The shipment returns to its pre-void status (typically submitted), and the void audit fields (voided_at, voided_by, void_reason) are cleared.

Side effects:

  • Restoring back to a shipped status re-creates the inventory movements and cost-layer consumption that the void reversed, and re-marks allocations as fulfilled.
  • If the shipment's sales-channel fulfillment (e.g. Shopify) was cancelled during the void, the channel submission is reset so a fresh fulfillment is pushed to the channel on the next sync.
  • Product inventory and average-cost figures are recalculated in the background.

Errors (422):

  • the shipment is not voided (nothing to restore)
  • the shipment is part of a multi-shipment merge group and cannot be restored individually
  • insufficient allocation to restore a shipped fulfillment (the error names the SKU and quantities)

Requires the orders:write token scope.

Request

Responses

OK

Response Headers
    Content-Type