Push transitions

customer left a store

POST
/api/push/transition/left

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Request Body

application/json

sessionId*stringDeprecated

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

session*|
customer*

Customer information

storeId*integer

AiFi store id

store*
storeExternalId*|

Retailer store id

timeOfOrigin*string

ISO formatted creation time of the event, that caused this webhook to be sent

Formatdate-time
timeOfIssue*string

ISO formatted time, in which this webhook was sent

Formatdate-time
payment*
shopperId*string

Identifier of the Shopper

shopper*

Response Body

application/json

curl -X POST "https://oasis-api.public.sandbox.oasis.aifi.com/api/push/transition/left" \  -H "Content-Type: application/json" \  -d '{    "sessionId": "d3a00526-1864-4f6e-bb2d-46e3ab7fa780",    "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"    },    "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",    "payment": {      "paymentProvider": "NONE"    },    "shopperId": "string",    "shopper": {      "shopperId": "string"    }  }'
"string"

How is this guide?

customer entered a store POST

AiFi system shall call this webhook when a customer entered a store. This webhook is intended to be only informative: no response is parsed and no action is taken regardless of the response. **IMPORTANT NOTE**: This event is going to be triggered for **every person from the group** that entered on the account of the provided customer. As an example for a group of 2 people that enter together on a single app you get the exact same push notification twice with ```customer``` field being the person that app was registered for after each person has entered the store. **Note**: as an integrator the URL you specify for transitions webhooks will be re-used for all transitions 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.

AiFI AI Chat

Beta

Powered by AiFi

Ask docs or API questions to get grounded answers.