Amazon SP API
    Amazon SP API
    • Overview
    • Authorization Workflow
    • Permissions
    • Sandbox
    • API Models
    • Available API Models
    • Request Apidog Access
    • OPENAPI SPECIFICATION
    • Research Docs
      • Amazon Seller Order Fulfillment Workflow
    • Amazon Warehousing and Distribution
      • getInboundShipment
        GET
      • listInboundShipments
        GET
      • listInventory
        GET
    • Authorization
      • Authorization
        POST
    • Catalog Items
      • searchCatalogItems
        GET
      • getCatalogItem
        GET
    • Catalog [Deprecated]
      • listCatalogItems
        GET
      • getCatalogItem
        GET
      • listCatalogCategories
        GET
    • Definitions
      • searchDefinitionsProductTypes
        GET
      • getDefinitionsProductType
        GET
    • Easy Ship
      • listHandoverSlots
        POST
      • getScheduledPackage
        GET
      • createScheduledPackage
        POST
      • updateScheduledPackages
        PATCH
      • createScheduledPackageBulk
        POST
    • FBAInbound
      • listInboundPlans
      • createInboundPlan
      • getInboundPlan
      • listInboundPlanBoxes
      • cancelInboundPlan
      • listInboundPlanItems
      • updateInboundPlanName
      • listPackingGroupBoxes
      • listPackingGroupItems
      • setPackingInformation
      • listPackingOptions
      • generatePackingOptions
      • confirmPackingOption
      • listInboundPlanPallets
      • listPlacementOptions
      • generatePlacementOptions
      • confirmPlacementOption
      • getShipment
      • listShipmentBoxes
      • listShipmentContentUpdatePreviews
      • generateShipmentContentUpdatePreviews
      • getShipmentContentUpdatePreview
      • confirmShipmentContentUpdatePreview
      • getDeliveryChallanDocument
      • listDeliveryWindowOptions
      • generateDeliveryWindowOptions
      • confirmDeliveryWindowOptions
      • listShipmentItems
      • updateShipmentName
      • listShipmentPallets
      • cancelSelfShipAppointment
      • getSelfShipAppointmentSlots
      • generateSelfShipAppointmentSlots
      • scheduleSelfShipAppointment
      • updateShipmentSourceAddress
      • updateShipmentTrackingDetails
      • listTransportationOptions
      • generateTransportationOptions
      • confirmTransportationOptions
      • listItemComplianceDetails
      • updateItemComplianceDetails
      • createMarketplaceItemLabels
      • listPrepDetails
      • setPrepDetails
      • getInboundOperationStatus
      • getItemEligibilityPreview
    • FBAInventory
      • getInventorySummaries
      • createInventoryItem
      • deleteInventoryItem
      • addInventory
    • FBAOutbound
      • getFulfillmentPreview
      • deliveryOffers
      • listAllFulfillmentOrders
      • createFulfillmentOrder
      • getPackageTrackingDetails
      • listReturnReasonCodes
      • createFulfillmentReturn
      • getFulfillmentOrder
      • updateFulfillmentOrder
      • cancelFulfillmentOrder
      • submitFulfillmentOrderStatusUpdate
      • getFeatures
      • getFeatureInventory
      • getFeatureSKU
    • Feeds
      • getFeeds
      • createFeed
      • cancelFeed
      • getFeed
      • createFeedDocument
      • getFeedDocument
    • Fees
      • getMyFeesEstimateForSKU
      • getMyFeesEstimateForASIN
      • getMyFeesEstimates
    • Finance
      • listTransactions
      • listFinancialEventGroups
      • listFinancialEventsByGroupId
      • listFinancialEventsByOrderId
      • listFinancialEvents
    • Invoices [Brazil]
      • getInvoicesAttributes
      • getInvoicesDocument
      • createInvoicesExport
      • getInvoicesExports
      • getInvoicesExport
      • getInvoices
      • getInvoice
    • Listings Items
      • getListingsRestrictions
      • deleteListingsItem
      • getListingsItem
      • patchListingsItem
      • putListingsItem
    • Merchant Fulfillment
      • getEligibleShipmentServices
      • getShipment
      • cancelShipment
      • createShipment
      • getAdditionalSellerInputs
    • Orders
      • getOrders
      • getOrder
      • getOrderBuyerInfo
      • getOrderAddress
      • getOrderItems
      • getOrderItemsBuyerInfo
      • updateShipmentStatus
      • getOrderRegulatedInfo
      • updateVerificationStatus
      • confirmShipment
    • ProductPricing
      • deprecated
        • getPricing
        • getCompetitivePricing
        • getListingOffers
        • getItemOffers
        • getItemOffersBatch
        • getListingOffersBatch
      • getFeaturedOfferExpectedPriceBatch
      • getCompetitiveSummary
    • Reports
      • getReports
      • createReport
      • cancelReport
      • getReport
      • getReportSchedules
      • createReportSchedule
      • cancelReportSchedule
      • getReportSchedule
      • getReportDocument
    • Sales
      • getOrderMetrics
    • Sellers
      • getMarketplaceParticipations
      • getAccount
    • Service
      • getServiceJobByServiceJobId
      • cancelServiceJobByServiceJobId
      • completeServiceJobByServiceJobId
      • getServiceJobs
      • addAppointmentForServiceJobByServiceJobId
      • rescheduleAppointmentForServiceJobByServiceJobId
      • assignAppointmentResources
      • setAppointmentFulfillmentData
      • getRangeSlotCapacity
      • getFixedSlotCapacity
      • updateSchedule
      • createReservation
      • updateReservation
      • cancelReservation
      • getAppointmmentSlotsByJobId
      • getAppointmentSlots
      • createServiceDocumentUploadDestination
    • ShipmentInvoice[Brazil]
      • getShipmentDetails
      • submitInvoice
      • getInvoiceStatus
    • Shipping
      • getRates
      • createShipment
      • directPurchaseShipment
      • getShipment
      • purchaseShipment
      • cancelShipment
      • oneClickShipment
      • purchaseLabels
      • getTracking
      • retrieveShippingLabel
      • getShipmentDocuments
      • purchaseShipment
      • cancelShipment
      • getRates
      • getAdditionalInputs
      • getAccount
      • getCarrierAccountFormInputs
      • getTrackingInformation
      • getCarrierAccounts
      • linkCarrierAccount
      • unlinkCarrierAccount
      • generateCollectionForm
      • getCollectionFormHistory
      • getUnmanifestedShipments
      • getCollectionForm
      • getAccessPoints
    • Supply Sources
      • getSupplySources
      • createSupplySource
      • getSupplySource
      • updateSupplySource
      • archiveSupplySource
      • updateSupplySourceStatus
    • Tokens
      • createRestrictedDataToken
    • Uploads
      • createUploadDestinationForResource
    • Notifications
      • getSubscription
      • createSubscription
      • getSubscriptionById
      • deleteSubscriptionById
      • getDestinations
      • createDestination
      • getDestination
      • deleteDestination

    Overview

    The Amazon Selling Partner API (SP-API) is a collection of RESTful APIs designed to provide programmatic access to Amazon's core seller tools and services. It allows developers to integrate with Amazon's ecosystem and automate various business processes related to selling on the Amazon marketplace.

    What is SP-API?#

    The SP-API enables sellers, developers, and partners to manage and automate operations such as product listings, order processing, inventory management, financial reporting, and fulfillment—all through a standardized set of APIs.
    It is an updated, improved version of the legacy Amazon Marketplace Web Service (MWS), offering enhanced functionality, greater security, and improved performance.

    Key Benefits:#

    Streamlined Operations: Automate repetitive tasks like updating inventory, managing orders, and generating financial reports.
    Scalability: Integrate with Amazon's vast selling platform, including all global marketplaces, with minimal overhead.
    Improved Data Access: Retrieve data on orders, inventory, shipments, financial transactions, and more, with flexible querying options.
    Security: Uses OAuth 2.0 for secure authorization and AWS Signature v4 for API access, ensuring that your data and credentials are handled safely.

    Core Functions:#

    Order Management: Retrieve detailed order data, including buyer information, payment status, shipping details, and order fulfillment status.
    Inventory Management: Track available stock, manage product listings, and update inventory in Amazon’s fulfillment network.
    Financial Management: Access detailed financial data, including transaction history, payments, fees, and refunds.
    Shipping & Fulfillment: Use Amazon’s fulfillment network to ship products and track shipments through the Fulfillment by Amazon (FBA) system.
    Reports & Analytics: Generate and retrieve various reports for sales performance, inventory status, and financial data to make informed business decisions.

    Available SP-API Models#

    SP-API provides several models that represent the various business operations you can automate. Each model corresponds to a specific API and defines the structure of data for requests, responses, and error handling.
    While the models cover a wide range of features, they can be broadly categorized into the following types:
    Orders: Manage and retrieve order information such as order status, items, shipping addresses, and payment.
    Inventory & Listings: Create, update, and retrieve product listings, manage inventory, and check listing restrictions.
    Fulfillment: Manage inbound and outbound shipments through Amazon’s fulfillment centers, track shipments, and fulfill orders.
    Financial: Access financial events, transaction data, fees, and invoices related to sales.
    Reports: Retrieve reports such as order data, inventory status, and sales performance metrics.
    Product Management: Fetch product details from the catalog, including pricing, descriptions, and attributes.
    Notifications: Subscribe to important notifications related to orders, account status, or product performance.

    How the SP-API Works#

    SP-API allows third-party applications to interact with Amazon’s seller platform via secure, authenticated API calls. Here’s how the general flow works:
    1.
    Authentication: The application must authenticate using OAuth 2.0. Once the seller authorizes the app, a token is generated that grants access to the seller’s data.
    2.
    API Calls: The application can then make API calls to different endpoints based on the features it needs (e.g., orders, inventory, reports).
    3.
    Data Handling: API responses contain the requested data in JSON format, which the application can then process. It’s important to handle errors and rate limits properly to ensure smooth integration.
    4.
    Rate Limits and Throttling: SP-API has built-in throttling to prevent overuse. Developers must manage API calls efficiently to stay within rate limits and avoid disruptions.

    Key SP-API Features:#

    OAuth 2.0 Authentication: Securely authenticate and access seller accounts.
    AWS Signature v4: Sign API requests to ensure they come from a legitimate source.
    Advanced Filtering: Retrieve specific data based on various parameters (e.g., date ranges, order statuses).
    Real-time Data: Access up-to-date information on orders, inventory, and financials.

    Conclusion#

    The Amazon SP-API empowers developers to create powerful applications that integrate directly with Amazon’s selling platform. It provides a robust and scalable solution for managing orders, inventory, shipping, and financial data, enabling sellers to streamline their operations and focus on growing their business.
    To get started, developers should review the official SP-API documentation, understand the available models, and explore how each API can automate specific tasks within their business workflow.
    Next
    Authorization Workflow
    Built with