API docs by Redocly

Feed API (v1.3.1)

Download OpenAPI specification:Download

License: eBay API License Agreement

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

getOrderTasks

This method returns the details and status for an array of order tasks based on a specified feed_type or schedule_id. Specifying both feed_type and schedule_id results in an error. Since schedules are based on feed types, you can specify a schedule (schedule_id) that returns the needed feed_type.

If specifying the feed_type, limit which order tasks are returned by specifying filters such as the creation date range or period of time using look_back_days.

If specifying a schedule_id, the schedule template (that the schedule_id is based on) determines which order tasks are returned (see schedule_id for additional information). Each schedule_id applies to one feed_type.

Authorizations:
Authorization_Code
query Parameters
date_range
string

The order tasks creation date range. This range is used to filter the results. The filtered results are filtered to include only tasks with a creation date that is equal to this date or is within specified range. Only orders less than 90 days old can be retrieved. Do not use with the look_back_days parameter.

Format: UTC

For example:

Tasks within a range
yyyy-MM-ddThh:mm:ss.SSSZ..yyyy-MM-ddThh:mm:ss.SSSZ

Tasks created on September 8, 2019
2019-09-08T00:00:00.000Z..2019-09-09T00:00:00.000Z

feed_type
string

The feed type associated with the task. The only presently supported value is LMS_ORDER_REPORT. Do not use with the schedule_id parameter. Since schedules are based on feed types, you can specify a schedule (schedule_id) that returns the needed feed_type.

limit
integer

The maximum number of order tasks that can be returned on each page of the paginated response. Use this parameter in conjunction with the offset parameter to control the pagination of the output.

Note: This feature employs a zero-based list, where the first item in the list has an offset of 0.

For example, if offset is set to 10 and limit is set to 10, the call retrieves order tasks 11 thru 20 from the result set.

If this parameter is omitted, the default value is used.

Default: 10

Maximum: 500

look_back_days
integer

The number of previous days in which to search for tasks. Do not use with the date_range parameter. If both date_range and look_back_days are omitted, this parameter's default value is used.

Default: 7

Range: 1-90 (inclusive)

offset
integer

The number of order tasks to skip in the result set before returning the first order in the paginated response.

Combine offset with the limit query parameter to control the items returned in the response. For example, if you supply an offset of 0 and a limit of 10, the first page of the response contains the first 10 items from the complete list of items retrieved by the call. If offset is 10 and limit is 20, the first page of the response contains items 11-30 from the complete result set. If this query parameter is not set, the default value is used and the first page of records is returned.

Default: 0

schedule_id
string

The schedule ID associated with the order task. A schedule periodically generates a report for the feed type specified by the schedule template (see scheduleTemplateId in createSchedule). Do not use with the feed_type parameter. Since schedules are based on feed types, you can specify a schedule (schedule_id) that returns the needed feed_type.

Responses

Response samples

Content type
application/json
{
  • "href": "string",
  • "limit": 0,
  • "next": "string",
  • "offset": 0,
  • "prev": "string",
  • "tasks": [
    ],
  • "total": 0
}

createOrderTask

This method creates an order download task with filter criteria for the order report. When using this method, specify the feedType, schemaVersion, and filterCriteria for the report. The method returns the location response header containing the getOrderTask call URI to retrieve the order task you just created. The URL includes the eBay-assigned task ID, which you can use to reference the order task.

To retrieve the status of the task, use the getOrderTask method to retrieve a single task ID or the getOrderTasks method to retrieve multiple order task IDs.

Note: The scope depends on the feed type. An error message results when an unsupported scope or feed type is specified.

The following list contains this method's authorization scope and its corresponding feed type:

For details about how this method is used, see General feed types in the Selling Integration Guide.

Note: At this time, the createOrderTask method only supports order creation date filters and not modified order date filters. Do not include the modifiedDateRange filter in your request payload.

Authorizations:
Authorization_Code
header Parameters
X-EBAY-C-MARKETPLACE-ID
string

The ID of the eBay marketplace where the item is hosted.

Note: This value is case sensitive.

For example:

X-EBAY-C-MARKETPLACE-ID:EBAY_US

This identifies the eBay marketplace that applies to this task. See MarketplaceIdEnum.

Request Body schema: application/json

description not needed

feedType
string

The feed type associated with the task. The only presently supported value is LMS_ORDER_REPORT. See Report download feed types for more information.

object (OrderFilterCriteria)

The type that defines the fields for the order filters.

