Developer Console
Accedi
Accedi
Developer Console
Ti ringraziamo per la visita. Questa pagina รจ per il momento disponibile solo in inglese.

Resolve Scan

The Identity Connector is a simple API provided to Amazon which will be called whenever a shopper scans their Scan Key Code at the JWO gate or when a store associate scans the associate device to identify the shopper while assisting the shopper. The Identity Connector provides an interface between the company's backend identity systems and Amazonโ€™s Identity Gateway. When a shopper scans their Scan Key Code at the JWO gate, Amazon will call the Identity Connector and pass the shopperโ€™s identity key. Once the shopperโ€™s identity is received, the company can verify the shopperโ€™s identity key and decide whether to allow them to shop in the store

Note: In the future, new attributes might be added. We recommend that you structure your code so that it can handle new attributes gracefully

Operations

ResolveScan

POST /v1/identity/scan

The ResolveScan API at /v1/identity/scan allows the company to validate the loyalty scanned data and provide resolution back to Amazon system

Body parameter

{
  "requestId": "string",
  "storeId": "string",
  "scanEvent": {
    "id": "string",
    "timestamp": "2024-04-25T13:03:14Z",
    "location": "ENTRY",
    "value": "string",
    "channel": "OPTICAL"
  }
}
Data Field Type Required Description
requestId string ^[0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{12}$ Required The requestId field holds a unique identifier (UUID) that Amazon generates each time a request is made to the company Connector
storeId string <= 255 characters. Required The storeId field contains the store identifier that Amazon assigned to you during your onboarding process. If you have multiple stores, each store will have a unique identifier. You use this field to identify in which one of your store locations a shopper is scanning their loyalty id in
scanEvent object (ScanEvent) Required object (ScanEvent)
Data Field Type Description Required
id string ^[0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{12}$ Required The ScanEvent.id is a UUID used to uniquely identify a shopper's scan event
timestamp string ,date-time Required The scanEvent.timestamp stores the date and time the scanEvent occurred in UTC format
location string (AuthLocation) Required Enum: "ENTRY", "EXIT", "MANUAL_IN_STORE", The location is an enumerated string containing the point of scan interation by the shopper.
value string <= 1000 characters Required ScanEvent.value represents payload captured by the Amazon Systems and requires a resolution from the customer's systems e.g. in case of a QR code scan, badge scan etc. The Amazon Identity API will pass a base64 encoded value for the scan code. Base64 encoding is not applicable if KeyChannel=RADIO. The processing application will be required to decode the incoming value.
channel string (KeyChannel) Required Enum: "OPTICAL", "RADIO", "CONTACT", The keyChannel object contains required information about the harware channel thru which the key was read.

Example responses

> 200 Response

Success example responses

{
  "id": "string",
  "type": "SHOPPER",
  "action": "ACCEPT"
}
Data Field Type Description Required
id string <= 255 characters Required The ResolveScanResponse.id is to be used to provide an identifier to Amazon systems to associate with the shopping.
type string (ScanResponseType) Required Enum: "SHOPPER", "ASSOCIATE", "CASH", "LOYALTY"
action string (Action) Required Enum: "ACCEPT" ,"REJECT"

Error example responses

{
  "message": "string"
}

Status code response samples

Status Meaning Description
200 OK Successful response
500 Internal Server Error You will respond with a 500 ServerError when the Identity Connector fails due to a server issue. For example an un-handled exception or error occurs when processing the Amazon API call.
Amazon Developer Assistant