eBay Connector Objects

note: This feature is a Beta Service. A customer may opt to try a Beta Service in its sole discretion. Any use of the Beta Service is subject to the applicable Beta Services Terms provided at Agreements and Terms. If you have questions or feedback about this Beta Service, contact the Data 360 Connector team at datacloud-connectors-beta@salesforce.com.

Objects Supported

Name	Description
Bidders	Query eBay users that bid on a specified listing, regardless of whether the listing has ended.
Categories	Query eBay Categories.
CategoryFeatures	Query the settings supported by eBay Categories.
CategorySubtree	Retrieve all nodes of the category tree hierarchy (the subtree) below a specified category in a specified category tree.
CategorySuggestions	Return an array of suggested categories that eBay has determined correspond to keywords that describe an item.
CategoryTree	Retrieve the complete category tree corresponding to a specified category tree ID.
CompatibilityProperties	Retrieve an array of parts compatibility aspects that are used to describe compatible vehicles.
CompatibilityPropertyValues	Retrieve an array of parts compatibility aspect values that are used to describe compatible vehicles.
Countries	Lists the country code and associated name of the countries supported by the eBay system, regardless of the site specified in the request.
Currencies	Query the supported Currencies in eBay.
DefaultCategoryTreeId	Retrieve the default category tree reference for a specific eBay marketplace.
FulfillmentPolicies	Retrieves all the fulfillment policies configured for the marketplace you specify using the MarketplaceId query parameter.
HighestBidder	Query the Highest Bidder of the eBay users who bid on a specified listing, regardless of whether the listing has ended.
ItemAspectsForCategory	Retrieve an array of aspects that are appropriate for describing items in a specified category.
ItemCompatibilityList	Query compatability categories and possible compatability values for a specific item.
ItemListing	Update, delete, and query Item Listings for sellers.
ItemShipping	Query details pertinent to one or more items for which calculated shipping has been offered by the seller, such as package dimension, weight, and packaging/handling costs.
ItemSpecifics	Query item specifics for a specific item.
ItemTransactions	Query order line item (transaction) information for a specified listing. For auction listings, order line items are not created until the auction ends with a winning bidder, or if the Buy It Now feature is enabled for the listing and used by the buyer to purchase the item. For fixed-price listings, order line items are created after a buyer has committed to purchase the item(s).
ItemVariations	Item Variations are multiple similar (but not identical) items in a single fixed-price listing. For example, a T-shirt listing could contain multiple items of the same brand that vary by color and size; each variation would specify a combination of one of these colors and sizes. Each variation can have a different quantity and price. You can buy multiple items from one variation at the same time. (That is, one order line item can contain multiple items from a single variation.)
MostWatchedItems	[DEPRECATED] Query items with the highest watch counts for the entire site or for a specific category. The top items are determined by the Watch Count totals from the preceding day. Ranking of the Most Watched Items is calculated with the latest Watch Count information.
OrderPayments	Query all payments of the orders, in which the authenticated user is either the buyer or seller. By default, only payment details of orders made in the last 90 days are returned. Payment details of orders older than 90 days can be retrieved by specifying OrderId.
Orders	Query all orders in which the authenticated user is either the buyer or seller. By default, only orders made in the last 90 days are returned. Orders older than 90 days can be retrieved by specifying OrderId.
OrderShipping	Query shipping details of the orders in which the authenticated user is either the buyer or seller. By default, only shipping details of orders made in the last 90 days are returned. Shipping details of orders older than 90 days can be retrieved by specifying OrderId.
PaymentPolicies	Retrieves all the payment policies configured for the marketplace you specify using the MarketplaceId query parameter.
ReturnPolicies	Retrieves all the return policies configured for the marketplace you specify using the MarketplaceId query parameter.
ShippingCarriers	Query Shipping Carriers supported by the specified site.
ShippingCategories	A shipping service category supported for the site.
ShippingLocations	Lists the regions and locations supported by eBay's shipping services. Returns all shipping locations supported by eBay, regardless of the site specified in the request.
ShippingServices	Query Shipping Services supported by the specified eBay site.
Sites	Lists all available eBay sites and their associated SiteID numbers.
SuggestedCategories	[DEPRECATED] Query eBay list of categories with the highest number of listings.
Tasks	Retrieves all the tasks for the marketplace you specify using the MarketplaceId query parameter.
TransactionLinkedItems	Query all linked line items of the transactions in which the authenticated user is either the buyer or seller. By default, only linked line items of transactions made in the last 90 days are returned. Linked line items of the transactions in orders older than 90 days can be retrieved by specifying OrderIds.
TransactionPayments	Query all payments of the transactions in which the authenticated user is either the buyer or seller. By default, only payments of transactions made in the last 90 days are returned. Payments of the transactions in orders older than 90 days can be retrieved by specifying OrderIds.
TransactionRefunds	Query all refunds of the transactions in which the authenticated user is either the buyer or seller. By default, only refunds of transactions made in the last 90 days are returned. Refunds of the transactions in orders older than 90 days can be retrieved by specifying OrderIds.
Transactions	Query all transactions in which the authenticated user is either the buyer or seller. By default, only transactions of orders made in the last 90 days are returned. Transactions of orders older than 90 days can be retrieved by specifying OrderId.
TransactionShipping	Query shipping details of the transactions in which the authenticated user is either the buyer or seller. By default, only shipping details of transaction made in the last 90 days are returned. Shipping details of the transactions in orders older than 90 days can be retrieved by specifying OrderIds.

Bidders

Name	Type	ReadOnly	FilterOnly	Description
Action	String	False	No	Indicates the type of offer being made on the specified listing.
MaxBid	Decimal	False	No	Amount of the offer placed. For auction listings, the amount bid on the item (subject to outbid by other buyers). For fixed-price listings, the fixed sale price at which the item is purchased. For auction listings with an active Buy It Now option, this amount will be either the Buy It Now price for purchase or the amount of a bid, depending on the offer type.
Currency	String	False	No	The three-digit currency code for the Max Bid.
ConvertedPrice	Decimal	False	No	The price in the currency specified.
ConvertedPriceCurrency	String	False	No	The three-digit currency Id of the converted price.
HighestBid	Decimal	False	No	Amount the highest bidder has bid on the item. Applicable to only auction listings where there is progressive bidding and winning bidders are determined based on the highest bid.
HighestBidCurrency	String	False	No	The three-digit currency code for the highest bid.
Quantity	Integer	False	No	Specifies the number of items the user tendering the offer intends to purchase, bid on, or make a Best Offer on.
SecondChanceEnabled	Boolean	False	No	Indicates whether user is willing to be the recipient of second chance offers.
SiteCurrency	String	False	No	Unique Id identifying the currency in which the localized offer amounts are expressed.
TimeBid	Datetime	False	No	Date and time the offer or bid was placed.
UserId	String	False	No	Unique eBay user Id for the user.
UserCountry	String	False	No	The two-digit code representing the country of the user.
UserFeedbackScore	Integer	False	No	The aggregate feedback score for a user. A feedback score for a user is the net positive feedback minus the net negative feedback left for the user.
ItemId	String	False	No	The Id of the item. The bidders who bid on this item are returned.
ListMode	String	False	Yes	Specifies which bidder information to return. EndedListing returns all nonwinning bidders for ended listings only. It can be used only by a seller. SecondChanceEligibleEndedListing returns all nonwinning bidders for an ended listing who have not yet received a Second Chance Offer and noted interest in receiving a Second Chance Offer. It can be used only by a seller. ViewAll returns all bidders for an ended or still-active listing. It can be used by any user.

Return to Top

Name	Type	ReadOnly	FilterOnly	Description
CategoryId [KEY]	String	False	No	This string value is the unique identifier of an eBay category.
AutoPayEnabled	Boolean	False	No	Specifies that the corresponding category supports immediate payment for listings.
B2BVATEnabled	Boolean	False	No	Specifies that the corresponding category supports business-to-business (B2B) VAT listings. This feature is applicable to the eBay Germany (DE), Austria (AT), and Switzerland (CH) sites only.
BestOfferEnabled	Boolean	False	No	Specifies that the corresponding category supports Best Offers.
CategoryLevel	Integer	False	No	This integer value indicates the level where the category fits in the category hierarchy of the eBay site. For example, if this field has a value of 2, then the category is two levels below the root category.
CategoryName	String	False	No	This string value is the display name of the eBay primary category, as it would appear on the eBay website.
CategoryParentId	String	False	No	This string value is the category Id of the parent category of the primary category indicated in the CategoryId field.
Expired	Boolean	False	No	Specifies that the corresponding category is no longer a valid eBay category on the site, and items may not be listed in this category.
LeafCategory	Boolean	False	No	Specifies that the corresponding category is an eBay leaf category, a category in which items may be listed.
LSD	Boolean	False	No	Lot Size Disabled. Specifies that the corresponding category does not support lot listings. A lot listing is a listing that features multiple related items that must be purchased by one buyer in one transaction.
ORPA	Boolean	False	No	Override Reserve Price Allowed: Specifies that the corresponding category is an exception to the standard Reserve Price policy on auction listings for the eBay site.
ORRA	Boolean	False	No	Override Reduce Reserve Allowed: Specifies that the corresponding category is an exception to the standard Reduce Reserve Price (on active auction listing) policy.
Virtual	Boolean	False	No	Specifies that the corresponding category is an eBay virtual category, a category in which items may not be listed.
CategorySiteId	String	False	Yes	The Id of the U.S. eBay site for the category.
LevelLimit	String	False	Yes	Specifies the maximum depth of the category hierarchy to retrieve, where the top-level categories (metacategories) are at level 1. If not specified, categories are retrieved at all applicable levels.
ViewAllNodes	String	False	Yes	This value controls whether all eBay categories or only leaf categories that satisfy any WHERE clause restrictions are returned. You can only list items in leaf categories. The default value is true.
DetailLevel	String	False	Yes	Detail levels are instructions that define subsets of data to return for particular tables. Possible values: ItemReturnAttributes, ItemReturnCategories, ItemReturnDescription, ReturnAll, ReturnHeaders, ReturnMessages, and ReturnSummary.

CategoryFeatures

