Skip to main content
eBay logo
  • Category: ecommerce
  • Auth: S2S_OAUTH2
  • Composio-managed OAuth available? No
  • Tools: 31
  • Triggers: 0
  • Slug: EBAY
  • Version: 20261101_00

Tools

Slug: EBAY_BUY_BROWSE_CHECK_COMPATIBILITYCheck whether an eBay Motors part is compatible with a supplied car, truck, or motorcycle definition without changing the item.

Input Parameters

string
required
RESTful identifier of the eBay item to check. For a single-SKU listing, use the v1|listing_id|0 form; for a variation, use its full RESTful item ID.
string ("EBAY_AT" | "EBAY_AU" | "EBAY_BE" | "EBAY_CA" | "EBAY_CH" | "EBAY_DE" | "EBAY_ES" | "EBAY_FR" | "EBAY_GB" | "EBAY_HK" | "EBAY_IE" | "EBAY_IN" | "EBAY_IT" | "EBAY_MOTORS_US" | "EBAY_MY" | "EBAY_NL" | "EBAY_PH" | "EBAY_PL" | "EBAY_RU" | "EBAY_SG" | "EBAY_US")
Seller marketplace identifier. Supply this for marketplaces outside the US; eBay defaults to EBAY_US.
string
Preferred response locale. Required when selecting a particular locale of a marketplace that supports multiple locales, such as fr-BE or fr-CA.
array
required
Product attribute name/value pairs that identify the vehicle whose compatibility with the item should be checked.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: EBAY_BUY_BROWSE_GET_ITEMRetrieve complete details for one eBay listing or variation by either its RESTful item ID or legacy listing ItemID using an application access token.

Input Parameters

string
required
Item identifier interpreted according to identifier_type. For RESTFUL, use an ID such as v1|110550035785|0. For LEGACY, use the listing’s legacy ItemID, such as 298220737822.
string
Comma-separated response expansions. Both identifier types support PRODUCT, ADDITIONAL_SELLER_DETAILS, and CHARITY_DETAILS. RESTFUL also supports COMPACT for change-detection fields; COMPACT must be used alone.
string ("EBAY_AT" | "EBAY_AU" | "EBAY_BE" | "EBAY_CA" | "EBAY_CH" | "EBAY_DE" | "EBAY_ES" | "EBAY_FR" | "EBAY_GB" | "EBAY_HK" | "EBAY_IE" | "EBAY_IN" | "EBAY_IT" | "EBAY_MOTORS_US" | "EBAY_MY" | "EBAY_NL" | "EBAY_PH" | "EBAY_PL" | "EBAY_RU" | "EBAY_SG" | "EBAY_US")
eBay marketplace identifier. It is required outside the US and defaults to EBAY_US.
string
Preferred response language and locale. Required when selecting a specific locale in a multilingual marketplace, such as fr-BE or fr-CA.
string ("RESTFUL" | "LEGACY")
required
How to interpret item_id: RESTFUL for an eBay RESTful item ID or LEGACY for a legacy listing ItemID.
string
eBay end-user context for affiliate attribution or buyer country and postal code used to improve shipping estimates.
string
Legacy variation ID for a specific item in a multi-variation listing. Valid only when identifier_type is LEGACY; do not combine with legacy_variation_sku.
string
Seller-defined SKU for a specific variation. Valid only when identifier_type is LEGACY; do not combine with legacy_variation_id.
string
Positive integer quantity used to calculate shipping estimates. Do not use this parameter for auction listings.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: EBAY_BUY_BROWSE_GET_ITEMSRetrieve details for up to 20 eBay items or 10 item groups in one request. This limited-release operation requires selected-partner access.

Input Parameters

string
Comma-separated RESTful item IDs to retrieve, with at most 20 IDs. Use this or item_group_ids, not both.
string
Comma-separated item group IDs to retrieve, with at most 10 IDs. Use this or item_ids, not both.
string ("EBAY_AT" | "EBAY_AU" | "EBAY_BE" | "EBAY_CA" | "EBAY_CH" | "EBAY_DE" | "EBAY_ES" | "EBAY_FR" | "EBAY_GB" | "EBAY_HK" | "EBAY_IE" | "EBAY_IN" | "EBAY_IT" | "EBAY_MOTORS_US" | "EBAY_MY" | "EBAY_NL" | "EBAY_PH" | "EBAY_PL" | "EBAY_RU" | "EBAY_SG" | "EBAY_US")
eBay marketplace ID. Required outside the US; defaults to EBAY_US.
string
Preferred response locale, such as fr-BE or fr-CA.
string
End-user context for affiliate attribution or destination-based shipping estimates.
string
Positive integer quantity to use when calculating shipping estimates.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: EBAY_BUY_BROWSE_GET_ITEMS_BY_ITEM_GROUPRetrieve every purchasable item variation and shared description in an eBay Browse item group.

