Upsert Customs Information

PUT

https://api.bigcommerce.com/stores/:store_hash/v3/shipping/products/customs-information

PUT

/stores/:store_hash/v3/shipping/products/customs-information

curl -X PUT https://api.bigcommerce.com/stores/store_hash/v3/shipping/products/customs-information \
     -H "Accept: application/json" \
     -H "X-Auth-Token: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '[
  {
    "product_id": 77,
    "country_of_origin": "US",
    "commodity_description": "Baseball caps",
    "international_shipping": true,
    "hs_codes": {
      "ALL": "501000",
      "AU": "817355",
      "CA": "508313"
    }
  }
]'

{
  "data": [
    {
      "product_id": 77,
      "country_of_origin": "US",
      "commodity_description": "Baseball caps",
      "international_shipping": true,
      "hs_codes": {
        "ALL": "501000",
        "AU": "817355",
        "CA": "508313",
        "US": "641000"
      },
      "created_at": {},
      "updated_at": {}
    }
  ]
}

Creates and updates product customs information.

This is a batch operation where the creation of multiple customs information objects can be done with one PUT request.

Limits

Limit of 50 customs information objects per PUT request.

Authentication

X-Auth-Tokenstring

OAuth scopes

UI Name	Permission	Parameter
Products	modify	`store_v2_products`
Products	read-only	`store_v2_products_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

store_hashstringRequired

Permanent ID of the BigCommerce store.

Request

This endpoint expects a list of objects.

product_idintegerRequired

The product ID to which the customs information data applies.

country_of_originstringRequired

The country of manufacture, production, or growth represented in ISO 3166-1 alpha-2 format.

commodity_descriptionstringRequired0-100 characters

Description that provides information for customs to identify and verify the shapes, physical characteristics, and packaging of each shipment.

international_shippingbooleanRequired

Flag to determine whether this product will be shipped internationally.

hs_codesobjectRequired

Key-value pairs that are commonly used in the following form:

countryISO2: '/^[0-9A-Za-z]{6,14}$/'

This key-value pair represents a country and the associated hs_code that applies to that country.

You can also use the ALL key in place of an ISO2 key to specify that the hs_code applies to all countries. The ALL key can be combined with other countries in the hs_code object.

Response

datalist of objectsOptional

Errors

400

Bad Request Error

413

Content Too Large Error

422

Unprocessable Entity Error