Shipping an order

The API provides shortcuts to automatically create shipments based on the line items in a given order. Learn about this alternative to the "complete" endpoint.

Assume you now have a workflow that requires shipments. OrderCloud provides a shorthand method so that you can automatically create a new shipment containing all of the line items on an order. It is called the Order Ship endpoint. Once everything is shipped, the order status is updated to "Complete" and the process is complete.

See Order Ship endpoint for more information.

If you already completed your order in the previous guide, create and submit another using the guide in creating your first order.

POST https://sandboxapi.ordercloud.io/v1/orders/incoming/INSERT_ORDER_ID_HERE/ship HTTP/1.1
Authorization: Bearer INSERT_ACCESS_TOKEN_HERE
Content-Type: application/json; charset=UTF-8

{} //empty order object

Viewing shipments

Now that you have shipped and completed your order, you can view the order's shipments using the OrderCloud Shipments resource.

See OrderCloud Shipments for more information.

GET https://sandboxapi.ordercloud.io/v1/shipments?orderID="INSERT_ORDER_ID_HERE" HTTP/1.1
Authorization: Bearer INSERT_ACCESS_TOKEN_HERE
Content-Type: application/json; charset=UTF-8;