eBay · Schema

SupportedConfiguration

An array that defines the configuration supported by this template. This includes specified properties and usage (whether the property is REQUIRED or OPTIONAL), and an optional default value.

AuctionsCommerceProductsMarketplaceFortune 500

Properties

Name Type Description
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.
property string Properties supported by the template. Properties can include the following:
  • scheduleStartDate: The timestamp that the report generation (subscription) begins. After this timestamp, the
usage string Whether the specified property is REQUIRED or OPTIONAL. For implementation help, refer to eBay API documentati
View JSON Schema on GitHub

JSON Schema

ebay-supportedconfiguration-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/SupportedConfiguration",
  "title": "SupportedConfiguration",
  "type": "object",
  "properties": {
    "defaultValue": {
      "type": "string",
      "description": "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."
    },
    "property": {
      "type": "string",
      "description": "Properties supported by the template. Properties can include the following: <ul><li><b>scheduleStartDate:</b> The timestamp that the report generation (subscription) begins. After this timestamp, the schedule status becomes active until either the scheduleEndDate occurs or the scheduleTemplate becomes inactive. Format: UTC <code>yyyy-MM-dd<strong>T</strong>HH<strong>Z</strong></code></li><li><b>scheduleEndDate:</b> The timestamp that the report generation (subscription) ends. After this date, the schedule status becomes INACTIVE. Format: UTC <code>yyyy-MM-dd<strong>T</strong>HH<strong>Z</strong></code></li><li><b>schemaVersion:</b> The schema version of the schedule templates feedType. This field is required if the feedType has a schema version.</li><li><b>preferredTriggerDayOfMonth:</b> The preferred day of the month to trigger the schedule. </li><li><b>preferredTriggerDayOfWeek:</b> The preferred day of the week to trigger the schedule. </li><li><b>preferredTriggerHour:</b> The preferred two-digit hour of the day to trigger the schedule. Format: UTC <code>hhZ</code></li><ul>"
    },
    "usage": {
      "type": "string",
      "description": "Whether the specified property is REQUIRED or OPTIONAL. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/feed/types/api:ConfigurationsUsageEnum'>eBay API documentation</a>"
    }
  },
  "description": "An array that defines the configuration supported by this template. This includes specified properties and usage (whether the property is REQUIRED or OPTIONAL), and an optional default value."
}