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
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 |
---|---|---|
schedule_template_id | string | This path parameter is the unique identifier of the schedule template being retrieved. Use the getScheduleTemplates method to retrieve schedule template IDs. Note: Template schedules are currently only available for LMS_ORDER_REPORT . Occurrence: Required |
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 |
---|---|---|
feedType | string | The 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 |
frequency | FrequencyEnum | This field specifies how often the schedule is generated. If set to Occurrence: Always |
name | string | The template name provided by the template. Occurrence: Conditional |
scheduleTemplateId | string | The ID of the template. Use this ID to create a schedule based on the properties of this schedule template. Occurrence: Always |
status | StatusEnum | The present status of the template. You cannot create or modify a schedule using a template with an Occurrence: Always |
supportedConfigurations | array of SupportedConfiguration | An array of the configuration supported by this template. Occurrence: Always |
supportedConfigurations.defaultValue | string | The 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.property | string | Properties supported by the template. Properties can include the following:
Occurrence: Conditional |
supportedConfigurations.usage | ConfigurationsUsageEnum | Whether 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.
Status | Meaning |
---|---|
200 | Success |
404 | Not Found |
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. |
160039 | API_FEED | REQUEST | The 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
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: 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.
GEThttps://api.ebay.com/sell/feed/v1/schedule_template/1********1
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.