post

/orders/{order_id}/shipments

Creates an Order Shipment. For more details, see Shipping an Order.

Required Fields

  • order_address_id
  • items

Usage Notes

Presuming that a valid carrier code is used, a tracking link is generated if either shipping_provider or tracking_carrier is supplied alongside a tracking number. Providing only the tracking number will result in an unclickable text in the customer facing email.

Acceptable values for shipping_provider include an empty string (""), auspost, canadapost, endicia, usps, fedex, ups, upsready, upsonline, or shipperhq.

Acceptable values for tracking_carrier include an empty string ("") or one of the valid tracking-carrier values viewable here and downloadable as a .CSV file here.

Authorization

apiKey - X-Auth-Token
apiKey - X-Auth-Client

Request Parameters

1 Path Parameter
2 Headers

Request Body

1 Example
Schema
object
order_address_id
integer

ID of the desired shipping_address associated with the shipment.

1 validation
tracking_number
string

Tracking number of the shipment.

1 validation
shipping_method
string

Additional information to describe the method of shipment (ex. Standard, Ship by Weight, Custom Shipment). Can be used for live quotes from certain shipping providers. If different from shipping_provider, shipping_method should correspond to tracking_carrier.

1 validation
shipping_provider
string

Enum of the BigCommerce shipping-carrier integration/module.

1 validation
tracking_carrier
string

Tracking carrier for the shipment. Acceptable values include an empty string ("") or one of the valid tracking-carrier values viewable here and downloadable as a .CSV file here.

comments
string

Comments the shipper wishes to add.

items
array[object]

The items in the shipment. This object has the following members, all integer: order_product_id (required), quantity (required), product_id (read-only). A sample items value might be: [ {“order_product_id”:16,“product_id”: 0,“quantity”:2} ]

Responses

1 Example
Schema
object
id
integer

Shipment ID.

1 validation
order_id
integer

ID of the order associated with this shipment.

1 validation
customer_id
integer

ID of this order’s customer.

1 validation
order_address_id
integer

ID of the desired shipping_address associated with the shipment.

1 validation
date_created
string

Creation date for the shipment.

tracking_number
string

Tracking number of the shipment.

1 validation
shipping_method
string

Additional information to describe the method of shipment (ex. Standard, Ship by Weight, Custom Shipment). Can be used for live quotes from certain shipping providers. If different from shipping_provider, shipping_method should correspond to tracking_carrier.

1 validation
shipping_provider
string

Enum of the BigCommerce shipping-carrier integration/module.

1 validation
tracking_carrier
string

Tracking carrier for the shipment. Acceptable values include an empty string ("") or one of the valid tracking-carrier values viewable here and downloadable as a .CSV file here.

comments
string

Comments the shipper wishes to add.

billing_address
object
shipping_address
object
items
array[object]

The items in the shipment. This object has the following members, all integer: order_product_id (required), quantity (required), product_id (read-only). A sample items value might be: [ {“order_product_id”:16,“product_id”: 0,“quantity”:2} ]

Send a Test Request

Send requests directly from the browser (CORS must be enabled)
Path Params
1 path param not set
order_id
$$.env
2 variables not set
store_hash
X-Auth-Token
X-Auth-Client