openapi: 3.0.0 info: title: eBay Account Advertising_eligibility Inventory_item API description: The Account API gives sellers the ability to configure their eBay seller accounts, including the seller's policies (eBay business policies and seller-defined custom policies), opt in and out of eBay seller programs, configure sales tax tables, and get account information.

For details on the availability of the methods in this API, see Account API requirements and restrictions. contact: name: eBay Inc, license: name: eBay API License Agreement url: https://go.developer.ebay.com/api-license-agreement version: v1.9.2 servers: - url: https://api.ebay.com{basePath} description: Production variables: basePath: default: /sell/account/v1 tags: - name: Inventory_item paths: /bulk_create_or_replace_inventory_item: post: tags: - Inventory_item description: 'Note: Please note that any eBay listing created using the Inventory API cannot be revised or relisted using the Trading API calls.
Note: 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.
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 bulkCreateOrReplaceInventoryItem call, and then make one or more additional bulkCreateOrReplaceInventoryItem 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.

Note: In addition to the authorization header, which is required for all eBay REST API calls, this call also requires the Content-Language and Content-Type headers. See the HTTP request headers section for more information.
In the case of updating existing inventory item records, the bulkCreateOrReplaceInventoryItem 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.

The key information that is set with the bulkCreateOrReplaceInventoryItem call include:

For those who prefer to create or update a single inventory item record, the createOrReplaceInventoryItem method can be used.

' operationId: bulkCreateOrReplaceInventoryItem parameters: - name: Content-Type in: header description: This header indicates the format of the request body provided by the client. Its value should be set to application/json.

For more information, refer to HTTP request headers. required: true schema: type: string - name: Content-Language in: header description: This header sets the natural language that will be used in the field values of the request payload. For example, the value passed in this header should be en-US for English or de-DE for German.

For more information on the Content-Language header, refer to HTTP request headers. required: true schema: type: string 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.

Note: In addition to the authorization header, which is required for all Inventory API calls, this call also requires the Content-Type header. See the HTTP request headers for more information.
For those who prefer to retrieve only one inventory item record by SKU value, the getInventoryItem method can be used. To retrieve all inventory item records defined on the seller's account, the getInventoryItems method can be used (with pagination control if desired). operationId: bulkGetInventoryItem parameters: - name: Content-Type in: header description: This header indicates the format of the request body provided by the client. Its value should be set to application/json.

For more information, refer to HTTP request headers. required: true schema: type: string 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 bulkUpdatePriceQuantity call. Only one SKU (one product) can be updated per call.

Note: 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.
Note: In addition to the authorization header, which is required for all Inventory API calls, this call also requires the Content-Type header. See the HTTP request headers for more information.
The getOffers call can be used to retrieve all offers associated with a SKU. The seller will just pass in the correct SKU value through the sku query parameter. To update an offer, the offerId value is required, and this value is returned in the getOffers call response. It is also useful to know which offers are unpublished and which ones are published. To get this status, look for the status value in the getOffers call response. Offers in the published state are live eBay listings, and these listings will be revised with a successful bulkUpdatePriceQuantity call.

An issue will occur if duplicate offerId values are passed through the same offers container, or if one or more of the specified offers are associated with different products/SKUs.

Note: For multiple-variation listings, it is recommended that the bulkUpdatePriceQuantity call be used to update price and quantity information for each SKU within that multiple-variation listing instead of using createOrReplaceInventoryItem calls to update the price and quantity for each SKU. Just remember that only one SKU (one product variation) can be updated per call.

operationId: bulkUpdatePriceQuantity parameters: - name: Content-Type in: header description: This header indicates the format of the request body provided by the client. Its value should be set to application/json.

For more information, refer to HTTP request headers. required: true schema: type: string 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.

The authorization header is the only required HTTP header for this call, and it is required for all Inventory API calls. See the HTTP request headers section for more information.

For those who prefer to retrieve numerous inventory item records by SKU value with one call (up to 25 at a time), the bulkGetInventoryItem method can be used. To retrieve all inventory item records defined on the seller's account, the getInventoryItems method can be used (with pagination control if desired). operationId: getInventoryItem parameters: - name: sku in: path description: 'This path parameter specifies the seller-defined SKU value of the product whose inventory item record you wish to retrieve.

Use the getInventoryItems method to retrieve SKU values.

Max length: 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: 'Note: Please note that any eBay listing created using the Inventory API cannot be revised or relisted using the Trading API calls.
Note: 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.
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 createOrReplaceInventoryItem call, and then make one or more additional createOrReplaceInventoryItem 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.

Note: In addition to the authorization header, which is required for all Inventory API calls, this call also requires the Content-Type and Content-Language headers. See the HTTP request headers for more information.
In the case of replacing an existing inventory item record, the createOrReplaceInventoryItem 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 getInventoryItem 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.

