eBay Inventory_item API
The Inventory_item API from eBay — 5 operation(s) for inventory_item.
eBay Inventory_item API is one of 64 APIs that eBay publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.
Tagged areas include Inventory_item. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, release notes, and an AsyncAPI specification.
This API exposes 7 operations across 5 paths, and defines 34 schemas. It is described by OpenAPI 3.0.0, at version v1.9.2.
Requests are made against a single base URL, https://api.ebay.com{basePath}.
7 operations
5 paths
34 schemas
1 DELETE2 GET3 POST1 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
eBay Inventory_item API declares
1 security scheme
for authenticating requests.
It supports OAuth 2.0 (api_auth) using the authorizationCode flow, exposing 2 scopes.
api_auth— The security definitions for this API. Please check individual operations for applicable scopes.
Paths & Operations 7
Across 5 paths, the API surfaces 7 operations — 1 DELETE, 2 GET, 3 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
Inventory_item 7
POST
/bulk_create_or_replace_inventory_item
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 da…
POST
/bulk_get_inventory_item
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…
POST
/bulk_update_price_quantity
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. U…
GET
/inventory_item/{sku}
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 r…
PUT
/inventory_item/{sku}
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 da…
DELETE
/inventory_item/{sku}
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: Dele…
GET
/inventory_item
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 pa…
Schemas 34
The contract defines 34 schemas that model the data the API accepts and returns. The most detailed are Product (12 properties), InventoryItemWithSkuLocaleGroupid (10 properties), Error (9 properties), InventoryItemWithSkuLocaleGroupKeys (9 properties). Each schema is shown below with its type and property counts.
GetInventoryItem
object
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.
1 property
Availability
object
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 th…
2 properties
InventoryItemWithSkuLocale
object
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 i…
8 properties
Weight
object
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…
2 properties
InventoryItemWithSkuLocaleGroupid
object
10 properties
PriceQuantity
object
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 specifi…
3 properties
BulkInventoryItem
object
The base request of the bulkCreateOrReplaceInventoryItem method.
1 property
BaseResponse
object
This is the base response of the createOrReplaceInventoryItem , createOrReplaceInventoryItemGroup , and createOrReplaceProductCompatibility calls. A response p…
1 property
FormatAllocation
object
This type is used to indicate the quantities of the inventory items that are reserved for the different listing formats of the SKU offers.
2 properties
PriceQuantityResponse
object
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 er…
5 properties
BulkGetInventoryItem
object
This type is used by the base request of the bulkGetInventoryItem method.
1 property
AvailabilityDistribution
object
This type is used to set the available quantity of the inventory item at one or more warehouse locations.
3 properties
ConditionDescriptor
object
This type is used by the seller to provide additional information about the condition of an item in a structured format.
3 properties
Amount
object
This type is used to express a dollar value and the applicable currency.
2 properties
InventoryItems
object
This type is used by the base response payload of getInventoryItems call.
7 properties
ShipToLocationAvailabilityWithAll
object
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.
3 properties
InventoryItemResponse
object
This type is used by the response of the bulkCreateOrReplaceInventoryItem method to indicate the success or failure of creating and/or updating each inventory…
5 properties
BulkGetInventoryItemResponse
object
This type is used by the base response of the bulkGetInventoryItem method.
1 property
BulkPriceQuantity
object
This type is used by the base request payload of the bulkUpdatePriceQuantity call. The bulkUpdatePriceQuantity call allows the seller to update the total 'ship…
1 property
Error
object
This type is used to express detailed information on errors and warnings that may occur with a call request.
9 properties
Product
object
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. O…
12 properties
Dimension
object
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 re…
4 properties
PickupAtLocationAvailability
object
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 (speci…
4 properties
PackageWeightAndSize
object
This type is used to indicate the package type, weight, and dimensions of the shipping package. Package weight and dimensions are required when calculated ship…
4 properties
BulkPriceQuantityResponse
object
This type is use by the base response payload of the bulkUpdatePriceQuantity call. The bulkUpdatePriceQuantity call response will return an HTTP status code, o…
1 property
BulkInventoryItemResponse
object
This type is used by the base response of the bulkCreateOrReplaceInventoryItem method.
1 property
InventoryItem
object
This type is used to provide detailed information about an inventory item.
6 properties
OfferPriceQuantity
object
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…
3 properties
ErrorParameter
object
This type is used to indicate the parameter field/value that caused an issue with the call request.
2 properties
InventoryItemWithSkuLocaleGroupKeys
object
This type is used to provide details about each retrieved inventory item record.
9 properties
AvailabilityWithAll
object
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…
2 properties
GetInventoryItemResponse
object
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.
5 properties
ShipToLocationAvailability
object
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.
2 properties
TimeDuration
object
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.
2 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from eBay 12
Other APIs eBay publishes across the network.
eBay Advertising_eligibility API
eBay Bidding API
eBay Category_tree API
eBay Charity_org API
eBay Config API
eBay Country API
eBay Custom_policy API
eBay Customer_service_metric API
eBay Customer_service_metric_task API
eBay Deal_item API
eBay Destination API
eBay Event API
#Inventory_item