GET/schedule
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.
Input
Resource URI
This method is supported in Sandbox environment. To access the endpoint, just replace the api.ebay.com root URI with api.sandbox.ebay.com
URI parameters
| Parameter | Type | Description |
|---|---|---|
| feed_type | string | The feed type associated with the schedules being retrieved. Note: Schedules are currently only available for LMS_ORDER_REPORT. Occurrence: Required |
| 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 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. Occurrence: Optional |
| 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 Occurrence: Optional |
HTTP request headers
All requests made to eBay REST operations require you to provide the Authorization HTTP header for authentication authorization.
All other standard RESTful request headers are optional. For more information on standard RESTful request headers, see the HTTP request headers- opens rest request components page table.
OAuth scope
This request requires an access token created with the authorization code grant flow, using one or more scopes from the following list (please check your Application Keys page for a list of OAuth scopes available to your application):
https://api.ebay.com/oauth/api_scope/sell.inventory
https://api.ebay.com/oauth/api_scope/sell.fulfillment
https://api.ebay.com/oauth/api_scope/sell.marketing
https://api.ebay.com/oauth/api_scope/commerce.catalog.readonly
https://api.ebay.com/oauth/api_scope/sell.analytics.readonly
See OAuth access tokens for more information.
Request payload
This call has no payload.
Request fields
This call has no field definitions.
Output
HTTP response headers
This call has no response headers.
Response payload
Response fields
| Output container/field | Type | Description |
|---|---|---|
| href | string | The path to the call URI that produced the current page of results. Occurrence: Always |
| limit | integer | The value of the limit parameter submitted in the request, which is the maximum number of schedules to return per page, from the result set. A result set is the complete set of schedules returned by the method. Note: Though this parameter is not required to be submitted in the request, the parameter defaults to 10 if omitted. Note: If this is the last or only page of the result set, the page may contain fewer tasks than the limit value. To determine the number of pages in a result set, divide the total value (total number of tasks matching input criteria) by this limit value, and then round up to the next integer. For example, if the total value was Occurrence: Always |
| next | string | The path to the call URI for the next page of results. This value is returned if there is an additional page of results to return from the result set. Occurrence: Conditional |
| offset | integer | The number of results skipped in the result set before listing the first returned result. This value can be set in the request with the offset query parameter. Note: The items in a paginated result set use a zero-based list where the first item in the list has an offset of Occurrence: Always |
| prev | string | The path to the call URI for the previous page of results. This is returned if there is a previous page of results from the result set. Occurrence: Conditional |
| schedules | array of UserScheduleResponse | An array of the schedules on this page. An empty array is returned if the filter criteria excludes all tasks. Occurrence: Always |
| schedules.scheduleId | string | The ID of the schedule. This ID is generated when the schedule was created by the createSchedule method. Occurrence: Always |
| schedules.creationDate | string | The creation date of the schedule in hours based on the 24-hour Coordinated Universal Time (UTC) clock. Occurrence: Always |
| schedules.feedType | string | The feedType associated with the schedule. Occurrence: Always |
| schedules.lastModifiedDate | string | The date the schedule was last modified. Occurrence: Always |
| schedules.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 number of days in the month. Occurrence: Conditional |
| schedules.preferredTriggerDayOfWeek | DayOfWeekEnum | The preferred day of the week to trigger the schedule. This field can be used with preferredTriggerHour for weekly schedules. Occurrence: Conditional |
| schedules.preferredTriggerHour | string | The preferred two-digit hour of the day to trigger the schedule. Occurrence: Conditional |
| schedules.scheduleEndDate | string | The timestamp on which the report generation (subscription) ends. After this date, the schedule status becomes Occurrence: Always |
| schedules.scheduleName | string | The schedule name assigned by the user for the created schedule. Users assign this name for their reference. Occurrence: Conditional |
| schedules.scheduleStartDate | string | The timestamp that indicates the start of the report generation. Occurrence: Always |
| schedules.scheduleTemplateId | string | The ID of the template used to create this schedule. Occurrence: Always |
| schedules.schemaVersion | string | The schema version of the feedType for the schedule. Occurrence: Conditional |
| schedules.status | StatusEnum | The enumeration value that indicates the state of the schedule. Occurrence: Always |
| schedules.statusReason | StatusReasonEnum | The reason the schedule is inactive. Occurrence: Conditional |
| total | integer | The total number of schedules that match the input criteria. Occurrence: Conditional |
HTTP status codes
This call can return one of the following HTTP status codes. For an overview of the status codes, see HTTP status codes in Using eBay RESTful APIs.
| Status | Meaning |
|---|---|
| 200 | Success |
| 400 | Bad Request |
| 403 | Forbidden |
| 500 | Internal Server Error |
Error codes
For more on errors, plus the codes of other common errors, see Handling errors.
| Code | Domain | Category | Meaning |
|---|---|---|---|
| 160001 | API_FEED | APPLICATION | There was a problem with an eBay internal system or process. Contact eBay Developer Technical Support for assistance. |
| 160002 | API_FEED | REQUEST | The authentication scope {scope} is incorrect for 'feed_type' {feedType}. Refer to documentation for details about the scopes. |
| 160012 | API_FEED | REQUEST | The 'limit' value must be greater than zero and less than or equal to 500. |
| 160013 | API_FEED | REQUEST | The 'offset' value cannot be less than zero. |
| 160017 | API_FEED | REQUEST | The 'feedType' is missing or invalid. |
| 160029 | API_FEED | REQUEST | The 'offset' value must be a multiple of the 'limit' value. |
Warnings
This call has no warnings.
Samples
New to making API calls? Please see Making a Call.
Note: Identifiers, such as order IDs or user IDs, and personal data in these samples might be anonymized or may no longer be active on eBay. If necessary, substitute current, relevant eBay data in your requests.
Sample 1: Get Schedules
This call retrieves the the group of schedules that are based on the specified feed_type.
Input
The inputs are feed_type and two other parameters, limit and offset. If these two parameters are not specified, their default values are used.
GEThttps://api.ebay.com/sell/feed/v1/schedule?feed_type=LMS_ORDER_REPORT&limit=2&offset=2
Output
If the call is successful, the output is an array of schedules and the details for each schedule, including the scheduleTemplateId, feedType, scheduleId, scheduleStartDate, creationDate, lastModifiedDate, status, and other specified or conditional properties.