Order Shipments

Lesson 15 of 26 · 15 min

Tracks a package consignment from an order that is shipped from the seller to the buyer.

Shipping an Order

• Once an Order has products, a billing address and at least one shipping address a order shipment can be created. Order shipments are a way to mark an order as shipped with the shipping information.
• To get the order_address_id use the id returned in Order Shipping Address.
• The items array requires the product quantity and order_product_id. The order_product_id is the ID returned from Order Products.
• There does not need to be a shipping provider. If the shipping provider is not sent in at all, it will default to custom and a tracking link is not generated. To have the tracking link generated without a shipping provider, provide an empty string. To add a shipping provider, see the available options on Order Shipment.
• Once the order shipment is created, it will automatically send out an email to the billing address with the shipment confirmation. To stop this behavior adjust the Order Notification settings in the Control Panel.
• If the order shipment is deleted, the status of the shipment is still in shipped. The status will need to be manually changed.

Create A Shipment

Multiple Locations

• Orders can have multiple shipment locations. There needs to be more than one product or quantity of a product and more than one shipping addresses. A shipping address can be added either during create or using an update.
• To ship to multiple locations create an order shipment for each location and items. Only one POST request per shipment.

Custom Quotes

An order can be created with a _shipping_cost_ex_tax and shipping_cost_inc_tax. This is a way to add a custom shipping amount to an order. This can be added when creating or updating an order.

Shipping Cost

Both shipping_cost_ex_tax and shipping_cost_inc_tax must be included otherwise, the final order amount will not be calculated correctly.

Shipping Carrier

Generating a quote through a shipping carrier is currently not supported. A shipping carrier can be specified when creating an Order Shipment. The quote can be generated elsewhere, then update the shipping_cost_ex_tax and shipping_cost_inc_tax for the order total to be correct.

GET A Shipment

To retrieve the details of a shipment, sent a GET request to: /orders/{order_id}/shipments/{shipment_id}

Resources:

• Order Shipments