ID of the desired shipping_address associated with the shipment.
Example: 20
date_createdstring
Creation date for the shipment.
tracking_numberstring
Tracking number of the shipment.
Example: w4se4b6ASFEW4T
shipping_methodstring
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.
Tracking carrier for the shipment.
Acceptable values for tracking_carrier include an empty string ("") or one of the valid tracking-carrier values.
tracking_linkstring
The custom tracking link supplied on POST or PUT shipments. For the auto-generated tracking link see the generated_tracking_link property.
commentsstring
Comments the shipper wishes to add.
<= 65535 characters
billing_addressobject
shipping_addressobject
Shipping Address properties common to all requests and responses.
itemsarray[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} ]
shipping_provider_display_namestring
read-only
The human-readable name for the shipping_provider.
generated_tracking_linkstring
The tracking link that is generated using the combination of either the tracking_number and shipping_provider or tracking_number and tracking_carrier. This will be empty if the custom tracking_link value is provided.
There are three methods for generating a tracking link for a shipment:
Use shipping_provider and tracking_number: This generates an automatic tracking link that you can click from the BigCommerce control panel and customer-facing emails. The generated_tracking_link property in the API response represents this tracking link. The tracking_link property in the API response will remain empty.
Use tracking_carrier and tracking_number: This also creates an automatic tracking link that you can click in both the BigCommerce control panel and customer-facing emails. Like the previous method, the generated_tracking_link property in the API response represents this tracking link. The tracking_link property in the API response will remain empty.
Supply a custom tracking_link: By providing a value for the tracking_link property, you can use your own tracking link within the BigCommerce control panel and in customer-facing emails. The API response will return your supplied tracking link as part of the tracking_link property in the response. In situations when there isn't a generated_tracking_link, the property in the API response will remain empty.
Acceptable values for shipping_provider include the following, and this list may be updated at any time:
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.
Example: Ship by Weight
shipping_provider
Any of:Standard Shipping ProviderCustom Shipping Provider
Tracking carrier for the shipment.
Acceptable values for tracking_carrier include an empty string ("") or one of the valid tracking-carrier values.
commentsstring
Comments the shipper wishes to add.
<= 65535 characters
itemsarray[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} ]
Response
201
Body
object | application/json
idinteger
Shipment ID.
Example: 1
order_idinteger
ID of the order associated with this shipment.
Example: 120
customer_idinteger
ID of this order’s customer.
Example: 5
order_address_idinteger
ID of the desired shipping_address associated with the shipment.
Example: 20
date_createdstring
Creation date for the shipment.
tracking_numberstring
Tracking number of the shipment.
Example: w4se4b6ASFEW4T
shipping_methodstring
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.
Example: Ship by Weight
shipping_provider
Any of:Standard Shipping ProviderCustom Shipping Provider
Tracking carrier for the shipment.
Acceptable values for tracking_carrier include an empty string ("") or one of the valid tracking-carrier values.
tracking_linkstring
The custom tracking link supplied on POST or PUT shipments. For the auto-generated tracking link see the generated_tracking_link property.
commentsstring
Comments the shipper wishes to add.
<= 65535 characters
billing_addressobject
shipping_addressobject
Shipping Address properties common to all requests and responses.
itemsarray[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} ]
shipping_provider_display_namestring
read-only
The human-readable name for the shipping_provider.
generated_tracking_linkstring
The tracking link that is generated using the combination of either the tracking_number and shipping_provider or tracking_number and tracking_carrier. This will be empty if the custom tracking_link value is provided.
ID of the desired shipping_address associated with the shipment.
Example: 20
date_createdstring
Creation date for the shipment.
tracking_numberstring
Tracking number of the shipment.
Example: w4se4b6ASFEW4T
shipping_methodstring
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.
Example: Ship by Weight
shipping_provider
Any of:Standard Shipping ProviderCustom Shipping Provider
Tracking carrier for the shipment.
Acceptable values for tracking_carrier include an empty string ("") or one of the valid tracking-carrier values.
tracking_linkstring
The custom tracking link supplied on POST or PUT shipments. For the auto-generated tracking link see the generated_tracking_link property.
commentsstring
Comments the shipper wishes to add.
<= 65535 characters
billing_addressobject
shipping_addressobject
Shipping Address properties common to all requests and responses.
itemsarray[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} ]
shipping_provider_display_namestring
read-only
The human-readable name for the shipping_provider.
generated_tracking_linkstring
The tracking link that is generated using the combination of either the tracking_number and shipping_provider or tracking_number and tracking_carrier. This will be empty if the custom tracking_link value is provided.
ID of the desired shipping_address associated with the shipment.
Example: 20
tracking_numberstring
Tracking number of the shipment.
Example: w4se4b6ASFEW4T
shipping_methodstring
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.
Example: Ship by Weight
shipping_provider
Any of:Standard Shipping ProviderCustom Shipping Provider
ID of the desired shipping_address associated with the shipment.
Example: 20
date_createdstring
Creation date for the shipment.
tracking_numberstring
Tracking number of the shipment.
Example: w4se4b6ASFEW4T
shipping_methodstring
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.
Example: Ship by Weight
shipping_provider
Any of:Standard Shipping ProviderCustom Shipping Provider
Tracking carrier for the shipment.
Acceptable values for tracking_carrier include an empty string ("") or one of the valid tracking-carrier values.
tracking_linkstring
The custom tracking link supplied on POST or PUT shipments. For the auto-generated tracking link see the generated_tracking_link property.
commentsstring
Comments the shipper wishes to add.
<= 65535 characters
billing_addressobject
shipping_addressobject
Shipping Address properties common to all requests and responses.
itemsarray[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} ]
shipping_provider_display_namestring
read-only
The human-readable name for the shipping_provider.
generated_tracking_linkstring
The tracking link that is generated using the combination of either the tracking_number and shipping_provider or tracking_number and tracking_carrier. This will be empty if the custom tracking_link value is provided.