If true, indicates that the user has set up an About Me page.

Base type definition of the request payload, which can carry any type of payload content plus optional versioning information and detail level requirements.

Base type definition of a response payload that can carry any type of payload content with following optional elements

Accent color for the Store.

This field is deprecated.

Enumerated type that defines the possible values that can be returned in the RuleCurrentStatus output field of the GetApiAccessRules call.

This enumerated type contains values that describe an application's current status with respect to an API access rule.

Indicates the unique identifier for the additional account (the account ID).

Enumerated type that defines the fee/charge and credit transactions that occur on an eBay user's account.

This enumeration value indicates the type of transaction or administrative action that occurred on the eBay user's account.

This container holds an array of account entries.

Type defining the array of AccountEntry objects that are conditionally returned in the GetAccount response.

Container consisting of detailed information for each debit or credit transaction that occurs on an eBay user's account.

Specifies how account entries should be sorted in the response, by an element and then in ascending or descending order.

Enumerated type defining the possible values that can be used in the AccountEntrySortType field of the GetAccount request to sort account entries returned in the response.

Type defining the AccountEntry container returned in the GetAccount response.

Specifies the report format in which to return account entries.

This enumerated type contains the suppported values that may be used in the AccountHistorySelection field to control the account entries that are returned in a GetAccount response.

Specifies the seller's unique account number.

This field is deprecated.

Indicates the current state of the account (such as active or inactive).

Enumerated type that lists the possible states of an eBay user account.

Contains summary data for the seller's account, such as the overall balance, bank account and credit card information, and amount and date of any past due balances.

Summary data for the requesting user's seller account as a whole.

A token representing the application-level acknowledgement code that indicates the response status (e.g., success).

This enumerated value indicates whether or not the corresponding message was successfully sent to the bidder(s)/potential buyer(s).

This enumerated type identifies the possible values that can be returned in the Ack field in call responses.

This field is deprecated.

Indicates the type of offer being made on the specified listing.

The enumeration value that the seller passes in to this field will control whether the seller accepts or make a counter offer to a single buyer's Best Offer, or declines one or more buyers' Best Offers.

Specifies the type of action (Add, Move, Delete, or Rename) to carry out for the specified eBay Store categories.

The seller must include this field and set it to 'AddOrUpdate' to add a new user note or update an existing user note, or set it to 'Delete' to delete an existing user note.

This field is deprecated.

This field is deprecated.

 

The number of currently active auctions that will sell.

The number of currently active auctions that will sell.

Indicates whether or not to limit the result set to active items.

Include this container and set the ActiveList.Include field to true to return the list of active listings on eBay.com.

This container consists of active listings.

This timestamp indicates when the order was actually delivered to the buyer.

The handling cost that the seller has charged for the order line item.

The shipping cost paid by the buyer for the order line item.

Enables a seller to create an Unpaid Item case against a buyer.

Enables a seller to create an Unpaid Item case against a buyer.

 

Enables a seller to create an Unpaid Item case against a buyer.

 

Enables a seller to create an Unpaid Item case against a buyer.

This call enables the seller to respond to an Item Not Received (INR) dispute opened by a buyer through PayPal's Purchase Protection program, or to update an Unpaid Item case.

This call enables the seller to respond to an Item Not Received (INR) dispute opened by a buyer through PayPal's Purchase Protection program, or to update an Unpaid Item case.

 

Type defining the response of the AddDispute call.

 

 

This call enables the seller to respond to an Item Not Received (INR) dispute opened by a buyer through PayPal's Purchase Protection program, or to update an Unpaid Item case.

 

This call enables the seller to respond to an Item Not Received (INR) dispute opened by a buyer through PayPal's Purchase Protection program, or to update an Unpaid Item case.

 

This type is the base response of the AddDisputeResponse call.

 

This type is the base response of the AddDisputeResponse call.

Type defining the response of the AddDispute call.

This call allows a seller to create and publish a fixed-price listing.

This call allows a seller to create and publish a fixed-price listing.

 

This call allows a seller to create and publish a fixed-price listing.

 

This call allows a seller to create and publish a fixed-price listing.

 

If the new listing is created successfully, the AddFixedPriceItem response includes the unique identifier of the new listing (ItemID) and the estimated values of any fees (such as insertion fee and any other listing upgrade fees) generated as a result of the listing being created.

 

If the new listing is created successfully, the AddFixedPriceItem response includes the unique identifier of the new listing (ItemID) and the estimated values of any fees (such as insertion fee and any other listing upgrade fees) generated as a result of the listing being created.

