Check parcels
Authorization
bearerAuth In: header
Path Parameters
Id of a physical store. The id is required when retailer want to make a call to specified store.
Request Body
application/json
Id of customer
Response Body
application/json
application/json
curl -X POST "https://oasis-api.public.sandbox.oasis.aifi.com/api/admin/v2/stores/0/parcels/check" \ -H "Content-Type: application/json" \ -d '{ "customerId": 0, "parcels": [ { "barcode": "string", "quantity": 1 } ] }'{
"status": "CORRECT"
}{
"message": "Invalid request body",
"type": "E_INVALID_BODY",
"errors": [
{
"error": "\"email\" is required",
"rule": "any.required",
"field": "\"email\""
}
]
}How is this guide?
Verify entry code and check in by device id POST
Endpoint returns 200 http code also in all instances when the code was successfully examined but rejected from one of the reasons bellow. Http error codes are used only when there are other errors preventing the check. When the code is validated successfully the response includes `status:OK` and `sessionId` `sessionId` is _customer's shopping session id_ (also referenced as transactionId on some AIFI diagrams). When the code is validated failed the response includes `status:FAILED` and `reason`. List of possible reasons for which the code could get rejected: message: 'Invalid verification code' code: 1 message: 'Verification code has expired' code: 2 message: 'Verification code was already used' code: 3 message: 'Verification code was already declined' code: 4 message: 'Verification code was issued for different store' code: 5 message: 'Customer was not found' code: 6 message: "Customer doesn't have associated stripe customerId" code: 7 message: "Customer doesn't have payment method set up" code: 8 message: "Customer has unsettled transactions" code: 9 message: "Customer's card is expired" code: 10 message: "The limit of people in this store was reached" code: 11 message: "The store is closed" code: 12 message: "The store is closed for maintenance" code: 13 message: "External verification error" code: 14 message: "Couldn't pre-authorize required amount on customer's card" code: 15
Create a store POST
Next Page