If this field is true, the user is currently exempt from the requirement to offer at least one safe payment method (PayPal/PaisaPay or one of the credit cards specified in Item.PaymentMethods) when listing items.

Indicates whether listings in this category need to have a safe payment method.

This field is returned as an empty element (a boolean value is not returned) if one or more eBay API-enabled sites require at least one form of safe payment.

Specifies whether categories on the site require a seller to offer a safe payment method (i.e.

For the US, Canada and Australia sites, users are required to offer at least one safe payment method (i.e.

This container shows sales tax information for an item in a specific tax jurisdiction.

This field is used if sales tax is being applied to the order.

This container is used if the seller wishes to apply sales tax to the order.

The amount of sales tax calculated for an order line item based on the sale price and the sales tax rate for the buyer's tax jurisdiction.

This float value is the sales tax percentage rate applicable to the corresponding tax jurisdiction (US state or Canadian province).

This float value is the sales tax percentage rate applicable to the corresponding tax jurisdiction.

This is the unique, two-digit identifier of the tax jurisdiction (such as 'CA' for California).

This type is used to show sales tax-related details for a tax jurisdiction.

The ScheduledDeliveryTimeMin and ScheduledDeliveryTimeMax timestamps indicate the delivery window for which the buyer can expect to receive the order.

The ScheduledDeliveryTimeMin and ScheduledDeliveryTimeMax timestamps indicate the delivery window for which the buyer can expect to receive the order.

Include this container and set the ScheduledList.Include field to true to return the list of items that are scheduled to become active listings on eBay.com at a future date/time.

This container consists of the items that are scheduled to become active at a future date/time.

This field is deprecated.

Allows the user to specify a time in the future that the listing becomes active on eBay.

This field is deprecated.

This type is deprecated.

Container for scheduling limits for the user.

Contains information for scheduling limits for the user.

Keyword string to be used for search purposes.

This field is deprecated.

This type is deprecated.

Specifies whether the custom header has a search box.

This field is deprecated.

The integer in this field indicates how many searches have been performed for listings in the category (in the last 30 days) using that item specific.

This field is deprecated.

This type is deprecated.

The SearchFlag value in a My eBay Favorite Search.

This enumerated type lists the possible values that can be returned under the FavoriteSearch.SearchFlag field of a GetMyeBayBuying response.

The keywords in the item title for the automatic item search criteria.

The name of the buyer's Saved Search on My eBay.

This is the URL of the buyer's Saved Search on My eBay.

The sort order chosen from the standard ebay sorts for the automatic search criteria.

Provides information about the visibility level you have earned for your listings.

Provides information about the visibility level you've earned for your eBay listings.

The Search standing that you have earned.

This field is deprecated.

Secondary color for the Store.

The unique identifer for a secondary category.

Part of the Second Chance Offer feature, indicates whether the seller can extend a second chance offer for the item.

Indicates the user's preference to accept second chance offers.

A Second Chance Offer item.

Include this container and set the SecondChanceOffer.Include field to true to return any Second Chance Offers that the eBay user has received.

This container consists of the items on which the eBay user has received a Second Chance Offer.

The number of reminders requesting that the seller review second chance offers.

This enumerated type contains the list of values that can be used by the seller to set the length of time that a Second Chance Offer or a Transaction Confirmation Request will be available to a specific recipient to whom the Second Chance Offer or Transaction Confirmation Request was presented.

The item ID for the original listing from which a second chance offer is made.

A value associated with the token retrieval request.

The enumeration value returned in this field indicates whether a seller can specify their own custom values for an Item Specific, or if they need to use a value (or values) that eBay has defined.

This enumerated type contains the values that will indicate whether a seller can specify their own custom values for an Item Specific, or if they need to use a value (or values) that eBay has defined.

This field is deprecated.

Container for information about this listing's seller.

This container consists of detailed information about the seller and the seller's account.

Contains information about the seller whose order line items are being returned.

This container provides the seller's account status, as well as any informational alerts related to the seller's account status.

Type defining the SellerAccount container returned in the GetSellerDashboard response.

Enumerated type that contains the different states of a seller's account.

Type of seller account.

The SellerBusinessType value in a My eBay Favorite Search.

Type of seller account.

Type of seller account.

This field is no longer applicable as Shopping.com listings are no longer created or managed with eBay APIs.

This container is used by sellers of Classified Ad listings to provide contact information.

Indicates whether this category supports seller-level contact information for 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 allow the seller to provide contact information at listing time for a classified ad listing.

Specifies the default site setting for whether most categories allow seller- level contact information for Classified Ad listings.

Defines the SellerContactDetailsEnabled feature.

Alerts can be either informational or a warning that identifies a problem.

A message to help the you understand your status as a seller (PowerSeller status, policy compliance status, etc.).

A container consisting of name and ID of the seller's discount campaign, as well as the discount amount that is being applied to the order line item.

A container consisting of name and ID of the seller's discount campaign, as well as the discount amount that is being applied to the order line item.

Type defining the SellerDiscounts container, which consists of one or more SellerDiscount nodes, as well as the original purchase price and shipping cost of the order line item.

Type that defines the SellerDiscount container, which contains the ID, name, and amount of the seller discount.

This field is no longer used.

This type is deprecated.

This field is deprecated.

This field is no longer used.

This field is deprecated.

This enumerated type is deprecated.

This is a unique identifier for the seller that does not change when the eBay user name is changed.

The email address of the seller involved in the order.

Container consisting of a list of the seller's excluded shipping locations.

Type used by the SellerExcludeShipToLocationPreferences container which is returned in the GetUserPreferences response to indicate which geographical regions and/or individual countries the seller has added as excluded ship-to locations.

Sellers can set up a global Exclude Ship-To List through their My eBay account.

This field is deprecated.

This field is deprecated.

Container consisting of the seller's preferences for displaying items on a buyer's Favorite Sellers' Items page or Favorite Sellers' Items digest.

This container is included if the seller wishes to set preferences for displaying items on a buyer's Favorite Sellers' Items page or Favorite Sellers' Items digest.

Contains the data for the seller favorite item preferences, i.e. the manual or automatic selection criteria to display items for buyer's favourite seller opt in email marketing.

This container provides the percentage discount that the seller is eligible to receive on the Final Value Fee for each order line item.

PowerSeller discount information (e.g., to show in a Seller Dashboard).

This field is deprecated.

This field is deprecated.

This type was deprecated along with the Seller Guarantee feature.

This field is deprecated.

The SellerID value in a My eBay Favorite Search.

The eBay user ID of the seller to retrieve ASQ subjects for.

The eBay ID of the seller who listed the item.

The SellerIDExclude value in a My eBay Favorite Search.

Contains information about a seller, including listing settings, listing preferences, seller rankings, and seller type.

This field was previously only used to identify and end Half.com listings, and since the Half.com site has been shut down, this element is no longer applicable.

This field was previously only used to identify and end Half.com listings, and since the Half.com site has been shut down, this element is no longer applicable.

Container for detailed seller ratings (DSRs).

The user's eBay PowerSeller tier.

Indicates the user's eBay PowerSeller tier.

DO NOT USE THIS FIELD.

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

This optional field is used to provide a message to the recipient of the Second Chance Offer.

Message content.

Specifies the paid status of the order.

Specifies the address the seller uses to receive mailed payments from buyers.

Address used by eBay for purposes of billing the user for seller fees.

This field is deprecated.

This enumerated type defines the payment methods that an eBay user can use to pay fees on monthly eBay invoice.

Container consisting of the seller's payment preferences.

This container is included if the seller wishes to set various payment preferences.

Type defining the SellerPaymentPreferences container, which consists of the seller's payment preferences.

The SellerPaymentProfile container is used in an Add/Revise/Relist/Verify Trading API call to reference and use the settings/values of a payment business policy.

Type defining the SellerPaymentProfile container, which is used in an Add/Revise/Relist/Verify Trading API call to reference and use a payment business policy.

This enumerated type is deprecated.

Boolean flag indicating whether or not a seller has opted in to Business Policies.

Parent response container consisting of high-level information for all Business Policies defined for the user's account.

Type defining the SellerProfilePreferences container.

This container is used if the seller would like to use/reference business policies to create, revise, relist, or verify their listing.

Type defining the SellerProfiles container, which consists of references to a seller's payment, shipping, and return policy profiles.

A descriptive free-text title for a US or CA eBay Motors vehicle listing.

This field is returned as true if the corresponding category supports the use of a seller-provided title for a motor vehicle listing on the US or Canada Motors marketplaces.

This field is returned as an empty element (a boolean value is not returned) if one or more eBay API-enabled sites support seller-provided titles in motor vehicle listings.

After EOL Attributes, Seller Provided Title will no longer be supported as primary attributes, rather consumers should use new tag.

If present, the site defines category settings for whether the seller can provide their own title for a US or CA eBay Motors listing.

Container for information about detailed seller ratings (DSRs) that buyers have left for a seller.

Type defining the SellerRatingSummaryArray container that is returned in the GetFeedback response.

This optional text field allows the seller to provide more details to the buyer about the action being taken against the buyer's Best Offer.

Container consisting of the OptedIn flag that indicates whether or not the seller has opted in to eBay Managed Returns.

Type defining the SellerReturnPreferences container, which consists of the OptedIn flag that indicates whether or not the seller has opted in to eBay Managed Returns.

The SellerReturnProfile container is used in an Add/Revise/Relist/Verify Trading API call to reference and use the settings/values of a return policy business policy.

Type defining the SellerReturnProfile container, which is used in an Add/Revise/Relist/Verify Trading API call to reference a return policy business policy.

Enables a seller to "reverse" an Unpaid Item dispute that has been closed in case the buyer and seller are able to reach a mutual agreement.

Enables a seller to "reverse" an Unpaid Item dispute that has been closed in case the buyer and seller are able to reach a mutual agreement.

 

Enables a seller to "reverse" an Unpaid Item dispute that has been closed in case the buyer and seller are able to reach a mutual agreement.

 

Enables a seller to "reverse" an Unpaid Item dispute that has been closed in case the buyer and seller are able to reach a mutual agreement.

 

The response of a SellerReverseDispute call only includes the standard response fields for Trading API calls, such as the Ack field (to indicate the success or failure of the call), the timestamp, and an Errors container (if there were any errors and/or warnings).

 

The response of a SellerReverseDispute call only includes the standard response fields for Trading API calls, such as the Ack field (to indicate the success or failure of the call), the timestamp, and an Errors container (if there were any errors and/or warnings).

Container for information about 1 year feedback metric as seller.

Specifies 1 year feedback metrics for a seller.

Contains information about the domestic leg of a Global Shipping Programn shipment, including the seller-selected shipping service, the domestic shipping cost, the domestic address of the international shipping provider, and the estimated shipping time range.

The SellerShippingProfile container is used in an Add/Revise/Relist/Verify Trading API call to reference and use the settings/values of a specific shipping business policy.

Type defining the SellerShippingProfile container, which is used in an Add/Revise/Relist Trading API call to reference a shipping business policy.

This field is deprecated along with third-party checkout.

This field is no longer applicable, as third-party checkout on eBay is no longer possible.

This field is deprecated.

This field is deprecated.

Information about a user returned in the context of an item's seller.

The eBay user ID of the seller involved in the dispute.

This is the eBay user ID of the order's seller.

This field is returned if the seller of the item is currently on vacation and that seller has turned on the Store vacation setting, and has included a message to display to shoppers who visit the eBay store.

This container consists of Selling Manager product details and is only returned if the item was listed through Selling Manager Pro.

Returned if the user is a Selling Manager user.

The sale record ID.

This container should be included if the user wishes to retrieve the counts of My eBay Selling Reminders.

This container is returned if the user included the SellingReminders container in the call request and set the SellingReminders.Include value to true.

Various details about the current status of the listing, such as the current number of bids, the current high bidder, quantity sold, current price, and listing status.

Contains the variation's quantity sold.

This container indicates the current bidding/purchase state of the order line item regarding the offer extended using PlaceOffer.

Contains various details about the current status of a listing.

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

This container consists of seller activity counts and values.

Contains summary information about the items the seller is selling.

This field is deprecated.

This container consists of the name and email of the person who purchased the digital gift card.

Display name of the eBay user that sent the message.

SenderEmail contains the static email address of an eBay member, used within the "reply to" email address when the eBay member sends a message.

The eBay user ID of the person who asked the question or sent the message.

An eBay ID that uniquely identifies a user.

Enables a seller to send an order invoice to a buyer.

Enables a seller to send an order invoice to a buyer.

 

Enables a seller to send an order invoice to a buyer.

 

Enables a seller to send an order invoice to a buyer.

 

The response of a SendInvoice call only includes the standard response fields for Trading API calls, such as the Ack field (to indicate the success or failure of the call), the timestamp, and an Errors container (if there were any errors and/or warnings).

 

The response of a SendInvoice call only includes the standard response fields for Trading API calls, such as the Ack field (to indicate the success or failure of the call), the timestamp, and an Errors container (if there were any errors and/or warnings).

Displayable name of the user or eBay application to which the message is sent.

The shipping cost types that this shipping service option supports, such as flat-rate or calculated.

A string obtained by making a GetSessionID call, passed in redirect URL to the eBay signin page.

A value associated with the token retrieval request. eBay generates the session ID when the application makes a GetSessionID request.

A 40-character identifier supplied by eBay to an application.

Enables a seller to add custom Ask Seller a Question (ASQ) subjects to their Ask a Question page, or to reset any custom subjects to their default values.

Enables a seller to add custom Ask Seller a Question (ASQ) subjects to their Ask a Question page, or to reset any custom subjects to their default values.

 

Enables a seller to add custom Ask Seller a Question (ASQ) subjects to their Ask a Question page, or to reset any custom subjects to their default values.

 

Enables a seller to add custom Ask Seller a Question (ASQ) subjects to their Ask a Question page, or to reset any custom subjects to their default values.

 

The response of a SetMessagePreferences call only includes the standard response fields for Trading API calls, such as the Ack field (to indicate the success or failure of the call), the timestamp, and an Errors container (if there were any errors and/or warnings).

 

The response of a SetMessagePreferences call only includes the standard response fields for Trading API calls, such as the Ack field (to indicate the success or failure of the call), the timestamp, and an Errors container (if there were any errors and/or warnings).

Manages notification and alert preferences for applications and users.

Manages notification and alert preferences for applications and users.

 

Manages notification and alert preferences for applications and users.

 

Manages notification and alert preferences for applications and users.

 

The response of a SetNotificationPreferences call only includes the standard response fields for Trading API calls, such as the Ack field (to indicate the success or failure of the call), the timestamp, and an Errors container (if there were any errors and/or warnings).

 

The response of a SetNotificationPreferences call only includes the standard response fields for Trading API calls, such as the Ack field (to indicate the success or failure of the call), the timestamp, and an Errors container (if there were any errors and/or warnings).

This call enables a seller to create and manage shipping discounts rules.

This call enables a seller to create and manage shipping discounts rules.

 

This call enables a seller to create and manage shipping discounts rules.

 

This call enables a seller to create and manage shipping discounts rules.

 

The response of a SetShippingDiscountProfiles call only includes the standard response fields for Trading API calls, such as the Ack field (to indicate the success or failure of the call), the timestamp, and an Errors container (if there were any errors and/or warnings).

 

The response of a SetShippingDiscountProfiles call only includes the standard response fields for Trading API calls, such as the Ack field (to indicate the success or failure of the call), the timestamp, and an Errors container (if there were any errors and/or warnings).

This call is used to set/modify the configuration of a seller's eBay Store.

This call is used to set/modify the configuration of a seller's eBay Store.

This call allows you to set or modify the category structure of an eBay Store.

This call allows you to set or modify the category structure of an eBay Store.

 

This call allows you to set or modify the category structure of an eBay Store.

 

This call allows you to set or modify the category structure of an eBay Store.

 

Base response of the SetStoreCategories call.

 

Base response of the SetStoreCategories call.

Creates or updates a custom page on a user's eBay Store.

Creates or updates a custom page on a user's eBay Store.

 

Creates or updates a custom page on a user's eBay Store.

 

Creates or updates a custom page on a user's eBay Store.

 

The base response for the SetStoreCustomPage call.

 

The base response for the SetStoreCustomPage call.

Sets the preferences for a user's eBay Store.

Sets the preferences for a user's eBay Store.

 

Sets the preferences for a user's eBay Store.

 

Sets the preferences for a user's eBay Store.

 

The base response for the SetStorePreferences call.

 

The base response for the SetStorePreferences call.

 

This call is used to set/modify the configuration of a seller's eBay Store.

 

This call is used to set/modify the configuration of a seller's eBay Store.

 

The response of a SetStore call only includes the standard response fields for Trading API calls, such as the Ack field (to indicate the success or failure of the call), the timestamp, and an Errors container (if there were any errors and/or warnings).

 

The response of a SetStore call only includes the standard response fields for Trading API calls, such as the Ack field (to indicate the success or failure of the call), the timestamp, and an Errors container (if there were any errors and/or warnings).

This call allows you to add or modify sales tax rates for one or more tax jurisdictions within the specified site.

This call allows you to add or modify sales tax rates for one or more tax jurisdictions within the specified site.

 

This call allows you to add or modify sales tax rates for one or more tax jurisdictions within the specified site.

 

This call allows you to add or modify sales tax rates for one or more tax jurisdictions within the specified site.

 

The response of a SetTaxTable call only includes the standard response fields for Trading API calls, such as the Ack field (to indicate the success or failure of the call), the timestamp, and an Errors container (if there were any errors and/or warnings).

 

The response of a SetTaxTable call only includes the standard response fields for Trading API calls, such as the Ack field (to indicate the success or failure of the call), the timestamp, and an Errors container (if there were any errors and/or warnings).

Enables users to add, modify, or delete a pinned note for any item that is being tracked in the My eBay All Selling and All Buying areas.

Enables users to add, modify, or delete a pinned note for any item that is being tracked in the My eBay All Selling and All Buying areas.

Specifies the action to take for an item's My eBay notes.

 

Enables users to add, modify, or delete a pinned note for any item that is being tracked in the My eBay All Selling and All Buying areas.

 

Enables users to add, modify, or delete a pinned note for any item that is being tracked in the My eBay All Selling and All Buying areas.

 

The response of a SetUserNotes call only includes the standard response fields for Trading API calls, such as the Ack field (to indicate the success or failure of the call), the timestamp, and an Errors container (if there were any errors and/or warnings).

 

The response of a SetUserNotes call only includes the standard response fields for Trading API calls, such as the Ack field (to indicate the success or failure of the call), the timestamp, and an Errors container (if there were any errors and/or warnings).

This call allows an eBay user to set/modify numerous seller account preferences.

This call allows an eBay user to set/modify numerous seller account preferences.

 

This call allows an eBay user to set/modify numerous seller account preferences.

 

This call allows an eBay user to set/modify numerous seller account preferences.

 

The response of a SetUserPreferences call only includes the standard response fields for Trading API calls, such as the Ack field (to indicate the success or failure of the call), the timestamp, and an Errors container (if there were any errors and/or warnings).

 

The response of a SetUserPreferences call only includes the standard response fields for Trading API calls, such as the Ack field (to indicate the success or failure of the call), the timestamp, and an Errors container (if there were any errors and/or warnings).

Indicates whether the error is a severe error (causing the request to fail) or an informational error (a warning).

The severity level helps you understand whether the alert is identifying a problem (a warning or strong warning) or if it is informational in nature.

Indicates whether the error is a severe error (causing the request to fail) or an informational error (a warning) that should be communicated to the user.

SeverityCodeType - Type declaration to be used by other schema.

The address from which the item is being shipped.

This field is deprecated.

Container consisting of shipment tracking information, shipped time, and an optional text field to provide additional details to the buyer.

Status of the delivery.

 

Contains information about one or more order line items in a Global Shipping Program package.

This type provides information about one or more order line items in a Global Shipping Program package.

 

Container for the shipping carrier and tracking information associated with the shipment of an order.

Container consisting of the tracking number and shipping carrier associated with the shipment of one item (package).

This type details the shipping carrier and shipment tracking number associated with a package shipment.

The tracking number assigned by the shipping carrier to the item shipment.

This field is deprecated.

The tracking number associated with one package of a shipment.

Type defining the Shipment container, which is used by the seller in CompleteSale to provide shipping information.

Details pertinent to one or more items for which calculated shipping (or flat rate shipping using shipping rate tables with weight surcharges) has been offered by the seller, such as package dimension and weight and packaging/handling costs.

The seller includes and sets this field to true if the order or order line item has been shipped.

Timestamp indicating the date and time of order shipment.

Indicates the time when the line item was marked as 'Shipped'.

The date and time that the seller handed off the package(s) to the shipping carrier.

This container shows the shipping address for the order.

Contains the shipping address of a bidder who has made a Best Offer for an item.

This container shows the buyer's shipping address.

For internal use only.

The address to which the item is to be shipped.

The code for the shipping carrier.

The enumeration value for the shipping carrier associated with the shipping service option.

Identifies a shipping carrier used to ship an order, and the countries served by that carrier.

Lists the shipping carriers supported by the specified site.

Details about type of Carrier used to ship an item.

Numeric identifier.

The name of the shipping carrier used to ship the item.

The shipping carrier used to ship the item in dispute.

This field is deprecated.

Indicates the shipping category.

Indicates the shipping category.

A shipping service category supported for the site.

This type defines the ShippingCategoryDetails container.

This is shipping cost X when DiscountName is either ShippingCostXForAmountY or ShippingCostXForItemCountN, and is the maximum cost when DiscountName is MaximumShippingCostPerOrder.

This field is used to show the cost of shipping being applied to the order.

This container consists of the enumeration values that can be passed into the ReturnPolicy.ShippingCostPaidByOption or ReturnPolicy.InternationalShippingCostPaidByOption field when using an Add/Revise/Relist API call.

This is a display string that buyer applications can use to present ShippingCostPaidByOption in a more user-friendly format to buyers.

This type defines the ShippingCostPaidBy container that is returned in GeteBayDetails if ReturnPolicyDetails is set as a DetailName value (or if no value is included in the request).

This option specifies whether the buyer or the seller pays for return shipping charges.

The party who pays the shipping cost for a returned item.

This enumerated type contains the values that specify the party (seller/buyer) who will be responsible for paying the return shipping cost if an item is returned.

The shipping-related details for an order, including flat and calculated shipping costs.

Container consisting of order-level shipping details.

Container consisting of shipping-related details for a sales transaction.

This container will be returned if at least one domestic or international shipping service option is available for the item.

The number of reminders requesting the seller to provide shipping details

Type defining the ShippingDetails container, which contains the shipping-related details for an order line item (pre-checkout) or order (post-checkout).

This field is deprecated.

The dollar amount of the shipping discount applied to the order line item.

On input, this is the ID of the shipping discount to offer for the domestic shipping services (where the shipping discount is either of type FlatShippingDiscount or CalculatedShippingDiscount).

This type is not currently in use.

 

Miscellaneous details of the shipment.

This field is included in an Add/Revise/Relist/Verify call and set to true if the seller wants sales tax for the jurisdiction to apply to the cumulative amount of item cost and shipping charges.

This field is included in a SetTaxTable call and set to true if the seller wants sales tax for the jurisdiction to apply to the cumulative amount of item cost and shipping charges.

This field is included and set to true if sales tax for the order is applied against shipping costs (in addition to the item cost).

This container is deprecated.

This field is no longer applicable as it is not longer possible for a seller to offer a buyer shipping insurance.

This field is no longer applicable as it is not longer possible for a seller to offer a buyer shipping insurance.

This field is no longer applicable as it is not longer possible for a seller to offer a buyer shipping insurance.

This field is no longer applicable as it is not longer possible for a seller to offer a buyer shipping insurance.

This type is deprecated, as Shipping Insurance can no longer be offered by the seller to the buyer in the APIs. orders.

Whether a package is irregular and therefore cannot go through the stamping machine at the shipping service office and thus requires special or fragile handling.

Short name or abbreviation for a region (e.g., Asia) or location (e.g.

Lists the worldwide regions that can be set as shipping locations from the specified eBay site.

Details about a region or location to which the seller is willing to ship.

The number of reminders advising the seller that shipping is needed.

This field is reserved for internal or future use.

This type is reserved for internal or future use.

The size of the package used to ship the item(s).

The nature of the package used to ship the item(s).

A supported value for the site that can be used in the Item.ShippingPackageDetails.ShippingPackage or Item.ShippingDetails.CalculatedShippingRate.ShippingPackage fields of an Add/Revise/Relist API call.

The shipping packages that can be used for this shipping service option.

The nature of the package used to ship the item(s).

Container consisting of dimension and size details related to a shipping package in which an item will be sent.

Lists the various shipping packages supported by the specified site.

Details about type of package used to ship an item.

This container is no longer applicable, and it was only applicable to eBay Now and 'eBay On Demand Delivery' orders, and neither of these features are available any longer.

Type defining the ShippingPackageInfoType container, which is returned in order management calls.

Indicates the Business Policies category group that may be used for Shipping profiles.

This field is returned as an empty element (a boolean value is not returned) if one or more eBay API-enabled sites support the use of category groups in shipping business policies.

Specifies what categories the Shipping profile is applicable to.

The unique identifier of a shipping business policy.

The name of a shipping business policy.

For most applicable calls, returns the words No Error or returns an error message related to an attempt to calculate shipping rates.

A shipping rate scale for shipping through USPS that affects the shipping cost calculated for USPS (lower if ShippingRateType is DailyPickup).

A shipping rate scale for shipping through UPS that affects the shipping cost calculated for UPS (lower if ShippingRateType is DailyPickup).

Regions to which the seller is willing to ship the item.

An international shipping service being offered by the seller to ship an item to a buyer.

This enumeration value indicates a specific domestic shipping service option being offered by the seller to ship an item to a buyer who is located within the same country as the item.

The shipping service selected by the buyer from among the shipping services offered by the seller (such as UPS Ground).

The shipping service specified for the domestic leg of a Global Shipping Program shipment.

The name of shipping service option.

The cost of shipping each additional item if the same buyer purchases multiple quantity of the same line item.

The cost of shipping each additional item if the same buyer purchases multiple quantity of the same line item.

This dollar value indicates the cost to ship each additional identical item to the buyer.

For future use.

A shipping service used to ship an item.

The base cost of shipping the item using the shipping service specified in the ShippingService field.

The base cost of shipping one unit of the item using the shipping service specified in the corresponding ShippingService field.

This dollar value indicates the shipping service cost to ship one item to the buyer.

A ShippingServiceCostOverride container is required for each domestic and/or international shipping service option, defined in the domesticShippingPolicyInfoService and intlShippingPolicyInfoService containers of the Business Policies shipping profile, that the seller wishes to override the shipping costs.

This container is used when the seller wants to override the flat shipping costs for all domestic and/or all international shipping services defined in the shipping business policy referenced in the SellerProfiles.SellerShippingProfile.ShippingProfileID field.

This field is reserved for internal or future use.

Type defining the ShippingServiceCostOverrideList container, which is used when the seller wants to override flat-rate shipping costs for one or more domestic and/or international shipping service options defined in the Business Policies shipping profile referenced in the SellerProfiles.SellerShippingProfile.ShippingProfileID field of an Add/Revise/Relist call.

Type defining the ShippingServiceCostOverride container, which is used to override the flat shipping costs for a domestic and/or international shipping service option that is defined in the domesticShippingPolicyInfoService and intlShippingPolicyInfoService containers of the Business Policies shipping profile.

The last time of day that an order using the specified shipping service will be accepted by the seller.

The last time of day that an order using the specified shipping service will be accepted by the seller for the current listing.

Contains information about the shipping service and cost of the domestic leg of a Global Shipping Program shipment.

Lists the shipping services supported by the specified eBay site.

Type used by the ShippingServiceDetails containers that are returned in the GeteBayDetails response.

Numeric identifier.

This container is used to provide details on a specific domestic shipping service option, including the unique identifier of the shipping service option and the costs related to domestic shipping service.

If the buyer has a domestic shipping address, use this container to offer up to four domestic shipping services.

Container consisting of shipping costs and other details related to a domestic shipping service.

Shipping Package level details for the enclosing shipping service, this complex type replaces the existing ShippingPackage type.

Packages supported by the enclosing shipping service.

This integer value controls the order (relative to other shipping services) in which the corresponding ShippingService will appear in the View Item and Checkout page.

Controls the order (relative to other shipping services) in which the corresponding ShippingService will appear in the View Item and Checkout page.

This integer value maps the particular instance of the ShippingServiceCostOverride container to the domesticShippingPolicyInfoService or intlShippingPolicyInfoService container of the Business Policies shipping profile.

Container consisting of details about the domestic or international shipping service selected by the buyer for delivery of the order.

The shipping service actually selected by the buyer from the shipping services offered by the seller.

This enumerated value indicates whether the shipping costs of a domestic or an international shipping costs are being overridden.

This enumerated type defines the possible values that can be used in the ShippingServiceType field of the ShippingServiceCostOverride container.

The shipping service actually used by the seller to ship the item(s) to the buyer.

The size of the package used to ship the item(s).

If the field is present, the corresponding feature applies to the category.

Indicates whether the category requires sellers to specify shipping details at listing time.

This field is returned as an empty element (a boolean value is not returned) if one or more eBay API-enabled sites require shipping terms at listing time, whiche includesat least one domestic shipping service option and its associated costs.

Specifies the default site setting for whether sellers are required to specify a domestic shipping service and its associated cost when listing items.

This timestamp indicates the date and time when the item under dispute was shipped.

The integer value returned here indicates the maximum number of business days that the corresponding shipping service (indicated in ShippingServiceDetails.ShippingService field) will take to be delivered to eBay's domestic shipping partner.

The integer value returned here indicates the maximum number of business days that the shipping service (indicated in the corresponding ShippingService field) will take to be delivered to the buyer.

The integer value returned here indicates the maximum number of business days that the shipping carrier (indicated in the corresponding ShippingCarrier field) will take to ship an item using the corresponding shipping service option (indicated in the ShippingService field).

The integer value returned here indicates the minimum number of business days that the corresponding shipping service (indicated in ShippingServiceDetails.ShippingService field) will take to be delivered to eBay's domestic shipping partner.

The integer value returned here indicates the minimum number of business days that the shipping service (indicated in the corresponding ShippingService field) will take to be delivered to the buyer.

The integer value returned here indicates the minimum number of business days that the shipping carrier (indicated in the corresponding ShippingCarrier field) will take to ship an item using the corresponding shipping service option (indicated in the ShippingService field).

This enumeration value indicates whether or not the order has been picked up from the store indicated by the StoreID value.

This type is no longer applicable as it only pertained to eBay Now orders, and eBay Now has been discontinued.

The shipping cost model offered by the seller.

The shipping cost model offered by the seller.

Contains shipping address information for the domestic leg of a Global Shipping Program shipment.

An international location or region to where the item seller will ship the item.

An international location or region to which the seller is willing to ship, regardless of shipping service.

The seller includes and sets this field to true as a mechanism to block bidders who reside (according to their eBay primary shipping address) in countries that are on the ship-to exclusion list.

A true value returned in this field indicates that the ShipToRegistrationCountry Buyer Requirement is supported for the specified site.

A brief description of the condition that raised the error.

This field is deprecated.

Seller-provided description of a Business Policies profile.

If included and set to true, the seller's preference for receiving contact information for unsuccessful bidders is returned in the response.

If included and set to true, the seller's combined invoice preferences are returned in the response.

This field is deprecated.

If included and set to true, the seller's same-day handling cutoff time is returned in DispatchCutoffTimePreference.CutoffTime.

To determine whether a seller can offer eBay Plus in qualified listings, include this field and set it to true.

If included and set to true, the seller's preference for sending an email to the buyer with the shipping tracking number is returned in the response.

If included and set to true, the seller's preferences for the end-of-auction email sent to the winning bidder is returned in the response.

If included and set to true, the GlobalShippingProgramListingPreference field is returned.

If this flag is included and set to true, the seller's preference for offering the Global Shipping Program to international buyers will be returned in OfferGlobalShippingProgramPreference.

This field must be used with the DisplayNameInCheckout field to control the options that are visible to a buyer during checkout.

If included and set to true, the seller's preferences related to the Out-of-Stock feature will be returned.

If included and set to true, the OverrideGSPServiceWithIntlServicePreference field is returned.

If included and set to true, the PickupDropoffSellerPreference field is returned.

This field is deprecated.

If included and set to true, the seller's preference for sending a purchase reminder email to buyers is returned in the response.

If included and set to true, the seller's preference for requiring that the buyer supply a shipping phone number upon checkout is returned in the response.

If included and set to true, all of the seller's excluded shipping locations are returned in the response.

If included and set to true, the seller's favorite item preferences are returned in the response.

If included and set to true, the seller's payment preferences are returned in the response.

If this flag is included and set to true, the seller's Business Policies profile information is returned in the response.

If this flag is included and set to true, the SellerReturnPreferences container is returned in the response and indicates whether or not the seller has opted in to eBay Managed Returns.

If included and set to true, the list of eBay user IDs on the Unpaid Item Assistant Excluded User list is returned through the UnpaidItemAssistancePreferences.ExcludedUser field in the response.

If included and set to true, the seller's Unpaid Item Assistant preferences are returned in the response.

This field is deprecated.

This type is deprecated.

Specifies whether the custom header has a link to Sign up for Store Newsletter.

This enumerated type defines the sort values that can be used in the FavoriteSearch.ItemSort filter in a GetMyeBayBuying request.

The name of the eBay listing site.

eBay site the user is registered with.

The eBay site(s) on which the seller's performance is being evaluated.

This enumeration value indicates the eBay site for which the seller is enrolled in a membership program.

A unique identifier for an eBay site.

Short name that identifies an eBay site.

This field is deprecated.

This enumeration value indicates the eBay site for which reason code details are returned.

This field is deprecated.

Type defining the BuyerRequirementDetails container, which is returned in GeteBayDetails, and provides the seller with the buyer requirement features (and applicable values) that are supported by the listing site.

eBay sites (by the country in which each resides) on which a user is registered and on which items can be listed through the Trading API.

Unique ID identifying the currency in which the localized offer amounts are expressed.

Returns the feature settings defined for most categories on the site.

A container for feature definitions that apply to the entire site.

Lists all available eBay sites and their associated SiteID numbers.

Details about a specific site.

The information about an UploadSiteHostedPictures upload, including the URL of the uploaded picture.

Type defining the SiteHostedPictureDetails container that is returned in an UploadSiteHostedPictures call.

The unique identifier of the eBay site on which the item is listed.

Specifies the criteria for filtering search results by site, where site is determined by the site ID in the SOAP URL or, for Unified Schema XML requests, X-EBAY-API-SITEID HTTP Header.

 

Numeric identifier for an eBay site.

Site criteria for filtering search results.

Contains the data that defines a site-based filter (used when searching for items and filtering the search result set).

This field is deprecated.

This type is deprecated.

This field is deprecated.

This value is the seller-defined SKU value of the item being revised.

A SKU (stock keeping unit) is a unique identifier defined and used by the seller to identify a product or variation of an item.

A SKU (Stock Keeping Unit) value is a seller-defined identifier for a product.

A SKU (stock keeping unit) is an identifier defined by a seller.

A SKU (stock keeping unit) is a seller-defined identifier.

The SKU value for an item is returned if the seller specified a SKU value through the Item.SKU field in the request.

The seller-defined SKU (stock keeping unit) value of the item in the listing being ended.

If a SKU (stock-keeping unit) exists for the item in the listing, it is returned in the response.

Retrieves an item that was listed by the user identified in AuthToken and that is being tracked by this SKU.

The seller-defined SKU value for the new listing (if a SKU value exists for the item).

The seller-defined SKU value for the revised listing (if a SKU value exists for the item).

The seller's unique identifier for an item that is being tracked by this SKU.

SKU value of the item variation to which the My eBay note will be attached.

Item-level SKU for the new listing, if the seller specified tem.SKU in the request.

This container can be used to specify one or multiple SKUs, and only listings associated with these SKUs are retrieved.

This container is used to search for order line items generated from one or more product SKU values.

A list of stock-keeping unit (SKU) identifiers that a seller uses in listings.

Primitive type that represents a stock-keeping unit (SKU).

This type is no longer applicable as member communication through Skype has been disabled in API calls.

This field is deprecated.

This field is deprecated.

This field is deprecated.

This feature is no longer applicable.

This type is no longer applicable as member communication through Skype has been disabled in API calls.

This field is deprecated.

This field is deprecated.

This feature is no longer applicable.

This type is no longer applicable as member communication through Skype has been disabled in API calls.

The wireless phone number to be used for receiving SMS messages.

User data related to SMS notifications.

Type of SMS subscription error.

User data related to notifications.

The current state of user SMS subscription.

The account ID/handle associated with the nonprofit charity organization's social networking site.

Enumeration value that indicates the social networking site that the nonprofit charity organization is associated with.

Enumerated type that defines the social networking sites that are supported by PayPal Giving Fund.

If this flag appears in the GetItem response, the auction has ended due to the item being sold to a seller using the Buy It Now option.

The average duration, in days, of all items sold.

The average duration, in days, of all items sold.

Include this container and set the SoldList.Include field to true to return the list of sold order line items.

This container consists of order line items that have been sold.

Used by the eBay UK and eBay Germany (DE) sites, this flag indicates that the discount price (specified as StartPrice) is the price for which the seller offered the same (or similar) item for sale on a Web site or offline store other than eBay in the previous 30 days.

Used by the eBay UK and eBay Germany (DE) sites, this flag indicates that the discount price (specified as StartPrice) is the price for which the seller offered the same (or similar) item for sale on eBay within the previous 30 days.

Specifies the sort order of the result.

Specifies the sort order of the result.

This field allows the user to control how the order line items are returned in the response.

This field can be used to control the order in which returned listings are sorted (based on the listings' actual/scheduled end dates).

This field is deprecated.

This field is deprecated.

This filter controls whether orders are retrieved in ascending order (oldest to newest according to modification date) or descending order (newest to oldest according to modification date).

This field is deprecated.

The SortOrder value works in conjunction with the ItemSort value, and indicates whether Saved Search results are returned in ascending (low to high values) or descending (high to low values) order.

This type specifies the sort order of a returned array of elements.

This field is not currently returned in GetCategorySpecifics for any Item Specific.

This enumerated value indicates 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.

This container is only returned if the corresponding category supports a special item condition such as Certified Refurbished condition (Condition ID 2000).

This container shows the site default special item condition values, such as Certified Refurbished condition (Condition ID 2000).

The value in this field indicates whether the category supports Motors Local Market listings if the seller has a Specialty vehicle subscription.

This field is deprecated.

Specifies the default site setting for whether LocalMarketSpecialitySubscription feature is supported for most categories.

Indicates category support for listing of Local Market items by sellers subscribed to Local Market for Specialty Vehicles.

Display name of a time zone in its standard (non-daylight saving) time representation.

The offset in hours from GMT for a time zone when it is not adjusted for daylight saving time.

Used with EndCreationTime to limit the returned leads for a user to only those with a creation date greater than or equal to the specified date and time.

Used as beginning of date range filter.

The index of the first dispute in the current result set, relative to the total number of disputes available.

The original price of the item at listing or re-listing time.

The fixed price for this item variation.

For auction listings, the StartPrice indicates the lowest dollar value that can be set for the item's Starting bid.

Starting date and time for the new listing.

Starting date and time for the new listing.

Starting date and time for the new listing.

This timestamp indicates the date and time when the Second Chance Offer became available to the recipient.

This timestamp indicates the date and time when the Transaction Confirmation Item became available to the recipient.

The beginning of the date-range filter.

Specifies the start date and time for which notification information will be retrieved.

Returns the start date and time for the notification information that is returned by this call.

The StartTime value returned by non-search calls such as GetItem is the time stamp (in GMT) for when the item was listed.

Start time of a discount for an item whose price a seller has reduced with the Promotional Price Display feature.

This timestamp indicates the date and time when the relisted item became active on the eBay site.

This timestamp indicates the date and time when the relisted item became active on the eBay site.

This timestamp indicates the date and time when the listing was created on the eBay site.

This timestamp indicates the date and time when the listing was created on the eBay site.

Indicates the date and time when the the new Second Chance Offer listing became active and the recipient user could purchase the item.

This timestamp indicates the date and time when the item to be relisted became active on the eBay site.

This field is deprecated.

Describes the earliest (oldest) time to use in a time range filter based on item start time.

Specifies the earliest (oldest) date to use in a date range filter based on item start time.

Describes the latest (most recent) date to use in a time range filter based on item start time.

Specifies the latest (most recent) date to use in a date range filter based on item start time.

The state in which a nonprofit charity organization is located.

The state or province associated with an address on file with eBay.

Contains the static email address of an eBay member, used within the "reply to" email address when the eBay member sends a message.

The status of the Best Offer or counter offer.

 

This value indicates the status of the eBay custom page.

Container consisting of checkout/payment status details for an order line item.

Indicates the user's registration/user status.

The enumeration value in this field will indicate whether or not the seller has responded to the lead.

The value in this field indicates whether the order line item has passed or failed the authenticity inspection, or if the test and/or results are still pending.

This field indicates the seller's buyer satisfaction rating.

This enumeration value indicates whether or not the nonprofit organization is a valid eBay for Charity organization, and is able to receive proceeds from eBay sales.

This enumeration value indicates whether or not the nonprofit organization is a valid eBay for Charity organization, and is able to receive proceeds from eBay sales.

Indicates the status of the order.

The status of a notification delivery URL.

This enumeration value indicates the status of the previous call that used the InvocationID or InvocationTrackingID specified in the DuplicateInvocationID.

Filters the leads based on their status.

The enumeration value indicates the status of an update to the eBay Store Category hierarchy.

This field indicates the seller's performance rating.

This field is deprecated.

This field is deprecated.

Indicates the status of the Region of Origin value.

Your earned search standing status.

This field indicates the status of your seller's account.

When an eBay Store category structure change is processed synchronously, the status is returned as 'Complete' or 'Failed'.

Status, for revise only

Current token status.

This field indicates the status of the Unpaid Item case.

This type is no longer used and was replaced by ShippingLocationDetails.

Fully qualified URL for a stock image (if any) that is associated with the eBay catalog product.

This field is deprecated.

The full URL for the eBay catalog product's stock photo.

This field is deprecated.

This field is deprecated.

This field is deprecated.

This container consists of detailed information on the seller's eBay Store.

This container is used to set/modify the configuration of a seller's eBay Store.

Specifies the store categories on which to act.

Unique identifier for the secondary custom category in which to list the item.

Name of the secondary custom category in which to list the item.

(For eBay Store owners only) The store custom category for the automatic item search criteria.

Unique identifier of a primary custom category in which to list the item.

Category name of a primary custom category in which to list the item.

Specifies the type of action to carry out with SetStoreCategories.

Set of eBay Store color schemes.

Store color scheme.

Store color set.

Set of custom categories for the Store.

Configuration of a store custom category.

Specifies whether the Store has a custom header.

Specifies how the custom listing header will be displayed.

Specifies the type of link in the custom listing header.

Custom listing header link.

Configuration of a Store custom listing header.

Set of Store custom pages.

List of possible statuses for Store custom pages.

 

Font selection for Store configuration.

Font size selection for Store configuration.

Store font set.

This container provides details about the seller's eBay store.

This type defines the Storefront container, which can be used by eBay Stores sellers to list an item under two primary custom categories either by category ID or category name.

 

The unique identifier of the store from where the order will be delivered.

This field is deprecated.

This field is deprecated.

This field is is no longer applicable.

This type is no longer applicable, as Store Inventory is no longer a supported eBay listing type.

Set of available layouts for items listed in an eBay Store.

List of available options for how items are sorted in an eBay Store.

Set of Store logos.

Store logo.

This field is deprecated.

The name of the store owned by the favorite seller, if applicable.

This field is deprecated.

The name of the seller's eBay Store.

Boolean value indicates whether or not the seller is an eBay Store owner.

Provides additional listings durations that are available to eBay Store owners.

This field is deprecated.

Provides additional listings durations that are supported by Store Owners.

If the field is present, the corresponding feature applies to the category.

Indicates if an eBay Store owner gets extended listing durations in a given category.

This field is returned as an empty element (a boolean value is not returned) if one or more eBay API-enabled sites support extended listing durations for eBay Business Sellers with eBay Stores.

Defines if extended business seller listing durations are enabled on a given site.

If the field is present, the corresponding feature applies to the category.

This type is used to specify the additional listing durations that are available to sellers who have eBay Store subscriptions.

This container consists of the seller's current eBay Store preferences.

This container is used to set the eBay Store's preferences.

Store Preferences type.

The site associated with the seller's eBay Store.

Set of eBay Store subscription levels.

This enumerated type contains the different subscription levels that a seller may subscribe to for their eBay Store.

Type used by the Subscription container that is returned in GetStoreOptions to indicate the subscription level and monthly fee associated with the eBay Store.

Set of Store themes.

Store theme.

The configuration of an eBay Store.

The URL for the seller's eBay Store.

The URL of the seller's eBay Stores page.

This type is used by the VacationPreferences container that is set in a SetStorePreferences call and returned in a GetStorePreferences call.

A concatenation of Street1 and Street2, primarily used for a registration address.

The first line of the user's street address.

The second line of the user's street address (such as an apartment number or suite number).

Indicates the type of string matching to use when a value is submitted in CharityName.

Each Subject field contains one custom Ask a Question (ASQ) subject.

Subject of this email message.

This field is deprecated.

Subject of the message.

Date and time (in GMT) that the lead was submitted.

This field is no longer applicable since the Seller Assistant feature is no longer available.

This field is no longer applicable since the Seller Assistant Pro feature is no longer available.

Indicates if a user subscribes to Selling Manager.

Indicates if a user subscribes to Selling Manager Pro.

A Store subscription level.

This container consists of the different levels of eBay Store subscriptions along with the monthly subscription price.

This type is deprecated.

This field is deprecated.

For the GetStore call, the value returned in this field indicates the user's eBay Store subscription level.

 

Subtitle to use in addition to the title.

The cumulative item cost for all line items in the order.

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

This type is used by the SuggestedBidValues container that is returned if the buyer is attempting to bid on an auction item through the PlaceOffer call.

Describes a category that contains listings that match specified keywords in the query.

This container consists of an array of suggested listing categories for an item based on the keywords that were specified in the Query field of the call request.

Contains an array of categories that contain listings with specified keywords in their titles or descriptions.

Defines a suggested category, returned in response to a search for categories that contain listings with certain keywords in their titles and descriptions.

This field is deprecated.

This container consists of seller activity counts and values.

Summary data for a given user's messages.

This integer value indicates the length of time (in number of days) that is being used to calculate all counts in the BiddingSummary container.

Details about a summary event schedule.

How often the summary is to be delivered.

The period of time for which to create a summary.

User account activity summary alert delivery schedule.

The period of time for which to create a summary.

 

Container consisting of information related to specific Business Policies payment, return, and shipping policy profiles.

Container consisting of one or more Business Policies profiles active for a seller's account.

Type defining the SupportedSellerProfiles container for all payment, return, and shipping policy profiles that a seller has defined for a site.

Type defining the SupportedSellerProfile container, which contains summary information related to specific Business Policies payment, return policy, and shipping profiles.

This field is only returned if 'true', and indicates that a shipping surcharge is applicable for this shipping service option.