List all Taxons

Returns a list of Taxons. Read more about Taxons

Query Parameters

filter[ids]

string

Fetch only resources with corresponding IDs

filter[name]

string

Find resources with matching name (supports wild-card, partial-word match search)

filter[parent_id]

string

Fetch children nodes of specified Taxon

filter[parent_permalink]

string

Fetch children nodes of specified Taxon permalink

filter[taxonomy_id]

string

Fetch Taxons in a specified Taxonomy

filter[roots]

boolean

Fetch only root Taxons (Taxonomies)

page

integer

Number of requested page when paginating collection

per_page

integer

Number of requested records per page when paginating collection

include

string

Specify the related resources you would like to receive in the response body. More Information.

fields[taxon]

string

Specify the fields you would like returned in the response body. More information.

Response

200 - application/vnd.api+json

data

object[]

required

Show child attributes

data.attributes

object

required

Show child attributes

data.attributes.depth

integer | null

data.attributes.is_child

boolean

Returns true is this is a child node of this Taxonomy tree

data.attributes.is_leaf

boolean

Returns true if this is the end of a branch of this Taxonomy tree

data.attributes.is_root

boolean

Indicates if the Taxon is the root node of this Taxonomy tree

data.attributes.left

integer

data.attributes.localized_slugs

object

Provides taxon's slugs in other locales

data.attributes.meta_description

string | null

data.attributes.meta_keywords

string | null

data.attributes.meta_title

string | null

data.attributes.name

string

data.attributes.permalink

string

data.attributes.position

integer

data.attributes.pretty_name

string

data.attributes.right

integer

data.attributes.seo_title

string

data.attributes.updated_at

string

data.id

string

required

data.relationships

object

required

Show child attributes

data.relationships.children

object

List of child nodes

Show child attributes

data.relationships.children.data

array

Show child attributes

data.relationships.children.data.id

string

required

data.relationships.children.data.type

string

required

data.relationships.image

object

Image associated with Taxon

Show child attributes

data.relationships.image.data

object | null

Show child attributes

data.relationships.image.data.id

string

required

data.relationships.image.data.type

string

required

data.relationships.parent

object

Parent node

Show child attributes

data.relationships.parent.data

object | null

Show child attributes

data.relationships.parent.data.id

string

required

data.relationships.parent.data.type

string

required

data.relationships.products

object

List of active and available Products associated with this Taxon

Show child attributes

data.relationships.products.data

array

Show child attributes

data.relationships.products.data.id

string

required

data.relationships.products.data.type

string

required

data.relationships.taxonomy

object

Taxonomy associated with this Taxon

Show child attributes

data.relationships.taxonomy.data

object | null

Show child attributes

data.relationships.taxonomy.data.id

string

required

data.relationships.taxonomy.data.type

string

required

data.type

string

default:

taxon

required

links

object

required

Show child attributes

links.first

string

URL to the first page of the listing

links.last

string

URL to the last page of the listing

links.next

string

URL to the next page of the listing

links.prev

string

URL to the previous page of the listing

links.self

string

URL to the current page of the listing

meta

object

required

Show child attributes

meta.count

number

Number of items on the current listing

meta.total_count

number

Number of all items matching the criteria

meta.total_pages

number

Number of all pages containing items matching the criteria

included

object[]

• Taxon Includes
• Taxon Includes
• Taxon Includes

Show child attributes

included.attributes

object

required

Show child attributes

included.attributes.available

boolean

included.attributes.available_on

string | null

included.attributes.backorderable

boolean

Indicates if any of Variants are backeorderable

included.attributes.compare_at_price

string | null

included.attributes.currency

string

included.attributes.description

string | null

included.attributes.display_compare_at_price

string | null

included.attributes.display_price

string | null

included.attributes.in_stock

boolean

Indicates if any of Variants are in stock

included.attributes.localized_slugs

object

Provides product's slugs in other locales

included.attributes.meta_description

string | null

included.attributes.meta_keywords

string | null

included.attributes.name

string

included.attributes.price

string | null

included.attributes.purchasable

boolean

Indicates if any of Variants are in stock or backorderable

included.attributes.sku

string

included.attributes.slug

string

included.attributes.updated_at

string

included.id

string

required

included.relationships

object

required

Show child attributes

included.relationships.default_variant

object

The default Variant for this product

Show child attributes

included.relationships.default_variant.data

object | null

Show child attributes

included.relationships.default_variant.data.id

string

required

included.relationships.default_variant.data.type

string

required

included.relationships.images

object

List of Images associated with this Product

Show child attributes

included.relationships.images.data

array

Show child attributes

included.relationships.images.data.id

string

required

included.relationships.images.data.type

string

required

included.relationships.option_types

object

List of Product Option Types

Show child attributes

included.relationships.option_types.data

array

Show child attributes

included.relationships.option_types.data.id

string

required

included.relationships.option_types.data.type

string

required

included.relationships.primary_variant

object

The Primary Variant for this product

Show child attributes

included.relationships.primary_variant.data

object | null

Show child attributes

included.relationships.primary_variant.data.id

string

required

included.relationships.primary_variant.data.type

string

required

included.relationships.product_properties

object

List of Product Properties

Show child attributes

included.relationships.product_properties.data

array

Show child attributes

included.relationships.product_properties.data.id

string

required

included.relationships.product_properties.data.type

string

required

included.relationships.taxons

object

List of Taxons associated with this Product

Show child attributes

included.relationships.taxons.data

array

Show child attributes

included.relationships.taxons.data.id

string

required

included.relationships.taxons.data.type

string

required

included.relationships.variants

object

List of Product Variants, excluding Master Variant

Show child attributes

included.relationships.variants.data

array

Show child attributes

included.relationships.variants.data.id

string

required

included.relationships.variants.data.type

string

required

included.type

string

default:

product

required