Input Parameters

string
Optional response expansion. Supported values include ADDITIONAL_SELLER_DETAILS and CHARITY_DETAILS.
string
required
Unique item-group identifier returned by Browse search or get-item results.
string ("EBAY_AT" | "EBAY_AU" | "EBAY_BE" | "EBAY_CA" | "EBAY_CH" | "EBAY_DE" | "EBAY_ES" | "EBAY_FR" | "EBAY_GB" | "EBAY_HK" | "EBAY_IE" | "EBAY_IN" | "EBAY_IT" | "EBAY_MOTORS_US" | "EBAY_MY" | "EBAY_NL" | "EBAY_PH" | "EBAY_PL" | "EBAY_RU" | "EBAY_SG" | "EBAY_US")
eBay marketplace identifier; defaults to EBAY_US.
string
Preferred response language and locale, such as fr-BE or fr-CA.
string
eBay end-user context for affiliate attribution or destination-specific shipping estimates.
string
Positive item quantity eBay should use to calculate shipping estimates; it must not exceed the available quantity.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: EBAY_BUY_BROWSE_SEARCHSearch eBay item summaries by keyword, category, product identifier, charity, compatibility, aspects, and Browse field filters, returning one page plus an opaque continuation cursor.

Input Parameters

string
UPC, EAN, or ISBN product identifier. May be combined with ebay_product_id but not with query.
string ("price" | "-price" | "distance" | "newlyListed" | "endingSoonest")
Sort criterion, including price, -price, distance, newlyListed, or endingSoonest. Distance sorting requires the documented pickup filters.
string
Items to return on this page as a numeric string (1-200). Default: 50.
string
Keyword query, up to 100 characters. Spaces mean AND; comma-separated terms in parentheses mean OR. Wildcards are not supported.
string
Opaque cursor returned by a previous call. It restores the original search context.
string
Browse field filters in eBay syntax, separated by commas.
string
Items to skip as a numeric string (0-9999). Must be zero or a multiple of limit. Use cursor for subsequent pages.
string
Up to 20 comma-separated charity registration IDs; supported in US and UK marketplaces.
string
Comma-separated response groups: ASPECT_REFINEMENTS, BUYING_OPTION_REFINEMENTS, CATEGORY_REFINEMENTS, CONDITION_REFINEMENTS, EXTENDED, MATCHING_ITEMS, or FULL.
string
Enable keyword correction. The documented value is KEYWORD.
string
Category IDs used to limit results. Although comma-separated IDs are accepted by the syntax, eBay currently permits one category per request.
string
Item-aspect filter in eBay syntax. Include the same category ID in category_ids and in this value, for example categoryId:15724,Color:{Red}.
string ("EBAY_AT" | "EBAY_AU" | "EBAY_BE" | "EBAY_CA" | "EBAY_CH" | "EBAY_DE" | "EBAY_ES" | "EBAY_FR" | "EBAY_GB" | "EBAY_HK" | "EBAY_IE" | "EBAY_IN" | "EBAY_IT" | "EBAY_MOTORS_US" | "EBAY_MY" | "EBAY_NL" | "EBAY_PH" | "EBAY_PL" | "EBAY_RU" | "EBAY_SG" | "EBAY_US")
eBay marketplace identifier. Required outside the US; defaults to EBAY_US.
string
Preferred response locale, required for a specific locale on multilingual marketplaces.
string
eBay product identifier. May be combined with gtin but not with query.
string
Affiliate and buyer-location context used for revenue sharing and more accurate shipping estimates.
string
Vehicle compatibility attributes in eBay syntax for cars, trucks, or motorcycles.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: EBAY_BUY_BROWSE_SEARCH_BY_IMAGESearch eBay item summaries using a bare Base64-encoded image, optionally refine the matches, and return one page plus an opaque continuation cursor. To continue, pass the cursor and repeat the same image; search selectors are restored from the cursor.

