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 | This call is used by the seller to create and/or update up to 25 inventory item records. | View bulkCreateOrReplaceInventoryItem - /bulk_create_or_replace_inventory_item |
| bulkGetInventoryItem | POST | /bulk_get_inventory_item | This call is used by the seller to retrieve up to 25 inventory item records. | View bulkGetInventoryItem - /bulk_get_inventory_item |
| bulkUpdatePriceQuantity | POST | /bulk_update_price_quantity | This call is used by the seller to update the total ship-to-home quantity of an inventory item and/or to update the price and/or quantity of that same inventory item in an actual live offer. | View bulkUpdatePriceQuantity - /bulk_update_price_quantity |
| createOrReplaceInventoryItem | PUT | /inventory_item/{sku} | This call creates a new inventory item record or updates an existing inventory item record. | View createOrReplaceInventoryItem - /inventory_item/{sku} |
| deleteInventoryItem | DELETE | /inventory_item/{sku} | This call is used to delete an inventory item record associated with a specified SKU. | View deleteInventoryItem - /inventory_item/{sku} |
| getInventoryItem | GET | /inventory_item/{sku} | This call retrieves the inventory item record for a given SKU. | View getInventoryItem - /inventory_item/{sku} |
| getInventoryItems | GET | /inventory_item | This call 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 | This call is used by the seller to create or replace 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 | This call is used by the seller to delete 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 | This call is used by the seller to retrieve 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} | This call 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} | This call deletes the inventory item group for a given inventoryItemGroupKey value. | View deleteInventoryItemGroup - /inventory_item_group/{inventoryItemGroupKey} |
| getInventoryItemGroup | GET | /inventory_item_group/{inventoryItemGroupKey} | This call retrieves the inventory item group for a given inventoryItemGroupKey value. | View getInventoryItemGroup - /inventory_item_group/{inventoryItemGroupKey} |
listing
| Method Name | HTTP Method | Path | Summary | Samples |
|---|---|---|---|---|
| bulkMigrateListing | POST | /bulk_migrate_listing | This call is used to convert existing eBay Listings to the corresponding Inventory API objects. | View bulkMigrateListing - /bulk_migrate_listing |
offer
| Method Name | HTTP Method | Path | Summary | Samples |
|---|---|---|---|---|
| bulkCreateOffer | POST | /bulk_create_offer | This call creates multiple offers (up to 25) for specific inventory items on a specific eBay marketplace. | View bulkCreateOffer - /bulk_create_offer |
| bulkPublishOffer | POST | /bulk_publish_offer | This call is used to convert unpublished offers (up to 25) into published offers, or live eBay listings. | View bulkPublishOffer - /bulk_publish_offer |
| createOffer | POST | /offer | This call creates an offer for a specific product on a specific eBay marketplace | View createOffer - /offer |
| deleteOffer | DELETE | /offer/{offerId} | This call deletes a specific published or unpublished offer. | View deleteOffer - /offer/{offerId} |
| getListingFees | POST | /offer/get_listing_fees | This call is used to retrieve the expected listing fees for one to 250 unpublished offers. | View getListingFees - /offer/get_listing_fees |
| getOffer | GET | /offer/{offerId} | This call retrieves a specific offer. | View getOffer - /offer/{offerId} |
| getOffers | GET | /offer | This call retrieves all existing offers for the specified SKU value. | View getOffers - /offer |
| publishOffer | POST | /offer/{offerId}/publish/ | This call is used to convert an unpublished offer into a published offer, or live eBay listing. | View publishOffer - /offer/{offerId}/publish/ |
| publishOfferByInventoryItemGroup | POST | /offer/publish_by_inventory_item_group/ | This call is used to convert all unpublished offers associated with an inventory item group into a published offer. | View publishOfferByInventoryItemGroup - /offer/publish_by_inventory_item_group/ |
| updateOffer | PUT | /offer/{offerId} | This call updates an existing published or unpublished offer. | View updateOffer - /offer/{offerId} |
| withdrawOffer | POST | /offer/{offerId}/withdraw | This call is used to end the eBay listing that is associated with the specified offer, but will not delete the Offer object. | View withdrawOffer - /offer/{offerId}/withdraw |
| withdrawOfferByInventoryItemGroup | POST | /offer/withdraw_by_inventory_item_group | This call is used to end a multiple-variation eBay listing that is associated with the specified inventory item group. | View withdrawOfferByInventoryItemGroup - /offer/withdraw_by_inventory_item_group |
location
| Method Name | HTTP Method | Path | Summary | Samples |
|---|---|---|---|---|
| createInventoryLocation | POST | /location/{merchantLocationKey} | This call is used to create a store or warehouse location for the associated seller. | View createInventoryLocation - /location/{merchantLocationKey} |
| deleteInventoryLocation | DELETE | /location/{merchantLocationKey} | This call is used to delete the specified inventory location from the seller's account. | View deleteInventoryLocation - /location/{merchantLocationKey} |
| disableInventoryLocation | POST | /location/{merchantLocationKey}/disable | This call is used to disable the specified inventory location. | View disableInventoryLocation - /location/{merchantLocationKey}/disable |
| enableInventoryLocation | POST | /location/{merchantLocationKey}/enable | This call is used to enable a disabled inventory location. | View enableInventoryLocation - /location/{merchantLocationKey}/enable |
| getInventoryLocation | GET | /location/{merchantLocationKey} | This call is used to retrieve the details of the specified inventory location. | View getInventoryLocation - /location/{merchantLocationKey} |
| getInventoryLocations | GET | /location | This call is used to retrieve a list of inventory locations as defined by the seller. | View getInventoryLocations - /location |
| updateInventoryLocation | POST | /location/{merchantLocationKey}/update_location_details | This call is used to update the details of a specified inventory location. | View updateInventoryLocation - /location/{merchantLocationKey}/update_location_details |