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 on behalf of EU/UK seller. 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.

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_itemThis 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
bulkGetInventoryItemPOST/bulk_get_inventory_itemThis call is used by the seller to retrieve up to 25 inventory item records.View bulkGetInventoryItem - /bulk_get_inventory_item
bulkUpdatePriceQuantityPOST/bulk_update_price_quantityThis 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
createOrReplaceInventoryItemPUT/inventory_item/{sku}This call creates a new inventory item record or updates an existing inventory item record.View createOrReplaceInventoryItem - /inventory_item/{sku}
deleteInventoryItemDELETE/inventory_item/{sku}This call is used to delete an inventory item record associated with a specified SKU.View deleteInventoryItem - /inventory_item/{sku}
getInventoryItemGET/inventory_item/{sku}This call retrieves the inventory item record for a given SKU.View getInventoryItem - /inventory_item/{sku}
getInventoryItemsGET/inventory_itemThis call retrieves 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_compatibilityThis 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
deleteProductCompatibilityDELETE/inventory_item/{sku}/product_compatibilityThis 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
getProductCompatibilityGET/inventory_item/{sku}/product_compatibilityThis 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 NameHTTP MethodPathSummarySamples
createOrReplaceInventoryItemGroupPUT/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}
deleteInventoryItemGroupDELETE/inventory_item_group/{inventoryItemGroupKey}This call deletes the inventory item group for a given inventoryItemGroupKey value.View deleteInventoryItemGroup - /inventory_item_group/{inventoryItemGroupKey}
getInventoryItemGroupGET/inventory_item_group/{inventoryItemGroupKey}This call retrieves the inventory item group for a given inventoryItemGroupKey value.View getInventoryItemGroup - /inventory_item_group/{inventoryItemGroupKey}

listing

Method NameHTTP MethodPathSummarySamples
bulkMigrateListingPOST/bulk_migrate_listingThis call is used to convert existing eBay Listings to the corresponding Inventory API objects.View bulkMigrateListing - /bulk_migrate_listing

offer

Method NameHTTP MethodPathSummarySamples
bulkCreateOfferPOST/bulk_create_offerThis call creates multiple offers (up to 25) for specific inventory items on a specific eBay marketplace.View bulkCreateOffer - /bulk_create_offer
bulkPublishOfferPOST/bulk_publish_offerThis call is used to convert unpublished offers (up to 25) into published offers, or live eBay listings.View bulkPublishOffer - /bulk_publish_offer
createOfferPOST/offerThis call creates an offer for a specific product on a specific eBay marketplaceView createOffer - /offer
deleteOfferDELETE/offer/{offerId}This call deletes a specific published or unpublished offer.View deleteOffer - /offer/{offerId}
getListingFeesPOST/offer/get_listing_feesThis call is used to retrieve the expected listing fees for one to 250 unpublished offers.View getListingFees - /offer/get_listing_fees
getOfferGET/offer/{offerId}This call retrieves a specific offer.View getOffer - /offer/{offerId}
getOffersGET/offerThis call retrieves all existing offers for the specified SKU value.View getOffers - /offer
publishOfferPOST/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/
publishOfferByInventoryItemGroupPOST/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/
updateOfferPUT/offer/{offerId}This call updates an existing published or unpublished offer.View updateOffer - /offer/{offerId}
withdrawOfferPOST/offer/{offerId}/withdrawThis 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
withdrawOfferByInventoryItemGroupPOST/offer/withdraw_by_inventory_item_groupThis 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 NameHTTP MethodPathSummarySamples
createInventoryLocationPOST/location/{merchantLocationKey}This call is used to create a store or warehouse location for the associated seller.View createInventoryLocation - /location/{merchantLocationKey}
deleteInventoryLocationDELETE/location/{merchantLocationKey}This call is used to delete the specified inventory location from the seller's account.View deleteInventoryLocation - /location/{merchantLocationKey}
disableInventoryLocationPOST/location/{merchantLocationKey}/disableThis call is used to disable the specified inventory location.View disableInventoryLocation - /location/{merchantLocationKey}/disable
enableInventoryLocationPOST/location/{merchantLocationKey}/enableThis call is used to enable a disabled inventory location.View enableInventoryLocation - /location/{merchantLocationKey}/enable
getInventoryLocationGET/location/{merchantLocationKey}This call is used to retrieve the details of the specified inventory location.View getInventoryLocation - /location/{merchantLocationKey}
getInventoryLocationsGET/locationThis call is used to retrieve a list of inventory locations as defined by the seller.View getInventoryLocations - /location
updateInventoryLocationPOST/location/{merchantLocationKey}/update_location_detailsThis call is used to update the details of a specified inventory location.View updateInventoryLocation - /location/{merchantLocationKey}/update_location_details

