Thanks for being patient while we implement your feedback to improve the developer experience.

Get Customs Information

GET /shipping/products/customs-information

Request

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-Token in header - required

Parameters

  • store_hash in path - string
  • Accept in header with default of application/json - string - required

    The MIME type of the response body.

  • product_id:in in query - array

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

  • page in query - integer
  • limit in query - integer

example

curl --request GET \
  --url 'https://api.bigcommerce.com/stores/[store_hash]/v3/shipping/products/customs-information' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header 'X-Auth-Token: xxxxxxxxxxxxxxxxx'

Response

Body

object | application/json

  • data    array[object]

  • meta    object

    Meta data relating to pagination.

example

{
  "data": [
    {
      "product_id": 77,
      "country_of_origin": "US",
      "commodity_description": "Baseball caps",
      "international_shipping": true,
      "hs_codes": {
        "ALL": "501000",
        "CA": "508313",
        "US": "641000",
        "AU": "817355"
      }
    }
  ],
  "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"
      }
    }
  }
}

Delete Customs Information

DELETE /shipping/products/customs-information

Request

Deletes customs information objects for a product.

Example

This is a batch operation. The product_id:in query parameter is required.

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

Authentication

  • X-Auth-Token in header - required

Parameters

  • store_hash in path - string
  • Accept in header with default of application/json - string - required

    The MIME type of the response body.

  • product_id:in in query - string - required

example

curl --request DELETE \
  --url 'https://api.bigcommerce.com/stores/[store_hash]/v3/shipping/products/customs-information' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header 'X-Auth-Token: xxxxxxxxxxxxxxxxx'

Response

No Content

Upsert Customs Information

PUT /shipping/products/customs-information

Request

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-Token in header - required

Parameters

  • store_hash in path - string
  • Content-Type in header with default of application/json - string - required

    The MIME type of the request body.

Body

array | application/json

  • product_id    integer

    The product ID to which the customs information data applies.

    Example: 77

  • country_of_origin    string

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

    Example: US

  • commodity_description    string

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

    >= 0 characters<= 100 characters

    Example: Baseball caps

  • international_shipping    boolean

    Flag to determine whether this product will be shipped internationally.

    Allowed: true | false

    Example: true

  • hs_codes    object

    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.

    Example: {"ALL":"501000","CA":"508313","US":"641000","AU":"817355"}

Example

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

Response

OK

Body

object | application/json

  • data    array[object]