Admin api stores

Create an frame annotation event for IDAP

POST
/api/admin/v2/stores/{storeId}/idapDevices/{idapDeviceId}/frame-annotation-event

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.

idapDeviceId*string

Id of the IDAP device

Request Body

application/json

timestamp*integer

unix timestamp (in milliseconds) when this event occurred

uniqueEventId*string

unique id of the event

Lengthlength <= 256
sessionId?|

A unique token to identify a shopping session. Note, sessionToken and sessionId are same concept in AIFI system.

Defaultnull
Lengthlength <= 256
oldShopperId?|

Identifier of previous shopper that did reid

Defaultnull
metadata*

Response Body

application/json

application/json

curl -X POST "https://oasis-api.public.sandbox.oasis.aifi.com/api/admin/v2/stores/0/idapDevices/37a426e5-f432-4f1c-9563-f6a8c795ca39/frame-annotation-event" \  -H "Content-Type: application/json" \  -d '{    "timestamp": 1709171638704,    "uniqueEventId": "bbd3fb79-f6c0-44df-bee0-0647e51b6c83",    "metadata": {      "subsystem": "FACE"    }  }'
{
  "uniqueEventId": "bbd3fb79-f6c0-44df-bee0-0647e51b6c83"
}
Empty
{
  "message": "Invalid request body",
  "type": "E_INVALID_BODY",
  "errors": [
    {
      "error": "\"email\" is required",
      "rule": "any.required",
      "field": "\"email\""
    }
  ]
}

How is this guide?

AiFI AI Chat

Beta

Powered by AiFi

Ask docs or API questions to get grounded answers.