as

Settings
Sign out
Notifications
Alexa
Amazonアプリストア
Ring
AWS
ドキュメント
Support
Contact Us
My Cases
Docs
Resources
Ecommerce Plug-ins
Publish
Connect
アクセスいただきありがとうございます。こちらのページは現在英語のみのご用意となっております。順次日本語化を進めてまいりますので、ご理解のほどよろしくお願いいたします。

Sample Store - App Entry

Disclaimer: This document contains sample content for illustrative purposes only. Organizations should follow their own established best practices, security requirements, and compliance standards to ensure solutions are production-ready.

Overview

This page provides a consolidated view of all the capabilities, APIs, and documentation required to implement a Just Walk Out store using app-based entry. In this model, the retailer manages shopper identity verification through a mobile app, delegates charge calculation to their own POS system, and handles payment orchestration independently.

Store Profile

Attribute Value
Entry Method Mobile app QR code scan
Identity Verification Retailer-managed via Verify Identity Keys API
Charge Calculation Order Delegation (retailer POS)
Payment Orchestration Retailer-managed
Catalog Management Catalog API

APIs in Scope

API Endpoint Purpose
Upload Catalog POST /v1/catalog/upload Upload product catalog to Amazon systems
Get Catalog Upload Status POST /v1/catalog/getCatalogUploadStatus Check catalog upload processing status
Verify Identity Keys POST /v1/identity/identity-keys Authorize shoppers at the JWO gate
Create Purchases POST /v1/order/purchases Receive the shopping cart and create a purchase record

1. Catalog Management

Before your store can operate, you must upload a product catalog to Amazon's systems. The catalog maps SKUs to barcodes, product names, and store IDs so that items picked up by shoppers can be identified.

Key Documentation

Topic Link
Catalog Overview Catalog Considerations
Catalog Data Fields Catalog Items
Reference Architecture Catalog Reference Architecture
API Setup Configure Catalog API
Upload Catalog API Upload Catalog
Get Upload Status API Get Catalog Upload Status
Catalog Maintenance Catalog Maintenance

Integration Summary

  1. Set up your AWS account and IAM role with Invoke API permissions
  2. Deploy the CloudFormation templates for SQS and connectivity testing
  3. Onboard your AWS account and SQS ARN via the Merchant Portal
  4. Confirm the SNS subscription for upload result notifications
  5. Upload your catalog (max 10,000 items per request, 10 requests/second)
  6. Track upload status via the Get Catalog Upload Status API or SNS/SQS notifications
  7. Download and process the upload result report from the S3 presigned URL (valid for 60 minutes)

2. Shopper Entry — App-Based Authorization

Shoppers enter the store by scanning a QR code generated by your mobile app. Amazon calls your Verify Identity Keys API to authorize the shopper. You verify the identity key and return a gate decision.

Key Documentation

Topic Link
Entry Experience Overview Shopper Entry Experience
Mobile App Entry Mobile App Entry
API Setup Configure Shopper Entry API
Verify Identity Keys API VerifyIdentityKeys

Integration Summary

  1. Build a mobile app that generates QR code Scan Key Codes per JWO specifications
  2. Implement the Verify Identity Keys API (POST /v1/identity/identity-keys) as your Identity Connector
  3. Decode the Base64-encoded identityKey and validate the shopper
  4. Return visitor details with type SHOPPER, ASSOCIATE, or CASH_SHOPPER
  5. Handle all requests idempotently using the authEvent.id
  6. Ensure responses return within 2 seconds

Gate Behavior

Response Code Gate Action
200 Gate opens
400 Gate remains closed
401 Gate remains closed
429 Gate remains closed
500 Gate follows store default decision

3. Charge Calculation — Order Delegation

After the shopper exits, Amazon calls your Create Purchases API with the virtual shopping cart. You calculate pricing, apply promotions and taxes, and return a purchaseId.

Key Documentation

Topic Link
Charge Calculation Overview Charge Calculation Overview
Setup Charge Calculation Setup
API Setup Configure Charge Calculation API
Create Purchases API Create Purchases

Integration Summary

  1. Implement the Create Purchases API (POST /v1/order/purchases) as your Ordering Connector
  2. Receive the cart with item SKUs, quantities, shopping trip details, and auth events
  3. Calculate pricing, promotions, and taxes using your POS system
  4. Return a purchaseId for cross-system tracking
  5. Handle empty carts by returning an empty purchaseId and triggering pre-auth cancellation
  6. Route unrecognized SKUs to your bad cart handling process
  7. Handle all requests idempotently using the idempotentShoppingTripId

4. Testing

Test Plans

Test Plan Link
Catalog Test Plan Catalog Test Plan
App Entry Store Test Plan App Entry Store Test Plan

Test Cases

Test Cases Link
Catalog Upload & Inventory Sync Catalog Upload Test Cases
Verify Identity Keys Verify Identity Keys Test Cases
Create Purchases Create Purchases Test Cases

Testing Phases

Phase Description Link
Functional / Mock Testing Test APIs with mock data before connecting to live systems Mock Testing
Connectivity Testing Verify your AWS account can invoke Amazon APIs Connectivity Testing
End-to-End Testing Complete shopping journey from entry to charge E2E Testing
Load Testing Validate performance under peak concurrent load Load Testing

5. Operational Readiness

Resource Link
Operational Readiness Overview Overview
App Entry Store WAR Well-Architected Review
Catalog Upload WAR Catalog Upload Well-Architected Review

End-to-End Flow

┌─────────────────────────────────────────────────────────────────┐
│                    PRE-LAUNCH SETUP                              │
│                                                                  │
│  1. Upload Catalog ──► POST /v1/catalog/upload                  │
│  2. Check Status ────► POST /v1/catalog/getCatalogUploadStatus  │
│  3. Process SNS/SQS notification ──► Download result report     │
└─────────────────────────────────────────────────────────────────┘
                              │
                              ▼
┌─────────────────────────────────────────────────────────────────┐
│                    SHOPPER ENTRY                                 │
│                                                                  │
│  1. Shopper opens mobile app ──► QR code generated              │
│  2. Shopper scans QR at gate                                    │
│  3. Amazon calls ──► POST /v1/identity/identity-keys            │
│  4. Retailer verifies identity key ──► 200 = gate opens         │
│  5. Pre-auth placed on payment instrument                       │
└─────────────────────────────────────────────────────────────────┘
                              │
                              ▼
┌─────────────────────────────────────────────────────────────────┐
│                    SHOPPING                                       │
│                                                                  │
│  Shopper picks up items ──► Amazon tracks virtual cart           │
└─────────────────────────────────────────────────────────────────┘
                              │
                              ▼
┌─────────────────────────────────────────────────────────────────┐
│                    SHOPPER EXIT & CHARGE                          │
│                                                                  │
│  1. Shopper exits store                                         │
│  2. Amazon calls ──► POST /v1/order/purchases                   │
│  3. Retailer calculates pricing, promotions, taxes              │
│  4. Retailer returns purchaseId                                 │
│  5. Retailer charges payment instrument                         │
│  6. Empty cart ──► cancel pre-auth                              │
└─────────────────────────────────────────────────────────────────┘

Generate Project Plan

📋

Would you like to generate a detailed project plan?

Generate a CSV project plan with tasks, dates, and milestones based on your target launch date.


Operational Readiness Checklist

Would you like an operational readiness checklist?

Download a checklist covering all operational readiness items for your app-entry JWO store launch.