eBay

Feed API

The Feed API lets sellers upload input files, download reports and files including their status, filter reports using URI parameters, and retrieve customer…

E-commerce#openapi#ecommerce

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

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.

Endpoints 23

customer_service_metric_task

  • GETgetCustomerServiceMetricTasks/customer_service_metric_task?date_range=string&feed_type=string&limit=string&look_back_days=string&offset=stringUse 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…
  • POSTcreateCustomerServiceMetricTask/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,…
  • GETgetCustomerServiceMetricTask/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>

inventory_task

  • GETgetInventoryTasks/inventory_task?feed_type=string&schedule_id=string&look_back_days=string&date_range=string&limit=string&offset=stringThis method searches for multiple tasks of a specific feed type, and includes date filters and pagination.
  • POSTcreateInventoryTask/inventory_taskThis method creates an inventory-related download task for a specified feed type with optional filter criteria. When using this method, specify the…
  • GETgetInventoryTask/inventory_task/:task_idThis method retrieves the task details and status of the specified inventory-related task. The input is <strong>task_id</strong>.

order_task

  • GETgetOrderTasks/order_task?date_range=string&feed_type=string&limit=string&look_back_days=string&offset=string&schedule_id=stringThis 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>.…
  • POSTcreateOrderTask/order_taskThis method creates an order download task with filter criteria for the order report. When using this method, specify the <b> feedType</b>, <b>…
  • GETgetOrderTask/order_task/:task_idThis 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,…

schedule

  • GETgetSchedules/schedule?feed_type=string&limit=string&offset=stringThis 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…
  • POSTcreateSchedule/scheduleThis method creates a schedule, which is a subscription to the specified schedule template. A schedule periodically generates a report for the…
  • GETgetSchedule/schedule/:schedule_idThis method retrieves schedule details and status of the specified schedule. Specify the schedule to retrieve using the <strong>schedule_id</strong>. Use the…
  • PUTupdateSchedule/schedule/:schedule_idThis method updates an existing schedule. Specify the schedule to update using the <strong>schedule_id</strong> path parameter. If the schedule template has…
  • DELETEdeleteSchedule/schedule/:schedule_idThis method deletes an existing schedule. Specify the schedule to delete using the <strong>schedule_id</strong> path parameter.
  • GETgetLatestResultFile/schedule/:schedule_id/download_result_fileThis 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…
  • GETgetScheduleTemplates/schedule_template?feed_type=string&limit=string&offset=stringThis method retrieves an array containing the details and status of all schedule templates based on the specified <strong>feed_type</strong>. Use this method…
  • GETgetScheduleTemplate/schedule_template/:schedule_template_idThis method retrieves the details of the specified template. Specify the template to retrieve using the <strong>schedule_template_id</strong> path parameter.…

task

  • GETgetTasks/task?date_range=string&feed_type=string&limit=string&look_back_days=string&offset=string&schedule_id=stringThis method returns the details and status for an array of tasks based on a specified <strong>feed_type</strong> or <strong>scheduledId</strong>. Specifying…
  • POSTcreateTask/taskThis 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>…
  • GETgetTask/task/:task_idThis 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,…
  • GETgetInputFile/task/:task_id/download_input_fileThis method downloads the file previously uploaded using <strong>uploadFile</strong>. Specify the task_id from the <strong>uploadFile</strong> call. <p><span…
  • GETgetResultFile/task/:task_id/download_result_fileThis 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…
  • POSTuploadFile/task/:task_id/upload_fileThis 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…

API details

Base URL
https://api.ebay.com{basePath}
Authentication
OAuth 2.0 (authorization code flow) with 5 scopes
Operations
23 operations on 16 pathsGET 15POST 6PUT 1DELETE 1
Main resources
schedule 8task 6customer_service_metric_task 3inventory_task 3order_task 3
Response formats
application/json application/octet-stream
Description format
OpenAPI 3.0.0, API version v1.3.1
Listed from
APIs.guru OpenAPI Directory (CC0-1.0)
Source updated

How to test the Feed API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Feed API collection, without the publisher's secrets.
  3. Add your credentialsThis API uses OAuth 2.0 (authorization code flow) with 5 scopes. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “getCustomerServiceMetricTasks” (GET /customer_service_metric_task?date_range=string&feed_type=string&limit=string&look_back_days=string&offset=string), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Feed API?

The Feed API lets sellers upload input files, download reports and files including their status, filter reports using URI parameters, and retrieve customer… It is listed under E-commerce and has 23 endpoints.

Who publishes the Feed API?

It is listed from eBay's public API description (an OpenAPI document), not published by eBay on Swastik Codes. Anyone who controls ebay.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Feed API?

Requests go to https://api.ebay.com{basePath}. Endpoint paths are added to this base URL.

How do I authenticate with the Feed API?

With OAuth 2.0 (authorization code flow) with 5 scopes.

How many endpoints does the Feed API have?

23 operations on 16 paths (15 GET, 6 POST, 1 PUT, 1 DELETE). The largest groups are schedule, task, customer_service_metric_task, inventory_task.

Is forking the Feed API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.