schemaVersion
string

The schema version of the LMS OrderReport. For the LMS_ORDER_REPORT feed type, see the OrderReport reference page to see the present schema version. The schemaVersion value is the version number shown at the top of the OrderReport page.

Restriction: This value must be 1113 or higher. The OrderReport schema version is updated about every two weeks. All version numbers are odd numbers (even numbers are skipped). For example, the next release version after '1113' is '1115'.

Responses

Request samples

Content type
application/json
{
  • "feedType": "string",
  • "filterCriteria": {
    },
  • "schemaVersion": "string"
}

getOrderTask

This method retrieves the task details and status of the specified task. The input is task_id.

For details about how this method is used, see Working with Order Feeds in the Selling Integration Guide.

Authorizations:
Authorization_Code
path Parameters
task_id
required
string

The ID of the task. This ID is generated when the task was created by the createOrderTask method.

Responses

Response samples

Content type
application/json
{
  • "completionDate": "string",
  • "creationDate": "string",
  • "detailHref": "string",
  • "feedType": "string",
  • "filterCriteria": {
    },
  • "schemaVersion": "string",
  • "status": "string",
  • "taskId": "string",
  • "uploadSummary": {
    }
}

inventory_task

getInventoryTasks

This method searches for multiple tasks of a specific feed type, and includes date filters and pagination.

Authorizations:
Authorization_Code
query Parameters
feed_type
string

The feed type associated with the inventory task. Either feed_type or schedule_id is required. Do not use with the schedule_id parameter. Presently, only one feed type is available:

  • LMS_ACTIVE_INVENTORY_REPORT

schedule_id
string

The ID of the schedule for which to retrieve the latest result file. This ID is generated when the schedule was created by the createSchedule method. Schedules apply to downloaded reports (LMS_ACTIVE_INVENTORY_REPORT). Either schedule_id or feed_type is required. Do not use with the feed_type parameter.

look_back_days
integer

The number of previous days in which to search for tasks. Do not use with the date_range parameter. If both date_range and look_back_days are omitted, this parameter's default value is used.

Default: 7

Range: 1-90 (inclusive)

date_range
string

Specifies the range of task creation dates used to filter the results. The results are filtered to include only tasks with a creation date that is equal to this date or is within specified range.

Note: Maximum date range window size is 90 days.


Valid Format (UTC): yyyy-MM-ddThh:mm:ss.SSSZ..yyyy-MM-ddThh:mm:ss.SSSZ

For example: Tasks created on March 31, 2021
2021-03-31T00:00:00.000Z..2021-03-31T00:00:00.000Z

limit
integer

The maximum number of tasks that can be returned on each page of the paginated response. Use this parameter in conjunction with the offset parameter to control the pagination of the output.

Note: This feature employs a zero-based list, where the first item in the list has an offset of 0.

For example, if offset is set to 10 and limit is set to 10, the call retrieves tasks 11 thru 20 from the result set.

If this parameter is omitted, the default value is used.

Default: 10

Maximum: 500

offset
integer

The number of tasks to skip in the result set before returning the first task in the paginated response.

Combine offset with the limit query parameter to control the items returned in the response. For example, if you supply an offset of 0 and a limit of 10, the first page of the response contains the first 10 items from the complete list of items retrieved by the call. If offset is 10 and limit is 20, the first page of the response contains items 11-30 from the complete result set. If this query parameter is not set, the default value is used and the first page of records is returned.

Default: 0

Responses

Response samples

Content type
application/json
{
  • "href": "string",
  • "limit": 0,
  • "next": "string",
  • "offset": 0,
  • "prev": "string",
  • "tasks": [
    ],
  • "total": 0
}

createInventoryTask

This method creates an inventory-related download task for a specified feed type with optional filter criteria. When using this method, specify the feedType.

This method returns the location response header containing the getInventoryTask call URI to retrieve the inventory task you just created. The URL includes the eBay-assigned task ID, which you can use to reference the inventory task.

To retrieve the status of the task, use the getInventoryTask method to retrieve a single task ID or the getInventoryTasks method to retrieve multiple task IDs.

Note: The scope depends on the feed type. An error message results when an unsupported scope or feed type is specified.

Presently, this method supports Active Inventory Report. The ActiveInventoryReport returns a report that contains price and quantity information for all of the active listings for a specific seller. A seller can use this information to maintain their inventory on eBay.

Authorizations:
Authorization_Code
header Parameters
X-EBAY-C-MARKETPLACE-ID
string

