Skip to main content

Windsor Framework Categorisation API

The Windsor Framework Categorisation API’s provide access to the trade tariff data for trade with Northern Ireland.

These APIs follow the JSON-API format for both request and response, in common with the other OTT APIs documented on this site.

Base URL

All requests to this API should be prefixed with the following URL:

https://www.trade-tariff.service.gov.uk/xi/api/green_lanes

Authentication

API Key: Parameter X-Api-Key, in header.

Access to these APIs will be restricted. Approved partners requiring access should contact the Online Trade Tariff team.

Those eligible traders will be supplied with a secret API key which should be included in the X-Api-Key header of every request, e.g.:

X-Api-Key: a1b2c3defg4567

Sample client

There’s a very simple html page client as an example of parsing these APIs in Javascript

View sample client   |   Download

About the categorisation API

Categorisation refers to determining whether goods fall under Category 1, Category 2, or Category 3 (often called “standard goods”) when moving them under the Windsor Framework.

The category assigned affects the level of checks, declarations, or paperwork required:

  • Category 1 typically carries the highest regulatory scrutiny or special requirements.
  • Category 2 applies a moderate level of checks or controls.
  • Standard Goods is for “standard goods,” which generally require fewer formalities.

This categorisation depends on factors such as:

  1. Commodity code (the classification of the goods).
  2. Country of origin (where the goods are produced or obtained).
  3. Date of movement (sometimes different rules or requirements apply at different times).
  4. Exemptions or documentation (if the trader possesses certain certificates, additional codes, or conditions, these may remove or reduce certain category rules).

Article 11, section 2 (opens in new tab) of the Windsor Framework establishes the role of these APIs within the broader policy and SPIMM deliverables for trade. It states:

Applicants shall be able to determine whether the goods they bring into Northern Ireland correspond to any of the categories set out in Annex IV to this Decision.

The Online Tariff Tool’s categorisation API returns a set of Category Assessments for each commodity code and origin (though origin agnostic queries can also be made). Each assessment indicates whether the goods could be Category 1 or 2, along with any associated exemptions that would nullify (or “exempt”) that particular category requirement. If an assessment is nullified by one of the trader’s valid exemptions—or if no assessments apply at all—the goods default to Category 3.

The following APIs will allow you to determine which category your goods belong to, following the rules set out in Annex IV:

  • GET /green_lanes/goods_nomenclatures/{id} → This is the main categorisation API which returns applicable category assessments for a given goods nomenclature, including assessments for all its descendants if queried at a higher hierarchical level. Additionally, can specify the date that the categorisation applies to and the origin of the goods.
  • GET /green_lanes/themes → Returns a list of all the Categorisation themes corresponding to the line items of Annex IV within the Windsor Framework.

A Category Assessment indicates when a commodity may fall under one of the rules outlined in Annex IV. However, exemptions can apply, meaning categorisation is not always definitive.

Key Considerations

  • Legal Scope: The rules in Annex IV exclusively reference EU legislation, not UK legislation. This is because the EU is focused on controlling goods entering the single market via Northern Ireland. The UK, on the other hand, does not regulate “internal movements” between Great Britain and Northern Ireland in this context.
  • Regulatory Updates: Annex IV also encompasses subsequent or replacement EU policies, as legislation is frequently updated. Additionally, overarching laws may have subordinate regulations that provide the legal basis for specific trade measures. As a result, you may encounter legislative references not explicitly listed in Annex IV but still falling within its scope.
  • Data Structure: For an overview of the data structure of a Category Assessment, refer to the objects listed in the lower sections of this page.
  • API as a Data Provider: These APIs do not provide a definitive category for a trade. Since exemptions may apply, the responsibility of determining the correct category remains with the user. The API serves only as a data source to support categorisation.
  • Frequent Data Changes: The dataset is updated regularly, often daily. Users should consider this when categorizing future trades.
  • Glossary of terms: a glossary of terms is available at the bottom of this document
  • Limitations on the /goods_nomenclatures API: the API accepts only the following inputs (please note that the more specific the query is - i.e. the further down the hierarchy a goods nomenclature is - the fewer Category ssessments will be returned):
    1. Goods Nomenclature IDs with 4 significant digits, only if the 4 digit codes have no descendants to be categorised (i.e. if the 4 significant digit code is the end commodity in the hierarchy; e.g.: 4906000000)
    2. All Goods Nomenclature IDs with 6, 8 or 10 significant digits, provided the Goods Nomenclature IDs exist on the Northern Ireland online tariff

For more information about categorisation visit Internal Market Movements form Great Britain to Northern Ireland: your questions answered

Determining the Category for commodities with no descendants

