Update Shipment

PUT

https://api.bigcommerce.com/stores/:store_hash/v2/orders/:order_id/shipments/:shipment_id

PUT

/stores/:store_hash/v2/orders/:order_id/shipments/:shipment_id

curl -X PUT https://api.bigcommerce.com/stores/store_hash/v2/orders/1/shipments/1 \
     -H "Accept: application/json" \
     -H "X-Auth-Token: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "order_address_id": 1,
  "tracking_number": "EJ958083578US",
  "merchant_shipping_cost": "1.0000",
  "shipping_provider": "fedex"
}'

200application/json

{
  "id": 11,
  "order_id": 228,
  "customer_id": 11,
  "order_address_id": 131,
  "date_created": "Wed, 13 Mar 2019 16:35:37 +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": "Doe",
    "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": 194,
      "product_id": 0,
      "quantity": 1
    },
    {
      "order_product_id": 195,
      "product_id": 0,
      "quantity": 1
    }
  ],
  "shipping_provider_display_name": "USPS",
  "generated_tracking_link": "http://trkcnfrm1.smi.usps.com/PTSInternetWeb/InterLabelInquiry.do?strOrigTrackNum=EJ958083578US"
}

Updates an existing shipment associated with 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_idintegerRequired

ID of the order.

shipment_idintegerRequired

Shipment ID.

store_hashstringRequired

Permanent ID of the BigCommerce store.

Request

This endpoint expects an object.

order_address_idintegerOptional

ID of the desired shipping_address associated with the shipment.

tracking_numberstringOptional

Tracking number of the shipment.

merchant_shipping_coststringOptional

Shipping cost for the merchant.

shipping_methodstringOptional

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 stringOptional

tracking_carrierstringOptional

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

tracking_linkstringOptional<=500 characters

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.

commentsstringOptional<=65535 characters

Comments the shipper wishes to add.

Response

The requested order shipment.

idintegerOptional

Shipment ID.

order_idintegerOptional

ID of the order associated with this shipment.

customer_idintegerOptional

ID of this order’s customer.

order_address_idintegerOptional

ID of the desired shipping_address associated with the shipment.

date_createdstringOptional

Creation date for the shipment.

tracking_numberstringOptional

Tracking number of the shipment.

merchant_shipping_coststringOptional

Shipping cost for the merchant.

shipping_methodstringOptional

shipping_providerenum or stringOptional

tracking_carrierstringOptional

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

tracking_linkstringOptional

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.

commentsstringOptional<=65535 characters

Comments the shipper wishes to add.

billing_addressobjectOptional

shipping_addressobjectOptional

Shipping Address properties common to all requests and responses.

itemslist of objectsOptional

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

The human-readable name for the shipping_provider.

generated_tracking_linkstringOptional

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.