The key information that is set with the createOrReplaceInventoryItem call include:

In addition to the authorization header, which is required for all eBay REST API calls, the createOrReplaceInventoryItem call also requires the Content-Language 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 en-US. To view other supported Content-Language values, and to read more about all supported HTTP headers for eBay REST API calls, see the HTTP request headers topic in the Using eBay RESTful APIs document.

For those who prefer to create or update numerous inventory item records with one call (up to 25 at a time), the bulkCreateOrReplaceInventoryItem method can be used.

' operationId: createOrReplaceInventoryItem parameters: - name: Content-Language in: header description: This header sets the natural language that will be used in the field values of the request payload. For example, the value passed in this header should be en-US for English or de-DE for German.

For more information on the Content-Language header, refer to HTTP request headers. required: true schema: type: string - name: sku in: path description: 'This path parameter specifies the seller-defined SKU value for the inventory item being created or updated. SKU values must be unique across the seller''s inventory.

Max length: 50' required: true schema: type: string - name: Content-Type in: header description: This header indicates the format of the request body provided by the client. Its value should be set to application/json.

For more information, refer to HTTP request headers. 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:

The authorization header is the only required HTTP header for this call. See the HTTP request headers section for more information.

operationId: deleteInventoryItem parameters: - name: sku in: path description: 'This path parameter specifies the seller-defined SKU value of the product whose inventory item record you wish to delete.

Use the getInventoryItems method to retrieve SKU values.

Max length: 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 limit query parameter allows the seller to control how many records are returned per page, and the offset 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.

The authorization header is the only required HTTP header for this call, and it is required for all Inventory API calls. See the HTTP request headers section for more information.

For those who prefer to retrieve numerous inventory item records by SKU value with one call (up to 25 at a time), the bulkGetInventoryItem 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 1 to 200.

Min: 1

Max: 200

Default: 25 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 0, the second page of records has a value of 1, and so on. If this query parameter is not set, its value defaults to 0, 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 components: schemas: GetInventoryItem: type: object properties: sku: type: string description: An array of SKU values are passed in under the sku container to retrieve up to 25 inventory item records.

Use the getInventoryItems method to retrieve SKU values. 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 bulkGetInventoryItem method. 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. InventoryItemWithSkuLocale: type: object properties: availability: description: This container is used to specify the quantity of the inventory item that are available for purchase.

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.

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 getItemConditionPolicies method of the Metadata API. This method returns condition ID values that map to the enumeration values defined in the ConditionEnum type. The Item condition ID and name values topic in the Selling Integration Guide has a table that maps condition ID values to ConditionEnum values. The getItemConditionPolicies call reference page has more information.

A condition 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.

Note: The ''Manufacturer Refurbished'' item condition is no longer a valid item condition on any eBay marketplace, and to reflect this change, the MANUFACTURER_REFURBISHED value is no longer applicable, and should not be used. With Version 1.13.0, the CERTIFIED_REFURBISHED enumeration value has been introduced, and CR-eligible sellers should make a note to start using CERTIFIED_REFURBISHED from this point forward. For the time being, if the MANUFACTURER_REFURBISHED enum is used for any of the SKUs in a bulkCreateOrReplaceInventoryItem method, it will be accepted but automatically converted by eBay to CERTIFIED_REFURBISHED.

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.

Any seller that is interested in eligibility requirements to list with ''Certified Refurbished'' should see the Certified refurbished program page in Seller Center.

Important!For trading card listings in Non-Sport Trading Card Singles (183050), CCG Individual Cards (183454), and Sports Trading Card Singles (261328) categories, LIKE_NEW (2750) can be used to specify the card as a Graded card and USED_VERY_GOOD (4000) can be used to specify the card as an Ungraded card. If either of these item conditions are used for the affected categories, the seller is then required to use the conditionDescriptors array to provide one or more applicable Condition Descriptor name-value pairs. See the conditionDescriptors field description for more information.

Beginning October 23, 2023, trading card listings in the affected categories must use either LIKE_NEW (2750) or USED_VERY_GOOD (4000) item condition, and no other item conditions will be accepted. These item conditions and the conditionDescriptors array will be required for all new listings. If not provided after this date, the publishOffer, bulkPublishOffer, and publishOfferByInventoryItemGroup methods will fail when trying to create new listings.

By January 22 2024, all existing listings must be modified with either LIKE_NEW (2750) or USED_VERY_GOOD (4000) item condition and applicable conditionDescriptors name-value pairs. The updateOffer method will fail if the inventory item object does not have one of these two item conditions along with applicable conditionDescriptors name-value pairs.

For implementation help, refer to eBay API documentation' 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 condition value is not NEW, LIKE_NEW, NEW_OTHER, or NEW_WITH_DEFECTS.

The conditionDescription field is available for all eBay categories. If the conditionDescription 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.

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 condition value, condition description, listing description, and the item''s pictures do not contradict one another.

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.