custom_policy

Method NameHTTP MethodPathSummarySamples
createCustomPolicyPOST/custom_policy/Creates a custom Product Compliance or Takeback policy for the associated seller account.View createCustomPolicy - /custom_policy/
getCustomPoliciesGET/custom_policy/Retrieves all custom policies associated with the specified eBay marketplace and policy type(s).View getCustomPolicies - /custom_policy/
getCustomPolicyGET/custom_policy/{custom_policy_id}Retrieves a custom policy identified by policy ID for the selected eBay marketplace.View getCustomPolicy - /custom_policy/{custom_policy_id}
updateCustomPolicyPUT/custom_policy/{custom_policy_id}Updates details for an existing custom policy.View updateCustomPolicy - /custom_policy/{custom_policy_id}

fulfillment_policy

Method NameHTTP MethodPathSummarySamples
createFulfillmentPolicyPOST/fulfillment_policy/Creates a fulfillment policy for the associated seller account.View createFulfillmentPolicy - /fulfillment_policy/
deleteFulfillmentPolicyDELETE/fulfillment_policy/{fulfillmentPolicyId}Deletes a fulfillment policy from the associated seller account.View deleteFulfillmentPolicy - /fulfillment_policy/{fulfillmentPolicyId}
getFulfillmentPoliciesGET/fulfillment_policyRetrieves all the fulfillment policies associated with the specified marketplace.View getFulfillmentPolicies - /fulfillment_policy
getFulfillmentPolicyGET/fulfillment_policy/{fulfillmentPolicyId}Retrieves the fulfillment policy associated with the specified fulfillment policy ID.View getFulfillmentPolicy - /fulfillment_policy/{fulfillmentPolicyId}
getFulfillmentPolicyByNameGET/fulfillment_policy/get_by_policy_nameRetrieves the fulfillment policy associated with the specified fulfillment policy name.View getFulfillmentPolicyByName - /fulfillment_policy/get_by_policy_name
updateFulfillmentPolicyPUT/fulfillment_policy/{fulfillmentPolicyId}Updates the fulfillment policy associated with the specified fulfillment policy ID.View updateFulfillmentPolicy - /fulfillment_policy/{fulfillmentPolicyId}

payment_policy

Method NameHTTP MethodPathSummarySamples
createPaymentPolicyPOST/payment_policyCreates a payment policy for the associated seller account.View createPaymentPolicy - /payment_policy
deletePaymentPolicyDELETE/payment_policy/{payment_policy_id}Deletes a payment policy from the associated seller account.View deletePaymentPolicy - /payment_policy/{payment_policy_id}
getPaymentPoliciesGET/payment_policyRetrieves all the payment policies associated with the specified marketplace.View getPaymentPolicies - /payment_policy
getPaymentPolicyGET/payment_policy/{payment_policy_id}Retrieves the payment policy associated with the specified payment policy ID.View getPaymentPolicy - /payment_policy/{payment_policy_id}
getPaymentPolicyByNameGET/payment_policy/get_by_policy_nameRetrieves the payment policy associated with the specified payment policy name.View getPaymentPolicyByName - /payment_policy/get_by_policy_name
updatePaymentPolicyPUT/payment_policy/{payment_policy_id}Updates the payment policy associated with the specified payment policy ID.View updatePaymentPolicy - /payment_policy/{payment_policy_id}

