Table of Contents
The objects and operations currently supported are displayed in the tables below. Bold fields indicate mandatory field entry.
Object: Catalog items #
| Operation | Description | Required Fields |
|---|---|---|
searchCatalogItems | Search for and return a list of Amazon catalog items and associated information either by identifier or by keywords. | marketplaceIds |
getCatalogItem | Retrieves details for an item in the Amazon catalog. | asin marketplaceIds |
Object: Feed (Native) #
| Operation | Description | Required Fields |
|---|---|---|
getFeeds | Returns feed details for the feeds that match the filters that you specify. | |
createFeed | Creates a feed. Upload the contents of the feed document before calling this operation. | body feedType marketplaceIds InputFeedDocumentId |
cancelFeed | Cancels the feed that you specify. Only feeds with processingStatus=IN_QUEUE can be cancelled. Cancelled feeds are returned in subsequent calls to the getFeed and getFeeds operations. | feedId |
getFeed | Returns feed details (including the resultDocumentId, if available) for the feed that you specify. | feedId |
createFeedDocument | Creates a feed document for the feed type that you specify. This operation returns a presigned URL for uploading the feed document contents. It also returns a feedDocumentId value that you can pass in with a subsequent call to the createFeed operation. | body contentType |
getFeedDocument | Returns the information required for retrieving a feed document’s contents. | feedDocumentId |
Object: Feed #
| Operation | Description | Required Fields |
|---|---|---|
createOrderAcknowledgementFeed | Create an Order Acknowledgement feed document. | body marketplaceIds envelope MerchantIdentifier document |
createOrderAdjustmentFeed | Create an Order Acknowledgement feed document. | body marketplaceIds envelope MerchantIdentifier document |
createOrderFulfillmentFeed | Create an order Order Fulfillment feed document. | body marketplaceIds envelope MerchantIdentifier document |
createInventoryFeed | Create an Inventory feed document. | body marketplaceIds envelope MerchantIdentifier OperationType — ( UPDATE, DELETE, PARTIAL_UPDATE, PATCH)document SKU |
createPricingFeed | Create a Pricing feed document. | body marketplaceIds envelope OperationType — ( UPDATE, DELETE, PARTIAL_UPDATE, PATCH)document |
downloadFeedDocument | Retrieves created object feed document based on supplied feedId. | feedId |
Object: Order #
| Operation | Description | Required Fields |
|---|---|---|
getOrders | Returns orders created or updated during the time frame indicated by the specified parameters. You can also apply a range of filtering criteria to narrow the list of orders returned. See Fulfilled by Amazon | marketplaceIds[Key] |
getOrder | Retrieves details for a specific order. | orderId |
getOrderItems | Returns detailed order item information for the order that you specify. | orderId |
Fulfilled by Amazon #
The FulfillmentChannels - item field can be set to filter returned results based on whether they were fulfilled by Amazon or the seller:
Setting the parameter to:
- AFN will return results fulfilled by Amazon.
- MFN will return results fulfilled by the seller.
- Leaving the parameter blank will enable the default setting and will return results for both fulfillment channels.
Object: Report #
| Operation | Description | Required Fields |
|---|---|---|
retrieveAllListingsReport | Retrieve all Listing reports using supplied reportId | reportId |
Object: Report (Native) #
| Operation | Description | Required Fields |
|---|---|---|
getReports | Returns report details for the reports that match the filters that you specify. | |
createReport | Creates a report. | body reportType marketplaceIds |
cancelReport | Cancels the report that you specify. Only reports with processingStatus=IN_QUEUE can be cancelled. Cancelled reports are returned in subsequent calls to the getReport and getReports operations. | reportId |
getReport | Returns report details (including the reportDocumentId, if available) for the report that you specify. | reportId |
getReportSchedules | Returns report schedule details for the report schedule that you specify. | reportScheduleId |
createReportSchedule | Creates a report schedule. If a report schedule with the same report type and marketplace IDs already exists, it will be cancelled and replaced with this one. | body reportType period |
cancelReportSchedule | Cancels the report schedule that you specify. | reportDocumentId |
getReportDocument | Returns the information required for retrieving a report document’s contents. | reportDocumentId |