Input Parameters

string
Requested sort expression. Image search currently returns best-match results, so this parameter has no practical effect.
string
required
Bare Base64-encoded image data without a data-URI prefix.
string
Items to return on this page as a numeric string (1-200). Default: 50.
string
Opaque cursor returned by a previous call. Repeat the same image when continuing; the cursor restores the original search selectors.
string
Browse field filters in eBay syntax, separated by commas.
string
Items to skip as a numeric string (0-9999). It must be zero or a multiple of limit. Use cursor for subsequent pages.
string
Up to 20 comma-separated charity registration IDs. This filter is supported by the US and UK marketplaces.
string
Comma-separated response groups: ASPECT_REFINEMENTS, BUYING_OPTION_REFINEMENTS, CATEGORY_REFINEMENTS, CONDITION_REFINEMENTS, EXTENDED, MATCHING_ITEMS, or FULL.
string
Category ID used to limit results. eBay currently permits one category per request even though the syntax accepts comma-separated IDs.
string
Item-aspect filter in eBay syntax. Include the same category ID in category_ids and in this value, for example categoryId:15724,Color:{Red}.
string ("EBAY_AT" | "EBAY_AU" | "EBAY_BE" | "EBAY_CA" | "EBAY_CH" | "EBAY_DE" | "EBAY_ES" | "EBAY_FR" | "EBAY_GB" | "EBAY_HK" | "EBAY_IE" | "EBAY_IN" | "EBAY_IT" | "EBAY_MOTORS_US" | "EBAY_MY" | "EBAY_NL" | "EBAY_PH" | "EBAY_PL" | "EBAY_RU" | "EBAY_SG" | "EBAY_US")
eBay marketplace identifier. Required outside the US; defaults to EBAY_US.
string
Preferred response locale, required for a specific locale on multilingual marketplaces.
string
Affiliate and buyer-location context used for revenue sharing and more accurate shipping and delivery estimates.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: EBAY_BUY_DEAL_GET_DEAL_ITEMSRetrieve one page of eBay deal items by category, commissionable status, delivery country, and marketplace. This Limited Release operation requires eBay Buy Deal approval.

Input Parameters

string
Maximum deal items returned on one page, as a numeric string.
string
Opaque cursor returned by a previous call; it restores the original deal filters.
string
Deal items to skip, as a numeric string. Use cursor for subsequent pages.
string
eBay category identifier used to filter deal items.
string ("true" | "false")
Filter by commissionable status using true or false; supported only on EBAY_US.
string ("EBAY_AT" | "EBAY_AU" | "EBAY_BE" | "EBAY_CA" | "EBAY_CH" | "EBAY_DE" | "EBAY_ES" | "EBAY_FR" | "EBAY_GB" | "EBAY_HK" | "EBAY_IE" | "EBAY_IN" | "EBAY_IT" | "EBAY_MOTORS_US" | "EBAY_MY" | "EBAY_NL" | "EBAY_PH" | "EBAY_PL" | "EBAY_RU" | "EBAY_SG" | "EBAY_US")
required
eBay marketplace identifier used to select the deal inventory.
string
Two-letter ISO country code to which returned items must be shippable.
string
Affiliate attribution and buyer-location context for revenue sharing and shipping estimates.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: EBAY_BUY_DEAL_GET_EVENTRetrieve the details of one eBay deal event by event ID, including its coupons, dates, terms, and images. This limited-release operation requires eBay approval for the buy.deal scope.

Input Parameters

string
required
Unique identifier of the eBay event to retrieve. Use Deal: Get Events to discover event IDs.
string ("EBAY_AT" | "EBAY_AU" | "EBAY_BE" | "EBAY_CA" | "EBAY_CH" | "EBAY_DE" | "EBAY_ES" | "EBAY_FR" | "EBAY_GB" | "EBAY_HK" | "EBAY_IE" | "EBAY_IN" | "EBAY_IT" | "EBAY_MOTORS_US" | "EBAY_MY" | "EBAY_NL" | "EBAY_PH" | "EBAY_PL" | "EBAY_RU" | "EBAY_SG" | "EBAY_US")
eBay marketplace identifier for which to retrieve the event.
string
End-user context for eBay Partner Network attribution and improved shipping or delivery estimates.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: EBAY_BUY_DEAL_GET_EVENT_ITEMSReturn one page of eBay Deal event items for an event, with optional category and delivery-country filters plus an opaque continuation cursor. This Limited Release operation requires eBay partner approval.