The ID of the eBay marketplace where the item is hosted.

Note: This value is case sensitive.

For example:

X-EBAY-C-MARKETPLACE-ID:EBAY_US

This identifies the eBay marketplace that applies to this task. See MarketplaceIdEnum.

Request Body schema: application/json

The request payload containing the version, feedType, and optional filterCriteria.

schemaVersion
string

The schemaVersion/version number of the file format (use the schema version of the API to which you are programming):

feedType
string

The feed type associated with the inventory task you are about to create. Use a feedType that is available for your API. Presently, only one feed type is available:

  • LMS_ACTIVE_INVENTORY_REPORT

See Report download feed types for more information.

object (InventoryFilterCriteria)

The container for the filter fields. This container is used to set the filter criteria for the order report. A seller can retrieve listings for a specified format.

Responses

Request samples

Content type
application/json
{
  • "schemaVersion": "string",
  • "feedType": "string",
  • "filterCriteria": {
    }
}

getInventoryTask

This method retrieves the task details and status of the specified inventory-related task. The input is task_id.

Authorizations:
Authorization_Code
path Parameters
task_id
required
string

The ID of the task. This ID was generated when the task was created by the createInventoryTask method

Responses

Response samples

Content type
application/json
{
  • "taskId": "string",
  • "status": "string",
  • "feedType": "string",
  • "creationDate": "string",
  • "completionDate": "string",
  • "schemaVersion": "string",
  • "detailHref": "string",
  • "uploadSummary": {
    },
  • "filterCriteria": {
    }
}

schedule

getSchedules

This method retrieves an array containing the details and status of all schedules based on the specified feed_type. Use this method to find a schedule if you do not know the schedule_id.

Authorizations:
Authorization_Code
query Parameters
feed_type
required
string

The feedType associated with the schedule.

limit
integer

The maximum number of schedules that can be returned on each page of the paginated response. Use this parameter in conjunction with the offset parameter to control the pagination of the output.

Note: This feature employs a zero-based list, where the first item in the list has an offset of 0.

For example, if offset is set to 10 and limit is set to 10, the call retrieves schedules 11 thru 20 from the result set.

If this parameter is omitted, the default value is used.

Default: 10

Maximum: 500

offset
integer

The number of schedules to skip in the result set before returning the first schedule in the paginated response.

Combine offset with the limit query parameter to control the items returned in the response. For example, if you supply an offset of 0 and a limit of 10, the first page of the response contains the first 10 items from the complete list of items retrieved by the call. If offset is 10 and limit is 20, the first page of the response contains items 11-30 from the complete result set. If this query parameter is not set, the default value is used and the first page of records is returned.

Default: 0

Responses

Response samples

Content type
application/json
{
  • "href": "string",
  • "limit": 0,
  • "next": "string",
  • "offset": 0,
  • "prev": "string",
  • "schedules": [
    ],
  • "total": 0
}

createSchedule

This method creates a schedule, which is a subscription to the specified schedule template. A schedule periodically generates a report for the feedType specified by the template. Specify the same feedType as the feedType of the associated schedule template. When creating the schedule, if available from the template, you can specify a preferred trigger hour, day of the week, or day of the month. These and other fields are conditionally available as specified by the template.

Note: Make sure to include all fields required by the schedule template (scheduleTemplateId). Call the getScheduleTemplate method (or the getScheduleTemplates method), to find out which fields are required or optional. If a field is optional and a default value is provided by the template, the default value will be used if omitted from the payload.

A successful call returns the location response header containing the getSchedule call URI to retrieve the schedule you just created. The URL includes the eBay-assigned schedule ID, which you can use to reference the schedule task.

To retrieve the details of the create schedule task, use the getSchedule method for a single schedule ID or the getSchedules method to retrieve all schedule details for the specified feed_type. The number of schedules for each feedType is limited. Error code 160031 is returned when you have reached this maximum.

Note: Except for schedules with a HALF-HOUR frequency, all schedules will ideally run at the start of each hour ('00' minutes). Actual start time may vary time may vary due to load and other factors.

Authorizations:
Authorization_Code
Request Body schema: application/json

In the request payload: feedType and scheduleTemplateId are required; scheduleName is optional; preferredTriggerHour, preferredTriggerDayOfWeek, preferredTriggerDayOfMonth, scheduleStartDate, scheduleEndDate, and schemaVersion are conditional.

feedType
string