Name	Type	ReadOnly	FilterOnly	Description
CategoryId	String	False	No	The unique identifier of the category that the setting belongs to.
BestOfferAutoAcceptEnabled	Boolean	False	No	Indicates whether the category supports the Best Offer Automatic Accept feature for fixed-price listings.
BestOfferAutoDeclineEnabled	Boolean	False	No	Indicates whether the category supports the Best Offer Auto Decline feature.
BestOfferCounterEnabled	Boolean	False	No	Indicates whether the category supports sellers offering a counter offer against the Best Offer from a buyer, or a buyer offering a counter offer against the counter offer of the seller. This field is only applicable to fixed-price listings.
BestOfferEnabled	Boolean	False	No	Indicates whether the category supports the Best Offer feature for fixed-price listings.
BrandMPNIdentifierEnabled	Boolean	False	No	Indicates whether the category supports the capability to identify a product using the brand/manufacturer part number combination.
ConditionEnabled	String	False	No	Indicates whether the category supports (or requires) conditions to be specified.
ConditionValuesAggregate	String	False	No	The valid condition Ids for this category.
EANEnabled	String	False	No	Indicates whether or not European Article Numbers (EANs) can be used to help create a listing.
FreeGalleryPlusEnabled	Boolean	False	No	Indicates whether the category supports free, automatic upgrades for Gallery Plus, which enhances pictures in search results.
FreePicturePackEnabled	Boolean	False	No	Indicates whether the category supports free, automatic upgrades for Picture Pack, a discount package that includes super-sizing of pictures.
GlobalShippingEnabled	Boolean	False	No	Specifies whether or not the corresponding category supports the Global Shipping Program (GSP).
Group1MaxFlatShippingCost	Double	False	No	Returns the applicable max. cap per shipping cost for shipping service group 1.
Group2MaxFlatShippingCost	Double	False	No	Returns the applicable max. cap per shipping cost for shipping service group 2.
Group3MaxFlatShippingCost	Double	False	No	Returns the applicable max. cap per shipping cost for shipping service group 3.
HandlingTimeEnabled	Boolean	False	No	If false, listings in this category require a handling time when flat or calculated shipping is specified. A handling time is not required for local pickup or for freight shipping. see DispatchTimeMax in AddItem.
HomePageFeaturedEnabled	Boolean	False	No	Indicates whether or not it is possible to enhance a listing by putting it into a rotation for display on a special area of the eBay home page. Support for this feature varies by site. Item or feedback restrictions may apply.
INEscrowWorkflowTimeline	String	False	No	Indicates the escrow workflow version that applies to the category on the India site: Default Workflow, Workflow A, or Workflow B.
ISBNEnabled	String	False	No	Indicates whether or not International Standard Book Numbers (ISBNs) can be used to help create a listing.
ItemCompatibilityEnabled	String	False	No	Indicates whether the category supports parts compatibility by application (ByApplication), by specification (BySpecification), or not at all (Disabled).
ItemSpecificsEnabled	String	False	No	Indicates whether the category supports custom Item Specifics.
ListingDurations	String	False	No	The listing types and listing durations in days that are supported for the category.
MaxFlatShippingCost	Double	False	No	The maximum cost the seller can charge for the first domestic flat rate shipping service. The total shipping cost is the base flat rate shipping cost plus the cost of insurance, if insurance is required. Mutually exclusive with GroupNMaxFlatShippingCost.
MaxGranularFitmentCount	Integer	False	No	Indicates the maximum fitment count.
MaxItemCompatibility	Integer	False	No	Specifies the maximum number of parts compatibilities.
MinimumReservePrice	Double	False	No	Indicates whether a Minimum Reserve Price is enabled for this category. On the Germany, Austria, Belgium French, and Belgium Dutch sites, Minimum Reserve Price is supported for the Art and Antiques, Watches and Jewelry, and Motorbikes categories.
MinItemCompatibility	Integer	False	No	This field specifies the minimum number of parts compatibilities for listing items.
NonSubscription	String	False	No	The value in this field indicates whether the category supports Motors Local Market listings if the seller does not have a vehicle subscription.
PaisaPayFullEscrowEnabled	Boolean	False	No	Indicates whether the category supports the PaisaPayEscrow payment method. This feature is only applicable to the India site.
PaymentMethods	String	False	No	Indicates the acceptable payment methods that can be used when adding, revising, or relisting an item in the corresponding category.
PaymentProfileCategoryGroup	String	False	No	Indicates the Business Policies category group that can be used for Payment profiles. Only returned when this value (or the setting of this category) overrides the value inherited from the parent category.
PayPalBuyerProtectionEnabled	Boolean	False	No	Whether then buyer protection is allowed for this category.
PayPalRequired	Boolean	False	No	Indicates whether the category requires PayPal as a payment method.
PickupDropOffEnabled	Boolean	False	No	A true value in this field indicates that items listed in the category can be enabled with the Click and Collect feature. With the Click and Collect feature, a buyer can purchase certain items on eBay and collect them at a local store. Buyers are notified by eBay once their items are available.
PremiumSubscription	String	False	No	The value in this field indicates whether the category supports Motors Local Market listings if the seller has a Premium vehicle subscription.
ProductCreationEnabled	String	False	No	Indicates whether a category supports (or requires) product creation in listings. Use this to determine whether it is mandatory to specify the product Id when adding, revising, or relisting.
ProPackEnabled	Boolean	False	No	Indicates whether the category supports the Pro Pack Bundle listing upgrade.
ReturnPolicyEnabled	Boolean	False	No	Only returned when this value (or the setting of this category) overrides the value inherited from the parent of the category.
ReturnPolicyProfileCategoryGroup	String	False	No	Indicates the Business Policies category group that can be used for Return Policy profiles. Only returned when this value (or the setting of this category) overrides the value inherited from the parent of the category.
RevisePriceAllowed	Boolean	False	No	Indicates if the category allows the seller to revise the price of a fixed-price listing.
ReviseQuantityAllowed	Boolean	False	No	Indicates if the category allows the seller to revise the quantity of a multiquantity, active listing.
SafePaymentRequired	Boolean	False	No	Indicates whether listings in this category need to have a safe payment method.
SellerContactDetailsEnabled	Boolean	False	No	Indicates whether this category supports seller-level contact information for Classified Ad listings.
SellerProvidedTitleSupported	Boolean	False	No	This boolean field indicates whether a category supports Seller Provided Titles in listings.
ShippingProfileCategoryGroup	String	False	No	Indicates the Business Policies category group that can be used for Shipping profiles. Only returned when this value (or the setting of this category) overrides the value inherited from the parent of the category.
ShippingTermsRequired	Boolean	False	No	Indicates whether the category requires sellers to specify shipping details at listing time.
SpecialitySubscription	String	False	No	The value in this field indicates whether the category supports Motors Local Market listings if the seller has a Specialty vehicle subscription.
ListingDurationsAggregate	String	False	No	Provides additional listings durations that are available to eBay Store owners. The extended listing durations provided here in this element should be merged in with the baseline listing durations provided in the ListingDurations column. Applies to fixed-price Listings.
TransactionConfirmationRequestEnabled	Boolean	False	No	Defines if transaction confirmation requests are enabled in a given category.
UPCEnabled	String	False	No	Indicates whether or not Universal Product Codes (UPCs) can be used to help create a listing.
UserConsentRequired	Boolean	False	No	Indicates whether a bidder must consent to the bid by confirming that he or she read and agrees to the terms in the privacy policy of eBay.
ValueCategory	Boolean	False	No	Some eBay sites may select a few categories and designate them as value categories. These are typically selected from categories where buyers can find great deals. This designation can change over time.
ValuePackEnabled	Boolean	False	No	Indicates whether the category supports the Value Pack bundle listing upgrade.
VariationsEnabled	Boolean	False	No	If true, you can create multiple-variation listings when you list a fixed-price item in this category.
VINSupported	Boolean	False	No	Indicates if the category supports the use of the VIN (Vehicle Identification Number) field to identify a motor vehicle and create a listing. VINs are supported on the US, Canada, Canada-French, and Australia sites.
VRMSupported	Boolean	False	No	Indicates if the category supports the use of the VRM (Vehicle Registration Mark) field to identify a motor vehicle and create a listing. VRMs are only supported on the UK site.
AllFeaturesForCategory	String	False	Yes	Use this switch to view all of the feature settings for a specific category. All feature settings are returned, regardless of the site default settings. This element works in conjunction with CategoryId--refer to the notes for that element for more details. If you also set FeatureId, eBay returns the status of the specified features only for the specified category. Default: false.
FeatureId	String	False	Yes	Use this field if you want to know if specific features are enabled at the site or root category level. Multiple FeatureId elements can be used in the request.
LevelLimit	String	False	Yes	A level of depth in the category hierarchy. Retrieves all category nodes with a CategoryLevel less than or equal to the LevelLimit value. The root category is 0.
ViewAllNodes	String	False	Yes	If set, eBay returns the site defaults along with all the categories that override the feature settings they inherit. That is, this column contains only the features that the category has overridden from its parent category.
DetailLevel	String	False	Yes	Detail levels are instructions that define subsets of data to return for particular tables. Possible values: ItemReturnAttributes, ItemReturnCategories, ItemReturnDescription, ReturnAll, ReturnHeaders, ReturnMessages, and ReturnSummary.

Return to Top

CategorySubtree

Name	Type	ReadOnly	References	FilterOnly	Description
CategoryTreeId [KEY]	String	False	DefaultCategoryTreeId.CategoryTreeId	No	The unique identifier of the eBay category tree to which this subtree belongs.
categoryTreeVersion	String	False		No	The version of the category tree identified by categoryTreeId.
categorySubtreeNode	String	False		No	Contains details of all nodes of the category subtree hierarchy below a specified node. This is a recursive structure.
category	String	False		No	Contains details about the current category tree node.
categoryName	String	False		No	The name of the category identified by categoryId.
categoryTreeNodeLevel	Integer	False		No	The absolute level of the current category tree node in the hierarchy of its category tree.
childCategoryTreeNodes	String	False		No	An array of one or more category tree nodes that are the immediate children of the current category tree node, as well as their children, recursively down to the leaf nodes.
category	String	False		No	Contains details about the current category tree node.
categoryName	String	False		No	The name of the category identified by categoryId.
categoryTreeNodeLevel	Integer	False		No	The absolute level of the current category tree node in the hierarchy of its category tree.
childCategoryTreeNodes	String	False		No	An array of one or more category tree nodes that are the immediate children of the current category tree node, as well as their children, recursively down to the leaf nodes.
category	String	False		No	Contains details about the current category tree node.
categoryName	String	False		No	The name of the category identified by categoryId.
categoryTreeNodeLevel	Integer	False		No	The absolute level of the current category tree node in the hierarchy of its category tree.
childCategoryTreeNodes	String	False		No	An array of one or more category tree nodes that are the immediate children of the current category tree node, as well as their children, recursively down to the leaf nodes.
leafCategoryTreeNode	Boolean	False		No	A 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.
parentCategoryTreeNodeHref	String	False		No	The href portion of the getCategorySubtree call that retrieves the subtree below the parent of this category tree node.
leafCategoryTreeNode	Boolean	False		No	A 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.
parentCategoryTreeNodeHref	String	False		No	The href portion of the getCategorySubtree call that retrieves the subtree below the parent of this category tree node.
leafCategoryTreeNode	Boolean	False		No	A 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.
parentCategoryTreeNodeHref	String	False		No	The href portion of the getCategorySubtree call that retrieves the subtree below the parent of this category tree node.
CategoryId	String	False		No	The unique identifier of the category at the top of the subtree being requested.

Return to Top

CategorySuggestions

Name	Type	ReadOnly	References	FilterOnly	Description
CategoryTreeId [KEY]	String	False	DefaultCategoryTreeId.CategoryTreeId	No	The unique identifier of the eBay category tree from which suggestions are returned.
categoryTreeVersion	String	False		No	The version of the category tree identified by categoryTreeId.
categorySuggestions	String	False		No	Contains details about one or more suggested categories that correspond to the provided keywords.
category	String	False		No	Contains details about the suggested category.
categoryId	String	False		No	The unique identifier of the eBay category within its category tree.
categoryName	String	False		No	The name of the category identified by categoryId.
categoryTreeNodeAncestors	String	False		No	An ordered list of category references that describes the location of the suggested category in the specified category tree.
categoryId	String	False		No	The unique identifier of the eBay ancestor category.
categoryName	String	False		No	The name of the ancestor category identified by categoryId.
categorySubtreeNodeHref	String	False		No	The href portion of the getCategorySubtree call that retrieves the subtree below the ancestor category node.
categoryTreeNodeLevel	String	False		No	The absolute level of the ancestor category node in the hierarchy of its category tree.
categoryTreeNodeLevel	Integer	False		No	The absolute level of the category tree node in the hierarchy of its category tree.
relevancy	String	False		No	This field is reserved for internal or future use.
Q	String	False		Yes	A quoted string that describes or characterizes the item being offered for sale.

