start remote register
Authorization
bearerAuth In: header
Request Body
application/json
AiFi store id
Retailer store id
ISO formatted creation time of the event, that caused this webhook to be sent
date-timeISO formatted time, in which this webhook was sent
date-timeA unique token to identify a shopping session. Note, sessionToken and sessionId are same concept in AIFI system.
Registration token type
"SESSION_ID""NONE" | "STRIPE" | "PAYTER" | "ADYEN" | "FREEDOM_PAY" | "GENERIC" | "SESSION_ID"This property will contain a null value if the endpoint /api/admin/v2/customers/remote-register was used. However, it's guaranteed to have a proper value if the endpoint /api/admin/v2/stores/{storeId}/check-in/{checkInDeviceId}/remote-register was used
Customer information
Response Body
curl -X POST "https://oasis-api.public.sandbox.oasis.aifi.com/api/push/remote-register" \ -H "Content-Type: application/json" \ -d '{ "storeId": 0, "store": { "oasisApiStoreId": 0, "aifiUniqueStoreId": "string" }, "storeExternalId": "string", "timeOfOrigin": "2019-08-24T14:15:22Z", "timeOfIssue": "2019-08-24T14:15:22Z", "token": "d3a00526-1864-4f6e-bb2d-46e3ab7fa780", "checkInDeviceId": 0, "customer": { "externalId": "string", "metadata": { "arbitraryKey": "arbitraryValue" }, "id": "string", "role": "customer" }, "customerPersonalInfo": { "email": "user@example.com", "firstName": "string", "lastName": "string", "phone": "string", "phoneNumber": "string" } }'How is this guide?
planogram error notification POST
AiFi system will trigger this webhook when a planogram error is reported in a store. This webhook provides information about the location where the planogram error was reported including store details gondola ID and shelf ID. Additional details may be included if available (such as bin index). This webhook is intended to be only informative: no response is parsed and no action is taken regardless of the response.
restricted products interactions POST
The AiFi system will trigger this webhook when shopper will interact with any of restricted products