Input Parameters

string
Maximum event items on this page as a numeric string (1-100).
string
Opaque cursor returned by a previous call; it restores the original filters.
string
Number of matching event items to skip as a non-negative numeric string.
string
required
Single event ID returned by Deal: Get Events.
string
Optional single eBay category ID used to filter event items.
string ("EBAY_AT" | "EBAY_AU" | "EBAY_BE" | "EBAY_CA" | "EBAY_CH" | "EBAY_DE" | "EBAY_ES" | "EBAY_FR" | "EBAY_GB" | "EBAY_HK" | "EBAY_IE" | "EBAY_IN" | "EBAY_IT" | "EBAY_MOTORS_US" | "EBAY_MY" | "EBAY_NL" | "EBAY_PH" | "EBAY_PL" | "EBAY_RU" | "EBAY_SG" | "EBAY_US")
eBay marketplace identifier; defaults to EBAY_US.
string
Two-letter ISO country code to return only items shippable there.
string
Affiliate and buyer-location context for revenue sharing and delivery estimates.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: EBAY_BUY_DEAL_GET_EVENTSReturn one page of eBay deal events for a marketplace, including coupons, event terms, images, and an opaque continuation cursor. This limited-release operation requires eBay approval for the buy.deal scope.

Input Parameters

string
Maximum events to return on this page as a numeric string (maximum 100).
string
Opaque cursor returned by a previous call to retrieve the next page.
string
Events to skip as a numeric string. Use cursor rather than setting this directly when continuing a previous result set.
string ("EBAY_AT" | "EBAY_AU" | "EBAY_BE" | "EBAY_CA" | "EBAY_CH" | "EBAY_DE" | "EBAY_ES" | "EBAY_FR" | "EBAY_GB" | "EBAY_HK" | "EBAY_IE" | "EBAY_IN" | "EBAY_IT" | "EBAY_MOTORS_US" | "EBAY_MY" | "EBAY_NL" | "EBAY_PH" | "EBAY_PL" | "EBAY_RU" | "EBAY_SG" | "EBAY_US")
eBay marketplace identifier for which to return events.
string
End-user context for eBay Partner Network attribution and improved shipping or delivery estimates.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: EBAY_BUY_FEED_GET_ITEM_FEEDDownload one byte range of an eBay Item feed gzip file for a top-level category. The restricted Buy Feed API grant and eBay partner approval are required.

Input Parameters

string
Daily feed date in yyyyMMdd format, 3 to 14 days in the past. Required for NEWLY_LISTED and ignored for ALL_ACTIVE.
string
required
Inclusive byte range for one gzip-file chunk, formatted as bytes=start-end. A production chunk cannot exceed 100 MiB.
string ("NEWLY_LISTED" | "ALL_ACTIVE")
required
Feed type to download. NEWLY_LISTED returns the daily feed and requires date; ALL_ACTIVE returns the latest weekly bootstrap feed.
string
required
Top-level eBay category ID for the feed. The category must belong to the selected marketplace and cannot be a Real Estate category.
string ("EBAY_AT" | "EBAY_AU" | "EBAY_BE" | "EBAY_CA" | "EBAY_CH" | "EBAY_DE" | "EBAY_ES" | "EBAY_FR" | "EBAY_GB" | "EBAY_HK" | "EBAY_IE" | "EBAY_IN" | "EBAY_IT" | "EBAY_MOTORS_US" | "EBAY_MY" | "EBAY_NL" | "EBAY_PH" | "EBAY_PL" | "EBAY_RU" | "EBAY_SG" | "EBAY_US")
Case-sensitive eBay marketplace ID that owns the requested category.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: EBAY_BUY_FEED_GET_ITEM_GROUP_FEEDDownload an eBay Item Group feed gzip file, or a byte range, for a top-level category, with downloads limited to 100 MiB. The restricted Buy Feed API grant and eBay partner approval are required.

Input Parameters

