Shipping an Order

The API provides some shortcuts to automatically create Shipments based on the Line Items in a given Order. Learn about this alternative to the "complete" endpoint.

Let's assume we now have a different workflow that does require 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.

If you already completed your order in the previous guide, you will need to create and submit another using the buyer perspective.

Let's go ahead and use the shorthand method of shipping and completing an order using the ID you retrieved in the previous guide:

1POST https://sandboxapi.ordercloud.io/v1/orders/incoming/INSERT_ORDER_ID_HERE/ship HTTP/1.1
2Authorization: Bearer INSERT_ACCESS_TOKEN_HERE
3Content-Type: application/json; charset=UTF-8;
4
5{} //empty order object

Viewing Shipments

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

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

Still have questions?
Ask in our Community Channel

Content Powered By