Developer Console
Anmelden
Anmelden
Developer Console
Vielen Dank für deinen Besuch. Diese Seite ist nur in Englisch verfügbar.

Get Shopper Authorization

The Fraud and Abuse API allows the company to participate in making a gate decision for shopper entry into the Just Walk Out technology enabled store based on a shopper's risk. Amazon offers multiple options for Fraud and Abuse management

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

GetShopperAuthorization

POST v1/fraudandabuse/shopperauthorization

The GetShopperAuthorization API at v1/fraudandabuse/shopperauthorization allows the company to authorize an authenticated shopper.

Body parameter

{
  "storeId": "string",
  "shopperIdentity": {
    "id": "string"
  },
  "authorizedAmount": {
    "value": 0,
    "currencyCode": "str"
  },
  "shopperInteraction": {
    "shoppingTripId": "string",
    "gateAuthenticationEvent": {
      "id": "string",
      "type": "CREDIT_CARD",
      "interactionType": "TAP",
      "timestamp": "2025-03-11T14:45:36Z",
      "location": "ENTRY",
      "data": {
        "property1": "string",
        "property2": "string"
      }
    },
    "recommendation": {
      "shopperAuthorized": true,
      "authorizationConditions": [
        {
          "type": "ADJUST",
          "amount": {
            "value": 0,
            "currencyCode": "str"
          }
        }
      ],
      "shopperRisks": [
        "InvalidCard"
      ]
    },
    "cartHint": {
      "totalPrice": {
        "value": 0,
        "currencyCode": "str"
      },
      "items": [
        {
          "id": "string",
          "type": "SKU",
          "unitPrice": {
            "value": 0,
            "currencyCode": "str"
          },
          "quantity": {
            "value": 0,
            "unit": "string"
          },
          "externalIdentifiers": [
            {
              "id": "string",
              "externalIdentifierType": "UPC"
            }
          ]
        }
      ]
    }
  }
}

Example responses

Example responses

> 200 Response
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. If you have multiple stores, each store will have a unique identifier
shopperIdentity object (ShopperIdentity) Required The shopperIdentity contains a unique Amazon generated id to associate the shopper payment instrument
Data Field Type Description Required
id string [ 1 .. 255 ] characters Required
authorizedAmount object (Amount) Required object (Amount)
Data Field Type Description Required
value number Required Currency amount expressed as an arbitrary decimal value.
currencyCode string [ 1 .. 3 ] characters ^[A-Z]{3}$ Required ISO defined 3-digit currency code
shopperInteraction object (ShopperInteraction) Required object (Amount)
Data Field Type Description Required
shoppingTripId number string [ 0 .. 255 ] characters ^[0-9a-zA-Z_\-]+$, The identifier for a session. SessionId is case-sensitive. Optional
gateAuthenticationEven object (AuthenticationEvent) Required
Data Field Type Description Required
id string 36 characters ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$ The identifier for an event. EventId is strictly lowercase. Required
type string (AuthenticationEventType) Enum: "CREDIT_CARD" "AMAZON_ONE" "QR" "MOBILE_WALLET" "UNRECOGNIZED" Required
interactionType string (InteractionType) Enum: "TAP" "DIP" "SWIPE" Optional
timestamp string date-time ISO-8601 format timestamp ending with 'Z' (UTC timezone). Required
location string (Location) Enum: "ENTRY" "EXIT" Required
data object password (TypeData) Optional object password (TypeData)
Data Field Type Description Required
property name string Optional
amazonRecommendation object (AmazonRecommendation) Optional AMAZON_RECOMMENDATION_DESCRIPTION
Data Field Type Description Required
shopperAuthorized boolean Required
shopperRisks Array of strings (ShopperRiskType) Items Enum: "InvalidCard" "ExpiredCard" "FailureToVetCard" "BillingAddressInvalid" "CustomerFraud" "CustomerConfirmedFraud" "BadDebt" "AccountIssue" "CreditCardFraud" "CardNotSupported" "NonpaymentLowRisk" "NonpaymentMediumRisk" "NonpaymentHighRisk" "NoRiskEvaluationRun" Optional
authorizationConditions Optional Array of objects (AuthorizationCondition)
type Optional string (AuthorizationConditionsType), Value: "ADJUST"
amount Optional object (Amount)
Data Field Description Required
value Required Number, Currency amount expressed as an arbitrary decimal value.
currencyCode Required string [ 1 .. 3 ] characters ^[A-Z]{3}$, ISO defined 3-digit currency code. 
  {
    "recommendation": {
      "shopperAuthorized": true,
      "authorizationConditions": [
        {
          "type": "ADJUST",
          "amount": {
            "value": 0,
            "currencyCode": "str"
          }
        }
      ],
      "shopperRisks": [
        "InvalidCard"
      ]
    },
    "authenticationEventId": "string"
  }
Data Field Required Description
authenticationEventId Optional string [ 1 .. 255 ] characters
recommendation Required object (AmazonRecommendation), AMAZON_RECOMMENDATION_DESCRIPTION
Data Field Description Required
shopperAuthorized Required boolean
shopperRisks Optional Array of strings (ShopperRiskType), Items Enum: "InvalidCard", "ExpiredCard", "FailureToVetCard", "BillingAddressInvalid", "CustomerFraud" ,"CustomerConfirmedFraud", "BadDebt" ,"AccountIssue", "CreditCardFraud", "CardNotSupported", "NonpaymentLowRisk", "NonpaymentMediumRisk", "NonpaymentHighRisk", "NoRiskEvaluationRun"
authorizationConditions Optional Array of objects (AuthorizationCondition)
type Optional string (AuthorizationConditionsType), Value: "ADJUST"
amount Optional object (Amount)
Data Field Description Required
value Required Number, Currency amount expressed as an arbitrary decimal value.
currencyCode Required string [ 1 .. 3 ] characters ^[A-Z]{3}$, ISO defined 3-digit currency code.

GetShopperAuthorization 200 response

Status Meaning Description
200 OK Successful response
400 Internal Server Error Amazon expects a 400 BadRequest when the Fraud and Abuse Connector fails due to an invalid request. For example a missing required value in the API call.
404 Internal Server Error Amazon expects a 404 NoConnectorConfiguredException when the Fraud and Abuse Connector fails due to a missing connector configuration. For example a missing API URI for the GetShopperAuthorization method
500 Internal Server Error Amazon expects a 500 ServerError when the Fraud and Abuse Connector fails due to a server issue. For example an un-handled exception or error occurs when processing the Amazon API call.
503 Internal Server Error Amazon expects a 503 ServerError when the Fraud and Abuse Connector fails due to a server issue. For example an un-handled exception or error occurs when processing the Amazon API call.