Shipments

Group: Inventory

Open in the interactive reference

A shipment records goods going out to a customer. You create it as a draft, then commit it to send the goods and record the cost of sale in a journal entry.

Through this API, a shipment is 'DRAFT' until it's committed, and 'DELIVERED' after. The packing process can set it to 'PACKED' before it's committed.

Other parts of the application, such as invoicing, sales returns, and cancellation, can set documentStatus to 'SHIPPED', 'PARTIALLY_SHIPPED', 'COMMITTED', 'COMPLETED', 'CANCELLED', 'INVOICED', 'PARTIALLY_INVOICED', 'RETURNED', or 'PARTIALLY_RETURNED'. No endpoint on this page sets these statuses.

Endpoints

• List shipments: GET /inventory/shipments
• Create a shipment: POST /inventory/shipments
• Bulk create shipments: POST /inventory/shipments/bulk
• Bulk delete shipments: POST /inventory/shipments/bulk-delete
• Search shipments: POST /inventory/shipments/search
• Retrieve a shipment: GET /inventory/shipments/{id}
• Update a shipment: PATCH /inventory/shipments/{id}
• Delete a shipment: DELETE /inventory/shipments/{id}
• Ship and deliver a shipment: POST /inventory/shipments/{id}/commit