> For the complete documentation index, see [llms.txt](https://docs.stackai.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.stackai.com/integrations/catalog/ebay.md).

# eBay

Read eBay orders and manage listings, offers, and shipments on an eBay seller account.

### Connectors

Choose the connector that matches your authentication method. The options below use the names shown in StackAI.

| Connector | Authentication |
| --------- | -------------- |
| eBay      | OAuth sign-in  |

#### eBay

Connect an eBay seller account to read orders and manage listings, offers, and shipments. Renews itself automatically.

**Set up in eBay**

1. Use a eBay account with access to the records and operations that your workflow needs.
2. If your organization restricts application access or user consent, have its administrator approve the connection before you sign in.

**Set up in StackAI**

1. Open **Settings → Connections**, add a connection, and select **eBay**.
2. Select **Connect**, sign in to the provider account, and review the requested access. Complete authorization to return to StackAI.
3. Save the connection and check its connection status. Select this saved connection when configuring an action or feature that uses it.

StackAI obtains the OAuth credentials during sign-in. You do not need to paste an access token or refresh token.

#### Verify the connection

Check that the connection is healthy. Then run a read operation against a resource the connected account can access. A successful connection check confirms authentication; it does not guarantee permission for every action.

If access is denied, check the credential or OAuth permissions, the selected account or environment, and access to the specific resource. Update expired credentials or reconnect after permissions change.

### Use an action

1. Add the required **eBay** action to the workflow.
2. Select a connection when the action requests one.
3. Complete the required fields. Use the reference picker when a value comes from another workflow step.
4. Run the workflow and inspect the action’s output. Check the result before using it in a later step.

### Actions

#### Create or Replace Inventory Item

Save a product to eBay inventory as the item a listing is published from, with title, description, condition, quantity, and images. Creating the offer that puts it on sale is a separate step.

**Required permissions:** `https://api.ebay.com/oauth/api_scope/sell.inventory`.

**Inputs**

| Field                    | Type            | Required | Description                                                                                                                                                                                                                                                                                                                                                                  |
| ------------------------ | --------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| SKU                      | string          | Yes      | Your own identifier for this product. Reusing one replaces it.                                                                                                                                                                                                                                                                                                               |
| Title                    | string          | Yes      | The listing title buyers see. eBay allows 80 characters.                                                                                                                                                                                                                                                                                                                     |
| Description              | textarea        | Yes      | The listing description. Basic HTML is allowed.                                                                                                                                                                                                                                                                                                                              |
| Condition                | select (string) | Yes      | The item's condition. Supported values vary by eBay category. Available values: New, New other (see details), New with defects, Certified Refurbished, Excellent - Refurbished, Very Good - Refurbished, Good - Refurbished, Seller refurbished, Like New, Pre-owned - Excellent, Used - Excellent, Pre-owned - Fair, Very Good, Good, Acceptable, For parts or not working. |
| Quantity                 | integer         | Yes      | Units available to ship. 0 publishes as out of stock.                                                                                                                                                                                                                                                                                                                        |
| Image URLs               | array           | Yes      | Links to the product images. HTTPS only.                                                                                                                                                                                                                                                                                                                                     |
| Item aspects (JSON)      | textarea        | No       | Item specifics as a JSON object. eBay requires certain aspects per category.                                                                                                                                                                                                                                                                                                 |
| Content language         | string          | No       | Language of the title, description, and aspects. Defaults to the connection's marketplace.                                                                                                                                                                                                                                                                                   |
| Show advanced fields     | boolean         | No       | Reveal product identifiers, condition notes, and package size. Default: false.                                                                                                                                                                                                                                                                                               |
| Brand                    | string          | No       | The product's brand. Often required with an MPN.                                                                                                                                                                                                                                                                                                                             |
| Manufacturer Part Number | string          | No       | The manufacturer's part number, paired with the brand.                                                                                                                                                                                                                                                                                                                       |
| UPC                      | string          | No       | The product's UPC barcode, if it has one.                                                                                                                                                                                                                                                                                                                                    |
| EAN                      | string          | No       | The product's European Article Number, if it has one.                                                                                                                                                                                                                                                                                                                        |
| ISBN                     | string          | No       | The book's ISBN, if the product is a book.                                                                                                                                                                                                                                                                                                                                   |
| eBay Product ID (ePID)   | string          | No       | An eBay catalog product ID, to inherit its details.                                                                                                                                                                                                                                                                                                                          |
| Subtitle                 | string          | No       | An optional paid subtitle shown under the title.                                                                                                                                                                                                                                                                                                                             |
| Condition description    | textarea        | No       | Notes on wear. eBay ignores this for new items.                                                                                                                                                                                                                                                                                                                              |
| Package weight           | number          | No       | Shipping weight. Required for calculated shipping.                                                                                                                                                                                                                                                                                                                           |
| Weight unit              | select (string) | No       | Unit the package weight is given in. Available values: Pound, Ounce, Kilogram, Gram. Default: POUND.                                                                                                                                                                                                                                                                         |
| Package length           | number          | No       | Longest side of the package.                                                                                                                                                                                                                                                                                                                                                 |
| Package width            | number          | No       | Second side of the package.                                                                                                                                                                                                                                                                                                                                                  |
| Package height           | number          | No       | Shortest side of the package.                                                                                                                                                                                                                                                                                                                                                |
| Dimension unit           | select (string) | No       | Unit the package dimensions are given in. Available values: Inch, Foot, Centimetre, Metre. Default: INCH.                                                                                                                                                                                                                                                                    |

**Outputs**

| Field            | Type   | Description                                       |
| ---------------- | ------ | ------------------------------------------------- |
| SKU              | string | The SKU that was written.                         |
| Content language | string | The language declared for the listing text.       |
| Warnings         | array  | Notes eBay returned about the saved item, if any. |

#### Get Orders

Retrieve eBay orders, filtered by shipping status or by when they were placed or last changed.

**Required permissions:** `https://api.ebay.com/oauth/api_scope/sell.fulfillment`.

**Inputs**

| Field              | Type            | Required | Description                                                                                                                        |
| ------------------ | --------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------- |
| Fulfillment status | select (string) | No       | Narrow to orders still to ship, or to those already shipped. Available values: Any status, Not shipped yet, Shipped. Default: ANY. |
| Created after      | datetime        | No       | Only orders placed at or after this time.                                                                                          |
| Created before     | datetime        | No       | Only orders placed before this time.                                                                                               |
| Modified after     | datetime        | No       | Only orders changed at or after this time.                                                                                         |
| Modified before    | datetime        | No       | Only orders changed before this time.                                                                                              |
| Order IDs          | array           | No       | Fetch specific orders by ID. Overrides every filter above.                                                                         |
| Limit              | integer         | No       | Orders per page, up to 200. Default: 50.                                                                                           |
| Offset             | integer         | No       | How many orders to skip. Use the previous next\_offset. Default: 0.                                                                |

**Outputs**

| Field          | Type          | Description                                                   |
| -------------- | ------------- | ------------------------------------------------------------- |
| Orders         | object\_array | The matching orders, with buyer, totals, items, and ship-to.  |
| Total matching | integer       | How many orders match, across all pages.                      |
| Next offset    | integer       | Offset for the next page, empty when the listing is complete. |

#### Create Shipping Fulfillment

Mark line items of an eBay order as shipped and give the buyer a tracking number.

**Required permissions:** `https://api.ebay.com/oauth/api_scope/sell.fulfillment`.

**Inputs**

| Field                 | Type     | Required | Description                                                                   |
| --------------------- | -------- | -------- | ----------------------------------------------------------------------------- |
| Order ID              | string   | Yes      | The eBay order being shipped.                                                 |
| Line items            | textarea | Yes      | Which line items are in this package, and how many of each.                   |
| Tracking number       | string   | No       | The carrier's tracking number. Alphanumeric only, and needs the carrier code. |
| Shipping carrier code | string   | No       | The carrier's eBay code. Required with a tracking number.                     |
| Shipped date          | datetime | No       | When the package actually shipped. Defaults to now.                           |

**Outputs**

| Field               | Type    | Description                                  |
| ------------------- | ------- | -------------------------------------------- |
| Fulfillment ID      | string  | eBay's id for the shipment just recorded.    |
| Order ID            | string  | The order the shipment was recorded against. |
| Line items recorded | integer | How many line items went into this package.  |

#### Update Offer

Reprice or restock an eBay offer. A published offer's live listing changes immediately.

**Required permissions:** `https://api.ebay.com/oauth/api_scope/sell.inventory`.

**Inputs**

| Field              | Type    | Required | Description                                                                      |
| ------------------ | ------- | -------- | -------------------------------------------------------------------------------- |
| Offer ID           | string  | Yes      | The eBay offer to change.                                                        |
| Price              | number  | No       | The new price. Left unchanged when empty.                                        |
| Available quantity | integer | No       | The new quantity available. Left unchanged when empty.                           |
| Currency           | string  | No       | Only needed when the offer has no price yet. Otherwise the existing one is kept. |

**Outputs**

| Field              | Type    | Description                                               |
| ------------------ | ------- | --------------------------------------------------------- |
| Offer ID           | string  | The offer that was updated.                               |
| Price              | string  | The price now on the offer.                               |
| Currency           | string  | Currency of the price.                                    |
| Available quantity | integer | The quantity now available.                               |
| Listing ID         | string  | The live eBay listing revised, if the offer is published. |
| Warnings           | array   | Notes eBay returned about the update, if any.             |

#### Search Items

Search eBay listings by keyword or category, with price, condition, and format filters.

**Required permissions:** `https://api.ebay.com/oauth/api_scope`.

**Inputs**

| Field              | Type            | Required | Description                                                                                                                                                                                                         |
| ------------------ | --------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Search keywords    | string          | No       | Keywords to search for. Needed unless you give a category.                                                                                                                                                          |
| Category ID        | string          | No       | Restrict to one eBay category. Usable instead of keywords.                                                                                                                                                          |
| Minimum price      | number          | No       | Lowest price to include. Needs a currency.                                                                                                                                                                          |
| Maximum price      | number          | No       | Highest price to include. Needs a currency.                                                                                                                                                                         |
| Price currency     | string          | No       | Currency for the price bounds, e.g. USD.                                                                                                                                                                            |
| Condition          | select (string) | No       | Restrict to new or used items. Available values: Any, New, Used, Unspecified. Default: ANY.                                                                                                                         |
| Buying format      | select (string) | No       | Restrict to auctions, Buy It Now, and so on. Available values: Any, Buy It Now, Auction, Best Offer, Classified Ad. Default: ANY.                                                                                   |
| Free shipping only | boolean         | No       | Only items that ship free. Default: false.                                                                                                                                                                          |
| Sort by            | select (string) | No       | Ordering. Defaults to eBay's Best Match relevance. Available values: Best match, Price + shipping: lowest first, Price + shipping: highest first, Newly listed, Ending soonest, Distance: nearest first. Default: . |
| Limit              | integer         | No       | Results per page, up to 200. Default: 50.                                                                                                                                                                           |
| Offset             | integer         | No       | Results to skip. Use the previous next\_offset. Default: 0.                                                                                                                                                         |

**Outputs**

| Field          | Type          | Description                                            |
| -------------- | ------------- | ------------------------------------------------------ |
| Items          | object\_array | The matching listings with prices, sellers, and links. |
| Total matching | integer       | How many listings match in total.                      |
| Next offset    | integer       | Offset for the next page, empty when done.             |

### Important behavior

If an operation is denied, check the connection’s granted permissions and the account’s access in the provider. Reauthorize the connection when it needs additional permissions.

Actions that create, update, send, or delete data can change the connected service. Review their inputs before running them. A retry can repeat an operation; consider this when configuring retries for actions that change data.

The catalog lists the fields and capabilities available in the supplied provider definition. Availability can also depend on your deployment and organization’s Feature Access settings.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.stackai.com/integrations/catalog/ebay.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
