Skip to main content

  • Important: Due to EU & UK Payments regulatory requirements, an additional security verification via Digital Signatures is required for certain API calls that are made by EU/UK sellers. Please refer to Digital Signatures for APIs to learn more on the impacted APIs and the process to create signature to be included in the HTTP payload.

  • OpenAPI Specification - Version 2.0 for all of our RESTful APIs will no longer be available starting April 5, 2023. We will continue leveraging OpenAPI Specification - Version 3.0 for new features in our RESTful APIs.

The Feed API lets sellers upload input files, download reports and files including their status, filter reports using URI parameters, and retrieve customer service metrics task details.


Method NameHTTP MethodPathSummarySamples
createOrderTaskPOST/order_taskConfigures and creates an order report task.View createOrderTask - /order_task
getOrderTaskGET/order_task/{task_id}Retrieves the details for a specified order report task.View getOrderTask - /order_task/{task_id}
getOrderTasksGET/order_taskRetrieves the details on one or more order report tasks based on search criteria.View getOrderTasks - /order_task


Method NameHTTP MethodPathSummarySamples
createInventoryTaskPOST/inventory_taskConfigures and creates an active inventory report task.View createInventoryTask - /inventory_task
getInventoryTaskGET/inventory_task/{task_id}Retrieves the details for a specified active inventory report task.View getInventoryTask - /inventory_task/{task_id}
getInventoryTasksGET/inventory_taskRetrieves the details on one or more active inventory report tasks based on search criteria.View getInventoryTasks - /inventory_task


Method NameHTTP MethodPathSummarySamples
createSchedulePOST/scheduleConfigures and creates a job that will generate a report based on the frequency and metric defined in the specific schedule template.View createSchedule - /schedule
deleteScheduleDELETE/schedule/{schedule_id}Deletes an existing schedule.View deleteSchedule - /schedule/{schedule_id}
getLatestResultFileGET/schedule/{schedule_id}/download_result_fileDownloads the latest result file generated by the schedule.View getLatestResultFile - /schedule/{schedule_id}/download_result_file
getScheduleGET/schedule/{schedule_id}Retrieves the schedule details and status of the specified schedule.View getSchedule - /schedule/{schedule_id}
getSchedulesGET/scheduleRetrieves details and status of schedules based on the specified feed type.View getSchedules - /schedule
getScheduleTemplateGET/schedule_template/{schedule_template_id}Retrieves details of the specified template.View getScheduleTemplate - /schedule_template/{schedule_template_id}
getScheduleTemplatesGET/schedule_templateRetrieves the details and status of schedule templates based on the specified feed type.View getScheduleTemplates - /schedule_template
updateSchedulePUT/schedule/{schedule_id}Updates an existing schedule for a given schedule ID.View updateSchedule - /schedule/{schedule_id}


Method NameHTTP MethodPathSummarySamples
createTaskPOST/taskCreates an upload feed file task and returns a task ID that will be needed before uploading the feed file.View createTask - /task
getInputFileGET/task/{task_id}/download_input_fileDownloads the upload feed file associated with the specified task ID. View getInputFile - /task/{task_id}/download_input_file
getResultFileGET/task/{task_id}/download_result_fileDownloads the report file associated with the specified task ID.View getResultFile - /task/{task_id}/download_result_file
getTaskGET/task/{task_id}Retrieves the details and status of the specified task.View getTask - /task/{task_id}
getTasksGET/taskRetrieves the details and status of tasks based on search criteria.View getTasks - /task
uploadFilePOST/task/{task_id}/upload_fileUploads a feed file associated with the specified task ID.View uploadFile - /task/{task_id}/upload_file


Method NameHTTP MethodPathSummarySamples
createCustomerServiceMetricTaskPOST/customer_service_metric_taskConfigures and creates a customer service metrics download task, and the resultant report can be downloaded with the getResultFile method.View createCustomerServiceMetricTask - /customer_service_metric_task
getCustomerServiceMetricTaskGET/customer_service_metric_task/{task_id}Retrieves the customer service metrics task details for the specified task ID.View getCustomerServiceMetricTask - /customer_service_metric_task/{task_id}
getCustomerServiceMetricTasksGET/customer_service_metric_taskRetrieves details and statuses for an array of customer service metric tasks by search criteria.View getCustomerServiceMetricTasks - /customer_service_metric_task