Return to Top

CategoryTree

Name	Type	ReadOnly	References	FilterOnly	Description
CategoryTreeId [KEY]	String	False	DefaultCategoryTreeId.CategoryTreeId	No	The unique identifier of the eBay category tree for the specified marketplace.
categoryTreeVersion	String	False		No	The version of the category tree identified by categoryTreeId.
applicableMarketplaceIds	String	False		No	A list of one or more identifiers of the eBay marketplaces that use this category tree.
rootCategoryNode	String	False		No	Contains details of all nodes of the category tree hierarchy, starting with the root node and down to the leaf nodes.
category	String	False		No	Contains details about the current category tree node.
categoryId	String	False		No	The unique identifier of the eBay category within its category tree.
categoryName	String	False		No	The name of the category identified by categoryId.
categoryTreeNodeLevel	Integer	False		No	The absolute level of the current category tree node in the hierarchy of its category tree.
childCategoryTreeNodes	String	False		No	An array of one or more category tree nodes that are the immediate children of the current category tree node, as well as their children, recursively down to the leaf nodes.
category	String	False		No	Contains details about the current category tree node.
categoryId	String	False		No	The unique identifier of the eBay category within its category tree.
categoryName	String	False		No	The name of the category identified by categoryId.
categoryTreeNodeLevel	Integer	False		No	The absolute level of the current category tree node in the hierarchy of its category tree.
childCategoryTreeNodes	String	False		No	An array of one or more category tree nodes that are the immediate children of the current category tree node, as well as their children, recursively down to the leaf nodes.
category	String	False		No	Contains details about the current category tree node.
categoryId	String	False		No	The unique identifier of the eBay category within its category tree.
categoryName	String	False		No	The name of the category identified by categoryId.
categoryTreeNodeLevel	Integer	False		No	The absolute level of the current category tree node in the hierarchy of its category tree.
childCategoryTreeNodes	String	False		No	An array of one or more category tree nodes that are the immediate children of the current category tree node, as well as their children, recursively down to the leaf nodes.
leafCategoryTreeNode	Boolean	False		No	A 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.
parentCategoryTreeNodeHref	String	False		No	The href portion of the getCategorySubtree call that retrieves the subtree below the parent of this category tree node.
leafCategoryTreeNode	Boolean	False		No	A 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.
parentCategoryTreeNodeHref	String	False		No	The href portion of the getCategorySubtree call that retrieves the subtree below the parent of this category tree node.
leafCategoryTreeNode	Boolean	False		No	A 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.
parentCategoryTreeNodeHref	String	False		No	The href portion of the getCategorySubtree call that retrieves the subtree below the parent of this category tree node.

Return to Top

CompatibilityProperties

Name	Type	ReadOnly	References	FilterOnly	Description
CategoryTreeId [KEY]	String	False	DefaultCategoryTreeId.CategoryTreeId	No	This is the unique identifier of category tree.
CategoryId	String	False		No	The unique identifier of an eBay category.
CompatibilityPropertyName	String	False		No	This is the actual name of the compatible vehicle property as it is known on the specified eBay marketplace and in the eBay category.
CompatibilityPropertyLocalizedName	String	False		No	This is the localized name of the compatible vehicle property.

Return to Top

CompatibilityPropertyValues

Name	Type	ReadOnly	References	FilterOnly	Description
CategoryTreeId [KEY]	String	False	DefaultCategoryTreeId.CategoryTreeId	No	This is the unique identifier of category tree.
CompatibilityProperty [KEY]	String	False		No	This is the actual name of the compatible vehicle property as it is known on the specified eBay marketplace and in the eBay category.
CategoryId [KEY]	String	False		No	The unique identifier of an eBay category.
CompatibilityPropertyValues	String	False		No	Each value field shows one applicable compatible vehicle property value.

Return to Top

Countries

Name	Type	ReadOnly	FilterOnly	Description
Country	String	False	No	Two-letter code representing a country. These two-letter codes are typically used in Add/Revise/Relist calls when referring to a country.
Description	String	False	No	Full country name for display purposes. May be similar to (but not necessarily identical to) CountryName in addresses (e.g., User.RegistrationAddress.CountryName in GetUser).
DetailVersion	String	False	No	Returns the latest version number for this field. The version can be used to determine if and when to refresh cached client data.
UpdateTime	Datetime	False	No	Gives the time in GMT that the feature flags for the details were last updated. This timestamp can be used to determine if and when to refresh cached client data.
DetailName	String	False	Yes	A designation of what kind of information you wish returned for the specified eBay site.

Return to Top

Currencies

Name	Type	ReadOnly	FilterOnly	Description
Currency	String	False	No	The three-digit currency code as defined in ISO 4217.
Description	String	False	No	Full currency name for display purposes.
DetailVersion	String	False	No	Returns the latest version number for this field.
UpdateTime	Datetime	False	No	Gives the time in GMT that the feature fields for the details were last updated.
DetailName	String	False	Yes	If set to a value of CurrencyDetails, additional currency details are returned.

Return to Top

DefaultCategoryTreeId

Name	Type	ReadOnly	FilterOnly	Description
CategoryTreeId [KEY]	String	False	No	The unique identifier of the eBay category tree for the specified marketplace.
CategoryTreeVersion	String	False	No	The version of the category tree identified by categoryTreeId.
MarketplaceId	String	False	Yes	The ID of the eBay marketplace for which the category tree ID is being requested.

Return to Top

FulfillmentPolicies

Name	Type	ReadOnly	FilterOnly	Description
FulfillmentPolicyId [KEY]	String	False	No	A unique eBay-assigned ID for the fulfillment policy. This ID is generated when the policy is created.
Name	String	False	No	A user-defined name for this fulfillment policy. Names must be unique for policies assigned to the same marketplace.
Description	String	False	No	An optional seller-defined description of the fulfillment policy for internal use (this value is not displayed to end users).
CategoryTypesAggr	String	False	No	The 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.)
MarketplaceId	String	False	No	The ID of the eBay marketplace to which this fulfillment policy applies.
FreightShipping	Boolean	False	No	If set to true, the seller offers freight shipping. Freight shipping can be used for large items over 150 lbs.
GlobalShipping	Boolean	False	No	Indicates if the seller has opted-in to the eBay Global Shipping Program and that they use that service for their international shipments.
HandlingTimeValue	Integer	False	No	The maximum number of business days the seller commits to for preparing and shipping an order after receiving a cleared payment for the order.
HandlingTimeUnit	String	False	No	A time-measurement unit that specifies a singular period of time used for HandlingTimeValue.
LocalPickup	Boolean	False	No	Identifies if the shipping is offered by this policy and the seller offers only local pickup of the item (normally from a non-business location).
PickupDropOff	Boolean	False	No	If set to true, the seller offers the
ShipToLocationsAggr	String	False	No	This object contains the regionIncluded and regionExcluded fields, which define the geographical regions that a seller does and does not cover by the associated shipping policy.
ShippingOptionsAggr	String	False	No	A list that defines the seller's shipping configurations for DOMESTIC and INTERNATIONAL order shipments.

Return to Top

HighestBidder

Name	Type	ReadOnly	FilterOnly	Description
ItemId	String	False	No	The Id of the item. The bidders who bid on this item are returned.
HighBidder	String	False	No	eBay user Id for the user with the highest bid (or the earliest timestamp, in the event of a tie); a second chance offer candidate.
HighestBid	Decimal	False	No	Bid amount offered by the highest bidder.
Currency	String	False	No	Currency code of the bid.
ListingStatus	String	False	No	Specifies the status of an active or ended listing in the processing workflow of the eBay system. If a listing ends with a sale (or sales), eBay needs to update the sale details (e.g., total price and buyer/high bidder) and the final value fee. This processing can take several minutes. If you retrieve a sold item and no details about the buyer/high bidder are returned or no final value fee is available, use this listing status information to determine whether eBay has finished processing the listing.
ListMode	String	False	Yes	Specifies which bidder information to return. EndedListing returns all nonwinning bidders for ended listings only. It can be used only by a seller. SecondChanceEligibleEndedListing returns all nonwinning bidders for an ended listing who have not yet received a Second Chance Offer and noted interest in receiving a Second Chance Offer. It can be used only by a seller. ViewAll returns all bidders for an ended or still-active listing. It can be used by any user.

Return to Top

ItemAspectsForCategory

Name	Type	ReadOnly	References	FilterOnly	Description
CategoryTreeId [KEY]	String	False	DefaultCategoryTreeId.CategoryTreeId	No	The unique identifier of the eBay category tree from which the specified category's aspects are being requested.
aspects	String	False		No	A list of item aspects (for example, color) that are appropriate or necessary for accurately describing items in a particular leaf category.
aspectConstraint	String	False		No	Information about the formatting, occurrence, and support of this aspect.
aspectApplicableTo	String	False		No	This value indicate if the aspect identified by the aspects.localizedAspectName field is a product aspect or an item/instance aspect.
aspectDataType	String	False		No	The data type of this aspect.
aspectEnabledForVariations	Boolean	False		No	A value of true indicates that this aspect can be used to help identify item variations.
aspectFormat	String	False		No	Returned only if the value of aspectDataType identifies a data type that requires specific formatting.
aspectMaxLength	Integer	False		No	The maximum length of the item/instance aspect's value.
aspectMode	String	False		No	The manner in which values of this aspect must be specified by the seller (as free text or by selecting from available options).
aspectRequired	Boolean	False		No	A value of true indicates that this aspect is required when offering items in the specified category.
aspectUsage	String	False		No	The enumeration value returned in this field will indicate if the corresponding aspect is recommended or optional.
expectedRequiredByDate	String	False		No	The expected date after which the aspect will be required.
itemToAspectCardinality	String	False		No	Indicates whether this aspect can accept single or multiple values for items in the specified category.
aspectValues	String	False		No	A list of valid values for this aspect (for example: Red, Green, and Blue), along with any constraints on those values.
localizedValue	String	False		No	The localized value of this aspect.
valueConstraints	String	False		No	Not returned if the value of the localizedValue field can always be selected for this aspect of the specified category.
applicableForLocalizedAspectName	String	False		No	The name of the control aspect on which the current aspect value depends.
applicableForLocalizedAspectValues	String	False		No	Contains a list of the values of the control aspect on which this aspect's value depends.
localizedAspectName	String	False		No	The localized name of this aspect (for example: Colour on the eBay UK site).
relevanceIndicator	String	False		No	The relevance of this aspect. This field is returned if eBay has data on how many searches have been performed for listings in the category using this item aspect.
searchCount	Integer	False		No	The number of recent searches (based on 30 days of data) for the aspect.
CategoryId	String	False		No	The unique identifier of an eBay category.

Return to Top

ItemCompatibilityList