string
Daily feed date in yyyyMMdd format, 3 to 14 days in the past. Required for NEWLY_LISTED and ignored for ALL_ACTIVE.
string
Optional inclusive byte range for one gzip-file chunk, formatted as bytes=start-end. A production chunk cannot exceed 100 MiB.
string ("NEWLY_LISTED" | "ALL_ACTIVE")
required
Feed type to download. NEWLY_LISTED returns the daily Item Group feed and requires date; ALL_ACTIVE returns the latest weekly bootstrap feed.
string
required
Top-level eBay category ID for the feed. The category must belong to the selected marketplace and cannot be a Real Estate category.
string ("EBAY_AT" | "EBAY_AU" | "EBAY_BE" | "EBAY_CA" | "EBAY_CH" | "EBAY_DE" | "EBAY_ES" | "EBAY_FR" | "EBAY_GB" | "EBAY_HK" | "EBAY_IE" | "EBAY_IN" | "EBAY_IT" | "EBAY_MOTORS_US" | "EBAY_MY" | "EBAY_NL" | "EBAY_PH" | "EBAY_PL" | "EBAY_RU" | "EBAY_SG" | "EBAY_US")
Case-sensitive eBay marketplace ID that owns the requested category.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: EBAY_BUY_FEED_GET_ITEM_PRIORITY_FEEDDownload one byte range of an eBay Item Priority delta feed gzip file for a top-level category and date. Consume the daily Item and Item Group feeds before this feed. The restricted Buy Feed API grant and eBay partner approval are required.

Input Parameters

string
required
Feed date in yyyyMMdd format, up to 14 days in the past and not in the future. Feed generation normally has 48 to 72 hours of latency.
string
required
Inclusive byte range for one gzip-file chunk, formatted as bytes=start-end. A production chunk cannot exceed 100 MiB.
string
required
Top-level eBay category ID for the priority-item delta feed. The category must belong to the selected marketplace and cannot be a Real Estate category.
string ("EBAY_AT" | "EBAY_AU" | "EBAY_BE" | "EBAY_CA" | "EBAY_CH" | "EBAY_DE" | "EBAY_ES" | "EBAY_FR" | "EBAY_GB" | "EBAY_HK" | "EBAY_IE" | "EBAY_IN" | "EBAY_IT" | "EBAY_MOTORS_US" | "EBAY_MY" | "EBAY_NL" | "EBAY_PH" | "EBAY_PL" | "EBAY_RU" | "EBAY_SG" | "EBAY_US")
Case-sensitive eBay marketplace ID that owns the requested category.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: EBAY_BUY_FEED_GET_ITEM_SNAPSHOT_FEEDDownload one byte range of an hourly eBay Item Snapshot feed gzip file for a top-level category and UTC hour. The restricted Buy Feed API grant and eBay partner approval are required.

Input Parameters

string
required
Inclusive byte range for one gzip-file chunk, formatted as bytes=start-end. A production chunk cannot exceed 100 MiB.
string
required
Top-level eBay category ID for the snapshot feed. The category must belong to the selected marketplace and cannot be a Real Estate category.
string
required
UTC hour covered by the snapshot, formatted as yyyy-MM-ddTHH:00:00.000Z. eBay retains seven days of hourly files and typically makes a file available two hours after the covered hour.
string ("EBAY_AT" | "EBAY_AU" | "EBAY_BE" | "EBAY_CA" | "EBAY_CH" | "EBAY_DE" | "EBAY_ES" | "EBAY_FR" | "EBAY_GB" | "EBAY_HK" | "EBAY_IE" | "EBAY_IN" | "EBAY_IT" | "EBAY_MOTORS_US" | "EBAY_MY" | "EBAY_NL" | "EBAY_PH" | "EBAY_PL" | "EBAY_RU" | "EBAY_SG" | "EBAY_US")
Case-sensitive eBay marketplace ID that owns the requested category.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: EBAY_BUY_MARKETING_GET_MERCHANDISED_PRODUCTSReturn eBay products selected by category and the BEST_SELLING metric, including catalog IDs, prices, images, reviews, and rating details. This limited-release operation requires eBay Buy Marketing approval.

Input Parameters

string
Maximum products to return as an integer string from 1 through 100; eBay defaults to 8.
string
required
Single eBay category ID used to select products.
string
Aspect name and value used to refine products within the category, such as Brand:Canon.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: EBAY_COMMERCE_CHARITY_GET_CHARITY_ORGRetrieve details for one eBay-supported charitable organization by its charity organization ID in the US or UK marketplace.

Input Parameters