The name of the feed type for the created schedule. Match the feed_type from the schedule template associated with this schedule.

preferredTriggerDayOfMonth
integer

The preferred day of the month to trigger the schedule. This field can be used with preferredTriggerHour for monthly schedules. The last day of the month is used for numbers larger than the actual number of days in the month.

This field is available as specified by the template (scheduleTemplateId). The template can specify this field as optional or required, and optionally provides a default value.

Minimum: 1

Maximum: 31

preferredTriggerDayOfWeek
string

The preferred day of the week to trigger the schedule. This field can be used with preferredTriggerHour for weekly schedules.

This field is available as specified by the template (scheduleTemplateId). The template can specify this field as optional or required, and optionally provides a default value. For implementation help, refer to eBay API documentation

preferredTriggerHour
string

The preferred two-digit hour of the day to trigger the schedule.

This field is available as specified by the template (scheduleTemplateId). The template can specify this field as optional or required, and optionally provides a default value.

Format: UTC hhZ

For example, the following represents 11:00 am UTC: 11Z

scheduleEndDate
string

The timestamp on which the report generation (subscription) ends. After this date, the schedule status becomes INACTIVE.

Use this field, if available, to end the schedule in the future. This value must be later than scheduleStartDate (if supplied). This field is available as specified by the template (scheduleTemplateId). The template can specify this field as optional or required, and optionally provides a default value.

Format: UTC yyyy-MM-ddTHHZ

For example, the following represents UTC October 10, 2021 at 10:00 AM:
2021-10-10T10Z

scheduleName
string

The schedule name assigned by the user for the created schedule.

scheduleStartDate
string

The timestamp to start generating the report. After this timestamp, the schedule status becomes active until either the scheduleEndDate occurs or the scheduleTemplateId becomes inactive.

Use this field, if available, to start the schedule in the future but before the scheduleEndDate (if supplied). This field is available as specified by the template (scheduleTemplateId). The template can specify this field as optional or required, and optionally provides a default value.

Format: UTC yyyy-MM-ddTHHZ

For example, the following represents a schedule start date of UTC October 01, 2020 at 12:00 PM:
2020-01-01T12Z

scheduleTemplateId
string

The ID of the template associated with the schedule ID. You can get this ID from the documentation or by calling the getScheduleTemplates method. This method requires a schedule template ID that is ACTIVE.

schemaVersion
string

The schema version of the schedule feedType. This field is required if the feedType has a schema version.

This field is available as specified by the template (scheduleTemplateId). The template can specify this field as optional or required, and optionally provides a default value.

Responses

Request samples

Content type
application/json
{
  • "feedType": "string",
  • "preferredTriggerDayOfMonth": 0,
  • "preferredTriggerDayOfWeek": "string",
  • "preferredTriggerHour": "string",
  • "scheduleEndDate": "string",
  • "scheduleName": "string",
  • "scheduleStartDate": "string",
  • "scheduleTemplateId": "string",
  • "schemaVersion": "string"
}

getSchedule

This method retrieves schedule details and status of the specified schedule. Specify the schedule to retrieve using the schedule_id. Use the getSchedules method to find a schedule if you do not know the schedule_id.

Authorizations:
Authorization_Code
path Parameters
schedule_id
required
string

The ID of the schedule for which to retrieve the details. This ID is generated when the schedule was created by the createSchedule method.

Responses

Response samples

Content type
application/json
{
  • "scheduleId": "string",
  • "creationDate": "string",
  • "feedType": "string",
  • "lastModifiedDate": "string",
  • "preferredTriggerDayOfMonth": 0,
  • "preferredTriggerDayOfWeek": "string",
  • "preferredTriggerHour": "string",
  • "scheduleEndDate": "string",
  • "scheduleName": "string",
  • "scheduleStartDate": "string",
  • "scheduleTemplateId": "string",
  • "schemaVersion": "string",
  • "status": "string",
  • "statusReason": "string"
}

updateSchedule

This method updates an existing schedule. Specify the schedule to update using the schedule_id path parameter. If the schedule template has changed after the schedule was created or updated, the input will be validated using the changed template.

Note: Make sure to include all fields required by the schedule template (scheduleTemplateId). Call the getScheduleTemplate method (or the getScheduleTemplates method), to find out which fields are required or optional. If you do not know the scheduleTemplateId, call the getSchedule method to find out.

Authorizations:
Authorization_Code
path Parameters
schedule_id
required
string

The ID of the schedule to update. This ID is generated when the schedule was created by the createSchedule method.

