Admin api stores
For a given store zone and time return a list of shoppers who were present in the zone at that time
Authorization
bearerAuth AuthorizationBearer <token>
In: header
Path Parameters
storeId*integer
Id of a physical store. The id is required when retailer want to make a call to specified store.
zoneId*string
Query Parameters
timestamp*string
Ether Unix timestamp in milliseconds (always UTC), example: 1697721601000. Or ISO8601 format with milliseconds (timezone can be passed according to standard), example: "2023-10-05T14:48:00.000Z"
Important note: we reject requests with:
Timestamp from the future
Timestamp older than 5 minutes (for now we don't keep historical shoppers)Response Body
application/json
application/json
curl -X GET "https://oasis-api.public.sandbox.oasis.aifi.com/api/admin/v2/stores/0/zones/string/shoppers?timestamp=1697721601000"{
"storeId": 0,
"storeExternalId": "string",
"store": {
"oasisApiStoreId": 0,
"aifiUniqueStoreId": "string"
},
"cameraImages": [
{
"cameraId": 0,
"frameUri": "string"
}
],
"shoppers": [
{
"shopper": {
"shopperId": "string",
"shopperFlags": [
"POTENTIALLY_INTERACTED_WITH_ALCOHOL"
],
"faceCoordinates": [
{
"cameraId": 0,
"location": {
"topLeft": {
"x": 0,
"y": 0
},
"bottomRight": {
"x": 0,
"y": 0
}
}
}
],
"interactionsCount": 0,
"restrictedInteractionsCount": 0,
"interestGroups": [
{
"id": "string",
"name": "string",
"interactionsCount": 0
}
]
},
"session": {
"sessionId": "string",
"shoppingSessionFlags": [
"POTENTIALLY_INTERACTED_WITH_ALCOHOL"
],
"interactionsCount": 0,
"restrictedInteractionsCount": 0,
"interestGroups": [
{
"id": "string",
"name": "string",
"interactionsCount": 0
}
]
},
"customer": {
"externalId": "string",
"role": "customer",
"metadata": {
"arbitraryKey": "arbitraryValue"
},
"priority": 0,
"id": "string"
},
"enteredAt": "2019-08-24T14:15:22Z"
}
]
}Empty
{
"message": "Invalid request body",
"type": "E_INVALID_BODY",
"errors": [
{
"error": "\"email\" is required",
"rule": "any.required",
"field": "\"email\""
}
]
}How is this guide?