feed APIv1.2.0

API Reference : Resources

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.

order_task

Method NameHTTP MethodPathSummarySamples
createOrderTaskPOST
/order_task
Creates an order download task with filter criteria for the order report.View createOrderTask - /order_task
getOrderTaskGET
/order_task/{task_id}
Retrieves the order task details for the specified task ID.View getOrderTask - /order_task/{task_id}
getOrderTasksGET
/order_task
Retrieves the details of order tasks for the specified feed_type. You can control the tasks that are returned by using URI parameters filters.View getOrderTasks - /order_task

schedule

Method NameHTTP MethodPathSummarySamples
createSchedulePOST
/schedule
Creates a schedule, which generates reports according to the specified schedule template.View createSchedule - /schedule
deleteScheduleDELETE
/schedule/{schedule_id}
Deletes an existing schedule.View deleteSchedule - /schedule/{schedule_id}
getLatestResultFileGET
/schedule/{schedule_id}/download_result_file
Downloads 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
/schedule
Retrieves an array containing the details and status of all 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_template
Retrieves an array containing the details and status of all 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}

task

Method NameHTTP MethodPathSummarySamples
createTaskPOST
/task
Creates a task without filter criteria. Whether it is a download or upload task is determined by the feed_type specified.View createTask - /task
getInputFileGET
/task/{task_id}/download_input_file
Downloads the input file associated with the specified task ID. View getInputFile - /task/{task_id}/download_input_file
getResultFileGET
/task/{task_id}/download_result_file
Downloads 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
/task
Retrieves the details and status tasks based on the specified feed_type. You can control which tasks are returned by using URI parameters.View getTasks - /task
uploadFilePOST
/task/{task_id}/upload_file
Uploads the specified input file, associates the file with the specified task ID, and generates the report.View uploadFile - /task/{task_id}/upload_file

customer_service_metric_task

Method NameHTTP MethodPathSummarySamples
createCustomerServiceMetricTaskPOST
/customer_service_metric_task
Creates a customer service metrics download task with filter criteria for the customer service metrics report.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_task
Retrieves details and status for an array of customer service metrics. These metrics are execution history tasks for the specified feed type or date range.View getCustomerServiceMetricTasks - /customer_service_metric_task