Connect to the eBay Sell API and get all your marketplace data automatically

Get central access to all your eBay data

Automate your data workflows

Become a truly data-driven marketplace seller

The eBay connector from Pipes

The selling platform eBay provides with its Sell API the possibility to retrieve all relevant data about your eBay seller business. With the eBay Sell API data connector from Data Virtuality Pipes you are able to connect your eBay account to your data warehouse without any coding. Just type in the corresponding credentials and create as many data pipelines as you like to automatically update all data about the following sections and more.

Through the eBay connector you retrieve data from the following sections:

Fulfillment API

With the eBay Fulfilment API you are able to retrieve detailed data about all orders like order value, shipping address, fulfillment status, payment method, status and more.

Inventory API

The Inventory API provides you with information about specific SKU records as well as lists with all your SKUs. With this endpoint the eBay Sell API delivers also all existing offers for a given SKU.

Finances API

Through eBay’s Finances API you are able to retrieve all relevant information on financial transactions like payouts, refunds, payment disputes etc. with the transaction value, status and more.

Marketing API

The eBay Marketing API provides you with all data on your eBay advertising campaigns (Promoted Listings) and price discounts (Promotions Manager). Get reports on the performance of your ad campaigns and discounted listings automatically.

For a detailed look at the available eBay seller information, check out the full eBay Sell API documentation here. If you’re missing data, a specific metric or a report eBay provides please let us know and we make it available for you through our eBay API data connector.

How Pipes works

Three simple steps in less than three minutes. 

Connect Your

Data Warehouse

Connect Your

Sources

Create Your

Pipelines

Play Video

Watch this 3 min demo to
learn how the eBay connector works

The pre-built eBay Sell API data templates from Pipes​

To enable quick and easy configuration of eBay data pipelines, Pipes provides pre-built eBay data templates. These contain data schemas that bundle meaningfully related metrics on a eBay seller business. Choose the eBay data template with the metrics you need, set a replication schedule, and configure and execute your eBay data pipeline. Below you can see all available eBay data templates and which metrics they contain.

eBay Sell API data templates:

