Developers
Taxonomies

Create a taxonomy term

POST/products/{product_id}/taxonomies/{taxonomy_id}/terms

Creates a term in a taxonomy. Requires the taxonomies.update permission.

The optional image field accepts the ID of a file previously uploaded to the account.

Terms cannot be created in taxonomies of 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
taxonomy_id*string

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

curl -X POST "https://example.com/products/string/taxonomies/string/terms" \  -H "Content-Type: application/json" \  -d '{    "name": "string"  }'
{  "data": {    "created_at": "2019-08-24T14:15:22Z",    "id": "string",    "image": "string",    "lessons_count": 0,    "name": "string",    "object": "taxonomy_term",    "revision": "string",    "taxonomy_id": "string",    "updated_at": "2019-08-24T14:15:22Z"  }}

List taxonomy terms GET

Lists the terms of a taxonomy, sorted alphabetically by name. Results are paginated with `limit` and `cursor`.

Retrieve a taxonomy term GET

Retrieves a taxonomy term 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 term to avoid overwriting a newer version.