Name	Type	ReadOnly	FilterOnly	Description
ItemId [KEY]	String	False	No	The Id that uniquely identifies the item listing. The Id is generated by eBay after an item is listed. You cannot choose or revise this value.
CompatibilityAttributes	String	False	No	A list of all potential compatability catagories for the specified item.
PossibleCompatibilities	String	False	No	A list of all possible compatability values for the specified item.
IncludeItemCompatibilityList	String	False	Yes	This is used to include ItemCompatibilityList items and should not be set manually.

Return to Top

ItemListing

Name	Type	ReadOnly	FilterOnly	Description
ItemId [KEY]	String	False	No	The Id that uniquely identifies the item listing. The Id is generated by eBay after an item is listed. You cannot choose or revise this value.
Title	String	False	No	Name of the item as it appears in the listing or search results.
AutoPay	Boolean	False	No	If true, the seller requests immediate payment for the item.
BuyerProtection	String	False	No	Flag to indicate the eligibility of an item for the PayPal Buyer Protection program.
BuyItNowPrice	Decimal	False	No	This field is only applicable for auction listings. By specifying a Buy It Now price, a seller is allowing prospective buyers the opportunity to purchase the item in the auction listing at this price immediately.
ConditionDescription	String	False	No	This string field is used by the seller to more clearly describe the condition of items that are not brand new.
Country	String	False	No	Defines the 2-letter ISO 3166 country code.
Currency	String	False	No	Currency associated with the price information of the item. 3-letter ISO 4217 currency code.
Description	String	False	No	The description of the item by the seller. In listing requests, you can use CDATA tags to submit your description if you want to use HTML or XML-reserved characters in the description.
HideFromSearch	Boolean	False	No	Whether the listing is hidden from all searches occurring on eBay.
HitCount	Integer	False	No	The number of page views for the item.
Adult	Boolean	False	No	If true, the item is listed in a Mature category.
BestOfferAutoAcceptPrice	Decimal	False	No	The price at which Best Offers are automatically accepted. Similar in use to MinimumBestOfferPrice.
CheckoutEnabled	Boolean	False	No	This flag indicates whether or not the Checkout Enabled preference of the seller is turned on (at account level or at listing level).
StartTime	Datetime	False	No	The StartTime for when the item was listed.
EndTime	Datetime	False	No	Time stamp (in GMT) when the listing is scheduled to end (calculated based on the values of StartTime and ListingDuration), or the actual end time if the item has ended.
MinimumBestOfferPrice	Decimal	False	No	Specifies the minimum acceptable Best Offer price. If a buyer submits a Best Offer that is below this value, the offer is automatically declined by the seller.
ViewItemURL	String	False	No	The URL of the Web page where a user can view the listing. On the U.S. site, this is called the View Item page.
ViewItemURLForNaturalSearch	String	False	No	This URL takes you to the same View Item page as ViewItemURL, but this URL is optimized to support natural search. That is, this URL is designed to make items on eBay easier to find via popular Internet search engines.
ListingDuration	String	False	No	Describes the number of days the seller wants the listing to be active (available for bidding/buying).
ListingType	String	False	No	The format of the listing the seller wants to use, such as Chinese auction or fixed price.
Location	String	False	No	Indicates the geographical location of the item (along with Country). When you revise a listing, you can add or change this value only if the listing has no bids (or no items have sold), and it does not end within 12 hours.
CategoryId	String	False	No	Category Id for the first (or only) category in which the item is listed (or will be listed, if the item is new).
CategoryName	String	False	No	This string value is the display name of the eBay primary category, as it would appear on the eBay website.
PrivateListing	Boolean	False	No	If true, designates the listing as private.
Quantity	Integer	False	No	The meaning of this value depends on the context.
QuantityAvailableHint	String	False	No	Indicates the type of message that will be returned describing the quantity available for the item.
QuantityThreshold	Integer	False	No	The quantity threshold above which the seller prefers not to show the actual quantity available.
ReservePrice	Decimal	False	No	The lowest price at which the seller is willing to sell the item.
Refund	String	False	No	Display string that buyer applications can use to present RefundOption in a more user-friendly format to buyers.
RefundOption	String	False	No	Indicates how the seller will compensate the buyer for a returned item.
ReturnsAccepted	String	False	No	Display string that buyer applications can use to present ReturnsAcceptedOption in a more user-friendly format to buyers.
ReturnsAcceptedOption	String	False	No	Indicates whether the seller allows the buyer to return the item. One of the following values: ReturnsAccepted or ReturnsNotAccepted. If you specify ReturnsNotAccepted, the View Item page will indicate that returns are not accepted instead.
ReturnsWithin	String	False	No	Display string that buyer applications can use to present ReturnsWithinOption in a more user-friendly format to buyers.
ReturnsWithinOption	String	False	No	The buyer can return the item within this period of time from the day they receive the item.
ShippingCostPaidBy	String	False	No	Display string that buyer applications can use to present ShippingCostPaidByOption in a more user-friendly format to buyers.
ShippingCostPaidByOption	String	False	No	The party who pays the shipping cost for a returned item.
ItemRevised	Boolean	False	No	This field is returned as true if the original listing has been revised.
SellerName	String	False	No	The name of the seller. This field is used as part of the address.
CurrentPrice	Decimal	False	No	The current price of the item in the original listing currency.
ListingStatus	String	False	No	Specifies an active or ended listing status in the processing workflow.
PromotionalEndTime	Datetime	False	No	End time of a discount for an item whose price a seller has reduced with the Promotional Price Display feature.
PromotionalOriginalPrice	Decimal	False	No	Original price of an item whose price a seller has reduced with the Promotional Price Display feature.
PromotionalStartTime	Datetime	False	No	Start time of a discount for an item whose price a seller has reduced with the Promotional Price Display feature.
QuantitySold	Integer	False	No	The total number of items purchased so far in the lifetime of the listing. Subtract this from Quantity to determine the quantity available.
ReserveMet	Boolean	False	No	Indicates whether the reserve price has been met for the listing. Returns true if the reserve price was met or no reserve price was specified.
SecondChanceEligible	Boolean	False	No	Part of the Second Chance Offer feature, which indicates whether the seller can extend a second chance offer for the item.
Site	String	False	No	The name of the site on which the item is listed.
SKU	String	False	No	A SKU (stock keeping unit) is an identifier defined by a seller.
StartPrice	Decimal	False	No	The original price of the item at listing or relisting time. If this value changes when the item is revised, the new value becomes the original price.
TimeLeft	String	False	No	Time left before the listing ends. The duration is represented in the ISO 8601 duration format (PnYnMnDTnHnMnS).
TotalQuestionCount	Integer	False	No	The number of questions asked about this item. Applies to eBay Motors Pro applications only.
WatchCount	Integer	False	No	The number of watches placed on this item from the My eBay accounts of the buyers.
StoreCategoryId	Long	False	No	Unique identifier of a primary custom category in which to list the item.
StoreCategoryId2	Long	False	No	Unique identifier for the secondary custom category in which to list the item.
AdminEndedItemsOnly	String	False	Yes	Specifies whether to return only items that were administratively ended based on a policy violation.
EndTimeFrom	Datetime	False	Yes	Specifies the earliest (oldest) date to use in a date range filter based on item end time. Specify either an end-time range or a start-time range filter. Each of the time ranges must be a value less than 120 days.
EndTimeTo	Datetime	False	Yes	Specifies the latest (most recent) date to use in a date range filter based on item end time. Specify either an end-time range or a start-time range filter. Each of the time ranges must be a value less than 120 days.
GranularityLevel	String	False	Yes	Specifies the subset of item and user fields to return.
StartTimeFrom	Datetime	False	Yes	Specifies the earliest (oldest) date to use in a date range filter based on item start time.
StartTimeTo	Datetime	False	Yes	Specifies the latest (most recent) date to use in a date range filter based on item start time. Must be specified if StartTimeFrom is specified.
UserId	String	False	Yes	Specifies the seller whose items will be returned. UserId is an optional input. If not specified, retrieves listings for the user identified by the authentication token passed in the request.
DetailLevel	String	False	Yes	Detail levels are instructions that define standard subsets of data to return for particular tables.
EndingReason	String	False	Yes	Indicates the reason the seller ended the listing early.

Return to Top

ItemShipping

Name	Type	ReadOnly	FilterOnly	Description
ItemId	String	False	No	The item Id that uniquely identifies the item listing for which to retrieve the data. Required input.
DestinationCountryCode	String	False	No	Destination country code. If DestinationCountryCode is US, a postal code is required and it represents the U.S. ZIP code. Default: US.
ExpeditedService	Boolean	False	No	Indicates whether the service is an expedited shipping service.
FreeShipping	Boolean	False	No	Specifies that the seller wants to offer free shipping. This applies only to the first specified domestic shipping service and is ignored if set for any other shipping service.
ImportCharge	Decimal	False	No	The total cost of customs and taxes for the international leg of an order shipped using the Global Shipping Program. This amount is calculated and supplied for each item by the international shipping provider when a buyer views the item properties.
Currency	String	False	No	Currency Id
ShippingService	String	False	No	A shipping service option being offered by the seller to ship an item to a buyer. For a list of valid ShippingService values, call GeteBayDetails with DetailName set to ShippingServiceDetails. The ShippingServiceDetails.ValidForSellingFlow flag must also be present. Otherwise, that particular shipping service option is no longer valid and cannot be offered to buyers through a listing.
ShippingInsuranceCost	Decimal	False	No	The insurance cost associated with shipping a single item with this shipping service.
ShippingServiceAdditionalCost	Decimal	False	No	A shipping service option being offered by the seller to ship an item to a buyer. For a list of valid ShippingService values, call GeteBayDetails with DetailName set to ShippingServiceDetails. The ShippingServiceDetails.ValidForSellingFlow flag must also be present. Otherwise, that particular shipping service option is no longer valid and cannot be offered to buyers through a listing.
ShippingServiceCost	Decimal	False	No	The base cost of shipping the item using the shipping service specified in the ShippingService field. In the case of a multiple-quantity, fixed-price listing, the ShippingServiceAdditionalCost field shows the cost to ship each additional item if the buyer purchases multiple quantity of the same line item.
ShippingServicePriority	Integer	False	No	Controls the order (relative to other shipping services) in which the corresponding ShippingService will appear in the View Item and Checkout page.
ShippingTimeMax	Integer	False	No	The maximum guaranteed number of days the shipping carrier will take to ship an item (not including the time it takes the seller to deliver the item to the shipping carrier).
ShippingTimeMin	Integer	False	No	The minimum guaranteed number of days in which the shipping carrier can ship an item (not including the time it takes the seller to deliver the item to the shipping carrier).
QuantitySold	String	False	Yes	Number of items sold to a single buyer and to be shipped together.
DestinationPostalCode	String	False	Yes	Destination country postal code (or ZIP code for U.S.). Ignored if no country code is provided. Optional tag for some countries. More likely to be required for large countries.

Return to Top

ItemSpecifics

Name	Type	ReadOnly	FilterOnly	Description
ItemId	String	False	No	The Id that uniquely identifies the item listing. The Id is generated by eBay after an item is listed. You cannot choose or revise this value.
Attribute	String	False	No	The name of the attribute for the specified item.
Specifics	String	False	No	Comma separated list of values for the specified item attribute.
Source	String	False	No	Enumerated value indicating whether the Item Specific was manually input or selected during listing/revision/re-listing time, or if the Item Specific name-value pair came from an eBay catalog product that the listing is associated with.
IncludeItemSpecifics	String	False	Yes	This is used to include ItemSpecifics items and should not be set manually.