string
required
Unique eBay identifier of the charitable organization to retrieve.
string ("EBAY_GB" | "EBAY_US")
eBay marketplace in which to retrieve the charity: EBAY_GB or EBAY_US.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: EBAY_COMMERCE_CHARITY_GET_CHARITY_ORGSSearch supported eBay charitable organizations by keywords or registration IDs, returning one page of complete organization details and an opaque continuation cursor.

Input Parameters

string
Organizations to return on this page as a numeric string (1-100).
string
Keywords matched against charity names, mission statements, and descriptions. Specify either query or registration_ids, not both.
string
Opaque cursor returned by a previous call; it restores the original search filters.
string
Organizations to skip as a numeric string (0-10000). Use cursor when continuing a previous search.
string ("EBAY_GB" | "EBAY_US")
eBay marketplace in which to search. Valid values are EBAY_US and EBAY_GB.
string
Up to 20 comma-separated charity registration IDs. Specify either registration_ids or query, not both.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: EBAY_COMMERCE_NOTIFICATION_GET_PUBLIC_KEYRetrieve the eBay public key identified by a push notification signature for validating that notification’s payload. Cache returned keys temporarily instead of requesting one for every notification.

Input Parameters

string
required
Unique public key ID decoded from the X-EBAY-SIGNATURE header of an eBay push notification.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: EBAY_COMMERCE_NOTIFICATION_GET_TOPICRetrieve one eBay notification topic by ID, including its subscription scope requirements and supported payload configurations.

Input Parameters

string
required
Unique identifier of the notification topic to retrieve. Use Notification: Get Topics to discover topic IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: EBAY_COMMERCE_NOTIFICATION_GET_TOPICSReturn one page of eBay notification topics, including subscription scope requirements, supported payload configurations, and a continuation cursor.

Input Parameters

integer
Maximum topics to return on this page (10-100).
string
Opaque cursor returned by a previous call to retrieve the next page.
string
Provider continuation token from a previous page’s next URL. Prefer cursor when continuing a response returned by this action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: EBAY_COMMERCE_TAXONOMY_FETCH_ITEM_ASPECTSDownload the gzipped JSON item-aspect dataset for leaf categories in an eBay category tree, subject to a 250 MB download limit. The compressed file can exceed 100 MB, and this bulk operation has a substantially lower daily quota than other Taxonomy operations.

Input Parameters

string
required
Unique identifier of the eBay category tree whose complete leaf-category aspect dataset should be downloaded. Retrieve a marketplace’s tree ID with the Taxonomy get-default-category-tree-ID operation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: EBAY_COMMERCE_TAXONOMY_GET_CATEGORY_SUGGESTIONSFind ranked eBay leaf-category suggestions for free-form item keywords, including each category’s ancestor path to the category-tree root.

Input Parameters

string
required
Free-form phrases or keywords describing the item. eBay parses this text and ranks the leaf categories that best match it.
string
required
Unique identifier of the eBay category tree to search. Retrieve a marketplace’s tree ID with the get-default-category-tree-ID operation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: EBAY_COMMERCE_TAXONOMY_GET_CATEGORY_TREERetrieve eBay’s complete category tree when root_category_id is omitted, or retrieve the subtree rooted at root_category_id when it is provided. Both modes include recursively nested descendants.

Input Parameters

string
Compression encoding accepted for the potentially large response.
string
required
Unique eBay category tree identifier returned by the get default category tree ID operation.
string
Optional category identifier to use as the root of a subtree. Omit it to retrieve the complete category tree.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: EBAY_COMMERCE_TAXONOMY_GET_COMPATIBILITY_PROPERTIESRetrieve the localized vehicle properties that define compatibility for an eBay parts category, such as Make, Model, Year, Engine, and Trim.

Input Parameters

string
required
Unique identifier of a category in the specified tree that supports parts compatibility for cars, trucks, or motorcycles.
string
required
Unique identifier of the eBay category tree containing the vehicle category. Supported trees include eBay Motors US (100), eBay US (0), Canada (2), UK (3), Germany (77), Australia (15), France (71), Italy (101), and Spain (186).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: EBAY_COMMERCE_TAXONOMY_GET_COMPATIBILITY_PROPERTY_VALUESRetrieve the applicable values of one vehicle compatibility property for an eBay parts category, optionally narrowed by other property-value pairs.

Input Parameters