Base request type for the AddItem call, which is used to create a fixed-price, auction, or classified ad listing.

Base request type for the AddItem call, which is used to create a fixed-price, auction, or classified ad listing.

 

Base request type for the AddItem call, which is used to create a fixed-price, auction, or classified ad listing.

 

An AddItemRequestContainer container is required for each listing that will be created with the AddItems request.

Type defining the AddItemRequestContainer containers that are used in an AddItems call.

Base request type for the AddItem call, which is used to create a fixed-price, auction, or classified ad listing.

 

If the new listing is created successfully, the AddItem response includes the unique identifier of the new listing (ItemID) and the estimated values of any fees (such as insertion fee and any other listing upgrade fees) generated as a result of the listing being created.

 

One AddItemResponseContainer container is returned for each listing that was created with the AddItems call.

Type defining the AddItemResponseContainer containers that are returned in an AddItems call.

If the new listing is created successfully, the AddItem response includes the unique identifier of the new listing (ItemID) and the estimated values of any fees (such as insertion fee and any other listing upgrade fees) generated as a result of the listing being created.

Base request type for the AddItems call, which is used to create one to five fixed-price, auction, or classified ad listings.

Base request type for the AddItems call, which is used to create one to five fixed-price, auction, or classified ad listings.

 

Base request type for the AddItems call, which is used to create one to five fixed-price, auction, or classified ad listings.

 

Base request type for the AddItems call, which is used to create one to five fixed-price, auction, or classified ad listings.

 

The response of the AddItems call.

 

The response of the AddItems call.

This container shows the identifier and current balance for another eBay account associated with the eBay user.

Contains the data for one additional account.

This field indicates whether or not the category (specified in the Category.CategoryID field) supports Boats and Motorcycles Parts compatibility.

This field is returned as an empty element (a boolean value is not returned) if one or more eBay API-enabled sites support the Boat and Motorcycle Parts Compatibility feature.

Indicates whether most categories on the specified eBay site support the Boat and Motorcycle Parts Compatibility feature.

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

This field shows any additional contact for the Business Seller in free-form text.

This field shows the message that was sent from the prospective buyer to the seller.

Enables a buyer and seller in an order relationship to send messages to each other's My Messages Inboxes.

Enables a buyer and seller in an order relationship to send messages to each other's My Messages Inboxes.

 

Enables a buyer and seller in an order relationship to send messages to each other's My Messages Inboxes.

 

Enables a buyer and seller in an order relationship to send messages to each other's My Messages Inboxes.

 

This type defines the response to the AddMemberMessageAAQToPartner call.

 

This type defines the response to the AddMemberMessageAAQToPartner call.

The base request of the AddMemberMessageRTQ call that enables a seller to reply to a question about an active item listing.

The base request of the AddMemberMessageRTQ call that enables a seller to reply to a question about an active item listing.

 

The base request of the AddMemberMessageRTQ call that enables a seller to reply to a question about an active item listing.

 

The base request of the AddMemberMessageRTQ call that enables a seller to reply to a question about an active item listing.

 

This type defines the response to the AddMemberMessageRTQ call.

 

This type defines the response to the AddMemberMessageRTQ call.

The base request of the AddMemberMessagesAAQToBidder call, which allows a seller to send up to 10 messages to bidders/potential buyers regarding an active listing.

The base request of the AddMemberMessagesAAQToBidder call, which allows a seller to send up to 10 messages to bidders/potential buyers regarding an active listing.

 

The base request of the AddMemberMessagesAAQToBidder call, which allows a seller to send up to 10 messages to bidders/potential buyers regarding an active listing.

 

An AddMemberMessagesAAQToBidderRequestContainer container is required for each message being sent to unique bidders/potential buyers.

This type is used by the AddMemberMessagesAAQToBidderRequestContainer container.

The base request of the AddMemberMessagesAAQToBidder call, which allows a seller to send up to 10 messages to bidders/potential buyers regarding an active listing.

 

Type defining the AddMemberMessagesAAQToBidderResponseContainer container, which consists of the Ack field (indicating the result of the send message operation) and the CorrelationID field (used to track multiple send message operations performed in one call).

 

Container consisting of the Ack field (indicating the result of the send message operation) and the CorrelationID field (used to track multiple send message operations performed in one call).

This type is used by the AddMemberMessagesAAQToBidderResponseContainer container.

Type defining the AddMemberMessagesAAQToBidderResponseContainer container, which consists of the Ack field (indicating the result of the send message operation) and the CorrelationID field (used to track multiple send message operations performed in one call).