To determine the final category for a trade:

  1. Call the /goods_nomenclatures/{id} endpoint with the as_of date and filter.geographical_area_id (use a 2-letter country code like GB, US, etc.).
  2. Extract applicable_category_assessments from the response.
  3. For each assessment:
    • If the trader holds any exemption listed under exemptions, ignore it and treat as Category 3.
    • Otherwise, use the category field (typically 1 or 2.
  4. Select the lowest remaining category (most restrictive).
    • If all assessments are exempted or none returned, assign Category 3.

Determining the Category for commodities with descendants

To determine the final category for a trade:

  1. Call the /goods_nomenclatures/{id} endpoint with the as_of date and filter.geographical_area_id (use a 2-letter country code like GB, US, etc.).
  2. Extract applicable_category_assessments & descendant_category_assessments from the response.
  3. For each assessment:
    • If the trader holds any exemption listed under exemptions, ignore it and treat as Category 3.
    • Otherwise, use the category field (typically 1 or 2.
  4. Select the lowest remaining category (most restrictive).
    • If all assessments are exempted or none returned, assign Category 3.
    • If the API call fails, handle gracefully (e.g., display error or mark as uncategorised).

Instructions for requesting an API Key

Prepare Your Details:

Before requesting an API key, ensure you have the following information:

  • Your company’s name
  • Your EORI (Economic Operators Registration and Identification) number
  • A valid contact email address
  • Confirmation of your UKIMS (UK Integrated Tariff System) authorisation status
Fill in the Template:

Replace the placeholder text in the template with your actual information:

  • Insert your company name where it says [Your Company Name]
  • Provide your EORI number where it says [Your EORI Number]
  • Use your contact email in place of [Your Contact Email]
  • Confirm your UKIMS authorisation where indicated.
Send the Email:

Send the completed email to hmrc-trade-tariff-support-g@digital.hmrc.gov.uk.

E-mail template:

Glossary

Term Definition
EU Market

EU customs territory

Single Market


The customs territory of the EU. The nations/territories where the EU has control of what goes in (and out?). EU trade rules apply throughout the UCC
NI Northern Ireland
SPIMM Simplified Process for Internal Market Movements - The post-EU Exit system designed to ease trade between Great Britain and Northern Ireland by reducing customs checks and paperwork.
XI The two-letter code used in trade tariffs to represent Northern Ireland, which operates under a dual tariff system involving both UK and EU rules.
UKIMS UK Internal Market Scheme - A system that allows traders to move goods from Great Britain to Northern Ireland under simplified customs procedures, provided they meet eligibility requirements.
Category A classification system under the Windsor Framework: Category 1 (not eligible for SPIMM), Category 2 (eligible for SPIMM with additional reporting requirements), and ‘Standard Goods’ (eligible for SPIMM with minimal reporting).
Category Assessment (CA) A determination of whether a trade may fall under one of the rules in Annex IV of the Windsor Framework.
Theme A data point uniquely created for this API to establish a connection between categorisation assessments and the relevant provisions in Annex IV of the Windsor Framework. While a categorisation assessment is determined by a combination of Regulation ID and Measure, the “theme” data point was introduced to link this combination to the appropriate line item in Annex IV. The theme numbering follows the structure of Annex IV, beginning with 1.1 and ending with 2.26. The first part of the theme represents the category (1 or 2), while the second part corresponds to the specific legislative provision in Annex IV that the category assessment relates to.
Goods Nomenclature (GN) A structured classification system for goods in the tariff, ranging from broad categories (e.g., “live animals”) to highly specific product classifications.
Exemption A certificate or additional code or pseudo-exemption that allows a trade to bypass certain regulatory requirements under SPIMM, effectively nullifying the impact of a Category Assessment.
Pseudo Measures Custom-defined regulatory data points that mimic official tariff measures, used when no official EU measures exist for certain SPIMM rules (e.g.: excise)
Measure Measures are the building blocks of any trade tariff. They link everything together. Any law that has an effect on the trade of goods becomes one or more measures. You can read more about them in the data manual: https://uktrade.github.io/tariff-data-manual/documentation/data-structures/measures.html#measures (opens in new tab)
Regulation Every measure entered into the tariff database must be associated with a regulation, i.e. a piece of legislation.

This is so there’s a ‘legal base’ for all tariff and regulatory activity. Without this, measures cannot be traced back to why they were created.

You can read more about them in the data manual : https://uktrade.github.io/tariff-data-manual/documentation/data-structures/regulations.html#regulations (opens in new tab)

GET /green_lanes/goods_nomenclatures/{id}

Returns the requested Goods Nomenclature together with relevant data including a list of the different Category Assessments applicable to this Goods Nomenclature

Each applicable Category Assessment will provide a primary category together with any potential exemptions. If at least one of the exemptions for that Category Assessment are met then that Category Assessment does not apply.

The effective category for the GoodsNomenclature is the most restrictive category from those Category Assessments determined by the API consumers filtering to be applicable (ie not exempted).

If no Category Assessments are applicable, or all if applicable Category Assessments are exempted, then the trade falls under a default category assessment of Category 3.

To perform this operation, you must be authenticated by means of one of the following methods: apiKey

Parameters

Parameter In Type Required Description
id path string true Item Id of the Goods Nomenclature you are requesting Category Assessments information for. This is the full 10 digit item ID of either a Subheading or Commodity. Valid input IDs can be provided in 4, 6, 8, or 10 significant digits, depending on the level of detail available in the XI Tariff. If your input ID is shorter than 10 digits (e.g., 4, 6, or 8 digits), it will be automatically padded with trailing zeros to reach the full 10-digit format. For example, an ID of 1234 would be processed as 1234000000.
as_of query string(date) false Returns the category assessments across all commodities as they existed on the as_of date. Use the format YYYY-MM-DD While as_of is not a required field it is advised to include it with all requests even if requesting data for today to ensure the data returned is correct.
filter.geographical_area_id query string false This parameter can be used to filter down for the origin of your goods. Without passing a value for this parameter, the API will return the potentially applicable CAs for all the origins. To better understand this data point, please consult the data manual : https://uktrade.github.io/tariff-data-manual/documentation/data-structures/geographical-areas.html (opens in new tab).

Example Request

curl -H "X-Api-Key: a1b2c3defg4567" \
  -H "Accept: application/vnd.hmrc.2.0+json" \
  https://www.trade-tariff.service.gov.uk/xi/api/green_lanes/goods_nomenclatures/0712909000

curl -H "X-Api-Key: a1b2c3defg4567" \
  -H "Accept: application/vnd.hmrc.2.0+json" \
  https://www.trade-tariff.service.gov.uk/xi/api/green_lanes/goods_nomenclatures/0712909000?as_of=2024-01-01

curl -H "X-Api-Key: a1b2c3defg4567" \
  -H "Accept: application/vnd.hmrc.2.0+json" \
  "https://www.trade-tariff.service.gov.uk/xi/api/green_lanes/goods_nomenclatures/0712909000?filter.geographical_area_id=US"

curl -H "X-Api-Key: a1b2c3defg4567" \
  -H "Accept: application/vnd.hmrc.2.0+json" \
  "https://www.trade-tariff.service.gov.uk/xi/api/green_lanes/goods_nomenclatures/0712909000?as_of=2024-01-01&filter.geographical_area_id=US"

Example Response

{
  "data": {
    "id": "106662",
    "type": "goods_nomenclature",
    "attributes": {
      "goods_nomenclature_item_id": "2404120000",
      "parent_sid": "106659",
      "description": "Other, containing nicotine",
      "number_indents": 2,
      "productline_suffix": "80",
      "validity_start_date": "2022-01-01T00:00:00.000Z",
      "validity_end_date": null,
      "supplementary_measure_unit": "1000 items (1000 p/st)"
    },
    "relationships": {
      "applicable_category_assessments": {
        "data": [
          {
            "id": "123456cd",
            "type": "category_assessment"
          }
        ]
      },
      "descendant_category_assessments": {
        "data": [
          {
            "id": "abcd1234",
            "type": "category_assessment"
          },
          {
            "id": "c5678def",
            "type": "category_assessment"
          }
        ]
      },
      "ancestors": {
        "data": [
          {
            "id": "35246",
            "type": "goods_nomenclature"
          },
          {
            "id": "106659",
            "type": "goods_nomenclature"
          }
        ]
      },
      "descendants": {
        "data": [
          {
            "id": "106676",
            "type": "goods_nomenclature"
          },
          {
            "id": "107156",
            "type": "goods_nomenclature"
          }
        ]
      },
      "licences": {
        "data": [
          {
            "id": "L100",
            "type": "certificate"
          }
        ]
      }
    }
  },
  "included": [
    {
      "id": "123456cd",
      "type": "category_assessments",
      "relationships": {
        "geographical_area": {
          "data": {
            "id": "1011",
            "type": "geographical_area"
          }
        },
        "excluded_geographical_areas": {
          "data": []
        },
        "theme": {
          "data": {
            "id": "1.1",
            "type": "theme"
          }
        },
        "exemptions": {
          "data": [
            {
              "id": "Y069",
              "type": "certificate"
            }
          ]
        },
        "measures": {
          "data": [
            {
              "id": "3871194",
              "type": "measure"
            }
          ]
        },
        "measure_type": {
          "data": {
            "id": "714",
            "type": "measure_type"
          }
        },
        "regulation": {
          "data": {
            "id": "D1908540",
            "type": "legal_act"
          }
        }
      }
    },
    {
      "id": "abcd1234",
      "type": "category_assessments",
      "relationships": {
        "geographical_area": {
          "data": {
            "id": "1011",
            "type": "geographical_area"
          }
        },
        "excluded_geographical_areas": {
          "data": []
        },
        "theme": {
          "data": {
            "id": "2.1",
            "type": "theme"
          }
        },
        "exemptions": {
          "data": [
            {
              "id": "L135",
              "type": "certificate"
            },
            {
              "id": "3200",
              "type": "additional_code"
            }
          ]
        },
        "measures": [
          {
            "data": [
              {
                "id": "3871192",
                "type": "measure"
              }
            ]
          },
          {
            "data": [
              {
                "id": "3871247",
                "type": "measure"
              }
            ]
          }
        ],
        "measure_type": {
          "data": {
            "id": "475",
            "type": "measure_type"
          }
        },
        "regulation": {
          "data": {
            "id": "D1908540",
            "type": "legal_act"
          }
        }
      }
    },
    {
      "id": "c5678def",
      "type": "category_assessment",
      "relationships": {
        "geographical_area": {
          "data": {
            "id": "1011",
            "type": "geographical_area"
          }
        },
        "excluded_geographical_areas": {
          "data": []
        },
        "theme": {
          "data": {
            "id": "2.1",
            "type": "theme"
          }
        },
        "exemptions": [
          {
            "id": "3200",
            "type": "additional_code"
          },
          {
            "id": "3249",
            "type": "additional_code"
          }
        ],
        "measures": [
          {
            "data": [
              {
                "id": "3871193",
                "type": "measure"
              },
              {
                "id": "3871248",
                "type": "measure"
              }
            ]
          }
        ],
        "measure_type": {
          "data": {
            "id": "475",
            "type": "measure_type"
          }
        },
        "regulation": {
          "data": {
            "id": "D1908540",
            "type": "legal_act"
          }
        }
      }
    },
    {
      "id": "1011",
      "type": "geographical_area",
      "attributes": {
        "description": "ERGA OMNES",
        "geographical_area_id": "1011"
      }
    },
    {
      "id": "1.1",
      "type": "theme",
      "attributes": {
        "theme": "Sanctions",
        "category": 1
      }
    },
    {
      "id": "2.1",
      "type": "theme",
      "attributes": {
        "theme": "Drug precursors",
        "category": 2
      }
    },
    {
      "id": "L135",
      "type": "certificate",
      "attributes": {
        "certificate_type_code": "L",
        "certificate_code": "135",
        "code": "L135",
        "description": "Import authorisation (precursors) issued by the competent authorities of the Member State where the importer is established",
        "formatted_description": "Import authorisation (precursors) issued by the competent authorities of the Member State where the importer is established"
      }
    },
    {
      "id": "3200",
      "type": "additional_code",
      "attributes": {
        "additional_code_type_id": "3",
        "additional_code": "200",
        "code": "3200",
        "description": "Mixtures of scheduled substances listed in the Annex to Regulation (EC) No 111/2005 that can be used for the illicit manufacture of narcotic drugs or psychotropic substances",
        "formatted_description": "Mixtures of scheduled substances listed in the Annex to Regulation (EC) No 111/2005 that can be used for the illicit manufacture of narcotic drugs or psychotropic substances"
      }
    },
    {
      "id": "Y069",
      "type": "certificate",
      "attributes": {
        "certificate_type_code": "Y",
        "certificate_code": "069",
        "code": "Y069",
        "description": "Goods not consigned from Iran",
        "formatted_description": "Goods not consigned from Iran"
      }
    },
    {
      "id": "3871194",
      "type": "measure",
      "attributes": {
        "goods_nomenclature_item_id": "2404120000",
        "goods_nomenclature_sid": "106662",
        "effective_start_date": "2022-01-01T00:00:00.000Z",
        "effective_end_date": null
      }
    },
    {
      "id": "3871192",
      "type": "measure",
      "attributes": {
        "goods_nomenclature_item_id": "2404120010",
        "goods_nomenclature_sid": "106676",
        "effective_start_date": "2022-01-01T00:00:00.000Z",
        "effective_end_date": null
      },
      "relationships": {
        "footnotes": {
          "data": [
            {
              "id": "CD437",
              "type": "footnote"
            }
          ]
        }
      }
    },
    {
      "id": "3871193",
      "type": "measure",
      "attributes": {
        "goods_nomenclature_item_id": "2404120010",
        "goods_nomenclature_sid": "106676",
        "effective_start_date": "2022-01-01T00:00:00.000Z",
        "effective_end_date": null
      },
      "relationships": {
        "footnotes": {
          "data": [
            {
              "id": "TM135",
              "type": "footnote"
            }
          ]
        }
      }
    },
    {
      "id": "3871247",
      "type": "measure",
      "attributes": {
        "goods_nomenclature_item_id": "2404120090",
        "goods_nomenclature_sid": "107156",
        "effective_start_date": "2022-01-01T00:00:00.000Z",
        "effective_end_date": null
      },
      "relationships": {
        "footnotes": {
          "data": [
            {
              "id": "CD437",
              "type": "footnote"
            },
            {
              "id": "TM135",
              "type": "footnote"
            }
          ]
        }
      }
    },
    {
      "id": "3871248",
      "type": "measure",
      "attributes": {
        "effective_start_date": "2022-01-01T00:00:00.000Z",
        "effective_end_date": null
      },
      "relationships": {
        "footnotes": {
          "data": [
            {
              "id": "TM135",
              "type": "footnote"
            }
          ]
        }
      }
    },
    {
      "id": "35246",
      "type": "goods_nomenclature",
      "attributes": {
        "goods_nomenclature_item_id": "2400000000",
        "parent_sid": null,
        "description": "Tobacco and manufactured tobacco substitutes; products, whether or not containing nicotine, intended for inhalation without combustion; other nicotine containing products intended for the intake of nicotine into the human body",
        "number_indents": 0,
        "productline_suffix": "80",
        "validity_start_date": "1971-12-31T00:00:00.000Z",
        "validity_end_date": null,
        "supplementary_measure_unit": null
      },
      "relationships": {
        "licences": {
          "data": []
        }
      }
    },
    {
      "id": "106659",
      "type": "goods_nomenclature",
      "attributes": {
        "goods_nomenclature_item_id": "2404000000",
        "parent_sid": 35246,
        "description": "Products containing tobacco, reconstituted tobacco, nicotine, or tobacco or nicotine substitutes, intended for inhalation without combustion; other nicotine containing products intended for the intake of nicotine into the human body",
        "number_indents": 0,
        "productline_suffix": "80",
        "validity_start_date": "2022-01-01T00:00:00.000Z",
        "validity_end_date": null,
        "supplementary_measure_unit": null
      },
      "relationships": {
        "licences": {
          "data": []
        }
      }
    },
    {
      "id": "106676",
      "type": "goods_nomenclature",
      "attributes": {
        "goods_nomenclature_item_id": "2404120010",
        "parent_sid": 106662,
        "description": "Cartridges and refills, filled, for electronic cigarettes, preparations for use in cartridges and refills for electronic cigarettes",
        "number_indents": 3,
        "productline_suffix": "80",
        "validity_start_date": "2022-01-01T00:00:00.000Z",
        "validity_end_date": null,
        "supplementary_measure_unit": "1000 items (1000 p/st)"
      },
      "relationships": {
        "licences": {
          "data": []
        }
      }
    },
    {
      "id": "107156",
      "type": "goods_nomenclature",
      "attributes": {
        "goods_nomenclature_item_id": "2404120090",
        "parent_sid": 106662,
        "description": "Other",
        "number_indents": 3,
        "productline_suffix": "80",
        "validity_start_date": "2022-01-01T00:00:00.000Z",
        "validity_end_date": null,
        "supplementary_measure_unit": "1000 items (1000 p/st)"
      },
      "relationships": {
        "licences": {
          "data": []
        }
      }
    },
    {
      "id": "475",
      "type": "measure_type",
      "attributes": {
        "description": "Restriction on entry into free circulation",
        "measure_type_series_description": "Entry into free circulation or exportation subject to conditions",
        "validity_start_date": "1972-01-01T00:00:00.000Z",
        "validity_end_date": null,
        "measure_type_series_id": "B",
        "trade_movement_code": 0
      }
    },
    {
      "id": "714",
      "type": "measure_type",
      "attributes": {
        "description": "Import control",
        "measure_type_series_description": "Entry into free circulation or exportation subject to conditions",
        "validity_start_date": "2017-02-01 00:00:00.000",
        "validity_end_date": null,
        "measure_type_series_id": "B",
        "trade_movement_code": 0
      }
    },
    {
      "id": "CD437",
      "type": "footnote",
      "attributes": {
        "code": "CD437",
        "description": "\"Import authorization\" and \"Specific import requirements\" - see Articles 20-25 of Regulation (EC) No 111/05 (OJ L 22) implemented by Regulation (EC) No 2015/1011 (OJ L 162)."
      }
    },
    {
      "id": "TM135",
      "type": "footnote",
      "attributes": {
        "code": "TM135",
        "description": "The surveillance does not apply to mixtures and natural products which contain scheduled substances and which are compounded in such a way that the scheduled substances cannot be easily used or extracted by readily applicable or economically viable means, to medicinal products as defined in point 2 of Article 1 of Directive 2001/83/EC of the European Parliament and of the Council and to veterinary medicinal products as defined in point 2 of Article 1 of Directive 2001/82/EC of the European Parliament and of the Council."
      }
    },
    {
      "id": "L100",
      "type": "certificate",
      "attributes": {
        "certificate_type_code": "L",
        "certificate_code": "100",
        "code": "L100",
        "description": "Import licence \"controlled substances\" (ozone), issued by the Commission",
        "formatted_description": "Import licence \"controlled substances\" (ozone), issued by the Commission"
      }
    },
    {
      "id": "D1908540",
      "type": "legal_act",
      "attributes": {
        "validity_start_date": "2019-09-20T00:00:00.000Z",
        "validity_end_date": null,
        "officialjournal_number": "L 147",
        "officialjournal_page": 1,
        "published_date": "2019-06-05",
        "regulation_code": "D0854/19",
        "regulation_url": "http://eur-lex.europa.eu/search.html?whOJ=NO_OJ%3D147,YEAR_OJ%3D2019,PAGE_FIRST%3D0001&DB_COLL_OJ=oj-l&type=advanced&lang=en",
        "description": null
      }
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK A GoodsNomenclature and a list of Category Assessments GoodsNomenclature
401 Unauthorized Authorization header is missing or contains an invalid token None
404 Not Found Unknown goods nomenclature item id None
422 Unprocessable Entity Likely to be missing or incorrect params None
5xx Server Error Unexpected error, something went wrong internally None

GET /green_lanes/themes

Returns a list of the all Categorisation themes within the Windsor Framework

To perform this operation, you must be authenticated by means of one of the following methods: apiKey

Example Request

curl -H "X-Api-Key: a1b2c3defg4567" \
  -H "Accept: application/vnd.hmrc.2.0+json" \
  https://www.trade-tariff.service.gov.uk/xi/api/green_lanes/themes

Example Response

Status Meaning Description Schema
200 OK An array of Themes Themes
401 Unauthorized Authorization header is missing or contains an invalid token None
5xx Server Error Unexpected error, something went wrong internally None

Objects

GoodsNomenclature

The full list of products in the UK Tariff is called the ‘goods classification’. Sometimes it is also referred to as the ‘goods nomenclature’ or ‘nomenclature’. Commodity codes classify goods for import and export. You can read more about them in the data manual : https://uktrade.github.io/tariff-data-manual/documentation/data-structures/commodity-codes.html#commodity-codes (opens in new tab).

For the purposes of this API, a Goods Nomenclature object is defined as per the below:

A goods_nomenclature object

%3<!– Applicable\nCAs –>Applicable\nCAsApplicableCAs<!– Category\nAssessment –>Category\nAssessmentCategoryAssessment<!– Applicable\nCAs->Category\nAssessment –>Applicable\nCAsCategory\nAssessment<!– Category\nAssessment 2 –>Category\nAssessment 2CategoryAssessment 2<!– Applicable\nCAs->Category\nAssessment 2 –>Applicable\nCAsCategory\nAssessment 2<!– Descendants\nCAs –>Descendants\nCAsDescendantsCAs<!– Category\nAssessment 3 –>Category\nAssessment 3CategoryAssessment 3<!– Descendants\nCAs->Category\nAssessment 3 –>Descendants\nCAsCategory\nAssessment 3<!– Licences –>LicencesLicences<!– Licence\nCertificate –>Licence\nCertificateLicenceCertificate<!– Licences->Licence\nCertificate –>LicencesLicence\nCertificate<!– Descendants\nLicences –>Descendants\nLicencesDescendantsLicences<!– Descendants\nLicences->Licence\nCertificate –>Descendants\nLicencesLicence\nCertificate<!– Licence\nCertificate 2 –>Licence\nCertificate 2LicenceCertificate 2<!– Descendants\nLicences->Licence\nCertificate 2 –>Descendants\nLicencesLicence\nCertificate 2<!– Ancestors –>AncestorsAncestors<!– Chapter GN –>Chapter GNChapter GN<!– Ancestors->Chapter GN –>AncestorsChapter GN<!– Heading GN –>Heading GNHeading GN<!– Ancestors->Heading GN –>AncestorsHeading GN<!– Descendants –>DescendantsDescendants<!– Commodity GN 1 –>Commodity GN 1Commodity GN 1<!– Descendants->Commodity GN 1 –>DescendantsCommodity GN 1<!– Commodity GN 2 –>Commodity GN 2Commodity GN 2<!– Descendants->Commodity GN 2 –>DescendantsCommodity GN 2<!– Goods\nNomenclature –>Goods\nNomenclatureGoodsNomenclature<!– Goods\nNomenclature->Applicable\nCAs –>Goods\nNomenclatureApplicable\nCAs<!– Goods\nNomenclature->Descendants\nCAs –>Goods\nNomenclatureDescendants\nCAs<!– Goods\nNomenclature->Licences –>Goods\nNomenclatureLicences<!– Goods\nNomenclature->Ancestors –>Goods\nNomenclatureAncestors<!– Goods\nNomenclature->Descendants –>Goods\nNomenclatureDescendants<!– Measure –>MeasureMeasure<!– Category\nAssessment->Measure –>Category\nAssessmentMeasure<!– Measure 2 –>Measure 2Measure 2<!– Category\nAssessment 2->Measure 2 –>Category\nAssessment 2Measure 2<!– Measure 3 –>Measure 3Measure 3<!– Category\nAssessment 3->Measure 3 –>Category\nAssessment 3Measure 3<!– Commodity GN 2->Descendants\nLicences –>Commodity GN 2Descendants\nLicences

Sample JSON
    
{
  "data": {
    "id": "106662",
    "type": "goods_nomenclature",
    "attributes": {
      "goods_nomenclature_item_id": "2404120000",
      "parent_sid": "106659",
      "description": "Other, containing nicotine",
      "number_indents": 2,
      "productline_suffix": "80",
      "validity_start_date": "2022-01-01T00:00:00.000Z",
      "validity_end_date": null,
      "supplementary_measure_unit": "1000 items (1000 p/st)"
    },
    "relationships": {
      "applicable_category_assessments": {
        "data": [
          {
            "id": "123456cd",
            "type": "category_assessment"
          }
        ]
      },
      "descendant_category_assessments": {
        "data": [
          {
            "id": "abcd1234",
            "type": "category_assessment"
          },
          {
            "id": "c5678def",
            "type": "category_assessment"
          }
        ]
      },
      "ancestors": {
        "data": [
          {
            "id": "35246",
            "type": "goods_nomenclature"
          },
          {
            "id": "106659",
            "type": "goods_nomenclature"
          }
        ]
      },
      "descendants": {
        "data": [
          {
            "id": "106676",
            "type": "goods_nomenclature"
          },
          {
            "id": "107156",
            "type": "goods_nomenclature"
          }
        ]
      },
      "licences": {
        "data": [
          {
            "id": "L100",
            "type": "certificate"
          }
        ]
      }
    }
  },
  "included": [
    {
      "id": "123456cd",
      "type": "category_assessments",
      "relationships": {
        "geographical_area": {
          "data": {
            "id": "1011",
            "type": "geographical_area"
          }
        },
        "excluded_geographical_areas": {
          "data": []
        },
        "theme": {
          "data": {
            "id": "1.1",
            "type": "theme"
          }
        },
        "exemptions": {
          "data": [
            {
              "id": "Y069",
              "type": "certificate"
            }
          ]
        },
        "measures": {
          "data": [
            {
              "id": "3871194",
              "type": "measure"
            }
          ]
        },
        "measure_type": {
          "data": {
            "id": "714",
            "type": "measure_type"
          }
        },
        "regulation": {
          "data": {
            "id": "D1908540",
            "type": "legal_act"
          }
        }
      }
    },
    {
      "id": "abcd1234",
      "type": "category_assessments",
      "relationships": {
        "geographical_area": {
          "data": {
            "id": "1011",
            "type": "geographical_area"
          }
        },
        "excluded_geographical_areas": {
          "data": []
        },
        "theme": {
          "data": {
            "id": "2.1",
            "type": "theme"
          }
        },
        "exemptions": {
          "data": [
            {
              "id": "L135",
              "type": "certificate"
            },
            {
              "id": "3200",
              "type": "additional_code"
            }
          ]
        },
        "measures": [
          {
            "data": [
              {
                "id": "3871192",
                "type": "measure"
              }
            ]
          },
          {
            "data": [
              {
                "id": "3871247",
                "type": "measure"
              }
            ]
          }
        ],
        "measure_type": {
          "data": {
            "id": "475",
            "type": "measure_type"
          }
        },
        "regulation": {
          "data": {
            "id": "D1908540",
            "type": "legal_act"
          }
        }
      }
    },
    {
      "id": "c5678def",
      "type": "category_assessment",
      "relationships": {
        "geographical_area": {
          "data": {
            "id": "1011",
            "type": "geographical_area"
          }
        },
        "excluded_geographical_areas": {
          "data": []
        },
        "theme": {
          "data": {
            "id": "2.1",
            "type": "theme"
          }
        },
        "exemptions": [
          {
            "id": "3200",
            "type": "additional_code"
          },
          {
            "id": "3249",
            "type": "additional_code"
          }
        ],
        "measures": [
          {
            "data": [
              {
                "id": "3871193",
                "type": "measure"
              },
              {
                "id": "3871248",
                "type": "measure"
              }
            ]
          }
        ],
        "measure_type": {
          "data": {
            "id": "475",
            "type": "measure_type"
          }
        },
        "regulation": {
          "data": {
            "id": "D1908540",
            "type": "legal_act"
          }
        }
      }
    },
    {
      "id": "1011",
      "type": "geographical_area",
      "attributes": {
        "description": "ERGA OMNES",
        "geographical_area_id": "1011"
      }
    },
    {
      "id": "1.1",
      "type": "theme",
      "attributes": {
        "theme": "Sanctions",
        "category": 1
      }
    },
    {
      "id": "2.1",
      "type": "theme",
      "attributes": {
        "theme": "Drug precursors",
        "category": 2
      }
    },
    {
      "id": "L135",
      "type": "certificate",
      "attributes": {
        "certificate_type_code": "L",
        "certificate_code": "135",
        "code": "L135",
        "description": "Import authorisation (precursors) issued by the competent authorities of the Member State where the importer is established",
        "formatted_description": "Import authorisation (precursors) issued by the competent authorities of the Member State where the importer is established"
      }
    },
    {
      "id": "3200",
      "type": "additional_code",
      "attributes": {
        "additional_code_type_id": "3",
        "additional_code": "200",
        "code": "3200",
        "description": "Mixtures of scheduled substances listed in the Annex to Regulation (EC) No 111/2005 that can be used for the illicit manufacture of narcotic drugs or psychotropic substances",
        "formatted_description": "Mixtures of scheduled substances listed in the Annex to Regulation (EC) No 111/2005 that can be used for the illicit manufacture of narcotic drugs or psychotropic substances"
      }
    },
    {
      "id": "Y069",
      "type": "certificate",
      "attributes": {
        "certificate_type_code": "Y",
        "certificate_code": "069",
        "code": "Y069",
        "description": "Goods not consigned from Iran",
        "formatted_description": "Goods not consigned from Iran"
      }
    },
    {
      "id": "3871194",
      "type": "measure",
      "attributes": {
        "goods_nomenclature_item_id": "2404120000",
        "goods_nomenclature_sid": "106662",
        "effective_start_date": "2022-01-01T00:00:00.000Z",
        "effective_end_date": null
      }
    },
    {
      "id": "3871192",
      "type": "measure",
      "attributes": {
        "goods_nomenclature_item_id": "2404120010",
        "goods_nomenclature_sid": "106676",
        "effective_start_date": "2022-01-01T00:00:00.000Z",
        "effective_end_date": null
      },
      "relationships": {
        "footnotes": {
          "data": [
            {
              "id": "CD437",
              "type": "footnote"
            }
          ]
        }
      }
    },
    {
      "id": "3871193",
      "type": "measure",
      "attributes": {
        "goods_nomenclature_item_id": "2404120010",
        "goods_nomenclature_sid": "106676",
        "effective_start_date": "2022-01-01T00:00:00.000Z",
        "effective_end_date": null
      },
      "relationships": {
        "footnotes": {
          "data": [
            {
              "id": "TM135",
              "type": "footnote"
            }
          ]
        }
      }
    },
    {
      "id": "3871247",
      "type": "measure",
      "attributes": {
        "goods_nomenclature_item_id": "2404120090",
        "goods_nomenclature_sid": "107156",
        "effective_start_date": "2022-01-01T00:00:00.000Z",
        "effective_end_date": null
      },
      "relationships": {
        "footnotes": {
          "data": [
            {
              "id": "CD437",
              "type": "footnote"
            },
            {
              "id": "TM135",
              "type": "footnote"
            }
          ]
        }
      }
    },
    {
      "id": "3871248",
      "type": "measure",
      "attributes": {
        "effective_start_date": "2022-01-01T00:00:00.000Z",
        "effective_end_date": null
      },
      "relationships": {
        "footnotes": {
          "data": [
            {
              "id": "TM135",
              "type": "footnote"
            }
          ]
        }
      }
    },
    {
      "id": "35246",
      "type": "goods_nomenclature",
      "attributes": {
        "goods_nomenclature_item_id": "2400000000",
        "parent_sid": null,
        "description": "Tobacco and manufactured tobacco substitutes; products, whether or not containing nicotine, intended for inhalation without combustion; other nicotine containing products intended for the intake of nicotine into the human body",
        "number_indents": 0,
        "productline_suffix": "80",
        "validity_start_date": "1971-12-31T00:00:00.000Z",
        "validity_end_date": null,
        "supplementary_measure_unit": null
      },
      "relationships": {
        "licences": {
          "data": []
        }
      }
    },
    {
      "id": "106659",
      "type": "goods_nomenclature",
      "attributes": {
        "goods_nomenclature_item_id": "2404000000",
        "parent_sid": 35246,
        "description": "Products containing tobacco, reconstituted tobacco, nicotine, or tobacco or nicotine substitutes, intended for inhalation without combustion; other nicotine containing products intended for the intake of nicotine into the human body",
        "number_indents": 0,
        "productline_suffix": "80",
        "validity_start_date": "2022-01-01T00:00:00.000Z",
        "validity_end_date": null,
        "supplementary_measure_unit": null
      },
      "relationships": {
        "licences": {
          "data": []
        }
      }
    },
    {
      "id": "106676",
      "type": "goods_nomenclature",
      "attributes": {
        "goods_nomenclature_item_id": "2404120010",
        "parent_sid": 106662,
        "description": "Cartridges and refills, filled, for electronic cigarettes, preparations for use in cartridges and refills for electronic cigarettes",
        "number_indents": 3,
        "productline_suffix": "80",
        "validity_start_date": "2022-01-01T00:00:00.000Z",
        "validity_end_date": null,
        "supplementary_measure_unit": "1000 items (1000 p/st)"
      },
      "relationships": {
        "licences": {
          "data": []
        }
      }
    },
    {
      "id": "107156",
      "type": "goods_nomenclature",
      "attributes": {
        "goods_nomenclature_item_id": "2404120090",
        "parent_sid": 106662,
        "description": "Other",
        "number_indents": 3,
        "productline_suffix": "80",
        "validity_start_date": "2022-01-01T00:00:00.000Z",
        "validity_end_date": null,
        "supplementary_measure_unit": "1000 items (1000 p/st)"
      },
      "relationships": {
        "licences": {
          "data": []
        }
      }
    },
    {
      "id": "475",
      "type": "measure_type",
      "attributes": {
        "description": "Restriction on entry into free circulation",
        "measure_type_series_description": "Entry into free circulation or exportation subject to conditions",
        "validity_start_date": "1972-01-01T00:00:00.000Z",
        "validity_end_date": null,
        "measure_type_series_id": "B",
        "trade_movement_code": 0
      }
    },
    {
      "id": "714",
      "type": "measure_type",
      "attributes": {
        "description": "Import control",
        "measure_type_series_description": "Entry into free circulation or exportation subject to conditions",
        "validity_start_date": "2017-02-01 00:00:00.000",
        "validity_end_date": null,
        "measure_type_series_id": "B",
        "trade_movement_code": 0
      }
    },
    {
      "id": "CD437",
      "type": "footnote",
      "attributes": {
        "code": "CD437",
        "description": "\"Import authorization\" and \"Specific import requirements\" - see Articles 20-25 of Regulation (EC) No 111/05 (OJ L 22) implemented by Regulation (EC) No 2015/1011 (OJ L 162)."
      }
    },
    {
      "id": "TM135",
      "type": "footnote",
      "attributes": {
        "code": "TM135",
        "description": "The surveillance does not apply to mixtures and natural products which contain scheduled substances and which are compounded in such a way that the scheduled substances cannot be easily used or extracted by readily applicable or economically viable means, to medicinal products as defined in point 2 of Article 1 of Directive 2001/83/EC of the European Parliament and of the Council and to veterinary medicinal products as defined in point 2 of Article 1 of Directive 2001/82/EC of the European Parliament and of the Council."
      }
    },
    {
      "id": "L100",
      "type": "certificate",
      "attributes": {
        "certificate_type_code": "L",
        "certificate_code": "100",
        "code": "L100",
        "description": "Import licence \"controlled substances\" (ozone), issued by the Commission",
        "formatted_description": "Import licence \"controlled substances\" (ozone), issued by the Commission"
      }
    },
    {
      "id": "D1908540",
      "type": "legal_act",
      "attributes": {
        "validity_start_date": "2019-09-20T00:00:00.000Z",
        "validity_end_date": null,
        "officialjournal_number": "L 147",
        "officialjournal_page": 1,
        "published_date": "2019-06-05",
        "regulation_code": "D0854/19",
        "regulation_url": "http://eur-lex.europa.eu/search.html?whOJ=NO_OJ%3D147,YEAR_OJ%3D2019,PAGE_FIRST%3D0001&DB_COLL_OJ=oj-l&type=advanced&lang=en",
        "description": null
      }
    }
  ]
}
    
  

Fields

Name Type Required Description
id string true The unique id for this revision of this Goods Nomenclature
goods_nomenclature_item_id string true The goods_nomenclature_item_id of this Goods Nomenclature
parent_sid string true The goods_nomenclature_sid of the Goods Nomenclature this GoodsNomenclature sits directly below in the Tariff
description string true The description of the goods nomenclature
number_indents integer true The indentation of the goods nomenclature within the Tariff hierarchy
productline_suffix string true The productline_suffix of the goods nomenclature
validity_start_date string(date-time) true The date this Goods Nomenclature is valid from
validity_end_date string(date-time) true The date this Goods Nomenclature is valid until, null if valid indefinitely
supplementary_measure_unit string false The supplementary measure unit applicable to this GoodsNomenclature, if one is applicable
applicable_category_assessments [CategoryAssessment] false A list of applicable Category Assessments for this Goods Nomenclature
descendant_category_assessments [CategoryAssessment] false A list of Category Assessments which apply only to some descendants, so require further classification to determine their applicability
ancestors [ReferencedGoodsNomenclature] false List of GoodsNomenclatures above the requested Goods Nomenclature in the Tariff, ordered by Chapter first
descendants [ReferencedGoodsNomenclature] false List of GoodsNomenclatures below the requested one in the Tariff, ordered by Goods Nomenclature Item Id
licences [Certificate] false List of licences applicable to this GoodsNomenclature

CategoryAssessment

A CategoryAssessment for the requested GoodsNomenclature

%3<!– Excluded\nGeo Areas –>Excluded\nGeo AreasExcludedGeo Areas<!– Geographical\nArea 2 –>Geographical\nArea 2GeographicalArea 2<!– Excluded\nGeo Areas->Geographical\nArea 2 –>Excluded\nGeo AreasGeographical\nArea 2<!– Geographical\nArea 3 –>Geographical\nArea 3GeographicalArea 3<!– Excluded\nGeo Areas->Geographical\nArea 3 –>Excluded\nGeo AreasGeographical\nArea 3<!– Exemptions –>ExemptionsExemptions<!– Certificate –>CertificateCertificate<!– Exemptions->Certificate –>ExemptionsCertificate<!– Exemption –>ExemptionExemption<!– Exemptions->Exemption –>ExemptionsExemption<!– Certificate 2 –>Certificate 2Certificate 2<!– Exemptions->Certificate 2 –>ExemptionsCertificate 2<!– Additional Code –>Additional CodeAdditional Code<!– Exemptions->Additional Code –>ExemptionsAdditional Code<!– Measures –>MeasuresMeasures<!– Measure 1 –>Measure 1Measure 1<!– Measures->Measure 1 –>MeasuresMeasure 1<!– Footnotes –>FootnotesFootnotes<!– Footnote 1 –>Footnote 1Footnote 1<!– Footnotes->Footnote 1 –>FootnotesFootnote 1<!– Footnote 2 –>Footnote 2Footnote 2<!– Footnotes->Footnote 2 –>FootnotesFootnote 2<!– Category\nAssessment –>Category\nAssessmentCategoryAssessment<!– Category\nAssessment->Excluded\nGeo Areas –>Category\nAssessmentExcluded\nGeo Areas<!– Category\nAssessment->Exemptions –>Category\nAssessmentExemptions<!– Category\nAssessment->Measures –>Category\nAssessmentMeasures<!– Geographical\nArea –>Geographical\nAreaGeographicalArea<!– Category\nAssessment->Geographical\nArea –>Category\nAssessmentGeographical\nArea<!– Theme –>ThemeTheme<!– Category\nAssessment->Theme –>Category\nAssessmentTheme<!– MeasureType –>MeasureTypeMeasureType<!– Category\nAssessment->MeasureType –>Category\nAssessmentMeasureType<!– Regulation –>RegulationRegulation<!– Category\nAssessment->Regulation –>Category\nAssessmentRegulation<!– Measure 1->Footnotes –>Measure 1Footnotes

Sample JSON
    
{
  "data": {
    "id": "abcd1234",
    "type": "category_assessment",
    "relationships": {
      "geographical_area": {
        "data": {
          "id": "1011",
          "type": "geographical_area"
        }
      },
      "excluded_geographical_areas": {
        "data": []
      },
      "theme": {
        "data": {
          "id": "2.1",
          "type": "theme"
        }
      },
      "exemptions": {
        "data": [
          {
            "id": "L135",
            "type": "certificate"
          },
          {
            "id": "3200",
            "type": "additional_code"
          },
          {
            "id": "WFE001",
            "type": "exemption"
          }
        ]
      },
      "measure_type": {
        "data": {
          "id": "475",
          "type": "measure_type"
        }
      },
      "regulation": {
        "data": {
          "id": "D1908540",
          "type": "legal_act"
        }
      }
    }
  },
  "included": [
    {
      "id": "1011",
      "type": "geographical_area",
      "attributes": {
        "description": "ERGA OMNES",
        "geographical_area_id": "1011"
      }
    },
    {
      "id": "2.1",
      "type": "theme",
      "attributes": {
        "theme": "Drug precursors",
        "category": 2
      }
    },
    {
      "id": "L135",
      "type": "certificate",
      "attributes": {
        "certificate_type_code": "L",
        "certificate_code": "135",
        "code": "L135",
        "description": "Import authorisation (precursors) issued by the competent authorities of the Member State where the importer is established",
        "formatted_description": "Import authorisation (precursors) issued by the competent authorities of the Member State where the importer is established"
      }
    },
    {
      "id": "3200",
      "type": "additional_code",
      "attributes": {
        "additional_code_type_id": "3",
        "additional_code": "200",
        "code": "3200",
        "description": "Mixtures of scheduled substances listed in the Annex to Regulation (EC) No 111/2005 that can be used for the illicit manufacture of narcotic drugs or psychotropic substances",
        "formatted_description": "Mixtures of scheduled substances listed in the Annex to Regulation (EC) No 111/2005 that can be used for the illicit manufacture of narcotic drugs or psychotropic substances"
      }
    },
    {
      "id": "WFE001",
      "type": "exemption",
      "attributes": {
        "code": "WFE001",
        "description": "Seed potatoes of a particular variety",
        "formatted_description": "Seed potatoes of a particular variety"
      }
    },
    {
      "id": "475",
      "type": "measure_type",
      "attributes": {
        "description": "Restriction on entry into free circulation",
        "measure_type_series_description": "Entry into free circulation or exportation subject to conditions",
        "validity_start_date": "1972-01-01T00:00:00.000Z",
        "validity_end_date": null,
        "measure_type_series_id": "B",
        "trade_movement_code": 0
      }
    },
    {
      "id": "D1908540",
      "type": "legal_act",
      "attributes": {
        "validity_start_date": "2019-09-20T00:00:00.000Z",
        "validity_end_date": null,
        "officialjournal_number": "L 147",
        "officialjournal_page": 1,
        "published_date": "2019-06-05",
        "regulation_code": "D0854/19",
        "regulation_url": "http://eur-lex.europa.eu/search.html?whOJ=NO_OJ%3D147,YEAR_OJ%3D2019,PAGE_FIRST%3D0001&DB_COLL_OJ=oj-l&type=advanced&lang=en",
        "description": null
      }
    }
  ]
}
    
  

Fields

Name Type Required Description
id string true The unique identifier for this category assessement
category integer true The category applicable unless exemption criteria are met
theme Theme true The Categorisation Theme used as the basis for this Category Assessment
measure_type MeasureType true The Measure Type resulting in this Category Assessment
regulation LegalAct true The Regulation resulting in this Category Assessment
geographical_area GeographicalArea true The geographical area this Category Assessment applies to
excluded_geographical_areas [GeographicalArea] false The geographical areas excluded from this Category Assessment
exemptions [Unknown] false The Certificates or Additional Codes which when supplied exempt a Goods Nomenclature from this Category Assessment

NB: Polymorphic array of Certificate, AdditionalCode and Exemption objects
measures [Measure] false A list of Measures resulting in this CategoryAssessment

Theme

A Categorisation Theme within the Windsor Framework

Sample JSON
    
{
  "data": {
    "id": "1.1",
    "type": "theme",
    "attributes": {
      "theme": "Sanctions",
      "category": 1
    }
  }
}
    
  

Fields

Name Type Required Description
id string true The relevant section number for this Categorisation theme
theme string true Categorisation Theme
category integer true The category for the theme in the absence of an exemption

GeographicalArea

A GeographicalArea object

Sample JSON
    
{
  "data": {
    "id": "1011",
    "type": "geographical_area",
    "attributes": {
      "description": "ERGA OMNES",
      "geographical_area_id": "1011"
    }
  }
}
    
  

Fields

Name Type Required Description
id string true The id of this geographical area
description string true The description of the geographical area
geographical_area_id string true The geographical_area_id of the geographical area

Certificate

A Certificate object

Sample JSON
    
{
  "data": {
    "id": "D005",
    "type": "certificate",
    "attributes": {
      "certificate_type_code": "D",
      "certificate_code": "005",
      "code": "D005",
      "description": "Commercial invoice within the framework of undertakings",
      "formatted_description": "Commercial invoice within the framework of undertakings"
    }
  }
}
    
  

Fields

Name Type Required Description
id string true The unique identifier for this description
certificate_type_code string true The certificate_type_code for the certificate
certificate_code string true The certificate_code for the certificate
code string true The code identifying the Certificate - combination of certificate_type_code and certficate_code
description string true The description for the certificate
formatted_description string true A version of the description including html formatting tags

AdditionalCode

An AdditionalCode object

Sample JSON
    
{
  "data": {
    "id": "3200",
    "type": "additional_code",
    "attributes": {
      "additional_code_type_id": "3",
      "additional_code": "200",
      "code": "3200",
      "description": "Mixtures of scheduled substances listed in the Annex to Regulation (EC) No 111/2005 that can be used for the illicit manufacture of narcotic drugs or psychotropic substances",
      "formatted_description": "Mixtures of scheduled substances listed in the Annex to Regulation (EC) No 111/2005 that can be used for the illicit manufacture of narcotic drugs or psychotropic substances"
    }
  }
}
    
  

Fields

Name Type Required Description
id string true The unique identifier for this additional_code object
additional_code_type_id string true The additional_code_type_id for the additional_code
additional_code string true The additional_code for the additional_code
code string true The code for the additional_code. Equal to additional_code_type_id + additional_code
description string true The description for the additional_code
formatted_description string true The formatted_description for the additional_code

Exemption

A non-tariff Exemption which exempts the CategoryAssessment when the Exemption is applicable

Sample JSON
    
{
  "data": {
    "id": "WFE001",
    "type": "exemption",
    "attributes": {
      "code": "WFE001",
      "description": "Seed potatoes of a particular variety",
      "formatted_description": "Seed potatoes of a particular variety"
    }
  }
}
    
  

Fields

Name Type Required Description
id string true The unique identifier for this description
code string true The code identifying the Exemption
description string true The description for the Exemption
formatted_description string true A version of the description potentially including html formatting tags

Measure

A Measure object which generates this Category Assessment.

Sample JSON
    
{
  "data": {
    "id": "3871192",
    "type": "measure",
    "attributes": {
      "goods_nomenclature_item_id": "2404120010",
      "goods_nomenclature_sid": "106676",
      "effective_start_date": "2022-01-01T00:00:00.000Z",
      "effective_end_date": null
    },
    "relationships": {
      "measure_type": {
        "data": {
          "id": "475",
          "type": "measure_type"
        }
      },
      "footnotes": {
        "data": [
          {
            "id": "CD437",
            "type": "footnote"
          }
        ]
      }
    }
  }
}
    
  

Fields

Name Type Required Description
id string true The unique identifier for this measure
goods_nomenclature_item_id string true The item id of the GoodsNomenclature this Measure is against.
goods_nomenclature_sid string true The item id of the GoodsNomenclature this Measure is against
effective_start_date string(date-time) true The effective start date of the measure.
effective_end_date string(date-time) true The effective end date of the measure.
footnotes [Footnote] false The footnotes for this measure

MeasureType

A referenced MeasureType object

Sample JSON
    
{
  "data": {
    "id": "475",
    "type": "measure_type",
    "attributes": {
      "description": "Restriction on entry into free circulation",
      "measure_type_series_description": "Entry into free circulation or exportation subject to conditions",
      "validity_start_date": "1972-01-01T00:00:00.000Z",
      "validity_end_date": null,
      "measure_type_series_id": "B",
      "trade_movement_code": 0
    }
  }
}
    
  

Fields

Name Type Required Description
id string false Unique identifier for this measure
description string false The description for the measure type
measure_type_series_description string false The description of the measure type series
validity_start_date string(date-time) false The validity start date of the measure type
validity_end_date string(date-time) false The validity end date of the measure type
measure_type_series_id string(byte) false A single char representing measure type series.
trade_movement_code integer false The code of trade movement.

LegalAct

The Regulations which the Category Assessment is derived from.

Sample JSON
    
{
  "data": {
    "id": "D1908540",
    "type": "legal_act",
    "attributes": {
      "validity_start_date": "2019-09-20T00:00:00.000Z",
      "validity_end_date": null,
      "officialjournal_number": "L 147",
      "officialjournal_page": 1,
      "published_date": "2019-06-05",
      "regulation_code": "D0854/19",
      "regulation_url": "http://eur-lex.europa.eu/search.html?whOJ=NO_OJ%3D147,YEAR_OJ%3D2019,PAGE_FIRST%3D0001&DB_COLL_OJ=oj-l&type=advanced&lang=en",
      "description": null
    }
  }
}
    
  

Fields

Name Type Required Description
id string false The unique identifier for this legal act
validity_start_date string(date-time) false The validity start date of this legal act
validity_end_date string(date-time) false The validity end date of this legal act
officialjournal_number string false The journal describing this legal act
officialjournal_page integer false The page within the journal describing this legal act
published_date string(date) false The date this legal was published
regulation_code string false Formatted code identifying this legal act
regulation_url string(uri) false URL descripting this legal act
description string false A description of this legal act

Footnote

A referenced Footnote object

Sample JSON
    
{
  "data": {
    "id": "CD437",
    "type": "footnote",
    "attributes": {
      "code": "CD437",
      "description": "\"Import authorization\" and \"Specific import requirements\" - see Articles 20-25 of Regulation (EC) No 111/05 (OJ L 22) implemented by Regulation (EC) No 2015/1011 (OJ L 162)."
    }
  }
}
    
  

Fields

Name Type Required Description
id string false Unique identifier for the footnote
code string false The code for the footnote
description string false The description for the footnote

ReferencedGoodsNomenclature

A GoodsNomenclature referenced from either Ancestors or Descendants lists

Sample JSON
    
{
  "data": {
    "id": "106659",
    "type": "goods_nomenclature",
    "attributes": {
      "goods_nomenclature_item_id": "2404000000",
      "parent_sid": "30240",
      "description": "Products containing tobacco, reconstituted tobacco, nicotine, or tobacco or nicotine substitutes, intended for inhalation without combustion; other nicotine containing products intended for the intake of nicotine into the human body",
      "number_indents": 0,
      "productline_suffix": "80",
      "validity_start_date": "2022-01-01T00:00:00.000Z",
      "validity_end_date": null,
      "supplementary_measure_unit": "1000 items (1000 p/st)"
    },
    "relationships": {
      "licences": {
        "data": [
          {
            "id": "L100",
            "type": "certificate"
          }
        ]
      }
    }
  }
}
    
  

Fields

Name Type Required Description
id string true The unique id for this revision of this Goods Nomenclature
goods_nomenclature_item_id string true The goods_nomenclature_item_id of this Goods Nomenclature
parent_sid string true The goods_nomenclature_sid of the Goods Nomenclature this GoodsNomenclature sits directly below in the Tariff
description string true The description of the goods nomenclature
number_indents integer true The indentation of the goods nomenclature within the Tariff hierarchy
productline_suffix string true The productline_suffix of the goods nomenclature
validity_start_date string(date-time) true The date this Goods Nomenclature is valid from
validity_end_date string(date-time) true The date this Goods Nomenclature is valid until, null if valid indefinitely
supplementary_measure_unit string false The supplementary measure unit applicable to this GoodsNomenclature, if one is applicable
licences [Certificate] false List of licences applicable to this GoodsNomenclature

CategoryAssessmentListing

Listing of all category assessments

Sample JSON
    
{
  "data": [
    {
      "id": "abcd1234",
      "type": "category_assessment",
      "relationships": {
        "geographical_area": {
          "data": {
            "id": "1011",
            "type": "geographical_area"
          }
        },
        "excluded_geographical_areas": {
          "data": []
        },
        "theme": {
          "data": {
            "id": "2.1",
            "type": "theme"
          }
        },
        "exemptions": {
          "data": [
            {
              "id": "L135",
              "type": "certificate"
            },
            {
              "id": "3200",
              "type": "additional_code"
            },
            {
              "id": "WFE001",
              "type": "exemption"
            }
          ]
        },
        "measure_type": {
          "data": {
            "id": "475",
            "type": "measure_type"
          }
        },
        "regulation": {
          "data": {
            "id": "D1908540",
            "type": "legal_act"
          }
        }
      }
    }
  ],
  "included": [
    {
      "id": "1011",
      "type": "geographical_area",
      "attributes": {
        "description": "ERGA OMNES",
        "geographical_area_id": "1011"
      }
    },
    {
      "id": "2.1",
      "type": "theme",
      "attributes": {
        "theme": "Drug precursors",
        "category": 2
      }
    },
    {
      "id": "L135",
      "type": "certificate",
      "attributes": {
        "certificate_type_code": "L",
        "certificate_code": "135",
        "code": "L135",
        "description": "Import authorisation (precursors) issued by the competent authorities of the Member State where the importer is established",
        "formatted_description": "Import authorisation (precursors) issued by the competent authorities of the Member State where the importer is established"
      }
    },
    {
      "id": "3200",
      "type": "additional_code",
      "attributes": {
        "additional_code_type_id": "3",
        "additional_code": "200",
        "code": "3200",
        "description": "Mixtures of scheduled substances listed in the Annex to Regulation (EC) No 111/2005 that can be used for the illicit manufacture of narcotic drugs or psychotropic substances",
        "formatted_description": "Mixtures of scheduled substances listed in the Annex to Regulation (EC) No 111/2005 that can be used for the illicit manufacture of narcotic drugs or psychotropic substances"
      }
    },
    {
      "id": "WFE001",
      "type": "exemption",
      "attributes": {
        "code": "WFE001",
        "description": "Seed potatoes of a particular variety",
        "formatted_description": "Seed potatoes of a particular variety"
      }
    },
    {
      "id": "475",
      "type": "measure_type",
      "attributes": {
        "description": "Restriction on entry into free circulation",
        "measure_type_series_description": "Entry into free circulation or exportation subject to conditions",
        "validity_start_date": "1972-01-01T00:00:00.000Z",
        "validity_end_date": null,
        "measure_type_series_id": "B",
        "trade_movement_code": 0
      }
    },
    {
      "id": "D1908540",
      "type": "legal_act",
      "attributes": {
        "validity_start_date": "2019-09-20T00:00:00.000Z",
        "validity_end_date": null,
        "officialjournal_number": "L 147",
        "officialjournal_page": 1,
        "published_date": "2019-06-05",
        "regulation_code": "D0854/19",
        "regulation_url": "http://eur-lex.europa.eu/search.html?whOJ=NO_OJ%3D147,YEAR_OJ%3D2019,PAGE_FIRST%3D0001&DB_COLL_OJ=oj-l&type=advanced&lang=en",
        "description": null
      }
    }
  ]
}
    
  

Fields

Name Type Required Description
data [CategoryAssessment] false An individual CategoryAssessment