Developers
Taxonomies10

Create a taxonomy

POST/products/{product_id}/taxonomies

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.

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

Public ID of the product, prefixed with prd_.

Header Parameters

Idempotency-Key*string

Client-generated key that makes the request safe to retry. Must be 1 to 128 characters from [A-Za-z0-9._:-]. Required by this operation: a missing key returns idempotency_key_required, and a malformed key returns idempotency_key_invalid. Repeating the request with the same key and the same body returns the stored result with Idempotent-Replayed: true.

X-Client-Request-Id?string

Optional client-generated identifier of the request, up to 64 characters from [A-Za-z0-9._-]. Echoed back in the response and recorded in the request log; it never replaces the server-generated X-Request-Id.

Lengthlength <= 64

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/products/string/taxonomies" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{    "name": "string",    "plural_name": "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"  }}

List taxonomies GET

Lists the taxonomies of a product. Results are paginated with `limit` and `cursor`. Taxonomies are available only for products in the `blog` format. For other formats, the API returns `409 Conflict` with the `format_unsupported` error code instead of an empty collection.

Retrieve a taxonomy GET

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.