Zonos logo
DOCS

Check for item restrictions rest

/

Verify that items are not restricted for import or export 

The Zonos Item Restriction API enables users to verify if any items that are being shipped are restricted from export or import by the destination country. Items are restricted for import or export based on the regulations put in place by government agencies. Parties that violate these restrictions can be subject to financial penalties.

Our API receives HS Codes and country data for shipped items and will flag any prohibitions, restrictions, or observations associated with those items in the shipment.

1

Provide item information

To check for item restrictions, we need to know some basic information about the item. We prefer to receive the country_of_origin, and require at minimum a six digit hs_code as restrictions sometimes apply to the country_of_origin and will always be based on an hs_code. The hs_code must have between 6 and 13 digits, and must only contain numbers and periods.

Request

1
2
3
4
5
6
7
8
9
{
  "items": [
      {
        "country_of_origin": "IT",
        "description": "Men's leather shoes",
        "hs_code": "6116.10.00"
      }
  ]
}
2

Provide country information as well as the level of restrictions you want to return

Shipment origin and destination are required as this will enable us to identify EXPORT and IMPORT restrictions that may apply to the shipment. You will also pass the level of restriction that you want to see in the request. Users can select from PROHIBITION (most severe), RESTRICTION (medium severity) and OBSERVATION (least severe). Based on this selection the API will return that severity and anything above it. If no field is passed in the request, we will default to PROHIBITION.

Request

1
2
3
4
5
{
  "restriction_type_threshold": "OBSERVATION",
  "ship_from_country": "US",
  "ship_to_country": "CA"
}
3

Send a request to the Zonos Item Restriction API

Now that you’ve built out your request, you can send a POST to the Zonos Item Restriction API. Make sure to authenticate with your API key and provide the correct version header in your request.

POST https://api.zonos.com/v1/item_restriction

Request

1
2
3
4
5
6
7
8
9
10
11
12
{
  "items": [
    {
      "country_of_origin": "IT",
      "description": "Men's leather shoes",
      "hs_code": "6116.10.00"
    }
  ],
  "restriction_type_threshold": "OBSERVATION",
  "ship_from_country": "US",
  "ship_to_country": "CA"
}
4

Interpret the response

The results returned will change if we find restrictions based on item and shipment details passed in the request. In cases where matches exist, the action field will return the type of restriction that applies as well as each of the details about the restrictions that apply to the shipment.

Response

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
{
  "created_at": "2022-09-07T17:15:51.887473174Z",
  "created_by": "organization_01111010-0110-1111-0110-1110-011011110111",
  "id": "item_restriction_result_5a8625ab-bb70-4ae1-be53-493243f1a9fd",
  "mode": "LIVE",
  "ship_from_country": "US",
  "ship_to_country": "CA",
  "items": [
    {
      "id": "applied_item_restrictions_5a8625ab-bb70-4ae1-be53-493243f1a9fd",
      "action": "RESTRICTIONS_APPLY",
      "country_of_origin": "US",
      "item_description": "Men's leather shoes",
      "item_hs_code": "6116.10.00",
      "item_restrictions": [
        {
          "id": "item_restriction_5a8625ab-bb70-4ae1-be53-493243f1a9fd",
          "applicable_countries": [
                      "AD",
                      "AE"
          ],
          "control_countries": [
                      "CA",
                      "BE"
          ],
        "control_country_codes": [
                      "EUG"
          ],
          "control_type": "IMPORT",
          "ends_at": "null",
          "hs_code": "6116.10.00",
          "note": "Italian leather shoes are not eligible for import into Canada",
          "sources": ["Bureau of Foreign Trade"],
          "starts_at": "2021-07-01T00:00:00Z",
          "type": "PROHIBITION"
        }
      ]
    }
  ]
}

Within the items array, the possible values for the action field are:

  • OBSERVATIONS_APPLY
  • PROHIBITIONS_APPLY
  • RESTRICTIONS_APPLY
  • NO_MATCH

Within the item_restrictions array, the possible values for the following fields are:

  • control_type

    • IMPORT
    • EXPORT
  • type

    • OBSERVATION
    • PROHIBITION
    • RESTRICTION

In scenarios where no match is found, the action field will return NO_MATCH and the item_restrictions field will return an empty array.

Response

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
{
 "created_at": "2022-09-09T16:15:07.18020051Z",
 "created_by": "organization_01111010-0110-1111-0110-1110-011011110111",
 "id": "item_restriction_result_1cfe390d-7095-4685-834f-8792bf024579",
 "mode": "LIVE",
 "ship_from_country": "AD",
 "ship_to_country": "FR",
 "items": [
  {
   "action": "NO_MATCH",
   "country_of_origin": "FR",
   "id": "applied_item_restrictions_entity_d982de78-8524-4cae-8492-aa4edb06de67",
   "item_description": "test des",
   "item_hs_code": "634133",
   "item_restrictions": []
  }
 ]
}