api-specs/sell_inventory_v1_oas3.yaml
openapi: 3.0.0
info:
title: Inventory API
description: The Inventory API is used to create and manage inventory, and then to publish and manage this inventory on an eBay marketplace. There are also methods in this API that will convert eligible, active eBay listings into the Inventory API model.
contact:
name: eBay Inc,
license:
name: eBay API License Agreement
url: https://go.developer.ebay.com/api-license-agreement
version: 1.16.1
servers:
- url: https://api.ebay.com{basePath}
description: Production
variables:
basePath:
default: /sell/inventory/v1
paths:
/bulk_create_or_replace_inventory_item:
post:
tags:
- inventory_item
description: '<span class="tablenote"><strong>Note:</strong> Please note that any eBay listing created using the Inventory API cannot be revised or relisted using the Trading API calls.</span><br /><br /><span class="tablenote"><strong>Note:</strong> Each listing can be revised up to 250 times in one calendar day. If this revision threshold is reached, the seller will be blocked from revising the item until the next calendar day.</span><br/><br/>This call can be used to create and/or update up to 25 new inventory item records. It is up to sellers whether they want to create a complete inventory item records right from the start, or sellers can provide only some information with the initial <strong>bulkCreateOrReplaceInventoryItem</strong> call, and then make one or more additional <strong>bulkCreateOrReplaceInventoryItem</strong> calls to complete all required fields for the inventory item records and prepare for publishing. Upon first creating inventory item records, only the SKU values are required. <br/><br/> In the case of updating existing inventory item records, the <strong>bulkCreateOrReplaceInventoryItem</strong> call will do a complete replacement of the existing inventory item records, so all fields that are currently defined for the inventory item record are required in that update action, regardless of whether their values changed. So, when replacing/updating an inventory item record, it is advised that the seller run a ''Get'' call to retrieve the full details of the inventory item records and see all of its current values/settings before attempting to update the records. Any changes that are made to inventory item records that are part of one or more active eBay listings, a successful call will automatically update these active listings. <br/><br/> The key information that is set with the <strong>bulkCreateOrReplaceInventoryItem</strong> call include: <ul> <li>Seller-defined SKU value for the product. Each seller product, including products within an item inventory group, must have their own SKU value. </li> <li>Condition of the item</li> <li>Product details, including any product identifier(s), such as a UPC, ISBN, EAN, or Brand/Manufacturer Part Number pair, a product description, a product title, product/item aspects, and links to images. eBay will use any supplied eBay Product ID (ePID) or a GTIN (UPC, ISBN, or EAN) and attempt to match those identifiers to a product in the eBay Catalog, and if a product match is found, the product details for the inventory item will automatically be populated.</li> <li>Quantity of the inventory item that is available for purchase</li> <li>Package weight and dimensions, which is required if the seller will be offering calculated shipping options. The package weight will also be required if the seller will be providing flat-rate shipping services, but charging a weight surcharge.</li> </ul> <p>In addition to the <code>authorization</code> header, which is required for all eBay REST API calls, the <strong>bulkCreateOrReplaceInventoryItem</strong> call also requires the <code>Content-Language</code> header, that sets the natural language that will be used in the field values of the request payload. For US English, the code value passed in this header should be <code>en-US</code>. To view other supported <code>Content-Language</code> values, and to read more about all supported HTTP headers for eBay REST API calls, see the <a href="/api-docs/static/rest-request-components.html#HTTP">HTTP request headers</a> topic in the <strong>Using eBay RESTful APIs</strong> document.</p><p>For those who prefer to create or update a single inventory item record, the <strong>createOrReplaceInventoryItem</strong> method can be used.</p>'
operationId: bulkCreateOrReplaceInventoryItem
requestBody:
description: Details of the inventories with sku and locale
content:
application/json:
schema:
description: Details of the inventories with sku and locale
$ref: '#/components/schemas/BulkInventoryItem'
required: true
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/BulkInventoryItemResponse'
x-response-codes:
errors:
'25401':
domain: API_INVENTORY
category: APPLICATION
description: Invalid listing options removed. {additionalInfo}
'25402':
domain: API_INVENTORY
category: APPLICATION
description: System warning. {additionalInfo}
'25504':
domain: API_INVENTORY
category: APPLICATION
description: '{additionalInfo}'
'25753':
domain: API_INVENTORY
category: REQUEST
description: listingStartDate is in the past or the offer is live. Value is not updated on the listing.
'207':
description: Multi-Status
'400':
description: Bad Request
x-response-codes:
errors:
'25002':
domain: API_INVENTORY
category: REQUEST
description: Any User error. {additionalInfo}
'25003':
domain: API_INVENTORY
category: REQUEST
description: Invalid price. {additionalInfo}
'25004':
domain: API_INVENTORY
category: REQUEST
description: Invalid quantity. {additionalInfo}
'25005':
domain: API_INVENTORY
category: REQUEST
description: Invalid category. {additionalInfo}
'25006':
domain: API_INVENTORY
category: REQUEST
description: Invalid listing option. {additionalInfo}
'25007':
domain: API_INVENTORY
category: REQUEST
description: Invalid Shipping policy information. {additionalInfo}
'25008':
domain: API_INVENTORY
category: REQUEST
description: Invalid Payment policy information. {additionalInfo}
'25009':
domain: API_INVENTORY
category: REQUEST
description: Invalid Return policy information. {additionalInfo}
'25011':
domain: API_INVENTORY
category: REQUEST
description: Invalid tax information. {additionalInfo}
'25012':
domain: API_INVENTORY
category: REQUEST
description: Invalid location. {additionalInfo}
'25013':
domain: API_INVENTORY
category: REQUEST
description: Invalid InventoryItemGroup information. {additionalInfo}
'25014':
domain: API_INVENTORY
category: REQUEST
description: Invalid pictures. {additionalInfo}
'25015':
domain: API_INVENTORY
category: REQUEST
description: Invalid picture URL. {additionalInfo}
'25016':
domain: API_INVENTORY
category: REQUEST
description: Invalid {fieldName}. {additionalInfo}
'25017':
domain: API_INVENTORY
category: REQUEST
description: Missing field {fieldName}. {additionalInfo}
'25018':
domain: API_INVENTORY
category: REQUEST
description: Incomplete account information. {additionalInfo}
'25019':
domain: API_INVENTORY
category: REQUEST
description: Cannot revise listing. {additionalInfo}
'25020':
domain: API_INVENTORY
category: REQUEST
description: Invalid package details. {additionalInfo}
'25021':
domain: API_INVENTORY
category: REQUEST
description: Invalid condition information. {additionalInfo}
'25022':
domain: API_INVENTORY
category: REQUEST
description: Invalid attribute. {fieldName}
'25023':
domain: API_INVENTORY
category: REQUEST
description: Invalid compatibility information. {additionalInfo}
'25026':
domain: API_INVENTORY
category: REQUEST
description: Selling limits exceeded. {additionalInfo}
'25501':
domain: API_INVENTORY
category: REQUEST
description: Invalid picture. {additionalInfo}
'25502':
domain: API_INVENTORY
category: REQUEST
description: Invalid attribute information. {additionalInfo}
'25503':
domain: API_INVENTORY
category: REQUEST
description: Invalid product information. {additionalInfo}
'25601':
domain: API_INVENTORY
category: REQUEST
description: Invalid attribute. {fieldName}
'25604':
domain: API_INVENTORY
category: REQUEST
description: Input error. {additionalInfo}
'25701':
domain: API_INVENTORY
category: REQUEST
description: These SKU(s) are not in the system
'25702':
domain: API_INVENTORY
category: REQUEST
description: SKU {additionalInfo} is not available in the system
'25707':
domain: API_INVENTORY
category: REQUEST
description: Invalid sku. sku has to be alphanumeric with upto 50 characters in length
'25708':
domain: API_INVENTORY
category: REQUEST
description: Invalid sku
'25709':
domain: API_INVENTORY
category: REQUEST
description: Invalid request. Invalid value for field {additionalInfo}
'25710':
domain: API_INVENTORY
category: REQUEST
description: We didn't find the resource/entity you are requesting. Please verify the request
'25713':
domain: API_INVENTORY
category: REQUEST
description: 'This Offer is not available : {additionalInfo}.'
'25715':
domain: API_INVENTORY
category: REQUEST
description: Invalid Dimension and Weight
'25727':
domain: API_INVENTORY
category: REQUEST
description: The number of InventoryItems in the request cannot exceed {additionalInfo}.
'25728':
domain: API_INVENTORY
category: REQUEST
description: InventoryItems should be unique in the request.
'25733':
domain: API_INVENTORY
category: REQUEST
description: Valid SKU and locale information are required for all the InventoryItems in the request.
'25759':
domain: API_INVENTORY
category: REQUEST
description: shipToLocationAvailability quantity value should be greater than or equal to auction allocation. Please provide valid quantity or unpublish auction offers of the sku.
'500':
description: Internal Server Error
x-response-codes:
errors:
'25001':
domain: API_INVENTORY
category: APPLICATION
description: Any System error. {additionalInfo}
'25025':
domain: API_INVENTORY
category: APPLICATION
description: Concurrent access of Inventory or InventoryItemGroup. Please try again later
security:
- api_auth:
- https://api.ebay.com/oauth/api_scope/sell.inventory
/bulk_get_inventory_item:
post:
tags:
- inventory_item
description: This call retrieves up to 25 inventory item records. The SKU value of each inventory item record to retrieve is specified in the request payload. <br/><br/>The <code>authorization</code> header is the only required HTTP header for this call, and it is required for all Inventory API calls. See the <strong>HTTP request headers</strong> section for more information.<br/><br/>For those who prefer to retrieve only one inventory item record by SKU value, , the <strong>getInventoryItem</strong> method can be used. To retrieve all inventory item records defined on the seller's account, the <strong>getInventoryItems</strong> method can be used (with pagination control if desired).
operationId: bulkGetInventoryItem
requestBody:
description: Details of the inventories with sku and locale
content:
application/json:
schema:
description: Details of the inventories with sku and locale
$ref: '#/components/schemas/BulkGetInventoryItem'
required: true
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/BulkGetInventoryItemResponse'
'207':
description: Multi-Status
'400':
description: Bad Request
x-response-codes:
errors:
'25702':
domain: API_INVENTORY
category: REQUEST
description: SKU {additionalInfo} is not available in the system
'25708':
domain: API_INVENTORY
category: REQUEST
description: Invalid SKU.
'25709':
domain: API_INVENTORY
category: REQUEST
description: Invalid request. Invalid value for field {additionalInfo}
'25710':
domain: API_INVENTORY
category: REQUEST
description: We didn't find the resource/entity you are requesting. Please verify the request
'25727':
domain: API_INVENTORY
category: REQUEST
description: The number of InventoryItems in the request cannot exceed {additionalInfo}.
'25734':
domain: API_INVENTORY
category: REQUEST
description: SKU should be unique in the request.
'500':
description: Internal Server Error
x-response-codes:
errors:
'25001':
domain: API_INVENTORY
category: APPLICATION
description: Any System error. {additionalInfo}
security:
- api_auth:
- https://api.ebay.com/oauth/api_scope/sell.inventory.readonly
- https://api.ebay.com/oauth/api_scope/sell.inventory
/bulk_update_price_quantity:
post:
tags:
- inventory_item
description: This call is used by the seller to update the total ship-to-home quantity of one inventory item, and/or to update the price and/or quantity of one or more offers associated with one inventory item. Up to 25 offers associated with an inventory item may be updated with one <strong>bulkUpdatePriceQuantity</strong> call. Only one SKU (one product) can be updated per call.<br /><br /><span class="tablenote"><strong>Note:</strong> Each listing can be revised up to 250 times in one calendar day. If this revision threshold is reached, the seller will be blocked from revising the item until the next calendar day.</span><br /><br />The <strong>getOffers</strong> call can be used to retrieve all offers associated with a SKU. The seller will just pass in the correct SKU value through the <strong>sku</strong> query parameter. To update an offer, the <strong>offerId</strong> value is required, and this value is returned in the <strong>getOffers</strong> call response. It is also useful to know which offers are unpublished and which ones are published. To get this status, look for the <strong>status</strong> value in the <strong>getOffers</strong> call response. Offers in the published state are live eBay listings, and these listings will be revised with a successful <strong>bulkUpdatePriceQuantity</strong> call.<br /><br />An issue will occur if duplicate <strong>offerId</strong> values are passed through the same <strong>offers</strong> container, or if one or more of the specified offers are associated with different products/SKUs.<br /><br /><span class="tablenote"><strong>Note:</strong> For multiple-variation listings, it is recommended that the <strong>bulkUpdatePriceQuantity</strong> call be used to update price and quantity information for each SKU within that multiple-variation listing instead of using <strong>createOrReplaceInventoryItem</strong> calls to update the price and quantity for each SKU. Just remember that only one SKU (one product variation) can be updated per call.</span><p>The <code>authorization</code> header is the only required HTTP header for this call. See the <strong>HTTP request headers</strong> section for more information.</p>
operationId: bulkUpdatePriceQuantity
requestBody:
description: Price and allocation details for the given SKU and Marketplace
content:
application/json:
schema:
description: Price and allocation details for the given SKU and Marketplace
$ref: '#/components/schemas/BulkPriceQuantity'
required: true
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/BulkPriceQuantityResponse'
'207':
description: Multi-Status
'400':
description: Bad Request
x-response-codes:
errors:
'25002':
domain: API_INVENTORY
category: REQUEST
description: Any User error. {additionalInfo}
'25709':
domain: API_INVENTORY
category: REQUEST
description: Invalid value for {fieldName}. {additionalInfo}
'25759':
domain: API_INVENTORY
category: REQUEST
description: shipToLocationAvailability quantity value should be greater than or equal to auction allocation. Please provide valid quantity or unpublish auction offers of the sku.
'500':
description: Internal Server Error
x-response-codes:
errors:
'25001':
domain: API_INVENTORY
category: APPLICATION
description: A system error has occurred. {additionalInfo}
security:
- api_auth:
- https://api.ebay.com/oauth/api_scope/sell.inventory
/inventory_item/{sku}:
get:
tags:
- inventory_item
description: This call retrieves the inventory item record for a given SKU. The SKU value is passed in at the end of the call URI. There is no request payload for this call.<br/><br/>The <code>authorization</code> header is the only required HTTP header for this call, and it is required for all Inventory API calls. See the <strong>HTTP request headers</strong> section for more information.<br/><br/>For those who prefer to retrieve numerous inventory item records by SKU value with one call (up to 25 at a time), the <strong>bulkGetInventoryItem</strong> method can be used. To retrieve all inventory item records defined on the seller's account, the <strong>getInventoryItems</strong> method can be used (with pagination control if desired).
operationId: getInventoryItem
parameters:
- name: sku
in: path
description: 'This is the seller-defined SKU value of the product whose inventory item record you wish to retrieve.<br/><br/><strong>Max length</strong>: 50.'
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/InventoryItemWithSkuLocaleGroupid'
'400':
description: Bad Request
x-response-codes:
errors:
'25702':
domain: API_INVENTORY
category: REQUEST
description: '{skuValue} could not be found or is not available in the system.'
'25709':
domain: API_INVENTORY
category: REQUEST
description: Invalid value for {fieldName}
'25710':
domain: API_INVENTORY
category: REQUEST
description: We didn't find the resource/entity you are requesting. Please verify the request
'404':
description: Not Found
'500':
description: Internal Server Error
x-response-codes:
errors:
'25001':
domain: API_INVENTORY
category: APPLICATION
description: A system error has occurred. {additionalInfo}
security:
- api_auth:
- https://api.ebay.com/oauth/api_scope/sell.inventory.readonly
- https://api.ebay.com/oauth/api_scope/sell.inventory
put:
tags:
- inventory_item
description: '<span class="tablenote"><strong>Note:</strong> Please note that any eBay listing created using the Inventory API cannot be revised or relisted using the Trading API calls.</span><br /><br /><span class="tablenote"><strong>Note:</strong> Each listing can be revised up to 250 times in one calendar day. If this revision threshold is reached, the seller will be blocked from revising the item until the next calendar day.</span><br/><br/>This call creates a new inventory item record or replaces an existing inventory item record. It is up to sellers whether they want to create a complete inventory item record right from the start, or sellers can provide only some information with the initial <strong>createOrReplaceInventoryItem</strong> call, and then make one or more additional <strong>createOrReplaceInventoryItem</strong> calls to complete all required fields for the inventory item record and prepare it for publishing. Upon first creating an inventory item record, only the SKU value in the call path is required. <br/><br/> In the case of replacing an existing inventory item record, the <strong>createOrReplaceInventoryItem</strong> call will do a complete replacement of the existing inventory item record, so all fields that are currently defined for the inventory item record are required in that update action, regardless of whether their values changed. So, when replacing/updating an inventory item record, it is advised that the seller run a <strong>getInventoryItem</strong> call to retrieve the full inventory item record and see all of its current values/settings before attempting to update the record. And if changes are made to an inventory item that is part of one or more active eBay listings, a successful call will automatically update these eBay listings. <br/><br/> The key information that is set with the <strong>createOrReplaceInventoryItem</strong> call include: <ul> <li>Seller-defined SKU value for the product. Each seller product, including products within an item inventory group, must have their own SKU value. This SKU value is passed in at the end of the call URI</li> <li>Condition of the item</li> <li>Product details, including any product identifier(s), such as a UPC, ISBN, EAN, or Brand/Manufacturer Part Number pair, a product description, a product title, product/item aspects, and links to images. eBay will use any supplied eBay Product ID (ePID) or a GTIN (UPC, ISBN, or EAN) and attempt to match those identifiers to a product in the eBay Catalog, and if a product match is found, the product details for the inventory item will automatically be populated.</li> <li>Quantity of the inventory item that is available for purchase</li> <li>Package weight and dimensions, which is required if the seller will be offering calculated shipping options. The package weight will also be required if the seller will be providing flat-rate shipping services, but charging a weight surcharge.</li> </ul> <p>In addition to the <code>authorization</code> header, which is required for all eBay REST API calls, the <strong>createOrReplaceInventoryItem</strong> call also requires the <code>Content-Language</code> header, that sets the natural language that will be used in the field values of the request payload. For US English, the code value passed in this header should be <code>en-US</code>. To view other supported <code>Content-Language</code> values, and to read more about all supported HTTP headers for eBay REST API calls, see the <a href="/api-docs/static/rest-request-components.html#HTTP">HTTP request headers</a> topic in the <strong>Using eBay RESTful APIs</strong> document.</p><p>For those who prefer to create or update numerous inventory item records with one call (up to 25 at a time), the <strong>bulkCreateOrReplaceInventoryItem</strong> method can be used.</p>'
operationId: createOrReplaceInventoryItem
parameters:
- name: Content-Language
in: header
description: This request header sets the natural language that will be provided in the field values of the request payload.
required: true
schema:
type: string
- name: sku
in: path
description: 'The seller-defined SKU value for the inventory item is required whether the seller is creating a new inventory item, or updating an existing inventory item. This SKU value is passed in at the end of the call URI. SKU values must be unique across the seller''s inventory. <br/><br/> <strong>Max length</strong>: 50.'
required: true
schema:
type: string
requestBody:
description: Details of the inventory item record.
content:
application/json:
schema:
description: Details of the inventory item record.
$ref: '#/components/schemas/InventoryItem'
required: true
responses:
'200':
description: Success
headers:
Content-Language:
schema:
type: string
description: This header controls the language that is used for any returned errors or warnings in the call response.
content:
application/json:
schema:
$ref: '#/components/schemas/BaseResponse'
x-response-codes:
errors:
'25401':
domain: API_INVENTORY
category: APPLICATION
description: Invalid listing format removed. {additionalInfo}
'25402':
domain: API_INVENTORY
category: APPLICATION
description: System warning. {additionalInfo}
'25504':
domain: API_INVENTORY
category: APPLICATION
description: "service\t{additionalInfo}"
'25753':
domain: API_INVENTORY
category: REQUEST
description: listingStartDate is in the past or the offer is live. Value is not updated on the listing.
'201':
description: Created
headers:
Content-Language:
schema:
type: string
description: This header controls the language that is used for any returned errors or warnings in the call response.
content:
application/json:
schema:
$ref: '#/components/schemas/BaseResponse'
x-response-codes:
errors:
'25401':
domain: API_INVENTORY
category: APPLICATION
description: Invalid listing format removed. {additionalInfo}
'25402':
domain: API_INVENTORY
category: APPLICATION
description: System warning. {additionalInfo}
'25504':
domain: API_INVENTORY
category: APPLICATION
description: "service\t{additionalInfo}"
'25753':
domain: API_INVENTORY
category: REQUEST
description: listingStartDate is in the past or the offer is live. Value is not updated on the listing.
'204':
description: No Content
'400':
description: Bad Request
x-response-codes:
errors:
'25002':
domain: API_INVENTORY
category: REQUEST
description: A user error has occurred. {additionalInfo}
'25003':
domain: API_INVENTORY
category: REQUEST
description: The eBay listing associated with the inventory item, or the unpublished offer has an invalid price. {additionalInfo}
'25004':
domain: API_INVENTORY
category: REQUEST
description: The eBay listing associated with the inventory item, or the unpublished offer has an invalid quantity. {additionalInfo}
'25005':
domain: API_INVENTORY
category: REQUEST
description: The eBay listing associated with the inventory item, or the unpublished offer has an invalid category ID. {additionalInfo}
'25006':
domain: API_INVENTORY
category: REQUEST
description: The eBay listing associated with the inventory item, or the unpublished offer has an invalid listing option. {additionalInfo}
'25007':
domain: API_INVENTORY
category: REQUEST
description: The eBay listing associated with the inventory item, or the unpublished offer has invalid data in the associated Fulfillment policy. {additionalInfo}
'25008':
domain: API_INVENTORY
category: REQUEST
description: The eBay listing associated with the inventory item, or the unpublished offer has invalid data in the associated Payment policy. {additionalInfo}
'25009':
domain: API_INVENTORY
category: REQUEST
description: The eBay listing associated with the inventory item, or the unpublished offer has invalid data in the associated Return policy. {additionalInfo}
'25011':
domain: API_INVENTORY
category: REQUEST
description: The eBay listing associated with the inventory item, or the unpublished offer has invalid tax information. {additionalInfo}
'25012':
domain: API_INVENTORY
category: REQUEST
description: Invalid inventory location. {additionalInfo}
'25013':
domain: API_INVENTORY
category: REQUEST
description: Invalid data in the Inventory Item Group. {additionalInfo}
'25014':
domain: API_INVENTORY
category: REQUEST
description: The eBay listing associated with the inventory item, or the unpublished offer has invalid pictures. {additionalInfo}
'25015':
domain: API_INVENTORY
category: REQUEST
description: The eBay listing associated with the inventory item, or the unpublished offer has an invalid picture URL. {additionalInfo}
'25016':
domain: API_INVENTORY
category: REQUEST
description: The {fieldName} value is invalid. {additionalInfo}
'25017':
domain: API_INVENTORY
category: REQUEST
description: '{fieldName} is missing. {additionalInfo}'
'25018':
domain: API_INVENTORY
category: REQUEST
description: Incomplete account information. {additionalInfo}
'25019':
domain: API_INVENTORY
category: REQUEST
description: Cannot revise listing. {additionalInfo}
'25020':
domain: API_INVENTORY
category: REQUEST
description: The eBay listing associated with the inventory item, or the unpublished offer has invalid shipping package details. {additionalInfo}
'25021':
domain: API_INVENTORY
category: REQUEST
description: The eBay listing associated with the inventory item, or the unpublished offer has invalid item condition information. {additionalInfo}
'25022':
domain: API_INVENTORY
category: REQUEST
description: Invalid attribute. {fieldName}
'25023':
domain: API_INVENTORY
category: REQUEST
description: Invalid compatibility information. {additionalInfo}
'25026':
domain: API_INVENTORY
category: REQUEST
description: Selling limit exceeded. {additionalInfo}
'25501':
domain: API_INVENTORY
category: REQUEST
description: The eBay listing associated with the inventory item, or the unpublished offer has an invalid picture. {additionalInfo}
'25502':
domain: API_INVENTORY
category: REQUEST
description: Invalid attribute information. {additionalInfo}
'25503':
domain: API_INVENTORY
category: REQUEST
description: The eBay listing associated with the inventory item, or the unpublished offer has invalid product information. {additionalInfo}
'25601':
domain: API_INVENTORY
category: REQUEST
description: '{fieldName} is an invalid attribute. '
'25604':
domain: API_INVENTORY
category: REQUEST
description: Input error. {additionalInfo}
'25701':
domain: API_INVENTORY
category: REQUEST
description: One or more of the supplied SKU(s) could not be found in the system.
'25702':
domain: API_INVENTORY
category: REQUEST
description: '{skuValue} could not be found or is not available in the system.'
'25707':
domain: API_INVENTORY
category: REQUEST
description: This is an invalid value for a SKU. Only alphanumeric characters can be used for SKUs, and their length must not exceed 50 characters.
'25708':
domain: API_INVENTORY
category: REQUEST
description: Invalid SKU.
'25709':
domain: API_INVENTORY
category: REQUEST
description: Invalid value for {fieldName}
'25710':
domain: API_INVENTORY
category: REQUEST
description: We didn't find the resource/entity you are requesting. Please verify the request.
'25713':
domain: API_INVENTORY
category: REQUEST
description: 'This Offer is not available : {additionalInfo}.'
'25715':
domain: API_INVENTORY
category: REQUEST
description: Invalid values for dimensions and/or weight of shipping package.
'25759':
domain: API_INVENTORY
category: REQUEST
description: shipToLocationAvailability quantity value should be greater than or equal to auction allocation. Please provide valid quantity or unpublish auction offers of the sku.
'500':
description: Internal Server Error
x-response-codes:
errors:
'25001':
domain: API_INVENTORY
category: APPLICATION
description: A system error has occurred. {additionalInfo}
'25025':
domain: API_INVENTORY
category: APPLICATION
description: Concurrent access of the same Inventory or Inventory Item Group object is not allowed. Please try again later.
security:
- api_auth:
- https://api.ebay.com/oauth/api_scope/sell.inventory
delete:
tags:
- inventory_item
description: This call is used to delete an inventory item record associated with a specified SKU. A successful call will not only delete that inventory item record, but will also have the following effects:<ul><li>Delete any and all unpublished offers associated with that SKU;</li><li>Delete any and all single-variation eBay listings associated with that SKU;</li><li>Automatically remove that SKU from a multiple-variation listing and remove that SKU from any and all inventory item groups in which that SKU was a member.</li></ul><p>The <code>authorization</code> header is the only required HTTP header for this call. See the <strong>HTTP request headers</strong> section for more information.</p>
operationId: deleteInventoryItem
parameters:
- name: sku
in: path
description: 'This is the seller-defined SKU value of the product whose inventory item record you wish to delete.<br/><br/><strong>Max length</strong>: 50.'
required: true
schema:
type: string
responses:
'204':
description: No Content
'400':
description: Bad Request
x-response-codes:
errors:
'25702':
domain: API_INVENTORY
category: REQUEST
description: '{skuValue} could not be found or is not available in the system.'
'25709':
domain: API_INVENTORY
category: REQUEST
description: Invalid value for {fieldName}. {additionalInfo}
'25710':
domain: API_INVENTORY
category: REQUEST
description: We didn't find the resource/entity you are requesting. Please verify the request
'404':
description: Not Found
'500':
description: Internal Server Error
x-response-codes:
errors:
'25001':
domain: API_INVENTORY
category: APPLICATION
description: A system error has occurred. {additionalInfo}
security:
- api_auth:
- https://api.ebay.com/oauth/api_scope/sell.inventory
/inventory_item:
get:
tags:
- inventory_item
description: This call retrieves all inventory item records defined for the seller's account. The <strong>limit</strong> query parameter allows the seller to control how many records are returned per page, and the <strong>offset</strong> query parameter is used to retrieve a specific page of records. The seller can make multiple calls to scan through multiple pages of records. There is no request payload for this call.<br/><br/>The <code>authorization</code> header is the only required HTTP header for this call, and it is required for all Inventory API calls. See the <strong>HTTP request headers</strong> section for more information.<br/><br/>For those who prefer to retrieve numerous inventory item records by SKU value with one call (up to 25 at a time), the <strong>bulkGetInventoryItem</strong> method can be used.
operationId: getInventoryItems
parameters:
- name: limit
in: query
description: 'The value passed in this query parameter sets the maximum number of records to return per page of data. Although this field is a string, the value passed in this field should be an integer from <code>1</code> to <code>100</code>. If this query parameter is not set, up to 100 records will be returned on each page of results.<br/><br/><strong>Min</strong>: 1, <strong>Max</strong>: 100 '
required: false
schema:
type: string
- name: offset
in: query
description: 'The value passed in this query parameter sets the page number to retrieve. The first page of records has a value of <code>0</code>, the second page of records has a value of <code>1</code>, and so on. If this query parameter is not set, its value defaults to <code>0</code>, and the first page of records is returned. '
required: false
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/InventoryItems'
'400':
description: Bad Request
x-response-codes:
errors:
'25706':
domain: API_INVENTORY
category: REQUEST
description: You have provided invalid pagination values. {additionalInfo}.
'25709':
domain: API_INVENTORY
category: REQUEST
description: Invalid value for {fieldName}.
'25710':
domain: API_INVENTORY
category: REQUEST
description: We didn't find the resource/entity you are requesting. Please verify the request
'404':
description: Not Found
'500':
description: Internal Server Error
x-response-codes:
errors:
'25001':
domain: API_INVENTORY
category: APPLICATION
description: A system error has occurred. {additionalInfo}
security:
- api_auth:
- https://api.ebay.com/oauth/api_scope/sell.inventory.readonly
- https://api.ebay.com/oauth/api_scope/sell.inventory
/inventory_item/{sku}/product_compatibility:
get:
tags:
- product_compatibility
description: This call is used by the seller to retrieve the list of products that are compatible with the inventory item. The SKU value for the inventory item is passed into the call URI, and a successful call with return the compatible vehicle list associated with this inventory item. Product compatibility is currently only applicable to motor vehicle parts and accessory categories, but more categories may be supported in the future.
operationId: getProductCompatibility
parameters:
- name: sku
in: path
description: A SKU (stock keeping unit) is an unique identifier defined by a seller for a product
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/Compatibility'
'400':
description: Bad Request
x-response-codes:
errors:
'25702':
domain: API_INVENTORY
category: REQUEST
description: '{skuValue} could not be found or is not available in the system.'
'25709':
domain: API_INVENTORY
category: REQUEST
description: Invalid value for {fieldName}. {additionalInfo}
'25710':
domain: API_INVENTORY
category: REQUEST
description: We didn't find the resource/entity you are requesting. Please verify the request
'404':
description: Not Found
'500':
description: Internal Server Error
x-response-codes:
errors:
'25001':
domain: API_INVENTORY
category: APPLICATION
description: A system error has occurred. {additionalInfo}
security:
- api_auth:
- https://api.ebay.com/oauth/api_scope/sell.inventory.readonly
- https://api.ebay.com/oauth/api_scope/sell.inventory
put:
tags:
- product_compatibility
description: This call is used by the seller to create or replace a list of products that are compatible with the inventory item. The inventory item is identified with a SKU value in the URI. Product compatibility is currently only applicable to motor vehicle parts and accessory categories, but more categories may be supported in the future.<br /><br /><p>In addition to the <code>authorization</code> header, which is required for all eBay REST API calls, the <strong>createOrReplaceProductCompatibility</strong> call also requires the <code>Content-Language</code> header, that sets the natural language that will be used in the field values of the request payload. For US English, the code value passed in this header should be <code>en-US</code>. To view other supported <code>Content-Language</code> values, and to read more about all supported HTTP headers for eBay REST API calls, see the <a href="/api-docs/static/rest-request-components.html#HTTP">HTTP request headers</a> topic in the <strong>Using eBay RESTful APIs</strong> document.</p>
operationId: createOrReplaceProductCompatibility
parameters:
- name: Content-Language
in: header
description: This request header sets the natural language that will be provided in the field values of the request payload.
required: true
schema:
type: string
- name: sku
in: path
description: A SKU (stock keeping unit) is an unique identifier defined by a seller for a product
required: true
schema:
type: string
requestBody:
description: Details of the compatibility
content:
application/json:
schema:
description: Details of the compatibility
$ref: '#/components/schemas/Compatibility'
required: true
responses:
'200':
description: Success
headers:
Content-Language:
schema:
type: string
description: This response header sets the natural language that will be provided in the field values of the response payload.
content:
application/json:
schema:
$ref: '#/components/schemas/BaseResponse'
x-response-codes:
errors:
'25401':
domain: API_INVENTORY
category: APPLICATION
description: Invalid listing format removed. {additionalInfo}
'25402':
domain: API_INVENTORY
category: APPLICATION
description: System warning. {additionalInfo}
'201':
description: Created
headers:
Content-Language:
schema:
type: string
description: This response header sets the natural language that will be provided in the field values of the response payload.
content:
application/json:
schema:
$ref: '#/components/schemas/BaseResponse'
x-response-codes:
errors:
'25401':
domain: API_INVENTORY
category: APPLICATION
description: Invalid listing format removed. {additionalInfo}
'25402':
domain: API_INVENTORY
category: APPLICATION
description: System warning. {additionalInfo}
'204':
description: No Content
'400':
description: Bad Request
x-response-codes:
errors:
'25002':
domain: API_INVENTORY
category: REQUEST
description: A user error has occurred. {additionalInfo}
'25003':
domain: API_INVENTORY
category: REQUEST
description: The eBay listing associated with the inventory item, or the unpublished offer has an invalid price. {additionalInfo}
'25004':
domain: API_INVENTORY
category: REQUEST
description: The eBay listing associated with the inventory item, or the unpublished offer has an invalid quantity. {additionalInfo}
'25005':
domain: API_INVENTORY
category: REQUEST
description: The eBay listing associated with the inventory item, or the unpublished offer has an invalid category ID. {additionalInfo}
'25006':
domain: API_INVENTORY
category: REQUEST
description: The eBay listing associated with the inventory item, or the unpublished offer has an invalid listing option. {additionalInfo}
'25007':
domain: API_INVENTORY
category: REQUEST
description: The eBay listing associated with the inventory item, or the unpublished offer has invalid data in the associated Fulfillment policy. {additionalInfo}
'25008':
domain: API_INVENTORY
category: REQUEST
description: The eBay listing associated with the inventory item, or the unpublished offer has invalid data in the associated Payment policy. {additionalInfo}
'25009':
domain: API_INVENTORY
category: REQUEST
description: The eBay listing associated with the inventory item, or the unpublished offer has invalid data in the associated Return policy. {additionalInfo}
'25011':
domain: API_INVENTORY
category: REQUEST
description: The eBay listing associated with the inventory item, or the unpublished offer has invalid tax information. {additionalInfo}
'25012':
domain: API_INVENTORY
category: REQUEST
description: Invalid inventory location. {additionalInfo}
'25013':
domain: API_INVENTORY
category: REQUEST
description: Invalid data in the Inventory Item Group. {additionalInfo}
'25014':
domain: API_INVENTORY
category: REQUEST
description: The eBay listing associated with the inventory item, or the unpublished offer has invalid pictures. {additionalInfo}
'25015':
domain: API_INVENTORY
category: REQUEST
description: The eBay listing associated with the inventory item, or the unpublished offer has an invalid picture URL. {additionalInfo}
'25016':
domain: API_INVENTORY
category: REQUEST
description: The {fieldName} value is invalid. {additionalInfo}
'25017':
domain: API_INVENTORY
category: REQUEST
description: '{fieldName} is missing. {additionalInfo}'
'25018':
domain: API_INVENTORY
category: REQUEST
description: Incomplete account information. {additionalInfo}
'25019':
domain: API_INVENTORY
category: REQUEST
description: Cannot revise listing. {additionalInfo}
'25020':
domain: API_INVENTORY
category: REQUEST
description: The eBay listing associated with the inventory item, or the unpublished offer has invalid shipping package details. {additionalInfo}
'25021':
domain: API_INVENTORY
category: REQUEST
description: The eBay listing associated with the inventory item, or the unpublished offer has invalid item condition information. {additionalInfo}
'25022':
domain: API_INVENTORY
category: REQUEST
description: Invalid attribute. {fieldName}
'25023':
domain: API_INVENTORY
category: REQUEST
description: Invalid compatibility information. {additionalInfo}
'25026':
domain: API_INVENTORY
category: REQUEST
description: Selling limit exceeded. {additionalInfo}
'25702':
domain: API_INVENTORY
category: REQUEST
description: '{skuValue} could not be found or is not available in the system.'
'25739':
domain: API_INVENTORY
category: REQUEST
description: User input error. The number of compatibilityProperties in the request cannot exceed {additionalInfo}.
'25740':
domain: API_INVENTORY
category: REQUEST
description: User input error. Invalid name for compatibilityProperties. The length should be between 1 and {additionalInfo} characters.
'25741':
domain: API_INVENTORY
category: REQUEST
description: User input error. Invalid value for compatibilityProperties. The length should be between 1 and {additionalInfo} characters.
'25742':
domain: API_INVENTORY
category: REQUEST
description: User input error. productFamilyProperties and compatibilityProperties cannot be used together. Please use compatibilityProperties.
'500':
description: Internal Server Error
x-response-codes:
errors:
'25001':
domain: API_INVENTORY
category: APPLICATION
description: A system error has occurred. {additionalInfo}
'25025':
domain: API_INVENTORY
category: APPLICATION
description: Concurrent access of the same Inventory or Inventory Item Group object is not allowed. Please try again later.
security:
- api_auth:
- https://api.ebay.com/oauth/api_scope/sell.inventory
delete:
tags:
- product_compatibility
description: This call is used by the seller to delete the list of products that are compatible with the inventory item that is associated with the compatible product list. The inventory item is identified with a SKU value in the URI. Product compatibility is currently only applicable to motor vehicle parts and accessory categories, but more categories may be supported in the future.
operationId: deleteProductCompatibility
parameters:
- name: sku
in: path
description: A SKU (stock keeping unit) is an unique identifier defined by a seller for a product
required: true
schema:
type: string
responses:
'204':
description: No Content
'400':
description: Bad Request
x-response-codes:
errors:
'25702':
domain: API_INVENTORY
category: REQUEST
description: '{skuValue} could not be found or is not available in the system.'
'25709':
domain: API_INVENTORY
category: REQUEST
description: Invalid value for {fieldName}. {additionalInfo}
'25710':
domain: API_INVENTORY
category: REQUEST
description: We didn't find the resource/entity you are requesting. Please verify the request
'404':
description: Not Found
'500':
description: Internal Server Error
x-response-codes:
errors:
'25001':
domain: API_INVENTORY
category: APPLICATION
description: A system error has occurred. <em><additional_information></em>
security:
- api_auth:
- https://api.ebay.com/oauth/api_scope/sell.inventory
/inventory_item_group/{inventoryItemGroupKey}:
get:
tags:
- inventory_item_group
description: This call retrieves the inventory item group for a given <strong>inventoryItemGroupKey</strong> value. The <strong>inventoryItemGroupKey</strong> value is passed in at the end of the call URI.
operationId: getInventoryItemGroup
parameters:
- name: inventoryItemGroupKey
in: path
description: The unique identifier of an inventory item group. This value is assigned by the seller when an inventory item group is created. The <strong>inventoryItemGroupKey</strong> value for the inventory item group to retrieve is passed in at the end of the call URI.
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/InventoryItemGroup'
'400':
description: Bad Request
x-response-codes:
errors:
'25705':
domain: API_INVENTORY
category: REQUEST
description: The Inventory Item Group named {inventoryItemGroupKey} could not be found or is not available in the system.
'25709':
domain: API_INVENTORY
category: REQUEST
description: Invalid value for {fieldName}. {additionalInfo}
'25710':
domain: API_INVENTORY
category: REQUEST
description: We didn't find the resource/entity you are requesting. Please verify the request
'404':
description: Not Found
'500':
description: Internal Server Error
x-response-codes:
errors:
'25001':
domain: API_INVENTORY
category: APPLICATION
description: A system error has occurred. {additionalInfo}
security:
- api_auth:
- https://api.ebay.com/oauth/api_scope/sell.inventory.readonly
- https://api.ebay.com/oauth/api_scope/sell.inventory
put:
tags:
- inventory_item_group
description: '<span class="tablenote"><strong>Note:</strong> Each listing can be revised up to 250 times in one calendar day. If this revision threshold is reached, the seller will be blocked from revising the item until the next calendar day.</span><br /><br />This call creates a new inventory item group or updates an existing inventory item group. It is up to sellers whether they want to create a complete inventory item group record right from the start, or sellers can provide only some information with the initial <strong>createOrReplaceInventoryItemGroup</strong> call, and then make one or more additional <strong>createOrReplaceInventoryItemGroup</strong> calls to complete the inventory item group record. Upon first creating an inventory item group record, the only required elements are the <strong>inventoryItemGroupKey</strong> identifier in the call URI, and the members of the inventory item group specified through the <strong>variantSKUs</strong> array in the request payload. <br><br>In the case of updating/replacing an existing inventory item group, this call does a complete replacement of the existing inventory item group record, so all fields (including the member SKUs) that make up the inventory item group are required, regardless of whether their values changed. So, when replacing/updating an inventory item group record, it is advised that the seller run a <strong>getInventoryItemGroup</strong> call for that inventory item group to see all of its current values/settings/members before attempting to update the record. And if changes are made to an inventory item group that is part of a live, multiple-variation eBay listing, these changes automatically update the eBay listing. For example, if a SKU value is removed from the inventory item group, the corresponding product variation will be removed from the eBay listing as well.<br/><br/> In addition to the required inventory item group identifier and member SKUs, other key information that is set with this call include: <ul> <li>Title and description of the inventory item group. The string values provided in these fields will actually become the listing title and listing description of the listing once the first SKU of the inventory item group is published successfully</li> <li>Common aspects that inventory items in the qroup share</li> <li>Product aspects that vary within each product variation</li> <li>Links to images demonstrating the variations of the product, and these images should correspond to the product aspect that is set with the <strong>variesBy.aspectsImageVariesBy</strong> field</li> </ul> <p>In addition to the <code>authorization</code> header, which is required for all eBay REST API calls, the <strong>createOrReplaceInventoryItemGroup</strong> call also requires the <code>Content-Language</code> header, that sets the natural language that will be used in the field values of the request payload. For US English, the code value passed in this header should be <code>en-US</code>. To view other supported <code>Content-Language</code> values, and to read more about all supported HTTP headers for eBay REST API calls, see the <a href="/api-docs/static/rest-request-components.html#HTTP">HTTP request headers</a> topic in the <strong>Using eBay RESTful APIs</strong> document.</p>'
operationId: createOrReplaceInventoryItemGroup
parameters:
- name: Content-Language
in: header
description: This request header sets the natural language that will be provided in the field values of the request payload.
required: true
schema:
type: string
- name: inventoryItemGroupKey
in: path
description: Unique identifier of the inventory item group. This identifier is supplied by the seller. The <strong>inventoryItemGroupKey</strong> value for the inventory item group to create/update is passed in at the end of the call URI. This value cannot be changed once it is set.
required: true
schema:
type: string
requestBody:
description: Details of the inventory Item Group
content:
application/json:
schema:
description: Details of the inventory Item Group
$ref: '#/components/schemas/InventoryItemGroup'
required: true
responses:
'200':
description: Success
headers:
Content-Language:
schema:
type: string
description: This describes the natural language(s) of the intended audience for the enclosed entity
content:
application/json:
schema:
$ref: '#/components/schemas/BaseResponse'
x-response-codes:
errors:
'25401':
domain: API_INVENTORY
category: APPLICATION
description: Invalid listing format removed {additionalInfo}
'25402':
domain: API_INVENTORY
category: APPLICATION
description: System warning. {additionalInfo}
'201':
description: Created
headers:
Content-Language:
schema:
type: string
description: This describes the natural language(s) of the intended audience for the enclosed entity
content:
application/json:
schema:
$ref: '#/components/schemas/BaseResponse'
x-response-codes:
errors:
'25401':
domain: API_INVENTORY
category: APPLICATION
description: Invalid listing format removed {additionalInfo}
'25402':
domain: API_INVENTORY
category: APPLICATION
description: System warning. {additionalInfo}
'204':
description: No Content
'400':
description: Bad Request
x-response-codes:
errors:
'25002':
domain: API_INVENTORY
category: REQUEST
description: A user error has occurred. {additionalInfo}
'25003':
domain: API_INVENTORY
category: REQUEST
description: The eBay listing associated with the inventory item, or the unpublished offer has an invalid price. {additionalInfo}
'25004':
domain: API_INVENTORY
category: REQUEST
description: The eBay listing associated with the inventory item, or the unpublished offer has an invalid quantity. {additionalInfo}
'25005':
domain: API_INVENTORY
category: REQUEST
description: The eBay listing associated with the inventory item, or the unpublished offer has an invalid category ID. {additionalInfo}
'25006':
domain: API_INVENTORY
category: REQUEST
description: The eBay listing associated with the inventory item, or the unpublished offer has an invalid listing option. {additionalInfo}
'25007':
domain: API_INVENTORY
category: REQUEST
description: The eBay listing associated with the inventory item, or the unpublished offer has invalid data in the associated Fulfillment policy. {additionalInfo}
'25008':
domain: API_INVENTORY
category: REQUEST
description: The eBay listing associated with the inventory item, or the unpublished offer has invalid data in the associated Payment policy. {additionalInfo}
'25009':
domain: API_INVENTORY
category: REQUEST
description: The eBay listing associated with the inventory item, or the unpublished offer has invalid data in the associated Return policy. {additionalInfo}
'25011':
domain: API_INVENTORY
category: REQUEST
description: The eBay listing associated with the inventory item, or the unpublished offer has invalid tax information. {additionalInfo}
'25012':
domain: API_INVENTORY
category: REQUEST
description: Invalid inventory location. {additionalInfo}
'25013':
domain: API_INVENTORY
category: REQUEST
description: Invalid data in the Inventory Item Group. {additionalInfo}
'25014':
domain: API_INVENTORY
category: REQUEST
description: The eBay listing associated with the inventory item, or the unpublished offer has invalid pictures. {additionalInfo}
'25015':
domain: API_INVENTORY
category: REQUEST
description: The eBay listing associated with the inventory item, or the unpublished offer has an invalid picture URL. {additionalInfo}
'25016':
domain: API_INVENTORY
category: REQUEST
description: The {fieldName} value is invalid. {additionalInfo}
'25017':
domain: API_INVENTORY
category: REQUEST
description: '{fieldName} is missing. {additionalInfo}'
'25018':
domain: API_INVENTORY
category: REQUEST
description: Incomplete account information. {additionalInfo}
'25019':
domain: API_INVENTORY
category: REQUEST
description: Cannot revise listing. {additionalInfo}
'25020':
domain: API_INVENTORY
category: REQUEST
description: The eBay listing associated with the inventory item, or the unpublished offer has invalid shipping package details. {additionalInfo}
'25021':
domain: API_INVENTORY
category: REQUEST
description: The eBay listing associated with the inventory item, or the unpublished offer has invalid item condition information. {additionalInfo}
'25022':
domain: API_INVENTORY
category: REQUEST
description: Invalid attribute. {fieldName}
'25023':
domain: API_INVENTORY
category: REQUEST
description: Invalid compatibility information. {additionalInfo}
'25024':
domain: API_INVENTORY
category: REQUEST
description: Invalid Best Offer information. {additionalInfo}
'25026':
domain: API_INVENTORY
category: REQUEST
description: Selling limit exceeded. {additionalInfo}
'25041':
domain: API_INVENTORY
category: REQUEST
description: When listing an item with Refurbished condition, maximum handling time must be {replaceable_value} business day(s).
'25042':
domain: API_INVENTORY
category: REQUEST
description: When listing an item with Refurbished condition, free shipping must be provided.
'25043':
domain: API_INVENTORY
category: REQUEST
description: When listing an item with Refurbished condition, returns must be accepted.
'25044':
domain: API_INVENTORY
category: REQUEST
description: When listing an item with Refurbished condition, refund must be provided as Money Back.
'25045':
domain: API_INVENTORY
category: REQUEST
description: When listing an item with Refurbished condition, the minimum time you'll accept returns must be {replaceable_value} days.
'25046':
domain: API_INVENTORY
category: REQUEST
description: When listing an item with Refurbished condition, seller must pay the cost for return shipping.
'25047':
domain: API_INVENTORY
category: REQUEST
description: Seller is not eligible to use Refurbished Item Condition
'25048':
domain: API_INVENTORY
category: REQUEST
description: Seller is not eligible to use Refurbished Item Condition in this Category
'25049':
domain: API_INVENTORY
category: REQUEST
description: Seller is not eligible to use Refurbished Item Condition for the selected Brand
'25050':
domain: API_INVENTORY
category: REQUEST
description: When listing an item with Refurbished condition, {replaceable_value} cannot be used in the Title.
'25051':
domain: API_INVENTORY
category: REQUEST
description: When listing an item with Refurbished condition, {replaceable_value} cannot be used in the Subtitle
'25052':
domain: API_INVENTORY
category: REQUEST
description: When listing an item with Refurbished condition, at least {replaceable_value} images must be provided
'25701':
domain: API_INVENTORY
category: REQUEST
description: One or more of the supplied SKU(s) could not be found in the system.
'25702':
domain: API_INVENTORY
category: REQUEST
description: '{skuValue} could not be found or is not available in the system.'
'25703':
domain: API_INVENTORY
category: REQUEST
description: 'The following SKU is already a member of another group. SKU : {skuValue} groupId : {inventoryItemGroupKey}'
'25704':
domain: API_INVENTORY
category: REQUEST
description: 'The following SKU is already listed as a single SKU listing. SKU : {skuValue} Listing ID : {listingId}'
'25705':
domain: API_INVENTORY
category: REQUEST
description: The Inventory Item Group named {inventoryItemGroupKey} could not be found or is not available in the system.
'25709':
domain: API_INVENTORY
category: REQUEST
description: Invalid value for {fieldName}. {additionalInfo}
'25756':
domain: API_INVENTORY
category: REQUEST
description: Auction format is not permitted with a SKU that is part of an InventoryItemGroup.
'500':
description: Internal Server Error
x-response-codes:
errors:
'25001':
domain: API_INVENTORY
category: APPLICATION
description: A system error has occurred. {additionalInfo}
'25025':
domain: API_INVENTORY
category: APPLICATION
description: Concurrent access of the same Inventory or Inventory Item Group object is not allowed. Please try again later.
security:
- api_auth:
- https://api.ebay.com/oauth/api_scope/sell.inventory
delete:
tags:
- inventory_item_group
description: This call deletes the inventory item group for a given <strong>inventoryItemGroupKey</strong> value.
operationId: deleteInventoryItemGroup
parameters:
- name: inventoryItemGroupKey
in: path
description: The unique identifier of an inventory item group. This value is assigned by the seller when an inventory item group is created. The <strong>inventoryItemGroupKey</strong> value for the inventory item group to delete is passed in at the end of the call URI.
required: true
schema:
type: string
responses:
'204':
description: No Content
'400':
description: Bad Request
x-response-codes:
errors:
'25705':
domain: API_INVENTORY
category: REQUEST
description: The Inventory Item Group named {inventoryItemGroupKey} could not be found or is not available in the system.
'25709':
domain: API_INVENTORY
category: REQUEST
description: Invalid value for {fieldName}. {additionalInfo}
'25710':
domain: API_INVENTORY
category: REQUEST
description: We didn't find the resource/entity you are requesting. Please verify the request
'404':
description: Not Found
'500':
description: Internal Server Error
x-response-codes:
errors:
'25001':
domain: API_INVENTORY
category: APPLICATION
description: A system error has occurred. {additionalInfo}
security:
- api_auth:
- https://api.ebay.com/oauth/api_scope/sell.inventory
/bulk_migrate_listing:
post:
tags:
- listing
description: This call is used to convert existing eBay Listings to the corresponding Inventory API objects. If an eBay listing is successfully migrated to the Inventory API model, new Inventory Location, Inventory Item, and Offer objects are created. For a multiple-variation listing that is successfully migrated, in addition to the three new Inventory API objects just mentioned, an Inventory Item Group object will also be created. If the eBay listing is a motor vehicle part or accessory listing with a compatible vehicle list (<strong>ItemCompatibilityList</strong> container in Trading API's Add/Revise/Relist/Verify calls), a Product Compatibility object will be created.<br/><br/><h3>Migration Requirements</h3><br/>To be eligible for migration, the active eBay listings must meet the following requirements:<ul><li>Listing type is Fixed-Price<p><span class="tablenote"><strong>Note:</strong> Auction listings are supported by the Inventory API, but the <b>bulkMigrateListing</b> method cannot be used to migrate auction listings.</span></p></li><li>The item(s) in the listings must have seller-defined SKU values associated with them, and in the case of a multiple-variation listing, each product variation must also have its own SKU value</li><li>Business Polices (Payment, Return Policy, and Shipping) must be used on the listing, as legacy payment, return policy, and shipping fields will not be accepted. With the Payment Policy associated with a listing, the immediate payment requirement must be enabled.</li><li>The postal/zip code (<strong>PostalCode</strong> field in Trading's <strong>ItemType</strong>) or city (<strong>Location</strong> field in Trading's <strong>ItemType</strong>) must be set in the listing; the country is also needed, but this value is required in Trading API, so it will always be set for every listing</li></ul><br /><h3>Unsupported Listing Features</h3><br/>The following features are not yet available to be set or modified through the Inventory API, but they will remain on the active eBay listing, even after a successful migration to the Inventory model. The downside to this is that the seller will be completely blocked (in APIs or My eBay) from revising these features/settings once the migration takes place:<ul><li>Any listing-level Buyer Requirements</li><li>Listing enhancements like a bold listing title or Gallery Plus</li></ul><br /><h3>Making the Call</h3><br/>In the request payload of the <strong>bulkMigrateListings</strong> call, the seller will pass in an array of one to five eBay listing IDs (aka Item IDs). To save time and hassle, that seller should do a pre-check on each listing to make sure those listings meet the requirements to be migrated to the new Inventory model. There are no path or query parameters for this call.<br/><br/><h3>Call Response</h3><br/>If an eBay listing is migrated successfully to the new Inventory model, the following will occur:<ul><li>An Inventory Item object will be created for the item(s) in the listing, and this object will be accessible through the Inventory API</li><li>An Offer object will be created for the listing, and this object will be accessible through the Inventory API</li><li>An Inventory Location object will be created and associated with the Offer object, as an Inventory Location must be associated with a published Offer</li></ul>The response payload of the Bulk Migrate Listings call will show the results of each listing migration. These results include an HTTP status code to indicate the success or failure of each listing migration, the SKU value associated with each item, and if the migration is successful, an Offer ID value. The SKU value will be used in the Inventory API to manage the Inventory Item object, and the Offer ID value will be used in the Inventory API to manage the Offer object. Errors and/or warnings containers will be returned for each listing where an error and/or warning occurred with the attempted migration.<br/><br/>If a multiple-variation listing is successfully migrated, along with the Offer and Inventory Location objects, an Inventory Item object will be created for each product variation within the listing, and an Inventory Item Group object will also be created, grouping those variations together in the Inventory API platform. For a motor vehicle part or accessory listing that has a specified list of compatible vehicles, in addition to the Inventory Item, Inventory Location, and Offer objects that are created, a Product Compatibility object will also be created in the Inventory API platform.
operationId: bulkMigrateListing
requestBody:
description: Details of the listings that needs to be migrated into Inventory
content:
application/json:
schema:
description: Details of the listings that needs to be migrated into Inventory
$ref: '#/components/schemas/BulkMigrateListing'
required: true
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/BulkMigrateListingResponse'
'207':
description: Multi-Status
'400':
description: Bad Request
x-response-codes:
errors:
'25718':
domain: API_INVENTORY
category: REQUEST
description: Cannot migrate listing. {additionalInfo}
'500':
description: Internal Server Error
x-response-codes:
errors:
'25001':
domain: API_INVENTORY
category: APPLICATION
description: Any System error. {additionalInfo}
security:
- api_auth:
- https://api.ebay.com/oauth/api_scope/sell.inventory
/bulk_create_offer:
post:
tags:
- offer
description: 'This call creates multiple offers (up to 25) for specific inventory items on a specific eBay marketplace. Although it is not a requirement for the seller to create complete offers (with all necessary details) right from the start, eBay recommends that the seller provide all necessary details with this call since there is currently no bulk operation available to update multiple offers with one call. The following fields are always required in the request payload: <strong>sku</strong>, <strong>marketplaceId</strong>, and (listing) <strong>format</strong>. <br><br>Other information that will be required before a offer can be published are highlighted below: <ul><li>Inventory location</li> <li>Offer price</li> <li>Available quantity</li> <li>eBay listing category</li> <li>Referenced listing policy profiles to set payment, return, and fulfillment values/settings</li> </ul><p><span class="tablenote"><strong>Note:</strong> Though the <strong>includeCatalogProductDetails</strong> parameter is not required to be submitted in the request, the parameter defaults to <code>true</code> if omitted.</span></p> <p>If the call is successful, unique <strong>offerId</strong> values are returned in the response for each successfully created offer. The <strong>offerId</strong> value will be required for many other offer-related calls. Note that this call only stages an offer for publishing. The seller must run either the <strong>publishOffer</strong>, <strong>bulkPublishOffer</strong>, or <strong>publishOfferByInventoryItemGroup</strong> call to convert offer(s) into an active single- or multiple-variation listing.</p> <p>In addition to the <code>authorization</code> header, which is required for all eBay REST API calls, the <strong>bulkCreateOffer</strong> call also requires the <code>Content-Language</code> header, that sets the natural language that will be used in the field values of the request payload. For US English, the code value passed in this header should be <code>en-US</code>. To view other supported <code>Content-Language</code> values, and to read more about all supported HTTP headers for eBay REST API calls, see the <a href="/api-docs/static/rest-request-components.html#HTTP">HTTP request headers</a> topic in the <strong>Using eBay RESTful APIs</strong> document.</p><p>For those who prefer to create a single offer per call, the <strong>createOffer</strong> method can be used instead.</p>'
operationId: bulkCreateOffer
requestBody:
description: Details of the offer for the channel
content:
application/json:
schema:
description: Details of the offer for the channel
$ref: '#/components/schemas/BulkEbayOfferDetailsWithKeys'
required: true
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/BulkOfferResponse'
'207':
description: Multi-Status
'400':
description: Bad Request
x-response-codes:
errors:
'25702':
domain: API_INVENTORY
category: REQUEST
description: SKU {additionalInfo} is not available in the system
'25709':
domain: API_INVENTORY
category: REQUEST
description: Invalid request. Invalid value for field {additionalInfo}
'25729':
domain: API_INVENTORY
category: REQUEST
description: The combination of SKU, marketplaceId and format should be unique.
'25730':
domain: API_INVENTORY
category: REQUEST
description: The number of offers in the request cannot exceed {additionalInfo}
'25735':
domain: API_INVENTORY
category: REQUEST
description: Invalid SKU, marketplaceId or format.
'25752':
domain: API_INVENTORY
category: REQUEST
description: listingStartDate provided is invalid.
'25755':
domain: API_INVENTORY
category: REQUEST
description: listingDuration is required for auction offer.
'25756':
domain: API_INVENTORY
category: REQUEST
description: Auction format is not permitted with a SKU that is part of an InventoryItemGroup.
'25757':
domain: API_INVENTORY
category: REQUEST
description: auctionStartPrice is required for auction offer.
'25758':
domain: API_INVENTORY
category: REQUEST
description: auctionStartPrice and auctionReservePrice are not supported for fixed price offer.
'25761':
domain: API_INVENTORY
category: REQUEST
description: Discount pricing is not applicable for auction offer.
'25762':
domain: API_INVENTORY
category: REQUEST
description: availableQuantity is not applicable for auction offer.
'25763':
domain: API_INVENTORY
category: REQUEST
description: quantityLimitPerBuyer is not applicable for auction offer.
'25764':
domain: API_INVENTORY
category: REQUEST
description: eBayPlusIfEligible is not applicable for auction offer.
'500':
description: Internal Server Error
x-response-codes:
errors:
'25001':
domain: API_INVENTORY
category: APPLICATION
description: Any System error. {additionalInfo}
security:
- api_auth:
- https://api.ebay.com/oauth/api_scope/sell.inventory
/bulk_publish_offer:
post:
tags:
- offer
description: <span class="tablenote"><strong>Note:</strong> Each listing can be revised up to 250 times in one calendar day. If this revision threshold is reached, the seller will be blocked from revising the item until the next calendar day.</span><br /><br />This call is used to convert unpublished offers (up to 25) into published offers, or live eBay listings. The unique identifier (<strong>offerId</strong>) of each offer to publlish is passed into the request payload. It is possible that some unpublished offers will be successfully created into eBay listings, but others may fail. The response payload will show the results for each <strong>offerId</strong> value that is passed into the request payload. The <strong>errors</strong> and <strong>warnings</strong> containers will be returned for an offer that had one or more issues being published. <br/><br/>For those who prefer to publish one offer per call, the <strong>publishOffer</strong> method can be used instead. In the case of a multiple-variation listing, the <strong>publishOfferByInventoryItemGroup</strong> call should be used instead, as this call will convert all unpublished offers associated with an inventory item group into a multiple-variation listing.
operationId: bulkPublishOffer
requestBody:
description: The base request of the <strong>bulkPublishOffer</strong> method.
content:
application/json:
schema:
description: The base request of the <strong>bulkPublishOffer</strong> method.
$ref: '#/components/schemas/BulkOffer'
required: true
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/BulkPublishResponse'
x-response-codes:
errors:
'25028':
domain: API_INVENTORY
category: REQUEST
description: '{field} is not applicable and has been dropped'
'25030':
domain: API_INVENTORY
category: REQUEST
description: '{field} is not applicable for the condition and has been dropped'
'25033':
domain: API_INVENTORY
category: REQUEST
description: Duplicate policy IDs found
'25037':
domain: API_INVENTORY
category: REQUEST
description: Item level Eco Participation Fee will be ignored
'25401':
domain: API_INVENTORY
category: APPLICATION
description: Invalid listing options removed. {additionalInfo}
'25402':
domain: API_INVENTORY
category: APPLICATION
description: System warning. {additionalInfo}
'25753':
domain: API_INVENTORY
category: REQUEST
description: listingStartDate is in the past or the offer is live. Value is not updated on the listing.
'207':
description: Multi-Status
'400':
description: Bad Request
x-response-codes:
errors:
'25002':
domain: API_INVENTORY
category: REQUEST
description: Any User error. {additionalInfo}
'25003':
domain: API_INVENTORY
category: REQUEST
description: Invalid price. {additionalInfo}
'25004':
domain: API_INVENTORY
category: REQUEST
description: Invalid quantity. {additionalInfo}
'25005':
domain: API_INVENTORY
category: REQUEST
description: Invalid category. {additionalInfo}
'25006':
domain: API_INVENTORY
category: REQUEST
description: Invalid listing option. {additionalInfo}
'25007':
domain: API_INVENTORY
category: REQUEST
description: Invalid Shipping policy information. {additionalInfo}
'25008':
domain: API_INVENTORY
category: REQUEST
description: Invalid Payment policy information. {additionalInfo}
'25009':
domain: API_INVENTORY
category: REQUEST
description: Invalid Return policy information. {additionalInfo}
'25011':
domain: API_INVENTORY
category: REQUEST
description: Invalid tax information. {additionalInfo}
'25012':
domain: API_INVENTORY
category: REQUEST
description: Invalid location. {additionalInfo}
'25013':
domain: API_INVENTORY
category: REQUEST
description: Invalid InventoryItemGroup information. {additionalInfo}
'25014':
domain: API_INVENTORY
category: REQUEST
description: Invalid pictures. {additionalInfo}
'25015':
domain: API_INVENTORY
category: REQUEST
description: Invalid picture URL. {additionalInfo}
'25016':
domain: API_INVENTORY
category: REQUEST
description: Invalid {fieldName}. {additionalInfo}
'25017':
domain: API_INVENTORY
category: REQUEST
description: Missing field {fieldName}. {additionalInfo}
'25018':
domain: API_INVENTORY
category: REQUEST
description: Incomplete account information. {additionalInfo}
'25019':
domain: API_INVENTORY
category: REQUEST
description: Cannot revise listing. {additionalInfo}
'25020':
domain: API_INVENTORY
category: REQUEST
description: Invalid package details. {additionalInfo}
'25021':
domain: API_INVENTORY
category: REQUEST
description: Invalid condition information. {additionalInfo}
'25022':
domain: API_INVENTORY
category: REQUEST
description: Invalid attribute. {fieldName}
'25023':
domain: API_INVENTORY
category: REQUEST
description: Invalid compatibility information. {additionalInfo}
'25026':
domain: API_INVENTORY
category: REQUEST
description: Selling limits exceeded. {additionalInfo}
'25029':
domain: API_INVENTORY
category: REQUEST
description: '{field} is required for this category.'
'25031':
domain: API_INVENTORY
category: REQUEST
description: '{field} is not valid and needs to be a number between {min} and {max}'
'25032':
domain: API_INVENTORY
category: REQUEST
description: '{field} is not valid'
'25034':
domain: API_INVENTORY
category: REQUEST
description: Only {max value} policies can be specified
'25035':
domain: API_INVENTORY
category: REQUEST
description: The specified policy is not found for the market place
'25036':
domain: API_INVENTORY
category: REQUEST
description: The policy(ies) {PolicyId} is not of type {PolicyEnum}
'25038':
domain: API_INVENTORY
category: REQUEST
description: '{ItemId} cannot be revised if the item has a bid or a best offer or is ending within 12 hours'
'25039':
domain: API_INVENTORY
category: REQUEST
description: '{ItemId} cannot be revised if the item has a bid or a best offer and is ending within 12 hours'
'25040':
domain: API_INVENTORY
category: REQUEST
description: '{ItemId} cannot be revised if the item has a bid or a best offer and is ending within 12 hours'
'25041':
domain: API_INVENTORY
category: REQUEST
description: When listing an item with Refurbished condition, maximum handling time must be {replaceable_value} business day(s).
'25042':
domain: API_INVENTORY
category: REQUEST
description: When listing an item with Refurbished condition, free shipping must be provided.
'25043':
domain: API_INVENTORY
category: REQUEST
description: When listing an item with Refurbished condition, returns must be accepted.
'25044':
domain: API_INVENTORY
category: REQUEST
description: When listing an item with Refurbished condition, refund must be provided as Money Back.
'25045':
domain: API_INVENTORY
category: REQUEST
description: When listing an item with Refurbished condition, the minimum time you'll accept returns must be {replaceable_value} days.
'25046':
domain: API_INVENTORY
category: REQUEST
description: When listing an item with Refurbished condition, seller must pay the cost for return shipping.
'25047':
domain: API_INVENTORY
category: REQUEST
description: Seller is not eligible to use Refurbished Item Condition
'25048':
domain: API_INVENTORY
category: REQUEST
description: Seller is not eligible to use Refurbished Item Condition in this Category
'25049':
domain: API_INVENTORY
category: REQUEST
description: Seller is not eligible to use Refurbished Item Condition for the selected Brand
'25050':
domain: API_INVENTORY
category: REQUEST
description: When listing an item with Refurbished condition, {replaceable_value} cannot be used in the Title.
'25051':
domain: API_INVENTORY
category: REQUEST
description: When listing an item with Refurbished condition, {replaceable_value} cannot be used in the Subtitle
'25052':
domain: API_INVENTORY
category: REQUEST
description: When listing an item with Refurbished condition, at least {replaceable_value} images must be provided
'25601':
domain: API_INVENTORY
category: REQUEST
description: Invalid attribute. {fieldName}
'25604':
domain: API_INVENTORY
category: REQUEST
description: Input error. {additionalInfo}
'25709':
domain: API_INVENTORY
category: REQUEST
description: Invalid offerId
'25713':
domain: API_INVENTORY
category: REQUEST
description: 'This Offer is not available : {additionalInfo}.'
'25730':
domain: API_INVENTORY
category: REQUEST
description: The number of offers in the request cannot exceed {additionalInfo}.
'25731':
domain: API_INVENTORY
category: REQUEST
description: OfferId should be unique in the request.
'25732':
domain: API_INVENTORY
category: REQUEST
description: Offers associated with SKUs that are part of a variation group cannot be published using this endpoint.
'25752':
domain: API_INVENTORY
category: REQUEST
description: listingStartDate provided is invalid.
'25760':
domain: API_INVENTORY
category: REQUEST
description: shipToLocationAvailability quantity insufficient to create auction listings.
'500':
description: Internal Server Error
x-response-codes:
errors:
'25001':
domain: API_INVENTORY
category: APPLICATION
description: Any System error. {additionalInfo}
'25025':
domain: API_INVENTORY
category: APPLICATION
description: Concurrent access of Inventory or InventoryItemGroup. Please try again later
security:
- api_auth:
- https://api.ebay.com/oauth/api_scope/sell.inventory
/offer:
get:
tags:
- offer
description: This call retrieves all existing offers for the specified SKU value. The seller has the option of limiting the offers that are retrieved to a specific eBay marketplace, or to a listing format.<br /><br /><span class="tablenote"><strong>Note:</strong> At this time, the same SKU value can not be offered across multiple eBay marketplaces, and the only supported listing format is fixed-price, so the <strong>marketplace_id</strong> and <strong>format</strong> query parameters currently do not have any practical use for this call.</span><br/><br/><p>The <code>authorization</code> header is the only required HTTP header for this call. See the <strong>HTTP request headers</strong> section for more information.</p>
operationId: getOffers
parameters:
- name: format
in: query
description: This enumeration value sets the listing format for the offer. This query parameter will be passed in if the seller only wants to see offers in this specified listing format.
required: false
schema:
type: string
- name: limit
in: query
description: The value passed in this query parameter sets the maximum number of records to return per page of data. Although this field is a string, the value passed in this field should be a positive integer value. If this query parameter is not set, up to 100 records will be returned on each page of results.
required: false
schema:
type: string
- name: marketplace_id
in: query
description: The unique identifier of the eBay marketplace. This query parameter will be passed in if the seller only wants to see the product's offers on a specific eBay marketplace.<br /><br /><span class="tablenote"><strong>Note:</strong> At this time, the same SKU value can not be offered across multiple eBay marketplaces, so the <strong>marketplace_id</strong> query parameter currently does not have any practical use for this call.</span>
required: false
schema:
type: string
- name: offset
in: query
description: The value passed in this query parameter sets the page number to retrieve. Although this field is a string, the value passed in this field should be a integer value equal to or greater than <code>0</code>. The first page of records has a value of <code>0</code>, the second page of records has a value of <code>1</code>, and so on. If this query parameter is not set, its value defaults to <code>0</code>, and the first page of records is returned.
required: false
schema:
type: string
- name: sku
in: query
description: 'The seller-defined SKU value is passed in as a query parameter. All offers associated with this product are returned in the response.<br/><br/> <strong>Max length</strong>: 50.'
required: false
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/Offers'
'400':
description: Bad Request
x-response-codes:
errors:
'25706':
domain: API_INVENTORY
category: REQUEST
description: You have provided invalid pagination values. {additionalInfo}.
'25709':
domain: API_INVENTORY
category: REQUEST
description: Invalid value for {fieldName}. {additionalInfo}
'404':
description: Not Found
'500':
description: Internal Server Error
x-response-codes:
errors:
'25001':
domain: API_INVENTORY
category: APPLICATION
description: A system error has occurred. {additionalInfo}
security:
- api_auth:
- https://api.ebay.com/oauth/api_scope/sell.inventory.readonly
- https://api.ebay.com/oauth/api_scope/sell.inventory
post:
tags:
- offer
description: 'This call creates an offer for a specific inventory item on a specific eBay marketplace. It is up to the sellers whether they want to create a complete offer (with all necessary details) right from the start, or sellers can provide only some information with the initial <strong>createOffer</strong> call, and then make one or more subsequent <strong>updateOffer</strong> calls to complete the offer and prepare to publish the offer. Upon first creating an offer, the following fields are required in the request payload: <strong>sku</strong>, <strong>marketplaceId</strong>, and (listing) <strong>format</strong>. <br><br>Other information that will be required before an offer can be published are highlighted below. These settings are either set with <strong>createOffer</strong>, or they can be set with a subsequent <strong>updateOffer</strong> call: <ul><li>Inventory location</li> <li>Offer price</li> <li>Available quantity</li> <li>eBay listing category</li> <li>Referenced listing policy profiles to set payment, return, and fulfillment values/settings</li> </ul> <p><span class="tablenote"><strong>Note:</strong> Though the <strong>includeCatalogProductDetails</strong> parameter is not required to be submitted in the request, the parameter defaults to <code>true</code> if omitted.</span></p><p>If the call is successful, a unique <strong>offerId</strong> value is returned in the response. This value will be required for many other offer-related calls. Note that this call only stages an offer for publishing. The seller must run the <strong>publishOffer</strong> call to convert the offer to an active eBay listing.</p> <p>In addition to the <code>authorization</code> header, which is required for all eBay REST API calls, the <strong>createOffer</strong> call also requires the <code>Content-Language</code> header, that sets the natural language that will be used in the field values of the request payload. For US English, the code value passed in this header should be <code>en-US</code>. To view other supported <code>Content-Language</code> values, and to read more about all supported HTTP headers for eBay REST API calls, see the <a href="/api-docs/static/rest-request-components.html#HTTP">HTTP request headers</a> topic in the <strong>Using eBay RESTful APIs</strong> document.</p><p>For those who prefer to create multiple offers (up to 25 at a time) with one call, the <strong>bulkCreateOffer</strong> method can be used.</p>'
operationId: createOffer
parameters:
- name: Content-Language
in: header
description: This request header sets the natural language that will be provided in the field values of the request payload.
required: true
schema:
type: string
requestBody:
description: Details of the offer for the channel
content:
application/json:
schema:
description: Details of the offer for the channel
$ref: '#/components/schemas/EbayOfferDetailsWithKeys'
required: true
responses:
'201':
description: Created
headers:
Content-Language:
schema:
type: string
description: This response header sets the natural language that will be provided in the field values of the response payload.
content:
application/json:
schema:
$ref: '#/components/schemas/OfferResponse'
'400':
description: Bad Request
x-response-codes:
errors:
'25702':
domain: API_INVENTORY
category: REQUEST
description: '{skuValue} could not be found or is not available in the system.'
'25709':
domain: API_INVENTORY
category: REQUEST
description: Invalid value for {fieldName}. {additionalInfo}
'25752':
domain: API_INVENTORY
category: REQUEST
description: listingStartDate provided is invalid.
'25755':
domain: API_INVENTORY
category: REQUEST
description: listingDuration is required for auction offer.
'25756':
domain: API_INVENTORY
category: REQUEST
description: Auction format is not permitted with a SKU that is part of an InventoryItemGroup.
'25757':
domain: API_INVENTORY
category: REQUEST
description: auctionStartPrice is required for auction offer.
'25758':
domain: API_INVENTORY
category: REQUEST
description: auctionStartPrice and auctionReservePrice are not supported for fixed price offer.
'25761':
domain: API_INVENTORY
category: REQUEST
description: Discount pricing is not applicable for auction offer.
'25762':
domain: API_INVENTORY
category: REQUEST
description: availableQuantity is not applicable for auction offer.
'25763':
domain: API_INVENTORY
category: REQUEST
description: quantityLimitPerBuyer is not applicable for auction offer.
'25764':
domain: API_INVENTORY
category: REQUEST
description: eBayPlusIfEligible is not applicable for auction offer.
'500':
description: Internal Server Error
x-response-codes:
errors:
'25001':
domain: API_INVENTORY
category: APPLICATION
description: A system error has occurred. {additionalInfo}
security:
- api_auth:
- https://api.ebay.com/oauth/api_scope/sell.inventory
/offer/{offerId}:
get:
tags:
- offer
description: This call retrieves a specific published or unpublished offer. The unique identifier of the offer (<strong>offerId</strong>) is passed in at the end of the call URI.<p>The <code>authorization</code> header is the only required HTTP header for this call. See the <strong>HTTP request headers</strong> section for more information.</p>
operationId: getOffer
parameters:
- name: offerId
in: path
description: The unique identifier of the offer that is to be retrieved.
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/EbayOfferDetailsWithAll'
'400':
description: Bad Request
x-response-codes:
errors:
'25709':
domain: API_INVENTORY
category: REQUEST
description: Invalid value for {fieldName}. {additionalInfo}
'25713':
domain: API_INVENTORY
category: REQUEST
description: 'This Offer is not available : {additionalInfo}.'
'404':
description: Not Found
'500':
description: Internal Server Error
x-response-codes:
errors:
'25001':
domain: API_INVENTORY
category: APPLICATION
description: A system error has occurred. {additionalInfo}
security:
- api_auth:
- https://api.ebay.com/oauth/api_scope/sell.inventory.readonly
- https://api.ebay.com/oauth/api_scope/sell.inventory
put:
tags:
- offer
description: 'This call updates an existing offer. An existing offer may be in published state (active eBay listing), or in an unpublished state and yet to be published with the <strong>publishOffer</strong> call. The unique identifier (<strong>offerId</strong>) for the offer to update is passed in at the end of the call URI. <br/><br/> The <strong>updateOffer</strong> call does a complete replacement of the existing offer object, so all fields that make up the current offer object are required, regardless of whether their values changed. <br/><br/> Other information that is required before an unpublished offer can be published or before a published offer can be revised include: <ul><li>Inventory location</li> <li>Offer price</li> <li>Available quantity</li> <li>eBay listing category</li> <li>Referenced listing policy profiles to set payment, return, and fulfillment values/settings</li> </ul> <p><span class="tablenote"><strong>Note:</strong> Though the <strong>includeCatalogProductDetails</strong> parameter is not required to be submitted in the request, the parameter defaults to <code>true</code> if omitted from both the <strong>updateOffer</strong> and the <strong>createOffer</strong> calls. If a value is specified in the <strong>updateOffer</strong> call, this value will be used.</span><br /><br /><span class="tablenote"><strong>Note:</strong> Each listing can be revised up to 250 times in one calendar day. If this revision threshold is reached, the seller will be blocked from revising the item until the next calendar day.</span><br /><br /><span class="tablenote"><strong>Note:</strong> Each listing can be revised up to 250 times in one calendar day. If this revision threshold is reached, the seller will be blocked from revising the item until the next calendar day.</span></p> <p>For published offers, the <strong>listingDescription</strong> field is also required to update the offer/eBay listing. For unpublished offers, this field is not necessarily required unless it is already set for the unpublished offer.</p> <p>In addition to the <code>authorization</code> header, which is required for all eBay REST API calls, the <strong>updateOffer</strong> call also requires the <code>Content-Language</code> header, that sets the natural language that will be used in the field values of the request payload. For US English, the code value passed in this header should be <code>en-US</code>. To view other supported <code>Content-Language</code> values, and to read more about all supported HTTP headers for eBay REST API calls, see the <a href="/api-docs/static/rest-request-components.html#HTTP">HTTP request headers</a> topic in the <strong>Using eBay RESTful APIs</strong> document.</p>'
operationId: updateOffer
parameters:
- name: Content-Language
in: header
description: This request header sets the natural language that will be provided in the field values of the request payload.
required: true
schema:
type: string
- name: offerId
in: path
description: The unique identifier of the offer that is being updated. This identifier is passed in at the end of the call URI.
required: true
schema:
type: string
requestBody:
description: Details of the offer for the channel
content:
application/json:
schema:
description: Details of the offer for the channel
$ref: '#/components/schemas/EbayOfferDetailsWithId'
required: true
responses:
'200':
description: Success
headers:
Content-Language:
schema:
type: string
description: This response header sets the natural language that will be provided in the field values of the response payload.
content:
application/json:
schema:
$ref: '#/components/schemas/OfferResponse'
x-response-codes:
errors:
'25028':
domain: API_INVENTORY
category: REQUEST
description: '{field} is not applicable and has been dropped'
'25030':
domain: API_INVENTORY
category: REQUEST
description: '{field} is not applicable for the condition and has been dropped'
'25033':
domain: API_INVENTORY
category: REQUEST
description: Duplicate policy IDs found
'25037':
domain: API_INVENTORY
category: REQUEST
description: Item level Eco Participation Fee will be ignored
'25401':
domain: API_INVENTORY
category: APPLICATION
description: Invalid listing options removed. {additionalInfo}
'25402':
domain: API_INVENTORY
category: APPLICATION
description: System warning. {additionalInfo}
'25753':
domain: API_INVENTORY
category: REQUEST
description: listingStartDate is in the past or the offer is live. Value is not updated on the listing.
'204':
description: No Content
'400':
description: Bad Request
x-response-codes:
errors:
'25002':
domain: API_INVENTORY
category: REQUEST
description: A user error has occurred. {additionalInfo}
'25003':
domain: API_INVENTORY
category: REQUEST
description: The eBay listing associated with the inventory item, or the unpublished offer has an invalid price. {additionalInfo}
'25004':
domain: API_INVENTORY
category: REQUEST
description: The eBay listing associated with the inventory item, or the unpublished offer has an invalid quantity. {additionalInfo}
'25005':
domain: API_INVENTORY
category: REQUEST
description: The eBay listing associated with the inventory item, or the unpublished offer has an invalid category ID. {additionalInfo}
'25006':
domain: API_INVENTORY
category: REQUEST
description: The eBay listing associated with the inventory item, or the unpublished offer has an invalid listing option. {additionalInfo}
'25007':
domain: API_INVENTORY
category: REQUEST
description: The eBay listing associated with the inventory item, or the unpublished offer has invalid data in the associated Fulfillment policy. {additionalInfo}
'25008':
domain: API_INVENTORY
category: REQUEST
description: The eBay listing associated with the inventory item, or the unpublished offer has invalid data in the associated Payment policy. {additionalInfo}
'25009':
domain: API_INVENTORY
category: REQUEST
description: The eBay listing associated with the inventory item, or the unpublished offer has invalid data in the associated Return policy. {additionalInfo}
'25011':
domain: API_INVENTORY
category: REQUEST
description: The eBay listing associated with the inventory item, or the unpublished offer has invalid tax information. {additionalInfo}
'25012':
domain: API_INVENTORY
category: REQUEST
description: Invalid inventory location. {additionalInfo}
'25013':
domain: API_INVENTORY
category: REQUEST
description: Invalid data in the Inventory Item Group. {additionalInfo}
'25014':
domain: API_INVENTORY
category: REQUEST
description: The eBay listing associated with the inventory item, or the unpublished offer has invalid pictures. {additionalInfo}
'25015':
domain: API_INVENTORY
category: REQUEST
description: The eBay listing associated with the inventory item, or the unpublished offer has an invalid picture URL. {additionalInfo}
'25016':
domain: API_INVENTORY
category: REQUEST
description: The {fieldName} value is invalid. {additionalInfo}
'25017':
domain: API_INVENTORY
category: REQUEST
description: '{fieldName} is missing. {additionalInfo}'
'25018':
domain: API_INVENTORY
category: REQUEST
description: Incomplete account information. {additionalInfo}
'25019':
domain: API_INVENTORY
category: REQUEST
description: Cannot revise listing. {additionalInfo}
'25020':
domain: API_INVENTORY
category: REQUEST
description: The eBay listing associated with the inventory item, or the unpublished offer has invalid shipping package details. {additionalInfo}
'25021':
domain: API_INVENTORY
category: REQUEST
description: The eBay listing associated with the inventory item, or the unpublished offer has invalid item condition information. {additionalInfo}
'25022':
domain: API_INVENTORY
category: REQUEST
description: Invalid attribute. {fieldName}
'25023':
domain: API_INVENTORY
category: REQUEST
description: Invalid compatibility information. {additionalInfo}
'25026':
domain: API_INVENTORY
category: REQUEST
description: Selling limit exceeded. {additionalInfo}
'25029':
domain: API_INVENTORY
category: REQUEST
description: '{field} is required for this category.'
'25031':
domain: API_INVENTORY
category: REQUEST
description: '{field} is not valid and needs to be a number between {min} and {max}'
'25032':
domain: API_INVENTORY
category: REQUEST
description: '{field} is not valid'
'25034':
domain: API_INVENTORY
category: REQUEST
description: Only {max value} policies can be specified
'25035':
domain: API_INVENTORY
category: REQUEST
description: The specified policy is not found for the market place
'25036':
domain: API_INVENTORY
category: REQUEST
description: The policy(ies) {PolicyId} is not of type {PolicyEnum}
'25038':
domain: API_INVENTORY
category: REQUEST
description: '{ItemId} cannot be revised if the item has a bid or a best offer or is ending within 12 hours'
'25039':
domain: API_INVENTORY
category: REQUEST
description: '{ItemId} cannot be revised if the item has a bid or a best offer and is ending within 12 hours'
'25040':
domain: API_INVENTORY
category: REQUEST
description: '{ItemId} cannot be revised if the item has a bid or a best offer and is ending within 12 hours'
'25601':
domain: API_INVENTORY
category: REQUEST
description: Invalid attribute. {fieldName}
'25604':
domain: API_INVENTORY
category: REQUEST
description: Input error. {additionalInfo}
'25710':
domain: API_INVENTORY
category: REQUEST
description: We didn't find the resource/entity you are requesting. Please verify the request
'25713':
domain: API_INVENTORY
category: REQUEST
description: 'This Offer is not available : {additionalInfo}.'
'25752':
domain: API_INVENTORY
category: REQUEST
description: listingStartDate provided is invalid.
'25756':
domain: API_INVENTORY
category: REQUEST
description: Auction format is not permitted with a SKU that is part of an InventoryItemGroup.
'25757':
domain: API_INVENTORY
category: REQUEST
description: auctionStartPrice is required for auction offer.
'25758':
domain: API_INVENTORY
category: REQUEST
description: auctionStartPrice and auctionReservePrice are not supported for fixed price offer.
'25761':
domain: API_INVENTORY
category: REQUEST
description: Discount pricing is not applicable for auction offer.
'25762':
domain: API_INVENTORY
category: REQUEST
description: availableQuantity is not applicable for auction offer.
'25763':
domain: API_INVENTORY
category: REQUEST
description: quantityLimitPerBuyer is not applicable for auction offer.
'25764':
domain: API_INVENTORY
category: REQUEST
description: eBayPlusIfEligible is not applicable for auction offer.
'404':
description: Not Found
'500':
description: Internal Server Error
x-response-codes:
errors:
'25001':
domain: API_INVENTORY
category: APPLICATION
description: A system error has occurred. {additionalInfo}
'25025':
domain: API_INVENTORY
category: APPLICATION
description: Concurrent access of the same Inventory or Inventory Item Group object is not allowed. Please try again later.
security:
- api_auth:
- https://api.ebay.com/oauth/api_scope/sell.inventory
delete:
tags:
- offer
description: If used against an unpublished offer, this call will permanently delete that offer. In the case of a published offer (or live eBay listing), a successful call will either end the single-variation listing associated with the offer, or it will remove that product variation from the eBay listing and also automatically remove that product variation from the inventory item group. In the case of a multiple-variation listing, the <strong>deleteOffer</strong> will not remove the product variation from the listing if that variation has one or more sales. If that product variation has one or more sales, the seller can alternately just set the available quantity of that product variation to <code>0</code>, so it is not available in the eBay search or View Item page, and then the seller can remove that product variation from the inventory item group at a later time.
operationId: deleteOffer
parameters:
- name: offerId
in: path
description: The unique identifier of the offer to delete. The unique identifier of the offer (<strong>offerId</strong>) is passed in at the end of the call URI.
required: true
schema:
type: string
responses:
'204':
description: No Content
'400':
description: Bad Request
x-response-codes:
errors:
'25713':
domain: API_INVENTORY
category: REQUEST
description: 'This Offer is not available : {additionalInfo}.'
'404':
description: Not Found
'500':
description: Internal Server Error
x-response-codes:
errors:
'25001':
domain: API_INVENTORY
category: APPLICATION
description: A system error has occurred. {additionalInfo}
security:
- api_auth:
- https://api.ebay.com/oauth/api_scope/sell.inventory
/offer/get_listing_fees:
post:
tags:
- offer
description: This call is used to retrieve the expected listing fees for up to 250 unpublished offers. An array of one or more <strong>offerId</strong> values are passed in under the <strong>offers</strong> container.<br/><br/> In the response payload, all listing fees are grouped by eBay marketplace, and listing fees per offer are not shown. A <strong>fees</strong> container will be returned for each eBay marketplace where the seller is selling the products associated with the specified offers. <br/><br/> Errors will occur if the seller passes in <strong>offerIds</strong> that represent published offers, so this call should be made before the seller publishes offers with the <strong>publishOffer</strong>.
operationId: getListingFees
requestBody:
description: List of offers that needs fee information
content:
application/json:
schema:
description: List of offers that needs fee information
$ref: '#/components/schemas/OfferKeysWithId'
required: false
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/FeesSummaryResponse'
'400':
description: Bad Request
x-response-codes:
errors:
'25709':
domain: API_INVENTORY
category: REQUEST
description: Invalid value for {fieldName}. {additionalInfo}
'25754':
domain: API_INVENTORY
category: REQUEST
description: One or more provided offerId(s) are invalid. All offerId(s) in the request should belong to an inventoryItem or inventoryItemGroup for a specific marketplaceId and format.
'404':
description: Not Found
'500':
description: Internal Server Error
x-response-codes:
errors:
'25001':
domain: API_INVENTORY
category: APPLICATION
description: A system error has occurred. {additionalInfo}
security:
- api_auth:
- https://api.ebay.com/oauth/api_scope/sell.inventory.readonly
- https://api.ebay.com/oauth/api_scope/sell.inventory
/offer/{offerId}/publish/:
post:
tags:
- offer
description: <span class="tablenote"><strong>Note:</strong> Each listing can be revised up to 250 times in one calendar day. If this revision threshold is reached, the seller will be blocked from revising the item until the next calendar day.</span><br /><br />This call is used to convert an unpublished offer into a published offer, or live eBay listing. The unique identifier of the offer (<strong>offerId</strong>) is passed in at the end of the call URI.<br/><br/>For those who prefer to publish multiple offers (up to 25 at a time) with one call, the <strong>bulkPublishOffer</strong> method can be used. In the case of a multiple-variation listing, the <strong>publishOfferByInventoryItemGroup</strong> call should be used instead, as this call will convert all unpublished offers associated with an inventory item group into a multiple-variation listing.
operationId: publishOffer
parameters:
- name: offerId
in: path
description: The unique identifier of the offer that is to be published.
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/PublishResponse'
x-response-codes:
errors:
'25028':
domain: API_INVENTORY
category: REQUEST
description: '{field} is not applicable and has been dropped'
'25030':
domain: API_INVENTORY
category: REQUEST
description: '{field} is not applicable for the condition and has been dropped'
'25033':
domain: API_INVENTORY
category: REQUEST
description: Duplicate policy IDs found
'25037':
domain: API_INVENTORY
category: REQUEST
description: Item level Eco Participation Fee will be ignored
'25401':
domain: API_INVENTORY
category: REQUEST
description: Invalid listing format removed {additionalInfo}
'25402':
domain: API_INVENTORY
category: REQUEST
description: System warning. {additionalInfo}
'25753':
domain: API_INVENTORY
category: REQUEST
description: listingStartDate is in the past or the offer is live. Value is not updated on the listing.
'400':
description: Bad Request
x-response-codes:
errors:
'25002':
domain: API_INVENTORY
category: REQUEST
description: A user error has occurred. {additionalInfo}
'25003':
domain: API_INVENTORY
category: REQUEST
description: The eBay listing associated with the inventory item, or the unpublished offer has an invalid price. {additionalInfo}
'25004':
domain: API_INVENTORY
category: REQUEST
description: The eBay listing associated with the inventory item, or the unpublished offer has an invalid quantity. {additionalInfo}
'25005':
domain: API_INVENTORY
category: REQUEST
description: The eBay listing associated with the inventory item, or the unpublished offer has an invalid category ID. {additionalInfo}
'25006':
domain: API_INVENTORY
category: REQUEST
description: The eBay listing associated with the inventory item, or the unpublished offer has an invalid listing option. {additionalInfo}
'25007':
domain: API_INVENTORY
category: REQUEST
description: The eBay listing associated with the inventory item, or the unpublished offer has invalid data in the associated Fulfillment policy. {additionalInfo}
'25008':
domain: API_INVENTORY
category: REQUEST
description: The eBay listing associated with the inventory item, or the unpublished offer has invalid data in the associated Payment policy. {additionalInfo}
'25009':
domain: API_INVENTORY
category: REQUEST
description: The eBay listing associated with the inventory item, or the unpublished offer has invalid data in the associated Return policy. {additionalInfo}
'25011':
domain: API_INVENTORY
category: REQUEST
description: Invalid tax information. {additionalInfo}
'25012':
domain: API_INVENTORY
category: REQUEST
description: Invalid inventory location. {additionalInfo}
'25013':
domain: API_INVENTORY
category: REQUEST
description: Invalid data in the Inventory Item Group. {additionalInfo}
'25014':
domain: API_INVENTORY
category: REQUEST
description: The eBay listing associated with the inventory item, or the unpublished offer has invalid pictures. {additionalInfo}
'25015':
domain: API_INVENTORY
category: REQUEST
description: The eBay listing associated with the inventory item, or the unpublished offer has an invalid picture URL. {additionalInfo}
'25016':
domain: API_INVENTORY
category: REQUEST
description: The {fieldName} value is invalid. {additionalInfo}
'25017':
domain: API_INVENTORY
category: REQUEST
description: '{fieldName} is missing. {additionalInfo}'
'25018':
domain: API_INVENTORY
category: REQUEST
description: Incomplete account information. {additionalInfo}
'25019':
domain: API_INVENTORY
category: REQUEST
description: Cannot revise listing. {additionalInfo}
'25020':
domain: API_INVENTORY
category: REQUEST
description: The eBay listing associated with the inventory item, or the unpublished offer has invalid shipping package details. {additionalInfo}
'25021':
domain: API_INVENTORY
category: REQUEST
description: The eBay listing associated with the inventory item, or the unpublished offer has invalid item condition information. {additionalInfo}
'25022':
domain: API_INVENTORY
category: REQUEST
description: Invalid attribute. {fieldName}
'25023':
domain: API_INVENTORY
category: REQUEST
description: Invalid compatibility information. {additionalInfo}
'25026':
domain: API_INVENTORY
category: REQUEST
description: Selling limit exceeded. {additionalInfo}
'25029':
domain: API_INVENTORY
category: REQUEST
description: '{field} is required for this category.'
'25031':
domain: API_INVENTORY
category: REQUEST
description: '{field} is not valid and needs to be a number between {min} and {max}'
'25032':
domain: API_INVENTORY
category: REQUEST
description: '{field} is not valid'
'25034':
domain: API_INVENTORY
category: REQUEST
description: Only {max value} policies can be specified
'25035':
domain: API_INVENTORY
category: REQUEST
description: The specified policy is not found for the market place
'25036':
domain: API_INVENTORY
category: REQUEST
description: The policy(ies) {PolicyId} is not of type {PolicyEnum}
'25038':
domain: API_INVENTORY
category: REQUEST
description: '{ItemId} cannot be revised if the item has a bid or a best offer or is ending within 12 hours'
'25039':
domain: API_INVENTORY
category: REQUEST
description: '{ItemId} cannot be revised if the item has a bid or a best offer and is ending within 12 hours'
'25040':
domain: API_INVENTORY
category: REQUEST
description: '{ItemId} cannot be revised if the item has a bid or a best offer and is ending within 12 hours'
'25041':
domain: API_INVENTORY
category: REQUEST
description: When listing an item with Refurbished condition, maximum handling time must be {replaceable_value} business day(s).
'25042':
domain: API_INVENTORY
category: REQUEST
description: When listing an item with Refurbished condition, free shipping must be provided.
'25043':
domain: API_INVENTORY
category: REQUEST
description: When listing an item with Refurbished condition, returns must be accepted.
'25044':
domain: API_INVENTORY
category: REQUEST
description: When listing an item with Refurbished condition, refund must be provided as Money Back.
'25045':
domain: API_INVENTORY
category: REQUEST
description: When listing an item with Refurbished condition, the minimum time you'll accept returns must be {replaceable_value} days.
'25046':
domain: API_INVENTORY
category: REQUEST
description: When listing an item with Refurbished condition, seller must pay the cost for return shipping.
'25047':
domain: API_INVENTORY
category: REQUEST
description: Seller is not eligible to use Refurbished Item Condition
'25048':
domain: API_INVENTORY
category: REQUEST
description: Seller is not eligible to use Refurbished Item Condition in this Category
'25049':
domain: API_INVENTORY
category: REQUEST
description: Seller is not eligible to use Refurbished Item Condition for the selected Brand
'25050':
domain: API_INVENTORY
category: REQUEST
description: When listing an item with Refurbished condition, {replaceable_value} cannot be used in the Title.
'25051':
domain: API_INVENTORY
category: REQUEST
description: When listing an item with Refurbished condition, {replaceable_value} cannot be used in the Subtitle
'25052':
domain: API_INVENTORY
category: REQUEST
description: When listing an item with Refurbished condition, at least {replaceable_value} images must be provided
'25601':
domain: API_INVENTORY
category: REQUEST
description: '{fieldName} is an invalid attribute.'
'25604':
domain: API_INVENTORY
category: REQUEST
description: Input error. {additionalInfo}
'25713':
domain: API_INVENTORY
category: REQUEST
description: 'This Offer is not available : {additionalInfo}.'
'25752':
domain: API_INVENTORY
category: REQUEST
description: listingStartDate provided is invalid.
'25760':
domain: API_INVENTORY
category: REQUEST
description: shipToLocationAvailability quantity insufficient to create auction listings.
'404':
description: Not Found
'500':
description: Internal Server Error
x-response-codes:
errors:
'25001':
domain: API_INVENTORY
category: APPLICATION
description: A system error has occurred. {additionalInfo}
'25025':
domain: API_INVENTORY
category: APPLICATION
description: Concurrent access of the same Inventory or Inventory Item Group object is not allowed. Please try again later.
security:
- api_auth:
- https://api.ebay.com/oauth/api_scope/sell.inventory
/offer/publish_by_inventory_item_group/:
post:
tags:
- offer
description: <span class="tablenote"><strong>Note:</strong> Please note that any eBay listing created using the Inventory API cannot be revised or relisted using the Trading API calls.</span><br/><br/><span class="tablenote"><strong>Note:</strong> Each listing can be revised up to 250 times in one calendar day. If this revision threshold is reached, the seller will be blocked from revising the item until the next calendar day.</span><br /><br />This call is used to convert all unpublished offers associated with an inventory item group into an active, multiple-variation listing.<br/><br/> The unique identifier of the inventory item group (<strong>inventoryItemGroupKey</strong>) is passed in the request payload. All inventory items and their corresponding offers in the inventory item group must be valid (meet all requirements) for the <strong>publishOfferByInventoryItemGroup</strong> call to be completely successful. For any inventory items in the group that are missing required data or have no corresponding offers, the <strong>publishOfferByInventoryItemGroup</strong> will create a new multiple-variation listing, but any inventory items with missing required data/offers will not be in the newly-created listing. If any inventory items in the group to be published have invalid data, or one or more of the inventory items have conflicting data with one another, the <strong>publishOfferByInventoryItemGroup</strong> call will fail. Be sure to check for any error or warning messages in the call response for any applicable information about one or more inventory items/offers having issues.
operationId: publishOfferByInventoryItemGroup
requestBody:
description: The identifier of the inventory item group to publish and the eBay marketplace where the listing will be published is needed in the request payload.
content:
application/json:
schema:
description: The identifier of the inventory item group to publish and the eBay marketplace where the listing will be published is needed in the request payload.
$ref: '#/components/schemas/PublishByInventoryItemGroupRequest'
required: true
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/PublishResponse'
x-response-codes:
errors:
'25028':
domain: API_INVENTORY
category: REQUEST
description: '{field} is not applicable and has been dropped'
'25030':
domain: API_INVENTORY
category: REQUEST
description: '{field} is not applicable for the condition and has been dropped'
'25033':
domain: API_INVENTORY
category: REQUEST
description: Duplicate policy IDs found
'25037':
domain: API_INVENTORY
category: REQUEST
description: Item level Eco Participation Fee will be ignored
'25401':
domain: API_INVENTORY
category: APPLICATION
description: Invalid listing options removed. {additionalInfo}
'25402':
domain: API_INVENTORY
category: APPLICATION
description: System warning. {additionalInfo}
'25753':
domain: API_INVENTORY
category: REQUEST
description: listingStartDate is in the past or the offer is live. Value is not updated on the listing.
'400':
description: Bad Request
x-response-codes:
errors:
'25002':
domain: API_INVENTORY
category: REQUEST
description: Any User error. {additionalInfo}
'25003':
domain: API_INVENTORY
category: REQUEST
description: Invalid price. {additionalInfo}
'25004':
domain: API_INVENTORY
category: REQUEST
description: Invalid quantity. {additionalInfo}
'25005':
domain: API_INVENTORY
category: REQUEST
description: Invalid category. {additionalInfo}
'25006':
domain: API_INVENTORY
category: REQUEST
description: Invalid listing option. {additionalInfo}
'25007':
domain: API_INVENTORY
category: REQUEST
description: Invalid Shipping policy information. {additionalInfo}
'25008':
domain: API_INVENTORY
category: REQUEST
description: Invalid Payment policy information. {additionalInfo}
'25009':
domain: API_INVENTORY
category: REQUEST
description: Invalid Return policy information. {additionalInfo}
'25011':
domain: API_INVENTORY
category: REQUEST
description: Invalid tax information. {additionalInfo}
'25012':
domain: API_INVENTORY
category: REQUEST
description: Invalid location. {additionalInfo}
'25013':
domain: API_INVENTORY
category: REQUEST
description: Invalid InventoryItemGroup information. {additionalInfo}
'25014':
domain: API_INVENTORY
category: REQUEST
description: Invalid pictures. {additionalInfo}
'25015':
domain: API_INVENTORY
category: REQUEST
description: Invalid picture URL. {additionalInfo}
'25016':
domain: API_INVENTORY
category: REQUEST
description: Invalid {fieldName}. {additionalInfo}
'25017':
domain: API_INVENTORY
category: REQUEST
description: Missing field {fieldName}. {additionalInfo}
'25018':
domain: API_INVENTORY
category: REQUEST
description: Incomplete account information. {additionalInfo}
'25019':
domain: API_INVENTORY
category: REQUEST
description: Cannot revise listing. {additionalInfo}
'25020':
domain: API_INVENTORY
category: REQUEST
description: Invalid package details. {additionalInfo}
'25021':
domain: API_INVENTORY
category: REQUEST
description: Invalid condition information. {additionalInfo}
'25022':
domain: API_INVENTORY
category: REQUEST
description: Invalid attribute. {fieldName}
'25023':
domain: API_INVENTORY
category: REQUEST
description: Invalid compatibility information. {additionalInfo}
'25026':
domain: API_INVENTORY
category: REQUEST
description: Selling limits exceeded. {additionalInfo}
'25029':
domain: API_INVENTORY
category: REQUEST
description: '{field} is required for this category.'
'25031':
domain: API_INVENTORY
category: REQUEST
description: '{field} is not valid and needs to be a number between {min} and {max}'
'25032':
domain: API_INVENTORY
category: REQUEST
description: '{field} is not valid'
'25034':
domain: API_INVENTORY
category: REQUEST
description: Only {max value} policies can be specified
'25035':
domain: API_INVENTORY
category: REQUEST
description: The specified policy is not found for the market place
'25036':
domain: API_INVENTORY
category: REQUEST
description: The policy(ies) {PolicyId} is not of type {PolicyEnum}
'25038':
domain: API_INVENTORY
category: REQUEST
description: '{ItemId} cannot be revised if the item has a bid or a best offer or is ending within 12 hours'
'25039':
domain: API_INVENTORY
category: REQUEST
description: '{ItemId} cannot be revised if the item has a bid or a best offer and is ending within 12 hours'
'25040':
domain: API_INVENTORY
category: REQUEST
description: '{ItemId} cannot be revised if the item has a bid or a best offer and is ending within 12 hours'
'25041':
domain: API_INVENTORY
category: REQUEST
description: When listing an item with Refurbished condition, maximum handling time must be {replaceable_value} business day(s).
'25042':
domain: API_INVENTORY
category: REQUEST
description: When listing an item with Refurbished condition, free shipping must be provided.
'25043':
domain: API_INVENTORY
category: REQUEST
description: When listing an item with Refurbished condition, returns must be accepted.
'25044':
domain: API_INVENTORY
category: REQUEST
description: When listing an item with Refurbished condition, refund must be provided as Money Back.
'25045':
domain: API_INVENTORY
category: REQUEST
description: When listing an item with Refurbished condition, the minimum time you'll accept returns must be {replaceable_value} days.
'25046':
domain: API_INVENTORY
category: REQUEST
description: When listing an item with Refurbished condition, seller must pay the cost for return shipping.
'25047':
domain: API_INVENTORY
category: REQUEST
description: Seller is not eligible to use Refurbished Item Condition
'25048':
domain: API_INVENTORY
category: REQUEST
description: Seller is not eligible to use Refurbished Item Condition in this Category
'25049':
domain: API_INVENTORY
category: REQUEST
description: Seller is not eligible to use Refurbished Item Condition for the selected Brand
'25050':
domain: API_INVENTORY
category: REQUEST
description: When listing an item with Refurbished condition, {replaceable_value} cannot be used in the Title.
'25051':
domain: API_INVENTORY
category: REQUEST
description: When listing an item with Refurbished condition, {replaceable_value} cannot be used in the Subtitle
'25052':
domain: API_INVENTORY
category: REQUEST
description: When listing an item with Refurbished condition, at least {replaceable_value} images must be provided
'25601':
domain: API_INVENTORY
category: REQUEST
description: Invalid attribute. {fieldName}
'25604':
domain: API_INVENTORY
category: REQUEST
description: Input error. {additionalInfo}
'25705':
domain: API_INVENTORY
category: REQUEST
description: The Inventory Item Group named {inventoryItemGroupKey} could not be found or is not available in the system.
'25752':
domain: API_INVENTORY
category: REQUEST
description: listingStartDate provided is invalid.
'500':
description: Internal Server Error
x-response-codes:
errors:
'25001':
domain: API_INVENTORY
category: APPLICATION
description: Any System error. {additionalInfo}
'25025':
domain: API_INVENTORY
category: APPLICATION
description: Concurrent access of Inventory or InventoryItemGroup. Please try again later
security:
- api_auth:
- https://api.ebay.com/oauth/api_scope/sell.inventory
/offer/{offerId}/withdraw:
post:
tags:
- offer
description: This call is used to end a single-variation listing that is associated with the specified offer. This call is used in place of the <strong>deleteOffer</strong> call if the seller only wants to end the listing associated with the offer but does not want to delete the offer object. With this call, the offer object remains, but it goes into the unpublished state, and will require a <strong>publishOffer</strong> call to relist the offer.<br><br>To end a multiple-variation listing that is associated with an inventory item group, the <strong>withdrawOfferByInventoryItemGroup</strong> method can be used. This call only ends the multiple-variation listing associated with an inventory item group but does not delete the inventory item group object, nor does it delete any of the offers associated with the inventory item group, but instead all of these offers go into the unpublished state.
operationId: withdrawOffer
parameters:
- name: offerId
in: path
description: The unique identifier of the offer that is to be withdrawn. This value is passed into the path of the call URI.
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/WithdrawResponse'
x-response-codes:
errors:
'25402':
domain: API_INVENTORY
category: APPLICATION
description: System warning. {additionalInfo}
'400':
description: Bad Request
x-response-codes:
errors:
'25002':
domain: API_INVENTORY
category: REQUEST
description: Any User error. {additionalInfo}
'25713':
domain: API_INVENTORY
category: REQUEST
description: 'This Offer is not available : {additionalInfo}.'
'404':
description: Not Found
'500':
description: Internal Server Error
x-response-codes:
errors:
'25001':
domain: API_INVENTORY
category: APPLICATION
description: Any System error. {additionalInfo}
security:
- api_auth:
- https://api.ebay.com/oauth/api_scope/sell.inventory
/offer/withdraw_by_inventory_item_group:
post:
tags:
- offer
description: This call is used to end a multiple-variation eBay listing that is associated with the specified inventory item group. This call only ends multiple-variation eBay listing associated with the inventory item group but does not delete the inventory item group object. Similarly, this call also does not delete any of the offers associated with the inventory item group, but instead all of these offers go into the unpublished state. If the seller wanted to relist the multiple-variation eBay listing, they could use the <strong>publishOfferByInventoryItemGroup</strong> method.
operationId: withdrawOfferByInventoryItemGroup
requestBody:
description: The base request of the <strong>withdrawOfferByInventoryItemGroup</strong> call.
content:
application/json:
schema:
description: The base request of the <strong>withdrawOfferByInventoryItemGroup</strong> call.
$ref: '#/components/schemas/WithdrawByInventoryItemGroupRequest'
required: true
responses:
'204':
description: No Content
'400':
description: Bad Request
x-response-codes:
errors:
'25725':
domain: API_INVENTORY
category: REQUEST
description: No offer found
'500':
description: Internal Server Error
x-response-codes:
errors:
'25001':
domain: API_INVENTORY
category: APPLICATION
description: Any System error. {additionalInfo}
security:
- api_auth:
- https://api.ebay.com/oauth/api_scope/sell.inventory
/location/{merchantLocationKey}:
get:
tags:
- location
description: This call retrieves all defined details of the inventory location that is specified by the <b>merchantLocationKey</b> path parameter. <p>The <code>authorization</code> HTTP header is the only required request header for this call. </p><p>A successful call will return an HTTP status value of <i>200 OK</i>.</p>
operationId: getInventoryLocation
parameters:
- name: merchantLocationKey
in: path
description: 'A unique merchant-defined key (ID) for an inventory location. This value is passed in at the end of the call URI to specify the inventory location to retrieve. <br/><br/><b>Max length</b>: 36'
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/InventoryLocationResponse'
'400':
description: Bad Request
x-response-codes:
errors:
'25804':
domain: API_INVENTORY
category: REQUEST
description: Input error. {additionalInfo}
'25805':
domain: API_INVENTORY
category: REQUEST
description: '{fieldName} Not Found.'
'404':
description: Not Found
'500':
description: Internal Server Error
x-response-codes:
errors:
'25001':
domain: API_INVENTORY
category: APPLICATION
description: System error. {additionalInfo}
security:
- api_auth:
- https://api.ebay.com/oauth/api_scope/sell.inventory.readonly
- https://api.ebay.com/oauth/api_scope/sell.inventory
post:
tags:
- location
description: <p>Use this call to create a new inventory location. In order to create and publish an offer (and create an eBay listing), a seller must have at least one inventory location, as every offer must be associated with a location.</p><p>Upon first creating an inventory location, only a seller-defined location identifier and a physical location is required, and once set, these values can not be changed. The unique identifier value (<i>merchantLocationKey</i>) is passed in at the end of the call URI. This <i>merchantLocationKey</i> value will be used in other Inventory Location calls to identify the inventory location to perform an action against.</p><p>At this time, location types are either warehouse or store. Warehouse locations are used for traditional shipping, and store locations are generally used by US merchants selling products through the In-Store Pickup program, or used by UK, Australian, and German merchants selling products through the Click and Collect program. A full address is required for store inventory locations. However, for warehouse inventory locations, a full street address is not needed, but the city, state/province, and country of the location must be provided. </p><p>Note that all inventory locations are "enabled" by default when they are created, and you must specifically disable them (by passing in a value of <code>DISABLED</code> in the <strong>merchantLocationStatus</strong> field) if you want them to be set to the disabled state. The seller's inventory cannot be loaded to inventory locations in the disabled state.</p> <p>In addition to the <code>authorization</code> header, which is required for all eBay REST API calls, the following table includes another request header that is mandatory for the <strong>createInventoryLocation</strong> call, and two other request headers that are optional:</p><br/> <table> <tr> <th>Header</th> <th>Description</th> <th>Required?</th> <th>Applicable Values</th> </tr> <tr> <td><code>Accept</code></td> <td>Describes the response encoding, as required by the caller. Currently, the interfaces require payloads formatted in JSON, and JSON is the default.</td> <td>No</td> <td><code>application/json</code></td> </tr> <tr> <td><code>Content-Language</code></td> <td>Use this header to control the language that is used for any returned errors or warnings in the call response.</td> <td>No</td> <td><code>en-US</code></td> </tr> <tr> <td><code>Content-Type</code></td> <td>The MIME type of the body of the request. Must be JSON.</td> <td>Yes</td> <td><code>application/json</code></td> </tr> </table></p><br/><p>Unless one or more errors and/or warnings occur with the call, there is no response payload for this call. A successful call will return an HTTP status value of <i>204 No Content</i>.</p>
operationId: createInventoryLocation
parameters:
- name: merchantLocationKey
in: path
description: 'A unique, merchant-defined key (ID) for an inventory location. This unique identifier, or key, is used in other Inventory API calls to identify an inventory location. <br/><br/><b>Max length</b>: 36'
required: true
schema:
type: string
requestBody:
description: Inventory Location details
content:
application/json:
schema:
description: Inventory Location details
$ref: '#/components/schemas/InventoryLocationFull'
required: true
responses:
'204':
description: No Content
'400':
description: Bad Request
x-response-codes:
errors:
'25800':
domain: API_INVENTORY
category: REQUEST
description: Invalid {fieldName}.
'25801':
domain: API_INVENTORY
category: REQUEST
description: Missing field {fieldName}.
'25802':
domain: API_INVENTORY
category: REQUEST
description: Input error. {additionalInfo}
'25803':
domain: API_INVENTORY
category: REQUEST
description: '{fieldName} already exists.'
'25804':
domain: API_INVENTORY
category: REQUEST
description: Input error. {additionalInfo}
'409':
description: Location Already Exists
'500':
description: Internal Server Error
x-response-codes:
errors:
'25001':
domain: API_INVENTORY
category: APPLICATION
description: System error. {additionalInfo}
security:
- api_auth:
- https://api.ebay.com/oauth/api_scope/sell.inventory
delete:
tags:
- location
description: <p>This call deletes the inventory location that is specified in the <code>merchantLocationKey</code> path parameter. Note that deleting a location will not affect any active eBay listings associated with the deleted location, but the seller will not be able modify the offers associated with the inventory location once it is deleted.</p><p>The <code>authorization</code> HTTP header is the only required request header for this call. </p><p>Unless one or more errors and/or warnings occur with the call, there is no response payload for this call. A successful call will return an HTTP status value of <i>200 OK</i>.</p>
operationId: deleteInventoryLocation
parameters:
- name: merchantLocationKey
in: path
description: 'A unique merchant-defined key (ID) for an inventory location. This value is passed in at the end of the call URI to indicate the inventory location to be deleted. <br/><br/><b>Max length</b>: 36'
required: true
schema:
type: string
responses:
'204':
description: Success
'400':
description: Bad Request
x-response-codes:
errors:
'25802':
domain: API_INVENTORY
category: REQUEST
description: Input error. {additionalInfo}
'25804':
domain: API_INVENTORY
category: REQUEST
description: Input error. {additionalInfo}
'25805':
domain: API_INVENTORY
category: REQUEST
description: '{fieldName} Not Found.'
'404':
description: Not Found
'500':
description: Internal Server Error
x-response-codes:
errors:
'25001':
domain: API_INVENTORY
category: APPLICATION
description: System error. {additionalInfo}
security:
- api_auth:
- https://api.ebay.com/oauth/api_scope/sell.inventory
/location/{merchantLocationKey}/disable:
post:
tags:
- location
description: <p>This call disables the inventory location that is specified in the <code>merchantLocationKey</code> path parameter. Sellers can not load/modify inventory to disabled inventory locations. Note that disabling an inventory location will not affect any active eBay listings associated with the disabled location, but the seller will not be able modify the offers associated with a disabled inventory location.</p><p>The <code>authorization</code> HTTP header is the only required request header for this call.</p><p>A successful call will return an HTTP status value of <i>200 OK</i>.</p>
operationId: disableInventoryLocation
parameters:
- name: merchantLocationKey
in: path
description: 'A unique merchant-defined key (ID) for an inventory location. This value is passed in through the call URI to disable the specified inventory location. <br/><br/><b>Max length</b>: 36'
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
'400':
description: Bad Request
x-response-codes:
errors:
'25802':
domain: API_INVENTORY
category: REQUEST
description: Input error. {additionalInfo}
'25804':
domain: API_INVENTORY
category: REQUEST
description: Input error. {additionalInfo}
'25805':
domain: API_INVENTORY
category: REQUEST
description: '{fieldName} Not Found.'
'404':
description: Not Found
'500':
description: Internal Server Error
x-response-codes:
errors:
'25001':
domain: API_INVENTORY
category: APPLICATION
description: System error. {additionalInfo}
security:
- api_auth:
- https://api.ebay.com/oauth/api_scope/sell.inventory
/location/{merchantLocationKey}/enable:
post:
tags:
- location
description: <p>This call enables a disabled inventory location that is specified in the <code>merchantLocationKey</code> path parameter. Once a disabled inventory location is enabled, sellers can start loading/modifying inventory to that inventory location. </p><p>The <code>authorization</code> HTTP header is the only required request header for this call.</p><p>A successful call will return an HTTP status value of <i>200 OK</i>.</p>
operationId: enableInventoryLocation
parameters:
- name: merchantLocationKey
in: path
description: 'A unique merchant-defined key (ID) for an inventory location. This value is passed in through the call URI to specify the disabled inventory location to enable. <br/><br/><b>Max length</b>: 36'
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
'400':
description: Bad Request
x-response-codes:
errors:
'25802':
domain: API_INVENTORY
category: REQUEST
description: Input error. {additionalInfo}
'25804':
domain: API_INVENTORY
category: REQUEST
description: Input error. {additionalInfo}
'25805':
domain: API_INVENTORY
category: REQUEST
description: '{fieldName} Not Found.'
'404':
description: Not Found
'500':
description: Internal Server Error
x-response-codes:
errors:
'25001':
domain: API_INVENTORY
category: APPLICATION
description: System error. {additionalInfo}
security:
- api_auth:
- https://api.ebay.com/oauth/api_scope/sell.inventory
/location:
get:
tags:
- location
description: This call retrieves all defined details for every inventory location associated with the seller's account. There are no required parameters for this call and no request payload. However, there are two optional query parameters, <strong>limit</strong> and <strong>offset</strong>. The <strong>limit</strong> query parameter sets the maximum number of inventory locations returned on one page of data, and the <strong>offset</strong> query parameter specifies the page of data to return. These query parameters are discussed more in the <strong>URI parameters</strong> table below. <p>The <code>authorization</code> HTTP header is the only required request header for this call. </p><p>A successful call will return an HTTP status value of <i>200 OK</i>.</p>
operationId: getInventoryLocations
parameters:
- name: limit
in: query
description: 'The value passed in this query parameter sets the maximum number of records to return per page of data. Although this field is a string, the value passed in this field should be a positive integer value. If this query parameter is not set, up to 100 records will be returned on each page of results. <br/><br/> <strong>Min</strong>: 1'
required: false
schema:
type: string
- name: offset
in: query
description: Specifies the number of locations to skip in the result set before returning the first location in the paginated response. <p>Combine <b>offset</b> with the <b>limit</b> query parameter to control the items returned in the response. For example, if you supply an <b>offset</b> of <code>0</code> and a <b>limit</b> of <code>10</code>, the first page of the response contains the first 10 items from the complete list of items retrieved by the call. If <b>offset</b> is <code>10</code> and <b>limit</b> is <code>20</code>, the first page of the response contains items 11-30 from the complete result set.</p> <p><b>Default:</b> 0</p>
required: false
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/LocationResponse'
'400':
description: Bad Request
'500':
description: Internal Server Error
x-response-codes:
errors:
'25001':
domain: API_INVENTORY
category: APPLICATION
description: System error. {additionalInfo}
security:
- api_auth:
- https://api.ebay.com/oauth/api_scope/sell.inventory.readonly
- https://api.ebay.com/oauth/api_scope/sell.inventory
/location/{merchantLocationKey}/update_location_details:
post:
tags:
- location
description: '<p>Use this call to update non-physical location details for an existing inventory location. Specify the inventory location you want to update using the <b>merchantLocationKey</b> path parameter. <br/><br/>You can update the following text-based fields: <strong>name</strong>, <strong>phone</strong>, <strong>locationWebUrl</strong>, <strong>locationInstructions</strong> and <strong>locationAdditionalInformation</strong>. Whatever text is passed in for these fields in an <strong>updateInventoryLocation</strong> call will replace the current text strings defined for these fields. For store inventory locations, the operating hours and/or the special hours can also be updated. <br/><br/> The merchant location key, the physical location of the store, and its geo-location coordinates can not be updated with an <strong>updateInventoryLocation</strong> call </p><p>In addition to the <code>authorization</code> header, which is required for all eBay REST API calls, the following table includes another request header that is mandatory for the <strong>updateInventoryLocation</strong> call, and two other request headers that are optional:</p><br/> <table> <tr> <th>Header</th> <th>Description</th> <th>Required?</th> <th>Applicable Values</th> </tr> <tr> <td><code>Accept</code></td> <td>Describes the response encoding, as required by the caller. Currently, the interfaces require payloads formatted in JSON, and JSON is the default.</td> <td>No</td> <td><code>application/json</code></td> </tr> <tr> <td><code>Content-Language</code></td> <td>Use this header to control the language that is used for any returned errors or warnings in the call response.</td> <td>No</td> <td><code>en-US</code></td> </tr> <tr> <td><code>Content-Type</code></td> <td>The MIME type of the body of the request. Must be JSON.</td> <td>Yes</td> <td><code>application/json</code></td> </tr> </table><br/><p>Unless one or more errors and/or warnings occurs with the call, there is no response payload for this call. A successful call will return an HTTP status value of <i>204 No Content</i>.</p>'
operationId: updateInventoryLocation
parameters:
- name: merchantLocationKey
in: path
description: 'A unique merchant-defined key (ID) for an inventory location. This value is passed in the call URI to indicate the inventory location to be updated. <br/><br/><b>Max length</b>: 36'
required: true
schema:
type: string
requestBody:
description: The inventory location details to be updated (other than the address and geo co-ordinates).
content:
application/json:
schema:
description: The inventory location details to be updated (other than the address and geo co-ordinates).
$ref: '#/components/schemas/InventoryLocation'
required: true
responses:
'204':
description: Success
'400':
description: Bad Request
x-response-codes:
errors:
'25800':
domain: API_INVENTORY
category: REQUEST
description: Invalid {fieldName}.
'25801':
domain: API_INVENTORY
category: REQUEST
description: Missing field {fieldName}.
'25802':
domain: API_INVENTORY
category: REQUEST
description: Input error. {additionalInfo}
'25804':
domain: API_INVENTORY
category: REQUEST
description: Input error. {additionalInfo}
'25805':
domain: API_INVENTORY
category: REQUEST
description: '{fieldName} Not Found.'
'404':
description: Not Found
'500':
description: Internal Server Error
x-response-codes:
errors:
'25001':
domain: API_INVENTORY
category: APPLICATION
description: System error. {additionalInfo}
security:
- api_auth:
- https://api.ebay.com/oauth/api_scope/sell.inventory
components:
schemas:
Address:
type: object
properties:
addressLine1:
type: string
description: 'The first line of a street address. This field is required for store inventory locations that will be holding In-Store Pickup inventory. A street address is not required if the inventory location is not holding In-Store Pickup Inventory. This field will be returned if defined for an inventory location. <br/><br/><b>Max length</b>: 128'
addressLine2:
type: string
description: 'The second line of a street address. This field can be used for additional address information, such as a suite or apartment number. A street address is not required if the inventory location is not holding In-Store Pickup Inventory. This field will be returned if defined for an inventory location. <br/><br/><b>Max length</b>: 128'
city:
type: string
description: 'The city in which the inventory location resides. This field is required for store inventory locations that will be holding In-Store Pickup inventory. For warehouse locations, this field is technically optional, as a <strong>postalCode</strong> can be used instead of <strong>city</strong>/<strong>stateOrProvince</strong> pair, and then the city is just derived from this postal/zip code. This field is returned if defined for an inventory location. <br/><br/><b>Max length</b>: 128'
country:
type: string
description: 'The country in which the address resides, represented as two-letter <a href="https://www.iso.org/iso-3166-country-codes.html " title="https://www.iso.org " target="_blank">ISO 3166</a> country code. For example, <code>US</code> represents the United States, and <code>DE</code> represents Germany. <br/><br/><b>Max length</b>: 2 For implementation help, refer to <a href=''https://developer.ebay.com/api-docs/sell/inventory/types/ba:CountryCodeEnum''>eBay API documentation</a>'
county:
type: string
description: The county in which the address resides. This field is returned if defined for an inventory location.
postalCode:
type: string
description: 'The postal/zip code of the address. eBay uses postal codes to surface In-Store Pickup items within the vicinity of a buyer''s location, and it also user postal codes (origin and destination) to estimate shipping costs when the seller uses calculated shipping. A <strong>city</strong>/<strong>stateOrProvince</strong> pair can be used instead of a <strong>postalCode</strong> value, and then the postal code is just derived from the city and state/province. This field is returned if defined for an inventory location. <br/><br/><b>Max length</b>: 16'
stateOrProvince:
type: string
description: 'The state/province in which the inventory location resides. This field is required for store inventory locations that will be holding In-Store Pickup inventory. For warehouse locations, this field is technically optional, as a <strong>postalCode</strong> can be used instead of <strong>city</strong>/<strong>stateOrProvince</strong> pair, and then the state or province is just derived from this postal/zip code. <br/><br/><b>Max length</b>: 128'
description: This type is used to define the physical address of an inventory location.
Amount:
type: object
properties:
currency:
type: string
description: A three-digit string value respresenting the type of currency being used. Both the <strong>value</strong> and <strong>currency</strong> fields are required/always returned when expressing prices. See the <a href="/api-docs/sell/inventory/types/ba:CurrencyCodeEnum">CurrencyCodeEnum</a> type for the full list of currencies and their corresponding three-digit string values.
value:
type: string
description: A string representation of a dollar value expressed in the currency specified in the <strong>currency</strong> field. Both the <strong>value</strong> and <strong>currency</strong> fields are required/always returned when expressing prices.
description: This type is used to express a dollar value and the applicable currency.
Availability:
type: object
properties:
pickupAtLocationAvailability:
type: array
description: This container consists of an array of one or more of the merchant's physical store locations where the inventory item is available for In-Store Pickup orders. The merchant's location, the quantity available, and the fulfillment time (how soon the item will be ready for pickup after the order takes place) are all in this container. In-Store Pickup is only available to large merchants selling on the US, UK, Germany, and Australia sites.
items:
$ref: '#/components/schemas/PickupAtLocationAvailability'
shipToLocationAvailability:
description: This container specifies the quantity of the inventory item that are available for purchase across one or more eBay marketplaces.
$ref: '#/components/schemas/ShipToLocationAvailability'
description: This type is used to specify the quantity of the inventory item that is available for purchase if the item will be shipped to the buyer, and the quantity of the inventory item that is available for In-Store Pickup at one or more of the merchant's physical stores. In-Store Pickup is only available to large merchants selling on the US, UK, Germany, and Australia sites.
AvailabilityDistribution:
type: object
properties:
fulfillmentTime:
description: 'This container is used to indicate the expected fulfillment time if the inventory item is shipped from the warehouse location identified in the corresponding <strong>merchantLocationKey</strong> field. The fulfillment time is the estimated number of business days after purchase that the buyer can expect the item to be delivered.<br><br> This field is optional, and is used by eBay to provide the estimated delivery date to buyers. This field is returned if set for the inventory item. '
$ref: '#/components/schemas/TimeDuration'
merchantLocationKey:
type: string
description: The unique identifier of an inventory location where quantity is available for the inventory item. This field is conditionally required to identify the inventory location that has quantity of the inventory item.
quantity:
type: integer
description: The integer value passed into this field indicates the quantity of the inventory item that is available at this inventory location. This field is conditionally required.
format: int32
description: This type is used to set the available quantity of the inventory item at one or more warehouse locations.
AvailabilityWithAll:
type: object
properties:
pickupAtLocationAvailability:
type: array
description: This container consists of an array of one or more of the merchant's physical stores where the inventory item is available for in-store pickup.<br /><br />The store ID, the quantity available, and the fulfillment time (how soon the item will be ready for pickup after the order occurs) are all returned in this container.
items:
$ref: '#/components/schemas/PickupAtLocationAvailability'
shipToLocationAvailability:
description: This container specifies the quantity of the inventory items that are available for a standard purchase, where the item is shipped to the buyer.
$ref: '#/components/schemas/ShipToLocationAvailabilityWithAll'
description: This type is used to specify the quantity of the inventory items that are available for purchase if the items will be shipped to the buyer, and the quantity of the inventory items that are available for In-Store Pickup at one or more of the merchant's physical stores.<br /><br />In-Store Pickup is only available to large merchants selling on the US, UK, Germany, and Australia sites.
BaseResponse:
type: object
properties:
warnings:
type: array
description: This container will be returned in a call response payload if one or more warnings or errors are triggered when an Inventory API call is made. This container will contain detailed information about the error or warning.
items:
$ref: '#/components/schemas/Error'
description: This is the base response of the <strong>createOrReplaceInventoryItem</strong>, <strong>createOrReplaceInventoryItemGroup</strong>, and <strong>createOrReplaceProductCompatibility</strong> calls. A response payload will only be returned for these three calls if one or more errors or warnings occur with the call.
BestOffer:
type: object
properties:
autoAcceptPrice:
description: This is the price at which Best Offers are automatically accepted. If a buyer submits a Best Offer that is equal to or above this value, the offer is automatically accepted on behalf of the seller. This field is only applicable if the <strong>bestOfferEnabled</strong> value is set to <code>true</code>.<br><br>The price set here must be lower than the current 'Buy it Now' price. This field is only returned if set.
$ref: '#/components/schemas/Amount'
autoDeclinePrice:
description: This is the price at which Best Offers are automatically declined. If a buyer submits a Best Offer that is equal to or below this value, the offer is automatically declined on behalf of the seller. This field is only applicable if the <strong>bestOfferEnabled</strong> value is set to <code>true</code>.<br><br>The price set here must be lower than the current 'Buy it Now' price and the price set in the <strong>autoAcceptPrice</strong> field (if used). This field is only returned if set.
$ref: '#/components/schemas/Amount'
bestOfferEnabled:
type: boolean
description: This field indicates whether or not the Best Offer feature is enabled for the listing. A seller can enable the Best Offer feature for a listing as long as the category supports the Best Offer feature.<br><br>The seller includes this field and sets its value to <code>true</code> to enable Best Offer feature.
description: This type is used by the <strong>bestOfferTerms</strong> container, which is used if the seller would like to support the Best Offer feature on their listing.
BulkEbayOfferDetailsWithKeys:
type: object
properties:
requests:
type: array
description: The details of each offer that is being created is passed in under this container. Up to 25 offers can be created with one <strong>bulkCreateOffer</strong> call.
items:
$ref: '#/components/schemas/EbayOfferDetailsWithKeys'
description: This type is used by the base request of the <strong>bulkCreateOffer</strong> method, which is used to create up to 25 new offers.
BulkGetInventoryItem:
type: object
properties:
requests:
type: array
description: The seller passes in multiple SKU values under this container to retrieve multiple inventory item records. Up to 25 inventory item records can be retrieved at one time.
items:
$ref: '#/components/schemas/GetInventoryItem'
description: This type is used by the base request of the <strong>bulkGetInventoryItem</strong> method.
BulkGetInventoryItemResponse:
type: object
properties:
responses:
type: array
description: This is the base container of the <strong>bulkGetInventoryItem</strong> response. The results of each attempted inventory item retrieval is captured under this container.
items:
$ref: '#/components/schemas/GetInventoryItemResponse'
description: This type is used by the base response of the <strong>bulkGetInventoryItem</strong> method.
BulkInventoryItem:
type: object
properties:
requests:
type: array
description: The details of each inventory item that is being created or updated is passed in under this container. Up to 25 inventory item records can be created and/or updated with one <strong>bulkCreateOrReplaceInventoryItem</strong> call.
items:
$ref: '#/components/schemas/InventoryItemWithSkuLocale'
description: The base request of the <strong>bulkCreateOrReplaceInventoryItem</strong> method.
BulkInventoryItemResponse:
type: object
properties:
responses:
type: array
description: This is the base container of the <strong>bulkCreateOrReplaceInventoryItem</strong> response. The results of each attempted inventory item creation/update is captured under this container.
items:
$ref: '#/components/schemas/InventoryItemResponse'
description: This type is used by the base response of the <strong>bulkCreateOrReplaceInventoryItem</strong> method.
BulkMigrateListing:
type: object
properties:
requests:
type: array
description: This is the base container of the <strong>bulkMigrateListings</strong> request payload. One to five eBay listings will be included under this container.
items:
$ref: '#/components/schemas/MigrateListing'
description: This type is used by the base container of the <strong>bulkMigrateListings</strong> request payload.
BulkMigrateListingResponse:
type: object
properties:
responses:
type: array
description: This is the base container of the response payload of the <strong>bulkMigrateListings</strong> call. The results of each attempted listing migration is captured under this container.
items:
$ref: '#/components/schemas/MigrateListingResponse'
description: This type is used by the response payload of the <strong>bulkMigrateListings</strong> call.
BulkOffer:
type: object
properties:
requests:
type: array
description: This container is used to pass in an array of offers to publish. Up to 25 offers can be published with one <strong>bulkPublishOffer</strong> method.
items:
$ref: '#/components/schemas/OfferKeyWithId'
description: This type is used by the base request of the <strong>bulkPublishOffer</strong> method, which is used to publish up to 25 different offers.
BulkOfferResponse:
type: object
properties:
responses:
type: array
items:
$ref: '#/components/schemas/OfferSkuResponse'
description: This type is used by the base response of the <strong>bulkCreateOffer</strong> method.
BulkPriceQuantity:
type: object
properties:
requests:
type: array
description: This container is used by the seller to update the total 'ship-to-home' quantity of one or more inventory items (up to 25) and/or to update the price and/or quantity of one or more specific published offers.
items:
$ref: '#/components/schemas/PriceQuantity'
description: This type is used by the base request payload of the <strong>bulkUpdatePriceQuantity</strong> call. The <strong>bulkUpdatePriceQuantity</strong> call allows the seller to update the total 'ship-to-home' quantity of one or more inventory items (up to 25) and/or to update the price and/or quantity of one or more specific published offers.
BulkPriceQuantityResponse:
type: object
properties:
responses:
type: array
description: This container will return an HTTP status code, offer ID, and SKU value for each offer/inventory item being updated, as well as an <strong>errors</strong> and/or <strong>warnings</strong> container if any errors or warnings are triggered while trying to update those offers/inventory items.
items:
$ref: '#/components/schemas/PriceQuantityResponse'
description: This type is use by the base response payload of the <strong>bulkUpdatePriceQuantity</strong> call. The <strong>bulkUpdatePriceQuantity</strong> call response will return an HTTP status code, offer ID, and SKU value for each offer/inventory item being updated, as well as an <strong>errors</strong> and/or <strong>warnings</strong> container if any errors or warnings are triggered while trying to update those offers/inventory items.
BulkPublishResponse:
type: object
properties:
responses:
type: array
description: A node is returned under the <strong>responses</strong> container to indicate the success or failure of each offer that the seller was attempting to publish.
items:
$ref: '#/components/schemas/OfferResponseWithListingId'
description: This type is used by the base response of the <strong>bulkPublishOffer</strong> method.
Charity:
type: object
properties:
charityId:
type: string
description: The eBay-assigned unique identifier of the charitable organization that will receive a percentage of the sales proceeds. The charitable organization must be reqistered with the PayPal Giving Fund in order to receive sales proceeds through eBay listings.<br/><br/>This field is conditionally required if a seller is planning on donating a percentage of the sale proceeds to a charitable organization.<br><br>The eBay-assigned unique identifier of a charitable organization can be found using the <strong>GetCharities</strong> call of the Trading API. In the <strong>GetCharities</strong> call response, this unique identifier is shown in the <strong>id</strong> attribute of the <strong>Charity</strong> container.
donationPercentage:
type: string
description: This field is the percentage of the purchase price that the charitable organization (identified in the <strong>charityId</strong> field) will receive for each sale that the listing generates. This field is conditionally required if a seller is planning on donating a percentage of the sale proceeds to a charitable organization. This numeric value can range from 10 to 100, and in any 5 (percent) increments in between this range (e.g. <code>10</code>, <code>15</code>, <code>20</code>...<code>95</code>,... <code>100</code>). The seller would pass in <code>10</code> for 10 percent, <code>15</code> for 15 percent, <code>20</code> for 20 percent, and so on, all the way to <code>100</code> for 100 percent.
description: This type is used to identify the charitable organization associated with the listing, and the percentage of the sale proceeds that the charitable organization will receive for each sale generated by the listing. <br/><br/>In order to receive a percentage of the sales proceeds, the charitable organization must be registered with the PayPal Giving Fund, which is a partner of eBay for Charity.
Compatibility:
type: object
properties:
compatibleProducts:
type: array
description: This container consists of an array of motor vehicles (make, model, year, trim, engine) that are compatible with the motor vehicle part or accessory specified by the sku value.
items:
$ref: '#/components/schemas/CompatibleProduct'
sku:
type: string
description: This is the seller-defined SKU value of the inventory item that will be associated with the compatible vehicles. This field is not applicable to the <strong>createOrReplaceProductCompatibility</strong> call, but it is always returned with the <strong>getProductCompatibility</strong> call. For the <strong>createOrReplaceProductCompatibility</strong> call, the SKU value for the inventory item is actually passed in as part of the call URI, and not in the request payload.
description: This type is used by the <strong>createOrReplaceProductCompatibility</strong> call to associate compatible vehicles to an inventory item. This type is also the base response of the <strong>getProductCompatibility</strong> call.
CompatibleProduct:
type: object
properties:
compatibilityProperties:
type: array
description: 'This container consists of an array of motor vehicles that are compatible with the motor vehicle part or accessory specified by the SKU value in the call URI. Each motor vehicle is defined through a separate set of name/value pairs. In the <strong>name</strong> field, the vehicle aspect (such as ''make'', ''model'', ''year'', ''trim'', or ''engine'') will be identified, and the <strong>value</strong> field will be used to identify the value of each aspect. The <a href="/api-docs/commerce/taxonomy/resources/category_tree/methods/getCompatibilityProperties">getCompatibilityProperties</a> method of the Taxonomy API can be used to retrieve applicable vehicle aspect names for a specified category, and the <a href="/api-docs/commerce/taxonomy/resources/category_tree/methods/getCompatibilityPropertyValues">getCompatibilityPropertyValues</a> method of the Taxonomy API can be used to retrieve possible values for these same vehicle aspect names. Below is an example of identifying one motor vehicle using the <strong>compatibilityProperties</strong> container:<br><br><code>"compatibilityProperties" : [<br> {<br> "name" : "make",<br> "value" : "Subaru"<br> },<br> {<br> "name" : "model",<br> "value" : "GL"<br> },<br> {<br> "name" : "year",<br> "value" : "1983"<br> },<br> {<br> "name" : "trim",<br> "value" : "Base Wagon 4-Door"<br> },<br> {<br> "name" : "engine",<br> "value" : "1.8L Turbocharged"<br> }<br>]</code><br><br>Typically, the make, model, and year of the motor vehicle are always required, with the trim and engine being necessary sometimes, but it will be dependent on the part or accessory, and on the vehicle class.<br/><br/><span class="tablenote"> <strong>Note:</strong> The <strong>productFamilyProperties</strong> container is in the process of being deprecated and will no longer be supported in February of 2021, so if you are a new user of <strong>createOrReplaceProductCompatibility</strong>, you should use the <strong>compatibilityProperties</strong> container instead, and if you are already integrated and using the <strong>productFamilyProperties</strong> container, you should make plans to migrate to <strong>compatibilityProperties</strong>. The <strong>productFamilyProperties</strong> and <strong>compatibilityProperties</strong> containers may not be used together or the call will fail.</span>'
items:
$ref: '#/components/schemas/NameValueList'
notes:
type: string
description: 'This field is optionally used by the seller to input any notes pertaining to the compatible vehicle list being defined. The seller might use this field to specify the placement of the part on a vehicle or other applicable information. This field will only be returned if specified by the seller.<br/><br/><strong>Max Length</strong>: 500<br/>'
productFamilyProperties:
description: This container consists of an array of motor vehicles that are compatible with the motor vehicle part or accessory specified by the SKU value in the call URI. These motor vehicles are identified by properties such as make, model, year, trim, and engine type. A separate <strong>productFamilyProperties</strong> node is needed to specify each compatible motor vehicle. Typically, the make, model, and year of the motor vehicle are always required, with the trim and engine being necessary sometimes, but it will be dependent on the part or accessory, and on the vehicle class.<br/><br/><span class="tablenote"> <strong>Note:</strong> The <strong>productFamilyProperties</strong> container is in the process of being deprecated and will no longer be supported in February of 2021, so if you are a new user of <strong>createOrReplaceProductCompatibility</strong>, you should use the newer <strong>compatibilityProperties</strong> container instead, and if you are already integrated and using the <strong>productFamilyProperties</strong> container, you should make plans to migrate to <strong>compatibilityProperties</strong>. The <strong>productFamilyProperties</strong> and <strong>compatibilityProperties</strong> containers may not be used together or the call will fail.</span>
$ref: '#/components/schemas/ProductFamilyProperties'
productIdentifier:
description: This container is used in a <strong>createOrReplaceProductCompatibility</strong> call to identify a motor vehicle that is compatible with the inventory item. The user specifies either an eBay Product ID (ePID) or K-Type value to identify a vehicle, and if the motor vehicle is found in the eBay product catalog, the motor vehicle properties (make, model, year, trim, engine) will automatically be populated for the vehicle. If the vehicle cannot be found using these identifiers, the vehicle will not be added to the compatible vehicle list. <br><br>Note that this container will not be returned in the <strong>getProductCompatibility</strong> call.
$ref: '#/components/schemas/ProductIdentifier'
description: 'This type is used to specify/indicate the motor vehicles that are compatible with the corresponding inventory item. '
Dimension:
type: object
properties:
height:
type: number
description: 'The actual height (in the measurement unit specified in the <strong>unit</strong> field) of the shipping package. All fields of the <strong>dimensions</strong> container are required if package dimensions are specified. <br/><br/> If a shipping package measured 21.5 inches in length, 15.0 inches in width, and 12.0 inches in height, the <strong>dimensions</strong> container would look as follows: <br/> <pre><code>"dimensions": {<br/> "length": 21.5,<br/> "width": 15.0,<br/> "height": 12.0,<br/> "unit": "INCH"<br/> } </pre></code>'
length:
type: number
description: 'The actual length (in the measurement unit specified in the <strong>unit</strong> field) of the shipping package. All fields of the <strong>dimensions</strong> container are required if package dimensions are specified. <br/><br/> If a shipping package measured 21.5 inches in length, 15.0 inches in width, and 12.0 inches in height, the <strong>dimensions</strong> container would look as follows: <br/> <pre><code>"dimensions": {<br/> "length": 21.5,<br/> "width": 15.0,<br/> "height": 12.0,<br/> "unit": "INCH"<br/> } </pre></code>'
unit:
type: string
description: The unit of measurement used to specify the dimensions of a shipping package. All fields of the <strong>dimensions</strong> container are required if package dimensions are specified. If the English system of measurement is being used, the applicable values for dimension units are <code>FEET</code> and <code>INCH</code>. If the metric system of measurement is being used, the applicable values for weight units are <code>METER</code> and <code>CENTIMETER</code>. The metric system is used by most countries outside of the US. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/inventory/types/slr:LengthUnitOfMeasureEnum'>eBay API documentation</a>
width:
type: number
description: 'The actual width (in the measurement unit specified in the <strong>unit</strong> field) of the shipping package. All fields of the <strong>dimensions</strong> container are required if package dimensions are specified.<br/><br/> If a shipping package measured 21.5 inches in length, 15.0 inches in width, and 12.0 inches in height, the <strong>dimensions</strong> container would look as follows: <br/> <pre><code>"dimensions": {<br/> "length": 21.5,<br/> "width": 15.0,<br/> "height": 12.0,<br/> "unit": "INCH"<br/> } </pre></code>'
description: This type is used to specify the dimensions (and the unit used to measure those dimensions) of a shipping package. The <strong>dimensions</strong> container is conditionally required if the seller will be offering calculated shipping rates to determine shipping cost. See the <a href="https://pages.ebay.com/help/pay/calculated-shipping.html" target="_blank">Calculated shipping</a> help page for more information on calculated shipping.
EbayOfferDetailsWithAll:
type: object
properties:
availableQuantity:
type: integer
description: This integer value indicates the quantity of the inventory item (specified by the <strong>sku</strong> value) that will be available for purchase by buyers shopping on the eBay site specified in the <strong>marketplaceId</strong> field. For unpublished offers where the available quantity has yet to be set, the <strong>availableQuantity</strong> value is set to <code>0</code>.
format: int32
categoryId:
type: string
description: The unique identifier of the primary eBay category that the inventory item is listed under. This field is always returned for published offers, but is only returned if set for unpublished offers.
charity:
description: This container is returned if a charitable organization will receive a percentage of sale proceeds for each sale generated by the listing. This container consists of the <strong>charityId</strong> field to identify the charitable organization, and the <strong>donationPercentage</strong> field that indicates the percentage of the sales proceeds that will be donated to the charitable organization.
$ref: '#/components/schemas/Charity'
extendedProducerResponsibility:
description: This container provides IDs for the producer or importer related to the new item, packaging, added documentation, or an eco-participation fee. In some markets, such as in France, this may be the importer of the item. This field is supported by a limited number of sites and specific categories. Use the <a href="/api-docs/sell/metadata/resources/marketplace/methods/getExtendedProducerResponsibilityPolicies" >getExtendedProducerResponsibilityPolicies</a> method of the <strong>Sell Metatdata API</strong> to retrieve valid categories for a site.
$ref: '#/components/schemas/ExtendedProducerResponsibility'
format:
type: string
description: This enumerated value indicates the listing format of the offer. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/inventory/types/slr:FormatTypeEnum'>eBay API documentation</a>
hideBuyerDetails:
type: boolean
description: This field is returned as <code>true</code> if the private listing feature has been enabled for the offer. Sellers may want to use this feature when they believe that a listing's potential bidders/buyers would not want their obfuscated user IDs (and feedback scores) exposed to other users. <br><br> This field is always returned even if not explicitly set in the offer. It defaults to <code>false</code>, so will get returned as <code>false</code> if seller does not set this feature with a 'Create' or 'Update' offer method.
includeCatalogProductDetails:
type: boolean
description: This field indicates whether or not eBay product catalog details are applied to a listing. A value of <code>true</code> indicates the listing corresponds to the eBay product associated with the provided product identifier. The product identifier is provided in <strong>createOrReplaceInventoryItem</strong>.<p><span class="tablenote"><strong>Note:</strong> Though the <strong>includeCatalogProductDetails</strong> parameter is not required to be submitted in the request, the parameter defaults to 'true' if omitted.</span></p>
listing:
description: For published offers, this container is always returned in the <strong>getOffer</strong> and <strong>getOffers</strong> calls, and includes the eBay listing ID associated with the offer, the status of the listing, and the quantity sold through the listing. The <strong>listing</strong> container is not returned at all for unpublished offers.
$ref: '#/components/schemas/ListingDetails'
listingDescription:
type: string
description: 'The description of the eBay listing that is part of the unpublished or published offer. This field is always returned for published offers, but is only returned if set for unpublished offers.<br/><br/><strong>Max Length</strong>: 500000 (which includes HTML markup/tags)'
listingDuration:
type: string
description: This field indicates the number of days that the listing will be active.<br /><br />This field is returned for both auction and fixed-price listings; however, the value returned for fixed-price listings will always be <code>GTC</code>. The GTC (Good 'Til Cancelled) listings are automatically renewed each calendar month until the seller decides to end the listing.<br /><br /><span class="tablenote"> <strong>Note:</strong> If the listing duration expires for an auction offer, the listing then becomes available as a fixed-price offer and will be GTC.</span> For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/inventory/types/slr:ListingDurationEnum'>eBay API documentation</a>
listingPolicies:
description: This container indicates the listing policies that are applied to the offer. Listing policies include business policies, custom listing policies, and fields that override shipping costs, enable eBay Plus eligibility, or enable the Best Offer feature.<br/><br/>It is required that the seller be opted into Business Policies before being able to create live eBay listings through the Inventory API. Sellers can opt-in to Business Policies through My eBay or by using the Account API's <strong>optInToProgram</strong> call. Payment, return, and fulfillment listing policies may be created/managed in My eBay or by using the listing policy calls of the sell <strong>Account API</strong>. The sell <strong>Account API</strong> can also be used to create and manage custom policies. For more information, see the sell <a href="/api-docs/sell/account/overview.html">Account API</a>.<br/><br/>For unpublished offers where business policies have yet to be specified, this container will be returned as empty.
$ref: '#/components/schemas/ListingPolicies'
listingStartDate:
type: string
description: This timestamp is the date/time that the seller set for the scheduled listing. With the scheduled listing feature, the seller can set a time in the future that the listing will become active, instead of the listing becoming active immediately after a <strong>publishOffer</strong> call. <br><br> Scheduled listings do not always start at the exact date/time specified by the seller, but the date/time of the timestamp returned in <strong>getOffer</strong>/<strong>getOffers</strong> will be the same as the timestamp passed into a 'Create' or 'Update' offer call. <br><br> This field is returned if set for an offer.
lotSize:
type: integer
description: This field is only applicable and returned if the listing is a lot listing. A lot listing is a listing that has multiple quantity of the same product. An example would be a set of four identical car tires. The integer value in this field is the number of identical items being sold through the lot listing.
format: int32
marketplaceId:
type: string
description: This enumeration value is the unique identifier of the eBay site on which the offer is available, or will be made available. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/inventory/types/slr:MarketplaceEnum'>eBay API documentation</a>
merchantLocationKey:
type: string
description: 'The unique identifier of the inventory location. This identifier is set up by the merchant when the inventory location is first created with the <strong>createInventoryLocation</strong> call. Once this value is set for an inventory location, it can not be modified. To get more information about this inventory location, the <strong>getInventoryLocation</strong> call can be used, passing in this value at the end of the call URI.<br/><br/>This field is always returned for published offers, but is only returned if set for unpublished offers.<br/><br/><b>Max length</b>: 36'
offerId:
type: string
description: The unique identifier of the offer. This identifier is used in many offer-related calls, and it is also used in the <strong>bulkUpdatePriceQuantity</strong> call.
pricingSummary:
description: This container shows the listing price for the product offer, and if applicable, the settings for the Minimum Advertised Price and Strikethrough Pricing features. The Minimum Advertised Price feature is only available on the US site. Strikethrough Pricing is available on the US, eBay Motors, UK, Germany, Canada (English and French), France, Italy, and Spain sites.<br/><br/>For unpublished offers where pricing information has yet to be specified, this container will be returned as empty.
$ref: '#/components/schemas/PricingSummary'
quantityLimitPerBuyer:
type: integer
description: This field is only applicable and set if the seller wishes to set a restriction on the purchase quantity of an inventory item per seller. If this field is set by the seller for the offer, then each distinct buyer may purchase up to, but not exceed the quantity in this field. So, if this field's value is <code>5</code>, each buyer may purchase a quantity of the inventory item between one and five, and the purchases can occur in one multiple-quantity purchase, or over multiple transactions. If a buyer attempts to purchase one or more of these products, and the cumulative quantity will take the buyer beyond the quantity limit, that buyer will be blocked from that purchase.<br/>
format: int32
secondaryCategoryId:
type: string
description: The unique identifier for a secondary category. This field is applicable if the seller decides to list the item under two categories. Sellers can use the <a href="/api-docs/commerce/taxonomy/resources/category_tree/methods/getCategorySuggestions" target="_blank">getCategorySuggestions</a> method of the Taxonomy API to retrieve suggested category ID values. A fee may be charged when adding a secondary category to a listing. <br/><br/><span class="tablenote"><strong>Note:</strong> You cannot list <strong>US eBay Motors</strong> vehicles in two categories. However, you can list <strong>Parts & Accessories</strong> in two categories.</span>
sku:
type: string
description: 'This is the seller-defined SKU value of the product in the offer.<br/><br/><strong>Max Length</strong>: 50 <br/>'
status:
type: string
description: The enumeration value in this field specifies the status of the offer - either <code>PUBLISHED</code> or <code>UNPUBLISHED</code>. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/inventory/types/slr:OfferStatusEnum'>eBay API documentation</a>
storeCategoryNames:
type: array
description: 'This container is returned if the seller chose to place the inventory item into one or two eBay store categories that the seller has set up for their eBay store. The string value(s) in this container will be the full path(s) to the eBay store categories, as shown below:<br> <pre><code>"storeCategoryNames": [<br/> "/Fashion/Men/Shirts", <br/> "/Fashion/Men/Accessories" ], </pre></code>'
items:
type: string
tax:
description: This container is only returned if a sales tax table, a Value-Added Tax (VAT) rate, and/or a tax exception category code was applied to the offer. Only Business Sellers can apply VAT to their listings. It is possible that the <strong>applyTax</strong> field will be included with a value of <code>true</code>, but a buyer's purchase will not involve sales tax. A sales tax rate must be set up in the seller's sales tax table for the buyer's state/tax jurisdiction in order for that buyer to be subject to sales tax.<br/><br/>See the <a href="https://pages.ebay.com/help/pay/checkout-tax-table.html" target="_blank">Using a tax table</a> help page for more information on setting up and using a sales tax table.
$ref: '#/components/schemas/Tax'
description: This type provides details of an offer, and is used by the response payloads of the <strong>getOffer</strong> and the <strong>getOffers</strong> calls.
EbayOfferDetailsWithId:
type: object
properties:
availableQuantity:
type: integer
description: This integer value sets the quantity of the inventory item that will be available through the offer. Quantity must be set to <code>1</code> or more in order for the inventory item to be purchasable. This value should not be more than the quantity that is specified for the inventory item record. For auction listings, this value must be <code>1</code>. <br/><br/>If this field exists for the current unpublished or published offer, it should be provided again in the <strong>updateOffer</strong> call, even if the value is not changing. If this particular field is omitted in an <strong>updateOffer</strong> call, the general available quantity set for the inventory item record may be used instead, and this may not be accurate if the inventory item is being sold across multiple marketplaces.
format: int32
categoryId:
type: string
description: The unique identifier of the eBay category that the inventory item is/will be listed under. This field is not immediately required for an unpublished offer, but will be required before publishing the offer. Sellers can use the <a href="https://developer.ebay.com/api-docs/commerce/taxonomy/resources/category_tree/methods/getCategorySuggestions" target="_blank">getCategorySuggestions</a> method of the Taxonomy API to retrieve suggested category ID values. The seller passes in a query string like "<em>iPhone 6</em>", and category ID values for suggested categories are returned in the response.<br/><br/>If this field exists for the current unpublished offer, it should be provided again in the <strong>updateOffer</strong> call, even if the eBay category is not changing. For a published offer (aka active eBay listing), this field must be provided or an error may occur. The eBay category of an active eBay listing cannot be changed once the listing has one or more sales, or if the listing is scheduled to end in less than 12 hours.
charity:
description: This container is used if the seller wishes to update a published or unpublished offer with a charitable organization that will receive a percentage of sale proceeds for each sale generated by the eBay listing. This container consists of the <strong>charityId</strong> field to identify the charitable organization, and the <strong>donationPercentage</strong> field that indicates the percentage of the sales proceeds that will be donated to the charitable organization for each sale. Both fields in this container are conditionally required for charitable listings.
$ref: '#/components/schemas/Charity'
extendedProducerResponsibility:
description: This container provides IDs for the producer or importer related to the new item, packaging, added documentation, or an eco-participation fee. In some markets, such as in France, this may be the importer of the item. This field is supported by a limited number of sites and specific categories. Use the <a href="/api-docs/sell/metadata/resources/marketplace/methods/getExtendedProducerResponsibilityPolicies" >getExtendedProducerResponsibilityPolicies</a> method of the <strong>Sell Metatdata API</strong> to retrieve valid categories for a site.
$ref: '#/components/schemas/ExtendedProducerResponsibility'
hideBuyerDetails:
type: boolean
description: This field is included and set to <code>true</code> if the seller wishes to update a published or unpublished offer with the private listing feature. Alternatively, the seller could also remove the private listing feature (if already set for a published or unpublished offer) by including this field and setting it to <code>false</code>. <br><br> Sellers may want to use this option when they believe that a listing's potential bidders/buyers would not want their obfuscated user IDs (and feedback scores) exposed to other users.
includeCatalogProductDetails:
type: boolean
description: This field indicates whether or not eBay product catalog details are applied to a listing. A value of <code>true</code> indicates the listing corresponds to the eBay product associated with the provided product identifier. The product identifier is provided in <strong>createOrReplaceInventoryItem</strong>.<p><span class="tablenote"><strong>Note:</strong> Though the <strong>includeCatalogProductDetails</strong> parameter is not required to be submitted in the request, the parameter defaults to 'true' if omitted.</span></p>
listingDescription:
type: string
description: 'The text in this field is (published offers), or will become (unpublished offers) the description of the eBay listing. This field is not immediately required for an unpublished offer, but will be required before publishing the offer. Note that if the <strong>listingDescription</strong> field was omitted in the <strong>createOffer</strong> call for the offer, the offer entity should have picked up the text provided in the <strong>product.description</strong> field of the inventory item record, or if the inventory item is part of a group, the offer entity should have picked up the text provided in the <strong>description</strong> field of the inventory item group record.<br/><br/>HTML tags and markup can be used in listing descriptions, but each character counts toward the max length limit.<br/><br/><span class="tablenote"> <strong>Note:</strong> To ensure that their short listing description is optimized when viewed on mobile devices, sellers should strongly consider using eBay''s <a href="https://pages.ebay.com/sell/itemdescription/customizeyoursummary.html" target="_blank">View Item description summary feature</a> when listing their items. Keep in mind that the ''short'' listing description is what prospective buyers first see when they view the listing on a mobile device. The ''full'' listing description is also available to mobile users when they click on the short listing description, but the full description is not automatically optimized for viewing in mobile devices, and many users won''t even drill down to the full description.<br><br> Using HTML div and span tag attributes, this feature allows sellers to customize and fully control the short listing description that is displayed to prospective buyers when viewing the listing on a mobile device. The short listing description on mobile devices is limited to 800 characters, and whenever the full listing description (provided in this field, in UI, or seller tool) exceeds this limit, eBay uses a special algorithm to derive the best possible short listing description within the 800-character limit. However, due to some short listing description content being removed, it is definitely not ideal for the seller, and could lead to a bad buyer experience and possibly to a Significantly not as described (SNAD) case, since the buyer may not get complete details on the item when viewing the short listing description. See the eBay help page for more details on using the HTML div and span tags.</span><br/><br/>If this field exists for the current unpublished offer, it should be provided again in the <strong>updateOffer</strong> call, even if the text is not changing. For a published offer (aka active eBay listing), this field must be provided or an error may occur.<br><br><strong>Max length</strong>: 500000 (which includes HTML markup/tags)'
listingDuration:
type: string
description: This field indicates the number of days that the listing will be active. For fixed-price listings, this value must be set to <code>GTC</code>, but auction listings support different listing durations.<br /><br /> The GTC (Good 'Til Cancelled) listings are automatically renewed each calendar month until the seller decides to end the listing.<br /><br /><span class="tablenote"> <strong>Note:</strong> If the listing duration expires for an auction offer without a winning bidder, the listing then becomes available as a fixed-price offer and listing duration will be <code>GTC</code>.</span> For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/inventory/types/slr:ListingDurationEnum'>eBay API documentation</a>
listingPolicies:
description: This container sets listing policies that will be used to construct the listing. Listing policies include business policies, custom listing policies, and fields that override shipping costs, enable eBay Plus eligibility, or enable the Best Offer feature. This container is not initially required when creating an offer but will become required before the offer can be published. Busines policies (payment, return, fulfillment policies) will always be required before publishing an offer. Other policies, including the seller created compliance policies and seller created take-back policy, will be required as needed by the marketplace, category, or product.<br/<br/>This container is required for updating published offers, regardless of whether or not the business policies are being changed or not. For an unpublished offer, this field is not necessarily required, but will be required before an offer can be published.<br/><br/>It is required that the seller be opted in to Business Policies before being able to create live eBay listings through the Inventory API. Sellers can opt-in to Business Policies through My eBay or by using the Account API's <strong>optInToProgram</strong> call. Similarly, payment, return, and fulfillment business policies may be created/managed in My eBay or by using the business policy calls of the <strong>Account API</strong>.
$ref: '#/components/schemas/ListingPolicies'
listingStartDate:
type: string
description: This field can be used with an unpublished offer if the seller wants to specify a time in the future that the listing will become active on eBay. The timestamp supplied in this field should be in UTC format, and it should be far enough in the future so that the seller will have enough time to publish the listing with the <strong>publishOffer</strong> method.<br><br> This field is optional, and it doesn't apply to offers where the corresponding listing is already active. If this field is not provided, the listing starts immediately after a successful <strong>publishOffer</strong> method.
lotSize:
type: integer
description: This field is only applicable if the listing is a lot listing. A lot listing is a listing that has multiple quantity of the same item, such as four identical tires being sold as a single offer, or it can be a mixed lot of similar items, such as used clothing items or an assortment of baseball cards. Whether the lot listing involved identical items or a mixed lot, the integer value passed into this field is the total number of items in the lot. Lots can be used for auction and fixed-price listings.
format: int32
merchantLocationKey:
type: string
description: 'The unique identifier of a merchant''s inventory location (where the inventory item in the offer is located). A <strong>merchantLocationKey</strong> value is established when the merchant creates an inventory location using the <strong>createInventoryLocation</strong> call. To get more information about inventory locations, the <strong>getInventoryLocation</strong> call can be used.<br/><br/>This field is not initially required upon first creating an offer, but will become required before an offer can be published.<br/><br/><b>Max length</b>: 36'
pricingSummary:
description: This container shows the listing price for the product offer, and if applicable, the settings for the Minimum Advertised Price and Strikethrough Pricing features. The Minimum Advertised Price feature is only available on the US site. Strikethrough Pricing is available on the US, eBay Motors, UK, Germany, Canada (English and French), France, Italy, and Spain sites. <br><br>This container is required for updating published offers, regardless of whether or not the pricing information is being changed or not. For an unpublished offer, this container is not necessarily required, but an offer price will be required before an offer can be published, and if a <strong>pricingSummary</strong> container already exists for an unpublished offer, it must be provided again, even if the values are not changing.
$ref: '#/components/schemas/PricingSummary'
quantityLimitPerBuyer:
type: integer
description: This field is only applicable and set if the seller wishes to set a restriction on the purchase quantity per seller. If this field is set by the seller for the offer, then each distinct buyer may purchase up to, but not exceeding the quantity specified for this field. So, if this field's value is <code>5</code>, each buyer may purchase between one to five of these products, and the purchases can occur in one multiple-quantity purchase, or over multiple transactions. If a buyer attempts to purchase one or more of these products, and the cumulative quantity will take the buyer beyond the quantity limit, that buyer will be blocked from that purchase.<br><br>If this field currently exists for an unpublished or published offer, it should be provided again in an <strong>updateOffer</strong> call, even if the value is not changing.<br/>
format: int32
secondaryCategoryId:
type: string
description: The unique identifier for a secondary category. This field is applicable if the seller decides to list the item under two categories. Sellers can use the <a href="/api-docs/commerce/taxonomy/resources/category_tree/methods/getCategorySuggestions" target="_blank">getCategorySuggestions</a> method of the Taxonomy API to retrieve suggested category ID values. A fee may be charged when adding a secondary category to a listing. <br/><br/><span class="tablenote"><strong>Note:</strong> You cannot list <strong>US eBay Motors</strong> vehicles in two categories. However, you can list <strong>Parts & Accessories</strong> in two categories.</span>
storeCategoryNames:
type: array
description: 'This container is used if the seller would like to place the inventory item into one or two store categories that the seller has set up for their eBay store. The string value(s) passed in to this container will be the full path(s) to the store categories, as shown below:<br> <pre><code>"storeCategoryNames": [<br/> "/Fashion/Men/Shirts", <br/> "/Fashion/Men/Accessories" ], </pre></code>If this field currently exists for an unpublished or published offer, it should be provided again in an <strong>updateOffer</strong> call, even if the eBay categories are not changing.'
items:
type: string
tax:
description: This container is only applicable and used if a sales tax table, a Value-Added Tax (VAT) rate, or a tax exception category code will be applied to the offer. Only Business Sellers can apply VAT to their listings. It is possible that the <strong>applyTax</strong> field will be included with a value of <code>true</code>, but a buyer's purchase will not involve sales tax. A sales tax rate must be set up in the seller's sales tax table for the buyer's state/tax jurisdiction in order for that buyer to be subject to sales tax. Sales tax rates for different jurisdictions can be added/modified in the Payment Preferences section of My eBay, or the seller can use the sales tax calls of the <strong>Account API</strong>.<br/><br/>If tax information currently exists for an unpublished or published offer, it should be provided again in an <strong>updateOffer</strong> call, even if none of the tax settings are changing.<br/><br/>See the <a href="https://pages.ebay.com/help/pay/checkout-tax-table.html" target="_blank">Using a tax table</a> help page for more information on setting up and using a sales tax table.
$ref: '#/components/schemas/Tax'
description: This type provides details of an offer, and is used by the base request payload of the <strong>updateOffer</strong> call. Every field that is currently set with the unpublished/published offer must also be passed into the <strong>updateOffer</strong> call, even those fields whose values are not changing. Note that for published offers, a successful <strong>updateOffer</strong> call will actually update the active eBay listing with whatever changes were made.
EbayOfferDetailsWithKeys:
type: object
properties:
availableQuantity:
type: integer
description: This integer value sets the quantity of the inventory item (specified by the <strong>sku</strong> value) that will be available for purchase by buyers shopping on the eBay site specified in the <strong>marketplaceId</strong> field. Quantity must be set to <code>1</code> or more in order for the inventory item to be purchasable, but this field is not necessarily required, even for published offers, if the general quantity of the inventory item has already been set in the inventory item record.<br/><br/> For auction listings, this value must be <code>1</code>.
format: int32
categoryId:
type: string
description: The unique identifier of the eBay category that the product will be listed under. This field is not immediately required upon creating an offer, but will be required before publishing the offer. Sellers can use the <a href="https://developer.ebay.com/api-docs/commerce/taxonomy/resources/category_tree/methods/getCategorySuggestions" target="_blank">getCategorySuggestions</a> method of the Taxonomy API to retrieve suggested category ID values. The seller passes in a query string like "<em>iPhone 6</em>", and category ID values for suggested categories are returned in the response.
charity:
description: This container is used if the seller wishes to select a charitable organization that will receive a percentage of sale proceeds for each sale generated by the eBay listing. This container consists of the <strong>charityId</strong> field to identify the charitable organization, and the <strong>donationPercentage</strong> field that indicates the percentage of the sales proceeds that will be donated to the charitable organization for each sale. Both fields in this container are conditionally required for charitable listings.
$ref: '#/components/schemas/Charity'
extendedProducerResponsibility:
description: This container provides IDs for the producer or importer related to the new item, packaging, added documentation, or an eco-participation fee. In some markets, such as in France, this may be the importer of the item. This field is supported by a limited number of sites and specific categories. Use the <a href="/api-docs/sell/metadata/resources/marketplace/methods/getExtendedProducerResponsibilityPolicies" >getExtendedProducerResponsibilityPolicies</a> method of the <strong>Sell Metatdata API</strong> to retrieve valid categories for a site.
$ref: '#/components/schemas/ExtendedProducerResponsibility'
format:
type: string
description: This enumerated value indicates the listing format of the offer. <br/><br/>Supported values are <code>FIXED_PRICE</code> and <code>AUCTION</code>. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/inventory/types/slr:FormatTypeEnum'>eBay API documentation</a>
hideBuyerDetails:
type: boolean
description: This field is included and set to <code>true</code> if the seller wishes to create a private listing. <br><br> Sellers may want to use this option when they believe that a listing's potential bidders/buyers would not want their obfuscated user IDs (and feedback scores) exposed to other users.
includeCatalogProductDetails:
type: boolean
description: This field indicates whether or not eBay product catalog details are applied to a listing. A value of <code>true</code> indicates the listing corresponds to the eBay product associated with the provided product identifier. The product identifier is provided in <strong>createOrReplaceInventoryItem</strong>.<br/><br/> <strong>Default:</strong> true<p><span class="tablenote"><strong>Note:</strong> Though the <strong>includeCatalogProductDetails</strong> parameter is not required to be submitted in the request, the parameter defaults to <code>true</code> if omitted.</span></p>
listingDescription:
type: string
description: 'The text in this field is (published offers), or will become (unpublished offers) the description of the eBay listing. This field is not immediately required for an unpublished offer, but will be required before publishing the offer. Note that if the <strong>listingDescription</strong> field was omitted in the <strong>createOffer</strong> call for the offer, the offer entity should have picked up the text provided in the <strong>product.description</strong> field of the inventory item record, or if the inventory item is part of a group, the offer entity should have picked up the text provided in the <strong>description</strong> field of the inventory item group record.<br/><br/>HTML tags and markup can be used in listing descriptions, but each character counts toward the max length limit.<br/><br/><span class="tablenote"> <strong>Note:</strong> To ensure that their short listing description is optimized when viewed on mobile devices, sellers should strongly consider using eBay''s <a href="https://pages.ebay.com/sell/itemdescription/customizeyoursummary.html" target="_blank">View Item description summary feature</a> when listing their items. Keep in mind that the ''short'' listing description is what prospective buyers first see when they view the listing on a mobile device. The ''full'' listing description is also available to mobile users when they click on the short listing description, but the full description is not automatically optimized for viewing in mobile devices, and many users won''t even drill down to the full description.<br><br> Using HTML div and span tag attributes, this feature allows sellers to customize and fully control the short listing description that is displayed to prospective buyers when viewing the listing on a mobile device. The short listing description on mobile devices is limited to 800 characters, and whenever the full listing description (provided in this field, in UI, or seller tool) exceeds this limit, eBay uses a special algorithm to derive the best possible short listing description within the 800-character limit. However, due to some short listing description content being removed, it is definitely not ideal for the seller, and could lead to a bad buyer experience and possibly to a Significantly not as described (SNAD) case, since the buyer may not get complete details on the item when viewing the short listing description. See the eBay help page for more details on using the HTML div and span tags.</span><br><br><strong>Max length</strong>: 500000 (which includes HTML markup/tags)'
listingDuration:
type: string
description: This field indicates the number of days that the listing will be active. For fixed-price listings, this value must be set to <code>GTC</code>, but auction listings support different listing durations.<br /><br /> The GTC (Good 'Til Cancelled) listings are automatically renewed each calendar month until the seller decides to end the listing.<br /><br /><span class="tablenote"> <strong>Note:</strong> If the listing duration expires for an auction offer without a winning bidder, the listing then becomes available as a fixed-price offer and listing duration will be <code>GTC</code>.</span> For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/inventory/types/slr:ListingDurationEnum'>eBay API documentation</a>
listingPolicies:
description: This container sets listing policies that will be used to construct the listing. Listing policies include business policies, custom listing policies, and fields that override shipping costs, enable eBay Plus eligibility, or enable the Best Offer feature. This container is not initially required when creating an offer but will become required before the offer can be published. Busines policies (payment, return, fulfillment policies) will always be required before publishing an offer. Other policies, including the seller created compliance policies and seller created take-back policy, will be required as needed by the marketplace, category, or product.<br/><br/>It is required that the seller be opted into Business Policies before being able to create live eBay listings through the Inventory API. Sellers can opt-in to Business Policies through My eBay or by using the Account API's <strong>optInToProgram</strong> call. Payment, return, and fulfillment listing policies may be created/managed in My eBay or by using the listing policy calls of the sell <strong>Account API</strong>. The sell <strong>Account API</strong> can also be used to create and manage custom policies. For more information, see the sell <a href="/api-docs/sell/account/overview.html">Account API</a>.
$ref: '#/components/schemas/ListingPolicies'
listingStartDate:
type: string
description: This field can be used if the seller wants to specify a time in the future that the listing will become active on eBay. The timestamp supplied in this field should be in UTC format, and it should be far enough in the future so that the seller will have enought time to publish the listing with the <strong>publishOffer</strong> method.<br><br> This field is optional. If this field is not provided, the listing starts immediately after a successful <strong>publishOffer</strong> method.
lotSize:
type: integer
description: This field is only applicable if the listing is a lot listing. A lot listing is a listing that has multiple quantity of the same item, such as four identical tires being sold as a single offer, or it can be a mixed lot of similar items, such as used clothing items or an assortment of baseball cards. Whether the lot listing involved identical items or a mixed lot, the integer value passed into this field is the total number of items in the lot. Lots can be used for auction and fixed-price listings.
format: int32
marketplaceId:
type: string
description: This enumeration value is the unique identifier of the eBay site for which the offer will be made available. See <strong>MarketplaceEnum</strong> for the list of supported enumeration values. This field is required. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/inventory/types/slr:MarketplaceEnum'>eBay API documentation</a>
merchantLocationKey:
type: string
description: 'The unique identifier of a merchant''s inventory location (where the inventory item in the offer is located). A <strong>merchantLocationKey</strong> value is established when the merchant creates an inventory location using the <strong>createInventoryLocation</strong> call. To get more information about inventory locations, the <strong>getInventoryLocation</strong> call can be used.<br/><br/>This field is not initially required upon first creating an offer, but will become required before an offer can be published.<br/><br/><b>Max length</b>: 36'
pricingSummary:
description: This container shows the listing price for the product offer, and if applicable, the settings for the Minimum Advertised Price and Strikethrough Pricing features. The Minimum Advertised Price feature is only available on the US site. Strikethrough Pricing is available on the US, eBay Motors, UK, Germany, Canada (English and French), France, Italy, and Spain sites. <br><br>This container is not initially required upon first creating an offer, but the price of the offer will become required before an offer can be published.
$ref: '#/components/schemas/PricingSummary'
quantityLimitPerBuyer:
type: integer
description: This field is only applicable and set if the seller wishes to set a restriction on the purchase quantity per seller. If this field is set by the seller for the offer, then each distinct buyer may purchase up to, but not exceed the quantity specified for this field. So, if this field's value is <code>5</code>, each buyer may purchase between one to five of these products, and the purchases can occur in one multiple-quantity purchase, or over multiple transactions. If a buyer attempts to purchase one or more of these products, and the cumulative quantity will take the buyer beyond the quantity limit, that buyer will be blocked from that purchase. <br/>
format: int32
secondaryCategoryId:
type: string
description: The unique identifier for a secondary category. This field is applicable if the seller decides to list the item under two categories. Sellers can use the <a href="/api-docs/commerce/taxonomy/resources/category_tree/methods/getCategorySuggestions" target="_blank">getCategorySuggestions</a> method of the Taxonomy API to retrieve suggested category ID values. A fee may be charged when adding a secondary category to a listing. <br/><br/><span class="tablenote"><strong>Note:</strong> You cannot list <strong>US eBay Motors</strong> vehicles in two categories. However, you can list <strong>Parts & Accessories</strong> in two categories.</span>
sku:
type: string
description: 'This is the seller-defined SKU value of the product that will be listed on the eBay site (specified in the <strong>marketplaceId</strong> field). Only one offer (in unpublished or published state) may exist for each <strong>sku</strong>/<strong>marketplaceId</strong>/<strong>format</strong> combination. This field is required.<br/><br/><strong>Max Length</strong>: 50<br/>'
storeCategoryNames:
type: array
description: 'This container is used if the seller would like to place the inventory item into one or two eBay store categories that the seller has set up for their eBay store. The string value(s) passed in to this container will be the full path(s) to the eBay store categories, as shown below:<br> <pre><code>"storeCategoryNames": [<br/> "/Fashion/Men/Shirts", <br/> "/Fashion/Men/Accessories" ], </pre></code>'
items:
type: string
tax:
description: This container is only applicable and used if a sales tax table, a Value-Added Tax (VAT) rate, or a tax exception category code will be applied to the offer. Only Business Sellers can apply VAT to their listings. It is possible that the <strong>applyTax</strong> field will be included with a value of <code>true</code>, but a buyer's purchase will not involve sales tax. A sales tax rate must be set up in the seller's sales tax table for the buyer's state/tax jurisdiction in order for that buyer to be subject to sales tax. Sales tax rates for different jurisdictions can be added/modified in the Payment Preferences section of My eBay, or the seller can use the sales tax calls of the <strong>Account API</strong>.<br/><br/>See the <a href="https://pages.ebay.com/help/pay/checkout-tax-table.html" target="_blank">Using a tax table</a> help page for more information on setting up and using a sales tax table.
$ref: '#/components/schemas/Tax'
description: This type provides details of an offer, and is used by the base request payload of the <strong>createOffer</strong> and <strong>bulkCreateOffer</strong> methods.
Error:
type: object
properties:
category:
type: string
description: 'This string value indicates the error category. There are three categories of errors: request errors, application errors, and system errors. '
domain:
type: string
description: The name of the domain in which the error or warning occurred.
errorId:
type: integer
description: A unique code that identifies the particular error or warning that occurred. Your application can use error codes as identifiers in your customized error-handling algorithms.
format: int32
inputRefIds:
type: array
description: An array of one or more reference IDs which identify the specific request element(s) most closely associated to the error or warning, if any.
items:
type: string
longMessage:
type: string
description: A detailed description of the condition that caused the error or warning, and information on what to do to correct the problem.
message:
type: string
description: A description of the condition that caused the error or warning.
outputRefIds:
type: array
description: An array of one or more reference IDs which identify the specific response element(s) most closely associated to the error or warning, if any.
items:
type: string
parameters:
type: array
description: Various warning and error messages return one or more variables that contain contextual information about the error or waring. This is often the field or value that triggered the error or warning.
items:
$ref: '#/components/schemas/ErrorParameter'
subdomain:
type: string
description: The name of the subdomain in which the error or warning occurred.
description: This type is used to express detailed information on errors and warnings that may occur with a call request.
ErrorParameter:
type: object
properties:
name:
type: string
description: This type contains the name and value of an input parameter that contributed to a specific error or warning condition.
value:
type: string
description: This is the actual value that was passed in for the element specified in the <strong>name</strong> field.
description: This type is used to indicate the parameter field/value that caused an issue with the call request.
ExtendedProducerResponsibility:
type: object
properties:
producerProductId:
type: string
description: This ID is the Unique Identifier of the producer related to the item. For instance, if the seller is selling a cell phone, it is the ID related to the cell phone.
productPackageId:
type: string
description: 'The Unique ID of the producer of any packaging related to the product added by the seller. This does not include package in which the product is shipped (see <strong>ShipmentPackageID</strong>). For instance, if the seller adds bubble wrap, it is the ID related to the bubble wrap. '
shipmentPackageId:
type: string
description: This ID is the Unique Identifier of the producer of any packaging used by the seller to ship the item. This does not include non-shipping packaging added to the product (see <strong>ProductPackageID</strong>). This ID is required when the seller uses packaging to ship the item. For instance, if the seller uses a different box to ship the item, it is the ID related to the box.
productDocumentationId:
type: string
description: This ID is the Unique Identifier of the producer of any paper added to the parcel of the item by the seller. For example, this ID concerns any notice, leaflet, or paper that the seller adds to a cell phone parcel.
ecoParticipationFee:
description: This is the fee paid for new items to the eco-organization (for example, "eco-organisme" in France). It is a contribution to the financing of the elimination of the item responsibly. <br/></br><b>Minimum:</b> 0.0
$ref: '#/components/schemas/Amount'
description: This type provides IDs for the producer or importer related to the new item, packaging, added documentation, or an eco-participation fee. In some markets, such as in France, this may be the importer of the item.
Fee:
type: object
properties:
amount:
description: This dollar value in this container is the actual dollar value of the listing fee type specified in the <strong>feeType</strong> field.
$ref: '#/components/schemas/Amount'
feeType:
type: string
description: The value returned in this field indicates the type of listing fee that the seller may incur if one or more unpublished offers (offers are specified in the call request) are published on the marketplace specified in the <strong>marketplaceId</strong> field. Applicable listing fees will often include things such as <code>InsertionFee</code> or <code>SubtitleFee</code>, but many fee types will get returned even when they are <code>0.0</code>.<br/><br/>See the <a href="https://pages.ebay.com/help/sell/fees.html" target="_blank">Standard selling fees</a> help page for more information on listing fees.
promotionalDiscount:
description: The dollar value in this container indicates any eBay promotional discount applied toward the listing fee type specified in the <strong>feeType</strong> field. If there was no discount applied toward the fee, this container is still returned but its value is <code>0.0</code>.
$ref: '#/components/schemas/Amount'
description: This type is used to express expected listing fees that the seller may incur for one or more unpublished offers, as well as any eBay-related promotional discounts being applied toward a specific fee. These fees are the expected cumulative fees per eBay marketplace (which is indicated in the <strong>marketplaceId</strong> field).
FeeSummary:
type: object
properties:
fees:
type: array
description: This container is an array of listing fees that can be expected to be applied to an offer on the specified eBay marketplace (<strong>marketplaceId</strong> value). Many fee types will get returned even when they are <code>0.0</code>.<br/><br/>See the <a href="https://pages.ebay.com/help/sell/fees.html" target="_blank">Standard selling fees</a> help page for more information on listing fees.
items:
$ref: '#/components/schemas/Fee'
marketplaceId:
type: string
description: This is the unique identifier of the eBay site for which listing fees for the offer are applicable. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/inventory/types/slr:MarketplaceEnum'>eBay API documentation</a>
warnings:
type: array
description: This container will contain an array of errors and/or warnings when a call is made, and errors and/or warnings occur.
items:
$ref: '#/components/schemas/Error'
description: This type is used to display the expected listing fees for each unpublished offer specified in the request of the <strong>getListingFees</strong> call.
FeesSummaryResponse:
type: object
properties:
feeSummaries:
type: array
description: This container consists of an array of one or more listing fees that the seller can expect to pay for unpublished offers specified in the call request. Many fee types will get returned even when they are <code>0.0</code>.
items:
$ref: '#/components/schemas/FeeSummary'
description: 'This type is used by the base response payload for the <strong>getListingFees</strong> call. '
FormatAllocation:
type: object
properties:
auction:
type: integer
description: This integer value indicates the quantity of the inventory item that is reserved for the published auction format offers of the SKU.
format: int32
fixedPrice:
type: integer
description: This integer value indicates the quantity of the inventory item that is available for the fixed-price offers of the SKU.
format: int32
description: This type is used to indicate the quantities of the inventory items that are reserved for the different listing formats of the SKU offers.
GeoCoordinates:
type: object
properties:
latitude:
type: number
description: The latitude (North-South) component of the geographic coordinate. This field is required if a <strong>geoCoordinates</strong> container is used. <br/><br/>This field is returned if geographical coordinates are set for the inventory location.
longitude:
type: number
description: The longitude (East-West) component of the geographic coordinate. This field is required if a <strong>geoCoordinates</strong> container is used. <br/><br/>This field is returned if geographical coordinates are set for the inventory location.
description: This type is used to express the Global Positioning System (GPS) latitude and longitude coordinates of an inventory location.
GetInventoryItem:
type: object
properties:
sku:
type: string
description: An array of SKU values are passed in under the <strong>sku</strong> container to retrieve up to 25 inventory item records.
description: The seller-defined Stock-Keeping Unit (SKU) of each inventory item that the user wants to retrieve is passed in the request of the <strong>bulkGetInventoryItem</strong> method.
GetInventoryItemResponse:
type: object
properties:
errors:
type: array
description: This container will be returned if there were one or more errors associated with retrieving the inventory item record.
items:
$ref: '#/components/schemas/Error'
inventoryItem:
description: This container consists of detailed information on the inventory item specified in the <strong>sku</strong> field.
$ref: '#/components/schemas/InventoryItemWithSkuLocaleGroupKeys'
sku:
type: string
description: The seller-defined Stock-Keeping Unit (SKU) of the inventory item. The seller should have a unique SKU value for every product that they sell.
statusCode:
type: integer
description: The HTTP status code returned in this field indicates the success or failure of retrieving the inventory item record for the inventory item specified in the <strong>sku</strong> field. See the <strong>HTTP status codes</strong> table to see which each status code indicates.
format: int32
warnings:
type: array
description: This container will be returned if there were one or more warnings associated with retrieving the inventory item record.
items:
$ref: '#/components/schemas/Error'
description: This type is used by the response of the <strong>bulkGetInventoryItem</strong> method to give the status of each inventory item record that the user tried to retrieve.
Interval:
type: object
properties:
close:
type: string
description: 'The <strong>close</strong> value is actually the time that the store closes. Local time (in Military format) is used. So, if a store closed at 8 PM local time, the <strong>close</strong> time would look like the following: <code>20:00:00</code>. This field is conditionally required if the <strong>intervals</strong> container is used to specify working hours or special hours for a store. <br/><br/>This field is returned if set for the store location.'
open:
type: string
description: 'The <strong>open</strong> value is actually the time that the store opens. Local time (in Military format) is used. So, if a store opens at 9 AM local time, the <strong>close</strong> time would look like the following: <code>09:00:00</code>. This field is conditionally required if the <strong>intervals</strong> container is used to specify working hours or special hours for a store. <br/><br/>This field is returned if set for the store location.'
description: 'This type is used by the <strong>intervals</strong> container to define the opening and closing times of a store''s working day. Local time (in Military format) is used, with the following format: <code>hh:mm:ss</code>.'
InventoryItem:
type: object
properties:
availability:
description: This container is used to specify the quantity of the inventory item that are available for purchase. <br /><br /> This container is optional up until the seller is ready to publish an offer with the SKU, at which time it becomes required. Availability data must also be passed if an inventory item is being updated and availability data already exists for that inventory item.<br /><br /> Since an inventory item must have specified quantity before being published in an offer, this container is always returned in the 'Get' calls for SKUs that are part of a published offer. If a SKU is not part of a published offer, this container will only be returned if set for the inventory item.
$ref: '#/components/schemas/Availability'
condition:
type: string
description: 'This enumeration value indicates the condition of the item. Supported item condition values will vary by eBay site and category. To see which item condition values that a particular eBay category supports, use the <a href="/api-docs/sell/metadata/resources/marketplace/methods/getItemConditionPolicies">getItemConditionPolicies</a> method of the <strong>Metadata API</strong>. This method returns condition ID values that map to the enumeration values defined in the <a href="/api-docs/sell/inventory/types/slr:ConditionEnum">ConditionEnum</a> type. The <a href="/api-docs/sell/static/metadata/condition-id-values.html">Item condition ID and name values</a> topic in the <strong>Selling Integration Guide</strong> has a table that maps condition ID values to <strong>ConditionEnum</strong> values. The <strong>getItemConditionPolicies</strong> call reference page has more information.<br><br> A <strong>condition</strong> value is optional up until the seller is ready to publish an offer with the SKU, at which time it becomes required for most eBay categories.<br/><br/> <span class="tablenote"> <strong>Note:</strong> The ''Manufacturer Refurbished'' item condition is no longer a valid item condition on any eBay marketplace, and to reflect this change, the <code>MANUFACTURER_REFURBISHED</code> value is no longer applicable, and should not be used. With Version 1.13.0, the <code>CERTIFIED_REFURBISHED</code> enumeration value has been introduced, and CR-eligible sellers should make a note to start using <code>CERTIFIED_REFURBISHED</code> from this point forward. For the time being, if the <code>MANUFACTURER_REFURBISHED</code> enum is used in a <strong>createOrReplaceInventoryItem</strong> method, it will be accepted but automatically converted by eBay to <code>CERTIFIED_REFURBISHED</code>. In the future, the <code>MANUFACTURER_REFURBISHED</code> may start triggering an error if used.<br/><br/>As of September 1, 2021, condition ID <code>2500</code> (''Seller Refurbished'') can no longer be used in the Cell Phones & Smartphones category (category ID <code>9355</code>) for the following marketplaces: US, Canada, UK, Germany, and Australia. The ''Seller Refurbished'' item condition will be replaced by one of three new refurbished values:<ul><li>condition ID <code>2010</code> (''Excellent - Refurbished'')</li><li>condition ID <code>2020</code> (''Very Good - Refurbished'')</li><li>condition ID <code>2030</code> (''Good - Refurbished'')</li></ul> To use any of these new refurbished item conditions in category <code>9355</code>, sellers must go through an application and qualification process. Any seller who is not eligible to use these new refurbished item conditions in category <code>9355</code> will be blocked if they try to create a new listing or revise an existing listing with any of these three new item conditions. Any active listings in category <code>9355</code> that had condition ID <code>2500</code> (''Seller Refurbished'') as the item condition should have been administratively ended by eBay. Sellers will have to relist these items, and until they are eligible to list with the new refurbished item conditions, they will need to use another item condition supported in category <code>9355</code>, such as condition ID <code>3000</code> (''Used'').<br/><br/>To list an item as ''Certified Refurbished'', a seller must be pre-qualified by eBay for this feature. Any seller who is not eligible for this feature will be blocked if they try to create a new listing or revise an existing listing with this item condition. <br><br> Any seller that is interested in eligibility requirements to list with ''Certified Refurbished'' should see the <a href="https://pages.ebay.com/seller-center/listing-and-marketing/certified-refurbished-program.html" target="_blank">Certified refurbished program</a> page in Seller Center. </span> For implementation help, refer to <a href=''https://developer.ebay.com/api-docs/sell/inventory/types/slr:ConditionEnum''>eBay API documentation</a>'
conditionDescription:
type: string
description: 'This string field is used by the seller to more clearly describe the condition of a used inventory item, or an inventory item whose <strong>condition</strong> value is not <code>NEW</code>, <code>LIKE_NEW</code>, <code>NEW_OTHER</code>, or <code>NEW_WITH_DEFECTS</code>.<br/><br/> The <strong>conditionDescription</strong> field is available for all eBay categories. If the <strong>conditionDescription</strong> field is used with an item in one of the new conditions (mentioned in previous paragraph), eBay will simply ignore this field if included, and eBay will return a warning message to the user. <br/><br/> This field should only be used to further clarify the condition of the used item. It should not be used for branding, promotions, shipping, returns, payment or other information unrelated to the condition of the used item. Make sure that the <strong>condition</strong> value, condition description, listing description, and the item''s pictures do not contradict one another. <br /><br /> This field is not always required, but is required if an inventory item is being updated and a condition description already exists for that inventory item. <br /><br /> This field is returned in the <strong>getInventoryItem</strong> and <strong>getInventoryItems</strong> calls if a condition description was provided for a used inventory item.<br/><br/><strong>Max Length</strong>: 1000.'
packageWeightAndSize:
description: This container is used if the seller is offering one or more calculated shipping options for the inventory item, or if the seller is offering flat-rate shipping but is including a shipping surcharge based on the item's weight. This container is used to specify the dimensions and weight of a shipping package. <br /><br /> This container is not always required, but is required if an inventory item is being updated and shipping package data already exists for that inventory item.<br /><br /> This container is returned in the <strong>getInventoryItem</strong> and <strong>getInventoryItems</strong> calls if package type, package weight, and/or package dimensions are specified for an inventory item.<br/><br/>See the <a href="https://pages.ebay.com/help/pay/calculated-shipping.html" target="_blank">Calculated shipping</a> help page for more information on calculated shipping.
$ref: '#/components/schemas/PackageWeightAndSize'
product:
description: This container is used to define the product details, such as product title, product description, product identifiers (eBay Product ID, GTIN, or Brand/MPN pair), product aspects/item specifics, and product images. Note that an eBay Product ID (ePID) or a Global Trade Item Number (GTIN) value can be used in an attempt to find a matching product in the eBay Catalog. If a product match is found, the inventory item record will automatically pick up all product details associated with the eBay Catalog product.<br/><br/> Many eBay categories will require at least one product identifier (a GTIN or a Brand/MPN pair). To discover which product identifier(s) that an eBay category might require or support, use the <a href="/api-docs/commerce/taxonomy/resources/category_tree/methods/getItemAspectsForCategory">getItemAspectsForCategory</a> method in the Taxonomy API. In the <strong>getItemAspectsForCategory</strong> response, look for product identifier names (<code>brand</code>, <code>mpn</code>, <code>upc</code>, <code>ean</code>, <code>isbn</code>) in the <strong>localizedAspectName</strong> fields, and then look for the correspondinng <strong>aspectRequired</strong> boolean fields as well as the corresponding <strong>aspectUsage</strong> field, which will indicate if the aspect is required, recommended, or optional. In some cases, a product identifier type may be required, but not known/applicable for a product. If this is the case, the seller must still include the corresponding field in the inventory item record, but pass in a default text string. This text string can vary by site, so the seller should use the <strong>GeteBayDetails</strong> call of the Trading API to get this string value. In the <strong>GeteBayDetails</strong> call, the seller should include a <strong>DetailName</strong> field with its value set to <code>ProductDetails</code>. In the response of the call, the seller can see the default string value in the <strong>ProductDetails.ProductIdentifierUnavailableText</strong> field. The seller will use this value in one or more of the product identifier fields (<strong>ean</strong>, <strong>isbn</strong>, <strong>upc</strong>, or <strong>mpn</strong>) if a product ID isn't known or applicable. <br /><br /> This container is not initially required, but it is required before an inventory item can be published as an offer, and/or if an inventory item is being updated and product data already exists for that inventory item. <br /><br /> This container is always returned for published offers in the <strong>getInventoryItem</strong>, <strong>bulkGetInventoryItem</strong>, and <strong>getInventoryItems</strong> calls since product data must be defined for published offers, but for unpublished inventory items, this container will only be returned if product details have been defined for the inventory item.
$ref: '#/components/schemas/Product'
description: This type is used to provide detailed information about an inventory item.
InventoryItemGroup:
type: object
properties:
aspects:
type: string
description: 'This is a collection of item specifics (aka product aspects) name-value pairs that are shared by all product variations within the inventory item group. Common aspects for the inventory item group are not immediately required upon creating an inventory item group, but these aspects will be required before the first offer of the group is published. Common aspects for a men''s t-shirt might be pattern and sleeve length. Below is an example of the proper JSON syntax to use when manually inputting item specifics. Note that one item specific name, such as ''Features'', can have more than one value. If an item specific name has more than one value, each value is delimited with a comma.<br/> <pre><code>"aspects": {<br/> "pattern": ["solid"],<br/> "sleeves": ["short"]<br/> }</code></pre>This container is always returned if one or more offers associated with the inventory item group have been published, and is only returned if set for an inventory item group if that group has yet to have any offers published.<br/>'
description:
type: string
description: 'The description of the inventory item group. This description should fully describe the product and the variations of the product that are available in the inventory item group, since this description will ultimately become the listing description once the first offer of the group is published. This field is not initially required when first creating an inventory item group, but will be required before the first offer of the group is published. <br><br><span class="tablenote"> <strong>Note:</strong> Since this description will ultimately become the listing description in a multiple-variation listing, the seller should omit the <strong>listingDescription</strong> field when creating the offers for each variation. If they include the <strong>listingDescription</strong> field for the individual offer(s) in an item group, the text in that field for a published offer will overwrite the text provided in this <strong>description</strong> field for the inventory item group.</span><br/><br/>HTML tags and markup can be used in this field, but each character counts toward the max length limit.<br/><br/><span class="tablenote"> <strong>Note:</strong> To ensure that their short listing description is optimized when viewed on mobile devices, sellers should strongly consider using eBay''s <a href="https://pages.ebay.com/sell/itemdescription/customizeyoursummary.html " target="_blank">View Item description summary feature</a> when listing their items. Keep in mind that the ''short'' listing description is what prospective buyers first see when they view the listing on a mobile device. The ''full'' listing description is also available to mobile users when they click on the short listing description, but the full description is not automatically optimized for viewing in mobile devices, and many users won''t even drill down to the full description.<br><br> Using HTML div and span tag attributes, this feature allows sellers to customize and fully control the short listing description that is displayed to prospective buyers when viewing the listing on a mobile device. The short listing description on mobile devices is limited to 800 characters, and whenever the full listing description (provided in this field, in UI, or seller tool) exceeds this limit, eBay uses a special algorithm to derive the best possible short listing description within the 800-character limit. However, due to some short listing description content being removed, it is definitely not ideal for the seller, and could lead to a bad buyer experience and possibly to a Significantly not as described (SNAD) case, since the buyer may not get complete details on the item when viewing the short listing description. See the eBay help page for more details on using the HTML div and span tags.</span><br/><br/>This field is always returned if one or more offers associated with the inventory item group have been published, and is only returned if set for an inventory item group if that group has yet to have any offers published.<br/><br/><strong>Max Length</strong>: 500000 (which includes HTML markup/tags)<br>'
imageUrls:
type: array
description: An array of one or more links to images for the inventory item group. URLs must use the "HTTPS" protocol. Images can be self-hosted by the seller, or sellers can use the <a href="https://developer.ebay.com/Devzone/XML/docs/Reference/eBay/UploadSiteHostedPictures.html " target="_blank">UploadSiteHostedPictures</a> call of the Trading API to upload images to an eBay Picture Server. If successful, the response of the <a href="https://developer.ebay.com/Devzone/XML/docs/Reference/eBay/UploadSiteHostedPictures.html " target="_blank">UploadSiteHostedPictures</a> call will contain a full URL to the image on an eBay Picture Server. This is the URL that will be passed in through the <strong>imageUrls</strong> array. <br/><br/> Before any offer can be published, at least one image must exist for the offer. Links to images can either be passed in through this <strong>imageUrls</strong> container, or they can be passed in through the <strong>product.imageUrls</strong> container when creating each inventory item in the group. If the <strong>variesBy.aspectsImageVariesBy</strong> field is used to specify the main product aspect where the variations vary, the links to the images must be passed in through this <strong>imageUrls</strong> container, and there should be a picture for each variation. So, if the <strong>variesBy.aspectsImageVariesBy</strong> field is set to <code>Color</code>, a link should be included to an image demonstrating each available color in the group.<br><br>In almost any category at no cost, sellers can include up to 24 pictures in one listing. For inventory items that are a part of an inventory item group/multiple-variation listings, a maximum of 12 pictures may be used per inventory item in the group. Motor vehicle listings are an exception. The number of included pictures in motor vehicle listings depend on the selected vehicle package (see <a href="https://www.ebay.com/help/selling/fees-credits-invoices/motors-fees?id=4127 ">Fees for selling vehicles on eBay Motors</a>).<br/><br/> This container will always be returned for an inventory item group that has at least one published offer since a published offer will always have at least one picture, but this container will only be returned if defined for inventory item groups that have yet to have any published offers.
items:
type: string
inventoryItemGroupKey:
type: string
description: 'This is the unique identifier of the inventory item group. This identifier is created by the seller when an inventory item group is created. This field is only applicable to the <strong>getInventoryItemGroup</strong> call and not to the <strong>createOrReplaceInventoryItemGroup</strong> call. In the <strong>createOrReplaceInventoryItemGroup</strong> call, the <strong>inventoryItemGroupKey</strong> value is passed into the end of the call URI instead. '
subtitle:
type: string
description: 'A subtitle is an optional listing feature that allows the seller to provide more information about the product, possibly including keywords that may assist with search results. An additional listing fee will be charged to the seller if a subtitle is used. For more information on using listing subtitles on the US site, see the <a href="https://pages.ebay.com/help/sell/itemsubtitle.html " target="_blank">Adding a subtitle to your listings</a> help page. <br><br><span class="tablenote"> <strong>Note:</strong> Since this subtitle will ultimately become the subtitle in a multiple-variation listing, the seller should not include the <strong>subtitle</strong> field when creating the inventory items that are members of the group. If they do include the <strong>subtitle</strong> field in an inventory item record, the text in that field will overwrite the text provided in this <strong>subtitle</strong> field for each inventory item in the group that is published.</span><br/><br/>This field will only be returned if set for an inventory item.<br/><br/><strong>Max Length</strong>: 55<br/>'
title:
type: string
description: 'The title of the inventory item group. This title will ultimately become the listing title once the first offer of the group is published. This field is not initially required when first creating an inventory item group, but will be required before the first offer of the group is published.<br><br><span class="tablenote"> <strong>Note:</strong> Since this title will ultimately become the listing title in a multiple-variation listing, the seller should omit the <strong>title</strong> field when creating the inventory items that are members of the group. If they do include the <strong>title</strong> field in an inventory item record, the text in that field will overwrite the text provided in this <strong>title</strong> field for each inventory item in the group that is published.</span><br/><br/> This field is always returned if one or more offers associated with the inventory item group have been published, and is only returned if set for an inventory item group if that group has yet to have any offers published.<br/><br/><strong>Max Length</strong>: 80 <br/>'
variantSKUs:
type: array
description: This required container is used to assign individual inventory items to the inventory item group. Multiple SKU values are passed in to this container. If updating an existing inventory item group, the seller should make sure that all member SKU values are passed in, as long as the seller wants that SKU to remain in the group.<br><br> It is also possible to add or remove SKUs with a <strong>createOrReplaceInventoryItemGroup</strong> call. If the seller wants to remove a SKU from the group, that seller will just omit that SKU value from this container to remove that inventory item/SKU from the inventory item group and any published, multiple-variation listing. However, a variation cannot be removed from the group if that variation has one or more sales for that listing. A workaround for this is to set that variation's quantity to <code>0</code> and it will be 'grayed out' in the View Item page.<br><br>This container is always returned.
items:
type: string
variesBy:
description: This container is used to specify product aspects for which variations within an inventory item group vary, and a complete list of all those variances. For example, t-shirts in an inventory item group may be available in multiple sizes and colors. If this is the case, <code>Color</code> and <code>Size</code> would both be values in the <strong>specifications.name</strong> fields, and the available colors and sizes would be values under the corresponding <strong>specifications.values</strong> array. If the seller will be including multiple images in the listing that will demonstrate how each variation differs, that seller will also include the <strong>aspectsImageVariesBy</strong> field, and call out the product aspect where the listing images differ. In the t-shirts example, this product aspect would be <code>Color</code>, and the seller could either include URLs to images of the t-shirt (in available colors) through the inventory item group entity, or the seller could also included URLs to images of the t-shirt through the individual inventory item entities of the group.<br/><br/> This container is not initially required when first creating an inventory item group, but the <strong>variesBy.specifications</strong> container will be required before the first offer of the group is published.<br/><br/>This container is always returned if one or more offers associated with the inventory item group have been published, and is only returned if set for an inventory item group if that group has yet to have any offers published.
$ref: '#/components/schemas/VariesBy'
videoIds:
type: array
description: An array of one or more VideoId values for the inventory item group. A VideoId is a unique identifier that is automatically created by eBay when a seller successfully uploads a video to eBay using the <a href="https://developer.ebay.com/api-docs/commerce/media/resources/video/methods/uploadVideo" target="_blank">uploadVideo</a> method of the <a href="https://developer.ebay.com/api-docs/commerce/media/overview.html" target="_blank">Media API</a>.<br /><br />For information on supported marketplaces and platforms, as well as other requirements and limitations of video support, please refer to <a href="https://developer.ebay.com/api-docs/sell/static/inventory/managing-video-media.html" target="_blank">Managing videos</a>.
items:
type: string
description: This type is used by the base request payload of the <strong>createOrReplaceInventoryItemGroup</strong> call and the base response payload of the <strong>getInventoryItemGroup</strong> call.
InventoryItemListing:
type: object
properties:
offerId:
type: string
description: Upon a successful migration of a listing, eBay auto-generates this unique identifier, and this offer ID value will be used to retrieve and manage the newly-created offer object. This value will only be generated and returned if the eBay listing is migrated successfully.
sku:
type: string
description: This is the seller-defined SKU value associated with the item(s) in a listing. This same SKU value will be used to retrieve and manage the newly-created inventory item object if the listing migration is successful. This SKU value will get returned even if the migration is not successful.
description: This type is used by the <strong>inventoryItems</strong> container that is returned in the response of the <strong>bulkMigrateListing</strong> call. Up to five <strong>sku</strong>/<strong>offerId</strong> pairs may be returned under the <strong>inventoryItems</strong> container, dependent on how many eBay listings the seller is attempting to migrate to the inventory model.
InventoryItemResponse:
type: object
properties:
errors:
type: array
description: This container will be returned if there were one or more errors associated with the creation or update to the inventory item record.
items:
$ref: '#/components/schemas/Error'
locale:
type: string
description: This field returns the natural language that was provided in the field values of the request payload (i.e., en_AU, en_GB or de_DE). For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/inventory/types/slr:LocaleEnum'>eBay API documentation</a>
sku:
type: string
description: The seller-defined Stock-Keeping Unit (SKU) of the inventory item. The seller should have a unique SKU value for every product that they sell.
statusCode:
type: integer
description: The HTTP status code returned in this field indicates the success or failure of creating or updating the inventory item record for the inventory item indicated in the <strong>sku</strong> field. See the <strong>HTTP status codes</strong> table to see which each status code indicates.
format: int32
warnings:
type: array
description: This container will be returned if there were one or more warnings associated with the creation or update to the inventory item record.
items:
$ref: '#/components/schemas/Error'
description: This type is used by the response of the <strong>bulkCreateOrReplaceInventoryItem</strong> method to indicate the success or failure of creating and/or updating each inventory item record. The <strong>sku</strong> value in this type identifies each inventory item record.
InventoryItemWithSkuLocale:
type: object
properties:
availability:
description: This container is used to specify the quantity of the inventory item that are available for purchase. <br /><br /> This container is optional up until the seller is ready to publish an offer with the SKU, at which time it becomes required. Availability data must also be passed if an inventory item is being updated and availability data already exists for that inventory item.<br /><br /> Since an inventory item must have specified quantity before being published in an offer, this container is always returned in the 'Get' calls for SKUs that are part of a published offer. If a SKU is not part of a published offer, this container will only be returned if set for the inventory item.
$ref: '#/components/schemas/Availability'
condition:
type: string
description: This enumeration value indicates the condition of the item. Supported item condition values will vary by eBay site and category. To see which item condition values that a particular eBay category supports, use the <a href="/api-docs/sell/metadata/resources/marketplace/methods/getItemConditionPolicies">getItemConditionPolicies</a> method of the <strong>Metadata API</strong>. This method returns condition ID values that map to the enumeration values defined in the <a href="/api-docs/sell/inventory/types/slr:ConditionEnum">ConditionEnum</a> type. The <a href="/api-docs/sell/static/metadata/condition-id-values.html">Item condition ID and name values</a> topic in the <strong>Selling Integration Guide</strong> has a table that maps condition ID values to <strong>ConditionEnum</strong> values. The <strong>getItemConditionPolicies</strong> call reference page has more information.<br><br> A <strong>condition</strong> value is optional up until the seller is ready to publish an offer with the SKU, at which time it becomes required for most eBay categories. <br/><br/> <span class="tablenote"> <strong>Note:</strong> The 'Manufacturer Refurbished' item condition is no longer a valid item condition on any eBay marketplace, and to reflect this change, the <code>MANUFACTURER_REFURBISHED</code> value is no longer applicable, and should not be used. With Version 1.13.0, the <code>CERTIFIED_REFURBISHED</code> enumeration value has been introduced, and CR-eligible sellers should make a note to start using <code>CERTIFIED_REFURBISHED</code> from this point forward. For the time being, if the <code>MANUFACTURER_REFURBISHED</code> enum is used for any of the SKUs in a <strong>bulkCreateOrReplaceInventoryItem</strong> method, it will be accepted but automatically converted by eBay to <code>CERTIFIED_REFURBISHED</code>. <br/><br/> To list an item as 'Certified Refurbished', a seller must be pre-qualified by eBay for this feature. Any seller who is not eligible for this feature will be blocked if they try to create a new listing or revise an existing listing with this item condition. <br><br> Any seller that is interested in eligibility requirements to list with 'Certified Refurbished' should see the <a href="https://pages.ebay.com/seller-center/listing-and-marketing/certified-refurbished-program.html" target="_blank">Certified refurbished program</a> page in Seller Center. </span> For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/inventory/types/slr:ConditionEnum'>eBay API documentation</a>
conditionDescription:
type: string
description: 'This string field is used by the seller to more clearly describe the condition of a used inventory item, or an inventory item whose <strong>condition</strong> value is not <code>NEW</code>, <code>LIKE_NEW</code>, <code>NEW_OTHER</code>, or <code>NEW_WITH_DEFECTS</code>.<br/><br/> The <strong>conditionDescription</strong> field is available for all eBay categories. If the <strong>conditionDescription</strong> field is used with an item in one of the new conditions (mentioned in previous paragraph), eBay will simply ignore this field if included, and eBay will return a warning message to the user. <br/><br/> This field should only be used to further clarify the condition of the used item. It should not be used for branding, promotions, shipping, returns, payment or other information unrelated to the condition of the used item. Make sure that the <strong>condition</strong> value, condition description, listing description, and the item''s pictures do not contradict one another. <br /><br /> This field is not always required, but is required if an inventory item is being updated and a condition description already exists for that inventory item. <br /><br /> This field is returned in the <strong>getInventoryItem</strong>, <strong>bulkGetInventoryItem</strong>, and <strong>getInventoryItems</strong> calls if a condition description was provided for a used inventory item.<br/><br/><strong>Max Length</strong>: 1000.'
locale:
type: string
description: This request parameter sets the natural language that was provided in the field values of the request payload (i.e., en_AU, en_GB or de_DE). For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/inventory/types/slr:LocaleEnum'>eBay API documentation</a>
packageWeightAndSize:
description: This container is used if the seller is offering one or more calculated shipping options for the inventory item, or if the seller is offering flat-rate shipping but is including a shipping surcharge based on the item's weight. This container is used to specify the dimensions and weight of a shipping package. <br /><br /> This container is not always required, but is required if an inventory item is being updated and shipping package data already exists for that inventory item.<br /><br /> This container is returned in the <strong>getInventoryItem</strong>, <strong>bulkGetInventoryItem</strong>, and <strong>getInventoryItems</strong> calls if package type, package weight, and/or package dimensions are specified for an inventory item.<br/><br/>See the <a href="https://pages.ebay.com/help/pay/calculated-shipping.html" target="_blank">Calculated shipping</a> help page for more information on calculated shipping.
$ref: '#/components/schemas/PackageWeightAndSize'
product:
description: This container is used to define the product details, such as product title, product description, product identifiers (eBay Product ID, GTIN, or Brand/MPN pair), product aspects/item specifics, and product images. Note that an eBay Product ID (ePID) or a Global Trade Item Number (GTIN) value can be used in an attempt to find a matching product in the eBay Catalog. If a product match is found, the inventory item record will automatically pick up all product details associated with the eBay Catalog product.<br/><br/> Many eBay categories will require at least one product identifier (a GTIN or a Brand/MPN pair). To discover which product identifier(s) that an eBay category might require or support, use the <a href="/api-docs/commerce/taxonomy/resources/category_tree/methods/getItemAspectsForCategory">getItemAspectsForCategory</a> method in the Taxonomy API. In the <strong>getItemAspectsForCategory</strong> response, look for product identifier names (<code>brand</code>, <code>mpn</code>, <code>upc</code>, <code>ean</code>, <code>isbn</code>) in the <strong>localizedAspectName</strong> fields, and then look for the correspondinng <strong>aspectRequired</strong> boolean fields as well as the corresponding <strong>aspectUsage</strong> field, which will indicate if the aspect is required, recommended, or optional. In some cases, a product identifier type may be required, but not known/applicable for a product. If this is the case, the seller must still include the corresponding field in the inventory item record, but pass in a default text string. This text string can vary by site, so the seller should use the <strong>GeteBayDetails</strong> call of the Trading API to get this string value. In the <strong>GeteBayDetails</strong> call, the seller should include a <strong>DetailName</strong> field with its value set to <code>ProductDetails</code>. In the response of the call, the seller can see the default string value in the <strong>ProductDetails.ProductIdentifierUnavailableText</strong> field. The seller will use this value in one or more of the product identifier fields (<strong>ean</strong>, <strong>isbn</strong>, <strong>upc</strong>, or <strong>mpn</strong>) if a product ID isn't known or applicable. <br /><br /> This container is not initially required, but it is required before an inventory item can be published as an offer, and/or if an inventory item is being updated and product data already exists for that inventory item. <br /><br /> This container is always returned for published offers in the <strong>getInventoryItem</strong>, <strong>bulkGetInventoryItem</strong>, and <strong>getInventoryItems</strong> calls since product data must be defined for published offers, but for unpublished inventory items, this container will only be returned if product details have been defined for the inventory item.
$ref: '#/components/schemas/Product'
sku:
type: string
description: 'This is the seller-defined SKU value of the product that will be listed on the eBay site (specified in the <strong>marketplaceId</strong> field). Only one offer (in unpublished or published state) may exist for each <strong>sku</strong>/<strong>marketplaceId</strong>/<strong>format</strong> combination. This field is required.<br/><br/><strong>Max Length</strong>: 50<br/>'
description: This type is used to define/modify each inventory item record that is being created and/or updated with the <strong>bulkCreateOrReplaceInventoryItem</strong> method. Up to 25 inventory item records can be created and/or updated with one call.
InventoryItemWithSkuLocaleGroupKeys:
type: object
properties:
availability:
description: This container shows the quantity of the inventory item that is available for purchase if the item will be shipped to the buyer, and/or the quantity of the inventory item that is available for In-Store Pickup at one or more of the merchant's physical stores.
$ref: '#/components/schemas/AvailabilityWithAll'
condition:
type: string
description: This enumeration value indicates the condition of the item. Supported item condition values will vary by eBay site and category. <br /><br /> Since the condition of an inventory item must be specified before being published in an offer, this field is always returned in the 'Get' calls for SKUs that are part of a published offer. If a SKU is not part of a published offer, this field will only be returned if set for the inventory item.<br/><br/> <span class="tablenote"> <strong>Note:</strong> The 'Manufacturer Refurbished' item condition is no longer a valid item condition on any eBay marketplace, and to reflect this change, the <code>MANUFACTURER_REFURBISHED</code> value has essentially been replaced with the <code>CERTIFIED_REFURBISHED</code> enumeration value with Version 1.13.0. For any existing inventory items that have <code>MANUFACTURER_REFURBISHED</code> set as their <strong>condition</strong> value, eBay will automatically convert the condition of these inventory items to <code>CERTIFIED_REFURBISHED</code>, so it is not necessary for the developer to update these inventory items with a 'create or replace' call. <br/><br/> To list an item as 'Certified Refurbished', a seller must be pre-qualified by eBay for this feature. Any seller who is not eligible for this feature will be blocked if they try to create a new listing or revise an existing listing with this item condition. <br><br> Any seller that is interested in eligibility requirements to list with 'Certified Refurbished' should see the <a href="https://pages.ebay.com/seller-center/listing-and-marketing/certified-refurbished-program.html" target="_blank">Certified refurbished program</a> page in Seller Center. </span> For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/inventory/types/slr:ConditionEnum'>eBay API documentation</a>
conditionDescription:
type: string
description: 'This string field is used by the seller to more clearly describe the condition of used items, or items that are not ''Brand New'', ''New with tags'', or ''New in box''. The ConditionDescription field is available for all categories. If the ConditionDescription field is used with an item in a new condition (Condition IDs 1000-1499), eBay will simply ignore this field if included, and eBay will return a warning message to the user. This field should only be used to further clarify the condition of the used item. It should not be used for branding, promotions, shipping, returns, payment or other information unrelated to the condition of the item. Make sure that the condition value, condition description, listing description, and the item''s pictures do not contradict one another.Max length: 1000.'
inventoryItemGroupKeys:
type: array
description: This array is returned if the inventory item is associated with any inventory item group(s). The value(s) returned in this array are the unique identifier(s) of the inventory item's variation in a multiple-variation listing. This array is not returned if the inventory item is not associated with any inventory item groups.
items:
type: string
locale:
type: string
description: This field returns the natural language that was provided in the field values of the request payload (i.e., en_AU, en_GB or de_DE). For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/inventory/types/slr:LocaleEnum'>eBay API documentation</a>
packageWeightAndSize:
description: This container is used to specify the dimensions and weight of a shipping package.
$ref: '#/components/schemas/PackageWeightAndSize'
product:
description: This container is used in a <strong>createOrReplaceInventoryItem</strong> call to pass in a Global Trade Item Number (GTIN) or a Brand and Manufacturer Part Number (MPN) pair to identify a product to be matched with a product in the eBay catalog. If a match is found in the eBay product catalog, the inventory item is automatically populated with available product details such as a title, a subtitle, a product description, item specifics, and links to stock images for the product.
$ref: '#/components/schemas/Product'
sku:
type: string
description: The seller-defined Stock-Keeping Unit (SKU) of the inventory item. The seller should have a unique SKU value for every product that they sell.
description: This type is used to provide details about each retrieved inventory item record.
InventoryItemWithSkuLocaleGroupid:
type: object
properties:
availability:
description: This container is used to specify the quantity of the inventory item that are available for purchase if the item will be shipped to the buyer, and the quantity of the inventory item that are available for In-Store Pickup at one or more of the merchant's physical stores
$ref: '#/components/schemas/AvailabilityWithAll'
condition:
type: string
description: This enumeration value indicates the condition of the item. Supported item condition values will vary by eBay site and category. <br /><br /> Since the condition of an inventory item must be specified before being published in an offer, this field is always returned in the 'Get' calls for SKUs that are part of a published offer. If a SKU is not part of a published offer, this field will only be returned if set for the inventory item.<br/><br/> <span class="tablenote"> <strong>Note:</strong> The 'Manufacturer Refurbished' item condition is no longer a valid item condition on any eBay marketplace, and to reflect this change, the <code>MANUFACTURER_REFURBISHED</code> value has essentially been replaced with the <code>CERTIFIED_REFURBISHED</code> enumeration value with Version 1.13.0. For any existing inventory items that have <code>MANUFACTURER_REFURBISHED</code> set as their <strong>condition</strong> value, eBay will automatically convert the condition of these inventory items to <code>CERTIFIED_REFURBISHED</code>, so it is not necessary for the developer to update these inventory items with a 'create or replace' call. <br/><br/> To list an item as 'Certified Refurbished', a seller must be pre-qualified by eBay for this feature. Any seller who is not eligible for this feature will be blocked if they try to create a new listing or revise an existing listing with this item condition. <br><br> Any seller that is interested in eligibility requirements to list with 'Certified Refurbished' should see the <a href="https://pages.ebay.com/seller-center/listing-and-marketing/certified-refurbished-program.html" target="_blank">Certified refurbished program</a> page in Seller Center. </span> For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/inventory/types/slr:ConditionEnum'>eBay API documentation</a>
conditionDescription:
type: string
description: 'This string field is used by the seller to more clearly describe the condition of used items, or items that are not ''Brand New'', ''New with tags'', or ''New in box''. The ConditionDescription field is available for all categories. If the ConditionDescription field is used with an item in a new condition (Condition IDs 1000-1499), eBay will simply ignore this field if included, and eBay will return a warning message to the user. This field should only be used to further clarify the condition of the used item. It should not be used for branding, promotions, shipping, returns, payment or other information unrelated to the condition of the item. Make sure that the condition value, condition description, listing description, and the item''s pictures do not contradict one another.<br /><br /><strong>Max length</strong>/: 1000.'
groupIds:
type: array
description: This array is returned if the inventory item is associated with any inventory item group(s). The value(s) returned in this array are the unique identifier(s) of the inventory item group(s). This array is not returned if the inventory item is not associated with any inventory item groups.
items:
type: string
inventoryItemGroupKeys:
type: array
description: This array is returned if the inventory item is associated with any inventory item group(s). The value(s) returned in this array are the unique identifier(s) of the inventory item's variation in a multiple-variation listing. This array is not returned if the inventory item is not associated with any inventory item groups.
items:
type: string
locale:
type: string
description: This field returns the natural language that was provided in the field values of the request payload (i.e., en_AU, en_GB or de_DE). For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/inventory/types/slr:LocaleEnum'>eBay API documentation</a>
packageWeightAndSize:
description: This container is used to specify the dimensions and weight of a shipping package.
$ref: '#/components/schemas/PackageWeightAndSize'
product:
description: This container is used in a <strong>createOrReplaceInventoryItem</strong> call to pass in a Global Trade Item Number (GTIN) or a Brand and Manufacturer Part Number (MPN) pair to identify a product to be matched with a product in the eBay catalog. If a match is found in the eBay product catalog, the inventory item is automatically populated with available product details such as a title, a subtitle, a product description, item specifics, and links to stock images for the product.
$ref: '#/components/schemas/Product'
sku:
type: string
description: The seller-defined Stock-Keeping Unit (SKU) of the inventory item. The seller should have a unique SKU value for every product that they sell.
InventoryItems:
type: object
properties:
href:
type: string
description: This is the URL to the current page of inventory items.
inventoryItems:
type: array
description: This container is an array of one or more inventory items, with detailed information on each inventory item.
items:
$ref: '#/components/schemas/InventoryItemWithSkuLocaleGroupid'
limit:
type: integer
description: This integer value is the number of inventory items that will be displayed on each results page.
format: int32
next:
type: string
description: This is the URL to the next page of inventory items. This field will only be returned if there are additional inventory items to view.
prev:
type: string
description: This is the URL to the previous page of inventory items. This field will only be returned if there are previous inventory items to view.
size:
type: integer
description: This integer value indicates the total number of pages of results that are available. This number will depend on the total number of inventory items available for viewing, and on the <strong>limit</strong> value.
format: int32
total:
type: integer
description: This integer value is the total number of inventory items that exist for the seller's account. Based on this number and on the <strong>limit</strong> value, the seller may have to toggle through multiple pages to view all inventory items.
format: int32
description: 'This type is used by the base response payload of <strong>getInventoryItems</strong> call. '
InventoryLocation:
type: object
properties:
locationAdditionalInformation:
type: string
description: 'This text field is used by the merchant to provide/update additional information about an inventory location. Whatever text is passed in this field will replace the current text string defined for this field. If the text will not change, the same text should be passed in once again. <br/><br/><b>Max length</b>: 256'
locationInstructions:
type: string
description: 'This text field is generally used by the merchant to provide/update special pickup instructions for a store inventory location. Although this field is optional, it is recommended that merchants provide this field to create a pleasant and easy pickup experience for In-Store Pickup and Click and Collect orders. If this field is not included in the call request payload, eBay will use the default pickup instructions contained in the merchant''s profile (if available). Whatever text is passed in this field will replace the current text string defined for this field. If the text will not change, the same text should be passed in once again. <br/><br/><b>Max length</b>: 1000'
locationWebUrl:
type: string
description: 'This text field is used by the merchant to provide/update the Website address (URL) associated with the inventory location. The URL that is passed in this field will replace any other URL that may be defined for this field. <br/><br/><b>Max length</b>: 512'
name:
type: string
description: This text field is used by the merchant to update the name of the inventory location. This name should be a human-friendly name as it will be in In-Store Pickup and Click and Collect listings. A name is not required for warehouse inventory locations. For store inventory locations, this field is not immediately required, but will be required before an offer enabled with the In-Store Pickup or Click and Collect capability can be published. So, if the seller omitted this field in the <strong>createInventoryLocation</strong> call, it is required for an <strong>updateInventoryLocation</strong> call. The name that is passed in this field will replace any other name that may be defined for this field.
operatingHours:
type: array
description: This container is used to provide/update the regular operating hours for a store location during the days of the week. A <strong>dayOfWeekEnum</strong> field and an <strong>intervals</strong> container will be needed for each day of the week that the store location is open. Note that if operating hours are already set for an inventory location for a specific day of the week, whatever is set through an <strong>updateInventoryLocation</strong> call will override those existing hours.
items:
$ref: '#/components/schemas/OperatingHours'
phone:
type: string
description: 'This text field is used by the merchant to provide/update the phone number for the inventory location. The phone number that is passed in this field will replace any other phone number that may be defined for this field. <br/><br/><b>Max length</b>: 36'
specialHours:
type: array
description: This container is used to provide/update the special operating hours for a store location on a specific date, such as a holiday. The special hours specified for the specific date will override the normal operating hours for that particular day of the week. If special hours have already been set up for an inventory location, specifying special hours through an <strong>updateInventoryLocation</strong> call will only add to the list, unless the date(s) used are the same special date(s) already set up, in which case, the special hours set up through the <strong>updateInventoryLocation</strong> call will override the existing special hours.
items:
$ref: '#/components/schemas/SpecialHours'
description: This type is used by the <strong>updateInventoryLocation</strong> call to update operating hours, special hours, phone number, and other minor details of an inventory location.
InventoryLocationFull:
type: object
properties:
location:
description: This required container is used to set the physical address and geographical coordinates (optional) of a warehouse or store inventory location. A warehouse inventory location only requires the city, province/state, and country, and does not require a full street address. However, the seller may still supply a full street address for a warehouse location. The physical location/address for an inventory location cannot be modified once set with a <strong>createInventoryLocation</strong> call. All other details of an inventory location (e.g. phone or operating hours) can be changed with an <strong>updateInventoryLocation</strong> call.
$ref: '#/components/schemas/LocationDetails'
locationAdditionalInformation:
type: string
description: 'This text field is used by the merchant to provide additional information about an inventory location. <br/><br/><b>Max length</b>: 256'
locationInstructions:
type: string
description: This text field is generally used by the merchant to provide special pickup instructions for a store inventory location. Although this field is optional, it is recommended that merchants provide this field to create a pleasant and easy pickup experience for In-Store Pickup and Click and Collect orders. If this field is not included in the call request payload, eBay will use the default pickup instructions contained in the merchant's profile (if available). <br/><br/>
locationTypes:
type: array
description: 'This container is used to define the function of the inventory location. Typically, an inventory location will serve as a store or a warehouse, but in some cases, an inventory location may be both. <br/><br/> If this container is omitted, the location type of the inventory location will default to <code>WAREHOUSE</code>. See <a href="/api-docs/sell/inventory/types/api:StoreTypeEnum">StoreTypeEnum</a> for the supported values.<br/><br/><b>Default</b>: WAREHOUSE'
items:
type: string
description: ' For implementation help, refer to <a href=''https://developer.ebay.com/api-docs/sell/inventory/types/api:StoreTypeEnum''>eBay API documentation</a>'
locationWebUrl:
type: string
description: 'This text field is used by the merchant to provide the Website address (URL) associated with the inventory location. <br/><br/><b>Max length</b>: 512'
merchantLocationStatus:
type: string
description: 'This field is used to indicate whether the inventory location will be enabled (inventory can be loaded to location) or disabled (inventory can not be loaded to location). If this field is omitted, a successful <strong>createInventoryLocation</strong> call will automatically enable the inventory location. A merchant may want to create a new inventory location but leave it as disabled if the inventory location is not yet ready for active inventory. Once the inventory location is ready, the merchant can use the <strong>enableInventoryLocation</strong> call to enable an inventory location that is in a disabled state. See <a href="/api-docs/sell/inventory/types/api:StatusEnum">StatusEnum</a> for the supported values. <br/><br/><b>Default</b>: ENABLED For implementation help, refer to <a href=''https://developer.ebay.com/api-docs/sell/inventory/types/api:StatusEnum''>eBay API documentation</a>'
name:
type: string
description: 'The name of the inventory location. This name should be a human-friendly name as it will be displayed in In-Store Pickup and Click and Collect listings. A name is not required for warehouse inventory locations. For store inventory locations, this field is not immediately required, but will be required before an offer enabled with the In-Store Pickup or Click and Collect capability can be published. So, if the seller omits this field in a <strong>createInventoryLocation</strong> call, it becomes required for an <strong>updateInventoryLocation</strong> call.<br/><br/><b>Max length</b>: 1000'
operatingHours:
type: array
description: Although not technically required, this container is highly recommended to be used to specify operating hours for a store inventory location. This container is used to express the regular operating hours for a store location during each day of the week. A <strong>dayOfWeekEnum</strong> field and an <strong>intervals</strong> container will be needed for each day of the week that the store location is open.
items:
$ref: '#/components/schemas/OperatingHours'
phone:
type: string
description: 'Although not technically required, this field is highly recommended to be used to specify the phone number for a store inventory location. <br/><br/><b>Max length</b>: 36'
specialHours:
type: array
description: This container is used to express the special operating hours for a store inventory location on a specific date, such as a holiday. The special hours specified for the specific date will override the normal operating hours for that particular day of the week.
items:
$ref: '#/components/schemas/SpecialHours'
description: This type is used by the <strong>createInventoryLocation</strong> call to provide details on the inventory location, including the location's name, physical address, operating hours, special hours, phone number and other details of an inventory location.
InventoryLocationResponse:
type: object
properties:
location:
description: This container provides location details of an inventory location. The <strong>address</strong> container will always be returned, but it will not always have a complete street address. Except in the case of an inventory location that supports In-Store Pickup inventory, a full address is not a requirement when setting up an inventory location. The <strong>geoCoordinates</strong> container will only be returned if the merchant provided geographical coordinates. The <strong>locationId</strong> field is always returned, but this value is only used internally by eBay.
$ref: '#/components/schemas/Location'
locationAdditionalInformation:
type: string
description: 'This text field provides additional information about an inventory location. This field is returned if it is set for the inventory location. <br/><br/><b>Max length</b>: 256'
locationInstructions:
type: string
description: 'This text field is used by the merchant to provide special pickup instructions for the store location. This field can help create a pleasant and easy pickup experience for In-Store Pickup and Click and Collect orders. If this field was not set up through a <strong>createInventoryLocation</strong> or a <strong>updateInventoryLocation</strong> call, eBay will use the default pickup instructions contained in the merchant''s profile.<br/><br/><b>Max length</b>: 1000'
locationTypes:
type: array
description: This container defines the function of the inventory location. Typically, an inventory location will serve as a store or a warehouse, but in some cases, an inventory location may be both. <br/><br/>The location type of an inventory location defaults to <code>WAREHOUSE</code> if a location type is not specified when a merchant creates an inventory location.
items:
type: string
description: ' For implementation help, refer to <a href=''https://developer.ebay.com/api-docs/sell/inventory/types/api:StoreTypeEnum''>eBay API documentation</a>'
locationWebUrl:
type: string
description: 'This text field shows the Website address (URL) associated with the inventory location. This field is returned if defined for the inventory location. <br/><br/><b>Max length</b>: 512'
merchantLocationKey:
type: string
description: 'The unique identifier of the inventory location. This identifier is set up by the merchant when the inventory location is first created with the <strong>createInventoryLocation</strong> call. Once this value is set for an inventory location, it cannot be modified. <br/><br/><b>Max length</b>: 36'
merchantLocationStatus:
type: string
description: This field indicates whether the inventory location is enabled (inventory can be loaded to location) or disabled (inventory can not be loaded to location). The merchant can use the <strong>enableInventoryLocation</strong> call to enable an inventory location in disabled status, or the <strong>disableInventoryLocation</strong> call to disable an inventory location in enabled status. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/inventory/types/api:StatusEnum'>eBay API documentation</a>
name:
type: string
description: 'The name of the inventory location. This name should be a human-friendly name as it will be displayed in In-Store Pickup and Click and Collect listings. For store inventory locations, this field is not required for the <strong>createInventoryLocation</strong> call, but a store inventory location must have a defined <strong>name</strong> value before an In-Store Pickup and Click and Collect enabled offer is published. So, if the seller omits this field in the <strong>createInventoryLocation</strong> call, it will have to be added later through a <strong>updateInventoryLocation</strong> call. <br/><br/><b>Max length</b>: 1000'
operatingHours:
type: array
description: This container shows the regular operating hours for a store location during the days of the week. A <strong>dayOfWeekEnum</strong> field and an <strong>intervals</strong> container is shown for each day of the week that the store location is open.
items:
$ref: '#/components/schemas/OperatingHours'
phone:
type: string
description: 'The phone number for an inventory location. This field will typically only be set and returned for store locations. <br/><br/><b>Max length</b>: 36'
specialHours:
type: array
description: This container shows the special operating hours for a store location on a specific date or dates.
items:
$ref: '#/components/schemas/SpecialHours'
description: This type is used by the base response of the <strong>getInventoryLocation</strong> and <strong>getInventoryLocations</strong> calls. These responses provide details about inventory location(s) defined for the merchant's account.
ListingDetails:
type: object
properties:
listingId:
type: string
description: 'The unique identifier of the eBay listing that is associated with the published offer. '
listingStatus:
type: string
description: The enumeration value returned in this field indicates the status of the listing that is associated with the published offer. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/inventory/types/slr:ListingStatusEnum'>eBay API documentation</a>
soldQuantity:
type: integer
description: This integer value indicates the quantity of the product that has been sold for the published offer.
format: int32
description: This type is used by the <strong>listing</strong> container in the <strong>getOffer</strong> and <strong>getOffers</strong> calls to provide the eBay listing ID, the listing status, and quantity sold for the offer. The <strong>listing</strong> container is only returned for published offers, and is not returned for unpublished offers.
ListingPolicies:
type: object
properties:
bestOfferTerms:
description: This container is used if the seller would like to support the Best Offer feature on their listing. To enable the Best Offer feature, the seller will have to set the <strong>bestOfferEnabled</strong> field to <code>true</code>, and the seller also has the option of setting 'auto-accept' and 'auto-decline' price thresholds.<br><br>This container is only returned if Best Offer is enabled on listing.
$ref: '#/components/schemas/BestOffer'
eBayPlusIfEligible:
type: boolean
description: This field is included in an offer and set to <code>true</code> if a Top-Rated seller is opted in to the eBay Plus program. With the eBay Plus program, qualified sellers must commit to next-day delivery of the item, and the buyers must have an eBay Plus subscription to be eligible to receive the benefits of this program, which are free, next-day delivery, as well as free returns.<br><br>Currently, this program is only available on the Germany and Australian sites.<br/><br/>This field will be returned in the <strong>getOffer</strong> and <strong>getOffers</strong> calls if set for the offer.
fulfillmentPolicyId:
type: string
description: This unique identifier indicates the fulfillment business policy that will be used once an offer is published and converted to an eBay listing. This fulfillment business policy will set all fulfillment-related settings for the eBay listing.<br/><br/>Business policies are not immediately required for offers, but are required before an offer can be published. The seller should review the fulfillment business policy before assigning it to the offer to make sure it is compatible with the inventory item and the offer settings. The seller may also want to review the shipping service costs in the fulfillment policy, and that seller might decide to override the shipping costs for one or more shipping service options by using the <strong>shippingCostOverrides</strong> container.<br/><br/>Business policies can be created and managed in My eBay or with the <strong>Account API</strong>. To get a list of all return policies associated with a seller's account on a specific eBay Marketplace, use the Account API's <strong>getFulfillmentPolicies</strong> call. There are also calls in the <strong>Account API</strong> to retrieve a fulfillment policy by policy ID or policy name.<br/><br/>This field will be returned in the <strong>getOffer</strong> and <strong>getOffers</strong> calls if set for the offer.
paymentPolicyId:
type: string
description: This unique identifier indicates the payment business policy that will be used once an offer is published and converted to an eBay listing. This payment business policy will set all payment-related settings for the eBay listing.<br/><br/>Business policies are not immediately required for offers, but are required before an offer can be published. The seller should review the payment business policy to make sure that it is compatible with the marketplace and listing category before assigning it to the offer.<br /><br />Business policies can be created and managed in My eBay or with the <strong>Account API</strong>. To get a list of all payment policies associated with a seller's account on a specific eBay Marketplace, use the Account API's <strong>getPaymentPolicies</strong> call. There are also calls in the <strong>Account API</strong> to retrieve a payment policy by policy ID or policy name.<br/><br/>This field will be returned in the <strong>getOffer</strong> and <strong>getOffers</strong> calls if set for the offer.
productCompliancePolicyIds:
type: array
description: This field contains an array of up to five IDs specifying the seller created compliance policies for the listing. Custom policies provide buyers with important information and disclosures about products. For example, if you sell batteries and specific disclosures are required, your compliance policy could contain the required disclosures. See <a href="https://www.ebay.com/help/selling/custom-policies/custom-policies?id=5311" target="_blank">Custom Policies</a> for more information. Up to five different compliance policies can be applied to each listing. Refer to the <a href="/api-docs/sell/account/resources/methods#h2-custom_policy ">custom_policy</a> resource (in the <strong>Sell Account API</strong>) to create and manage custom policies.
items:
type: string
returnPolicyId:
type: string
description: This unique identifier indicates the return business policy that will be used once an offer is published and converted to an eBay listing. This return business policy will set all return policy settings for the eBay listing.<br/><br/>Business policies are not immediately required for offers, but are required before an offer can be published. The seller should review the return business policy before assigning it to the offer to make sure it is compatible with the inventory item and the offer settings.<br/><br/>Business policies can be created and managed in My eBay or with the <strong>Account API</strong>. To get a list of all return policies associated with a seller's account on a specific eBay Marketplace, use the Account API's <strong>getReturnPolicies</strong> call. There are also calls in the <strong>Account API</strong> to retrieve a return policy by policy ID or policy name.<br/><br/>This field will be returned in the <strong>getOffer</strong> and <strong>getOffers</strong> calls if set for the offer.
shippingCostOverrides:
type: array
description: This container is used if the seller wishes to override the shipping costs or surcharge for one or more domestic or international shipping service options defined in the fulfillment listing policy. To override the costs of a specific domestic or international shipping service option, the seller must know the priority/order of that shipping service in the fulfillment listing policy. The name of a shipping service option can be found in the <strong>shippingOptions.shippingServices.shippingServiceCode</strong> field of the fulfillment policy, and the priority/order of that shipping service option is found in the <strong>shippingOptions.shippingServices.sortOrderId</strong> field. Both of these values can be retrieved by searching for that fulfillment policy with the <strong>getFulfillmentPolicies</strong> or <strong>getFulfillmentPolicyByName</strong> calls of the <strong>Account API</strong>. The <strong>shippingCostOverrides.priority</strong> value should match the <strong>shippingOptions.shippingServices.sortOrderId</strong> in order to override the shipping costs for that shipping service option. The seller must also ensure that the <strong>shippingServiceType</strong> value is set to <code>DOMESTIC</code> to override a domestic shipping service option, or to <code>INTERNATIONAL</code> to override an international shipping service option.<br/><br/>A separate <strong>ShippingCostOverrides</strong> node is needed for each shipping service option whose costs are being overridden. All defined fields of the <strong>shippingCostOverrides</strong> container should be included, even if the shipping costs and surcharge values are not changing.<br/><br/>The <strong>shippingCostOverrides</strong> container is returned in the <strong>getOffer</strong> and <strong>getOffers</strong> calls if one or more shipping cost overrides are being applied to the fulfillment policy.
items:
$ref: '#/components/schemas/ShippingCostOverride'
takeBackPolicyId:
type: string
description: This field specifies the ID of the seller created take-back policy. The law in some countries may require sellers to take back a used product when the buyer buys a new product. See <a href="https://www.ebay.com/help/selling/custom-policies/custom-policies?id=5311" target="_blank">Custom Policies</a> for more information. One take-back policy ID can be specified for each listing. Refer to the <a href="/api-docs/sell/account/resources/methods#h2-custom_policy ">custom_policy</a> resource (in the <strong>Sell Account API</strong>) to create and manage takeback policies.
description: This type is used to identify business policies including payment, return, and fulfillment policies, and also to identify custom policies. These policies are, or will be, associated with the listing. Every published offer must have a payment, return, and fulfillment business policy associated with it. This type is also used to override the shipping costs of one or more shipping service options that are associated with the fulfillment policy, to enable eBay Plus eligibility for a listing, or to enable the Best Offer feature on the listing.
Location:
type: object
properties:
address:
description: The <strong>address</strong> container is always returned in <strong>getInventoryLocation</strong>/<strong>getInventoryLocations</strong> calls. Except in the case of an inventory location that supports In-Store Pickup inventory, a full address is not a requirement when setting up an inventory location.
$ref: '#/components/schemas/Address'
geoCoordinates:
description: This container displays the Global Positioning System (GPS) latitude and longitude coordinates for the inventory location. This container is only returned if the geo-coordinates are set for an inventory location.
$ref: '#/components/schemas/GeoCoordinates'
locationId:
type: string
description: A unique eBay-assigned ID for the location. <br/><br/> <span class="tablenote"> <strong>Note:</strong> This field should not be confused with the seller-defined <b>merchantLocationKey</b> value. It is the <b>merchantLocationKey</b> value which is used to identify an inventory location when working with inventory location API calls. The <strong>locationId</strong> value is only used internally by eBay.</span>
description: A complex type that is used to provide the physical address of a location, and it geo-coordinates.
LocationDetails:
type: object
properties:
address:
description: The <b>address</b> container is required for a <b>createInventoryLocation</b> call. Except in the case of an inventory location that supports In-Store Pickup inventory, a full address is not a requirement when setting up an inventory location.
$ref: '#/components/schemas/Address'
geoCoordinates:
description: This container is used to set the Global Positioning System (GPS) latitude and longitude coordinates for the inventory location.
$ref: '#/components/schemas/GeoCoordinates'
description: This type is used by the <b>createInventoryLocation</b> call to provide an full or partial address of an inventory location.
LocationResponse:
type: object
properties:
href:
type: string
description: The URI of the current page of results from the result set.
limit:
type: integer
description: The number of items returned on a single page from the result set.
format: int32
next:
type: string
description: 'The URI for the following page of results. This value is returned only if there is an additional page of results to display from the result set. <br/><br/><b>Max length</b>: 2048'
offset:
type: integer
description: 'The number of results skipped in the result set before listing the first returned result. This value is set in the request with the <b>offset</b> query parameter. <p class="tablenote"><strong>Note: </strong>The items in a paginated result set use a zero-based list where the first item in the list has an offset of <code>0</code>.</p>'
format: int32
prev:
type: string
description: 'The URI for the preceding page of results. This value is returned only if there is a previous page of results to display from the result set. <br/><br/><b>Max length</b>: 2048'
total:
type: integer
description: The total number of items retrieved in the result set. <br/><br/>If no items are found, this field is returned with a value of <code>0</code>.
format: int32
locations:
type: array
description: An array of one or more of the merchant's inventory locations.
items:
$ref: '#/components/schemas/InventoryLocationResponse'
description: This type is used by the base response payload for the <strong>getInventoryLocations</strong> call.
MigrateListing:
type: object
properties:
listingId:
type: string
description: The unique identifier of the eBay listing to migrate to the new Inventory model. In the Trading API, this field is known as the <strong>ItemID</strong>. Up to five unique eBay listings may be specified here in separate <strong>listingId</strong> fields. The seller should make sure that each of these listings meet the requirements that are stated at the top of this Call Reference page.
description: This type is used to specify one to five eBay listings that will be migrated to the new Inventory model.
MigrateListingResponse:
type: object
properties:
errors:
type: array
description: If one or more errors occur with the attempt to migrate the listing, this container will be returned with detailed information on each error.
items:
$ref: '#/components/schemas/Error'
inventoryItemGroupKey:
type: string
description: This field will only be returned for a multiple-variation listing that the seller attempted to migrate. Its value is auto-generated by eBay. For a multiple-variation listing that is successfully migrated to the new Inventory model, eBay automatically creates an inventory item group object for the listing, and the seller will be able to retrieve and manage that new inventory item group object by using the value in this field.
inventoryItems:
type: array
description: This container exists of an array of SKU values and offer IDs. For single-variation listings, this will only be one SKU value and one offer ID (if listing was successfully migrated), but multiple SKU values and offer IDs will be returned for multiple-variation listings.
items:
$ref: '#/components/schemas/InventoryItemListing'
listingId:
type: string
description: The unique identifier of the eBay listing that the seller attempted to migrate.
marketplaceId:
type: string
description: This is the unique identifier of the eBay Marketplace where the listing resides. The value fo the eBay US site will be <code>EBAY_US</code>. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/inventory/types/slr:MarketplaceEnum'>eBay API documentation</a>
statusCode:
type: integer
description: This field is returned for each listing that the seller attempted to migrate. See the <strong>HTTP status codes</strong> table to see which each status code indicates.
format: int32
warnings:
type: array
description: If one or more warnings occur with the attempt to migrate the listing, this container will be returned with detailed information on each warning. It is possible that a listing can be successfully migrated even if a warning occurs.
items:
$ref: '#/components/schemas/Error'
description: This type is used to display the results of each listing that the seller attempted to migrate.
NameValueList:
type: object
properties:
name:
type: string
description: This string value identifies the motor vehicle aspect, such as 'make', 'model', 'year', 'trim', and 'engine'. Typically, the make, model, and year of the motor vehicle are always required, with the trim and engine being necessary sometimes, but it will be dependent on the part or accessory, and on the vehicle class.
value:
type: string
description: This string value identifies the motor vehicle aspect specified in the corresponding <strong>name</strong> field. For example, if the <strong>name</strong> field is 'make', this field may be 'Toyota', or if the <strong>name</strong> field is 'model', this field may be 'Camry'.
description: This type is used by the <strong>compatibilityProperties</strong> container to identify a motor vehicle using name/value pairs.
OfferKeyWithId:
type: object
properties:
offerId:
type: string
description: The unique identifier of an unpublished offer for which expected listing fees will be retrieved. One to 250 <strong>offerId</strong> values can be passed in to the <strong>offers</strong> container for one <strong>getListingFees</strong> call. Errors will occur if <strong>offerId</strong> values representing published offers are passed in.
description: This type is used by the <strong>getListingFees</strong> call to indicate the unpublished offer(s) for which expected listing fees will be retrieved. The user passes in one or more <strong>offerId</strong> values (a maximum of 250). See the <a href="https://pages.ebay.com/help/sell/fees.html" target="_blank">Standard selling fees</a> help page for more information on listing fees.
OfferKeysWithId:
type: object
properties:
offers:
type: array
description: This container is used to identify one or more (up to 250)unpublished offers for which expected listing fees will be retrieved. The user passes one or more <strong>offerId</strong> values (maximum of 250) in to this container to identify the unpublished offers in which to retrieve expected listing fees. This call is only applicable for offers in the unpublished state. <br/><br/> The call response gives aggregate fee amounts per eBay marketplace, and does not give fee information at the individual offer level.
items:
$ref: '#/components/schemas/OfferKeyWithId'
description: This type is used by the base request payload of the <strong>getListingFees</strong> call.
OfferPriceQuantity:
type: object
properties:
availableQuantity:
type: integer
description: This field is used if the seller wants to modify the current quantity of the inventory item that will be available for purchase in the offer (identified by the corresponding <strong>offerId</strong> value). Either the <strong>availableQuantity</strong> field or the <strong>price</strong> container is required, but not necessarily both.
format: int32
offerId:
type: string
description: This field is the unique identifier of the offer. If an <strong>offers</strong> container is used to update one or more offers associated to a specific inventory item, the <strong>offerId</strong> value is required in order to identify the offer to update with a modified price and/or quantity.<br/><br/>The seller can run a <strong>getOffers</strong> call (passing in the correct SKU value as a query parameter) to retrieve <strong>offerId</strong> values for offers associated with the SKU.
price:
description: This container is used if the seller wants to modify the current price of the inventory item. The dollar value set here will be the new price of the inventory item in the offer (identified by the corresponding <strong>offerId</strong> value). Either the <strong>availableQuantity</strong> field or the <strong>price</strong> container is required, but not necessarily both.
$ref: '#/components/schemas/Amount'
description: This type is used by the <strong>offers</strong> container in a <strong>Bulk Update Price and Quantity</strong> call to update the current price and/or quantity of one or more offers associated with a specific inventory item.
OfferResponse:
type: object
properties:
offerId:
type: string
description: The unique identifier of the offer that was just created with a <strong>createOffer</strong> call. It is not returned if the <strong>createOffer</strong> call fails to create an offer. This identifier will be needed for many offer-related calls. <p> <span class="tablenote"><strong>Note:</strong> The <strong>offerId</strong> value is only returned with a successful <strong>createOffer</strong> call. This field will not be returned in the <strong>updateOffer </strong> response.</span></p>
warnings:
type: array
description: This container will contain an array of errors and/or warnings when a call is made, and errors and/or warnings occur.
items:
$ref: '#/components/schemas/Error'
description: This type is used by the response payload of the <strong>createOffer</strong> and <strong>updateOffer</strong> calls. The <strong>offerId</strong> field contains the unique identifier for the offer if the offer is successfully created by the <strong>createOffer</strong> call. The <strong>warnings</strong> field contains any errors and/or warnings that may have been triggered by the call. <p> <span class="tablenote"><strong>Note:</strong> The <strong>offerId</strong> value is only returned with a successful <strong>createOffer</strong> call. This field will not be returned in the <strong>updateOffer </strong> response.</span></p>
OfferResponseWithListingId:
type: object
properties:
errors:
type: array
description: This container will be returned if there were one or more errors associated with publishing the offer.
items:
$ref: '#/components/schemas/Error'
listingId:
type: string
description: The unique identifier of the newly-created eBay listing. This field is only returned if the seller successfully published the offer and created the new eBay listing.
offerId:
type: string
description: The unique identifier of the offer that the seller published (or attempted to publish).
statusCode:
type: integer
description: The HTTP status code returned in this field indicates the success or failure of publishing the offer specified in the <strong>offerId</strong> field. See the <strong>HTTP status codes</strong> table to see which each status code indicates.
format: int32
warnings:
type: array
description: This container will be returned if there were one or more warnings associated with publishing the offer.
items:
$ref: '#/components/schemas/Error'
description: This type is used to indicate the status of each offer that the user attempted to publish. If an offer is successfully published, an eBay listing ID (also known as an Item ID) is returned. If there is an issue publishing the offer and creating the new eBay listing, the information about why the listing failed should be returned in the <strong>errors</strong> and/or <strong>warnings</strong> containers.
OfferSkuResponse:
type: object
properties:
errors:
type: array
description: This container will be returned at the offer level, and will contain one or more errors if any occurred with the attempted creation of the corresponding offer.
items:
$ref: '#/components/schemas/Error'
format:
type: string
description: This enumeration value indicates the listing format of the offer. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/inventory/types/slr:FormatTypeEnum'>eBay API documentation</a>
marketplaceId:
type: string
description: This enumeration value is the unique identifier of the eBay marketplace for which the offer will be made available. This enumeration value should be the same for all offers since the <strong>bulkCreateOffer</strong> method can only be used to create offers for one eBay marketplace at a time. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/inventory/types/slr:MarketplaceEnum'>eBay API documentation</a>
offerId:
type: string
description: The unique identifier of the newly-created offer. This identifier should be automatically created by eBay if the creation of the offer was successful. It is not returned if the creation of the offer was not successful. In which case, the user may want to scan the corresponding <strong>errors</strong> and/or <strong>warnings</strong> container to see what the issue may be.
sku:
type: string
description: The seller-defined Stock-Keeping Unit (SKU) of the inventory item. The <strong>sku</strong> value is required for each product offer that the seller is trying to create, and it is always returned to identified the product that is associated with the offer.
statusCode:
type: integer
description: The integer value returned in this field is the http status code. If an offer is created successfully, the value returned in this field should be <code>200</code>. A user can view the <strong>HTTP status codes</strong> section for information on other status codes that may be returned with the <strong>bulkCreateOffer</strong> method.
format: int32
warnings:
type: array
description: This container will be returned at the offer level, and will contain one or more warnings if any occurred with the attempted creation of the corresponding offer. Note that it is possible that an offer can be created successfully even if one or more warnings are triggered.
items:
$ref: '#/components/schemas/Error'
description: This type is used by the <strong>bulkCreateOffer</strong> response to show the status of each offer that the seller attempted to create with the <strong>bulkCreateOffer</strong> method. For each offer that is created successfully, the returned <strong>statusCode</strong> value should be <code>200</code>, and a unique <strong>offerId</strong> should be created for each offer. If any issues occur with the creation of any offers, <strong>errors</strong> and/or <strong>warnings</strong> containers will be returned.
Offers:
type: object
properties:
href:
type: string
description: This is the URL to the current page of offers.
limit:
type: integer
description: This integer value is the number of offers that will be displayed on each results page.
format: int32
next:
type: string
description: This is the URL to the next page of offers. This field will only be returned if there are additional offers to view.
offers:
type: array
description: This container is an array of one or more of the seller's offers for the SKU value that is passed in through the required <strong>sku</strong> query parameter.<br/><br/> <span class="tablenote"> <strong>Note:</strong> Currently, the Inventory API does not support the same SKU across multiple eBay marketplaces, so the <strong>getOffers</strong> call will only return one offer.</span><br/><br/><strong>Max Occurs:</strong> 25
items:
$ref: '#/components/schemas/EbayOfferDetailsWithAll'
prev:
type: string
description: This is the URL to the previous page of offers. This field will only be returned if there are previous offers to view.
size:
type: integer
description: This integer value indicates the number of offers being displayed on the current page of results. This number will generally be the same as the <strong>limit</strong> value if there are additional pages of results to view.<br/><br/> <span class="tablenote"> <strong>Note:</strong> Currently, the Inventory API does not support the same SKU across multiple eBay marketplaces, so the <strong>Get Offers</strong> call will only return one offer, so this value should always be <code>1</code>.</span>
format: int32
total:
type: integer
description: This integer value is the total number of offers that exist for the specified SKU value. Based on this number and on the <strong>limit</strong> value, the seller may have to toggle through multiple pages to view all offers.<br/><br/> <span class="tablenote"> <strong>Note:</strong> Currently, the Inventory API does not support the same SKU across multiple eBay marketplaces, so the <strong>Get Offers</strong> call will only return one offer, so this value should always be <code>1</code>.</span>
format: int32
description: This type is used by the base response of the <strong>getOffers</strong> call, and it is an array of one or more of the seller's offers, along with pagination data.
OperatingHours:
type: object
properties:
dayOfWeekEnum:
type: string
description: A <strong>dayOfWeekEnum</strong> value is required for each day of the week that the store location has regular operating hours. <br/><br/>This field is returned if operating hours are defined for the store location. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/inventory/types/api:DayOfWeekEnum'>eBay API documentation</a>
intervals:
type: array
description: This container is used to define the opening and closing times of a store's working day (defined in the <strong>dayOfWeekEnum</strong> field). An <strong>intervals</strong> container is needed for each day of the week that the store location is open. If a store location closes for lunch (or any other period during the day) and then reopens, multiple <strong>open</strong> and <strong>close</strong> pairs are needed <br/><br/>This container is returned if operating hours are defined for the store location.
items:
$ref: '#/components/schemas/Interval'
description: This type is used to express the regular operating hours of a merchant's store during the days of the week.
PackageWeightAndSize:
type: object
properties:
dimensions:
description: This container is used to indicate the length, width, and height of the shipping package that will be used to ship the inventory item. The dimensions of a shipping package are needed when calculated shipping is used.<br/><br/>This container will be returned if package dimensions are set for the inventory item.
$ref: '#/components/schemas/Dimension'
packageType:
type: string
description: This enumeration value indicates the type of shipping package used to ship the inventory item. The supported values for this field can be found in the <a href="/api-docs/sell/inventory/types/slr:PackageTypeEnum">PackageTypeEnum</a> type.<br/><br/>This field will be returned if the package type is set for the inventory item.<br /><br /><span class="tablenote"> <strong>Note:</strong> You can use the <a href="/Devzone/XML/docs/Reference/eBay/GeteBayDetails.html#Response.ShippingPackageDetails">GeteBayDetails</a> Trading API call to retrieve a list of supported package types for a specific marketplace.</span> For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/inventory/types/slr:PackageTypeEnum'>eBay API documentation</a>
weight:
description: This container is used to specify the weight of the shipping package that will be used to ship the inventory item. The weight of a shipping package are needed when calculated shipping is used, or if flat-rate shipping rates are used, but with a weight surcharge.<br/><br/>This field will be returned if package weight is set for the inventory item.
$ref: '#/components/schemas/Weight'
description: This type is used to indicate the package type, weight, and dimensions of the shipping package. Package weight and dimensions are required when calculated shipping rates are used, and weight alone is required when flat-rate shipping is used, but with a weight surcharge. See the <a href="https://pages.ebay.com/help/pay/calculated-shipping.html" target="_blank">Calculated shipping</a> help page for more information on calculated shipping.
PickupAtLocationAvailability:
type: object
properties:
availabilityType:
type: string
description: The enumeration value in this field indicates the availability status of the inventory item at the merchant's physical store specified by the <strong>pickupAtLocationAvailability.merchantLocationKey</strong> field. This field is required if the <strong>pickupAtLocationAvailability</strong> container is used, and is always returned with the <strong>pickupAtLocationAvailability</strong> container. <br/><br/> See <a href="/api-docs/sell/inventory/types/slr:AvailabilityTypeEnum">AvailabilityTypeEnum</a> for more information about how/when you use each enumeration value. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/inventory/types/slr:AvailabilityTypeEnum'>eBay API documentation</a>
fulfillmentTime:
description: This container is used to indicate how soon an In-Store Pickup order will be available for pickup by the buyer after the order takes place. This container is required if the <strong>pickupAtLocationAvailability</strong> container is used, and is always returned with the <strong>pickupAtLocationAvailability</strong> container.
$ref: '#/components/schemas/TimeDuration'
merchantLocationKey:
type: string
description: 'The unique identifier of a merchant''s store where the In-Store Pickup inventory item is currently located, or where inventory will be sent to. If the merchant''s store is currently awaiting for inventory, the <strong>availabilityType</strong> value should be <code>SHIP_TO_STORE</code>. This field is required if the <strong>pickupAtLocationAvailability</strong> container is used, and is always returned with the <strong>pickupAtLocationAvailability</strong> container.<br/> <br/><b>Max length</b>: 36'
quantity:
type: integer
description: This integer value indicates the quantity of the inventory item that is available for In-Store Pickup at the store identified by the <strong>merchantLocationKey</strong> value. The value of <strong>quantity</strong> should be an integer value greater than <code>0</code>, unless the inventory item is out of stock. This field is required if the <strong>pickupAtLocationAvailability</strong> container is used, and is always returned with the <strong>pickupAtLocationAvailability</strong> container.
format: int32
description: This type is used to specify/indicate the quantity of the inventory item that is available for an In-Store Pickup order at the merchant's physical store (specified by the <strong>merchantLocationKey</strong> field).
PriceQuantity:
type: object
properties:
offers:
type: array
description: This container is needed if the seller is updating the price and/or quantity of one or more published offers, and a successful call will actually update the active eBay listing with the revised price and/or available quantity.<br/><br/>This call is not designed to work with unpublished offers. For unpublished offers, the seller should use the <strong>updateOffer</strong> call to update the available quantity and/or price.<br/><br/> If the seller is also using the <strong>shipToLocationAvailability</strong> container and <strong>sku</strong> field to update the total 'ship-to-home' quantity of the inventory item, the SKU value associated with the corresponding <strong>offerId</strong> value(s) must be the same as the corresponding <strong>sku</strong> value that is passed in, or an error will occur.<br/><br/>A separate (<strong>OfferPriceQuantity</strong>) node is required for each offer being updated.
items:
$ref: '#/components/schemas/OfferPriceQuantity'
shipToLocationAvailability:
description: This container is needed if the seller is updating the total 'ship-to-home' quantity for the corresponding inventory item (specified in the <strong>sku</strong> field. A successful call will update the inventory item record associated with the <strong>sku</strong> value.
$ref: '#/components/schemas/ShipToLocationAvailability'
sku:
type: string
description: 'This is the seller-defined SKU value of the inventory item whose total ''ship-to-home'' quantity will be updated. This field is only required when the seller is updating the total quantity of an inventory item using the <strong>shipToLocationAvailability</strong> container. If the seller is updating the price and/or quantity of one or more specific offers, one or more <strong>offerId</strong> values are used instead, and the <strong>sku</strong> value is not needed.<br/><br/>If the seller wants to update the price and/or quantity of one or more offers, and also wants to update the total ''ship-to-home'' quantity of the corresponding inventory item, the SKU value associated with the <strong>offerId</strong> value(s) must be the same as the corresponding <strong>sku</strong> value that is passed in, or an error will occur.<br/><br/><strong>Max Length</strong>: 50<br/>'
description: This type is used to update the total "ship-to-home" quantity for one or more inventory items and/or to update the price and/or quantity of one or more specific offers associated with one or more inventory items.
PriceQuantityResponse:
type: object
properties:
errors:
type: array
description: This array will be returned if there were one or more errors associated with the update to the offer or inventory item record.
items:
$ref: '#/components/schemas/Error'
offerId:
type: string
description: The unique identifier of the offer that was updated. This field will not be returned in situations where the seller is only updating the total 'ship-to-home' quantity of an inventory item record.
sku:
type: string
description: 'This is the seller-defined SKU value of the product. This field is returned whether the seller attempted to update an offer with the SKU value or just attempted to update the total ''ship-to-home'' quantity of an inventory item record.<br/><br/><strong>Max Length</strong>: 50<br/>'
statusCode:
type: integer
description: The value returned in this container will indicate the status of the attempt to update the price and/or quantity of the offer (specified in the corresponding <strong>offerId</strong> field) or the attempt to update the total 'ship-to-home' quantity of an inventory item (specified in the corresponding <strong>sku</strong> field). For a completely successful update of an offer or inventory item record, a value of <code>200</code> will appear in this field. A user can view the <strong>HTTP status codes</strong> section for information on other status codes that may be returned with the <strong>bulkUpdatePriceQuantity</strong> method.
format: int32
warnings:
type: array
description: This array will be returned if there were one or more warnings associated with the update to the offer or inventory item record.
items:
$ref: '#/components/schemas/Error'
description: This type is used to display the result for each offer and/or inventory item that the seller attempted to update with a <strong>bulkUpdatePriceQuantity</strong> call. If any errors or warnings occur, the error/warning data is returned at the offer/inventory item level.
PricingSummary:
type: object
properties:
auctionReservePrice:
description: This field indicates the lowest price at which the seller is willing to sell an item through an auction listing. Note that setting a Reserve Price will incur a listing fee of $5 or 7.5% of the Reserve Price, whichever is greater. The minimum fee is $5.<br /><br /><span class="tablenote"><b>Important:</b> This fee is charged regardless of whether or not the item is sold.</span>
$ref: '#/components/schemas/Amount'
auctionStartPrice:
description: This field indicates the minimum bidding price for the auction. The bidding starts at this price.<br/><br/><span class="tablenote"><b>Note:</b> If the <b>auctionReservePrice</b> is also specified, the value of <b>auctionStartPrice</b> must be lower than the value of <b>auctionReservePrice</b>.</span>
$ref: '#/components/schemas/Amount'
minimumAdvertisedPrice:
description: This container is needed if the Minimum Advertised Price (MAP) feature will be used in the offer. Minimum Advertised Price (MAP) is an agreement between suppliers (or manufacturers (OEM)) and the retailers (sellers) stipulating the lowest price an item is allowed to be advertised at. Sellers can only offer prices below this price through the use of other discounts. The MAP feature is only available to eligible US sellers. This field will be ignored if the seller and or the listing is not eligible for the MAP feature.<br/><br/>This container will be returned if set for the offer.
$ref: '#/components/schemas/Amount'
originallySoldForRetailPriceOn:
type: string
description: This field is needed if the Strikethrough Pricing (STP) feature will be used in the offer. This field indicates that the product was sold for the price in the <strong>originalRetailPrice</strong> field on an eBay site, or sold for that price by a third-party retailer. When using the <strong>createOffer</strong> or <strong>updateOffer</strong> calls, the seller will pass in a value of <code>ON_EBAY</code> to indicate that the product was sold for the <strong>originalRetailPrice</strong> on an eBay site, or the seller will pass in a value of <code>OFF_EBAY</code> to indicate that the product was sold for the <strong>originalRetailPrice</strong> through a third-party retailer. This field and the <strong>originalRetailPrice</strong> field are only applicable if the seller and listing are eligible to use the Strikethrough Pricing feature, a feature which is limited to the US (core site and Motors), UK, Germany, Canada (English and French versions), France, Italy, and Spain sites.<br/><br/>This field will be returned if set for the offer. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/inventory/types/slr:SoldOnEnum'>eBay API documentation</a>
originalRetailPrice:
description: This container is needed if the Strikethrough Pricing (STP) feature will be used in the offer. The dollar value passed into this field indicates the original retail price set by the manufacturer (OEM). eBay does not maintain or validate the value supplied here by the seller. The dollar value in this field should always be more than the dollar value in the <strong>price</strong> container. This field and the <strong>originallySoldForRetailPriceOn</strong> field are only applicable if the seller and listing are eligible to use the Strikethrough Pricing feature, a feature which is limited to the US (core site and Motors), UK, Germany, Canada (English and French versions), France, Italy, and Spain sites. Compare the <strong>originalRetailPrice</strong> and the dollar value in the <strong>price</strong> field to determine the amount of savings to the buyer. This Original Retail Price will have a strikethrough line through for a marketing affect.<br/><br/>This container will be returned if set for the offer.
$ref: '#/components/schemas/Amount'
price:
description: This is the listing price of the product. A listing price must be specified before publishing an offer, but it is possible to create an offer without a price.<br/><br/>For published offers, this container will always be returned, but for unpublished offers, this container will only be returned if set for the offer.
$ref: '#/components/schemas/Amount'
pricingVisibility:
type: string
description: This field is needed if the Minimum Advertised Price (MAP) feature will be used in the offer. This field is only applicable if an eligible US seller is using the Minimum Advertised Price (MAP) feature and a <strong>minimumAdvertisedPrice</strong> has been specified. The value set in this field will determine whether the MAP price is shown to a prospective buyer prior to checkout through a pop-up window accessed from the View Item page, or if the MAP price is not shown until the checkout flow after the buyer has already committed to buying the item. To show the MAP price prior to checkout, the seller will set this value to <code>PRE_CHECKOUT</code>. To show the MAP price after the buyer already commits to buy the item, the seller will set this value to <code>DURING_CHECKOUT</code>. This field will be ignored if the seller and/or the listing is not eligible for the MAP feature.<br/><br/>This field will be returned if set for the offer. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/inventory/types/slr:MinimumAdvertisedPriceHandlingEnum'>eBay API documentation</a>
description: This type is used to specify the listing price for the product and settings for the Minimum Advertised Price and Strikethrough Pricing features. The <strong>price</strong> field must be supplied before an offer is published, but a seller may create an offer without supplying a price initially. The Minimum Advertised Price feature is only available on the US site. Strikethrough Pricing is available on the US, eBay Motors, UK, Germany, Canada (English and French), France, Italy, and Spain sites.
Product:
type: object
properties:
aspects:
type: string
description: 'This is a collection of item specifics (aka product aspects) name-value pairs that provide more information about the product and might make it easier for buyers to find. To view required/recommended product aspects/item specifics names (and corresponding values) for a specific eBay category, sellers can use the <a href="/api-docs/commerce/taxonomy/resources/category_tree/methods/getItemAspectsForCategory" target="_blank">getItemAspectsForCategory</a> method of the Taxonomy API. Alternatively, sellers can view similar items on eBay.com in the same category to get an idea of what other sellers are using for product aspects/item specifics.<br/><br/>Sellers also have the option of specifying an eBay Product ID (ePID) or optionally, a Global Trade Item Number (GTIN) through the corresponding fields in the <strong>product</strong> container in an attempt to find a product match in the eBay Catalog. If a match is found based on the ePID or GTIN value, the product aspects that are defined for the eBay Catalog product will automatically get picked up by the newly created/updated inventory item. <br/><br/>Below is an example of the proper JSON syntax to use when manually inputting item specifics. Note that one item specific name, such as ''Features'', can have more than one value. If an item specific name has more than one value, each value is delimited with a comma.<br/><br/> <pre><code>"aspects": {<br/> "Brand": ["GoPro"],<br/> "Storage Type": ["Removable"]<br/> }</code></pre><br/>Note that inventory items that will become part of an inventory item group and multiple-variation listing should have the same attributes that are defined for the inventory item group.<br/><br/>This container will be returned if one or more item specific pairs are defined for the inventory item.<br/><br/><strong>Max Length for Aspect Name</strong>: 40<br/><br/><strong>Max Length for Aspect Value</strong>: 50'
brand:
type: string
description: 'The brand of the product. This field is often paired with the <strong>mpn</strong> field to identify a specific product by Manufacture Part Number. This field is conditionally required if the eBay category requires a Manufacturer Part Number (MPN) value. If eBay is able to find a product match in the eBay Catalog when an eBay Product ID (ePID) or GTIN value (UPC, ISBN, or EAN) is supplied, all product details of that eBay Catalog product is picked up by the inventory item record (including brand) if the <strong>createOrReplaceInventoryItem</strong> call is successful. <br/><br/>This field is returned if defined for an inventory item. If a brand was passed in as an item specific name-value pair through the <strong>aspects</strong> array in a <strong>createOrReplaceInventoryItem</strong> call, this value is also picked up by the <strong>brand</strong> field.<br/><br/><strong>Max Length</strong>: 65'
description:
type: string
description: 'The description of the product. The description of an existing inventory item can be added or modified with a <strong>createOrReplaceInventoryItem</strong> call. The description of an inventory item is automatically populated if the seller specifies an eBay Product ID (ePID) or a Global Trade Item Number (GTIN) and eBay is able to find a matching product in the eBay Catalog.<br/><br/>Note that this field is optional but recommended. If a <strong>listingDescription</strong> field is omitted when creating and publishing a single-variation offer, the text in this field will be used instead. If neither the <strong>product.description</strong> field for the inventory item nor the <strong>listingDescription</strong> field for the offer exist, the <strong>publishOffer</strong> call will fail. If the inventory item will be part of an inventory item group/multiple-variation listing, this field should definitely be used to specify how the corresponding product variation is different (e.g. <em>This is the green, extra-large version of the shirt</em>). However, in the case of an inventory item group, the text in the <strong>description</strong> field of the inventory item group will become the listing description of the actual eBay listing instead of the text in this field.<br/><br/>Basic HTML tags are supported, including the following tags:<ul><li><b></li><li><strong></li><li><br></li><li><ol></li><li><ul></li><li><li></li><li>Table tags including <table>, <tr>, <td>, <th>, <thead>, <tfoot>, <tbody>, <caption>, <colgroup>, and <col></li></ul>A seller can not use any active content in their listing description. Active content includes animation or video via JavaScript, Flash, plug-ins, or form actions.<br/><br/>This field is returned if defined for an inventory item. If one of the GTIN types (e.g. UPC) was passed in when the inventory item was created/modified and a product match was found in the eBay catalog, product description is one of the details that gets picked up from the catalog product.<br/><br/><strong>Max Length</strong>: 4000'
ean:
type: array
description: The European Article Number/International Article Number (EAN) for the product. Although an ePID value is preferred when trying to find a product match in the eBay Catalog, this field can also be used in an attempt to find a product match in the eBay Catalog. If a product match is found in the eBay Catalog, the inventory item is automatically populated with available product details such as a title, a product description, product aspects (including the specified EAN value), and a link to any stock image that exists for the catalog product.<br/><br/>This field is returned if defined for an inventory item. If an EAN was passed in as an item specific name-value pair through the <strong>aspects</strong> array in a <strong>createOrReplaceInventoryItem</strong> call, this value is also picked up by the <strong>ean</strong> field.
items:
type: string
epid:
type: string
description: The eBay Product Identifier (ePID) for the product. This field can be used to directly identify an eBay Catalog product. Based on its specified ePID value, eBay will search for the product in the eBay Catalog, and if a match is found, the inventory item is automatically populated with available product details such as product title, product description, product aspects, and a link to any stock image that exists for the catalog product.<br/><br/>In an attempt to find a eBay Catalog product match, an ePID value is always preferred over the other product identifiers, since it is possible that one GTIN value can be associated with multiple eBay Catalog products, and if multiple products are found, product details will not be picked up by the Inventory Item object.<br/><br/>This field is returned if defined for an inventory item.
imageUrls:
type: array
description: An array of one or more links to images for the product. URLs must use the "HTTPS" protocol. Images can be self-hosted by the seller, or sellers can use the <a href="https://developer.ebay.com/Devzone/XML/docs/Reference/eBay/UploadSiteHostedPictures.html " target="_blank">UploadSiteHostedPictures</a> call of the Trading API to upload images to an eBay Picture Server. If successful, the response of the <a href="https://developer.ebay.com/Devzone/XML/docs/Reference/eBay/UploadSiteHostedPictures.html " target="_blank">UploadSiteHostedPictures</a> call will contain a full URL to the image on an eBay Picture Server. This is the URL that will be passed in through the <strong>imageUrls</strong> array. Before an offer can be published, at least one image must exist for the inventory item. In almost any category at no cost, sellers can include up to 24 pictures in one listing. For inventory items that are a part of an inventory item group/multiple-variation listings, a maximum of 12 pictures may be used per inventory item in the group. Motor vehicle listings are an exception. The number of included pictures in motor vehicle listings depend on the selected vehicle package (see <a href="https://www.ebay.com/help/selling/fees-credits-invoices/motors-fees?id=4127 ">Fees for selling vehicles on eBay Motors</a>).<br/><br/>A link to a stock image for a product may automatically be populated for an inventory item if the seller specifies an eBay Product ID (ePID) or a Global Trade Item Number (GTIN) and eBay is able to find a matching product in the eBay Catalog.<br/><br/>This container will always be returned for an inventory item that is part of a published offer since a published offer will always have at least one picture, but this container will only be returned if defined for inventory items that are not a part of a published offer.
items:
type: string
isbn:
type: array
description: The International Standard Book Number (ISBN) value for the product. Although an ePID value is preferred when trying to find a product match in the eBay Catalog, this field can also be used in an attempt to find a product match in the eBay Catalog. If a product match is found in the eBay Catalog, the inventory item is automatically populated with available product details such as a title, a product description, product aspects (including the specified ISBN value), and a link to any stock image that exists for the catalog product.<br/><br/>This field is returned if defined for an inventory item. If an ISBN was passed in as an item specific name-value pair through the <strong>aspects</strong> array in a <strong>createOrReplaceInventoryItem</strong> call, this value is also picked up by the <strong>isbn</strong> field.
items:
type: string
mpn:
type: string
description: 'The Manufacturer Part Number (MPN) of a product. This field is paired with the <strong>brand</strong> field to identify a product. Some eBay categories require MPN values. The <a href="/api-docs/commerce/taxonomy/resources/category_tree/methods/getItemAspectsForCategory">getItemAspectsForCategory</a> method in the Taxonomy API can be used to see if a category requires an MPN. The MPN value for a product may automatically be populated for an inventory item if the seller specifies an eBay Product ID (ePID) or a Global Trade Item Number (GTIN) and eBay is able to find a matching product in the eBay Catalog. <br/><br/>This field is returned if defined for an inventory item. If an MPN was passed in as an item specific name-value pair through the <strong>aspects</strong> array in a <strong>createOrReplaceInventoryItem</strong> call, this value is also picked up by the <strong>mpn</strong> field.<br/><br/><strong>Max Length</strong>: 65'
subtitle:
type: string
description: 'A subtitle is an optional listing feature that allows the seller to provide more information about the product, possibly including keywords that may assist with search results. An additional listing fee will be charged to the seller if a subtitle is used. For more information on using listing subtitles on the US site, see the <a href="https://pages.ebay.com/help/sell/itemsubtitle.html" target="_blank">Adding a subtitle to your listings</a> help page. The subtitle of an existing inventory item can added, modified, or removed with a <strong>createOrReplaceInventoryItem</strong> call.<br/><br/>Note that the same <strong>subtitle</strong> text should be used for each inventory item that will be part of an inventory item group, and ultimately become one product variation within a multiple-variation listing.<br/><br/>This field will only be returned if set for an inventory item.<br/><br/><strong>Max Length</strong>: 55'
title:
type: string
description: 'The title of an inventory item can be added or modified with a <strong>createOrReplaceInventoryItem</strong> call. Although not immediately required, a title will be needed before an offer with the inventory item is published. The title of an inventory item is automatically populated if the seller specifies an eBay Product ID (ePID) or a Global Trade Item Number (GTIN) and eBay is able to find a matching product in the eBay Catalog. If the inventory item will become part of a single-variation offer, and the listing is not a product-based listing, the text in this field will become the actual listing title for the published offer. However, if the inventory item will become part of a multiple-variation offer, the text in <strong>title</strong> field of the inventory item group entity will actually become the listing title for the published offer instead, although a title can still be provided for the inventory item, and it will actually become the title of the variation.<br/><br/>This field will always be returned for an inventory item that is part of a published offer since a published offer will always have a listing title, but this field will only be returned if defined for inventory items that are not a part of a published offer.<br/><br/><strong>Max Length</strong>: 80'
upc:
type: array
description: The Universal Product Code (UPC) value for the product. Although an ePID value is preferred when trying to find a product match in the eBay Catalog, this field can also be used in an attempt to find a product match in the eBay Catalog. If a product match is found in the eBay Catalog, the inventory item is automatically populated with available product details such as a title, a product description, product aspects (including the specified UPC value), and a link to any stock image that exists for the catalog product.<br/><br/>This field is returned if defined for an inventory item. If a UPC was passed in as an item specific name-value pair through the <strong>aspects</strong> array in a <strong>createOrReplaceInventoryItem</strong> call, this value is also picked up by the <strong>upc</strong> field.
items:
type: string
videoIds:
type: array
description: An array of one or more VideoId values for the product. A VideoId is a unique identifier that is automatically created by eBay when a seller successfully uploads a video to eBay using the <a href="https://developer.ebay.com/api-docs/commerce/media/resources/video/methods/uploadVideo" target="_blank">uploadVideo</a> method of the <a href="https://developer.ebay.com/api-docs/commerce/media/overview.html" target="_blank">Media API</a>.<br /><br />For information on supported marketplaces and platforms, as well as other requirements and limitations of video support, please refer to <a href="https://developer.ebay.com/api-docs/sell/static/inventory/managing-video-media.html" target="_blank">Managing videos</a>.
items:
type: string
description: This type is used to define the product details, such as a title, a product description, product aspects/item specifics, and links to images for the product. Optionally, in a <strong>createOrReplaceInventoryItem</strong> call, a seller can pass in an eBay Product Identifier (ePID) or a Global Trade Item Number (GTIN) value, such as an EAN, an ISBN, a UPC, to identify a product to be matched with a product in the eBay Catalog. The information in this type is also returned in the <strong>getInventoryItem</strong>, <strong>getInventoryItems</strong>, and <strong>bulkGetInventoryItem</strong> calls if defined.
ProductFamilyProperties:
type: object
properties:
engine:
type: string
description: This field indicates the specifications of the engine, including its size, block type, and fuel type. An example is <code>2.7L V6 gas DOHC naturally aspirated</code>. This field is conditionally required, but should be supplied if known/applicable.
make:
type: string
description: This field indicates the make of the vehicle (e.g. <code>Toyota</code>). This field is always required to identify a motor vehicle.
model:
type: string
description: This field indicates the model of the vehicle (e.g. <code>Camry</code>). This field is always required to identify a motor vehicle.
trim:
type: string
description: This field indicates the trim of the vehicle (e.g. <code>2-door Coupe</code>). This field is conditionally required, but should be supplied if known/applicable.
year:
type: string
description: This field indicates the year of the vehicle (e.g. <code>2016</code>). This field is always required to identify a motor vehicle.
description: This type is used to specify the details of a motor vehicle that is compatible with the inventory item specified through the SKU value in the call URI.
ProductIdentifier:
type: object
properties:
epid:
type: string
description: This field can be used if the seller already knows the eBay catalog product ID (ePID) associated with the motor vehicle that is to be added to the compatible product list. If this eBay catalog product ID is found in the eBay product catalog, the motor vehicle properties (e.g. make, model, year, engine, and trim) will automatically get picked up for that motor vehicle.
gtin:
type: string
description: This field can be used if the seller knows the Global Trade Item Number for the motor vehicle that is to be added to the compatible product list. If this GTIN value is found in the eBay product catalog, the motor vehicle properties (e.g. make, model, year, engine, and trim will automatically get picked up for that motor vehicle.<br/><br/><span class="tablenote"> <strong>Note:</strong> This field is for future use.</span>
ktype:
type: string
description: This field can be used if the seller knows the K Type Number for the motor vehicle that is to be added to the compatible product list. If this K Type value is found in the eBay product catalog, the motor vehicle properties (e.g. make, model, year, engine, and trim) will automatically get picked up for that motor vehicle. <br/><br/>Only the AU, DE, ES, FR, IT, and UK marketplaces support the use of K Type Numbers.
description: This type is used to identify a motor vehicle that is compatible with the corresponding inventory item (the SKU that is passed in as part of the call URI). The motor vehicle can be identified through an eBay Product ID or a K-Type value. The <strong>gtin</strong> field (for inputting Global Trade Item Numbers) is for future use only. If a motor vehicle is found in the eBay product catalog, the motor vehicle properties (engine, make, model, trim, and year) will automatically get picked up for that motor vehicle.<br/><br/><span class="tablenote"> <strong>Note:</strong> Currently, parts compatibility is only applicable for motor vehicles, but it is possible that the Product Compatibility feature is expanded to other (non-vehicle) products in the future.</span>
PublishByInventoryItemGroupRequest:
type: object
properties:
inventoryItemGroupKey:
type: string
description: This is the unique identifier of the inventory item group. All unpublished offers associated with this inventory item group will be published as a multiple-variation listing if the <strong>publishByInventoryItemGroup</strong> call is successful. The <strong>inventoryItemGroupKey</strong> identifier is automatically generated by eBay once an inventory item group is created.<br/><br/>To retrieve an <strong>inventoryItemGroupKey</strong> value, you can use the <strong>getInventoryItem</strong> call to retrieve an inventory item that is known to be in the inventory item group to publish, and then look for the inventory item group identifier under the <strong>groupIds</strong> container in the response of that call.
marketplaceId:
type: string
description: This is the unique identifier of the eBay site on which the multiple-variation listing will be published. The <strong>marketPlaceId</strong> enumeration values are found in <strong>MarketplaceIdEnum</strong>. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/inventory/types/slr:MarketplaceEnum'>eBay API documentation</a>
description: This type is used by the request payload of the <strong>publishByInventoryItemGroup</strong> call. The identifier of the inventory item group to publish and the eBay marketplace where the listing will be published is needed in the request payload.
PublishResponse:
type: object
properties:
listingId:
type: string
description: The unique identifier of the newly created eBay listing. This field is returned if the single offer (if <strong>publishOffer</strong> call was used) or group of offers in an inventory item group (if <strong>publishOfferByInventoryItemGroup</strong> call was used) was successfully converted into an eBay listing.
warnings:
type: array
description: This container will contain an array of errors and/or warnings if any occur when a <strong>publishOffer</strong> or <strong>publishOfferByInventoryItemGroup</strong> call is made.
items:
$ref: '#/components/schemas/Error'
description: This type is used by the base response payload of the <strong>publishOffer</strong> and <strong>publishOfferByInventoryItemGroup</strong> calls.
ShipToLocationAvailability:
type: object
properties:
availabilityDistributions:
type: array
description: This container is used to set the available quantity of the inventory item at one or more warehouse locations.<br><br> This container will be returned if available quantity is set for one or more inventory locations.
items:
$ref: '#/components/schemas/AvailabilityDistribution'
quantity:
type: integer
description: This container is used to set the total 'ship-to-home' quantity of the inventory item that will be available for purchase through one or more published offers. This container is not immediately required, but 'ship-to-home' quantity must be set before an offer of the inventory item can be published.<br/><br/>If an existing inventory item is being updated, and the 'ship-to-home' quantity already exists for the inventory item record, this container should be included again, even if the value is not changing, or the available quantity data will be lost.
format: int32
description: This type is used to specify the total 'ship-to-home' quantity of the inventory item that will be available for purchase through one or more published offers.
ShipToLocationAvailabilityWithAll:
type: object
properties:
allocationByFormat:
description: This container is used to specify the quantity of the inventory item that is available for purchase, allocated by the offer types.
$ref: '#/components/schemas/FormatAllocation'
availabilityDistributions:
type: array
description: This container is used to set the available quantity of the inventory item at one or more warehouse locations.<br /><br /> This container will be returned if the available quantity is set for one or more inventory locations.
items:
$ref: '#/components/schemas/AvailabilityDistribution'
quantity:
type: integer
description: This container is used to set the total 'ship-to-home' quantity of the inventory item that will be available for purchase through one or more published offers. This container is not immediately required, but 'ship-to-home' quantity must be set before an offer of the inventory item can be published.<br/><br/>If an existing inventory item is being updated, and the 'ship-to-home' quantity already exists for the inventory item record, this container should be included again, even if the value is not changing, or the available quantity data will be lost.
format: int32
description: This type is used to specify the total 'ship-to-home' quantity of the inventory items that will be available for purchase through one or more published offers.
ShippingCostOverride:
type: object
properties:
additionalShippingCost:
description: The dollar value passed into this field will override the additional shipping cost that is currently set for the applicable shipping service option. The "Additional shipping cost" is the cost to ship each additional identical product to the buyer using the corresponding shipping service. The shipping service option in the fulfillment policy to override is controlled by the <strong>shippingServiceType</strong> and <strong>priority</strong> values.<br><br>If using an <strong>updateOffer</strong> call, and this field is defined for the offer being updated, this field must be supplied again, even if its value is not changing.<br><br>This field is returned in the <strong>getOffer</strong> and <strong>getOffers</strong> calls if defined.
$ref: '#/components/schemas/Amount'
priority:
type: integer
description: The integer value input into this field, along with the <strong>shippingServiceType</strong> value, sets which domestic or international shipping service option in the fulfillment policy will be modified with updated shipping costs. Specifically, the <strong>shippingCostOverrides.shippingServiceType</strong> value in a <strong>createOffer</strong> or <strong>updateOffer</strong> call must match the <strong>shippingOptions.optionType</strong> value in a fulfillment listing policy, and the <strong>shippingCostOverrides.priority</strong> value in a <strong>createOffer</strong> or <strong>updateOffer</strong> call must match the <strong>shippingOptions.shippingServices.sortOrderId</strong> value in a fulfillment listing policy.<br><br>This field is always required when overriding the shipping costs of a shipping service option, and will be always be returned for each shipping service option whose costs are being overridden.
format: int32
shippingCost:
description: The dollar value passed into this field will override the shipping cost that is currently set for the applicable shipping service option. This value will be the cost to ship one item to the buyer using the corresponding shipping service. The shipping service option in the fulfillment policy to override is controlled by the <strong>shippingServiceType</strong> and <strong>priority</strong> values.<br><br>If using an <strong>updateOffer</strong> call, and this field is defined for the offer being updated, this field must be supplied again, even if its value is not changing.<br><br>This field is returned in the <strong>getOffer</strong> and <strong>getOffers</strong> calls if defined.
$ref: '#/components/schemas/Amount'
shippingServiceType:
type: string
description: This enumerated value indicates whether the shipping service specified in the <strong>priority</strong> field is a domestic or an international shipping service option. To override the shipping costs for a specific domestic shipping service in the fulfillment listing policy, this field should be set to <code>DOMESTIC</code>, and to override the shipping costs for each international shipping service, this field should be set to <code>INTERNATIONAL</code>. This value, along with <strong>priority</strong> value, sets which domestic or international shipping service option in the fulfillment policy that will be modified with updated shipping costs. Specifically, the <strong>shippingCostOverrides.shippingServiceType</strong> value in a <strong>createOffer</strong> or <strong>updateOffer</strong> call must match the <strong>shippingOptions.optionType</strong> value in a fulfillment listing policy, and the <strong>shippingCostOverrides.priority</strong> value in a <strong>createOffer</strong> or <strong>updateOffer</strong> call must match the <strong>shippingOptions.shippingServices.sortOrderId</strong> value in a fulfillment listing policy.<br><br>This field is always required when overriding the shipping costs of a shipping service option, and will be always be returned for each shipping service option whose costs are being overridden. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/inventory/types/slr:ShippingServiceTypeEnum'>eBay API documentation</a>
surcharge:
description: <span class="tablenote"> <strong>Note:</strong> DO NOT USE THIS FIELD. Shipping surcharges for shipping service options can no longer be set with fulfillment business policies. To set a shipping surcharge for a shipping service option, only the <b>Shipping rate tables</b> tool in My eBay can be used. </span><br/><br/>The dollar value passed into this field will override the shipping surcharge that is currently set for the applicable shipping service option. The shipping service option in the fulfillment policy to override is controlled by the <strong>shippingServiceType</strong> and <strong>priority</strong> values.<br><br>If using an <strong>updateOffer</strong> call, and this field is defined for the offer being updated, this field must be supplied again, even if its value is not changing.<br><br>This field is returned in the <strong>getOffer</strong> and <strong>getOffers</strong> calls if defined.
$ref: '#/components/schemas/Amount'
description: This type is used if the seller wants to override the shipping costs or surcharge associated with a specific domestic or international shipping service option defined in the fulfillment listing policy that is being applied toward the offer. The shipping-related costs that can be overridden include the shipping cost to ship one item, the shipping cost to ship each additional item (if multiple quantity are purchased), and the shipping surcharge applied to the shipping service option.
SpecialHours:
type: object
properties:
date:
type: string
description: A <strong>date</strong> value is required for each specific date that the store location has special operating hours. <br/><br/>The timestamp is formatted as an <a href="https://www.iso.org/iso-8601-date-and-time-format.html " title="https://www.iso.org " target="_blank">ISO 8601</a> string, which is based on the 24-hour Coordinated Universal Time (UTC) clock. <br/><br/><b>Format:</b> <code>[YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z</code> <br/><b>Example:</b> <code>2018-08-04T07:09:00.000Z</code> <br/><br/>This field is returned if set for the store location.
intervals:
type: array
description: This container is used to define the opening and closing times of a store on a specific date (defined in the <strong>date</strong> field). An <strong>intervals</strong> container is needed for each specific date that the store has special operating hours. These special operating hours on the specific date override the normal operating hours for the specific day of the week. If a store location closes for lunch (or any other period during the day) and then reopens, multiple <strong>open</strong> and <strong>close</strong> pairs are needed. <br/><br/>This container is returned if set for the store location.
items:
$ref: '#/components/schemas/Interval'
description: This type is used to express the special operating hours of a store location on a specific date. A <strong>specialHours</strong> container is needed when the store's opening hours on a specific date are different than the normal operating hours on that particular day of the week.
Specification:
type: object
properties:
name:
type: string
description: 'This is the name of product variation aspect. Typically, for clothing, typical aspect names are <code>"Size"</code> and <code>"Color"</code>. Product variation aspects are not required immediately upon creating an inventory item group, but these aspects will be required before a multiple-variation listing containing this inventory item group is published. For each product variation aspect that is specified through the <strong>specifications</strong> container, one <strong>name</strong> value is required and two or more variations of this aspect are required through the <strong>values</strong> array.<br/><br/> <span class="tablenote"> <strong>Note:</strong> Each member of the inventory item group should have these same aspect names specified through the <strong>product.aspects</strong> container when the inventory item is created with the <strong>createOrReplaceInventoryItem</strong> or <strong>bulkCreateOrReplaceInventoryItem</strong> call. </span><br/><strong>Max Length</strong>: 40'
values:
type: array
description: 'This is an array of values pertaining to the corresponding product variation aspect (specified in the <strong>name</strong> field). Below is a sample of how these values will appear under a <strong>specifications</strong> container: <br/> <pre><code>"specifications": [{<br/> "name": "Size",<br/> "values": ["Small",<br/> "Medium",<br/> "Large"]<br/> },<br/> { <br/> "name": "Color",<br/> "values": ["Blue",<br/> "White",<br/> "Red"] <br/> }] </pre></code><span class="tablenote"> <strong>Note:</strong> Each member of the inventory item group should have these same aspect names, and each individual inventory item should have each variation of the product aspect values specified through the <strong>product.aspects</strong> container when the inventory item is created with the <strong>createOrReplaceInventoryItem</strong> or <strong>bulkCreateOrReplaceInventoryItem</strong> call. </span><br/><strong>Max Length</strong>: 50'
items:
type: string
description: This type is used to specify product aspects for which variations within an inventory item group vary, and the order in which they appear in the listing. For example, t-shirts in an inventory item group may be available in multiple sizes and colors.
Tax:
type: object
properties:
applyTax:
type: boolean
description: This field will be included and set to <code>true</code> if the seller would like to reference their account-level Sales Tax Table to calculate sales tax for an order. A seller's Sales Tax Table can be created and managed manually in My eBay's Payment Preferences. This Sales Tax Table contains all tax jurisdictions for the seller's country (individual states and territories in US), and the seller can set the sales tax rate for these individual tax jurisdictions. <br/><br/> The Trading API has a <a href="https://developer.ebay.com/Devzone/XML/docs/Reference/eBay/SetTaxTable.html" target="_blank">SetTaxTable</a> call to add/modify sales tax rates for one or more tax jurisdictions, and a <a href="https://developer.ebay.com/Devzone/XML/docs/Reference/eBay/GetTaxTable.html" target="_blank">GetTaxTable</a> call that will retrieve all tax jurisdictions and related data, such as the sales tax rate (if defined) and a boolean field to indicate if sales tax is applied to shipping and handling costs.<br/><br/> The Account API has a <strong>getSalesTaxTable</strong> call to retrieve all tax jurisdictions that have a defined sales tax rate, a <strong>getSalesTaxTableEntry</strong> call to retrieve a sales tax rate for a specific tax jurisdiction, a <strong>createSalesTaxTableEntry</strong> call to set/modify a sales tax rate for a specific tax jurisdiction, and a <strong>deleteSalesTaxTableEntry</strong> call to remove a sales tax rate from a specific tax jurisdiction. <br/><br/>Note that a seller can enable the use of a sales tax table, but if a sales tax rate is not specified for the buyer's state/tax jurisdiction, sales tax will not be applied to the order. If a <strong>thirdPartyTaxCategory</strong> value is used, the <strong>applyTax</strong> field must also be used and set to <code>true</code><br/><br/>This field will be returned if set for the offer.<br/><br/>See the <a href="https://pages.ebay.com/help/pay/checkout-tax-table.html" target="_blank">Using a tax table</a> help page for more information on setting up and using a sales tax table.
thirdPartyTaxCategory:
type: string
description: The tax exception category code. If this field is used, sales tax will also apply to a service/fee, and not just the item price. This is to be used only by sellers who have opted into sales tax being calculated by a sales tax calculation vendor. If you are interested in becoming a tax calculation vendor partner with eBay, contact <a href="mailto:developer-relations@ebay.com">developer-relations@ebay.com</a>. One supported value for this field is <code>WASTE_RECYCLING_FEE</code>. If this field is used, the <strong>applyTax</strong> field must also be used and set to <code>true</code><br/><br/>This field will be returned if set for the offer.
vatPercentage:
type: number
description: This value is the Value Add Tax (VAT) rate for the item, if any. When a VAT percentage is specified, the item's VAT information appears on the listing's View Item page. In addition, the seller can choose to print an invoice that includes the item's net price, VAT percent, VAT amount, and total price. Since VAT rates vary depending on the item and on the user's country of residence, a seller is responsible for entering the correct VAT rate; it is not calculated by eBay. <br/><br/> To use VAT, a seller must be a business seller with a VAT-ID registered with eBay, and must be listing the item on a VAT-enabled site. Max applicable length is 6 characters, including the decimal (e.g., 12.345). The scale is 3 decimal places. (If you pass in 12.3456, eBay may round up the value to 12.346).<br/><br/>This field will be returned if set for the offer.
description: This type is used to enable the use of a sales tax table, to pass in a tax exception category code, or to specify a VAT percentage.
TimeDuration:
type: object
properties:
unit:
type: string
description: This enumeration value indicates the time unit used to specify the fulfillment time, such as <code>HOUR</code> or <code>BUSINESS_DAY</code>. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/inventory/types/slr:TimeDurationUnitEnum'>eBay API documentation</a>
value:
type: integer
description: The integer value in this field, along with the time unit in the <strong>unit</strong> field, will indicate the fulfillment time.<br><br> For In-Store Pickup orders, this value will indicate how soon after an In-Store Pickup purchase can the buyer pick up the item at the designated store location. If the value of this field is <code>4</code>, and the value of the <strong>unit</strong> field is <code>HOUR</code>, then the fulfillment time for the In-Store Pickup order is four hours, which means that the buyer will be able to pick up the item at the store four hours after the transaction took place.<br><br> For standard orders that will be shipped, this value will indicate the expected fulfillment time if the inventory item is shipped from the inventory location. If the value of this field is <code>4</code>, and the value of the <strong>unit</strong> field is <code>BUSINESS_DAY</code>, then the estimated delivery date after purchase is 4 business days.
format: int32
description: This type is used to indicate the fulfillment time for an In-Store Pickup order, or for an order than will be shipped to the buyer.
VariesBy:
type: object
properties:
aspectsImageVariesBy:
type: array
description: This container is used if the seller wants to include multiple images to demonstrate how variations within a multiple-variation listing differ. In this string field, the seller will specify the product aspect where the variations of the inventory item group vary, such as color. If <code>Color</code> is specified in this field, <code>Color</code> must also be one of the <strong>specifications.name</strong> values, and all available colors must appear in the corresponding <strong>specifications.values</strong> array.<br><br>If the <strong>aspectsImageVariesBy</strong> container is used, links to images of each variation should be specified through the <strong>imageUrls</strong> container of the inventory item group, or the seller can choose to include those links to images in each inventory item record for the inventory items in the group.
items:
type: string
specifications:
type: array
description: This container consists of an array of one or more product aspects where each variation differs, and values for each of those product aspects. This container is not immediately required, but will be required before the first offer of the inventory item group is published. <br><br>If a product aspect is specified in the <strong>aspectsImageVariesBy</strong> container, this product aspect (along with all variations of that product aspect) must be included in the <strong>specifications</strong> container. Before offers related to the inventory item group are published, the product aspects and values specified through the <strong>specifications</strong> container should be in synch with the name-value pairs specified through the <strong>product.aspects</strong> containers of the inventory items contained in the group. For example, if <code>Color</code> and <code>Size</code> are in this <strong>specifications</strong> container, each inventory item of the group should also have <code>Color</code> and <code>Size</code> as aspect names in their inventory item records.<br><br/>This container is always returned if one or more offers associated with the inventory item group have been published. For inventory item groups that have yet to have any published offers, this container is only returned if set.
items:
$ref: '#/components/schemas/Specification'
description: This type is used to specify the product aspect(s) where individual items of the group vary, as well as a list of the available variations of those aspects.
Version:
type: object
properties:
instance:
description: The instance of the version.
$ref: '#/components/schemas/Version'
version:
type: string
description: The version number of the service or API.
description: This type is used to show the version number and instance of the service or API.
Weight:
type: object
properties:
unit:
type: string
description: The unit of measurement used to specify the weight of a shipping package. Both the <strong>unit</strong> and <strong>value</strong> fields are required if the <strong>weight</strong> container is used. If the English system of measurement is being used, the applicable values for weight units are <code>POUND</code> and <code>OUNCE</CODE>. If the metric system of measurement is being used, the applicable values for weight units are <code>KILOGRAM</code> and <code>GRAM</code>. The metric system is used by most countries outside of the US. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/inventory/types/slr:WeightUnitOfMeasureEnum'>eBay API documentation</a>
value:
type: number
description: 'The actual weight (in the measurement unit specified in the <strong>unit</strong> field) of the shipping package. Both the <strong>unit</strong> and <strong>value</strong> fields are required if the <strong>weight</strong> container is used. If a shipping package weighed 20.5 ounces, the container would look as follows: <br/><pre>"weight": {<br/> "value": 20.5,<br/> "unit": "OUNCE"<br/> }</pre>'
description: This type is used to specify the weight (and the unit used to measure that weight) of a shipping package. The <strong>weight</strong> container is conditionally required if the seller will be offering calculated shipping rates to determine shipping cost, or is using flat-rate costs, but charging a weight surcharge. See the <a href="https://pages.ebay.com/help/pay/calculated-shipping.html" target="_blank">Calculated shipping</a> help page for more information on calculated shipping.
WithdrawByInventoryItemGroupRequest:
type: object
properties:
inventoryItemGroupKey:
type: string
description: This is the unique identifier of the inventory item group. This identifier is automatically generated by eBay once an inventory item group is created. This field is required.
marketplaceId:
type: string
description: This is the unique identifier of the eBay site for which the offer will be made available. The marketPlaceId enumeration values are found in MarketplaceIdEnum. This field is required. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/inventory/types/slr:MarketplaceEnum'>eBay API documentation</a>
description: This type is used by the base request of the <strong>WithdrawByInventoryItemGroup</strong> method, which is used to end a multiple-variation listing.
WithdrawResponse:
type: object
properties:
listingId:
type: string
description: The unique identifier of the eBay listing associated with the offer that was withdrawn. This field will not be returned if the eBay listing was not successfully ended.
warnings:
type: array
description: This container will be returned if there were one or more warnings associated with the attempt to withdraw the offer.
items:
$ref: '#/components/schemas/Error'
description: The base response of the <strong>withdrawOffer</strong> call.
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.inventory: View and manage your inventory and offers
https://api.ebay.com/oauth/api_scope/sell.inventory.readonly: View your inventory and offers