string
Optional comma-separated property:value pairs that narrow the values, for example Year:2018,Make:Toyota,Model:Camry. Escape a comma within a value with a backslash.
string
required
Unique identifier of a category in the specified tree that supports parts compatibility for cars, trucks, or motorcycles.
string
required
Unique identifier of the eBay category tree containing the vehicle category. Supported trees include eBay Motors US (100), eBay US (0), Canada (2), UK (3), Germany (77), Australia (15), France (71), Italy (101), and Spain (186).
string
required
Vehicle property whose applicable values should be returned, such as Make, Model, Year, Engine, or Trim. Use a name returned by the Taxonomy get-compatibility-properties operation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: EBAY_COMMERCE_TAXONOMY_GET_DEFAULT_CATEGORY_TREE_IDRetrieve the identifier and version of the default eBay category tree for a marketplace. Use the returned identifier with other Taxonomy operations.

Input Parameters

string ("EBAY_AT" | "EBAY_AU" | "EBAY_BE" | "EBAY_CA" | "EBAY_CH" | "EBAY_DE" | "EBAY_ES" | "EBAY_FR" | "EBAY_GB" | "EBAY_HK" | "EBAY_IE" | "EBAY_IN" | "EBAY_IT" | "EBAY_MOTORS_US" | "EBAY_MY" | "EBAY_NL" | "EBAY_PH" | "EBAY_PL" | "EBAY_RU" | "EBAY_SG" | "EBAY_US")
required
Unique eBay marketplace identifier whose default category tree should be returned.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: EBAY_COMMERCE_TAXONOMY_GET_EXPIRED_CATEGORIESRetrieve mappings from expired eBay leaf categories to the active leaf categories that replaced them. Only mapped category consolidations and splits are returned; expired categories without an active replacement are omitted.

Input Parameters

string
required
Unique identifier of the eBay category tree whose mapped expired leaf categories should be retrieved. Retrieve a marketplace’s tree ID with the get-default-category-tree-ID operation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: EBAY_COMMERCE_TAXONOMY_GET_ITEM_ASPECTS_FOR_CATEGORYRetrieve complete eBay aspect metadata for a leaf category, including valid values, value dependencies, listing requirements, variation support, and format constraints.

Input Parameters

string
required
Unique identifier of the leaf category whose item aspects should be returned; non-leaf categories are rejected.
string
required
Unique eBay category tree identifier. Retrieve a marketplace’s tree ID with the get-default-category-tree-ID operation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: EBAY_COMMERCE_TRANSLATION_TRANSLATETranslate one eBay listing title or description from a supported source language to a supported target language without changing a listing.

Input Parameters

array
required
Text to translate. eBay currently accepts one string per call, with up to 1,000 characters for ITEM_TITLE or 20,000 characters for ITEM_DESCRIPTION visible text. HTML markup, CSS, scripts, and link attributes do not count toward the description limit.
string ("en" | "de" | "fr" | "it" | "es" | "pl" | "zh" | "ja")
required
Source language code. Supported source-to-target pairs are: en to de, zh, ja, fr, it, pt, es, or ru; de to en, fr, it, es, or pl; fr to en, de, it, or es; it to en, de, fr, or es; es to en, de, fr, or it; pl to de; zh to en; and ja to en. Choose only a listed pairing.
string ("de" | "en" | "es" | "fr" | "it" | "ja" | "pl" | "pt" | "ru" | "zh")
required
Target language code. Supported source-to-target pairs are: en to de, zh, ja, fr, it, pt, es, or ru; de to en, fr, it, es, or pl; fr to en, de, it, or es; it to en, de, fr, or es; es to en, de, fr, or it; pl to de; zh to en; and ja to en. Choose only a listed pairing.
string ("ITEM_TITLE" | "ITEM_DESCRIPTION")
required
Listing text context, which determines the input text length limit.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: EBAY_DEVELOPER_ANALYTICS_GET_RATE_LIMITSReturn application-level eBay API quota usage, remaining calls, and reset windows, optionally filtered by API context and name.

Input Parameters

string
API name whose application-level rate limits should be returned, such as browse, inventory, taxonomy, or tradingapi.
string ("buy" | "sell" | "commerce" | "developer" | "tradingapi")
API context whose application-level rate limits should be returned.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: EBAY_SHOPPING_UNAVAILABLECompatibility-only action for retired eBay Shopping API calls. It always fails locally because eBay decommissioned Shopping; use Browse for items and Taxonomy for categories and aspects.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not