Get Scan Details
The GetScanDetails API retrieves loyalty provider metadata for validated scans in JWO/RFID stores. This API is called after successful scan validation via ResolveScan to fetch additional loyalty information for accepted shoppers.
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
GetScanDetails
POST /v1/identity/scan/details
The GetScanDetails API allows retrieval of loyalty provider metadata for previously validated scan results. The GetScanDetails API allows the company to provide additional loyalty provider metadata for a resolved scan event.
Body parameter
{
"storeId": "string",
"scanResult": {
"id": "string",
"type": "string"
}
}
| Data Field | Type | Required | Description | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| storeId | string <= 255 characters | Required | The storeId field contains the store identifier that Amazon assigned to you during your onboarding process | |||||||||||
| scanResult | object (ScanResult) | Required | Scan result from successful ResolveScan response | |||||||||||
|
||||||||||||||
Succcess response
> 200 Response{
"provider": "string",
"promotionIds": ["string"]
}
| Data Field | Type | Description | Required |
|---|---|---|---|
| provider | string <= 255 characters | Required | The loyalty provider name associated with the scan result |
| promotionIds | array[string] | Required | List of promotion identifiers associated with the loyalty scan |
Error responses
Get Scan Details example responses
| Status | Meaning | Description |
|---|---|---|
| 404 | Not Found Error | The API returns a 404 when the request is made to an unknown resource |
| 404 | Not Found | The API returns a 404 when the requested resource could not be found |
| 500 | Internal Server Error | Amazon expects a 500 ServerError when the Identity Connector fails due to a server issue |