Skip to main content

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 (production)

GET https://api.ebay.com/sell/feed/v1/schedule?

URI parameters

ParameterTypeDescription
feed_typestringThe feedType associated with the schedule.

Occurrence: Required

limitintegerThe 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

Occurrence: Optional

offsetintegerThe 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

Occurrence: Optional

HTTP request headers

All requests made to eBay REST operations require you to provide the Authorization HTTP header for authentication authorization.

This method has no additional required headers. See HTTP request headers- opens rest request components page for details.

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/fieldTypeDescription
hrefstring

The path to the call URI that produced the current page of results.

Occurrence: Always

limitinteger

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 120 (120 total tasks) and the limit value was 50 (show 50 tasks per page), the total number of pages in the result set is three, so the seller would have to make three separate getSchedules calls to view all tasks matching the input criteria.

Occurrence: Always

nextstring

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

offsetinteger

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

Occurrence: Always

prevstring

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

schedulesarray 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.scheduleIdstring

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

Occurrence: Always

schedules.creationDatestring

The creation date of the schedule in hours based on the 24-hour Coordinated Universal Time (UTC) clock.

Occurrence: Always

schedules.feedTypestring

The feedType associated with the schedule.

Occurrence: Always

schedules.lastModifiedDatestring

The date the schedule was last modified.

Occurrence: Always

schedules.preferredTriggerDayOfMonthinteger

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

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

Occurrence: Conditional

schedules.preferredTriggerHourstring

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

Format: UTC hhZ

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

11Z

Occurrence: Conditional

schedules.scheduleEndDatestring

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

Occurrence: Always

schedules.scheduleNamestring

The schedule name assigned by the user for the created schedule. Users assign this name for their reference.

Occurrence: Conditional

schedules.scheduleStartDatestring

The timestamp that indicates the start of the report generation.

Occurrence: Always

schedules.scheduleTemplateIdstring

The ID of the template used to create this schedule.

Occurrence: Always

schedules.schemaVersionstring

The schema version of the feedType for the schedule.

Occurrence: Conditional

schedules.statusStatusEnum

The enumeration value that indicates the state of the schedule.

Occurrence: Always

schedules.statusReasonStatusReasonEnum

The reason the schedule is inactive.

Occurrence: Conditional

totalinteger

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.

StatusMeaning
200Success
400Bad Request
403Forbidden
500Internal Server Error

Error codes

For more on errors, plus the codes of other common errors, see Handling errors.

CodeDomainCategoryMeaning
160001API_FEEDAPPLICATIONThere was a problem with an eBay internal system or process. Contact eBay Developer Technical Support for assistance.
160002API_FEEDREQUESTThe authentication scope {scope} is incorrect for 'feed_type' {feedType}. Refer to documentation for details about the scopes.
160012API_FEEDREQUESTThe 'limit' value must be greater than zero and less than or equal to 500.
160013API_FEEDREQUESTThe 'offset' value cannot be less than zero.
160017API_FEEDREQUESTThe 'feedType' is missing or invalid.
160029API_FEEDREQUESTThe '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.