Developers
Taxonomies

List taxonomy terms

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

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

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

Query Parameters

limit?integer
Range1 <= value <= 200
cursor?string

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/products/string/taxonomies/string/terms"
{  "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"    }  ],  "page": {    "limit": 1,    "next_cursor": "string",    "prev_cursor": "string"  }}

Delete a taxonomy DELETE

Moves the taxonomy and all of its terms to the trash. The terms are also removed from every lesson they were assigned to. Send the `ETag` returned by the retrieve operation in the `If-Match` header to avoid deleting a taxonomy that has changed since it was retrieved. Taxonomies of replicated products are read-only and cannot be deleted. Attempts to delete them return `403 Forbidden` with the `replica_readonly` error code.

Create a taxonomy term POST

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.