Get Shipment | BigCommerce Developer Center

Gets an order shipment.

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.

### 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](/developer/docs/overview/api-accounts#api-accounts). | ### Further reading For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-accounts#x-auth-token-header-example-requests). For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-accounts#oauth-scopes). For a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).

Path parameters

order_idstringRequired

shipment_idstringRequired

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.

1	import requests
2
3	url = "https://api.bigcommerce.com/stores/store_hash/v2/orders/order_id/shipments/shipment_id"
4
5	headers = {"X-Auth-Token": "<apiKey>"}
6
7	response = requests.get(url, headers=headers)
8
9	print(response.json())

1	{
2	"id": 11,
3	"order_id": 228,
4	"customer_id": 11,
5	"order_address_id": 131,
6	"date_created": "Wed, 13 Mar 2019 16:35:37 +0000",
7	"tracking_number": "EJ958083578US",
8	"merchant_shipping_cost": "0.0000",
9	"shipping_method": "None",
10	"shipping_provider": "usps",
11	"tracking_carrier": "",
12	"tracking_link": "",
13	"comments": "Ready to go...",
14	"billing_address": {
15	"zip": "78751",
16	"first_name": "Jane",
17	"last_name": "Doe",
18	"company": "",
19	"street_1": "123 Main Street",
20	"street_2": "",
21	"city": "Austin",
22	"state": "Texas",
23	"country": "United States",
24	"country_iso2": "US",
25	"phone": "",
26	"email": "janedoe@example.com"
27	},
28	"shipping_address": {
29	"first_name": "Trishy",
30	"last_name": "Test",
31	"company": "Acme Pty Ltd",
32	"street_1": "666 Sussex St",
33	"street_2": "",
34	"city": "Anywhere",
35	"state": "Some State",
36	"zip": "12345",
37	"country": "United States",
38	"country_iso2": "US",
39	"phone": "",
40	"email": "elsie@example.com"
41	},
42	"items": [
43	{
44	"order_product_id": 194,
45	"product_id": 0,
46	"quantity": 1
47	},
48	{
49	"order_product_id": 195,
50	"product_id": 0,
51	"quantity": 1
52	}
53	],
54	"shipping_provider_display_name": "USPS",
55	"generated_tracking_link": "http://trkcnfrm1.smi.usps.com/PTSInternetWeb/InterLabelInquiry.do?strOrigTrackNum=EJ958083578US"
56	}