---
canonical_url: "https://docs.composio.dev/toolkits/ebay"
markdown_url: "https://docs.composio.dev/toolkits/ebay.md"
product: "platform"
version: null
last_updated: null
---

# eBay

Access eBay public marketplace, taxonomy, notification, and developer APIs with application OAuth.

- **Category:** ecommerce
- **Auth:** S2S_OAUTH2
- **Composio-managed OAuth available?** No
- **Tools:** 31
- **Triggers:** 0
- **Slug:** `EBAY`
- **Version:** 00000000_00

## Tools

### Browse: Check Compatibility

**Slug:** `EBAY_BUY_BROWSE_CHECK_COMPATIBILITY`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `item_id` | string | Yes | 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. |
| `marketplace_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") | No | Seller marketplace identifier. Supply this for marketplaces outside the US; eBay defaults to EBAY_US. |
| `accept_language` | string | No | Preferred response locale. Required when selecting a particular locale of a marketplace that supports multiple locales, such as fr-BE or fr-CA. |
| `compatibility_properties` | array | Yes | Product attribute name/value pairs that identify the vehicle whose compatibility with the item should be checked. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Browse: Get Item

**Slug:** `EBAY_BUY_BROWSE_GET_ITEM`

Retrieve 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `item_id` | string | Yes | 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. |
| `fieldgroups` | string | No | 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. |
| `marketplace_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") | No | eBay marketplace identifier. It is required outside the US and defaults to EBAY_US. |
| `accept_language` | string | No | Preferred response language and locale. Required when selecting a specific locale in a multilingual marketplace, such as fr-BE or fr-CA. |
| `identifier_type` | string ("RESTFUL" | "LEGACY") | Yes | How to interpret item_id: RESTFUL for an eBay RESTful item ID or LEGACY for a legacy listing ItemID. |
| `end_user_context` | string | No | eBay end-user context for affiliate attribution or buyer country and postal code used to improve shipping estimates. |
| `legacy_variation_id` | string | No | 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. |
| `legacy_variation_sku` | string | No | Seller-defined SKU for a specific variation. Valid only when identifier_type is LEGACY; do not combine with legacy_variation_id. |
| `quantity_for_shipping_estimate` | string | No | Positive integer quantity used to calculate shipping estimates. Do not use this parameter for auction listings. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Browse: Get Items

**Slug:** `EBAY_BUY_BROWSE_GET_ITEMS`

Retrieve details for up to 20 eBay items or 10 item groups in one request. This limited-release operation requires selected-partner access.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `item_ids` | string | No | Comma-separated RESTful item IDs to retrieve, with at most 20 IDs. Use this or item_group_ids, not both. |
| `item_group_ids` | string | No | Comma-separated item group IDs to retrieve, with at most 10 IDs. Use this or item_ids, not both. |
| `marketplace_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") | No | eBay marketplace ID. Required outside the US; defaults to EBAY_US. |
| `accept_language` | string | No | Preferred response locale, such as fr-BE or fr-CA. |
| `end_user_context` | string | No | End-user context for affiliate attribution or destination-based shipping estimates. |
| `quantity_for_shipping_estimate` | string | No | Positive integer quantity to use when calculating shipping estimates. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Browse: Get Items By Item Group

**Slug:** `EBAY_BUY_BROWSE_GET_ITEMS_BY_ITEM_GROUP`

Retrieve every purchasable item variation and shared description in an eBay Browse item group.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `fieldgroups` | string | No | Optional response expansion. Supported values include ADDITIONAL_SELLER_DETAILS and CHARITY_DETAILS. |
| `item_group_id` | string | Yes | Unique item-group identifier returned by Browse search or get-item results. |
| `marketplace_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") | No | eBay marketplace identifier; defaults to EBAY_US. |
| `accept_language` | string | No | Preferred response language and locale, such as fr-BE or fr-CA. |
| `end_user_context` | string | No | eBay end-user context for affiliate attribution or destination-specific shipping estimates. |
| `quantity_for_shipping_estimate` | string | No | Positive item quantity eBay should use to calculate shipping estimates; it must not exceed the available quantity. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Browse: Search

**Slug:** `EBAY_BUY_BROWSE_SEARCH`

Search 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

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Browse: Search By Image

**Slug:** `EBAY_BUY_BROWSE_SEARCH_BY_IMAGE`

