feed APIv1.2.0

getSchedule

GET
/schedule/{schedule_id}
This method retrieves schedule details and status of the specified schedule. Specify the schedule to retrieve using the schedule_id. Use the getSchedules 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/{schedule_id}

URI parameters

ParameterTypeDescription
schedule_idstringThe ID of the schedule for which to retrieve the details. This ID is generated when the schedule was created by the createSchedule method.

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
scheduleIdstringThe ID of the schedule. This ID is generated when the schedule was created by the createSchedule method.

Occurrence: Always

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

Occurrence: Always

feedTypestringThe feedType associated with the schedule.

Occurrence: Always

lastModifiedDatestringThe date the schedule was last modified.

Occurrence: Always

preferredTriggerDayOfMonthintegerThe 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

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

Occurrence: Conditional

preferredTriggerHourstringThe 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

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

Occurrence: Always

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

Occurrence: Conditional

scheduleStartDatestringThe timestamp that indicates the start of the report generation.

Occurrence: Always

scheduleTemplateIdstringThe ID of the template used to create this schedule.

Occurrence: Always

schemaVersionstringThe schema version of the feedType for the schedule.

Occurrence: Conditional

statusStatusEnumThe enumeration value that indicates the state of the schedule.

Occurrence: Always

statusReasonStatusReasonEnumThe reason the schedule is inactive.

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
403Forbidden
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.
160002API_FEEDREQUESTThe authentication scope {scope} is incorrect for 'feed_type' {feedType}. Refer to documentation for details about the scopes.
160038API_FEEDREQUESTThe schedule id {schedule_id} does not exist.

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 a schedule for the specified schedule_id.

Input

The input is schedule_id. In this case, the schedule_id is 10-13567-10354530.
GET
https://api.ebay.com/sell/feed/v1/schedule/10-13567-10354530

Output

If the call is successful, the output is the schedule status and the criteria specified when the schedule was created.