eBay Connector Objects

NameDescription
BiddersQuery eBay users that bid on a specified listing, regardless of whether the listing has ended.
CategoriesQuery eBay Categories.
CategoryFeaturesQuery the settings supported by eBay Categories.
CategorySubtreeRetrieve all nodes of the category tree hierarchy (the subtree) below a specified category in a specified category tree.
CategorySuggestionsReturn an array of suggested categories that eBay has determined correspond to keywords that describe an item.
CategoryTreeRetrieve the complete category tree corresponding to a specified category tree ID.
CompatibilityPropertiesRetrieve an array of parts compatibility aspects that are used to describe compatible vehicles.
CompatibilityPropertyValuesRetrieve an array of parts compatibility aspect values that are used to describe compatible vehicles.
CountriesLists the country code and associated name of the countries supported by the eBay system, regardless of the site specified in the request.
CurrenciesQuery the supported Currencies in eBay.
DefaultCategoryTreeIdRetrieve the default category tree reference for a specific eBay marketplace.
FulfillmentPoliciesRetrieves all the fulfillment policies configured for the marketplace you specify using the MarketplaceId query parameter.
HighestBidderQuery the Highest Bidder of the eBay users who bid on a specified listing, regardless of whether the listing has ended.
ItemAspectsForCategoryRetrieve an array of aspects that are appropriate for describing items in a specified category.
ItemCompatibilityListQuery compatability categories and possible compatability values for a specific item.
ItemListingUpdate, delete, and query Item Listings for sellers.
ItemShippingQuery 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.
ItemSpecificsQuery item specifics for a specific item.
ItemTransactionsQuery 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).
ItemVariationsItem 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.
OrderPaymentsQuery 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.
OrdersQuery 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.
OrderShippingQuery 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.
PaymentPoliciesRetrieves all the payment policies configured for the marketplace you specify using the MarketplaceId query parameter.
ReturnPoliciesRetrieves all the return policies configured for the marketplace you specify using the MarketplaceId query parameter.
ShippingCarriersQuery Shipping Carriers supported by the specified site.
ShippingCategoriesA shipping service category supported for the site.
ShippingLocationsLists 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.
ShippingServicesQuery Shipping Services supported by the specified eBay site.
SitesLists all available eBay sites and their associated SiteID numbers.
SuggestedCategories[DEPRECATED] Query eBay list of categories with the highest number of listings.
TasksRetrieves all the tasks for the marketplace you specify using the MarketplaceId query parameter.
TransactionLinkedItemsQuery 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.
TransactionPaymentsQuery 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.
TransactionRefundsQuery 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.
TransactionsQuery 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.
TransactionShippingQuery 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.
NameTypeReadOnlyReferencesFilterOnlyDescription
ActionStringFalseNoIndicates the type of offer being made on the specified listing.
MaxBidDecimalFalseNoAmount 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.
CurrencyStringFalseNoThe three-digit currency code for the Max Bid.
ConvertedPriceDecimalFalseNoThe price in the currency specified.
ConvertedPriceCurrencyStringFalseNoThe three-digit currency Id of the converted price.
HighestBidDecimalFalseNoAmount 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.
HighestBidCurrencyStringFalseNoThe three-digit currency code for the highest bid.
QuantityIntegerFalseNoSpecifies the number of items the user tendering the offer intends to purchase, bid on, or make a Best Offer on.
SecondChanceEnabledBooleanFalseNoIndicates whether user is willing to be the recipient of second chance offers.
SiteCurrencyStringFalseNoUnique Id identifying the currency in which the localized offer amounts are expressed.
TimeBidDatetimeFalseNoDate and time the offer or bid was placed.
UserIdStringFalseNoUnique eBay user Id for the user.
UserCountryStringFalseNoThe two-digit code representing the country of the user.
UserFeedbackScoreIntegerFalseNoThe 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.
ItemIdStringFalseNoThe Id of the item. The bidders who bid on this item are returned.
ListModeStringFalseYesSpecifies 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

NameTypeReadOnlyReferencesFilterOnlyDescription
CategoryId [KEY]StringFalseNoThis string value is the unique identifier of an eBay category.
AutoPayEnabledBooleanFalseNoSpecifies that the corresponding category supports immediate payment for listings.
B2BVATEnabledBooleanFalseNoSpecifies 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.
BestOfferEnabledBooleanFalseNoSpecifies that the corresponding category supports Best Offers.
CategoryLevelIntegerFalseNoThis 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.
CategoryNameStringFalseNoThis string value is the display name of the eBay primary category, as it would appear on the eBay website.
CategoryParentIdStringFalseNoThis string value is the category Id of the parent category of the primary category indicated in the CategoryId field.
ExpiredBooleanFalseNoSpecifies that the corresponding category is no longer a valid eBay category on the site, and items may not be listed in this category.
LeafCategoryBooleanFalseNoSpecifies that the corresponding category is an eBay leaf category, a category in which items may be listed.
LSDBooleanFalseNoLot 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.
ORPABooleanFalseNoOverride Reserve Price Allowed: Specifies that the corresponding category is an exception to the standard Reserve Price policy on auction listings for the eBay site.
ORRABooleanFalseNoOverride Reduce Reserve Allowed: Specifies that the corresponding category is an exception to the standard Reduce Reserve Price (on active auction listing) policy.
VirtualBooleanFalseNoSpecifies that the corresponding category is an eBay virtual category, a category in which items may not be listed.
CategorySiteIdStringFalseYesThe Id of the U.S. eBay site for the category.
LevelLimitStringFalseYesSpecifies 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.
ViewAllNodesStringFalseYesThis 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.
DetailLevelStringFalseYesDetail 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

