Skip to content
docs
Guides
ES
CatalogSample Catalog
catalog:read

Get the customizable sample products

Returns the seeded sample products that can still be tailored to the store. Samples the merchant edited, sold or already tailored are excluded.

GET/v1/catalog/sample-catalog

Returns the seeded sample products that can still be tailored to the store. Samples the merchant edited, sold or already tailored are excluded.

Authorization

bearerAuth
AuthorizationBearer <token>

OAuth2 access token issued by Ecomiq Auth.

In: header

Header Parameters

x-Store-Id?string

Store the request acts on. Not needed when the token is bound to a store.

Authorization*string

OAuth 2.0 bearer token.

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/sample-catalog" \  -H "x-Store-Id: <store-id>" \  -H "Authorization: Bearer <token>"
{  "status": "customizable",  "products": [    {      "id": "7204558912004325301",      "version": 1,      "name": "Example resource",      "description": "Example description."    }  ]}