Request Body schema: application/json

In the request payload: scheduleName is optional; preferredTriggerHour, preferredTriggerDayOfWeek, preferredTriggerDayOfMonth, scheduleStartDate, scheduleEndDate, and schemaVersion are conditional.

preferredTriggerDayOfMonth
integer

The preferred day of the month to trigger the schedule. This field can be used with preferredTriggerHour for monthly schedules. The last day of the month is used for numbers larger than the actual number of days in the month.

This field is available as specified by the template (scheduleTemplateId). The template can specify this field as optional or required, and optionally provides a default value.

Minimum: 1

Maximum: 31

preferredTriggerDayOfWeek
string

The preferred day of the week to trigger the schedule. This field can be used with preferredTriggerHour for weekly schedules.

This field is available as specified by the template (scheduleTemplateId). The template can specify this field as optional or required, and optionally provides a default value. For implementation help, refer to eBay API documentation

preferredTriggerHour
string

The preferred two-digit hour of the day to trigger the schedule.

This field is available as specified by the template (scheduleTemplateId). The template can specify this field as optional or required, and optionally provides a default value.

Format: UTC hhZ

For example, the following represents 11:00 am UTC: 11Z

Minimum: 00Z

Maximum: 23Z

scheduleEndDate
string

The timestamp on which the schedule (report generation) ends. After this date, the schedule status becomes INACTIVE.

Use this field, if available, to end the schedule in the future. This value must be later than scheduleStartDate (if supplied). This field is available as specified by the template (scheduleTemplateId). The template can specify this field as optional or required, and optionally provides a default value.

Format: UTC yyyy-MM-ddTHHZ

For example, the following represents UTC October 10, 2021 at 10:00 AM:
2021-10-10T10Z

scheduleName
string

The schedule name assigned by the user for the created schedule.

scheduleStartDate
string

The timestamp to start generating the report. After this timestamp, the schedule status becomes active until either the scheduleEndDate occurs or the scheduleTemplateId becomes inactive.

Use this field, if available, to start the schedule in the future but before the scheduleEndDate (if supplied). This field is available as specified by the template (scheduleTemplateId). The template can specify this field as optional or required, and optionally provides a default value.

Format: UTC yyyy-MM-ddTHHZ

For example, the following represents a schedule start date of UTC October 01, 2020 at 12:00 PM:
2020-01-01T12Z

schemaVersion
string

The schema version of the feedType for the schedule. This field is required if the feedType has a schema version.

This field is available as specified by the template (scheduleTemplateId). The template can specify this field as optional or required, and optionally provides a default value.

Responses

Request samples

Content type
application/json
{
  • "preferredTriggerDayOfMonth": 0,
  • "preferredTriggerDayOfWeek": "string",
  • "preferredTriggerHour": "string",
  • "scheduleEndDate": "string",
  • "scheduleName": "string",
  • "scheduleStartDate": "string",
  • "schemaVersion": "string"
}

deleteSchedule

This method deletes an existing schedule. Specify the schedule to delete using the schedule_id path parameter.

Authorizations:
Authorization_Code
path Parameters
schedule_id
required
string

The schedule_id of the schedule to delete. This ID was generated when the task was created. If you do not know the schedule_id, use the getSchedules method to return all schedules based on a specified feed_type and find the schedule_id of the schedule to delete.

Responses

getLatestResultFile

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 the applicable file extension (for example: csv.gz). Specify the schedule_id path parameter to download its last generated file.

Authorizations:
Authorization_Code
path Parameters
schedule_id
required
string

The ID of the schedule for which to retrieve the latest result file. This ID is generated when the schedule was created by the createSchedule method.

Responses

getScheduleTemplate

This method retrieves the details of the specified template. Specify the template to retrieve using the schedule_template_id path parameter. Use the getScheduleTemplates method to find a schedule template if you do not know the schedule_template_id.

Authorizations:
Authorization_Code
path Parameters
schedule_template_id
required
string

The ID of the template to retrieve. If you do not know the schedule_template_id, refer to the documentation or use the getScheduleTemplates method to find the available schedule templates.

Responses

Response samples

Content type
application/json
{
  • "feedType": "string",
  • "frequency": "string",
  • "name": "string",
  • "scheduleTemplateId": "string",
  • "status": "string",
  • "supportedConfigurations": [
    ]
}

getScheduleTemplates

This method retrieves an array containing the details and status of all schedule templates based on the specified feed_type. Use this method to find a schedule template if you do not know the schedule_template_id.

