Map Merchant Fulfillment API, Orders API, and Reports API from MWS to SP-API
Provides detailed mapping of API endpoints for Merchant Fulfillment API, Orders API, and Reports API for reference during migration from MWS to SP-API.
by Jiang G., Solutions Architect, Selling Partner Developer Services | August 15, 2023
The Amazon Marketplace Web Service (Amazon MWS) API has helped developers access data programmatically for over 10 years. The new SP-API is a REST-based API, created to provide a more modern and robust solution for sellers looking to manage their inventory, orders, and fulfillment more effectively. The tables included in this post can assist developers with comprehending the association between APIs for Amazon MWS and those for Selling Partner API, as certain names and features might differ after migration.
Merchant Fulfillment API
With the Merchant Fulfillment API, sellers can programmatically purchase and print shipping labels for orders they have received on Amazon and are fulfilling themselves. This API provides a range of functions such as listing available shipping services, purchasing shipping, and generating shipping label data. By using the Merchant Fulfillment API, sellers can streamline their fulfillment processes, reduce costs, and improve their overall efficiency on the Amazon platform.
The concept of shipping flow for SP-API is similar to the shipping flow for MWS. When creating a shipment, the developer's system that uses the Merchant Fulfillment API, first checks for eligible shipment services by calling the getEligibleShipmentServices operation.
If the shipping service requires additional seller inputs, the value for ShippingService.RequiresAdditionalSellerInputs will be true, and the developer's system will need to call the operation getAdditionalSellerInputs before proceeding with creating the shipment.
Once all required information is gathered, the developer's system calls the createShipment operation. The response from this API call returns a JSON field “Label” that includes data for creating a shipping label and dimensions for printing the label. To extract label information, the developer's system must decode the Base64-encoded string, save the decoded string with a ".gzip" extension, and then extract the PDF, PNG, or ZPL file from the GZIP file.
This API is not available in the JP marketplace. Although the GetServiceStatus operation from MWS was deprecated, the operations in SP-API are similar to MWS and there are no huge differences. The Selling Partner API - Health Dashboard can be used to check all SP-API service statuses.
Shipping API v2 is also now available in SP-API. This API is designed to support outbound shipping use cases both for orders originating on Amazon-owned marketplaces and external channels/marketplaces. With these APIs, you can request shipping rates, create shipments, cancel shipments, and track shipments.
| MWS | SP-API |
|---|---|
| N/A | getEligibleShipmentServices Note: Do not use getEligibleShipmentServicesOld |
| GetEligibleShippingServices | getEligibleShipmentServices |
| GetShipment | getShipment |
| CancelShipment | cancelShipment |
| N/A | cancelShipment Note: Do not use cancelShipmentOld |
| CreateShipment | createShipment |
| N/A | getAdditionalSellerInputs Note: Do not use getAdditionalSellerInputsOld |
| GetAdditionalSellerInputs | getAdditionalSellerInputs |
| GetServiceStatus | Selling Partner API - Health Dashboard |
Orders API
With the Orders API, sellers can retrieve detailed information about orders including the order status, buyer information, shipping information, item details, payment information, and more. Remember to use a Restricted Data Token for PII data, such as buyer information and shipping information.
Using the Orders API, sellers can streamline their order management processes and integrate their own systems with Amazon's order management system. This can help sellers improve their operational efficiency and manage their orders on the Amazon platform. SP-API provides additional API operations, compared to MWS, such as getOrderBuyerInfo, getOrderItemsBuyerInfo, and regulated order related operations.
| MWS | SP-API |
|---|---|
| ListOrders ListOrdersByNextToken | getOrders (NextToken is an optional query parameter for getOrders) |
| GetOrder | getOrder |
| N/A | getOrderBuyerInfo |
| N/A | getOrderAddress |
| ListOrderItems ListOrderItemsByNextToken | getOrderItems (NextToken is an optional query parameter for getOrderItems) |
| N/A | getOrderItemsBuyerInfo |
| N/A | updateShipmentStatus |
| N/A | getOrderRegulatedInfo |
| N/A | updateVerificationStatus |
| N/A | confirmShipment |
| GetServiceStatus | Selling Partner API - Health Dashboard |
To detect new incoming orders, we recommend subscribing to the ORDER_CHANGE notification type, so sellers get notifications as soon as a new order is placed on Amazon the platform or when an existing order changes its status. Find out how to avoid missing orders when using the getOrders API by watching Best Practices to Avoid Missing Orders in Orders API (EN,JP, CN) on the Amazon SP-API Developer University YouTube channel.
Developers can also subscribe to our YouTube channel SP-API Developer University.
Reports API
With the Reports API, sellers can programmatically retrieve various types of reports related to their Amazon business, such as order reports, financial reports, and FBA reports. These reports provide valuable insights and data about a seller's business on Amazon that helps the seller optimize their operations and grow their business on the platform.
The concept of report request flows for SP-API is the same as MWS, except that SP-API removed some endpoints, such as get count endpoints and get by NextToken endpoints, to make the API call simple and robust.
The tutorials and the details for the use cases can be found in the Reports API documentation.
| MWS | SP-API |
|---|---|
| RequestReport | createReport |
| GetReportRequestList GetReportRequestListByNextToken | getReports (NextToken is an optional query parameter for getReports)getReport |
| GetReportRequestCount | N/A |
| CancelReportRequests | cancelReport |
| GetReportList GetReportListByNextToken | N/A |
| GetReportCount | N/A |
| GetReport | getReportDocument |
| ManageReportSchedule | createReportSchedule cancelReportSchedule |
| GetReportScheduleList GetReportScheduleListByNextToken | getReportSchedules (NextToken is an optional query parameter for getReportSchedules) |
| N/A | getReportSchedule |
| GetReportScheduleCount | N/A |
| UpdateReportAcknowledgements | N/A |
To detect when a report has been successfully generated, is canceled, or has a fatal status, we recommend subscribing to the REPORT_PROCESSING_FINISHED notification type, which developers can use to design an event driven system architecture. Developers can also subscribe to our YouTube channel and view a demonstration of How to Create Notifications for Reports.
Conclusion
This blog post introduced the API endpoint mapping for Merchant Fulfillment API, Orders API, and Reports API. Refer to the following links for more migration related content.
• SP-API Migration Hub
• Amazon MWS to SP-API Migration Guide
• Migration FAQ
• Selling Partner API videos
Have feedback on this post?
If you have questions or feedback on this post, we'd like to hear from you! Please vote and leave a comment using the tools at the bottom of this page.
Subscribe to updates via RSS feed.
Updated 6 months ago