Jump to Content
Selling Partner API
HomeDocumentationCode SamplesAPI ReferenceAnnouncementsModelsRelease NotesFAQGitHubVideos
Developer HubAPI StatusSupportSelling Partner API
Documentation
Developer HubAPI StatusSupport
HomeDocumentationCode SamplesAPI ReferenceAnnouncementsModelsRelease NotesFAQGitHubVideos

Get Started

  • Welcome to SP-API Documentation
  • What is the Selling Partner API?
  • Onboarding to the SP-API
    • Step 1: Prepare for Registration
    • Step 2: Create a Solution Provider Portal Account
    • Step 3: Create a Developer Profile
    • Step 4: Register a Sandbox Application
    • Step 5: Make Your First Call to the SP-API Sandbox
    • Step 6: Set up the Authorization Workflow
    • Step 7: Register Your Production Application
    • Step 8: Call the SP-API in Production
    • Step 9: Test Your Application
    • Step 10: List Your Application
  • Terminology
  • Frequently Asked Questions
    • SP-API General FAQ
    • Solution Provider Portal FAQ

Changelog

  • SP-API Release Notes
  • SP-API Deprecation Schedule
  • SP-API Product Metadata Updates

Directories

  • SP-API Models
  • SP-API Code Samples
  • SP-API Seller Use Cases
  • SP-API Vendor Use Cases
  • Seller Central URLs
  • Vendor Central URLs

Registration

  • SP-API Registration Overview
    • Register as a Public SP-API Developer
    • Register as a Private SP-API Developer
    • Register as a Private SP-API Vendor
    • Solution Provider Identity Verification
  • Developer Registration Request Status
  • Third-Party Provider Registration
    • Third-Party Provider Signature Guidance
    • Third-Party Provider FAQ
  • Service Provider Registration and Migration
  • User Permissions for Service Providers
  • Solution Provider Portal Account Unification
  • Register your Application
  • Update your Application Information
  • Rotate your Application's LWA Credentials
    • LWA Credentials FAQ
  • View your Application Information and Credentials
  • Selling Partner API Roles
    • Role Mappings for SP-API Operations
    • Role Mappings for SP-API Types
  • Policies and Agreements
  • About Facial Data

Authorization

  • Authorize Applications
    • Authorize Public Applications
      • Selling Partner Appstore Authorization Workflow
      • Website Authorization Workflow
    • Authorize Private Applications
  • Renew Authorizations
  • Revoke Self-Authorizations
  • Authorization Limits
  • Special Authorization Types
    • Authorize your Application to Access Vendor Groups
    • Authorization with the Restricted Data Token

Integration

  • Building Robust Amazon SP-API Applications
  • SP-API SDKs
    • Connect to the Selling Partner API Using a Generated C# SDK
    • Connecting to the Selling Partner API Using a Generated Java SDK
    • Tutorial: Automate your SP-API calls using C# SDK
    • Tutorial: Automate your SP-API calls using Java SDK
    • Tutorial: Automate your SP-API calls using JavaScript SDK for Node.js
    • Tutorial: Automate your SP-API calls using Python SDK
    • Tutorial: Automate your SP-API calls using prebuilt Java SDK
    • Tutorial: Automate your SP-API calls using a prebuilt JavaScript SDK
    • Tutorial: Automate your SP-API calls using prebuilt PHP SDK
    • Tutorial: Automate your SP-API calls using a prebuilt Python SDK
  • Delete an Application From Your Developer Account

Calling the SP-API

  • Configuration Details
    • SP-API Endpoints
    • Marketplace IDs
    • Date and Time Formatting
    • Grantless Operations
  • Call Structure
    • Connect to the SP-API
    • Parse SP-API Responses
  • Development Tools
    • Selling Partner API Sandbox
    • Using Postman for Selling Partner API Models
  • Performance Management
    • Usage Plans and Rate Limits
    • Optimize Rate Limits for Application Workloads

Tutorials

  • Tutorial: Test Selling Partner API Endpoints
  • Tutorial: Automate your SP-API Calls Using a C# SDK
  • Tutorial: Automate your SP-API Calls Using a Java SDK
  • Tutorial: Automate your SP-API Calls Using a JavaScript SDK for Node.js
  • Tutorial: Automate your SP-API Calls Using a Python SDK
  • Tutorial: Automate your SP-API Calls using prebuilt Java SDK
  • Tutorial: Automate your SP-API Calls using a prebuilt JavaScript SDK
  • Tutorial: Automate your SP-API Calls using prebuilt PHP SDK
  • Tutorial: Automate your SP-API calls using a prebuilt Python SDK
  • Tutorial: Subscribe to the ORDER_CHANGE Notification
  • Tutorial: Authorize Multiple Vendor Central Accounts with a Single SP-API Application
  • Tutorial: Retrieve Merchant Shipping Templates
  • Tutorial: Grant the SP-API Permission to an Amazon SQS Queue
  • Tutorial: Retrieve and Pass a Purchase Order Number to a Carrier

