Sign in

v1

latestOpenAPI 3.0.0eBay API License Agreement2026-07-142328131.5 KB
schedule

This method retrieves schedule details and status of the specified schedule. Specify the schedule to retrieve using the <strong>schedule_id</strong>. Use the <strong>getSchedules</strong> method to find a schedule if you do not know the <strong>schedule_id</strong>.

get/schedule/{schedule_id}

Path parameters

schedule_idstring required

The ID of the schedule for which to retrieve the details. This ID is generated when the schedule was created by the <strong>createSchedule</strong> method.

Response

Success

creationDatestring

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

feedTypestring

The <strong>feedType</strong> associated with the schedule.

lastModifiedDatestring

The date the schedule was last modified.

preferredTriggerDayOfMonthinteger

The preferred day of the month to trigger the schedule. This field can be used with <strong>preferredTriggerHour</strong> for monthly schedules. The last day of the month is used for numbers larger than the number of days in the month.

preferredTriggerDayOfWeekstring

The preferred day of the week to trigger the schedule. This field can be used with <strong>preferredTriggerHour</strong> for weekly schedules. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/feed/types/api:DayOfWeekEnum'>eBay API documentation</a>

preferredTriggerHourstring

The preferred two-digit hour of the day to trigger the schedule. <br /><br /><b>Format:</b> UTC <code>hhZ</code><br /><br />For example, the following represents 11:00 am UTC:<br /><br /><code>11Z</code><br /><br />

scheduleEndDatestring

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

scheduleIdstring

The ID of the schedule. This ID is generated when the schedule was created by the <strong>createSchedule</strong> method.

scheduleNamestring

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

scheduleStartDatestring

The timestamp that indicates the start of the report generation.

scheduleTemplateIdstring

The ID of the template used to create this schedule.

schemaVersionstring

The schema version of the feedType for the schedule.

statusstring

The enumeration value that indicates the state of the schedule. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/feed/types/api:StatusEnum'>eBay API documentation</a>

statusReasonstring

The reason the schedule is inactive. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/feed/types/api:StatusReasonEnum'>eBay API documentation</a>