feed APIv1.3.1

getScheduleTemplates

GET
/schedule_template
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.

Input

Resource URI (production)

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

URI parameters

ParameterTypeDescription
feed_typestringThe feed type of the schedule templates to retrieve.

Occurrence: Required

limitintegerThe 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

Occurrence: Optional

offsetintegerThe 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

Occurrence: Optional

HTTP request headers

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

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.

Output

HTTP response headers

Output container/fieldTypeDescription
hrefstringThe path to the call URI that produced the current page of results.

Occurrence: Always

limitintegerThe value of the limit parameter submitted in the request, which is the maximum number of schedule templates to return per page, from the result set. A result set is the complete set of schedule templates 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 getScheduleTemplates calls to view all tasks matching the input criteria.

Occurrence: Always

nextstringThe 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

offsetintegerThe 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

prevstringThe 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

scheduleTemplatesarray of ScheduleTemplateResponseAn array of the schedule templates on this page. An empty array is returned if the filter criteria excludes all tasks.

Occurrence: Always

scheduleTemplates.feedTypestringThe feed type of the schedule template.

Note: When calling createSchedule and updateSchedule methods you must match the feed type specified by the schedule template (this feedType).

Occurrence: Always

scheduleTemplates.frequencyFrequencyEnumThis field specifies how often the schedule is generated. If set to HALF_HOUR or ONE_HOUR, you cannot set a preferredTriggerHour using createSchedule or updateSchedule.

Occurrence: Always

scheduleTemplates.namestringThe template name provided by the template.

Occurrence: Conditional

scheduleTemplates.scheduleTemplateIdstringThe ID of the template. Use this ID to create a schedule based on the properties of this schedule template.

Occurrence: Always

scheduleTemplates.statusStatusEnumThe present status of the template. You cannot create or modify a schedule using a template with an INACTIVE status.

Occurrence: Always

scheduleTemplates.supportedConfigurationsarray of SupportedConfigurationAn array of the configuration supported by this template.

Occurrence: Always

scheduleTemplates.supportedConfigurations.defaultValuestringThe default value for the property. If a value is omitted from the schedule and a default value is supplied, the default value is used.

Occurrence: Conditional

scheduleTemplates.supportedConfigurations.propertystringProperties supported by the template. Properties can include the following:
  • scheduleStartDate: The timestamp that the report generation (subscription) begins. After this timestamp, the schedule status becomes active until either the scheduleEndDate occurs or the scheduleTemplate becomes inactive. Format: UTC yyyy-MM-ddTHHZ
  • scheduleEndDate: The timestamp that the report generation (subscription) ends. After this date, the schedule status becomes INACTIVE. Format: UTC yyyy-MM-ddTHHZ
  • schemaVersion: The schema version of the schedule templates feedType. This field is required if the feedType has a schema version.
  • preferredTriggerDayOfMonth: The preferred day of the month to trigger the schedule.
  • preferredTriggerDayOfWeek: The preferred day of the week to trigger the schedule.
  • preferredTriggerHour: The preferred two-digit hour of the day to trigger the schedule. Format: UTC hhZ
    • Occurrence: Conditional

scheduleTemplates.supportedConfigurations.usageConfigurationsUsageEnumWhether the specified property is REQUIRED or OPTIONAL.

Occurrence: Conditional

totalintegerThe total number of schedule templates that match the input criteria.

Occurrence: Always

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

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 Schedule Templates

This call retrieves the group of schedule templates 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.
GET
https://api.ebay.com/sell/feed/v1/schedule_template?feed_type=LMS_ORDER_REPORT&limit=2&offset=2

Output

If the call is successful, the output is an array of schedule templates and the details for each schedule template, including the scheduleTemplateId, frequency, name, supportedConfigurations, feedType, and status. Of the two templates returned in the sample, 1********1 is active and available for use (1********4 is not).