API Reference

Expositions

Manage the displays, shelves, or product areas that Exponata monitors in each store.

GET
/v1/stores/{externalId}/expositions

Returns the monitored displays configured for the store.

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

externalId*string

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/expositions"
{  "externalId": "string",  "storeId": "b8adcdc8-9238-4168-90f8-77b2d14c211c",  "items": [    {      "expositionId": "9ea3c12e-334c-4cc0-8ef1-de71b907bcd0",      "label": "string",      "friendlyTitle": "string",      "productCategories": [        "SANDWICHES"      ],      "expositionType": "FRIDGE_DRINKS",      "status": "active"    }  ]}
{  "error": {    "code": "not_configured",    "message": "string",    "issues": [      {        "path": "string",        "message": "string",        "code": "string"      }    ]  }}
PUT
/v1/stores/{externalId}/expositions

Creates or updates monitored displays for the store. Existing expositions with the same expositionId are updated.

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

externalId*string

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.

Response Body

application/json

application/json

application/json

curl -X PUT "https://example.com/v1/stores/store-123/expositions" \  -H "Content-Type: application/json" \  -d '{    "expositions": [      {        "label": "string",        "productCategories": [          "SANDWICHES"        ],        "expositionType": "FRIDGE_DRINKS"      }    ]  }'
{  "externalId": "string",  "storeId": "b8adcdc8-9238-4168-90f8-77b2d14c211c",  "items": [    {      "expositionId": "9ea3c12e-334c-4cc0-8ef1-de71b907bcd0",      "label": "string",      "friendlyTitle": "string",      "productCategories": [        "SANDWICHES"      ],      "expositionType": "FRIDGE_DRINKS",      "status": "active"    }  ]}
{  "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"      }    ]  }}