SP-API Release Notes
Selling Partner API new features, software updates, and changelog.
For releases prior to January 19, 2022, refer to Announcements on the Selling Partner API GitHub repo.
August 19, 2024
API changes
- Removed the August 14, 2024 updates to Amazon Warehousing and Distribution API v2024-05-09.
August 14, 2024
API changes
##### Amazon Warehousing and Distribution API v2024-05-09
- Added the optional response parameter totalInboundQuantity
to the listInventory
operation. You can use this parameter to track inventory in transit to Amazon Warehousing and Distribution.
- Added a new optional request parameter skuQuantities
to the getInboundShipment
operation. You can use this parameter to reconcile and compare expected and received inventory for each SKU in a shipment.
You can now use the Amazon Warehousing and Distribution API to:
- Track inventory in-transit to Amazon Warehousing and Distribution to improve end-to-end inventory view.
- Reconcile and compare expected and received inventory for each SKU in a shipment.
- Added a new inbound ineligibility enum value,
FBA_INB_0342
in thegetItemEligibilityPreview
operation. This value provides more information on why an offer can't use certain manufacturer barcodes.
- Added the
getAccount
operation to retrieve information about seller accounts.
-
Added a new
unitOfMeasure
variable to support variable weight products. This variable provides the unit of measure for prices of items sold by weight. If this field is absent, the item is sold by eaches. Operations that return this variable include:
Documentation changes
- The new Services API v1 Use Case Guide outlines how to access service job details and confirm or reschedule appointments using the Services API v1.
Deprecation notices
Deprecated SP-API resources are no longer in active development. Calls to deprecated SP-API resources will fail as of their removal date. For more information about SP-API deprecation dates, refer to the deprecations table.
The following operations in the Catalog Items API v0 were deprecated on September 30, 2022 and will be removed on September 25, 2024:
listCatalogItems
getCatalogItem
July 31, 2024
API changes
-
Added the
queryStartDate
parameter to thegetFeatureInventory
operation. You can use this parameter to select inventory that has been updated since a specified date. -
The Fulfillment Outbound API v2020-07-01 Use Case Guide provides steps on how to pass the
queryStartDate
parameter when retrieving a list of inventory items that are eligible for a specified fulfillment feature.
Documentation changes
The Selling Partner API Blog will be removed on July 31, 2024. For technical guidance on Selling Partner APIs, refer to the SP-API Documentation site. For supplementary guidance on Selling Partner APIs, refer to Developer University.
Deprecation notices
Deprecated SP-API resources are no longer in active development. Calls to deprecated SP-API resources will fail as of their removal date. For more information about SP-API deprecation dates, refer to the deprecations table.
The following operations in the Catalog Items API v0 were deprecated on September 30, 2022 and will be removed on September 25, 2024:
listCatalogItems
getCatalogItem
July 8, 2024
API changes
- Added the
Benefits
object, which contains a list of included and excluded Amazon benefits from a shipping service offer. Each excluded benefit has a list of reason codes for why it is excluded. Benefits represent services provided by Amazon (for example,CLAIMS_PROTECTED
for A-to-z Guarantee) when sellers purchase shipping through Amazon. Sellers gain insight into what comes with buying a label through Amazon.
June 28, 2024
API changes
- Removed the June 27, 2024 updates to Fulfillment Outbound API v2020-07-01 and Merchant Fulfillment v0 API.
June 27, 2024
API changes
- The Fulfillment Inbound API v2024-03-20 is now in general availability. You can use this API to select from multiple inbound placement service options and create inbound plans with support for up to 1500 SKUs.
- The Fulfillment Inbound API v2024-03-20 Use Case Guide provides tutorials on how to create shipments and guidance on the fulfillment inbound shipment workflow.
- The Fulfillment Inbound API frequently asked questions includes the benefits of the Fulfillment Inbound API v2024-03-20 and guidance on migrating from the Fulfillment Inbound API v0.
- Migrating Fulfillment Inbound workflows guide you through migrating from the Fulfillment Inbound API v0 to the new Fulfillment Inbound API v2024-03-20.
##### Fulfillment Outbound API v2020-07-01
- Added the queryStartDate
parameter to the getFeatureInventory
operation. Sellers can use this parameter to select inventory that has been updated since a specified date.
- The Fulfillment Outbound API v2020-07-01 Use Case Guide provides steps on how to pass the queryStartDate
parameter when retrieving a list of inventory items that are eligible for a specified fulfillment feature.
##### Merchant Fulfillment v0 API
- Added the Benefits
object, which contains a list of included and excluded Amazon benefits from a shipping service offer. Each excluded benefit has a list of reason codes for why it is excluded. Benefits represent services provided by Amazon (for example, CLAIMS_PROTECTED
for A-to-z Guarantee) when sellers purchase shipping through Amazon. Sellers gain insight into what comes with buying a label through Amazon.
- You can use the new Transfers API v2024-06-01 to initiate payouts and retrieve instrument details sellers' accounts by calling the
initiatePayout
andgetPaymentMethods
operations. For tutorials on how to use the Transfers API v2024-06-01, sellers can refer to the Transfers API v2024-06-01 Use Case Guide. This API is only available in private beta.
Documentation changes
- The Finances v0 Use Case Guide outlines how to retrieve financial information, such as the current balance, transactions, and fund transfer status for your orders using the Finances API v0.
Deprecation notices
Deprecated SP-API resources are no longer in active development. Calls to deprecated SP-API resources will fail beginning on their removal date. For more information about SP-API deprecation dates, refer to the deprecations table.
June 19, 2024
API changes
- Sellers can use the new Amazon Warehousing and Distribution API v2024-05-09 to track inventory inside AWD distribution centers and track shipments going into AWD distribution centers.
- The Data Kiosk API v2023-11-05 is now in general availability.
- The new Data Kiosk sample solution provides all the resources that you need to deploy a fully functional SP-API application that automates the creation and retrieval of Data Kiosk documents.
- The new Data Kiosk workflow guide offers insights into best practices, answers common questions about API usage, and outlines optimal workflows.
- The new Vendor Analytics dataset provides vendor data across multiple domains. You can aggregate data across any granularity (ASIN/Brand/Manufacturing/date) and access more than 100 metrics across sales, traffic, inventory, forecast, profitability, and new geographic sales metrics.
- Developers who create or manage applications that integrate with the FBA Inventory API v1 and Fulfillment Outbound API v2020-07-01 can use the two dynamic sandbox environments to test code integrations between the FBA and Fulfillment Outbound API domains. These sandboxes simulate order fulfillment and inventory movements that mimic Amazon's production responses. For more information, refer to the FBA Inventory Dynamic Sandbox Guide.
- Added the new
deliveryOffers
operation. Sellers can use this operation to display Multi-Channel Fulfillment (MCF) standard delivery offers on pre-checkout pages. This operation is only available in the United States (US) marketplace. - Added the optional field
lockerDetails
to thegetFulfillmentOrder
response. Sellers can include the information that is needed to access the locker delivery boxes. This field is only available in the Japan (JP) marketplace. - Added the optional field
deliveryPreferences
to thecreateFulfillmentOrder
request. Sellers can include the delivery preferences that are applied to the destination address. This field is only available in the Japan (JP) marketplace. - Developers who create or manage applications that integrate with the FBA Inventory API v1 and Fulfillment Outbound API v2020-07-01 can use the two dynamic sandbox environments to test code integrations between the FBA and Fulfillment Outbound API domains. These sandboxes simulate order fulfillment and inventory movements that mimic Amazon's production responses. For more information, refer to the Fulfillment Outbound Dynamic Sandbox Guide.
- The
getFeaturedOfferExpectedPriceBatch
operation is now available in all marketplaces except Japan (JP). Sellers can use this operation to get the featured offer expected price (FOEP) data for up to 40 SKUs.
- Added the metrics
LOST_REVENUE_DUE_TO_OOS
,SUBSCRIBER_NON_SUBSCRIBER_AVERAGE_REORDERS
, andCOUPONS_REVENUE_PENETRATION
to thegetSellingPartnerMetrics
operation response. These metrics describe sources of revenue and lost revenue. - Added the metrics
LOST_REVENUE_DUE_TO_OOS
andCOUPONS_REVENUE_PENETRATION
to thelistOfferMetrics
operation response. These metrics describe sources of revenue and lost revenue.
Deprecation notices
Deprecated SP-API resources are no longer in active development. Calls to deprecated SP-API resources will fail beginning on their removal date. For more information about SP-API deprecation dates, refer to the Deprecations table.
June 4, 2024
API changes
- New feature: View and select one of the available delivery windows for a shipment to arrive at an Amazon facility
- New feature: Print labels for individual items
- Select Partnered Carrier as an option for your less-than-truckload (LTL) shipments
- Update the name of inbound plans and shipments
- Update the quantity of units of a SKU after shipment confirmation
- Add three new mandatory operations:
confirmDeliveryWindowOptions
,generateDeliveryWindowOptions
, andlistDeliveryWindowOptions
Deprecation notices
Deprecated SP-API resources are no longer in active development. Calls to deprecated SP-API resources will fail beginning on their removal date. For more information about SP-API deprecation dates, refer to the Deprecations table.
The following operations in Fulfillment Inbound API v0 are no longer deprecated:
May 22, 2024
API changes
-
Added the
lowestPricedOffers
andreferencePrices
attributes to the Product Pricing API v2022-05-01. This enhancement provides the top 20 lowest priced offers and reference prices. -
In the Product Pricing API v2022-05-01 Use Case Guide, the Tutorial: Retrieve a list of featured offers for a batch of up to 20 ASINs makes use of two new attributes:
lowestPricedOffers
andreferencePrices
. -
Added the Price Adjustment Automation Workflows Guide to our Selling Partner API documentation site. This guide outlines how to leverage the Product Pricing API v2022-05-01 and Pricing notifications to build best-in-class workflows that automate pricing management.
-
Added the Product pricing API and notifications frequently asked questions to our Selling Partner API documentation site. This documentation covers common questions and details for the Product Pricing API v2022-05-01.
- Added a new
includedData
query parameter option calledclassifications
, which replaces the deprecated MWSGetProductCategoriesForSKU
andGetProductCategoriesForASIN
operations. Sellers and vendors can useclassifications
to browse the classification trees assigned to an ASIN.
- The Order feeds attributes
POST_ORDER_FULFILLMENT_DATA
andPOST_FLAT_FILE_FULFILLMENT_DATA
are updated with a new field:ship-from-supply-source-id
.
Deprecation notices
Deprecated SP-API resources are no longer in active development. Calls to deprecated SP-API resources will fail beginning on their removal date. For more information about SP-API deprecation dates, refer to the Deprecations table.
April 24, 2024
API changes
-
Added the the
CompanyName
attribute to the Orders API v0 API. -
Updated the rate limit for the
getOrder
,getOrderAddress
, andgetOrderBuyerInfo
operations from .0167 to .5 and increased the burst from 20 to 30. -
Updated the
IsBuyerRequestedCancel
,IsGift
andNumberOfItems
object types from Boolean/integer to string. -
Updated the
getOrders
operation to return theAutomatedCarrier
andAutomatedShipMethod
attributes.
- Updated the license from the Amazon Software License to the Apache License 2.0.
- Added the 413 HTTP code to each operation’s list of possible responses.
Report schema changes
Added The lastUpdatedDate
field to the following Vendor reports:
GET_VENDOR_SALES_REPORT
GET_VENDOR_NET_PURE_PRODUCT_MARGIN_REPORT
GET_VENDOR_TRAFFIC_REPORT
GET_VENDOR_FORECASTING_REPORT
GET_VENDOR_INVENTORY_REPORT
Vendor Central Marketplace Expansion to Ireland (IE)
On April 23rd, 2024, Vendor Central launched support for Ireland (IE) Marketplace. For more information, refer to the SP-API Vendor Central URLs, SP-API Endpoints, and Marketplace IDs topics in the SP-API documentation.
Documentation changes
- The Orders API v0 Use Case Guide includes new details about order age. Orders more than two years old will not be returned in the API response. The JP, AU, and SG marketplaces are an exception. In those marketplaces the Orders API v0 supports orders from 2016 to present.
Deprecation notices
Deprecated SP-API resources will no longer receive technical support. Calls to deprecated SP-API resources will fail beginning on their removal date. For more detailed information about SP-API deprecation dates, refer to the Deprecations table.
- Fulfillment Inbound API v0 (Select operations)
createInboundShipmentPlan
updateInboundShipment
createInboundShipment
getPreorderInfo
confirmPreorder
getTransportDetails
putTransportDetails
voidTransport
estimateTransport
confirmTransport
getShipments
getShipmentItemsByShipmentId
getShipmentItems
POST_PRODUCT_DATA
POST_INVENTORY_AVAILABILITY_DATA
POST_PRODUCT_OVERRIDES_DATA
POST_PRODUCT_PRICING_DATA
POST_PRODUCT_IMAGE_DATA
POST_PRODUCT_RELATIONSHIP_DATA
POST_FLAT_FILE_INVLOADER_DATA
POST_FLAT_FILE_LISTINGS_DATA
POST_FLAT_FILE_BOOKLOADER_DATA
POST_FLAT_FILE_CONVERGENCE_LISTINGS_DATA
POST_FLAT_FILE_LISTINGS_DATA
POST_FLAT_FILE_PRICEANDQUANTITYONLY_UPDATE_DATA
POST_UIEE_BOOKLOADER_DATA
LISTING_ITEM_ISSUES_CHANGE
payload version 1.0
April 1, 2024
API changes
- Early access to the new Fulfillment Inbound v2024-03-20 API, which supports FBA Inbound shipment creation and allows you to select from multiple inbound placement service options, among other features.
Deprecation notices
SP-API resources announcing deprecation will no longer be supported after their deprecation date. Calls to deprecated resources will fail beginning on their removal date. For more detailed information about SP-API deprecation dates, refer to the Deprecations table.
- Fulfillment Inbound API v0 (Select operations)
createInboundShipmentPlan
updateInboundShipment
createInboundShipment
getPreorderInfo
confirmPreorder
getTransportDetails
putTransportDetails
voidTransport
estimateTransport
confirmTransport
getShipments
getShipmentItemsByShipmentId
getShipmentItems
March 20, 2024
API changes
- Added the
AdditionalAddressNotes
,NdrAction
,NdrRequestData
, andSubmitNdrFeedbackRequest
objects to thendrFeedback parameter
. - Added tutorial for Using the ndrFeedback API to submit Non-Delivery Reports for eligible shipments.
- Added the Dangerous Goods attributes
LiquidVolume
,IsHazmat
, andDangerousGoodsDetails
to the Item object.
- Updated Marketplace ASIN Page View Metric report to include support for the UK. For more information about this report, refer to Regulatory Compliance Report Type Values. This change applies to the UK marketplace only.
- Published new Request and retrieve a bulk invoice report for Multi-Channel Fulfillment (MCF) orders for India tutorial to the Request a report tutorial page. The bulk invoice report lets MCF Sellers download the Goods and Service Tax invoice associated with their MCF order in a batch/zip format. Sellers can pass a date range to generate the download request and receive a zip file with delivered MCF order invoices.
- Updated
FEED_PROCESSING_FINISHED
andREPORT_PROCESSING_FINISHED
to include support for vendors. Both notifications include a newaccountId
property, which identifies the selling partner on whose behalf the feed or report was submitted. This change applies to all marketplaces.
- Added the
PaymentInformation
attribute, which is required for India but is optional for all other marketplaces. - Added tutorial on how to create an MCF order for India in the Fulfillment Outbound API v2020-07-01 Use Case Guide.
Documentation changes
- Added Python and Javascript client libraries for SDKs in the SP-API. To learn more about SP-API SDKs, refer to Using SDKs, Tutorial: Automate your SP-API calls using JavaScript SDK for Node.js, and Tutorial: Automate your SP-API calls using Python SDK.
- Reformatted the Report Type Values pages and consolidated the report type attributes for optimized discoverability.
Deprecation notices
Deprecated SP-API resources are no longer in active development. Calls to deprecated SP-API resources will fail beginning on their removal date. For more detailed information about SP-API deprecation dates, refer to the Deprecations table.
- Authorization API v1 (All operations)
- FBA Small and Light API v1 (All operations)
- Fulfillment Inbound API v0 (Select operations)
getInboundGuidance
POST_PRODUCT_DATA
POST_INVENTORY_AVAILABILITY_DATA
POST_PRODUCT_OVERRIDES_DATA
POST_PRODUCT_PRICING_DATA
POST_PRODUCT_IMAGE_DATA
POST_PRODUCT_RELATIONSHIP_DATA
POST_FLAT_FILE_INVLOADER_DATA
POST_FLAT_FILE_LISTINGS_DATA
POST_FLAT_FILE_BOOKLOADER_DATA
POST_FLAT_FILE_CONVERGENCE_LISTINGS_DATA
POST_FLAT_FILE_LISTINGS_DATA
POST_FLAT_FILE_PRICEANDQUANTITYONLY_UPDATE_DATA
POST_UIEE_BOOKLOADER_DATA
POST_FLAT_FILE_FBA_UPDATE_INBOUND_PLAN
POST_FLAT_FILE_FBA_CREATE_INBOUND_PLAN
RFQ_UPLOAD_FEED
GET_PRODUCT_EXCHANGE_DATA
GET_FBA_UNO_INVENTORY_DATA
MFN_ORDER_STATUS_CHANGE
LISTING_ITEM_ISSUES_CHANGE
payload version 1.0
February 21, 2024
API changes
- Added new Report Type Value EndUserDataReport provides personal customer data, including contact information, Glance View, and
Orderdata
for customers who have elected to share this data with the seller when completing a transaction in DE, FR, IT, ES, NL, PL, SE and BE (EU-8) marketplaces.
- Promoted the Application Management API v2023-11-30 from Public Beta to Production. This API lets you programmatically rotate your Login with Amazon (LWA) credentials (client secrets).
Documentation updates
- Added six new code tutorials that detail how to do various tasks such as previewing orders, creating orders, and canceling orders. Find them in the Code Samples section.
Deprecation notices
SP-API resources announcing deprecation will no longer be supported after their deprecation date. Calls to deprecated resources will fail beginning on their removal date. For more detailed information about SP-API deprecation dates, refer to the Deprecations table.
POST_FLAT_FILE_FBA_UPDATE_INBOUND_PLAN
POST_FLAT_FILE_FBA_CREATE_INBOUND_PLAN
RFQ_UPLOAD_FEED
GET_PRODUCT_EXCHANGE_DATA
GET_FBA_UNO_INVENTORY_DATA
MFN_ORDER_STATUS_CHANGE
January 31, 2024
API changes
- Added a new validation mode for the
putListingsItem
andpatchListingsItem
operations. Use themode=VALIDATION_PREVIEW
query parameter to validate a listings item without persisting the data in the catalog. This feature allows you to preview listing errors in production without creating listings.
- Added the
ShipsInProductPackaging
value to thePrepInstruction
enum.PrepInstructionList
is returned in the response for calls toprepInstructions
.
- Added
ExtendedFields
andAddressExtendedFields
objects. These objects are only available for Brazil addresses and are returned in responses for a Brazil shipping addresses that contain extended fields.
Deprecation notices
SP-API resources announcing deprecation will no longer be supported after their deprecation date. Calls to deprecated resources will fail beginning on their removal date. For more detailed information about SP-API deprecation dates, refer to the Deprecations table.
- Authorization API v1 (All operations)
- FBA Small and Light API v1 (All operations)
POST_FLAT_FILE_FBA_UPDATE_INBOUND_PLAN
POST_FLAT_FILE_FBA_CREATE_INBOUND_PLAN
RFQ_UPLOAD_FEED
GET_FBA_UNO_INVENTORY_DATA
GET_PRODUCT_EXCHANGE_DATA
December 13, 2023
API changes
- New Application Management API lets you programmatically rotate your Login with Amazon (LWA) credentials (client secrets). Available in public beta.
- Launched support for dangerous goods (DG) shipping in the US and UK markets.
- India (IN) is now a supported marketplace
- Two new fields added to the
Issue
object:Enforcements
andCategories
searchDefinitionsProductTypes
operation type updated to string
- Added an optional
payloadVersion
parameter - New Listings Item Issues Change Notification version 2023-12-13 has three new enforcement actions:
LISTING_SUPPRESSED
,ATTRIBUTE_SUPPRESSED
, andCATALOG_ITEM_REMOVED
Documentation updates
Vendor Direct Fulfillment Orders API v1 Use Case Guide was updated to include a section on Direct Fulfillment customer data transmission. Vendors do not receive customer data such as name, address, or phone number for certain shipments fulfilled through the getOrder
and getOrders
operations. For Amazon label only vendors, certain fields will be replaced with the fictitious value XXXXX
.
The Vendor Retail Procurement APIs v1 Use Case Guide has been updated to include information on using the Operations SubmitShipments and GetShipmentDetails.
GET_FBA_FULFILLMENT_LONGTERM_STORAGE_FEE_CHARGES_DATA
now includes updated column names. A note has been added to the FBA Long Term Storage Fee Charges Report on the Fulfillment by Amazon (FBA) Report Type Values page, outlining the correct way to generate the report.
The Fulfillment by Amazon (FBA) bulk invoice report (FBA_BULK_INVOICE
) shares the invoices for a seller within the given date range. These invoices include customer orders served by the seller.
Deprecation notices
SP-API resources announcing deprecation will no longer be supported after their deprecation date. Calls to deprecated resources will fail beginning on their removal date. For more detailed information about SP-API deprecation dates, refer to the Deprecations table.
- Authorization API v1 (All operations)
- FBA Small and Light API v1 (All operations)
- Fulfillment Inbound API v0 (Select operations)
getInboundGuidance
- Merchant Fulfillment API v0 (Select operations)
getEligibleShipmentServicesOld
cancelShipmentOld
getAdditionalSellerInputsOld
POST_FLAT_FILE_FBA_UPDATE_INBOUND_PLAN
POST_FLAT_FILE_FBA_CREATE_INBOUND_PLAN
RFQ_UPLOAD_FEED
GET_FBA_UNO_INVENTORY_DATA
GET_PRODUCT_EXCHANGE_DATA
ORDER_STATUS_CHANGE
November 8, 2023
API changes
- New Supply Sources API configures and updates information on seller supply sources, such as stores and warehouses.
- The United Kingdom is now a valid marketplace.
getFeaturedOfferExpectedPriceBatch
(FOEP) has been extended to Amazon.co.uk.ASIN_NOT_ELIGIBLE
is now a value forresultStatus
.- The new
competitiveSummary
operation returns the competitive summary response including featured buying options for the ASIN andmarketplaceId
combination.
- Updated for three new parameters (
itemName
,locale
, andsearchlocale
) and one newdisplayName
product type.
- Updated
ListFinancialEvent
andListFinancialEventGroups
operations more clearly communicate expected responses and scope. The response forChangeRefundTransactions
was modified from an object to an array.
- Updated
weight
field is now mandatory. This change will generate an error when invokingshipmentconfirmations
so that vendors do not have to wait for an error during transaction status.
Documentation updates
- New Multi-Location Inventory (MLI) Integration guide advises Selling Partners on the APIs and operations that are mandatory for integration with MLI , which allows multi location sellers to provide Amazon with location-level data on their inventory and actual fulfillment capabilities.
- Updated Building Listings Management Workflows Guide now includes steps to retrieve a recommendation using the
itemName
orkeywords
in the List an item that does not already exist in the Amazon catalog workflow.
Deprecation notices
SP-API resources announcing deprecation will no longer be supported after their deprecation date. Calls to deprecated resources will fail beginning on their removal date. For more detailed information about SP-API deprecation dates, refer to the Deprecations table.
- Authorization API v1 (All operations)
- FBA Small and Light API v1 (All operations)
- Fulfillment Inbound API v0 (Select operations)
getInboundGuidance
- Merchant Fulfillment API v0 (Select operations)
getEligibleShipmentServicesOld
cancelShipmentOld
getAdditionalSellerInputsOld
GET_FBA_UNO_INVENTORY_DATA
GET_PRODUCT_EXCHANGE_DATA
ORDER_STATUS_CHANGE
October 11, 2023
API changes
- Updated
ItemProcurement
data element changed from object to an array.
- A list of associated items was added to the response for the
getOrderItems
operation.
- The
listingPrice
attribute in thegetItemOffers
response was renamed to help developers avoid errors when extending their code for business-to-business use cases. TheLandedprice
andShipping
sub-fields are no longer required, but optional.
Deprecation notices
SP-API resources announcing deprecation will no longer be supported after their deprecation date. Calls to deprecated resources will fail beginning on their removal date. For more detailed information about SP-API deprecation dates, refer to the Deprecations table.
- Authorization API v1 (All operations)
- FBA Small and Light API v1 (All operations)
- Feeds API v2020-09-04 (All operations)
- Fulfillment Inbound API v0 (Select operations)
getInboundGuidance
- Merchant Fulfillment API v0 (Select operations)
getEligibleShipmentServicesOld
cancelShipmentOld
getAdditionalSellerInputsOld
- Reports API v2020-09-04 (All operations)
GET_FBA_UNO_INVENTORY_DATA
GET_PRODUCT_EXCHANGE_DATA
ORDER_STATUS_CHANGE
September 20, 2023
API changes
- The
BuyerCompanyName
operation description in the Orders v0 API has been updated to clarify the company name of the destination address.
Documentation updates
- Updated Building Listings Management Workflows Guide includes guidance for using the Listings Items API to create package hierarchy relationships, which can link units, case packs, and pallets of a product to create a connected listing. For more information, refer to Configuring package hierarchies.
Deprecation notices
SP-API resources announcing deprecation will no longer be supported after their deprecation date. Calls to deprecated resources will fail beginning on their removal date. For more detailed information about SP-API deprecation dates, refer to the Deprecations table.
- Authorization API v1 (All operations)
- FBA Small and Light API v1 (All operations)
- Feeds API v2020-09-04 (All operations)
- Fulfillment Inbound API v0 (Select operations)
getInboundGuidance
- Merchant Fulfillment API v0 (Select operations)
getEligibleShipmentServicesOld
cancelShipmentOld
getAdditionalSellerInputsOld
- Reports API v2020-09-04 (All operations)
GET_FBA_UNO_INVENTORY_DATA
GET_PRODUCT_EXCHANGE_DATA
August 16, 2023
API changes
- The
ShipmentServiceLevelCategory
property of the order definition has been updated to include the valuePriority
. This value is available from the new shipping template available in the France, Spain, Germany, Poland, Netherlands, Sweden, and Belgium marketplaces to support seller-fulfilled Prime orders. If your integration uses the new shipping templates for these regions, you might need to update your integration to accept thePriority
value forShipmentServiceLevelCategory
.
- The
generic_keyword
attribute is proprietary seller-specific data and will no longer be returned by the Catalog Items API. Selling Partners can use the Listings Items API to view submitted values.
Documentation updates
- The SP-API developer documentation site recently published a new Welcome topic. This topic provides resources for migrating to and integrating with SP-API, tips for searching the documentation site, and quick links to popular SP-API content.
- The SP-API developer documentation site has been updated to include new and improved developer registration topics including how to Register as a public developer, how to Register as a private developer, how to Register as a private vendor, how to Apply for restricted (PII) roles, and how to Check the status of your request to register as a developer.
Deprecation notices
We have adjusted the removal date for the following APIs:
Calls to these APIs will have a lower throttle rate from Aug 16, 2023-* through October 18, 2023. Calls to these APIs will fail on October 18, 2023.
For more detailed information about SP-API deprecation dates, refer to the Deprecations table.
June 21, 2023
API changes
Replenishment API
- New Replenishment API v2022-11-07 returns a selling partner's replenishment program (Subscribe & Save) metrics and offer information. This API is available in the following marketplaces: United States of America, Canada, Brazil, Mexico, United Kingdom, Germany, Spain, Italy, France, Netherlands, United Arab Emirates, India, Japan, and Australia.
Reports API
- New
MARKETPLACE_ASIN_PAGE_VIEW_METRICS
report provides information on the ASIN page view (glance view) metrics for the DE, FR, IT, ES, NL, PL, SE and BE (EU-8) marketplaces, with data available up to the last seven days.
Rapid Retail Analytics
- New
GET_VENDOR_REAL_TIME_SALES_REPORT
shares sales data at an ASIN level, aggregated hourly. Requests can span multiple date range periods. - New
GET_VENDOR_REAL_TIME_TRAFFIC_REPORT
shares data on the customer traffic to the detail pages of the vendor's items, aggregated hourly. Requests can span multiple date range periods. - New
GET_VENDOR_REAL_TIME_INVENTORY_REPORT
shares inventory data at an ASIN level, aggregated hourly.
Listings Items API
- Listings Items API now available in the Belgium (BE) marketplace.
Notifications API
- New
LISTINGS_ITEM_MFN_QUANTITY_CHANGE
notification is sent whenever there is change in the available quantity of a listings item. - New
ORDER_CHANGE
notification is sent whenever there is an important change in the order. Important changes include order status changes and buyer requested cancellations. This notification replacesORDER_STATUS_CHANGE
. - The
B2B_ANY_OFFER_CHANGED
notification has been updated to include the Quantity Discount (QD) pricing in theOffer
section, with new attributes including multiple quantity tiers, discount type, and price. You can now use this notification to build QD re-pricing solutions, which eliminates the need to use pricing APIs for this purpose.
Rapid Retail Analytics
- New
ITEM_SALES_EVENT_CHANGE
notification is sent five minutes after the beginning of each hour. This notification shares sales data at an ASIN level and includes data for the previous hour, as well as any delayed data from up to 24 hours earlier. ASINs are included when they have orders or cancellations during a given hour. Each notification can include multiple ASINs, and a selling partner can expect to receive multiple notifications every hour. - New
ITEM_INVENTORY_EVENT_CHANGE
notification is sent five minutes after the beginning of each hour. This notification shares inventory data at an ASIN level, and includes data for the previous hour, as well as any delayed data from up to 24 hours earlier. ASINs are included if the number of units available for purchase by customers has changed. Each notification can include multiple ASINs, and a selling partner can expect to receive multiple notifications every hour. - New
DETAIL_PAGE_TRAFFIC_EVENT
notification is sent five minutes after the beginning of each hour. This notification shares traffic data at an ASIN level and includes data for the hour before the previous hour, as well as any delayed data from up to 24 hours earlier. ASINs that have glance views are included. Each notification can include multiple ASINs, and a selling partner can expect to receive multiple notifications every hour.
Documentation updates
- New Migrating Listings Management Workflows guide helps you migrate your existing listings management workflows from XML-based and flat file feeds to the Selling Partner Listings Items API and JSON-based feeds.
- Updated reports schemas repo includes
GET_B2B_PRODUCT_OPPORTUNITIES_RECOMMENDED_FOR_YOU
andGET_B2B_PRODUCT_OPPORTUNITIES_NOT_YET_ON_AMAZON
Deprecation notices
SP-API resources announcing deprecation will no longer be supported after their deprecation date. Calls to deprecated resources will fail beginning on their removal date
For more detailed information about SP-API deprecation dates, refer to the Deprecations table.
May 17, 2023
API changes
- Updated the dynamic sandbox to include the
createShippingLabels
operation.
- Remove the Generic Orders Approvals workflow. Removed
ItemApprovalTypes
andItemApprovalStatus
attributes.
Documentation updates
-
New Reports attributes directory lists all the available attributes in SP-API reports.
-
New Vendor Retail Procurement FAQ includes frequently asked questions regarding the SP-API Vendor Retail Procurement API.
Deprecation notices
- Feeds API v2020-09-04
- Reports API v2020-09-04
POST_FLAT_FILE_FBA_CREATE_INBOUND_PLAN
POST_FLAT_FILE_FBA_UPDATE_INBOUND_PLAN
April 19, 2023
API changes
- Updated the
city
property in theaddress
attribute from required to optional.
- Updated the
sellerSku
field to include and parse commas.
Documentation updates
- The Amazon Product Type Definition Meta-Schema (v1) has been updated to include the following keywords:
$lifecycle
,replacedBy
,replaces
,enumDeprecated
, andenumReplacement.
C# guide updates
- Added two new C# guides: Generate a C# SDK with LWA Token Generation and Authentication and Connect to the Selling Partner API using a generated C# SDK.
Deprecation notices
March 29, 2023
API changes
- Update
nextToken
to expire after 30 seconds.
- Added
confirmShipment
operation.
- Updated
address
attribute to include city. - Updated to employ a dynamic sandbox for testing instead of a static sandbox. Includes one new sandbox-only operation.
Documentation updates
- New Orders API Use Case Guide for the Orders v0 shipment confirmation operation. The
confirmShipment
operation confirms the shipment status for a specified order. It can also be used to edit shipment details of orders that have been shipped. include link to guide (when available) - New use case guide Fulfillment Outbound API Dynamic Sandbox v2020-07-01 explains how test your applications without affecting production data or initiating real-world events.
- Expanded library of reports schemas available on selling-partner-api-models GitHub repo
- Three new Listings Items API resources to address common questions:
Deprecation notices
February 22, 2023
API changes
- Updated static sandbox mock responses to display names of select UPS domestic (US) ship methods on SP-API.
- Added the following delivery preferences attributes to
getOrderAddress
to support Amazon Business customer orders:PreferredDeliveryTime
BusinessHours
OtherAttributes
AddressInstructions
These attributes contain information about how and when a package is delivered.
- The
customedURL
attribute ofbuyerCustomizedInfo
, returned by thegetOrder
andgetOrders
operations, is now a Base 64 encoded URL using the UTF-8 character set.
- Updated to pass
six-month-past-in-date
as a query parameter.
Documentation updates
- New Amazon Business Orders Use Case Guide introduces operations to obtain information about Amazon Business customers and their delivery preferences.
- New Sales API Use Case Guide provides sellers with sales performance information. This is achieved through returning aggregated order metrics for a given period of time, broken down by granularity, and buyer type.
- New FBA Small & Light Use Case Guide introduces operations to help access the Small and Light FBA program.
Deprecation notices
January 25, 2023
API Changes
- New
getFeaturedOfferExpectedPriceBatch
operation retrieves responses to a batch of up to 40 featured offer expected price (FOEP) requests.
- New
buyerCustomizedInfo
attribute, containing buyer information for products the vendor has configured as customizable, specifying the types of customization or configurations along with types and ranges for their product.
- New
serialNumber
attribute returns a list of serial numbers for electronic products that are shipped to customers. Returned for FBA orders only.
- New financial event type:
CapacityReservationBillingEventList
allows you to retrieve details related to a Capacity Reservation Billing charge.
Documentation updates
- New use case directories identify the APIs, notifications, and reports that you’ll need for general SP-API Seller and Vendor use cases. Additionally, the SP-API models table indicates whether each API is available for sellers or vendors and includes links to each model’s reference and any relevant release notes.
- New Vendor Direct Fulfillment Orders API v2021-23-28 use case guide covers the Vendor DF Orders API, which provides programmatic access to a direct fulfillment vendor's order data.
- New Vendor Direct Fulfillment Transaction Status API v2021-12-28 use case guide covers the Vendor DF Transaction Status API, which provides programmatic access to a direct fulfillment vendor's transaction status.
- Updated dynamic usage plans topic for the Usage Plans and Rate Limits in the SP-API Guide includes the Product Pricing API and
getFeaturedOfferExpectedPriceBatch
operation.
Deprecation notices
- Feeds API v2020-09-04
- Reports API v2020-09-04
- FBA Inventory Reports
MFN_ORDER_STATUS_CHANGE
Notification
December 6, 2022
API Changes
The Catalog Items v2022-04-01 API has been updated to include several additional attributes in the summary to bring the Catalog Items API to parity with the Marketplace Web Services Catalog Items section:
In addition, the following attributes have been added to ItemSummaryByMarketplace
:
adultProduct
autographed
memorabilia
releaseDate
tradeInEligible
November 9, 2022
API Changes
-
New GST Merchant Tax Report B2B
GET_GST_MTR_B2B_CUSTOM
provides detailed information about sales, refunds, and cancellations from Amazon Business invoices issued within a date range that you specify. Only available in the India Marketplace. -
New GST Merchant Tax Report B2C
GET_GST_MTR_B2C_CUSTOM
provides detailed information about sales, refunds, and cancellations from consumer invoices issued within a date range that you specify. Only available in the India Marketplace. -
New GST Merchant Stock Transfer Report
GET_GST_STR_ADHOC
provides details on inventory movements from Amazon Fulfillment Centers (FC removals or FC to FC transfers). The report contains transaction level details required for accounting and GST tax filing. Only available in the India Marketplace.
Documentation updates
- New Building Listings Management Workflows Guide describes the steps you can take to build best-in-class listings creation and management workflows by integrating with the Selling Partner API.
October 19, 2022
API Changes
Updated for new FBA_INVENTORY_AVAILABILITY_CHANGES
notification that is sent whenever there is a change in the Fulfillment By Amazon (FBA) inventory quantities. This notification includes a snapshot of the FBA inventory in all eligible marketplaces in a particular region.
-
Updated
GET_SALES_AND_TRAFFIC_REPORT
, which now includes B2B traffic data regarding traffic originating from Amazon Business customers. As of 08/28/2022 B2B conversion metrics have changed to use the new B2B traffic data. Data before 08/28/2022 is set to zero to avoid confusion. -
New Subscribe and Save Forecasting report
GET_FBA_SNS_FORECAST_DATA
provides an eight-week forecast of sales based on existing subscriptions and sales history. -
New Subscribe and Save Performance report
GET_FBA_SNS_PERFORMANCE_DATA
provides a trailing four-week view of items shipped, percentage of orders missed due to being out of stock, average post-discount sale price, and average discount for each SKU.
Documentation updates
- New Selling Partner API Guard Implementation Guide describes architectural considerations and configuration steps for deploying Amazon Selling Partner Guard in AWS Cloud.
September 21, 2022
API Changes
- Updated for new createShippingLabels synchronous operation that creates shipping labels for a purchase order and returns the labels. Note that the
createShippingLabels
operation does not have any sandbox support at this time. - Updated for production and dynamic sandbox support for all of the equivalent Vendor Direct Fulfillment Shipping V1 operations.
- Updated for the following restricted operations to support Vendor Direct Fulfillment Shipping API v2021-12-28:
createShippingLabels
getPackingSlip
getCustomerInvoice
getShippingLabel
- Updated Inventory Ledger Report (
GET_LEDGER_DETAIL_VIEW_DATA
) now includes a neweventType
filter to filter on particular warehouse events.
Documentation updates
- New VAT Calculation Service Guide provides developers in EU marketplaces with guidance for Amazon’s VAT Calculation Service.
- New Solicitations API v1 Use Case Guide covers the Selling Partner API for Solicitations (Solicitations API) which helps you build applications that let sellers send consistent, high-quality solicitations to buyers.
- New Messaging API v1 Use Case Guide discusses the Messaging API.
- New URL encoding guide explains how to encode URLs to avoid errors with SKUs.
- Updated Vendor Direct Fulfillment Dynamic Sandbox Guide includes support for Vendor Direct Fulfillment Shipping v2021-12-28 operations. Note that the createShippingLabels operation does not have any sandbox support at this time.
August 10, 2022
API Changes
- Improvements to the Orders API in support of Easy Ship shipments.
- Updated for new
getRangeSlotCapacity
operation that provides capacity slots in a format similar to availability records. - Updated for new
getFixedSlotCapacity
operation that provides fixed capacity slots.
May 18, 2022
API Changes
- New Catalog Items API version 2022-04-01 improves the API experience and addresses developer feedback with the following changes:
- Added identifier-based searches to the
searchCatalogItems
operation, enabling batch-like requests with up to 20 identifiers per request (such as ASINs, UPCs, and EANs) - Added
dimensions
data set, providing normalized item and package dimensions - Added display names for product category, product subcategory, and browse classification
- Expanded identifying attributes to item summaries (item classification, package quantity, part number, website display group)
- Added browse classifications and website display groups to sales ranks
- Aligned
searchCatalogItems
andgetCatalogItem
operations to use the same data sets, includingattributes
- Replaced
variations
withrelationships
to allow for multiple relationship types to be represented, such as package hierarchies - Added variation theme details (name to the relationships details)
- Added identifier-based searches to the
- Added a
processingDirective
parameter that lets you pass additional information to the subscription to control the processing of notifications. This parameter is used by theANY_OFFER_CHANGED
notification. - Updated the
ANY_OFFER_CHANGED
notification to support filtering notifications to only specificmarketplaceIds
, and limiting notifications to one every five or ten minute interval.
- Updated to include support for the Purchase Shield program that manages regulated orders in the UK. Regulated orders are a limited set of orders that fulfill products requiring a prescription (pet medication, prescription contacts, and prescription glasses). Two new operations have been added:
getOrderRegulatedInfo
andupdateVerificationStatus
. - New
IsAccessPointOrder
attribute to support identifying MFN (fulfilled by seller) orders that have been shipped to access point (AP) hubs.
- Updated for new
getMyFeesEstimates
operation that retrieves product fee estimates for a list of products and marketplaces.
- Updated for new
getItemOffersBatch
andgetListingOffersBatch
operations that retrieve product pricing and offer information in a list for products.
- New EPR Monthly Report, EPR Quarterly Report, and EPR Annual Reports report types include data on the Extended Producer Responsibility (EPR) declarations for service providers in France and Germany to help sellers maintain compliance with EU regulations.
April 13, 2022
API Changes
- New Easy Ship API helps you build applications that help sellers manage and ship Amazon Easy Ship orders.
- Updated FBA Inventory API for global availability and released new FBA Inventory Use Case Guide.
- New
PRICING_HEALTH
notification is sent whenever a seller offer is ineligible to be the Featured Offer (Buy Box offer) because of an uncompetitive price. - New
FulfillmentChannel
property in theORDER_STATUS_CHANGE
notification that allows you to filter order status change notifications based on whether the order is fulfilled by Amazon (AFN) or fulfilled by seller (MFN).
- New Vendor Direct Fulfillment Orders API v2021-12-28 provides programmatic access to a direct fulfillment vendor's order data. This v2021-12-28 release adds support for dynamic sandbox testing.
- New Vendor Direct Fulfillment Sandbox Test Data API v2021-10-28 provides programmatic access to vendor direct fulfillment sandbox test data.
- New Vendor Direct Fulfillment Shipping API v2021-12-28 reference provides programmatic access to a direct fulfillment vendor's shipping data. This v2021-12-28 release adds support for dynamic sandbox testing.
- New Vendor Direct Fulfillment Transactions API v2021-12-28 provides programmatic access to a direct fulfillment vendor's transaction status. This v2021-12-28 release adds support for dynamic sandbox testing.
Documentation updates
- New Vendor Direct Fulfillment Dynamic Sandbox Guide introduces the available dynamic sandbox operations for the Vendor Direct Fulfillment APIs.
- New Vendor Retail Analytics Reports Migration Guide that explains changes to the vendor retail analytics reports and provides steps for migration.
March 23, 2022
API Changes
- New
buyerRequestedCancel
parameter provides information on whether a buyer requested order cancellation and reason for cancellation.
New Seller retail analytics reports
- New Sales and Traffic Business Report helps you manage your analytics better by providing key sales performance metrics such as ordered product sales, revenue, units ordered, and claim amount, as well as page traffic metrics such as page views and buy box percentage of the seller’s entire catalog of items aggregated by date and ASIN. This report requires the Brand Analytics Selling Partner API role which is now available to all sellers.
- New Coupons Performance Report helps you optimize your promotions and adjust your advertising strategies. The report includes campaign-level details (total clips, redemptions) and coupon-level details (start/end date, clips, redemptions, and budget information). Available to vendors who have the Brand Analytics Selling Partner API role.
New Vendor retail analytics reports
- New Vendor Sales Report helps you manage your inventory better by providing key retail sales metrics such as ordered/shipped revenue and units. Data is reported at the aggregate level across a vendor's catalog of items and at the ASIN level across
DAY
,WEEK
,MONTH
,QUARTER
, andYEAR
reporting periods. Available to vendors who have the Brand Analytics Selling Partner API role. - New Vendor Traffic Report helps you manage your inventory better by providing key retail traffic metrics such as detail page views. Data is reported at the aggregate level across a vendor's catalog of items and at the ASIN level across
DAY
,WEEK
,MONTH
,QUARTER
, andYEAR
reporting periods. Available to vendors who have the Brand Analytics Selling Partner API role. - New Vendor Forecasting Report helps you manage your inventory better by providing forward looking mean, P70, P80, and P90 weekly customer demand forecasts. The forecasting system produces forecasts for an ASIN at various P-levels, also known as confidence levels. If you are setting a forecasting P-level of .80 ("P80"), it means that there is an 80% probability customer demand will not exceed the weekly forecasted units. Data is reported at the ASIN level for the most recent weekly forecast generation date. Available to vendors who have the Brand Analytics Selling Partner API role.
- New Vendor Inventory Health Report 2.0 helps you manage your inventory better by providing inventory and operational health metrics such as sellable on hand units and vendor confirmation rate. Data is reported at the aggregate level across a vendor's catalog of items and at the ASIN level across week, month, quarter, and year reporting periods. Available to vendors who have the Brand Analytics Selling Partner API role.
Documentation update for Invoice data reports
- Flat File VAT Invoice Data Report and XML VAT Invoice Data Report are now available in documentation. These reports are for sellers enrolled in Amazon’s VAT Calculation Service and who opt to upload their own invoices.
Documentation updates
-
New Migration Hub page aggregates all Amazon MWS to Selling Partner API migration-related timelines, planned deprecation dates, and resources into a single reference page.
-
New Selling Partner API Blog site includes articles from Amazon Solutions Architects and API experts covering a range of topics including customer stories, migration, best practices, tips and tricks, and much more.
January 19, 2022
API Changes
- New error code
PRODUCTASSURANCE_SAFETYDOCUMENTATION
returned for non-compliant products that do not have safety compliance documentation. This error code is returned for the following operations:CreateInboundShipmentPlan
CreateInboundShipment
UpdateInboundShipment
PreviewItemEligibility
Read more about this change on Seller Central.
- New
buyerTaxInformation
attribute for the Turkey Marketplace. This attribute includes business tax information when the buyer is a business.
- New Order Status Change notification is sent whenever there is a change in the status of order availability.
- New FBA Manage Inventory Health Report helps you manage your inventory better by providing a consolidated view across your sales (7, 30, 60, and 90 days), shipment statuses (working, received, and shipped), estimated storage and long-term storage fees, and aged and excess units. This report includes metrics across sales, inbound, estimated fees, and recommended actions.
- New On Demand Stock Transfer Report that provides transaction level information like invoice value, invoice number, tax rate, and Goods and Services Tax Identification Numbers (GSTINs) for interstate movement transactions.
Documentation updates
Amazon MWS to Selling Partner API Migration Guide
- Updated documentation with additional migration guidance and resources, including the Selling Partner API (SP-API) Video Series on YouTube for step-by-step migration assistance and the Selling Partner API on AWS Quick Start for configuring IAM resources and deploying SP-API on the AWS Cloud.
Updated 3 days ago