List Customs Information

GET

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

GET

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

curl https://api.bigcommerce.com/stores/store_hash/v3/shipping/products/customs-information \
     -H "Accept: application/json" \
     -H "X-Auth-Token: <apiKey>"

{
  "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": {}
    }
  ],
  "meta": {
    "pagination": {
      "total": 3,
      "count": 1,
      "per_page": 1,
      "current_page": 2,
      "total_page": 3,
      "links": {
        "previous": "?limit=1&page=1",
        "next": "?limit=1&page=3",
        "current": "?limit=1&page=2"
      }
    }
  }
}

Get customs information for products.

This list can be filtered to return customs information objects specific to a list of requested product_ids. This is achieved by appending the query string ?product_id:in=4,5,6 to the resource /shipping/products/customs-information.

GET /shipping/products/customs-information?product_id:in=4,5,6

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.

Query parameters

product_id:inlist of integersOptional

A comma-separated list of product IDs. For more information, see Filtering.

pageintegerOptional

The page number of the results to return, starting at 1.

limitintegerOptional

The number of results to return per page.

Response

datalist of objectsOptional

metaobjectOptional

Meta data relating to pagination.

Errors

400

Bad Request Error