The AddOrder call can be used by a seller to combine two or more unpaid, single line item orders from the same buyer into one 'Combined Invoice' order with multiple line items.

The AddOrder call can be used by a seller to combine two or more unpaid, single line item orders from the same buyer into one 'Combined Invoice' order with multiple line items.

 

The AddOrder call can be used by a seller to combine two or more unpaid, single line item orders from the same buyer into one 'Combined Invoice' order with multiple line items.

 

The AddOrder call can be used by a seller to combine two or more unpaid, single line item orders from the same buyer into one 'Combined Invoice' order with multiple line items.

 

This type defines the response of an AddOrder call.

 

This type defines the response of an AddOrder call.

This container consists of contact information for the prospective buyer.

This field shows the address on file for the Business Seller.

This field shows an attribute for the address, and its corresponding value.

This enumerated type contains the possible values that can be returned in the type attribute of the AddressAttribute field.

This type is used to display the value of the type attribute of the AddressAttribute field.

Unique ID for a user's address in the eBay database.

The street address of a nonprofit charity organization.

The second line (if needed) of a nonprofit charity organization.

The realm to which the address belongs (e.g. eBay vs PayPal).

Enumerated type used by AddressType to indicate whether a shipping address is on file with eBay or on file with PayPal.

 

This enumerated type is deprecated.

 

This enumerated type is deprecated.

Enumeration value that indicates whether or not a nonprofit charity organization is registered with the PayPal Giving Fund.

Contains the data for an eBay user's address.

Enumerated type that indicates whether or not a nonprofit charity organization is registered with the PayPal Giving Fund.

This tag tells whether current address is a default shipping address or one of the shipping addresses in address book.

This enumeration type lists the values that will be returned to the seller in a GetOrders call (and other order management calls) to indicate that the shipping address is the buyer's default shipping address, an alternative/secondary shipping address, or an invalid shipping address.

Used by the seller of an auction listing to provide a Second Chance Offer to one of that auction item's non-winning bidders.

Used by the seller of an auction listing to provide a Second Chance Offer to one of that auction item's non-winning bidders.

 

Used by the seller of an auction listing to provide a Second Chance Offer to one of that auction item's non-winning bidders.

 

Used by the seller of an auction listing to provide a Second Chance Offer to one of that auction item's non-winning bidders.

 

Type defining the response container of an AddSecondChanceItem call.

 

Type defining the response container of an AddSecondChanceItem call.

Specifies whether the custom header has a link to Add to Favorite Stores.

The base request of the AddToItemDescription call, which is used to add additional text to an active listing's item description.

The base request of the AddToItemDescription call, which is used to add additional text to an active listing's item description.

 

The base request of the AddToItemDescription call, which is used to add additional text to an active listing's item description.

 

The base request of the AddToItemDescription call, which is used to add additional text to an active listing's item description.

 

This type defines the response of the AddToItemDescription call.

 

This type defines the response of the AddToItemDescription call.

Adds one or more order line items to the eBay user's Watch List.

Adds one or more order line items to the eBay user's Watch List.

 

Adds one or more order line items to the eBay user's Watch List.

 

Adds one or more order line items to the eBay user's Watch List.

 

This type defines the response of the AddToWatchList call.

 

This type defines the response of the AddToWatchList call.

Base request of the AddTransactionConfirmationItem call, which is used to end an eBay Motors listing and creates a new Transaction Confirmation Request (TCR) for the motor vehichle, thus enabling the TCR recipient to purchase the item.

Base request of the AddTransactionConfirmationItem call, which is used to end an eBay Motors listing and creates a new Transaction Confirmation Request (TCR) for the motor vehichle, thus enabling the TCR recipient to purchase the item.

 

Base request of the AddTransactionConfirmationItem call, which is used to end an eBay Motors listing and creates a new Transaction Confirmation Request (TCR) for the motor vehichle, thus enabling the TCR recipient to purchase the item.

 

Base request of the AddTransactionConfirmationItem call, which is used to end an eBay Motors listing and creates a new Transaction Confirmation Request (TCR) for the motor vehichle, thus enabling the TCR recipient to purchase the item.

 

The base response of the AddTransactionConfirmationItem call.

 

The base response of the AddTransactionConfirmationItem call.

Indicates whether the category supports Classified Ad listings.

This field is returned as an empty element (a boolean value is not returned) if one or more eBay API-enabled sites support Classified Ad listings.

Specifies the default site setting for whether categories allow Classified Ad format listings.

