API Reference
Stores
Create, update, retrieve, and page through stores using your external store IDs.
Returns stores ordered by external ID. Use nextCursor to request the next page.
Authorization
bearerAuth In: header
Query Parameters
Maximum number of items to return. The default and maximum are 100.
External ID returned as nextCursor from the previous page.
Response Body
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/v1/stores?limit=100"{ "items": [ { "storeId": "b8adcdc8-9238-4168-90f8-77b2d14c211c", "externalId": "string", "name": "string", "location": "string", "regionId": "a29f01e1-8a8d-451e-b685-f8b0b4ec4767", "storeType": "Biuro", "openingTimes": [ { "weekday": 0, "from": "string", "to": "string" } ], "protocolScheduleId": "6d496a63-584a-4438-9730-6708cc1dd3f1", "protocolCronEnabled": true, "onboardingComplete": true, "loginCode": "string" } ], "nextCursor": "string"}{ "error": { "code": "not_configured", "message": "string", "issues": [ { "path": "string", "message": "string", "code": "string" } ] }}{ "error": { "code": "not_configured", "message": "string", "issues": [ { "path": "string", "message": "string", "code": "string" } ] }}{ "error": { "code": "not_configured", "message": "string", "issues": [ { "path": "string", "message": "string", "code": "string" } ] }}Returns one store by the external ID used in your source system.
Authorization
bearerAuth In: header
Path Parameters
Store identifier from your system. This is the public store key used in API paths.
Response Body
application/json
application/json
curl -X GET "https://example.com/v1/stores/store-123"{ "storeId": "b8adcdc8-9238-4168-90f8-77b2d14c211c", "externalId": "string", "name": "string", "location": "string", "regionId": "a29f01e1-8a8d-451e-b685-f8b0b4ec4767", "storeType": "Biuro", "openingTimes": [ { "weekday": 0, "from": "string", "to": "string" } ], "protocolScheduleId": "6d496a63-584a-4438-9730-6708cc1dd3f1", "protocolCronEnabled": true, "onboardingComplete": true, "loginCode": "string"}{ "error": { "code": "not_configured", "message": "string", "issues": [ { "path": "string", "message": "string", "code": "string" } ] }}Creates or updates one store. The path externalId is the public identifier; body fields are optional so you can patch only changed attributes.
Authorization
bearerAuth In: header
Path Parameters
Store identifier from your system. This is the public store key used in API paths.
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Fields accepted when creating or updating a store. Omitted fields keep their current values on update.
Response Body
application/json
application/json
curl -X PUT "https://example.com/v1/stores/store-123" \ -H "Content-Type: application/json" \ -d '{}'{ "storeId": "b8adcdc8-9238-4168-90f8-77b2d14c211c", "externalId": "string", "name": "string", "location": "string", "regionId": "a29f01e1-8a8d-451e-b685-f8b0b4ec4767", "storeType": "Biuro", "openingTimes": [ { "weekday": 0, "from": "string", "to": "string" } ], "protocolScheduleId": "6d496a63-584a-4438-9730-6708cc1dd3f1", "protocolCronEnabled": true, "onboardingComplete": true, "loginCode": "string"}{ "error": { "code": "not_configured", "message": "string", "issues": [ { "path": "string", "message": "string", "code": "string" } ] }}