identity matching
Authorization
bearerAuth In: header
Request Body
application/json
A unique token to identify a shopping session. Note, sessionToken and sessionId are same concept in AIFI system. Deprecated, usesession.sessionId
Customer information
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-timeProvides details about the session for the registered shopper that was matched with the visitor shopper. During identity matching, the system attempts to associate the visitor shopper with the corresponding registered shopper. Ultimately, the goal is to link the visitor shopper to the session of the same customer for whom the registered session was originally created.
Identifier of the Visitor shopper that was matched with registered shopper during identity matching
Response Body
curl -X POST "https://oasis-api.public.sandbox.oasis.aifi.com/api/push/identity-matching" \ -H "Content-Type: application/json" \ -d '{ "sessionId": "d3a00526-1864-4f6e-bb2d-46e3ab7fa780", "customer": { "externalId": "string", "metadata": { "arbitraryKey": "arbitraryValue" }, "id": "string", "role": "customer" }, "storeId": 0, "store": { "oasisApiStoreId": 0, "aifiUniqueStoreId": "string" }, "storeExternalId": "string", "timeOfOrigin": "2019-08-24T14:15:22Z", "timeOfIssue": "2019-08-24T14:15:22Z", "session": { "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "id": 0, "customerId": 0, "code": "c69bb289-1190-4156-b9f6-bfb7f61e85db", "codeFirstSuccesfullyScannedAt": "2019-08-24T14:15:22Z", "codeLastSuccesfullyScannedAt": "2019-08-24T14:15:22Z", "customerFirstEnteredAt": "2019-08-24T14:15:22Z", "customerLastEnteredAt": "2019-08-24T14:15:22Z", "customerFirstExitedAt": "2019-08-24T14:15:22Z", "customerLastExitedAt": "2019-08-24T14:15:22Z", "customerPaymentInstrumentId": 0, "customerSatisfaction": 95, "customerSatisfactionSubmitted": false, "groupSize": 0, "visitors": 0, "locationId": "string", "priority": 0, "sessionToken": "d3a00526-1864-4f6e-bb2d-46e3ab7fa780", "sessionId": "d3a00526-1864-4f6e-bb2d-46e3ab7fa780", "referencedSessionId": null, "status": "active", "storeId": 0, "storeIdScannableAt": 0, "suspectedFraud": false, "metadata": { "events": [ { "eventId": "6bdbfb2d-65b2-491c-bc97-c0ac73338476", "metadata": { "key": "value" } } ], "exampleKey": "exampleValue" }, "expiresAt": "2019-08-24T14:15:22Z" }, "visitorShopperId": "string" }'How is this guide?
request to third party to evaluate order price POST
AiFi system shall call this webhook when a customer checked out but **before** an order is being placed in AiFi system. The webhook expects that the third party system is going to take the list of the products specified and based on them calculate the final total price of the order that is going to be then used to check out the customer. **Note**: as an integrator the URL you specify for this webhook is going to be exactly the URL that will be called. For example if you specify "http://example-retailer-api.com/webhook" then exactly "http://example-retailer-api.com/webhook" will be called.
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.