# eBay

> Manage your eBay seller account: inventory, listings, orders and business policies.

App · E-Commerce · 20 actions. Web page: https://docs.lodol.com/docs/integrations/ebay

## Actions

### Create inventory location

Create a location to ship from. An offer cannot be published without one.

**Inputs**

- Merchant location key (`merchant_location_key`, text, required): Your own key for this location, e.g. main-warehouse.
- Name (`name`, text, required): Display name for the location.
- Country (`country`, text, required): Two-letter country code, e.g. US. Default: `US`.
- Postal code (`postal_code`, text): Postal or ZIP code.
- City (`city`, text): City.
- State or province (`state_or_province`, text): State or province.
- Address line1 (`address_line1`, text): Street address.

**Outputs**

- `created` (true/false)
- `merchantLocationKey` (text)

**Example output**

```json
{
  "created": true,
  "merchantLocationKey": "example_value"
}
```

### Create offer

Create an unpublished offer for a SKU on one marketplace. Publish it afterwards to create the live listing.

**Inputs**

- SKU (`sku`, text, required): The seller-defined SKU of the inventory item. Use 'List inventory items' to find one.
- Marketplace ID (`marketplace_id`, text): The eBay marketplace to list on. One of: `EBAY_US` (United States), `EBAY_GB` (United Kingdom), `EBAY_DE` (Germany), `EBAY_AU` (Australia), `EBAY_CA` (Canada), `EBAY_FR` (France), `EBAY_IT` (Italy), `EBAY_ES` (Spain), `EBAY_AT` (Austria), `EBAY_BE` (Belgium), and 8 more. Default: `EBAY_US`.
- Category ID (`category_id`, text, required): eBay leaf category id, e.g. 9355. Find it by looking at a similar live listing, or in eBay's category lookup.
- Price (`price`, number, required): Listing price, e.g. 19.99. At least 0.
- Currency (`currency`, text): Currency for the price (3-letter code). Default: `USD`.
- Quantity (`quantity`, number): How many units this offer makes available. At least 0. Default: `1`.
- Merchant location key (`merchant_location_key`, text, required): The inventory location this offer ships from.
- Listing format (`listing_format`, text): Fixed price or auction. One of: `FIXED_PRICE` (Fixed Price), `AUCTION`. Default: `FIXED_PRICE`.
- Listing description (`listing_description`, text): Listing description. Falls back to the inventory item's description when empty.
- Fulfillment policy ID (`fulfillment_policy_id`, text): Shipping policy to apply. Required to publish.
- Payment policy ID (`payment_policy_id`, text): Payment policy to apply. Required to publish.
- Return policy ID (`return_policy_id`, text): Return policy to apply. Required to publish.

**Outputs**

- `created` (true/false)
- `offerId` (text)

**Example output**

```json
{
  "created": true,
  "offerId": "example_value"
}
```

### Create or replace inventory item

Create an inventory item for a SKU, or replace it if the SKU already exists. An inventory item is the product record; an offer turns it into a listing.

**Inputs**

- SKU (`sku`, text, required): Your own SKU for this product. Replaces the item if the SKU already exists.
- Title (`title`, text, required): Product title shown on the listing (max 80 characters).
- Description (`description`, text): Full product description. Accepts basic HTML.
- Condition (`condition`, text): The item's condition. One of: `NEW`, `LIKE_NEW` (Like New), `NEW_OTHER` (New Other), `NEW_WITH_DEFECTS` (New With Defects), `MANUFACTURER_REFURBISHED` (Manufacturer Refurbished), `SELLER_REFURBISHED` (Seller Refurbished), `USED_EXCELLENT` (Used Excellent), `USED_VERY_GOOD` (Used Very Good), `USED_GOOD` (Used Good), `USED_ACCEPTABLE` (Used Acceptable), `FOR_PARTS_OR_NOT_WORKING` (For Parts Or Not Working). Default: `NEW`.
- Quantity (`quantity`, number): How many units are available to ship. At least 0. Default: `1`.
- Image URLS (`image_urls`, list): Publicly reachable image URLs. eBay requires at least one image before an offer can be published.
- Brand (`brand`, text): Product brand. Supply with MPN, or leave both empty.
- Mpn (`mpn`, text): Manufacturer part number. Supply with Brand.
- Aspects (`aspects`, object): Item specifics, as an object of name to value, for example {"Type": "Tablet", "Screen Size": "10 in"}. Most eBay categories require their own; an offer missing one is rejected when its fees are previewed or it is published.
- Locale (`locale`, text): Language the product details are written in. One of: `en_US` (En Us), `en_GB` (En Gb), `en_AU` (En Au), `en_CA` (En Ca), `fr_CA` (Fr Ca), `de_DE` (De De), `fr_FR` (Fr Fr), `it_IT` (It It), `es_ES` (Es Es), `nl_NL` (Nl Nl).

**Outputs**

- `created` (true/false)
- `sku` (text)

**Example output**

```json
{
  "created": true,
  "sku": "example_value"
}
```

### Delete inventory item

Delete an inventory item and any unpublished offers against it.

**Inputs**

