Check for restrictions

To start a session, you will create a mutation with the hsCode and countryOfOrigin for the items being shipped. 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.

mutation Mutation($input: ItemRestrictionApplyInput!) {
  itemRestrictionApply(input: $input) {
    id
    items {
      id
      action
      itemRestrictions {
        hsCode
        id
        note
        type
        sources
      }
    }
  }
}

{
  "input": {
    "items": [
      {
        "countryOfOrigin": "IT",
        "description": "Mens Leather Shoes",
        "hsCode": "61161000"
      }
    ],
    "shipFromCountry": "US",
    "shipToCountry": "CA",
    "restrictionTypeThreshold": "OBSERVATION"
  }
}

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.

{
  "data": {
    "itemRestrictionsApply": [
      {
        "action": "RESTRICTIONS_APPLY",
        "id": "appliedItemRestrictions_1d9f4691-3611-40d6-a585-78ca41dae326",
        "itemHsCode": "61161000",
        "itemRestriction": {
          "endsAt": "2022-08-26T20:40:51.019Z",
          "hsCode": "61161000",
          "id": "restriction_69b7cd66-738e-4e4c-ac79-79607ab45eae",
          "note": "Italian leather shoes are not eligible for import into Canada without a license",
          "source": "Bureau of Foreign Trade",
          "startsAt": "2022-08-26T20:40:51.019Z",
          "type": "RESTRICTION"
        }
      }
    ]
  }
}

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

• OBSERVATIONS_APPLY
• PROHIBITIONS_APPLY
• RESTRICTIONS_APPLY
• NO_MATCH

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

• controlType

  • IMPORT
  • EXPORT

• type

  • OBSERVATION
  • PROHIBITION
  • RESTRICTION

Note field

The note field in the response from the Zonos Item Restriction API is a text description of any restrictions, prohibitions, or observations associated with the shipped items. The note provides additional information about the restrictions not explicitly stated in other fields.

Based on the given text, possible note responses could be:

• "Live animals are prohibited from being imported into Australia"
• "Clothing items made from fur are restricted from export to certain countries"
• "Weapons and ammunition are prohibited from import into most countries"

The notes field will only be populated if there is a restriction, prohibition, or observation associated with the item being shipped. It will contain the relevant details of that restriction." In scenarios where no match is found, the itemRestrictions field will return an empty array.

{
  "data": {
    "itemRestrictionApply": {
      "items": [
        {
          "id": "applied_item_restrictions_entity_3a7f54c0-fc3d-4184-9ffd-29865c8937de",
          "action": "NO_MATCH",
          "itemRestrictions": []
        }
      ]
    }
  }
}