This field is returned in the getInventoryItem, bulkGetInventoryItem, and getInventoryItems calls if a condition description was provided for a used inventory item.

Max Length: 1000.' conditionDescriptors: type: array description: '

Important!For trading card listings in Non-Sport Trading Card Singles (183050), CCG Individual Cards (183454), and Sports Trading Card Singles (261328) categories, LIKE_NEW (2750) can be used to specify the card as a Graded card and USED_VERY_GOOD (4000) can be used to specify the card as an Ungraded card. If either of these item conditions are used for the affected categories, the seller is then required to use the conditionDescriptors array to provide one or more applicable Condition Descriptor name-value pairs.

Beginning October 23, 2023, trading card listings in the affected categories must use either LIKE_NEW (2750) or USED_VERY_GOOD (4000) item condition, and no other item conditions will be accepted. These item conditions and the conditionDescriptors array will be required for all new listings. If not provided after this date, the publishOffer, bulkPublishOffer, and publishOfferByInventoryItemGroup methods will fail when trying to create new listings.

By January 22 2024, all existing listings must be modified with either LIKE_NEW (2750) or USED_VERY_GOOD (4000) item condition and applicable conditionDescriptors name-value pairs. The updateOffer method will fail if the inventory item object does not have one of these two item conditions along with applicable conditionDescriptors name-value pairs.



This container is used by the seller to provide additional information about the condition of an item in a structured format. Condition descriptors are name-value attributes that can be either close set or open text inputs.

To retrieve all condition descriptor numeric IDs for a category, use the getItemConditionPolicies method of the Metadata API.

' items: $ref: '#/components/schemas/ConditionDescriptor' 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 eBay API documentation 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.

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.

This container is returned in the getInventoryItem, bulkGetInventoryItem, and getInventoryItems calls if package type, package weight, and/or package dimensions are specified for an inventory item.

See the Calculated shipping 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.

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 getItemAspectsForCategory method in the Taxonomy API. In the getItemAspectsForCategory response, look for product identifier names (brand, mpn, upc, ean, isbn) in the localizedAspectName fields, and then look for the correspondinng aspectRequired boolean fields as well as the corresponding aspectUsage 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 GeteBayDetails call of the Trading API to get this string value. In the GeteBayDetails call, the seller should include a DetailName field with its value set to ProductDetails. In the response of the call, the seller can see the default string value in the ProductDetails.ProductIdentifierUnavailableText field. The seller will use this value in one or more of the product identifier fields (ean, isbn, upc, or mpn) if a product ID isn't known or applicable.

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.

This container is always returned for published offers in the getInventoryItem, bulkGetInventoryItem, and getInventoryItems 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 marketplaceId field). Only one offer (in unpublished or published state) may exist for each sku/marketplaceId/format combination. This field is required.

Max Length: 50
' description: This type is used to define/modify each inventory item record that is being created and/or updated with the bulkCreateOrReplaceInventoryItem method. Up to 25 inventory item records can be created and/or updated with one call. Weight: type: object properties: unit: type: string description: The unit of measurement used to specify the weight of a shipping package. Both the unit and value fields are required if the weight container is used. If the English system of measurement is being used, the applicable values for weight units are POUND and OUNCE. If the metric system of measurement is being used, the applicable values for weight units are KILOGRAM and GRAM. The metric system is used by most countries outside of the US. For implementation help, refer to eBay API documentation value: type: number description: 'The actual weight (in the measurement unit specified in the unit field) of the shipping package. Both the unit and value fields are required if the weight container is used. If a shipping package weighed 20.5 ounces, the container would look as follows: 
"weight": {
 "value": 20.5,
 "unit": "OUNCE"
 }
' description: This type is used to specify the weight (and the unit used to measure that weight) of a shipping package. The weight 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 Calculated shipping help page for more information on calculated shipping. 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.

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.

Note: The ''Manufacturer Refurbished'' item condition is no longer a valid item condition on any eBay marketplace, and to reflect this change, the MANUFACTURER_REFURBISHED value has essentially been replaced with the CERTIFIED_REFURBISHED enumeration value with Version 1.13.0. For any existing inventory items that have MANUFACTURER_REFURBISHED set as their condition value, eBay will automatically convert the condition of these inventory items to CERTIFIED_REFURBISHED, so it is not necessary for the developer to update these inventory items with a ''create or replace'' call.

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.

Any seller that is interested in eligibility requirements to list with ''Certified Refurbished'' should see the Certified refurbished program page in Seller Center.

Important!For trading card listings in Non-Sport Trading Card Singles (183050), CCG Individual Cards (183454), and Sports Trading Card Singles (261328) categories, LIKE_NEW (2750) can be used to specify the card as a Graded card and USED_VERY_GOOD (4000) can be used to specify the card as an Ungraded card. If either of these item conditions are used for the affected categories, the seller is then required to use the conditionDescriptors array to provide one or more applicable Condition Descriptor name-value pairs. See the conditionDescriptors field description for more information.