Search 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sort` | string | No | Requested sort expression. Image search currently returns best-match results, so this parameter has no practical effect. |
| `image` | string | Yes | Bare Base64-encoded image data without a data-URI prefix. |
| `limit` | string | No | Items to return on this page as a numeric string (1-200). Default: 50. |
| `cursor` | string | No | Opaque cursor returned by a previous call. Repeat the same image when continuing; the cursor restores the original search selectors. |
| `filter` | string | No | Browse field filters in eBay syntax, separated by commas. |
| `offset` | string | No | Items to skip as a numeric string (0-9999). It must be zero or a multiple of limit. Use cursor for subsequent pages. |
| `charity_ids` | string | No | Up to 20 comma-separated charity registration IDs. This filter is supported by the US and UK marketplaces. |
| `fieldgroups` | string | No | Comma-separated response groups: ASPECT_REFINEMENTS, BUYING_OPTION_REFINEMENTS, CATEGORY_REFINEMENTS, CONDITION_REFINEMENTS, EXTENDED, MATCHING_ITEMS, or FULL. |
| `category_ids` | string | No | Category ID used to limit results. eBay currently permits one category per request even though the syntax accepts comma-separated IDs. |
| `aspect_filter` | string | No | Item-aspect filter in eBay syntax. Include the same category ID in category_ids and in this value, for example categoryId:15724,Color:{Red}. |
| `marketplace_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") | No | eBay marketplace identifier. Required outside the US; defaults to EBAY_US. |
| `accept_language` | string | No | Preferred response locale, required for a specific locale on multilingual marketplaces. |
| `end_user_context` | string | No | Affiliate and buyer-location context used for revenue sharing and more accurate shipping and delivery estimates. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Deal: Get Deal Items

**Slug:** `EBAY_BUY_DEAL_GET_DEAL_ITEMS`

Retrieve 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | string | No | Maximum deal items returned on one page, as a numeric string. |
| `cursor` | string | No | Opaque cursor returned by a previous call; it restores the original deal filters. |
| `offset` | string | No | Deal items to skip, as a numeric string. Use cursor for subsequent pages. |
| `category_id` | string | No | eBay category identifier used to filter deal items. |
| `commissionable` | string ("true" | "false") | No | Filter by commissionable status using true or false; supported only on EBAY_US. |
| `marketplace_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") | Yes | eBay marketplace identifier used to select the deal inventory. |
| `delivery_country` | string | No | Two-letter ISO country code to which returned items must be shippable. |
| `end_user_context` | string | No | Affiliate attribution and buyer-location context for revenue sharing and shipping estimates. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Deal: Get Event

**Slug:** `EBAY_BUY_DEAL_GET_EVENT`

Retrieve 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `event_id` | string | Yes | Unique identifier of the eBay event to retrieve. Use Deal: Get Events to discover event IDs. |
| `marketplace_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") | No | eBay marketplace identifier for which to retrieve the event. |
| `end_user_context` | string | No | End-user context for eBay Partner Network attribution and improved shipping or delivery estimates. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Deal: Get Event Items

**Slug:** `EBAY_BUY_DEAL_GET_EVENT_ITEMS`

Return 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | string | No | Maximum event items on this page as a numeric string (1-100). |
| `cursor` | string | No | Opaque cursor returned by a previous call; it restores the original filters. |
| `offset` | string | No | Number of matching event items to skip as a non-negative numeric string. |
| `event_id` | string | Yes | Single event ID returned by Deal: Get Events. |
| `category_id` | string | No | Optional single eBay category ID used to filter event items. |
| `marketplace_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") | No | eBay marketplace identifier; defaults to EBAY_US. |
| `delivery_country` | string | No | Two-letter ISO country code to return only items shippable there. |
| `end_user_context` | string | No | Affiliate and buyer-location context for revenue sharing and delivery estimates. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Deal: Get Events

**Slug:** `EBAY_BUY_DEAL_GET_EVENTS`

Return 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | string | No | Maximum events to return on this page as a numeric string (maximum 100). |
| `cursor` | string | No | Opaque cursor returned by a previous call to retrieve the next page. |
| `offset` | string | No | Events to skip as a numeric string. Use cursor rather than setting this directly when continuing a previous result set. |
| `marketplace_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") | No | eBay marketplace identifier for which to return events. |
| `end_user_context` | string | No | End-user context for eBay Partner Network attribution and improved shipping or delivery estimates. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Feed: Get Item Feed

**Slug:** `EBAY_BUY_FEED_GET_ITEM_FEED`

