Docs
Open Lodol
DocumentationIntegrationsAPI

eBay

App · E-Commerce · 20 actions

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

Actions

ActionWhat it does
Create inventory locationCreate a location to ship from.
Create offerCreate an unpublished offer for a SKU on one marketplace.
Create or replace inventory itemCreate an inventory item for a SKU, or replace it if the SKU already exists.
Delete inventory itemDelete an inventory item and any unpublished offers against it.
Delete inventory locationDelete an inventory location.
Delete offerDelete an offer.
Get inventory itemFetch one inventory item by its SKU.
Get listing feesPreview the fees eBay would charge to publish an unpublished offer.
Get offerFetch one offer by its id.
Get orderFetch one order, including its line items and buyer.
List business policiesList your shipping, payment or return policies for one marketplace.
List inventory itemsList the SKUs defined on your eBay seller account.
List inventory locationsList the warehouses and stores you ship from.
List offers for a SKUList every offer defined against one SKU.
List ordersList orders placed with your seller account.
List shipments for an orderList the shipments recorded against an order, with tracking numbers.
Publish offerPublish an offer, creating the live eBay listing.
Update offerChange an offer's price, quantity or description.
Update price and quantityChange a SKU's available quantity, an offer's price, or both.
Withdraw offerEnd the live listing for an offer.

Create inventory location

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

Inputs

Merchant location keymerchant_location_keytextRequired
Your own key for this location, e.g. main-warehouse.
NamenametextRequired
Display name for the location.
CountrycountrytextRequired
Two-letter country code, e.g. US.Default: US.
Postal codepostal_codetext
Postal or ZIP code.
Citycitytext
City.
State or provincestate_or_provincetext
State or province.
Address line1address_line1text
Street address.

Outputs

