customer left a checkout zone
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-timeFor old integrations it will be sent as an integer, while for new ones it will be a string. Eventually all integrations will be converted to strings.
Object holding information about the shopper who triggered the webhook
Available only if the webhook is configured with option 'send_cart'
Response Body
application/json
curl -X POST "https://oasis-api.public.sandbox.oasis.aifi.com/api/push/checkout-zone/left" \ -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" }, "checkoutZoneId": "string", "shopper": { "shopperId": "string" } }'"string"How is this guide?
customer entered a checkout zone POST
AiFi system shall call this webhook when a customer entered a checkout zone in a given store. This webhook is intended to be only visual: no response is parsed and no action is taken regardless of the response. **Note**: as an integrator the URL you specify for checkout zone webhooks will be re-used for all checkout zone actions. For example if you specify "http://example-retailer-api.com/webhook" then "http://example-retailer-api.com/webhook/entered" will be called in this case.
customer was created or updated POST
AiFi system shall call this webhook when a customer is created and his personal data is fully collected. Additionally it will be called every time when existing customer's personal data is updated. Personal data considered here is either of [firstName lastName email phoneNumber]. This webhook is intended to be only informative: no response is parsed and no action is taken regardless of the response. **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.