post

/orders/{order_id}/shipments

Creates an Order Shipment. To learn how to create an Order Shipment, see Orders Overview.

Required Fields

  • order_address_id
  • items
  • shipping_provider

Read Only Fields

  • id
  • order_id
  • date_created
  • customer_id
  • billing_address
  • shipping_address

Notes
tracking_carrier is optional, but if you include it, its value must refer/map to the same carrier service as the shipping_provider value. Acceptable values for tracking_carrier are 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
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 associated order address.

1 validation
date_created
string

Creation date for the shipment.

2 validations
tracking_number
string

Tracking number of the shipment.

1 validation
shipping_method
string

Extra detail to describe the shipment, with values like: Standard, My Custom Shipping Method Name, etc. Can also be used for live quotes from some shipping providers.

1 validation
shipping_provider
string

Enum of the BigCommerce shipping-carrier integration/module. (Note: This property should be included in a POST request to create a shipment object. If it is omitted from the request, the property’s value will default to custom, and no tracking link will be generated in the email. To avoid this behavior, you can pass the property as an empty string.)

1 validation
tracking_carrier
string

Optional, but if you include it, its value must refer/map to the same carrier service as the shipping_provider value.

3 validations
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} ]

Responses

2 Examples
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 associated order address.

1 validation
date_created
string

Creation date for the shipment.

2 validations
tracking_number
string

Tracking number of the shipment.

1 validation
shipping_method
string

Extra detail to describe the shipment, with values like: Standard, My Custom Shipping Method Name, etc. Can also be used for live quotes from some shipping providers.

1 validation
shipping_provider
string

Enum of the BigCommerce shipping-carrier integration/module. (Note: This property should be included in a POST request to create a shipment object. If it is omitted from the request, the property’s value will default to custom, and no tracking link will be generated in the email. To avoid this behavior, you can pass the property as an empty string.)

1 validation
tracking_carrier
string

Optional, but if you include it, its value must refer/map to the same carrier service as the shipping_provider value.

3 validations
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
2 path params not set
store_hash
order_id
$$.env
2 variables not set
X-Auth-Token
X-Auth-Client