For AI agents: visit https://developer-docs.amazon/sp-api/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI. Append .md to any documentation page URL to get its markdown version.

Jump to Content

Home Documentation Code Samples API Reference Announcements Models Release Notes FAQ GitHub Videos

Developer Hub API Status Support

Documentation

Developer Hub API Status Support

Home Documentation Code Samples API Reference Announcements Models Release Notes FAQ GitHub Videos

Get Started

Welcome to SP-API Documentation
What is the Selling Partner API?
Selling Partner API Onboarding Overview
- Onboarding as a Developer
- Onboarding as a Service Provider
Terminology
Frequently Asked Questions

Changelog

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

Directories

SP-API Models
SP-API Seller Use Cases
SP-API Vendor Use Cases
Seller Central URLs
Vendor Central URLs

Registration

SP-API Registration Overview
Developer Registration Request Status
Third-Party Provider Registration
- Third-Party Provider Signature Guidance
Service Provider Registration and Role Approval Process Overview
Eligible Seller Central Roles for Service Providers
Website Guidelines for Public Developers and Service Providers
User Permissions for Service Providers
Register your Application
Update your Application Information
Rotate your Application's LWA Credentials
- LWA Credentials FAQ
View your Application Information and Credentials
Learn How Sellers Authorize Service Providers
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
Reauthorize Applications
Reactivate Authorizations
Revoke 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
Delete an Application From Your Developer Account

Calling the SP-API

Configuration Details
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

Solution Provider Portal

Manage Users in Solution Provider Portal
Manage Your Business And Contact information in Solution Provider Portal
Update Your Developer Profile in Solution Provider Portal
Unify Your Developer Accounts
Verify Your Identity in Solution Provider Portal
API Usage Metrics in Solution Provider Portal

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 a prebuilt C# 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: 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

Troubleshoot SP-API Errors
URL Encoding
Resolve Common HTTP and Authorization Error Codes
External Fulfillment Errors
Listings Items API Issues Troubleshooting

Selling Partner Appstore

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

Service Provider Network

List Your Service

Security and Compliance

SP-API Security and Compliance Overview
Amazon Selling Partner API Guard Implementation Guide
VAT Calculation Service
Amazon Seller Data Access
Best Practices

A+ Content API

A+ Content API
- Create, edit, and publish A+ content
- Manage A+ content
A+ Content Examples
A+ Content API Rate Limits

Amazon Warehousing and Distribution API

Amazon Warehousing and Distribution API
Amazon Warehousing and Distribution API v2024-05-09 Reference

App Integrations API

App Integrations API

Application Management API

Application Management API
- Set up credential rotation notifications
- Rotate your application's client secret

Catalog Items API

Catalog Items API
- Retrieve catalog item details
- Search catalog items
Catalog Items API Rate Limits
Catalog Items API v2022-04-01 Reference

Customer Feedback API

Customer Feedback API
- Get Feedback Insights for an ASIN
- Get Feedback Insights for a Browse Node
Customer Feedback API Rate Limits

Data Kiosk

Data Kiosk API
- Request and filter data with a GraphQL query
- Verify that query processing is complete
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

Delivery by Amazon API

Delivery by Amazon API
- Submit an invoice for Delivery by Amazon and Self Ship orders
- Check the invoice submission status for Delivery by Amazon and Self Ship orders

Easy Ship API

Easy Ship API

External Fulfillment

External Fulfillment Inventory API
- Publish Location-Level Inventory
- Retrieve Location-Level Inventory
External Fulfillment Returns API
- Retrieve Return Information
External Fulfillment Shipping API
External Fulfillment Errors
External Fulfillment APIs Rate Limits

Fulfillment By Amazon (FBA)

FBA Inventory API
- Get inventory summaries
FBA Inventory Dynamic Sandbox Guide

Feeds API

Feeds API
- Submit a feed
Feed Type Values
Feeds JSON Schemas
Feeds API Best Practices
Feeds API FAQ
Feeds API Rate Limits

Finances

Finances API
Transfers API
Invoices API
- Retrieve invoice headers
- Get invoice details

Fulfillment Inbound API

Fulfillment Inbound API
Fulfillment Inbound API FAQ
Migrating Fulfillment Inbound workflows
Fulfillment Inbound API Rate Limits

