Skip to main content

Create Shipment

POST 
/api/purchase-order-shipments

Create a new shipment for an open purchase order. If shipment_lines is omitted, creates a shipment for all remaining unshipped quantity.

Authentication: Requires Bearer token.

Fields:

  • purchase_order_id (required): ID of the purchase order (must not be draft, not fully shipped)
  • shipment_date (required): Date of shipment in Y-m-d format
  • shipping_method_id (optional): System shipping method ID
  • tracking (optional): Tracking number, max 255 characters
  • shipment_lines (optional): Array of line quantities to ship. If omitted, ships everything remaining
  • shipment_lines[].purchase_order_line_id (conditional): PO line ID. Required without purchase_order_line_reference
  • shipment_lines[].purchase_order_line_reference (conditional): PO line reference code. Required without purchase_order_line_id
  • shipment_lines[].quantity (required): Quantity to ship (must not exceed unfulfilled quantity)

Errors:

  • 422: AWD purchase orders use 'Mark as Shipped' instead
  • 400: Purchase order is not open (draft)

Request​

Responses​

Successful response