- SKU (`sku`, text, required): The seller-defined SKU of the inventory item. Use 'List inventory items' to find one.

**Outputs**

- `deleted` (true/false)
- `sku` (text)

**Example output**

```json
{
  "deleted": true,
  "sku": "example_value"
}
```

### Delete inventory location

Delete an inventory location.

**Inputs**

- Merchant location key (`merchant_location_key`, text, required): The location's key.

**Outputs**

- `deleted` (true/false)
- `merchantLocationKey` (text)

**Example output**

```json
{
  "deleted": true,
  "merchantLocationKey": "example_value"
}
```

### Delete offer

Delete an offer. Withdraw it first if it is published.

**Inputs**

- Offer ID (`offer_id`, text, required): The offer's eBay id. Comes from 'Create offer' or 'List offers for a SKU'.

**Outputs**

- `deleted` (true/false)
- `offerId` (text)

**Example output**

```json
{
  "deleted": true,
  "offerId": "example_value"
}
```

### Get inventory item

Fetch one inventory item by its SKU.

**Inputs**

- SKU (`sku`, text, required): The seller-defined SKU of the inventory item. Use 'List inventory items' to find one.

**Outputs**

- `item` (object)

**Example output**

```json
{
  "item": {
    "availability": {
      "shipToLocationAvailability": {
        "allocationByFormat": {
          "auction": 1,
          "fixedPrice": 1
        },
        "quantity": 1
      }
    },
    "condition": "example_value",
    "conditionDescription": "example_value",
    "locale": "example_value",
    "packageWeightAndSize": {
      "dimensions": {
        "height": 1,
        "length": 1,
        "unit": "example_value",
        "width": 1
      },
      "packageType": "example_value",
      "weight": {
        "unit": "example_value",
        "value": 1
      }
    },
    "product": {
      "aspects": {},
      "brand": "example_value",
      "description": "example_value",
      "epid": "example_value",
      "imageUrls": [],
      "mpn": "example_value",
      "title": "example_value"
    },
    "sku": "example_value"
  }
}
```

### Get listing fees

Preview the fees eBay would charge to publish an unpublished offer.

**Inputs**

- Offer ID (`offer_id`, text, required): The offer's eBay id. Comes from 'Create offer' or 'List offers for a SKU'.

**Outputs**

- `feeSummaries` (list)
- `offerId` (text)

**Example output**

```json
{
  "feeSummaries": [],
  "offerId": "example_value"
}
```

### Get offer

Fetch one offer by its id.

**Inputs**

- Offer ID (`offer_id`, text, required): The offer's eBay id. Comes from 'Create offer' or 'List offers for a SKU'.

**Outputs**

- `offer` (object)

**Example output**

```json
{
  "offer": {
    "availableQuantity": 1,
    "categoryId": "example_value",
    "format": "example_value",
    "listingDescription": "example_value",
    "listingId": "example_value",
    "listingPolicies": {
      "fulfillmentPolicyId": "example_value",
      "paymentPolicyId": "example_value",
      "returnPolicyId": "example_value"
    },
    "marketplaceId": "example_value",
    "merchantLocationKey": "example_value",
    "offerId": "example_value",
    "pricingSummary": {
      "minimumAdvertisedPrice": {
        "currency": "example_value",
        "value": "example_value"
      },
      "originallySoldForRetailPriceOn": "example_value",
      "price": {
        "currency": "example_value",
        "value": "example_value"
      }
    },
    "sku": "example_value",
    "status": "example_value",
    "tax": {
      "applyTax": true,
      "thirdPartyTaxCategory": "example_value",
      "vatPercentage": 1
    }
  }
}
```

### Get order

Fetch one order, including its line items and buyer.

**Inputs**

- Order ID (`order_id`, text, required): The order id, from 'List orders'.

**Outputs**

- `order` (object)

**Example output**

```json
{
  "order": {
    "buyer": {
      "taxAddress": {
        "countryCode": "example_value"
      },
      "username": "example_value"
    },
    "creationDate": "example_value",
    "fulfillmentStartInstructions": [],
    "lastModifiedDate": "example_value",
    "legacyOrderId": "example_value",
    "lineItems": [],
    "orderFulfillmentStatus": "example_value",
    "orderId": "example_value",
    "orderPaymentStatus": "example_value",
    "pricingSummary": {
      "deliveryCost": {
        "currency": "example_value",
        "value": "example_value"
      },
      "priceSubtotal": {
        "currency": "example_value",
        "value": "example_value"
      },
      "tax": {
        "currency": "example_value",
        "value": "example_value"
      },
      "total": {
        "currency": "example_value",
        "value": "example_value"
      }
    },
    "sellerId": "example_value"
  }
}
```

### List business policies

List your shipping, payment or return policies for one marketplace. An offer references these by id.

**Inputs**

- Policy type (`policy_type`, text): Which kind of policy to list. One of: `fulfillment`, `payment`, `return`. Default: `fulfillment`.
- Marketplace ID (`marketplace_id`, text): The marketplace the policies apply to. One of: `EBAY_US` (United States), `EBAY_GB` (United Kingdom), `EBAY_DE` (Germany), `EBAY_AU` (Australia), `EBAY_CA` (Canada), `EBAY_FR` (France), `EBAY_IT` (Italy), `EBAY_ES` (Spain), `EBAY_AT` (Austria), `EBAY_BE` (Belgium), and 8 more. Default: `EBAY_US`.

