Developers
Taxonomies

Retrieve a taxonomy

GET/products/{product_id}/taxonomies/{taxonomy_id}

Retrieves a taxonomy of a product by its public ID.

The response includes an ETag representing the current revision. Send this value in the If-Match header when updating or deleting the taxonomy to avoid overwriting a newer version.

Authorization

AuthorizationBearer <token>

Autonomous mode: the API credential secret, sent as a bearer token. Credential secrets are identified by a fixed prefix.

In: header

Path Parameters

product_id*string
taxonomy_id*string

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/products/string/taxonomies/string"
{  "data": {    "created_at": "2019-08-24T14:15:22Z",    "id": "string",    "name": "string",    "object": "taxonomy",    "plural_name": "string",    "product_id": "string",    "revision": "string",    "terms_count": 0,    "updated_at": "2019-08-24T14:15:22Z"  }}

Create a taxonomy POST

Creates a taxonomy in a product, with a singular `name` and a `plural_name`. Taxonomies are available only for products in the `blog` format. For other formats, the API returns `409 Conflict` with the `format_unsupported` error code. Taxonomies cannot be created in replicated products. Attempts to do so return `403 Forbidden` with the `replica_readonly` error code.

Update a taxonomy PATCH

Updates the `name` and `plural_name` of a taxonomy. Send the `ETag` returned by the retrieve operation in the `If-Match` header to avoid overwriting a newer version. Taxonomies of replicated products are read-only. Attempts to update them return `403 Forbidden` with the `replica_readonly` error code.