Skip to main content

  • Important: Due to EU & UK Payments regulatory requirements, an additional security verification via Digital Signatures is required for certain API calls that are made by EU/UK sellers. Please refer to Digital Signatures for APIs to learn more on the impacted APIs and the process to create signature to be included in the HTTP payload.

  • OpenAPI Specification - Version 2.0 for all of our RESTful APIs will no longer be available starting April 5, 2023. We will continue leveraging OpenAPI Specification - Version 3.0 for new features in our RESTful APIs.

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 NameHTTP MethodPathSummarySamples
bulkCreateOrReplaceInventoryItemPOST/bulk_create_or_replace_inventory_itemCreates or updates up to 25 inventory item records.View bulkCreateOrReplaceInventoryItem - /bulk_create_or_replace_inventory_item
bulkGetInventoryItemPOST/bulk_get_inventory_itemRetrieves up to 25 inventory item records.View bulkGetInventoryItem - /bulk_get_inventory_item
bulkUpdatePriceQuantityPOST/bulk_update_price_quantityUpdates 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
createOrReplaceInventoryItemPUT/inventory_item/{sku}Creates a new inventory item record or updates an existing inventory item record.View createOrReplaceInventoryItem - /inventory_item/{sku}
deleteInventoryItemDELETE/inventory_item/{sku}Deletes an inventory item record.View deleteInventoryItem - /inventory_item/{sku}
getInventoryItemGET/inventory_item/{sku}Retrieves the inventory item record.View getInventoryItem - /inventory_item/{sku}
getInventoryItemsGET/inventory_itemRetrieves all inventory item records defined for the seller's account.View getInventoryItems - /inventory_item

inventory_item:product_compatibility

Method NameHTTP MethodPathSummarySamples
createOrReplaceProductCompatibilityPUT/inventory_item/{sku}/product_compatibilityCreates or replaces a list of products that are compatible with the inventory item.View createOrReplaceProductCompatibility - /inventory_item/{sku}/product_compatibility
deleteProductCompatibilityDELETE/inventory_item/{sku}/product_compatibilityDeletes the list of products that are compatible with the inventory item.View deleteProductCompatibility - /inventory_item/{sku}/product_compatibility
getProductCompatibilityGET/inventory_item/{sku}/product_compatibilityRetrieves the list of products that are compatible with the inventory item.View getProductCompatibility - /inventory_item/{sku}/product_compatibility

inventory_item_group

Method NameHTTP MethodPathSummarySamples
createOrReplaceInventoryItemGroupPUT/inventory_item_group/{inventoryItemGroupKey}Creates a new inventory item group or updates an existing inventory item group.View createOrReplaceInventoryItemGroup - /inventory_item_group/{inventoryItemGroupKey}
deleteInventoryItemGroupDELETE/inventory_item_group/{inventoryItemGroupKey}Deletes the inventory item group.View deleteInventoryItemGroup - /inventory_item_group/{inventoryItemGroupKey}
getInventoryItemGroupGET/inventory_item_group/{inventoryItemGroupKey}Retrieves the inventory item group.View getInventoryItemGroup - /inventory_item_group/{inventoryItemGroupKey}

listing

Method NameHTTP MethodPathSummarySamples
bulkMigrateListingPOST/bulk_migrate_listingConverts existing eBay listings to the corresponding Inventory API objects.View bulkMigrateListing - /bulk_migrate_listing

offer

Method NameHTTP MethodPathSummarySamples
bulkCreateOfferPOST/bulk_create_offerCreates offers for up to 25 SKUs.View bulkCreateOffer - /bulk_create_offer
bulkPublishOfferPOST/bulk_publish_offerPublishes up to 25 unpublished offers.View bulkPublishOffer - /bulk_publish_offer
createOfferPOST/offerCreates an offer for a SKU.View createOffer - /offer
deleteOfferDELETE/offer/{offerId}Deletes a published or unpublished offer.View deleteOffer - /offer/{offerId}
getListingFeesPOST/offer/get_listing_feesRetrieves the expected listing fees for up to 250 unpublished offers.View getListingFees - /offer/get_listing_fees
getOfferGET/offer/{offerId}Retrieves an offer.View getOffer - /offer/{offerId}
getOffersGET/offerRetrieves existing offers for a SKU.View getOffers - /offer
publishOfferPOST/offer/{offerId}/publishPublishes an unpublished offer.View publishOffer - /offer/{offerId}/publish
publishOfferByInventoryItemGroupPOST/offer/publish_by_inventory_item_groupPublishes a multi-SKU offer.View publishOfferByInventoryItemGroup - /offer/publish_by_inventory_item_group
updateOfferPUT/offer/{offerId}Updates an offer.View updateOffer - /offer/{offerId}
withdrawOfferPOST/offer/{offerId}/withdrawEnds a single-SKU listing.View withdrawOffer - /offer/{offerId}/withdraw
withdrawOfferByInventoryItemGroupPOST/offer/withdraw_by_inventory_item_groupEnds a multi-SKU listing.View withdrawOfferByInventoryItemGroup - /offer/withdraw_by_inventory_item_group

location

Method NameHTTP MethodPathSummarySamples
createInventoryLocationPOST/location/{merchantLocationKey}Creates an inventory location.View createInventoryLocation - /location/{merchantLocationKey}
deleteInventoryLocationDELETE/location/{merchantLocationKey}Deletes an inventory location.View deleteInventoryLocation - /location/{merchantLocationKey}
disableInventoryLocationPOST/location/{merchantLocationKey}/disableDisables an inventory location.View disableInventoryLocation - /location/{merchantLocationKey}/disable
enableInventoryLocationPOST/location/{merchantLocationKey}/enableEnables a disabled inventory location.View enableInventoryLocation - /location/{merchantLocationKey}/enable
getInventoryLocationGET/location/{merchantLocationKey}Retrieves an inventory location.View getInventoryLocation - /location/{merchantLocationKey}
getInventoryLocationsGET/locationRetrieves all inventory location associated with a seller's account.View getInventoryLocations - /location
updateInventoryLocationPOST/location/{merchantLocationKey}/update_location_detailsUpdates non-physical location details for an inventory location.View updateInventoryLocation - /location/{merchantLocationKey}/update_location_details