**Outputs**

- `policies` (list)
- `policyType` (text)
- `total` (number)

**Example output**

```json
{
  "policies": [],
  "policyType": "example_value",
  "total": 1
}
```

### List inventory items

List the SKUs defined on your eBay seller account.

**Inputs**

- Limit (`limit`, number): How many records to return (1-200). From 1 to 200. Default: `25`.
- Offset (`offset`, number): How many records to skip, for paging through results. At least 0. Default: `0`.

**Outputs**

- `items` (list)
- `total` (number)

**Example output**

```json
{
  "items": [],
  "total": 1
}
```

### List inventory locations

List the warehouses and stores you ship from.

**Inputs**

- Limit (`limit`, number): How many records to return (1-200). From 1 to 200. Default: `25`.
- Offset (`offset`, number): How many records to skip, for paging through results. At least 0. Default: `0`.

**Outputs**

- `locations` (list)
- `total` (number)

**Example output**

```json
{
  "locations": [],
  "total": 1
}
```

### List offers for a SKU

List every offer defined against one SKU.

**Inputs**

- SKU (`sku`, text, required): The seller-defined SKU of the inventory item. Use 'List inventory items' to find one.
- Limit (`limit`, number): How many records to return (1-200). From 1 to 200. Default: `25`.
- Offset (`offset`, number): How many records to skip, for paging through results. At least 0. Default: `0`.

**Outputs**

- `offers` (list)
- `total` (number)

**Example output**

```json
{
  "offers": [],
  "total": 1
}
```

### List orders

List orders placed with your seller account.

**Inputs**

- Order status (`order_status`, text): Only return orders with this fulfillment status. Leave empty for all. One of: `ACTIVE`, `COMPLETED`, `CANCELLED`.
- Limit (`limit`, number): How many records to return (1-200). From 1 to 200. Default: `25`.
- Offset (`offset`, number): How many records to skip, for paging through results. At least 0. Default: `0`.

**Outputs**

- `orders` (list)
- `total` (number)

**Example output**

```json
{
  "orders": [],
  "total": 1
}
```

### List shipments for an order

List the shipments recorded against an order, with tracking numbers.

**Inputs**

- Order ID (`order_id`, text, required): The order id, from 'List orders'.

**Outputs**

- `fulfillments` (list)
- `orderId` (text)

**Example output**

```json
{
  "fulfillments": [],
  "orderId": "example_value"
}
```

### Publish offer

Publish an offer, creating the live eBay listing. The offer needs a category, price, quantity, location and business policies first.

**Inputs**

- Offer ID (`offer_id`, text, required): The offer's eBay id. Comes from 'Create offer' or 'List offers for a SKU'.

**Outputs**

- `listingId` (text)
- `offerId` (text)
- `published` (true/false)

**Example output**

```json
{
  "listingId": "example_value",
  "offerId": "example_value",
  "published": true
}
```

### Update offer

Change an offer's price, quantity or description. Other settings are preserved.

**Inputs**

- Offer ID (`offer_id`, text, required): The offer's eBay id. Comes from 'Create offer' or 'List offers for a SKU'.
- Price (`price`, number): New price, e.g. 24.99. Leave empty to keep it. At least 0.
- Currency (`currency`, text): Currency for the new price (3-letter code).
- Quantity (`quantity`, number): New available quantity. Leave empty to keep it. At least 0.
- Listing description (`listing_description`, text): New listing description. Leave empty to keep it.

**Outputs**

- `offerId` (text)
- `updated` (true/false)

**Example output**

```json
{
  "offerId": "example_value",
  "updated": true
}
```

### Update price and quantity

Change a SKU's available quantity, an offer's price, or both. Changing a price needs the offer id, because price belongs to the offer rather than to the inventory item.

**Inputs**

- SKU (`sku`, text, required): The seller-defined SKU of the inventory item. Use 'List inventory items' to find one.
- Quantity (`quantity`, number): New available quantity. Leave empty to keep it. At least 0.
- Price (`price`, number): New price, e.g. 19.99. Requires the offer id below. At least 0.
- Currency (`currency`, text): Currency for the new price (3-letter code). Default: `USD`.
- Offer ID (`offer_id`, text): The offer whose price to change. Required with price.

**Outputs**

- `sku` (text)
- `updated` (true/false)

**Example output**

```json
{
  "sku": "example_value",
  "updated": true
}
```

### Withdraw offer

End the live listing for an offer. The offer itself is kept and can be published again.

**Inputs**

- Offer ID (`offer_id`, text, required): The offer's eBay id. Comes from 'Create offer' or 'List offers for a SKU'.

**Outputs**

- `listingId` (text)
- `offerId` (text)
- `withdrawn` (true/false)

**Example output**

```json
{
  "listingId": "example_value",
  "offerId": "example_value",
  "withdrawn": true
}
```