feed APIv1.3.1

updateSchedule

PUT
/schedule/{schedule_id}
This method updates an existing schedule. Specify the schedule to update using the schedule_id path parameter. If the schedule template has changed after the schedule was created or updated, the input will be validated using the changed template.

Note: Make sure to include all fields required by the schedule template (scheduleTemplateId). Call the getScheduleTemplate method (or the getScheduleTemplates method), to find out which fields are required or optional. If you do not know the scheduleTemplateId, call the getSchedule method to find out.

Input

Resource URI (production)

PUT https://api.ebay.com/sell/feed/v1/schedule/{schedule_id}

URI parameters

ParameterTypeDescription
schedule_idstringThe ID of the schedule to update. 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.

Input container/fieldTypeDescription
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 actual number of days in the month.

This field is available as specified by the template (scheduleTemplateId). The template can specify this field as optional or required, and optionally provides a default value.

Minimum: 1

Maximum: 31

Occurrence: Conditional

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

This field is available as specified by the template (scheduleTemplateId). The template can specify this field as optional or required, and optionally provides a default value.

Occurrence: Conditional

preferredTriggerHourstringThe preferred two-digit hour of the day to trigger the schedule.

This field is available as specified by the template (scheduleTemplateId). The template can specify this field as optional or required, and optionally provides a default value.

Format: UTC hhZ

For example, the following represents 11:00 am UTC: 11Z

Minimum: 00Z

Maximum: 23Z

Occurrence: Conditional

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

Use this field, if available, to end the schedule in the future. This value must be later than scheduleStartDate (if supplied). This field is available as specified by the template (scheduleTemplateId). The template can specify this field as optional or required, and optionally provides a default value.

Format: UTC yyyy-MM-ddTHHZ

For example, the following represents UTC October 10, 2021 at 10:00 AM:
2021-10-10T10Z

Occurrence: Conditional

scheduleNamestringThe schedule name assigned by the user for the created schedule.

Occurrence: Optional

scheduleStartDatestringThe timestamp to start generating the report. After this timestamp, the schedule status becomes active until either the scheduleEndDate occurs or the scheduleTemplateId becomes inactive.

Use this field, if available, to start the schedule in the future but before the scheduleEndDate (if supplied). This field is available as specified by the template (scheduleTemplateId). The template can specify this field as optional or required, and optionally provides a default value.

Format: UTC yyyy-MM-ddTHHZ

For example, the following represents a schedule start date of UTC October 01, 2020 at 12:00 PM:
2020-01-01T12Z

Occurrence: Conditional

schemaVersionstringThe schema version of the feedType for the schedule. This field is required if the feedType has a schema version.

This field is available as specified by the template (scheduleTemplateId). The template can specify this field as optional or required, and optionally provides a default value.

Occurrence: Conditional

Output

HTTP response headers

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
204No Content
400Bad Request
403Forbidden
404Not Found
409Conflict
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.
160034API_FEEDREQUESTThe '{fieldName}' is invalid, missing, or not allowed.
160036API_FEEDREQUESTThe '{fieldName}' is in past.
160037API_FEEDREQUESTThe 'scheduleEndDate' is before 'scheduleStartDate'.
160038API_FEEDREQUESTThe schedule id {schedule_id} does not exist.
160040API_FEEDBUSINESSThe 'scheduleTemplateId' is inactive. You cannot create or modify a schedule with an inactive 'scheduleTemplateId'.

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: Update a Schedule

This call updates the subscription (schedule) to the specified schedule template.

Input

The input is the schedule_id path parameter and the payload containing the following updates to the schedule:
  • Name of the schedule for user reference: My schedule
  • Preferred trigger hour of 11:00 AM UTC: 11Z
  • Preferred trigger day of the 2nd day of the month: 2
  • Schema version: 941
  • Schedule start date of October 1, 2020 at 12:00 PM UTC: 2020-10-01T12Z
PUT
https://api.ebay.com/sell/feed/v1/schedule/10-1***7-1******0

Output

The output is an HTTP status. If the call is successful, the schedule ID is returned in the Location response header. This method has no response payload.