CustomsInformation
Retrieves and manages customs information for products.
Table Specific Information
Select
The component uses the BigCommerce API to process WHERE clause conditions built with the following columns and operators:
- ProductId supports the = and IN comparisons.
The rest of the filter is executed client-side within the component.
For example, the following queries are processed server-side:
SELECT * FROM CustomsInformation WHERE ProductId = 126
SELECT * FROM CustomsInformation WHERE ProductId IN (126,127)
Insert
CustomsInformation only supports an upsert-style write: inserting a product that does not yet have customs information creates it, while inserting a product that already has customs information updates it. Specify ProductId, CountryOfOrigin, CommodityDescription, InternationalShipping, and HsCodes. HsCodes must be a JSON-formatted object mapping a destination country ISO-2 code (or ALL) to a Harmonized System code.
INSERT INTO CustomsInformation (ProductId, CountryOfOrigin, CommodityDescription, InternationalShipping, HsCodes) VALUES (77, 'US', 'Cotton T-Shirt', true, '{"ALL":"610910"}')
Delete
DELETE FROM CustomsInformation WHERE ProductId = 126
DELETE FROM CustomsInformation WHERE ProductId IN (126,127)
Columns
| Name | Type | ReadOnly | Description |
| ProductId [KEY] | Integer | False |
The Id of the product this customs information is associated with. |
| CountryOfOrigin | String | False |
ISO 3166-1 alpha-2 country code representing the product's country of origin. |
| CommodityDescription | String | False |
Description that provides information for customs to identify and verify the product's physical characteristics. |
| InternationalShipping | Boolean | False |
Whether the product is eligible for international shipping. |
| HsCodes | String | False |
A JSON-formatted object mapping a country ISO-2 code (or ALL) to the Harmonized System code used for that destination. |
| CreatedAt | Datetime | True |
Date and time the customs information was created. |
| UpdatedAt | Datetime | True |
Date and time the customs information was last updated. |