Admin api customers

Create new entry code for a customer

POST
/api/admin/v2/customers/{customerId}/entry-codes

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

customerId*integer

Query Parameters

displayable?boolean

If true, the returned value will be returned in a form which can be used as a qr-code payload. resulting qr-code can be scanned to let somebody into the store. otherwise the returned value will be returned "as is" and can be used in other calls to the APIs

Request Body

application/json

code?string

Entry code to be added to valid customer codes

groupSize?integer

Group size for that entry code

sessionId?string

Session token sent out later by aifi to identify transactions made on this entry code

referencedSessionId?|

Referenced session token, that points to the source session

Defaultnull
expiresAt?string

ISO 8601 encoded time, at which this entry code will expire. If not specified a default value (depending on a deployment) will be set.

Formatdate-time
priority?integer

Customer priority. default to 0, which means any regular customer. customers with higher priority will have their shopping sessions prioritized during processing, the lower priority is opposite.

Default0
Range-10 <= value <= 10
error?

Card reader error, to allow registration screen to display error message to customer

Response Body

application/json

application/json

curl -X POST "https://oasis-api.public.sandbox.oasis.aifi.com/api/admin/v2/customers/0/entry-codes" \  -H "Content-Type: application/json" \  -d '{}'
{
  "code": "string"
}
Empty
Empty
{
  "message": "Invalid request body",
  "type": "E_INVALID_BODY",
  "errors": [
    {
      "error": "\"email\" is required",
      "rule": "any.required",
      "field": "\"email\""
    }
  ]
}

How is this guide?

AiFI AI Chat

Beta

Powered by AiFi

Ask docs or API questions to get grounded answers.