Taxons
Retrieve a Taxon
Storefront API
- Authentication
- Account
- Account / Address
- Account / Credit Cards
- Account / Orders
- Order Status
- Cart
- Cart / Line Items
- Cart / Other
- Cart / Coupons
- Checkout
- Checkout / State
- Checkout / Shipments
- Checkout / Payments
- Checkout / Store Credit
- Products
- Stores
- Taxons
- Countries
- CMS Pages
- Menus
- Wishlists
- Wishlists / Wished Items
- Digital Downloads
Platform API
- Authentication
- Addresses
- Adjustments
- Classifications
- CMS Pages
- CMS Sections
- Countries
- Data Feeds
- Digital Links
- Digital Assets
- Line Items
- Menu Items
- Menus
- Option Types
- Option Values
- Orders
- Payment Methods
- Payments
- Products
- Promotion Actions
- Promotion Categories
- Promotion Rules
- Promotions
- Roles
- Shipments
- Shipping Categories
- Shipping Methods
- States
- Stock Items
- Stock Locations
- Store Credit Categories
- Store Credit Types
- Store Credits
- Tax Categories
- Tax Rates
- Taxonomies
- Taxons
- Users
- Variants
- Webhook Events
- Webhook Subscribers
- Wished Items
- Wishlists
- Zones
Taxons
Retrieve a Taxon
Returns the details of a specified taxon.
GET
/
api
/
v2
/
storefront
/
taxons
/
{taxon_permalink}
taxon_permalink
string
*
taxon_permalink
Required
string
Specify the taxon using the permalink or taxon ID.
include
string
include
string
Specify the related resources you would like to receive in the response body. More Information.
fields[taxon]
string
fields[taxon]
string
Specify the fields you would like returned in the response body. More information.
{
"data": {
"id": "22",
"type": "taxon",
"attributes": {
"name": "Summer Sale",
"pretty_name": "Categories -> Summer Sale",
"permalink": "categories/summer-sale",
"seo_title": "Summer Sale",
"description": null,
"meta_title": null,
"meta_description": null,
"meta_keywords": null,
"left": 42,
"right": 43,
"position": 0,
"depth": 1,
"updated_at": "2021-10-02T11:03:15.118Z",
"is_root": false,
"is_child": true,
"is_leaf": true,
"localized_slugs": {
"en": "categories/summer-sale",
"de": "kategorien/sommerschlussverkauf",
"fr": "categories/soldes-dete"
}
},
"relationships": {
"parent": {
"data": {
"id": "1",
"type": "taxon"
}
},
"taxonomy": {
"data": {
"id": "1",
"type": "taxonomy"
}
},
"children": {
"data": []
},
"products": {
"data": [
{
"id": "76",
"type": "product"
},
{
"id": "92",
"type": "product"
},
{
"id": "112",
"type": "product"
},
{
"id": "15",
"type": "product"
},
{
"id": "86",
"type": "product"
},
{
"id": "52",
"type": "product"
},
{
"id": "78",
"type": "product"
},
{
"id": "36",
"type": "product"
},
{
"id": "93",
"type": "product"
},
{
"id": "73",
"type": "product"
},
{
"id": "83",
"type": "product"
},
{
"id": "7",
"type": "product"
},
{
"id": "95",
"type": "product"
},
{
"id": "8",
"type": "product"
},
{
"id": "59",
"type": "product"
},
{
"id": "28",
"type": "product"
},
{
"id": "41",
"type": "product"
},
{
"id": "66",
"type": "product"
},
{
"id": "10",
"type": "product"
},
{
"id": "12",
"type": "product"
},
{
"id": "21",
"type": "product"
},
{
"id": "111",
"type": "product"
},
{
"id": "48",
"type": "product"
},
{
"id": "46",
"type": "product"
},
{
"id": "5",
"type": "product"
},
{
"id": "71",
"type": "product"
},
{
"id": "103",
"type": "product"
},
{
"id": "20",
"type": "product"
},
{
"id": "62",
"type": "product"
},
{
"id": "64",
"type": "product"
}
]
},
"image": {
"data": null
}
}
}
}Path Parameters
Specify the taxon using the permalink or taxon ID.
Query Parameters
Specify the related resources you would like to receive in the response body. More Information.
Specify the fields you would like returned in the response body. More information.
Response
200 - application/vnd.api+json
Indicates if the Taxon is the root node of this Taxonomy tree
Returns true is this is a child node of this Taxonomy tree
Returns true if this is the end of a branch of this Taxonomy tree
Provides taxon's slugs in other locales
Indicates if any of Variants are in stock or backorderable
Indicates if any of Variants are in stock
Indicates if any of Variants are backeorderable
Provides product's slugs in other locales
List of tags associated with the product
List of labels associated with the product
Was this page helpful?
{
"data": {
"id": "22",
"type": "taxon",
"attributes": {
"name": "Summer Sale",
"pretty_name": "Categories -> Summer Sale",
"permalink": "categories/summer-sale",
"seo_title": "Summer Sale",
"description": null,
"meta_title": null,
"meta_description": null,
"meta_keywords": null,
"left": 42,
"right": 43,
"position": 0,
"depth": 1,
"updated_at": "2021-10-02T11:03:15.118Z",
"is_root": false,
"is_child": true,
"is_leaf": true,
"localized_slugs": {
"en": "categories/summer-sale",
"de": "kategorien/sommerschlussverkauf",
"fr": "categories/soldes-dete"
}
},
"relationships": {
"parent": {
"data": {
"id": "1",
"type": "taxon"
}
},
"taxonomy": {
"data": {
"id": "1",
"type": "taxonomy"
}
},
"children": {
"data": []
},
"products": {
"data": [
{
"id": "76",
"type": "product"
},
{
"id": "92",
"type": "product"
},
{
"id": "112",
"type": "product"
},
{
"id": "15",
"type": "product"
},
{
"id": "86",
"type": "product"
},
{
"id": "52",
"type": "product"
},
{
"id": "78",
"type": "product"
},
{
"id": "36",
"type": "product"
},
{
"id": "93",
"type": "product"
},
{
"id": "73",
"type": "product"
},
{
"id": "83",
"type": "product"
},
{
"id": "7",
"type": "product"
},
{
"id": "95",
"type": "product"
},
{
"id": "8",
"type": "product"
},
{
"id": "59",
"type": "product"
},
{
"id": "28",
"type": "product"
},
{
"id": "41",
"type": "product"
},
{
"id": "66",
"type": "product"
},
{
"id": "10",
"type": "product"
},
{
"id": "12",
"type": "product"
},
{
"id": "21",
"type": "product"
},
{
"id": "111",
"type": "product"
},
{
"id": "48",
"type": "product"
},
{
"id": "46",
"type": "product"
},
{
"id": "5",
"type": "product"
},
{
"id": "71",
"type": "product"
},
{
"id": "103",
"type": "product"
},
{
"id": "20",
"type": "product"
},
{
"id": "62",
"type": "product"
},
{
"id": "64",
"type": "product"
}
]
},
"image": {
"data": null
}
}
}
}