Authorizations:
Authorization_Code
query Parameters
feed_type
required
string

The feed type of the schedule templates to retrieve.

limit
integer

The maximum number of schedule templates that can be returned on each page of the paginated response. Use this parameter in conjunction with the offset parameter to control the pagination of the output.

Note: This feature employs a zero-based list, where the first item in the list has an offset of 0.

For example, if offset is set to 10 and limit is set to 10, the call retrieves schedule templates 11 thru 20 from the result set.

If this parameter is omitted, the default value is used.

Default: 10

Maximum: 500

offset
integer

The number of schedule templates to skip in the result set before returning the first template in the paginated response.

Combine offset with the limit query parameter to control the items returned in the response. For example, if you supply an offset of 0 and a limit of 10, the first page of the response contains the first 10 items from the complete list of items retrieved by the call. If offset is 10 and limit is 20, the first page of the response contains items 11-30 from the complete result set. If this query parameter is not set, the default value is used and the first page of records is returned.

Default: 0

Responses

Response samples

Content type
application/json
{
  • "href": "string",
  • "limit": 0,
  • "next": "string",
  • "offset": 0,
  • "prev": "string",
  • "scheduleTemplates": [
    ],
  • "total": 0
}

task

getTasks

This method returns the details and status for an array of tasks based on a specified feed_type or scheduledId. Specifying both feed_type and scheduledId results in an error. Since schedules are based on feed types, you can specify a schedule (schedule_id) that returns the needed feed_type.

If specifying the feed_type, limit which tasks are returned by specifying filters, such as the creation date range or period of time using look_back_days. Also, by specifying the feed_type, both on-demand and scheduled reports are returned.

If specifying a scheduledId, the schedule template (that the schedule ID is based on) determines which tasks are returned (see schedule_id for additional information). Each scheduledId applies to one feed_type.

Authorizations:
Authorization_Code
query Parameters
date_range
string

Specifies the range of task creation dates used to filter the results. The results are filtered to include only tasks with a creation date that is equal to this date or is within specified range. Only tasks that are less than 90 days can be retrieved.

Note: Maximum date range window size is 90 days.


Valid Format (UTC):yyyy-MM-ddThh:mm:ss.SSSZ..yyyy-MM-ddThh:mm:ss.SSSZ

For example: Tasks created on September 8, 2019
2019-09-08T00:00:00.000Z..2019-09-09T00:00:00.000Z

feed_type
string

The feed type associated with the tasks to be returned. Only use a feedType that is available for your API:

  • Order Feeds: LMS_ORDER_ACK, LMS_ORDER_REPORT
  • Large Merchant Services (LMS) Feeds: See Available FeedTypes

Do not use with the schedule_id parameter. Since schedules are based on feed types, you can specify a schedule (schedule_id) that returns the needed feed_type.

limit
integer

The maximum number of tasks that can be returned on each page of the paginated response. Use this parameter in conjunction with the offset parameter to control the pagination of the output.

Note: This feature employs a zero-based list, where the first item in the list has an offset of 0.

For example, if offset is set to 10 and limit is set to 10, the call retrieves tasks 11 thru 20 from the result set.

If this parameter is omitted, the default value is used.

Default: 10

Maximum: 500

look_back_days
integer

The number of previous days in which to search for tasks. Do not use with the date_range parameter. If both date_range and look_back_days are omitted, this parameter's default value is used.

Default: 7

Range: 1-90 (inclusive)

offset
integer

The number of tasks to skip in the result set before returning the first task in the paginated response.

Combine offset with the limit query parameter to control the items returned in the response. For example, if you supply an offset of 0 and a limit of 10, the first page of the response contains the first 10 items from the complete list of items retrieved by the call. If offset is 10 and limit is 20, the first page of the response contains items 11-30 from the complete result set. If this query parameter is not set, the default value is used and the first page of records is returned.

Default: 0

schedule_id
string

The schedule ID associated with the task. A schedule periodically generates a report for the feed type specified by the schedule template (see scheduleTemplateId in createSchedule). Do not use with the feed_type parameter. Since schedules are based on feed types, you can specify a schedule (schedule_id) that returns the needed feed_type.

Responses

Response samples

Content type
application/json
{
  • "href": "string",
  • "limit": 0,
  • "next": "string",
  • "offset": 0,
  • "prev": "string",
  • "tasks": [
    ],
  • "total": 0
}