Download 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `date` | string | No | Daily feed date in yyyyMMdd format, 3 to 14 days in the past. Required for NEWLY_LISTED and ignored for ALL_ACTIVE. |
| `range` | string | Yes | Inclusive byte range for one gzip-file chunk, formatted as bytes=start-end. A production chunk cannot exceed 100 MiB. |
| `feed_scope` | string ("NEWLY_LISTED" | "ALL_ACTIVE") | Yes | Feed type to download. NEWLY_LISTED returns the daily feed and requires date; ALL_ACTIVE returns the latest weekly bootstrap feed. |
| `category_id` | string | Yes | Top-level eBay category ID for the feed. The category must belong to the selected marketplace and cannot be a Real Estate category. |
| `marketplace_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") | No | Case-sensitive eBay marketplace ID that owns the requested category. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Feed: Get Item Group Feed

**Slug:** `EBAY_BUY_FEED_GET_ITEM_GROUP_FEED`

Download an eBay Item Group feed gzip file, or an optional byte range, for a top-level category. The restricted Buy Feed API grant and eBay partner approval are required.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `date` | string | No | Daily feed date in yyyyMMdd format, 3 to 14 days in the past. Required for NEWLY_LISTED and ignored for ALL_ACTIVE. |
| `range` | string | No | Optional inclusive byte range for one gzip-file chunk, formatted as bytes=start-end. A production chunk cannot exceed 100 MiB. |
| `feed_scope` | string ("NEWLY_LISTED" | "ALL_ACTIVE") | Yes | Feed type to download. NEWLY_LISTED returns the daily Item Group feed and requires date; ALL_ACTIVE returns the latest weekly bootstrap feed. |
| `category_id` | string | Yes | Top-level eBay category ID for the feed. The category must belong to the selected marketplace and cannot be a Real Estate category. |
| `marketplace_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") | No | Case-sensitive eBay marketplace ID that owns the requested category. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Feed: Get Item Priority Feed

**Slug:** `EBAY_BUY_FEED_GET_ITEM_PRIORITY_FEED`

Download 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `date` | string | Yes | 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. |
| `range` | string | Yes | Inclusive byte range for one gzip-file chunk, formatted as bytes=start-end. A production chunk cannot exceed 100 MiB. |
| `category_id` | string | Yes | 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. |
| `marketplace_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") | No | Case-sensitive eBay marketplace ID that owns the requested category. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Feed: Get Item Snapshot Feed

**Slug:** `EBAY_BUY_FEED_GET_ITEM_SNAPSHOT_FEED`

Download 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `range` | string | Yes | Inclusive byte range for one gzip-file chunk, formatted as bytes=start-end. A production chunk cannot exceed 100 MiB. |
| `category_id` | string | Yes | Top-level eBay category ID for the snapshot feed. The category must belong to the selected marketplace and cannot be a Real Estate category. |
| `snapshot_date` | string | Yes | 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. |
| `marketplace_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") | No | Case-sensitive eBay marketplace ID that owns the requested category. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Marketing: Get Merchandised Products

**Slug:** `EBAY_BUY_MARKETING_GET_MERCHANDISED_PRODUCTS`

Return 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | string | No | Maximum products to return as an integer string from 1 through 100; eBay defaults to 8. |
| `category_id` | string | Yes | Single eBay category ID used to select products. |
| `aspect_filter` | string | No | Aspect name and value used to refine products within the category, such as Brand:Canon. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Charity: Get Charity Org

**Slug:** `EBAY_COMMERCE_CHARITY_GET_CHARITY_ORG`

Retrieve full details for one eBay-supported charitable organization by its charity organization ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `charity_org_id` | string | Yes | Unique eBay identifier of the charitable organization to retrieve. |
| `marketplace_id` | string ("EBAY_GB" | "EBAY_US") | No | eBay marketplace in which to retrieve the charity: EBAY_GB or EBAY_US. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Charity: Get Charity Orgs

**Slug:** `EBAY_COMMERCE_CHARITY_GET_CHARITY_ORGS`

Search supported eBay charitable organizations by keywords or registration IDs, returning one page of complete organization details and an opaque continuation cursor.

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Notification: Get Public Key

**Slug:** `EBAY_COMMERCE_NOTIFICATION_GET_PUBLIC_KEY`

Retrieve 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `public_key_id` | string | Yes | Unique public key ID decoded from the X-EBAY-SIGNATURE header of an eBay push notification. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Notification: Get Topic

**Slug:** `EBAY_COMMERCE_NOTIFICATION_GET_TOPIC`

Retrieve one eBay notification topic by ID, including its subscription scope requirements and supported payload configurations.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `topic_id` | string | Yes | Unique identifier of the notification topic to retrieve. Use Notification: Get Topics to discover topic IDs. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Notification: Get Topics

**Slug:** `EBAY_COMMERCE_NOTIFICATION_GET_TOPICS`

Return one page of eBay notification topics, including subscription scope requirements, supported payload configurations, and a continuation cursor.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum topics to return on this page (10-100). |
| `cursor` | string | No | Opaque cursor returned by a previous call to retrieve the next page. |
| `continuation_token` | string | No | Provider continuation token from a previous page's next URL. Prefer cursor when continuing a response returned by this action. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Taxonomy: Fetch Item Aspects

**Slug:** `EBAY_COMMERCE_TAXONOMY_FETCH_ITEM_ASPECTS`

