eBay · Schema

UserScheduleResponse

The type that defines the fields for a paginated result set of available schedules. The response consists of 0 or more sequenced pages where each page has 0 or more items.

AuctionsCommerceProductsMarketplaceFortune 500

Properties

Name	Type	Description
scheduleId	string	The ID of the schedule. This ID is generated when the schedule was created by the createSchedule method.
creationDate	string	The creation date of the schedule in hours based on the 24-hour Coordinated Universal Time (UTC) clock.
feedType	string	The feedType associated with the schedule.
lastModifiedDate	string	The date the schedule was last modified.
preferredTriggerDayOfMonth	integer	The 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 th
preferredTriggerDayOfWeek	string	The preferred day of the week to trigger the schedule. This field can be used with preferredTriggerHour for weekly schedules. For implementation help, refer to eBay API documentation
statusReason	string	The reason the schedule is inactive. For implementation help, refer to eBay API documentation

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/UserScheduleResponse",
  "title": "UserScheduleResponse",
  "type": "object",
  "properties": {
    "scheduleId": {
      "type": "string",
      "description": "The ID of the schedule. This ID is generated when the schedule was created by the <strong>createSchedule</strong> method."
    },
    "creationDate": {
      "type": "string",
      "description": "The creation date of the schedule in hours based on the 24-hour Coordinated Universal Time (UTC) clock."
    },
    "feedType": {
      "type": "string",
      "description": "The <strong>feedType</strong> associated with the schedule."
    },
    "lastModifiedDate": {
      "type": "string",
      "description": "The date the schedule was last modified."
    },
    "preferredTriggerDayOfMonth": {
      "type": "integer",
      "description": "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.",
      "format": "int32"
    },
    "preferredTriggerDayOfWeek": {
      "type": "string",
      "description": "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>"
    },
    "preferredTriggerHour": {
      "type": "string",
      "description": "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 />"
    },
    "scheduleEndDate": {
      "type": "string",
      "description": "The timestamp on which the report generation (subscription) ends. After this date, the schedule status becomes <code>INACTIVE</code>."
    },
    "scheduleName": {
      "type": "string",
      "description": "The schedule name assigned by the user for the created schedule. Users assign this name for their reference."
    },
    "scheduleStartDate": {
      "type": "string",
      "description": "The timestamp that indicates the start of the report generation."
    },
    "scheduleTemplateId": {
      "type": "string",
      "description": "The ID of the template used to create this schedule."
    },
    "schemaVersion": {
      "type": "string",
      "description": "The schema version of the feedType for the schedule."
    },
    "status": {
      "type": "string",
      "description": "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>"
    },
    "statusReason": {
      "type": "string",
      "description": "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>"
    }
  },
  "description": "The type that defines the fields for a paginated result set of available schedules. The response consists of 0 or more sequenced <em> pages</em> where each page has 0 or more items."
}