Beginning October 23, 2023, trading card listings in the affected categories must use either LIKE_NEW (2750) or USED_VERY_GOOD (4000) item condition, and no other item conditions will be accepted. These item conditions and the conditionDescriptors array will be required for all new listings. If not provided after this date, the publishOffer, bulkPublishOffer, and publishOfferByInventoryItemGroup methods will fail when trying to create new listings.

By January 22 2024, all existing listings must be modified with either LIKE_NEW (2750) or USED_VERY_GOOD (4000) item condition and applicable conditionDescriptors name-value pairs. The updateOffer method will fail if the inventory item object does not have one of these two item conditions along with applicable conditionDescriptors name-value pairs.

For implementation help, refer to eBay API documentation' 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.' conditionDescriptors: type: array description: '

Important!For trading card listings in Non-Sport Trading Card Singles (183050), CCG Individual Cards (183454), and Sports Trading Card Singles (261328) categories, LIKE_NEW (2750) can be used to specify the card as a Graded card and USED_VERY_GOOD (4000) can be used to specify the card as an Ungraded card. If either of these item conditions are used for the affected categories, the seller is then required to use the conditionDescriptors array to provide one or more applicable Condition Descriptor name-value pairs.

Beginning October 23, 2023, trading card listings in the affected categories must use either LIKE_NEW (2750) or USED_VERY_GOOD (4000) item condition, and no other item conditions will be accepted. These item conditions and the conditionDescriptors array will be required for all new listings. If not provided after this date, the publishOffer, bulkPublishOffer, and publishOfferByInventoryItemGroup methods will fail when trying to create new listings.

By January 22 2024, all existing listings must be modified with either LIKE_NEW (2750) or USED_VERY_GOOD (4000) item condition and applicable conditionDescriptors name-value pairs. The updateOffer method will fail if the inventory item object does not have one of these two item conditions along with applicable conditionDescriptors name-value pairs.



This container is used by the seller to provide additional information about the condition of an item in a structured format. Descriptors are name-value attributes that can be either closed set or open text.

For more information on the numeric IDs and their text equivalents, use the getItemConditionPolicies method of the Metadata API.

' items: $ref: '#/components/schemas/ConditionDescriptor' 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 eBay API documentation 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 createOrReplaceInventoryItem 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. 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.

This call is not designed to work with unpublished offers. For unpublished offers, the seller should use the updateOffer call to update the available quantity and/or price.

If the seller is also using the shipToLocationAvailability container and sku field to update the total 'ship-to-home' quantity of the inventory item, the SKU value associated with the corresponding offerId value(s) must be the same as the corresponding sku value that is passed in, or an error will occur.

A separate (OfferPriceQuantity) 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 sku field). A successful call will update the inventory item record associated with the sku 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 shipToLocationAvailability container. If the seller is updating the price and/or quantity of one or more specific offers, one or more offerId values are used instead, and the sku value is not needed.

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 offerId value(s) must be the same as the corresponding sku value that is passed in, or an error will occur.

Use the getInventoryItems method to retrieve SKU values.

Max Length: 50
' 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. 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 bulkCreateOrReplaceInventoryItem call. items: $ref: '#/components/schemas/InventoryItemWithSkuLocale' description: The base request of the bulkCreateOrReplaceInventoryItem method. 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 createOrReplaceInventoryItem, createOrReplaceInventoryItemGroup, and createOrReplaceProductCompatibility calls. A response payload will only be returned for these three calls if one or more errors or warnings occur with the 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. 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.

Max Length: 50
' 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 offerId field) or the attempt to update the total 'ship-to-home' quantity of an inventory item (specified in the corresponding sku field). For a completely successful update of an offer or inventory item record, a value of 200 will appear in this field. A user can view the HTTP status codes section for information on other status codes that may be returned with the bulkUpdatePriceQuantity 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 bulkUpdatePriceQuantity call. If any errors or warnings occur, the error/warning data is returned at the offer/inventory item level. 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 bulkGetInventoryItem method. 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 merchantLocationKey field. The fulfillment time is the estimated number of business days after purchase that the buyer can expect the item to be delivered.

This field is optional, and is used by eBay to provide the estimated delivery date to buyers. This field is returned by getInventoryItem and getInventoryItems 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.

Use the getInventoryLocations method to retrieve merchant location keys. 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. ConditionDescriptor: type: object properties: additionalInfo: type: string description: This string provides additional information about a condition descriptor. Open text is passed in this field.

In the case of trading cards, this field houses the optional Certification Number condition descriptor for graded cards.

