eBay Trading API

Version 1359

B

If this field is returned as true, the corresponding category supports business-to-business (B2B) VAT listings.

This field is no longer returned.

Indicates the current balance of the additional account.

This string value represents the first four digits of the bank account the associated with the user account.

This timestamp indicates the date and time when the owner of the account last changed the bank account on file as the primary payment method.

Base64 is a binary-to-text encoding scheme that represents binary data in an ASCII string format by translating it into a radix-64 representation.

This is the truncated version of the full URL.

This field is deprecated.

Specifies the default site setting for whether categories allow the BasicUpgradePack feature (a feature pack).

This type is deprecated.

This field is used to retrieve all account entries dating back to the timestamp passed into this BeginDate field up until the timestamp passed into the EndDate field.

For GetBestOffers, each BestOffer container consists of detailed information on the Best Offer/Counter Offer, including the type of Best Offer (Best Offer, Buyer/Seller Counter Offer), amount of the Best Offer/Counter Offer, and status of Best Offer/Counter Offer.

This is the amount of the buyer's current Best Offer.

Container consisting of the status for a Best Offer.

Enumerated type that defines the possible values that can be passed in to the Action field in a RespondToBestOffer request.

All Best Offers for the item according to the filter or Best Offer ID (or both) used in the input.

All Best Offers for the item according to the filter or Best Offer ID (or both) used in the input.

An array of one or more Best Offers.

Indicates whether the category supports the Best Offer Automatic Accept feature for listings.

This field is returned as an empty element (a boolean value is not returned) if one or more eBay marketplaces support the Best Offer Auto-Accept feature.

Specifies the default site setting for whether categories allow auto-accept for Best Offers.

Type defining the BestOfferAutoAcceptEnabled field that is returned under the FeatureDefinitions container of the GetCategoryFeatures response (as long as BestOfferAutoAcceptEnabled or BestOfferAutoDeclineEnabled is included as a FeatureID value in the call request or no FeatureID values are passed into the call request).

The price at which Best Offers are automatically accepted.

Indicates whether the category supports the Best Offer Auto Decline feature.

This field is returned as an empty element (a boolean value is not returned) if one or more eBay marketplaces support the Best Offer Auto-Decline feature.

Specifies the default site setting for whether categories allow auto decline for Best Offers.

Type defining the BestOfferAutoDeclineEnabled field that is returned under the FeatureDefinitions container of the GetCategoryFeatures response (as long as BestOfferAutoDeclineEnabled or BestOfferAutoAcceptEnabled is included as a FeatureID value in the call request or no FeatureID values are passed into the call request).

This value indicates whether the corresponding offer is a Best Offer, a seller's counter offer, or a buyer counter offer to the seller's counter offer.

The number of Best Offers made for this item, if any.

The number of items the user has made Best Offers on.

Indicates whether the category supports sellers offering a counter offer against a buyer's Best Offer, or a buyer offering a counter offer against the seller's counter offer.

This field is returned as an empty element (a boolean value is not returned) if one or more eBay marketplaces support counter offers to Best Offers.

Specifies the default site setting for whether categories allow counter offers for Best Offers.

Type defining the BestOfferCounterEnabled field that is returned under the FeatureDefinitions container of the GetCategoryFeatures response (as long as BestOfferCounterEnabled is included as a FeatureID value in the call request or no FeatureID values are passed into the call request).

For Add/Revise/Relist/Verify calls: This container is used to enable the Best Offer feature on a listing.

Type defining the BestOfferDetails container, which consists of Best Offer details associated with a listing.

This field indicates whether or not the Best Offer feature is enabled for the listing.

Indicates whether the category supports the Best Offer feature for listings.

If this field is returned as true, the corresponding category supports Best Offers.

This field is returned as an empty element (a boolean value is not returned) if one or more eBay marketplaces support the Best Offer feature.

Specifies the default site setting for whether categories allow Best Offers.

Type defining the BestOfferEnabled field that is returned under the FeatureDefinitions container of the GetCategoryFeatures response (as long as BestOfferEnabled is included as a FeatureID value in the call request or no FeatureID values are passed into the call request).

Unique identifier for a Best Offer.

The unique identifier of a Best Offer.

The unique identifier of a Best Offer on an item.

The unique identifier of a buyer's Best Offer for the order line item.

Unique identifier for a Best Offer.

Include this container and set the BestOfferList.Include field to true to return the list of items on which the eBay user has made a Best Offer.

This container consists of the items on which the eBay user has made Best Offers.

Indicates whether or not the sales transaction resulted from the seller accepting a Best Offer (or Counter Offer) from a buyer.

This enumeration value indicates the status of the latest Best Offer from the buyer.

This field can be used if the seller wants to retrieve Best Offers in a specific state.

Enumerated type that defines the possible values for the status of a Best Offer or a buyer's/seller's counter offer.

Note: this field is no longer used.

Type defining the BestOffer container, which consists of information on one Best Offer or counter offer.

Enumerated type that defines the possible offer types for the Best Offer feature.