NameTypeReadOnlyReferencesFilterOnlyDescription
CategoryIdStringFalseNoThe unique identifier of the category that the setting belongs to.
BestOfferAutoAcceptEnabledBooleanFalseNoIndicates whether the category supports the Best Offer Automatic Accept feature for fixed-price listings.
BestOfferAutoDeclineEnabledBooleanFalseNoIndicates whether the category supports the Best Offer Auto Decline feature.
BestOfferCounterEnabledBooleanFalseNoIndicates 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.
BestOfferEnabledBooleanFalseNoIndicates whether the category supports the Best Offer feature for fixed-price listings.
BrandMPNIdentifierEnabledBooleanFalseNoIndicates whether the category supports the capability to identify a product using the brand/manufacturer part number combination.
ConditionEnabledStringFalseNoIndicates whether the category supports (or requires) conditions to be specified.
ConditionValuesAggregateStringFalseNoThe valid condition Ids for this category.
EANEnabledStringFalseNoIndicates whether or not European Article Numbers (EANs) can be used to help create a listing.
FreeGalleryPlusEnabledBooleanFalseNoIndicates whether the category supports free, automatic upgrades for Gallery Plus, which enhances pictures in search results.
FreePicturePackEnabledBooleanFalseNoIndicates whether the category supports free, automatic upgrades for Picture Pack, a discount package that includes super-sizing of pictures.
GlobalShippingEnabledBooleanFalseNoSpecifies whether or not the corresponding category supports the Global Shipping Program (GSP).
Group1MaxFlatShippingCostDoubleFalseNoReturns the applicable max. cap per shipping cost for shipping service group 1.
Group2MaxFlatShippingCostDoubleFalseNoReturns the applicable max. cap per shipping cost for shipping service group 2.
Group3MaxFlatShippingCostDoubleFalseNoReturns the applicable max. cap per shipping cost for shipping service group 3.
HandlingTimeEnabledBooleanFalseNoIf 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.
HomePageFeaturedEnabledBooleanFalseNoIndicates 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.
INEscrowWorkflowTimelineStringFalseNoIndicates the escrow workflow version that applies to the category on the India site: Default Workflow, Workflow A, or Workflow B.
ISBNEnabledStringFalseNoIndicates whether or not International Standard Book Numbers (ISBNs) can be used to help create a listing.
ItemCompatibilityEnabledStringFalseNoIndicates whether the category supports parts compatibility by application (ByApplication), by specification (BySpecification), or not at all (Disabled).
ItemSpecificsEnabledStringFalseNoIndicates whether the category supports custom Item Specifics.
ListingDurationsStringFalseNoThe listing types and listing durations in days that are supported for the category.
MaxFlatShippingCostDoubleFalseNoThe 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.
MaxGranularFitmentCountIntegerFalseNoIndicates the maximum fitment count.
MaxItemCompatibilityIntegerFalseNoSpecifies the maximum number of parts compatibilities.
MinimumReservePriceDoubleFalseNoIndicates 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.
MinItemCompatibilityIntegerFalseNoThis field specifies the minimum number of parts compatibilities for listing items.
NonSubscriptionStringFalseNoThe value in this field indicates whether the category supports Motors Local Market listings if the seller does not have a vehicle subscription.
PaisaPayFullEscrowEnabledBooleanFalseNoIndicates whether the category supports the PaisaPayEscrow payment method. This feature is only applicable to the India site.
PaymentMethodsStringFalseNoIndicates the acceptable payment methods that can be used when adding, revising, or relisting an item in the corresponding category.
PaymentProfileCategoryGroupStringFalseNoIndicates 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.
PayPalBuyerProtectionEnabledBooleanFalseNoWhether then buyer protection is allowed for this category.
PayPalRequiredBooleanFalseNoIndicates whether the category requires PayPal as a payment method.
PickupDropOffEnabledBooleanFalseNoA 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.
PremiumSubscriptionStringFalseNoThe value in this field indicates whether the category supports Motors Local Market listings if the seller has a Premium vehicle subscription.
ProductCreationEnabledStringFalseNoIndicates 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.
ProPackEnabledBooleanFalseNoIndicates whether the category supports the Pro Pack Bundle listing upgrade.
ReturnPolicyEnabledBooleanFalseNoOnly returned when this value (or the setting of this category) overrides the value inherited from the parent of the category.
ReturnPolicyProfileCategoryGroupStringFalseNoIndicates 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.
RevisePriceAllowedBooleanFalseNoIndicates if the category allows the seller to revise the price of a fixed-price listing.
ReviseQuantityAllowedBooleanFalseNoIndicates if the category allows the seller to revise the quantity of a multiquantity, active listing.
SafePaymentRequiredBooleanFalseNoIndicates whether listings in this category need to have a safe payment method.
SellerContactDetailsEnabledBooleanFalseNoIndicates whether this category supports seller-level contact information for Classified Ad listings.
SellerProvidedTitleSupportedBooleanFalseNoThis boolean field indicates whether a category supports Seller Provided Titles in listings.
ShippingProfileCategoryGroupStringFalseNoIndicates 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.
ShippingTermsRequiredBooleanFalseNoIndicates whether the category requires sellers to specify shipping details at listing time.
SpecialitySubscriptionStringFalseNoThe value in this field indicates whether the category supports Motors Local Market listings if the seller has a Specialty vehicle subscription.
ListingDurationsAggregateStringFalseNoProvides 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.
TransactionConfirmationRequestEnabledBooleanFalseNoDefines if transaction confirmation requests are enabled in a given category.
UPCEnabledStringFalseNoIndicates whether or not Universal Product Codes (UPCs) can be used to help create a listing.
UserConsentRequiredBooleanFalseNoIndicates 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.
ValueCategoryBooleanFalseNoSome 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.
ValuePackEnabledBooleanFalseNoIndicates whether the category supports the Value Pack bundle listing upgrade.
VariationsEnabledBooleanFalseNoIf true, you can create multiple-variation listings when you list a fixed-price item in this category.
VINSupportedBooleanFalseNoIndicates 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.
VRMSupportedBooleanFalseNoIndicates 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.
AllFeaturesForCategoryStringFalseYesUse 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.
FeatureIdStringFalseYesUse 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.
LevelLimitStringFalseYesA 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.
ViewAllNodesStringFalseYesIf 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.
DetailLevelStringFalseYesDetail 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

