List Order Shipments

import requests
url = "https://api.bigcommerce.com/stores/store_hash/v2/orders/order_id/shipments"
headers = {"X-Auth-Token": "<apiKey>"}
response = requests.get(url, headers=headers)
print(response.json())

[
  {
    "id": 6,
    "order_id": 225,
    "customer_id": 11,
    "order_address_id": 127,
    "date_created": "Mon, 11 Mar 2019 17:22:08 +0000",
    "tracking_number": "EJ958083578US",
    "merchant_shipping_cost": "0.0000",
    "shipping_method": "None",
    "shipping_provider": "usps",
    "tracking_carrier": "",
    "tracking_link": "",
    "comments": "Ready to go...",
    "billing_address": {
      "zip": "78751",
      "first_name": "Jane",
      "last_name": "Does",
      "company": "",
      "street_1": "123 Main Street",
      "street_2": "",
      "city": "Austin",
      "state": "Texas",
      "country": "United States",
      "country_iso2": "US",
      "phone": "",
      "email": "janedoe@example.com"
    },
    "shipping_address": {
      "first_name": "Trishy",
      "last_name": "Test",
      "company": "Acme Pty Ltd",
      "street_1": "666 Sussex St",
      "street_2": "",
      "city": "Anywhere",
      "state": "Some State",
      "zip": "12345",
      "country": "United States",
      "country_iso2": "US",
      "phone": "",
      "email": "elsie@example.com"
    },
    "items": [
      {
        "order_product_id": 188,
        "product_id": 0,
        "quantity": 1
      }
    ],
    "shipping_provider_display_name": "USPS",
    "generated_tracking_link": "http://trkcnfrm1.smi.usps.com/PTSInternetWeb/InterLabelInquiry.do?strOrigTrackNum=EJ958083578US"
  },
  {
    "id": 7,
    "order_id": 225,
    "customer_id": 11,
    "order_address_id": 128,
    "date_created": "Mon, 11 Mar 2019 17:22:31 +0000",
    "tracking_number": "EJ958083578UK",
    "merchant_shipping_cost": "0.0000",
    "shipping_method": "None",
    "shipping_provider": "usps",
    "tracking_carrier": "",
    "tracking_link": "",
    "comments": "Janes Order",
    "billing_address": {
      "zip": "78751",
      "first_name": "Jane",
      "last_name": "Does",
      "company": "",
      "street_1": "123 Main Street",
      "street_2": "",
      "city": "Austin",
      "state": "Texas",
      "country": "United States",
      "country_iso2": "US",
      "phone": "",
      "email": "janedoe@example.com"
    },
    "shipping_address": {
      "first_name": "Jane",
      "last_name": "Doe",
      "company": "",
      "street_1": "555 Main Street",
      "street_2": "",
      "city": "Austin",
      "state": "Texas",
      "zip": "78751",
      "country": "United States",
      "country_iso2": "US",
      "phone": "",
      "email": "janedoe@example.com"
    },
    "items": [
      {
        "order_product_id": 189,
        "product_id": 0,
        "quantity": 1
      }
    ],
    "shipping_provider_display_name": "USPS",
    "generated_tracking_link": "http://trkcnfrm1.smi.usps.com/PTSInternetWeb/InterLabelInquiry.do?strOrigTrackNum=EJ958083578US"
  }
]

Gets a list of all shipments on an order.

Authentication

X-Auth-Tokenstring

OAuth scopes

UI Name	Permission	Parameter
Orders	modify	`store_v2_orders`
Orders	read-only	`store_v2_orders_read_only`

Authentication header

Header	Argument	Description
`X-Auth-Token`	`access_token`	For more about API accounts that generate `access_token`s, see our Guide to API Accounts.

Path parameters

order_idstringRequired

Query parameters

pagedoubleOptionalDefaults to 1

The page to return in the response.

limitdoubleOptionalDefaults to 50

Number of results to return.

Response

idinteger

Shipment ID.

order_idinteger

ID of the order associated with this shipment.

customer_idinteger

ID of this order’s customer.

order_address_idinteger

ID of the desired shipping_address associated with the shipment.

date_createdstring

Creation date for the shipment.

tracking_numberstring

Tracking number of the shipment.

merchant_shipping_coststring

Shipping cost for the merchant.

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.

shipping_providerenum or string

tracking_carrierstring

Tracking carrier for the shipment. Acceptable values for tracking_carrier include an empty string ("") or one of the valid tracking-carrier values.

Tracking carrier for the shipment. Acceptable values for `tracking_carrier` include an empty string (`""`) or one of the valid [tracking-carrier values](https://www.aftership.com/docs/tracking/others/supported-couriers).

tracking_linkstring

The custom tracking link supplied on POST or PUT shipments. For the link to one of our integrated providers or Aftership tracking link, see the generated_tracking_link property.

commentsstring<=65535 characters

Comments the shipper wishes to add.

billing_addressobject

shipping_addressobject

Shipping Address properties common to all requests and responses.

itemslist of objects

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_namestringRead-only

The human-readable name for the shipping_provider.

generated_tracking_linkstring

The link to one of our integrated providers or Aftership 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.

Authentication

OAuth scopes

Authentication header

Further reading

Path parameters

Query parameters

Response

OAuth scopes

Authentication header

Further reading