This enumerated type contains a list of values that will indicate whether or not an Ad Format listing type is enabled for an eBay site or for an eBay category.

Type defining the AdFormatEnabled field that is returned under the FeatureDefinitions container if AdFormatEnabled is used as a FeatureID value in the request, or if no FeatureID values are used in the request.

Contains contact and other information for one lead.

The total number of leads returned.

Enumerated type that indicates to the owner of a classified ad whether or not an email correspondence from a prospective buyer has been answered.

This type is used by the AdFormatLead container that is returned in the GetAdFormatLeads call response.

This value indicates the dollar amount by which the buyer has adjusted the order total.

This value indicates the dollar amount by which the buyer has adjusted the the total cost of the sales transaction.

This field may be used if the buyer and seller have agreed on making an adjustment to the order total.

This field allows the seller to adjust the total cost of the order to account for an extra charge or to pass down a discount to the buyer.

If included in the response as true, indicates that the listing was administratively canceled due to a violation of eBay's listing policies and that the item can be relisted using RelistItem.

This boolean field can be included and set to true if the seller would like to retrieve any listings that were administratively ended by eBay due to a listing policy violation.

If true, the item is listed in a Mature category.

This container consists of the current set of advanced themes available for eBay Stores.

Container for affiliate-related tags, which enable the tracking of user activity.

Type used by the AffiliateTrackingDetails container, which is included in the PlaceOffer call to pass in eBay Partner Network affiliate-related data, so affiliates can earn commissions based on user activity and the number of calls made by the user's application.

This field is not required, but an affiliate may want to use this identifier to better monitor marketing efforts.

The enumeration value returned here indicates whether the eBay user is just selling on the behalf of the nonprofit organization, or if the eBay user is directly affiliated with/representing the nonprofit organization, or the eBay user has been added as a Direct Seller by the nonprofit organization.

This field is deprecated.

The BuyerSatisfaction.Alert container is only returned if eBay has posted one or more informational or warning messages related to the seller's buyer satisfaction rating.

The Performance.Alert container is only returned if eBay has posted one or more informational or warning messages related to the seller's performance rating.

This field is deprecated.

The PowerSellerStatus.Alert container is only returned if eBay has posted one or more informational or warning messages related to the seller's PowerSeller status.

The SellerAccount.Alert container is only returned if eBay has posted one or more informational or warning messages to the seller's account.

The email address to which eBay sends all application markup and markdown event notifications.

For SetNotificationPreferences: include and set AlertEnable to Enable to receive application markup and markdown alerts, or set to Disable to disable the alerts.

This field is deprecated.

This field is deprecated.

This field is deprecated.

This container is deprecated.

This field is deprecated.

This container is deprecated.

Use this switch to view all of the feature settings for a specific category.

This field is deprecated and has been replaced by the ShippingDetails.PaymentEdited field.

Indicates whether the user as a seller by default allows buyers to edit the total cost of an item (while in checkout).

This field is deprecated.

Sellers include this field and set it to true if they want buyers to mail payment to the payment address specified in the SellerPaymentPreferences.SellerPaymentAddress field.

The amount of the discount in the currency indicated in the currencyID attribute.

The total value of the items listed price that this seller can list.

This value indicates the total amount paid by the buyer for the order.

The total amount the buyer paid for the order line item.

The total amount paid by the buyer.

This value indicates the amount of money that is past due on the user's account.

This field is deprecated.

This value indicates the amount that the buyer saved on the order due to any discounts (item, shipping, promotional) applied to the purchase, or if the seller 'manually' reduced the order total.

An eBay-defined complex type for specifying monetary amounts.

Part of the mechanism for eBay to control which announcement messages are to be made available to the user.

Type defining the ShippingServiceDetails.DeprecationDetails container that is returned in the GeteBayDetails response.

The date on which an upcoming event can start to be announced.

This field corresponds to a configurable question on the lead form in the View Item web page.

This field corresponds to a configurable question on the lead form in the View Item web page.

Each returned ApiAccessRule container includes the application's current daily, hourly, and periodic usage of a call, and the maximum amount of times that the application can make that call during the given period.

This type is used by the ApiAccessRule container that is returned in the GetApiAccessRules call response.

The application ID that is unique to each application you (or your company) has registered with the eBay Developers Program.

Return custom, application-specific data associated with the item.

Specifies application-based event preferences that have been enabled.

Specifies application-level event preferences that have been enabled, including the URL to which notifications should be delivered and whether notifications should be enabled or disabled (although the UserDeliveryPreferenceArray input property specifies specific notification subscriptions).

