The Sell Feed API lets sellers upload input files, download reports and files including their status, filter reports using URI parameters, and retrieve customer service metrics task details.
", "contact": { "name": "eBay Inc" }, "license": { "name": "eBay API License Agreement", "url": "https://developer.ebay.com/join/api-license-agreement" }, "version": "v1.3.1" }, "servers": [ { "url": "https://api.ebay.com/sell/feed/v1", "description": "Production", "variables": { "basePath": { "default": "/sell/feed/v1" } } }, { "url": "https://api.sandbox.ebay.com/sell/feed/v1", "description": "Sandbox server" } ], "security": [ {} ], "paths": { "/order_task": { "get": { "tags": [ "order_task" ], "description": "This method returns the details and status for an array of order tasks. Rather than using a request payload, it does this through specified input in query parameters, such as feed_type or schedule_id. Specifying both feed_type and schedule_id results in an error. Since schedules are based on feed types, you can specify a schedule (schedule_id) that returns the needed feed_type.LMS_ORDER_REPORTyyyy-MM-ddThh:mm:ss.SSSZ..yyyy-MM-ddThh:mm:ss.SSSZ 2019-09-08T00:00:00.000Z..2019-09-09T00:00:00.000Z Note: This feature employs a zero-based list, where the first item in the list has an offset of 0.
For example, if offset is set to 10 and limit is set to 10, the call retrieves order tasks 11 thru 20 from the result set.
If this parameter is omitted, the default value is used.
Default: 10
Maximum: 500
", "required": false, "schema": { "type": "integer", "default": 10 }, "style": "form", "explode": true }, { "name": "offset", "in": "query", "description": "The number of order tasks to skip in the result set before returning the first order in the paginated response.Combine offset with the limit query parameter to control the items returned in the response. For example, if you supply an offset of 0 and a limit of 10, the first page of the response contains the first 10 items from the complete list of items retrieved by the call. If offset is 10 and limit is 20, the first page of the response contains items 11-30 from the complete result set. If this query parameter is not set, the default value is used and the first page of records is returned.
Default: 0",
"required": false,
"schema": {
"type": "integer",
"default": 0
},
"style": "form",
"explode": true
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrderTaskCollection"
}
}
}
},
"400": {
"description": "Bad Request",
"x-response-codes": {
"errors": {
"160004": {
"domain": "API_FEED",
"category": "REQUEST",
"description": "You must submit either a 'feed_type' or 'schedule_id'."
},
"160005": {
"domain": "API_FEED",
"category": "REQUEST",
"description": "Both 'feed_type' and 'schedule_id' were provided. Please remove one of them."
},
"160006": {
"domain": "API_FEED",
"category": "REQUEST",
"description": "The 'feed_type' {feedTypeValue} is invalid."
},
"160007": {
"domain": "API_FEED",
"category": "REQUEST",
"description": "The 'schedule_id' {scheduleID} is invalid."
},
"160008": {
"domain": "API_FEED",
"category": "REQUEST",
"description": "Both 'look_back_days' and 'date_range' were provided. Please remove one of them."
},
"160009": {
"domain": "API_FEED",
"category": "REQUEST",
"description": "The format of the 'date_range' is invalid. The format for a date range is yyyy-MM-ddThh:mm:ss.SSSZ..yyyy-MM-ddThh:mm:ss.SSSZ."
},
"160010": {
"domain": "API_FEED",
"category": "REQUEST",
"description": "The 'date_range' must be less than or equal to 90 days."
},
"160011": {
"domain": "API_FEED",
"category": "REQUEST",
"description": "The 'look_back_days' value must be greater than zero and less than or equal to 90."
},
"160012": {
"domain": "API_FEED",
"category": "REQUEST",
"description": "The 'limit' value must be greater than zero and less than or equal to 500."
},
"160013": {
"domain": "API_FEED",
"category": "REQUEST",
"description": "The 'offset' value cannot be less than zero."
},
"160029": {
"domain": "API_FEED",
"category": "REQUEST",
"description": "The 'offset' value must be a multiple of the 'limit' value."
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"x-response-codes": {
"errors": {
"1001": {
"domain": "API_FEED",
"category": "REQUEST",
"description": "Invalid access token. Check the value of the Authorization HTTP request header."
}
}
}
},
"403": {
"description": "Forbidden",
"x-response-codes": {
"errors": {
"160002": {
"domain": "API_FEED",
"category": "REQUEST",
"description": "The authentication scope {scope} is incorrect for 'feed_type' {feedType}. Refer to documentation for details about the scopes."
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"500": {
"description": "Internal Server Error",
"x-response-codes": {
"errors": {
"160001": {
"domain": "API_FEED",
"category": "APPLICATION",
"description": "There was a problem with an eBay internal system or process. Contact eBay Developer Technical Support for assistance."
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"security": [
{
"api_auth": [
"https://api.ebay.com/oauth/api_scope/sell.fulfillment"
],
"sell_fulfillment_scope": [
"https://api.ebay.com/oauth/api_scope/sell.fulfillment"
]
},
{
"ebay_user_scope": []
}
]
},
"post": {
"tags": [
"order_task"
],
"description": "This method creates an order download task with filter criteria for the order report. When using this method, specify the feedType, schemaVersion, and filterCriteria for the report. The method returns the location response header containing the getOrderTask call URI to retrieve the order task you just created. The URL includes the eBay-assigned task ID, which you can use to reference the order task.
To retrieve the status of the task, use the getOrderTask method to retrieve a single task ID or the getOrderTasks method to retrieve multiple order task IDs.
Note: The scope depends on the feed type. An error message results when an unsupported scope or feed type is specified.
The following contains this method's authorization scope and its corresponding feed type:
For details about how this method is used, see General feed types in the Selling Integration Guide.
Note: At this time, the createOrderTask method only supports order creation date filters and not modified order date filters. Do not include the modifiedDateRange filter in your request payload.
", "operationId": "createOrderTask", "parameters": [ { "name": "Content-Type", "in": "header", "description": "This header indicates the format of the request body provided by the client. Its value should be set to application/json.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "description not needed", "content": { "application/json": { "schema": { "description": "description not needed", "$ref": "#/components/schemas/CreateOrderTaskRequest" } } }, "required": true }, "responses": { "202": { "description": "Accepted", "headers": { "Location": { "description": "The URI of the task, which includes the ID of the task.", "style": "simple", "explode": false, "schema": { "type": "string" } } } }, "400": { "description": "Bad Request", "x-response-codes": { "errors": { "160017": { "domain": "API_FEED", "category": "REQUEST", "description": "The 'feedType' is missing or invalid." }, "160018": { "domain": "API_FEED", "category": "REQUEST", "description": "The 'schemaVersion' is invalid." }, "160019": { "domain": "API_FEED", "category": "REQUEST", "description": "The 'filterCriteria' is invalid. {additionalInfo}" }, "160027": { "domain": "API_FEED", "category": "REQUEST", "description": "The X-EBAY-C-MARKETPLACE-ID header is missing or invalid." }, "160030": { "domain": "API_FEED", "category": "REQUEST", "description": "This resource is not applicable for the feed type {feedTypeValue}. For more information, see the documentation for this API." } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "x-response-codes": { "errors": { "1001": { "domain": "API_FEED", "category": "REQUEST", "description": "Invalid access token. Check the value of the Authorization HTTP request header." } } } }, "403": { "description": "Forbidden", "x-response-codes": { "errors": { "160002": { "domain": "API_FEED", "category": "REQUEST", "description": "The authentication scope {scope} is incorrect for 'feed_type' {feedType}. Refer to documentation for details about the scopes." }, "160022": { "domain": "API_FEED", "category": "REQUEST", "description": "You are not allowed to access this resource. Contact eBay Developer Technical Support for assistance." } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict", "x-response-codes": { "errors": { "160024": { "domain": "API_FEED", "category": "BUSINESS", "description": "You have reached the maximum number of feed tasks that can be queued or processed concurrently. Wait for current tasks to complete before adding tasks. For more information, see the documentation for this API." }, "160025": { "domain": "API_FEED", "category": "BUSINESS", "description": "You have exceeded the maximum number of records or tasks that can be created or processed in the period (hourly or daily). Wait until the present period ends before trying again. For more information, see the documentation for this API." } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "x-response-codes": { "errors": { "160001": { "domain": "API_FEED", "category": "APPLICATION", "description": "There was a problem with an eBay internal system or process. Contact eBay Developer Technical Support for assistance." } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "api_auth": [ "https://api.ebay.com/oauth/api_scope/sell.fulfillment" ], "sell_fulfillment_scope": [ "https://api.ebay.com/oauth/api_scope/sell.fulfillment" ] }, { "ebay_user_scope": [] } ] } }, "/order_task/{task_id}": { "get": { "tags": [ "order_task" ], "description": "This method retrieves the task details and status of the specified task. The input is task_id.For details about how this method is used, see Working with Order Feeds in the Selling Integration Guide.
", "operationId": "getOrderTask", "parameters": [ { "name": "task_id", "in": "path", "description": "This path parameter is the unique identifier of the order task being retrieved.LMS_ACTIVE_INVENTORY_REPORTdate_range parameter. If both date_range and look_back_days are omitted, this parameter's default value is used. Note: Maximum date range window size is 90 days.
yyyy-MM-ddThh:mm:ss.SSSZ..yyyy-MM-ddThh:mm:ss.SSSZ2021-03-31T00:00:00.000Z..2021-03-31T00:00:00.000Z Note: This feature employs a zero-based list, where the first item in the list has an offset of 0.
For example, if offset is set to 10 and limit is set to 10, the call retrieves tasks 11 thru 20 from the result set.
If this parameter is omitted, the default value is used.
Default: 10
Maximum: 500",
"required": false,
"schema": {
"type": "integer",
"default": 10
},
"style": "form",
"explode": true
},
{
"name": "offset",
"in": "query",
"description": "The number of tasks to skip in the result set before returning the first task in the paginated response.
Combine offset with the limit query parameter to control the items returned in the response. For example, if you supply an offset of 0 and a limit of 10, the first page of the response contains the first 10 items from the complete list of items retrieved by the call. If offset is 10 and limit is 20, the first page of the response contains items 11-30 from the complete result set. If this query parameter is not set, the default value is used and the first page of records is returned.
Default: 0",
"required": false,
"schema": {
"type": "integer",
"default": 0
},
"style": "form",
"explode": true
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InventoryTaskCollection"
}
}
}
},
"400": {
"description": "Bad Request",
"x-response-codes": {
"errors": {
"160004": {
"domain": "API_FEED",
"category": "REQUEST",
"description": "You must submit either a 'feed_type' or 'schedule_id'."
},
"160005": {
"domain": "API_FEED",
"category": "REQUEST",
"description": "Both 'feed_type' and 'schedule_id' were provided. Please remove one of them."
},
"160006": {
"domain": "API_FEED",
"category": "REQUEST",
"description": "The 'feed_type' {feedTypeValue} is invalid."
},
"160007": {
"domain": "API_FEED",
"category": "REQUEST",
"description": "The 'schedule_id' {scheduleID} is invalid."
},
"160008": {
"domain": "API_FEED",
"category": "REQUEST",
"description": "Both 'look_back_days' and 'date_range' were provided. Please remove one of them."
},
"160009": {
"domain": "API_FEED",
"category": "REQUEST",
"description": "The format of the 'date_range' is invalid. The format for a date range is yyyy-MM-ddThh:mm:ss.SSSZ..yyyy-MM-ddThh:mm:ss.SSSZ."
},
"160010": {
"domain": "API_FEED",
"category": "REQUEST",
"description": "The 'date_range' must be less than or equal to 90 days."
},
"160011": {
"domain": "API_FEED",
"category": "REQUEST",
"description": "The 'look_back_days' value must be greater than zero and less than or equal to 90."
},
"160012": {
"domain": "API_FEED",
"category": "REQUEST",
"description": "The 'limit' value must be greater than zero and less than or equal to 500."
},
"160013": {
"domain": "API_FEED",
"category": "REQUEST",
"description": "The 'offset' value cannot be less than zero."
},
"160029": {
"domain": "API_FEED",
"category": "REQUEST",
"description": "The 'offset' value must be a multiple of the 'limit' value."
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"x-response-codes": {
"errors": {
"1001": {
"domain": "API_FEED",
"category": "REQUEST",
"description": "Invalid access token. Check the value of the Authorization HTTP request header."
}
}
}
},
"403": {
"description": "Forbidden",
"x-response-codes": {
"errors": {
"160002": {
"domain": "API_FEED",
"category": "REQUEST",
"description": "The authentication scope {scope} is incorrect for 'feed_type' {feedType}. Refer to documentation for details about the scopes."
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"500": {
"description": "Internal Server Error",
"x-response-codes": {
"errors": {
"160001": {
"domain": "API_FEED",
"category": "APPLICATION",
"description": "There was a problem with an eBay internal system or process. Contact eBay Developer Technical Support for assistance."
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"security": [
{
"api_auth": [
"https://api.ebay.com/oauth/api_scope/sell.inventory"
],
"sell_inventory_scope": [
"https://api.ebay.com/oauth/api_scope/sell.inventory"
]
},
{
"ebay_user_scope": []
}
]
},
"post": {
"tags": [
"inventory_task"
],
"description": "This method creates an inventory-related download task for a specified feed type with optional filter criteria. When using this method, specify the feedType.
This method returns the location response header containing the getInventoryTask call URI to retrieve the inventory task you just created. The URL includes the eBay-assigned task ID, which you can use to reference the inventory task.
To retrieve the status of the task, use the getInventoryTask method to retrieve a single task ID or the getInventoryTasks method to retrieve multiple task IDs.
Note: The scope depends on the feed type. An error message results when an unsupported scope or feed type is specified.
Presently, this method supports Active Inventory Report. The ActiveInventoryReport returns a report that contains price and quantity information for all of the active listings for a specific seller. A seller can use this information to maintain their inventory on eBay.", "operationId": "createInventoryTask", "parameters": [ { "name": "Content-Type", "in": "header", "description": "This header indicates the format of the request body provided by the client. Its value should be set to application/json.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The request payload containing the version, feedType, and optional filterCriteria.", "content": { "application/json": { "schema": { "description": "The request payload containing the version, feedType, and optional filterCriteria.", "$ref": "#/components/schemas/CreateInventoryTaskRequest" } } }, "required": true }, "responses": { "202": { "description": "Accepted", "headers": { "Location": { "description": "The URI of the task, which includes the ID of the task.", "style": "simple", "explode": false, "schema": { "type": "string" } } } }, "400": { "description": "Bad Request", "x-response-codes": { "errors": { "160017": { "domain": "API_FEED", "category": "REQUEST", "description": "The 'feedType' is missing or invalid." }, "160018": { "domain": "API_FEED", "category": "REQUEST", "description": "The 'schemaVersion' is invalid." }, "160019": { "domain": "API_FEED", "category": "REQUEST", "description": "The 'filterCriteria' is invalid. {additionalInfo}" }, "160027": { "domain": "API_FEED", "category": "REQUEST", "description": "The X-EBAY-C-MARKETPLACE-ID header is missing or invalid." }, "160030": { "domain": "API_FEED", "category": "REQUEST", "description": "This resource is not applicable for the feed type {feedTypeValue}. For more information, see the documentation for this API." } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "x-response-codes": { "errors": { "1001": { "domain": "API_FEED", "category": "REQUEST", "description": "Invalid access token. Check the value of the Authorization HTTP request header." } } } }, "403": { "description": "Forbidden", "x-response-codes": { "errors": { "160002": { "domain": "API_FEED", "category": "REQUEST", "description": "The authentication scope {scope} is incorrect for 'feed_type' {feedType}. Refer to documentation for details about the scopes." }, "160022": { "domain": "API_FEED", "category": "REQUEST", "description": "You are not allowed to access this resource. Contact eBay Developer Technical Support for assistance." } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict", "x-response-codes": { "errors": { "160024": { "domain": "API_FEED", "category": "BUSINESS", "description": "You have reached the maximum number of feed tasks that can be queued or processed concurrently. Wait for current tasks to complete before adding tasks. For more information, see the documentation for this API." }, "160025": { "domain": "API_FEED", "category": "BUSINESS", "description": "You have exceeded the maximum number of records or tasks that can be created or processed in the period (hourly or daily). Wait until the present period ends before trying again. Please reference the API documentation for more information." } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "x-response-codes": { "errors": { "160001": { "domain": "API_FEED", "category": "APPLICATION", "description": "There was a problem with an eBay internal system or process. Contact eBay Developer Technical Support for assistance." } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "api_auth": [ "https://api.ebay.com/oauth/api_scope/sell.inventory" ], "sell_inventory_scope": [ "https://api.ebay.com/oauth/api_scope/sell.inventory" ] }, { "ebay_user_scope": [] } ] } }, "/inventory_task/{task_id}": { "get": { "tags": [ "inventory_task" ], "description": "This method retrieves the task details and status of the specified inventory-related task. The input is task_id.", "operationId": "getInventoryTask", "parameters": [ { "name": "task_id", "in": "path", "description": "This path parameter is the unique identifier of the inventory task being retrieved.LMS_ORDER_REPORT.",
"required": true,
"schema": {
"type": "string"
},
"style": "form",
"explode": true
},
{
"name": "limit",
"in": "query",
"description": "The maximum number of schedules that can be returned on each page of the paginated response. Use this parameter in conjunction with the offset parameter to control the pagination of the output. Note: This feature employs a zero-based list, where the first item in the list has an offset of 0.
For example, if offset is set to 10 and limit is set to 10, the call retrieves schedules 11 thru 20 from the result set.
If this parameter is omitted, the default value is used.
Default: 10
Maximum: 500",
"required": false,
"schema": {
"type": "integer",
"default": 10
},
"style": "form",
"explode": true
},
{
"name": "offset",
"in": "query",
"description": "The number of schedules to skip in the result set before returning the first schedule in the paginated response.
Combine offset with the limit query parameter to control the items returned in the response. For example, if you supply an offset of 0 and a limit of 10, the first page of the response contains the first 10 items from the complete list of items retrieved by the call. If offset is 10 and limit is 20, the first page of the response contains items 11-30 from the complete result set. If this query parameter is not set, the default value is used and the first page of records is returned.
Default: 0",
"required": false,
"schema": {
"type": "integer",
"default": 0
},
"style": "form",
"explode": true
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserScheduleCollection"
}
}
}
},
"400": {
"description": "Bad Request",
"x-response-codes": {
"errors": {
"160012": {
"domain": "API_FEED",
"category": "REQUEST",
"description": "The 'limit' value must be greater than zero and less than or equal to 500."
},
"160013": {
"domain": "API_FEED",
"category": "REQUEST",
"description": "The 'offset' value cannot be less than zero."
},
"160017": {
"domain": "API_FEED",
"category": "REQUEST",
"description": "The 'feedType' is missing or invalid."
},
"160029": {
"domain": "API_FEED",
"category": "REQUEST",
"description": "The 'offset' value must be a multiple of the 'limit' value."
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"x-response-codes": {
"errors": {
"1001": {
"domain": "API_FEED",
"category": "REQUEST",
"description": "Invalid access token. Check the value of the Authorization HTTP request header."
}
}
}
},
"403": {
"description": "Forbidden",
"x-response-codes": {
"errors": {
"160002": {
"domain": "API_FEED",
"category": "REQUEST",
"description": "The authentication scope {scope} is incorrect for 'feed_type' {feedType}. Refer to documentation for details about the scopes."
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"500": {
"description": "Internal Server Error",
"x-response-codes": {
"errors": {
"160001": {
"domain": "API_FEED",
"category": "APPLICATION",
"description": "There was a problem with an eBay internal system or process. Contact eBay Developer Technical Support for assistance."
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"security": [
{
"api_auth": [
"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"
],
"sell_inventory_scope": [
"https://api.ebay.com/oauth/api_scope/sell.inventory"
]
},
{
"sell_fulfillment_scope": [
"https://api.ebay.com/oauth/api_scope/sell.fulfillment"
]
},
{
"sell_marketing_scope": [
"https://api.ebay.com/oauth/api_scope/sell.marketing"
]
},
{
"commerce_catalog_readonly_scope": [
"https://api.ebay.com/oauth/api_scope/commerce.catalog.readonly"
]
},
{
"sell_analytics_readonly_scope": [
"https://api.ebay.com/oauth/api_scope/sell.analytics.readonly"
]
},
{
"ebay_user_scope": []
}
]
},
"post": {
"tags": [
"schedule"
],
"description": "This method creates a schedule, which is a subscription to the specified schedule template. A schedule periodically generates a report for the feedType specified by the template. Specify the same feedType as the feedType of the associated schedule template. When creating the schedule, if available from the template, you can specify a preferred trigger hour, day of the week, or day of the month. These and other fields are conditionally available as specified by the 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 a field is optional and a default value is provided by the template, the default value will be used if omitted from the payload.
A successful call returns the location response header containing the getSchedule call URI to retrieve the schedule you just created. The URL includes the eBay-assigned schedule ID, which you can use to reference the schedule task.Note: Except for schedules with a HALF-HOUR frequency, all schedules will ideally run at the start of each hour ('00' minutes). Actual start time may vary due to load and other factors.
", "operationId": "createSchedule", "parameters": [ { "name": "Content-Type", "in": "header", "description": "This header indicates the format of the request body provided by the client. Its value should be set to application/json.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "In the request payload: feedType and scheduleTemplateId are required; scheduleName is optional; preferredTriggerHour, preferredTriggerDayOfWeek, preferredTriggerDayOfMonth, scheduleStartDate, scheduleEndDate, and schemaVersion are conditional.", "content": { "application/json": { "schema": { "description": "In the request payload: feedType and scheduleTemplateId are required; scheduleName is optional; preferredTriggerHour, preferredTriggerDayOfWeek, preferredTriggerDayOfMonth, scheduleStartDate, scheduleEndDate, and schemaVersion are conditional.", "$ref": "#/components/schemas/CreateUserScheduleRequest" } } }, "required": true }, "responses": { "201": { "description": "Created", "headers": { "Location": { "schema": { "type": "string", "description": "The URL of the schedule, which includes the id." }, "description": "The URL of the schedule, which includes the id.", "style": "simple", "explode": false } }, "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request", "x-response-codes": { "errors": { "160017": { "domain": "API_FEED", "category": "REQUEST", "description": "The 'feedType' is missing or invalid." }, "160032": { "domain": "API_FEED", "category": "REQUEST", "description": "The 'scheduleTemplateId' is invalid. Call the getScheduleTemplates method to get the available schedule templates." }, "160033": { "domain": "API_FEED", "category": "REQUEST", "description": "The 'feedType' is not associated with the 'scheduleTemplateId'. Please provide a 'feedType' that matches the 'scheduleTemplateId'. Call the getScheduleTemplates method to get the available schedule templates." }, "160034": { "domain": "API_FEED", "category": "REQUEST", "description": "The '{fieldName}' is invalid, missing, or not allowed." }, "160036": { "domain": "API_FEED", "category": "REQUEST", "description": "The '{fieldName}' is in the past." }, "160037": { "domain": "API_FEED", "category": "REQUEST", "description": "The 'scheduleEndDate' is before 'scheduleStartDate'." } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "x-response-codes": { "errors": { "1001": { "domain": "API_FEED", "category": "REQUEST", "description": "Invalid access token. Check the value of the Authorization HTTP request header." } } } }, "403": { "description": "Forbidden", "x-response-codes": { "errors": { "160002": { "domain": "API_FEED", "category": "REQUEST", "description": "The authentication scope {scope} is incorrect for 'feed_type' {feedType}. Refer to documentation for details about the scopes." }, "160022": { "domain": "API_FEED", "category": "REQUEST", "description": "You are not allowed to access this resource. Contact eBay Developer Technical Support for assistance." } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict", "x-response-codes": { "errors": { "160031": { "domain": "API_FEED", "category": "BUSINESS", "description": "You have reached the maximum number of subscribed schedules for the 'feedType' {feedType}. To subscribe to another schedule, you must delete one." }, "160035": { "domain": "API_FEED", "category": "BUSINESS", "description": "Duplicate schedule (a matching schedule already exists). Use the getSchedules method to see the existing schedules." }, "160040": { "domain": "API_FEED", "category": "BUSINESS", "description": "The 'scheduleTemplateId' is inactive. You cannot create or modify a schedule with an inactive 'scheduleTemplateId'." } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "x-response-codes": { "errors": { "160001": { "domain": "API_FEED", "category": "APPLICATION", "description": "There was a problem with an eBay internal system or process. Contact eBay Developer Technical Support for assistance." } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "api_auth": [ "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" ], "sell_inventory_scope": [ "https://api.ebay.com/oauth/api_scope/sell.inventory" ] }, { "sell_fulfillment_scope": [ "https://api.ebay.com/oauth/api_scope/sell.fulfillment" ] }, { "sell_marketing_scope": [ "https://api.ebay.com/oauth/api_scope/sell.marketing" ] }, { "commerce_catalog_readonly_scope": [ "https://api.ebay.com/oauth/api_scope/commerce.catalog.readonly" ] }, { "sell_analytics_readonly_scope": [ "https://api.ebay.com/oauth/api_scope/sell.analytics.readonly" ] }, { "ebay_user_scope": [] } ] } }, "/schedule/{schedule_id}": { "get": { "tags": [ "schedule" ], "description": "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.", "operationId": "getSchedule", "parameters": [ { "name": "schedule_id", "in": "path", "description": "This path parameter is the unique identifier of the schedule for which to retrieve details.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.
", "operationId": "updateSchedule", "parameters": [ { "name": "schedule_id", "in": "path", "description": "This path parameter is the unique identifier of the schedule being updated.LMS_ORDER_REPORT.",
"required": true,
"schema": {
"type": "string"
},
"style": "simple",
"explode": false
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ScheduleTemplateResponse"
}
}
}
},
"400": {
"description": "Bad Request"
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"x-response-codes": {
"errors": {
"1001": {
"domain": "API_FEED",
"category": "REQUEST",
"description": "Invalid access token. Check the value of the Authorization HTTP request header."
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"x-response-codes": {
"errors": {
"160002": {
"domain": "API_FEED",
"category": "REQUEST",
"description": "The authentication scope {scope} is incorrect for this API. See the API call reference documentation for the correct scope."
}
}
}
},
"404": {
"description": "Not Found",
"x-response-codes": {
"errors": {
"160039": {
"domain": "API_FEED",
"category": "REQUEST",
"description": "The schedule template ID {schedule_template_id} does not exist. Please provide a valid schedule template ID as contained in the documentation or by calling the getScheduleTemplates method."
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"500": {
"description": "Internal Server Error",
"x-response-codes": {
"errors": {
"160001": {
"domain": "API_FEED",
"category": "APPLICATION",
"description": "There was a problem with an eBay internal system or process. Contact eBay Developer Technical Support for assistance."
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"security": [
{
"api_auth": [
"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"
],
"sell_inventory_scope": [
"https://api.ebay.com/oauth/api_scope/sell.inventory"
]
},
{
"sell_fulfillment_scope": [
"https://api.ebay.com/oauth/api_scope/sell.fulfillment"
]
},
{
"sell_marketing_scope": [
"https://api.ebay.com/oauth/api_scope/sell.marketing"
]
},
{
"commerce_catalog_readonly_scope": [
"https://api.ebay.com/oauth/api_scope/commerce.catalog.readonly"
]
},
{
"sell_analytics_readonly_scope": [
"https://api.ebay.com/oauth/api_scope/sell.analytics.readonly"
]
},
{
"ebay_user_scope": []
}
]
}
},
"/schedule_template": {
"get": {
"tags": [
"schedule_template"
],
"description": "This method retrieves an array containing the details and status of all schedule templates based on the specified feed_type. Use this method to find a schedule template if you do not know the schedule_template_id.",
"operationId": "getScheduleTemplates",
"parameters": [
{
"name": "feed_type",
"in": "query",
"description": "The feed type of the schedule templates to retrieve. LMS_ORDER_REPORT.",
"required": true,
"schema": {
"type": "string"
},
"style": "form",
"explode": true
},
{
"name": "limit",
"in": "query",
"description": "The maximum number of schedule templates that can be returned on each page of the paginated response. Use this parameter in conjunction with the offset parameter to control the pagination of the output. Note: This feature employs a zero-based list, where the first item in the list has an offset of 0.
For example, if offset is set to 10 and limit is set to 10, the call retrieves schedule templates 11 thru 20 from the result set.
If this parameter is omitted, the default value is used.
Default: 10
Maximum: 500",
"required": false,
"schema": {
"type": "integer",
"default": 10
},
"style": "form",
"explode": true
},
{
"name": "offset",
"in": "query",
"description": "The number of schedule templates to skip in the result set before returning the first template in the paginated response.
Combine offset with the limit query parameter to control the items returned in the response. For example, if you supply an offset of 0 and a limit of 10, the first page of the response contains the first 10 items from the complete list of items retrieved by the call. If offset is 10 and limit is 20, the first page of the response contains items 11-30 from the complete result set. If this query parameter is not set, the default value is used and the first page of records is returned.
Default: 0",
"required": false,
"schema": {
"type": "integer",
"default": 0
},
"style": "form",
"explode": true
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ScheduleTemplateCollection"
}
}
}
},
"400": {
"description": "Bad Request",
"x-response-codes": {
"errors": {
"160012": {
"domain": "API_FEED",
"category": "REQUEST",
"description": "The 'limit' value must be greater than zero and less than or equal to 500."
},
"160013": {
"domain": "API_FEED",
"category": "REQUEST",
"description": "The 'offset' value cannot be less than zero."
},
"160017": {
"domain": "API_FEED",
"category": "REQUEST",
"description": "The 'feedType' is missing or invalid."
},
"160029": {
"domain": "API_FEED",
"category": "REQUEST",
"description": "The 'offset' value must be a multiple of the 'limit' value."
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"x-response-codes": {
"errors": {
"1001": {
"domain": "API_FEED",
"category": "REQUEST",
"description": "Invalid access token. Check the value of the Authorization HTTP request header."
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"x-response-codes": {
"errors": {
"160002": {
"domain": "API_FEED",
"category": "REQUEST",
"description": "The authentication scope {scope} is incorrect for this API. See the API call reference documentation for the correct scope."
}
}
}
},
"500": {
"description": "Internal Server Error",
"x-response-codes": {
"errors": {
"160001": {
"domain": "API_FEED",
"category": "APPLICATION",
"description": "There was a problem with an eBay internal system or process. Contact eBay Developer Technical Support for assistance."
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"security": [
{
"api_auth": [
"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"
],
"sell_inventory_scope": [
"https://api.ebay.com/oauth/api_scope/sell.inventory"
]
},
{
"sell_fulfillment_scope": [
"https://api.ebay.com/oauth/api_scope/sell.fulfillment"
]
},
{
"sell_marketing_scope": [
"https://api.ebay.com/oauth/api_scope/sell.marketing"
]
},
{
"commerce_catalog_readonly_scope": [
"https://api.ebay.com/oauth/api_scope/commerce.catalog.readonly"
]
},
{
"sell_analytics_readonly_scope": [
"https://api.ebay.com/oauth/api_scope/sell.analytics.readonly"
]
},
{
"ebay_user_scope": []
}
]
}
},
"/task": {
"get": {
"tags": [
"task"
],
"description": "This method returns the details and status for an array of tasks based on a specified feed_type or schedule_id. Specifying both feed_type and schedule_id results in an error. Since schedules are based on feed types, you can specify a schedule (schedule_id) that returns the needed feed_type.
If specifying the feed_type, limit which tasks are returned by specifying filters, such as the creation date range or period of time using look_back_days. Also, by specifying the feed_type, both on-demand and scheduled reports are returned.
If specifying a schedule_id, the schedule template (that the schedule ID is based on) determines which tasks are returned (see schedule_id for additional information). Each scheduledId applies to one feed_type.",
"operationId": "getTasks",
"parameters": [
{
"name": "feed_type",
"in": "query",
"description": "The feed type associated with the tasks to be returned. Only use a feedType that is available for your API:
LMS_ORDER_ACK, LMS_ORDER_REPORTLMS_ORDER_REPORT.date_range parameter. If both date_range and look_back_days are omitted, this parameter's default value is used. Note: Maximum date range window size is 90 days.
yyyy-MM-ddThh:mm:ss.SSSZ..yyyy-MM-ddThh:mm:ss.SSSZ 2019-09-08T00:00:00.000Z..2019-09-09T00:00:00.000Z",
"required": false,
"schema": {
"type": "string"
},
"style": "form",
"explode": true
},
{
"name": "limit",
"in": "query",
"description": "The maximum number of tasks that can be returned on each page of the paginated response. Use this parameter in conjunction with the offset parameter to control the pagination of the output. Note: This feature employs a zero-based list, where the first item in the list has an offset of 0.
For example, if offset is set to 10 and limit is set to 10, the call retrieves tasks 11 thru 20 from the result set.
If this parameter is omitted, the default value is used.
Default: 10
Maximum: 500",
"required": false,
"schema": {
"type": "integer",
"default": 10
},
"style": "form",
"explode": true
},
{
"name": "offset",
"in": "query",
"description": "The number of tasks to skip in the result set before returning the first task in the paginated response.
Combine offset with the limit query parameter to control the items returned in the response. For example, if you supply an offset of 0 and a limit of 10, the first page of the response contains the first 10 items from the complete list of items retrieved by the call. If offset is 10 and limit is 20, the first page of the response contains items 11-30 from the complete result set. If this query parameter is not set, the default value is used and the first page of records is returned.
Default: 0",
"required": false,
"schema": {
"type": "integer",
"default": 0
},
"style": "form",
"explode": true
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TaskCollection"
}
}
}
},
"400": {
"description": "Bad Request",
"x-response-codes": {
"errors": {
"160004": {
"domain": "API_FEED",
"category": "REQUEST",
"description": "You must submit either a 'feed_type' or 'schedule_id'."
},
"160005": {
"domain": "API_FEED",
"category": "REQUEST",
"description": "Both 'feed_type' and 'schedule_id' were provided. Please remove one of them."
},
"160006": {
"domain": "API_FEED",
"category": "REQUEST",
"description": "The 'feed_type' {feedTypeValue} is invalid."
},
"160007": {
"domain": "API_FEED",
"category": "REQUEST",
"description": "The 'schedule_id' {scheduleID} is invalid."
},
"160008": {
"domain": "API_FEED",
"category": "REQUEST",
"description": "Both 'look_back_days' and 'date_range' were provided. Please remove one of them."
},
"160009": {
"domain": "API_FEED",
"category": "REQUEST",
"description": "The format of the 'date_range' is invalid. The format for a date range is yyyy-MM-ddThh:mm:ss.SSSZ..yyyy-MM-ddThh:mm:ss.SSSZ."
},
"160010": {
"domain": "API_FEED",
"category": "REQUEST",
"description": "The 'date_range' must be less than or equal to 90 days."
},
"160011": {
"domain": "API_FEED",
"category": "REQUEST",
"description": "The 'look_back_days' value must be greater than zero and less than or equal to 90."
},
"160012": {
"domain": "API_FEED",
"category": "REQUEST",
"description": "The 'limit' value must be greater than zero and less than or equal to 500."
},
"160013": {
"domain": "API_FEED",
"category": "REQUEST",
"description": "The 'offset' value cannot be less than zero."
},
"160016": {
"domain": "API_FEED",
"category": "REQUEST",
"description": "The 'date_range' value is not valid. Ensure that the beginning of the range is before the end of the range."
},
"160029": {
"domain": "API_FEED",
"category": "REQUEST",
"description": "The 'offset' value must be a multiple of the 'limit' value."
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"x-response-codes": {
"errors": {
"1001": {
"domain": "API_FEED",
"category": "REQUEST",
"description": "Invalid access token. Check the value of the Authorization HTTP request header."
}
}
}
},
"403": {
"description": "Forbidden",
"x-response-codes": {
"errors": {
"160002": {
"domain": "API_FEED",
"category": "REQUEST",
"description": "The authentication scope {scope} is incorrect for 'feed_type' {feedType}. Refer to documentation for details about the scopes."
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"500": {
"description": "Internal Server Error",
"x-response-codes": {
"errors": {
"160001": {
"domain": "API_FEED",
"category": "APPLICATION",
"description": "There was a problem with an eBay internal system or process. Contact eBay Developer Technical Support for assistance."
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"security": [
{
"api_auth": [
"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"
],
"sell_inventory_scope": [
"https://api.ebay.com/oauth/api_scope/sell.inventory"
]
},
{
"sell_fulfillment_scope": [
"https://api.ebay.com/oauth/api_scope/sell.fulfillment"
]
},
{
"sell_marketing_scope": [
"https://api.ebay.com/oauth/api_scope/sell.marketing"
]
},
{
"commerce_catalog_readonly_scope": [
"https://api.ebay.com/oauth/api_scope/commerce.catalog.readonly"
]
},
{
"sell_analytics_readonly_scope": [
"https://api.ebay.com/oauth/api_scope/sell.analytics.readonly"
]
},
{
"sell_managed_fulfillment_scope": []
},
{
"ebay_user_scope": []
}
]
},
"post": {
"tags": [
"task"
],
"description": "This method creates an upload task or a download task without filter criteria. When using this method, specify the feedType and the feed file schemaVersion. The feed type specified sets the task as a download or an upload task.
For details about the upload and download flows, see Working with Order Feeds in the Selling Integration Guide.
Note: The scope depends on the feed type. An error message results when an unsupported scope or feed type is specified.
The following list contains this method's authorization scopes and their corresponding feed types:
* Reserved for future release
", "operationId": "createTask", "parameters": [ { "name": "X-EBAY-C-MARKETPLACE-ID", "in": "header", "description": "The ID of the eBay marketplace where the item is hosted.X-EBAY-C-MARKETPLACE-ID:EBAY_USEBAY_CA and include the Accept-Language header with a value of fr-CA.EBAY_BE and include the Accept-Language header with a value of fr-BE.EBAY_CA and include the Accept-Language header with a value of fr-CA.EBAY_BE and include the Accept-Language header with a value of fr-BE.Note: With respect to LMS, this method applies to all feed types except LMS_ORDER_REPORT and LMS_ACTIVE_INVENTORY_REPORT. See LMS API Feeds in the Selling Integration Guide.
For details about how this method is used, see Working with Order Feeds in the Selling Integration Guide.
Note: The status of the task to retrieve must be in the COMPLETED or COMPLETED_WITH_ERROR state before this method can retrieve the file. You can use the getTask or getTasks method to retrieve the status of the task.
QUEUED > IN_PROCESS > COMPLETED or COMPLETED_WITH_ERROR. When the status is COMPLETED or COMPLETED_WITH_ERROR, this indicates the file has been processed and the order report can be downloaded. If there are errors, they will be indicated in the report file. fileName: "AddFixedPriceItem_Macbook.xml"See Samples for information.
name: "file"
type: "form-data"
file: @"/C:/Users/.../AddFixedPriceItem_Macbook.7z"
Note: This method applies to all Seller Hub feed types, and to all LMS feed types except LMS_ORDER_REPORT and LMS_ACTIVE_INVENTORY_REPORT.
Note: You must use a Content-Type header with its value set to \"multipart/form-data\". See Samples for information.
Note: For LMS feed types, upload a regular XML file or an XML file in zipped format (both formats are allowed).
", "operationId": "uploadFile", "parameters": [ { "name": "task_id", "in": "path", "description": "This path parameter is the unique identifier of the task associated with the file that will be uploaded. Note: You can pass in either the look_back_days or date_range, but not both.
Use this method to create a customer service metrics download task with filter criteria for the customer service metrics report. When using this method, specify the feedType and filterCriteria including both evaluationMarketplaceId and customerServiceMetricType for the report. The method returns the location response header containing the call URI to use with getCustomerServiceMetricTask to retrieve status and details on the task.
Only CURRENT Customer Service Metrics reports can be generated with the Sell Feed API. PROJECTED reports are not supported at this time. See the getCustomerServiceMetric method document in the Analytics API for more information about these two types of reports.
Note: Before calling this API, retrieve the summary of the seller's performance and rating for the customer service metric by calling getCustomerServiceMetric (part of the Analytics API). You can then populate the create task request fields with the values from the response. This technique eliminates failed tasks that request a report for a customerServiceMetricType and evaluationMarketplaceId that are without evaluation.
", "operationId": "createCustomerServiceMetricTask", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Use this header to specify the natural language in which the authenticated user desires the response. For example,en-US for English or de-DE for German.",
"required": true,
"schema": {
"type": "string"
},
"style": "simple",
"explode": false
},
{
"name": "Content-Type",
"in": "header",
"description": "This header indicates the format of the request body provided by the client. Its value should be set to application/json.",
"required": true,
"schema": {
"type": "string"
},
"style": "simple",
"explode": false
}
],
"requestBody": {
"description": "Request payload containing version, feedType, and optional filterCriteria.",
"content": {
"application/json": {
"schema": {
"description": "Request payload containing version, feedType, and optional filterCriteria.",
"$ref": "#/components/schemas/CreateServiceMetricsTaskRequest"
}
}
},
"required": true
},
"responses": {
"202": {
"description": "Accepted",
"headers": {
"Location": {
"description": "The location response header contains the getCustomerServiceMetricTask call URI that you can use to retrieve the customer service metric task just created.",
"style": "simple",
"explode": false,
"schema": {
"type": "string"
}
}
}
},
"400": {
"description": "Bad Request",
"x-response-codes": {
"errors": {
"160017": {
"domain": "API_FEED",
"category": "REQUEST",
"description": "The 'feedType' is missing or invalid."
},
"160018": {
"domain": "API_FEED",
"category": "REQUEST",
"description": "The 'schemaVersion' is invalid."
},
"160024": {
"domain": "API_FEED",
"category": "REQUEST",
"description": "You have reached the maximum number of feed tasks that can be queued or processed concurrently. Wait for current tasks to complete before adding tasks. For more information, see the documentation for this API."
},
"160025": {
"domain": "API_FEED",
"category": "REQUEST",
"description": "You have exceeded the maximum number of feed tasks that can be created or processed in a given period (hour or day). Wait until the present period ends before adding tasks. For more information, see the documentation for this API."
},
"164500": {
"domain": "API_FEED",
"category": "REQUEST",
"description": "The 'customerServiceMetricType' in 'filterCriteria' is not a valid type. Valid metric types are ITEM_NOT_AS_DESCRIBED or ITEM_NOT_RECEIVED."
},
"164501": {
"domain": "API_FEED",
"category": "REQUEST",
"description": "The 'evaluationMarketplaceId' in 'filterCriteria' is not a supported marketplace. For a complete list of the supported marketplace IDs, see the documentation."
},
"164502": {
"domain": "API_FEED",
"category": "REQUEST",
"description": "The 'listingCategories' in 'filterCriteria' or some part of the 'listingCategories' is invalid. {additionalInfo}"
},
"164503": {
"domain": "API_FEED",
"category": "REQUEST",
"description": "The 'shippingRegions' in 'filterCriteria' or some part of the 'shippingRegions' is invalid. {additionalInfo}"
},
"164504": {
"domain": "API_FEED",
"category": "REQUEST",
"description": "The Accept-Language header is missing or invalid."
},
"164505": {
"domain": "API_FEED",
"category": "REQUEST",
"description": "The 'filterCriteria' is missing or invalid."
},
"164506": {
"domain": "API_FEED",
"category": "REQUEST",
"description": "The 'listingCategories' is not applicable to the 'customerServiceMetricType' {customerServiceMetricType} in 'filterCriteria'."
},
"164507": {
"domain": "API_FEED",
"category": "REQUEST",
"description": "The 'shippingRegions' is not applicable to the 'customerServiceMetricType' {customerServiceMetricType} in 'filterCriteria'."
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"x-response-codes": {
"errors": {
"1001": {
"domain": "API_FEED",
"category": "REQUEST",
"description": "Invalid access token. Check the value of the Authorization HTTP request header."
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"x-response-codes": {
"errors": {
"1100": {
"domain": "API_FEED",
"category": "REQUEST",
"description": "Insufficient permissions to fulfill the request."
}
}
}
},
"409": {
"description": "Business Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"x-response-codes": {
"errors": {
"160024": {
"domain": "API_FEED",
"category": "BUSINESS",
"description": "You have reached the maximum number of feed tasks that can be queued or processed concurrently. Wait for current tasks to complete before adding tasks. For more information, see the documentation for this API."
},
"160025": {
"domain": "API_FEED",
"category": "BUSINESS",
"description": "You have exceeded the maximum number of feed tasks that can be created or processed in a given period (hour or day). Wait until the present period ends before adding tasks. For more information, see the documentation for this API."
}
}
}
},
"500": {
"description": "Internal Server Error",
"x-response-codes": {
"errors": {
"160001": {
"domain": "API_FEED",
"category": "APPLICATION",
"description": "There was a problem with an eBay internal system or process. Contact eBay Developer Technical Support for assistance."
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"security": [
{
"api_auth": [
"https://api.ebay.com/oauth/api_scope/sell.analytics.readonly"
]
}
]
}
},
"/customer_service_metric_task/{task_id}": {
"get": {
"tags": [
"customer_service_metric_task"
],
"description": "Use this method to retrieve customer service metric task details for the specified task. The input is task_id.
", "operationId": "getCustomerServiceMetricTask", "parameters": [ { "name": "task_id", "in": "path", "description": "This path parameter is the unique identifier of the customer service metric task being retrieved.LMS_ACTIVE_INVENTORY_REPORT1.0."
}
},
"description": "This type defines inventory-related download task request fields."
},
"CreateOrderTaskRequest": {
"type": "object",
"required": [
"feedType",
"schemaVersion"
],
"properties": {
"feedType": {
"type": "string",
"description": "The feed type associated with the task. The only presently supported value is LMS_ORDER_REPORT.LMS_ORDER_REPORT feed type, see the OrderReport reference page to see the present schema version. The schemaVersion value is the version number shown at the top of the OrderReport page. CUSTOMER_SERVICE_METRICS_REPORT
1.0."
}
},
"description": "The type that defines the fields for the Customer Service Metric reports generated with the Feed API."
},
"CreateTaskRequest": {
"type": "object",
"required": [
"feedType",
"schemaVersion"
],
"properties": {
"feedType": {
"type": "string",
"description": "The feed type associated with the task. Available feed types:LMS_ORDER_REPORT."
},
"preferredTriggerDayOfMonth": {
"type": "integer",
"description": "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 than the actual number of days in the month. hhZ11Z"
},
"scheduleEndDate": {
"type": "string",
"description": "The timestamp on which the report generation (subscription) ends. After this date, the schedule status becomes INACTIVE. yyyy-MM-ddTHHZ2021-10-10T10Z"
},
"scheduleName": {
"type": "string",
"description": "The schedule name assigned by the user for the created schedule."
},
"scheduleStartDate": {
"type": "string",
"description": "The timestamp to start generating the report. After this timestamp, the schedule status becomes active until either the scheduleEndDate occurs or the scheduleTemplateId becomes inactive. yyyy-MM-ddTHHZ 2020-01-01T12Z"
},
"scheduleTemplateId": {
"type": "string",
"description": "The unique identifier of the template to be used for this schedule. ACTIVE.LMS_ORDER_REPORT."
},
"schemaVersion": {
"type": "string",
"description": "The schema version of a schedule."
}
},
"description": "The type that defines the fields for the createSchedule method.",
"allOf": [
{
"$ref": "#/components/schemas/UpdateUserScheduleRequest"
},
{
"type": "object",
"properties": {
"scheduleTemplateId": {
"type": "string",
"description": "The unique identifier of the template to be used for this schedule."
},
"feedType": {
"type": "string",
"description": "The name of the feed type for the created schedule."
}
}
}
]
},
"CustomerServiceMetricTaskCollection": {
"type": "object",
"required": [
"href",
"limit",
"offset",
"tasks",
"total"
],
"properties": {
"href": {
"type": "string",
"description": "The URI of the current page of results."
},
"limit": {
"type": "integer",
"description": "The value of the limit parameter submitted in the request, which is the maximum number of tasks to return per page, from the result set. A result set is the complete set of tasks returned by the method. Note: Even though this parameter is not required to be submitted in the request, the parameter defaults to 10 if omitted.
Note: If this is the last or only page of the result set, the page may contain fewer tasks than the limit value. To determine the number of pages in a result set, divide the total value (total number of tasks matching input criteria) by this limit value, and then round up to the next integer. For example, if the total value was 120 (120 total tasks) and the limit value was 50 (show 50 tasks per page), the total number of pages in the result set is three, so the seller would have to make three separate getCustomerServiceMetricTasks calls to view all tasks matching the input criteria.
Note: The items in a paginated result set use a zero-based list where the first item in the list has an offset of 0.
Note: Pass this attribute to narrow down your filter results for the ITEM_NOT_AS_DESCRIBED customerServiceMetricType.
Supported categories include:
primary(L1) category Id
Note: Pass this attribute to narrow down your filter results for the ITEM_NOT_RECEIVED customerServiceMetricType.
Supported categories include:
primary(L1) category Id
yyyy-MM-ddThh:mm:ss.SSSZ yyyy-MM-ddThh:mm:ss.SSSZ..yyyy-MM-ddThh:mm:ss.SSSZ 2021-03-31T00:00:00.000Z..2021-03-31T00:00:00.000Z "
},
"to": {
"type": "string",
"description": "The end date for the date range, which is inclusive. If the parent type is included, both the from and the to fields become conditionally required. yyyy-MM-ddThh:mm:ss.SSSZ..yyyy-MM-ddThh:mm:ss.SSSZ 2021-03-31T00:00:00.000Z..2021-03-31T00:00:00.000Z "
}
},
"description": "This type defines the fields for a date range."
},
"DayOfWeekEnum": {
"type": "string",
"description": "An enumerated type defining the days of the week. | - **SUN**: Indicates Sunday - **MON**: Indicates Monday - **TUE**: Indicates Tuesday - **WED**: Indicates Wednesday - **THU**: Indicates Thursday - **FRI**: Indicates Friday - **SAT**: Indicates Saturday",
"enum": [
"SUN",
"MON",
"TUE",
"WED",
"THU",
"FRI",
"SAT"
]
},
"Error": {
"type": "object",
"properties": {
"category": {
"type": "string",
"description": "Identifies the type of error.",
"enum": [
"APPLICATION",
"BUSINESS",
"REQUEST"
]
},
"domain": {
"type": "string",
"description": "Name for the primary system where the error occurred. This is relevant for application errors."
},
"errorId": {
"type": "integer",
"description": "A unique number to identify the error.",
"format": "int64"
},
"inputRefIds": {
"type": "array",
"description": "An array of request elements most closely associated to the error.",
"items": {
"type": "string"
}
},
"longMessage": {
"type": "string",
"description": "A more detailed explanation of the error."
},
"message": {
"type": "string",
"description": "Information on how to correct the problem, in the end user's terms and language where applicable."
},
"outputRefIds": {
"type": "array",
"description": "An array of request elements most closely associated to the error.",
"items": {
"type": "string"
}
},
"parameters": {
"type": "array",
"description": "An array of name/value pairs that describe details the error condition. These are useful when multiple errors are returned.",
"items": {
"$ref": "#/components/schemas/ErrorParameter"
}
},
"subdomain": {
"type": "string",
"description": "Further helps indicate which subsystem the error is coming from. System subcategories include: Initialization, Serialization, Security, Monitoring, Rate Limiting, etc."
}
},
"description": "This type defines the fields that can be returned in an error.",
"required": [
"category",
"domain",
"errorId",
"message"
]
},
"ErrorParameter": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The object of the error.",
"examples": [
"categoryId"
]
},
"value": {
"type": "string",
"description": "The value of the object.",
"examples": [
"1234"
]
}
},
"description": "A complex type that contains context-specific error parameter information."
},
"FeedStatusEnum": {
"type": "string",
"description": "An enumerated type for the values that represent the state of the task. | - **CREATED**: Indicates the task has been created. - **QUEUED**: Indicates the task has been added to the queue. - **IN_PROCESS**: Indicates the task is being processed. - **COMPLETED**: Indicates the task has finished being processed. - **COMPLETED_WITH_ERROR**: Indicates the task has completed but there are errors. If there are errors, they will be indicated in the report. - **FAILED**: Indicates the task has failed to complete. - **PARTIALLY_PROCESSED**: Indicates the task has failed to complete but was partially processed.",
"enum": [
"CREATED",
"QUEUED",
"IN_PROCESS",
"COMPLETED",
"COMPLETED_WITH_ERROR",
"FAILED",
"PARTIALLY_PROCESSED"
]
},
"FrequencyEnum": {
"type": "string",
"description": "An enumerated type for the values that represent the frequency (specified by the template) for triggering the schedule. | - **HALF_HOUR**: Triggered every 30 minutes (every half hour) - **ONE_HOUR**: Triggered every 60 minutes (every hour) - **FOUR_HOURS**: Triggered every 240 minutes (every four hours) - **EIGHT_HOURS**: Triggered every 480 minutes (every eight hours) - **DAILY**: Triggered every 1440 minutes (every day) - **WEEKLY**: Triggered every 10080 minutes (every week) - **MONTHLY**: Triggered every month - **QUARTERLY**: Triggered every quarter (3 months)",
"enum": [
"HALF_HOUR",
"ONE_HOUR",
"FOUR_HOURS",
"EIGHT_HOURS",
"DAILY",
"WEEKLY",
"MONTHLY",
"QUARTERLY"
]
},
"InputStream": {
"type": "object",
"description": "File stream"
},
"InventoryFilterCriteria": {
"type": "object",
"properties": {
"listingFormat": {
"description": "The listing format for the ActiveInventoryReport being created. Supported types are:AUCTIONFIXED_PRICECOMPLETED, COMPLETED_WITH_ERROR, or PARTIALLY_PROCESSED state. This field is only returned if the status is one of the three completed values."
},
"schemaVersion": {
"type": "string",
"description": "The schema version number associated with the task."
},
"detailHref": {
"type": "string",
"description": "The path to the call URI used to retrieve the task. This field points to the getInventoryTask URI."
},
"uploadSummary": {
"description": "This container provides summary information on an upload feed (not applicable for download feed types).",
"$ref": "#/components/schemas/UploadSummary"
},
"filterCriteria": {
"description": "This container is used to set the filter criteria for the ActiveInventoryReport. A seller can retrieve listings for a specified format.",
"$ref": "#/components/schemas/InventoryFilterCriteria"
}
}
},
"InventoryTaskCollection": {
"type": "object",
"required": [
"href",
"limit",
"offset",
"tasks",
"total"
],
"description": "This container is used to hold the inventory tasks returned by the method.",
"properties": {
"href": {
"type": "string",
"description": "The path to the call URI that produced the current page of results."
},
"limit": {
"type": "integer",
"description": "The value of the limit parameter submitted in the request, which is the maximum number of inventory tasks to return per page, from the result set. A result set is the complete set of tasks returned by the method.10 if omitted. Additionally, if this is the last or only page of the result set, the page may contain fewer tasks than the limit value submitted in the request.120 (120 total tasks) and the limit value was 50 (show 50 tasks per page), the total number of pages in the result set is three, so the seller would have to make three separate getInventoryTasks calls to view all tasks matching the input criteria.",
"format": "int32"
},
"next": {
"type": "string",
"description": "The path to the call URI for the next page of results. This value is returned if there is an additional page of results to return from the result set."
},
"offset": {
"type": "integer",
"description": "The number of results skipped in the result set before listing the first returned result. This value can be specified in the request with the offset query parameter.0.",
"format": "int32"
},
"prev": {
"type": "string",
"description": "The path to the call URI for the previous page of results. This is returned if there is a previous page of results from the result set."
},
"tasks": {
"type": "array",
"description": "An array of the inventory tasks on this page. The tasks are sorted by creation date.Note: This container is for future use. At this time, the createOrderTask method only supports order creation date filters and not modified order date filters.
", "$ref": "#/components/schemas/DateRange" }, "orderStatus": { "description": "The order status of the orders returned. If the filter is omitted from the createOrderTask call, orders that are in bothACTIVE and COMPLETED states are returned.",
"$ref": "#/components/schemas/OrderStatusEnum"
}
},
"description": "The type that defines the fields for the order filters."
},
"OrderStatusEnum": {
"type": "string",
"description": "An enumerated type for the values that represent the state of the order. This is used by Large Merchant Services (LMS) sellers only. | - **ACTIVE**: Indicates the buyer has not paid for the order. - **COMPLETED**: Indicates the buyer has paid for the order and checkout is complete.",
"enum": [
"ACTIVE",
"COMPLETED"
]
},
"OrderTask": {
"type": "object",
"required": [
"creationDate",
"detailHref",
"feedType",
"schemaVersion",
"status",
"taskId"
],
"properties": {
"completionDate": {
"type": "string",
"description": "The timestamp when the task went into the COMPLETED or COMPLETED_WITH_ERROR state. This state means that eBay has compiled the report for the seller based on the seller's filter criteria, and the seller can run a getResultFile call to download the report."
},
"creationDate": {
"type": "string",
"description": "The date the task was created."
},
"detailHref": {
"type": "string",
"description": "The path to the call URI used to retrieve the task."
},
"feedType": {
"type": "string",
"description": "The feed type associated with the task."
},
"filterCriteria": {
"description": "A container that returns the filter criteria used.",
"$ref": "#/components/schemas/OrderFilterCriteria"
},
"schemaVersion": {
"type": "string",
"description": "The schema version number associated with the create task."
},
"status": {
"description": "The enumeration value that indicates the state of the task that was submitted in the request. See FeedStatusEnum for information. The values COMPLETED and COMPLETED_WITH_ERROR indicate the Order Report file is ready to download.
Note: Though this parameter is not required to be submitted in the request, the parameter defaults to 10 if omitted.
Note: If this is the last or only page of the result set, the page may contain fewer tasks than the limit value. To determine the number of pages in a result set, divide the total value (total number of tasks matching input criteria) by this limit value, and then round up to the next integer. For example, if the total value was 120 (120 total tasks) and the limit value was 50 (show 50 tasks per page), the total number of pages in the result set is three, so the seller would have to make three separate getOrderTasks calls to view all tasks matching the input criteria.
Note: The items in a paginated result set use a zero-based list where the first item in the list has an offset of 0.
Note: Though this parameter is not required to be submitted in the request, the parameter defaults to 10 if omitted.
Note: If this is the last or only page of the result set, the page may contain fewer tasks than the limit value. To determine the number of pages in a result set, divide the total value (total number of tasks matching input criteria) by this limit value, and then round up to the next integer. For example, if the total value was 120 (120 total tasks) and the limit value was 50 (show 50 tasks per page), the total number of pages in the result set is three, so the seller would have to make three separate getScheduleTemplates calls to view all tasks matching the input criteria.
Note: The items in a paginated result set use a zero-based list where the first item in the list has an offset of 0.
Note: When calling createSchedule and updateSchedule methods, you must match the feed type specified by the schedule template (this feedType).
" }, "frequency": { "description": "This field specifies how often the schedule is generated. If set toHALF_HOUR or ONE_HOUR, you cannot set a preferredTriggerHour using createSchedule or updateSchedule.",
"$ref": "#/components/schemas/FrequencyEnum"
},
"name": {
"type": "string",
"description": "The template name provided by the template."
},
"scheduleTemplateId": {
"type": "string",
"description": "The ID of the template. Use this ID to create a schedule based on the properties of this schedule template."
},
"status": {
"description": "The present status of the template. You cannot create or modify a schedule using a template with an INACTIVE status. ",
"$ref": "#/components/schemas/StatusEnum"
},
"supportedConfigurations": {
"type": "array",
"description": "An array of the configuration supported by this template.",
"items": {
"$ref": "#/components/schemas/SupportedConfiguration"
}
}
},
"description": "The type that defines the fields for a paginated result set of available schedule templates. The response consists of 0 or more sequenced pages where each page has 0 or more items."
},
"ServiceMetricsTask": {
"type": "object",
"required": [
"creationDate",
"detailHref",
"feedType",
"filterCriteria",
"schemaVersion",
"status",
"taskId"
],
"properties": {
"completionDate": {
"type": "string",
"description": "The timestamp when the customer service metrics task went into the COMPLETED or COMPLETED_WITH_ERROR state. This field is only returned if the status is one of the two completed values. This state means that eBay has compiled the report for the seller based on the seller's filter criteria, and the seller can run a getResultFile call to download the report."
},
"creationDate": {
"type": "string",
"description": "The date the customer service metrics task was created."
},
"detailHref": {
"type": "string",
"description": "The relative getCustomerServiceMetricTask call URI path to retrieve the corresponding task."
},
"feedType": {
"type": "string",
"description": "The feed type associated with the task."
},
"filterCriteria": {
"description": "This container shows the criteria set for the report.",
"$ref": "#/components/schemas/CustomerServiceMetricsFilterCriteria"
},
"schemaVersion": {
"type": "string",
"description": "The schema version number of the file format. If omitted, the default value is used. Default value: 1.0
"
},
"status": {
"description": "An enumeration value that indicates the state of the task.",
"$ref": "#/components/schemas/FeedStatusEnum"
},
"taskId": {
"type": "string",
"description": "The unique eBay-assigned ID of the task."
}
},
"description": "This type defines customer service metric task response fields."
},
"ShippingRegionTypeEnum": {
"type": "string",
"description": "This enumerated type lists the types that are available for Shipping Regions. | - **DOMESTIC**: Listing and Item Shipped market places are the same. - **INTERNATIONAL_MATURED_REGION**: Items are shipped outside of the listing marketplace and shipped to one of the countries described in the policy page. https://www.ebay.com/help/selling/selling/monitor-service-metrics?id=4785#section4 - **INTERNATIONAL_EMERGING_REGION**: Items are shipped outside of the listing marketplace and shipped to countries which are not part of the International Mature region. https://www.ebay.com/help/selling/selling/monitor-service-metrics?id=4785#section4",
"enum": [
"DOMESTIC",
"INTERNATIONAL_MATURED_REGION",
"INTERNATIONAL_EMERGING_REGION"
]
},
"StatusEnum": {
"type": "string",
"description": "This enumeration value indicates the state of the schedule template. | - **ACTIVE**: Indicates the buyer has not paid for the order. - **INACTIVE**: Indicates the buyer has paid for the order and checkout is complete.",
"enum": [
"ACTIVE",
"INACTIVE"
]
},
"StatusReasonEnum": {
"type": "string",
"description": "The enumeration value that indicates the reason the schedule template is INACTIVE. | - **SCHEDULE_END_DATE_REACHED**: The active period for the schedule template has expired. Use the getScheduleTemplates method to find available active templates. - **DISABLED_TEMPLATE**: The template was disabled. Use the getScheduleTemplates method to find available active templates.",
"enum": [
"SCHEDULE_END_DATE_REACHED",
"DISABLED_TEMPLATE"
]
},
"StreamingOutput": {
"type": "object",
"description": "The file stream for the generated report."
},
"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:
yyyy-MM-ddTHHZyyyy-MM-ddTHHZhhZCOMPLETED or COMPLETED_WITH_ERROR state. This state means that eBay has compiled the report for the seller based on the seller's filter criteria, and the seller can run a getResultFile call to download the report."
},
"creationDate": {
"type": "string",
"description": "The date the task was created."
},
"detailHref": {
"type": "string",
"description": "The path to the call URI used to retrieve the task. This field points to the GetOrderTask URI if the task is for LMS_ORDER_REPORT, or it will be null if this task is for LMS_ORDER_ACK."
},
"feedType": {
"type": "string",
"description": "The feed type associated with the task."
},
"schemaVersion": {
"type": "string",
"description": "The schema version number associated with the task."
},
"status": {
"description": "The enumeration value that indicates the state of the task that was submitted in the request. See FeedStatusEnum for information. The values COMPLETED and COMPLETED_WITH_ERROR indicate the Order Report file is ready to download.
Note: Though this parameter is not required to be submitted in the request, the parameter defaults to 10 if omitted.
Note: If this is the last or only page of the result set, the page may contain fewer tasks than the limit value. To determine the number of pages in a result set, divide the total value (total number of tasks matching input criteria) by this limit value, and then round up to the next integer. For example, if the total value was 120 (120 total tasks) and the limit value was 50 (show 50 tasks per page), the total number of pages in the result set is three, so the seller would have to make three separate getTasks calls to view all tasks matching the input criteria.
Note: The items in a paginated result set use a zero-based list where the first item in the list has an offset of 0.
hhZ11Z00Z23Z"
},
"scheduleEndDate": {
"type": "string",
"description": "The timestamp on which the schedule (report generation) ends. After this date, the schedule status becomes INACTIVE. yyyy-MM-ddTHHZ 2021-10-10T10Z"
},
"scheduleName": {
"type": "string",
"description": "The schedule name assigned by the user for the created schedule."
},
"scheduleStartDate": {
"type": "string",
"description": "The timestamp to start generating the report. After this timestamp, the schedule status becomes active until either the scheduleEndDate occurs or the scheduleTemplateId becomes inactive. yyyy-MM-ddTHHZ 2020-01-01T12Z"
},
"schemaVersion": {
"type": "string",
"description": "The schema version of a schedule."
}
},
"description": "The type that defines the fields for a schedule update to a schedule generated with the Feed API."
},
"UploadSummary": {
"type": "object",
"properties": {
"failureCount": {
"type": "integer",
"description": "The number of records, such as the number of listings created or the number of pictures uploaded to a listing, that failed to process during the upload feed. Check the response file and correct any issues mentioned. If the feed fails before processing, no response file is provided. In this case, check the REST output response.",
"format": "int32"
},
"successCount": {
"type": "integer",
"description": "The number of records that were successfully processed during the upload feed.",
"format": "int32"
}
},
"description": "This container provides summary information on an upload feed (not applicable for download feed types)."
},
"UserScheduleCollection": {
"type": "object",
"required": [
"href",
"limit",
"offset",
"schedules"
],
"properties": {
"href": {
"type": "string",
"description": "The path to the call URI that produced the current page of results."
},
"limit": {
"type": "integer",
"description": "The value of the limit parameter submitted in the request, which is the maximum number of schedules to return per page, from the result set. A result set is the complete set of schedules returned by the method. Note: Though this parameter is not required to be submitted in the request, the parameter defaults to 10 if omitted. Note: If this is the last or only page of the result set, the page may contain fewer tasks than the limit value. To determine the number of pages in a result set, divide the total value (total number of tasks matching input criteria) by this limit value, and then round up to the next integer. For example, if the total value was 120 (120 total tasks) and the limit value was 50 (show 50 tasks per page), the total number of pages in the result set is three, so the seller would have to make three separate getSchedules calls to view all tasks matching the input criteria.
Note: The items in a paginated result set use a zero-based list where the first item in the list has an offset of 0.
hhZ11Z"
},
"scheduleEndDate": {
"type": "string",
"description": "The timestamp on which the report generation (subscription) ends. After this date, the schedule status becomes INACTIVE."
},
"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": {
"description": "The enumeration value that indicates the state of the schedule.",
"$ref": "#/components/schemas/StatusEnum"
},
"statusReason": {
"description": "The reason the schedule is inactive.",
"$ref": "#/components/schemas/StatusReasonEnum"
}
},
"description": "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."
},
"ErrorResponse": {
"type": "object",
"description": "Error response with all error details in COS/ETS format.",
"properties": {
"errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ErrorDetail"
}
}
}
},
"ErrorDetail": {
"type": "object",
"description": "An instance of an error or warning as defined by the COS/ETS error handling standard.",
"properties": {
"errorId": {
"type": "integer",
"format": "int64",
"description": "uniquely identifying the error within its Domain.",
"examples": [
10001
]
},
"domain": {
"type": "string",
"description": "The domain your service/application is in",
"examples": [
"Selling"
]
},
"subdomain": {
"type": "string",
"description": "Name of the subsystem or subdivision of the domain",
"examples": [
"Seller Marketing"
]
},
"category": {
"type": "string",
"description": "The error's type, with allowed values APPLICATION, BUSINESS, or REQUEST",
"examples": [
"REQUEST"
]
},
"message": {
"type": "string",
"description": "A device agnostic message that is end user and app developer friendly. It should explain what the error or warning is, and how it can be fixed (in a general sense). The value MUST be limited to 50 or fewer characters. If applicable, it must also be localized in the end user's requested locale. Refer to Section 6, Error Message Content and Localization.",
"examples": [
"Bad Request"
]
},
"longMessage": {
"type": "string",
"description": "An expanded version of message that SHOULD be limited to about 100-200 characters.",
"examples": [
"Bad Request. Invalid Sale Format"
]
},
"inputRefIds": {
"type": "array",
"description": "Identifies specific request elements associated with the error, if any. inputRefId's response is format specific. For XML, use XPath notation. For JSON, use JSONPath notation.",
"items": {
"type": "string"
}
},
"outputRefIds": {
"type": "array",
"description": "Identifies specific response elements associated with the error, if any. Path format is the same as inputRefId.",
"items": {
"type": "string"
}
},
"parameters": {
"type": "array",
"description": "Used to specify information relevant to the end user/client.",
"items": {
"$ref": "#/components/schemas/ErrorParameter"
}
}
}
}
},
"securitySchemes": {
"api_auth": {
"type": "oauth2",
"description": "The security definitions for this API. Please check individual operations for applicable scopes.",
"flows": {
"authorizationCode": {
"authorizationUrl": "https://auth.ebay.com/oauth2/authorize",
"tokenUrl": "https://api.ebay.com/identity/v1/oauth2/token",
"scopes": {
"https://api.ebay.com/oauth/api_scope/sell.fulfillment": "View and manage your order fulfillments",
"https://api.ebay.com/oauth/api_scope/commerce.catalog.readonly": " This scope would allow signed in user to read catalog data.",
"https://api.ebay.com/oauth/api_scope/sell.inventory": "View and manage your inventory and offers",
"https://api.ebay.com/oauth/api_scope/sell.marketing": "View and manage your eBay marketing activities, such as ad campaigns and listing promotions",
"https://api.ebay.com/oauth/api_scope/sell.analytics.readonly": "Read-only access to Analytics API",
"eBayUser": "eBay user access scope"
}
}
}
},
"bearerAuth": {
"type": "http",
"scheme": "bearer"
},
"sell_inventory_scope": {
"type": "oauth2",
"flows": {
"clientCredentials": {
"tokenUrl": "https://api.ebay.com/identity/v1/oauth2/token",
"scopes": {
"https://api.ebay.com/oauth/api_scope/sell.inventory": "Sell inventory access."
}
}
}
},
"sell_fulfillment_scope": {
"type": "oauth2",
"flows": {
"clientCredentials": {
"tokenUrl": "https://api.ebay.com/identity/v1/oauth2/token",
"scopes": {
"https://api.ebay.com/oauth/api_scope/sell.fulfillment": "Sell fulfillment access."
}
}
}
},
"sell_marketing_scope": {
"type": "oauth2",
"flows": {
"clientCredentials": {
"tokenUrl": "https://api.ebay.com/identity/v1/oauth2/token",
"scopes": {
"https://api.ebay.com/oauth/api_scope/sell.marketing": "Sell marketing access."
}
}
}
},
"commerce_catalog_readonly_scope": {
"type": "oauth2",
"flows": {
"clientCredentials": {
"tokenUrl": "https://api.ebay.com/identity/v1/oauth2/token",
"scopes": {
"https://api.ebay.com/oauth/api_scope/commerce.catalog.readonly": "Commerce catalog readonly access."
}
}
}
},
"sell_analytics_readonly_scope": {
"type": "oauth2",
"flows": {
"clientCredentials": {
"tokenUrl": "https://api.ebay.com/identity/v1/oauth2/token",
"scopes": {
"https://api.ebay.com/oauth/api_scope/sell.analytics.readonly": "Sell analytics readonly access."
}
}
}
},
"sell_managed_fulfillment_scope": {
"type": "oauth2",
"flows": {
"clientCredentials": {
"tokenUrl": "https://api.ebay.com/identity/v1/oauth2/token",
"scopes": {
"https://api.ebay.com/oauth/api_scope/sell.managed.fulfillment": "Sell managed fulfillment access."
}
}
}
},
"ebay_user_scope": {
"type": "oauth2",
"flows": {
"clientCredentials": {
"tokenUrl": "https://api.ebay.com/identity/v1/oauth2/token",
"scopes": {
"eBayUser": "eBay user access."
}
}
}
}
}
},
"tags": [
{
"name": "CustomerServiceMetricTask",
"description": "Operations that create and retrieve customer service metric tasks and reports."
}
]
}