NameTypeReadOnlyReferencesFilterOnlyDescription
CategoryTreeId [KEY]StringFalseDefaultCategoryTreeId.CategoryTreeIdNoThe unique identifier of the eBay category tree to which this subtree belongs.
categoryTreeVersionStringFalseNoThe version of the category tree identified by categoryTreeId.
categorySubtreeNodeStringFalseNoContains details of all nodes of the category subtree hierarchy below a specified node. This is a recursive structure.
categoryStringFalseNoContains details about the current category tree node.
categoryNameStringFalseNoThe name of the category identified by categoryId.
categoryTreeNodeLevelIntegerFalseNoThe absolute level of the current category tree node in the hierarchy of its category tree.
childCategoryTreeNodesStringFalseNoAn 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.
categoryStringFalseNoContains details about the current category tree node.
categoryNameStringFalseNoThe name of the category identified by categoryId.
categoryTreeNodeLevelIntegerFalseNoThe absolute level of the current category tree node in the hierarchy of its category tree.
childCategoryTreeNodesStringFalseNoAn 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.
categoryStringFalseNoContains details about the current category tree node.
categoryNameStringFalseNoThe name of the category identified by categoryId.
categoryTreeNodeLevelIntegerFalseNoThe absolute level of the current category tree node in the hierarchy of its category tree.
childCategoryTreeNodesStringFalseNoAn 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.
leafCategoryTreeNodeBooleanFalseNoA 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.
parentCategoryTreeNodeHrefStringFalseNoThe href portion of the getCategorySubtree call that retrieves the subtree below the parent of this category tree node.
leafCategoryTreeNodeBooleanFalseNoA 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.
parentCategoryTreeNodeHrefStringFalseNoThe href portion of the getCategorySubtree call that retrieves the subtree below the parent of this category tree node.
leafCategoryTreeNodeBooleanFalseNoA 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.
parentCategoryTreeNodeHrefStringFalseNoThe href portion of the getCategorySubtree call that retrieves the subtree below the parent of this category tree node.
CategoryIdStringFalseNoThe unique identifier of the category at the top of the subtree being requested.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
CategoryTreeId [KEY]StringFalseDefaultCategoryTreeId.CategoryTreeIdNoThe unique identifier of the eBay category tree from which suggestions are returned.
categoryTreeVersionStringFalseNoThe version of the category tree identified by categoryTreeId.
categorySuggestionsStringFalseNoContains details about one or more suggested categories that correspond to the provided keywords.
categoryStringFalseNoContains details about the suggested category.
categoryIdStringFalseNoThe unique identifier of the eBay category within its category tree.
categoryNameStringFalseNoThe name of the category identified by categoryId.
categoryTreeNodeAncestorsStringFalseNoAn ordered list of category references that describes the location of the suggested category in the specified category tree.
categoryIdStringFalseNoThe unique identifier of the eBay ancestor category.
categoryNameStringFalseNoThe name of the ancestor category identified by categoryId.
categorySubtreeNodeHrefStringFalseNoThe href portion of the getCategorySubtree call that retrieves the subtree below the ancestor category node.
categoryTreeNodeLevelStringFalseNoThe absolute level of the ancestor category node in the hierarchy of its category tree.
categoryTreeNodeLevelIntegerFalseNoThe absolute level of the category tree node in the hierarchy of its category tree.
relevancyStringFalseNoThis field is reserved for internal or future use.
QStringFalseYesA quoted string that describes or characterizes the item being offered for sale.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
CategoryTreeId [KEY]StringFalseDefaultCategoryTreeId.CategoryTreeIdNoThe unique identifier of the eBay category tree for the specified marketplace.
categoryTreeVersionStringFalseNoThe version of the category tree identified by categoryTreeId.
applicableMarketplaceIdsStringFalseNoA list of one or more identifiers of the eBay marketplaces that use this category tree.
rootCategoryNodeStringFalseNoContains details of all nodes of the category tree hierarchy, starting with the root node and down to the leaf nodes.
categoryStringFalseNoContains details about the current category tree node.
categoryIdStringFalseNoThe unique identifier of the eBay category within its category tree.
categoryNameStringFalseNoThe name of the category identified by categoryId.
categoryTreeNodeLevelIntegerFalseNoThe absolute level of the current category tree node in the hierarchy of its category tree.
childCategoryTreeNodesStringFalseNoAn 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.
categoryStringFalseNoContains details about the current category tree node.
categoryIdStringFalseNoThe unique identifier of the eBay category within its category tree.
categoryNameStringFalseNoThe name of the category identified by categoryId.
categoryTreeNodeLevelIntegerFalseNoThe absolute level of the current category tree node in the hierarchy of its category tree.
childCategoryTreeNodesStringFalseNoAn 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.
categoryStringFalseNoContains details about the current category tree node.
categoryIdStringFalseNoThe unique identifier of the eBay category within its category tree.
categoryNameStringFalseNoThe name of the category identified by categoryId.
categoryTreeNodeLevelIntegerFalseNoThe absolute level of the current category tree node in the hierarchy of its category tree.
childCategoryTreeNodesStringFalseNoAn 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.
leafCategoryTreeNodeBooleanFalseNoA 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.
parentCategoryTreeNodeHrefStringFalseNoThe href portion of the getCategorySubtree call that retrieves the subtree below the parent of this category tree node.
leafCategoryTreeNodeBooleanFalseNoA 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.
parentCategoryTreeNodeHrefStringFalseNoThe href portion of the getCategorySubtree call that retrieves the subtree below the parent of this category tree node.
leafCategoryTreeNodeBooleanFalseNoA 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.
parentCategoryTreeNodeHrefStringFalseNoThe href portion of the getCategorySubtree call that retrieves the subtree below the parent of this category tree node.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
CategoryTreeId [KEY]StringFalseDefaultCategoryTreeId.CategoryTreeIdNoThis is the unique identifier of category tree.
CategoryIdStringFalseNoThe unique identifier of an eBay category.
CompatibilityPropertyNameStringFalseNoThis is the actual name of the compatible vehicle property as it is known on the specified eBay marketplace and in the eBay category.
CompatibilityPropertyLocalizedNameStringFalseNoThis is the localized name of the compatible vehicle property.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
CategoryTreeId [KEY]StringFalseDefaultCategoryTreeId.CategoryTreeIdNoThis is the unique identifier of category tree.
CompatibilityProperty [KEY]StringFalseNoThis 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]StringFalseNoThe unique identifier of an eBay category.
CompatibilityPropertyValuesStringFalseNoEach value field shows one applicable compatible vehicle property value.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
CountryStringFalseNoTwo-letter code representing a country. These two-letter codes are typically used in Add/Revise/Relist calls when referring to a country.
DescriptionStringFalseNoFull country name for display purposes. May be similar to (but not necessarily identical to) CountryName in addresses (e.g., User.RegistrationAddress.CountryName in GetUser).
DetailVersionStringFalseNoReturns the latest version number for this field. The version can be used to determine if and when to refresh cached client data.
UpdateTimeDatetimeFalseNoGives 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.
DetailNameStringFalseYesA designation of what kind of information you wish returned for the specified eBay site.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
CurrencyStringFalseNoThe three-digit currency code as defined in ISO 4217.
DescriptionStringFalseNoFull currency name for display purposes.
DetailVersionStringFalseNoReturns the latest version number for this field.
UpdateTimeDatetimeFalseNoGives the time in GMT that the feature fields for the details were last updated.
DetailNameStringFalseYesIf set to a value of CurrencyDetails, additional currency details are returned.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
CategoryTreeId [KEY]StringFalseNoThe unique identifier of the eBay category tree for the specified marketplace.
CategoryTreeVersionStringFalseNoThe version of the category tree identified by categoryTreeId.
MarketplaceIdStringFalseYesThe ID of the eBay marketplace for which the category tree ID is being requested.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
FulfillmentPolicyId [KEY]StringFalseNoA unique eBay-assigned ID for the fulfillment policy. This ID is generated when the policy is created.
NameStringFalseNoA user-defined name for this fulfillment policy. Names must be unique for policies assigned to the same marketplace.
DescriptionStringFalseNoAn optional seller-defined description of the fulfillment policy for internal use (this value is not displayed to end users).
CategoryTypesAggrStringFalseNoThe 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.)
MarketplaceIdStringFalseNoThe ID of the eBay marketplace to which this fulfillment policy applies.
FreightShippingBooleanFalseNoIf set to true, the seller offers freight shipping. Freight shipping can be used for large items over 150 lbs.
GlobalShippingBooleanFalseNoIndicates if the seller has opted-in to the eBay Global Shipping Program and that they use that service for their international shipments.
HandlingTimeValueIntegerFalseNoThe maximum number of business days the seller commits to for preparing and shipping an order after receiving a cleared payment for the order.
HandlingTimeUnitStringFalseNoA time-measurement unit that specifies a singular period of time used for HandlingTimeValue.
LocalPickupBooleanFalseNoIdentifies if the shipping is offered by this policy and the seller offers only local pickup of the item (normally from a non-business location).
PickupDropOffBooleanFalseNoIf set to true, the seller offers the
ShipToLocationsAggrStringFalseNoThis 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.
ShippingOptionsAggrStringFalseNoA list that defines the seller's shipping configurations for DOMESTIC and INTERNATIONAL order shipments.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
ItemIdStringFalseNoThe Id of the item. The bidders who bid on this item are returned.
HighBidderStringFalseNoeBay user Id for the user with the highest bid (or the earliest timestamp, in the event of a tie); a second chance offer candidate.
HighestBidDecimalFalseNoBid amount offered by the highest bidder.
CurrencyStringFalseNoCurrency code of the bid.
ListingStatusStringFalseNoSpecifies 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.
ListModeStringFalseYesSpecifies 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

