feed APIv1.2.0

getScheduleTemplate

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

Input

Resource URI (production)

GET https://api.ebay.com/sell/feed/v1/schedule_template/{schedule_template_id}

URI parameters

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

Occurrence: Required

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

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

namestringThe template name provided by the template.

Occurrence: Conditional

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

Occurrence: Always

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

Occurrence: Always

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

Occurrence: Always

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

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

supportedConfigurations.usageConfigurationsUsageEnumWhether the specified property is REQUIRED or OPTIONAL.

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
404Not Found
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.
160039API_FEEDREQUESTThe schedule template id {schedule_template_id} does not exist. Please provide a valid schedule template id as contained in the documentation or by calling the getScheduleTemplates method.

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: Retrieve a Schedule Template

This call retrieves the details, including template status, of the specified schedule template.

Input

The input is the schedule_template_id.
GET
https://api.ebay.com/sell/feed/v1/schedule_template/10-15651

Output

If the call is successful, the output is the schedule template and its supported configuration. Make sure to include properties in your schedule as required by the template. The returned template for this example requires schemaVersion and preferredTriggerHour. The template also provides for three other optional parameters.