Parameter Description
dayDate
clicksThe number of times a buyer saw a Promoted Listing and then clicked through to the listing page
impressionsThe number of times a Promoted Listing was rendered on a page
ctrClick-through-rate: clicks divided by impressions
ad_feesThe seller fees incurred from the sale of their Promoted Listings
ad_fees_currencyCurrency of the seller fees incurred from the sale of their Promoted Listings
salesThe number of sales
sale_amountTotal amount of sales
sale_amount_currencyCurrency of the total amount of sales
avg_cost_per_saleThe average fee per sale. ad_fees divided by sales
avg_cost_per_sale_currencyCurrency of the average fee per sale
Parameter Description
campaignIdA unique eBay-assigned ID for an ad campaign that’s generated when a campaign is created
adIdA unique eBay-assigned ID for the ad that is generated when the ad is created
bidPercentageThe user-defined bid percentage (also known as the ad rate) sets level to which eBay should raise the visibility of the associated listing across the eBay buyer flows. The value is also used to calculate the Promoted Listings fee. Minimum value: 1.0 Maximum value: 100.0
adGroupIdAd group id
adStatusAd status
listingIdA unique eBay-assigned ID that is generated when a listing is created
Parameter Description
campaign_idA unique eBay-assigned ID for an ad campaign. This ID is generated when a campaign is created
campaign_start_dateThe date and time the campaign starts
campaign_end_dateThe date and time the campaign ends
campaign_nameA seller-defined name for the campaign. This value must be unique for the seller
inventory_reference_idThe inventory reference ID associated with the ad you want returned. A seller’s inventory reference ID is the ID of either a listing or the ID of an inventory item group (the parent of a multi-variation listing, such as a shirt that is available in multiple sizes and colors)
inventory_reference_typeThe type of the inventory reference ID. Set this value to either INVENTORY_ITEM (a single listing) or INVENTORY_ITEM_GROUP (a multi-variation listing)
listing_idA unique eBay-assigned ID that is generated when a listing is created via the Trading API
listing_start_dateThe date and time the campaign starts
listing_end_dateThe date and time the campaign ends
listing_priceThe price of the item in the listing currency
listing_price_currencyCurrency of the price of the item in the listing currency
listing_quantity_availableQuantity available for the listing
listing_quantity_soldQuantity of items sold for the listing
listing_titleThe title of the listing
clicksThe number of times a buyer saw a Promoted Listing and then clicked through to the listing page
impressionsThe number of times a Promoted Listing was rendered on a page
ctrClick-through-rate: clicks divided by impressions
ad_feesThe seller fees incurred from the sale of their Promoted Listings
ad_fees_currencyCurrency of the seller fees incurred from the sale of their Promoted Listings
salesThe number of sales
sale_amountTotal amount of sales
sale_amount_currencyCurrency of the total amount of sales
avg_cost_per_saleThe average fee per sale. ad_fees divided by sales
avg_cost_per_sale_currencyCurrency of the average fee per sale
Parameter Description
dayDate
campaign_idA unique eBay-assigned ID for an ad campaign. This ID is generated when a campaign is created
campaign_start_dateThe date and time the campaign starts
campaign_end_dateThe date and time the campaign ends
campaign_nameA seller-defined name for the campaign. This value must be unique for the seller
clicksThe number of times a buyer saw a Promoted Listing and then clicked through to the listing page
impressionsThe number of times a Promoted Listing was rendered on a page
ctrClick-through-rate: clicks divided by impressions
ad_feesThe seller fees incurred from the sale of their Promoted Listings
ad_fees_currencyCurrency of the seller fees incurred from the sale of their Promoted Listings
salesThe number of sales
sale_amountTotal amount of sales
sale_amount_currencyCurrency of the total amount of sales
avg_cost_per_saleThe average fee per sale. ad_fees divided by sales
avg_cost_per_sale_currencyCurrency of the average fee per sale
Parameter Description
campaignIdA unique eBay-assigned ID for a campaign. This ID is generated when a campaign is created
campaignNameA seller-defined name for the campaign. This value must be unique for the seller. You can use any alphanumeric characters in the name, except the less than (<) or greater than (>) characters
campaignStatusIndicates the status of the campaign, such as RUNNING, PAUSED, and ENDED
startDateThe date and time the campaign starts
endDateThe date and time the campaign ends
marketplaceIdThe ID of the eBay marketplace where the campaign is hosted
campaignCriterion_autoSelectFutureInvent…Reserved for future use
campaignCriterion_criterionTypeThis enum defines the criterion (selection rule) types. Currently, the only criterion type supported is INVENTORY_PARTITION, and you must specify this value if you manage your items with the Inventory API and you want to include items based on their inventory reference IDs. Leave this field blank if you want to create campaign ads based on listing IDs
fundingStrategy_bidPercentageThe user-defined bid percentage (also known as the ad rate) sets the level that eBay increases the visibility in search results for the associated listing. The higher the bidPercentage value, the more eBay promotes the listing. The value specified here is also used to calculate the Promoted Listings fee. This percentage value is multiplied by the final sales price to determine the fee. The Promoted Listings fee is determined at the time the transaction completes and the seller is assessed the fee only when an item sells through a Promoted Listings ad campaign. bidPercentage is a single precision value that is guided by the following rules: If a bid percentage is not provided for an ad, eBay uses the default bid percentage of the associated campaign.Minimum value: 1.0 Maximum value: 100.0
fundingStrategy_fundingModelIndicates the model that eBay uses to calculate the Promoted Listings fee. Currently, only COST_PER_SALE is supported
Parameter Description
categoryIdThe unique identifier of this eBay category
categoryNameThe name of this eBay category
categoryTreeIdThe unique identifier of this eBay category tree
categoryTreeNodeLevelThe absolute level of the current category tree node in the hierarchy of its category tree
categoryTreeVersionThe version of this category tree. It’s a good idea to cache this value for comparison so you can determine if this category tree has been modified in subsequent calls
leafCategoryTreeNodeA value of true indicates that the current category tree node is a leaf node (it has no child nodes). A value of false indicates that the current node has one or more child nodes, which are identified by the childCategoryTreeNodes array. Returned only if the value of this field is true
parent_categoryId
Parameter Description
nameA user-defined name for this fulfillment policy. Names must be unique for policies assigned to the same marketplace
descriptionAn optional seller-defined description of the fulfillment policy for internal use (this value is not displayed to end users)
categoryTypesThe CategoryTypeEnum value to which this policy applies. Used to discern accounts that sell motor vehicles from those that don’t. (Currently, each policy can be set to only one categoryTypes value at a time.)
marketplaceIdThe ID of the eBay marketplace to which this fulfillment policy applies. If this value is not specified, value defaults to the seller’s eBay registration site
freightShippingIf set to true, the seller offers freight shipping. Freight shipping can be used for large items over 150 lbs
fulfillmentPolicyIdA unique eBay-assigned ID for the fulfillment policy. This ID is generated when the policy is created
globalShippingIf set to true, the seller has opted-in to the eBay and that they use that service for their international shipments. Setting this value automatically sets the international shipping service for the policy to International Priority Shipping and the buyer does not need to set any other shipping services for their INTERNATIONAL shipping options (unless they sell items not covered by the Global Shipping Program). If this value is set to false, the seller is responsible for manually specifying the international shipping services, as described in . To opt-in to the Global Shipping Program, log in to eBay and navigate to My Account > Site Preferences > Shipping preferences
handlingTime_unitA time-measurement unit that specifies a singular period of time. A span of time is defined when you apply the value specified in the value field to the value specified for unit. Time-measurement units can be YEAR, MONTH, DAY, and so on. See TimeDurationUnitEnum for a complete list of possible time-measurement units
handlingTime_valueAn integer that represents an amount of time, as measured by the time-measurement unit specified in the unit field
pickupDropOffIf set to true, the seller offers the “Click and Collect” feature. Click and Collect is supported by the Inventory API, and it can be used with Add/Revise/Relist calls. To enable “Click and Collect”, a seller (1) must be eligible for Click and Collect and (2) must set this boolean field to ‘true’. Currently, Click and Collect is available to only large retail merchants selling in the eBay AU and UK marketplaces. In addition to setting this field, the merchant must also do the following to enable the “Click and Collect” option on a listing: When a UK merchant successfully lists an item with Click and Collect, prospective buyers within a reasonable distance from one of the merchant’s stores (that has stock available) will see the “Available for Click and Collect” option on the listing, along with information on the closest store that has the item
shipToLocations_regionExcludedA list of one or more regionsName fields that specify the areas to where a seller does not ship
shipToLocations_regionIncludedA list of one or more regionsName fields that specify the areas to where a seller ships
shippingOptions_costTypeDefines whether the shipping cost is FLAT_RATE (the same rate for all buyers), CALCULATED (the shipping rate varies by the ship-to location and size and weight of the package, as defined by the item), or NOT_SPECIFIED (for use with local pickup)
shippingOptions_insuranceFee_currencyThe base currency applied to the value field to establish a monetary amount. The currency is represented as a 3-letter currency code. For example, the code for the Canadian Dollar is CAD
shippingOptions_insuranceFee_valueThe monetary amount in the specified currency
shippingOptions_insuranceOfferedThis field has been deprecated. Shipping insurance is offered only via a shipping carrier’s shipping services and is no longer available via eBay shipping policies
shippingOptions_optionTypeUse this field to set the ShippingOption element to either DOMESTIC or INTERNATIONAL
shippingOptions_shippingServices_additio…The base currency applied to the value field to establish a monetary amount. The currency is represented as a 3-letter currency code. For example, the code for the Canadian Dollar is CAD
shippingOptions_shippingServices_additio…The monetary amount in the specified currency
shippingOptions_shippingServices_buyerRe…This field is only applicable to vehicle categories on eBay Motors (US and Canada). If set to true, the buyer is responsible for picking up the vehicle. Otherwise, the seller should specify the vehicle pickup arrangements in the item description. The seller cannot modify this flag if the vehicle has bids or if the listing ends within 12 hours
shippingOptions_shippingServices_buyerRe…This field is applicable for only items listed in vehicle categories on eBay Motors (US and Canada). If set to true, the buyer is responsible for the shipment of the vehicle. Otherwise, the seller should specify the vehicle shipping arrangements in the item description. The seller cannot modify this flag if the vehicle has bids or if the listing ends within 12 hours
shippingOptions_shippingServices_freeShi…If set to true, the seller offers free shipping to the buyer. This field can only be included and set to ‘true’ for the first domestic shipping service option specified in the shippingServices container (it is ignored if set for subsequent shipping services). The first specified shipping service option has a sortOrder value of 1 or (if the sortOrderId field is not used) it is the shipping service option that’s specified first in the shippingServices container
shippingOptions_shippingServices_shippin…The shipping carrier, such as ‘USPS’, ‘FedEx’, ‘UPS’, and so on
shippingOptions_shippingServices_shippin…The base currency applied to the value field to establish a monetary amount. The currency is represented as a 3-letter currency code. For example, the code for the Canadian Dollar is CAD
shippingOptions_shippingServices_shippin…The monetary amount in the specified currency
shippingOptions_shippingServices_shippin…The shipping service that the shipping carrier uses to ship an item. For example, an overnight, two-day delivery, or other type of service. For details on configuring shipping services, see
shippingOptions_shippingServices_sortOrd…This integer value controls the order that this shipping service option appears in the View Item and Checkout pages, as related to the other specified shipping service options. Sellers can specify up to four domestic shipping services (in four separate shippingService containers), so valid values are 1, 2, 3, and 4. A shipping service option with a sortOrder value of ‘1’ appears at the top of View Item and Checkout pages. Conversely, a shipping service option with a sortOrder value of ‘4’ appears at the bottom of the list. Sellers can specify up to five international shipping services (in five separate shippingService containers, so valid values for international shipping services are 1, 2, 3, 4, and 5. Similarly to domestic shipping service options, the sortOrder value of a international shipping service option controls the placement of that shipping service option in the View Item and Checkout pages. Set up different domestic and international services by configuring two shippingOptions containers, where you set shippingOptions.optionType to either DOMESTIC or INTERNATIONAL to indicate the area supported by the listed shipping services. If the sortOrder field is not supplied, the order of domestic and international shipping service options is determined by the order in which they are listed in the API call. Min: 1. Max: 4 (for domestic shipping service) or 5 (for international shipping service)
Parameter Description
skuThe seller-defined Stock-Keeping Unit (SKU) of the inventory item. The seller should have a unique SKU value for every product that they sell
product_upcThe Universal Product Code (UPC) value for the product. Although an ePID value is preferred when trying to find a product match in the eBay Catalog, this field can also be used in an attempt to find a product match in the eBay Catalog. If a product match is found in the eBay Catalog, the inventory item is automatically populated with available product details such as a title, a product description, product aspects (including the specified UPC value), and a link to any stock image that exists for the catalog product.This field is returned if defined for an inventory item. If a UPC was passed in as an item specific name-value pair through the array in a call, this value is also picked up by the field
product_titleThe title of an inventory item can be added or modified with a call. Although not immediately required, a title will be needed before an offer with the inventory item is published. The title of an inventory item is automatically populated if the seller specifies an eBay Product ID (ePID) or a Global Trade Item Number (GTIN) and eBay is able to find a matching product in the eBay Catalog. If the inventory item will become part of a single-variation offer, and the listing is not a product-based listing, the text in this field will become the actual listing title for the published offer. However, if the inventory item will become part of a multiple-variation offer, the text in field of the inventory item group entity will actually become the listing title for the published offer instead, although a title can still be provided for the inventory item, and it will actually become the title of the variation.This field will always be returned for an inventory item that is part of a published offer since a published offer will always have a listing title, but this field will only be returned if defined for inventory items that are not a part of a published offer
product_subtitleA subtitle is an optional listing feature that allows the seller to provide more information about the product, possibly including keywords that may assist with search results. An additional listing fee will be charged to the seller if a subtitle is used. For more information on using listing subtitles on the US site, see the help page. The subtitle of an existing inventory item can added, modified, or removed with a call.Note that the same text should be used for each inventory item that will be part of an inventory item group, and ultimately become one product variation within a multiple-variation listing.This field will only be returned if set for an inventory item
availability_shipToLocationAvailability_…This container is used to set the total ‘ship-to-home’ quantity of the inventory item that will be available for purchase through one or more published offers. This container is not immediately required, but ‘ship-to-home’ quantity must be set before an offer of the inventory item can be published.If an existing inventory item is being updated, and the ‘ship-to-home’ quantity already exists for the inventory item record, this container should be included again, even if the value is not changing, or the available quantity data will be lost
conditionThis enumeration value indicates the condition of the item. Supported item condition values will vary by eBay site and category. To see which item condition values that a particular eBay category supports, use the method of the . This method returns condition ID values that map to the enumeration values defined in the type. The topic in the has a table that maps condition ID values to values. The call reference page has more information. Since the condition of an inventory item must be specified before being published in an offer, this field is always returned in the ‘Get’ calls for SKUs that are part of a published offer. If a SKU is not part of a published offer, this container will only be returned if set for the inventory item
packageWeightAndSize_dimensions_heightThe actual height (in the measurement unit specified in the field) of the shipping package. All fields of the container are required if package dimensions are specified. If a shipping package measured 21.5 inches in length, 15.0 inches in width, and 12.0 inches in height, the container would look as follows: “dimensions”: { “length”: 21.5, “width”: 15.0, “height”: 12.0, “unit”: “INCH” }
packageWeightAndSize_dimensions_lengthThe actual length (in the measurement unit specified in the field) of the shipping package. All fields of the container are required if package dimensions are specified. If a shipping package measured 21.5 inches in length, 15.0 inches in width, and 12.0 inches in height, the container would look as follows: “dimensions”: { “length”: 21.5, “width”: 15.0, “height”: 12.0, “unit”: “INCH” }
packageWeightAndSize_dimensions_unitThe unit of measurement used to specify the dimensions of a shipping package. All fields of the container are required if package dimensions are specified. If the English system of measurement is being used, the applicable values for dimension units are FEET and INCH. If the metric system of measurement is being used, the applicable values for weight units are METER and CENTIMETER. The metric system is used by most countries outside of the US
packageWeightAndSize_dimensions_widthThe actual width (in the measurement unit specified in the field) of the shipping package. All fields of the container are required if package dimensions are specified. If a shipping package measured 21.5 inches in length, 15.0 inches in width, and 12.0 inches in height, the container would look as follows: “dimensions”: { “length”: 21.5, “width”: 15.0, “height”: 12.0, “unit”: “INCH” }
packageWeightAndSize_weight_unitThe unit of measurement used to specify the weight of a shipping package. Both the and fields are required if the container is used. If the English system of measurement is being used, the applicable values for weight units are POUND and OUNCE. If the metric system of measurement is being used, the applicable values for weight units are KILOGRAM and GRAM. The metric system is used by most countries outside of the US
packageWeightAndSize_weight_valueThe actual weight (in the measurement unit specified in the field) of the shipping package. Both the and fields are required if the container is used. If a shipping package weighed 20.5 ounces, the container would look as follows: “weight”: { “value”: 20.5, “unit”: “OUNCE” }
product_aspectsThis is an array of item specific pairs that provide more information about the product and might make it easier for buyers to find. To view required/recommended product aspects/item specifics names (and corresponding values) for a specific eBay category, sellers can use the call of the Trading API. Alternatively, sellers can view similar items on eBay.com in the same category to get an idea of what other sellers are using for product aspects/item specifics.Sellers also have the option of specifying an eBay Product ID (ePID) or optionally, a Global Trade Item Number (GTIN) through the corresponding fields in the container in an attempt to find a product match in the eBay Catalog. If a match is found based on the ePID or GTIN value, the product aspects that are defined for the eBay Catalog product will automatically get picked up by the newly created/updated inventory item. Below is an example of the proper JSON syntax to use when manually inputting item specifics: “aspects”: { “Brand”: [“GoPro”], “Storage Type”: [“Removable”] }Note that inventory items that will become part of an inventory item group and multiple-variation listing should have the same attributes that are defined for the inventory item group.This container will be returned if one or more item specific pairs are defined for the inventory item
product_brandThe brand of the product. This field is often paired with the field to identify a specific product by Manufacture Part Number. This field is conditionally required if the eBay category requires a Manufacturer Part Number (MPN) value. If eBay is able to find a product match in the eBay Catalog when an eBay Product ID (ePID) or GTIN value (UPC, ISBN, or EAN) is supplied, all product details of that eBay Catalog product is picked up by the inventory item record (including brand) if the call is successful. This field is returned if defined for an inventory item. If a brand was passed in as an item specific name-value pair through the array in a call, this value is also picked up by the field
product_descriptionThe description of the product. The description of an existing inventory item can be added or modified with a call. The description of an inventory item is automatically populated if the seller specifies an eBay Product ID (ePID) or a Global Trade Item Number (GTIN) and eBay is able to find a matching product in the eBay Catalog.Note that this field is optional but recommended. If a field is omitted when creating and publishing a single-variation offer, the text in this field will be used instead. If neither the field for the inventory item nor the field for the offer exist, the call will fail. If the inventory item will be part of an inventory item group/multiple-variation listing, this field should definitely be used to specify how the corresponding product variation is different (e.g. ). However, in the case of an inventory item group, the text in the field of the inventory item group will become the listing description of the actual eBay listing instead of the text in this field.Basic HTML tags are supported, including the following tags:A seller can not use any active content in their listing description. Active content includes animation or video via JavaScript, Flash, plug-ins, or form actions.This field is returned if defined for an inventory item. If one of the GTIN types (e.g. UPC) was passed in when the inventory item was created/modified and a product match was found in the eBay catalog, product description is one of the details that gets picked up from the catalog product
product_imageUrlsAn array of one or more links to images for the product. URLs must use the “HTTPS” protocol. Images can be self-hosted by the seller, or sellers can use the call of the Trading API to upload images to an eBay Picture Server. If successful, the response of the call will contain a full URL to the image on an eBay Picture Server. This is the URL that will be passed in through the array. Before an offer can be published, at least one image must exist for the inventory item. Most eBay sites support up to 12 pictures free of charge, and eBay Motors listings can have up to 24 pictures.A link to a stock image for a product may automatically be populated for an inventory item if the seller specifies an eBay Product ID (ePID) or a Global Trade Item Number (GTIN) and eBay is able to find a matching product in the eBay Catalog.This container will always be returned for an inventory item that is part of a published offer since a published offer will always have at least one picture, but this container will only be returned if defined for inventory items that are not a part of a published offer
Parameter Description
complianceTypeThis enumeration value indicates the compliance type of listing violation. See for more information on each compliance type. This will always be returned for each listing violation that is found
listingIdThe unique identifier of the eBay listing that currently has the corresponding listing violation{s). This field will always be returned for each listing that has one or more violations
violations_messageThis field provides a textual summary of the listing violation. A field is returned for each listing violation. This message will vary widely based on the compliance type and corresponding reason code
violations_reasonCodeThis value states the nature of the listing violation. A value is returned for each listing violation, and each compliance type can have several reason codes and related messages. The values vary by compliance type. The reason codes for each compliance type are summarized below.The reason codes for ASPECTS_ADOPTION compliance indicate that for the given violation, aspects listed in the container are either missing from the listing or they have invalid values. The reason codes specify whether the violation is for required aspects or recommended (preferred) aspects.The reason codes for HTTPS compliance identify where in the listing the violation occurs. For HTTPS policy violations, the seller will just need to remove the HTTP link (or update to HTTPS) from the listing details or product details: The reason codes for OUTSIDE_EBAY_BUYING_AND_SELLING compliance identify the specific type of data (e.g., telephone number) that violated the policy. For each of these violations, the seller will just need to revise the listing, removing this information:Product Adoption is not enforced at this time.Product Adoption is not enforced at this time.The only RETURNS_POLICY reason code is UNSUPPORTED_RETURNS_PERIOD. The seller will have to revise their listing (or return business policy) with a supported return period for the site and category. The call of the Trading API can be used to verify the supported return periods for a particular category. For most eBay categories, the minimum return period that can be stated in a Returns Policy is 14 days for domestic and international sales, but some categories require a minimum 30-day return period
Parameter Description
campaign_idA unique eBay-assigned ID for an ad campaign. This ID is generated when a campaign is created
campaign_start_dateThe date and time the campaign starts
campaign_end_dateThe date and time the campaign ends
campaign_nameA seller-defined name for the campaign. This value must be unique for the seller
inventory_reference_idThe inventory reference ID associated with the ad you want returned. A seller’s inventory reference ID is the ID of either a listing or the ID of an inventory item group (the parent of a multi-variation listing, such as a shirt that is available in multiple sizes and colors)
inventory_reference_typeThe type of the inventory reference ID. Set this value to either INVENTORY_ITEM (a single listing) or INVENTORY_ITEM_GROUP (a multi-variation listing)
listing_idA unique eBay-assigned ID that is generated when a listing is created via the Trading API
listing_start_dateThe date and time the campaign starts
listing_end_dateThe date and time the campaign ends
listing_priceThe price of the item in the listing currency
listing_price_currencyCurrency of the price of the item in the listing currency
listing_quantity_availableQuantity available for the listing
listing_quantity_soldQuantity of items sold for the listing
listing_titleThe title of the listing
clicksThe number of times a buyer saw a Promoted Listing and then clicked through to the listing page
impressionsThe number of times a Promoted Listing was rendered on a page
ctrClick-through-rate: clicks divided by impressions
ad_feesThe seller fees incurred from the sale of their Promoted Listings
ad_fees_currencyCurrency of the seller fees incurred from the sale of their Promoted Listings
salesThe number of sales
sale_amountTotal amount of sales
sale_amount_currencyCurrency of the total amount of sales
avg_cost_per_saleThe average fee per sale. ad_fees divided by sales
avg_cost_per_sale_currencyCurrency of the average fee per sale
Parameter Description
orderIdThe unique identifier of the order. Both the legacyOrderId field (traditionally used by Trading and other legacy APIS) and this field are always returned
legacyOrderIdThe unique identifier of the order in legacy format, as traditionally used by the Trading API (and other legacy APIs). Both the orderId field and this field are always returned
orderFulfillmentStatusThe degree to which fulfillment of the order is complete. See the type definition for more information about each possible fulfillment state
orderPaymentStatusThe enumeration value returned in this field indicates the current payment status of an order, or in case of a refund request, the current status of the refund. See the type definition for more information about each possible payment/refund state
creationDateThe date and time that the order was created. This timestamp is in ISO 8601 format, which uses the 24-hour Universal Coordinated Time (UTC) clock
lastModifiedDateThe date and time that the order was last modified. This timestamp is in ISO 8601 format, which uses the 24-hour Universal Coordinated Time (UTC) clock
buyerCheckoutNotesThis field contains any comments that the buyer left for the seller about the order during checkout process. This field is only returned if a buyer left comments at checkout time
buyer_usernameThe buyer’s eBay user ID
cancelStatus_cancelStateThe state of the order with regard to cancellation. This field is always returned, and if there are no cancellation requests, a value of NONE_REQUESTED is returned
ebayCollectAndRemitTaxThis field is only returned if true, and indicates that eBay will collect tax (US state-mandates sales tax or ‘goods and services’ tax in Australia or New Zealand) for at least one line item in the order, and remit the tax to the taxing authority of the buyer’s residence. If this field is returned, the seller should search for one or more containers at the line item level to get more information about the type of tax and the amount
fulfillmentHrefsThis array contains a list of one or more call URIs that can be used to retrieve shipping fulfillments that have been set up for the order
paymentSummary_totalDueSeller_currencyA three-letter ISO 4217 code that indicates the currency of the amount in the value field. If currency conversion/localization is required, this is the post-conversion currency of the amount in the value field
paymentSummary_totalDueSeller_valueThe monetary amount, in the currency specified by the currency field. If currency conversion/localization is required, this value is the converted amount, and the convertedFromValue field contains the amount in the original currency
pricingSummary_deliveryCost_currencyA three-letter ISO 4217 code that indicates the currency of the amount in the value field. If currency conversion/localization is required, this is the post-conversion currency of the amount in the value field
pricingSummary_deliveryCost_valueThe monetary amount, in the currency specified by the currency field. If currency conversion/localization is required, this value is the converted amount, and the convertedFromValue field contains the amount in the original currency
pricingSummary_priceDiscount_currency
pricingSummary_priceDiscount_value
pricingSummary_priceSubtotal_currencyA three-letter ISO 4217 code that indicates the currency of the amount in the value field. If currency conversion/localization is required, this is the post-conversion currency of the amount in the value field
pricingSummary_priceSubtotal_valueThe monetary amount, in the currency specified by the currency field. If currency conversion/localization is required, this value is the converted amount, and the convertedFromValue field contains the amount in the original currency
pricingSummary_tax_currencyA three-letter ISO 4217 code that indicates the currency of the amount in the value field. If currency conversion/localization is required, this is the post-conversion currency of the amount in the value field
pricingSummary_tax_valueThe monetary amount, in the currency specified by the currency field. If currency conversion/localization is required, this value is the converted amount, and the convertedFromValue field contains the amount in the original currency
pricingSummary_total_currencyA three-letter ISO 4217 code that indicates the currency of the amount in the value field. If currency conversion/localization is required, this is the post-conversion currency of the amount in the value field
pricingSummary_total_valueThe monetary amount, in the currency specified by the currency field. If currency conversion/localization is required, this value is the converted amount, and the convertedFromValue field contains the amount in the original currency
salesRecordReferenceAn eBay-generated identifier that is used to identify and manage orders through the Selling Manager and Selling Manager Pro tools. This order identifier can also be found on the Orders grid page and in the Sales Record pages in Seller Hub. A number is only generated and returned at the order level, and not at the order line item level. In cases where the seller does not have a Selling Manager or Selling Manager Pro subscription nor access to Seller Hub, this field may not be returned
sellerIdThe unique eBay user ID of the seller who sold the order
totalFeeBasisAmount_currency
totalFeeBasisAmount_value
Parameter Description
amount_currencyA three-letter ISO 4217 code (such as USD for US site) that indicates the currency of the amount in the value field. Both the value and currency fields are required when expressing the amount of the refund or the amount involved in a payment dispute
amount_valueThe monetary amount of the refund. Only use a maximum of two digits to the right of the decimal point. Both the value and currency fields are required when expressing the amount of the refund or the amount involved in a payment dispute
buyerUsernameThis is the buyer’s eBay user ID. This field is returned for all payment disputes returned in the response
openDateThe timestamp in this field shows the date/time when the payment dispute was opened. This field is returned for payment disputes in all states.The timestamps returned here use the ISO-8601 24-hour date and time format, and the time zone used is Universal Coordinated Time (UTC), also known as Greenwich Mean Time (GMT), or Zulu
orderIdThis is the unique identifier of the order involved in the payment dispute
paymentDisputeIdThis is the unique identifier of the payment dispute. This identifier is automatically created by eBay once the payment dispute comes into the eBay managed payments system. This identifier is passed in at the end of the call URI to retrieve a specific payment dispute. The method returns more details about a payment dispute than the method
paymentDisputeStatusThe enumeration value in this field gives the current status of the payment dispute
reasonThe enumeration value in this field gives the reason why the buyer initiated the payment dispute. See type for a description of the supported reasons that buyers can give for initiating a payment dispute
respondByDateThe timestamp in this field shows the date/time when the seller must response to a payment dispute, so this field is only returned for payment disputes in the ACTION_NEEDED state. For payment disputes that require action by the seller, that same seller must call to see the next action(s) that they can take against the payment dispute.The timestamps returned here use the ISO-8601 24-hour date and time format, and the time zone used is Universal Coordinated Time (UTC), also known as Greenwich Mean Time (GMT), or Zulu
Parameter Description
paymentPolicyIdA unique eBay-assigned ID for a payment policy. This ID is generated when the policy is created
nameA user-defined name for this payment policy. Names must be unique for policies assigned to the same marketplace
descriptionAn optional seller-defined description of the payment policy for internal use (this value is not displayed to end users)
categoryTypesThe CategoryTypeEnum value to which this policy applies. Used to discern accounts that sell motor vehicles from those that don’t. (Currently, each policy can be set to only one categoryTypes value at a time.)
marketplaceIdThe ID of the eBay marketplace to which the payment policy applies. If this value is not specified, value defaults to the seller’s eBay registration site
immediatePayIf set to true, payment is due upon receipt (eBay generates a receipt when the buyer agrees to purchase an item). This boolean must be set in the payment policy if the seller wants to create a listing that has an “immediate payment” requirement. The seller can change the immediate payment requirement at any time during the life cycle of a listing. The following must be true before a seller can apply an immediate payment requirement to an item:To enable the immediate payment requirement, the seller must also perform the following actions via API calls:For more information, see the Help page
paymentMethods_brandsIt’s important to note that the credit card brands Visa and MasterCard must both be listed if either one is listed, as is shown in the following code fragment: “paymentMethods”: [{ “brands”: [VISA, MASTERCARD] }] … Note: Different eBay marketplaces may or may not support this field. Use the Trading API GetCategoryFeatures call with FeatureID set to PaymentMethods and DetailLevel set to ReturnAll to see what credit card brands different marketplaces support. If the GetCategoryFeatures call returns details on credit card brands for the categories in which you sell, then you can use this field to list the credit card brands the seller accepts. If, on the other hand, GetCategoryFeatures does not enumerate credit card brands for your target site (for example, if it returns PaymentMethod set to CCAccepted), then you cannot enumerate specific credit card brands with this field for that marketplace
paymentMethods_paymentMethodTypeThe payment method, selected from the supported payment method types. Use GetCategoryFeatures in the Trading API to retrieve the payment methods allowed for a category on a specific marketplace, as well as the default payment method for that marketplace (review the Sit
paymentMethods_recipientAccountReference…
paymentMethods_recipientAccountReference…A reference a recipient’s account. Currently only PAYPAL_EMAIL is valid
Parameter Description
amount_currencyA three-letter ISO 4217 code that indicates the currency of the amount in the value field. This field is always returned with the amount container
amount_valueThe monetary amount, in the currency specified by the currency field. This field is always returned with the amount container
payoutDateThis timestamp indicates when the seller payout began processing. The following format is used: YYYY-MM-DDTHH:MM:SS.SSSZ. For example, 2015-08-04T19:09:02.768Z. This field is still returned even if the payout was pending but failed ( value shows RETRYABLE_FAILED or TERMINAL_FAILED)
payoutIdThe unique identifier of the seller payout. This identifier is generated once eBay begins processing the payout to the seller’s bank account
payoutInstrument_accountLastFourDigitsThis string value is the last four digits of the seller’s account number
payoutInstrument_instrumentTypeThis string value indicates the type of account that received the payout. At this time, seller payouts can only be distributed to bank acounts, so the string value returned in this field will always be BankAccount
payoutInstrument_nicknameThis string value is a seller-provided nickname that the seller uses to represent the bank account
payoutStatusThis enumeration value indicates the current status of the seller payout. For a successful payout, the value returned will be SUCCEEDED. See the type for more details on each payout status value
payoutStatusDescriptionThis field provides more details about the current status of payout. The description returned here will correspond with enumeration value returned in the field. The following shows what description text might appear based on the different values:
transactionCountThis integer value indicates the number of monetary transactions (all orders, refunds, and credits, etc.) that have occurred with the corresponding payout. Its value should always be at least 1, since there is at least one order per seller payout
Parameter Description
averageItemDiscount_currency The base currency applied to the value field to establish a monetary amount. The currency is represented as a 3-letter currency code. For example, the code for the Canadian Dollar is CAD
averageItemDiscount_value The monetary amount in the specified currency
averageItemRevenue_currency The base currency applied to the value field to establish a monetary amount. The currency is represented as a 3-letter currency code. For example, the code for the Canadian Dollar is CAD
averageItemRevenue_value The monetary amount in the specified currency
averageOrderDiscount_currency The base currency applied to the value field to establish a monetary amount. The currency is represented as a 3-letter currency code. For example, the code for the Canadian Dollar is CAD
averageOrderDiscount_value The monetary amount in the specified currency
averageOrderRevenue_currency The base currency applied to the value field to establish a monetary amount. The currency is represented as a 3-letter currency code. For example, the code for the Canadian Dollar is CAD
averageOrderRevenue_value The monetary amount in the specified currency
averageOrderSize The average order size is the average number of items that each order contained in a promotion. This value is calculated as follows: itemsSoldQuantity / numberOfOrdersSold = averageOrderSize
baseSale_currency The base currency applied to the value field to establish a monetary amount. The currency is represented as a 3-letter currency code. For example, the code for the Canadian Dollar is CAD
baseSale_value The monetary amount in the specified currency
itemsSoldQuantity This is the quantity of items purchased in a threshold promotion where the threshold has been met and the discount was applied. For example, suppose you’re running a “Buy 1, get 1 at 50%” promotion on $5 socks. One buyer purchases two pairs of socks, so they pay $7.50 for both pairs (rather than the full price of $10). Your number of items sold (itemsSoldQuantity) would be 2 and your number of orders sold (numberOfOrdersSold) would be 1
numberOfOrdersSold This is the number of orders sold in a threshold promotion where the threshold has been met and the discount was applied. For example, suppose you’re running a “Buy 1, get 1 at 50%” promotion on $5 socks. One buyer purchases two pairs of socks, so they pay $7.50 for both pairs (rather than the full price of $10). Your numberOfOrdersSold would be 1 and your itemsSoldQuantity would be 2
percentageSalesLift The percentage sales lift is the total dollar amount gained due to promotions. This value is calculated as follows: promotionSale / totalSale = percentageSalesLift
promotionHref The URI of the promotion report
promotionId A unique eBay-assigned ID for the promotion that’s generated when the promotion is created
promotionReportId The unique eBay-assigned ID of the promotion report that is generated when the report is created
promotionSale_currency The base currency applied to the value field to establish a monetary amount. The currency is represented as a 3-letter currency code. For example, the code for the Canadian Dollar is CAD
promotionSale_value The monetary amount in the specified currency
promotionType Indicates the type of the promotion, either MARKDOWN_SALE, ORDER_DISCOUNT, or VOLUME_DISCOUNT
totalDiscount_currency The base currency applied to the value field to establish a monetary amount. The currency is represented as a 3-letter currency code. For example, the code for the Canadian Dollar is CAD
totalDiscount_value The monetary amount in the specified currency
totalSale_currency The base currency applied to the value field to establish a monetary amount. The currency is represented as a 3-letter currency code. For example, the code for the Canadian Dollar is CAD
totalSale_value The monetary amount in the specified currency
Parameter Description
startDateThe date and time the promotion starts. For display purposes, convert this time into the local time of the seller
endDateThe date and time the promotion ends. If this field is blank (null), it indicates the promotion has no end date. For display purposes, convert this time into the local time of the seller
marketplaceIdThe eBay marketplace ID of the site where the promotion is hosted. Threshold promotions are supported on a select set of marketplaces while markdown promotions are supported on all eBay marketplaces. Valid values for threshold promotions are as follows:
nameThe seller-defined name or “title” of the promotion, such as “Buy 1 Get 1”, that the seller can use to identify a promotion. This label is not displayed in end-user flows. Maximum length: 90
priorityApplicable for only ORDER_DISCOUNT promotions, this field indicates the precedence of the promotion, which is used to determine the position of a promotion on the seller’s All Offers page. If an item is associated with multiple promotions, the promotion with the higher priority takes precedence
promotionHrefThe URI of the promotion details
promotionIdA unique eBay-assigned ID for the promotion that’s generated when the promotion is created
promotionStatusThe current status of the promotion. When creating a new promotion, you must set this value to either DRAFT or SCHEDULED
promotionTypeIndicates type of the promotion, either MARKDOWN_SALE, ORDER_DISCOUNT, or VOLUME_DISCOUNT
Parameter Description
categoryTypesFor return policies, this field can be set to only ALL_EXCLUDING_MOTORS_VEHICLES (returns on motor vehicles are not processed through eBay flows)
descriptionAn optional seller-defined description of the return policy for internal use (this value is not displayed to end users)
internationalOverride_returnPeriod_unitA time-measurement unit that specifies a singular period of time. A span of time is defined when you apply the value specified in the value field to the value specified for unit. Time-measurement units can be YEAR, MONTH, DAY, and so on. See TimeDurationUnitEnum for a complete list of possible time-measurement units
internationalOverride_returnPeriod_valueAn integer that represents an amount of time, as measured by the time-measurement unit specified in the unit field
internationalOverride_returnShippingCost…This field indicates who is responsible for paying for the shipping charges for returned items. The field can be set to either BUYER or SELLER. Depending on the return policy and specifics of the return, either the buyer or the seller can be responsible for the return shipping costs. Note that the seller is always responsible for return shipping costs for SNAD-related issues
internationalOverride_returnsAcceptedIf set to true, the seller allows international returns. If set to false, the seller does not accept international returns
marketplaceIdThe ID of the eBay marketplace to which this return policy applies. If this value is not specified, value defaults to the seller’s eBay registration site
nameA user-defined name for this return policy. Names must be unique for policies assigned to the same marketplace
refundMethodthis field has been deprecated as of version 1.2.0, released on May 31, 2018. Any value other than MONEY_BACK will be treated as MONEY_BACK (although for a period of time, eBay will store and return the legacy values to preserve backwards compatibility). Indicates the method the seller uses to compensate the buyer for returned items. The return method specified applies only to . Each eBay marketplace may support different sets of refund methods and marketplaces can also have differing default values for this field. Sellers are obligated to honor the refund method displayed in their listings. Call GeteBayDetails in the Trading API to see the refund methods supported by the marketplaces you sell into. We recommend you set this field to the value of your preferred refund method and that you use the description field to detail the seller’s return policy (such as indicating how quickly the seller will process a refund, whether the seller must receive the item before processing a refund, and other similar useful details). You cannot modify this value in a Revise item call if (1) the listing has bids or (2) the listing ends within 12 hours
returnMethodValid in the US marketplace only, this optional field indicates additional services (other than money-back) that sellers can offer buyers for . As of version 1.2.0, the only accepted value for this field is REPLACEMENT. This field is valid in only the US marketplace, any supplied value is ignored in other marketplaces
returnPeriod_unitA time-measurement unit that specifies a singular period of time. A span of time is defined when you apply the value specified in the value field to the value specified for unit. Time-measurement units can be YEAR, MONTH, DAY, and so on. See TimeDurationUnitEnum for a complete list of possible time-measurement units
returnPeriod_valueAn integer that represents an amount of time, as measured by the time-measurement unit specified in the unit field
returnPolicyIdA unique eBay-assigned ID for this policy. This ID value is appended to the end of the Location URI that is returned as a response header when you call createReturnPolicy)
returnShippingCostPayerThis field indicates who is responsible for paying for the shipping charges for returned items. The field can be set to either BUYER or SELLER. Depending on the return policy and specifics of the return, either the buyer or the seller can be responsible for the return shipping costs. Note that the seller is always responsible for return shipping costs for SNAD-related issues
returnsAcceptedIf set to true, the seller accepts returns. Call the getReturnPolicies in the Metadata API to see what categories require returns to be offered for listings in each category. Also, note that some European marketplaces (for example, UK, IE, and DE) require sellers to accept returns for fixed-price items and auctions listed with Buy It Now. For details, see
Parameter Description
dateDate dimension
click_through_rateThe number of times an item displays on the search results page divided by the number of times buyers clicked through to its View Item page
listing_impressions_search_results_pageThe number of times the seller’s listings displayed on the search results page. Note, the listing might not have been visible to the buyer due to its position on the page
listing_impression_storeThe number of times the seller’s listings displayed on the seller’s store. Note, the listing might not have been visible to the buyer due to its position on the page
listing_impression_totalThe total number of times the seller’s listings displayed on the search results page OR in the seller’s store. The item is counted each time it displays on either page. However, the listing might not have been visible to the buyer due to its position on the page
listing_views_source_directThe number of times a View Item page was directly accessed, such as when a buyer navigates to the page using a bookmark
listing_views_source_off_ebayThe number of times a View Item page was accessed via a site other than eBay, such as when a buyer clicks on a link to the listing from a search engine page
listing_views_source_other_ebayThe number of times a View Item page was accessed from an eBay page that is not either the search results page or the seller’s store
listing_views_source_search_results_pageThe number of times the item displayed on the search results page
listing_views_source_storeThe number of times a View Item page was accessed via the seller’s store
listing_views_totalTotal number of listings viewed
sales_conversion_rateThe number of completed transactions divided by the number of View Item page views
transaction_countThe total number of completed transactions
Parameter Description
dateDate dimension
listing_idListing id
click_through_rateThe number of times an item displays on the search results page divided by the number of times buyers clicked through to its View Item page
listing_impressions_search_results_pageThe number of times the seller’s listings displayed on the search results page. Note, the listing might not have been visible to the buyer due to its position on the page
listing_impression_storeThe number of times the seller’s listings displayed on the seller’s store. Note, the listing might not have been visible to the buyer due to its position on the page
listing_impression_totalThe total number of times the seller’s listings displayed on the search results page OR in the seller’s store. The item is counted each time it displays on either page. However, the listing might not have been visible to the buyer due to its position on the page
listing_views_source_directThe number of times a View Item page was directly accessed, such as when a buyer navigates to the page using a bookmark
listing_views_source_off_ebayThe number of times a View Item page was accessed via a site other than eBay, such as when a buyer clicks on a link to the listing from a search engine page
listing_views_source_other_ebayThe number of times a View Item page was accessed from an eBay page that is not either the search results page or the seller’s store
listing_views_source_search_results_pageThe number of times the item displayed on the search results page
listing_views_source_storeThe number of times a View Item page was accessed via the seller’s store
listing_views_totalTotal number of listings viewed
sales_conversion_rateThe number of completed transactions divided by the number of View Item page views
transaction_countThe total number of completed transactions
Parameter Description
listing_idListing id
click_through_rateThe number of times an item displays on the search results page divided by the number of times buyers clicked through to its View Item page
listing_impressions_search_results_pageThe number of times the seller’s listings displayed on the search results page. Note, the listing might not have been visible to the buyer due to its position on the page
listing_impression_storeThe number of times the seller’s listings displayed on the seller’s store. Note, the listing might not have been visible to the buyer due to its position on the page
listing_impression_totalThe total number of times the seller’s listings displayed on the search results page OR in the seller’s store. The item is counted each time it displays on either page. However, the listing might not have been visible to the buyer due to its position on the page
listing_views_source_directThe number of times a View Item page was directly accessed, such as when a buyer navigates to the page using a bookmark
listing_views_source_off_ebayThe number of times a View Item page was accessed via a site other than eBay, such as when a buyer clicks on a link to the listing from a search engine page
listing_views_source_other_ebayThe number of times a View Item page was accessed from an eBay page that is not either the search results page or the seller’s store
listing_views_source_search_results_pageThe number of times the item displayed on the search results page
listing_views_source_storeThe number of times a View Item page was accessed via the seller’s store
listing_views_totalTotal number of listings viewed
sales_conversion_rateThe number of completed transactions divided by the number of View Item page views
transaction_countThe total number of completed transactions
Parameter Description
amount_currencyA three-letter ISO 4217 code that indicates the currency of the amount in the value field. This field is always returned with the amount container
amount_valueThe monetary amount, in the currency specified by the currency field. This field is always returned with the amount container
buyer_usernameThe eBay user ID of the order’s buyer
orderIdThe unique identifier of the order associated with the monetary transaction
payoutIdThe unique identifier of the seller payout associated with the monetary transaction. This identifier is generated once eBay begins processing the payout for the corresponding order. This field will not be returned if eBay has not yet begun processing the payout for an order
salesRecordReferenceThe Sales Record Number associated with a sales order. Sales Record Numbers are Selling Manager/Selling Manager Pro identifiers that are created at order checkout
transactionDateThis timestamp indicates when the monetary transaction (order purchase, buyer refund, seller credit) occurred
transactionIdThe unique identifier of the monetary transaction. A monetary transaction can be a sales order, an order refund to the buyer, a credit to the seller’s account, a debit to the seller for the purchase of a shipping label, or a transaction where eBay recouped money from the seller if the seller lost a buyer-initiated payment dispute
transactionStatusThis enumeration value indicates the current status of the seller payout associated with the monetary transaction. See the TransactionStatusEnum type for more information on the different states
transactionTypeThis enumeration value indicates whether the monetary transaction is a buyer’s payment for an order, a refund to the buyer for a returned item or cancelled order, a credit issued by eBay to the seller’s account, a payment dispute between the buyer and seller, or where eBay is billing the seller for an eBay shipping label. Note that the shipping label functionality will initially only be available to a select number of sellers

Ready-to-use data connectors

We have developed data connectors to 200+ APIs and web services. Can’t find your connector? Reach out to us through our chat. We are continuously developing new connectors.

Start Your Free Trial

Try Pipes for 14 days, no credit card required.