Return to Top

ItemTransactions

Name	Type	ReadOnly	FilterOnly	Description
OrderLineItemId [KEY]	String	False	No	A unique identifier for an eBay order line item. This field is created as soon as there is a commitment to buy from the seller, and its value is based upon the concatenation of ItemId and TransactionId with a hyphen in between these two Ids.
TransactionId	String	False	No	The unique identifier for a transaction that was made for a specific item. If a TransactionId is provided, any specified time filter is ignored.
ItemId	String	False	No	Unique identifier for an eBay item listing.
HandlingCost	Decimal	False	No	The handling cost that the seller has charged for the order line item. This field is only returned after checkout is complete. The value of this field is returned as zero dollars (0.0) if the seller did not specify a handling cost for the listing.
ShippingCost	Decimal	False	No	The shipping cost paid by the buyer for the order line item. This field is only returned after checkout is complete.
AdjustmentAmount	Decimal	False	No	Adjustment amount entered by the buyer. A positive amount indicates the amount is an extra charge being paid to the seller by the buyer. A negative value indicates this amount is a credit given to the buyer by the seller.
AmountPaid	Decimal	False	No	The total amount the buyer paid for the order line item.
Currency	String	False	No	A standard 3-digit ISO 4217 currency code for currency used in countries around the world.
BestOfferSale	Boolean	False	No	Indicates whether or not the order line item was created as the result of the seller accepting a Best Offer from a buyer.
BuyerId	String	False	No	Unique eBay user Id for the user.
BuyerCheckoutMessage	String	False	No	This field is returned if a buyer left a comment for the seller during the checkout flow.
CreatedDate	Datetime	False	No	Indicates the creation time of the order line item.
DepositType	String	False	No	This value indicates whether or not the seller requires a deposit for the vehicle. This field is only applicable to U.S. eBay Motors listings. Otherwise, this field is returned as an empty value.
EBayPlusTransaction	Boolean	False	No	If true, this transaction is for an item that was purchased under the eBay Plus program.
ExtendedOrderId	String	False	No	A unique identifier for an eBay order.
FinalValueFee	Decimal	False	No	A Final Value Fee is calculated and charged to the account of a seller immediately upon creation of an order line item.
Gift	Boolean	False	No	This boolean field is returned as true if the seller is giving a digital gift card to another individual as a gift. This field is only applicable for digital gift card order line items.
GiftSummaryMessage	String	False	No	This free-form text contains the message that the purchaser of the digital gift card left for the recipient of the gift card.
IntangibleItem	Boolean	False	No	This flag indicates whether or not the order line item is an intangible good such as an MP3 track or a mobile phone ringtone. Intangible items are not eligible for the PayPal Seller Protection program, so the seller will not be able to open an Unpaid Item case against the buyer.
InvoiceSentTime	Datetime	False	No	This field indicates the date and time that an order invoice was sent from the seller to the buyer. This field is only returned if an invoice (containing the order line item) was sent to the buyer.
IsMultiLegShipping	Boolean	False	No	If IsMultilegShipping is true, the Global Shipping Program (GSP) will be used to ship the order line item to an international buyer.
LogisticsPlanType	String	False	No	This field will be returned only if the buyer purchased a digital gift card, which is delivered by email, or if the buyer purchased an item that is enabled with the Click and Collect feature.
PaidTime	Datetime	False	No	Indicates the time when the order was marked paid. This field is not returned until payment has been made by the buyer. This field will not be returned for orders where the buyer has received partial or full refunds.
QuantityPurchased	Integer	False	No	This value indicates the number of identical items purchased at the same time by the same buyer from one listing.
ShippedTime	Datetime	False	No	Indicates the time when the items associated with the order were marked as shipped. This value will only be visible to the user on either side of the order. An order can be marked as shipped in My eBay, Selling Manager Pro, or programmatically by the seller through the CompleteSale stored procedure.
ShippingConvenienceCharge	Decimal	False	No	The amount that the seller is being charged for the convenience of an eBay Now delivery.
ExpeditedService	Boolean	False	No	Indicates whether the service is an expedited shipping service.
ShippingServiceImportCharge	Decimal	False	No	The total cost of customs and taxes for the international leg of an order shipped using the Global Shipping Program. This amount is calculated and supplied for each item by the international shipping provider when a buyer views the item properties.
ShippingInsuranceCost	Decimal	False	No	The insurance cost associated with shipping a single item with this shipping service.
ShippingPackageInfo	String	False	No	If the order is being delivered through eBay Now, it contains information on the status of the order, the unique identifier of the store where the order is originating from, and the expected and actual delivery times.
ShippingService	String	False	No	A shipping service option being offered by the seller to ship an item to a buyer.
ShippingServiceAdditionalCost	Decimal	False	No	The cost of shipping each additional item if the same buyer purchases one or more of the same line item.
ShippingServiceCost	Decimal	False	No	The base cost using the shipping service specified in the ShippingService field to ship the item. In the case of a multiple quantity, fixed-price listing, the ShippingServiceAdditionalCost field shows the cost to ship each additional item if the buyer purchases one or more of the same line item.
ShippingServicePriority	Integer	False	No	This integer value controls the order (relative to other shipping services) in which the corresponding ShippingService will appear in the View Item and Checkout page.
ShippingTimeMax	Integer	False	No	The maximum guaranteed number of days the shipping carrier will take to ship an item (not including the time it takes the seller to deliver the item to the shipping carrier).
ShippingTimeMin	Integer	False	No	The minimum guaranteed number of days in which the shipping carrier can ship an item (not including the time it takes the seller to deliver the item to the shipping carrier).
BuyerSelectedShipping	Boolean	False	No	Indicates whether the buyer has selected shipping details during checkout.
CheckoutStatus	String	False	No	Indicates the current status of the checkout flow for the order.
CompleteStatus	String	False	No	Indicates whether checkout is complete, incomplete, or pending for an order.
DigitalStatus	String	False	No	The current state of a purchased digital gift card.
EBayPaymentStatus	String	False	No	Indicates the success or failure of the online payment for an order by the buyer.
InquiryStatus	String	False	No	This field gives the status of an Item Not Received (INR) Inquiry by the buyer. This field is only returned if the buyer has created an INR Inquiry.
LastTimeModified	Datetime	False	No	Indicates date and time the status of an order was last updated (in GMT).
PaymentHoldStatus	String	False	No	This field indicates the type and/or status of a payment hold on the item.
PaymentInstrument	String	False	No	The payment method used by a German buyer who was offered the Pay Upon Invoice option. This field will only be returned if a German buyer was offered the Pay Upon Invoice option. Otherwise, the payment method selected by the buyer is returned in the PaymentMethodUsed field.
PaymentMethodUsed	String	False	No	The payment method that the buyer selected to pay for the order. If checkout is not yet complete, PaymentMethodUsed is set to whatever the buyer selected as his or her preference on the Review Your Purchase page.
ReturnStatus	String	False	No	This field gives the status of a return request from the buyer. This field is only returned if the buyer has initiated a return request or has escalated an existing return request into a return case.
TransactionPrice	Decimal	False	No	The price of the order line item (transaction).
ModTimeFrom	String	False	Yes	The ModTimeFrom and ModTimeTo fields specify a date range for retrieving order line items associated with the specified ItemId. The ModTimeFrom field is the starting date range.
ModTimeTo	String	False	Yes	The ModTimeFrom and ModTimeTo fields specify a date range for retrieving order line items associated with the specified ItemId. The ModTimeTo field is the ending date range.
NumberOfDays	String	False	Yes	This time filter specifies the number of days (24-hour periods) in the past to search for order line items.

Return to Top

ItemVariations

Name	Type	ReadOnly	FilterOnly	Description
ItemId [KEY]	String	False	No	The Id that uniquely identifies the item listing. The Id is generated by eBay after an item is listed. You cannot choose or revise this value.
VariationSpecificsAggregate [KEY]	String	False	No	A list of name/value pairs that uniquely identify the variation within the listing. All variations must specify the same set of names. For example, if the items vary by color and size, then every variation must specify Color and Size as names, and no two variations can specify the same combination of color and size values.
StartPrice	Decimal	False	No	The price of the item at listing or relisting time. If this value changes when the item is revised, the new value becomes this price.
Currency	String	False	No	Currency associated with the price information of the item. 3-letter ISO 4217 currency code.
Quantity	Integer	False	No	This value indicates the quantity of items in the specific variation that are available for purchase.
QuantitySold	Integer	False	No	The total number of items purchased so far. Subtract this from Quantity to determine the quantity available.
SKU	String	False	No	A SKU (stock keeping unit) is an identifier defined by a seller. It is only intended for the use of the seller (not for buyers).
EAN	String	False	No	This field is used if the seller wishes to identify each product variation within a multivariation listing by an EAN (European Article Number) value.
ISBN	String	False	No	This field is used if the seller wishes to identify each product variation within a multivariation listing by an ISBN (International Standard Book Number) value.
UPC	String	False	No	This field is used if the seller wishes to identify each product variation within a multivariation listing by a UPC (Universal Product Code) value.
ListingStatus	String	False	No	Specifies a listing with an active or ended status in the eBay processing workflow.

Return to Top

MostWatchedItems

Name	Type	ReadOnly	FilterOnly	Description
ItemId [KEY]	String	False	No	The Id that uniquely identifies the item listing. The Id is generated by eBay after an item is listed.
Title	String	False	No	Name of the item as it appears in the listing or search results.
Subtitle	String	False	No	Subtitle of the item. Only returned if the seller included a subtitle for the listing.
WatchCount	Integer	False	No	The number of watches placed on this item from the My eBay accounts of the buyers.
BidCount	Integer	False	No	The number of bids that have been placed on the item.
BuyItNowPrice	Decimal	False	No	The Buy It Now Price of the item (if any), in the currency of the site on which the item was listed.
Currency	String	False	No	The 3-digit ISO 4217 currency codes for the currency used by the site.
OriginalRetailPrice	Decimal	False	No	The actual retail price set by the manufacturer (OEM).
PricingTreatment	String	False	No	Using OriginalRetailPrice, MinimumAdvertisedPrice, and StartPrice values, eBay identifies whether the listing falls under MAP or STP (aka OriginalRetailPrice).
SoldOffEbay	Boolean	False	No	Used by the eBay UK and eBay Germany (DE) sites, this flag indicates that the discount price (specified as StartPrice) is the price for which the seller offered the same (or similar) item for sale on a Web site or offline store other than eBay in the previous 30 days. The discount price is always in reference to the price for the item set by the seller.
SoldOnEbay	Boolean	False	No	Used by the eBay UK and eBay Germany (DE) sites, this flag indicates that the discount price (specified as StartPrice) is the price for which the seller offered the same (or similar) item for sale on eBay in the previous 30 days. The discount price is always in reference to the price for the item set by the seller.
GlobalId	String	False	No	The site upon which the item is listed. Returns a Global Id, which is a unique identifier for combinations of site, language, and territory.
ImageURL	String	False	No	URL for a picture used as the Gallery thumbnail, if any. The image uses one of the following graphics formats: JPEG, BMP, TIF, or GIF. Only returned if the seller chose to show a gallery image.
OriginalPrice	Decimal	False	No	Original price of an item whose price a seller has reduced with the Promotional Price Display feature. Only returned if the price has been revised.
PrimaryCategoryId	String	False	No	Numeric Id of the first (or only) category in which the item is listed. (Listings can appear in more than one category.)
PrimaryCategoryName	String	False	No	Display name of the first (or only) category in which the item is listed. This is a fully qualified category breadcrumb (e.g., Computers & Networking:Laptops, Notebooks).
ShippingCost	Decimal	False	No	The shipping cost associated with the first shipping service. Only returned when ShippingType is flat.
ShippingType	String	False	No	The shipping cost model offered by the seller.
TimeLeft	String	False	No	Time left before the item listing ends. The duration is represented in the ISO 8601 duration format (PnDTnHnMnS). For ended listings, the time left is P0DT0H0M0S (zero days, zero hours, zero minutes, and zero seconds).
ViewItemURL	String	False	No	The URL of the Web page where a user can view the listing. On the U.S. site, this is called the View Item page. If you enabled affiliate tracking in the call, ViewItemURL contains a string that includes affiliate tracking information (see the eBay Partner Network).
CategoryId	String	False	Yes	Specifies the category from which to retrieve item listings.
AffiliateCustomId	String	False	Yes	Need not be specified. You can define an AffiliateCustomId to better monitor your marketing efforts. If you are using the eBay Partner Network, and you provide an AffiliateCustomId, the tracking URL returned by the eBay Partner Network will contain the AffiliateUserId.
AffiliateNetworkId	String	False	Yes	Specifies your tracking partner for affiliate commissions.
AffiliateTrackingId	String	False	Yes	The value you specify is obtained from your tracking partner.