Troubleshooting

  • SP-API Errors FAQ
  • URL Encoding
  • Resolve 400 Errors
  • Authorization Errors
  • Listings Items API Issues Troubleshooting
  • Troubleshoot Seller Accounts

Selling Partner Appstore

  • What is the Selling Partner Appstore?
  • List Your App on the Selling Partner Appstore
  • Edit Your Appstore Listing
  • Check Listing Status
  • Amazon Selling Partner Appstore Badge
  • Appstore Ratings and Reviews
  • Press Releases and Promotions

Security and Compliance

  • Amazon Selling Partner API Guard Implementation Guide
    • Architecture Overview
      • Guard Components
      • Guard Cost
      • Guard Source Code
      • Guard and Security
    • Regional Guard Deployments
      • Automated Guard Deployment
      • AWS CloudFormation Template
    • Update Guard
    • Uninstall Guard
    • Troubleshoot
    • Guard Intellectual Property License
    • Guard Legal Notice
  • VAT Calculation Service
    • Create and Upload Invoices
    • Invoice Compliance and Correction
    • Use Cases
    • Error Handling
    • Best Practices
    • Launch Readiness Checklist
  • Amazon Seller Data Access
  • Technical Papers
    • Vulnerability Management
    • Network Protection Guidance
    • Key Security Control Guidance
    • Logging and Monitoring for Amazon API Applications
    • Protect Amazon API Applications with Data Retention and Recovery
    • Protect Amazon API Applications with Data Encryption
    • Protect Amazon API Applications with Incident Response
    • Safeguarding Sensitive Credentials

A+ Content API

  • A+ Content API v2020-11-01 Use Case Guide
  • A+ Content Examples
  • A+ Content API Rate Limits
  • A+ Content 2020-11-01 Model

Amazon Warehousing and Distribution API

  • Amazon Warehousing and Distribution API Use Case Guide
    • Amazon Warehousing and Distribution API v2024-05-09 Reference
  • Amazon Warehousing and Distribution API Rate Limits
  • Amazon Warehousing and Distribution API v2024-05-09 Model

App Integrations API

  • App Integrations v2024-04-01 Use Case Guide
  • App Integrations API Rate Limits
  • App Integrations API v2024-04-01 Model

Application Management API

  • Application Management API v2023-11-30 Use Case Guide
  • Application Management API Rate Limits
  • Application Management API v2023-11-30 Model

Catalog Items API

  • Catalog Items API v2022-04-01 Use Case Guide
    • Catalog Items API v2022-04-01 Model
    • Catalog Items API v2022-04-01 Reference
  • Catalog Items API v2020-12-01 Use Case Guide
    • Catalog Items API v2020-12-01 Model
  • Catalog Items API v0 Model
  • Catalog Items API Rate Limits

Data Kiosk

  • Data Kiosk API v2023-11-15 Use Case Guide
  • Data Kiosk Schema Explorer User Guide
  • Data Kiosk Query Processing Finished Notification
  • Building Data Kiosk workflows guide
  • Vendor Analytics Dataset Use Case Guide
  • Schedule Data Kiosk Queries
  • Data Kiosk API Rate Limits
  • Data Kiosk API v2023-11-15 Model

Easy Ship API

  • Easy Ship API v2022-03-23 Use Case Guide
  • Easy Ship API Rate Limits
  • Easy Ship API v2022-03-23 Model

Fulfillment By Amazon (FBA)

  • FBA Inbound Eligibility API v1 Model
  • FBA Inventory API v1 Use Case Guide
    • FBA Inventory Dynamic Sandbox Guide
    • FBA Inventory API v1 Model
  • FBA Inbound Eligibility API Rate Limits
  • FBA Inventory API Rate Limits

Feeds API

  • Feeds API v2021-06-30 Use Case Guide
  • Feed Type Values
    • Business Feed Type Values
    • Easy Ship Feed Type Values
    • Fulfillment By Amazon Feed Type Values
    • Invoicing Feed Type Values
    • Listings Feed Type Values
    • Order Feed Type Values
  • Feeds JSON Schemas
  • Feeds API Best Practices
  • Feeds API FAQ
  • Feeds API Rate Limits
  • Feeds API v2021-06-30 Model

Finances

  • Finances API v0 Use Case Guide
    • Finances v0 Model
  • Finances API v2024-06-19 Use Case Guide
    • Finances v2024-06-19 Model
    • Finances API v2024-06-19 Reference
  • Transfers API v2024-06-01 Use Case Guide
    • Transfers API v2024-06-01 Model
  • Finances API Rate Limits
  • Transfers API Rate Limits