The time of day when the prospective buyer prefers to be contacted by the seller.

This enumerated type lists the possible actions that can be made on a listing or Best Offer and the possible states of a bid or Best Offer.

This integer value is actually a percentage value that indicates what percentage of the user's total number of bids during the last 30 days (or the number of days specified in the SummaryDays field) has been placed on auction items that the seller has listed.

This container consists of an array of bids made on the specified auction listing.

The total number of bids that the user has placed on the auction item.

This field is deprecated.

Number of bids placed so far against the auction item.

The BidCountMax value in a My eBay Favorite Search.

The BidCountMin value in a My eBay Favorite Search.

Data for one eBay bidder.

Number of bidders for an item.

Container consisting of the seller's preference for receiving contact information for unsuccessful bidders.

This container is included if the seller wishes to receive contact information for unsuccessful bidders.

This type is used by the BidderNoticePreferences container, which consists of the seller's preference for receiving contact information for unsuccessful bidders in auction listings.

The number of auction items the user has bid on.

Detailed information about a bid.

Type defining the BiddingDetails container, which consists of information about the buyer's bidding history on a single auction item.

Contains information about the user as a bidder on a certain item.

Type used by the BiddingSummary container, which is returned in the GetAllBidders response if the IncludeBiddingSummary boolean field is included and set to true in the call request.

The minimum amount a progressive bid must be above the current high bid to be accepted.

Array of items the bidder has bid on, has won or has lost.

Include this container and set the BidList.Include field to true to return the list of auction items on which the eBay user has bid.

This container consists of the auction items on which the eBay user has bid.

Bid retractions count, for multiple predefined time periods preceding the call.

This integer value indicates the total number of bids that the user has retracted (from any and all sellers) during the last 30 days (or the number of days specified in the SummaryDays field).

This integer value indicates the total number of bids made with unique listing categories that the user has placed during the last 30 days (or the number of days specified in the SummaryDays field).

This integer value indicates the total number of bids to unique sellers that the user has placed during the last 30 days (or the number of days specified in the SummaryDays field).

The SuggestedBidValues container is only returned if the buyer is attempting to bid on an auction item.

Currency type in which the user is billed seller fees.

This integer value indicates the day of the month on which eBay sends a billing invoice to the user.

Applicable for Real Estate auctions only.

If a warning message is generated when the call is made, this BlockOnWarning will block the bid/buy action if set to true.

Content of the message is input into this string field.

The enumeration value returned in this field indicates whether or not the Bold Title featured is enabled for the eBay site.

This enumerated type contains the possible values that can be returned in the ListingFeatureDetails.BoldTitle field to indicate whether or not bold listing titles are supported by the eBay site specified in the GeteBayDetails call request.

This container is only used by the PlaceOffer call request if the previous PlaceOffer call resulted in a BotBlock container in the response.

This container is conditionally returned in the PlaceOffer call response if eBay wants to challenge the user making the call to ensure that the call is being made by a real user and not a bot.

This string value is a URL to an audio clip that eBay generates and returns in the PlaceOffer call response when eBay is requiring that the user supply an authentication token and URL in order for eBay to process the PlaceOffer call.

Type used by the BotBlock container of the PlaceOffer call request.

This type is used by the BotBlock container that is returned in the PlaceOffer call response if eBay is requiring that the user supply an authentication token and URL in order for eBay to process the PlaceOffer call.

This string value is an encrypted token that eBay generates and returns in the BotBlock.BotBlockToken field of the PlaceOffer call response when eBay is requiring that the user supply an authentication token and URL in order for eBay to process the PlaceOffer call.

This string value is an encrypted token that eBay generates and returns in the BotBlock.BotBlockToken field of the PlaceOffer call response when eBay is requiring that the user supply an authentication token and URL in order for eBay to process the PlaceOffer call.

This string value is a URL to an image that eBay generates and returns in the PlaceOffer call response when eBay is requiring that the user supply an authentication token and URL in order for eBay to process the PlaceOffer call.

This string value is a URL that eBay generates and returns in either the BotBlock.BotBlockUrl or BotBlock.BotBlockAudioUrl field (returned for site-impaired users) of the PlaceOffer call response when eBay is requiring that the user supply an authentication token and URL in order for eBay to process the PlaceOffer call.

The brand of the product.

The brand name of the item being reported for VeRO violation.

This container is used if the seller wants to, or is required to identify a product using an Brand/Manufacturer Part Number (MPN) pair.

Indicates whether the category supports the capability to identify a product using the brand/manufacturer part number combination.

This field is returned as an empty element (a boolean value is not returned) if one or more eBay marketplaces support the use of Brand and MPN (Manufacturer Part Number) to identify a product.

Indicates whether the category is enabled for the BrandMPN field for a specific item.

Type defining the BrandMPNIdentifierEnabled field that is returned under the FeatureDefinitions container of the GetCategoryFeatures response (as long as BrandMPNIdentifierEnabled is included as a FeatureID value in the call request or no FeatureID values are passed into the call request).