Return to Top

OrderPayments

Name	Type	ReadOnly	FilterOnly	Description
PaymentId [KEY]	String	False	No	A unique transaction ID for the payment.
OrderId	String	False	No	A unique identifier for an eBay order.
FeeOrCreditAmount	Decimal	False	No	Fee Amount is a positive value and Credit Amount is a negative value.
Payee	String	False	No	The person or organization who is to receive the payment allocation.
Payer	String	False	No	This field indicates the eBay user or eBay partner who submitted the payment.
PaymentAmount	Decimal	False	No	The amount of the payment that is allocated to the payee.
PaymentStatus	String	False	No	The current status of a buyer payment that is allocated to a specified payee.
PaymentTime	Datetime	False	No	The date and time when the payment is received by the payee.
CreateTimeFrom	Datetime	False	Yes	Specifies the start of the date range for which to retrieve payment details of the orders created within this date range.
CreateTimeTo	Datetime	False	Yes	Specifies the end of the date range for which to retrieve payment details of the orders created within this date range.
ModTimeFrom	Datetime	False	Yes	Specifies the start of the date range for which to retrieve payment details of the orders modified within this date range. The maximum time range that may be specified is 30 days.
ModTimeTo	Datetime	False	Yes	Specifies the end of the date range for which to retrieve payment details of the orders modified within this date range. The maximum time range that may be specified is 30 days.
NumberOfDays	Integer	False	Yes	All eBay payment details of the orders that were either created or modified within this period are returned in the output. Min: 1. Max: 30.
OrderRole	String	False	Yes	Filters the returned payment details of the orders based on the role of the user. The user's role is either buyer or seller.
OrderStatus	String	False	Yes	Filters the returned payment details of the orders based on the status of the order. Applicable Values: Active, All, Completed, Inactive.

Return to Top

Orders

Name	Type	ReadOnly	FilterOnly	Description
OrderId [KEY]	String	False	No	A unique identifier for an eBay order.
ExtendedOrderId	String	False	No	The unique identifier of the order in legacy format, as traditionally used by the Trading API.
BuyerUserId	String	False	No	eBay user ID of the order's buyer.
SellerUserId	String	False	No	This is the eBay user ID of the order's seller.
OrderStatus	String	False	No	This enumeration value indicates the current status of the order. Applicable Values: Active, All, Cancelled, Completed, Inactive.
AdjustmentAmount	Decimal	False	No	This value indicates the dollar amount by which the buyer has adjusted the order total.
AmountPaid	Decimal	False	No	This value indicates the total amount of the order.
AmountSaved	Decimal	False	No	This value indicates the shipping discount experienced by the buyer as a result of creating a Combined Invoice order.
CreatedTime	Datetime	False	No	Timestamp that indicates the date and time that the order was created.
ShippedTime	Datetime	False	No	Timestamp indicating the date and time of order shipment. This field is not returned until the order has been marked as shipped.
PaymentMethod	String	False	No	The payment method that the buyer selected to pay for the order.
PaymentStatus	String	False	No	This value indicates the payment status of an order.
CheckoutStatus	String	False	No	Container consisting of details related to the current checkout status of the order.
SellerEmail	String	False	No	The email address of the seller involved in the order. The email address of the seller is only returned if it is the same seller making the call.
SubTotal	Decimal	False	No	The subtotal amount for the order is the total cost of all order line items. This value does not include any shipping/handling, shipping insurance, or sales tax costs.
Total	Decimal	False	No	The Total amount equals the Subtotal value plus the shipping/handling, shipping insurance, and sales tax costs.
CancelCompleteDate	Datetime	False	No	Timestamp indicating when the cancellation process of an eBay order has been completed.
CancelInitiationDate	Datetime	False	No	This timestamp indicates when the cancellation of the eBay order was initiated.
CancelInitiator	String	False	No	This value indicates which party initiated the cancellation of the eBay order.
CancelReason	String	False	No	This value indicates the reason why the order cancellation was initiated.
CancelStatus	String	False	No	The current status for the order cancellation request if it exists.
CreateTimeFrom	Datetime	False	Yes	Specifies the start of the date range for which to retrieve orders created within this date range.
CreateTimeTo	Datetime	False	Yes	Specifies the end of the date range for which to retrieve orders created within this date range.
ModTimeFrom	Datetime	False	Yes	Specifies the start of the date range for which to retrieve orders modified within this date range. The maximum time range that may be specified is 30 days.
ModTimeTo	Datetime	False	Yes	Specifies the end of the date range for which to retrieve orders modified within this date range. The maximum time range that may be specified is 30 days.
NumberOfDays	Integer	False	Yes	All eBay orders that were either created or modified within this period are returned in the output. Min: 1. Max: 30.
OrderRole	String	False	Yes	Filters the returned orders based on the role of the user. The user's role is either buyer or seller.

Return to Top

OrderShipping

Name	Type	ReadOnly	FilterOnly	Description
OrderId [KEY]	String	False	No	The Id that uniquely identifies the item listing. The Id is generated by eBay after an item is listed. You cannot choose or revise this value.
AddressId	String	False	No	Unique ID for a user's address in the eBay database.
CityName	String	False	No	The name of the user's city.
Country	String	False	No	The two-digit code representing the country of the user.
CountryName	String	False	No	The name of the user's country.
AddressName	String	False	No	User's name for the address.
Phone	String	False	No	User's primary phone number.
PostalCode	String	False	No	User's postal code.
StateOrProvince	String	False	No	The state or province of the user's address. Whether it's a state or a province will depend on the region and/or country.
Street1	String	False	No	The first line of the user's street address.
Street2	String	False	No	The second line of the user's street address (such as an apartment number or suite number).
ShippingCharge	Decimal	False	No	The dollar value in this field indicates the amount that the seller is being charged (at order level) for the convenience of an eBay On Demand Delivery.
ExpeditedService	Boolean	False	No	Indicates whether the service is an expedited shipping service.
ShippingImportCharge	Decimal	False	No	The total cost of customs and taxes for the international leg of an order shipped using the Global Shipping Program.
ShippingInsuranceCost	Decimal	False	No	The insurance cost associated with shipping a single item with this shipping service.
ShippingServiceAdditionalCost	Decimal	False	No	The cost of shipping each additional item if the same buyer purchases multiple quantity of the same line item.
ShippingServiceCost	Decimal	False	No	The base cost of shipping the item using the shipping service specified in the ShippingService field.
ActualDeliveryTime	Datetime	False	No	This timestamp indicates when the order was actually delivered to the buyer.
EstimatedDeliveryTimeMax	Datetime	False	No	The EstimatedDeliveryTimeMin and EstimatedDeliveryTimeMax timestamps indicate the window during which the buyer can expect delivery.
EstimatedDeliveryTimeMin	Datetime	False	No	The EstimatedDeliveryTimeMin and EstimatedDeliveryTimeMax timestamps indicate the window during which the buyer can expect delivery.
HandleByTime	Datetime	False	No	This timestamp indicates the latest date/time that the seller should ship the package to ensure that the package arrives to the buyer within the estimated delivery window.
ScheduledDeliveryTimeMax	Datetime	False	No	The ScheduledDeliveryTimeMin and ScheduledDeliveryTimeMax timestamps indicate the delivery window for which the buyer can expect to receive the order.
ScheduledDeliveryTimeMin	Datetime	False	No	The ScheduledDeliveryTimeMin and ScheduledDeliveryTimeMax timestamps indicate the delivery window for which the buyer can expect to receive the order.
ShippingTrackingEvent	String	False	No	This enumeration value indicates whether or not the order has been picked up from the store indicated by the StoreID value.
StoreId	String	False	No	The unique identifier of the store from where the order will be delivered.
SalesTaxAmount	Decimal	False	No	The amount of sales tax, calculated for an order based on the SalesTaxPercent and pricing information.
SalesTaxPercent	Float	False	No	Percent of an item's price to be charged as the sales tax for the order.
SalesTaxState	String	False	No	State or jurisdiction for which the sales tax is being collected. Only returned if the seller specified a value.
ShipmentTrackingNumbers	String	False	No	The tracking numbers assigned by the shipping carriers.
ShippingCarriers	String	False	No	The name of the shipping carriers used to ship the items.
CreateTimeFrom	Datetime	False	Yes	Specifies the start of the date range for which to retrieve shipping details of the orders created within this date range.
CreateTimeTo	Datetime	False	Yes	Specifies the end of the date range for which to retrieve shipping details of the orders created within this date range.
ModTimeFrom	Datetime	False	Yes	Specifies the start of the date range for which to retrieve shipping details of the orders modified within this date range. The maximum time range that may be specified is 30 days.
ModTimeTo	Datetime	False	Yes	Specifies the end of the date range for which to retrieve shipping details of the orders modified within this date range. The maximum time range that may be specified is 30 days.
NumberOfDays	Integer	False	Yes	All eBay shipping details of the orders that were either created or modified within this period are returned in the output. Min: 1. Max: 30.
OrderRole	String	False	Yes	Filters the returned shipping details of the orders based on the role of the user. The user's role is either buyer or seller.
OrderStatus	String	False	Yes	Filters the returned shipping details of the orders based on the status of the order. Applicable Values: Active, All, Completed, Inactive.

Return to Top

PaymentPolicies