Fulfillment Inbound API

  • Fulfillment Inbound API v2024-03-20 Use Case Guide
    • Tutorial: Create a shipment when the seller knows the carton-level information up-front
    • Tutorial: Create a shipment when the seller does not know the carton-level information up-front
    • Tutorial: Ship Inventory to Amazon Fulfillment Centers in India
    • Tutorial: Create a shipment with a non-partnered carrier
    • Tutorial: Create a shipment with an Amazon-partnered carrier (PCP)
    • Additional Functionality
    • Fulfillment Inbound API v2024-03-20 Model
  • Fulfillment Inbound API v0 Model
  • Fulfillment Inbound API FAQ
  • Migrating Fulfillment Inbound workflows
  • Fulfillment Inbound API Rate Limits

Fulfillment Outbound API

  • Fulfillment Outbound Dynamic Sandbox Guide
  • Fulfillment Outbound API v2020-07-01 Use Case Guide
  • Fulfillment Outbound API Rate Limits
  • Fulfillment Outbound API v2020-07-01 Model

Invoices API

  • Invoices API v2024-06-19 Use Case Guide
  • Invoices API FAQ
  • Invoices API Rate Limits
  • Invoices API v2024-06-19 Model

Listings

  • Manage Product Listings with the Selling Partner API
  • Building Listings Management Workflows Guide
  • Listings Management Workflow Migration
    • Listings migration strategies
    • Listing workflow migration tutorial
    • Mapping product attributes to the Listings Items API and JSON-based feeds
    • Additional Listings migration resources
    • Listings migration FAQ
  • Manage Amazon Haul, Advanced Multiple-Offer, and Multiple-Fulfillment Use Cases
  • Listings Items API v2021-08-01 Use Case Guide
    • Guidance for Complex Attributes
    • Listings Items API v2021-08-01 Model
  • Listings Items API Issues Troubleshooting
  • Listings Items API v2020-09-01 Use Case Guide
    • Listings Items API v2020-09-01 Model
  • Listings Restrictions API v2021-08-01 Use Case Guide
    • Listings Restrictions API v2021-08-01 Model
  • Product Type Definitions API v2020-09-01 Use Case Guide
    • Product Type Definitions API v2020-09-01 Model
    • Amazon Product Type Definitions Meta-Schema (v1)
      • C# Example of Meta-Schema v1
      • Java Example of Meta-Schema v1
      • Javascript Example of Meta-Schema v1
  • Listings APIs FAQ
  • Listings Items API Rate Limits
  • Listings Restrictions API Rate Limits
  • Product Type Definitions API Rate Limits

Merchant Fulfillment API

  • Merchant Fulfillment API v0 Use Case Guide
  • Merchant Fulfillment API Rate Limits
  • Merchant Fulfillment API v0 Model

Messaging API

  • Messaging API v1 Use Case Guide
  • Messaging API Rate Limits
  • Messaging API v1 Model

Notifications API

  • Notifications API v1 Use Case Guide
    • Tutorial: Grant SP-API Permission to an Amazon SQS Queue
    • Tutorial: Subscribe to the ORDER_CHANGE notification
  • Notification Type Values
  • Notifications API Rate Limits
  • Notifications API v1 Model

Orders API

  • Orders API v0 Use Case Guide
  • Regulated Orders
  • Amazon Business Orders Use Case Guide
  • Tutorial: Retrieve and Pass a Purchase Order Number to a Carrier
  • Orders API Rate Limits
  • Orders API v0 Model

Product Fees API

  • Product Fees v0 Use Case Guide
  • Product Fees API Rate Limits
  • Product Fees API v0 Model

Product Pricing API

  • Product Pricing API and Notifications FAQ
  • Price Adjustment Automation Workflows Guide
  • Manage automated pricing rules with SP-API
  • Product Pricing API v2022-05-01 Use Case Guide
    • Product Pricing API v2022-05-01 Model
  • Product Pricing API v0 Use Case Guide
    • Product Pricing API v0 Model
  • Product Pricing API Rate Limits

Replenishment API

  • Replenishment API v2022-11-07 Use Case Guide
  • Replenishment API Rate Limits
  • Replenishment API v2022-11-07 Model

Reports API

  • Reports API v2021-06-30 Use Case Guide
    • Tutorial: Request a report
    • Tutorial: Schedule and Retrieve Reports
    • Tutorial: Retrieve Automatically Generated Reports
    • Verify that Report Processing is Complete
    • Retrieve a Report
  • Report Type Values
    • Payment Reports
    • Analytics Reports
    • Inventory Reports
    • Order Reports
    • Returns Reports
    • Performance Reports
    • Settlement Reports
    • Fulfillment by Amazon (FBA) Reports
    • Tax Reports
    • Invoice Data Reports
    • Browse Tree Reports
    • Easy Ship Reports
    • Amazon Business Reports
    • B2B Product Opportunities Reports
    • Regulatory Compliance Reports
  • Reports JSON Schemas
  • Reports API FAQ
  • Reports API Rate Limits
  • Reports API v2021-06-30 Model

