Skip to content
Guides
ES
API reference
stablecatalog:read

Get collection

Returns collection metadata, rules, overrides and counts. Product rows are available separately through the paginated collection products endpoint.

GET/v1/catalog/collections/{collectionId}

Returns collection metadata, rules, overrides and counts. Product rows are available separately through the paginated collection products endpoint.

Authorization

bearerAuth
AuthorizationBearer <token>

OAuth2 access token issued by Ecomiq Auth.

In: header

Path Parameters

collectionId*string

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X GET "https://example.com/v1/catalog/collections/string"
{  "id": "string",  "storeId": "string",  "name": "string",  "slug": "string",  "description": null,  "status": "draft",  "image": null,  "type": "static",  "dynamicOperator": "and",  "validFrom": null,  "validTo": null,  "rules": [    {      "field": "price",      "operator": "eq",      "path": null,      "value": "string"    }  ],  "includeCollectionIds": [],  "excludeCollectionIds": [],  "includeProductIds": [],  "excludeProductIds": [],  "pins": [    {      "productId": "string",      "position": 0    }  ],  "productCount": 0,  "createdOn": "2019-08-24T14:15:22Z",  "updatedOn": null}