Type defining the BrandMPN container which is used to identify a product (through a unique product brand and Manufacturer Part Number combination).

The short description of the infringement associated with the reason code ID.

This refers to the specific software build that eBay used when processing the request and generating the response.

Reserved for future use.

Boolean value indicating whether or not an order line item is part of a bundle purchase using Product Configurator.

This field indicates whether the user's account is enabled for buying and selling (indicated by FullMarketPlaceParticipant) on eBay, or if the account is a Partially Provisioned Account (indicated by Shopper) without selling and buying privileges on eBay.

Enumerated type that defines the eBay user's account type.

This field should be included in an Add/Revise/Relist call and set to true if the seller is registered on the selling site as a Business Seller.

Returns the seller's information (in a business card format) if the seller's SellerBusinessCodeType is set to Commercial.

Type used by the BusinessSellerDetails container, which is returned in an Item node if the item's seller is registered on eBay as a Business Seller.

Container consisting of information about the prospective buyer who made the Best Offer.

Container consisting of user and shipping details for the order's buyer.

This field is returned if the buyer left a message for the seller during checkout.

This field is returned if a buyer left a comment for the seller during the left by buyer during the checkout flow.

If this field is returned as true, the category supports the Best Price Guarantee feature on the Australia site.

This field is deprecated.

For the Australia site, if the BuyerGuaranteeEnabled is returned, then the default site setting is that categories allow buyer protection.

Type defining the BuyerGuaranteeEnabled field that is returned under the FeatureDefinitions container of the GetCategoryFeatures response (as long as BuyerGuaranteeEnabled is included as a FeatureID value in the call request or no FeatureID values are passed into the call request).

The eBay Best Price Guarantee price.

Contains information about the user as a buyer, such as the shipping address.

A prospective buyer has the option to include a comment when placing a Best Offer or making a counter offer to the seller's counter offer.

Display message from buyer.

A BuyerPackageEnclosure container will be returned for each shipping package containing payment instructions.

This container is returned in GetOrders (and other order management calls) if the 'Pay Upon Invoice' option is being offered to the buyer, and the seller is including payment instructions in the shipping package(s) for the order

This container is returned in GetOrders (and other order management calls) if the 'Pay Upon Invoice' option is being offered to the buyer, and the seller is including payment instructions in the shipping package(s) for the order.

Type defining the BuyerPackageEnclosures container, which is returned in GetOrders (and other order management calls) if the 'Pay Upon Invoice' option is being offered to the buyer, and the seller is including payment instructions in the shipping package(s).

Type defining the BuyerPackageEnclosure container, which is returned in GetOrders (and other order management calls) if the 'Pay Upon Invoice' option is being offered to the buyer, and the seller is including payment instructions in the shipping package.

Specifies the paid status of the order.

This enumerated type identifies all of the payment methods supported for the 'Pay Upon Invoice' feature.

This enumerated type defines different payment methods that can be used by buyers to pay sellers for purchases.

The enumeration value returned in this field indicates whether an item is eligible for the buyer protection.

This enumeration type indicates the item's eligibility status for eBay's Money Back Guarantee program.

Type defining the ApplyBuyerProtection container, which consists of details related to whether or not the item is eligible for buyer protection and which of the buyer protection programs will cover the item.

This value indicates the type of buyer protection program applicable for the item.

This enumeration type indicates the applicable buyer protection program that the item is eligible to be covered under.

This value indicates the item's eligibility for the buyer protection program listed in the ApplyBuyerProtection.BuyerProtectionSource field.

Lists the threshold values that can be passed in through the BuyerRequirementDetails container in the Add/Revise/Relist API calls.

This container is returned if the seller has applied one or more buyer requirement criteria to the listing.

Type defining the BuyerRequirementDetails container, which indicates if the seller has set any buyer requirements that apply to a listing.

Applicable for listings in vehicle categories on the US eBay Motors site and eBay Canada site.

Container for information about 1 year feedback metric as buyer.

Type defining the BuyerRoleMetrics container, which consists of details relating to the eBay buyer's one-year history of leaving feedback for the seller.

Indicates whether the buyer has selected shipping details during checkout.

This container consists of taxpayer identification for the buyer.

This container will either consist of VAT or Codice Fiscale taxpayer identification information for the buyer

This type is used by various Get calls, including GetItem and GetOrders.

The eBay user ID of the order's buyer.

Include this container and set the BuyingSummary.Include field to true to return the BuyingSummary container in the response.

This container consists of buying/bidding activity counts and values.

Type defining the BuyingSummary container returned in GetMyeBayBuying.

This field is returned as true if a Buy It Now price has been added to the auction listing.

Indicates whether the Buy It Now feature is available for an auction listing.

This field is returned as true if the Buy It Now price on the original auction listing was lowered as part of a revision to the original auction listing.

The amount the offer recipient must pay to purchase the item as a Second Chance Offer.

This field is only applicable for auction listings.

Specifies the amount the offer recipient must pay to purchase the item from the Second Chance Offer listing.