Just getting started with the Inventory API? See the following documents for details on using this API:
The API release history
The following table lists the most recent releases for the Inventory API. For prior releases, refer to the Inventory API Release Notes Archive.
| Release Version | Release Date | Description of Release |
|---|---|---|
| Version 1.16.3 | 2023-05-24 |
Added support for:
Note: Energy Efficiency labeling and Global Custom Policies are currently available only on the German (DE) marketplace. Hazmat information is now available on the German (DE) marketplace. |
| Version 1.16.2 | 2023-01-23 | Added support for Hazmat and Repair Score information for items being sold on eBay. |
| Version 1.16.1 | 2022-11-14 | Updated picture limit |
| Version 1.16.0 | 2022-01-10 | Adds support for three new refurbished condition enumeration values. |
| Version 1.15.0 | 2021-12-15 | Adds support for the extended producer responsibility regulations and for custom policies including new and updated containers, types, error codes, and warnings. |
| Version 1.14.0 | 2021-07-20 | Added the field videoIds to the Product and InventoryItemGroup types to support the addition of videos to item listings. |
| Version 1.13.0 | 2021-04-21 | A new CERTIFIED_REFURBISHED ConditionEnum value has been added. This new value essentially replaces the existing MANUFACTURER_REFURBISHED enumeration value, which has been deprecated. |
| Version 1.12.0 | 2021-02-17 | Added support for auction listing capabilities, including new and updated types, and new error codes. |
| Version 1.11.1 | 2021-01-07 | Added 204 return status to updateOffer and corrected OfferResponse documentation, and other documentation updates. |
| Version 1.11.0 | 2020-09-30 | Added location-based inventory, scheduled listing, and private listing capabilities. |
Version 1.16.3
This release of the Inventory API adds support for Energy Efficiency labeling for durable goods and Global Custom Policies.
Note: Energy Efficiency labeling and Global Custom Policies are currently available only on the German (DE) marketplace.
Schema changes
The following new types have been added to the bulkCreateOffer, createOffer, getOffer, getOffers, and updateOffer methods:
- EnergyEfficiencyLabel: Provides information about the energy efficiency for certain durable goods.
- CountryPolicy: Specifies custom product compliance and/or take-back policies that apply to a specified country.
- RegionalProductCompliancePolicies: Lists regional product compliance policies to be used by an offer when it is published and converted to a listing.
- RegionalTakeBackPolicies: Lists regional take-back policies to be used by an offer when it is published and converted to a listing.
New error codes
The following new error codes have been added to the bulkPublishOffer, publishOffer, publishOfferByInventoryItemGroup, updateOffer methods:
- 25083: Energy efficiency image is missing. Image is required with image description.
- 25084: The listing must have both an energy efficiency label and a product information sheet.
- 25086: The URL provided must be an eBay Picture Service URL.
Announcements
Hazmat information is now available on the German (DE) marketplace.
Version 1.16.2
This release of the Inventory API adds support for Hazmat and Repair Score information for items being sold on eBay.
Schema changes
The following new types have been added to the bulkCreateOffer, createOffer, getOffer, getOffers, and updateOffer methods:
- Hazmat: Provides hazardous material information for a listing.
- Regulatory: Provides hazardous material related information and the repair score for a listing.
New error codes
The following new error codes have been added to the bulkPublishOffer, publishOffer, publishOfferByInventoryItemGroup, updateOffer methods:
- 25076: {replaceable_value} ID(s) {replaceable_value} not found. Please use valid ID(s).
- 25077: Duplicate Regulatory ID(s) {replaceable_value} sent in the request. Duplicate ID(s) have been ignored.
- 25078: Hazmat structure incorrect for {replaceable_value}.
- 25079: Repair score invalid. Repair score must be in the range from {replaceable_value} to {replaceable_value} with one decimal place.
- 25080: The value of the {0} field is invalid. Field must not exceed {replaceable_value} characters.
- 25081: Hazardous material information incomplete. Your listing must include pictograms, hazardous statements and a signal word.
Version 1.16.1
This release of the Inventory API updates the picture limit. With the exception of motor vehicle listings on the US and Canada marketplaces, sellers can now include up to 24 pictures in a listing free of charge in all categories on all marketplaces. The number of included pictures in motor vehicle listings depend on the selected vehicle package (refer to Fees for selling vehicles on eBay Motors).
Picture URLs for an item are specified in the imageUrls array of the createOrReplaceInventoryItem and bulkCreateOrReplaceInventoryItem methods.
Version 1.16.0
This release of the Inventory API adds three new refurbished condition enumeration values to the ConditionEnum type:
- EXCELLENT_REFURBISHED: This enumeration value should be used if the Condition ID value is
2010. - VERY_GOOD_REFURBISHED: This enumeration value should be used if the Condition ID value is
2020. - GOOD_REFURBISHED: This enumeration value should be used if the Condition ID value is
2030.
Note: These enumeration values and Condition IDs are available ONLY for Cell Phones and Smartphones (category ID 9355) in US, Canada, UK, Germany, and Australia marketplaces.
Version 1.15.0
This release of the Inventory API adds support for the extended producer responsibility regulations and for custom policies. These features are supported by a limited number of sites and specific categories. Use the getExtendedProducerResponsibilityPolicies method of the Sell Metadata API to return the enabled sites and categories.
Extended producer responsibility regulations supported
To support new extended producer responsibility regulations, IDs of the producer or importer related to the new item, packaging, added documentation, or an eco-participation fee can be specified in create or update offer calls.
Custom policies supported
Custom policy IDs that refer to the relevant policy created for compliance or for other purposes can be specified in create or update offer calls.
Schema changes
The following table contains the schema changes made with this release and their affected methods.
| Type | Change | Used By |
|---|---|---|
| ExtendedProducerResponsibility |
New type including fields:
|
|
| EbayOfferDetailsWithAll | Modified (added container): extendedProducerResponsibility |
|
| EbayOfferDetailsWithId | Modified (added container): extendedProducerResponsibility | updateOffer |
| EbayOfferDetailsWithKeys | Modified (added container): extendedProducerResponsibility |
|
| ListingPolicies |
Modified (added fields):
|
|
New Error Codes and Warnings
New error codes and warnings were added with this release to the bulkPublishOffer, publishOffer, publishOfferByInventoryItemGroup, and updateOffer methods. The following new error codes were added:
| Error Code | Error Message |
|---|---|
| 25029 | {field} is required for this category. |
| 25031 | {field} is not valid and needs to be a number between {min} and {max} |
| 25032 | {field} is not valid |
| 25034 | Only {max value} policies can be specified |
| 25035 | The specified policy is not found |
| 25036 | The policy(ies) {PolicyId} is not of type {PolicyEnum} |
| 25038 | {ItemId} cannot be revised if the item has a bid or a best offer or is ending within 12 hours |
| 25039 | {ItemId} cannot be revised if the item has a bid or a best offer and is ending within 12 hours |
| 25040 | {ItemId} cannot be revised if the item has a bid or a best offer and is ending within 12 hours |
The following new warnings were added:
| Warning Code | Warning Message |
|---|---|
| 25028 | {field} is not applicable and has been dropped |
| 25030 | {field} is not applicable for the condition and has been dropped |
| 25033 | Duplicate policy IDs found |
| 25037 | Item level Eco Participation Fee will be ignored |
Version 1.14.0
The following section details the updates that have been made for this release.
Support for adding videos to item listings
The field videoIds has been added to the Product type that is used by the bulkCreateOrReplaceInventoryItem, bulkGetInventoryItem, createOrReplaceInventoryItem, getInventoryItem, and getInventoryItems methods for the inventory_item resource, and the createOrReplaceInventoryItemGroup and getInventoryItemGroup methods for the inventory_item_group resource. This field contains an array of one or more videoId values for the product. A videoId is a unique identifier that is automatically created by eBay when a seller successfully uploads a video to eBay using the uploadVideo method of the Media API.
For information about supported marketplaces and platforms, as well as other requirements and limitations of video support, refer to Managing videos.
Version 1.13.0
The following sections detail the updates that have been made for this release.
CERTIFIED_REFURBISHED enum value replaces MANUFACTURER_REFURBISHED
A new CERTIFIED_REFURBISHED ConditionEnum value has been added. This CERTIFIED_REFURBISHED value has essentially replaced the MANUFACTURER_REFURBISHED value, which has been deprecated. The 'Manufacturer Refurbished' item condition is no longer a valid item condition on any eBay marketplace. 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.
Version 1.12.0
The following sections detail the updates that have been made for this release.
New Features
Auction listings are now supported by the Inventory API resource methods. In order to support this new feature, several schema changes were made in this release (refer to the Schema Changes section for details).
A new auction format has been added, and new fields were created to indicate the reserved inventory quantities that are allocated for both fixed-price and auction offer listings. When auction listing offers are published, the allocated quantity will be reserved for the specified listing duration. If the offer ends without a bid, the allocated quantity will be released and available for fixed-price offers and will remain GTC (Good 'til Canceled).
New error codes were also added in this release to address the new validations and business logic (refer to the New Error Codes section for details).
Schema Changes
The following schema elements were added and/or updated with this release:
| Type | Change | Used By |
|---|---|---|
| AvailabilityWithAll | New type |
|
| FormatAllocation | New type |
|
| FormatTypeEnum | New enum value added: AUCTION |
|
| ListingDurationEnum | Updated type: Auction listing offers now supported |
|
| PricingSummary |
New fields added:
|
|
| ShipToLocationAvailabilityWithAll | New type |
|
New Error Codes
The following new error codes were added with this release:
| Error Code | Error Message |
|---|---|
| 25752 | listingStartDate provided is invalid. |
| 25753 | listingStartDate is in the past or the offer is live. Value is not updated on the listing. |
| 25755 | listingDuration is required for auction offer. |
| 25756 | Auction format is not permitted with a SKU that is part of an InventoryItemGroup. |
| 25757 | auctionStartPrice is required for auction offer. |
| 25758 | auctionStartPrice and auctionReservePrice are not supported for fixed price offer. |
| 25760 | shipToLocationAvailability quantity insufficient to create auction listings. |
| 25761 | Discount pricing is not applicable for auction offer. |
| 25762 | availableQuantity is not applicable for auction offer. |
| 25763 | quantityLimitPerBuyer is not applicable for auction offer. |
| 25764 | eBayPlusIfEligible is not applicable for auction offer. |
Version 1.11.1
This release of the Inventory API includes changes to the documentation and other updates for the following resources:
updateOffer
- Added http status code of 204 Success. With a successful updateOffer call, an http status code of
204 Successis returned, and there is no response payload.
createOffer
- Removed 204 status code
createOrReplaceInventoryItem
- Added 25710 error code
OfferResponse
- Corrected OfferResponse type documentation. The offerId value is only returned with successful a createOffer call. This field will not be returned in the updateOffer response.
Version 1.11.0
The following sections detail the updates that have been made for this release.
New Features
The following features were added for this release.
Ability to set available quantity at specific warehouse locations
An availabilityDistributions array was added under the shipToLocationAvailability container in inventory_item resource methods to allow the seller to set available quantity at specific warehouse locations.
Scheduled listings now supported
A listingStartDate field was added to offer resource methods to allow the seller to set a 'scheduled listing' time. With scheduled listings, the seller can set the published offer to be become an active listing at a later date/time, and not become active as soon as the publishOffer method is used.
Private listings now supported
A hideBuyerDetailsfield was added to offer resource methods to allow the seller to create a private listing. With private listings, the user IDs of buyers/bidders are only shown to the seller of the listing, and not to any other eBay users.
Schema Changes
The following schema elements were added with this release:
| Type | Change | Used By |
|---|---|---|
| AvailabilityDistribution | New type | createOrReplaceInventoryItem, getInventoryItem, getInventoryItems, bulkCreateOrReplaceInventoryItem, bulkGetInventoryItem, bulkUpdatePriceQuantity |
| ShipToLocationAvailability | availabilityDistributions array added | createOrReplaceInventoryItem, getInventoryItem, getInventoryItems, bulkCreateOrReplaceInventoryItem, bulkGetInventoryItem, bulkUpdatePriceQuantity |
| EbayOfferDetailsWithKeys | listingStartDate and hideBuyerDetails fields added | createOffer, bulkCreateOffer |
| EbayOfferDetailsWithId | listingStartDate and hideBuyerDetails fields added | updateOffer |
| EbayOfferDetailsWithAll | listingStartDate and hideBuyerDetails fields added | getOffer, getOffers |
- secondaryCategoryId field was added to allow sellers to list an item under two categories. This field was added to three types: EbayOfferDetailsWithKeys, EbayOfferDetailsWithAll, and EbayOfferDetailsWithId