Open documentation ↗Overview
<p>The <strong>Feed API</strong> lets sellers upload input files, download reports and files including their status, filter reports using URI parameters, and retrieve customer service metrics task details.</p>
Feed API is a shopping API from ebay.com. Requests are authenticated with OAuth. It is served over HTTPS. Its OpenAPI description documents 23 endpoints.
At a glance
- Authentication
- OAuth
- HTTPS
- Yes
- CORS
- Unknown
- Category
- Shopping
- Version
- v1.3.1
- Endpoints
- 23
- OpenAPI
- Specification ↗
- Spec updated
- 2023-03-05
Endpoints
| Method | Path | What it does |
|---|---|---|
| GET | /customer_service_metric_task | Use this method to return an array of customer service metric tasks. You can limit the tasks returned by specifying a date range. </p> <p> <span class="tablenot |
| POST | /customer_service_metric_task | <p>Use this method to create a customer service metrics download task with filter criteria for the customer service metrics report. When using this method, spec |
| GET | /customer_service_metric_task/{task_id} | <p>Use this method to retrieve customer service metric task details for the specified task. The input is <strong>task_id</strong>.</p> |
| GET | /inventory_task | This method searches for multiple tasks of a specific feed type, and includes date filters and pagination. |
| POST | /inventory_task | This method creates an inventory-related download task for a specified feed type with optional filter criteria. When using this method, specify the <strong>feed |
| GET | /inventory_task/{task_id} | This method retrieves the task details and status of the specified inventory-related task. The input is <strong>task_id</strong>. |
| GET | /order_task | This method returns the details and status for an array of order tasks based on a specified <strong>feed_type</strong> or <strong>schedule_id</strong>. Specifyi |
| POST | /order_task | This method creates an order download task with filter criteria for the order report. When using this method, specify the <b> feedType</b>, <b> schemaVersion</b |
| GET | /order_task/{task_id} | This method retrieves the task details and status of the specified task. The input is <strong>task_id</strong>. <p>For details about how this method is used, se |
| GET | /schedule | This method retrieves an array containing the details and status of all schedules based on the specified <strong>feed_type</strong>. Use this method to find a s |
| POST | /schedule | This method creates a schedule, which is a subscription to the specified schedule template. A schedule periodically generates a report for the <strong>feedType< |
| GET | /schedule/{schedule_id} | This method retrieves schedule details and status of the specified schedule. Specify the schedule to retrieve using the <strong>schedule_id</strong>. Use the <s |
| PUT | /schedule/{schedule_id} | This method updates an existing schedule. Specify the schedule to update using the <strong>schedule_id</strong> path parameter. If the schedule template has cha |
| DELETE | /schedule/{schedule_id} | This method deletes an existing schedule. Specify the schedule to delete using the <strong>schedule_id</strong> path parameter. |
| GET | /schedule/{schedule_id}/download_result_file | This method downloads the latest result file generated by the schedule. The response of this call is a compressed or uncompressed CSV, XML, or JSON file, with t |
| GET | /schedule_template | This method retrieves an array containing the details and status of all schedule templates based on the specified <strong>feed_type</strong>. Use this method to |
| GET | /schedule_template/{schedule_template_id} | This method retrieves the details of the specified template. Specify the template to retrieve using the <strong>schedule_template_id</strong> path parameter. Us |
| GET | /task | This method returns the details and status for an array of tasks based on a specified <strong>feed_type</strong> or <strong>scheduledId</strong>. Specifying bot |
| POST | /task | This method creates an upload task or a download task without filter criteria. When using this method, specify the <b> feedType</b> and the feed file <b> schema |
| GET | /task/{task_id} | This method retrieves the details and status of the specified task. The input is <strong>task_id</strong>. <br /><br />For details of how this method is used, s |
| GET | /task/{task_id}/download_input_file | This method downloads the file previously uploaded using <strong>uploadFile</strong>. Specify the task_id from the <strong>uploadFile</strong> call. <p><span cl |
| GET | /task/{task_id}/download_result_file | This method retrieves the generated file that is associated with the specified task ID. The response of this call is a compressed or uncompressed CSV, XML, or J |
| POST | /task/{task_id}/upload_file | This method associates the specified file with the specified task ID and uploads the input file. After the file has been uploaded, the processing of the file be |
Questions
Does the Feed API API need an API key?
Yes. The Feed API API uses OAuth authentication; the documentation explains how to get credentials.
Does the Feed API API support HTTPS?
Yes, the Feed API API is served over HTTPS.
How many endpoints does the Feed API API have?
Its OpenAPI description lists 23 endpoints in version v1.3.1. All of them are shown on this page.
What are alternatives to the Feed API API?
Other Shopping APIs include Etsy, eBay, Flipkart Marketplace, Inventory Management, Intel Product Catalogue Service.
Similar shopping APIs
Compare alternatives →Etsy
ShoppingManage shop and interact with listings
eBay
ShoppingSell and Buy on eBay
Flipkart Marketplace
ShoppingProduct listing management, Order Fulfilment in the Flipkart Marketplace
Inventory Management
ShoppingMaintaining up-to-date inventory for your items on Walmart.com ensures a great experience for your customers and greater sales opportunities for you.
Intel Product Catalogue Service
ShoppingThis is the documentation for PIM Micro services. In order to use this tool you need to have Basic Auth credentials and a client id. If you dont have one, please make sure to request one by sending an email to the PIM MS team: [[email protected]](mailto:[email protected]?subject=PIMServices)
Item API
ShoppingPlease make sure you use the correct version of the APIs for your use case. To find out the appropriate version, go to the API Docs drop down on the menu.
Listed from APIs.guru (CC0).