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
    • SP-API Vendor 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
    • Guide History
  • 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 Management API v2020-11-01 Reference
    • A+ Content 2020-11-01 Model
  • A+ Content API v2020-11-01 Use Case Guide
  • A+ Content Examples
  • A+ Content API Rate Limits

Amazon Warehousing and Distribution API

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

App Integrations API

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

Application Management API

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

Catalog Items API

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

Data Kiosk

  • Data Kiosk API v2023-11-15 Reference
    • Data Kiosk API v2023-11-15 Use Case Guide
    • Data Kiosk API v2023-11-15 Model
  • 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

Easy Ship API

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

Fulfillment By Amazon (FBA)

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

Feeds API

  • Feeds API v2021-06-30 Reference
    • Feeds API v2021-06-30 Use Case Guide
    • Feeds API v2021-06-30 Model
  • 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

Finances

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

Fulfillment Inbound API

  • Fulfillment Inbound API v2024-03-20 Reference
    • 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 Reference
    • Fulfillment Inbound API v0 Model
  • Fulfillment Inbound API FAQ
  • Migrating Fulfillment Inbound workflows
  • Fulfillment Inbound API Rate Limits

Fulfillment Outbound API

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

Invoices API

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

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 Reference
    • Listings Items API v2021-08-01 Use Case Guide
    • Listings Items API v2021-08-01 Model
    • Guidance for Complex Attributes
  • Listings Items API Issues Troubleshooting
  • Listings Items API v2020-09-01 Reference
    • Listings Items API v2020-09-01 Use Case Guide
    • Listings Items API v2020-09-01 Model
  • Listings Restrictions API v2021-08-01 Reference
    • Listings Restrictions API v2021-08-01 Use Case Guide
    • Listings Restrictions API v2021-08-01 Model
  • Product Type Definitions API v2020-09-01 Reference
    • Product Type Definitions API v2020-09-01 Use Case Guide
    • Product Type Definitions API v2020-09-01 Model
    • Product Type Definitions API FAQ
    • 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 Reference
    • Merchant Fulfillment API v0 Model
  • Merchant Fulfillment API v0 Use Case Guide
  • Merchant Fulfillment API Rate Limits

Messaging API

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

Notifications API

  • Notifications API v1 Reference
    • Notifications API v1 Model
  • 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

Orders API

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

Product Fees API

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

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 Reference
    • Product Pricing API v2022-05-01 Use Case Guide
    • Product Pricing API v2022-05-01 Model
  • Product Pricing API v0 Reference
    • 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 v2022-11-07 Reference
    • Replenishment API v2022-11-07 Model
  • Replenishment API Rate Limits

Reports API

  • Reports API v2021-06-30 Reference
    • 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
    • Reports API v2021-06-30 Model
  • Report Type Values
    • 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 Best Practices
  • SP-API for Vendors - Reports FAQ
  • Reports API FAQ
  • Reports API Rate Limits

Sales API

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

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 v2024-03-01 Model
  • Seller Wallet API Rate Limits

Sellers API

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

Services API

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

Shipment Invoicing API

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

Shipping API

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

Solicitations API

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

Supply Sources API

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

Tokens API

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

Uploads API

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

Vehicles API

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

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 Reference
    • 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 Reference
    • Vendor Direct Fulfillment Inventory API v1 Model
  • Vendor Direct Fulfillment Transactions API v1 Reference
    • Vendor Direct Fulfillment Transactions API v1 Model
  • Vendor Direct Fulfillment Orders API v1 Reference
    • Vendor Direct Fulfillment Orders API v1 Model
  • Vendor Direct Fulfillment Shipping API v1 Reference
    • Vendor Direct Fulfillment Shipping API v1 Model
  • Vendor Direct Fulfillment Payments API v1 Reference
    • Vendor Direct Fulfillment Payments API v1 Model
  • Vendor Direct Fulfillment Orders API v2021-12-28 Reference
    • 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 Reference
    • Vendor Direct Fulfillment Shipping API v2021-12-28 Use Case Guide
    • Vendor Direct Fulfillment Shipping API v2021-12-28 Model
  • Vendor Direct Fulfillment Transactions API v2021-12-28 Reference
    • 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 Reference
    • Vendor Invoices API v1 Model
  • Vendor Shipments API v1 Reference
    • Vendor Shipments API v1 Model
  • Vendor Transaction Status API v1 Reference
    • Vendor Transaction Status API v1 Model
  • Vendor Orders API v1 Reference
    • Vendor Orders API v1 Model
  • Vendor Retail Procurement FAQ
  • Vendor Retail Procurement API Rate Limits

Frequently Asked Questions

Frequently asked questions (FAQ) about the Selling Partner APIs.

  • General
  • Solution Provider Portal
  • Listings API
  • Listings API migration
  • Product Type Definitions API
  • SP-API Errors
  • SP-API Guard
  • Product Pricing API and Notifications
  • Fulfillment Inbound API
  • Feeds API
  • Reports API
  • LWA Credentials

FAQ for SP-API Vendors

  • General
  • Reports

Updated about 6 hours ago


  • Table of Contents
    • FAQ for SP-API Vendors
Policies and Agreements   Privacy notice  |   Conditions of use