Windsor Framework Green Lanes Categorisation API
The Green Lanes Categorisation API’s provide access to Category Assessment data for the different Commodities and Subheadings within the Tariff.
These APIs follow the JSON-API format for both request and response, in common with the other OTT APIs documented on this site.
We recommend using a suitable JSON-API client library for your application platform to consume these APIs - possible JSON-API client libraries
The APIs are subject to change and this document will be updated as the API development evolves.
An RSS feed is available for notification of changes - see below.
Previous version
Earlier docs for the current API implementation
Authentication
Access to these APIs will be restricted initially whilst they are in development. Approved partners requiring access should contact the Online Trade Tariff team.
The token should be included with the API request via the standard HTTP Authorization header, eg.
Authorization: Token <SUPPLIED TOKEN>
Sample client
There’s a very simple html page client as an example of parsing these APIs in Javascript
Latest changes
These changes can be subscribed to at the Atom (RSS) feed
18 April 2024
Revised Green Lanes API documentation
* Added Theme API
Previous changes
12 Mar 2024
Added sample API client implementation in Javascript and HTML. Key lines for JSON:API parsing are 19, 20, 73
12 Mar 2024
Revised and extended API structure - added as a separate ‘next’ page for now until the API is updated to reflect it
* Reverted to a relationship to separate Theme entity in place of `Category.theme`
* Added `descendant_category_assessments` to the GoodsNomenclature API
* Added `ancestors` and their `measures` and related entities to the GoodsNomenclature API
* Added `descendants` and their `measures` and related entities to the GoodsNomenclature API
* Removed Measures.goods_nomenclature relationship to avoid circular parsing issues for simpler client implementations
* Brought Certificate structure inline with AdditionalCode to ease parsing of Exemptions
22 Feb 2024
Small update to describe api client logic around Category Assessment selection
Also corrects the api example when filtering by goods origin.
30 Jan 2024
Revised Green Lanes API documentation
* Renamed `Categorisation` entity to `CategoryAssessment` entity
* Renamed `GoodsNomenclature.possible_categorisations` relationship to `GoodsNomenclature.application_category_assessments`
* Replaced `Theme` entity and `CategoryAssessment.theme` relationship with simpler plain text `CategoryAssessment.theme`
* Clarified definition of `CategoryAssessment.category`
* Added Measures, Footnotes and MeasureTypes relationships to CategoryAssessments to provide further context, and include these in the API response
* Added links to top of the page providing further information for the JSON-API format we utilize
16 Jan 2024
Early access Green Lanes API documentation
Implementation of this API is currently in progress and access will be provided to approved partners on request once the implementation is sufficiently progressed
Base URL
All requests to this API should be prefixed with the following URL:
https://www.trade-tariff.service.gov.uk/xi/api/v2/green_lanes
Authentication
Green Lanes
GET /green_lanes/category_assessments
Returns a list of all category assessments
Returns a list of the all category assessments
To perform this operation, you must be authenticated by means of one of the following methods: http
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| 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. |
Example Request
curl -X GET -H "Authorization: Token TOKEN123" https://www.trade-tariff.service.gov.uk/xi/api/v2/green_lanes/category_assessments
curl -X GET -H "Authorization: Token TOKEN123" https://www.trade-tariff.service.gov.uk/xi/api/v2/green_lanes/category_assessments?as_of=2024-01-01
Example Response
{
"data": [
{
"id": "abcd1234",
"type": "category_assessment",
"relationships": {
"theme": {
"data": {
"id": "2.1",
"type": "theme"
}
},
"geographical_area": {
"data": {
"id": "1011",
"type": "geographical_area"
}
},
"excluded_geographical_areas": {
"data": []
},
"exemptions": {
"data": [
{
"id": "L135",
"type": "certificate"
},
{
"id": "3200",
"type": "additional_code"
}
]
}
}
},
{
"id": "abcd1234",
"type": "category_assessment",
"relationships": {
"theme": {
"data": {
"id": "1.1",
"type": "theme"
}
},
"geographical_area": {
"data": {
"id": "1011",
"type": "geographical_area"
}
},
"excluded_geographical_areas": {
"data": []
},
"exemptions": {
"data": []
}
}
}
],
"included": [
{
"id": "1.1",
"type": "theme",
"attributes": {
"theme": "Sanctions",
"category": 1
}
},
{
"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"
}
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | An array of CategoryAssessments | CategoryAssessmentListing |
| 401 | Unauthorized | Authorization header is missing or contains an invalid token | None |
| 422 | Unprocessable Entity | Likely incorrectly formatted as_of param |
None |
| 5xx | Server Error | Unexpected error, something went wrong internally | None |
GET /green_lanes/goods_nomenclatures/{id}
Returns Category Assessments for the requested Goods Nomenclature
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: http
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. If you are working with truncated item ids, ie truncated to 6 or 8 significant digits, then pad to 10 with trailing zero’s - so 123456 would submitted as 1234560000. |
| as_of | query | string(date) | false | Returns tariff data as it applies on the as_of date While this 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. As caching is used on the API this will ensure the data returned is as expected. |
| filter[geographical_area_id] | query | string | false | A geographical area code you wish to use to filter the Category Assessment information |
Example Request
curl -X GET -H "Authorization: Token TOKEN123" https://www.trade-tariff.service.gov.uk/xi/api/v2/green_lanes/goods_nomenclatures/0712909000
curl -X GET -H "Authorization: Token TOKEN123" https://www.trade-tariff.service.gov.uk/xi/api/v2/green_lanes/goods_nomenclatures/0712909000?as_of=2024-01-01
curl -X GET -H "Authorization: Token TOKEN123" "https://www.trade-tariff.service.gov.uk/xi/api/v2/green_lanes/goods_nomenclatures/0712909000?filter\[geographical_area_id\]=US"
curl -X GET -H "Authorization: Token TOKEN123" "https://www.trade-tariff.service.gov.uk/xi/api/v2/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
},
"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"
}
]
},
"measures": {
"data": []
}
}
},
"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"
}
]
}
}
},
{
"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"
}
]
}
]
}
},
{
"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"
}
]
}
]
}
},
{
"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
},
"relationships": {
"measure_type": {
"data": {
"id": "714",
"type": "measure_type"
}
}
}
},
{
"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"
}
]
}
}
},
{
"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": {
"measure_type": {
"data": {
"id": "475",
"type": "measure_type"
}
},
"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": {
"measure_type": {
"data": {
"id": "475",
"type": "measure_type"
}
},
"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": {
"measure_type": {
"data": {
"id": "475",
"type": "measure_type"
}
},
"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
}
},
{
"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
}
},
{
"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
},
"relationships": {
"measures": {
"data": [
{
"id": "3871192",
"type": "measure"
},
{
"id": "3871193",
"type": "measure"
}
]
}
}
},
{
"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
},
"relationships": {
"measures": {
"data": [
{
"id": "3871247",
"type": "measure"
},
{
"id": "3871248",
"type": "measure"
}
]
}
}
},
{
"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",
"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."
}
}
]
}
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 all themes
Returns a list of the all Green Lane themes within the Windsor Framework
To perform this operation, you must be authenticated by means of one of the following methods: http
Example Request
curl -X GET -H "Authorization: Token TOKEN123" https://www.trade-tariff.service.gov.uk/xi/api/v2/green_lanes/themes
Example Response
Responses
| 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
A goods_nomenclature object
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
},
"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"
}
]
},
"measures": {
"data": []
}
}
},
"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"
}
]
}
}
},
{
"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"
}
]
}
]
}
},
{
"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"
}
]
}
]
}
},
{
"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
},
"relationships": {
"measure_type": {
"data": {
"id": "714",
"type": "measure_type"
}
}
}
},
{
"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"
}
]
}
}
},
{
"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": {
"measure_type": {
"data": {
"id": "475",
"type": "measure_type"
}
},
"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": {
"measure_type": {
"data": {
"id": "475",
"type": "measure_type"
}
},
"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": {
"measure_type": {
"data": {
"id": "475",
"type": "measure_type"
}
},
"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
}
},
{
"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
}
},
{
"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
},
"relationships": {
"measures": {
"data": [
{
"id": "3871192",
"type": "measure"
},
{
"id": "3871193",
"type": "measure"
}
]
}
}
},
{
"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
},
"relationships": {
"measures": {
"data": [
{
"id": "3871247",
"type": "measure"
},
{
"id": "3871248",
"type": "measure"
}
]
}
}
},
{
"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",
"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."
}
}
]
}
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 |
| descendants | Unknown | false | List of GoodsNomenclatures below the requested one in the Tariff, ordered by Goods Nomenclature Item Id |
| 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 |
| measures | [Measure] | false | The measures directly against this GoodsNomenclature |
CategoryAssessment
A CategoryAssessment for the requested GoodsNomenclature
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"
}
]
}
}
},
"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"
}
}
]
}
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 Green Lanes Theme used as the basis for 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 and Additional Code objects |
| measures | [Measure] | false | A list of Measures resulting in this CategoryAssessment |
Theme
A Green Lane 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 Green Lanes theme |
| theme | string | true | Green Lanes Theme |
| category | integer | true | The green lanes 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 |
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. |
| measure_type | MeasureType | false | The measure type associated with this 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. |
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
},
"relationships": {
"measures": {
"data": [
{
"id": "3871192",
"type": "measure"
},
{
"id": "3871193",
"type": "measure"
}
]
}
}
}
}
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 |
| measures | [Measure] | false | The measures directly against this GoodsNomenclature |
CategoryAssessmentListing
Listing of all category assessments
Sample JSON
{
"data": [
{
"id": "abcd1234",
"type": "category_assessment",
"relationships": {
"theme": {
"data": {
"id": "2.1",
"type": "theme"
}
},
"geographical_area": {
"data": {
"id": "1011",
"type": "geographical_area"
}
},
"excluded_geographical_areas": {
"data": []
},
"exemptions": {
"data": [
{
"id": "L135",
"type": "certificate"
},
{
"id": "3200",
"type": "additional_code"
}
]
}
}
},
{
"id": "abcd1234",
"type": "category_assessment",
"relationships": {
"theme": {
"data": {
"id": "1.1",
"type": "theme"
}
},
"geographical_area": {
"data": {
"id": "1011",
"type": "geographical_area"
}
},
"excluded_geographical_areas": {
"data": []
},
"exemptions": {
"data": []
}
}
}
],
"included": [
{
"id": "1.1",
"type": "theme",
"attributes": {
"theme": "Sanctions",
"category": 1
}
},
{
"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"
}
}
]
}
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 Category 1 = Prohibited Category 2 = Controlled Category 3 = Exempted |
| 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 and Additional Code objects |