payments_program

Method NameHTTP MethodPathSummarySamples
getPaymentsProgramGET/payments_program/{marketplace_id}/{payments_program_type}Returns the seller's status relating to the specified payments program.View getPaymentsProgram - /payments_program/{marketplace_id}/{payments_program_type}

payments_program:onboarding

Method NameHTTP MethodPathSummarySamples
getPaymentsProgramOnboardingGET/payments_program/{marketplace_id}/{payments_program_type}/onboardingView getPaymentsProgramOnboarding - /payments_program/{marketplace_id}/{payments_program_type}/onboarding

privilege

Method NameHTTP MethodPathSummarySamples
getPrivilegesGET/privilegeRetrieves a seller's account privileges (e.g., selling limits and registration status).View getPrivileges - /privilege

program

Method NameHTTP MethodPathSummarySamples
getOptedInProgramsGET/program/get_opted_in_programsRetrieves the eBay seller programs for which the seller has "opted-in."View getOptedInPrograms - /program/get_opted_in_programs
optInToProgramPOST/program/opt_inOpts the seller in to the specified eBay seller program.View optInToProgram - /program/opt_in
optOutOfProgramPOST/program/opt_outOpts the seller out of the specified eBay seller program.View optOutOfProgram - /program/opt_out

rate_table

Method NameHTTP MethodPathSummarySamples
getRateTablesGET/rate_tableReturns details about the shipping rate tables defined by the seller.View getRateTables - /rate_table

return_policy

Method NameHTTP MethodPathSummarySamples
createReturnPolicyPOST/return_policyCreates a seller's return policy for the specific marketplace.View createReturnPolicy - /return_policy
deleteReturnPolicyDELETE/return_policy/{return_policy_id}Deletes a return policy from the associated seller account.View deleteReturnPolicy - /return_policy/{return_policy_id}
getReturnPoliciesGET/return_policyRetrieves all the return policies associated with the specified marketplace.View getReturnPolicies - /return_policy
getReturnPolicyGET/return_policy/{return_policy_id}Retrieves the return policy associated with the specified return policy ID.View getReturnPolicy - /return_policy/{return_policy_id}
getReturnPolicyByNameGET/return_policy/get_by_policy_nameRetrieves the return policy associated with the specified return policy name.View getReturnPolicyByName - /return_policy/get_by_policy_name
updateReturnPolicyPUT/return_policy/{return_policy_id}Updates the return policy associated with the specified return policy ID.View updateReturnPolicy - /return_policy/{return_policy_id}

sales_tax

Method NameHTTP MethodPathSummarySamples
createOrReplaceSalesTaxPUT/sales_tax/{countryCode}/{jurisdictionId}This method creates or updates a sales tax table entry for the specified country and jurisdiction.View createOrReplaceSalesTax - /sales_tax/{countryCode}/{jurisdictionId}
deleteSalesTaxDELETE/sales_tax/{countryCode}/{jurisdictionId}This method deletes the sales tax table entry for the specified country and jurisdiction.View deleteSalesTax - /sales_tax/{countryCode}/{jurisdictionId}
getSalesTaxGET/sales_tax/{countryCode}/{jurisdictionId}This method retrieves the sales tax table entry for the specified country and jurisdiction.View getSalesTax - /sales_tax/{countryCode}/{jurisdictionId}
getSalesTaxesGET/sales_taxThis method retrieves the sales tax table for the specified country. The table is comprised of entries for the different jurisdictions in the country.View getSalesTaxes - /sales_tax

country

Method NameHTTP MethodPathSummarySamples
getSalesTaxJurisdictionsGET/country/{countryCode}/sales_tax_jurisdictionRetrieves sales tax jurisdictions for the countries with tax jurisdictions: CA and US.View getSalesTaxJurisdictions - /country/{countryCode}/sales_tax_jurisdiction