Connectors
E-commerce
eBay
Online marketplace: listings, orders, inventory, and fulfillment management
eBay API referenceAPI checked August 18, 2026
- Signs in with
- API token
- Runs on
- Cloud or On-Prem Worker
- Operations
- 477
- Ready-made triggers
- 0
Connect eBay
- In Neblex open Connect › Connections and click New Connection.
- Search for eBay and give the connection a clear name.
- Fill in the fields. Secret values are encrypted and never shown again.
- Click Test, then Create Connection.
| Field | What to enter |
|---|---|
| OAuth access tokenRequiredSecret | Sealed application or user token; native Bearer is the sole Authorization transport.Example: v^1.1#... |
| Environment host infixOptional | Production default; Sandbox only on unanimously directory-enabled methods. |
| HTTP signature private key PEMOptionalSecret | Optional sealed PKCS#8 PEM; required by EU/UK signed variants.Example: PEM text |
| HTTP signature public-key JWEOptionalSecret | Optional sealed eBay public-key JWE; required by EU/UK signed variants.Example: eyJ... |
Use it in a flow
- Open a flow, open the node library and search for eBay.
- Drag it onto the canvas and choose an Operation and your connection.
- Map the operation's fields from earlier steps, or click Map with Matt.
- Use Test this step to see what it returns, then save.
To start a flow from eBay without a ready-made trigger: a Poll for changes trigger can check one of its list operations on a schedule and pass on only what is new; if eBay can send webhooks, a Webhook trigger receives them at its own URL.
Operations
477 operations in 38 groups. Each one is a step you can add to a flow.
Buy Browse7
Check CompatibilitycheckCompatibility | POST | This method checks if a product is compatible with the specified item. |
Get ItemgetItem | GET | This method retrieves the details of a specific item, such as description, price, category, all item aspects, condition, return policies, seller feedback and score, shipping options,... |
Get Item By Legacy IdgetItemByLegacyId | GET | This method is a bridge between the eBay legacy APIs and the eBay Buy APIs. |
Get ItemsgetItems | GET | This method retrieves the details about specific items that buyers need to make a purchasing decision. |
Get Items By Item GroupgetItemsByItemGroup | GET | This method retrieves details about individual items in an item group. |
Searchsearch | GET | This method searches for eBay items by various query parameters and retrieves summaries of the items. |
Search By ImagesearchByImage | POST | This method searches for eBay items based on a image and retrieves summaries of the items. |
Buy Buy Feed6
Download FiledownloadFile | GET | Use this method to download a selected feed file. |
Get Feed TypegetFeedType | GET | Use this method to obtain the details about a particular feed type to determine its applicability to your needs. |
Get Feed TypesgetFeedTypes | GET | Use this method to obtain the details about one or more feed types that are available to be downloaded. |
Retrieves detailed metadata on a specific feed file.getFile | GET | Use this method to fetch the details of a feed file available to download, as specified by the file's file id . |
Retrieves detailed metadata on one or more feed files based on search criteria.getFiles | GET | This method provides a list of the feed files available for download. |
Retrieves details of feed types and L1 categories accessible to the user.getAccess | GET | This method retrieves the access rules specific to the application; for example, the feed types to which the application has permissions. |
Buy Buy Marketing3
Get Merchandised ProductsgetMerchandisedProducts_2 | GET | This method returns an array of products based on the category and metric specified. |
Get Most Watched ItemsgetMostWatchedItems | GET | This method retrieves items with the highest watch counts in a specific category. |
Get Similar ItemsgetSimilarItems | GET | This method retrieves items that are similar to the specified item. |
Buy Deal4
Get details for ebay Event by event id.getEvent | GET | This method retrieves the details for an eBay event. |
This is for getting deal item.getDealItems | GET | This method retrieves a paginated set of deal items. |
This method returns a paginated set of event items.getEventItems | GET | This method returns a paginated set of event items. |
This method returns paginated results containing all eBay eventsgetEvents | GET | This method returns paginated results containing all eBay events for the specified marketplace. |
Buy Feed Beta4
Get Item FeedgetItemFeed | GET | This method lets you download a TSV GZIP (tab-separated value gzip) Item feed file. |
Get Item Group FeedgetItemGroupFeed | GET | This method lets you download a TSV GZIP (tab separated value gzip) Item Group feed file. |
Get Item Priority FeedgetItemPriorityFeed | GET | Using this method, you can download a TSV GZIP (tab separated value gzip) Item Priority feed file, which allows you to track changes (deltas) in the status of your priority items, such as... |
Get Item Snapshot FeedgetItemSnapshotFeed | GET | The Hourly Snapshot feed file is generated each hour every day for most categories. |
Buy Marketing Beta1
Get Merchandised ProductsgetMerchandisedProducts | GET | This method returns an array of products based on the category and metric specified. |
Buy Offer2
Get BiddinggetBidding | GET | This method retrieves the bidding details that are specific to the buyer of the specified auction. |
Place Proxy BidplaceProxyBid | POST | This method uses a user access token to place a proxy bid for the buyer on a specific auction item. |
Buy Order11
Apply CouponapplyCoupon | POST | |
Get Checkout SessiongetCheckoutSession | GET | This method returns the details of the specified eBay member checkout session. |
Get Purchase OrdergetPurchaseOrder | GET | This method retrieves the details about a specific eBay member purchase order. |
Initiate Checkout SessioninitiateCheckoutSession | POST | This method creates an eBay member checkout session, which is the first step in performing a checkout. |
Place OrderplaceOrder | POST | This method creates the purchase order, pays for the items, and terminates the specified eBay member checkout session. |
Remove CouponremoveCoupon | POST | (Limited Release) You must be whitelisted to use this method. |
Update Addon Services StatusupdateAddonServicesStatus | POST | This method changes the selection of add-on services for one line item for the checkout session. |
Update Payment InfoupdatePaymentInfo | POST | |
Update QuantityupdateQuantity_2 | POST | This method changes the quantity of the specified line item in an eBay member checkout session. |
Update Shipping AddressupdateShippingAddress | POST | This method changes the shipping address for in an eBay member checkout session. |
Update Shipping OptionupdateShippingOption | POST | This method changes the shipping method for the specified line item in an eBay member checkout session. |
Buy Order V28
Apply Guest CouponapplyGuestCoupon | POST | Note: The Order V2 API supports guest checkout payment flows. |
Get Guest Checkout SessiongetGuestCheckoutSession | GET | Note: The Order V2 API supports guest checkout payment flows. |
Get Guest Purchase OrdergetGuestPurchaseOrder | GET | Note: The Order V2 API supports guest checkout payment flows. |
Initiate Guest Checkout SessioninitiateGuestCheckoutSession | POST | Note: The Order V2 API supports guest checkout payment flows. |
Remove Guest CouponremoveGuestCoupon | POST | Note: The Order V2 API supports guest checkout payment flows. |
Update Guest QuantityupdateGuestQuantity | POST | Note: The Order V2 API supports guest checkout payment flows. |
Update Guest Shipping AddressupdateGuestShippingAddress | POST | Note: The Order V2 API supports guest checkout payment flows. |
Update Guest Shipping OptionupdateGuestShippingOption | POST | Note: The Order V2 API supports guest checkout payment flows. |
Sell Account37
Bulk Create Or Replace Sales TaxbulkCreateOrReplaceSalesTax | POST | This method creates or updates multiple sales-tax table entries. |
Create Custom PolicycreateCustomPolicy | POST | This method creates a new custom policy that specifies the seller's terms for complying with local governmental regulations. |
Create Fulfillment PolicycreateFulfillmentPolicy | POST | This method creates a new fulfillment policy for an eBay marketplace where the policy encapsulates seller's terms for fulfilling item purchases. |
Create Or Replace Sales TaxcreateOrReplaceSalesTax | PUT | This method creates or updates a sales-tax table entry for a jurisdiction. |
Create Payment PolicycreatePaymentPolicy | POST | This method creates a new payment policy where the policy encapsulates seller's terms for order payments. |
Create Return PolicycreateReturnPolicy | POST | This method creates a new return policy where the policy encapsulates seller's terms for returning items. |
Delete Fulfillment PolicydeleteFulfillmentPolicy | DELETE | This method deletes a fulfillment policy. |
Delete Payment PolicydeletePaymentPolicy | DELETE | This method deletes a payment policy. |
Delete Return PolicydeleteReturnPolicy | DELETE | This method deletes a return policy. |
Delete Sales TaxdeleteSalesTax | DELETE | This call deletes a sales-tax table entry for a jurisdiction. |
Get Advertising EligibilitygetAdvertisingEligibility | GET | This method allows developers to check the seller eligibility status for eBay advertising programs. |
Get Custom PoliciesgetCustomPolicies | GET | This method retrieves the list of custom policies defined for a seller's account. |
Get Custom PolicygetCustomPolicy | GET | This method retrieves the custom policy specified by the custom policy id path parameter. |
Get Fulfillment PoliciesgetFulfillmentPolicies | GET | This method retrieves all the fulfillment policies configured for the marketplace you specify using the marketplace id query parameter. |
Get Fulfillment PolicygetFulfillmentPolicy | GET | This method retrieves the complete details of a fulfillment policy. |
Get Fulfillment Policy By NamegetFulfillmentPolicyByName | GET | This method retrieves the details for a specific fulfillment policy. |
Get K Y CgetKYC | GET | Note: This method was originally created to see which onboarding requirements were still pending for sellers being onboarded for eBay managed payments, but now that all seller accounts... |
Get Opted In ProgramsgetOptedInPrograms | GET | This method gets a list of the seller programs that the seller has opted-in to. |
Get Payment PoliciesgetPaymentPolicies | GET | This method retrieves all the payment business policies configured for the marketplace you specify using the marketplace id query parameter. |
Get Payment PolicygetPaymentPolicy | GET | This method retrieves the complete details of a payment policy. |
Get Payment Policy By NamegetPaymentPolicyByName | GET | This method retrieves the details of a specific payment policy. |
Get Payments ProgramgetPaymentsProgram | GET | Note: This method is no longer applicable, as all seller accounts globally have been enabled for the new eBay payment and checkout flow. |
Get Payments Program OnboardinggetPaymentsProgramOnboarding | GET | Note: This method is no longer applicable, as all seller accounts globally have been enabled for the new eBay payment and checkout flow. |
Get PrivilegesgetPrivileges | GET | This method retrieves the seller's current set of privileges, including whether or not the seller's eBay registration has been completed, as well as the details of their site-wide... |
Get Rate TablesgetRateTables | GET | This method retrieves a seller's shipping rate tables for the country specified in the country code query parameter. |
Get Return PoliciesgetReturnPolicies | GET | This method retrieves all the return policies configured for the marketplace you specify using the marketplace id query parameter. |
Get Return PolicygetReturnPolicy | GET | This method retrieves the complete details of the return policy specified by the returnPolicyId path parameter. |
Get Return Policy By NamegetReturnPolicyByName | GET | This method retrieves the details of a specific return policy. |
Get Sales TaxgetSalesTax | GET | This call retrieves the current sales-tax table entry for a specific tax jurisdiction. |
Get Sales TaxesgetSalesTaxes | GET | Use this call to retrieve all sales tax table entries that the seller has defined for a specific country. |
Get SubscriptiongetSubscription | GET | This method retrieves a list of subscriptions associated with the seller account. |
Opt In To ProgramoptInToProgram | POST | This method opts the seller in to an eBay seller program. |
Opt Out Of ProgramoptOutOfProgram | POST | This method opts the seller out of a seller program in which they are currently opted in to. |
Update Custom PolicyupdateCustomPolicy | PUT | This method updates an existing custom policy specified by the custom policy id path parameter. |
Update Fulfillment PolicyupdateFulfillmentPolicy | PUT | This method updates an existing fulfillment policy. |
Update Payment PolicyupdatePaymentPolicy | PUT | This method updates an existing payment policy. |
Update Return PolicyupdateReturnPolicy | PUT | This method updates an existing return policy. |
Sell Account V214
Creates calculated shipping rules that determine combined shipping costs based on item attributes, such as weight and dimensions, for the seller's account.createCalculatedShippingRules | POST | This method creates or registers calculated shipping rules that determine combined shipping costs based on weight, item count, or cost parameters for an authenticated seller. |
Creates flat-rate rules that apply standard combined shipping costs for a seller's listings.createFlatShippingRules | POST | This method is used to create fixed-rate (flat) shipping rules that apply standard combined shipping costs for a seller’s listings. |
Creates promotional shipping rules, such as discounts or free-shipping thresholds.createPromotionalShippingRule | POST | This method defines promotional shipping rules such as discounts or free-shipping thresholds, configurable by marketplace for the seller. |
Modifies one or more preferences for a seller on a specific marketplace.setUserPreferences | PATCH | This method is used to modify one or more preferences for a seller on a specific marketplace. |
Retrieves all combined shipping rule configurations defined for the seller.getCombinedShippingRules | GET | This method retrieves all existing combined shipping rule configurations defined by the authenticated seller, including calculated, flat, and promotional types. |
Retrieves details of a specific shipping rate table.getRateTable | GET | This method retrieves an existing rate table identified by the rate table id path parameter. |
Retrieves payout percentages and unique IDs for accounts configured to receive seller payouts.getPayoutSettings | GET | |
Retrieves the seller's preferences for a specific eBay marketplace.getUserPreferences | GET | This method retrieves the seller's preferences for a specific eBay marketplace, such as combined payment preferences, same-day shipping cutoff time, excluded shipping locations, and... |
Updates a promotional shipping rule to adjust discount thresholds, eligibility criteria, or duration for the seller.updatePromotionalShippingRule | POST | This method updates an existing promotional shipping rule to adjust discount thresholds, eligibility criteria, or duration for the seller. |
Updates combined payment settings that determine how unpaid orders can be merged.updateCombinedPayments | POST | This method configures or modifies combined payment settings that determine how unpaid orders can be merged for a single invoice within a defined duration for the seller. |
Updates existing flat-rate shipping rules.updateFlatShippingRules | POST | This method updates existing shipping rules. |
Updates one or more shipping rates for a specific shipping rate table.updateShippingCost | POST | This method allows sellers to update shippingCost and/or additionalCost information for an existing shipping rate table identified by the rate table id path parameter. |
Updates previously defined calculated shipping rules.updateCalculatedShippingRules | POST | This method updates previously defined calculated shipping rules to modify discount percentages, weight offsets, or amount parameters for the seller. |
Updates the split-payout percentage for two payout instruments for sellers in mainland China.updatePayoutPercentage | POST |
Sell Analytics4
Find Seller Standards ProfilesfindSellerStandardsProfiles | GET | This call retrieves all the standards profiles for the associated seller. |
Get Seller Standards ProfilegetSellerStandardsProfile | GET | This call retrieves a single standards profile for the associated seller. |
Get Traffic ReportgetTrafficReport | GET | This method returns a report that details the user traffic received by a seller's listings. |
Retrieves the seller's customer service performance for the specified metric type and eBay marketplace.getCustomerServiceMetric | GET | Use this method to retrieve a seller's performance and rating for the customer service metric. |
Sell Catalog2
Get ProductgetProduct | GET | This method retrieves details of the catalog product identified by the eBay product identifier (ePID) specified in the request. |
Searchsearch_2 | GET | This method searches for and retrieves summaries of one or more products in the eBay catalog that match the search criteria provided by a seller. |
Sell Charity2
Get Charity OrggetCharityOrg | GET | This call is used to retrieve detailed information about supported charitable organizations. |
Get Charity OrgsgetCharityOrgs | GET | This call is used to search for supported charitable organizations. |
Sell Developer Analytics2
Retrieves call limit and utilization data for a user based on search criteria.getUserRateLimits | GET | This method retrieves the call limit and utilization data for an application user. |
Retrieves call limit and utilization data for an application based on search criteria.getRateLimits | GET | This method retrieves the call limit and utilization data for an application. |
Sell Edelivery International Shipping28
Bulk Cancel PackagesbulkCancelPackages | POST | |
Bulk Confirm PackagesbulkConfirmPackages | POST | |
Bulk Delete PackagesbulkDeletePackages | POST | |
Cancel BundlecancelBundle | POST | |
Cancel PackagecancelPackage | POST | |
Clone PackageclonePackage | POST | |
Confirm PackageconfirmPackage | POST | |
Create Address PreferencecreateAddressPreference | POST | |
Create BundlecreateBundle | POST | |
Create ComplaintcreateComplaint | POST | |
Create Consign PreferencecreateConsignPreference | POST | |
Create PackagecreatePackage | POST | |
Delete PackagedeletePackage | DELETE | |
Get Actual CostsgetActualCosts | GET | |
Get Address PreferencesgetAddressPreferences | GET | |
Get AgentsgetAgents | GET | |
Get Battery QualificationsgetBatteryQualifications | GET | |
Get BundlegetBundle | GET | |
Get Bundle LabelgetBundleLabel | GET | |
Get Consign PreferencesgetConsignPreferences | GET | |
Get Cpsc ProfilesgetCpscProfiles | GET | |
Get Dropoff SitesgetDropoffSites | GET | |
Get Handover SheetgetHandoverSheet | GET | |
Get LabelsgetLabels | GET | |
Get PackagegetPackage | GET | |
Get Packages By Line Item I DgetPackagesByLineItemID | GET | |
Get ServicesgetServices | GET | |
Get TrackinggetTracking | GET |
Sell Feed23
Create Customer Service Metric TaskcreateCustomerServiceMetricTask | POST | Use this method to create a customer service metrics download task with filter criteria for the customer service metrics report. |
Create Inventory TaskcreateInventoryTask | POST | This method creates an inventory-related download task for a specified feed type with optional filter criteria. |
Create Order TaskcreateOrderTask | POST | This method creates an order download task with filter criteria for the order report. |
Create SchedulecreateSchedule | POST | This method creates a schedule, which is a subscription to the specified schedule template. |
Create TaskcreateTask | POST | This method creates an upload task or a download task without filter criteria. |
Delete ScheduledeleteSchedule | DELETE | This method deletes an existing schedule. |
Get Customer Service Metric TaskgetCustomerServiceMetricTask | GET | Use this method to retrieve customer service metric task details for the specified task. |
Get Customer Service Metric TasksgetCustomerServiceMetricTasks | GET | Use this method to return an array of customer service metric tasks. |
Get Input FilegetInputFile | GET | This method downloads a file previously uploaded using uploadFile . |
Get Inventory TaskgetInventoryTask | GET | This method retrieves the task details and status of the specified inventory-related task. |
Get Inventory TasksgetInventoryTasks | GET | This method searches for multiple tasks of a specific feed type and includes date filters and pagination. |
Get Latest Result FilegetLatestResultFile | GET | This method downloads the latest Order Report generated by the schedule. |
Get Order TaskgetOrderTask | GET | This method retrieves the task details and status of the specified task. |
Get Order TasksgetOrderTasks | GET | This method returns the details and status for an array of order tasks. |
Get Result FilegetResultFile | GET | This method retrieves the generated file that is associated with the specified task ID. |
Get SchedulegetSchedule | GET | This method retrieves schedule details and status of the specified schedule. |
Get Schedule TemplategetScheduleTemplate | GET | This method retrieves the details of the specified template. |
Get Schedule TemplatesgetScheduleTemplates | GET | This method retrieves an array containing the details and status of all schedule templates based on the specified feed type . |
Get SchedulesgetSchedules | GET | This method retrieves an array containing the details and status of all schedules based on the specified feed type . |
Get TaskgetTask | GET | This method retrieves the details and status of the specified task. |
Get TasksgetTasks | GET | This method returns the details and status for an array of tasks based on a specified feed type or schedule id . |
Update ScheduleupdateSchedule | PUT | This method updates an existing schedule. |
Upload FileuploadFile | POST | This method associates the specified file with the specified task ID and uploads the input file. |
Sell Feedback5
Get FeedbackgetFeedback | GET | This method enables users to retrieve feedback for any specified user ID and feedback type (sent or received). |
Get Feedback Rating SummarygetFeedbackRatingSummary | GET | This method provides a detailed overview of feedback ratings associated with a user in the eBay marketplace. |
Get Items Awaiting FeedbackgetItemsAwaitingFeedback | GET | This method retrieves line items awaiting feedback from the user's order partner. |
Leave FeedbackleaveFeedback | POST | This method creates and submits feedback to the user's order partner for a line item in the order. |
Respond To FeedbackrespondToFeedback | POST | This method allows users to respond to feedback provided by the order partner for a specific line item in an order. |
Sell Finances26
Get Billing ActivitiesgetBillingActivities | GET | |
Get Billing Activities (EU/UK signed)getBillingActivities__eu_uk_signed | GET | |
Get Order EarningsgetOrderEarnings | GET | This method returns detailed order-level financial data for each order associated with a seller account. |
Get Order Earnings (EU/UK signed)getOrderEarnings__eu_uk_signed | GET | This method returns detailed order-level financial data for each order associated with a seller account. |
Get Order Earnings By IdgetOrderEarningsById | GET | This method returns detailed order-level financial data including order earnings, gross amount, expenses, and refunds. |
Get Order Earnings By Id (EU/UK signed)getOrderEarningsById__eu_uk_signed | GET | This method returns detailed order-level financial data including order earnings, gross amount, expenses, and refunds. |
Get Order Earnings SummarygetOrderEarningsSummary | GET | This method returns a summarized view of order earnings information for one or more orders associated with a seller account. |
Get Order Earnings Summary (EU/UK signed)getOrderEarningsSummary__eu_uk_signed | GET | This method returns a summarized view of order earnings information for one or more orders associated with a seller account. |
Get PayoutgetPayout | GET | |
Get PayoutgetPayout_2 | GET | This method retrieves details on a specific seller payout. |
Get Payout (EU/UK signed)getPayout_2__eu_uk_signed | GET | This method retrieves details on a specific seller payout. |
Get Payout (EU/UK signed)getPayout__eu_uk_signed | GET | |
Get Payout SummarygetPayoutSummary | GET | |
Get Payout Summary (EU/UK signed)getPayoutSummary__eu_uk_signed | GET | |
Get PayoutsgetPayouts | GET | |
Get Payouts (EU/UK signed)getPayouts__eu_uk_signed | GET | |
Get Seller Funds SummarygetSellerFundsSummary | GET | |
Get Seller Funds Summary (EU/UK signed)getSellerFundsSummary__eu_uk_signed | GET | |
Get Transaction SummarygetTransactionSummary | GET | |
Get Transaction Summary (EU/UK signed)getTransactionSummary__eu_uk_signed | GET | |
Get TransactionsgetTransactions | GET | |
Get Transactions (EU/UK signed)getTransactions__eu_uk_signed | GET | |
Get TransfergetTransfer | GET | |
Get TransfergetTransfer_2 | GET | This method retrieves detailed information regarding a TRANSFER transaction type. |
Get Transfer (EU/UK signed)getTransfer_2__eu_uk_signed | GET | This method retrieves detailed information regarding a TRANSFER transaction type. |
Get Transfer (EU/UK signed)getTransfer__eu_uk_signed | GET |
Sell Fulfillment16
Accept Payment DisputeacceptPaymentDispute | POST | This method is used if the seller wishes to accept a payment dispute. |
Add an Evidence FileaddEvidence | POST | This method is used by the seller to add one or more evidence files to address a payment dispute initiated by the buyer. |
Contest Payment DisputecontestPaymentDispute | POST | This method is used if the seller wishes to contest a payment dispute initiated by the buyer. |
Create Shipping FulfillmentcreateShippingFulfillment | POST | When you group an order's line items into one or more packages, each package requires a corresponding plan for handling, addressing, and shipping; this is shipping fulfillment . |
Get OrdergetOrder | GET | Use this call to retrieve the contents of an order based on its unique identifier, orderId . |
Get OrdersgetOrders | GET | Use this method to search for and retrieve one or more orders based on their creation date, last modification date, or fulfillment status using the filter parameter. |
Get Payment Dispute ActivitygetActivities | GET | This method retrieves the activity log for a payment dispute. |
Get Payment Dispute DetailsgetPaymentDispute | GET | This method retrieves detailed information on a specific payment dispute. |
Get Payment Dispute Evidence FilefetchEvidenceContent | GET | This call retrieves a specific evidence file for a payment dispute. |
Get Shipping FulfillmentgetShippingFulfillment | GET | Use this call to retrieve the contents of a fulfillment based on its unique identifier, fulfillmentId (combined with the associated order's orderId ). |
Get Shipping FulfillmentsgetShippingFulfillments | GET | Use this call to retrieve the contents of all fulfillments currently defined for a specified order based on the order's unique identifier, orderId . |
Issues a full or partial refund to a buyer on behalf of the seller.issueRefund | POST | This method allows a seller to issue a full or partial refund to a buyer for an order. |
Issues a full or partial refund to a buyer on behalf of the seller. (EU/UK signed)issueRefund__eu_uk_signed | POST | This method allows a seller to issue a full or partial refund to a buyer for an order. |
Search Payment Dispute by FiltersgetPaymentDisputeSummaries | GET | This method is used retrieve one or more payment disputes filed against the seller. |
Update evidenceupdateEvidence | POST | This method is used by the seller to update an existing evidence set for a payment dispute with one or more evidence files. |
Upload an Evidence FileuploadEvidenceFile | POST | This method is used to upload an evidence file for a contested payment dispute. |
Sell Identity1
Get UsergetUser | GET | This method retrieves the account profile information for an authenticated user, which requires a User access token . |
Sell Inventory36
Bulk Create OfferbulkCreateOffer | POST | This call creates multiple offers (up to 25) for specific inventory items on a specific eBay marketplace. |
Bulk Create Or Replace Inventory ItembulkCreateOrReplaceInventoryItem | POST | Note: Please note that any eBay listing created using the Inventory API cannot be revised or relisted using the Trading API calls. |
Bulk Get Inventory ItembulkGetInventoryItem | POST | This call retrieves up to 25 inventory item records. |
Bulk Migrate ListingbulkMigrateListing | POST | This call is used to convert existing eBay Listings to the corresponding Inventory API objects. |
Bulk Publish OfferbulkPublishOffer | POST | Note: Each listing can be revised up to 250 times in one calendar day. |
Bulk Update Price QuantitybulkUpdatePriceQuantity | POST | 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... |
Create Inventory LocationcreateInventoryLocation | POST | Use this call to create a new inventory location. |
Create OffercreateOffer | POST | This call creates an offer for a specific inventory item on a specific eBay marketplace. |
Create Or Replace Inventory ItemcreateOrReplaceInventoryItem | PUT | Note: Please note that any eBay listing created using the Inventory API cannot be revised or relisted using the Trading API calls. |
Create Or Replace Inventory Item GroupcreateOrReplaceInventoryItemGroup | PUT | Note: Each listing can be revised up to 250 times in one calendar day. |
Create Or Replace Product CompatibilitycreateOrReplaceProductCompatibility | PUT | This call is used by the seller to create or replace a list of products that are compatible with the inventory item. |
Create Or Replace Sku Location MappingcreateOrReplaceSkuLocationMapping | PUT | This method allows sellers to map multiple fulfillment center locations to single-SKU listing, or to a single SKU within a multiple-variation listing. |
Delete Inventory ItemdeleteInventoryItem | DELETE | This call is used to delete an inventory item record associated with a specified SKU. |
Delete Inventory Item GroupdeleteInventoryItemGroup | DELETE | This call deletes the inventory item group for a given inventoryItemGroupKey value. |
Delete Inventory LocationdeleteInventoryLocation | DELETE | This call deletes the inventory location that is specified in the merchantLocationKey path parameter. |
Delete OfferdeleteOffer | DELETE | If used against an unpublished offer, this call will permanently delete that offer. |
Delete Product CompatibilitydeleteProductCompatibility | DELETE | This call is used by the seller to delete the list of products that are compatible with the inventory item that is associated with the compatible product list. |
Delete Sku Location MappingdeleteSkuLocationMapping | DELETE | This method allows sellers to remove all location mappings associated with a specific SKU within a listing. |
Disable Inventory LocationdisableInventoryLocation | POST | This call disables the inventory location that is specified in the merchantLocationKey path parameter. |
Enable Inventory LocationenableInventoryLocation | POST | This call enables a disabled inventory location that is specified in the merchantLocationKey path parameter. |
Get Inventory ItemgetInventoryItem | GET | This call retrieves the inventory item record for a given SKU. |
Get Inventory Item GroupgetInventoryItemGroup | GET | This call retrieves the inventory item group for a given inventoryItemGroupKey value. |
Get Inventory ItemsgetInventoryItems | GET | This call retrieves all inventory item records defined for the seller's account. |
Get Inventory LocationgetInventoryLocation | GET | This call retrieves all defined details of the inventory location that is specified by the merchantLocationKey path parameter. |
Get Inventory LocationsgetInventoryLocations | GET | This call retrieves all defined details for every inventory location associated with the seller's account. |
Get Listing FeesgetListingFees | POST | This call is used to retrieve the expected listing fees for up to 250 unpublished offers. |
Get OffergetOffer | GET | This call retrieves a specific published or unpublished offer. |
Get OffersgetOffers | GET | This call retrieves all existing offers for the specified SKU value. |
Get Product CompatibilitygetProductCompatibility | GET | This call is used by the seller to retrieve the list of products that are compatible with the inventory item. |
Get Sku Location MappinggetSkuLocationMapping | GET | This method allows sellers to retrieve the locations mapped to a specific SKU within a listing. |
Publish OfferpublishOffer | POST | Note: Each listing can be revised up to 250 times in one calendar day. |
Publish Offer By Inventory Item GrouppublishOfferByInventoryItemGroup | POST | Note: Please note that any eBay listing created using the Inventory API cannot be revised or relisted using the Trading API calls. |
Update Inventory LocationupdateInventoryLocation | POST | Use this call to update location details for an existing inventory location. |
Update OfferupdateOffer | PUT | This call updates an existing offer. |
Withdraw OfferwithdrawOffer | POST | This call is used to end a single-variation listing that is associated with the specified offer. |
Withdraw Offer By Inventory Item GroupwithdrawOfferByInventoryItemGroup | POST | This call is used to end a multiple-variation eBay listing that is associated with the specified inventory item group. |
Sell Key Management3
Creates keypairs using the selected cipher.createSigningKey | POST | This method creates keypairs using one of the following ciphers: ED25519 (Edwards Curve) RSA Note: The recommended signature cipher is ED25519 (Edwards Curve) since it uses much shorter... |
Retrieve keypairs and metadata for all keypairs associated with the application key making the call.getSigningKeys | GET | This method returns the Public Key , Public Key as JWE , and metadata for all keypairs associated with the application key making the call. |
Retrieves a specific keypair and metadata for a specified signing key ID associated with the application key making the call.getSigningKey | GET | This method returns the Public Key , Public Key as JWE , and metadata for a specified signingKeyId associated with the application key making the call. |
Sell Leads2
Get All Classified LeadsgetAllClassifiedLeads | GET | This method retrieves leads for all of the seller's active classified ad listings. |
Get Classified Leads By Item IdgetClassifiedLeadsByItemId | GET | This method returns a seller account's leads generated by the specified classified ad and includes any contact information that prospective buyers have submitted. |
Sell Logistics6
Cancel ShipmentcancelShipment | POST | This method cancels the shipment associated with the specified shipment ID and the associated shipping label is deleted. |
Create From Shipping QuotecreateFromShippingQuote | POST | This method creates a shipment based on the shippingQuoteId and rateId values supplied in the request. |
Create Shipping QuotecreateShippingQuote | POST | The createShippingQuote method returns a shipping quote that contains a list of live "rates." Each rate represents an offer made by a shipping carrier for a specific service and each... |
Download Label FiledownloadLabelFile | GET | This method returns the shipping label file that was generated for the shipmentId value specified in the request. |
Get ShipmentgetShipment | GET | This method retrieves the shipment details for the specified shipment ID. |
Get Shipping QuotegetShippingQuote | GET | This method retrieves the complete details of the shipping quote associated with the specified shippingQuoteId value. |
Sell Marketing82
Bulk Create Ads By Inventory ReferencebulkCreateAdsByInventoryReference | POST | This method adds multiple listings that are managed with the Inventory API to an existing Promoted Listings campaign. |
Bulk Create Ads By Listing IdbulkCreateAdsByListingId | POST | This method adds multiple listings to an existing Promoted Listings campaign using listingId values generated by the Trading API or Inventory API , or using values generated by an ad... |
Bulk Create KeywordbulkCreateKeyword | POST | This method adds keywords, in bulk, to an existing priority strategy ad group in a campaign that uses manual targeting. |
Bulk Create Negative KeywordbulkCreateNegativeKeyword | POST | This method adds negative keywords, in bulk, to an existing ad group in a priority strategy campaign that uses manual targeting. |
Bulk Delete Ads By Inventory ReferencebulkDeleteAdsByInventoryReference | POST | This method works with listings created with the Inventory API . |
Bulk Delete Ads By Listing IdbulkDeleteAdsByListingId | POST | This method works with listing IDs created with either the Trading API or the Inventory API . |
Bulk Update Ads Bid By Inventory ReferencebulkUpdateAdsBidByInventoryReference | POST | This method works with listings created with either the Trading API or the Inventory API . |
Bulk Update Ads Bid By Listing IdbulkUpdateAdsBidByListingId | POST | This method works with listings created with either the Trading API or the Inventory API . |
Bulk Update Ads StatusbulkUpdateAdsStatus | POST | This method works with listings created with either the Trading API or the Inventory API . |
Bulk Update Ads Status By Listing IdbulkUpdateAdsStatusByListingId | POST | The method updates the status of ads in bulk, based on listing ID values. |
Bulk Update KeywordbulkUpdateKeyword | POST | This method updates the bids and statuses of keywords, in bulk, for an existing priority strategy campaign. |
Bulk Update Negative KeywordbulkUpdateNegativeKeyword | POST | This method updates the statuses of existing negative keywords, in bulk. |
Bulk Upsert Video Ads PreferencesbulkUpsertVideoAdsPreferences | PUT | Call this method to create or update video ads preferences for multiple listings in a single ad campaign request. |
Clone CampaigncloneCampaign | POST | This method clones (makes a copy of) the specified campaign's campaign criterion . |
Create Ad By Listing IdcreateAdByListingId | POST | This method adds a listing to an existing Promoted Listings campaign using a listingId value generated by the Trading API or Inventory API , or using a value generated by an ad group ID. |
Create Ad GroupcreateAdGroup | POST | This method adds an ad group to an existing priority strategy campaign that uses manual targeting. |
Create Ads By Inventory ReferencecreateAdsByInventoryReference | POST | This method adds a listing that is managed with the Inventory API to an existing Promoted Listings campaign. |
Create CampaigncreateCampaign | POST | This method can be used to create a Promoted Listings general, priority, or offsite campaign. |
Create Email CampaigncreateEmailCampaign | POST | This method creates a new email campaign. |
Create Item Price Markdown PromotioncreateItemPriceMarkdownPromotion | POST | Note: As of July 8th 2024, promotions are now being referred to as discounts on Seller Hub and eBay help pages. |
Create Item PromotioncreateItemPromotion | POST | Note: As of July 8th 2024, promotions are now being referred to as discounts on Seller Hub and eBay help pages. |
Create KeywordcreateKeyword | POST | This method creates keywords using a specified campaign ID for an existing priority strategy campaign that uses manual targeting. |
Create Negative KeywordcreateNegativeKeyword | POST | This method adds a negative keyword to an existing ad group in a priority strategy campaign that uses manual targeting. |
Create Report TaskcreateReportTask | POST | This method creates a report task , which generates a Promoted Listings report based on the values specified in the call. |
Delete AddeleteAd | DELETE | This method removes the specified ad from the specified campaign. |
Delete Ads By Inventory ReferencedeleteAdsByInventoryReference | POST | This method works with listings that are managed with the Inventory API . |
Delete CampaigndeleteCampaign | DELETE | This method deletes the campaign specified by the campaign id query parameter. |
Delete Email CampaigndeleteEmailCampaign | DELETE | This method deletes the email campaign specified by the email campaign id path parameter. |
Delete Item Price Markdown PromotiondeleteItemPriceMarkdownPromotion | DELETE | Note: As of July 8th 2024, promotions are now being referred to as discounts on Seller Hub and eBay help pages. |
Delete Item PromotiondeleteItemPromotion | DELETE | Note: As of July 8th 2024, promotions are now being referred to as discounts on Seller Hub and eBay help pages. |
Delete Report TaskdeleteReportTask | DELETE | This call deletes the report task specified by the report task id path parameter. |
End CampaignendCampaign | POST | This method ends an active ( RUNNING ) or paused campaign. |
Find Campaign By Ad ReferencefindCampaignByAdReference | GET | This method retrieves the campaigns containing the listing that is specified using either a listing ID, or an inventory reference ID and inventory reference type pair. |
Get AdgetAd | GET | This method retrieves the specified ad from the specified campaign. |
Get Ad GroupgetAdGroup | GET | This method retrieves the details of a specified ad group, such as the ad group’s default bid and status. |
Get Ad GroupsgetAdGroups | GET | This method retrieves ad groups for the specified campaign. |
Get AdsgetAds | GET | This method retrieves Promoted Listings ads that are associated with listings created with either the Trading API or the Inventory API . |
Get Ads By Inventory ReferencegetAdsByInventoryReference | GET | This method retrieves Promoted Listings ads associated with listings that are managed with the Inventory API from the specified campaign. |
Get AudiencesgetAudiences | GET | This method retrieves all available email newsletter audiences for the email campaign type specified by the emailCampaignType path parameter. |
Get CampaigngetCampaign | GET | This method retrieves the details of a single campaign, as specified with the campaign id query parameter. |
Get Campaign By NamegetCampaignByName | GET | This method retrieves the details of a single campaign, as specified with the campaign name query parameter. |
Get CampaignsgetCampaigns | GET | This method retrieves the details for all of the seller's defined campaigns. |
Get Email CampaigngetEmailCampaign | GET | This method returns the details of a single email campaign specified by the email campaign id path parameter. |
Get Email CampaignsgetEmailCampaigns | GET | This method retrieves a list of email campaigns from a seller's eBay store. |
Get Email PreviewgetEmailPreview | GET | This method returns a preview of the email sent by the email campaign indicated by the email campaign id path parameter. |
Get Email ReportgetEmailReport | GET | This method returns the seller's email campaign performance report for a time period specified by the startDate and endDate path parameters. |
Get Item Price Markdown PromotiongetItemPriceMarkdownPromotion | GET | Note: As of July 8th 2024, promotions are now being referred to as discounts on Seller Hub and eBay help pages. |
Get Item PromotiongetItemPromotion | GET | Note: As of July 8th 2024, promotions are now being referred to as discounts on Seller Hub and eBay help pages. |
Get KeywordgetKeyword | GET | This method retrieves details on a specific keyword from an ad group within a priority strategy campaign that uses the Cost Per Click (CPC) funding model. |
Get KeywordsgetKeywords | GET | This method can be used to retrieve all of the keywords for ad groups in priority strategy campaigns that use the Cost Per Click (CPC) funding model. |
Get Listing SetgetListingSet | GET | Note: As of July 8th 2024, promotions are now being referred to as discounts on Seller Hub and eBay help pages. |
Get Negative KeywordgetNegativeKeyword | GET | This method retrieves details on a specific negative keyword. |
Get Negative KeywordsgetNegativeKeywords | GET | This method can be used to retrieve all of the negative keywords for ad groups in priority strategy campaigns that use the Cost Per Click (CPC) funding model. |
Get Promotion ReportsgetPromotionReports | GET | Note: As of July 8th 2024, promotions are now being referred to as discounts on Seller Hub and eBay help pages. |
Get Promotion Summary ReportgetPromotionSummaryReport | GET | Note: As of July 8th 2024, promotions are now being referred to as discounts on Seller Hub and eBay help pages. |
Get PromotionsgetPromotions | GET | Note: As of July 8th 2024, promotions are now being referred to as discounts on Seller Hub and eBay help pages. |
Get ReportgetReport | GET | This call downloads the report as specified by the report id path parameter. |
Get Report MetadatagetReportMetadata | GET | This call retrieves information that details the fields used in each of the Promoted Listings reports. |
Get Report Metadata For Report TypegetReportMetadataForReportType | GET | This call retrieves metadata that details the fields used by a specific Promoted Listings report type. |
Get Report TaskgetReportTask | GET | This call returns the details of a specific Promoted Listings report task, as specified by the report task id path parameter. |
Get Report TasksgetReportTasks | GET | This method returns information on all the existing report tasks related to a seller. |
Pause CampaignpauseCampaign | POST | This method pauses an active (RUNNING) campaign. |
Pause PromotionpausePromotion | POST | Note: As of July 8th 2024, promotions are now being referred to as discounts on Seller Hub and eBay help pages. |
Resume CampaignresumeCampaign | POST | This method resumes a paused campaign, as long as its end date is in the future. |
Resume PromotionresumePromotion | POST | Note: As of July 8th 2024, promotions are now being referred to as discounts on Seller Hub and eBay help pages. |
Suggest BidssuggestBids | POST | This method allows sellers to retrieve the suggested bids for input keywords and match type. |
Suggest BudgetsuggestBudget | GET | Note: This method is only supported for Promoted Offsite campaigns. |
Suggest ItemssuggestItems | GET | This method allows sellers to obtain ideas for listings, which can be targeted for Promoted Listings campaigns. |
Suggest KeywordssuggestKeywords | POST | This method allows sellers to retrieve a list of keyword ideas to be targeted for Promoted Listings campaigns. |
Suggest Max CpcsuggestMaxCpc | POST | Note: This method is only supported for smart targeting priority strategy campaigns. |
Update Ad GroupupdateAdGroup | PUT | This method updates the ad group associated with a campaign. |
Update Ad Rate StrategyupdateAdRateStrategy | POST | This method updates the ad rate strategy for an existing rules-based general strategy ad campaign that uses the Cost Per Sale (CPS) funding model. |
Update BidupdateBid | POST | This method updates the bid percentage (also known as the "ad rate") for the specified ad in the specified campaign. |
Update Bidding StrategyupdateBiddingStrategy | POST | This method allows sellers to change the bidding strategy for a specified Cost Per Click (CPC) campaign that uses manual targeting. |
Update Campaign BudgetupdateCampaignBudget | POST | This method updates the daily budget for a priority strategy campaign that uses the Cost Per Click (CPC) funding model. |
Update Campaign IdentificationupdateCampaignIdentification | POST | This method can be used to change the name of a campaign, as well as modify the start or end dates. |
Update Email CampaignupdateEmailCampaign | PUT | This method lets users update an existing email campaign. |
Update Item Price Markdown PromotionupdateItemPriceMarkdownPromotion | PUT | Note: As of July 8th 2024, promotions are now being referred to as discounts on Seller Hub and eBay help pages. |
Update Item PromotionupdateItemPromotion | PUT | Note: As of July 8th 2024, promotions are now being referred to as discounts on Seller Hub and eBay help pages. |
Update KeywordupdateKeyword | PUT | This method updates keywords using a campaign ID and keyword ID for an existing priority strategy campaign. |
Update Negative KeywordupdateNegativeKeyword | PUT | This method updates the status of an existing negative keyword. |
Upsert Video Ads PreferencesupsertVideoAdsPreferences | PUT | Call this method to create or update video ads preferences for a single listing in an ad campaign. |
Sell Media13
Create DocumentcreateDocument | POST | This method stages a document to be uploaded, and requires the type of document to be uploaded, and the language(s) that the document contains. |
Create Document From UrlcreateDocumentFromUrl | POST | This method downloads a document from the provided URL and adds that document to the user's account. |
Create Image From FilecreateImageFromFile | POST | This method uploads a picture file to eBay Picture Services (EPS) using multipart/form-data. |
Create Image From UrlcreateImageFromUrl | POST | This method uploads a picture to eBay Picture Services (EPS) from the specified URL. |
Create VideocreateVideo | POST | This method creates a video resource. |
Download Post Order DocumentdownloadPostOrderDocument | GET | This method downloads the file associated with the specified document ID. |
Get DocumentgetDocument | GET | This method retrieves the current status and metadata of the specified document. |
Get ImagegetImage | GET | This method retrieves an EPS image URL and its expiration details for the unique identifier specified in the path parameter image id . |
Get VideogetVideo | GET | This method retrieves a video's metadata and content given a specified video ID . |
Remove Post Order DocumentremovePostOrderDocument | DELETE | This method deletes a previously uploaded document by its document ID. |
Upload DocumentuploadDocument | POST | This method associates the specified file with the specified document ID and uploads the input file. |
Upload Post Order DocumentuploadPostOrderDocument | POST | This method uploads a document for post‑order processes (for example, a seller providing a return shipping label). |
Upload VideouploadVideo | POST | This method associates the specified file with the specified video ID and uploads the input file. |
Sell Message5
Bulk Update ConversationbulkUpdateConversation | POST | This method can be used to update the conversationStatus of up to 10 conversations. |
Get ConversationgetConversation | GET | This method can be used to retrieve messages within a specific conversation. |
Get ConversationsgetConversations | GET | This method can be used to retrieve one or more conversations associated with a user. |
Send MessagesendMessage | POST | This method can be used to start a conversation with another user or send a message in an existing conversation with another user based on the information provided in the request. |
Update ConversationupdateConversation | POST | This method can be used to update the conversationStatus or the read status of a specified conversation. |
Sell Metadata28
Get Automotive Parts Compatibility PoliciesgetAutomotivePartsCompatibilityPolicies | GET | This method returns the eBay policies that define how to list automotive parts compatibility items in the categories of the specified marketplace. |
Get Category PoliciesgetCategoryPolicies | GET | This method returns eBay category policy metadata for all leaf categories on the specified marketplace. |
Get Classified Ad PoliciesgetClassifiedAdPolicies | GET | This method returns eBay classified ad policy metadata for all leaf categories on the specified marketplace. |
Get Compatibilities By SpecificationgetCompatibilitiesBySpecification | POST | This method is used to retrieve all compatible application name-value pairs for a part based on the provided specification(s). |
Get Compatibility Property NamesgetCompatibilityPropertyNames | POST | This method is used to retrieve product compatibility property names for the specified compatibility-enabled category. |
Get Compatibility Property ValuesgetMetadataCompatibilityPropertyValues | POST | This method is used to retrieve product compatibility property values associated with a single property name, in the specified category. |
Get CurrenciesgetCurrencies | GET | This method returns the default currency used by the eBay marketplace specified in the request. |
Get Exclude Shipping LocationsgetExcludeShippingLocations | GET | This method retrieves a list of locations that the seller can use as excluded shipping locations within their listings or in their fulfillment business policies for the specified... |
Get Extended Producer Responsibility PoliciesgetExtendedProducerResponsibilityPolicies | GET | This method returns the Extended Producer Responsibility policies for one, multiple, or all eBay categories in an eBay marketplace. |
Get Handling TimesgetHandlingTimes | GET | This method retrieves a list of supported handling times for the specified marketplace. |
Get Hazardous Materials LabelsgetHazardousMaterialsLabels | GET | This method returns hazardous materials label information for the specified eBay marketplace. |
Get Item Condition PoliciesgetItemConditionPolicies | GET | This method returns item condition metadata on one, multiple, or all eBay categories on an eBay marketplace. |
Get Listing Structure PoliciesgetListingStructurePolicies | GET | This method returns the eBay policies that define the allowed listing structures for the categories of a specific marketplace. |
Get Listing Type PoliciesgetListingTypePolicies | GET | This method returns eBay listing type policy metadata for all leaf categories on the specified marketplace. |
Get Minimum Listing Price PoliciesgetMinimumListingPricePolicies | GET | This method returns minimum listing price policies for supported types of listings on a specific marketplace. |
Get Motors Listing PoliciesgetMotorsListingPolicies | GET | This method returns eBay Motors policy metadata for all leaf categories on the specified marketplace. |
Get Multi Compatibility Property ValuesgetMultiCompatibilityPropertyValues | POST | This method is used to retrieve product compatibility property values associated with multiple property names, in the specified category. |
Get Negotiated Price PoliciesgetNegotiatedPricePolicies | GET | This method returns the eBay policies that define the supported negotiated price features (like "best offer") for the categories of a specific marketplace. |
Get Product CompatibilitiesgetProductCompatibilities | POST | This method is used to retrieve all available item compatibility details for the specified product. |
Get Product Safety LabelsgetProductSafetyLabels | GET | This method returns product safety label information for the specified eBay marketplace. |
Get Regulatory PoliciesgetRegulatoryPolicies | GET | This method returns regulatory policies for one, multiple, or all eBay categories in an eBay marketplace. |
Get Return PoliciesgetReturnPolicies_2 | GET | This method returns the eBay policies that define whether or not you must include a return policy for the items you list in the categories of a specific marketplace, plus the guidelines... |
Get Sales Tax JurisdictionsgetSalesTaxJurisdictions | GET | This method retrieves all sales-tax jurisdictions for the country specified in the countryCode path parameter. |
Get Shipping CarriersgetShippingCarriers | GET | This method retrieves a list of supported shipping carriers for the specified marketplace. |
Get Shipping LocationsgetShippingLocations | GET | This method retrieves a list of supported shipping locations for the specified marketplace. |
Get Shipping PoliciesgetShippingPolicies | GET | This method returns eBay shipping policy metadata for all leaf categories on the specified marketplace. |
Get Shipping ServicesgetShippingServices | GET | This method retrieves a list of shipping services supported for the specified marketplace, including valid shipping services, shipping times, and package constraints such as size and weight. |
Get Site Visibility PoliciesgetSiteVisibilityPolicies | GET | This method returns eBay international site visibility policy metadata for all leaf categories on the specified marketplace. |
Sell Negotiation2
Find Eligible ItemsfindEligibleItems | GET | This method evaluates a seller's current listings and returns the set of IDs that are eligible for a seller-initiated discount offer to a buyer. |
Send Offer To Interested BuyerssendOfferToInterestedBuyers | POST | This method sends eligible buyers offers to purchase items in a listing at a discount. |
Sell Notification21
Create DestinationcreateDestination | POST | This method allows applications to create a destination. |
Create SubscriptioncreateSubscription | POST | This method allows applications to create a subscription for a topic and supported schema version. |
Create Subscription FiltercreateSubscriptionFilter | POST | This method allows applications to create a filter for a subscription. |
Delete DestinationdeleteDestination | DELETE | This method provides applications a way to delete a destination. |
Delete SubscriptiondeleteSubscription | DELETE | This method allows applications to delete a subscription. |
Delete Subscription FilterdeleteSubscriptionFilter | DELETE | This method allows applications to disable the active filter on a subscription, so that a new subscription filter may be added. |
Disable SubscriptiondisableSubscription | POST | This method disables a subscription, which prevents the subscription from providing notifications. |
Enable SubscriptionenableSubscription | POST | This method allows applications to enable a disabled subscription. |
Get ConfiggetConfig | GET | This method allows applications to retrieve a previously created configuration. |
Get DestinationgetDestination | GET | This method allows applications to fetch the details for a destination. |
Get DestinationsgetDestinations | GET | This method allows applications to retrieve a paginated collection of destination resources and related details. |
Get Public KeygetPublicKey | GET | This method allows users to retrieve a public key using a specified key ID. |
Get SubscriptiongetNotificationSubscription | GET | This method allows applications to retrieve subscription details for the specified subscription. |
Get Subscription FiltergetSubscriptionFilter | GET | This method allows applications to retrieve the filter details for the specified subscription filter. |
Get SubscriptionsgetSubscriptions | GET | This method allows applications to retrieve a list of all subscriptions. |
Get TopicgetTopic | GET | This method allows applications to retrieve details for the specified topic. |
Get TopicsgetTopics | GET | This method returns a paginated collection of all supported topics, along with the details for the topics. |
Test SubscriptiontestSubscription | POST | This method triggers a mocked test payload that includes a notification ID, publish date, and so on. |
Update ConfigupdateConfig | PUT | This method allows applications to create a new configuration or update an existing configuration. |
Update DestinationupdateDestination | PUT | This method allows applications to update a destination. |
Update SubscriptionupdateSubscription | PUT | This method allows applications to update a subscription. |
Sell Post Order44
Add Shipping Label InfoaddShippingLabelInfo | POST | The primary function of this seller-facing method is to create a return shipping label for the buyer. |
Appeal Case DecisionappealCaseDecision | POST | Buyers and sellers can use this method to appeal a case decision that was not ruled in their favor by eBay customer support. |
Approve CancellationapproveCancellation | POST | This method approves a buyer's order cancellation request on behalf of the seller. |
Approve Cancellation (EU/UK signed)approveCancellation__eu_uk_signed | POST | This method approves a buyer's order cancellation request on behalf of the seller. |
Check Cancellation EligibilitycheckCancellationEligibility | POST | This method is used to check if a specified order is eligible to be cancelled. |
Close CasecloseCase | POST | Note: This call has been deprecated and will be decommissioned on March 2, 2026. |
Close InquirycloseInquiry | POST | Note: This call has been deprecated and will be decommissioned on March 16, 2026. |
Confirm Cancellation Refundconfirm | POST | Note: This call has been deprecated and will be decommissioned on March 2, 2026. |
Confirm Inquiry RefundconfirmInquiryRefund | POST | Note: This call has been deprecated and will be decommissioned on March 16, 2026. |
Create Cancellation RequestcreateCancellationRequest | POST | This method initiates an order cancellation on behalf of a seller and, if needed, you can also create an order cancellation on behalf of a buyer. |
Create Cancellation Request (EU/UK signed)createCancellationRequest__eu_uk_signed | POST | This method initiates an order cancellation on behalf of a seller and, if needed, you can also create an order cancellation on behalf of a buyer. |
Create InquirycreateInquiry | POST | Note: This call has been deprecated and will be decommissioned on March 16, 2026. |
Create Return RequestcreateReturnRequest | POST | This method is used to create a return request on behalf of the buyer. |
Escalate InquiryescalateInquiry | POST | This method is used to escalate the specified Item Not Received inquiry to an INR case on behalf of the buyer or seller. |
Escalate ReturnescalateReturn | POST | This method is used to escalate a return request into a case. |
Get CancellationgetCancellation | GET | This method retrieves the details of a specific cancellation request. |
Get CasegetCase | GET | This method can be used on behalf of buyers and sellers to retrieve detailed information on a case, including case history and (if applicable) refund information, appeal information, and... |
Get InquirygetInquiry | GET | This method retrieves details about the specified INR inquiry and a summary of the activity to date with respect to the inquiry. |
Get ReturngetReturn | GET | Use this method to retrieve information on a specific return request. |
Get Return FilesgetReturnFiles | GET | Use this method to retrieve information about the files associated with a return request. |
Get Return PreferencesgetReturnPreferences | GET | This method retrieves the return preferences currently active on the seller's account. |
Get Shipment Tracking InfogetShipmentTrackingInfo | GET | This method can be used to retrieve all shipment tracking activity on a specific return request. |
Issue Case RefundissueCaseRefund | POST | Note: This call has been deprecated and will be decommissioned on March 2, 2026. |
Issue Case Refund (EU/UK signed)issueCaseRefund__eu_uk_signed | POST | Note: This call has been deprecated and will be decommissioned on March 2, 2026. |
Issue Inquiry RefundissueInquiryRefund | POST | This method can be used on behalf of the seller to issue a full refund to the buyer for the missing line item. |
Issue Inquiry Refund (EU/UK signed)issueInquiryRefund__eu_uk_signed | POST | This method can be used on behalf of the seller to issue a full refund to the buyer for the missing line item. |
Issue Return RefundissueReturnRefund | POST | This method can be used on behalf of the seller to issue a refund to the buyer. |
Issue Return Refund (EU/UK signed)issueReturnRefund__eu_uk_signed | POST | This method can be used on behalf of the seller to issue a refund to the buyer. |
Mark Return ReceivedmarkItemReceived | POST | This method can be used on behalf of a seller to mark a return item as received. |
Process Return RequestprocessReturnRequest | POST | This method can be used on behalf of a seller or buyer to perform an action against a return request. |
Process Return Request (EU/UK signed)processReturnRequest__eu_uk_signed | POST | This method can be used on behalf of a seller or buyer to perform an action against a return request. |
Provide Case Shipment InfoprovideCaseShipmentInfo | POST | Note: This call has been deprecated and will be decommissioned on March 2, 2026. |
Provide Inquiry Refund InfoprovideInquiryRefundInfo | POST | Note: This call has been deprecated and will be decommissioned on March 16, 2026. |
Provide Inquiry Shipment InfoprovideInquiryShipmentInfo | POST | This method can be used to provide shipment tracking and other information about the shipment of an order line item that had an INR inquiry filed against it. |
Provides Return AddressprovideCaseReturnAddress | POST | Note: This call has been deprecated and will be decommissioned on March 2, 2026. |
Reject CancellationrejectCancellation | POST | This method is used on behalf of a seller to reject a buyer's order cancellation request. |
Search CancellationssearchCancellations | GET | Use this method to search for and retrieve one or more order cancellations. |
Search CasessearchCases | GET | This method is used to search for return requests and Item Not Received inquiries that have been escalated to eBay cases by the buyer. |
Search InquiriessearchInquiries | GET | This method is used to search for INR inquiries using multiple filter types. |
Search ReturnssearchReturns | GET | Use this method to retrieve the details on one or more return requests, or a summary of return requests per user. |
Send Inquiry MessagesendInquiryMessage | POST | This method allows a buyer or seller to send a message to their order partner in regards to an INR inquiry. |
Send Return MessagesendReturnMessage | POST | This method can be used on behalf of a buyer or seller to send a message to order partner regarding the return request. |
Set Return PreferencessetReturnPreferences | POST | This method is used if the seller wants to indicate whether or not a Return Merchandise Authorization (RMA) number is required for returned items. |
Upload Return FileuploadReturnFile | POST | This method may be used on behalf of a seller or buyer to upload files associated with a return request. |
Sell Recommendation1
Find Listing RecommendationsfindListingRecommendations | POST | The find method currently returns information for a single recommendation type ( AD ) which contains information that sellers can use to configure Promoted Listings ad campaigns. |
Sell Stores8
Add Store CategoryaddStoreCategory | POST | This method is used to add a single new custom category to a user's eBay store through an asynchronous request. |
Delete Store CategorydeleteStoreCategory | DELETE | This method is used to delete one custom category of a user's eBay store through an asynchronous request. |
Get StoregetStore | GET | This method is used to retrieve information for an eBay user's store such as store name, store URL, and description. |
Get Store CategoriesgetStoreCategories | GET | This method is used to retrieve the category hierarchy for an eBay user's store. |
Get Store TaskgetStoreTask | GET | This method retrieves the current status of a recent store operation. |
Get Store TasksgetStoreTasks | GET | This method retrieves the status of all async store tasks for a store. |
Move Store CategorymoveStoreCategory | POST | This method is used to move an existing user's eBay store custom category through an asynchronous request. |
Rename Store CategoryrenameStoreCategory | PUT | This method is used to rename the single category of a user's eBay store through a synchronous request. |
Sell Taxonomy9
Get a category subtreegetCategorySubtree | GET | This method retrieves the details of all nodes of the category tree hierarchy (the subtree) below a specified category of a category tree. |
Get a category treegetCategoryTree | GET | This method retrieves the complete category tree that is identified by the category tree id parameter. |
Get aspects for a leaf categorygetItemAspectsForCategory | GET | This method returns a list of aspects that are appropriate or necessary for accurately describing items in the specified leaf category. |
Get compatibility properties for a compatibility-enabled categorygetCompatibilityProperties | GET | This method retrieves the compatible vehicle aspects that are used to define a motor vehicle that is compatible with a motor vehicle part or accessory. |
Get compatibility property values for a compatibility-enabled categorygetCompatibilityPropertyValues | GET | This method retrieves applicable compatible vehicle property values based on the specified eBay marketplace, specified eBay category, and filters used in the request. |
Get expired categories for a marketplacegetExpiredCategories | GET | This method retrieves the mappings of expired leaf categories in the specified category tree to their corresponding active leaf categories. |
Get item aspects for all leaf categories in a marketplacefetchItemAspects | GET | This method returns a complete list of aspects for all of the leaf categories that belong to an eBay marketplace. |
Get suggested categories for a keywordgetCategorySuggestions | GET | This method returns an array of category tree leaf nodes in the specified category tree that are considered by eBay to most closely correspond to the query string q . |
Get the default category tree ID for a marketplacegetDefaultCategoryTreeId | GET | A given eBay marketplace might use multiple category trees, but one of those trees is considered to be the default for that marketplace. |
Sell Translation1
Translate text from one language to anothertranslate | POST | This method translates listing title and listing description text from one language into another. |
Sell Vero Publics5
Create Vero ReportcreateVeroReport | POST | |
Get Vero Reason CodegetVeroReasonCode_2 | GET | |
Get Vero Reason CodesgetVeroReasonCodes_2 | GET | |
Get Vero ReportgetVeroReport_2 | GET | |
Retrieves status for VERO infringement reports by Brand.getVeroReportItems_2 | GET |
Sell Vero V25
Get Vero Reason CodegetVeroReasonCode | GET | |
Get Vero Reason CodesgetVeroReasonCodes | GET | |
Get Vero ReportgetVeroReport | GET | |
Report Vero ViolationsreportVeroViolations | POST | |
Retrieves status for VeRO infringement reports by item and date range.getVeroReportItems | GET |