Max Length: 30 characters name: type: string description: This string provides the name of a condition descriptor. A numeric ID is passed in this field. This numeric ID maps to the name of a condition descriptor. Condition descriptor name-value pairs provide more information about an item's condition in a structured way.

To retrieve all condition descriptor name numeric IDs for a category, refer to the conditionDescriptorId field returned in the getItemConditionPolicies method of Metadata API.

In the case of trading cards, this field is used to provide condition descriptors for a card. For graded cards, the condition descriptors for Grader and Grade are required, while the condition descriptor for Certification Number is optional. For ungraded cards, only the Card Condition condition descriptor is required. values: type: array description: This array provides the value(s) associated with a condition descriptor. One or more numeric IDs is passed in this field. Commas are used as delimiters between successive name/value pairs. These numeric IDs map to the values associated with a condition descriptor name. Condition descriptor name-value pairs provide more information about an item's condition in a structured way.

To retrieve all condition descriptor value numeric IDs for a category, refer to the ConditionDescriptorValueId array returned in the getItemConditionPolicies method of Metadata API.

In the case of trading cards, this field houses the information on the Grader and Grade descriptors of graded cards and the Card Condition descriptor for ungraded cards. items: type: string description: This type is used by the seller to provide additional information about the condition of an item in a structured format. Amount: type: object properties: currency: type: string description: A three-digit string value representing the type of currency being used. Both the value and currency fields are required/always returned when expressing prices.

See the CurrencyCodeEnum 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 currency field. Both the value and currency fields are required/always returned when expressing prices. description: This type is used to express a dollar value and the applicable currency. 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 limit 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 limit 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 getInventoryItems call. ' 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.

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.

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. 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 eBay API documentation 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 sku field. See the HTTP status codes 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 bulkCreateOrReplaceInventoryItem method to indicate the success or failure of creating and/or updating each inventory item record. The sku value in this type identifies each inventory item record. BulkGetInventoryItemResponse: type: object properties: responses: type: array description: This is the base container of the bulkGetInventoryItem 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 bulkGetInventoryItem 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 bulkUpdatePriceQuantity call. The bulkUpdatePriceQuantity 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. 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. 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 getItemAspectsForCategory 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.

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 product 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.

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.

"aspects": {
 "Brand": ["GoPro"],
 "Storage Type": ["Removable"]
 }

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.

This container will be returned if one or more item specific pairs are defined for the inventory item.

Max Length for Aspect Name: 40

Max Length for Aspect Value: 50' brand: type: string description: 'The brand of the product. This field is often paired with the mpn 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 createOrReplaceInventoryItem call is successful.

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 aspects array in a createOrReplaceInventoryItem call, this value is also picked up by the brand field.

Max Length: 65' description: type: string description: 'The description of the product. The description of an existing inventory item can be added or modified with a createOrReplaceInventoryItem 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.

Note that this field is optional but recommended. If a listingDescription field is omitted when creating and publishing a single-variation offer, the text in this field will be used instead. If neither the product.description field for the inventory item nor the listingDescription field for the offer exist, the publishOffer 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. This is the green, extra-large version of the shirt). However, in the case of an inventory item group, the text in the description field of the inventory item group will become the listing description of the actual eBay listing instead of the text in this field.

Basic HTML tags are supported, including the following tags: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.

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.

Max Length: 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.

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 aspects array in a createOrReplaceInventoryItem call, this value is also picked up by the ean 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.

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.

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 UploadSiteHostedPictures call of the Trading API to upload images to an eBay Picture Server. If successful, the response of the UploadSiteHostedPictures 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 imageUrls 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 Fees for selling vehicles on eBay Motors).

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.

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.

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 aspects array in a createOrReplaceInventoryItem call, this value is also picked up by the isbn field. items: type: string mpn: type: string description: 'The Manufacturer Part Number (MPN) of a product. This field is paired with the brand field to identify a product. Some eBay categories require MPN values. The getItemAspectsForCategory 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.

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 aspects array in a createOrReplaceInventoryItem call, this value is also picked up by the mpn field.

Max Length: 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 Adding a subtitle to your listings help page. The subtitle of an existing inventory item can added, modified, or removed with a createOrReplaceInventoryItem call.

Note that the same subtitle 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.

This field will only be returned if set for an inventory item.

Max Length: 55' title: type: string description: 'The title of an inventory item can be added or modified with a createOrReplaceInventoryItem 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 title 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.

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.

Max Length: 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.

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 aspects array in a createOrReplaceInventoryItem call, this value is also picked up by the upc field. items: type: string videoIds: type: array description: An array of one or more videoId values for the product. A video ID is a unique identifier that is automatically created by eBay when a seller successfully uploads a video to eBay using the uploadVideo method of the Media API.

For information on supported marketplaces and platforms, as well as other requirements and limitations of video support, please refer to Managing videos.

