API Reference
Expectations
Define expected fill-rate targets by weekday, protocol time, display type, and product category.
Returns the fill-rate expectations used when calculating analytics deltas and below-expectation flags.
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/expectations"{ "externalId": "string", "items": [ { "expectationId": "2572de4d-522b-4b7c-9f24-c08b7255c034", "productCategory": "SANDWICHES", "displayType": "FRIDGE_DRINKS", "weekday": 0, "protocolTime": "string", "expectedFillRatio": 0, "updatedAt": "2019-08-24T14:15:22Z" } ]}{ "error": { "code": "not_configured", "message": "string", "issues": [ { "path": "string", "message": "string", "code": "string" } ] }}Replaces the full expectation set for the store. Expectations match by display type, weekday, protocol time, and optionally product category.
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/expectations" \ -H "Content-Type: application/json" \ -d '{ "expectations": [ { "productCategory": "SANDWICHES", "displayType": "FRIDGE_DRINKS", "weekday": 0, "protocolTime": "string", "expectedFillRatio": 0 } ] }'{ "externalId": "string", "items": [ { "expectationId": "2572de4d-522b-4b7c-9f24-c08b7255c034", "productCategory": "SANDWICHES", "displayType": "FRIDGE_DRINKS", "weekday": 0, "protocolTime": "string", "expectedFillRatio": 0, "updatedAt": "2019-08-24T14:15:22Z" } ]}{ "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" } ] }}