Get a category

GET

/categories/{id}

The shape is identical to one element of categories.list. A foreign, unknown or soft-deleted id is 404 NOT_FOUND.

Requires scope: catalog:read

Authorizations

• apiKey
• oauth2
  catalog:read

Responses

200

Get a category

Media typeapplication/json

object

data

required

object

depth

required

integer

>= -9007199254740991 <= 9007199254740991

id

required

string format: uuid

/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

name

required

string

parent_id

required

Any of:

string

string format: uuid

/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

null

null

version

required

Opaque delta-sync version. Increases with every change; use it to detect updates.

string

Example^generated

{
  "data": {
    "depth": 1,
    "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "name": "example",
    "parent_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "version": "example"
  }
}

default

An error response.

Media typeapplication/json

object

error

required

object

code

required

A machine-readable error code, e.g. VALIDATION_FAILED.

string

Allowed values: UNAUTHORIZED PLAN_REQUIRED INSUFFICIENT_SCOPE NOT_FOUND VALIDATION_FAILED CONFLICT STALE_VERSION RATE_LIMITED IDEMPOTENCY_KEY_REUSED IDEMPOTENCY_IN_PROGRESS IMAGE_FETCH_FAILED UNPROCESSABLE INTERNAL RETAILER_CANCELLED RETAILER_SUSPENDED RETAILER_NOT_FOUND TRIAL_DECISION_REQUIRED PLAN_USERS_EXCEEDED RETAILER_PAUSED PRODUCT_LIMIT_REACHED NOT_STOCK_TRACKED REASON_DIRECTION_MISMATCH REASON_NOT_ALLOWED INSUFFICIENT_STOCK OUTLET_DELETED

fields

Array<object>

object

field

required

string

message

required

string

message

required

A plain-English sentence describing what went wrong.

string

Example

{
  "error": {
    "code": "UNAUTHORIZED"
  }
}