Trade Tariff Public Beta Search API
The HMRC Online Trade Tariff search API has been developed to provide access to third parties to utilise the Tariff’s built-in search functionality. This API is also used by the Trade Tariff itself, so that the results accessible via the API equate to those accessible via the interface.
The search service is current in BETA.
Search is designed to provide access for end-users to find commodity codes using free text search terms, fully-qualified commodity codes and partial commodity codes. There is a version of the search for UK data and a separate version for XI (Northern Ireland). Both the UK and the XI versions operate in an identical fashion and feature the same data structures, however the data is in certain places slightly different, as the UK commodity code base is on occasion not identical to the XI equivalent (for example in terms of the use of the terms EUR and GBP in commodity code descriptions).
The UK API is accessible via the uk prefix.
The XI API is accessible via the xi prefix.
Search uses the following data entities as source material:
- 10-digit commodity code numbers (goods nomenclature items)
- commodity code descriptions
- the commodity code hierarchy (relations between commodity codes)
- curated meta data to facilitate filtering on the commodity codes
- curated synonym data and search references to support the association of like terms
- data linking goods classification sections to official guides on difficult to classify goods
How search works
- Search loads the raw data described above into an AWS OpenSearch index
- Search terms are cleansed and interpreted and return a set of matching results in the core entities described below
- Items are returned in the API using the JSON API specification (link to https://jsonapi.org/format/) Introduction to the primary data entities
Entities returned by search
The following entities are returned by the json api response
Hits
- This section features the full list of all results that match the search term
- By default the result set will feature all hits, irrespective of the ‘class’ of the entity returned
- A hit may be one of the following classes of entities:
- chapter - a 2-significant digit commodity code which has one or more dependent child codes (which are mostly headings, but may also be commodities)
- heading - a 4-significant digit commodity code which has one or more dependent child codes (either subheadings or commodities)
- subheading - a 6-, 8- or 10-significant digit commodity code that is a child of a heading but is not declarable (not an end-line)
- commodity - a declarable commodity code (with no children)
- The structure of the hits node is described in the sections below
Chapter statistics
- This section lists any chapters that are included in the search results as well as relevant statistics concerning the chapter
- This is described in detail below
Heading statistics
- This section lists any headings that are included in the search results as well as relevant statistics concerning the heading
- This is described in detail below
Filters
- Filters provide access for users to ‘slice and dice’ the search results to reduce a large volume to a more accurate, granular and useful subset of those results.
- When a filter is used, the results set is reduced according to the data that matches the selected filter
- Any number of filters may be used to reduce the size of the result set and to render it more pertinent to the user’s needs
Guides
- HMRC has produced a number of guides for goods that are considered to be difficult to classify
- these guides are associated to specific chapters and headings in the goods classification, such that, when a given percentage of results are returned in the result set that match a heading with an associated guide, the guide entity is returned
- only 1 guide entity may be returned as a part of the result section
Messages
- Specific messages are returned when users search for certain search terms.
- This need has been fostered through analysis of previously submitted search terms and the results that they have returned
- The messages are intended to show users guidance on where to look in the classification to find the right commodity, for example if there are complex decisions to be made that are not obviously follow the structure of the commodity code hierarchy.
Please note - search provides access to the content of the current tariff not past or future versions of the tariff.
Base URLs
Search
GET /search
Returns search results for the input query and filters
This request does not require authentication.
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| q | query | string | true | What you’re searching for |
| filter | query | string | false | The filter method, when appended with the search query narrows down the search results from the original search query to more precise results. Usually, you’d do an initial query with your search term and then offer the user additional filters based on the previous search result Multiple filters can be supplied |
Example Request
curl -X GET https://www.trade-tariff.service.gov.uk/uk/api/beta/search?q=horse \
-H 'Accept: application/json'
Example Response
{
"data": {
"id": "773f19eb133e44c7b88f87902b3e557a",
"type": "search_result",
"attributes": {
"took": 14,
"timed_out": false,
"max_score": 83.56923,
"total_results": 10
},
"relationships": {
"search_query_parser_result": {
"data": {
"id": "52b14869c15726dda86b87cb93666a74",
"type": "search_query_parser_result"
}
},
"intercept_message": {
"data": {
"id": "f12f2d963bd9edfcbc56138adff3698a",
"type": "intercept_message"
}
},
"hits": {
"data": [
{
"id": "93797",
"type": "subheading"
},
{
"id": "93796",
"type": "commodity"
},
{
"id": "93798",
"type": "subheading"
},
{
"id": "93799",
"type": "commodity"
},
{
"id": "93800",
"type": "commodity"
},
{
"id": "28100",
"type": "commodity"
},
{
"id": "28105",
"type": "commodity"
},
{
"id": "93801",
"type": "commodity"
},
{
"id": "72763",
"type": "commodity"
},
{
"id": "93994",
"type": "commodity"
}
]
},
"heading_statistics": {
"data": [
{
"id": "0101",
"type": "heading_statistic"
},
{
"id": "0206",
"type": "heading_statistic"
},
{
"id": "0302",
"type": "heading_statistic"
}
]
},
"chapter_statistics": {
"data": [
{
"id": "01",
"type": "chapter_statistic"
},
{
"id": "02",
"type": "chapter_statistic"
},
{
"id": "03",
"type": "chapter_statistic"
}
]
},
"guide": {
"data": null
},
"facet_filter_statistics": {
"data": [
{
"id": "82daf4c6437dc8d7e507aa906ca5d8a1",
"type": "facet_filter_statistic"
},
{
"id": "eccb53b0914b1e33430ac80de39c1ae5",
"type": "facet_filter_statistic"
},
{
"id": "0ae963502c0515639087a35157e8e671",
"type": "facet_filter_statistic"
},
{
"id": "8a34fc49e7461bf91bb00b4527081f31",
"type": "facet_filter_statistic"
}
]
}
}
},
"included": [
{
"id": "27623",
"type": "ancestor",
"attributes": {
"goods_nomenclature_item_id": "0100000000",
"producline_suffix": "80",
"description": "LIVE ANIMALS",
"description_indexed": "LIVE ANIMALS"
}
},
{
"id": "27624",
"type": "ancestor",
"attributes": {
"goods_nomenclature_item_id": "0101000000",
"producline_suffix": "80",
"description": "Live horses, asses, mules and hinnies",
"description_indexed": "Live horses, asses, mules and hinnies"
}
},
{
"id": "93797",
"type": "subheading",
"attributes": {
"goods_nomenclature_item_id": "0101210000",
"producline_suffix": "10",
"description": "Horses",
"description_indexed": "Horses",
"search_references": "",
"validity_start_date": "2012-01-01T00:00:00Z",
"validity_end_date": null,
"chapter_id": "01",
"score": 83.56923,
"chapter_description": null,
"heading_description": null,
"heading_id": "0101"
},
"relationships": {
"ancestors": {
"data": [
{
"id": "27623",
"type": "ancestor"
},
{
"id": "27624",
"type": "ancestor"
}
]
}
}
},
{
"id": "93797",
"type": "ancestor",
"attributes": {
"goods_nomenclature_item_id": "0101210000",
"producline_suffix": "10",
"description": "Horses",
"description_indexed": "Horses"
}
},
{
"id": "93796",
"type": "commodity",
"attributes": {
"goods_nomenclature_item_id": "0101210000",
"producline_suffix": "80",
"description": "Pure-bred breeding animals",
"description_indexed": "Pure-bred breeding animals",
"search_references": "",
"validity_start_date": "2012-01-01T00:00:00Z",
"validity_end_date": null,
"chapter_id": "01",
"score": 70.354416,
"chapter_description": null,
"heading_description": null,
"heading_id": "0101"
},
"relationships": {
"ancestors": {
"data": [
{
"id": "27623",
"type": "ancestor"
},
{
"id": "27624",
"type": "ancestor"
},
{
"id": "93797",
"type": "ancestor"
}
]
}
}
},
{
"id": "93798",
"type": "subheading",
"attributes": {
"goods_nomenclature_item_id": "0101290000",
"producline_suffix": "80",
"description": "Other",
"description_indexed": "Other",
"search_references": "",
"validity_start_date": "2012-01-01T00:00:00Z",
"validity_end_date": null,
"chapter_id": "01",
"score": 70.354416,
"chapter_description": null,
"heading_description": null,
"heading_id": "0101"
},
"relationships": {
"ancestors": {
"data": [
{
"id": "27623",
"type": "ancestor"
},
{
"id": "27624",
"type": "ancestor"
},
{
"id": "93797",
"type": "ancestor"
}
]
}
}
},
{
"id": "93798",
"type": "ancestor",
"attributes": {
"goods_nomenclature_item_id": "0101290000",
"producline_suffix": "80",
"description": "Other",
"description_indexed": "Other"
}
},
{
"id": "93799",
"type": "commodity",
"attributes": {
"goods_nomenclature_item_id": "0101291000",
"producline_suffix": "80",
"description": "For slaughter",
"description_indexed": "For slaughter",
"search_references": "",
"validity_start_date": "2012-01-01T00:00:00Z",
"validity_end_date": null,
"chapter_id": "01",
"score": 70.354416,
"chapter_description": null,
"heading_description": null,
"heading_id": "0101"
},
"relationships": {
"ancestors": {
"data": [
{
"id": "27623",
"type": "ancestor"
},
{
"id": "27624",
"type": "ancestor"
},
{
"id": "93797",
"type": "ancestor"
},
{
"id": "93798",
"type": "ancestor"
}
]
}
}
},
{
"id": "93800",
"type": "commodity",
"attributes": {
"goods_nomenclature_item_id": "0101299000",
"producline_suffix": "80",
"description": "Other",
"description_indexed": "Other",
"search_references": "",
"validity_start_date": "2012-01-01T00:00:00Z",
"validity_end_date": null,
"chapter_id": "01",
"score": 70.354416,
"chapter_description": null,
"heading_description": null,
"heading_id": "0101"
},
"relationships": {
"ancestors": {
"data": [
{
"id": "27623",
"type": "ancestor"
},
{
"id": "27624",
"type": "ancestor"
},
{
"id": "93797",
"type": "ancestor"
},
{
"id": "93798",
"type": "ancestor"
}
]
}
}
},
{
"id": "27809",
"type": "ancestor",
"attributes": {
"goods_nomenclature_item_id": "0200000000",
"producline_suffix": "80",
"description": "MEAT AND EDIBLE MEAT OFFAL",
"description_indexed": "MEAT AND EDIBLE MEAT OFFAL"
}
},
{
"id": "28044",
"type": "ancestor",
"attributes": {
"goods_nomenclature_item_id": "0206000000",
"producline_suffix": "80",
"description": "Edible offal of bovine animals, swine, sheep, goats, horses, asses, mules or hinnies, fresh, chilled or frozen",
"description_indexed": "Edible offal of bovine animals, swine, sheep, goats, horses, asses, mules or hinnies, fresh, chilled or frozen"
}
},
{
"id": "28097",
"type": "ancestor",
"attributes": {
"goods_nomenclature_item_id": "0206800000",
"producline_suffix": "80",
"description": "Other, fresh or chilled",
"description_indexed": "Other, fresh or chilled"
}
},
{
"id": "28099",
"type": "ancestor",
"attributes": {
"goods_nomenclature_item_id": "0206809100",
"producline_suffix": "10",
"description": "Other",
"description_indexed": "Other"
}
},
{
"id": "28100",
"type": "commodity",
"attributes": {
"goods_nomenclature_item_id": "0206809100",
"producline_suffix": "80",
"description": "Of horses, asses, mules and hinnies",
"description_indexed": "Of horses, asses, mules and hinnies",
"search_references": "",
"validity_start_date": "1972-01-01T00:00:00Z",
"validity_end_date": null,
"chapter_id": "02",
"score": 63.343044,
"chapter_description": null,
"heading_description": null,
"heading_id": "0206"
},
"relationships": {
"ancestors": {
"data": [
{
"id": "27809",
"type": "ancestor"
},
{
"id": "28044",
"type": "ancestor"
},
{
"id": "28097",
"type": "ancestor"
},
{
"id": "28099",
"type": "ancestor"
}
]
}
}
},
{
"id": "28102",
"type": "ancestor",
"attributes": {
"goods_nomenclature_item_id": "0206900000",
"producline_suffix": "80",
"description": "Other, frozen",
"description_indexed": "Other, frozen"
}
},
{
"id": "28104",
"type": "ancestor",
"attributes": {
"goods_nomenclature_item_id": "0206909100",
"producline_suffix": "10",
"description": "Other",
"description_indexed": "Other"
}
},
{
"id": "28105",
"type": "commodity",
"attributes": {
"goods_nomenclature_item_id": "0206909100",
"producline_suffix": "80",
"description": "Of horses, asses, mules and hinnies",
"description_indexed": "Of horses, asses, mules and hinnies",
"search_references": "",
"validity_start_date": "1972-01-01T00:00:00Z",
"validity_end_date": null,
"chapter_id": "02",
"score": 63.343044,
"chapter_description": null,
"heading_description": null,
"heading_id": "0206"
},
"relationships": {
"ancestors": {
"data": [
{
"id": "27809",
"type": "ancestor"
},
{
"id": "28044",
"type": "ancestor"
},
{
"id": "28102",
"type": "ancestor"
},
{
"id": "28104",
"type": "ancestor"
}
]
}
}
},
{
"id": "93801",
"type": "commodity",
"attributes": {
"goods_nomenclature_item_id": "0101300000",
"producline_suffix": "80",
"description": "Asses",
"description_indexed": "Asses",
"search_references": "",
"validity_start_date": "2012-01-01T00:00:00Z",
"validity_end_date": null,
"chapter_id": "01",
"score": 60.350147,
"chapter_description": null,
"heading_description": null,
"heading_id": "0101"
},
"relationships": {
"ancestors": {
"data": [
{
"id": "27623",
"type": "ancestor"
},
{
"id": "27624",
"type": "ancestor"
}
]
}
}
},
{
"id": "72763",
"type": "commodity",
"attributes": {
"goods_nomenclature_item_id": "0101900000",
"producline_suffix": "80",
"description": "Other",
"description_indexed": "Other",
"search_references": "",
"validity_start_date": "2002-01-01T00:00:00Z",
"validity_end_date": null,
"chapter_id": "01",
"score": 60.350147,
"chapter_description": null,
"heading_description": null,
"heading_id": "0101"
},
"relationships": {
"ancestors": {
"data": [
{
"id": "27623",
"type": "ancestor"
},
{
"id": "27624",
"type": "ancestor"
}
]
}
}
},
{
"id": "28373",
"type": "ancestor",
"attributes": {
"goods_nomenclature_item_id": "0300000000",
"producline_suffix": "80",
"description": "FISH AND CRUSTACEANS, MOLLUSCS AND OTHER AQUATIC INVERTEBRATES",
"description_indexed": "FISH AND CRUSTACEANS, MOLLUSCS AND OTHER AQUATIC INVERTEBRATES"
}
},
{
"id": "28402",
"type": "ancestor",
"attributes": {
"goods_nomenclature_item_id": "0302000000",
"producline_suffix": "80",
"description": "Fish, fresh or chilled, excluding fish fillets and other fish meat of heading 0304",
"description_indexed": "Fish, fresh or chilled"
}
},
{
"id": "93985",
"type": "ancestor",
"attributes": {
"goods_nomenclature_item_id": "0302410000",
"producline_suffix": "10",
"description": "Herrings (Clupea harengus, Clupea pallasii), anchovies (Engraulis spp.), sardines (Sardina pilchardus, Sardinops spp.), sardinella (Sardinella spp.), brisling or sprats (Sprattus sprattus), mackerel (Scomber scombrus, Scomber australasicus, Scomber japonicus), Indian mackerels (Rastrelliger spp.), seerfishes (Scomberomorus spp.), jack and horse mackerel (Trachurus spp.), jacks, crevalles (Caranx spp.), cobia (Rachycentron canadum), silver pomfrets (Pampus spp.), Pacific saury (Cololabis saira), scads (Decapterus spp.), capelin (Mallotus villosus), swordfish (Xiphias gladius), Kawakawa (Euthynnus affinis), bonitos (Sarda spp.), marlins, sailfishes, spearfish (Istiophoridae), excluding edible fish offal of subheadings 0302 91 to 0302 99",
"description_indexed": "Herrings (Clupea harengus, Clupea pallasii), anchovies (Engraulis spp.), sardines (Sardina pilchardus, Sardinops spp.), sardinella (Sardinella spp.), brisling or sprats (Sprattus sprattus), mackerel (Scomber scombrus, Scomber australasicus, Scomber japonicus), Indian mackerels (Rastrelliger spp.), seerfishes (Scomberomorus spp.), jack and horse mackerel (Trachurus spp.), jacks, crevalles (Caranx spp.), cobia (Rachycentron canadum), silver pomfrets (Pampus spp.), Pacific saury (Cololabis saira), scads (Decapterus spp.), capelin (Mallotus villosus), swordfish (Xiphias gladius), Kawakawa (Euthynnus affinis), bonitos (Sarda spp.), marlins, sailfishes, spearfish (Istiophoridae)"
}
},
{
"id": "93993",
"type": "ancestor",
"attributes": {
"goods_nomenclature_item_id": "0302450000",
"producline_suffix": "80",
"description": "Jack and horse mackerel (Trachurus spp.)",
"description_indexed": "Jack and horse mackerel (Trachurus spp.)"
}
},
{
"id": "93994",
"type": "commodity",
"attributes": {
"goods_nomenclature_item_id": "0302451000",
"producline_suffix": "80",
"description": "Atlantic horse mackerel (Trachurus trachurus)",
"description_indexed": "Atlantic horse mackerel (Trachurus trachurus)",
"search_references": "",
"validity_start_date": "2012-01-01T00:00:00Z",
"validity_end_date": null,
"chapter_id": "03",
"score": 53.984024,
"chapter_description": null,
"heading_description": null,
"heading_id": "0302"
},
"relationships": {
"ancestors": {
"data": [
{
"id": "28373",
"type": "ancestor"
},
{
"id": "28402",
"type": "ancestor"
},
{
"id": "93985",
"type": "ancestor"
},
{
"id": "93993",
"type": "ancestor"
}
]
}
}
},
{
"id": "52b14869c15726dda86b87cb93666a74",
"type": "search_query_parser_result",
"attributes": {
"corrected_search_query": "horses",
"original_search_query": "horses",
"verbs": [],
"adjectives": [],
"nouns": [
"horse"
],
"noun_chunks": [
"horses"
]
}
},
{
"id": "0101",
"type": "heading_statistic",
"attributes": {
"description": null,
"chapter_id": "01",
"chapter_description": null,
"score": 485.68718800000005,
"cnt": 7,
"avg": 69.38388400000001,
"chapter_score": 485.68718800000005
}
},
{
"id": "0206",
"type": "heading_statistic",
"attributes": {
"description": null,
"chapter_id": "02",
"chapter_description": null,
"score": 126.686088,
"cnt": 2,
"avg": 63.343044,
"chapter_score": 126.686088
}
},
{
"id": "0302",
"type": "heading_statistic",
"attributes": {
"description": null,
"chapter_id": "03",
"chapter_description": null,
"score": 53.984024,
"cnt": 1,
"avg": 53.984024,
"chapter_score": 53.984024
}
},
{
"id": "01",
"type": "chapter_statistic",
"attributes": {
"description": null,
"cnt": 7,
"score": 485.68718800000005,
"avg": 69.38388400000001
}
},
{
"id": "02",
"type": "chapter_statistic",
"attributes": {
"description": null,
"cnt": 2,
"score": 126.686088,
"avg": 63.343044
}
},
{
"id": "03",
"type": "chapter_statistic",
"attributes": {
"description": null,
"cnt": 1,
"score": 53.984024,
"avg": 53.984024
}
},
{
"id": "f12f2d963bd9edfcbc56138adff3698a",
"type": "intercept_message",
"attributes": {
"term": "horses",
"message": "Based on your search term we have provided the subheading for horses."
}
},
{
"id": "3afc6150b5c9a06ba76a427bf50d4efb",
"type": "facet_classification_statistic",
"attributes": {
"facet": "animal_type",
"classification": "equine animals",
"count": 10
}
},
{
"id": "a20f3c40ef03c710ed7d5eb87a81a0ea",
"type": "facet_classification_statistic",
"attributes": {
"facet": "animal_type",
"classification": "fish",
"count": 1
}
},
{
"id": "82daf4c6437dc8d7e507aa906ca5d8a1",
"type": "facet_filter_statistic",
"attributes": {
"facet_filter": "filter_animal_type",
"facet_count": 10,
"display_name": "Animal type",
"question": "What type of animal?"
},
"relationships": {
"facet_classification_statistics": {
"data": [
{
"id": "3afc6150b5c9a06ba76a427bf50d4efb",
"type": "facet_classification_statistic"
},
{
"id": "a20f3c40ef03c710ed7d5eb87a81a0ea",
"type": "facet_classification_statistic"
}
]
}
}
},
{
"id": "2b771b5fcfc98ca0c0fb7dd60f66253c",
"type": "facet_classification_statistic",
"attributes": {
"facet": "animal_product_state",
"classification": "live",
"count": 7
}
},
{
"id": "43ed094f711336292fe0a5777098dacf",
"type": "facet_classification_statistic",
"attributes": {
"facet": "animal_product_state",
"classification": "chilled",
"count": 2
}
},
{
"id": "1252229951c35a7689434199b425be96",
"type": "facet_classification_statistic",
"attributes": {
"facet": "animal_product_state",
"classification": "fresh",
"count": 2
}
},
{
"id": "e5deafe40c6f42c6b9cba986886460d5",
"type": "facet_classification_statistic",
"attributes": {
"facet": "animal_product_state",
"classification": "frozen",
"count": 1
}
},
{
"id": "eccb53b0914b1e33430ac80de39c1ae5",
"type": "facet_filter_statistic",
"attributes": {
"facet_filter": "filter_animal_product_state",
"facet_count": 10,
"display_name": "Animal state",
"question": "What state is the animal in?"
},
"relationships": {
"facet_classification_statistics": {
"data": [
{
"id": "2b771b5fcfc98ca0c0fb7dd60f66253c",
"type": "facet_classification_statistic"
},
{
"id": "43ed094f711336292fe0a5777098dacf",
"type": "facet_classification_statistic"
},
{
"id": "1252229951c35a7689434199b425be96",
"type": "facet_classification_statistic"
},
{
"id": "e5deafe40c6f42c6b9cba986886460d5",
"type": "facet_classification_statistic"
}
]
}
}
},
{
"id": "83cc7bb14d0a35522570e9d1377df4b2",
"type": "facet_classification_statistic",
"attributes": {
"facet": "purpose",
"classification": "breeding",
"count": 1
}
},
{
"id": "065862a3558fc55989a98e985f3ad92b",
"type": "facet_classification_statistic",
"attributes": {
"facet": "purpose",
"classification": "human consumption",
"count": 1
}
},
{
"id": "0ae963502c0515639087a35157e8e671",
"type": "facet_filter_statistic",
"attributes": {
"facet_filter": "filter_purpose",
"facet_count": 2,
"display_name": "Purpose",
"question": "What is the purpose of the commodity?"
},
"relationships": {
"facet_classification_statistics": {
"data": [
{
"id": "83cc7bb14d0a35522570e9d1377df4b2",
"type": "facet_classification_statistic"
},
{
"id": "065862a3558fc55989a98e985f3ad92b",
"type": "facet_classification_statistic"
}
]
}
}
},
{
"id": "fa48febf19fa48f88a392b506eeaa7cb",
"type": "facet_classification_statistic",
"attributes": {
"facet": "fish_classification",
"classification": "mackerel",
"count": 1
}
},
{
"id": "8a34fc49e7461bf91bb00b4527081f31",
"type": "facet_filter_statistic",
"attributes": {
"facet_filter": "filter_fish_classification",
"facet_count": 1,
"display_name": "Fish classification",
"question": "Pick one of Fish classification"
},
"relationships": {
"facet_classification_statistics": {
"data": [
{
"id": "fa48febf19fa48f88a392b506eeaa7cb",
"type": "facet_classification_statistic"
}
]
}
}
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | The search resuts were found and returned | SearchResult |
| 400 | Bad Request | Bad request or URL invalid format | None |
Objects
SearchResult
A scheme of lower or preferential tariffs
Sample JSON
{
"data": {
"id": "773f19eb133e44c7b88f87902b3e557a",
"type": "search_result",
"attributes": {
"took": 14,
"timed_out": false,
"max_score": 83.56923,
"total_results": 10
},
"relationships": {
"search_query_parser_result": {
"data": {
"id": "52b14869c15726dda86b87cb93666a74",
"type": "search_query_parser_result"
}
},
"intercept_message": {
"data": {
"id": "f12f2d963bd9edfcbc56138adff3698a",
"type": "intercept_message"
}
},
"hits": {
"data": [
{
"id": "93797",
"type": "subheading"
},
{
"id": "93796",
"type": "commodity"
},
{
"id": "93798",
"type": "subheading"
},
{
"id": "93799",
"type": "commodity"
},
{
"id": "93800",
"type": "commodity"
},
{
"id": "28100",
"type": "commodity"
},
{
"id": "28105",
"type": "commodity"
},
{
"id": "93801",
"type": "commodity"
},
{
"id": "72763",
"type": "commodity"
},
{
"id": "93994",
"type": "commodity"
}
]
},
"heading_statistics": {
"data": [
{
"id": "0101",
"type": "heading_statistic"
},
{
"id": "0206",
"type": "heading_statistic"
},
{
"id": "0302",
"type": "heading_statistic"
}
]
},
"chapter_statistics": {
"data": [
{
"id": "01",
"type": "chapter_statistic"
},
{
"id": "02",
"type": "chapter_statistic"
},
{
"id": "03",
"type": "chapter_statistic"
}
]
},
"guide": {
"data": null
},
"facet_filter_statistics": {
"data": [
{
"id": "82daf4c6437dc8d7e507aa906ca5d8a1",
"type": "facet_filter_statistic"
},
{
"id": "eccb53b0914b1e33430ac80de39c1ae5",
"type": "facet_filter_statistic"
},
{
"id": "0ae963502c0515639087a35157e8e671",
"type": "facet_filter_statistic"
},
{
"id": "8a34fc49e7461bf91bb00b4527081f31",
"type": "facet_filter_statistic"
}
]
}
}
},
"included": [
{
"id": "27623",
"type": "ancestor",
"attributes": {
"goods_nomenclature_item_id": "0100000000",
"producline_suffix": "80",
"description": "LIVE ANIMALS",
"description_indexed": "LIVE ANIMALS"
}
},
{
"id": "27624",
"type": "ancestor",
"attributes": {
"goods_nomenclature_item_id": "0101000000",
"producline_suffix": "80",
"description": "Live horses, asses, mules and hinnies",
"description_indexed": "Live horses, asses, mules and hinnies"
}
},
{
"id": "93797",
"type": "subheading",
"attributes": {
"goods_nomenclature_item_id": "0101210000",
"producline_suffix": "10",
"description": "Horses",
"description_indexed": "Horses",
"search_references": "",
"validity_start_date": "2012-01-01T00:00:00Z",
"validity_end_date": null,
"chapter_id": "01",
"score": 83.56923,
"chapter_description": null,
"heading_description": null,
"heading_id": "0101"
},
"relationships": {
"ancestors": {
"data": [
{
"id": "27623",
"type": "ancestor"
},
{
"id": "27624",
"type": "ancestor"
}
]
}
}
},
{
"id": "93797",
"type": "ancestor",
"attributes": {
"goods_nomenclature_item_id": "0101210000",
"producline_suffix": "10",
"description": "Horses",
"description_indexed": "Horses"
}
},
{
"id": "93796",
"type": "commodity",
"attributes": {
"goods_nomenclature_item_id": "0101210000",
"producline_suffix": "80",
"description": "Pure-bred breeding animals",
"description_indexed": "Pure-bred breeding animals",
"search_references": "",
"validity_start_date": "2012-01-01T00:00:00Z",
"validity_end_date": null,
"chapter_id": "01",
"score": 70.354416,
"chapter_description": null,
"heading_description": null,
"heading_id": "0101"
},
"relationships": {
"ancestors": {
"data": [
{
"id": "27623",
"type": "ancestor"
},
{
"id": "27624",
"type": "ancestor"
},
{
"id": "93797",
"type": "ancestor"
}
]
}
}
},
{
"id": "93798",
"type": "subheading",
"attributes": {
"goods_nomenclature_item_id": "0101290000",
"producline_suffix": "80",
"description": "Other",
"description_indexed": "Other",
"search_references": "",
"validity_start_date": "2012-01-01T00:00:00Z",
"validity_end_date": null,
"chapter_id": "01",
"score": 70.354416,
"chapter_description": null,
"heading_description": null,
"heading_id": "0101"
},
"relationships": {
"ancestors": {
"data": [
{
"id": "27623",
"type": "ancestor"
},
{
"id": "27624",
"type": "ancestor"
},
{
"id": "93797",
"type": "ancestor"
}
]
}
}
},
{
"id": "93798",
"type": "ancestor",
"attributes": {
"goods_nomenclature_item_id": "0101290000",
"producline_suffix": "80",
"description": "Other",
"description_indexed": "Other"
}
},
{
"id": "93799",
"type": "commodity",
"attributes": {
"goods_nomenclature_item_id": "0101291000",
"producline_suffix": "80",
"description": "For slaughter",
"description_indexed": "For slaughter",
"search_references": "",
"validity_start_date": "2012-01-01T00:00:00Z",
"validity_end_date": null,
"chapter_id": "01",
"score": 70.354416,
"chapter_description": null,
"heading_description": null,
"heading_id": "0101"
},
"relationships": {
"ancestors": {
"data": [
{
"id": "27623",
"type": "ancestor"
},
{
"id": "27624",
"type": "ancestor"
},
{
"id": "93797",
"type": "ancestor"
},
{
"id": "93798",
"type": "ancestor"
}
]
}
}
},
{
"id": "93800",
"type": "commodity",
"attributes": {
"goods_nomenclature_item_id": "0101299000",
"producline_suffix": "80",
"description": "Other",
"description_indexed": "Other",
"search_references": "",
"validity_start_date": "2012-01-01T00:00:00Z",
"validity_end_date": null,
"chapter_id": "01",
"score": 70.354416,
"chapter_description": null,
"heading_description": null,
"heading_id": "0101"
},
"relationships": {
"ancestors": {
"data": [
{
"id": "27623",
"type": "ancestor"
},
{
"id": "27624",
"type": "ancestor"
},
{
"id": "93797",
"type": "ancestor"
},
{
"id": "93798",
"type": "ancestor"
}
]
}
}
},
{
"id": "27809",
"type": "ancestor",
"attributes": {
"goods_nomenclature_item_id": "0200000000",
"producline_suffix": "80",
"description": "MEAT AND EDIBLE MEAT OFFAL",
"description_indexed": "MEAT AND EDIBLE MEAT OFFAL"
}
},
{
"id": "28044",
"type": "ancestor",
"attributes": {
"goods_nomenclature_item_id": "0206000000",
"producline_suffix": "80",
"description": "Edible offal of bovine animals, swine, sheep, goats, horses, asses, mules or hinnies, fresh, chilled or frozen",
"description_indexed": "Edible offal of bovine animals, swine, sheep, goats, horses, asses, mules or hinnies, fresh, chilled or frozen"
}
},
{
"id": "28097",
"type": "ancestor",
"attributes": {
"goods_nomenclature_item_id": "0206800000",
"producline_suffix": "80",
"description": "Other, fresh or chilled",
"description_indexed": "Other, fresh or chilled"
}
},
{
"id": "28099",
"type": "ancestor",
"attributes": {
"goods_nomenclature_item_id": "0206809100",
"producline_suffix": "10",
"description": "Other",
"description_indexed": "Other"
}
},
{
"id": "28100",
"type": "commodity",
"attributes": {
"goods_nomenclature_item_id": "0206809100",
"producline_suffix": "80",
"description": "Of horses, asses, mules and hinnies",
"description_indexed": "Of horses, asses, mules and hinnies",
"search_references": "",
"validity_start_date": "1972-01-01T00:00:00Z",
"validity_end_date": null,
"chapter_id": "02",
"score": 63.343044,
"chapter_description": null,
"heading_description": null,
"heading_id": "0206"
},
"relationships": {
"ancestors": {
"data": [
{
"id": "27809",
"type": "ancestor"
},
{
"id": "28044",
"type": "ancestor"
},
{
"id": "28097",
"type": "ancestor"
},
{
"id": "28099",
"type": "ancestor"
}
]
}
}
},
{
"id": "28102",
"type": "ancestor",
"attributes": {
"goods_nomenclature_item_id": "0206900000",
"producline_suffix": "80",
"description": "Other, frozen",
"description_indexed": "Other, frozen"
}
},
{
"id": "28104",
"type": "ancestor",
"attributes": {
"goods_nomenclature_item_id": "0206909100",
"producline_suffix": "10",
"description": "Other",
"description_indexed": "Other"
}
},
{
"id": "28105",
"type": "commodity",
"attributes": {
"goods_nomenclature_item_id": "0206909100",
"producline_suffix": "80",
"description": "Of horses, asses, mules and hinnies",
"description_indexed": "Of horses, asses, mules and hinnies",
"search_references": "",
"validity_start_date": "1972-01-01T00:00:00Z",
"validity_end_date": null,
"chapter_id": "02",
"score": 63.343044,
"chapter_description": null,
"heading_description": null,
"heading_id": "0206"
},
"relationships": {
"ancestors": {
"data": [
{
"id": "27809",
"type": "ancestor"
},
{
"id": "28044",
"type": "ancestor"
},
{
"id": "28102",
"type": "ancestor"
},
{
"id": "28104",
"type": "ancestor"
}
]
}
}
},
{
"id": "93801",
"type": "commodity",
"attributes": {
"goods_nomenclature_item_id": "0101300000",
"producline_suffix": "80",
"description": "Asses",
"description_indexed": "Asses",
"search_references": "",
"validity_start_date": "2012-01-01T00:00:00Z",
"validity_end_date": null,
"chapter_id": "01",
"score": 60.350147,
"chapter_description": null,
"heading_description": null,
"heading_id": "0101"
},
"relationships": {
"ancestors": {
"data": [
{
"id": "27623",
"type": "ancestor"
},
{
"id": "27624",
"type": "ancestor"
}
]
}
}
},
{
"id": "72763",
"type": "commodity",
"attributes": {
"goods_nomenclature_item_id": "0101900000",
"producline_suffix": "80",
"description": "Other",
"description_indexed": "Other",
"search_references": "",
"validity_start_date": "2002-01-01T00:00:00Z",
"validity_end_date": null,
"chapter_id": "01",
"score": 60.350147,
"chapter_description": null,
"heading_description": null,
"heading_id": "0101"
},
"relationships": {
"ancestors": {
"data": [
{
"id": "27623",
"type": "ancestor"
},
{
"id": "27624",
"type": "ancestor"
}
]
}
}
},
{
"id": "28373",
"type": "ancestor",
"attributes": {
"goods_nomenclature_item_id": "0300000000",
"producline_suffix": "80",
"description": "FISH AND CRUSTACEANS, MOLLUSCS AND OTHER AQUATIC INVERTEBRATES",
"description_indexed": "FISH AND CRUSTACEANS, MOLLUSCS AND OTHER AQUATIC INVERTEBRATES"
}
},
{
"id": "28402",
"type": "ancestor",
"attributes": {
"goods_nomenclature_item_id": "0302000000",
"producline_suffix": "80",
"description": "Fish, fresh or chilled, excluding fish fillets and other fish meat of heading 0304",
"description_indexed": "Fish, fresh or chilled"
}
},
{
"id": "93985",
"type": "ancestor",
"attributes": {
"goods_nomenclature_item_id": "0302410000",
"producline_suffix": "10",
"description": "Herrings (Clupea harengus, Clupea pallasii), anchovies (Engraulis spp.), sardines (Sardina pilchardus, Sardinops spp.), sardinella (Sardinella spp.), brisling or sprats (Sprattus sprattus), mackerel (Scomber scombrus, Scomber australasicus, Scomber japonicus), Indian mackerels (Rastrelliger spp.), seerfishes (Scomberomorus spp.), jack and horse mackerel (Trachurus spp.), jacks, crevalles (Caranx spp.), cobia (Rachycentron canadum), silver pomfrets (Pampus spp.), Pacific saury (Cololabis saira), scads (Decapterus spp.), capelin (Mallotus villosus), swordfish (Xiphias gladius), Kawakawa (Euthynnus affinis), bonitos (Sarda spp.), marlins, sailfishes, spearfish (Istiophoridae), excluding edible fish offal of subheadings 0302 91 to 0302 99",
"description_indexed": "Herrings (Clupea harengus, Clupea pallasii), anchovies (Engraulis spp.), sardines (Sardina pilchardus, Sardinops spp.), sardinella (Sardinella spp.), brisling or sprats (Sprattus sprattus), mackerel (Scomber scombrus, Scomber australasicus, Scomber japonicus), Indian mackerels (Rastrelliger spp.), seerfishes (Scomberomorus spp.), jack and horse mackerel (Trachurus spp.), jacks, crevalles (Caranx spp.), cobia (Rachycentron canadum), silver pomfrets (Pampus spp.), Pacific saury (Cololabis saira), scads (Decapterus spp.), capelin (Mallotus villosus), swordfish (Xiphias gladius), Kawakawa (Euthynnus affinis), bonitos (Sarda spp.), marlins, sailfishes, spearfish (Istiophoridae)"
}
},
{
"id": "93993",
"type": "ancestor",
"attributes": {
"goods_nomenclature_item_id": "0302450000",
"producline_suffix": "80",
"description": "Jack and horse mackerel (Trachurus spp.)",
"description_indexed": "Jack and horse mackerel (Trachurus spp.)"
}
},
{
"id": "93994",
"type": "commodity",
"attributes": {
"goods_nomenclature_item_id": "0302451000",
"producline_suffix": "80",
"description": "Atlantic horse mackerel (Trachurus trachurus)",
"description_indexed": "Atlantic horse mackerel (Trachurus trachurus)",
"search_references": "",
"validity_start_date": "2012-01-01T00:00:00Z",
"validity_end_date": null,
"chapter_id": "03",
"score": 53.984024,
"chapter_description": null,
"heading_description": null,
"heading_id": "0302"
},
"relationships": {
"ancestors": {
"data": [
{
"id": "28373",
"type": "ancestor"
},
{
"id": "28402",
"type": "ancestor"
},
{
"id": "93985",
"type": "ancestor"
},
{
"id": "93993",
"type": "ancestor"
}
]
}
}
},
{
"id": "52b14869c15726dda86b87cb93666a74",
"type": "search_query_parser_result",
"attributes": {
"corrected_search_query": "horses",
"original_search_query": "horses",
"verbs": [],
"adjectives": [],
"nouns": [
"horse"
],
"noun_chunks": [
"horses"
]
}
},
{
"id": "0101",
"type": "heading_statistic",
"attributes": {
"description": null,
"chapter_id": "01",
"chapter_description": null,
"score": 485.68718800000005,
"cnt": 7,
"avg": 69.38388400000001,
"chapter_score": 485.68718800000005
}
},
{
"id": "0206",
"type": "heading_statistic",
"attributes": {
"description": null,
"chapter_id": "02",
"chapter_description": null,
"score": 126.686088,
"cnt": 2,
"avg": 63.343044,
"chapter_score": 126.686088
}
},
{
"id": "0302",
"type": "heading_statistic",
"attributes": {
"description": null,
"chapter_id": "03",
"chapter_description": null,
"score": 53.984024,
"cnt": 1,
"avg": 53.984024,
"chapter_score": 53.984024
}
},
{
"id": "01",
"type": "chapter_statistic",
"attributes": {
"description": null,
"cnt": 7,
"score": 485.68718800000005,
"avg": 69.38388400000001
}
},
{
"id": "02",
"type": "chapter_statistic",
"attributes": {
"description": null,
"cnt": 2,
"score": 126.686088,
"avg": 63.343044
}
},
{
"id": "03",
"type": "chapter_statistic",
"attributes": {
"description": null,
"cnt": 1,
"score": 53.984024,
"avg": 53.984024
}
},
{
"id": "f12f2d963bd9edfcbc56138adff3698a",
"type": "intercept_message",
"attributes": {
"term": "horses",
"message": "Based on your search term we have provided the subheading for horses."
}
},
{
"id": "3afc6150b5c9a06ba76a427bf50d4efb",
"type": "facet_classification_statistic",
"attributes": {
"facet": "animal_type",
"classification": "equine animals",
"count": 10
}
},
{
"id": "a20f3c40ef03c710ed7d5eb87a81a0ea",
"type": "facet_classification_statistic",
"attributes": {
"facet": "animal_type",
"classification": "fish",
"count": 1
}
},
{
"id": "82daf4c6437dc8d7e507aa906ca5d8a1",
"type": "facet_filter_statistic",
"attributes": {
"facet_filter": "filter_animal_type",
"facet_count": 10,
"display_name": "Animal type",
"question": "What type of animal?"
},
"relationships": {
"facet_classification_statistics": {
"data": [
{
"id": "3afc6150b5c9a06ba76a427bf50d4efb",
"type": "facet_classification_statistic"
},
{
"id": "a20f3c40ef03c710ed7d5eb87a81a0ea",
"type": "facet_classification_statistic"
}
]
}
}
},
{
"id": "2b771b5fcfc98ca0c0fb7dd60f66253c",
"type": "facet_classification_statistic",
"attributes": {
"facet": "animal_product_state",
"classification": "live",
"count": 7
}
},
{
"id": "43ed094f711336292fe0a5777098dacf",
"type": "facet_classification_statistic",
"attributes": {
"facet": "animal_product_state",
"classification": "chilled",
"count": 2
}
},
{
"id": "1252229951c35a7689434199b425be96",
"type": "facet_classification_statistic",
"attributes": {
"facet": "animal_product_state",
"classification": "fresh",
"count": 2
}
},
{
"id": "e5deafe40c6f42c6b9cba986886460d5",
"type": "facet_classification_statistic",
"attributes": {
"facet": "animal_product_state",
"classification": "frozen",
"count": 1
}
},
{
"id": "eccb53b0914b1e33430ac80de39c1ae5",
"type": "facet_filter_statistic",
"attributes": {
"facet_filter": "filter_animal_product_state",
"facet_count": 10,
"display_name": "Animal state",
"question": "What state is the animal in?"
},
"relationships": {
"facet_classification_statistics": {
"data": [
{
"id": "2b771b5fcfc98ca0c0fb7dd60f66253c",
"type": "facet_classification_statistic"
},
{
"id": "43ed094f711336292fe0a5777098dacf",
"type": "facet_classification_statistic"
},
{
"id": "1252229951c35a7689434199b425be96",
"type": "facet_classification_statistic"
},
{
"id": "e5deafe40c6f42c6b9cba986886460d5",
"type": "facet_classification_statistic"
}
]
}
}
},
{
"id": "83cc7bb14d0a35522570e9d1377df4b2",
"type": "facet_classification_statistic",
"attributes": {
"facet": "purpose",
"classification": "breeding",
"count": 1
}
},
{
"id": "065862a3558fc55989a98e985f3ad92b",
"type": "facet_classification_statistic",
"attributes": {
"facet": "purpose",
"classification": "human consumption",
"count": 1
}
},
{
"id": "0ae963502c0515639087a35157e8e671",
"type": "facet_filter_statistic",
"attributes": {
"facet_filter": "filter_purpose",
"facet_count": 2,
"display_name": "Purpose",
"question": "What is the purpose of the commodity?"
},
"relationships": {
"facet_classification_statistics": {
"data": [
{
"id": "83cc7bb14d0a35522570e9d1377df4b2",
"type": "facet_classification_statistic"
},
{
"id": "065862a3558fc55989a98e985f3ad92b",
"type": "facet_classification_statistic"
}
]
}
}
},
{
"id": "fa48febf19fa48f88a392b506eeaa7cb",
"type": "facet_classification_statistic",
"attributes": {
"facet": "fish_classification",
"classification": "mackerel",
"count": 1
}
},
{
"id": "8a34fc49e7461bf91bb00b4527081f31",
"type": "facet_filter_statistic",
"attributes": {
"facet_filter": "filter_fish_classification",
"facet_count": 1,
"display_name": "Fish classification",
"question": "Pick one of Fish classification"
},
"relationships": {
"facet_classification_statistics": {
"data": [
{
"id": "fa48febf19fa48f88a392b506eeaa7cb",
"type": "facet_classification_statistic"
}
]
}
}
}
]
}
Fields
| Name | Type | Required | Description |
|---|---|---|---|
| took | integer(number) | false | The time the search query took to execute in milliseconds |
| timed_out | boolean | false | Whether the ElasticSearch service timed_out retrieving the hits |
| max_score | number | false | The highest scored hit |
| total_results | integer(number) | false | The total hits that were returned for the request |
| search_query_parser_result | object | false | Indicates the original search query and tokenisation that happened on the search query (q) input |
| heading_statistics | object | false | Indicates the popularity of headings in the search results |
| chapter_statistics | object | false | Indicates the popularity of chapters in the search results |
| guide | object | false | Indicates the popular guidance that applies to the search results |
| facet_filter_statistics | object | false | Indicates which facets and classifications apply to the current search results. This informs subsequent searches to further refine results by specific facets and the available classifications. |
Chapter
Sample JSON
{
"goods_nomenclature_item_id": 100000000,
"producline_suffix": 10,
"description": "Horses",
"description_indexed": "Horses",
"search_references": "ricotta",
"validity_start_date": "2012-01-01T00:00:00.000Z",
"validity_end_date": "string",
"score": 83.576675,
"ancestors": [],
"guides": []
}
Fields
| Name | Type | Required | Description |
|---|---|---|---|
| goods_nomenclature_item_id | string | false | The publicly displayed, sortable, unique id of the current Chapter |
| producline_suffix | string | false | Used in conjunction with the goods_nomenclature_item_id to uniquely identify a goods nomenclature. |
| description | string | false | The non-negated description used for presentational purposes. |
| description_indexed | string | false | The negated description used for searching a given goods nomenclature and its ancestors |
| search_references | string | false | Used to prioritise specific terms and have them point at specific goods nomenclature (usually at the heading and chapter levels). |
| validity_start_date | string(date-time) | false | No description |
| validity_end_date | string(nullable) | false | No description |
| score | number | false | The score returned by for the current search query based on interesting terms, specific filter and field boosts. |
Heading
Sample JSON
{
"goods_nomenclature_item_id": 101000000,
"producline_suffix": 10,
"description": "Horses",
"description_indexed": "Horses",
"search_references": "ricotta",
"validity_start_date": "2012-01-01T00:00:00.000Z",
"validity_end_date": "string",
"score": 83.576675,
"chapter_id": 1,
"chapter_description": "Live animals",
"ancestors": [],
"guides": []
}
Fields
| Name | Type | Required | Description |
|---|---|---|---|
| goods_nomenclature_item_id | string | false | The publicly displayed, sortable, unique id of the current Chapter |
| producline_suffix | string | false | Used in conjunction with the goods_nomenclature_item_id to uniquely identify a goods nomenclature. |
| description | string | false | The non-negated description used for presentational purposes. |
| description_indexed | string | false | The negated description used for searching a given goods nomenclature and its ancestors |
| search_references | string | false | Used to prioritise specific terms and have them point at specific goods nomenclature (usually at the heading and chapter levels). |
| validity_start_date | string(date-time) | false | No description |
| validity_end_date | string(nullable) | false | No description |
| score | number | false | The score returned by for the current search query based on interesting terms, specific filter and field boosts. |
| chapter_id | string | false | No description |
| chapter_description | string | false | No description |
Subheading
Sample JSON
{
"goods_nomenclature_item_id": 101210000,
"producline_suffix": 10,
"description": "Horses",
"description_indexed": "Horses",
"search_references": "ricotta",
"validity_start_date": "2012-01-01T00:00:00.000Z",
"validity_end_date": "string",
"score": 83.576675,
"chapter_id": 1,
"chapter_description": "Live animals",
"heading_id": 101,
"heading_description": "Live horses, asses, mules and hinnies",
"ancestors": []
}
Fields
| Name | Type | Required | Description |
|---|---|---|---|
| goods_nomenclature_item_id | string | false | The publicly displayed, sortable, unique id of the current Chapter |
| producline_suffix | string | false | Used in conjunction with the goods_nomenclature_item_id to uniquely identify a goods nomenclature. |
| description | string | false | The non-negated description used for presentational purposes. |
| description_indexed | string | false | The negated description used for searching a given goods nomenclature and its ancestors |
| search_references | string | false | Used to prioritise specific terms and have them point at specific goods nomenclature (usually at the heading and chapter levels). |
| validity_start_date | string(date-time) | false | No description |
| validity_end_date | string(nullable) | false | No description |
| score | number | false | The score returned by for the current search query based on interesting terms, specific filter and field boosts. |
| chapter_id | string | false | No description |
| chapter_description | string | false | No description |
| heading_id | string | false | No description |
| heading_description | string(nullable) | false | No description |
Commodity
Sample JSON
{
"goods_nomenclature_item_id": 101210000,
"producline_suffix": 10,
"description": "Horses",
"description_indexed": "Horses",
"search_references": "ricotta",
"validity_start_date": "2012-01-01T00:00:00.000Z",
"validity_end_date": "string",
"score": 83.576675,
"chapter_id": 1,
"chapter_description": "Live animals",
"heading_id": 101,
"heading_description": "Live horses, asses, mules and hinnies",
"ancestors": []
}
Fields
| Name | Type | Required | Description |
|---|---|---|---|
| goods_nomenclature_item_id | string | false | The publicly displayed, sortable, unique id of the current Chapter |
| producline_suffix | string | false | Used in conjunction with the goods_nomenclature_item_id to uniquely identify a goods nomenclature. |
| description | string | false | The non-negated description used for presentational purposes. |
| description_indexed | string | false | The negated description used for searching a given goods nomenclature and its ancestors |
| search_references | string | false | Used to prioritise specific terms and have them point at specific goods nomenclature (usually at the heading and chapter levels). |
| validity_start_date | string(date-time) | false | No description |
| validity_end_date | string(nullable) | false | No description |
| score | number | false | The score returned by for the current search query based on interesting terms, specific filter and field boosts. |
| chapter_id | string | false | No description |
| chapter_description | string | false | No description |
| heading_id | string | false | No description |
| heading_description | string(nullable) | false | No description |
Ancestor
Sample JSON
{
"goods_nomenclature_item_id": 101210000,
"producline_suffix": 10,
"description": "Horses",
"description_indexed": "Horses"
}
Fields
| Name | Type | Required | Description |
|---|---|---|---|
| goods_nomenclature_item_id | string | false | No description |
| producline_suffix | string | false | No description |
| description | string | false | No description |
| description_indexed | string | false | No description |
Guide
Sample JSON
{
"title": "Textiles and textile articles",
"url": "https://www.gov.uk/guidance/classifying-textile-apparel",
"image": "textiles.png",
"strapline": "Get help to classify textiles and which headings and codes to use."
}
Fields
| Name | Type | Required | Description |
|---|---|---|---|
| title | string | false | No description |
| url | string | false | No description |
| image | string | false | No description |
| strapline | string | false | No description |
HeadingStatistic
Sample JSON
{
"description": "Live horses asses mules and hinnies",
"chapter_id": 1,
"chapter_description": "Live animals",
"score": 485.68718800000005,
"cnt": 7,
"avg": 69.38388400000001,
"chapter_score": 485.68718800000005
}
Fields
| Name | Type | Required | Description |
|---|---|---|---|
| description | string | false | No description |
| chapter_id | string | false | No description |
| chapter_description | string | false | No description |
| score | number | false | No description |
| cnt | number | false | No description |
| avg | number | false | No description |
| chapter_score | number | false | No description |
ChapterStatistic
Sample JSON
{
"description": "Live horses",
"cnt": 7,
"score": 485.68718800000005,
"avg": 69.38388400000001
}
Fields
| Name | Type | Required | Description |
|---|---|---|---|
| description | string | false | No description |
| cnt | number | false | No description |
| score | number | false | No description |
| avg | number | false | No description |
FacetFilterStatistic
Sample JSON
{
"facet_filter": "filter_animal_type",
"facet_count": 10,
"display_name": "Animal type",
"question": "What type of animal",
"facet_classification_statistics": []
}
Fields
| Name | Type | Required | Description |
|---|---|---|---|
| facet_filter | string | false | No description |
| facet_count | number | false | The number of times this facet appears in the search results |
| display_name | string | false | No description |
| question | string | false | No description |
FacetClassificationStatistic
Sample JSON
{
"facet": "animal_type",
"classification": "equine animals",
"count": 10
}
Fields
| Name | Type | Required | Description |
|---|---|---|---|
| facet | string | false | The category this classification is associated with |
| classification | string | false | The classification that we can filter by |
| count | number | false | The number of times we encountered these classifications in our search results. |
InterceptMessage
Sample JSON
{
"term": "horse",
"message": "Based on your search term we have provided the subheading for horses."
}
Fields
| Name | Type | Required | Description |
|---|---|---|---|
| term | string | false | The term that is searched for |
| message | string | false | The corresponding message associated with the search term |