createTask

This method creates an upload task or a download task without filter criteria. When using this method, specify the feedType and the feed file schemaVersion. The feed type specified sets the task as a download or an upload task.

For details about the upload and download flows, see Working with Order Feeds in the Selling Integration Guide.

Note: The scope depends on the feed type. An error message results when an unsupported scope or feed type is specified.

The following list contains this method's authorization scopes and their corresponding feed types:

* Reserved for future release

Authorizations:
Authorization_Code
header Parameters
X-EBAY-C-MARKETPLACE-ID
string

The ID of the eBay marketplace where the item is hosted.

Note: This value is case sensitive.

For example:

X-EBAY-C-MARKETPLACE-ID:EBAY_US

This identifies the eBay marketplace that applies to this task. See MarketplaceIdEnum.

Request Body schema: application/json

description not needed

feedType
string

The feed type associated with the task. Only use a feedType that is available for your API. Available feed types:

schemaVersion
string

The schemaVersion/version number of the file format (use the schema version of the API to which you are programming):

Responses

Request samples

Content type
application/json
{
  • "feedType": "string",
  • "schemaVersion": "string"
}

getInputFile

This method downloads the file previously uploaded using uploadFile. Specify the task_id from the uploadFile call.

Note: With respect to LMS, this method applies to all feed types except LMS_ORDER_REPORT and LMS_ACTIVE_INVENTORY_REPORT. See LMS API Feeds in the Selling Integration Guide.

Authorizations:
Authorization_Code
path Parameters
task_id
required
string

The task ID associated with the file to be downloaded.

Responses

getResultFile

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 JSON file, with the applicable file extension (for example: csv.gz).

For details about how this method is used, see Working with Order Feeds in the Selling Integration Guide.

Note: The status of the task to retrieve must be in the COMPLETED or COMPLETED_WITH_ERROR state before this method can retrieve the file. You can use the getTask or getTasks method to retrieve the status of the task.

Authorizations:
Authorization_Code
path Parameters
task_id
required
string

The ID of the task associated with the file you want to download. This ID was generated when the task was created.

Responses

getTask

This method retrieves the details and status of the specified task. The input is task_id.

For details of how this method is used, see Working with Order Feeds in the Selling Integration Guide.

Authorizations:
Authorization_Code
path Parameters
task_id
required
string

The ID of the task. This ID was generated when the task was created.

Responses

Response samples

Content type
application/json
{
  • "completionDate": "string",
  • "creationDate": "string",
  • "detailHref": "string",
  • "feedType": "string",
  • "schemaVersion": "string",
  • "status": "string",
  • "taskId": "string",
  • "uploadSummary": {
    }
}

uploadFile

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 begins.

Reports often take time to generate and it's common for this method to return an HTTP status of 202, which indicates the report is being generated. Use the getTask with the task ID or getTasks to determine the status of a report.

The status flow is QUEUED > IN_PROCESS > COMPLETED or COMPLETED_WITH_ERROR. When the status is COMPLETED or COMPLETED_WITH_ERROR, this indicates the file has been processed and the order report can be downloaded. If there are errors, they will be indicated in the report file.

For details of how this method is used in the upload flow, see Working with Order Feeds in the Selling Integration Guide.

Note: This method applies to all Seller Hub feed types and LMS feed types except LMS_ORDER_REPORT and LMS_ACTIVE_INVENTORY_REPORT. See LMS feed types and Seller Hub feed types.

Note: You must use a Content-Type header with its value set to "multipart/form-data". See Samples for information.

Authorizations:
Authorization_Code
path Parameters
task_id
required
string

The task_id associated with the file that will be uploaded. This ID was generated when the specified task was created.

Request Body schema: multipart/form-data
creationDate
string

The file creation date.

Format: UTC yyyy-MM-ddThh:mm:ss.SSSZ

For example:

Created on September 8, 2019

2019-09-08T00:00:00.000Z

fileName
string

The name of the file including its extension (for example, xml or csv) to be uploaded.

modificationDate
string

The file modified date.

Format: UTC yyyy-MM-ddThh:mm:ss.SSSZ

For example:

Created on September 9, 2019

2019-09-09T00:00:00.000Z

name
string

A content identifier. The only presently supported name is file.

object

The parameters you want associated with the file.

readDate
string

The date you read the file.

Format: UTC yyyy-MM-ddThh:mm:ss.SSSZ

For example:

Created on September 10, 2019

2019-09-10T00:00:00.000Z