NameTypeReadOnlyReferencesFilterOnlyDescription
CategoryTreeId [KEY]StringFalseDefaultCategoryTreeId.CategoryTreeIdNoThe unique identifier of the eBay category tree from which the specified category's aspects are being requested.
aspectsStringFalseNoA list of item aspects (for example, color) that are appropriate or necessary for accurately describing items in a particular leaf category.
aspectConstraintStringFalseNoInformation about the formatting, occurrence, and support of this aspect.
aspectApplicableToStringFalseNoThis value indicate if the aspect identified by the aspects.localizedAspectName field is a product aspect or an item/instance aspect.
aspectDataTypeStringFalseNoThe data type of this aspect.
aspectEnabledForVariationsBooleanFalseNoA value of true indicates that this aspect can be used to help identify item variations.
aspectFormatStringFalseNoReturned only if the value of aspectDataType identifies a data type that requires specific formatting.
aspectMaxLengthIntegerFalseNoThe maximum length of the item/instance aspect's value.
aspectModeStringFalseNoThe manner in which values of this aspect must be specified by the seller (as free text or by selecting from available options).
aspectRequiredBooleanFalseNoA value of true indicates that this aspect is required when offering items in the specified category.
aspectUsageStringFalseNoThe enumeration value returned in this field will indicate if the corresponding aspect is recommended or optional.
expectedRequiredByDateStringFalseNoThe expected date after which the aspect will be required.
itemToAspectCardinalityStringFalseNoIndicates whether this aspect can accept single or multiple values for items in the specified category.
aspectValuesStringFalseNoA list of valid values for this aspect (for example: Red, Green, and Blue), along with any constraints on those values.
localizedValueStringFalseNoThe localized value of this aspect.
valueConstraintsStringFalseNoNot returned if the value of the localizedValue field can always be selected for this aspect of the specified category.
applicableForLocalizedAspectNameStringFalseNoThe name of the control aspect on which the current aspect value depends.
applicableForLocalizedAspectValuesStringFalseNoContains a list of the values of the control aspect on which this aspect's value depends.
localizedAspectNameStringFalseNoThe localized name of this aspect (for example: Colour on the eBay UK site).
relevanceIndicatorStringFalseNoThe 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.
searchCountIntegerFalseNoThe number of recent searches (based on 30 days of data) for the aspect.
CategoryIdStringFalseNoThe unique identifier of an eBay category.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
ItemId [KEY]StringFalseNoThe 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.
CompatibilityAttributesStringFalseNoA list of all potential compatability catagories for the specified item.
PossibleCompatibilitiesStringFalseNoA list of all possible compatability values for the specified item.
IncludeItemCompatibilityListStringFalseYesThis is used to include ItemCompatibilityList items and should not be set manually.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
ItemId [KEY]StringFalseNoThe 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.
TitleStringFalseNoName of the item as it appears in the listing or search results.
AutoPayBooleanFalseNoIf true, the seller requests immediate payment for the item.
BuyerProtectionStringFalseNoFlag to indicate the eligibility of an item for the PayPal Buyer Protection program.
BuyItNowPriceDecimalFalseNoThis 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.
ConditionDescriptionStringFalseNoThis string field is used by the seller to more clearly describe the condition of items that are not brand new.
CountryStringFalseNoDefines the 2-letter ISO 3166 country code.
CurrencyStringFalseNoCurrency associated with the price information of the item. 3-letter ISO 4217 currency code.
DescriptionStringFalseNoThe 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.
HideFromSearchBooleanFalseNoWhether the listing is hidden from all searches occurring on eBay.
HitCountIntegerFalseNoThe number of page views for the item.
AdultBooleanFalseNoIf true, the item is listed in a Mature category.
BestOfferAutoAcceptPriceDecimalFalseNoThe price at which Best Offers are automatically accepted. Similar in use to MinimumBestOfferPrice.
CheckoutEnabledBooleanFalseNoThis flag indicates whether or not the Checkout Enabled preference of the seller is turned on (at account level or at listing level).
StartTimeDatetimeFalseNoThe StartTime for when the item was listed.
EndTimeDatetimeFalseNoTime 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.
MinimumBestOfferPriceDecimalFalseNoSpecifies 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.
ViewItemURLStringFalseNoThe URL of the Web page where a user can view the listing. On the U.S. site, this is called the View Item page.
ViewItemURLForNaturalSearchStringFalseNoThis 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.
ListingDurationStringFalseNoDescribes the number of days the seller wants the listing to be active (available for bidding/buying).
ListingTypeStringFalseNoThe format of the listing the seller wants to use, such as Chinese auction or fixed price.
LocationStringFalseNoIndicates 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.
CategoryIdStringFalseNoCategory Id for the first (or only) category in which the item is listed (or will be listed, if the item is new).
CategoryNameStringFalseNoThis string value is the display name of the eBay primary category, as it would appear on the eBay website.
PrivateListingBooleanFalseNoIf true, designates the listing as private.
QuantityIntegerFalseNoThe meaning of this value depends on the context.
QuantityAvailableHintStringFalseNoIndicates the type of message that will be returned describing the quantity available for the item.
QuantityThresholdIntegerFalseNoThe quantity threshold above which the seller prefers not to show the actual quantity available.
ReservePriceDecimalFalseNoThe lowest price at which the seller is willing to sell the item.
RefundStringFalseNoDisplay string that buyer applications can use to present RefundOption in a more user-friendly format to buyers.
RefundOptionStringFalseNoIndicates how the seller will compensate the buyer for a returned item.
ReturnsAcceptedStringFalseNoDisplay string that buyer applications can use to present ReturnsAcceptedOption in a more user-friendly format to buyers.
ReturnsAcceptedOptionStringFalseNoIndicates 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.
ReturnsWithinStringFalseNoDisplay string that buyer applications can use to present ReturnsWithinOption in a more user-friendly format to buyers.
ReturnsWithinOptionStringFalseNoThe buyer can return the item within this period of time from the day they receive the item.
ShippingCostPaidByStringFalseNoDisplay string that buyer applications can use to present ShippingCostPaidByOption in a more user-friendly format to buyers.
ShippingCostPaidByOptionStringFalseNoThe party who pays the shipping cost for a returned item.
ItemRevisedBooleanFalseNoThis field is returned as true if the original listing has been revised.
SellerNameStringFalseNoThe name of the seller. This field is used as part of the address.
CurrentPriceDecimalFalseNoThe current price of the item in the original listing currency.
ListingStatusStringFalseNoSpecifies an active or ended listing status in the processing workflow.
PromotionalEndTimeDatetimeFalseNoEnd time of a discount for an item whose price a seller has reduced with the Promotional Price Display feature.
PromotionalOriginalPriceDecimalFalseNoOriginal price of an item whose price a seller has reduced with the Promotional Price Display feature.
PromotionalStartTimeDatetimeFalseNoStart time of a discount for an item whose price a seller has reduced with the Promotional Price Display feature.
QuantitySoldIntegerFalseNoThe total number of items purchased so far in the lifetime of the listing. Subtract this from Quantity to determine the quantity available.
ReserveMetBooleanFalseNoIndicates whether the reserve price has been met for the listing. Returns true if the reserve price was met or no reserve price was specified.
SecondChanceEligibleBooleanFalseNoPart of the Second Chance Offer feature, which indicates whether the seller can extend a second chance offer for the item.
SiteStringFalseNoThe name of the site on which the item is listed.
SKUStringFalseNoA SKU (stock keeping unit) is an identifier defined by a seller.
StartPriceDecimalFalseNoThe 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.
TimeLeftStringFalseNoTime left before the listing ends. The duration is represented in the ISO 8601 duration format (PnYnMnDTnHnMnS).
TotalQuestionCountIntegerFalseNoThe number of questions asked about this item. Applies to eBay Motors Pro applications only.
WatchCountIntegerFalseNoThe number of watches placed on this item from the My eBay accounts of the buyers.
StoreCategoryIdLongFalseNoUnique identifier of a primary custom category in which to list the item.
StoreCategoryId2LongFalseNoUnique identifier for the secondary custom category in which to list the item.
AdminEndedItemsOnlyStringFalseYesSpecifies whether to return only items that were administratively ended based on a policy violation.
EndTimeFromDatetimeFalseYesSpecifies 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.
EndTimeToDatetimeFalseYesSpecifies 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.
GranularityLevelStringFalseYesSpecifies the subset of item and user fields to return.
StartTimeFromDatetimeFalseYesSpecifies the earliest (oldest) date to use in a date range filter based on item start time.
StartTimeToDatetimeFalseYesSpecifies the latest (most recent) date to use in a date range filter based on item start time. Must be specified if StartTimeFrom is specified.
UserIdStringFalseYesSpecifies 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.
DetailLevelStringFalseYesDetail levels are instructions that define standard subsets of data to return for particular tables.
EndingReasonStringFalseYesIndicates the reason the seller ended the listing early.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
ItemIdStringFalseNoThe item Id that uniquely identifies the item listing for which to retrieve the data. Required input.
DestinationCountryCodeStringFalseNoDestination country code. If DestinationCountryCode is US, a postal code is required and it represents the U.S. ZIP code. Default: US.
ExpeditedServiceBooleanFalseNoIndicates whether the service is an expedited shipping service.
FreeShippingBooleanFalseNoSpecifies 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.
ImportChargeDecimalFalseNoThe 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.
CurrencyStringFalseNoCurrency Id
ShippingServiceStringFalseNoA 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.
ShippingInsuranceCostDecimalFalseNoThe insurance cost associated with shipping a single item with this shipping service.
ShippingServiceAdditionalCostDecimalFalseNoA 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.
ShippingServiceCostDecimalFalseNoThe 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.
ShippingServicePriorityIntegerFalseNoControls the order (relative to other shipping services) in which the corresponding ShippingService will appear in the View Item and Checkout page.
ShippingTimeMaxIntegerFalseNoThe 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).
ShippingTimeMinIntegerFalseNoThe 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).
QuantitySoldStringFalseYesNumber of items sold to a single buyer and to be shipped together.
DestinationPostalCodeStringFalseYesDestination 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

