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

    Available API Models

    A+ Content Management API#

    Purpose
    The A+ Content Management API allows you to create and manage A+ content (enhanced product content with multimedia) for your products on Amazon.
    Use Cases
    Create and edit A+ content for listings.
    Manage the status of the created content.
    Retrieve the content for editing or deleting.

    Amazon Warehousing and Distribution API#

    Purpose
    The Amazon Warehousing and Distribution API enables you to track and manage shipments that are inbound to Amazon’s distribution centers, specifically for Amazon Warehousing and Distribution (AWD).
    Use Cases
    Retrieve shipment tracking information.
    Monitor the status of AWD shipments.
    Check the delivery status and expected arrival times for inbound shipments.

    App Integrations API#

    Purpose
    The App Integrations API allows you to send notifications to Amazon Selling Partners and display the notifications in Seller Central.
    Use Cases
    Send notifications to inform sellers about updates and changes.
    Manage notification preferences and configurations.

    Application Management API#

    Purpose
    The Application Management API allows you to rotate the client secret on registered applications.
    Use Cases
    Rotate client secrets for security purposes.
    Manage your application's registration and credentials.

    Catalog Items API#

    Purpose
    The Catalog Items API allows you to retrieve information about items in the Amazon catalog.
    Use Cases
    Fetch product details and attributes.
    Retrieve information on catalog items for analysis or display.

    Data Kiosk API#

    Purpose
    The Data Kiosk API enables you to submit GraphQL queries to retrieve data from various schemas across Amazon.
    Use Cases
    Submit queries for data across multiple schemas.
    Retrieve detailed, structured data for analysis and reporting.

    Easy Ship API#

    Purpose
    The Easy Ship API helps manage and ship Amazon Easy Ship orders.
    Use Cases
    Create and manage Easy Ship orders.
    Track the shipping status of orders fulfilled through Easy Ship.

    FBA Inbound Eligibility API#

    Purpose
    The FBA Inbound Eligibility API helps check the eligibility of items before shipping them to Amazon’s fulfillment centers.
    Use Cases
    Get eligibility previews for items.
    Check whether items can be shipped to Amazon's fulfillment centers.

    FBA Inventory API#

    Purpose
    The FBA Inventory API allows you to retrieve information about inventory stored in Amazon's fulfillment centers.
    Use Cases
    Monitor the inventory levels in FBA warehouses.
    Retrieve data on your stock in fulfillment centers.

    Feeds API#

    Purpose
    The Feeds API enables you to upload data to Amazon for managing your selling business.
    Use Cases
    Upload product data, pricing, inventory, and other related information.
    Manage the data uploaded to Amazon in bulk.

    Finances API#

    Purpose
    The Finances API provides detailed financial event information for a given order or date range.
    Use Cases
    Retrieve financial event data such as payments, refunds, and adjustments.
    Analyze transaction history and business performance.

    Fulfillment Inbound API#

    Purpose
    The Fulfillment Inbound API allows you to create and update inbound inventory to Amazon’s fulfillment network.
    Use Cases
    Create inbound shipments for Amazon fulfillment centers.
    Track inbound inventory status.

    Fulfillment Outbound API#

    Purpose
    The Fulfillment Outbound API enables you to retrieve information about Multi-Channel Fulfillment (MCF) orders in Amazon’s fulfillment network.
    Use Cases
    Retrieve the status of MCF orders.
    Track fulfillment and shipment details for MCF orders.

    Invoices API#

    Purpose
    The Invoices API lets you retrieve and manage invoices for your business transactions on Amazon.
    Use Cases
    Retrieve invoice data for orders.
    Manage and store invoice records for accounting and tax purposes.

    Listings Items API#

    Purpose
    The Listings Items API allows you to access and manage your product listings on Amazon.
    Use Cases
    Create, update, or delete product listings.
    Retrieve details on existing listings.

    Listings Restrictions API#

    Purpose
    The Listings Restrictions API allows you to retrieve restrictions on Amazon catalog listings.
    Use Cases
    Check for any listing restrictions on products.
    Manage compliance with Amazon’s listing policies.

    Merchant Fulfillment API#

    Purpose
    The Merchant Fulfillment API enables you to purchase shipping for non-Prime and Prime orders using Amazon Buy Shipping.
    Use Cases
    Purchase shipping for non-Prime and Prime orders.
    Create shipment labels and manage shipments.

    Messaging API#

    Purpose
    The Messaging API allows you to send messages to buyers on Amazon.
    Use Cases
    Send order-related messages to buyers.
    Handle customer inquiries and responses through Amazon’s messaging system.

    Notifications API#

    Purpose
    The Notifications API lets you subscribe to notifications relevant to your selling business.
    Use Cases
    Subscribe to alerts for changes in account status, order processing, and product issues.
    Manage notification preferences.

    Orders API#

    Purpose
    The Orders API allows you to retrieve detailed information about orders placed by customers on Amazon.
    Use Cases
    Retrieve order details such as items, prices, and shipping information.
    Track the status and fulfillment of orders.

    Product Fees API#

    Purpose
    The Product Fees API enables you to retrieve estimated fees for a product.
    Use Cases
    Estimate Amazon fees for a product.
    Calculate profitability before listing or promoting products.

    Product Pricing API#

    Purpose
    The Product Pricing API allows you to retrieve product pricing and offer information for products in the Amazon catalog.
    Use Cases
    Retrieve product prices and offers for competitive analysis.
    Check pricing history and trends for items in the catalog.

    Product Type Definitions API#

    Purpose
    The Product Type Definitions API lets you retrieve attribute and data requirements for product types in the Amazon catalog.
    Use Cases
    Retrieve data requirements for various product types.
    Ensure product listings are compliant with Amazon's catalog structure.

    Replenishment API#

    Purpose
    The Replenishment API provides access to replenishment program metrics and offer information for products.
    Use Cases
    Retrieve replenishment data for inventory management.
    Analyze metrics related to product restocking.

    Reports API#

    Purpose
    The Reports API allows you to retrieve and manage reports necessary for managing your selling business.
    Use Cases
    Request and download various reports such as order, inventory, and financial reports.
    Automate the retrieval of key business insights.

    Sales API#

    Purpose
    The Sales API enables you to retrieve information about sales performance.
    Use Cases
    Monitor sales trends and performance.
    Analyze sales data to optimize pricing and inventory.

    Sellers API#

    Purpose
    The Sellers API provides essential information about your seller account, including marketplace details, currency, and listing suspension status.
    Use Cases
    Retrieve details about your seller account and its configuration.
    Manage settings related to your selling platform.

    Services API#

    Purpose
    The Services API allows you to get and modify service orders and manage resources.
    Use Cases
    Retrieve service order details.
    Modify resource configurations and status for Amazon services.

    Shipment Invoicing API#

    Purpose
    The Shipment Invoicing API lets you retrieve shipment invoice information for Fulfillment by Amazon (FBA) orders in the Brazil marketplace.
    Use Cases
    Retrieve and manage FBA shipment invoices.
    Access invoicing information for FBA shipments in Brazil.

    Shipping API#

    Purpose
    The Shipping API enables you to request shipping rates, create shipments, cancel shipments, and track shipments.
    Use Cases
    Request shipping rates for orders.
    Create and track shipments for orders fulfilled by Amazon.

    Solicitations API#

    Purpose
    The Solicitations API enables you to send non-critical solicitations to buyers.
    Use Cases
    Send messages like customer feedback or product reviews.
    Engage with customers without critical order-related concerns.

    Supply Sources API#

    Purpose
    The Supply Sources API allows you to manage configurations and capabilities of seller supply sources.
    Use Cases
    Configure and manage supply sources.
    Retrieve supply source information for fulfillment planning.

    Tokens API#

    Purpose
    The Tokens API enables you to get a Restricted Data Token (RDT) for accessing restricted resources.
    Use Cases
    Retrieve RDTs for accessing restricted data in your seller account.
    Use tokens for secure API operations.

    Uploads API#

    Purpose
    The Uploads API allows you to upload files that can be accessed by other operations within the SP-API.
    Use Cases
    Upload bulk files such as inventory updates, product images, etc.
    Access and process uploaded files for different use cases.

    Vendor Direct Fulfillment Inventory API#

    Purpose
    The Vendor Direct Fulfillment Inventory API enables you to manage your direct fulfillment operations.
    Use Cases
    Track and manage inventory for direct fulfillment.
    Monitor the status and availability of vendor stock.

    Vendor Direct Fulfillment Orders API#

    Purpose
    The Vendor Direct Fulfillment Orders API lets you access vendor order data for direct fulfillment operations.
    Use Cases
    Retrieve order details for direct fulfillment.
    Track and manage orders fulfilled by vendors.

    Vendor Direct Fulfillment Shipping API#

    Purpose
    The Vendor Direct Fulfillment Shipping API lets you create and manage shipping labels for vendor-direct fulfillment.
    Use Cases
    Create and manage shipping labels.
    Track shipments managed through vendor-direct fulfillment.
    Modified at 2024-11-27 05:58:22
    Previous
    API Models
    Next
    Request Apidog Access
    Built with