Name	Type	ReadOnly	FilterOnly	Description
PaymentPolicyId [KEY]	String	False	No	A unique eBay-assigned ID for a payment policy. This ID is generated when the policy is created.
Description	String	False	No	The Description of the payment policy.
Name	String	False	No	The Description of the payment policy.
CategoryTypesName	String	False	No	The Category Type name value to which this policy applies. Used to discern accounts that sell motor vehicles from those that don't.
DepositAggr	String	False	No	Amounts and due dates for deposits on motor vehicle listings on eBay Motors. Is applicable only if the categoryTypes.name field is set to MOTORS_VEHICLES.
MarketplaceId	String	False	No	The ID of the eBay marketplace to which the payment policy applies.
ImmediatePay	Boolean	False	No	If set to true, payment is due upon receipt (eBay generates a receipt when the buyer agrees to purchase an item).
PaymentMethodAggr	String	False	No	If the seller is not opted-in to managed payments, this container returns a list of the payment methods accepted by the seller.
RecipientAccountReferenceId	String	False	No	Contains the PayPal email address of the recipient (buyer) if referenceType is set to PAYPAL_EMAIL.
RecipientAccountReferenceType	String	False	No	A reference a recipient's account. Currently only PAYPAL_EMAIL is valid.

Return to Top

ReturnPolicies

Name	Type	ReadOnly	FilterOnly	Description
ReturnPolicyId [KEY]	String	False	No	A unique eBay-assigned ID for this policy.
Description	String	False	No	The seller-defined description of the return policy for internal use (this value is not displayed to end users).
Name	String	False	No	The category type to which the policy applies (motor vehicles or non-motor vehicles).
CategoryTypesName	String	False	No	The category type to which the policy applies (motor vehicles or non-motor vehicles).
MarketplaceId	String	False	No	The ID of the eBay marketplace to which this return policy applies.
ExtendedHolidayReturnsOffered	String	False	No	If set to true, the seller offers an Extended Holiday Returns policy for their listings.
InternationalOverrideAggr	String	False	No	If populated, specifies the seller's policies for international returns (items that require postage via an international shipping service).
RefundMethod	String	False	No	Indicates the method the seller uses to compensate the buyer for returned items. The return method specified applies only to remorse returns.
RestockingFeePercentage	String	False	No	For sellers who accept returns, this field is filled if they charge buyers a restocking fee when items are returned.
ReturnInstructions	String	False	No	Contains the seller's detailed explanation for their return policy and is displayed in the Return Policy section of the View Item page.
ReturnMethod	String	False	No	Valid in the US marketplace only, this optional field indicates additional services (other than money-back) that sellers can offer buyers for remorse returns.
ReturnPeriodValue	String	False	No	Specifies the amount of time the buyer has to return an item.
ReturnPeriodUnit	String	False	No	Specifies the unit of measure of amount of time the buyer has to return an item.
ReturnsAccepted	Boolean	False	No	If set to true, the seller accepts returns.
ReturnShippingCostPayer	String	False	No	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.

Return to Top

ShippingCarriers

Name	Type	ReadOnly	FilterOnly	Description
ShippingCarrierId	Integer	False	No	Numeric identifier.
Description	String	False	No	Display string that applications can use to present a list of shipping carriers in a more user-friendly format (such as in a drop-down list).
DetailVersion	String	False	No	Returns the latest version number for this field.
ShippingCarrier	String	False	No	The code for the shipping carrier.
UpdateTime	Datetime	False	No	Gives the time in GMT that the feature flags for the details were last updated.
DetailName	String	False	Yes	A designation of what kind of information you wish returned for the specified eBay site.

Return to Top

ShippingCategories

Name	Type	ReadOnly	FilterOnly	Description
ShippingCategory [KEY]	String	False	No	Indicates the shipping category. Shipping categories include the following: ECONOMY, STANDARD, EXPEDITED, ONE_DAY, PICKUP, OTHER, and NONE. International shipping services are generally grouped into the NONE category. For more information on these shipping categories, and which services fall into which category, see the Shipping Basics page on the eBay Shipping Center site.
Description	String	False	No	Display string that applications can use to present a list of shipping categories in a more user-friendly format (such as in a drop-down list). This field is localized per site.
DetailVersion	String	False	No	Returns the latest version number for this field. The version can be used to determine if and when to refresh cached client data.
UpdateTime	Datetime	False	No	Gives the time in GMT that the feature flags for the details were last updated. This timestamp can be used to determine if and when to refresh cached client data.
DetailName	String	False	Yes	A designation of what kind of information you wish returned for the specified eBay site.

Return to Top

ShippingLocations

Name	Type	ReadOnly	FilterOnly	Description
ShippingLocation [KEY]	String	False	No	Short name or abbreviation for a region (e.g., Asia) or location (e.g. Japan).
Description	String	False	No	Display string that applications can use to present a list of shipping locations in a more user-friendly format (such as in a drop-down list). This field is localized in the language of the site.
DetailVersion	String	False	No	Returns the latest version number for this field. The version can be used to determine if and when to refresh cached client data.
UpdateTime	Datetime	False	No	Gives the time in GMT that the feature flags for the details were last updated. This timestamp can be used to determine if and when to refresh cached client data.
DetailName	String	False	Yes	A designation of what kind of information you wish returned for the specified eBay site.

Return to Top

ShippingServices

Name	Type	ReadOnly	FilterOnly	Description
ShippingServiceId [KEY]	Integer	False	No	Numeric identifier. A value greater than 50000 represents an international shipping service.
CODService	Boolean	False	No	This flag is returned as true if the corresponding ShippingService value is a COD (Cash-On-Delivery) service.
CostGroupFlat	Boolean	False	No	If returned, this is the shipping service group to which the shipping service belongs.
Description	String	False	No	A user-friendly description of shipping service options.
DetailVersion	String	False	No	Returns the latest version number for this field.
DimensionsRequired	Boolean	False	No	Whether the shipping service option requires that package dimensions are provided by the seller.
ExpeditedService	Boolean	False	No	Indicates whether the shipping service is an expedited shipping service. Only returned for sites for which the Get It Fast feature is enabled and only if true.
InternationalService	Boolean	False	No	Indicates whether the shipping service is an international shipping service.
MappedToShippingServiceId	Integer	False	No	The Id of another shipping service that will be used when a shipping service is deprecated.
ShippingCategory	String	False	No	Indicates the shipping category. Shipping categories include the following: ECONOMY, STANDARD, EXPEDITED, ONE_DAY, PICKUP, OTHER, and NONE. International shipping services are generally grouped into the NONE category.
ShippingService	String	False	No	The name of the shipping service option. If the ValidForSellingFlow column is not true, this particular shipping service option is no longer valid and cannot be offered to buyers through a listing.
ShippingTimeMax	Integer	False	No	The maximum guaranteed number of days the shipping carrier will take to ship an item (not including the time it takes the seller to deliver the item to the shipping carrier). Always returned when ExpeditedService is true or if defined for a particular service.
ShippingTimeMin	Integer	False	No	The minimum guaranteed number of days the shipping carrier will take to ship an item (not including the time it takes the seller to deliver the item to the shipping carrier). Always returned when ExpeditedService is true or if defined for a particular service.
SurchargeApplicable	Boolean	False	No	True if a surcharge applies for any region that this service ships to.
UpdateTime	Datetime	False	No	Gives the time in GMT that the feature flags for the details were last updated.
ValidForSellingFlow	Boolean	False	No	If this field is returned as true, the shipping service option can be used. If this field is returned as false, the shipping service option is not currently supported.
WeightRequired	Boolean	False	No	If true, a seller who selects this package type for the listing and then offers this shipping service must specify WeightMajor and WeightMinor in the item definition. If not returned, WeightRequired is false.
DetailName	String	False	Yes	A designation of what kind of information you wish returned for the specified eBay site.

Return to Top

Sites

Name	Type	ReadOnly	FilterOnly	Description
SiteID	Integer	False	No	Numeric identifier for an eBay site. If you are using the SOAP API, you use numeric site IDs in the request URL. If you are using the XML API, you use numeric site IDs in the X-EBAY-API-SITEID header.
SiteName	String	False	No	Short name that identifies an eBay site. Usually, an eBay site is associated with a particular country or region (e.g., US or Belgium_French). Specialty sites (e.g., eBay Stores) use the same site ID as their associated main eBay site. The US eBay Motors site is an exception to this convention.
DetailVersion	String	False	No	Returns the latest version number for this field. The version can be used to determine if and when to refresh cached client data.
UpdateTime	Datetime	False	No	Gives the time in GMT that the feature flags for the details were last updated. This timestamp can be used to determine if and when to refresh cached client data.
DetailName	String	False	Yes	A designation of what kind of information you wish returned for the specified eBay site.

Return to Top

SuggestedCategories

Name	Type	ReadOnly	FilterOnly	Description
CategoryId	Integer	False	No	This string value is the unique identifier of an eBay category.
CategoryName	String	False	No	This string value is the display name of the eBay primary category, as it would appear on the eBay website.
CategoryParentId	String	False	No	This string value is the category Id of the parent category of the primary category indicated in the CategoryId field.
CategoryParentName	String	False	No	This string value is the display name of the eBay primary category, as it would appear on the eBay website.
PercentItemFound	Integer	False	No	Percentage of the matching items that were found in this category, relative to other categories in which matching items were also found. Indicates the distribution of matching items across the suggested categories.
Query	String	False	Yes	This field is used to specify the search query, consisting of one or more keywords to search for in listing titles and descriptions. The words and and or are treated like any other word.

Return to Top

Tasks

Name	Type	ReadOnly	FilterOnly	Description
TaskId [KEY]	String	True	No	The ID of the task that was submitted in the request.
Status	String	True	No	The enumeration value that indicates the state of the task that was submitted in the request.
FeedType	String	False	No	The feed type associated with the task.
CreationDate	Datetime	True	No	The date the task was created.
UploadSummaryAggr	String	True	No	This container provides summary information on an upload feed (not applicable for download feed types).
MarketplaceID	String	False	Yes	MarketplaceID of your Ebay account.
SchemaVersion	String	False	Yes	The schema version number associated with the task.

Return to Top

TransactionLinkedItems

Name	Type	ReadOnly	FilterOnly	Description
ID [KEY]	String	False	No	The unique identifier of the linked order line item.
TransactionId	String	False	No	Unique identifier for an eBay sales transaction.
OrderId	String	False	No	The unique identifier of the order to which the linked line item belongs.
EstimatedDeliveryTimeMax	Datetime	False	No	Indicates the latest date and time to receive the order.
EstimatedDeliveryTimeMin	Datetime	False	No	Indicates the earliest date and time to receive the order.
SellerUserID	String	False	No	The eBay user ID of the seller who sold the linked line item.
ItemName	String	False	No	Depending on the call and context, this value is either a name of an Item/Variation Specific, or a Parts Compatibility name.
ItemValue	String	False	No	Depending on the call and context, this value is either the value of an Item/Variation Specific, a Parts Compatibility value, or a product identifier.
ItemsTitle	String	False	No	This field is used to specify the title of the listing.
CreateTimeFrom	Datetime	False	No	Specifies the start of the date range for which to retrieve payment details of the transactions in orders created within this date range. By default the date range is 90 days.
CreateTimeTo	Datetime	False	No	Specifies the end of the date range for which to retrieve payment details of the transactions in orders created within this date range. By default the date range is 90 days.
ModTimeFrom	Datetime	False	No	Specifies the start of the date range for which to retrieve payment details of the transactions in orders modified within this date range. The maximum time range that may be specified is 30 days.
ModTimeTo	Datetime	False	No	Specifies the end of the date range for which to retrieve payment details of the transactions in orders modified within this date range. The maximum time range that may be specified is 30 days.
NumberOfDays	Integer	False	No	All eBay payment details of the transactions in orders that were either created or modified within this period are returned in the output. Min: 1. Max: 30.
OrderRole	String	False	No	Filters the returned payment details of the transactions based on the role of the user. The user's role is either buyer or seller.
OrderStatus	String	False	No	Filters the returned payment details of the transactions based on the status of the order. Applicable Values: Active, All, Completed, Inactive.

