v1

latestOpenAPI 3.0.12026-07-24501176.6 MB

Get/Search labels

get/v2/labels

Query parameters

entityType'CUSTOMER' | 'PRODUCT' | 'STORE'

Filters labels by entity type.

qstring

Search term to filter labels by name or external ID.

status'ACTIVE' | 'ARCHIVED'

Filters labels by status.

limitinteger

Maximum number of labels to return per page.

offsetinteger

Number of records to skip for pagination.

Headers

Authorizationstring
X-CAP-API-OAUTH-TOKENstring

Response

Successful response.