Skip to content
docs
Guides
ES
CatalogSample Catalog
catalog:update

Tailor the sample products to the store

Replaces the name, description and image of untouched sample products once, using the expected versions. Fails with 409 when any sample changed.

PUT/v1/catalog/sample-catalog

Replaces the name, description and image of untouched sample products once, using the expected versions. Fails with 409 when any sample changed.

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.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X PUT "https://example.com/v1/catalog/sample-catalog" \  -H "x-Store-Id: <store-id>" \  -H "Authorization: Bearer <token>" \  -H "Content-Type: application/json" \  -d '{    "brief": "example",    "products": [      {        "id": "7204558912004325301",        "expectedVersion": 1,        "name": "Example resource",        "description": "Example description.",        "imageAssetId": "7204558912004325301"      }    ]  }'
{  "status": "customizable",  "products": [    {      "id": "7204558912004325301",      "version": 1,      "name": "Example resource",      "description": "Example description."    }  ]}