Search Taxonomy GET
Searches for and lists categories within the product description taxonomy. Use this method to explore the taxonomy and find appropriate product categories.
If a search term is supplied, any category that fully or partially matches the term is returned. If no search term given, a list of root categories is returned.
Request Parameters
| Parameter | Description |
| Term String | The whole or partial term to search for within the taxonomy |
| Configuration String | The taxonomy configuration settings to use to filter results returned. If not given, no filtering will be applied. |
| Strict Boolean | Applies strict filtering to only return terms explicitly allowed by the taxonomy configuration |
Response Parameters
| Parameter | Description |
| Categories List | CategoriesOptional |
Name String
| The name of the category |
Identifier String
| The unique identifier assigned to this category |
WiderTermName String
| The name of the category that contains this categoryOptional |
WiderTermIdentifier String
| The unique identifier assigned to the category that contains this categoryOptional |
Example Request
GET https://api.xure.co/v1/lookup/taxonomy.eb?Term=String&Configuration=String&Strict=Boolean HTTP/1.1
Accept: text/xml
Response Schema
<?xml version="1.0" encoding="utf-8"?>
<xsd:schema elementFormDefault="qualified" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<xsd:element name="CategorySearchResults">
<xsd:complexType>
<xsd:sequence>
<xsd:element name="Categories" minOccurs="0">
<xsd:complexType>
<xsd:sequence>
<xsd:element name="Item" minOccurs="0" maxOccurs="unbounded">
<xsd:complexType>
<xsd:sequence>
<xsd:element name="Name" type="xsd:string">
<xsd:annotation>
<xsd:documentation>The name of the category</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="Identifier" type="xsd:string">
<xsd:annotation>
<xsd:documentation>The unique identifier assigned to this category</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="WiderTermName" minOccurs="0" type="xsd:string">
<xsd:annotation>
<xsd:documentation>The name of the category that contains this category</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="WiderTermIdentifier" minOccurs="0" type="xsd:string">
<xsd:annotation>
<xsd:documentation>The unique identifier assigned to the category that contains this category</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
</xsd:schema>
Example Response
HTTP/1.1 200 OK
Content-Type: text/xml
<?xml version="1.0" encoding="utf-8"?>
<CategorySearchResults>
<Categories>
<Item>
<Name>xsd:string</Name>
<Identifier>xsd:string</Identifier>
<WiderTermName>xsd:string</WiderTermName>
<WiderTermIdentifier>xsd:string</WiderTermIdentifier>
</Item>...</Categories>
</CategorySearchResults>
Example Request
GET https://api.xure.co/v1/lookup/taxonomy.eb?Term=String&Configuration=String&Strict=Boolean HTTP/1.1
Accept: application/json
Example Response
HTTP/1.1 200 OK
Content-Type: application/json
{"Categories":[{"Name":String,
"Identifier":String,
"WiderTermName":String,
"WiderTermIdentifier":String},
...]}
Status and Error Codes
| HTTP Status | Error Code and Description |
| 200 | |
| 400 | DataError:Configuration:InvalidIdentifier |
| 400 | DataError:Configuration:MissingIdentifier |