Skip to main content

cancelOrderShipment

Cancels a recorded shipment while retaining it as part of the fulfillment's history.

Business Rules:

  • The shipment remains visible in the fulfillment's history with a canceled status.
  • Remaining shipped coverage determines whether the fulfillment stays fulfilled or reopens.
  • An uncovered fulfillment returns to ready locally or in_progress for an external service.
  • A canceled shipment cannot be canceled again.

Error Scenarios:

  • The shipment does not exist or belongs to another company.
  • The shipment has already been canceled.

Permissions Required:

  • orders:archive_shipment
cancelOrderShipment(
  input: CancelOrderShipmentInput!
): OrderShipment!

Arguments​

cancelOrderShipment.input ● CancelOrderShipmentInput! non-null input common​

Parameters for CancelOrderShipment

Type​

OrderShipment object shipments​

This type represents an order shipment. An order can have multiple shipments, each one associated with a fulfillment and a carrier that shipped the order