Return to Top

TransactionPayments

Name	Type	ReadOnly	FilterOnly	Description
TransactionReferenceId [KEY]	String	False	No	A unique transaction ID for the payment.
TransactionId	String	False	No	The unique identifier of the transaction the payment has been made for.
OrderId	String	False	No	The unique identifier of the order the payment has been made for.
FeeOrCreditAmount	Decimal	False	No	Fee Amount is a positive value and Credit Amount is a negative value.
Payee	String	False	No	The person or organization who is to receive the payment allocation.
Payer	String	False	No	This field indicates the eBay user or eBay partner who submitted the payment.
PaymentAmount	Decimal	False	No	The amount of the payment that is allocated to the payee.
PaymentStatus	String	False	No	The current status of a buyer payment that is allocated to a specified payee.
PaymentTime	Datetime	False	No	The date and time when the payment is received by the payee.
CreateTimeFrom	Datetime	False	Yes	Specifies the start of the date range for which to retrieve payment details of the transactions in orders created within this date range. By default the date range is 90 days.
CreateTimeTo	Datetime	False	Yes	Specifies the end of the date range for which to retrieve payment details of the transactions in orders created within this date range. By default the date range is 90 days.
ModTimeFrom	Datetime	False	Yes	Specifies the start of the date range for which to retrieve payment details of the transactions in orders modified within this date range. The maximum time range that may be specified is 30 days.
ModTimeTo	Datetime	False	Yes	Specifies the end of the date range for which to retrieve payment details of the transactions in orders modified within this date range. The maximum time range that may be specified is 30 days.
NumberOfDays	Integer	False	Yes	All eBay payment details of the transactions in orders that were either created or modified within this period are returned in the output. Min: 1. Max: 30.
OrderRole	String	False	Yes	Filters the returned payment details of the transactions based on the role of the user. The user's role is either buyer or seller.
OrderStatus	String	False	Yes	Filters the returned payment details of the transactions based on the status of the order. Applicable Values: Active, All, Completed, Inactive.

Return to Top

TransactionRefunds

Name	Type	ReadOnly	FilterOnly	Description
ReferenceId [KEY]	String	False	No	This dollar value is the amount of the refund to the buyer for this specific refund transaction.
TransactionId	String	False	No	The unique identifier of the transaction the payment has been made for.
OrderId	String	False	No	The unique identifier of the order the payment has been made for.
FeeOrCreditAmount	Decimal	False	No	Fee Amount is a positive value and Credit Amount is a negative value.
RefundTo	String	False	No	This field is the eBay user ID of the buyer who is receiving the refund or store credit from the merchant.
RefundType	String	False	No	This value indicates whether the merchant refunded or provided a store credit to the buyer for the returned In-Store Pickup item.
RefundAmount	Decimal	False	No	This dollar value is the amount of the refund to the buyer for this specific refund transaction.
RefundStatus	String	False	No	This value indicates the success or failure of the attempt by the merchant to refund or provide store credit to the buyer for a returned In-Store Pickup item.
RefundTime	Datetime	False	No	This date/time value is the timestamp for the refund transaction. This field is not returned if the refund was not successful (RefundStatus=FAILED).
CreateTimeFrom	Datetime	False	No	Specifies the start of the date range for which to retrieve payment details of the transactions in orders created within this date range. By default the date range is 90 days.
CreateTimeTo	Datetime	False	No	Specifies the end of the date range for which to retrieve payment details of the transactions in orders created within this date range. By default the date range is 90 days.
ModTimeFrom	Datetime	False	No	Specifies the start of the date range for which to retrieve payment details of the transactions in orders modified within this date range. The maximum time range that may be specified is 30 days.
ModTimeTo	Datetime	False	No	Specifies the end of the date range for which to retrieve payment details of the transactions in orders modified within this date range. The maximum time range that may be specified is 30 days.
NumberOfDays	Integer	False	No	All eBay payment details of the transactions in orders that were either created or modified within this period are returned in the output. Min: 1. Max: 30.
OrderRole	String	False	No	Filters the returned payment details of the transactions based on the role of the user. The user's role is either buyer or seller.
OrderStatus	String	False	No	Filters the returned payment details of the transactions based on the status of the order. Applicable Values: Active, All, Completed, Inactive.

Return to Top

Transactions

Name	Type	ReadOnly	FilterOnly	Description
TransactionId [KEY]	String	False	No	Unique identifier for an eBay order line item. An order line item is created once there is a commitment from a buyer to purchase an item.
OrderId	String	False	No	The Id that uniquely identifies the item listing. The Id is generated by eBay after an item is listed. You cannot choose or revise this value.
ItemId	String	False	No	The unique identifier of the eBay listing. This identifier is generated by eBay and returned in the response of an Add call if an item is successfully listed.
ItemSite	String	False	No	The name of the site on which the item is listed.
ItemTitle	String	False	No	This field is used to specify the title of the listing.
ActualHandlingCost	Decimal	False	No	The handling cost that the seller has charged for the order line item.
ActualShippingCost	Decimal	False	No	The shipping cost paid by the buyer for the order line item. This field is only returned after checkout is complete.
BuyerEmail	String	False	No	Email address for the user.
BuyerFirstName	String	False	No	The first name of the buyer who purchased the order.
BuyerLastName	String	False	No	The last name of the buyer who purchased the order.
CreatedDate	Datetime	False	No	Indicates the creation time of the order line item.
Price	Decimal	False	No	The price of the order line item.
SiteId	String	False	No	The site upon which the order line item (transaction) was created.
PaidTime	Datetime	False	No	Indicates the time when the order was marked paid.
DigitalRecipientEmail	String	False	No	This field displays the email address of the sender/purchaser of the digital gift card.
DigitalRecipientName	String	False	No	This field displays the actual name (not the eBay user ID) of the sender/purchaser of the digital gift card.
DigitalSenderEmail	String	False	No	This field displays the email address of the sender/purchaser of the digital gift card.
DigitalSenderName	String	False	No	This field displays the actual name (not the eBay user ID) of the sender/purchaser of the digital gift card
DigitalDeliveryMethod	String	False	No	This value indicates the method in which the digital gift card will be delivered to the buyer.
EBayPlusTransaction	Boolean	False	No	If true, this transaction is for an item that was purchased under the eBay Plus program.
FinalValueFee	Decimal	False	No	A Final Value Fee is calculated and charged to a seller's account immediately upon creation of an order line item.
GuaranteedDelivery	Boolean	False	No	This field is returned as true if the order line item is qualified for eBay Guaranteed Delivery, or false if it is not eligible.
GuaranteedShipping	Boolean	False	No	This field is returned as true if the seller chose to use eBay's Guaranteed Shipping feature at listing time.
InvoiceSentTime	Datetime	False	No	This field indicates the date/time that an order invoice was sent from the seller to the buyer.
DigitalStatus	String	False	No	This enumeration value indicates the current state of a purchased digital gift card.
InquiryStatus	String	False	No	This field gives the status of a buyer's Item Not Received (INR) Inquiry.
ReturnStatus	String	False	No	This field gives the status of a buyer's return request.
TotalTaxAmount	Decimal	False	No	This value indicates the total tax amount for the order line item, including the sales tax on the item, the sales tax on shipping and handling, and any electronic waste recycling fee.
CreateTimeFrom	Datetime	False	Yes	Specifies the start of the date range for which to retrieve transactions of orders created within this date range.
CreateTimeTo	Datetime	False	Yes	Specifies the end of the date range for which to retrieve transactions of orders created within this date range.
ModTimeFrom	Datetime	False	Yes	Specifies the start of the date range for which to retrieve transactions of orders modified within this date range. The maximum time range that may be specified is 30 days.
ModTimeTo	Datetime	False	Yes	Specifies the end of the date range for which to retrieve transactions of orders modified within this date range. The maximum time range that may be specified is 30 days.
NumberOfDays	Integer	False	Yes	All eBay transactions that were either created or modified within this period are returned in the output. Min: 1. Max: 30.
OrderRole	String	False	Yes	Filters the returned transactions based on the role of the user. The user's role is either buyer or seller.
OrderStatus	String	False	Yes	Filters the returned transactions based on the status of the order. Applicable Values: Active, All, Completed, Inactive.

Return to Top

TransactionShipping

Name	Type	ReadOnly	FilterOnly	Description
TransactionId [KEY]	String	False	No	Unique identifier for the transaction.
OrderId	String	False	No	Unique identifier for the order.
InternationalPackagingHandlingCosts	Decimal	False	No	Fees a seller might assess for the shipping of the item (in addition to whatever the shipping service might charge).
PostalCode	String	False	No	Postal code for the location from which the package will be shipped.
PackagingHandlingCosts	Decimal	False	No	Fees a seller might assess for the shipping of the item (in addition to whatever the shipping service might charge).
ShippingIrregular	Boolean	False	No	This boolean field indicates that the shipping package is considered an irregular shape and/or size by the shipping carrier, and thus requires special handling.
ExpeditedService	Boolean	False	No	Indicates whether the service is an expedited shipping service.
ShippingImportCharge	Decimal	False	No	The total cost of customs and taxes for the international leg of an order shipped using the Global Shipping Program.
ShippingInsuranceCost	Decimal	False	No	The insurance cost associated with shipping a single item with this shipping service.
ShippingServiceAdditionalCost	Decimal	False	No	The cost of shipping each additional item if the same buyer purchases multiple quantity of the same line item.
ShippingServiceCost	Decimal	False	No	The base cost of shipping the item using the shipping service specified in the ShippingService field.
ShippingPackageInfo	String	False	No	This aggregate contains all shipping package info.
ShipmentTrackingNumbers	String	False	No	The tracking numbers assigned by the shipping carriers.
ShippingCarriers	String	False	No	The name of the shipping carriers used to ship the items.
CreateTimeFrom	Datetime	False	Yes	Specifies the start of the date range for which to retrieve shipping details of the transactions in orders created within this date range. By default the date range is 90 days.
CreateTimeTo	Datetime	False	Yes	Specifies the end of the date range for which to retrieve shipping details of the transactions in orders created within this date range. By default the date range is 90 days.
ModTimeFrom	Datetime	False	Yes	Specifies the start of the date range for which to retrieve shipping details of the transactions in orders modified within this date range. The maximum time range that may be specified is 30 days.
ModTimeTo	Datetime	False	Yes	Specifies the end of the date range for which to retrieve shipping details of the transactions in orders modified within this date range. The maximum time range that may be specified is 30 days.
NumberOfDays	Integer	False	Yes	All eBay shipping details of the transactions in orders that were either created or modified within this period are returned in the output. Min: 1. Max: 30.
OrderRole	String	False	Yes	Filters the returned shipping details of the transactions based on the role of the user. The user's role is either buyer or seller.
OrderStatus	String	False	Yes	Filters the returned shipping details of the transactions based on the status of the order. Applicable Values: Active, All, Completed, Inactive.

Return to Top