Note: Only one video per listing is supported. 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 createOrReplaceInventoryItem 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 getInventoryItem, getInventoryItems, and bulkGetInventoryItem calls if defined. Dimension: type: object properties: height: type: number description: 'The actual height (in the measurement unit specified in the unit field) of the shipping package. All fields of the dimensions container are required if package dimensions are specified.

If a shipping package measured 21.5 inches in length, 15.0 inches in width, and 12.0 inches in height, the dimensions container would look as follows: 
"dimensions": {
 "length": 21.5,
 "width": 15.0,
 "height": 12.0,
 "unit": "INCH"
 }
' length: type: number description: 'The actual length (in the measurement unit specified in the unit field) of the shipping package. All fields of the dimensions container are required if package dimensions are specified.

If a shipping package measured 21.5 inches in length, 15.0 inches in width, and 12.0 inches in height, the dimensions container would look as follows: 
"dimensions": {
 "length": 21.5,
 "width": 15.0,
 "height": 12.0,
 "unit": "INCH"
 }
' unit: type: string description: The unit of measurement used to specify the dimensions of a shipping package. All fields of the dimensions container are required if package dimensions are specified. If the English system of measurement is being used, the applicable values for dimension units are FEET and INCH. If the metric system of measurement is being used, the applicable values for weight units are METER and CENTIMETER. The metric system is used by most countries outside of the US. For implementation help, refer to eBay API documentation width: type: number description: 'The actual width (in the measurement unit specified in the unit field) of the shipping package. All fields of the dimensions container are required if package dimensions are specified.

If a shipping package measured 21.5 inches in length, 15.0 inches in width, and 12.0 inches in height, the dimensions container would look as follows: 
"dimensions": {
 "length": 21.5,
 "width": 15.0,
 "height": 12.0,
 "unit": "INCH"
 }
' description: This type is used to specify the dimensions (and the unit used to measure those dimensions) of a shipping package. The dimensions container is conditionally required if the seller will be offering calculated shipping rates to determine shipping cost. See the Calculated shipping 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 pickupAtLocationAvailability.merchantLocationKey field. This field is required if the pickupAtLocationAvailability container is used, and is always returned with the pickupAtLocationAvailability container.

See AvailabilityTypeEnum for more information about how/when you use each enumeration value. For implementation help, refer to eBay API documentation 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 pickupAtLocationAvailability container is used, and is always returned with the pickupAtLocationAvailability 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 availabilityType value should be SHIP_TO_STORE. This field is required if the pickupAtLocationAvailability container is used, and is always returned with the pickupAtLocationAvailability container.

Use the getInventoryLocations method to retrieve merchant location keys.

Max length: 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 merchantLocationKey value. The value of quantity should be an integer value greater than 0, unless the inventory item is out of stock. This field is required if the pickupAtLocationAvailability container is used, and is always returned with the pickupAtLocationAvailability 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 merchantLocationKey field). 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.

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 PackageTypeEnum type.

This field will be returned if the package type is set for the inventory item.

Note: You can use the GeteBayDetails Trading API call to retrieve a list of supported package types for a specific marketplace. For implementation help, refer to eBay API documentation shippingIrregular: type: boolean description: A value of true indicates that the package is irregular and cannot go through the stamping machine at the shipping service office. This field applies to calculated shipping only. Irregular packages require special or fragile handling. 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.

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 Calculated shipping help page for more information on calculated shipping. 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 errors and/or warnings 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 bulkUpdatePriceQuantity call. The bulkUpdatePriceQuantity call response will return an HTTP status code, offer ID, and SKU value for each offer/inventory item being updated, as well as an errors and/or warnings container if any errors or warnings are triggered while trying to update those offers/inventory items. BulkInventoryItemResponse: type: object properties: responses: type: array description: This is the base container of the bulkCreateOrReplaceInventoryItem 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 bulkCreateOrReplaceInventoryItem method. InventoryItem: type: object properties: availability: description: This container is used to specify the quantity of the inventory item that are available for purchase.

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.

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 getItemConditionPolicies method of the Metadata API. This method returns condition ID values that map to the enumeration values defined in the ConditionEnum type. The Item condition ID and name values topic in the Selling Integration Guide has a table that maps condition ID values to ConditionEnum values. The getItemConditionPolicies call reference page has more information.

A condition 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.

Note: The ''Manufacturer Refurbished'' item condition is no longer a valid item condition on any eBay marketplace, and to reflect this change, the MANUFACTURER_REFURBISHED value is no longer applicable, and should not be used. With Version 1.13.0, the CERTIFIED_REFURBISHED enumeration value has been introduced, and CR-eligible sellers should make a note to start using CERTIFIED_REFURBISHED from this point forward. For the time being, if the MANUFACTURER_REFURBISHED enum is used in a createOrReplaceInventoryItem method, it will be accepted but automatically converted by eBay to CERTIFIED_REFURBISHED. In the future, the MANUFACTURER_REFURBISHED may start triggering an error if used.

