The Inventory API is used to create and manage inventory, and then to publish and manage this inventory on an eBay marketplace. There are also methods in this API that will convert eligible, active eBay listings into the Inventory API model.
inventory_item
| Method Name | HTTP Method | Path | Summary | Samples |
|---|---|---|---|---|
| bulkCreateOrReplaceInventoryItem | POST | /bulk_create_or_replace_inventory_item | Creates or updates up to 25 inventory item records. | View bulkCreateOrReplaceInventoryItem - /bulk_create_or_replace_inventory_item |
| bulkGetInventoryItem | POST | /bulk_get_inventory_item | Retrieves up to 25 inventory item records. | View bulkGetInventoryItem - /bulk_get_inventory_item |
| bulkUpdatePriceQuantity | POST | /bulk_update_price_quantity | Updates the quantity of up to 25 inventory item records and/or quantity of active offers associated with the SKUs. | View bulkUpdatePriceQuantity - /bulk_update_price_quantity |
| createOrReplaceInventoryItem | PUT | /inventory_item/{sku} | Creates a new inventory item record or updates an existing inventory item record. | View createOrReplaceInventoryItem - /inventory_item/{sku} |
| deleteInventoryItem | DELETE | /inventory_item/{sku} | Deletes an inventory item record. | View deleteInventoryItem - /inventory_item/{sku} |
| getInventoryItem | GET | /inventory_item/{sku} | Retrieves the inventory item record. | View getInventoryItem - /inventory_item/{sku} |
| getInventoryItems | GET | /inventory_item | Retrieves all inventory item records defined for the seller's account. | View getInventoryItems - /inventory_item |
inventory_item:product_compatibility
| Method Name | HTTP Method | Path | Summary | Samples |
|---|---|---|---|---|
| createOrReplaceProductCompatibility | PUT | /inventory_item/{sku}/product_compatibility | Creates or replaces a list of products that are compatible with the inventory item. | View createOrReplaceProductCompatibility - /inventory_item/{sku}/product_compatibility |
| deleteProductCompatibility | DELETE | /inventory_item/{sku}/product_compatibility | Deletes the list of products that are compatible with the inventory item. | View deleteProductCompatibility - /inventory_item/{sku}/product_compatibility |
| getProductCompatibility | GET | /inventory_item/{sku}/product_compatibility | Retrieves the list of products that are compatible with the inventory item. | View getProductCompatibility - /inventory_item/{sku}/product_compatibility |
inventory_item_group
| Method Name | HTTP Method | Path | Summary | Samples |
|---|---|---|---|---|
| createOrReplaceInventoryItemGroup | PUT | /inventory_item_group/{inventoryItemGroupKey} | Creates a new inventory item group or updates an existing inventory item group. | View createOrReplaceInventoryItemGroup - /inventory_item_group/{inventoryItemGroupKey} |
| deleteInventoryItemGroup | DELETE | /inventory_item_group/{inventoryItemGroupKey} | Deletes the inventory item group. | View deleteInventoryItemGroup - /inventory_item_group/{inventoryItemGroupKey} |
| getInventoryItemGroup | GET | /inventory_item_group/{inventoryItemGroupKey} | Retrieves the inventory item group. | View getInventoryItemGroup - /inventory_item_group/{inventoryItemGroupKey} |
listing
| Method Name | HTTP Method | Path | Summary | Samples |
|---|---|---|---|---|
| bulkMigrateListing | POST | /bulk_migrate_listing | Converts existing eBay listings to the corresponding Inventory API objects. | View bulkMigrateListing - /bulk_migrate_listing |
| createOrReplaceSkuLocationMapping | PUT | /listing/{listingId}/sku/{sku}/locations | Creates location mappings for a specified SKU within a listing. | View createOrReplaceSkuLocationMapping - /listing/{listingId}/sku/{sku}/locations |
| deleteSkuLocationMapping | DELETE | /listing/{listingId}/sku/{sku}/locations | Deletes the location mappings from a specific SKU within a listing. | View deleteSkuLocationMapping - /listing/{listingId}/sku/{sku}/locations |
| getSkuLocationMapping | GET | /listing/{listingId}/sku/{sku}/locations | Retrieves all location mappings for a specific SKU within a listing. | View getSkuLocationMapping - /listing/{listingId}/sku/{sku}/locations |
offer
| Method Name | HTTP Method | Path | Summary | Samples |
|---|---|---|---|---|
| bulkCreateOffer | POST | /bulk_create_offer | Creates offers for up to 25 SKUs. | View bulkCreateOffer - /bulk_create_offer |
| bulkPublishOffer | POST | /bulk_publish_offer | Publishes up to 25 unpublished offers. | View bulkPublishOffer - /bulk_publish_offer |
| createOffer | POST | /offer | Creates an offer for a SKU. | View createOffer - /offer |
| deleteOffer | DELETE | /offer/{offerId} | Deletes a published or unpublished offer. | View deleteOffer - /offer/{offerId} |
| getListingFees | POST | /offer/get_listing_fees | Retrieves the expected listing fees for up to 250 unpublished offers. | View getListingFees - /offer/get_listing_fees |
| getOffer | GET | /offer/{offerId} | Retrieves an offer. | View getOffer - /offer/{offerId} |
| getOffers | GET | /offer | Retrieves existing offers for a SKU. | View getOffers - /offer |
| publishOffer | POST | /offer/{offerId}/publish | Publishes an unpublished offer. | View publishOffer - /offer/{offerId}/publish |
| publishOfferByInventoryItemGroup | POST | /offer/publish_by_inventory_item_group | Publishes a multi-SKU offer. | View publishOfferByInventoryItemGroup - /offer/publish_by_inventory_item_group |
| updateOffer | PUT | /offer/{offerId} | Updates an offer. | View updateOffer - /offer/{offerId} |
| withdrawOffer | POST | /offer/{offerId}/withdraw | Ends a single-SKU listing. | View withdrawOffer - /offer/{offerId}/withdraw |
| withdrawOfferByInventoryItemGroup | POST | /offer/withdraw_by_inventory_item_group | Ends a multi-SKU listing. | View withdrawOfferByInventoryItemGroup - /offer/withdraw_by_inventory_item_group |
location
| Method Name | HTTP Method | Path | Summary | Samples |
|---|---|---|---|---|
| createInventoryLocation | POST | /location/{merchantLocationKey} | Creates an inventory location. | View createInventoryLocation - /location/{merchantLocationKey} |
| deleteInventoryLocation | DELETE | /location/{merchantLocationKey} | Deletes an inventory location. | View deleteInventoryLocation - /location/{merchantLocationKey} |
| disableInventoryLocation | POST | /location/{merchantLocationKey}/disable | Disables an inventory location. | View disableInventoryLocation - /location/{merchantLocationKey}/disable |
| enableInventoryLocation | POST | /location/{merchantLocationKey}/enable | Enables a disabled inventory location. | View enableInventoryLocation - /location/{merchantLocationKey}/enable |
| getInventoryLocation | GET | /location/{merchantLocationKey} | Retrieves an inventory location. | View getInventoryLocation - /location/{merchantLocationKey} |
| getInventoryLocations | GET | /location | Retrieves all inventory location associated with a seller's account. | View getInventoryLocations - /location |
| updateInventoryLocation | POST | /location/{merchantLocationKey}/update_location_details | Updates non-physical location details for an inventory location. | View updateInventoryLocation - /location/{merchantLocationKey}/update_location_details |