Sales API

  • Sales API v1 Use Case Guide
  • Sales API Rate Limits
  • Sales API v1 Model

Seller Wallet API

  • Seller Wallet API v2024-03-01 Use Case Guide
    • Retrieve Seller Wallet account details
    • Retrieve transaction details
    • Preview fees and initiate a transaction
    • Manage transfer schedules for a Seller Waller account
  • Seller Wallet API Rate Limits
  • Seller Wallet API v2024-03-01 Model

Sellers API

  • Sellers API v1 Use Case Guide
  • Sellers API Rate Limits
  • Sellers API v1 Model

Services API

  • Services API v1 Use Case Guide
  • Services API Rate Limits
  • Services API v1 Model

Shipment Invoicing API

  • Shipment Invoicing API v0 Use Case Guide
    • Tutorial: Retrieve shipment information
    • Tutorial: Submit a shipment invoice
  • Shipment Invoicing API Rate Limits
  • Shipment Invoicing API v0 Model

Shipping API

  • Shipping API v2 Resources
  • Shipping API v1 Reference
    • Shipping API v1 Model
  • Shipping API Rate Limits

Solicitations API

  • Solicitations API v1 Use Case Guide
  • Solicitations API Rate Limits
  • Solicitations API v1 Model

Supply Sources API

  • Supply Sources API v2020-07-01 Use Case Guide
  • Multi-Location Inventory Integration Guide
  • Supply Sources API Rate Limits
  • Supply Sources API v2020-07-01 Model

Tokens API

  • Tokens API Use Case Guide
  • Tokens API Rate Limits
  • Tokens API v2021-03-01 Model

Uploads API

  • Uploads API Use Case Guide
  • Uploads API Rate Limits
  • Uploads API v2020-11-01 Model

Vehicles API

  • Vehicles API v2024-11-01 Use Case Guide
  • Vehicles API Rate Limits
  • Vehicles 2024-11-01 Model

Vendor Direct Fulfillment APIs

  • Vendor Direct Fulfillment Dynamic Sandbox Guide
  • Vendor Direct Fulfillment Workflow Guide
  • Vendor Direct Fulfillment Sandbox Test Data API v2021-10-28 Model
  • Vendor Direct Fulfillment APIs v1 Use Case Guide
    • Vendor Direct Fulfillment Orders API v1 Use Case Guide
    • Vendor Direct Fulfillment Shipping API v1 Use Case Guide
    • Vendor Direct Fulfillment Payments API v1 Use Case Guide
    • Vendor Direct Fulfillment Inventory API v1 Use Case Guide
    • Vendor Direct Fulfillment Transaction Status API v1 Use Case Guide
  • Vendor Direct Fulfillment Inventory API v1 Model
  • Vendor Direct Fulfillment Transactions API v1 Model
  • Vendor Direct Fulfillment Orders API v1 Model
  • Vendor Direct Fulfillment Shipping API v1 Model
  • Vendor Direct Fulfillment Payments API v1 Model
  • Vendor Direct Fulfillment Orders API v2021-12-28 Use Case Guide
    • Vendor Direct Fulfillment Orders API v2021-12-28 Model
  • Vendor Direct Fulfillment Shipping API v2021-12-28 Use Case Guide
    • Vendor Direct Fulfillment Shipping API v2021-12-28 Model
  • Vendor Direct Fulfillment Transaction Status API v2021-12-28 Use Case Guide
    • Vendor Direct Fulfillment Transactions API v2021-12-28 Model
  • SP-API Bill-to-Party Addresses
  • Vendor Direct Fulfillment API Rate Limits

Vendor Retail Procurement APIs

  • Vendor Retail Procurement APIs v1 Use Case Guide
  • SP-API Bill to Party Addresses
  • Vendor Invoices API v1 Model
  • Vendor Shipments API v1 Model
  • Vendor Transaction Status API v1 Model
  • Vendor Orders API v1 Model
  • Vendor Retail Procurement API Rate Limits

AWS CloudFormation Template

AWS CloudFormation template for Amazon Selling Partner API Guard

To automate deployment, Selling Partner API Guard uses the following AWS CloudFormation templates for AWS and AWS China. Use these templates to launch Selling Partner API Guard and all associated components.

  • Deployment in AWS: amazon-selling-partner-api-guard-aws.template

  • Deployment in AWS China: amazon-selling-partner-api-guard-aws-cn.template

Updated 6 days ago


Policies and Agreements   Privacy notice  |   Conditions of use