Fulfillment Outbound API

Fulfillment Outbound API
Fulfillment Outbound Workflow Guide
Fulfillment Outbound Dynamic Sandbox Guide
Fulfillment Outbound API Migration Guide
Fulfillment Outbound Troubleshooting Guide
MCF Best Practices

Invoicing

Invoices API (Brazil Only)
- Export invoice files
Invoices API FAQ

Listings

Listings Items API
Listings Items API Rate Limits
Listings Restrictions API
- Get listings restrictions for an item in the catalog
Listings Restrictions API Rate Limits
Manage Product Listings with the Selling Partner API
Building Listings Management Workflows Guide
Understanding Amazon listing status and seller-fulfilled inventory management
Listings Management Workflow Migration
- Mapping product attributes to the Listings Items API and JSON-based feeds
- Submit Listings data
Manage Amazon Haul, Advanced Multiple-Offer, and Multiple-Fulfillment Use Cases
Listings APIs FAQ
Product Type Definitions API
Product Type Definitions API Rate Limits

Merchant Fulfillment API

Merchant Fulfillment API

Messaging API

Messaging API
- Send a message

Notifications API

Notifications API
Notification Type Values
Subscribe to the ORDER_CHANGE Notification
Subscribe to shipment tracking notifications

Orders API

Orders API
Tutorial: Retrieve and Pass a Purchase Order Number to a Carrier
Orders API Migration Guide
Orders API Rate Limits

Product Fees API

Product Fees API

Product Pricing API

Product Pricing API
- Return a batch of FOEP data for a set of SKUs
- Retrieve a list of featured offers for a batch of up to 20 ASINs
Product Pricing API and Notifications FAQ
Price Adjustment Automation Workflows Guide
Manage automated pricing rules with SP-API

Promotions API

Promotions API

Replenishment API

Replenishment API

Reports API

Reports API
Report Type Values
Reports JSON Schemas
Reports API FAQ

Sales API

Sales API
- Receive sales performance information

Seller Wallet API

Seller Wallet API
Seller Wallet API Rate Limits

Sellers API

Sellers API
- Get the account information of a seller
- Get the market participation of a seller

Services API

Services API

Shipment Invoicing API

Shipment Invoicing API
- Retrieve shipment information
- Submit a shipment invoice

Shipping API

Shipping API v2 Resources
Shipping API v1 Reference

Solicitations API

Solicitations API
- Set up the Solicitations API
- Solicit feedback for an order

Supply Sources API

Supply Sources API
Multi-Location Inventory Integration Guide
Supply Sources API Rate Limits

Tokens API

Tokens API

Tracking API

Tracking API
- Track an external channel shipment
- Shipment milestone event subcodes

Uploads API

Uploads API
- Create an upload destination

Vehicles API

Vehicles API
- Provide fitment information on ASINs
Vehicles API Rate Limits

Vendor Direct Fulfillment APIs

Vendor Direct Fulfillment Dynamic Sandbox Guide
Vendor Direct Fulfillment Workflow Guide
SP-API Bill-to-Party Addresses

Vendor Direct Fulfillment Transaction Status API

Vendor Direct Fulfillment Transaction Status API
- Get the transaction status

Vendor Direct Fulfillment Inventory API

Vendor Direct Fulfillment Inventory API
- Submit an inventory update

Vendor Direct Fulfillment Orders API

Vendor Direct Fulfillment Orders API

Vendor Direct Fulfillment Shipping API

Vendor Direct Fulfillment Shipping API

Vendor Direct Fulfillment Payments API

Vendor Direct Fulfillment Payments API
- Submit an invoice

Vendor Retail Procurement Invoices API

Vendor Retail Procurement Invoices API
- Submit credit notes
- Submit invoices

Vendor Retail Procurement Orders API

Vendor Retail Procurement Orders API

Vendor Retail Procurement Shipments API

Vendor Retail Procurement Shipments API

Vendor Retail Procurement Transaction Status API

Vendor Retail Procurement Transaction Status API
- Get transaction status

Powered by

Set up notifications using the Amazon EventBridge workflow

Learn how to set up your system to receive notifications using the Amazon EventBridge workflow.

Policies and Agreements Privacy notice | Conditions of use