NameTypeReadOnlyReferencesFilterOnlyDescription
ItemIdStringFalseNoThe 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.
AttributeStringFalseNoThe name of the attribute for the specified item.
SpecificsStringFalseNoComma separated list of values for the specified item attribute.
SourceStringFalseNoEnumerated 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.
IncludeItemSpecificsStringFalseYesThis is used to include ItemSpecifics items and should not be set manually.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
OrderLineItemId [KEY]StringFalseNoA 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.
TransactionIdStringFalseNoThe unique identifier for a transaction that was made for a specific item. If a TransactionId is provided, any specified time filter is ignored.
ItemIdStringFalseNoUnique identifier for an eBay item listing.
HandlingCostDecimalFalseNoThe 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.
ShippingCostDecimalFalseNoThe shipping cost paid by the buyer for the order line item. This field is only returned after checkout is complete.
AdjustmentAmountDecimalFalseNoAdjustment 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.
AmountPaidDecimalFalseNoThe total amount the buyer paid for the order line item.
CurrencyStringFalseNoA standard 3-digit ISO 4217 currency code for currency used in countries around the world.
BestOfferSaleBooleanFalseNoIndicates whether or not the order line item was created as the result of the seller accepting a Best Offer from a buyer.
BuyerIdStringFalseNoUnique eBay user Id for the user.
BuyerCheckoutMessageStringFalseNoThis field is returned if a buyer left a comment for the seller during the checkout flow.
CreatedDateDatetimeFalseNoIndicates the creation time of the order line item.
DepositTypeStringFalseNoThis 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.
EBayPlusTransactionBooleanFalseNoIf true, this transaction is for an item that was purchased under the eBay Plus program.
ExtendedOrderIdStringFalseNoA unique identifier for an eBay order.
FinalValueFeeDecimalFalseNoA Final Value Fee is calculated and charged to the account of a seller immediately upon creation of an order line item.
GiftBooleanFalseNoThis 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.
GiftSummaryMessageStringFalseNoThis free-form text contains the message that the purchaser of the digital gift card left for the recipient of the gift card.
IntangibleItemBooleanFalseNoThis 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.
InvoiceSentTimeDatetimeFalseNoThis 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.
IsMultiLegShippingBooleanFalseNoIf IsMultilegShipping is true, the Global Shipping Program (GSP) will be used to ship the order line item to an international buyer.
LogisticsPlanTypeStringFalseNoThis 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.
PaidTimeDatetimeFalseNoIndicates 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.
QuantityPurchasedIntegerFalseNoThis value indicates the number of identical items purchased at the same time by the same buyer from one listing.
ShippedTimeDatetimeFalseNoIndicates 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.
ShippingConvenienceChargeDecimalFalseNoThe amount that the seller is being charged for the convenience of an eBay Now delivery.
ExpeditedServiceBooleanFalseNoIndicates whether the service is an expedited shipping service.
ShippingServiceImportChargeDecimalFalseNoThe 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.
ShippingInsuranceCostDecimalFalseNoThe insurance cost associated with shipping a single item with this shipping service.
ShippingPackageInfoStringFalseNoIf 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.
ShippingServiceStringFalseNoA shipping service option being offered by the seller to ship an item to a buyer.
ShippingServiceAdditionalCostDecimalFalseNoThe cost of shipping each additional item if the same buyer purchases one or more of the same line item.
ShippingServiceCostDecimalFalseNoThe 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.
ShippingServicePriorityIntegerFalseNoThis integer value controls the order (relative to other shipping services) in which the corresponding ShippingService will appear in the View Item and Checkout page.
ShippingTimeMaxIntegerFalseNoThe 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).
ShippingTimeMinIntegerFalseNoThe 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).
BuyerSelectedShippingBooleanFalseNoIndicates whether the buyer has selected shipping details during checkout.
CheckoutStatusStringFalseNoIndicates the current status of the checkout flow for the order.
CompleteStatusStringFalseNoIndicates whether checkout is complete, incomplete, or pending for an order.
DigitalStatusStringFalseNoThe current state of a purchased digital gift card.
EBayPaymentStatusStringFalseNoIndicates the success or failure of the online payment for an order by the buyer.
InquiryStatusStringFalseNoThis 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.
LastTimeModifiedDatetimeFalseNoIndicates date and time the status of an order was last updated (in GMT).
PaymentHoldStatusStringFalseNoThis field indicates the type and/or status of a payment hold on the item.
PaymentInstrumentStringFalseNoThe 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.
PaymentMethodUsedStringFalseNoThe 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.
ReturnStatusStringFalseNoThis 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.
TransactionPriceDecimalFalseNoThe price of the order line item (transaction).
ModTimeFromStringFalseYesThe 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.
ModTimeToStringFalseYesThe 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.
NumberOfDaysStringFalseYesThis time filter specifies the number of days (24-hour periods) in the past to search for order line items.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
ItemId [KEY]StringFalseNoThe 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]StringFalseNoA 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.
StartPriceDecimalFalseNoThe price of the item at listing or relisting time. If this value changes when the item is revised, the new value becomes this price.
CurrencyStringFalseNoCurrency associated with the price information of the item. 3-letter ISO 4217 currency code.
QuantityIntegerFalseNoThis value indicates the quantity of items in the specific variation that are available for purchase.
QuantitySoldIntegerFalseNoThe total number of items purchased so far. Subtract this from Quantity to determine the quantity available.
SKUStringFalseNoA SKU (stock keeping unit) is an identifier defined by a seller. It is only intended for the use of the seller (not for buyers).
EANStringFalseNoThis field is used if the seller wishes to identify each product variation within a multivariation listing by an EAN (European Article Number) value.
ISBNStringFalseNoThis field is used if the seller wishes to identify each product variation within a multivariation listing by an ISBN (International Standard Book Number) value.
UPCStringFalseNoThis field is used if the seller wishes to identify each product variation within a multivariation listing by a UPC (Universal Product Code) value.
ListingStatusStringFalseNoSpecifies a listing with an active or ended status in the eBay processing workflow.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
ItemId [KEY]StringFalseNoThe Id that uniquely identifies the item listing. The Id is generated by eBay after an item is listed.
TitleStringFalseNoName of the item as it appears in the listing or search results.
SubtitleStringFalseNoSubtitle of the item. Only returned if the seller included a subtitle for the listing.
WatchCountIntegerFalseNoThe number of watches placed on this item from the My eBay accounts of the buyers.
BidCountIntegerFalseNoThe number of bids that have been placed on the item.
BuyItNowPriceDecimalFalseNoThe Buy It Now Price of the item (if any), in the currency of the site on which the item was listed.
CurrencyStringFalseNoThe 3-digit ISO 4217 currency codes for the currency used by the site.
OriginalRetailPriceDecimalFalseNoThe actual retail price set by the manufacturer (OEM).
PricingTreatmentStringFalseNoUsing OriginalRetailPrice, MinimumAdvertisedPrice, and StartPrice values, eBay identifies whether the listing falls under MAP or STP (aka OriginalRetailPrice).
SoldOffEbayBooleanFalseNoUsed 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.
SoldOnEbayBooleanFalseNoUsed 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.
GlobalIdStringFalseNoThe site upon which the item is listed. Returns a Global Id, which is a unique identifier for combinations of site, language, and territory.
ImageURLStringFalseNoURL 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.
OriginalPriceDecimalFalseNoOriginal price of an item whose price a seller has reduced with the Promotional Price Display feature. Only returned if the price has been revised.
PrimaryCategoryIdStringFalseNoNumeric Id of the first (or only) category in which the item is listed. (Listings can appear in more than one category.)
PrimaryCategoryNameStringFalseNoDisplay name of the first (or only) category in which the item is listed. This is a fully qualified category breadcrumb (e.g., Computers & Networking, Notebooks).
ShippingCostDecimalFalseNoThe shipping cost associated with the first shipping service. Only returned when ShippingType is flat.
ShippingTypeStringFalseNoThe shipping cost model offered by the seller.
TimeLeftStringFalseNoTime 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).
ViewItemURLStringFalseNoThe 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).
CategoryIdStringFalseYesSpecifies the category from which to retrieve item listings.
AffiliateCustomIdStringFalseYesNeed 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.
AffiliateNetworkIdStringFalseYesSpecifies your tracking partner for affiliate commissions.
AffiliateTrackingIdStringFalseYesThe value you specify is obtained from your tracking partner.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
PaymentId [KEY]StringFalseNoA unique transaction ID for the payment.
OrderIdStringFalseNoA unique identifier for an eBay order.
FeeOrCreditAmountDecimalFalseNoFee Amount is a positive value and Credit Amount is a negative value.
PayeeStringFalseNoThe person or organization who is to receive the payment allocation.
PayerStringFalseNoThis field indicates the eBay user or eBay partner who submitted the payment.
PaymentAmountDecimalFalseNoThe amount of the payment that is allocated to the payee.
PaymentStatusStringFalseNoThe current status of a buyer payment that is allocated to a specified payee.
PaymentTimeDatetimeFalseNoThe date and time when the payment is received by the payee.
CreateTimeFromDatetimeFalseYesSpecifies the start of the date range for which to retrieve payment details of the orders created within this date range.
CreateTimeToDatetimeFalseYesSpecifies the end of the date range for which to retrieve payment details of the orders created within this date range.
ModTimeFromDatetimeFalseYesSpecifies 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.
ModTimeToDatetimeFalseYesSpecifies 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.
NumberOfDaysIntegerFalseYesAll eBay payment details of the orders that were either created or modified within this period are returned in the output. Min: 1. Max: 30.
OrderRoleStringFalseYesFilters the returned payment details of the orders based on the role of the user. The user's role is either buyer or seller.
OrderStatusStringFalseYesFilters the returned payment details of the orders based on the status of the order. Applicable Values: Active, All, Completed, Inactive.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
OrderId [KEY]StringFalseNoA unique identifier for an eBay order.
ExtendedOrderIdStringFalseNoThe unique identifier of the order in legacy format, as traditionally used by the Trading API.
BuyerUserIdStringFalseNoeBay user ID of the order's buyer.
SellerUserIdStringFalseNoThis is the eBay user ID of the order's seller.
OrderStatusStringFalseNoThis enumeration value indicates the current status of the order. Applicable Values: Active, All, Cancelled, Completed, Inactive.
AdjustmentAmountDecimalFalseNoThis value indicates the dollar amount by which the buyer has adjusted the order total.
AmountPaidDecimalFalseNoThis value indicates the total amount of the order.
AmountSavedDecimalFalseNoThis value indicates the shipping discount experienced by the buyer as a result of creating a Combined Invoice order.
CreatedTimeDatetimeFalseNoTimestamp that indicates the date and time that the order was created.
ShippedTimeDatetimeFalseNoTimestamp indicating the date and time of order shipment. This field is not returned until the order has been marked as shipped.
PaymentMethodStringFalseNoThe payment method that the buyer selected to pay for the order.
PaymentStatusStringFalseNoThis value indicates the payment status of an order.
CheckoutStatusStringFalseNoContainer consisting of details related to the current checkout status of the order.
SellerEmailStringFalseNoThe 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.
SubTotalDecimalFalseNoThe 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.
TotalDecimalFalseNoThe Total amount equals the Subtotal value plus the shipping/handling, shipping insurance, and sales tax costs.
CancelCompleteDateDatetimeFalseNoTimestamp indicating when the cancellation process of an eBay order has been completed.
CancelInitiationDateDatetimeFalseNoThis timestamp indicates when the cancellation of the eBay order was initiated.
CancelInitiatorStringFalseNoThis value indicates which party initiated the cancellation of the eBay order.
CancelReasonStringFalseNoThis value indicates the reason why the order cancellation was initiated.
CancelStatusStringFalseNoThe current status for the order cancellation request if it exists.
CreateTimeFromDatetimeFalseYesSpecifies the start of the date range for which to retrieve orders created within this date range.
CreateTimeToDatetimeFalseYesSpecifies the end of the date range for which to retrieve orders created within this date range.
ModTimeFromDatetimeFalseYesSpecifies 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.
ModTimeToDatetimeFalseYesSpecifies 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.
NumberOfDaysIntegerFalseYesAll eBay orders that were either created or modified within this period are returned in the output. Min: 1. Max: 30.
OrderRoleStringFalseYesFilters the returned orders based on the role of the user. The user's role is either buyer or seller.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
OrderId [KEY]StringFalseNoThe 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.
AddressIdStringFalseNoUnique ID for a user's address in the eBay database.
CityNameStringFalseNoThe name of the user's city.
CountryStringFalseNoThe two-digit code representing the country of the user.
CountryNameStringFalseNoThe name of the user's country.
AddressNameStringFalseNoUser's name for the address.
PhoneStringFalseNoUser's primary phone number.
PostalCodeStringFalseNoUser's postal code.
StateOrProvinceStringFalseNoThe state or province of the user's address. Whether it's a state or a province will depend on the region and/or country.
Street1StringFalseNoThe first line of the user's street address.
Street2StringFalseNoThe second line of the user's street address (such as an apartment number or suite number).
ShippingChargeDecimalFalseNoThe 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.
ExpeditedServiceBooleanFalseNoIndicates whether the service is an expedited shipping service.
ShippingImportChargeDecimalFalseNoThe total cost of customs and taxes for the international leg of an order shipped using the Global Shipping Program.
ShippingInsuranceCostDecimalFalseNoThe insurance cost associated with shipping a single item with this shipping service.
ShippingServiceAdditionalCostDecimalFalseNoThe cost of shipping each additional item if the same buyer purchases multiple quantity of the same line item.
ShippingServiceCostDecimalFalseNoThe base cost of shipping the item using the shipping service specified in the ShippingService field.
ActualDeliveryTimeDatetimeFalseNoThis timestamp indicates when the order was actually delivered to the buyer.
EstimatedDeliveryTimeMaxDatetimeFalseNoThe EstimatedDeliveryTimeMin and EstimatedDeliveryTimeMax timestamps indicate the window during which the buyer can expect delivery.
EstimatedDeliveryTimeMinDatetimeFalseNoThe EstimatedDeliveryTimeMin and EstimatedDeliveryTimeMax timestamps indicate the window during which the buyer can expect delivery.
HandleByTimeDatetimeFalseNoThis 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.
ScheduledDeliveryTimeMaxDatetimeFalseNoThe ScheduledDeliveryTimeMin and ScheduledDeliveryTimeMax timestamps indicate the delivery window for which the buyer can expect to receive the order.
ScheduledDeliveryTimeMinDatetimeFalseNoThe ScheduledDeliveryTimeMin and ScheduledDeliveryTimeMax timestamps indicate the delivery window for which the buyer can expect to receive the order.
ShippingTrackingEventStringFalseNoThis enumeration value indicates whether or not the order has been picked up from the store indicated by the StoreID value.
StoreIdStringFalseNoThe unique identifier of the store from where the order will be delivered.
SalesTaxAmountDecimalFalseNoThe amount of sales tax, calculated for an order based on the SalesTaxPercent and pricing information.
SalesTaxPercentFloatFalseNoPercent of an item's price to be charged as the sales tax for the order.
SalesTaxStateStringFalseNoState or jurisdiction for which the sales tax is being collected. Only returned if the seller specified a value.
ShipmentTrackingNumbersStringFalseNoThe tracking numbers assigned by the shipping carriers.
ShippingCarriersStringFalseNoThe name of the shipping carriers used to ship the items.
CreateTimeFromDatetimeFalseYesSpecifies the start of the date range for which to retrieve shipping details of the orders created within this date range.
CreateTimeToDatetimeFalseYesSpecifies the end of the date range for which to retrieve shipping details of the orders created within this date range.
ModTimeFromDatetimeFalseYesSpecifies 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.
ModTimeToDatetimeFalseYesSpecifies 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.
NumberOfDaysIntegerFalseYesAll eBay shipping details of the orders that were either created or modified within this period are returned in the output. Min: 1. Max: 30.
OrderRoleStringFalseYesFilters the returned shipping details of the orders based on the role of the user. The user's role is either buyer or seller.
OrderStatusStringFalseYesFilters the returned shipping details of the orders based on the status of the order. Applicable Values: Active, All, Completed, Inactive.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
PaymentPolicyId [KEY]StringFalseNoA unique eBay-assigned ID for a payment policy. This ID is generated when the policy is created.
DescriptionStringFalseNoThe Description of the payment policy.
NameStringFalseNoThe Description of the payment policy.
CategoryTypesNameStringFalseNoThe Category Type name value to which this policy applies. Used to discern accounts that sell motor vehicles from those that don't.
DepositAggrStringFalseNoAmounts 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.
MarketplaceIdStringFalseNoThe ID of the eBay marketplace to which the payment policy applies.
ImmediatePayBooleanFalseNoIf set to true, payment is due upon receipt (eBay generates a receipt when the buyer agrees to purchase an item).
PaymentMethodAggrStringFalseNoIf the seller is not opted-in to managed payments, this container returns a list of the payment methods accepted by the seller.
RecipientAccountReferenceIdStringFalseNoContains the PayPal email address of the recipient (buyer) if referenceType is set to PAYPAL_EMAIL.
RecipientAccountReferenceTypeStringFalseNoA reference a recipient's account. Currently only PAYPAL_EMAIL is valid.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
ReturnPolicyId [KEY]StringFalseNoA unique eBay-assigned ID for this policy.
DescriptionStringFalseNoThe seller-defined description of the return policy for internal use (this value is not displayed to end users).
NameStringFalseNoThe category type to which the policy applies (motor vehicles or non-motor vehicles).
CategoryTypesNameStringFalseNoThe category type to which the policy applies (motor vehicles or non-motor vehicles).
MarketplaceIdStringFalseNoThe ID of the eBay marketplace to which this return policy applies.
ExtendedHolidayReturnsOfferedStringFalseNoIf set to true, the seller offers an Extended Holiday Returns policy for their listings.
InternationalOverrideAggrStringFalseNoIf populated, specifies the seller's policies for international returns (items that require postage via an international shipping service).
RefundMethodStringFalseNoIndicates the method the seller uses to compensate the buyer for returned items. The return method specified applies only to remorse returns.
RestockingFeePercentageStringFalseNoFor sellers who accept returns, this field is filled if they charge buyers a restocking fee when items are returned.
ReturnInstructionsStringFalseNoContains the seller's detailed explanation for their return policy and is displayed in the Return Policy section of the View Item page.
ReturnMethodStringFalseNoValid in the US marketplace only, this optional field indicates additional services (other than money-back) that sellers can offer buyers for remorse returns.
ReturnPeriodValueStringFalseNoSpecifies the amount of time the buyer has to return an item.
ReturnPeriodUnitStringFalseNoSpecifies the unit of measure of amount of time the buyer has to return an item.
ReturnsAcceptedBooleanFalseNoIf set to true, the seller accepts returns.
ReturnShippingCostPayerStringFalseNoThis 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