size
integer

The size of the file.

type
string

The file type. The only presently supported type is form-data.

Responses

Response samples

Content type
application/json
{ }

customer_service_metric_task

getCustomerServiceMetricTasks

Use this method to return an array of customer service metric tasks. You can limit the tasks returned by specifying a date range.

Note: You can pass in either the look_back_days or date_range, but not both.

Authorizations:
Authorization_Code
query Parameters
date_range
string

The task creation date range. The results are filtered to include only tasks with a creation date that is equal to the dates specified or is within the specified range. Do not use with the look_back_days parameter.

Format: UTC

For example, tasks within a range:

yyyy-MM-ddThh:mm:ss.SSSZ..yyyy-MM-ddThh:mm:ss.SSSZ

Tasks created on March 8, 2020

2020-03-08T00:00.00.000Z..2020-03-09T00:00:00.000Z

Maximum: 90 days

feed_type
string

The feed type associated with the task. The only presently supported value is CUSTOMER_SERVICE_METRICS_REPORT.

limit
integer

The number of customer service metric tasks to return per page of the result set. Use this parameter in conjunction with the offset parameter to control the pagination of the output.

For example, if offset is set to 10 and limit is set to 10, the call retrieves tasks 11 thru 20 from the result set.

If this parameter is omitted, the default value is used.

Note:This feature employs a zero-based list, where the first item in the list has an offset of 0.

Default: 10

Maximum: 500

look_back_days
integer

The number of previous days in which to search for tasks. Do not use with the date_range parameter. If both date_range and look_back_days are omitted, this parameter's default value is used.

Default value: 7

Range: 1-90 (inclusive)

offset
integer

The number of customer service metric tasks to skip in the result set before returning the first task in the paginated response.

Combine offset with the limit query parameter to control the items returned in the response. For example, if you supply an offset of 0 and a limit of 10, the first page of the response contains the first 10 items from the complete list of items retrieved by the call. If offset is 10 and limit is 20, the first page of the response contains items 11-30 from the complete result set.

Default: 0

Responses

Response samples

Content type
application/json
{
  • "href": "string",
  • "limit": 0,
  • "next": "string",
  • "offset": 0,
  • "prev": "string",
  • "tasks": [
    ],
  • "total": 0
}

createCustomerServiceMetricTask

Use this method to create a customer service metrics download task with filter criteria for the customer service metrics report. When using this method, specify the feedType and filterCriteria including both evaluationMarketplaceId and customerServiceMetricType for the report. The method returns the location response header containing the call URI to use with getCustomerServiceMetricTask to retrieve status and details on the task.

Only CURRENT Customer Service Metrics reports can be generated with the Sell Feed API. PROJECTED reports are not supported at this time. See the getCustomerServiceMetric method document in the Analytics API for more information about these two types of reports.

Note: Before calling this API, retrieve the summary of the seller's performance and rating for the customer service metric by calling getCustomerServiceMetric (part of the Analytics API). You can then populate the create task request fields with the values from the response. This technique eliminates failed tasks that request a report for a customerServiceMetricType and evaluationMarketplaceId that are without evaluation.

Authorizations:
Authorization_Code
header Parameters
accept-language
required
string

Use this header to specify the natural language in which the authenticated user desires the response.

Request Body schema: application/json

Request payload containing version, feedType, and optional filterCriteria.

feedType
string

The feedType specified for the task. The report lists the transaction details that contribute to the service metrics evaluation. Supported types include:

CUSTOMER_SERVICE_METRICS_REPORT

object (CustomerServiceMetricsFilterCriteria)

A complex data type that filters data for report creation. See CustomerServiceMetricsFilterCriteria for fields and descriptions.

schemaVersion
string

The version number of the file format.

Valid value: 1.0

Responses

Request samples

Content type
application/json
{
  • "feedType": "string",
  • "filterCriteria": {
    },
  • "schemaVersion": "string"
}

getCustomerServiceMetricTask

Use this method to retrieve customer service metric task details for the specified task. The input is task_id.

Authorizations:
Authorization_Code
path Parameters
task_id
required
string

Use this path parameter to specify the task ID value for the customer service metric task to retrieve.

Responses

Response samples

Content type
application/json
{
  • "completionDate": "string",
  • "creationDate": "string",
  • "detailHref": "string",
  • "feedType": "string",
  • "filterCriteria": {
    },
  • "schemaVersion": "string",
  • "status": "string",
  • "taskId": "string"
}