As of September 1, 2021, condition ID 2500 (''Seller Refurbished'') can no longer be used in the Cell Phones & Smartphones category (category ID 9355) 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: To use any of these new refurbished item conditions in category 9355, sellers must go through an application and qualification process. Any seller who is not eligible to use these new refurbished item conditions in category 9355 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 9355 that had condition ID 2500 (''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 9355, such as condition ID 3000 (''Used'').

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.

Any seller that is interested in eligibility requirements to list with ''Certified Refurbished'' should see the Certified refurbished program page in Seller Center.

Important!For trading card listings in Non-Sport Trading Card Singles (183050), CCG Individual Cards (183454), and Sports Trading Card Singles (261328) categories, LIKE_NEW (2750) can be used to specify the card as a Graded card and USED_VERY_GOOD (4000) can be used to specify the card as an Ungraded card. If either of these item conditions are used for the affected categories, the seller is then required to use the conditionDescriptors array to provide one or more applicable Condition Descriptor name-value pairs. See the conditionDescriptors field description for more information.

Beginning October 23, 2023, trading card listings in the affected categories must use either LIKE_NEW (2750) or USED_VERY_GOOD (4000) item condition, and no other item conditions will be accepted. These item conditions and the conditionDescriptors array will be required for all new listings. If not provided after this date, the publishOffer, bulkPublishOffer, and publishOfferByInventoryItemGroup methods will fail when trying to create new listings.

By January 22 2024, all existing listings must be modified with either LIKE_NEW (2750) or USED_VERY_GOOD (4000) item condition and applicable conditionDescriptors name-value pairs. The updateOffer method will fail if the inventory item object does not have one of these two item conditions along with applicable conditionDescriptors name-value pairs.

For implementation help, refer to eBay API documentation' 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 condition value is not NEW, LIKE_NEW, NEW_OTHER, or NEW_WITH_DEFECTS.

The conditionDescription field is available for all eBay categories. If the conditionDescription 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.

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 condition value, condition description, listing description, and the item''s pictures do not contradict one another.

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.

This field is returned in the getInventoryItem and getInventoryItems calls if a condition description was provided for a used inventory item.

Max Length: 1000.' conditionDescriptors: type: array description: '

Important!For trading card listings in Non-Sport Trading Card Singles (183050), CCG Individual Cards (183454), and Sports Trading Card Singles (261328) categories, LIKE_NEW (2750) can be used to specify the card as a Graded card and USED_VERY_GOOD (4000) can be used to specify the card as an Ungraded card. If either of these item conditions are used for the affected categories, the seller is then required to use the conditionDescriptors array to provide one or more applicable Condition Descriptor name-value pairs.

Beginning October 23, 2023, trading card listings in the affected categories must use either LIKE_NEW (2750) or USED_VERY_GOOD (4000) item condition, and no other item conditions will be accepted. These item conditions and the conditionDescriptors array will be required for all new listings. If not provided after this date, the publishOffer, bulkPublishOffer, and publishOfferByInventoryItemGroup methods will fail when trying to create new listings.

By January 22 2024, all existing listings must be modified with either LIKE_NEW (2750) or USED_VERY_GOOD (4000) item condition and applicable conditionDescriptors name-value pairs. The updateOffer method will fail if the inventory item object does not have one of these two item conditions along with applicable conditionDescriptors name-value pairs.



This container is used by the seller to provide additional information about the condition of an item in a structured format. Condition descriptors are name-value attributes that can be either close set or open text inputs.

To retrieve all condition descriptor numeric IDs for a category, use the getItemConditionPolicies method of the Metadata API.

' items: $ref: '#/components/schemas/ConditionDescriptor' 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.

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.

This container is returned in the getInventoryItem and getInventoryItems calls if package type, package weight, and/or package dimensions are specified for an inventory item.

See the Calculated shipping 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.

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 getItemAspectsForCategory method in the Taxonomy API. In the getItemAspectsForCategory response, look for product identifier names (brand, mpn, upc, ean, isbn) in the localizedAspectName fields, and then look for the correspondinng aspectRequired boolean fields as well as the corresponding aspectUsage 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 GeteBayDetails call of the Trading API to get this string value. In the GeteBayDetails call, the seller should include a DetailName field with its value set to ProductDetails. In the response of the call, the seller can see the default string value in the ProductDetails.ProductIdentifierUnavailableText field. The seller will use this value in one or more of the product identifier fields (ean, isbn, upc, or mpn) if a product ID isn't known or applicable.

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.

This container is always returned for published offers in the getInventoryItem, bulkGetInventoryItem, and getInventoryItems 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. 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 offerId value). Either the availableQuantity field or the price container is required, but not necessarily both. format: int32 offerId: type: string description: This field is the unique identifier of the offer. If an offers container is used to update one or more offers associated to a specific inventory item, the offerId value is required in order to identify the offer to update with a modified price and/or quantity.