NameTypeReadOnlyReferencesFilterOnlyDescription
ShippingCarrierIdIntegerFalseNoNumeric identifier.
DescriptionStringFalseNoDisplay 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).
DetailVersionStringFalseNoReturns the latest version number for this field.
ShippingCarrierStringFalseNoThe code for the shipping carrier.
UpdateTimeDatetimeFalseNoGives the time in GMT that the feature flags for the details were last updated.
DetailNameStringFalseYesA designation of what kind of information you wish returned for the specified eBay site.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
ShippingCategory [KEY]StringFalseNoIndicates 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.
DescriptionStringFalseNoDisplay 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.
DetailVersionStringFalseNoReturns the latest version number for this field. The version can be used to determine if and when to refresh cached client data.
UpdateTimeDatetimeFalseNoGives 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.
DetailNameStringFalseYesA designation of what kind of information you wish returned for the specified eBay site.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
ShippingLocation [KEY]StringFalseNoShort name or abbreviation for a region (e.g., Asia) or location (e.g. Japan).
DescriptionStringFalseNoDisplay 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.
DetailVersionStringFalseNoReturns the latest version number for this field. The version can be used to determine if and when to refresh cached client data.
UpdateTimeDatetimeFalseNoGives 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.
DetailNameStringFalseYesA designation of what kind of information you wish returned for the specified eBay site.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
ShippingServiceId [KEY]IntegerFalseNoNumeric identifier. A value greater than 50000 represents an international shipping service.
CODServiceBooleanFalseNoThis flag is returned as true if the corresponding ShippingService value is a COD (Cash-On-Delivery) service.
CostGroupFlatBooleanFalseNoIf returned, this is the shipping service group to which the shipping service belongs.
DescriptionStringFalseNoA user-friendly description of shipping service options.
DetailVersionStringFalseNoReturns the latest version number for this field.
DimensionsRequiredBooleanFalseNoWhether the shipping service option requires that package dimensions are provided by the seller.
ExpeditedServiceBooleanFalseNoIndicates 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.
InternationalServiceBooleanFalseNoIndicates whether the shipping service is an international shipping service.
MappedToShippingServiceIdIntegerFalseNoThe Id of another shipping service that will be used when a shipping service is deprecated.
ShippingCategoryStringFalseNoIndicates 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.
ShippingServiceStringFalseNoThe 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.
ShippingTimeMaxIntegerFalseNoThe 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.
ShippingTimeMinIntegerFalseNoThe 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.
SurchargeApplicableBooleanFalseNoTrue if a surcharge applies for any region that this service ships to.
UpdateTimeDatetimeFalseNoGives the time in GMT that the feature flags for the details were last updated.
ValidForSellingFlowBooleanFalseNoIf 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.
WeightRequiredBooleanFalseNoIf 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.
DetailNameStringFalseYesA designation of what kind of information you wish returned for the specified eBay site.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
SiteIDIntegerFalseNoNumeric 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.
SiteNameStringFalseNoShort 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.
DetailVersionStringFalseNoReturns the latest version number for this field. The version can be used to determine if and when to refresh cached client data.
UpdateTimeDatetimeFalseNoGives 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.
DetailNameStringFalseYesA designation of what kind of information you wish returned for the specified eBay site.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
CategoryIdIntegerFalseNoThis string value is the unique identifier of an eBay category.
CategoryNameStringFalseNoThis string value is the display name of the eBay primary category, as it would appear on the eBay website.
CategoryParentIdStringFalseNoThis string value is the category Id of the parent category of the primary category indicated in the CategoryId field.
CategoryParentNameStringFalseNoThis string value is the display name of the eBay primary category, as it would appear on the eBay website.
PercentItemFoundIntegerFalseNoPercentage 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.
QueryStringFalseYesThis 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

