reference deployment

Amazon Selling Partner API Reports Notification on AWS

Build and scale your Amazon business with reports and notifications

This Quick Start deploys Amazon Selling Partner API (SP-API) Reports Notification on the Amazon Web Services (AWS) Cloud. It helps Amazon selling partners manage their Amazon business with SP-API reports, notifications, and credentials storage. Automated reports generation gives sellers access to a variety of SP-API reports, such as inventory management, taxes, and invoicing. SP-API notifications alert sellers to relevant changes to their Amazon business, such as order and shipment status. Report creation, notifications, and credentials-storage functions are exposed using Amazon API Gateway endpoints that sellers can integrate into their SP-API applications.

AWS logo

This Quick Start was developed by AWS.

  •  What you'll build
  •  How to deploy
  •  Cost and licenses
  •  What you'll build
  • The Quick Start sets up the following:

    • Three Amazon API Gateway HTTP endpoints, providing REST APIs (application programming interfaces) for three Lambda functions.
      • Token storage to encrypt and store the selling partner's SP-API refresh token. 
      • Notifications subscriber to subscribe the selling partner to the SP-API notifications.
      • Report creator to submit report creation requests to the SP-API.
    • An AWS Identity and Access Management (IAM) role to authenticate API Gateway requests.
    • Two Amazon Dynamo DB tables, one for client tokens and another for report information.
    • A selling partner notifications Amazon Simple Queue Service (Amazon SQS) queue to receive SP-API notifications.
    • A notifications processor Lambda function to listen for SP-API messages and invoke an AWS Step Functions workflow.
    • An AWS Step Functions workflow (report processor) containing the following resources:
      • A report document retrieval Lambda function to retrieve report information from the SP-API.
      • A report document storage Lambda function to store reports in an Amazon Simple Storage Service (Amazon S3) bucket.
      • A presigned URL generator Lambda function to generate presigned URLs for the stored reports.
      • An Amazon Simple Notification Service (Amazon SNS) topic to send email notifications of completed report processing.
      • An Amazon S3 bucket to store reports.
    • AWS Key Management Service (AWS KMS) to encrypt and decrypt client tokens.
    • AWS Secrets Manager to store SP-API IAM user credentials and SP-API application credentials.
  •  How to deploy
  • To deploy this Quick Start, follow the instructions in the deployment guide, which includes these steps. The stack takes about 5 minutes to launch.

    1. Sign up for a Profesional selling plan on Amazon Seller Central and register as a developer to create SP-API applications.
    2. Sign in to your AWS account. If you don't have an account, sign up at https://aws.amazon.com.
    3. Launch the Quick Start. Before you create the stack, choose the AWS Region from the top toolbar.
    4. Complete postdeployment steps.

    Amazon may share user-deployment information with the AWS Partner that collaborated with AWS on the Quick Start.  

  •  Cost and licenses
  • You are responsible for the cost of the AWS services and any third-party licenses used while running this Quick Start reference deployment. There is no additional cost for using this Quick Start.

    The AWS CloudFormation templates for this Quick Start include configuration parameters that you can customize. Some of these settings, such as instance type, affect the cost of deployment. For cost estimates, refer to the pricing pages for each AWS service you use. Prices are subject to change.

    Tip: After you deploy the Quick Start, create AWS Cost and Usage Reports to track costs associated with the Quick Start. These reports deliver billing metrics to an Amazon Simple Storage Service (Amazon S3) bucket in your account. They provide cost estimates based on usage throughout each month and aggregate the data at the end of the month. For more information about the report, refer to What are AWS Cost and Usage Reports?