Type used by the ApplicationDeliveryPreferences container to control/indicate where and how Platform Notifications and/or Client Alerts are delivered to a user application, server, and/or email address.

This enumerated type list the possible devices that may be running a affiliate user's application.

This field allows the user to enable or disable Platform Notifications and Client Alerts.

The URL to which eBay delivers all Platform Notifications and Client Alerts sent to the application.

Different Buyer protection schemes and the various status associated with each one of them.

This field is deprecated.

 

This field is deprecated.

The value returned in this field will indicate if the item specific value is a product aspect (relevant to catalog products in the category) or an item/instance aspect, which is an aspect whose value will vary based on a particular instance of the product.

This enumerated type is used by the AspectUsage field that is returned in GetCategorySpecifics to indicate if an Item Specific is defined/derived from an eBay catalog product, or if the Item Specific is typically unique to a particular instance of a product in that category.

Returns a seller's ASQ subjects, each in its own Subject node.

This container can be used to set customized ASQ subjects, or it can be used to reset the ASQ subjects to the eBay defaults.

This type is used by the ASQPreferences container to allow the seller to add custom Ask Seller a Question (ASQ) subjects to item listings, or to reset the custom subjects to the default eBay values.

This field shows an attribute, and its corresponding value for the buyer's tax identification card.

AttributeArrayType and the Attribute element are only applicable for Half.com listings, and since the Half.com site was taken down, this field is no longer applicable.

This field is deprecated.

This field has been deprecated, and should no longer be used.

This type is only applicable for Half.com listings, and since the Half.com site was taken down, this type is no longer applicable.

This field is deprecated.

This field is deprecated.

This field is deprecated.

This enumerated type is deprecated.

This enumerated type is deprecated.

This field is deprecated.

This field is deprecated.

AttributeType and all of its elements are only applicable for Half.com listings, and since the Half.com site was taken down, this field is no longer applicable.

AttributeType and all of its elements are only applicable for Half.com listings, and since the Half.com site was taken down, this field is no longer applicable.

This field is deprecated.

This type is deprecated.

This field is deprecated.

This field is deprecated.

This field has been deprecated, and should no longer be used.

This field is deprecated.

This field is deprecated.

This type is deprecated.

This field is deprecated.

This field is deprecated.

This field is deprecated.

This field is deprecated.

This field is deprecated.

This attribute is deprecated.

This type is deprecated.

This field is deprecated.

This field is deprecated.

This type is only applicable for Half.com listings, and since the Half.com site was taken down, this type is no longer applicable.

The total number of bids made on the seller's active auction listings.

The total number of bids made on the seller's active listings.

The total number of currently active auctions for a given seller.

The total number of currently active auctions for a given seller.

The URL of the audio clip your application should provide for sight-impaired users.

Authentication certificate that authenticates the application when making API calls.

This container gives status on whether the order line item has passed or failed the authenticity inspection.

This type is used by the AuthenticityVerification container, which gives status on whether the order line item has passed or failed the authenticity inspection, or if the test is still pending.

This enumeration type lists the types of user authentication tokens that can be used to access/use eBay APIs.

Flag to indicate whether or not the seller wants eBay to automatically request PayPal Giving Fund donation refunds after Unpaid Item cases are opened and closed through the Unpaid Item Assistant mechanism without payment.

If true, the seller requests immediate payment for a fixed-price item or an auction item that is purchased with the 'Buy it Now' feature.

If this field is returned as true, the corresponding category supports immediate payment for listings.

Flag to indicate whether or not the seller wants eBay to automatically relist items after corresponding Unpaid Item cases are opened and closed through the Unpaid Item Assistant mechanism without payment.

This field is only returned if true, and indicates that the 'Click and Collect' feature is available for this item.

This field is deprecated.

This field is deprecated.

This type has been deprecated.

This field is deprecated.

Applicable to sites that support the Detailed Seller Ratings feature.

Applicable to sites that support the Detailed Seller Rating (DSR) feature.

Container consisting of a seller's Detailed Seller Rating (DSR) for each type of rating (Communication, Item As Described, Shipping and Handling Charges, or Shipping Time), the seller's average rating for each DSR type, the total number of DSR ratings for each DSR type, and the period in which those ratings were received (the last year or the last 30 days).

This type is used by the AverageRatingSummary container that is returned in the GetFeedback call to display the seller's rating information across the four different Detail Seller Rating areas.

This field is deprecated.

This field is deprecated.