NameTypeReadOnlyReferencesFilterOnlyDescription
TaskId [KEY]StringTrueNoThe ID of the task that was submitted in the request.
StatusStringTrueNoThe enumeration value that indicates the state of the task that was submitted in the request.
FeedTypeStringFalseNoThe feed type associated with the task.
CreationDateDatetimeTrueNoThe date the task was created.
UploadSummaryAggrStringTrueNoThis container provides summary information on an upload feed (not applicable for download feed types).
MarketplaceIDStringFalseYesMarketplaceID of your Ebay account.
SchemaVersionStringFalseYesThe schema version number associated with the task.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
ID [KEY]StringFalseNoThe unique identifier of the linked order line item.
TransactionIdStringFalseNoUnique identifier for an eBay sales transaction.
OrderIdStringFalseNoThe unique identifier of the order to which the linked line item belongs.
EstimatedDeliveryTimeMaxDatetimeFalseNoIndicates the latest date and time to receive the order.
EstimatedDeliveryTimeMinDatetimeFalseNoIndicates the earliest date and time to receive the order.
SellerUserIDStringFalseNoThe eBay user ID of the seller who sold the linked line item.
ItemNameStringFalseNoDepending on the call and context, this value is either a name of an Item/Variation Specific, or a Parts Compatibility name.
ItemValueStringFalseNoDepending on the call and context, this value is either the value of an Item/Variation Specific, a Parts Compatibility value, or a product identifier.
ItemsTitleStringFalseNoThis field is used to specify the title of the listing.
CreateTimeFromDatetimeFalseNoSpecifies 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.
CreateTimeToDatetimeFalseNoSpecifies 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.
ModTimeFromDatetimeFalseNoSpecifies 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.
ModTimeToDatetimeFalseNoSpecifies 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.
NumberOfDaysIntegerFalseNoAll 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.
OrderRoleStringFalseNoFilters the returned payment details of the transactions based on the role of the user. The user's role is either buyer or seller.
OrderStatusStringFalseNoFilters the returned payment details of the transactions based on the status of the order. Applicable Values: Active, All, Completed, Inactive.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
TransactionReferenceId [KEY]StringFalseNoA unique transaction ID for the payment.
TransactionIdStringFalseNoThe unique identifier of the transaction the payment has been made for.
OrderIdStringFalseNoThe unique identifier of the order the payment has been made for.
FeeOrCreditAmountDecimalFalseNoFee Amount is a positive value and Credit Amount is a negative value.
PayeeStringFalseNoThe person or organization who is to receive the payment allocation.
PayerStringFalseNoThis field indicates the eBay user or eBay partner who submitted the payment.
PaymentAmountDecimalFalseNoThe amount of the payment that is allocated to the payee.
PaymentStatusStringFalseNoThe current status of a buyer payment that is allocated to a specified payee.
PaymentTimeDatetimeFalseNoThe date and time when the payment is received by the payee.
CreateTimeFromDatetimeFalseYesSpecifies 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.
CreateTimeToDatetimeFalseYesSpecifies 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.
ModTimeFromDatetimeFalseYesSpecifies 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.
ModTimeToDatetimeFalseYesSpecifies 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.
NumberOfDaysIntegerFalseYesAll 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.
OrderRoleStringFalseYesFilters the returned payment details of the transactions based on the role of the user. The user's role is either buyer or seller.
OrderStatusStringFalseYesFilters the returned payment details of the transactions based on the status of the order. Applicable Values: Active, All, Completed, Inactive.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
ReferenceId [KEY]StringFalseNoThis dollar value is the amount of the refund to the buyer for this specific refund transaction.
TransactionIdStringFalseNoThe unique identifier of the transaction the payment has been made for.
OrderIdStringFalseNoThe unique identifier of the order the payment has been made for.
FeeOrCreditAmountDecimalFalseNoFee Amount is a positive value and Credit Amount is a negative value.
RefundToStringFalseNoThis field is the eBay user ID of the buyer who is receiving the refund or store credit from the merchant.
RefundTypeStringFalseNoThis value indicates whether the merchant refunded or provided a store credit to the buyer for the returned In-Store Pickup item.
RefundAmountDecimalFalseNoThis dollar value is the amount of the refund to the buyer for this specific refund transaction.
RefundStatusStringFalseNoThis 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.
RefundTimeDatetimeFalseNoThis date/time value is the timestamp for the refund transaction. This field is not returned if the refund was not successful (RefundStatus=FAILED).
CreateTimeFromDatetimeFalseNoSpecifies 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.
CreateTimeToDatetimeFalseNoSpecifies 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.
ModTimeFromDatetimeFalseNoSpecifies 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.
ModTimeToDatetimeFalseNoSpecifies 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.
NumberOfDaysIntegerFalseNoAll 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.
OrderRoleStringFalseNoFilters the returned payment details of the transactions based on the role of the user. The user's role is either buyer or seller.
OrderStatusStringFalseNoFilters the returned payment details of the transactions based on the status of the order. Applicable Values: Active, All, Completed, Inactive.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
TransactionId [KEY]StringFalseNoUnique 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.
OrderIdStringFalseNoThe 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.
ItemIdStringFalseNoThe 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.
ItemSiteStringFalseNoThe name of the site on which the item is listed.
ItemTitleStringFalseNoThis field is used to specify the title of the listing.
ActualHandlingCostDecimalFalseNoThe handling cost that the seller has charged for the order line item.
ActualShippingCostDecimalFalseNoThe shipping cost paid by the buyer for the order line item. This field is only returned after checkout is complete.
BuyerEmailStringFalseNoEmail address for the user.
BuyerFirstNameStringFalseNoThe first name of the buyer who purchased the order.
BuyerLastNameStringFalseNoThe last name of the buyer who purchased the order.
CreatedDateDatetimeFalseNoIndicates the creation time of the order line item.
PriceDecimalFalseNoThe price of the order line item.
SiteIdStringFalseNoThe site upon which the order line item (transaction) was created.
PaidTimeDatetimeFalseNoIndicates the time when the order was marked paid.
DigitalRecipientEmailStringFalseNoThis field displays the email address of the sender/purchaser of the digital gift card.
DigitalRecipientNameStringFalseNoThis field displays the actual name (not the eBay user ID) of the sender/purchaser of the digital gift card.
DigitalSenderEmailStringFalseNoThis field displays the email address of the sender/purchaser of the digital gift card.
DigitalSenderNameStringFalseNoThis field displays the actual name (not the eBay user ID) of the sender/purchaser of the digital gift card
DigitalDeliveryMethodStringFalseNoThis value indicates the method in which the digital gift card will be delivered to the buyer.
EBayPlusTransactionBooleanFalseNoIf true, this transaction is for an item that was purchased under the eBay Plus program.
FinalValueFeeDecimalFalseNoA Final Value Fee is calculated and charged to a seller's account immediately upon creation of an order line item.
GuaranteedDeliveryBooleanFalseNoThis field is returned as true if the order line item is qualified for eBay Guaranteed Delivery, or false if it is not eligible.
GuaranteedShippingBooleanFalseNoThis field is returned as true if the seller chose to use eBay's Guaranteed Shipping feature at listing time.
InvoiceSentTimeDatetimeFalseNoThis field indicates the date/time that an order invoice was sent from the seller to the buyer.
DigitalStatusStringFalseNoThis enumeration value indicates the current state of a purchased digital gift card.
InquiryStatusStringFalseNoThis field gives the status of a buyer's Item Not Received (INR) Inquiry.
ReturnStatusStringFalseNoThis field gives the status of a buyer's return request.
TotalTaxAmountDecimalFalseNoThis 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.
CreateTimeFromDatetimeFalseYesSpecifies the start of the date range for which to retrieve transactions of orders created within this date range.
CreateTimeToDatetimeFalseYesSpecifies the end of the date range for which to retrieve transactions of orders created within this date range.
ModTimeFromDatetimeFalseYesSpecifies 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.
ModTimeToDatetimeFalseYesSpecifies 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.
NumberOfDaysIntegerFalseYesAll eBay transactions that were either created or modified within this period are returned in the output. Min: 1. Max: 30.
OrderRoleStringFalseYesFilters the returned transactions based on the role of the user. The user's role is either buyer or seller.
OrderStatusStringFalseYesFilters the returned transactions based on the status of the order. Applicable Values: Active, All, Completed, Inactive.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
TransactionId [KEY]StringFalseNoUnique identifier for the transaction.
OrderIdStringFalseNoUnique identifier for the order.
InternationalPackagingHandlingCostsDecimalFalseNoFees a seller might assess for the shipping of the item (in addition to whatever the shipping service might charge).
PostalCodeStringFalseNoPostal code for the location from which the package will be shipped.
PackagingHandlingCostsDecimalFalseNoFees a seller might assess for the shipping of the item (in addition to whatever the shipping service might charge).
ShippingIrregularBooleanFalseNoThis boolean field indicates that the shipping package is considered an irregular shape and/or size by the shipping carrier, and thus requires special handling.
ExpeditedServiceBooleanFalseNoIndicates whether the service is an expedited shipping service.
ShippingImportChargeDecimalFalseNoThe total cost of customs and taxes for the international leg of an order shipped using the Global Shipping Program.
ShippingInsuranceCostDecimalFalseNoThe insurance cost associated with shipping a single item with this shipping service.
ShippingServiceAdditionalCostDecimalFalseNoThe cost of shipping each additional item if the same buyer purchases multiple quantity of the same line item.
ShippingServiceCostDecimalFalseNoThe base cost of shipping the item using the shipping service specified in the ShippingService field.
ShippingPackageInfoStringFalseNoThis aggregate contains all shipping package info.
ShipmentTrackingNumbersStringFalseNoThe tracking numbers assigned by the shipping carriers.
ShippingCarriersStringFalseNoThe name of the shipping carriers used to ship the items.
CreateTimeFromDatetimeFalseYesSpecifies 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.
CreateTimeToDatetimeFalseYesSpecifies 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.
ModTimeFromDatetimeFalseYesSpecifies 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.
ModTimeToDatetimeFalseYesSpecifies 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.
NumberOfDaysIntegerFalseYesAll 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.
OrderRoleStringFalseYesFilters the returned shipping details of the transactions based on the role of the user. The user's role is either buyer or seller.
OrderStatusStringFalseYesFilters the returned shipping details of the transactions based on the status of the order. Applicable Values: Active, All, Completed, Inactive.

Return to Top