# eBay Listing Bulk Editor (Price, Title, Shipping) (`amicable_ironmonger/ebay-listing-editor`) Actor

Updates eBay listing prices, titles, and shipping settings in bulk using the official eBay Inventory REST API. No screen scraping — ToS-compliant. Supports SKU-based or Offer ID-based updates.

- **URL**: https://apify.com/amicable\_ironmonger/ebay-listing-editor.md
- **Developed by:** [Kai Shitashima](https://apify.com/amicable_ironmonger) (community)
- **Categories:** E-commerce
- **Stats:** 1 total users, 0 monthly users, 0.0% runs succeeded, NaN bookmarks
- **User rating**: No ratings yet

## Pricing

Pay per usage

This Actor is paid per platform usage. The Actor is free to use, and you only pay for the Apify platform usage, which gets cheaper the higher subscription plan you have.

Learn more: https://docs.apify.com/platform/actors/running/actors-in-store#pay-per-usage

## What's an Apify Actor?

Actors are a software tools running on the Apify platform, for all kinds of web data extraction and automation use cases.
In Batch mode, an Actor accepts a well-defined JSON input, performs an action which can take anything from a few seconds to a few hours,
and optionally produces a well-defined JSON output, datasets with results, or files in key-value store.
In Standby mode, an Actor provides a web server which can be used as a website, API, or an MCP server.
Actors are written with capital "A".

## How to integrate an Actor?

If asked about integration, you help developers integrate Actors into their projects.
You adapt to their stack and deliver integrations that are safe, well-documented, and production-ready.
The best way to integrate Actors is as follows.

In JavaScript/TypeScript projects, use official [JavaScript/TypeScript client](https://docs.apify.com/api/client/js.md):

```bash
npm install apify-client
```

In Python projects, use official [Python client library](https://docs.apify.com/api/client/python.md):

```bash
pip install apify-client
```

In shell scripts, use [Apify CLI](https://docs.apify.com/cli/docs.md):

````bash
# MacOS / Linux
curl -fsSL https://apify.com/install-cli.sh | bash
# Windows
irm https://apify.com/install-cli.ps1 | iex
```bash

In AI frameworks, you might use the [Apify MCP server](https://docs.apify.com/platform/integrations/mcp.md).

If your project is in a different language, use the [REST API](https://docs.apify.com/api/v2.md).

For usage examples, see the [API](#api) section below.

For more details, see Apify documentation as [Markdown index](https://docs.apify.com/llms.txt) and [Markdown full-text](https://docs.apify.com/llms-full.txt).


# README

## eBay Listing Bulk Editor (Price, Title, Shipping)

Updates eBay listing prices, titles, and shipping settings in bulk using the **official eBay Inventory REST API** — no screen scraping, fully ToS-compliant.

---

### What you can update

| Field | API | Notes |
|-------|-----|-------|
| Price | Offer API | Per listing, any currency |
| Free Shipping | Offer API | Toggle on/off |
| Title | Inventory Item API | Up to 80 characters |

---

### Prerequisites

eBay Developer account with OAuth credentials (same as eBay Tracking Uploader):

1. Sign up at [developer.ebay.com](https://developer.ebay.com)
2. Get **Client ID** and **Client Secret**
3. Get a **User Token** (Refresh Token) with `sell.inventory` scope:
   - Go to [developer.ebay.com/my/auth](https://developer.ebay.com/my/auth/?env=production&index=0)
   - Select scopes: `sell.inventory`
   - Copy the **Refresh Token** (~540 days valid)

---

### Input

| Field | Required | Description |
|-------|----------|-------------|
| `clientId` | ✅ | eBay Developer Client ID |
| `clientSecret` | ✅ | eBay Developer Client Secret |
| `refreshToken` | ✅ | OAuth Refresh Token with `sell.inventory` scope |
| `environment` | — | `production` (default) or `sandbox` |
| `marketplaceId` | — | e.g. `EBAY_US`, `EBAY_DE`, `EBAY_JP` (default: `EBAY_US`) |
| `listings` | ✅ | Array of listing updates (see below) |

#### Listing object

```json
{
  "sku": "MY-PRODUCT-001",
  "title": "Updated Product Title",
  "price": "29.99",
  "currency": "USD",
  "freeShipping": true
}
````

- `sku` or `offerId` must be provided
- All other fields are optional — only specified fields are updated
- You can specify `offerId` directly to skip the SKU lookup

***

### Output (Dataset)

```json
{
  "sku": "MY-PRODUCT-001",
  "offerId": "3456789012",
  "updatedFields": ["price=29.99USD", "freeShipping=true"],
  "status": "success",
  "processedAt": "2026-05-14T10:30:00.000Z"
}
```

***

### PPE Pricing

**$0.10 per successfully updated listing.**

Each listing uses 2–3 API calls (SKU lookup + offer update + optional item update). Rate limit: 5,000 calls/day.

***

### ⚠️ Notes

- Title updates require `sku` (not just `offerId`)
- Duplicate SKUs or offerIds in a single run are rejected to prevent race conditions
- Failed updates are reported in the dataset but do not halt the run
- Use `environment: "sandbox"` to test with dummy listings first

# Actor input Schema

## `clientId` (type: `string`):

Your eBay Developer application Client ID. Found at developer.ebay.com > Application Keys.

## `clientSecret` (type: `string`):

Your eBay Developer application Client Secret (Cert ID).

## `refreshToken` (type: `string`):

OAuth refresh token with sell.inventory scope. Generate at: developer.ebay.com > Get a User Token.

## `environment` (type: `string`):

Use 'sandbox' for testing, 'production' for live listings.

## `marketplaceId` (type: `string`):

Your eBay marketplace (e.g. EBAY\_US, EBAY\_DE, EBAY\_GB, EBAY\_JP).

## `listings` (type: `array`):

List of listing updates. Specify 'sku' or 'offerId' (or both). Only fields you include will be updated.

## Actor input object example

```json
{
  "environment": "production",
  "marketplaceId": "EBAY_US",
  "listings": [
    {
      "sku": "MY-PRODUCT-SKU-001",
      "title": "New Title Here",
      "price": "29.99",
      "currency": "USD",
      "freeShipping": true
    }
  ]
}
```

# API

You can run this Actor programmatically using our API. Below are code examples in JavaScript, Python, and CLI, as well as the OpenAPI specification and MCP server setup.

## JavaScript example

```javascript
import { ApifyClient } from 'apify-client';

// Initialize the ApifyClient with your Apify API token
// Replace the '<YOUR_API_TOKEN>' with your token
const client = new ApifyClient({
    token: '<YOUR_API_TOKEN>',
});

// Prepare Actor input
const input = {
    "environment": "production",
    "marketplaceId": "EBAY_US",
    "listings": [
        {
            "sku": "MY-PRODUCT-SKU-001",
            "title": "New Title Here",
            "price": "29.99",
            "currency": "USD",
            "freeShipping": true
        }
    ]
};

// Run the Actor and wait for it to finish
const run = await client.actor("amicable_ironmonger/ebay-listing-editor").call(input);

// Fetch and print Actor results from the run's dataset (if any)
console.log('Results from dataset');
console.log(`💾 Check your data here: https://console.apify.com/storage/datasets/${run.defaultDatasetId}`);
const { items } = await client.dataset(run.defaultDatasetId).listItems();
items.forEach((item) => {
    console.dir(item);
});

// 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/js/docs

```

## Python example

```python
from apify_client import ApifyClient

# Initialize the ApifyClient with your Apify API token
# Replace '<YOUR_API_TOKEN>' with your token.
client = ApifyClient("<YOUR_API_TOKEN>")

# Prepare the Actor input
run_input = {
    "environment": "production",
    "marketplaceId": "EBAY_US",
    "listings": [{
            "sku": "MY-PRODUCT-SKU-001",
            "title": "New Title Here",
            "price": "29.99",
            "currency": "USD",
            "freeShipping": True,
        }],
}

# Run the Actor and wait for it to finish
run = client.actor("amicable_ironmonger/ebay-listing-editor").call(run_input=run_input)

# Fetch and print Actor results from the run's dataset (if there are any)
print("💾 Check your data here: https://console.apify.com/storage/datasets/" + run["defaultDatasetId"])
for item in client.dataset(run["defaultDatasetId"]).iterate_items():
    print(item)

# 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/python/docs/quick-start

```

## CLI example

```bash
echo '{
  "environment": "production",
  "marketplaceId": "EBAY_US",
  "listings": [
    {
      "sku": "MY-PRODUCT-SKU-001",
      "title": "New Title Here",
      "price": "29.99",
      "currency": "USD",
      "freeShipping": true
    }
  ]
}' |
apify call amicable_ironmonger/ebay-listing-editor --silent --output-dataset

```

## MCP server setup

```json
{
    "mcpServers": {
        "apify": {
            "command": "npx",
            "args": [
                "mcp-remote",
                "https://mcp.apify.com/?tools=amicable_ironmonger/ebay-listing-editor",
                "--header",
                "Authorization: Bearer <YOUR_API_TOKEN>"
            ]
        }
    }
}

```

## OpenAPI specification

```json
{
    "openapi": "3.0.1",
    "info": {
        "title": "eBay Listing Bulk Editor (Price, Title, Shipping)",
        "description": "Updates eBay listing prices, titles, and shipping settings in bulk using the official eBay Inventory REST API. No screen scraping — ToS-compliant. Supports SKU-based or Offer ID-based updates.",
        "version": "0.1",
        "x-build-id": "OJ8drPBpd2WuQbi7o"
    },
    "servers": [
        {
            "url": "https://api.apify.com/v2"
        }
    ],
    "paths": {
        "/acts/amicable_ironmonger~ebay-listing-editor/run-sync-get-dataset-items": {
            "post": {
                "operationId": "run-sync-get-dataset-items-amicable_ironmonger-ebay-listing-editor",
                "x-openai-isConsequential": false,
                "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.",
                "tags": [
                    "Run Actor"
                ],
                "requestBody": {
                    "required": true,
                    "content": {
                        "application/json": {
                            "schema": {
                                "$ref": "#/components/schemas/inputSchema"
                            }
                        }
                    }
                },
                "parameters": [
                    {
                        "name": "token",
                        "in": "query",
                        "required": true,
                        "schema": {
                            "type": "string"
                        },
                        "description": "Enter your Apify token here"
                    }
                ],
                "responses": {
                    "200": {
                        "description": "OK"
                    }
                }
            }
        },
        "/acts/amicable_ironmonger~ebay-listing-editor/runs": {
            "post": {
                "operationId": "runs-sync-amicable_ironmonger-ebay-listing-editor",
                "x-openai-isConsequential": false,
                "summary": "Executes an Actor and returns information about the initiated run in response.",
                "tags": [
                    "Run Actor"
                ],
                "requestBody": {
                    "required": true,
                    "content": {
                        "application/json": {
                            "schema": {
                                "$ref": "#/components/schemas/inputSchema"
                            }
                        }
                    }
                },
                "parameters": [
                    {
                        "name": "token",
                        "in": "query",
                        "required": true,
                        "schema": {
                            "type": "string"
                        },
                        "description": "Enter your Apify token here"
                    }
                ],
                "responses": {
                    "200": {
                        "description": "OK",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/runsResponseSchema"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/acts/amicable_ironmonger~ebay-listing-editor/run-sync": {
            "post": {
                "operationId": "run-sync-amicable_ironmonger-ebay-listing-editor",
                "x-openai-isConsequential": false,
                "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.",
                "tags": [
                    "Run Actor"
                ],
                "requestBody": {
                    "required": true,
                    "content": {
                        "application/json": {
                            "schema": {
                                "$ref": "#/components/schemas/inputSchema"
                            }
                        }
                    }
                },
                "parameters": [
                    {
                        "name": "token",
                        "in": "query",
                        "required": true,
                        "schema": {
                            "type": "string"
                        },
                        "description": "Enter your Apify token here"
                    }
                ],
                "responses": {
                    "200": {
                        "description": "OK"
                    }
                }
            }
        }
    },
    "components": {
        "schemas": {
            "inputSchema": {
                "type": "object",
                "required": [
                    "clientId",
                    "clientSecret",
                    "refreshToken",
                    "listings"
                ],
                "properties": {
                    "clientId": {
                        "title": "eBay Client ID (App ID)",
                        "type": "string",
                        "description": "Your eBay Developer application Client ID. Found at developer.ebay.com > Application Keys."
                    },
                    "clientSecret": {
                        "title": "eBay Client Secret (Cert ID)",
                        "type": "string",
                        "description": "Your eBay Developer application Client Secret (Cert ID)."
                    },
                    "refreshToken": {
                        "title": "eBay Refresh Token",
                        "type": "string",
                        "description": "OAuth refresh token with sell.inventory scope. Generate at: developer.ebay.com > Get a User Token."
                    },
                    "environment": {
                        "title": "Environment",
                        "enum": [
                            "production",
                            "sandbox"
                        ],
                        "type": "string",
                        "description": "Use 'sandbox' for testing, 'production' for live listings.",
                        "default": "production"
                    },
                    "marketplaceId": {
                        "title": "Marketplace ID",
                        "type": "string",
                        "description": "Your eBay marketplace (e.g. EBAY_US, EBAY_DE, EBAY_GB, EBAY_JP).",
                        "default": "EBAY_US"
                    },
                    "listings": {
                        "title": "Listings to Update",
                        "type": "array",
                        "description": "List of listing updates. Specify 'sku' or 'offerId' (or both). Only fields you include will be updated.",
                        "default": [
                            {
                                "sku": "MY-PRODUCT-SKU-001",
                                "title": "New Title Here",
                                "price": "29.99",
                                "currency": "USD",
                                "freeShipping": true
                            }
                        ]
                    }
                }
            },
            "runsResponseSchema": {
                "type": "object",
                "properties": {
                    "data": {
                        "type": "object",
                        "properties": {
                            "id": {
                                "type": "string"
                            },
                            "actId": {
                                "type": "string"
                            },
                            "userId": {
                                "type": "string"
                            },
                            "startedAt": {
                                "type": "string",
                                "format": "date-time",
                                "example": "2025-01-08T00:00:00.000Z"
                            },
                            "finishedAt": {
                                "type": "string",
                                "format": "date-time",
                                "example": "2025-01-08T00:00:00.000Z"
                            },
                            "status": {
                                "type": "string",
                                "example": "READY"
                            },
                            "meta": {
                                "type": "object",
                                "properties": {
                                    "origin": {
                                        "type": "string",
                                        "example": "API"
                                    },
                                    "userAgent": {
                                        "type": "string"
                                    }
                                }
                            },
                            "stats": {
                                "type": "object",
                                "properties": {
                                    "inputBodyLen": {
                                        "type": "integer",
                                        "example": 2000
                                    },
                                    "rebootCount": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "restartCount": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "resurrectCount": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "computeUnits": {
                                        "type": "integer",
                                        "example": 0
                                    }
                                }
                            },
                            "options": {
                                "type": "object",
                                "properties": {
                                    "build": {
                                        "type": "string",
                                        "example": "latest"
                                    },
                                    "timeoutSecs": {
                                        "type": "integer",
                                        "example": 300
                                    },
                                    "memoryMbytes": {
                                        "type": "integer",
                                        "example": 1024
                                    },
                                    "diskMbytes": {
                                        "type": "integer",
                                        "example": 2048
                                    }
                                }
                            },
                            "buildId": {
                                "type": "string"
                            },
                            "defaultKeyValueStoreId": {
                                "type": "string"
                            },
                            "defaultDatasetId": {
                                "type": "string"
                            },
                            "defaultRequestQueueId": {
                                "type": "string"
                            },
                            "buildNumber": {
                                "type": "string",
                                "example": "1.0.0"
                            },
                            "containerUrl": {
                                "type": "string"
                            },
                            "usage": {
                                "type": "object",
                                "properties": {
                                    "ACTOR_COMPUTE_UNITS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "DATASET_READS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "DATASET_WRITES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "KEY_VALUE_STORE_READS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "KEY_VALUE_STORE_WRITES": {
                                        "type": "integer",
                                        "example": 1
                                    },
                                    "KEY_VALUE_STORE_LISTS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "REQUEST_QUEUE_READS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "REQUEST_QUEUE_WRITES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "DATA_TRANSFER_INTERNAL_GBYTES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "DATA_TRANSFER_EXTERNAL_GBYTES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "PROXY_SERPS": {
                                        "type": "integer",
                                        "example": 0
                                    }
                                }
                            },
                            "usageTotalUsd": {
                                "type": "number",
                                "example": 0.00005
                            },
                            "usageUsd": {
                                "type": "object",
                                "properties": {
                                    "ACTOR_COMPUTE_UNITS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "DATASET_READS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "DATASET_WRITES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "KEY_VALUE_STORE_READS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "KEY_VALUE_STORE_WRITES": {
                                        "type": "number",
                                        "example": 0.00005
                                    },
                                    "KEY_VALUE_STORE_LISTS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "REQUEST_QUEUE_READS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "REQUEST_QUEUE_WRITES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "DATA_TRANSFER_INTERNAL_GBYTES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "DATA_TRANSFER_EXTERNAL_GBYTES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "PROXY_SERPS": {
                                        "type": "integer",
                                        "example": 0
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}
```
