Skip to main content

orderShipmentCreate

Creates an order shipment with the SKUs and quantities that shipped.

Business Rules​

  • The fulfillment must belong to the order and must not be canceled.
  • Each shipment line requires a SKU and a positive quantity. At least one line is required.
  • Each SKU must match exactly one item in this fulfillment and must not be repeated. Shipment items are automatically linked to the matching fulfillment items.
  • Partial shipments retain remaining fulfillment work. Full shipment coverage completes the fulfillment and commits its existing inventory allocation.
  • Multiple shipments can be created for a fulfillment. External shipment IDs, when supplied, must be unique among its active shipped records.

Error Scenarios​

  • The order or fulfillment does not exist or is inaccessible.
  • Shipment items are missing, invalid, or duplicated.
  • The shipment ID or external shipment ID has already been used.
  • An integration is not authorized to report shipments for this fulfillment.

Permissions Required​

  • orders:create_shipment permission for the order’s company.
orderShipmentCreate(
  input: OrderShipmentCreateInput!
): OrderShipmentCreatePayload

Arguments​

orderShipmentCreate.input ● OrderShipmentCreateInput! non-null input common​

Parameters for OrderShipmentCreate

Type​

OrderShipmentCreatePayload object common​

Autogenerated return type of OrderShipmentCreate.