Queek docs
Merchant endpoint reference

Publications

GET
/publications

Requires scope merchant-publications-read.

Lists the calling installation’s sales-channel publications in p_id order, each with its p_id, key, name, kind and status. A human key lists every publication on the store.

Authorization

merchantKey
X-Client-Key<token>

The store's private API key (sk_live_…, sk_test_… on a dev store) from a Server connection under Dashboard → Channels → Headless API (keys are also listed in Settings → Connections). It is bound to one store and carries the scopes the merchant granted; each operation names the scope it needs. Server-side only — never ship it to a browser or an app bundle.

In: header

Query Parameters

limit?|

Maximum number of items to return in one page.

Range1 <= value <= 100
starting_after?|

Cursor for the next page: pass next_cursor from the previous response unchanged. Keep walking while has_more is true.

Header Parameters

X-Client-Key*string

A private API key (sk_live_…, sk_test_… on a dev store) minted by a Server connection under Dashboard → Channels → Headless API (keys are also listed in Settings → Connections). The key is bound to ONE store, so no vendor header or vendor_id is sent; its scopes decide which operations it may call. pk_ public keys never reach this API. Keep it on your server.

X-Request-Id?string

Your own correlation id (8–128 chars, ^[A-Za-z0-9_.:-]+$). Echoed back on the response and on every log line of the request; one is generated when you omit it.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/publications?limit=2" \  -H "X-Client-Key: {{merchantKey}}"
{  "data": [    {      "id": 1001,      "key": "kiosk-downtown",      "name": "Downtown kiosk",      "kind": "app",      "status": "active",      "created_at": "2026-10-07T12:00:00+01:00"    }  ],  "has_more": true,  "next_cursor": "eyJpZCI6MTAwMSwiX3BvaW50c1RvTmV4dEl0ZW1zIjp0cnVlfQ"}
POST
/publications

Requires scope merchant-publications-create.

Registers a sales channel on the calling installation (installation-only). At most 10 active publications per installation; a duplicate key is refused with a 422.

Authorization

merchantKey
X-Client-Key<token>

The store's private API key (sk_live_…, sk_test_… on a dev store) from a Server connection under Dashboard → Channels → Headless API (keys are also listed in Settings → Connections). It is bound to one store and carries the scopes the merchant granted; each operation names the scope it needs. Server-side only — never ship it to a browser or an app bundle.

In: header

Header Parameters

X-Client-Key*string

A private API key (sk_live_…, sk_test_… on a dev store) minted by a Server connection under Dashboard → Channels → Headless API (keys are also listed in Settings → Connections). The key is bound to ONE store, so no vendor header or vendor_id is sent; its scopes decide which operations it may call. pk_ public keys never reach this API. Keep it on your server.

X-Request-Id?string

Your own correlation id (8–128 chars, ^[A-Za-z0-9_.:-]+$). Echoed back on the response and on every log line of the request; one is generated when you omit it.

Idempotency-Key?string

Retry-safe write key. The same key with the same body replays the stored response for 24h with Idempotent-Replayed: true; with a different body it is 409 idempotency_key_reuse; while the first call is still running it is 409 idempotency_key_in_progress.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Registers a publication (a sales channel) for the calling app. Only an app connection can register one; the key is a slug unique to the app and may not be digits only.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/publications" \  -H "X-Client-Key: {{merchantKey}}" \  -H "Content-Type: application/json" \  -d '{    "key": "kiosk-downtown",    "name": "Downtown kiosk"  }'
{  "status": "success",  "message": "Publication registered.",  "data": {    "id": 1001,    "key": "kiosk-downtown",    "name": "Downtown kiosk",    "kind": "app",    "status": "active",    "created_at": "2026-10-07T12:00:00+01:00"  }}
PATCH
/publications/{publication}/resources

Requires scope merchant-publications-update.

Incrementally publishes or unpublishes product and collection refs on one of the calling installation’s publications (at most 50 refs per call in total; unresolvable refs are reported, never silently dropped). A newly listed product’s updated_at advances, so it appears in GET products?publication=…&updated_after=…; removals are found by reconciling the full GET products?publication= list.

Authorization

merchantKey
X-Client-Key<token>

The store's private API key (sk_live_…, sk_test_… on a dev store) from a Server connection under Dashboard → Channels → Headless API (keys are also listed in Settings → Connections). It is bound to one store and carries the scopes the merchant granted; each operation names the scope it needs. Server-side only — never ship it to a browser or an app bundle.

In: header

Path Parameters

publication*string

Identifier of the publication, as returned by the Merchant API.

Header Parameters

X-Client-Key*string

A private API key (sk_live_…, sk_test_… on a dev store) minted by a Server connection under Dashboard → Channels → Headless API (keys are also listed in Settings → Connections). The key is bound to ONE store, so no vendor header or vendor_id is sent; its scopes decide which operations it may call. pk_ public keys never reach this API. Keep it on your server.

X-Request-Id?string

Your own correlation id (8–128 chars, ^[A-Za-z0-9_.:-]+$). Echoed back on the response and on every log line of the request; one is generated when you omit it.

Idempotency-Key?string

Retry-safe write key. The same key with the same body replays the stored response for 24h with Idempotent-Replayed: true; with a different body it is 409 idempotency_key_reuse; while the first call is still running it is 409 idempotency_key_in_progress.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Publishes or unpublishes products and collections on one of your publications: up to 50 references per call in total, each a product or collection p_id, UUID or slug from this store. Every reference gets its own result; a publication you cannot access answers 404 and an archived one 410.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://example.com/publications/1001/resources" \  -H "X-Client-Key: {{merchantKey}}" \  -H "Content-Type: application/json" \  -d '{    "publish": {      "products": [        "019a1d52-3c8e-7f41-b0d2-6a3e9c1f4b21"      ],      "collections": []    },    "unpublish": {      "products": [],      "collections": []    }  }'
{  "status": "success",  "message": "Publication resources updated.",  "data": {    "publication": {      "id": 1001,      "key": "kiosk-downtown",      "name": "Downtown kiosk",      "kind": "app",      "status": "active",      "created_at": "2026-10-07T12:00:00+01:00"    },    "results": [      {        "ref": "20417",        "type": "product",        "id": 20417,        "result": "published",        "code": null      },      {        "ref": "3108",        "type": "collection",        "id": 3108,        "result": "unchanged",        "code": null      }    ]  }}