Download the complete gzipped JSON item-aspect dataset for every leaf category in an eBay category tree. The compressed file can exceed 100 MB and this bulk operation has a substantially lower daily quota than other Taxonomy operations.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `category_tree_id` | string | Yes | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Taxonomy: Get Category Suggestions

**Slug:** `EBAY_COMMERCE_TAXONOMY_GET_CATEGORY_SUGGESTIONS`

Find ranked eBay leaf-category suggestions for free-form item keywords, including each category's ancestor path to the category-tree root.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `query` | string | Yes | Free-form phrases or keywords describing the item. eBay parses this text and ranks the leaf categories that best match it. |
| `category_tree_id` | string | Yes | Unique identifier of the eBay category tree to search. Retrieve a marketplace's tree ID with the get-default-category-tree-ID operation. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Taxonomy: Get Category Tree

**Slug:** `EBAY_COMMERCE_TAXONOMY_GET_CATEGORY_TREE`

Retrieve 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `accept_encoding` | string | No | Compression encoding accepted for the potentially large response. |
| `category_tree_id` | string | Yes | Unique eBay category tree identifier returned by the get default category tree ID operation. |
| `root_category_id` | string | No | Optional category identifier to use as the root of a subtree. Omit it to retrieve the complete category tree. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Taxonomy: Get Compatibility Properties

**Slug:** `EBAY_COMMERCE_TAXONOMY_GET_COMPATIBILITY_PROPERTIES`

Retrieve the localized vehicle properties that define compatibility for an eBay parts category, such as Make, Model, Year, Engine, and Trim.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `category_id` | string | Yes | Unique identifier of a category in the specified tree that supports parts compatibility for cars, trucks, or motorcycles. |
| `category_tree_id` | string | Yes | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Taxonomy: Get Compatibility Property Values

**Slug:** `EBAY_COMMERCE_TAXONOMY_GET_COMPATIBILITY_PROPERTY_VALUES`

Retrieve the applicable values of one vehicle compatibility property for an eBay parts category, optionally narrowed by other property-value pairs.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `filter` | string | No | 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. |
| `category_id` | string | Yes | Unique identifier of a category in the specified tree that supports parts compatibility for cars, trucks, or motorcycles. |
| `category_tree_id` | string | Yes | 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). |
| `compatibility_property` | string | Yes | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Taxonomy: Get Default Category Tree ID

**Slug:** `EBAY_COMMERCE_TAXONOMY_GET_DEFAULT_CATEGORY_TREE_ID`

Retrieve the identifier and version of the default eBay category tree for a marketplace. Use the returned identifier with other Taxonomy operations.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `marketplace_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") | Yes | Unique eBay marketplace identifier whose default category tree should be returned. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Taxonomy: Get Expired Categories

**Slug:** `EBAY_COMMERCE_TAXONOMY_GET_EXPIRED_CATEGORIES`

Retrieve 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `category_tree_id` | string | Yes | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Taxonomy: Get Item Aspects for Category

**Slug:** `EBAY_COMMERCE_TAXONOMY_GET_ITEM_ASPECTS_FOR_CATEGORY`

Retrieve complete eBay aspect metadata for a leaf category, including valid values, value dependencies, listing requirements, variation support, and format constraints.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `category_id` | string | Yes | Unique identifier of the leaf category whose item aspects should be returned; non-leaf categories are rejected. |
| `category_tree_id` | string | Yes | Unique eBay category tree identifier. Retrieve a marketplace's tree ID with the get-default-category-tree-ID operation. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Translation: Translate

**Slug:** `EBAY_COMMERCE_TRANSLATION_TRANSLATE`

Translate one eBay listing title or description from a supported source language to a supported target language without changing a listing.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `text` | array | Yes | 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. |
| `source_language` | string ("en" | "de" | "fr" | "it" | "es" | "pl" | "zh" | "ja") | Yes | 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. |
| `target_language` | string ("de" | "en" | "es" | "fr" | "it" | "ja" | "pl" | "pt" | "ru" | "zh") | Yes | 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. |
| `translation_context` | string ("ITEM_TITLE" | "ITEM_DESCRIPTION") | Yes | Listing text context, which determines the input text length limit. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Analytics: Get Rate Limits

**Slug:** `EBAY_DEVELOPER_ANALYTICS_GET_RATE_LIMITS`

Return application-level eBay API quota usage, remaining calls, and reset windows, optionally filtered by API context and name.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `api_name` | string | No | API name whose application-level rate limits should be returned, such as browse, inventory, taxonomy, or tradingapi. |
| `api_context` | string ("buy" | "sell" | "commerce" | "developer" | "tradingapi") | No | API context whose application-level rate limits should be returned. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Shopping API Unavailable

**Slug:** `EBAY_SHOPPING_UNAVAILABLE`

Compatibility-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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |