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
  • Developer Registration Request Status
  • Third-Party Provider Registration
    • Third-Party Provider Signature Guidance
  • Service Provider Registration and Migration
  • 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
  • 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 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
  • 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

Solution Provider Portal

  • Manage Users in Solution Provider Portal
  • Solution Provider Identity Verification
  • Solution Provider Portal Account Unification

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: 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
    • 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
    • Create an inbound order for shipment
    • Retrieve and filter inbound shipments
    • Track an inbound shipment with expected and received SKU details
  • Amazon Warehousing and Distribution API Rate Limits
  • Amazon Warehousing and Distribution API v2024-05-09 Reference

App Integrations API

  • App Integrations API
    • Create and onboard an app notification template
    • Sample sandbox notification templates
    • Send an app notification
    • Record app notification feedback
    • Delete app notifications
  • App Integrations API Rate Limits

Application Management API

  • Application Management API
    • Set up credential rotation notifications
    • Rotate your application's client secret
  • Application Management API Rate Limits

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
  • Data Kiosk API Rate Limits

Easy Ship API

  • Easy Ship API
    • Schedule an Easy Ship package
    • Reschedule an Easy Ship package
    • Check the status of an Easy Ship package
    • Find order items that require serial numbers
    • Get shipping labels, invoice, and warranty documents
  • Easy Ship API Rate Limits

Fulfillment By Amazon (FBA)

  • FBA Inventory API
    • Get inventory summaries
  • FBA Inventory API Rate Limits
  • FBA Inventory Dynamic Sandbox Guide
  • FBA Inbound Eligibility API Rate Limits

Feeds API

  • Feeds API
    • Submit a feed
  • 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
    • Get the latest transactions
    • Determine payment transactions
    • Finances API v2024-06-19 Reference
  • Finances API Rate Limits
  • Transfers API
    • Retrieve payment method details and initiate a payout
  • 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 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

Invoices API

  • Invoices API
    • Export invoice files
  • Invoices API FAQ
  • Invoices API Rate Limits

Listings

  • Listings Items API
    • Retrieve details about a listing
    • Preview errors before partially updating a listing
    • Create or fully update a listing
    • Preview errors before creating or fully updating a listing
    • Partially update a listing
    • Merge a listing
    • Delete a listing
    • Search for listings items by product identifier (or other listings parameters)
    • Guidance for Complex Attributes
    • Listings Items API Issues Troubleshooting
  • 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
  • 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 APIs FAQ
  • Product Type Definitions API
    • Search available Product Type Definitions
    • Get Product Type Definition recommendations
    • Retrieve a Product Type Definition
  • Product Type Definitions API Rate Limits

Merchant Fulfillment API

  • Merchant Fulfillment API
    • Fulfill seller-fulfilled Prime and non-Prime orders
    • Cancel a shipment
    • Manipulate shipping labels
    • Include additional seller input data
    • Subscribe to MFN notifications
  • Merchant Fulfillment API Rate Limits

Messaging API

  • Messaging API
    • Send a message
  • Messaging API Rate Limits

Notifications API

  • Notifications API
    • Set up notifications (Amazon EventBridge workflow)
    • Set up notifications (Amazon Simple Queue Service workflow)
  • Notification Type Values
  • Notifications API Rate Limits

Orders API

  • Orders API
    • Get orders with filtering criteria
    • Get order information
    • Get order item information
    • Confirm the shipment status
  • 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 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 Use Case Guide
  • Product Pricing API v0 Use Case Guide
  • Product Pricing API Rate Limits

Replenishment API

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

Reports API

  • Reports API
    • Request a report
    • Schedule and retrieve reports
    • 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

Sales API

  • 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 Rate Limits

Sellers API

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

Services API

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

Shipment Invoicing API

  • Shipment Invoicing API
    • Retrieve shipment information
    • Submit a shipment invoice
  • Shipment Invoicing API Rate Limits

Shipping API

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

Solicitations API

  • Solicitations API
    • Set up the Solicitations API
    • Solicit feedback for an order
  • Solicitations API Rate Limits

Supply Sources API

  • Supply Sources API
    • Configure a new supply source
    • Configure the status of an existing supply source
    • Retrieve the details of a configured supply source
    • Update an existing supply source
    • Practice onboarding an end-to-end seller with one SKU
  • Multi-Location Inventory Integration Guide
  • Supply Sources API Rate Limits

Tokens API

  • Tokens API
    • Get authorization to access restricted report types with PII information
    • Get authorization to access PII for bulk orders
    • Get authorization to access PII for order items in an order
    • Delegate authorization to access PII
    • Get authorization to access shipment information for multiple shipments
  • Tokens API Rate Limits

Uploads API

  • Uploads API
    • Create an upload destination
  • Uploads API Rate Limits

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
  • Vendor Direct Fulfillment APIs 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 Shipping API v2021-12-28 Use Case Guide
  • 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 Retail Procurement API Rate Limits

Vendor Direct Fulfillment Transaction Status API

  • Vendor Direct Fulfillment Transaction Status API
    • Get the transaction status
  • Vendor Direct Fulfillment Transaction Status API Rate Limits

Vendor Direct Fulfillment Inventory API

  • Vendor Direct Fulfillment Inventory API
    • Submit an inventory update
  • Vendor Direct Fulfillment Inventory API Rate Limits

Vendor Direct Fulfillment Orders API

  • Vendor Direct Fulfillment Orders API
    • Get a list of orders
    • Get an order
    • Submit an acknowledgement
  • Vendor Direct Fulfillment Orders API Rate Limits

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 SP-API Applications with Incident Response
  • Safeguarding Sensitive Credentials

Updated 4 months ago


Policies and Agreements   Privacy notice  |   Conditions of use