createdtrue/false
merchantLocationKeytext
Example output
{
  "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

SKUskutextRequired
The seller-defined SKU of the inventory item. Use 'List inventory items' to find one.
Marketplace IDmarketplace_idtext
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 IDcategory_idtextRequired
eBay leaf category id, e.g. 9355. Find it by looking at a similar live listing, or in eBay's category lookup.
PricepricenumberRequired
Listing price, e.g. 19.99.At least 0.
Currencycurrencytext
Currency for the price (3-letter code).Default: USD.
Quantityquantitynumber
How many units this offer makes available.At least 0. Default: 1.
Merchant location keymerchant_location_keytextRequired
The inventory location this offer ships from.
Listing formatlisting_formattext
Fixed price or auction.One of: FIXED_PRICE (Fixed Price), AUCTION. Default: FIXED_PRICE.
Listing descriptionlisting_descriptiontext
Listing description. Falls back to the inventory item's description when empty.
Fulfillment policy IDfulfillment_policy_idtext
Shipping policy to apply. Required to publish.
Payment policy IDpayment_policy_idtext
Payment policy to apply. Required to publish.
Return policy IDreturn_policy_idtext
Return policy to apply. Required to publish.

Outputs

createdtrue/false
offerIdtext
Example output
{
  "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

SKUskutextRequired
Your own SKU for this product. Replaces the item if the SKU already exists.
TitletitletextRequired
Product title shown on the listing (max 80 characters).
Descriptiondescriptiontext
Full product description. Accepts basic HTML.
Conditionconditiontext
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.
Quantityquantitynumber
How many units are available to ship.At least 0. Default: 1.
Image URLSimage_urlslist
Publicly reachable image URLs. eBay requires at least one image before an offer can be published.
Brandbrandtext
Product brand. Supply with MPN, or leave both empty.
Mpnmpntext
Manufacturer part number. Supply with Brand.
Aspectsaspectsobject
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.
Localelocaletext
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

createdtrue/false
skutext
Example output
{
  "created": true,
  "sku": "example_value"
}

Delete inventory item

Delete an inventory item and any unpublished offers against it.

Inputs

SKUskutextRequired
The seller-defined SKU of the inventory item. Use 'List inventory items' to find one.

Outputs

deletedtrue/false
skutext
Example output
{
  "deleted": true,
  "sku": "example_value"
}

Delete inventory location

Delete an inventory location.

Inputs

Merchant location keymerchant_location_keytextRequired
The location's key.

Outputs

deletedtrue/false
merchantLocationKeytext
Example output
{
  "deleted": true,
  "merchantLocationKey": "example_value"
}

Delete offer

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

Inputs

Offer IDoffer_idtextRequired
The offer's eBay id. Comes from 'Create offer' or 'List offers for a SKU'.

Outputs

deletedtrue/false
offerIdtext
Example output
{
  "deleted": true,
  "offerId": "example_value"
}

Get inventory item

Fetch one inventory item by its SKU.

Inputs

SKUskutextRequired
The seller-defined SKU of the inventory item. Use 'List inventory items' to find one.

Outputs

itemobject
Example output
{
  "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 IDoffer_idtextRequired
The offer's eBay id. Comes from 'Create offer' or 'List offers for a SKU'.

Outputs

feeSummarieslist
offerIdtext
Example output
{
  "feeSummaries": [],
  "offerId": "example_value"
}

Get offer

Fetch one offer by its id.

Inputs

Offer IDoffer_idtextRequired
The offer's eBay id. Comes from 'Create offer' or 'List offers for a SKU'.

Outputs

offerobject
Example output
{
  "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 IDorder_idtextRequired
The order id, from 'List orders'.

Outputs

orderobject
Example output
{
  "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 typepolicy_typetext
Which kind of policy to list.One of: fulfillment, payment, return. Default: fulfillment.
Marketplace IDmarketplace_idtext
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

policieslist
policyTypetext
totalnumber
Example output
{
  "policies": [],
  "policyType": "example_value",
  "total": 1
}

List inventory items

List the SKUs defined on your eBay seller account.

Inputs

Limitlimitnumber
How many records to return (1-200).From 1 to 200. Default: 25.
Offsetoffsetnumber
How many records to skip, for paging through results.At least 0. Default: 0.

Outputs

itemslist
totalnumber
Example output
{
  "items": [],
  "total": 1
}

List inventory locations

List the warehouses and stores you ship from.

Inputs

Limitlimitnumber
How many records to return (1-200).From 1 to 200. Default: 25.
Offsetoffsetnumber
How many records to skip, for paging through results.At least 0. Default: 0.

Outputs

locationslist
totalnumber
Example output
{
  "locations": [],
  "total": 1
}

List offers for a SKU

List every offer defined against one SKU.

Inputs

SKUskutextRequired
The seller-defined SKU of the inventory item. Use 'List inventory items' to find one.
Limitlimitnumber
How many records to return (1-200).From 1 to 200. Default: 25.
Offsetoffsetnumber
How many records to skip, for paging through results.At least 0. Default: 0.

Outputs

offerslist
totalnumber
Example output
{
  "offers": [],
  "total": 1
}

List orders

List orders placed with your seller account.

Inputs

Order statusorder_statustext
Only return orders with this fulfillment status. Leave empty for all.One of: ACTIVE, COMPLETED, CANCELLED.
Limitlimitnumber
How many records to return (1-200).From 1 to 200. Default: 25.
Offsetoffsetnumber
How many records to skip, for paging through results.At least 0. Default: 0.

Outputs

orderslist
totalnumber
Example output
{
  "orders": [],
  "total": 1
}

List shipments for an order

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

Inputs

Order IDorder_idtextRequired
The order id, from 'List orders'.

Outputs

fulfillmentslist
orderIdtext
Example output
{
  "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 IDoffer_idtextRequired
The offer's eBay id. Comes from 'Create offer' or 'List offers for a SKU'.

Outputs

listingIdtext
offerIdtext
publishedtrue/false
Example output
{
  "listingId": "example_value",
  "offerId": "example_value",
  "published": true
}

Update offer

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

Inputs

Offer IDoffer_idtextRequired
The offer's eBay id. Comes from 'Create offer' or 'List offers for a SKU'.
Pricepricenumber
New price, e.g. 24.99. Leave empty to keep it.At least 0.
Currencycurrencytext
Currency for the new price (3-letter code).
Quantityquantitynumber
New available quantity. Leave empty to keep it.At least 0.
Listing descriptionlisting_descriptiontext
New listing description. Leave empty to keep it.

Outputs

offerIdtext
updatedtrue/false
Example output
{
  "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

SKUskutextRequired
The seller-defined SKU of the inventory item. Use 'List inventory items' to find one.
Quantityquantitynumber
New available quantity. Leave empty to keep it.At least 0.
Pricepricenumber
New price, e.g. 19.99. Requires the offer id below.At least 0.
Currencycurrencytext
Currency for the new price (3-letter code).Default: USD.
Offer IDoffer_idtext
The offer whose price to change. Required with price.

Outputs

skutext
updatedtrue/false
Example output
{
  "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 IDoffer_idtextRequired
The offer's eBay id. Comes from 'Create offer' or 'List offers for a SKU'.

Outputs

listingIdtext
offerIdtext
withdrawntrue/false
Example output
{
  "listingId": "example_value",
  "offerId": "example_value",
  "withdrawn": true
}

Dune

Previous Page

eBird

Next Page

On this page

ActionsCreate inventory locationCreate offerCreate or replace inventory itemDelete inventory itemDelete inventory locationDelete offerGet inventory itemGet listing feesGet offerGet orderList business policiesList inventory itemsList inventory locationsList offers for a SKUList ordersList shipments for an orderPublish offerUpdate offerUpdate price and quantityWithdraw offer