Skip to main content

Get Catalog

GET 

/api/admin/portal/catalogs/:catalog

Get a catalog with its rules. Each rule includes ref_kind (product | category | brand | lifecycle_state), ref_key (the lifecycle state key on lifecycle-state rules, null otherwise; ref_id is null on those rules) and the resolved ref_label (the product/category/brand name, or the lifecycle state's label); product rules also include ref_sku. ref_label/ref_sku are null when the referenced record no longer exists.

Required scope: customers:read

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

Request​

Responses​

OK

Response Headers
    Content-Type