The seller can use the getOffers method (passing in the correct SKU value as a query parameter) to retrieve offerId 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 offerId value). Either the availableQuantity field or the price container is required, but not necessarily both. $ref: '#/components/schemas/Amount' description: This type is used by the offers container in a Bulk Update Price and Quantity call to update the current price and/or quantity of one or more offers associated with a specific inventory item. 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 name field. description: This type is used to indicate the parameter field/value that caused an issue with the call request. 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.

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.

Note: The ''Manufacturer Refurbished'' item condition is no longer a valid item condition on any eBay marketplace, and to reflect this change, the MANUFACTURER_REFURBISHED value has essentially been replaced with the CERTIFIED_REFURBISHED enumeration value with Version 1.13.0. For any existing inventory items that have MANUFACTURER_REFURBISHED set as their condition value, eBay will automatically convert the condition of these inventory items to CERTIFIED_REFURBISHED, so it is not necessary for the developer to update these inventory items with a ''create or replace'' call.

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.

Any seller that is interested in eligibility requirements to list with ''Certified Refurbished'' should see the Certified refurbished program page in Seller Center.

Important!For trading card listings in Non-Sport Trading Card Singles (183050), CCG Individual Cards (183454), and Sports Trading Card Singles (261328) categories, LIKE_NEW (2750) can be used to specify the card as a Graded card and USED_VERY_GOOD (4000) can be used to specify the card as an Ungraded card. If either of these item conditions are used for the affected categories, the seller is then required to use the conditionDescriptors array to provide one or more applicable Condition Descriptor name-value pairs. See the conditionDescriptors field description for more information.

Beginning October 23, 2023, trading card listings in the affected categories must use either LIKE_NEW (2750) or USED_VERY_GOOD (4000) item condition, and no other item conditions will be accepted. These item conditions and the conditionDescriptors array will be required for all new listings. If not provided after this date, the publishOffer, bulkPublishOffer, and publishOfferByInventoryItemGroup methods will fail when trying to create new listings.

By January 22 2024, all existing listings must be modified with either LIKE_NEW (2750) or USED_VERY_GOOD (4000) item condition and applicable conditionDescriptors name-value pairs. The updateOffer method will fail if the inventory item object does not have one of these two item conditions along with applicable conditionDescriptors name-value pairs.

For implementation help, refer to eBay API documentation' 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.' conditionDescriptors: type: array description: '

Important!For trading card listings in Non-Sport Trading Card Singles (183050), CCG Individual Cards (183454), and Sports Trading Card Singles (261328) categories, LIKE_NEW (2750) can be used to specify the card as a Graded card and USED_VERY_GOOD (4000) can be used to specify the card as an Ungraded card. If either of these item conditions are used for the affected categories, the seller is then required to use the conditionDescriptors array to provide one or more applicable Condition Descriptor name-value pairs.

Beginning October 23, 2023, trading card listings in the affected categories must use either LIKE_NEW (2750) or USED_VERY_GOOD (4000) item condition, and no other item conditions will be accepted. These item conditions and the conditionDescriptors array will be required for all new listings. If not provided after this date, the publishOffer, bulkPublishOffer, and publishOfferByInventoryItemGroup methods will fail when trying to create new listings.

By January 22 2024, all existing listings must be modified with either LIKE_NEW (2750) or USED_VERY_GOOD (4000) item condition and applicable conditionDescriptors name-value pairs. The updateOffer method will fail if the inventory item object does not have one of these two item conditions along with applicable conditionDescriptors name-value pairs.



This container is used by the seller to provide additional information about the condition of an item in a structured format. Descriptors are name-value attributes that can be either closed set or open text.

For more information on the numeric IDs and their text equivalents, use the getItemConditionPolicies method of the Metadata API.

' items: $ref: '#/components/schemas/ConditionDescriptor' 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 eBay API documentation 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 createOrReplaceInventoryItem 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. 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.

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.

In-Store Pickup is only available to large merchants selling on the US, UK, Germany, and Australia sites. 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 sku 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 sku field. See the HTTP status codes 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 bulkGetInventoryItem method to give the status of each inventory item record that the user tried to retrieve. 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.

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.

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. TimeDuration: type: object properties: unit: type: string description: This enumeration value indicates the time unit used to specify the fulfillment time, such as BUSINESS_DAY. For implementation help, refer to eBay API documentation value: type: integer description: The integer value in this field, along with the time unit in the unit field, will indicate the fulfillment time.

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 4, and the value of the unit field is BUSINESS_DAY, 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. 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.account.readonly: View your account settings https://api.ebay.com/oauth/api_scope/sell.account: View and manage your account settings