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

    API Models

    Amazon Selling Partner API (SP-API) models define the structure of requests, responses, and error formats for all endpoints. They are essential for integrating your application with SP-API in a compliant and consistent manner.

    What Are SP-API Models?#

    SP-API models are JSON-based schemas that ensure:
    1.
    Standardized Communication: Defines the structure of data sent to and received from Amazon endpoints.
    2.
    Validation: Ensures all required fields are present and correctly formatted.
    3.
    Error Handling: Provides consistent error structures for debugging and troubleshooting.

    Where to Find SP-API Models#

    1. Amazon's Swagger Files#

    Amazon provides OpenAPI (Swagger) specifications for SP-API
    These specifications include request/response models, parameter definitions, and error formats
    Access them on Amazon's GitHub

    2. Official Documentation#

    Each SP-API endpoint (e.g., Orders, Feeds, Reports) has detailed documentation outlining the models
    Explore it here: SP-API Official Documentation

    How to Work with SP-API Models#

    1. Use Swagger Files#

    Download Swagger files from GitHub
    Visualize them using tools like Swagger UI or Postman
    Generate client libraries in your programming language for efficient integration

    2. Understand Required Fields#

    Each API request specifies mandatory and optional fields
    Review the documentation to ensure your app sends valid requests

    3. Validate Responses#

    Use the provided response models to parse and verify data returned by the API

    Best Practices#

    1. Error Handling#

    Familiarize yourself with error models to gracefully handle common API issues

    2. Stay Updated#

    SP-API models may evolve
    Regularly check for updates in the Swagger files or documentation

    Resources#

    SP-API Swagger Models on GitHub
    Amazon SP-API Documentation
    Previous
    Sandbox
    Next
    Available API Models
    Built with