us87.ebaysdkcore.1131.1.source-code.eBaySvc.wsdl Maven / Gradle / Ivy
The newest version!
Authentication information for the user on whose behalf the
application is making the request. Only registered eBay users are
allowed to make API calls. To verify that a user is registered,
your application needs to pass a user-specific value called an
"authentication token" in the request. This is equivalent to
signing in on the eBay Web site. As API calls do not pass session
information, you need to pass the user's authentication token every
time you invoke a call on their behalf. All calls require an
authentication token, except the calls you use to retrieve a token
in the first place. (For such calls, you use the eBay member's
username and password instead.)
Yes
Enables a seller to create an Unpaid Item case against a buyer, or to cancel a
single line item order.
<br>
<br>
Although the seller is eligible to open up an Unpaid Item case two days after the buyer purchases the item or wins the item through an auction, it is recommended that the seller contacts the buyer first to try and make it right before opening a case. The <a href="http://pages.ebay.com/help/sell/unpaid-items.html" target="_blank">Unpaid Items</a> help page talks more about how a seller should to handle an unpaid item.
<br>
<br>
To cancel a multiple line item order programmatically, the seller would have to use the <a href="https://developer.ebay.com/Devzone/post-order/post-order_v2_cancellation__post.html" target="_blank">POST /post-order/v2/cancellation</a> call of the <b>Post-Order API</b>.
Creates an Unpaid Item case against a buyer or cancels a single line item order.
Unpaid Item Disputes
http://developer.ebay.com/DevZone/guides/features-guide/default.html#development/UPI-Disputes.html
This enumerated value gives the explanation of why the seller opened a case (or why seller canceled a single line item order). Not all values contained in <b>DisputeExplanationCodeType</b> are allowed in the <b>AddDispute</b> call, and the values that are allowed must match the <b>DisputeReason</b> value.
AddDispute
Yes
PaymentMethodNotSupported, ShipCountryNotSupported, Unspecified, UPIAssistance, UPIAssistanceDisabled
Creating and Managing Disputes With Trading API
http://developer.ebay.com/DevZone/guides/features-guide/default.html#development/UPI-DisputesAPIManagement.html#UsingAddDispute
The enumeration value passed into this required field will depend on the action being taken. The seller will pass in <code>BuyerHasNotPaid</code> if the seller is creating an Unpaid Item case against the buyer, or
<code>TransactionMutuallyCanceled</code> if the seller is cancelling a single line item order at the request of the buyer, or if the seller has ran out of stock on the item or otherwise cannot fulfill the order.
AddDispute
Yes
BuyerHasNotPaid, TransactionMutuallyCanceled
Unique identifier of an eBay listing. To identify a specific order line item, either an <b>ItemID</b>/<b>TransactionID</b> pair or an <b>OrderLineItemID</b> value must be passed in the request. So, unless <b>OrderLineItemID</b> is used, this field is required.
<br>
AddDispute
Conditionally
The unique identifier of a buyer's purchase. A <b>TransactionID</b> is created by eBay once a buyer purchases the item through a fixed-priced listing or by using the Buy It Now feature in an auction listing, or when an auction listing ends with a winning bidder. To identify a specific order line item, either an <b>ItemID</b>/<b>TransactionID</b> pair or an <b>OrderLineItemID</b> value must be passed in the request. So, unless <b>OrderLineItemID</b> is used, this field is required.
<br>
19 (Note: TransactionIDs usually consist of 9 to 12 digits.)
AddDispute
Conditionally
<b>OrderLineItemID</b> is a unique identifier of an order line item. To identify a specific order line item, either an <b>ItemID</b>/<b>TransactionID</b> pair or an <b>OrderLineItemID</b> value must be passed in the request. So, unless <b>ItemID</b>/<b>TransactionID</b> pair is used, this field is required.
<br>
50
AddDispute
Conditionally
Type defining the response of the <b>AddDispute</b> call. Upon a successful call, the response contains a newly created <b>DisputeID</b> value, which confirms that an Unpaid Item case was created, or that a single line item order was successfully cancelled.
This field will show the unique identifier of an Unpaid Item case that was created, or the unique identifier of the order cancellation.
AddDispute
Always
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. To respond to a case opened by the buyer through eBay's Resolution Center, the seller should use the <a href="http://developer.ebay.com/Devzone/post-order/index.html" target="_blank">Case Management calls</a> of the <b>Post-Order API</b>, the <a href="http://developer.ebay.com/Devzone/resolution-case-management/CallRef/index.html" target="_blank">Resolution Case Management API</a>, or manage the case manually through the eBay Resolution Center.
Used to respond to a PayPal Purchase Protection dispute or to update an Unpaid Item case.
Unpaid Item Disputes
https://developer.ebay.com/DevZone/guides/features-guide/default.html#development/UPI-Disputes.html
Buyer Disputes
https://developer.ebay.com/DevZone/guides/features-guide/default.html#development/Disputes-Buyer.html
The unique identifier of the eBay Unpaid Item case or PayPal INR dispute. This identifier is created by eBay or PayPal upon case/dispute creation.
AddDisputeResponse
Yes
The text of a comment or response being posted to the case/dispute. Required when <b>DisputeActivity</b> is <b>SellerAddInformation</b>, <b>SellerComment</b>, or <b>SellerPaymentNotReceived</b>. Otherwise, this field is optional.
AddDisputeResponse
Conditionally
The type of activity the seller plans to take on the case/dispute. The allowed value is determined by the current state of the case/dispute and whether the seller is updating an Unpaid Item case or responding to a PayPal INR dispute.
AddDisputeResponse
Yes
Unpaid Item Disputes
http://developer.ebay.com/DevZone/guides/features-guide/default.html#development/UPI-Disputes.html
Buyer Disputes
http://developer.ebay.com/DevZone/guides/features-guide/default.html#development/Disputes-Buyer.html
The shipping carrier used to ship the item in dispute. This field is not case sensitive in the <strong>AddDisputeResponse</strong> request. Non-alphanumeric characters are not allowed. This field (along with <b>ShipmentTrackNumber</b>) is required if the value of <b>DisputeActivity</b> is set to <code>SellerShippedItem</code>.
AddDisputeResponse
Conditionally
The tracking number associated with one package of a shipment. The seller is responsible for the accuracy of the shipment tracking number, as eBay only verifies that the tracking number is consistent with the numbering scheme used by the specified shipping carrier, but cannot verify the accuracy of the tracking number. This field (along with <b>ShippingCarrierUsed</b>) is required if the value of <b>DisputeActivity</b> is set to <code>SellerShippedItem</code>.
AddDisputeResponse
Conditionally
This timestamp indicates the date and time when the item under dispute was
shipped. This field is required if the value of <b>DisputeActivity</b> is set to <code>SellerShippedItem</code>.
AddDisputeResponse
Conditionally
This type is the base response of the <b>AddDisputeResponse</b> call. This type has no call-specific fields, but the applicable fields of the <b>AbstractResponseType</b> will be returned in the <b>AddDisputeResponse</b> response.
This call allows a seller to create and publish a fixed-price listing.
The main difference between <b>AddFixedPriceItem</b> and <b>AddItem</b> is that
<b>AddFixedPriceItem</b> supports the creation of fixed-price listings only,
whereas <b>AddItem</b> supports all listing formats.
<br>
<br>
Also, only <b>AddFixedPriceItem</b> supports multipl-variation listings
and tracking inventory by a seller-defined SKU value. <b>AddItem</b> does not support
Variations or the <b>InventoryTrackingMethod</b> field.
Defines and publishes a single or multiple-variation fixed-price listing.
AddItem, AddItems, VerifyAddFixedPriceItem
Listing an Item
https://developer.ebay.com/DevZone/guides/features-guide/default.html#development/Listing-AnItem.html
Listing Items
https://developer.ebay.com/DevZone/guides/features-guide/default.html#development/Listing.html
Introduction to Pictures in Item Listings
https://developer.ebay.com/DevZone/guides/features-guide/default.html#development/Pictures-Intro.html
Multi-Variation Listings
https://developer.ebay.com/DevZone/guides/features-guide/default.html#development/Variations.html
Considering Best Match When Revising and Relisting Items
https://developer.ebay.com/DevZone/guides/features-guide/default.html#development/Listing-AnItem.html#ConsideringBestMatchWhenListingItems
This container is used to specify all of the values and settings that define a new fixed-price listing.
AddFixedPriceItem
Yes
Returns the item ID, SKU (if any), listing recommendations (if applicable), the estimated fees for the new listing (except the Final Value Fee, which isn't calculated until the item has sold), the start and end times of the listing, and other details.
Unique identifier for the new fixed-price listing. This field is returned as long as the listing was successfully created.
AddFixedPriceItem
Always
The SKU value for an item is returned if the seller specified a SKU value through the <b>Item.SKU</b> field in the request. In the case of a multi-variation listing, variation-level SKU values are not returned in the response. To get this data, a <b>GetItem</b> call would have to be made by the seller.
AddFixedPriceItem
Conditionally
Starting date and time for the new listing. This value is based on the time the listing was received and processed, or the time the item will be listed if the seller included the <b>Item.ScheduleTime</b> field in the request and set a custom start time of the listing (in the future).
AddFixedPriceItem
Always
Date and time when the new listing is scheduled to end based on the start time and the listing duration value that was set in the <b>ListingDuration</b> field at listing time. If the value of <b>ListingDuration</b> was set to <code>GTC</code> (Good 'Til Cancelled) this value will be set 30 days ahead of the start time, although this value will be updated if the GTC listing is still alive and automatically renewed 30 days after start time.
<br><br>
<span class="tablenote"><b>Note: </b>
As of July 1, 2019, the Good 'Til Cancelled renewal schedule has been modified from every 30 days to once per calendar month. For example, if a GTC listing is created July 5, the next monthly renewal date will be August 5. If a GTC listing is created on the 31st of the month, but the following month only has 30 days, the renewal will happen on the 30th in the following month. Finally, if a GTC listing is created on January 29-31, the renewal will happen on February 28th (or 29th during a 'Leap Year'). See the
<a href="https://pages.ebay.com/seller-center/seller-updates/2019-spring/marketplace-updates.html#good-til-cancelled" target="_blank">Good 'Til Cancelled listings update</a> in the <b>Spring 2019 Seller Updates</b> for more information about this change.
</span>
AddFixedPriceItem
Conditionally
This container is an array of fees associated with the creation of the listing. The fees do not include the Final Value Fee (FVF), which cannot be determined until an item is sold.
eBay.com Fees
http://pages.ebay.com/help/sell/fees.html
AddFixedPriceItem
Always
Final Value Fees and Credits
https://developer.ebay.com/DevZone/guides/features-guide/default.html#development/Sales-Completing.html#FinalValueFeesandCredits
Final Value Fees
https://www.ebay.com/help/selling/fees-credits-invoices/selling-fees?id=4364#section2
Fees per Site
http://developer.ebay.com/DevZone/guides/features-guide/default.html#development/IntlDiffs-Fees.html
Using Feature Packs to Save on Upgrade Fees
http://developer.ebay.com/DevZone/guides/features-guide/default.html#development/Desc-FeaturePacks.html
The unique identifier of the primary category in which the item was listed. This field is only returned if the <b>Item.CategoryMappingAllowed</b> boolean field is set to <code>true</code> in the request (or omitted) and the Category ID passed in as the primary listing category was automatically mapped to a new Category ID by eBay. If the primary category ID passed in the request is still active/valid, this field is not returned.
<br/><br/>
<span class="tablenote"><b>Note: </b> The <b>Item.CategoryMappingAllowed</b> field value in the request now defaults to <code>true</code> if omitted. Previously, the default value was <code>false</code>, so a user had to include this field and set it to <code>true</code> in order for eBay to map an outdated Primary or Secondary Category ID to the updated Category ID.
</span>
10
AddFixedPriceItem
Conditionally
Unique identifier of the secondary category in which the item was listed. This field is only returned if the <b>Item.CategoryMappingAllowed</b> boolean field is set to <code>true</code> in the request (or omitted) and the Category ID passed in as the secondary listing category was automatically mapped to a new Category ID by eBay. If the secondary category ID passed in the request is still active/valid, this field is not returned.
<br/><br/>
<span class="tablenote"><b>Note: </b> The <b>Item.CategoryMappingAllowed</b> field value in the request now defaults to <code>true</code> if omitted. Previously, the default value was <code>false</code>, so a user had to include this field and set it to <code>true</code> in order for eBay to map an outdated Primary or Secondary Category ID to the updated Category ID.
</span>
10
AddFixedPriceItem
Conditionally
This container is an array of one or more listing fee/upgrade discount types being offered by eBay to the seller.
AddFixedPriceItem
Conditionally
This container holds an array of one or more products in the eBay product catalog that appear to match the product being listed, just based on the information in the listing. This container will not be returned if no similar products were found in the eBay product catalog.
AddFixedPriceItem
Conditionally
Container consisting of one or more <b>Recommendation</b> containers. Each <b>Recommendation</b> container provides a message to the seller on how a listing can be improved or brought up to standard in regards to top-rated seller/listing requirements, mandated or recommended Item Specifics, picture quality requirements, pricing and/or listing format recommendations, recommended keywords and/or Item Specifics in a Title, and/or a recommendation to offer fast handling (same-day handling or handling time of 1 day) and/or a free shipping option in order to qualify the listing for a Fast 'N Free badge.
<br><br>
This container is only returned if the <b>IncludeRecommendations</b> flag was included and set to 'true' in the <b>AddFixedPriceItem</b> request, and if at least one listing recommendation exists for the newly created listing. If one or more listing recommendations are returned, it will be at the seller's discretion about whether to revise the item based on eBay's listing recommendation(s).
AddFixedPriceItem
Conditionally
Base request type for the <b>AddItem</b> call, which is used to create a fixed-price, auction, or classified ad listing.
Creates a fixed-price, auction, or classified ad listing.
AddFixedPriceItem, AddItems, VerifyAddItem
Listing an Item
https://developer.ebay.com/DevZone/guides/features-guide/default.html#development/Listing-AnItem.html
Listing Items
https://developer.ebay.com/DevZone/guides/features-guide/default.html#development/Listing.html
Introduction to Pictures in Item Listings
https://developer.ebay.com/DevZone/guides/features-guide/default.html#development/Pictures-Intro.html
This container is used to specify all of the values and settings that define a new listing.
AddItem
Yes
The base response of the <b>AddItem</b> call. The response will include the Item ID of the newly created listing, SKU (if any), listing recommendations (if applicable), the estimated fees for the new listing (except the Final Value Fee, which isn't calculated until the item has sold), the start and end times of the listing, and other details.
Unique identifier for the new listing. This field is returned as long as the listing was successfully created.
AddItem
Always
Starting date and time for the new listing. This value is based on the time the listing was received and processed, or the time the item will be listed if the seller included the <b>Item.ScheduleTime</b> field in the request and set a custom start time of the listing (in the future).
AddItem
Always
Date and time when the new listing is scheduled to end based on the start time and the listing duration value that was set in the <b>ListingDuration</b> field at listing time. If the value of <b>ListingDuration</b> was set to <code>GTC</code> (Good 'Til Cancelled) this value will be set 30 days ahead of the start time, although this value will be updated if the GTC listing is still alive and automatically renewed 30 days after start time. Note that GTC is not an option with auction listings.
<br><br>
<span class="tablenote"><b>Note: </b>
As of July 1, 2019, the Good 'Til Cancelled renewal schedule has been modified from every 30 days to once per calendar month. For example, if a GTC listing is created July 5, the next monthly renewal date will be August 5. If a GTC listing is created on the 31st of the month, but the following month only has 30 days, the renewal will happen on the 30th in the following month. Finally, if a GTC listing is created on January 29-31, the renewal will happen on February 28th (or 29th during a 'Leap Year'). See the
<a href="https://pages.ebay.com/seller-center/seller-updates/2019-spring/marketplace-updates.html#good-til-cancelled" target="_blank">Good 'Til Cancelled listings update</a> in the <b>Spring 2019 Seller Updates</b> for more information about this change.
</span>
AddItem
Always
This container is an array of fees associated with the creation of the listing. The fees do not include the Final Value Fee (FVF), which cannot be determined until an item is sold.
AddItem
Always
eBay.com Selling Fees
https://www.ebay.com/help/selling/fees-credits-invoices/selling-fees?id=4822
Final Value Fees and Credits
https://developer.ebay.com/DevZone/guides/features-guide/default.html#development/Sales-Completing.html#FinalValueFeesandCredits
Final Value Fees
https://www.ebay.com/help/selling/fees-credits-invoices/selling-fees?id=4822#section2
Fees per Site
https://developer.ebay.com/DevZone/guides/features-guide/default.html#development/IntlDiffs-Fees.html
Using Feature Packs to Save on Upgrade Fees
https://developer.ebay.com/DevZone/guides/features-guide/default.html#development/Desc-FeaturePacks.html
The unique identifier of the primary category in which the item was listed. This field is only returned if the <b>Item.CategoryMappingAllowed</b> boolean field is set to <code>true</code> in the request (or omitted) and the Category ID passed in as the primary listing category was automatically mapped to a new Category ID by eBay. If the primary category ID passed in the request is still active/valid, this field is not returned.
<br/><br/>
<span class="tablenote"><b>Note: </b> The <b>Item.CategoryMappingAllowed</b> field value in the request now defaults to <code>true</code> if omitted. Previously, the default value was <code>false</code>, so a user had to include this field and set it to <code>true</code> in order for eBay to map an outdated Primary or Secondary Category ID to the updated Category ID.
</span>
10
AddItem
Conditionally
Unique identifier of the secondary category in which the item was listed. This field is only returned if the <b>Item.CategoryMappingAllowed</b> boolean field is set to <code>true</code> in the request (or omitted) and the Category ID passed in as the secondary listing category was automatically mapped to a new Category ID by eBay. If the secondary category ID passed in the request is still active/valid, this field is not returned.
<br/><br/>
<span class="tablenote"><b>Note: </b> The <b>Item.CategoryMappingAllowed</b> field value in the request now defaults to <code>true</code> if omitted. Previously, the default value was <code>false</code>, so a user had to include this field and set it to <code>true</code> in order for eBay to map an outdated Primary or Secondary Category ID to the updated Category ID.
</span>
10
AddItem
Conditionally
This container is an array of one or more listing fee/upgrade discount types being offered by eBay to the seller.
AddItem
Conditionally
This container holds an array of one or more products in the eBay product catalog that appear to match the product being listed, just based on the information in the listing. This container will not be returned if no similar products were found in the eBay product catalog.
AddItem
Conditionally
Container consisting of one or more <b>Recommendation</b> containers. Each <b>Recommendation</b> container provides a message to the seller on how a listing can be improved or brought up to standard in regards to top-rated seller/listing requirements, mandated or recommended Item Specifics, picture quality requirements, pricing and/or listing format recommendations, recommended keywords and/or Item Specifics in a Title, and/or a recommendation to offer fast handling (same-day handling or handling time of 1 day) and/or a free shipping option in order to qualify the listing for a Fast 'N Free badge.
<br><br>
This container is only returned if the <b>IncludeRecommendations</b> flag was included and set to 'true' in the <b>AddItem</b> request, and if at least one listing recommendation exists for the newly created listing. If one or more listing recommendations are returned, it will be at the seller's discretion about whether to revise the item based on eBay's listing recommendation(s).
AddItem
Conditionally
This is the base request type of the <b>AddItemFromSellingManagerTemplate</b> call, which is used to create listings based on settings contained in a Selling Manager template.
AddSellingManagerTemplate, GetSellingManagerTemplates
Creates a listing based on settings contained in a Selling Manager Pro template.
Using Selling Manager Calls in the Trading API
https://developer.ebay.com/DevZone/guides/features-guide/default.html#development/Listings-SellingManager.html
Selling Manager Pro page on the eBay Site
https://www.ebay.com/help/selling/selling-tools/selling-manager-selling-manager-pro?id=4098
The unique identifier of the Selling Manager template that a seller is using to create a listing. Unique identifiers of Selling Manager templates can be retrieved programatically by using the <b>GetSellingManagerInventory</b> call.
AddItemFromSellingManagerTemplate
No
This field allows the user to specify a time in the future when the listing being created becomes active. If this field is not used, the listing will become active immediately upon being created successfully. The time in this field should be specified in GMT format.
AddItemFromSellingManagerTemplate
No
This container is intended for specifying setting in the listing that differ from values in the Selling Manager template being used.
<br><br>
<span class="tablenote"><strong>Note:</strong>
Only the following three values of <b>ItemType</b> may be used for a <b>AddItemFromSellingManagerTemplate</b> call: <b>CategoryMappingAllowed</b>, <b>PaymentMethods</b>, and <b>PayPalEmailAddress</b>.
AddItemFromSellingManagerTemplate
No
Returns the item ID, the estimated fees for the new listing (except the Final Value Fee, which isn't calculated until the item has sold), the start and end times of the listing, and other details.
Unique identifier for the new listing. This field is returned as long as the listing was successfully created.
AddItemFromSellingManagerTemplate
Always
Starting date and time for the new listing. This value is based on the time the listing was received and processed, or the time the item will be listed if the seller included the <b>ScheduleTime</b> field in the request and set a custom start time of the listing (in the future).
AddItemFromSellingManagerTemplate
Always
Date and time when the new listing is scheduled to end based on the start time and the listing duration value that was set in the <b>ListingDuration</b> field at listing time. If the value of <b>ListingDuration</b> was set to <code>GTC</code> (Good 'Til Cancelled) this value will be set 30 days ahead of the start time, although this value will be updated if the GTC listing is still alive and automatically renewed 30 days after start time. Note that GTC is not an option with auction listings.
<br><br>
<span class="tablenote"><b>Note: </b>
As of July 1, 2019, the Good 'Til Cancelled renewal schedule has been modified from every 30 days to once per calendar month. For example, if a GTC listing is created July 5, the next monthly renewal date will be August 5. If a GTC listing is created on the 31st of the month, but the following month only has 30 days, the renewal will happen on the 30th in the following month. Finally, if a GTC listing is created on January 29-31, the renewal will happen on February 28th (or 29th during a 'Leap Year'). See the
<a href="https://pages.ebay.com/seller-center/seller-updates/2019-spring/marketplace-updates.html#good-til-cancelled" target="_blank">Good 'Til Cancelled listings update</a> in the <b>Spring 2019 Seller Updates</b> for more information about this change.
</span>
AddItemFromSellingManagerTemplate
Always
This container is an array of fees associated with the creation of the listing. The fees do not include the Final Value Fee (FVF), which cannot be determined until an item is sold.
AddItemFromSellingManagerTemplate
Always
The unique identifier of the primary category in which the item was listed. This field is only returned if the <b>Item.CategoryMappingAllowed</b> boolean field is set to <code>true</code> in the request (or omitted) and the Category ID passed in as the primary listing category was automatically mapped to a new Category ID by eBay. If the primary category ID passed in the request is still active/valid, this field is not returned.
<br/><br/>
<span class="tablenote"><b>Note: </b> The <b>Item.CategoryMappingAllowed</b> field value in the request now defaults to <code>true</code> if omitted. Previously, the default value was <code>false</code>, so a user had to include this field and set it to <code>true</code> in order for eBay to map an outdated Primary or Secondary Category ID to the updated Category ID.
</span>
10
AddItemFromSellingManagerTemplate
Conditionally
Unique identifier of the secondary category in which the item was listed. This field is only returned if the <b>Item.CategoryMappingAllowed</b> boolean field is set to <code>true</code> in the request (or omitted) and the Category ID passed in as the secondary listing category was automatically mapped to a new Category ID by eBay. If the secondary category ID passed in the request is still active/valid, this field is not returned.
<br/><br/>
<span class="tablenote"><b>Note: </b> The <b>Item.CategoryMappingAllowed</b> field value in the request now defaults to <code>true</code> if omitted. Previously, the default value was <code>false</code>, so a user had to include this field and set it to <code>true</code> in order for eBay to map an outdated Primary or Secondary Category ID to the updated Category ID.
</span>
10
AddItemFromSellingManagerTemplate
Conditionally
Defines from one to five items and lists them on a specified eBay site.
AddItem, VerifyAddItem
Listing an Item
https://developer.ebay.com/DevZone/guides/features-guide/default.html#development/Listing-AnItem.html
Listing Items
https://developer.ebay.com/DevZone/guides/features-guide/default.html#development/Listing.html
Introduction to Pictures in Item Listings
https://developer.ebay.com/DevZone/guides/features-guide/default.html#development/Pictures-Intro.html
Defines a single item to be listed on eBay. This container is similar to an <b>AddItem</b> request. Up to five of these containers can be included in one <b>AddItems</b> request.
1
5
AddItems
Yes
The response of the <b>AddItems</b> call. The response includes the Item IDs of the newly created listings, the eBay category each item is listed under, the seller-defined SKUs of the items (if any), the listing recommendations for each item (if applicable), the start and end time of each listing, and the estimated fees that each listing will incur.
One <b>AddItemResponseContainer</b> container is returned for each listing that is being created with the <b>AddItems</b> call. Each container includes the <b>ItemID</b> of each newly created listings, the eBay category each item is listed under, the seller-defined SKUs of the items (if any), the listing recommendations for each item (if applicable), the start and end time of each listing, and the estimated fees that each listing will incur.
AddItems
Always
Enables a buyer and seller in an order relationship to
send messages to each other's My Messages Inboxes.
AddMemberMessagesAAQToBidder, AddMemberMessageRTQ
Unique identifier for the listing that is being discussed between the two order partners.
AddMemberMessageAAQToPartner
Yes
This container holds the message, and includes the subject, message body, and other details related to the message.
AddMemberMessageAAQToPartner
Yes
This type defines the response to the <b>AddMemberMessageAAQToPartner</b> call. There are no call-specific fields in this response.
The base request of the <b>AddMemberMessageRTQ</b> call that enables a seller to reply to a question about an active item listing.
Enables a seller to reply to a question about an active item listing.
AddMemberMessagesAAQToBidder, AddMemberMessageAAQToPartner
The unique identifier of the listing about which the question was asked. This field is not required if the request includes a <b>RecipientID</b> value in the <b>MemberMessage</b> container, and the bidder/potential buyer and seller do not have more than one listing in common between one another.
AddMemberMessageRTQ
No
This container is used by the seller to answer the question from the bidder/potential buyer. This container includes the recipient ID of the bidder/potential buyer, the message subject, the message body (where the question is answered), and other values related to the message.
AddMemberMessageRTQ
Yes
This type defines the response to the <b>AddMemberMessageRTQ</b> call. There are no call-specific fields in this response.
The base request of the <b>AddMemberMessagesAAQToBidder</b> call, which allows a seller to send up to 10 messages to bidders/potential buyers regarding an active listing. These potential buyers may include those who have made a Best Offer on a listing.
Enables a seller to send up to 10 messages to bidders/potential buyers regarding an active listing.
AddMemberMessageAAQToPartner, AddMemberMessageRTQ
An <b>AddMemberMessagesAAQToBidderRequestContainer</b> container is required for each message being sent to unique bidders/potential buyers. A seller can send up to 10 messages to unique bidders/potential buyers in one <b>AddMemberMessagesAAQToBidder</b> call.
AddMemberMessagesAAQToBidder
Yes
Type defining the <b>AddMemberMessagesAAQToBidderResponseContainer</b> container, which consists of the <b>Ack</b> field (indicating the result of the send message operation) and the <b>CorrelationID</b> field (used to track multiple send message operations performed in one call).
Container consisting of the <b>Ack</b> field (indicating the result of the send message operation) and the <b>CorrelationID</b> field (used to track multiple send message operations performed in one call).
10
AddMemberMessagesAAQToBidder
Always
The <b>AddOrder</b> 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. Once multiple line items are combined into one order, the buyer can make one single payment for multiple line item order. If possible and agreed to, the seller can then ship multiple line items in the same shipping package, saving on shipping costs, and possibly passing that savings down to the buyer through Combined Shipping Discount rules set up in My eBay.
Combines two or more order line items into a single order, enabling a buyer to pay for all of those order line items with a single payment.
https://developer.ebay.com/DevZone/guides/features-guide/default.html#development/Sales-Checkouts.html#ReviewingandModifyinganOrderLineItem
Reviewing and Modifying an Order Line Item
https://developer.ebay.com/DevZone/guides/features-guide/default.html#development/Listing-AnItem.html#CombinedInvoice
Combined Invoice
The root container of the <b>AddOrder</b> request. In this call, the seller identifies two or more unpaid order line items from the same buyer through the <b>TransactionArray</b> container, specifies one or more accepted payment methods through the <b>PaymentMethods</b> field(s), and specifies available shipping services and other shipping details through the <b>ShippingDetails</b> container.
AddOrder
Yes
This type defines the response of an <b>AddOrder</b> call. If the multiple line items are successfully combined into a single order, this response includes the unique identifier of this 'Combined Invoice' order (automatically generated by eBay), and a timestamp indicating when the new order was created.
The unique identifier of the successfully-created 'Combined Invoice' order. This value is only created and returned if the <b>AddOrder</b> call is successful in creating the new order.
<br/><br/>
This value can be used as an input filter in <b>GetOrders</b> and <b>GetOrderTransactions</b> calls to retrieve the order.
<br><br>
<span class="tablenote"><b>Note: </b> As of June 2019, eBay has changed the format of order identifier values. The new format is a non-parsable string, globally unique across all eBay marketplaces, and consistent for both single line item and multiple line item orders. Unlike in the past, instead of just being known and exposed to the seller, these unique order identifiers will also be known and used/referenced by the buyer and eBay customer support.
<br><br>
For developers and sellers who are already integrated with the Trading API's order management calls, this change shouldn't impact your integration unless you parse the existing order identifiers (e.g., <b>OrderID</b> or <b>OrderLineItemID</b>), or otherwise infer meaning from the format (e.g., differentiating between a single line item order versus a multiple line item order). Because we realize that some integrations may have logic that is dependent upon the old identifier format, eBay is rolling out this Trading API change with version control to support a transition period of approximately 9 months before applications must switch to the new format completely.
<br><br>
During the transition period, for developers/sellers using a Trading WSDL older than Version 1113, they can use the <b>X-EBAY-API-COMPATIBILITY-LEVEL</b> HTTP header in API calls to control whether the new or old <b>OrderID</b> format is returned in call response payloads. To get the new <b>OrderID</b> format, the value of the <b>X-EBAY-API-COMPATIBILITY-LEVEL</b> HTTP header must be set to <code>1113</code>. During the transition period and even after, the new and old <b>OrderID</b> formats will still be supported/accepted in all Trading API call request payloads. After the transition period (which will be announced), only the new <b>OrderID</b> format will be returned in all Trading API call response payloads, regardless of the Trading WSDL version used or specified compatibility level.
</span>
<br>
<span class="tablenote"><b>Note: </b> For sellers integrated with the new order ID format, please note that the identifier for an order will change as it goes from unpaid to paid status. Sellers can check to see if an order has been paid by looking for a value of 'Complete' in the <b>CheckoutStatus.Status</b> field in the response of <b>GetOrders</b> or <b>GetOrderTransactions</b> call, or in the <b>Status.CompleteStatus</b> field in the response of <b>GetItemTransactions</b> or <b>GetSellerTransactions</b> call. Sellers should not fulfill orders until buyer has made payment. When using a <b>GetOrders</b> or <b>GetOrderTransactions</b> call to retrieve specific order(s), either of these order IDs (paid or unpaid status) can be used to retrieve an order.
</span>
40
AddOrder
Always
http://developer.ebay.com/DevZone/guides/features-guide/default.html#development/Listing-AnItem.html#CombinedInvoice
Combined Invoice
Timestamp that indicates the date and time that the 'Combined Invoice' order was created.
AddOrder
Always
http://developer.ebay.com/DevZone/guides/features-guide/default.html#development/Listing-AnItem.html#CombinedInvoice
Combined Invoice
Used by the seller of an auction listing to provide a Second Chance Offer to one of that auction item's non-winning bidders. A Second Chance Offer is used by sellers whenever the seller was unable to complete the sale with the winning bidder because the bidder didn't pay, or if the auction listing ended without the Reserve Price being met, or if that seller has multiple identical items for sale and wants to give other bidders a chance to purchase the item.
<br>
<br>
To get information on the bidders for a recently-ended auction listing, the seller can use the <b>GetAllBidders</b> call and pass the corresponding <b>ItemID</b> value into the call request.
<br>
<br>
For more information on the specifics of Second Chance Offers, see the <a href="https://pages.ebay.com/help/sell/second_chance_offer.html" target="_blank">Making a Second Chance Offer</a> help page.
VerifyAddSecondChanceItem
Making Second Chance Offers for Items
https://developer.ebay.com/DevZone/guides/features-guide/default.html#development/Sales-SecondChanceOffers.html
This field is used to specify the bidder that is being offered the Second Chance Offer. The eBay User ID of the bidder is used in this field. Specify only one <b>RecipientBidderUserID</b> per call. If multiple users are specified, only the last one specified receives the offer. User ID values will be returned in the <b>Offer.User.UserID</b> field of the <b>GetAllBidders</b> call response.
AddSecondChanceItem
Yes
The amount the offer recipient must pay to purchase the item as a Second Chance Offer. This field should only be used when the original item was listed in an eBay Motors vehicle category (or in some categories on U.S. and international sites for high-priced items, such as items in many U.S. and Canada Business and Industrial categories) and it ended unsold because the reserve price was not met. Otherwise, eBay establishes the price and no price should be submitted. The price offered to the Second Chance Offer recipient is generally the highest bid that the user made on the original listing.
AddSecondChanceItem
No
This enumeration value indicates the length of time (in days) that the Second Chance Offer will be available to the recipient. Upon receiving the Second Chance Offer, the recipient bidder will have this many days to accept the offer before the offer expires. One of the values in <b>SecondChanceOfferDurationCodeType</b> must be used.
AddSecondChanceItem
Yes
This field is used to identify the original auction listing through its unique identifier (Item ID). Upon a successful call, the Second Chance Offer will be identified by a new <b>ItemID</b> in the response.
AddSecondChanceItem
Yes
This optional field is used to provide a message to the recipient of the Second Chance Offer. This message cannot contain HTML, asterisks, or quotes. The content in this field will be included in the Second Chance Offer email that is sent to the recipient.
1000
AddSecondChanceItem
No
Type defining the response container of an <b>AddSecondChanceItem</b> call. This response container consists of the <b>ItemID</b> of the listing in which a Second Chance Offer is being offered, as well as the start and end time that the Second Chance Offer is available to the recipient (identified through the <b>RecipientBidderUserID</b> in the request).
This field contains the Item ID for the Second Chance Offer that was just created with the <b>AddSecondChanceItem</b> call. Note that this Item ID will be different from the Item ID in the original auction listing that was passed in the request.
AddSecondChanceItem
Always
This timestamp indicates the date and time when the Second Chance Offer became available to the recipient.
AddSecondChanceItem
Always
This timestamp indicates the date and time when the Second Chance Offer listing will expire, at which time the recipient will no longer be able to purchase the item.
AddSecondChanceItem
Always
Adds a new product folder to a user's Selling Manager account.
Using Selling Manager Calls in the Trading API
https://developer.ebay.com/DevZone/guides/features-guide/default.html#development/Listings-SellingManager.html
Selling Manager Pro page on the eBay Site
https://www.ebay.com/help/selling/selling-tools/selling-manager-selling-manager-pro?id=4098
Name of the new Selling Manager inventory folder.
AddSellingManagerInventoryFolder
No
Unique identifier of the parent Selling Manager inventory folder. If no <b>ParentFolderID</b> is submitted, the folder
is added at the root level.
AddSellingManagerInventoryFolder
No
Contains comments that will be associated with this folder.
AddSellingManagerInventoryFolder
No
The base response type of the <b>AddSellingManagerInventoryFolder</b> call. Along with the standard Trading API response fields, a <b>FolderID</b> field will be returned if the folder creation operation is successful.
The unique identifier of the newly created Selling Manager Inventory Folder. This field will generally be returned unless the call is not successful at creating the new folder.
AddSellingManagerInventoryFolder
Always
The base request type of the <b>AddSellingManagerProduct</b> call, which is used to create a product or a group of product variations within the Selling Manager Pro system. Once a Selling Manager Pro product or production variation group is created, the product settings and product specifics can be transferred over into a Selling Manager Pro listing template with the <b>AddSellingManagerTemplate</b> call.
Creates a Selling Manager product, which can be used to create Selling Manager listing templates.
Using Selling Manager Calls in the Trading API
https://developer.ebay.com/DevZone/guides/features-guide/default.html#development/Listings-SellingManager.html
Selling Manager Pro page on the eBay Site
https://www.ebay.com/help/selling/selling-tools/selling-manager-selling-manager-pro?id=4098
This container is used to provide details about the Selling Manager product, such as product name, quantity available, and unit price.
AddSellingManagerProduct
Yes
This is the unique identifier of the folder in which the new product will be placed. This folder can be a new folder or a folder that already exists for the seller in Selling Manager Pro. If no folder is specified through this field, the new product is place into the <em>My Products</em> folder by default.
AddSellingManagerProduct
No
This container allows the seller to specify item specifics for a product, to create a product variation group and variation specifics, and/or to specify a listing category for the product or product variation group. A product variation group can be transferred into a listing template that can create a multiple-variation listing. The listing category can either be provided through the <b>PrimaryCategoryID</b> value of this call, or through the <b>Item.PrimaryCategory.CategoryID</b> field of the subsequent <b>AddSellingManagerTemplate</b> call.
AddSellingManagerProduct
Yes
The base response for the <b>AddSellingManagerProduct</b> call.
This container includes the same information that was passed into the <b>SellingManagerProductDetails</b> container in the request, as well as a new <b>ProductID</b> value if the new product was successfully created.
AddSellingManagerProduct
Always
The base request for the <b>AddSellingManagerTemplate</b> call, which is used to create a Selling Manager listing template. Each Selling Manager listing template must be associated with an existing Selling Manager product, and each product can have up to 20 listing templates associated with it.
Creates a Selling Manager listing template that can be used to create an eBay listing based on the Selling Manager product associated with the template.
Using Selling Manager Calls in the Trading API
https://developer.ebay.com/DevZone/guides/features-guide/default.html#development/Listings-SellingManager.html
Selling Manager Pro page on the eBay Site
https://www.ebay.com/help/selling/selling-tools/selling-manager-selling-manager-pro?id=4098
This <b>Item</b> container is similar to the one that is used in standard Add/Revise/Relist/Verify Item calls, with the difference being that some of the product-specific data/settings will be inherited through the Selling Manager product that is referenced in the call request, and not through this <b>Item</b> container. The data that is passed in this container will become part of the listing template that is created with this call.
AddSellingManagerTemplate
Yes
The name of the Selling Manager listing template is provided in this field. If you don't specify a name, then the value in the <b>Item.Title</b> field will be used as the name instead.
AddSellingManagerTemplate
No
The unique identifier of the Selling Manager product that will be associated with the listing template being created. Selling Manager Product IDs are returned in the response of a <b>AddSellingManagerProduct</b> call.
Alternatively, the <b>GetSellingManagerInventory</b> call can be used to retrieve active Selling Manager products for the user's account.
AddSellingManagerTemplate
Yes
The base response of the <b>AddSellingManagerTemplate</b> call. The response includes the unique identifier and name of the new Selling Manager template, the listing category, some information on the Selling Manager product associated with the template, and the expected listing fees if a listing is created using this Selling Manager template.
The unique identifier of the eBay category in which the product associated with the Selling Manager template will be listed. The primary listing category is provided through the <b>PrimaryCategoryID</b> field of an <b>AddSellingManagerProduct</b> call or through the <b>Item.PrimaryCategory.CategoryID</b> field.
AddSellingManagerTemplate
Always
The unique identifier of the secondary eBay category in which the product associated with the Selling Manager template will be listed. This field will only be returned if defined through a <b>Item.SecondaryCategory.CategoryID</b> field.
AddSellingManagerTemplate
Conditionally
This is the unique identifier of the new Selling Manager template. This value is created by eBay upon successful creation of the Selling Manager template.
AddSellingManagerTemplate
Always
Ihis field is deprecated.
This is the unique name of the newly created Selling Manager template. This name will be the value that was provided in the <b>SaleTemplateName</b> field of the call request. If the <b>SaleTemplateName</b> field was omitted the Selling Manager template inherits the name specified in the <b>Item.Title</b> field instead.
AddSellingManagerTemplate
Always
This container consists of details related to the Selling Manager product associated with the Selling Manager template, including the unique identifer, product name, and current quantity available.
AddSellingManagerTemplate
Always
This container consists of listing fees that can be expected to be assessed against an eBay listing created with Selling Manager template. Each <b>Fee</b> container will contain the name of the listing fee, the expected amount, and any eBay promotional discount that will be applied towards the expected fee. The Final Value Fee (FVF) will never be returned in this container, as this fee cannot be determined until an item is sold.
AddSellingManagerTemplate
Always
Final Value Fees and Credits
https://developer.ebay.com/DevZone/guides/features-guide/default.html#development/Sales-Completing.html#FinalValueFeesandCredits
Fees per Site
https://developer.ebay.com/DevZone/guides/features-guide/default.html#development/IntlDiffs-Fees.html
Using Feature Packs to Save on Upgrade Fees
https://developer.ebay.com/DevZone/guides/features-guide/default.html#development/Desc-FeaturePacks.html
The base request of the <b>AddToItemDescription</b> call, which is used to add additional text to an active listing's item description. Upon a successful call, the text supplied in this call will be inserted into the active listing, with a horizontal rule separating the original item description and the additional text that was added with this call.
Adds additional text to an active listing's item description.
Changing Item Descriptions
http://developer.ebay.com/DevZone/guides/features-guide/default.html#development/Listings-ModifyingDetails.html
ReviseItem, ReviseFixedPriceItem
This field is used to identify the active listing that will be updated with additional text in the item description field. The Item ID is a unique identifier for a listing.
AddToItemDescription
Yes
This field is used to specify the text that will be appended to the end of the active listing's item description.
The text provided in this field must abide by the same rules/restrictions
applicable to the original item description supplied at listing time. For more information on these rules and restrictions, see the <a href="http://developer.ebay.com/Devzone/XML/docs/Reference/ebay/types/ItemType.html#Description">Description field of ItemType</a>.
AddToItemDescription
Yes
This type defines the response of the <b>AddToItemDescription</b> call. There are no call-specific fields in this response. The seller should look for an <b>Ack</b> value of <code>true</code> in the response, that will indicate that the additional text in the item description was added successfully.
Adds one or more order line items to the eBay user's Watch List. An auction item or a single-variation, fixed-price listing is identified with an <b>ItemID</b> value. To add a specific item variation to the Watch List from within a multi-variation, fixed-price listing, the user will use the <b>VariationKey</b> container instead.
The unique identifier of the single-variation listing that is to be added to the eBay user's Watch List. The item must be a currently active item, and the total number of items in the user's Watch List (after the items in the request have been added) cannot exceed the maximum allowed number of Watch List items. One or more <b>ItemID</b> fields can be specified. A separate error node will be returned for each item that was not successfully added to the Watch List.<br> <br> The user must use either one or more <b>ItemID</b> values or one or more <b>VariationKey</b> containers, but the user may not use both of these entities in the same call.
AddToWatchList
Conditionally
This container is used to specify one or more item variations in a multi-variation, fixed-price listing that you want to add to the Watch List.
The listing is identified through the <b>ItemID</b> value and each item variation existing within that listing is identified through a <b>VariationSpecifics.NameValueList</b> container.
<br>
<br>
The user must use either one or more <b>ItemID</b> values or one or more <b>VariationKey</b> containers, but the user may not use both of these entities in the same call.
AddToWatchList
Conditionally
This type defines the response of the <b>AddToWatchList</b> call. Along with data indicating the success or failure of adding one or more items to a user's Watch List, this response also includes the number of items currently in the user's Watch List and the maximum number of items allowed in the Watch List.
This integer value indicates the total number of items in the user's Watch List (after those specified in the call request have been successfully added).
AddToWatchList
Always
This integer value indicates the maximum number of items allowed in a user's Watch List. This value can vary by site and is subject to change. Currently on the US site, up to 200 items can be on the user's Watch List at any given time.
AddToWatchList
Always
Base request of the <b>AddTransactionConfirmationItem</b> 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. You can also use this call to see if a new TCR can be created for the specified item.
Ends an eBay Motors listing and creates a new Transaction Confirmation Request
(TCR) for the item.
Learning About Bidders
https://developer.ebay.com/DevZone/guides/features-guide/default.html#development/Listings-Bidders.html
Enabling Best Offer
https://developer.ebay.com/DevZone/guides/features-guide/default.html#development/Feature-BestOffer.html
This field is used to specify the recipient of the Transaction
Confirmation Request (TCR).
AddTransactionConfirmationItem
Yes
This field is included and set to <code>true</code> if the seller wants to verify whether or not a new Transaction
Confirmation Request (TCR) can be created for the item. If this field is included and its value set to <code>true</code>, no TCR is actually created. If this field is included and its value set to <code>false</code>, or if it is omitted, a Transaction
Confirmation Request is actually created.
AddTransactionConfirmationItem
No
This field is used to specify the postal code of the user to whom the seller is offering the Transaction Confirmation Request. This field is only required if the user does not meet the other options listed in <b>RecipientRelationCodeType</b>.
AddTransactionConfirmationItem
Conditionally
The enumeration value supplied in this field specifies the current relationship between the seller and the potential buyer. A Transaction Confirmation Request (TCR) for an item can be sent to a potential buyer who has at least one of the following criteria: is an active bidder on the auction listing; has made a Best Offer on the fixed-price listing, is an eBay user who has used the Ask Seller a Question feature, or is an eBay user whose postal code is known.
AddTransactionConfirmationItem
Yes
The amount in this field is the price that the seller is asking for to purchase the motor vehicle.
AddTransactionConfirmationItem
Yes
The enumeration value specified in this field will control how many days that the recipient of the offer has to purchase the motor vehicle at the price listed in the <b>NegotiatedPrice</b> field.
AddTransactionConfirmationItem
Yes
This field is used to identify the eBay Motors listing using the unique identifier of the listing (<b>ItemID</b>).
AddTransactionConfirmationItem
Yes
This is optional free-form string field that can be used by the seller to provide any comments or additional information about the Transaction Confirmation Item.
AddTransactionConfirmationItem
No
The base response of the <b>AddTransactionConfirmationItem</b> call.
This field contains the Item ID associated with the Transaction Confirmation Item that was just created with the <b>AddTransactionConfirmationItem</b> call. This field is not returned if the request was only used to verify that a new TCR could be created.
AddTransactionConfirmationItem
Conditionally
This timestamp indicates the date and time when the Transaction Confirmation Item became available to the recipient.
AddTransactionConfirmationItem
Always
This timestamp indicates the date and time when the Transaction Confirmation Item will no longer be available for purchase.
AddTransactionConfirmationItem
Always
Enables a seller to perform various tasks with a single or multiple line item order. Tasks available with this call include marking the order as paid, marking the order as shipped, providing shipment tracking details to the buyer, and leaving feedback for the buyer.
ReviseCheckoutStatus
Unique identifier for an eBay listing. An <b>ItemID</b> value can be paired up with a corresponding <b>TransactionID</b> value in a <b>CompleteSale</b> request to identify a single order line item. Alternatively, the <b>OrderLineItemID</b> value for the order line item can be used.
<br><br>
Unless an <b>OrderLineItemID</b> value is used to identify a single order line item, or the <b>OrderID</b> value is used to identify a single or multiple line item order, the <b>ItemID</b>/<b>TransactionID</b> pair must be specified. To perform an action on an entire multiple line item order, the <b>OrderID</b> field must be used. If an <b>OrderID</b> or <b>OrderLineItemID</b> value is specified, an <b>ItemID</b>/<b>TransactionID</b> pair will be ignored (if present in the same request).
CompleteSale
Conditionally
Unique identifier for a sales transaction. A <b>TransactionID</b> identifier is created once there is a commitment to buy (bidder wins the auction, buyer clicks buy button, or buyer purchases item through <b>PlaceOffer</b> call). The
<b>TransactionID</b> can be paired up with the corresponding <b>ItemID</b> value in a <b>CompleteSale</b> request to identify a single order line item. Alternatively, the <b>OrderLineItemID</b> value for the order line item can be used.
<br><br>
Unless an <b>OrderLineItemID</b> value is used to identify a single order line item, or the <b>OrderID</b> value is used to identify a single or multiple line item order, the <b>ItemID</b>/<b>TransactionID</b> pair must be specified. To perform an action on an entire multiple line item order, the <b>OrderID</b> field must be used. If an <b>OrderID</b> or <b>OrderLineItemID</b> value is specified, an <b>ItemID</b>/<b>TransactionID</b> pair will be ignored (if present in the same request).
CompleteSale
Conditionally
This container is used by the seller to leave feedback for the buyer for the order line item identified in the call request. The seller must include and specify all fields of this type, including the buyer's eBay User ID, the Feedback rating (a seller can only leave a buyer a 'Positive' rating), and a comment, which helps justify the Feedback rating. The eBay User ID must match the buyer who bought the order line item, or an error will occur. An error will also occur if Feedback has already been left for the buyer (either through API or the Web flow).
<br><br>
To determine if Feedback has already been left for an order line item, you can call <b class="con">GetFeedback</b>, passing in the <b class="con">OrderLineItemID</b> value in the call request.
<br><br>
<span class="tablenote"><b>Note: </b> Feedback entries are submitted at the order line item level, so either an <b>OrderLineItemID</b> value or an <b>ItemID</b>/<b>TransactionID</b> pair should be specified to identify the order line item (and not an <b>OrderLineItemID</b> value). To leave Feedback for all line items in a multiple line item order, the seller would need a separate <b>CompleteSale</b> request for each order line item.
</span>
CompleteSale
No
The seller includes and sets this field to true if the order or order line item has been shipped. If the call is successful, the order line item(s) are marked as Shipped in My eBay.
<br><br>
If the seller includes and sets this field to false, the order or order line item are marked (or remain) as 'Not Shipped' in eBay's system.
<br><br>
If this field is not included, the shipped status of the order or order line item remain unchanged in My eBay.
<br><br>
If shipment tracking information is provided for an order or order line item through the <b>Shipment</b> container in the same request, the <b>Shipped</b> status is set to <code>true</code> automatically, and the <b>Shipped</b> field is not necessary.
CompleteSale
No
The seller includes and sets this field to true if the order has been
paid for by the buyer. If the call is successful, the order line item(s)
are marked as 'Paid' in eBay's system.
<br><br>
If the seller includes and sets this field to <code>false</code>, the order line item(s) are marked (or remain) as 'Not Paid' in eBay's system.
<br><br>
If this field is not included, the paid status of the order line item(s) remain unchanged in eBay's system.
CompleteSale
No
<span class="tablenote"><b>Note: </b> DO NOT USE THIS FIELD. Previously, this field's only purpose was to classify the order to be updated as a Half.com order. However, since the Half.com site has been shut down, this field is no longer applicable.
</span>
1027
NoOp
1033
Container consisting of shipment tracking information, shipped time, and an optional text field to provide additional details to the buyer. Setting the tracking number and shipping carrier automatically marks the order line item as shipped and the <b>Shipped</b> field is not necessary.
<br><br>
If you supply <b>ShipmentTrackingNumber</b>, you must also supply <b>ShippingCarrierUsed</b>; otherwise you will get an error.
<br><br>
To modify the shipping tracking number and/or shipping carrier, supply the new number in the <b>ShipmentTrackingNumber</b> field or supply the value for <b>ShippingCarrierUsed</b>, or both. The old number and carrier are deleted and the new ones are added.
<br><br>
To simply delete the current tracking details altogether, supply empty <b>Shipment</b> tags.
<br> <br>
<span class="tablenote"><b>Note:</b> Top-Rated sellers must have a record of uploading shipment tracking information (through site or through API) for at least 95 percent of their order line items (purchased by U.S. buyers) to keep their status as Top-Rated sellers. For more information on the requirements to becoming a Top-Rated Seller, see the <a href="http://pages.ebay.com/help/sell/top-rated.html">Becoming a Top-Rated Seller and qualifying for Top-Rated Plus</a> customer support page. </span> <br>
CompleteSale
No
A unique identifier for an eBay order. An <b>OrderID</b> value should only be used in a <b>CompleteSale</b> call for a single line item order. For a multiple line item order, the <b>OrderLineItemID</b> or <b>ItemID</b>/<b>TransactionID</b> pair must be used to identify an order line item within the order.
<br><br>
<b>OrderID</b> overrides an <b>OrderLineItemID</b> or <b>ItemID</b>/<b>TransactionID</b> pair if these fields are also specified in the same request.
<br><br>
<span class="tablenote"><b>Note: </b> As of June 2019, eBay has changed the format of order identifier values. The new format is a non-parsable string, globally unique across all eBay marketplaces, and consistent for both single line item and multiple line item orders. Unlike in the past, instead of just being known and exposed to the seller, these unique order identifiers will also be known and used/referenced by the buyer and eBay customer support.
<br><br>
For developers and sellers who are already integrated with the Trading API's order management calls, this change shouldn't impact your integration unless you parse the existing order identifiers (e.g., <b>OrderID</b> or <b>OrderLineItemID</b>), or otherwise infer meaning from the format (e.g., differentiating between a single line item order versus a multiple line item order). Because we realize that some integrations may have logic that is dependent upon the old identifier format, eBay is rolling out this Trading API change with version control to support a transition period of approximately 9 months before applications must switch to the new format completely.
<br><br>
During the transition period, for developers/sellers using a Trading WSDL older than Version 1113, they can use the <b>X-EBAY-API-COMPATIBILITY-LEVEL</b> HTTP header in API calls to control whether the new or old <b>OrderID</b> format is returned in call response payloads. To get the new <b>OrderID</b> format, the value of the <b>X-EBAY-API-COMPATIBILITY-LEVEL</b> HTTP header must be set to <code>1113</code>. During the transition period and even after, the new and old <b>OrderID</b> formats will still be supported/accepted in all Trading API call request payloads. After the transition period (which will be announced), only the new <b>OrderID</b> format will be returned in all Trading API call response payloads, regardless of the Trading WSDL version used or specified compatibility level.
</span>
<br>
<span class="tablenote"><b>Note: </b> For sellers integrated with the new order ID format, please note that the identifier for an order will change as it goes from unpaid to paid status. Sellers can check to see if an order has been paid by looking for a value of 'Complete' in the <b>CheckoutStatus.Status</b> field in the response of <b>GetOrders</b> or <b>GetOrderTransactions</b> call, or in the <b>Status.CompleteStatus</b> field in the response of <b>GetItemTransactions</b> or <b>GetSellerTransactions</b> call. Sellers should not fulfill orders until buyer has made payment. When using a <b>CompleteSale</b> call, either of these order IDs (paid or unpaid status) can be used to update an order. Similarly, either of these order IDs (paid or unpaid status) can be used in <b>GetOrders</b> or <b>GetOrderTransactions</b> call to retrieve specific order(s).
</span>
40
CompleteSale
No
A unique identifier for an eBay order line item. <b>OrderLineItemID</b> values are returned (at the order line item level) in Trading API's order management calls. This identifier is created once there is a commitment to buy (bidder wins the auction, buyer clicks buy button, or buyer purchases item through <b>PlaceOffer</b> call). An <b>OrderLineItemID</b> value can be used in a <b>CompleteSale</b> request to identify a line item within an order. Alternatively, an <b>ItemID</b>/<b>TransactionID</b> pair can also be used to identify a line item.
<br><br>
Unless an <b>ItemID</b>/<b>TransactionID</b> pair is used to identify an order line
item, or an <b>OrderID</b> value is used to identify an order, the <b>OrderLineItemID</b> must be specified. If <b>OrderLineItemID</b> is specified, the <b>ItemID</b>/<b>TransactionID</b> pair are
ignored if present in the same request.
CompleteSale
No
This type defines the response of the <b>CompleteSale</b> call. There are no call-specific fields in this response, but the seller should look for an <b>Ack</b> value of <Success>true</code> in the response, as this value will indicate that the action(s) in the <b>CompleteSale</b> call were successful. If any other <b>Ack</b> value besides <Success>true</code> is returned, the seller should look for any returned error messages or warnings.
Returns the ID of a user who has gone through an application's consent flow
process for obtaining an authorization token.
Getting Tokens
https://developer.ebay.com/DevZone/guides/features-guide/default.html#basics/Tokens.html
A string obtained by making a <b>GetSessionID</b> call, passed in redirect URL to the eBay signin page.
ConfirmIdentity
Yes
Confirms the identity of the user by returning the <b>UserID</b> and the <b>EIASToken</b> belonging to the user.
Unique eBay user ID for the user.
ConfirmIdentity
Always
Removes selected messages for a given user.
This field is deprecated.
Contains a list of up to 10 <b>MessageID</b> values.
DeleteMyMessages
No
The response to <b>DeleteMyMessages</b>. If the request is successful,
<b>DeleteMyMessages</b> has an empty payload.
Removes an inventory folder when a user deletes it in My eBay. This call is subject to change without notice; the deprecation process is inapplicable to this call.
Removes a Selling Manager inventory folder.
Using Selling Manager Calls in the Trading API
https://developer.ebay.com/DevZone/guides/features-guide/default.html#development/Listings-SellingManager.html
Selling Manager Pro page on the eBay Site
https://www.ebay.com/help/selling/selling-tools/selling-manager-selling-manager-pro?id=4098
Unique ID of the Selling Manager Inventory folder to be deleted.
DeleteSellingManagerInventoryFolder
No
Returns the status of delete folder operation.
Removes the association of Selling Manager automation rules
to an item. Returns the remaining rules in the response.
<br><br>
This call is subject to change without notice; the
deprecation process is inapplicable to this call.
DeleteSellingManagerTemplateAutomationRule
Using Selling Manager Calls in the Trading API
https://developer.ebay.com/DevZone/guides/features-guide/default.html#development/Listings-SellingManager.html
Selling Manager Pro page on the eBay Site
https://www.ebay.com/help/selling/selling-tools/selling-manager-selling-manager-pro?id=4098
The unique identifier of the listing from which to delete automation rules.
DeleteSellingManagerItemAutomationRule
Yes
This field is included and set to <code>true</code> if the user would like to disable the automated relisting rule for the listing.
DeleteSellingManagerItemAutomationRule
No
This field is included and set to <code>true</code> if the user would like to disable the automated Second Chance Offer rule for the listing.
DeleteSellingManagerItemAutomationRule
No
Contains the set of automation rules associated with the specified item.
This container is returned if automated listing rules are set up for the Selling Manager item.
DeleteSellingManagerItemAutomationRule
Conditionally
This container is returned if automated relisting rules are set up for the Selling Manager item.
DeleteSellingManagerItemAutomationRule
Conditionally
This container is returned if automated Second Chance Offer rules are set up for the Selling Manager item.
DeleteSellingManagerItemAutomationRule
Conditionally
Contains fees that may be incurred when items are listed using the
automation rules (e.g., a scheduled listing fee). Use of an automation rule
does not in itself have a fee, but use can result in a fee.
DeleteSellingManagerItemAutomationRule
Conditionally
Deletes a Selling Manager product.
This call is subject to change without notice; the
deprecation process is inapplicable to this call.
Using Selling Manager Calls in the Trading API
https://developer.ebay.com/DevZone/guides/features-guide/default.html#development/Listings-SellingManager.html
Selling Manager Pro page on the eBay Site
https://www.ebay.com/help/selling/selling-tools/selling-manager-selling-manager-pro?id=4098
The unique identifier of the Selling Manager product to be deleted.
DeleteSellingManagerProduct
Yes
Response for deleting a Selling Manager product.
This container consists of the unique identifier and name of the Seller
Manager product.
DeleteSellingManagerProduct
Always
Deletes a Selling Manager template.
This call is subject to change without notice; the
deprecation process is inapplicable to this call.
Using Selling Manager Calls in the Trading API
https://developer.ebay.com/DevZone/guides/features-guide/default.html#development/Listings-SellingManager.html
Selling Manager Pro page on the eBay Site
https://www.ebay.com/help/selling/selling-tools/selling-manager-selling-manager-pro?id=4098
Unique identifier of the Selling Manager template to be deleted.
You can obtain a <b>SaleTemplateID</b> by calling <b>GetSellingManagerInventory</b>.
DeleteSellingManagerTemplate
Yes
Response for deleting a Selling Manager template.
The unique identifier of the Selling Manager template.
DeleteSellingManagerTemplate
Always
The name of the Selling Manager template.
DeleteSellingManagerTemplate
Always
Removes the association of Selling Manager automation rules
to a template. Returns the remaining rules in the response.
This call is subject to change without notice; the
deprecation process is inapplicable to this call.
DeleteSellingManagerItemAutomationRule
Using Selling Manager Calls in the Trading API
https://developer.ebay.com/DevZone/guides/features-guide/default.html#development/Listings-SellingManager.html
Selling Manager Pro page on the eBay Site
https://www.ebay.com/help/selling/selling-tools/selling-manager-selling-manager-pro?id=4098
The unique identifier of the Selling Manager template from which you want to remove automation rules.
You can obtain a <b>SaleTemplateID</b> by calling <b>GetSellingManagerInventory</b>.
DeleteSellingManagerTemplateAutomationRule
Yes
This field is included and set to <code>true</code> if the user would like to disable the automated listing rule for the Selling Manager template.
DeleteSellingManagerTemplateAutomationRule
No
This field is included and set to <code>true</code> if the user would like to disable the automated relisting rule for the Selling Manager template.
DeleteSellingManagerTemplateAutomationRule
No
This field is included and set to <code>true</code> if the user would like to disable the automated Second Chance Offer rule for the Selling Manager template.
DeleteSellingManagerTemplateAutomationRule
No
Contains the set of automation rules associated with the specified template.
This container is returned if automated listing rules are set up for the Selling Manager template.
DeleteSellingManagerTemplateAutomationRule
Conditionally
This container is returned if automated relisting rules are set up for the Selling Manager template.
DeleteSellingManagerTemplateAutomationRule
Conditionally
This container is returned if automated Second Chance Offer rules are set up for the Selling Manager template.
DeleteSellingManagerTemplateAutomationRule
Conditionally
Contains fees that may be incurred when items are listed using the
automation rules (e.g., a scheduled listing fee). Use of an automation rule
does not in itself have a fee, but use can result in a fee.
DeleteSellingManagerTemplateAutomationRule
Conditionally
Enables a seller who has opted into the automated Unpaid Item Assistant mechanism to disable the Unpaid Item Assistant at the order line item level. This call can be made whether or not a Unpaid Item case exists for the order line item. If an Unpaid Item case has already been created by the Unpaid Item Assistant, it is converted to a "manual" case for the seller to manage like any other manually-created case.
https://pages.ebay.com/help/sell/unpaid-item-assistant.html
Unpaid Item Assistant
https://pages.ebay.com/sell/UPI/standardprocess/index.html
Understanding the New Unpaid Item Process
Unique identifier for an eBay listing. A listing can have multiple order line items, but only one <b>ItemID</b>. To identify a specific order line item for which to disable the Unpaid Item Assistant mechanism, either an <b>ItemID</b>/<b>TransactionID</b> pair, an <b>OrderLineItemID</b>, or a <b>DisputeID</b> (if an Unpaid Item case already exists) is required in the request.
DisableUnpaidItemAssistance
Conditionally
The unique identifier of an order line item. An order line item is created once there is a commitment from a buyer to purchase an item. To identify a specific order line item for which to disable the Unpaid Item Assistant mechanism, either an <b>ItemID</b>/<b>TransactionID</b> pair, an <b>OrderLineItemID</b>, or a <b>DisputeID</b> (if an Unpaid Item case already exists) is required in the request.
DisableUnpaidItemAssistance
Conditionally
A unique identifier for an Unpaid Item case that is filed against an order line item. If an <b>ItemID</b>/<b>TransactionID</b> pair or an <b>OrderLineItemID</b> is used to identify an order line item, <b>DisputeID</b> cannot be used and will be ignored if it is included in the request.
DisableUnpaidItemAssistance
No
<b>OrderLineItemID</b> is a unique identifier for an eBay order line item. To identify a specific order line item for which to disable the Unpaid Item Assistant mechanism, either an <b>ItemID</b>/<b>TransactionID</b> pair, an <b>OrderLineItemID</b>, or a <b>DisputeID</b> is required in the request.
100
DisableUnpaidItemAssistance
Conditionally
Response of the <b>DisableUnpaidItemAssistance</b> call, which includes only the standard response fields like <b>Ack</b>, <b>Timestamp</b>, <b>Errors</b>, etc.
Ends the specified fixed-price listing before the date and time at which
it would normally end (per the listing duration).
EndItem, EndItems
Ending Items Early
https://developer.ebay.com/DevZone/guides/features-guide/default.html#development/Listings-EndingEarly.html
Unique identifier of the listing that you want to end.
<br><br>
In the <b>EndFixedPriceItem</b> request, either <b>ItemID</b> or <b>SKU</b> value is required.
If both are passed in and they don't refer to the same listing, eBay
ignores <b>SKU</b> and considers only the <b>ItemID</b>.
EndFixedPriceItem
Conditionally
The seller's reason for ending the listing early is input into this required field. The seller is not allowed to use the <code>ProductDeleted</code> value, as this ending reason can only be used internally by eBay to administratively end a listing due to the associated Catalog product being removed from the eBay Catalog.
ProductDeleted
EndFixedPriceItem
Yes
The seller-defined SKU (stock keeping unit) value of the item in the listing being ended. The <b>SKU</b> field can only be used to end a listing if that listing was created or relisted with an <b>AddFixedPriceItem</b> or <b>RelistFixedPriceItem</b> call, and the <b>Item.InventoryTrackingMethod</b> was included in the call and set to <code>SKU</code>.
<br><br>
In the <b>EndFixedPriceItem</b> request, either <b>ItemID</b> or <b>SKU</b> is required.
If both are passed in and they don't refer to the same listing, eBay
ignores <b>SKU</b> and considers only the lt;b>ItemID</b>.
50
EndFixedPriceItem e>
Conditionally
Acknowledgement that includes SKU, as well as the date and time that the listing ended due to the call to EndFixedPriceItem.
Timestamp that indicates the date and time (GMT) that the specified listing was ended.
EndFixedPriceItem
Always
If a SKU (stock-keeping unit) exists for the item in the listing, it is returned in the response.
50
EndFixedPriceItem e>
Conditionally
Ends the specified item listing before the date and time at which it would normally end per the listing duration.
EndFixedPriceItem, EndItems
Ending Items Early
https://developer.ebay.com/DevZone/guides/features-guide/default.html#development/Listings-EndingEarly.html
Unique item ID that identifies the listing that you want to end.
EndItem
Yes
The seller's reason for ending the listing early is input into this required field. The seller is not allowed to use the <code>ProductDeleted</code> value, as this ending reason can only be used internally by eBay to administratively end a listing due to the associated Catalog product being removed from the eBay Catalog.
EndItem
Yes
ProductDeleted
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.
1027
NoOp
1033
This type includes the acknowledgement of the date and time when the eBay listing was ended due to the call to <b>EndItem</b>.
This timestamp indicates the date and time (returned in GMT) when the specified eBay listing was ended.
EndItem
Always
The <b>EndItems</b> call is used to end up to 10 specified eBay listings before the date and time at which those listings would normally end per the listing duration.
EndItem, EndFixedPriceItem
Ending Items Early
https://developer.ebay.com/DevZone/guides/features-guide/default.html#development/Listings-EndingEarly.html
An <b>EndItemRequestContainer</b> container is required for each eBay listing that the seller plans to end through the <b>EndItems</b> call. Up to 10 eBay listings can be ended with one <b>EndItems</b> call.
10
EndItems
Yes
Contains a response of the resulting status of ending each item.
Returns a response for an individually ended item. Mutiple containers will be listed if multiple items are ended.
EndItems
Always
By default, unpublished pictures uploaded to eBay Picture Services (EPS) via the <b>UploadSiteHostedPictures</b> call will be kept on the server for five days before being purged. The <b>ExtendSiteHostedPictures</b> call is used to extend this expiration date by the number of days specified in the call. This restricted call gives approved sellers the ability to extend the default expiration date of pictures uploaded to EPS but not immediately published in an eBay listing.
This call is used to extend this expiration date of pictures uploaded to the eBay Picture Server (EPS).
The URL of the image hosted by eBay Picture Services. This URL is returned in the <b>SiteHostedPictureDetails.FullURL</b> field of the <b>UploadSiteHostedPictures</b> response.
ExtendSiteHostedPictures
No
The number of days by which to extend the expiration date for the
specified image.
ExtendSiteHostedPictures
No
Returns the URL of an eBay Picture Services image whose expiration date was
extended.
The URL of the site-hosted picture whose expiration date was extended through the <b>ExtendSiteHostedPictures</b> call. This field will be returned if the expiration date of the site-hosted picture was successfully extended.
ExtendSiteHostedPictures
Conditionally
Retrieves an authentication token for a user.
Getting Tokens
https://developer.ebay.com/DevZone/guides/features-guide/default.html#basics/Tokens.html
Getting Tokens for Applications with Multiple Users
https://developer.ebay.com/DevZone/guides/features-guide/default.html#basics/Tokens-MultipleUsers.html
A value associated with the token retrieval request. SecretID is
defined by the application, and is passed in the redirect URL to the
eBay sign-in page. eBay recommends using a UUID for the secret ID
value. You must also set Username (part of the RequesterCredentials)
for the particular user of interest. SecretID and Username are not
required if SessionID is present.
FetchToken
No
A value associated with the token retrieval request. eBay generates the
session ID when the application makes a GetSessionID request. SessionID
is passed in the redirect URL to the eBay sign-in page. The advantage
of using SessionID is that it does not require UserID as part of the
FetchToken request. SessionID is not required if SecretID is present.
FetchToken
No
Includes the authentication token for the user and the date it expires.
The authentication token for the user.
FetchToken
Always
Getting Tokens
http://developer.ebay.com/DevZone/guides/features-guide/default.html#basics/Tokens.html
Date and time at which the token returned in eBayAuthToken expires
and can no longer be used to authenticate the user for that application.
FetchToken
Always
The REST authentication token for the user.
FetchToken
Conditionally
Returns a seller's invoice data for their eBay account, including the account's
summary data.
Getting Account Information
https://developer.ebay.com/DevZone/guides/features-guide/default.html#development/CRM-UserInformation.html
Testing Applications
https://developer.ebay.com/DevZone/guides/features-guide/default.html#basics/Call-SandboxTesting.html
Specifies the report format in which to return account entries.
LastInvoice
GetAccount
Conditionally
This field is used to retrieve all account entries from a specific invoice, which is identified through this <b>InvoiceDate</b> field with the timestamp of the account invoice. This field is only applicable if the <b>AccountHistorySelection</b> value is set to 'SpecifiedInvoice'; otherwise, this field will be ignored.
GetAccount
Conditionally
This field is used to retrieve all account entries dating back to the timestamp passed into this <b>BeginDate</b> field up until the timestamp passed into the <b>EndDate</b> field. The <b>BeginDate</b> value can not be set back any further than four months into the past.
<br/><br/>
The allowed date formats are <em>YYYY-MM-DD</em> and <em>YYYY-MM-DD HH:mm:ss</em> The <b>BeginDate</b> value must be less than or equal to the <b>EndDate</b> value. The user might use the same values in both fields if that user wanted to retrieve all account entries from a specific day (if <em>YYYY-MM-DD</em> format used) or wanted to retrieve a specific account entry (if <em>YYYY-MM-DD HH:mm:ss</em> format used).
<br/><br/>
This field is only applicable if the <b>AccountHistorySelection</b> value is set to 'BetweenSpecifiedDates'; otherwise, this field will be ignored. fiedDates' is used, both the <b>BeginDate</b> and <b>EndDate</b> must be included.
GetAccount
Conditionally
This field is used to retrieve all account entries dating up to the timestamp passed into this <b>EndDate</b> field dating back to the timestamp passed into the <b>BeginDate</b> field. The <b>EndDate</b> value can not be set for a future date.
<br/><br/>
The allowed date formats are <em>YYYY-MM-DD</em> and <em>YYYY-MM-DD HH:mm:ss</em> The <b>EndDate</b> value must be more than or equal to the <b>BeginDate</b> value. The user might use the same values in both fields if that user wanted to retrieve all account entries from a specific day (if <em>YYYY-MM-DD</em> format used) or wanted to retrieve a specific account entry (if <em>YYYY-MM-DD HH:mm:ss</em> format used).
<br/><br/>
This field is only applicable if the <b>AccountHistorySelection</b> value is set to 'BetweenSpecifiedDates'; otherwise, this field will be ignored. If 'BetweenSpecifiedDates' is used, both the <b>BeginDate</b> and <b>EndDate</b> must be included.
GetAccount
Conditionally
This container is used to control how many account entries are returned on each page of data in the response. <b>PaginationType</b> is used by numerous Trading API calls, and the default and maximum values for the <b>EntriesPerPage</b> field differs with each call. For the <b>GetAccount</b> call, the default value is 500 (account entries) per page, and maximum allowed value is 2000 (account entries) per page.
GetAccount
No
By default, the current balance of the user's account will not be returned in the call response. To retrieve the current balance of their account, the user should include the <b>ExcludeBalance</b> flag in the request and set its value to 'false'. The current balance on the account will be shown in the <b>AccountSummary.CurrentBalance</b> field in the call response.
GetAccount
No
Specifies whether to return account summary information in an
AccountSummary node. Default is true, to return AccountSummary.
GetAccount
No
Specifies whether to retrieve the rate used for the currency conversion for usage transactions.
GetAccount
No
Specifies how account entries should be sorted in the response, by an
element and then in ascending or descending order.
GetAccount
No
Specifies the currency used in the account report. Do not specify Currency
in the request unless the following conditions are met. First, the user has
or had multiple accounts under the same UserID. Second, the account
identified in the request uses the currency you specify in the request. An
error is returned if no account is found that uses the currency you specify
in the request.
GetAccount
No
Specifies the item ID for which to return account entries. If ItemID is
used, all other filters in the request are ignored. If the specified item
does not exist or if the requesting user is not the seller of the item, an
error is returned.
GetAccount
No
The unique identifier of an eBay order. This field must be included if the value of the <b>AccountHistorySelection</b> filter is set to <code>OrderId</code>. A user can filter by order ID to see if there specific account entries related to a specific eBay order.
<br><br>
It is possible that no account entries will be found directly related to the specified order ID, and if this is the case, no <b>AccountEntries</b> container will be returned, and the <b>ack</b> value will still be <code>Success</code>.
<br><br>
<span class="tablenote"><b>Note: </b> In June 2019, eBay introduced a new order ID format to both legacy (including Trading API) and REST-based APIs. At this time, both old and new format order IDs will be accepted in legacy API request payloads to identify orders. In legacy API response payloads, order IDs will appear in the new format if the user is using a Trading WSDL version of '1113' (or newer), or if the user sets the <code>X-EBAY-API-COMPATIBILITY-LEVEL</code> HTTP header to a value of '1113' (or newer). If the Trading WSDL version or compatibility level is less/older than '1113', old format order IDs will be returned in legacy API response payloads. Beginning as soon as March 2020, only new format order IDs will be returned regardless of version number.
</span>
GetAccount
Conditionally
Returns information about an eBay seller's own account.
Specifies the seller's unique account number.
GetAccount
Always
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. Can also contain data for
one or more additional accounts, if the user has changed country
of residence.
GetAccount
Conditionally
Indicates the currency used for monetary amounts in the report.
GetAccount
Always
This container holds an array of account entries. The account entries that are returned are dependent on the selection that the user made in the <b>AccountHistorySelection</b> field in the call request. Each <b>AccountEntry</b> container consists of one credit, one debit, or one administrative action on the account. It is possible that no <b>AccountEntry</b> containers will be returned if no account entries exist since the last invoice (if 'LastInvoice' value is used), between the specified dates (if 'BetweenSpecifiedDates' value is used), or on a specified invoice (if 'SpecifiedInvoice' value is used).
GetAccount
Conditionally
This container shows the total number of account entries and the total number of account entry pages that exist based on the filters used in the <b>GetAccount</b> call request. The total number of account entry pages is partly controlled by the <b>Pagination.EntriesPerPage</b> value that is set in the request.
GetAccount
Always
If this boolean value is returned as 'true', there are more account entries to view on one or more pages of data. To view additional entries, the user would have to make additional <b>GetAccount</b> calls and increment the value of the <b>Pagination.PageNumber</b> field by '1' to view additional pages of account entries.
GetAccount
Conditionally
This integer value indicates the number of account entries that are being returned per virtual page of data. This value will be the same value passed into the <b>Pagination.EntriesPerPage</b> field in the request.
GetAccount
Always
This integer value indicates the current page number of account entries that is currently being shown. This value will be the same value passed into the <b>Pagination.PageNumber</b> field in the request.
GetAccount
Always
Retrieves sales lead information for a lead generation listing.
DetailLevel
The unique identifier of an item listed on the eBay site.
Returned by eBay when the item is created. This ID must correspond
to an ad format item.
GetAdFormatLeads
No
Filters the leads based on their status.
GetAdFormatLeads
No
Boolean which indicates whether to return mail messages for this lead in a MemberMessage node.
GetAdFormatLeads
No
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.
GetAdFormatLeads
Conditionally
Used with StartCreationTime to limit the returned leads for a user to only
those with a creation date less than or equal to the specified date and
time.
GetAdFormatLeads
Conditionally
Returns number of leads and contact and other information for each lead. One
AdFormatLead node is returned for each lead.
Contains contact and other information for one lead. One node is
returned for each lead. Only returned at a detail level of ReturnAll. At
least one lead must be available for the specified item to return
AdFormatLead.
GetAdFormatLeads
DetailLevel: ReturnAll
Conditionally
The total number of leads returned. Only returned if you do not
specify a detail level.
GetAdFormatLeads
DetailLevel: none
Always
This is the base request type for the <b>GetAllBidders</b> call, which is used to retrieve bidders from an active or recently-ended auction listing.
This call is used to retrieve bidders from an active or recently-ended auction listing.
Making Second Chance Offers for Items
https://developer.ebay.com/DevZone/guides/features-guide/default.html#development/Sales-SecondChanceOffers.html
This is the unique identifier of the auction listing for which bidders are being retrieved. This auction listing can be active or recently ended. However, to retrieve bidders for an active auction listing, the only <b>CallMode</b> enumeration value that can be used is <code>ViewAll</code>.
GetAllBidders
Yes
The enumeration value that is passed into this field will control the set of bidders that will be retrieved in the response. To retrieve bidders from a recently-ended auction listing, any of the three values can be used. To retrieve bidders for an active auction listing, only the <code>ViewAll</code> enumeration value can be used. These values are discussed in <b>GetAllBiddersModeCodeType</b>.
<br/>
EndedListing
GetAllBidders
No
The user must include this field and set its value to <code>true</code> if the user wishes to retrieve the <b>BiddingSummary</b> container for each bidder. The <b>BiddingSummary</b> container consists of more detailed bidding information on each bidder.
GetAllBidders
Conditionally
Includes detailed bidding data for the auction listing that was specified in the request. Unless the listing is private, the actual eBay user IDs of all bidders are returned if the listing's seller makes this API call. If a bidder makes this API call, only that bidder's eBay user ID is returned, and the rest of the bidder's user IDs are anonymized.
Working with Anonymous User Information
http://developer.ebay.com/DevZone/guides/features-guide/default.html#development/CRM-UserInformation.html
This container consists of an array of bids made on the specified auction listing. Each <b>OfferType</b> object represents the data for one bid.
GetAllBidders
Always
The eBay user ID for the user with the winning bid (if auction has ended) or current highest bid (if auction is still active). The seller should take note of or save this User ID as this user may be a a Second Chance Offer candidate.
GetAllBidders
Always
This is the dollar amount of the winning bid (if auction has ended) or dollar amount of the current highest bid (if auction is still active).
GetAllBidders
Always
This enumeration value indicates the listing status of the specified listing.
GetAllBidders
Always
The base request type for the <b>GetApiAccessRules</b> call, which returns details on how many calls your application has made and is allowed to make per hour or day.
This call returns details on how many calls your application has made and is allowed to make per hour or day.
https://developer.ebay.com/support/app-check
Compatible Application Check
Responds to a call to GetApiAccessRules.
Each returned <b>ApiAccessRule</b> 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.
GetApiAccessRules
Always
This is the base request type of the <b>GetBestOffers</b> call. Depending on the input parameters that are used, this call can be used by a seller to retrieve all active Best Offers, all Best Offers on a specific listing, a specific Best Offer for a specific listing, or Best Offers in a specific state.
<br/><br/>
<span class="tablenote"><b>Note: </b>
The Best Offer feature is now available for auction listings on the following sites: US, Canada, UK, Germany, Australia, France, Italy, and Spain. However, sellers must choose between offering Best Offer or Buy It Now on an auction listing, as both features cannot be enabled on the same auction listing.
</span>
This call can be used by a seller to retrieve all active Best Offers, all Best Offers on a specific listing, a specific Best Offer for a specific listing, or Best Offers in a specific state.
DetailLevel
Enabling Best Offer
https://developer.ebay.com/DevZone/guides/features-guide/default.html#development/Feature-BestOffer.html
Email and Address Privacy Policy
https://developer.ebay.com/DevZone/guides/features-guide/default.html#development/CRM-UserInformation.html
The unique identifier of an eBay listing. If an <b>ItemID</b> is used by itself in the call request, all Best Offers in all states are retrieved for this listing. However, the seller can also combine <b>ItemID</b> and a <b>BestOfferStatus</b> value if that seller only wants to see Best Offers in a specific state. If a <b>BestOfferID</b> field is included in the call request, any <b>ItemID</b> value will be ignored since eBay will only search for and return the Best Offer identified in the <b>BestOfferID</b> field.
GetBestOffers
No
The unique identifier of a Best Offer. An identifier for a Best Offer is automatically created by eBay once a prospective buyer makes a Best Offer on a Best Offer-enabled listing. If a <b>BestOfferID</b> value is supplied in the call request, any <b>ItemID</b> or <b>BestOfferStatus</b> values will be ignored. Only the Best Offer identified by the <b>BestOfferID</b> value will be returned.
GetBestOffers
No
This field can be used if the seller wants to retrieve Best Offers in a specific state. The typical use case for this field is when the seller wants to retrieve Best Offers in all states for a specific listing. In fact, the <b>All</b> value can only be used if an <b>ItemID</b> value is also supplied in the call request. If a <b>BestOfferID</b> field is included in the call request, any <b>BestOfferStatus</b> value will be ignored since eBay will only search for and return the Best Offer identified in the <b>BestOfferID</b> field.
<br/>
Active
GetBestOffers
All, Active
No
This container can be used if the seller is expecting that the <b>GetBestOffers</b> call will retrieve a large number of results, so that seller wishes to view just a subset (one page of multiple pages) of those results at a time. See this container's child fields for more information on how pagination is used.
GetBestOffers
No
All Best Offers for the item according to the filter or Best Offer ID (or both) used in the input. For the notification client usage, this response includes a single Best Offer.
All Best Offers for the item according to the filter or Best Offer ID (or both) used in the input. The buyer and seller messages are returned only if the detail level is defined. Includes the buyer and seller message only if the <code>ReturnAll</code> detail level is used. Only returned if Best Offers have been made.
GetBestOffers
DetailLevel: none, ReturnAll
Conditionally
This container consists of several details about the listing for which a Best Offer has been made, including the Item ID, the current price of the item (not the Best Offer price), and the time that the listing is scheduled to end.
GetBestOffers
DetailLevel: none, ReturnAll
Conditionally
A collection of details about the Best Offers received for a specific item. Empty if there are no Best Offers.
GetBestOffers
DetailLevel: none, ReturnAll
Conditionally
This integer value indicates the current page number of Best Offers that is currently being shown. This value will be the same value passed into the <b>Pagination.PageNumber</b> field in the request.
GetBestOffers
DetailLevel: none, ReturnAll
Conditionally
Provides information about the data returned, including the number of pages and the number
of entries.
GetBestOffers
DetailLevel: none, ReturnAll
Conditionally
Retrieves all items that the user is currently bidding on, and the ones they have won
or purchased.
GetMyeBayBuying
Retrieves all items that the user is currently bidding on, and the ones they have won or purchased.
Indicates whether or not to limit the result set to active items. If <code>true</code>, only
active items are returned and the <b>EndTimeFrom</b> and <b>EndTimeTo</b> filters are
ignored. If <code>false</code> (or not sent), both active and ended items are returned.
GetBidderList
No
Used in conjunction with <b>EndTimeTo</b>. Limits returned items to only those for
which the item's end date is on or after the date/time specified. Specify an
end date within 30 days prior to today. Items that ended more than 30 days
ago are omitted from the results. If specified, <b>EndTimeTo</b> must also be
specified. Express date/time in the format <code>YYYY-MM-DD HH:MM:SS</code>, and in GMT.
This field is ignored if <b>ActiveItemsOnly</b> is set to <code>true</code>.
GetBidderList
Conditionally
Used in conjunction with <b>EndTimeFrom</b>. Limits returned items to only those for
which the item's end date is on or before the date/time specified. If
specified, <b>EndTimeFrom</b> must also be specified. Express date/time in the format
<code>YYYY-MM-DD HH:MM:SS</code>, and in GMT. This field is ignored if <b>ActiveItemsOnly</b> is set to
<code>true</code>. Note that for GTC items, whose end times automatically increment by 30
days every 30 days, an <b>EndTimeTo</b> value within the first 30 days of a listing will
refer to the listing's initial end time.
<br><br>
<span class="tablenote"><b>Note: </b>
Starting July 1, 2019, the Good 'Til Cancelled renewal schedule will be modified from every 30 days to once per calendar month. For example, if a GTC listing is created July 5, the next monthly renewal date will be August 5. If a GTC listing is created on the 31st of the month, but the following month only has 30 days, the renewal will happen on the 30th in the following month. Finally, if a GTC listing is created on January 29-31, the renewal will happen on February 28th (or 29th during a 'Leap Year'). See the
<a href="https://pages.ebay.com/seller-center/seller-updates/2019-spring/marketplace-updates.html#good-til-cancelled" target="_blank">Good 'Til Cancelled listings update</a> in the <b>Spring 2019 Seller Updates</b> for more information about this change.
</span>
GetBidderList
Conditionally
The unique identifier of an eBay user.
<br><br>
This field is generally not required unless there are multiple User IDs tied to the requester credentials that are specified through the <b>RequesterCredentials</b> header. If there are multiple User IDs tied to the requester credentials, this field allows you to specify the User ID for which you wish to retrieves bids and purchases.
GetBidderList
Conditionally
You can control some of the fields returned in the response by specifying one of two values in the <b>GranularityLevel</b> field: <code>Fine</code> or <code>Medium</code>. <code>Fine</code> returns more fields than the default, while setting this field to <code>Medium</code> returns an abbreviated set of results.
Yes
GetBidderList
No
Response to a <b>GetBidderList</b> call, which retrieves all items the
user is currently bidding on, or has won or purchased.
Response to GetBidderListRequest.
Data for one eBay bidder.
GetBidderList
Always
Array of items the bidder has bid on, has won or has lost.
GetBidderList
Always
Retrieves the latest eBay category hierarchy for a given eBay site.
Information returned for each category includes the category name
and the unique ID for the category (unique within the eBay site for which
categories are retrieved). A category ID is a required input when you list most items.
Retrieves the latest eBay category hierarchy for a given eBay site.
DetailLevel
Categories
https://developer.ebay.com/DevZone/guides/features-guide/default.html#development/Categories.html
This field is used if the user wants to retrieve category data for another eBay site (other than the one specified in the <code>X-EBAY-API-SITEID</code> request header).
<br>
<br>
If the user wishes to retrieve category data for the US eBay Motors site, the user must set the Site ID in the <code>X-EBAY-API-SITEID</code> request header to <code>0</code>, and then set this field's value to <code>100</code>.
GetCategories
No
eBay Site IDs
https://developer.ebay.com/DevZone/merchandising/docs/Concepts/SiteIDToGlobalID.html
This field is used if the user wishes to retrieve category hierarchy information on one or more specific eBay categories, and optionally, one or more levels of each category's children (if a category has one or more levels of children). For example, if you wanted to view the entire category hierarchy under the <em>Home & Garden</em> L1 category, you would include this field and set its value to <code>11700</code>. As long as the <b>LevelLimit</b> field is omitted, all of <em>Home & Garden</em>'s child categories are returned. If you only wanted to see the next level (L2s) of <em>Home & Garden</em> categories, you would include the <b>LevelLimit</b> field and set its value to <code>2</code>, allowing the L1 category (<em>Home & Garden</em>) and all of its L2 categories to appear in the response.
<br>
<br>
If you wanted to see all of the Category IDs for the eBay site's L1 categories, you could omit the <b>CategoryParent</b> field but include the <b>LevelLimit</b> field and set its value to <code>1</code>.
<br>
<br>
<span class="tablenote"><b>Note:</b>
Numerous Category IDs may be specified under multiple <b>CategoryParent</b> fields in a <b>GetCategories</b> request, but if multiple <b>CategoryParent</b> fields are used, the specified Category IDs should all be at the same level (L1, L2, L3, etc.).
</span>
GetCategories
No
This field is used if the user wants to control the maximum depth of the category hierarchy to retrieve, or in other words, how many levels of eBay categories that are returned in the response. If this field is omitted, every eBay category from the root on down will be returned, or, if a <b>CategoryParent</b> category is specified, the specified category and all of its children (down to the leaf categories) are returned.
<br>
<br>
If the <b>CategoryParent</b> is not used, but the <b>LevelLimit</b> field is used and set to <code>1</code>, only the top-level categories (also known as L1 categories) are returned in the response.
GetCategories
No
This flag controls whether all eBay categories (that satisfy input filters) are returned, or only leaf categories (you can only list items in leaf categories) are returned. The default value is 'true', so if this field is omitted, all eBay categories will be returned. If you only want to retrieve leaf categories, include this flag and set it to <code>false</code>.
<br>
true
GetCategories
No
Contains the category data for the eBay site specified as input. The category
data is contained in a CategoryArrayType object, within which are zero, one, or
multiple CategoryType objects. Each CategoryType object contains the detail data
for one category. Other fields tell how many categories are returned in a call,
when the category hierarchy was last updated, and the version of the category
hierarchy (all three of which can differ from one eBay site to the next).
List of the returned categories. The category array contains one CategoryType
object for each returned category. Returns empty if no detail level is specified.
GetCategories
DetailLevel: ReturnAll
Always
Indicates the number of categories returned (i.e., the number of CategoryType
objects in CategoryArray).
GetCategories
DetailLevel: ReturnAll
Always
Indicates the last date and time that eBay modified the category hierarchy for the
specified eBay site.
GetCategories
DetailLevel: ReturnAll, none
Always
Indicates the version of the category hierarchy on the
specified eBay site.
GetCategories
DetailLevel: ReturnAll, none
Always
If true, <b>ReservePriceAllowed</b> indicates that all categories on the
site allow the seller to specify a reserve price for an item.
If false, this field is not returned in the response and all categories on the site do not normally allow sellers to specify reserve prices.
The Category.ORPA (override reserve price allowed) field can override (or toggle)
the reserve price allowed setting for a given category.
For example, if <b>ReservePriceAllowed</b> is false and Category.ORPA is true,
the category overrides the site setting and supports reserve prices.
If <b>ReservePriceAllowed</b> is true and Category.ORPA is true, the category
overrides the site setting and does does not support reserve prices.
GetCategories
DetailLevel: ReturnAll, none
Always
Indicates the lowest possible reserve price allowed for any item
listed in any category on the site. You can use the fields returned by <b>GetCategoryFeatures</b> to determine if a different Minimum Reserve Price is defined for the category you want to use.
GetCategories
DetailLevel: ReturnAll, none
Always
If true, <b>ReduceReserveAllowed</b> indicates that all categories on the
site allow the seller to reduce an item's reserve price.
If false, this field is not returned in the response and all categories on the site do not normally allow sellers to reduce an
item's reserve price.
The Category.ORRA (override reduce reserve price) field can override (or toggle)
the reserve price reduction setting for a given category.
For example, if <b>ReduceReserveAllowed</b> is false and Category.ORRA is true,
the category overrides the site setting and supports reducing reserve prices.
If <b>ReduceReserveAllowed</b> is true and Category.ORRA is true, the category
overrides the site setting and does does not support reducing reserve prices.
GetCategories
DetailLevel: ReturnAll, none
Always
Returns information about the features that are applicable to different categories,
such as listing durations, shipping term requirements, and Best Offer support.
DetailLevel
Categories
https://developer.ebay.com/DevZone/guides/features-guide/default.html#development/Categories.html
Specifies the category for which you want to retrieve the feature settings.
<br><br>
Specify a CategoryID, set DetailLevel to ReturnAll, and set
ViewAllNodes to true to return the default site settings, the
overrides for the specified category, plus all the child
categories that have overrides on the features they inherit.
<br><br>
If you also set AllFeaturesForCategory to true, eBay returns the site
defaults, plus all the settings for the specified category. Child
category information is not returned in this case.
<br><br>
If CategoryID is not specified, eBay returns the feature settings for
the site. To return details on all categories that have overrides on
the properties they inherit, set DetailLevel to ReturnAll, and set
ViewAllNodes to true. If you also set AllFeaturesForCategory to true,
eBay returns only the site defaults with no child category information.
GetCategoryFeatures
No
This field is used if the user wants to control the maximum depth of the category hierarchy to retrieve, or in other words, how many levels of eBay categories that are returned in the response. If this field is omitted, and no <b>CategoryID</b> is specified, eBay feature metadata for every eBay category from the root on down will be returned. If this field is omitted, but a <b>CategoryID</b> is specified, the specified category and all of its children (down to the leaf categories) are returned.
<br>
<br>
If the <b>CategoryID</b> field is not used, but the <b>LevelLimit</b> field is used and set to <code>1</code>, eBay feature metadata is only returned for the top-level categories (also known as L1 categories).
GetCategoryFeatures
No
You must set <b>DetailLevel</b> to <code>ReturnAll</code> in order to correctly populate the
response when you set <b>ViewAllNodes</b> to true. In this case, eBay returns the
site defaults along with all the categories that override the feature
settings they inherit. Here, each Category container shows only the
features that it has overridden from its parent node.
<br><br>
If you also specify a <b>CategoryID</b>, eBay returns the details for that category,
along with containers for each of its child categories that have feature
overrides.
<br><br>
Note that if <b>ViewAllNodes</b> is set to false (the default) and <b>DetailLevel</b> is
set to <code>ReturnAll</code>, eBay returns only the leaf categories that have features
that override the settings they inherit. In this case, the call will not
return leaf categories that do not have overrides.
GetCategoryFeatures
No
false
Use this field if you want to know if specific features are enabled at the site or root category level. Multiple <b>FeatureID</b> elements can be used in the request. If no <b>FeatureID</b> elements are used, the call retrieves data for all features, as applicable to the other request parameters.
ItemSpecificsEnabled
GetCategoryFeatures
No
All feature metadata returned if no <b>FeatureID</b> values are used
Use this switch to view all of the feature settings for a specific category.
All feature settings are returned, regardless of the site default settings.
This element works in conjunction with CategoryID--refer to the notes for
that element for more details.
<br><br>
If you also set FeatureID, eBay returns the status of the specified
features only, for the specified category.
GetCategoryFeatures
No
false
Returns the current version of the set of feature meta-data.
Compare this value to the version of the last version you
downloaded to determine whether the data may have changed.
GetCategoryFeatures
DetailLevel: none, ReturnSummary, ReturnAll
Always
Gives the time in GMT that the feature flags for the
category hierarchy were last updated.
GetCategoryFeatures
DetailLevel: none, ReturnSummary, ReturnAll
Always
A category whose feature settings are different from the settings of its parent category.<br>
<br>
For example, suppose there is a branch of the category tree with 5 category levels
(L1, L2, L3, L4, and L5). Suppose the feature settings for SiteDefaults, L1, L4, and L5
are all "A", and the settings for L2 and L3 are "B". In this case:<br>
L1's settings (A) match the site default, so L1 is not returned.<br>
L2's settings (B) are different from L1's, so L2 is returned.<br>
L3's settings (B) are the same as L2's, so L3 is not returned<br>
L4's settings (A) are different from L3's, so L4 is returned<br>
L5's settings (A) are the same as L4's, so L5 is not returned.<br>
<br>
If you specified a particular FeatureID in the request, this field
only returns feature settings for that feature.
Only returned when the category is different from its parent.
If the category has children and they aren't returned,
it means the children inherit the category's feature settings.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
Returns the feature settings defined for most categories on the site. Most categories share these settings. However, some categories can override some settings, as indicated in the Category nodes (if any).
GetCategoryFeatures
DetailLevel: ReturnAll
Always
Returns definitions of the various features on the site,
or the features you requested in FeatureID (if any).
Each feature has a node within FeatureDefinitions.
GetCategoryFeatures
DetailLevel: none, ReturnSummary, ReturnAll
Always
Retrieves a map of old category IDs and corresponding active
category IDs defined for the site to which the request is sent.
DetailLevel
Maintaining Category Data
https://developer.ebay.com/DevZone/guides/features-guide/default.html#development/Categories-DataMaintenance.html#MappingOldCategoryIDstoCurrentIDs
A version of the category mapping for the site. Filters
out data from the call to return only the category
mappings for which the data has changed since the
specified version. If not specified, all category
mappings are returned. Typically, an application passes
the version value of the last set of category mappings
that the application stored locally. The latest version
value is not necessarily greater than the previous value
that was returned. Therefore, when comparing versions,
only compare whether the value has changed.
GetCategoryMappings
No
Returns a map of old category IDs and corresponding active category IDs defined
for the site to which the request was sent. Typically used to update an older item
definition with a new category ID prior to listing the item.
Mapping between an old category ID and an active category ID. Returned when
category mappings exist and the value of CategoryVersion is different from
the current version on the site.
GetCategoryMappings
DetailLevel: ReturnAll
Conditionally
Version value assigned to the current category mapping data for the site.
Compare this value to the version value the application stored with the mappings
the last time the application executed the call. If the versions are the same,
the data has not changed since the last time the data was retrieved and stored.
GetCategoryMappings
DetailLevel: none, ReturnAll
Always
This is the base request type for the <b>GetCategorySpecifics</b> call. This call is used to retrieve recommended Item Specifics names and values for one or multiple eBay Categories.
This call is used to retrieve recommended Item Specifics names and values for one or multiple eBay Categories.
A unique identifer for an eBay leaf-level category. Recommended Item Specifics names and values will be retrieved for each eBay category that is specified. Up to 100 <b>CategoryID</b> values may be specified in one call.
<br><br>
A <b>GetCategorySpecifics</b> call request requires at least one of the following: a <b>CategoryID</b> value, a <b>CategorySpecifics.CategoryID</b> value, or the
<b>CategorySpecificsFileInfo</b> field with its value set to <code>true</code>. <b>CategoryID</b> values and
<b>CategorySpecific.CategoryID</b> values can both be used in the same request.
<br><br>
Keep in mind that a high number of specified categories can result in
longer response times and larger result sets. If your call request happens to time out, you might want specify fewer categories. If any
<b>CategoryID</b> values are specified more than once, only the first instance will be used.
100
GetCategorySpecifics
Conditionally
This dateTime filter can be included and used if the user only wants to check for recently-added Item Specifics names and values for one or more categories. If this filter is used, the Item Specifics recommendation engine will only check for Item Specifics names and values that have been added/changed since the date that was passed in to this field. If this field is used, the call will not return any Item Specifics data; it will only return the <b>Recommendations.Updated</b> boolean field for each specified eBay category. A <code>true</code> value in this field will indicate that the recommended Item Specifics names/values for the eBay category have changed since the timestamp passed in the <b>LastUpdateTime</b> field, and a <code>false</code> value in this field will indicate that the recommended Item Specifics names/values for the eBay category have not changed since the timestamp passed in the <b>LastUpdateTime</b> field.
<br><br>
Typically, you will pass in the timestamp value that was returned the last time you refreshed the list of Item Specifics names and values for the same categories. If the <b>Recommendations.Updated</b> flag returns <code>true</code> for any eBay categories in the response, you will want to call <b>GetCategorySpecifics</b> again for those eBay categories to get the latest names and values. As downloading all the data may affect your application's performance, it may help to only download Item Specifics data for an eBay category if the data has changed since you last checked.
GetCategorySpecifics
Conditionally
This field can be used if you want to control the number of Item Specifics that are returned for each specified eBay category. If you only wanted to retrieve the 10 most popular Item Specifics per category, you would include this field and set its value to <code>10</code>. Note that mandatory Item Specifics are always returned first in the response. If this field is omitted, all available Item Specifics names for each specified category are returned. If this field's value is set to a value that is higher than the number of Item Specific names available, all Item Specific names are still returned.
<br>
<br>
<span class="tablenote"><b>Note:</b>
In October 2019, eBay has updated the <b>GetCategorySpecifics</b> call to retrieve all available Item Specifics name-value pairs for each specified category by default. Previously, 30 Item Specifics names would be returned by default (if the <b>MaxNames</b> filter wasn't used) and 25 corresponding Item Specifics values would be returned by default (if the <b>MaxValuesPerName</b> filter wasn't used). However, if a user wants to limit the number of Item Specifics names and corresponding values that are returned, they can still use the <b>MaxNames</b> and/or <b>MaxValuesPerName</b> filters to do this.
</span>
<br>
1
GetCategorySpecifics
No
This field can be used if you want to control the number of corresponding values that are returned for each returned Item Specific name in each specified eBay category. If you only wanted to retrieve the 10 most popular values/options for each returned Item Specific name in each category, you would include this field and set its value to <code>10</code>. If this field is omitted, all available values for the corresponding Item Specifics name for each category are returned. If this field's value is set to a value that is higher than the number of Item Specific values available for any Item Specific name, all Item Specific values are still returned.
<br>
<br>
<span class="tablenote"><b>Note:</b>
In October 2019, eBay has updated the <b>GetCategorySpecifics</b> call to retrieve all available Item Specifics name-value pairs for each specified category by default. Previously, 30 Item Specifics names would be returned by default (if the <b>MaxNames</b> filter wasn't used) and 25 corresponding Item Specifics values would be returned by default (if the <b>MaxValuesPerName</b> filter wasn't used). However, if a user wants to limit the number of Item Specifics names and corresponding values that are returned, they can still use the <b>MaxNames</b> and/or <b>MaxValuesPerName</b> filters to do this.
</span>
<br>
1
GetCategorySpecifics
No
This field can be used if you already have an Item Specific name in mind, and you only want the recommended values for this Item Specifics name.
If you specify multiple eBay categories in the request, the recommendation engine may find a matching Item Specifics name for some categories, but not for others. For eBay categories where the Item Specifics name is not found, recommended Item Specifics names and values will be returned. The Item Specifics name passed in this field is case-sensitive, and wildcards are not supported.
<br><br>
30
GetCategorySpecifics
No
This container can be used instead of, or in conjunction with <b>CategoryID</b> values specified at the call request root level. The <b>CategorySpecific</b> container can actually be more powerful since you can pass in multiple Category ID and Item Specifics name combinations, and if you specify <b>CategoryID</b> values at the root level, only one (Item Specifics) <b>Name</b> value can be used.
<br><br>
A <b>GetCategorySpecifics</b> call request requires at least one of the following: a <b>CategoryID</b> value, a <b>CategorySpecifics.CategoryID</b> value, or the
<b>CategorySpecificsFileInfo</b> field with its value set to <code>true</code>. <b>CategoryID</b> values and
<b>CategorySpecific.CategoryID</b> values can both be used in the same request.
<br><br>
Keep in mind that a high number of specified categories can result in
longer response times and larger result sets. If your call request happens to time out, you might want specify fewer categories. If any
<b>CategorySpecifics.CategoryID</b> values are specified more than once, only the first instance will be used.
275
GetCategorySpecifics
Conditionally
If this boolean field is included and set to <code>true</code>, the <b>Relationship</b> container will not be returned for any Item Specifics name or value recommendations. Relationship recommendations tell you whether an Item Specific has a logical dependency another Item Specific.
<br> <br>
For example, in a clothing category, Size Type could be
recommended as a parent of Size, because Size=Small would
mean something different to buyers depending on whether
Size Type=Petite or Size Type=Plus.<br>
<br>
In general, it is a good idea to retrieve and use relationship
recommendations, as this data can help buyers find the items
they want more easily.
GetCategorySpecifics
false
No
If this boolean field is included and set to <code>true</code>, eBay's level of confidence in the popularity of each Item Specific name and value for the specified category is returned in the response. Some sellers may find this useful when choosing whether to use eBay's recommendation or their own Item Specifics names or values.
<br> <br>
If this field is used, either one or more <b>CategoryID</b> values and/or one or more <b>CategorySpecific.CategoryID</b> values must be specified. If you try to use this field solely with the <b>CategorySpecificsFileInfo</b> field, the request fails and no <b>TaskReferenceID</b> or <b>FileReferenceID</b> values are returned.
GetCategorySpecifics
false
No
If this boolean field is included and set to <code>true</code>, the response includes a <b>FileReferenceID</b> and
<b>TaskReferenceID</b> value. Use these identifiers as inputs to the <b>downloadFile</b>
call in the eBay File Transfer API. That API lets you retrieve
a single (bulk) <b>GetCategorySpecifics</b> response with all the Item
Specifics recommendations available for the requested site ID.
(The <b>downloadFile</b> call downloads a .zip file as an
attachment.)<br>
<br>
Either the <b>CategorySpecificsFileInfo</b> field or one or more <b>CategoryID</b> and/or <b>CategorySpecific.CategoryID</b> values are required
in a <b>GetCategorySpecifics</b> call. <br>
<br>
<span class="tablenote"><b>Note:</b>
You can use the File Transfer API without using or learning
about the Bulk Data Exchange API or other
Large Merchant Services APIs.
</span>
GetCategorySpecifics
Conditionally
downloadFile in the File Transfer API
https://developer.ebay.com/DevZone/file-transfer/CallRef/downloadFile.html
This is the base response type for the <b>GetCategorySpecifics</b> call. This call retrieves recommended Item Specifics names and values for one or multiple eBay Categories.
This container provide details about relevant Item Specifics for the specified category. Required Item Specifics are generally returned at the top of the response payload, followed by the other most common/popular Item Specifics for the category. If an Item Specific is required, a <b>MinValues</b> field will be returned with a value of <code>1</code>, and the corresponding <b>UsageConstraint</b> field will show a value of <code>Required</code>. Optional Item Specifics are returned after required and recommended Item Specifics, but sellers should still provide any optional Item Specific name-value pairs if known and relevant for the product.
<br>
<br>
As mentioned above, the most relevant Item Specifics are returned first, and similarly, if an Item Specific
has multiple suggested values, these values are sorted according to popularity (most popular to less popular/common).<br>
<br>
This node returns empty (or it's not returned) for a category if
there is no applicable data (such as when you request a parent category, a category that has no popular Item Specifics yet,
or a duplicate category that was already returned).
If you pass in the <b>CategoryID</b> and <b>Name</b> fields together, but no
matching values are found for the name, eBay returns the name
with no values (even if the name is not recommended).<br>
<br>
If <b>GetCategoryFeatures</b> indicates that Item Specifics are
enabled for a leaf category, but <b>GetCategorySpecifics</b> doesn't
return any recommendations for that category, the seller can still
specify their own Item Specifics in that category.
275
GetCategorySpecifics
Conditionally
A <b>TaskReferenceID</b> and a <b>FileReferenceID</b> value are returned if the <b>CategorySpecificsFileInfo</b> field is included in the call request and set to <code>true</code>. These values will be used as inputs in the <b>downloadFile</b> call of the File Transfer API. That API lets you retrieve a single (bulk) <b>GetCategorySpecifics</b> response with all the Item Specifics recommendations available for the requested site ID. (The <b>downloadFile</b> call downloads a .zip file as an attachment.)
GetCategorySpecifics
Conditionally
downloadFile in the File Transfer API
http://developer.ebay.com/DevZone/file-transfer/CallRef/downloadFile.html
A <b>TaskReferenceID</b> and a <b>FileReferenceID</b> value are returned if the <b>CategorySpecificsFileInfo</b> field is included in the call request and set to <code>true</code>. These values will be used as inputs in the <b>downloadFile</b> call of the File Transfer API. That API lets you retrieve a single (bulk) <b>GetCategorySpecifics</b> response with all the Item Specifics recommendations available for the requested site ID. (The <b>downloadFile</b> call downloads a .zip file as an attachment.)
GetCategorySpecifics
Conditionally
downloadFile in the File Transfer API
http://developer.ebay.com/DevZone/file-transfer/CallRef/downloadFile.html
This is the base request type for the <b>GetChallengeToken</b> call. This call retrieves a botblock token and URLs for an image or audio clip that the user is to match.
<br/><br/>
This call does not have any call-specific input parameters.
This call retrieves a botblock token and URLs for an image or audio clip that the user is to match.
This is the base response type for the <b>GetChallengeToken</b> call. This call retrieves a botblock token and URLs for an image or audio clip that the user is to match.
Botblock token that is used to validate that the user is a human and not a bot.
GetChallengeToken
Always
The URL of the image your application should display to
the user for a botblock challenge.
GetChallengeToken
Always
The URL of the audio clip your application should provide for sight-impaired users.
The audio clip corresponds to the image.
GetChallengeToken
Always
The <b>GetCharities</b> call is used to search for nonprofit organizations that are registered with the eBay for Charity program. This call allows users to search for a specific nonprofit organization, or to search for multiple nonprofit organizations from a particular charitable domain, and/or geographical region, or by using a search string.
This call is used to search for nonprofit organizations that are registered with the eBay for Charity program.
Identifying Listings that Benefit Nonprofits
https://developer.ebay.com/DevZone/guides/features-guide/default.html#development/Feature-NonprofitSupport.html
A unique identification number assigned to a nonprofit
organization when that organization registers with the PayPal Giving Fund. If a <b>CharityID</b> value is used in the request, all other search filters set in the call request will be ignored, as the call will only search for the specified nonprofit organization.
GetCharities
Conditionally
This field will accept the full or partial name of a registered nonprofit organization. For example, if you pass in a value of <b>heart</b>, all registered nonprofit organizations with "heart" in their name may be returned in the response. If the <b>MatchType</b> field is used and set to <code>StartsWith</code> (default value), or is not used at all, the phrase "heart" must come at the beginning of the nonprofit organization's name to be returned. However, if the <b>MatchType</b> field is used and set to <code>Contains</code>, all registered nonprofit organizations with "heart" in their name should be returned in the response. The string passed in this field is not case-sensitive.
<br/><br/>
150
GetCharities
Conditionally
This field accept any string up to 350 characters in length. The functionality of this field is similar to the <b>CharityName</b> field, except that the call will also search for the supplied query string within the charity's mission statement (which is returned under the <b>Charity.Mission</b> field in the response). If you pass in a value of <b>heart</b>, all registered nonprofit organizations with "heart" in their name or in their mission statement may be returned in the response.
<br/><br/>
The string passed in this field is not case-sensitive. The <b>MatchType</b> field will have no effect if the <b>Query</b> field is used, as the <b>MatchType</b> field will only have an effect if a <b>CharityName</b> string field is included.
<br/><br/>
350
GetCharities
Conditionally
This field can be used to search for registered nonprofit organizations within a specified geographical region. Each geographical region will have an integer value associated with it. This integer value is what is passed in to this field.
GetCharities
No
This field can be used to search for registered nonprofit organizations within a specified charitable domain. Each charitable domain will have an integer value associated with it. This integer value is what is passed in to this field. Nonprofit organizations can be associated with multiple charitable domains.
GetCharities
No
This field should be included and set to <code>true</code> if a user wants the charity's description to appear in the response. Note that not all charitable organizations will have defined descriptions.
false
GetCharities
No
This filter is used if the user wants to specify where to look for the string specified in the <b>CharityName</b> field. The enumeration value input into this field controls the type of string matching to use when a value is submitted in the
<b>CharityName</b> field. If this field is omitted, and a <b>CharityName</b> string is used, this parameter value defaults to <code>StartsWith</code>.
<br/><br/>
This field is not applicable when a <b>Query</b> value is used.
<br/>
StartsWith
GetCharities
No
This boolean field is used and set to <code>true</code> if the user wants to search for nonprofit organizations currently featured on the eBay for Charity site.
GetCharities
No
Reserved for future use.
This is the base response type for the <b>GetCharities</b> call. This call is used to search for eBay for Charity nonprofit organizations. A <b>Charity</b> container is returned for each nonprofit organization that matches the criteria in the call request.
Each <b>Charity</b> container consists of information about a specific nonprofit organization. Each nonprofit organization is identified by the <b>id</b> attribute of the container. If no nonprofit organization are found that match the input criteria, no <b>Charity</b> containers are returned.
GetCharities
Conditionally
This is the base request type for the <b>GetClientAlertsAuthToken</b> call. This call retrieves a Client Alerts token for the user, which is required when the user makes a <b>GetUserAlerts</b> call (Client Alerts API).
This call retrieves a Client Alerts token for the user, which is required when the user makes a <b>GetUserAlerts</b> call (Client Alerts API).
https://developer.ebay.com/DevZone/client-alerts/docs/CallRef/index.html
Client Alerts API Call Reference
Returns a Client Alerts token.
This token string is required for the Login call in the Client Alerts API.
The Client Alerts GetUserAlerts call, which returns alerts about events
associated with a specific user, requires Login.
GetClientAlertsAuthToken
Always
A Client Alerts token expires after seven days.
GetClientAlertsAuthToken
Always
Retrieves top-ranked contextual eBay keywords and categories
for a specified web page.
SG, HK
The URL of the web page from which eBay is to extract keywords.
GetContextualKeywords
Yes
Web page encoding by which the URL is to be handled, such as ISO-8859-1.
GetContextualKeywords
Yes
The ID of the category to which keywords are to be limited.
Zero or more category IDs can be specified.
GetContextualKeywords
No
Response to a <b>GetContextualKeywords</b> request.
An array of either keyword/category pairs or categories, with ranking and score.
GetContextualKeywords
Always
Retrieves Listing Designer templates that are available for use by the seller.
This is the base request type for the <b>GetDescriptionTemplates</b> call. This call retrieves detailed information on the Listing Designer templates that are available for use by the seller.
This call retrieves detailed information on the Listing Designer templates that are available for use by the seller.
Using Description Templates
http://developer.ebay.com/DevZone/guides/features-guide/default.html#development/DescTemplates.html
A <b>CategoryID</b> value can be specified if the seller would like to only see the Listing Designer templates that are available for that eBay category. This field will be ignored if the <b>MotorVehicles</b> boolean field is also included in the call request and set to <code>true</code>.
10
GetDescriptionTemplates
No
This dateTime filter can be included and used if the user only wants to check for recently-added Listing Designer templates. If this filter is used, only the Listing Designer templates that have been added/modified after the specified timestamp will be returned in the response.
<br/><br/>
Typically, you will pass in the timestamp value that was returned the last time you refreshed the list of Listing Designer templates.
GetDescriptionTemplates
No
This boolean field should be included and set to <code>true</code> if the user would only like to see the Listing Designer templates that are available for motor vehicle categories. This field will override any <b>CategoryID</b> value that is specified in the call request.
<br>
<br>
<span class="tablenote"><b>Note:</b>
Motor vehicle-related Listing Designer templates are only available for eBay Motors on the US and Canada (English) marketplaces. To retrieve eBay US Motors Listing Designer templates, the <b>SITEID</b> HTTP header value must be set to <code>100</code>, which is the identifier of the eBay US Motors vertical (ebay.com/motors).
</span>
false
GetDescriptionTemplates
No
Retrieves detailed information on Listing Designer templates that are available for use by the seller.
This is the base response type for the <b>GetDescriptionTemplates</b> call. This call retrieves the Listing Designer templates that are available for use by the seller. The user has the option of retrieving all available Listing Designer templates for all categories, for all motor vehicle categories, or for a specific eBay category.
A <b>DescriptionTemplate</b> container is retrieved for each available Listing Designer template. Each <b>DescriptionTemplate</b> container includes the unique identifier of the template, the Listing Designer Theme Group that it belongs to, the CDATA representation of the Listing Designer template, and the URL to an image that serves as an example of the Listing Designer template.
GetDescriptionTemplates
Always
This integer value indicates the total number of Listing Designer Layout templates that were retrieved. This field is always returned, even if it is <code>0</code>
GetDescriptionTemplates
Always
The unique identifier of a Listing Designer Layout template that is now obsolete. An <b>ObsoleteLayoutID</b> field is returned for each obsolete Listing Designer Layout template.
GetDescriptionTemplates
Conditionally
The unique identifier of a Listing Designer Theme template that is now obsolete. An <b>ObsoleteThemeID</b> field is returned for each obsolete Listing Designer Theme template.
GetDescriptionTemplates
Conditionally
A <b>ThemeGroup</b> container is retrieved for each available Listing Designer Theme Group. Each <b>ThemeGroup</b> container includes the unique identifier of the Theme Group, the Theme Group name, and all of the Listing Designer Theme template that belong to that Theme Group.
GetDescriptionTemplates
Conditionally
This integer value indicates the total number of Listing Designer Theme templates that were retrieved. This field is always returned, even if it is <code>0</code>
GetDescriptionTemplates
Always
This is the base request type for the <b>GetDispute</b> call. This call retrieves the details of a seller-initiated dispute. Seller-initiated disputes include mutually-cancelled transactions and unpaid items.
<br/><br/>
<span class="tablenote"><strong>Note:</strong>
This call does not support buyer-initiated cases created through eBay's Resolution Center. Buyer-initiated cases include Item Not Received (INR) and escalated Return cases. To retrieve and manage eBay Money Back Guarantee cases, the Case Management calls of the <a href="http://developer.ebay.com/Devzone/post-order/index.html" target="_blank">Post-Order API</a> can be used instead.
</span>
This call retrieves the details of a seller-initiated dispute.
GetUserDisputes
Unpaid Item Disputes
https://developer.ebay.com/DevZone/guides/features-guide/default.html#development/UPI-Disputes.html
Buyer Disputes
https://developer.ebay.com/DevZone/guides/features-guide/default.html#development/Disputes-Buyer.html
Getting Details About a Dispute
https://developer.ebay.com/DevZone/guides/features-guide/default.html#development/UPI-DisputesGettingDetails.html
The unique identifier of an seller-initiated dispute. The caller passes in this value to retrieve detailed information on a specific dispute.
<br/><br/>
<span class="tablenote"><strong>Note:</strong>
Buyer-initiated Money Back Guarantee cases are not supported with this call. To retrieve and manage eBay Money Back Guarantee cases, the Case Management calls of the <a href="https://developer.ebay.com/Devzone/post-order/index.html" target="_blank">Post-Order API</a> can be used instead.
</span>
GetDispute
Yes
This is the base response type for the <b>GetDispute</b> call. This call retrieves the details of a seller-initiated dispute. Seller-initiated disputes include mutually-cancelled transactions and unpaid items.
<br/><br/>
<span class="tablenote"><strong>Note:</strong>
This call does not support buyer-initiated cases created through eBay's Resolution Center. Buyer-initiated cases include Item Not Received (INR) and escalated Return cases. To retrieve and manage eBay Money Back Guarantee cases, the Case Management calls of the <a href="http://developer.ebay.com/Devzone/post-order/index.html" target="_blank">Post-Order API</a> can be used instead.
</span>
Platform Notifications
http://developer.ebay.com/DevZone/guides/features-guide/default.html#development/index.html#PlatformNotifications
If the dispute that is specified in the call request is found, this <b>Dispute</b> container is returned in the response. This container includes detailed information about the dispute, the buyer and seller user IDs, and information on the listing that is associated with the dispute.
GetDispute
Always
Retrieves one, many, or all Feedback records for a specific eBay user. There is a filter option in the call request to limit Feedback records to those that are received, or to those that are left for other buyers, as well as a filter option to limit Feedback records to those that are received as a buyer or seller.
DetailLevel
Leaving and Retrieving Feedback
https://developer.ebay.com/DevZone/guides/features-guide/default.html#development/Sales-Feedback.html
The user's eBay User ID is specified in this field. If this field is used, all retrieved Feedback data will be for this eBay user. Specifies the user whose feedback data is to be returned. If this field is omitted in the call request, all retrieved Feedback records will be for the eBay user making the call.
GetFeedback
No
The unique identifier of a Feedback record. This field is used if the user wants to retrieve a specific Feedback record. If <b>FeedbackID</b> is specified in the call request, all other input fields are ignored.
GetFeedback
No
Unique identifier for an eBay listing. A listing can have multiple order line items, but only one <b>ItemID</b>. If <b>ItemID</b> is specified in the <b>GetFeedback</b> request, the returned Feedback record(s) are restricted to the specified <b>ItemID</b>. The maximum number of Feedback records that can be returned is 100.
GetFeedback
No
Unique identifier for an eBay order line item. A
<b>TransactionID</b> can be paired up with its corresponding <b>ItemID</b> and used as
an input filter in the <b>GetFeedback</b> request. If an <b>ItemID</b>/<b>TransactionID</b>
pair or an <b>OrderLineItemID</b> value is used to retrieve a feedback record
on a specific order line item, the <b>FeedbackType</b> and <b>Pagination</b>
fields (if included) are ignored.
GetFeedback
No
This field is used to retrieve Feedback records of a specific type (Positive, Negative, or Neutral) in <b>FeedbackDetailArray</b>. You can include one or two <b> CommentType</b> fields in the request. If no <b>CommentType</b> value is specified, Feedback records of all types are returned.
GetFeedback
No
This field is used to restrict retrieved Feedback records to those that the user left for other buyers, Feedback records received as a seller, Feedback records received as a buyer, or Feedback records received as a buyer and seller. The default value is <b>FeedbackReceived</b>, so if the <b>FeedbackType</b> field is omitted in the request, all Feedback records received by the user as a buyer and seller are returned in the response. "Feedback Left" data will not be returned in the call response.
FeedbackReceived
GetFeedback
No
Controls the pagination of the result set. Child elements, <b>EntriesPerPage</b> and
<b>PageNumber</b>, specify the maximum number of individual feedback records to return
per call and which page of data to return. Only applicable if <b>DetailLevel</b> is
set to <b>ReturnAll</b> and the call is returning feedback for a <b>UserID</b>. Feedback
summary data is not paginated, but when pagination is used, it is returned
after the last feedback detail entry.
<br><br>
Accepted values for <b>Pagination.EntriesPerPage</b> for GetFeedback is 25 (the
default), 50, 100, and 200. If you specify a value of zero, or a value
greater than 200, the call fails with an error. If you specify a value between
one and twenty-four, the value is rounded up to 25. Values between 26 and 199
that are not one of the accepted values are rounded down to the nearest
accepted value.
GetFeedback
No
<b>OrderLineItemID</b> is a unique identifier for an eBay order line item. An <b>OrderLineItemID</b> can be used as an
input filter in the <b>GetFeedback</b> request. If an <b>OrderLineItemID</b> value is
used to retrieve a feedback record on a specific order line item, the
<b>FeedbackType</b> and <b>Pagination</b> fields (if included) are ignored.
GetFeedback
No
The <b>GetFeedback</b> response contains the feedback summary if a <b>TransactionID</b> or <b>ItemID</b> is specified, and contains the specified user's total feedback score and feedback summary data if a <b>UserID</b> is specified. If no value is supplied, the feedback score and feedback summary for the requesting user will be returned.
<br>
If a detail level value of <b>ReturnAll</b> is specified, an array of all feedback records will be returned.
Contains the individual Feedback records for the user or order line item specified in the request. There is one <b>FeedbackDetail</b> container returned for each Feedback record. Only populated with data when a detail level of <code>ReturnAll</code> is specified in the request. Not returned if you specify a <b>FeedbackID</b> in the request.
GetFeedback
DetailLevel: ReturnAll
Conditionally
Indicates the total number of Feedback records returned in the the response. Only applicable if Feedback details are returned.
GetFeedback
DetailLevel: ReturnAll
Conditionally
Summary Feedback data for the user. Contains counts of positive, neutral,
and negative Feedback for pre-defined time periods. Only applicable if Feedback details are returned.
GetFeedback
DetailLevel: none, ReturnAll
Conditionally
Indicates the total Feedback score for the user.
GetFeedback
DetailLevel: none, ReturnAll
Always
Contains information regarding the pagination of data, including the total number of Feedback entries and the total number of pages required to show all of these Feedback entries. The total number of pages is dependent on the <b>Pagination.EntriesPerPage</b> value (if set). The <b>EntriesPerPage</b> value defaults to <code>25</code> if the <b>Pagination.EntriesPerPage</b> field is not used.
<br><br>
If the call request returns no Feedback entries because there are none, or because the <b>DetailLevel</b> field was not included and set to <code>ReturnAll</code>, the <b>PaginationResult.TotalNumberOfPages</b> and <b>PaginationResult.TotalNumberOfEntries</b> fields are still returned, but with values of <code>0</code>.
GetFeedback
DetailLevel: none, ReturnAll
Always
Indicates the number of Feedback records that are set to be
returned per page of data (i.e., per call). The <b>EntriesPerPage</b> value defaults to <code>25</code> if the <b>Pagination.EntriesPerPage</b> field is not set in the request.
<br><br>
This field is always returned even if the response is not showing any Feedback entries.
GetFeedback
DetailLevel: none, ReturnAll
Always
Indicates the page of data that is currently displaying. The page number to display is set in the <b>Pagination.PageNumber</b> field in the request. If this field is omitted, the <b>PageNumber</b> value defaults to <code>1</code> (first page of Feedback entries). If the integer value input into the <b>Pagination.PageNumber</b> field in the request is higher than the total number of available pages, the call fails with an error.
<br><br>
This field is always returned even if the response is not showing any Feedback entries.
GetFeedback
DetailLevel: none, ReturnAll
Always
The <b>GetItem</b> call returns listing data such as title, description, price information, user information, and so on, for the specified <b>ItemID</b>.
DetailLevel
Retrieving Items
https://developer.ebay.com/DevZone/guides/features-guide/default.html#development/Items-Retrieving.html
Introduction to Pictures in Item Listings
https://developer.ebay.com/DevZone/guides/features-guide/default.html#development/Pictures-Intro.html
This field is used to identify the eBay listing by Item ID value.
<br><br>
<b>ItemID</b> is a required input in most cases. <b>SKU</b> can be used instead in certain
cases (see the description of SKU). If both <b>ItemID</b> and <b>SKU</b> are specified for
items where the inventory tracking method is <b>ItemID</b>, <b>ItemID</b> takes precedence.
GetItem
Conditionally
The seller can include this field and set its value to <code>true</code> if that seller wants to see how many prospective bidders/buyers currently have the item added to their Watch Lists. The Watch count is returned in the <b>WatchCount</b> field in the response.
<br>
<br>
This field will only be returnd to the seller of the item.
false
GetItem
No
This field is deprecated.
If this field is included and set to <code>true</code>, the call response includes the <b>ItemSpecifics</b> container
if Item Specifics are defined for the listing.<br>
<br>
An Item Specific is any aspect that helps define/classify the item. Many eBay categories mandate including specific Item Specifics, so it is always a good idea to make a call to <b>GetCategorySpecifics</b> to see what Item Specifics are required and which ones are recommended.<br>
<br>
Including this field and setting it to <code>true</code> will also return the <strong>UnitInfo</strong> container if applicable. The <strong>UnitInfo</strong> container will provide information about the weight, volume or other quantity measurement of a listed item. The European Union requires listings for certain types of products to include the price per unit so buyers can accurately compare prices. eBay uses the <strong>UnitType</strong> and <strong>UnitQuantity</strong> values and the item's listed price to calculate and display the per-unit price on eBay EU sites.
GetItem
No
false
Working with Item Specifics
https://developer.ebay.com/devzone/guides/features-guide/default.html#development/ItemSpecifics.html
The seller will include this field and set its value to <code>true</code> if the seller wishes to view the defined sales tax rates for the various jurisdictions in the country (generally, states and provinces). Information for each defined sales tax rate will be returned in the <b>TaxTable</b> container in the response.
<br/><br/>
Even if this field is included and set to <code>true</code>, no <b>TaxTable</b> container will be returned If no sales tax rates are defined for any tax jurisdiction in the seller's sales tax table.
<br/><br/>
Sales tax tables are only available for eBay US and Canada marketplaces. Sales tax rates can be added/modified in My eBay, through the <b>SetTaxTable</b> and <b>GetTaxTable</b> calls of the Trading API, or through the Sales Tax calls of the Account API.
false
GetItem
No
Retrieves an item that was listed by the user identified
in AuthToken and that is being tracked by this SKU.<br>
<br>
A SKU (stock keeping unit) is an identifier defined by a seller.
Some sellers use SKUs to track complex flows of products
and information on the client side.
eBay preserves the SKU on the item, enabling you
to obtain it before and after an order line item is created.
(SKU is recommended as an alternative to
ApplicationData.)<br>
<br>
In <b>GetItem</b>, <b>SKU</b> can only be used to retrieve one of your
own items, where you listed the item by using <b>AddFixedPriceItem</b>
or <b>RelistFixedPriceItem</b>,
and you set <b>Item.InventoryTrackingMethod</b> to <b>SKU</b> at
the time the item was listed. (These criteria are necessary to
uniquely identify the listing by a SKU.)<br>
<br>
Either <b>ItemID</b> or <b>SKU</b> is required in the request.
If both are passed, they must refer to the same item,
and that item must have <b>InventoryTrackingMethod</b> set to <b>SKU</b>.
50
GetItem
Conditionally
Variation-level SKU that uniquely identifes a Variation within
the listing identified by <b>ItemID</b>. Only applicable when the
seller listed the item with Variation-level SKU (<b>Variation.SKU</b>)
values. Retrieves all the usual <b>Item</b> fields, but limits the
<b>Variations</b> content to the specified Variation.
If not specified, the response includes all Variations.
GetItem
Conditionally
Name-value pairs that identify one or more Variations within the
listing identified by <b>ItemID</b>. Only applicable when the seller
listed the item with Variations. Retrieves all the usual <b>Item</b>
fields, but limits the Variations content to the specified
Variation(s). If the specified pairs do not match any Variation,
eBay returns all Variations.<br>
<br>
To retrieve only one variation, specify the full set of
name/value pairs that match all the name-value pairs of one
Variation. <br>
<br>
To retrieve multiple variations (using a wildcard),
specify one or more name/value pairs that partially match the
desired variations. For example, if the listing contains
Variations for shirts in different colors and sizes, specify
Color as Red (and no other name/value pairs) to retrieve
all the red shirts in all sizes (but no other colors).
GetItem
Conditionally
A unique identifier for an order line item. An order line item is created
when a buyer commits to purchasing an item.
<br><br>
Since you can change active multiple-quantity fixed-price listings even
after one of the items has been purchased, the <b>TransactionID</b> is
associated with a snapshot of the item data at the time of the purchase.
<br><br>
After one item in a multi-quantity listing has been sold, sellers can not
change the values in the Title, Primary Category, Secondary Category,
Listing Duration, and Listing Type fields. However, all other fields are
editable.
<br><br>
Specifying a <b>TransactionID</b> in the <b>GetItem</b> request allows you to retrieve
a snapshot of the listing as it was when the order line item was created.
GetItem
Conditionally
This field is used to specify whether or not to retrieve Parts
Compatiblity information for a motor part or accessory listing. If this field is included and set to <code>true</code>, the <b>Item.ItemCompatibilityList</b> container will be returned if a Parts Compatibility list exists for the listing. A Parts Compatibility list is a list of motor vehicles that are compatible with the listed motor part or accesory item. If a Parts Compatibility list does not exist for the listing, this field will have no effect if it is included, regardless of its value (<code>true</code> or <code>false</code>).
<br><br>
If this field is included and set to <code>false</code> or omitted, but a Parts Compatibility list does exist for the listing, the <b>Item.ItemCompatibilityList</b> container will not be returned, but the <b>Item.ItemCompatibilityCount</b> field will be returned, and this field will simply indicate the quantity of motor vehicles that are compatible with the the listed motor part or accesory item.
<br><br>
Parts Compatibility lists are only applicable to motor parts and accessory categories on the sites that support eBay Motors - US, CA, UK, and DE.
false
GetItem
No
ItemCompatibilityCount
#Response.Item.ItemCompatibilityCount
ItemCompatibilityList
#Response.Item.ItemCompatibilityList
Listing Items with Parts Compatibility
https://developer.ebay.com/DevZone/guides/features-guide/default.html#development/CompatibleParts.html
This type is used to display detailed information about the listing that was retrieved.
This container consists of detailed information about the retrieved listing. The amount of information that is returned is partially controlled by the filters that are set in the call request.
GetItem
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Always
This is the base request type of the <b>GetItemShipping</b> call. This call takes an <b>ItemID</b> value for an item that has yet to be shipped, and then returns estimated shipping costs for every shipping service that the seller has offered with the listing. This call will also return <b>PickUpInStoreDetails.EligibleForPickupDropOff</b> and <b>PickUpInStoreDetails.EligibleForPickupInStore</b> flags if the item is available for buyer pick-up through the In-Store Pickup or Click and Collect features.
This call takes an <b>ItemID</b> value for an item that has yet to be shipped, and then returns estimated shipping costs for every shipping service that the seller has offered with the listing.
Determining Shipping Costs for a Listing
http://developer.ebay.com/DevZone/guides/features-guide/default.html#development/Shipping-DeterminingCosts.html
The unique identifier of the eBay listing for which to retrieve estimated shipping costs for all offered shipping service options. The <b>ItemID</b> value passed into this field should be for an listing that offers at least one calculated shipping service option, and for an item that has yet to be shipped.
GetItemShipping
Yes
This field is used to specify the quantity of the item. The <b>QuantitySold</b> value defaults to <code>1</code> if not specified. If a value greater than <code>1</code> is specified in this field, the shipping service costs returned in the response will reflect the expense to ship multiple quantity of an item.
<br>
1
Quantity available in the listing
GetItemShipping
No
The destination postal code (or zip code for US) is supplied in this field. <b>GetItemShipping</b> requires the destination of the shipment. Some countries will require both the <b>DestinationPostalCode</b> and the lt;b>DestinationCountryCode</b>, and some countries will accept either one or the other.
GetItemShipping
Conditionally
The destination country code is supplied in this field. <b>GetItemShipping</b> requires the destination of the shipment. Some countries will require both the <b>DestinationPostalCode</b> and the lt;b>DestinationCountryCode</b>, and some countries will accept either one or the other.
<br><br>
Two-digit country codes can be found in <a href="types/CountryCodeType.html">CountryCodeType</a>.
<br>
US
GetItemShipping
Conditionally
This is the base response type of the <b>GetItemShipping</b> call. This call takes an <b>ItemID</b> value for an item that has yet to be shipped, and then returns estimated shipping costs for every shipping service that the seller has offered with the listing. This call will also return the <b>PickUpInStoreDetails.EligibleForPickupInStore</b> flag if the item is available for buyer pick-up through the In-Store Pickup feature.
This container will be returned if at least one domestic or international shipping service option is available for the item. A <b>ShippingServiceOptions</b> (for domestic shipping) and/or an <b>InternationalShippingServiceOptions</b> container (for international shipping) is returned for each available calculated shipping service option. These shipping service option containers consists of estimated shipping cost and estimated shipping times.
<br>
<br>
Any error about shipping services (returned by a vendor of eBay's who calculates shipping costs) is returned in <b>ShippingRateErrorMessage</b>. Errors from a shipping service are likely to be related to issues with shipping specifications, such as package size and the selected shipping method not supported by a particular shipping service.
GetItemShipping
Always
This container is only returned in <b>GetItemShipping</b> if the In-Store Pickup feature is enabled for the listing. In-Store Pickup as a fulfillment method is only available to a limited number of large retail merchants in the US, Canada, UK, Germany, and Australia marketplaces. The In-Store Pickup feature can only be applied to multiple-quantity, fixed-price listings, and the merchant must have quantity of the item available in a store that is near the prospective buyer, in order for In-Store Pickup to be an available fulfillment option for that buyer.
GetItemShipping
Conditionally
This call retrieves details on one or more order line items for a specified eBay listing. Auctions and single-quantity, fixed-price listings can only have one order line item, but a multiple-quantity and/or multiple-variation, fixed-priced listing can have numerous order line items.
<br><br>
To find one or more order line items for an eBay listing, an <b>ItemID</b> value can be passed in. If a user wanted to retrieve a specific order line item, an <b>ItemID</b> value and a an <b>TransactionID</b> value can be passed in, or an <b>OrderLineItemID</b> value can be passed in instead of an <b>ItemID</b>/<b>TransactionID</b> pair.
<br><br>
The <b>NumberOfDays</b> or the <b>ModTimeFrom</b> and <b>ModTimeTo</b> date range filters can be used to retrieve order line items generated (or last modified) within a specific range of time. The maximum date range that can be set is 30 days, and the <b>ModTimeFrom</b> date value cannot be set any further back than 90 days in the past. If no date range filters are used, all order line items (associated with the specified listing) generated (or last modified) in the last 30 days are retrieved. Date ranges are generally only used for multiple-quantity or multiple-variation, fixed-price listings that can have multiple order line items.
<br><br>
There are also pagination filters available that allow the user to control how many and which order line items are returned on each page of a results set.
DetailLevel
Retrieving Order Line Item Data and Managing Orders
https://developer.ebay.com/DevZone/guides/features-guide/default.html#development/Sales-Completing.html
Unique identifier for an eBay listing. A listing can have multiple order line items, but only one <b>ItemID</b>. When you use <b>ItemID</b> alone, eBay returns all order line items that are associated with the <b>ItemID</b>. If you pair <b>ItemID</b> with a specific <b>TransactionID</b>, data on a specific order line item is returned. An <b>OrderLineItemID</b> value can be used instead of an <b>ItemID</b>/<b>TransactionID</b> pair to identify an order line item, and if an <b>OrderLineItemID</b> is specified in the request, any <b>ItemID</b>/<b>TransactionID</b> pair specified in the same request is ignored.
<br>
<br>
<span class="tablenote"><b>Note:</b>
<b>GetItemTransactions</b> doesn't support SKU as an input because this
call requires an identifier that is unique across your active
and ended listings. Even when <b>InventoryTrackingMethod</b> is set to
<b>SKU</b> in a listing, the SKU is only unique across your active
listings (not your ended listings). To retrieve order line items
by SKU, use <b>GetSellerTransactions</b> or <b>GetOrderTransactions</b> instead.
</span>
GetItemTransactions
Conditionally
The <b>ModTimeFrom</b> and <b>ModTimeTo</b> fields specify a date range for retrieving order line items associated with the specified <b>ItemID</b> value. The <b>ModTimeFrom</b> field is the starting date range. All of the listing's order line items that were generated (or last modified)within this date range are returned in the output. The maximum date range that may be specified is 30 days. This value cannot be set back more than 90 days in the past, as this call cannot retrieve sales older than 90 days old. The maximum date range that may be specified is 30 days. This field is not applicable (and is ignored) if the user is looking for a specific order line item by either using an <b>ItemID</b>/<b>TransactionID</b> pair, or an <b>OrderLineItemID</b> value.
GetItemTransactions
No
The <b>ModTimeFrom</b> and <b>ModTimeTo</b> fields specify a date range for retrieving order line items associated with the specified <b>ItemID</b> value. The <b>ModTimeTo</b> field is the ending date range. All eBay order line items that were generated (or last modified) within this date range are returned in the output. The maximum date range that may be specified is 30 days. If the <b>ModTimeFrom</b> field is used and the <b>ModTimeTo</b> field is omitted, the <b>ModTimeTo</b> value defaults to the present time or to 30 days after the date specified with the <b>ModTimeFrom</b> value (if <b>ModTimeFrom</b> value is more than 30 days in the past). This field is not applicable (and is ignored) if the user is looking for a specific order line item by either using an <b>ItemID</b>/<b>TransactionID</b> pair, or an <b>OrderLineItemID</b> value.
GetItemTransactions
No
Include a <b>TransactionID</b> field in the request if you want to retrieve the data for a specific order line item for the listing specified in the <b>ItemID</b> field. This field is really only applicable for a multiple-quantity or multiple-variation, fixed-price listing that may have multiple sales. An auction listing or a single-quantity, fixed-price listing will only result in one order line item, so this field is not needed in these two cases. If an <b>OrderLineItemID</b> value is used instead to identify an order line item, this field is ignored.
<br><br>
If this field is used, any specified date filter is ignored.
GetItemTransactions
No
This container controls how many order line items should be returned per page of data, as well as which page of data to return (if there are multiple pages of order line items). Use the <b>EntriesPerPage</b> property to control the number of order line items to return per call and the <b>PageNumber</b> property to specify the specific page of data to return. If multiple pages of order line items are returned based on input criteria and <b>Pagination</b> properties, <b>GetItemTransactions</b> will need to be called multiple times (with the <b>PageNumber</b> value being increased by 1 each time) to scroll through all results.
GetItemTransactions
No
This field is included and set to <code>true</code> if the user wants to view the Final Value Fee (FVF) for all order line items in the response. The Final Value Fee is returned in the <b>Transaction.FinalValueFee</b> field. The Final Value Fee is assessed right after the creation of an order line item.
<br/><br/>
false
GetItemTransactions
No
This field is included and set to <code>true</code> if the user wants to view order-level details, including the unique identifier of the order and the status of the order. The order-level details will be shown in the <b>ContainingOrder</b> container in the response.
<br/>
false
GetItemTransactions
No
<span class="tablenote"><b>Note: </b> This field is should no longer be used, as its purpose in the past was to give the user the ability to retrieve only eBay marketplace order line items or only Half.com listings, and since the Half.com site no longer exists, this field is no longer relevant.
</span>
1027
NoOp
1033
This date range filter specifies the number of days (24-hour periods) in the past to search for order line items. All eBay order line items that were either created or modified within this period are returned in the response. If specified, <b>NumberOfDays</b> will override any date range specified with the <b>ModTimeFrom</b>/<b>ModTimeTo</b> date range filters. This field is not applicable if a specific order line item is specified either through an <b>ItemID</b><b>TransactionID</b> pair or an <b>OrderLineItemID</b> value.
30
1
30
GetItemTransactions
No
If this field is included in the request and set to <code>true</code>, details on all variations defined in the specified multiple-variation listing are returned, including variations that have no sales. If this field is not included in the request or set to <code>false</code>, the variations with sales are still returned in separate <b>Transaction</b> nodes. This information is intended to help sellers to reconcile their local inventory with eBay's records, while processing order line items (without requiring a separate call to <b>GetItem</b>).
GetItemTransactions
false
No
A unique identifier for an eBay order line item. This identifier is created once there is a commitment to buy (bidder wins the auction, buyer clicks buy button, or buyer purchases item through <b>PlaceOffer</b> call). If you want to retrieve data on a
specific order line item, you can use an <b>OrderLineItemID</b> value in the
request instead of an <b>ItemID</b>/<b>TransactionID</b> pair. If an <b>OrderLineItemID</b> is
provided, any specified date range filter is ignored.
GetItemTransactions
No
Returns an array of order line item data for the item specified in the request.
The results can be used to create a report of data that is commonly
necessary for order processing.
Zero, one, or many <b>Transaction</b> objects can be returned in the <b>TransactionArray</b>.
The set of order line items returned is limited to those that were modified between
the times specified in the request's <b>ModTimeFrom</b> and <b>ModTime</b> filters.
Also returns the <b>Item</b> object that spawned the order line items.
If pagination filters were specified in the request, returns meta-data describing
the effects of those filters on the current response and the estimated effects if
the same filters are used in subsequent calls.
<br><br>
Data from the <b>TransactionArray</b> may be used to trigger the following Platform
Notifications: EndOfAuction, AuctionCheckoutComplete, FixedPriceEndOfTransaction,
CheckoutBuyerRequestTotal, FixedPriceTransaction, Checkout,
FixedPriceTransactionForSeller, FixedPriceTransactionForBuyer, ItemMarkedAsShipped,
and ItemMarkedAsPaid. Each notification will be based on the state of the item
(a 'snapshot' of the item) at the time the order line item was created.
Contains the total number of pages (<b>TotalNumberOfPages</b>) and the total number
of entries (<b>TotalNumberOfEntries</b>) that could be returned given repeated calls
that use the same selection criteria as the call that returned this response.
GetItemTransactions
DetailLevel: none, ReturnAll, ItemReturnDescription
Always
Indicates whether there are additional order line items to retrieve.
That is, indicates whether more pages of data are available to be
returned, given the filters that were specified in the request.
Returns false for the last page of data.
GetItemTransactions
DetailLevel: none, ReturnAll, ItemReturnDescription
Always
Number of order line items returned per page (per call). May be a higher value
than <b>ReturnedTransactionCountActual</b> if the page returned is the last page
and more than one page of data exists.
GetItemTransactions
DetailLevel: none, ReturnAll, ItemReturnDescription
Always
Page number for the page of order line items the response returned.
GetItemTransactions
DetailLevel: none, ReturnAll, ItemReturnDescription
Always
Number of order line items retrieved in the current page of results just returned.
May be a lower value than <b>TransactionsPerPage</b> if the page returned is the last
page and more than one page of data exists.
GetItemTransactions
DetailLevel: none, ReturnAll, ItemReturnDescription
Always
<b>Item</b> object that spawned the order line item. It is a purchase from this item's listing
that the order line item represents.
GetItemTransactions
DetailLevel: none, ReturnAll, ItemReturnDescription
Always
List of <b>Transaction</b> objects representing the order line items resulting
from the listing. Each <b>Transaction</b> object contains the data for one purchase
(of one or more items in the same listing). The <b>Transaction.Item</b> field is not
returned because the <b>Item</b> object is returned at the root level of the response.
See the reference guide for more information about the fields that are returned.
GetItemTransactions
DetailLevel: none, ReturnAll, ItemReturnDescription
Conditionally
Indicates whether the item's seller has the preference enabled that shows
that the seller prefers PayPal as the method of payment for an item. This
preference is indicated on an item's View Item page and is intended to
influence a buyer to use PayPal
to pay for the item.
GetItemTransactions
DetailLevel: none, ReturnAll, ItemReturnDescription
Always
This is the base request type of the <b>GetItemsAwaitingFeedback</b> call. This call retrieves all completed order line items for which the user (buyer or seller) still needs to leave Feedback for their order partner.
This call retrieves all completed order line items for which the user (buyer or seller) still needs to leave Feedback for their order partner.
GetMyeBayReminders
This field allows the user to control how the order line items are returned in the response. If this field is not used, order line items are returned based on end time (from most recent to oldest).
Valid values for this field are:
<ul>
<li><code>EndTime</code></li>
<li><code>EndTimeDescending</code> (default value)</li>
<li><code>FeedbackLeft</code></li>
<li><code>FeedbackLeftDescending</code></li>
<li><code>FeedbackReceived</code></li>
<li><code>FeedbackReceivedDescending</code></li>
<li><code>Title</code></li>
<li><code>TitleDescending</code></li>
<li><code>UserID</code></li>
<li><code>UserIDDescending</code></li>
</ul>
Reference the <a href="types/ItemSortTypeCodeType.html">ItemSortTypeCodeType</a> definition for more information on these sort values.
<br/>
EndTimeDescending
GetItemsAwaitingFeedback
No
This container can be used if the user only wants to see a subset of order line item results. In this container, the user will specify the number of order line items to return per page of data, and will specify the specific page of data they want to view with each call.
<br/><br/>
With the <b>GetItemsAwaitingFeedback</b> call, the maximum allowed value for <b>EntriesPerPage</b> is 200.
GetItemsAwaitingFeedback
No
This is the base response type of the <b>GetItemsAwaitingFeedback</b> call. This call retrieves all completed order line items for which the user (buyer or seller) still needs to leave Feedback for their order partner.
This container consists of one or more order line items that are awaiting Feedback from the user that made the call. Each order line item is returned in its own <b>TransactionArray.Transaction</b> container.
<br><br>
This container will not be returned if no order line items are awaiting Feedback from the user who made the call.
GetItemsAwaitingFeedback
Always
Retrieves a list of the messages buyers have posted about your
active item listings.
GetMyMessages
The unique identifier of the eBay listing for which you wish to retrieve member messages.
<br><br>
For <em>Ask Seller Question</em> messages, the <b>ItemID</b> and/or a date range
(specified with <b>StartCreationTime</b> and <b>EndCreationTime</b> fields),
are required, or the call will fail.
GetMemberMessages
Conditionally
This required field indicates the type of member message to retrieve. Only the following two enumeration values are allowed. The call will fail if this field is not included in the request.
GetMemberMessages
AskSellerQuestion, All
Yes
This field allows you to retrieve only unanswered member messages or answered member messages. If this field is omitted, both answered and unanswered member messages are retrieved.
GetMemberMessages
No
If included in the request and set to <code>true</code>, only public messages (viewable in the Item listing) are returned. If omitted or set to <code>false</code> in the request, all messages (that match other filters in the request) are returned in the response.
GetMemberMessages
No
Used as beginning of date range filter. If specified, filters the returned messages to only those with a creation date greater than or equal to the specified date and time.
<br><br>
For Contact eBay Member (CEM) messages, <b>StartCreationTime</b> and <b>EndCreationTime</b> must be provided.
<br><br>
For Ask Seller a Question (ASQ) messages, either the <b>ItemID</b>, or a date range (specified with <b>StartCreationTime</b> and <b>EndCreationTime</b>), or both must be included.
GetMemberMessages
Conditionally
Used as end of date range filter. If specified, filters
the returned messages to only those with a creation date
less than or equal to the specified date and time.
<br><br>
For Contact eBay Member (CEM) messages, <b>StartCreationTime</b> and <b>EndCreationTime</b>
must be provided.
<br><br>
For Ask Seller a Question (ASQ) messages, either the <b>ItemID</b>, or a date range
(specified with <b>StartCreationTime</b> and <b>EndCreationTime</b>),
or both must be included.
GetMemberMessages
Conditionally
Standard pagination argument used to reduce response.
GetMemberMessages
No
An ID that uniquely identifies the message for a given user to be retrieved. Used for the <b>AskSellerQuestion</b> notification only.
GetMemberMessages
No
An eBay ID that uniquely identifies a user. For <b>GetMemberMessages</b>, this is the sender of the message. If included in the request, returns only messages from the specified sender.
GetMemberMessages
No
Retrieves a list of the messages buyers have posted about your active item listings.
The returned member messages. Returned if messages that meet the request criteria exist. Note that <b>GetMemberMessages</b> does not return messages when, in the request, the <b>MailMessageType</b> is <b>AskSellerQuestion</b>.
GetMemberMessages
Conditionally
Shows the pagination of data returned by requests.
GetMemberMessages
Always
Specifies whether the response has more items.
GetMemberMessages
Always
Returns a seller's Ask Seller a Question (ASQ) subjects, each in
its own <b>Subject</b> field.
SetMessagePreferences
The eBay user ID of the seller to retrieve ASQ subjects for. A user can retrieve their own ASQ subjects or those of another eBay user with a seller account.
GetMessagePreferences
Yes
This field must be included and set to <code>true</code> to retrieve the ASQ subjects for the specified eBay user.
GetMessagePreferences
Yes
Contains the ASQ subjects for the user specified in the request.
Returns a seller's ASQ subjects, each in its own Subject
node. If the seller has not customized the ASQ subjects
using SetMessagePreferences, the call will return the
current default values. Returned if
IncludeASQPreferences = true was specified in the
request.
GetMessagePreferences
Conditionally
Retrieves information about the messages sent to a given user.
Retrieves information about the messages sent to
a user.
DetailLevel
GetMemberMessages
This container is deprecated.
This container can be used to retrieve one or more specific messages identified with their unique <b>MessageID</b> values. Up to 10 <b>MessageID</b> values can be specified with one call.
GetMyMessages
Conditionally
A unique identifier for a My Messages folder. If a <b>FolderID</b> value is provided,
only messages from the specified folder are returned in the response.
GetMyMessages
No
The beginning of the date-range filter.
Filtering takes into account the entire timestamp of when messages were sent.
Messages expire after one year.
GetMyMessages
No
The end of the date-range filter. See StartTime
(which is the beginning of the date-range filter).
GetMyMessages
Conditionally
This field is currently available on the US site. A container for IDs that
uniquely identify messages for a given user. If provided at the time of message
creation, this ID can be used to retrieve messages and will take precedence
over message ID.
GetMyMessages
No
Specifies how to create virtual pages in the returned list (such as total
number of entries and total number of pages to return).
Default value for <b>EntriesPerPage</b> with <b>GetMyMessages</b> is 25.
GetMyMessages
No
If this field is included in the request and set to <code>true</code>, only High Priority messages are returned in the response.
GetMyMessages
No
Conains information about the messages sent to a user. Depending on the detail
level, this information can include message counts, resolution and flagged status,
message headers, and message text.
Summary data for a given user's messages. This includes the numbers of new
messages, flagged messages, and total messages. The amount and type of
data returned is the same whether or not the request includes specific
Message IDs. Always/Conditionally returned logic assumes a detail level of
ReturnMessages.
GetMyMessages
DetailLevel: ReturnSummary
Conditionally
This container is deprecated.
This container consists of an array of one or more messages that match the search criteria in the call request.
GetMyMessages
DetailLevel: ReturnHeaders, ReturnMessages
Always
Retrieves information regarding a user's buying activity, such as items they are watching, bidding on, have won, did not win, and have made Best Offers on.
GetMyeBayReminders
DetailLevel
Include this container and set the <b>WatchList.Include</b> field to <code>true</code> to return the list of items on the eBay user's Watch List.
<br><br>
The user also has the option of using pagination and sorting for the list of watched items that will be returned.
GetMyeBayBuying
No
Include this container and set the <b>BidList.Include</b> field to <code>true</code> to return the list of auction items on which the eBay user has bid.
<br><br>
The user also has the option of using pagination and sorting for the list of auction items that will be returned.
GetMyeBayBuying
No
Include this container and set the <b>BestOfferList.Include</b> field to <code>true</code> to return the list of items on which the eBay user has made a Best Offer.
<br><br>
The user also has the option of using pagination and sorting for the list of items that will be returned.
GetMyeBayBuying
No
Include this container and set the <b>WonList.Include</b> field to <code>true</code> to return the list of auction items on which the eBay user has bid on and won.
<br><br>
The user also has the option of using pagination and sorting for the list of auction items that will be returned.
GetMyeBayBuying
No
Include this container and set the <b>LostList.Include</b> field to <code>true</code> to return the list of auction items on which the eBay user has bid on and lost.
<br><br>
The user also has the option of using pagination and sorting for the list of auction items that will be returned.
GetMyeBayBuying
No
Include this container and set the <b>FavoriteSearches.Include</b> field to <code>true</code> to return the list of the eBay user's saved searches.
GetMyeBayBuying
No
Include this container and set the <b>FavoriteSellers.Include</b> field to <code>true</code> to return the list of the eBay user's saved sellers.
GetMyeBayBuying
No
Include this container and set the <b>SecondChanceOffer.Include</b> field to <code>true</code> to return any Second Chance Offers that the eBay user has received.
GetMyeBayBuying
No
This field is deprecated.
Include this container and set the <b>DeletedFromWonList.Include</b> field to <code>true</code> to return the list of auction items on which the eBay user has bid on and won, but has deleted from their My eBay page.
<br><br>
The user also has the option of using pagination and sorting for the list of auction items that will be returned.
GetMyeBayBuying
No
Include this container and set the <b>DeletedFromLostList.Include</b> field to <code>true</code> to return the list of auction items on which the eBay user has bid on and lost, and has deleted from their My eBay page.
<br><br>
The user also has the option of using pagination and sorting for the list of auction items that will be returned.
GetMyeBayBuying
No
Include this container and set the <b>BuyingSummary.Include</b> field to <code>true</code> to return the <b>BuyingSummary</b> container in the response. The <b>BuyingSummary</b> container consists of buying/bidding activity counts and values.
GetMyeBayBuying
No
Include this container and set the <b>UserDefinedLists.Include</b> field to <code>true</code> to return one or more user-defined lists. User-defined lists are lists created by the user in My eBay and consists of a combination of items, saved sellers, and/or saved searches.
GetMyeBayBuying
No
If this field is included and set to <code>true</code>, the <b>Variations</b> node (and all variation data) is omitted for all multiple-variation listings in the response. If this field is omitted or set to <code>false</code>, the <b>Variations</b> node is returned for all multiple-variation listings in the response.
<br>
GetMyeBayBuying
No
false
Returns information regarding a user's buying activity, such as items they are watching, bidding on, have won, did not win, and have made Best Offers on.
This container consists of buying/bidding activity counts and values. For this container to be returned, the user must include the <b>BuyingSummary.Include</b> field in the request and set its value to <code>true</code>.
GetMyeBayBuying
DetailLevel: ReturnAll
Conditionally
This container consists of the items on the eBay user's Watch List. This container will be returned if the eBay user has one or more items on their Watch List.
<br><br>
This container will not be returned in the response (even if there are items on the Watch List) if the <b>DetailLevel</b> value is set to <code>ReturnSummary</code> and the <b>WatchList.Include</b> field is omitted or set to <code>false</code>.
GetMyeBayBuying
DetailLevel: ReturnAll
Conditionally
This container consists of the auction items on which the eBay user has bid. This container will be returned if the eBay user has bid on one or more auction items.
<br><br>
This container will not be returned in the response (even if there are items on the Bid List) if the <b>DetailLevel</b> value is set to <code>ReturnSummary</code> and the <b>BidList.Include</b> field is omitted or set to <code>false</code>.
GetMyeBayBuying
DetailLevel: ReturnAll
Conditionally
This container consists of the items on which the eBay user has made Best Offers. This container will be returned if the eBay user has made one or more Best Offers.
<br><br>
This container will not be returned in the response (even if user has made Best Offers) if the <b>DetailLevel</b> value is set to <code>ReturnSummary</code> and the <b>BestOfferList.Include</b> field is omitted or set to <code>false</code>.
GetMyeBayBuying
DetailLevel: ReturnAll
Conditionally
This container consists of the auction items on which the eBay user has won. This container will be returned if the eBay user has won one or more auction items.
<br><br>
This container will not be returned in the response (even if there are items on the Won List) if the <b>DetailLevel</b> value is set to <code>ReturnSummary</code> and the <b>WonList.Include</b> field is omitted or set to <code>false</code>.
GetMyeBayBuying
DetailLevel: ReturnAll
Conditionally
This container consists of the auction items on which the eBay user has bid on but lost. This container will be returned if the eBay user has lost one or more auction items.
<br><br>
This container will not be returned in the response (even if the buyer has lost one or more auction items) if the <b>DetailLevel</b> value is set to <code>ReturnSummary</code> and the <b>LostList.Include</b> field is omitted or set to <code>false</code>.
GetMyeBayBuying
DetailLevel: ReturnAll
Conditionally
This container consists of the eBay user's saved searches. This container will be returned if the eBay user has one or more saved searches.
<br><br>
This container will not be returned in the response (even if the user has saved searches) if the <b>DetailLevel</b> value is set to <code>ReturnSummary</code> and the <b>FavoriteSearches.Include</b> field is omitted or set to <code>false</code>.
<br><br>
This container consists of the search name, search query, and other search
elements. The user can copy and paste the URL in the <b>SearchQuery</b> field into a browser to view the search results again.
GetMyeBayBuying
DetailLevel: ReturnAll
Conditionally
This container consists of the eBay user's saved sellers. This container will be returned if the eBay user has one or more saved sellers.
<br><br>
This container will not be returned in the response (even if the user has saved sellers) if the <b>DetailLevel</b> value is set to <code>ReturnSummary</code> and the <b>FavoriteSellers.Include</b> field is omitted or set to <code>false</code>.
<br><br>
This container consists of the saved sellers' user IDs and eBay Store names (if applicable).
GetMyeBayBuying
DetailLevel: ReturnAll
Conditionally
This container consists of the items on which the eBay user has received a Second Chance Offer. This container will be returned if the eBay user has made one or more Second Chance Offers.
<br><br>
This container will not be returned in the response (even if user has received Second Chance Offers) if the <b>DetailLevel</b> value is set to <code>ReturnSummary</code> and the <b>SecondChanceOffer.Include</b> field is omitted or set to <code>false</code>.
GetMyeBayBuying
DetailLevel: ReturnAll
Conditionally
This field is deprecated.
This container consists of the auction items on which the eBay user has won but deleted from their My eBay page. This container will be returned if the eBay user has won one or more auction items but have deleted these items from My eBay.
<br><br>
This container will not be returned in the response (even if they have won and then deleted one or more items) if the <b>DetailLevel</b> value is set to <code>ReturnSummary</code> and the <b>DeletedFromWonList.Include</b> field is omitted or set to <code>false</code>.
GetMyeBayBuying
DetailLevel: ReturnAll
Conditionally
This container consists of the auction items on which the eBay user has lost and then deleted from their My eBay page. This container will be returned if the eBay user has lost one or more auction items and then deleted those items from My eBay.
<br><br>
This container will not be returned in the response (even if they have lost and then deleted one or more items) if the <b>DetailLevel</b> value is set to <code>ReturnSummary</code> and the <b>DeletedFromLostList.Include</b> field is omitted or set to <code>false</code>.
GetMyeBayBuying
DetailLevel: ReturnAll
Conditionally
This container consists of data for a user-defined list that was created by the user in My eBay. User-defined lists consists of a combination of items, saved sellers, and/or saved searches.
<br><br>
This container will not be returned in the response (even if one or more user-defined lists exist) if the <b>DetailLevel</b> value is set to <code>ReturnSummary</code> and the <b>UserDefinedList.Include</b> field is omitted or set to <code>false</code>.
GetMyeBayBuying
Conditionally
This is the base request type of the <b>GetMyeBayReminders</b> call. This call returns the total counts for My eBay Buying and/or My eBay Selling Reminders for a user.
This call returns the total counts for My eBay Buying and/or My eBay Selling Reminders for a user.
GetMyeBayBuying, GetMyeBaySelling
This container should be included if the user wishes to retrieve the counts of My eBay Buying Reminders. Counts will only be retrieved for My eBay Buying Reminders that the user received.
GetMyeBayReminders
No
This container should be included if the user wishes to retrieve the counts of My eBay Selling Reminders. Counts will only be retrieved for My eBay Selling Reminders that the user received.
GetMyeBayReminders
No
This is the base response type of the <b>GetMyeBayReminders</b> call. This call returns the total counts for My eBay Buying and/or My eBay Selling Reminders for a user.
This is the base response type of the <b>GetMyeBayReminders</b> call. This call returns the total counts for My eBay Buying and/or My eBay Selling Reminders for a user.
This container is returned if the user included the <b>BuyingReminders</b> container in the call request and set the <b>BuyingReminders.Include</b> value to <code>true</code>. Counts will only be retrieved for My eBay Buying Reminders that the user received during the number of days specified in the <b>BuyingReminders.DurationInDays</b> field in the call request.
GetMyeBayReminders
Conditionally
This container is returned if the user included the <b>SellingReminders</b> container in the call request and set the <b>SellingReminders.Include</b> value to <code>true</code>. Counts will only be retrieved for My eBay Selling Reminders that the user received during the number of days specified in the <b>SellingReminders.DurationInDays</b> field in the call request.
GetMyeBayReminders
Conditionally
Retrieves information regarding the user's selling activity, such as items that the user is currently selling (the Active list), auction listings that have bids, sold items, and unsold items.
DetailLevel
GetMyeBayReminders
Retrieving Items with GetMyeBaySelling
https://developer.ebay.com/DevZone/guides/features-guide/default.html#development/CRM-MyeBay.html#RetrievingItemswithGetMyeBaySelling
eBay Selling Page (US)
https://www.ebay.com/help/selling
Include this container and set the <b>ScheduledList.Include</b> field to <code>true</code> to return the list of items that are scheduled to become active listings on eBay.com at a future date/time.
<br><br>
The user also has the option of using pagination and sorting for the list of Scheduled listings that will be returned.
GetMyeBaySelling
No
Include this container and set the <b>ActiveList.Include</b> field to <code>true</code> to return the list of active listings on eBay.com.
<br><br>
The user also has the option of using pagination and sorting for the list of active listings that will be returned.
GetMyeBaySelling
No
Include this container and set the <b>SoldList.Include</b> field to <code>true</code> to return the list of sold order line items.
<br><br>
The user also has the option of using pagination and sorting for the list of sold items that will be returned.
GetMyeBaySelling
No
Include this container and set the <b>UnsoldList.Include</b> field to <code>true</code> to return the listings that have ended without a purchase.
<br><br>
The user also has the option of using pagination and sorting for the list of unsold items that will be returned.
GetMyeBaySelling
No
This container is deprecated as a Bid List is no longer returned in <b>GetMyeBaySelling</b>.
Include this container and set the <b>DeletedFromSoldList.Include</b> field to <code>true</code> to return the list of sold order line items that have since been deleted from the seller's My eBay page.
<br><br>
The user also has the option of using pagination and sorting for the list of deleted, sold items that will be returned.
GetMyeBaySelling
No
Include this container and set the <b>DeletedFromUnsoldList.Include</b> field to <code>true</code> to return the list of unsold order line items that have since been deleted from the seller's My eBay page.
<br><br>
The user also has the option of using pagination and sorting for the list of deleted, unsold items that will be returned.
GetMyeBaySelling
No
Include this container and set the <b>SellingSummary.Include</b> field to <code>true</code> to return the <b>SellingSummary</b> container in the response. The <b>SellingSummary</b> container consists of selling activity counts and values.
GetMyeBaySelling
No
If this field is included and set to <code>true</code>, the <b>Variations</b> node (and all variation data) is omitted for all multiple-variation listings in the response. If this field is omitted or set to <code>false</code>, the <b>Variations</b> node is returned for all multiple-variation listings in the response.
<br>
GetMyeBaySelling
No
false
Returns summary and detail information about items the user is selling,
items scheduled to sell, currently listed, sold, and closed but not sold.
This container consists of seller activity counts and values. For this container to be returned, the user must include the <b>SellingSummary.Include</b> field in the request and set its value to <code>true</code>.
GetMyeBaySelling
DetailLevel: none, ReturnAll
Conditionally
This container consists of the items that are scheduled to become active at a future date/time. This container will be returned if the eBay user has one or more listings scheduled to become active at a future date/time.
<br><br>
This container will not be returned in the response (even if there are listings scheduled to become active) if the <b>DetailLevel</b> value is set to <code>ReturnSummary</code> and the <b>ScheduledList.Include</b> field is omitted or set to <code>false</code>.
GetMyeBaySelling
DetailLevel: none, ReturnAll
Conditionally
This container consists of active listings. This container will be returned if the eBay user has one or more active listings on eBay.com.
<br><br>
This container will not be returned in the response (even if there are one or more active listings) if the <b>DetailLevel</b> value is set to <code>ReturnSummary</code> and the <b>ActiveList.Include</b> field is omitted or set to <code>false</code>.
GetMyeBaySelling
DetailLevel: none, ReturnAll
Conditionally
This container consists of order line items that have been sold. This container will be returned if the eBay user has one or more listings that have had recent sales.
<br><br>
This container will not be returned in the response (even if there are one or more sales) if the <b>DetailLevel</b> value is set to <code>ReturnSummary</code> and the <b>SoldList.Include</b> field is omitted or set to <code>false</code>.
GetMyeBaySelling
DetailLevel: none, ReturnAll
Conditionally
This container consists of listings that have ended without sales. This container will be returned if the eBay user has one or more listings that have ended without sales.
<br><br>
This container will not be returned in the response (even if there are one or more listings that ended without sales) if the <b>DetailLevel</b> value is set to <code>ReturnSummary</code> and the <b>UnsoldList.Include</b> field is omitted or set to <code>false</code>.
GetMyeBaySelling
DetailLevel: none, ReturnAll
Conditionally
This container consists of seller activity counts and values. This container is always returned if there has been recent sell activity.
GetMyeBaySelling
DetailLevel: none, ReturnAll
Always
This container is no longer applicable to <b>GetMyeBaySelling</b>.
This container consists of listings that have had sales but have been deleted from My eBay. This container will be returned if the eBay user has one or more listings with sales that have been deleted from My eBay.
<br><br>
This container will not be returned in the response (even if there are one or more listings that have sales but have been deleted) if the <b>DetailLevel</b> value is set to <code>ReturnSummary</code> and the <b>DeletedFromSoldList.Include</b> field is omitted or set to <code>false</code>.
GetMyeBaySelling
DetailLevel: none, ReturnAll
Conditionally
This container consists of listings that have ended without sales and have been deleted from My eBay. This container will be returned if the eBay user has one or more listings with sales that have been deleted from My eBay.
<br><br>
This container will not be returned in the response (even if there are one or more listings that have sales but have been deleted) if the <b>DetailLevel</b> value is set to <code>ReturnSummary</code> and the <b>DeletedFromSoldList.Include</b> field is omitted or set to <code>false</code>.
GetMyeBaySelling
DetailLevel: none, ReturnAll
Conditionally
Retrieves the requesting application's notification preferences. Details are only returned for events for which a preference has been set. For example, if you enabled notification for the <b>EndOfAuction</b> event and later disabled it, the <b>GetNotificationPreferences</b> response would cite the <b>EndOfAuction</b> event preference as <b>Disabled</b>. Otherwise, no details would be returned regarding <b>EndOfAuction</b>.
Working with Platform Notifications
http://developer.ebay.com/DevZone/guides/features-guide/default.html#development/Notifications.html
Specifies the type of preferences to retrieve. For example, preferences can be associated with a user, with
an application, or with events.
<br>
Application
GetNotificationPreferences
Yes
Contains the requesting application's notification preferences. <b>GetNotificationPreferences</b> retrieves preferences that you have deliberately set. For example, if you enable the <b>EndOfAuction</b> event and then later disable it, the response shows the <b>EndOfAuction</b> event preference as <b>Disabled</b>. But if you have never set a preference for the <b>EndOfAuction</b> event, no <b>EndOfAuction</b> preference is returned at all.
Specifies application-based event preferences that have been enabled.
GetNotificationPreferences
Conditionally
Specifies application delivery URL Name associated with this user.
GetNotificationPreferences
Conditionally
Specifies user-based event preferences that have been enabled or disabled.
GetNotificationPreferences
Conditionally
Returns user data for notification settings, such as set mobile phone.
GetNotificationPreferences
Conditionally
Contains names and values assigned to a notification event.
Currently can only be set for wireless applications.
GetNotificationPreferences
Conditionally
Retrieves usage information about platform notifications for a given application.
You can use this notification information to troubleshoot issues with platform
notifications. You can call this up to 50 times per hour for a given application.
Working with Platform Notifications
http://developer.ebay.com/DevZone/guides/features-guide/default.html#development/Notifications.html
Specifies the start date and time for which notification information will be retrieved. <b>StartTime</b> is optional. If no <b>StartTime</b> is specified, the default value of 24 hours prior to the call time is used. If no <b>StartTime</b> is specified or if an invalid <b>StartTime</b> is specified, date range errors are returned in the response. For a <b>StartTime</b> to be valid, it must be no more than 72 hours before the time of the call, it cannot be more recent than the <b>EndTime</b>, and it cannot be later than the time of the call. If an invalid <b>StartTime</b> is specified, the default value is used.
GetNotificationsUsage
Conditionally
Specifies the end date and time for which notification information will be retrieved. <b>EndTime</b> is optional. <br/><br/> If no <b>EndTime</b> is specified, the current time (the time the call is made) is used. If no <b>EndTime</b> is specified or if an invalid <b>EndTime</b> is specified, date range errors are returned in the response. For an <b>EndTime</b> to be valid, it must be no more than 72 hours before the time the of the call, it cannot be before the <b>StartTime</b>, and it cannot be later than the time of the call. If an invalid <b>EndTime</b> is specified, the current time is used.
GetNotificationsUsage
Conditionally
Specifies an item ID for which detailed notification information will be retrieved. <b>ItemID</b> is optional. If no <b>ItemID</b> is specified, the response will not include any individual notification details.
GetNotificationsUsage
Conditionally
Returns an array of notifications sent to a given application identified by the appID (comes in the credentials). The result can be used by third-party developers troubleshoot issues with notifications. <br/><br/> Zero, one or many notifications can be returned in the array. The set of notifications returned is limited to those that were sent between the <b>StartTime</b> and <b>EndTime</b> specified in the request. <br/><br/> If <b>StartTime</b> or <b>EndTime</b> filters were not found in the request, then the response will contain the data for only one day (Now-1day). By default, maximum duration is limited to 3 days (Now-3days). These min (1day) and max(3days) applies to <b>Notifications</b>, <b>MarkDownMarkUpHistory</b> and <b>NotificationStatistics</b>. <br/><br/> Notifications are sent only if the <b>ItemID</b> is included in the request. If there is no <b>ItemID</b>, then only <b>Statistics</b> and <b>MarkDownMarkUpHistory</b> information is included.
Returns the start date and time for the notification information that is
returned by this call.
GetNotificationsUsage
Always
Returns the end date and time for the notification information that is
returned by this call.
GetNotificationsUsage
Always
List of notification objects representing the notifications sent to an
application for the given time period. It will only be returned if ItemID
was specified in the input request.
GetNotificationsUsage
Conditionally
List of objects representing <b>MarkUp</b> or <b>MarkDown</b> history for a given appID
and for given <b>StartTime</b> and <b>EndTime</b>. This node will always be returned.
GetNotificationsUsage
Always
Summary information about number of notifications that were successfully
delivered, queued, failed, connection attempts made, connection timeouts,
http errors for the given appID and given time period. By default, statistics
for only one day (Now-1day) is included. Maximum time duration allowed is 3 days
(Now-3days).
GetNotificationsUsage
Always
The base request type for the <b>GetOrderTransactions</b> call. This call retrieves detailed information about one or more orders or order line items created (or modified) in the last 90 days.
<br><br>
Unlike <b>GetOrders</b>, which can be used to retrieve specific orders, or orders created (or modified) within a specific time period, the <b>GetOrderTransactions</b> call only supports the retrieval of specific orders and/or order line items.
This call retrieves detailed information about one or more order or order line items.
DetailLevel
GetOrders
This container is used if the seller wants to retrieve for one or more order line items. An <b>ItemTransactionID</b> container is required for each order line item that is to be retrieved. An order line item can be identified with an <b>ItemID</b>/<b>TransactionID</b> pair, with an <b>OrderLineItemID</b> value, or with a <b>SKU</b> value (if a SKU is defined for the order line item).
GetOrderTransactions
Conditionally
This container is used if the seller wants to search for one or more orders. An <b>OrderID</b> field is required for each order that is to be retrieved. Up to 20 <b>OrderID</b> fields can be used.
<br><br>
<span class="tablenote"><b>Note: </b> As of June 2019, eBay has changed the format of order identifier values. The new format is a non-parsable string, globally unique across all eBay marketplaces, and consistent for both single line item and multiple line item orders. Unlike in the past, instead of just being known and exposed to the seller, these unique order identifiers will also be known and used/referenced by the buyer and eBay customer support.
<br><br>
For developers and sellers who are already integrated with the Trading API's order management calls, this change shouldn't impact your integration unless you parse the existing order identifiers (e.g., <b>OrderID</b> or <b>OrderLineItemID</b>), or otherwise infer meaning from the format (e.g., differentiating between a single line item order versus a multiple line item order). Because we realize that some integrations may have logic that is dependent upon the old identifier format, eBay is rolling out this Trading API change with version control to support a transition period of approximately 9 months before applications must switch to the new format completely.
<br><br>
During the transition period, for developers/sellers using a Trading WSDL older than Version 1113, they can use the <b>X-EBAY-API-COMPATIBILITY-LEVEL</b> HTTP header in API calls to control whether the new or old <b>OrderID</b> format is returned in call response payloads. To get the new <b>OrderID</b> format, the value of the <b>X-EBAY-API-COMPATIBILITY-LEVEL</b> HTTP header must be set to <code>1113</code>. During the transition period and even after, the new and old <b>OrderID</b> formats will still be supported/accepted in all Trading API call request payloads. After the transition period (which will be announced), only the new <b>OrderID</b> format will be returned in all Trading API call response payloads, regardless of the Trading WSDL version used or specified compatibility level.
</span>
<br>
<span class="tablenote"><b>Note: </b> For sellers integrated with the new order ID format, please note that the identifier for an order will change as it goes from unpaid to paid status. Sellers can check to see if an order has been paid by looking for a value of 'Complete' in the <b>CheckoutStatus.Status</b> field in the response of <b>GetOrders</b> or <b>GetOrderTransactions</b> call, or in the <b>Status.CompleteStatus</b> field in the response of <b>GetItemTransactions</b> or <b>GetSellerTransactions</b> call. Sellers should not fulfill orders until buyer has made payment. When using a <b>GetOrders</b> or <b>GetOrderTransactions</b> call to retrieve specific order(s), either of these order IDs (paid or unpaid status) can be used to retrieve an order.
</span>
GetOrderTransactions
Conditionally
<span class="tablenote"><b>Note: </b> This field should no longer be used since its sole purpose was to allow the seller to filter between eBay orders and Half.com orders, and the Half.com site no longer exists.
</span>
1027
NoOp
1033
This field is included and set to <code>true</code> if the user wants to view the Final Value Fee (FVF) for all order line items in the response. The Final Value Fee is returned in the <b>Transaction.FinalValueFee</b> field. The Final Value Fee is assessed right after the creation of an order line item.
<br/>
false
GetOrderTransactions
No
The base response type for the <b>GetOrderTransactions</b> call. This call retrieves detailed information about one or more eBay.com orders. An <b>OrderArray.Order</b> container is returned for each order that matches the input criteria in the call request.
This container consists of an array of eBay orders that match the input criteria that was passed into the call request.
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Always
Retrieves the orders for which the authenticated user is a participant, either as the buyer or the seller. The call returns all the orders that meet the request criteria. Orders older than 90 days old will not be returned.
DetailLevel
This container is used if the user wants to retrieve one or more specific orders in which they are involved as either the seller or buyer. If one or more order IDs are specified in this container, any order role, order status, or date range filters are ignored if specified in the request.
<br><br>
<span class="tablenote"><b>Note: </b> As of June 2019, eBay has changed the format of order identifier values. The new format is a non-parsable string, globally unique across all eBay marketplaces, and consistent for both single line item and multiple line item orders. Unlike in the past, instead of just being known and exposed to the seller, these unique order identifiers will also be known and used/referenced by the buyer and eBay customer support.
<br><br>
For developers and sellers who are already integrated with the Trading API's order management calls, this change shouldn't impact your integration unless you parse the existing order identifiers (e.g., <b>OrderID</b> or <b>OrderLineItemID</b>), or otherwise infer meaning from the format (e.g., differentiating between a single line item order versus a multiple line item order). Because we realize that some integrations may have logic that is dependent upon the old identifier format, eBay is rolling out this Trading API change with version control to support a transition period of approximately 9 months before applications must switch to the new format completely.
<br><br>
During the transition period, for developers/sellers using a Trading WSDL older than Version 1113, they can use the <b>X-EBAY-API-COMPATIBILITY-LEVEL</b> HTTP header in API calls to control whether the new or old <b>OrderID</b> format is returned in call response payloads. To get the new <b>OrderID</b> format, the value of the <b>X-EBAY-API-COMPATIBILITY-LEVEL</b> HTTP header must be set to <code>1113</code>. During the transition period and even after, the new and old <b>OrderID</b> formats will still be supported/accepted in all Trading API call request payloads. After the transition period (which will be announced), only the new <b>OrderID</b> format will be returned in all Trading API call response payloads, regardless of the Trading WSDL version used or specified compatibility level.
</span>
<br>
<span class="tablenote"><b>Note: </b> For sellers integrated with the new order ID format, please note that the identifier for an order will change as it goes from unpaid to paid status. Sellers can check to see if an order has been paid by looking for a value of 'Complete' in the <b>CheckoutStatus.Status</b> field in the response of <b>GetOrders</b> or <b>GetOrderTransactions</b> call, or in the <b>Status.CompleteStatus</b> field in the response of <b>GetItemTransactions</b> or <b>GetSellerTransactions</b> call. Sellers should not fulfill orders until buyer has made payment. When using a <b>GetOrders</b> or <b>GetOrderTransactions</b> call to retrieve specific order(s), either of these order IDs (paid or unpaid status) can be used to retrieve an order.
</span>
GetOrders
Conditionally
The <b>CreateTimeFrom</b> and <b>CreateTimeTo</b> fields specify a date range for retrieving orders that were created during this time period. The <b>CreateTimeFrom</b> field is the starting date range. All eBay orders that were created within this date range are returned in the output. The maximum date range that may be specified with the <b>CreateTimeFrom</b> and <b>CreateTimeTo</b> fields is 90 days. <b>CreateTimeFrom</b>/<b>CreateTimeTo</b> date filters are ignored if the <b>NumberOfDays</b> date filter is used in the request, or if one or more order IDs are passed in the request. This value cannot be set back more than 90 days in the past, as this call cannot retrieve sales older than 90 days old.
<br><br>
<span class="tablenote"><strong>Note:</strong>
Unless one or more <b>OrderID</b> values are used, one of the three available date range filters must be used.
</span>
GetOrders
Conditionally
The <b>CreateTimeFrom</b> and <b>CreateTimeTo</b> fields specify a date range for retrieving orders that were created during this time period. The <b>CreateTimeTo</b> field is the ending date range. All eBay orders that were created within this date range are returned in the output. The maximum date range that may be specified with the <b>CreateTimeFrom</b> and <b>CreateTimeTo</b> fields is 90 days. If the <b>CreateTimeFrom</b> field is used and the <b>CreateTimeTo</b> field is omitted, the "TimeTo" value defaults to the present time or to 90 days past the <b>CreateTimeFrom</b> value (if <b>CreateTimeFrom</b> value is more than 90 days in the past). <b>CreateTimeFrom</b>/<b>CreateTimeTo</b> date filters are ignored if the <b>NumberOfDays</b> date filter is used in the request, or if one or more order IDs are passed in the request.
<br><br>
<span class="tablenote"><strong>Note:</strong> If a <b>GetOrders</b> call is made within a few seconds after the creation of a multiple line item order, the caller runs the risk of retrieving orders that are in an inconsistent state, since the order consolidation involved in a multiple line item order may not have been completed. For this reason, it is recommended that sellers include the <b>CreateTimeTo</b> field in the call, and set its value to: <i>Current Time</i> - 2 minutes.
</span>
<br>
<span class="tablenote"><strong>Note:</strong>
Unless one or more <b>OrderID</b> values are used, one of the three available date range filters must be used.
</span>
GetOrders
Conditionally
This filter is used to toggle between retrieving orders based on the role of the user (seller or buyer). The order role defaults to <code>Seller</code> if this field is not used. If this field is used with a date filter, returned orders must satisfy both the date range and the <b>OrderRole</b> value.
<br>
Seller
GetOrders
Conditionally
The field is used to retrieve eBay orders that are in a specific state. If this field is used with a date filter, only orders that satisfy both the date range and the <b>OrderStatus</b> value are retrieved. <br><br> If one or more <b>OrderID</b> values are specified through the <b>OrderIDArray</b> container, the <b>OrderStatus</b> field should not be used, and it is ignored if it is used. If an <b>OrderStatus</b> value is not used and no <b>OrderID</b> values are specified, orders in all states are returned.
<br>
GetOrders
Active, All, Cancelled, Completed, Inactive
No
All
<span class="tablenote"><b>Note: </b> This field's purpose was to allow the seller to retrieve only Half.com listings. Since the Half.com site has been shut down, this field is no longer applicable.
</span>
1027
NoOp
1033
If many orders are available to retrieve, you may need to call <b>GetOrders</b> multiple times to retrieve all the data. Each result set is returned as a page of orders. Use the <b>Pagination</b> filters to control the maximum number of orders to retrieve per page (i.e., per call), and the page number to retrieve.
GetOrders
No
The <b>ModTimeFrom</b> and <b>ModTimeTo</b> fields specify a date range for retrieving existing orders that have been modified within this time period (for example, <code>Incomplete</code> status to <code>Pending</code> status or <code>Pending</code> status to <code>Complete</code> status). The <b>ModTimeFrom</b> field is the starting date range. All eBay orders that were last modified within this date range are returned in the output. Unlike the <b>CreateTimeFrom</b>/<b>CreateTimeTo</b> filters, which may cover a maximum period of 90 days, the maximum date range that may be specified with the <b>ModTimeFrom</b> and <b>ModTimeTo</b> fields is only 30 days. This value cannot be set back more than 90 days in the past, as this call cannot retrieve sales older than 90 days old. <b>ModTimeFrom</b>/<b>ModTimeTo</b> date filters are ignored if the <b>CreateTimeFrom</b>/<b>CreateTimeTo</b> or <b>NumberOfDays</b> date filters are used in the request, or if one or more order IDs are passed in the request.
<br><br>
<span class="tablenote"><strong>Note:</strong>
Unless one or more <b>OrderID</b> values are used, one of the three available date range filters must be used.
</span>
GetOrders
Conditionally
The <b>ModTimeFrom</b> and <b>ModTimeTo</b> fields specify a date range for retrieving existing orders that have been modified within this time window (for example, <code>Incomplete</code> status to <code>Pending</code> status or <code>Pending</code> status to <code>Complete</code> status). The <b>ModTimeTo</b> field is the ending date range. All eBay orders that were last modified within this date range are returned in the output. Unlike the <b>CreateTimeFrom</b>/<b>CreateTimeTo</b> filters, which may cover a maximum period of 90 days, the maximum date range that may be specified with the <b>ModTimeFrom</b> and <b>ModTimeTo</b> fields is 30 days. If the <b>ModTimeFrom</b> field is used and the <b>ModTimeTo</b> field is omitted, the 'TimeTo' value defaults to the present time (if <b>ModTimeFrom</b> value is less than 30 days in the past) or to 30 days past the <b>ModTimeFrom</b> value. <b>ModTimeFrom</b>/<b>ModTimeTo</b> date filters are ignored if the <b>CreateTimeFrom</b>/<b>CreateTimeTo</b> or <b>NumberOfDays</b> date filters are used in the request, or if one or more order IDs are passed in the request.
<br><br>
<span class="tablenote"><strong>Note:</strong>
Unless one or more <b>OrderID</b> values are used, one of the three available date range filters must be used.
</span>
GetOrders
Conditionally
This filter specifies the number of days (24-hour periods) in the past to search for orders. All eBay orders that were either created or modified within this period are returned in the output. This field cannot be used in conjunction with the <b>CreateTimeFrom</b>/<b>CreateTimeTo</b> or <b>ModTimeFrom</b>/<b>ModTimeTo</b> date filters.
<br><br>
<span class="tablenote"><strong>Note:</strong>
This date filter only allows you to retrieve orders created/modified within the last 30 days. So, if you wish to retrieve orders created and/or modified more than 30 days in the past, the <b>CreateTimeFrom</b>/<b>CreateTimeTo</b> or <b>ModTimeFrom</b>/<b>ModTimeTo</b> date filters should be used instead.
</span>
<br>
<span class="tablenote"><strong>Note:</strong>
Unless one or more <b>OrderID</b> values are used, one of the three available date range filters must be used.
</span>
1
30
GetOrders
Conditionally
This field is included and set to <code>true</code> if the user wants to view the Final Value Fee (FVF) for all orders in the response. The Final Value Fee is returned in the <b>Transaction.FinalValueFee</b> field. The Final Value Fee is assessed right after the creation of an order line item.
<br/>
false
GetOrders
Conditionally
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). The default is <code>Ascending</code>, so the user will need to include this field and set it to <code>Descending</code> if the user wishes to view the most recent orders first in the retrieved output.
<br>
Ascending
GetOrders
No
Returns the set of orders that match the order IDs or filter criteria specified.
Contains information regarding the pagination of data, including the total number of pages and the total number of orders.
GetOrders
DetailLevel: none, ReturnAll
Always
A true value indicates that there are more orders to be retrieved. Additional <b>GetOrders</b> calls with higher page numbers or more entries per page must be made to retrieve these orders. If false, no more orders are available or no orders match the request (based on the input filters).
GetOrders
DetailLevel: none, ReturnAll
Always
The set of orders that match the order IDs or filter criteria specified.
GetOrders
DetailLevel: none, ReturnAll
Always
Indicates the number of orders that can be returned per page of data (i.e., per call). This is the same value specified in the <b>Pagination.EntriesPerPage</b> input (or the default value, if <b>EntriesPerPage</b> was not specified). This is not necessarily the actual number of orders returned per page (see <b>ReturnedOrderCountActual</b>).
GetOrders
DetailLevel: none, ReturnAll
Always
Indicates the page number of data returned in the response. This is the same value specified in the <b>Pagination.PageNumber</b> input. If orders are returned, the first page is 1.
GetOrders
DetailLevel: none, ReturnAll
Always
Indicates the total number of orders returned.
GetOrders
DetailLevel: none, ReturnAll
Always
The base request type for the <b>GetPromotionalSaleDetails</b> call. This call retrieves information about promotional sales set up by an eBay store owner. The eBay store owner has the option to retrieve all promotional sales, a specific promotional sale, or promotional sales in a specific state.
This call retrieves information about promotional sales set up by an eBay store owner.
SetPromotionalSale, SetPromotionalSaleListings
Putting Store Items on Sale
https://developer.ebay.com/DevZone/guides/features-guide/default.html#development/Sites-eBayStore.html
The unique identifier of the promotional sale to retrieve. This field is used if the eBay store owner only wants to retrieve a specific promotional sale. Any <b>PromotionalSaleStatus</b> fields that are included will be ignored if the <b>PromotionalSaleID</b> field is used.
<br><br>
If neither the <b>PromotionalSaleID</b> nor a <b>PromotionalSaleStatus</b> field is used, then all promotional sales for the eBay store owner are returned.
GetPromotionalSaleDetails
No
One or more <b>PromotionalSaleStatus</b> fields are used if the eBay store owner wants to retrieve promotional sales in a specific state, such as <code>Active</code>, <code>Scheduled</code>, or <code>Deleted</code>. A <b>PromotionalSaleStatus</b> field is included for each status. See <a href="types/PromotionalSaleStatusCodeType.html">PromotionalSaleStatusCodeType</a> for a description of the status values that can be used in this field.
<br><br>
If neither the <b>PromotionalSaleID</b> nor a <b>PromotionalSaleStatus</b> field is used, then all promotional sales for the eBay store owner are returned.
GetPromotionalSaleDetails
No
The base response type for the <b>GetPromotionalSaleDetails</b> call. This call retrieves information about promotional sales set up by an eBay store owner.
This container consists of an array of one or more promotional sales for an eBay store owner. A <b>PromotionalSaleDetails.PromotionalSale</b> container is returned for each promotional sale that matches the input criteria in the call request.
GetPromotionalSaleDetails
Conditionally
The base request type for the <b>GetSellerDashboard</b> call. This call retrieves seller performance data, including seller standards level, Power Seller status, Buyer Satisfaction status, eBay Search standing, and any seller fee discounts.
This call retrieves seller performance data, including seller standards level, Power Seller status, Buyer Satisfaction status, eBay Search standing, and any seller fee discounts.
The base response type for the <b>GetSellerDashboard</b> call. This call retrieves seller performance data, including seller standards level, Power Seller status, Buyer Satisfaction status, eBay Search standing, and any seller fee discounts.
Provides information about the visibility level you have earned for your
listings. The higher your search standing rating, the higher your items
will be placed in search results sorted by Best Match. Because your search
standing rating is directly tied to your customer service record, this
rating is an important way that eBay rewards you as a good seller--it
encourages you to give buyers the best possible shopping experience.
<br><br>
This field is returned <b>only</b> for the following sites.
<br><br>
<table>
<tr> <th>Site</th> <th>Id</th> </tr>
<tr> <td>AU</td> <td>15</td> </tr>
<tr> <td>BEFR</td> <td>23</td> </tr>
<tr> <td>BENL</td> <td>123</td> </tr>
<tr> <td>CA</td> <td>2</td> </tr>
<tr> <td>ES</td> <td>186</td> </tr>
<tr> <td>FR</td> <td>71</td> </tr>
<tr> <td>IN</td> <td>203</td> </tr>
<tr> <td>IT</td> <td>101</td> </tr>
<tr> <td>MOTORS</td> <td>100</td> </tr>
<tr> <td>NL</td> <td>146</td> </tr>
<tr> <td>PL</td> <td>212</td> </tr>
</table>
GetSellerDashboard
Conditionally
About Your Seller Dashboard: Search Standing
http://pages.ebay.com/help/myebay/seller-dashboard.html#standing
Zum Thema Verkaeufer-Cockpit: Platzierung in der Suche
http://pages.ebay.de/help/myebay/seller-dashboard.html#standing
This container provides the percentage discount that the seller is eligible to receive on the Final Value Fee for each order line item. Top-Rated Sellers may be eligible for Final Value Fee discounts if their listings meet all requirements for the discount.
<br><br>
This container is still returned even if the seller is not receiving a Final Value Fee discount (returned as <code>0.0</code>)
GetSellerDashboard
Conditionally
Becoming a Top Rated Seller and qualifying for Top Rated Plus
http://pages.ebay.com/help/sell/top-rated.html
Zum Thema Verkaeufer-Cockpit: PowerSeller-Rabatt
http://pages.ebay.de/help/myebay/seller-dashboard.html#discount
This container provides the seller's PowerSeller status, as well as any informational alerts related to the seller's PowerSeller status. If the seller has not achieved Power Seller status, a value of <code>None</code> will be returned in the <b>PowerSellerStatus.Level</b> field. A <b>PowerSellerStatus.Alert</b> container will only be returned if there is an alert/message related to the seller's PowerSeller status.
<br><br>
For eBay Germany and France, you must be a registered business seller to
see your Power Seller status.
GetSellerDashboard
Conditionally
Becoming a PowerSeller
http://pages.ebay.com/help/sell/sell-powersellers.html
What's a PowerSeller
http://pages.ebay.com/services/buyandsell/welcome.html
Zum Thema Verkaeufer-Cockpit: PowerSeller-Status
http://pages.ebay.de/help/myebay/seller-dashboard.html#status
This container is no longer returned in <b>GetSellerDashboard</b>.
This container provides the seller's Buyer Satisfaction status, as well as any informational alerts related to the seller's Buyer Satisfaction status. A <b>BuyerSatisfaction.Alert</b> container will only be returned if there is an alert/message related to the seller's Buyer Satisfaction status.
<br><br>
This field is not returned for all sites.
GetSellerDashboard
Conditionally
This container provides the seller's account status, as well as any informational alerts related to the seller's account status. A seller's account status can either be 'current' (all selling fees paid), 'past due' (seller is late paying selling fees), or 'on hold' (seller will be blocked from listing and is in danger of being suspended until selling fees are brought current). A <b>SellerAccount.Alert</b> container will only be returned if there is an alert/message related to the seller's account status.
GetSellerDashboard
Always
This container provides the seller's performance level, as well as any informational alerts related to the seller's performance level. A <b>Performance.Alert</b> container will only be returned if there is an alert/message related to the seller's performance level.
GetSellerDashboard
Always
Becoming a Top Rated Seller and qualifying for Top Rated Plus
http://pages.ebay.com/help/sell/top-rated.html
About your Seller Dashboard: Performance summary
http://pages.ebay.com/help/myebay/seller-dashboard.html#performance
Zum Thema Verkaeufer-Cockpit: Leistung
http://pages.ebay.de/help/myebay/seller-dashboard.html#performance
This call is used by a seller to retrieve changes to their own listings that have occurred within the last 48 hours, including price changes, available quantity, and other revisions to listing.
<br/><br/>
One of the available date range filters must be used with this call.
DetailLevel
Working with Seller Events
http://developer.ebay.com/DevZone/guides/features-guide/default.html#development/Listings-ChangeTracking.html
<span class="tablenote"><strong>Note:</strong>
This field should no longer be used, and will be ignored if it is included in a <b>GetSellerEvents</b> request. There are plans to remove this field from the public WSDL. The only eBay user ID that can be used is the one associated with the authentication token.
</span>
1099
1099
NoOp
Describes the earliest (oldest) time to use in a time range filter based
on item start time. Must be specified if <b>StartTimeTo</b> is specified.
<br/><br/>
Either
the <b>StartTimeFrom</b>, <b>EndTimeFrom</b>, or <b>ModTimeFrom</b> filter must be specified.
<br/><br/>
If you do not specify the corresponding <b>To</b> filter,
it is set to the time you make the call.
<br/><br/>
For better results, the time period you use should be less than 48 hours.
If 3000 or more items are found, use a smaller time range.<br>
<br>
Include a 2-minute, overlapping buffer between requests.
For example, if <b>StartTimeTo</b> was 6:58 in a prior request,
the current request should use 6:56 in <b>StartTimeFrom</b>
(e.g., use ranges like 5:56-6:58, 6:56-7:58, 7:56-8:58).
KB article: Best Practices for GetSellerEvents and GetSellerTransactions
http://ebay.custhelp.com/cgi-bin/ebay.cfg/php/enduser/std_adp.php?p_faqid=222
GetSellerEvents
Conditionally
Describes the latest (most recent) date to use in a time range filter
based on item start time. If you specify the corresponding <b>From</b> filter,
but you do not include <b>StartTimeTo</b>, the <b>StartTimeTo</b> is set to
the time you make the call.
GetSellerEvents
No
Describes the earliest (oldest) date to use in a time range filter based
on item end time. Must be specified if <b>EndTimeTo</b> is specified.
<br/><br/>
Either
the <b>StartTimeFrom</b>, <b>EndTimeFrom</b>, or <b>ModTimeFrom</b> filter must be specified.
If you do not specify the corresponding To filter,
it is set to the time you make the call.<br>
<br>
For better results, the time range you use should be less than 48 hours.
If 3000 or more items are found, use a smaller time range.<br>
<br>
Include a 2-minute, overlapping buffer between requests.
For example, if <b>EndTimeTo</b> was 6:58 in a prior request,
the current request should use 6:56 in <b>EndTimeFrom</b>
(e.g., use ranges like 5:56-6:58, 6:56-7:58, 7:56-8:58).
KB article: Best Practices for GetSellerEvents and GetSellerTransactions
http://ebay.custhelp.com/cgi-bin/ebay.cfg/php/enduser/std_adp.php?p_faqid=222
GetSellerEvents
Conditionally
Describes the latest (most recent) date to use in a time range filter
based on item end time.
<br/><br/>
If you specify the corresponding <b>From</b> filter,
but you do not include <b>EndTimeTo</b>, then <b>EndTimeTo</b> is set
to the time you make the call.
GetSellerEvents
No
Describes the earliest (oldest) date to use in a time range filter based
on item modification time. Must be specified if <b>ModTimeTo</b> is specified. Either
the <b>StartTimeFrom</b>, <b>EndTimeFrom</b>, or <b>ModTimeFrom</b> filter must be specified.
If you do not specify the corresponding To filter,
it is set to the time you make the call.<br>
<br>
Include a 2-minute, overlapping buffer between requests.
For example, if <b>ModTimeTo</b> was 6:58 in a prior request,
the current request should use 6:56 in <b>ModTimeFrom</b>
(e.g., use ranges like 5:56-6:58, 6:56-7:58, 7:56-8:58).
<br><br>
For better results, the time range you use should be less than 48 hours.
If 3000 or more items are found, use a smaller time range.
<br><br>
If an unexpected item is returned (including an old item
or an unchanged active item), please ignore the item.
Although a maintenance process may have triggered a change in the modification time, item characteristics are unchanged.
KB article: Best Practices for GetSellerEvents and GetSellerTransactions
http://ebay.custhelp.com/cgi-bin/ebay.cfg/php/enduser/std_adp.php?p_faqid=222
GetSellerEvents
Conditionally
Describes the latest (most recent) date and time to use in a time range filter based on the time an item's record was modified. If you specify the corresponding <b>From</b> filter, but you do not include <b>ModTimeTo</b> , then <b>ModTimeTo</b> is set to the time you make the call. Include a 2-minute buffer between the current time and the <b>ModTimeTo</b> filter.
GetSellerEvents
No
If true, response includes only items that have been modified
within the <b>ModTime</b> range. If false, response includes all items.
GetSellerEvents
No
The seller can include this field and set its value to <code>true</code> if that seller wants to see how many prospective bidders/buyers currently have an item added to their Watch Lists. The Watch count is returned in the <b>WatchCount</b> field for each item in the response.
GetSellerEvents
No
Specifies whether to force the response to include
variation specifics for multiple-variation listings. <br>
<br>
If false (or not specified), eBay keeps the response as small as
possible by not returning <b>Variation.VariationSpecifics</b>.
It only returns <b>Variation.SKU</b> as an identifier
(along with the variation price and other selling details).
If the variation has no SKU, then <b>Variation.VariationSpecifics</b>
is returned as the variation's unique identifier.<br>
<br>
If true, <b>Variation.VariationSpecifics</b> is returned.
(<b>Variation.SKU</b> is also returned, if the variation has a SKU.)
This may be useful for applications that don't track variations
by SKU.<br>
<br>
Ignored when <b>HideVariations</b> is set to <b>true</b>.
<br>
<br>
<b>Note:</b> If the seller includes a large number of
variations in many listings, using this flag may degrade the
call's performance. Therefore, when you use this flag, you may
need to reduce the total number of items you're requesting at
once. For example, you may need to use shorter time ranges in
the <b>StartTimeFrom</b>, <b>EndTimeFrom</b>, or <b>ModTimeFrom</b> filters.
false
GetSellerEvents
No
Specifies whether to force the response to hide
variation details for multiple-variation listings.<br>
<br>
If false (or not specified), eBay returns variation details (if
any). In this case, the amount of detail can be controlled by
using <b>IncludeVariationSpecifics</b>.<br>
<br>
If true, variation details are not returned (and
<b>IncludeVariationSpecifics</b> has no effect). This may be useful for applications that use other calls, notifications, alerts, or reports to track price and quantity details.
false
GetSellerEvents
No
Returns the items in an <b>ItemArrayType</b> object for the a seller events that have occurred and that meet any filters specified. There can be zero, one, or multiple <b>ItemType</b> objects. Each <b>ItemType</b> object contains the detail data for one item listing.
Indicates the latest (most recent) date for any date-based filtering specified as
input. Specifically, this field contains the value you specified in the <b>StartTimeFrom</b>, <b>EndTimeFrom</b>, or <b>ModTimeFrom</b> filter, if you used a time filter in the request. If no time filter was specified, <b>TimeTo</b> returns the current time.
GetSellerEvents
DetailLevel: none, ReturnAll
Always
Collection of items whose last modified time matches
the filters specified in the request.
Returns empty if no items were modified within the
time range of the request.<br/><br/>
If 1 to 2999 items are returned, then the results are
complete. If 3000 or more items are returned, it usually means
additional items exist within the time range you requested,
but they were not all returned.
<br/><br/>
To retrieve complete results,
use a smaller time range in the request so that fewer than
3000 are returned per response.
KB article: Best Practices for GetSellerEvents and GetSellerTransactions
https://ebaydts.com/eBayKBDetails?KBid=222
GetSellerEvents
DetailLevel: none, ReturnAll
Always
This call is used to retrieve an array of listings for the seller. The seller must be associated with the user/application token being used to make the call.
<br/><br/>
This call requires that either the 'Start Time' or 'End Time' date range filters be used. The date range specified by either of these filters can not exceed 120 days or an error will occur.
<br/><br/>
This call also requires that pagination be used.
DetailLevel, GranularityLevel
GetItem
Browsing a Seller's Items
http://developer.ebay.com/DevZone/guides/features-guide/default.html#development/Items-Retrieving.html
<span class="tablenote"><strong>Note:</strong>
This field should no longer be used, and will be ignored if it is included in a <b>GetSellerList</b> request. There are plans to remove this field from the public WSDL. The only eBay user ID that can be used is the one associated with the authentication token.
</span>
1099
1099
NoOp
Specifies the list of Motors Dealer sellers for which a special set of
metrics can be requested. Applies to eBay Motors Pro applications only.
GetSellerList
No
Specifies the earliest (oldest) date to use in a date range filter based on
item end time. Specify either an end-time range or a start-time range
filter in every call request. Each of the time ranges must be a value less than
120 days.
GetSellerList
Conditionally
Specifies the latest (most recent) date to use in a date range filter based on item end time. Must be specified if <b>EndTimeFrom</b> is specified.
GetSellerList
Conditionally
This field can be used to control the order in which returned listings are sorted (based on the listings' actual/scheduled end dates). Valid values are as follows:
<ul>
<li><code>1</code> (descending order)</li>
<li>code>2</code> (ascending order)</li>
</ul>
2 (Ascending)
GetSellerList
No
Specifies the earliest (oldest) date to use in a date range filter based on
item start time. Each of the time ranges must be a value less than
120 days. In all calls, at least one date-range filter must be specified
(i.e., you must specify either the end time range or start time range
in every request).
GetSellerList
Conditionally
Specifies the latest (most recent) date to use in a date range filter based on item start time. Must be specified if <b>StartTimeFrom</b> is specified.
GetSellerList
Conditionally
This container controls the maximum number of listings that can appear on one page of the result set, as well as the page number of the result to return.
<br><br>
The <b>GetSellerList</b> call requires that the <b>EntriesPerPage</b> value be set. The <b>PageNumber</b> field is not required but will default to <code>1</code> if not included.
GetSellerList
Yes
This field allows the user to control the amount of data that is returned in the response. See the <a href="#GranularityLevel">Granularity Level</a> table on this page for a list of the fields that are returned for each granularity level. Either <b>GranularityLevel</b> or <b>DetailLevel</b> can be used in a <b>GetSellerList</b> call, but not both. If both are specified, <b>DetailLevel</b> is ignored. If neither are used, the response fields will be the ones shown for 'Coarse' granularity.
Yes
Coarse
GetSellerList
No
This container can be used to specify one or multiple SKUs, and only listings associated with these SKUs are retrieved. Note that all other request criteria are also considered when one or more SKU values are specified.
<br>
<br>
<span class="tablenote"><b>Note:</b>
Listings with matching SKUs are returned regardless of their
<b>Item.InventoryTrackingMethod</b> setting.
</span>
GetSellerList
No
This field may be included and set to <code>true</code> if the seller wishes to see the number of eBay users that are watching each listing.
false
GetSellerList
No
This boolean field can be included and set to <code>true</code> if the seller would like to retrieve any listings that were administratively ended by eBay due to a listing policy violation.
false
GetSellerList
No
If you specify a <b>CategoryID</b> value, the response will only contain listings in the category you specify.
GetSellerList
No
If this field is included and set to <code>true</code>, the <b>Variations</b> node is returned for all multi-variation listings in the response.
<br>
<br>
<span class="tablenote"><b>Note: </b> If the seller has many multiple-variation listings, that seller may not want to include variations in the <b>GetSellerList</b> response. Or, a seller can include variations data, but possibly limit the response by specifying shorter date ranges with the date range filters, or by reducing the number of listings returned per results (decreasing the <b>Pagination.EntriesPerPage</b> value).
</span>
GetSellerList
No
This is the base response type of the <b>GetSellerList</b> call. The <b>GetSellerList</b> response includes an array of one or more listings that matched the input criteria, as well as pagination data.
This container shows the total number or pages in the result set, as well as the total number of listings that match the current input criteria.
GetSellerList
DetailLevel: none, ItemReturnDescription, ReturnAll
Always
This field's value is returned as <code>true</code> if there are more pages in the current result set to view, or <code>false</code> if the current page being viewed is the last (or only) page of the result set.
<br/><br/>
If there are more listings to view in the result set, additional <b>GetSellerList</b> calls can be made but with changes to the <b>Pagination</b> values in the request. For example, if the <b>Pagination.PageNumber</b> value in the request for the last call was <code>1</code>, you can make another <b>GetSellerList</b> call, keeping everything the same except changing the value of the <b>Pagination.PageNumber</b> field from <code>1</code> to <code>2</code>.
GetSellerList
DetailLevel: none, ItemReturnDescription, ReturnAll
Always
This container is an array of one or more listings that match the input criteria. If none of the seller's listings match the input criteria, this container is returned as an empty tag.
GetSellerList
DetailLevel: none, ItemReturnDescription, ReturnAll
Always
This value reflects the value that was set in the <b>Pagination.EntriesPerPage</b> field in the request. This is the maximum number of listings that may be returned per page of the result set. Note that this value is only the maximum threshold and does not necessarily reflect the number of listings appearing on the current page of data.
GetSellerList
DetailLevel: none, ItemReturnDescription, ReturnAll
Always
This value indicates the current page of data in the result set that is being displayed. This value reflects the value specified in the <b>Pagination.PageNumber</b> field in the request. Note that page number defaults to <code>1</code> if the <b>Pagination.PageNumber</b> field was not included in the request.
GetSellerList
DetailLevel: none, ItemReturnDescription, ReturnAll
Always
This value indicates the total number of listings being shown on the current page of the results set.
GetSellerList
DetailLevel: none, ItemReturnDescription, ReturnAll
Always
This container consists of detailed information about the seller and the seller's account. This container is only returned if the <b>GranularityLevel</b> field is included in the request and set to <code>Fine</code>.
GetSellerList
GranularityLevel: Fine
Conditionally
Retrieves a seller's order line item information. To retrieve order line items for another seller, the <b>GetItemTransactions</b>) call should be used. This call cannot retrieve sales older than 90 days old.
<br><br>
If one or more <b>SKU</b> values or the date range filters (<b>ModTimeFrom</b>/<b>ModTimeTo</b> or <b>NumberOfDays</b>) are not used, the <b>GetItemTransactions</b>) call will retrieve order line items created (or modified) within the last 30 days.
Retrieves order line item information for the seller for which the call is made, and not for any other user. To retrieve order line items for another seller's listings, use <b>GetItemTransactions</b>.
DetailLevel
GetOrders
Retrieving Order Line Item Data and Managing Orders
http://developer.ebay.com/DevZone/guides/features-guide/default.html#development/Sales-Completing.html
The <b>ModTimeFrom</b> and <b>ModTimeTo</b> fields are used to specify a date range for retrieving order line items associated with the seller. The <b>ModTimeFrom</b> field is the starting date range. All of the seller's order line items that were created (or last modified) within this date range are returned in the output. The maximum date range that may be specified is 30 days. This value cannot be set back more than 90 days in the past, as this call cannot retrieve sales older than 90 days. This field is not applicable if the <b>NumberOfDays</b> date filter is used.
<br><br>
If you don't specify a <b>ModTimeFrom</b>/<b>ModTimeTo</b> filter, the <b>NumberOfDays</b> time filter is used and it defaults to 30 (days).
GetSellerTransactions
No
The <b>ModTimeFrom</b> and <b>ModTimeTo</b> fields are used to specify a date range for retrieving order line items associated with the seller. The <b>ModTimeTo</b> field is the ending date range. All of the seller's order line items that were created (or last modified) within this date range are returned in the output. The maximum date range that may be specified is 30 days.
<br/><br/>
If the <b>ModTimeFrom</b> field is
used and the <b>ModTimeTo</b> field is omitted, the <b>ModTimeTo</b> value defaults to
the present time or to 30 days past the <b>ModTimeFrom</b> value (if
<b>ModTimeFrom</b> value is more than 30 days in the past). This field is not
applicable if the <b>NumberOfDays</b> date filter is used.
<br><br>
If you don't specify a <b>ModTimeFrom</b>/<b>ModTimeTo</b> filter, the <b>NumberOfDays</b>
time filter is used and it defaults to 30 (days).
GetSellerTransactions
No
If many order line items are available to retrieve, you may need to call <b>GetSellerTransactions</b> multiple times to retrieve all the data. Each result set is returned as a page of order line items. Use the <b>Pagination</b> filters to control the maximum number of order line items to retrieve per page (i.e., per call), and the page number to retrieve.
GetSellerTransactions
No
This field is included and set to <code>true</code> if the user wants to view the Final Value Fee (FVF) for all order line items in the response. The Final Value Fee is returned in the <b>Transaction.FinalValueFee</b> field. The Final Value Fee is assessed right after the creation of an order line item.
<br/>
false
GetSellerTransactions
No
This field is included and set to <code>true</code> if the user wants to view order-level details, including the unique identifier of the order and the status of the order. The order-level details will be shown in the <b>ContainingOrder</b> container in the response.
<br/>
false
GetSellerTransactions
No
This container is used to search for order line items generated from one or more product SKU values. The response will only include order line items for the seller's product(s) that are represented by the specified SKU value(s).
<br> <br>
If a user wants to retrieve order line items based on SKUs, the
<b>InventoryTrackingMethod</b> must be set to <code>SKU</code>. The <b>InventoryTrackingMethod</b> value can be set when the seller lists the item through an <b>AddFixedPriceItem</b> call, or it can be set by including the <b>InventoryTrackingMethod</b> field in a <b>GetSellerTransactions</b> call and setting its value to <code>SKU</code>.
<br> <br>
<span class="tablenote"><b>Note: </b> SKU values must be defined for products in listings for this container to be applicable.
</span>
GetSellerTransactions
No
<span class="tablenote"><b>Note: </b> This field should no longer be used since its sole purpose was to allow the seller to filter between eBay orders and Half.com orders, and the Half.com site no longer exists.
</span>
1027
NoOp
1033
This field is used to specify how many days (24-hour periods) back in the past you wish to retrieve order line items. All order line items created (or last modified) within this period are retrieved. This value can be set between 1 (day) and 30 (days), and defaults to 30 (days) if omitted from the call.
<br/><br/>
If the <b>NumberOfDays</b> filter is used, <b>ModTimeFrom</b> and <b>ModTimeTo</b> date range filters are ignored (if included in the same request).
<br/>
1
30
30
GetSellerTransactions
No
This filter is used if the seller wishes to set/change the inventory tracking method. When creating a listing with the <b>AddFixedPriceItem</b> call (or relisting with <b>RelistFixedPriceItem</b> call), sellers can decide whether to track their inventory by Item ID (generated by eBay at listing time) or by seller-defined SKU value.
<br><br>
This field is needed (and its value must be set to <code>SKU</code>) if the seller wishes to retrieve order line items based on specified SKU values (specified through <b>SKUArray</b> container) and the current inventory tracking method is set to Item ID.
<br><br>
A seller can use a <b>GetItem</b> call for a listing (and look for the <b>Item.InventoryTrackingMethod</b> in the response) to see which inventory tracking method is used for the listing/product.
GetSellerTransactions
Conditionally
If this field is included in the call request and set to <code>true</code>, taxpayer identification information for the buyer is returned under the <b>BuyerTaxIdentifier</b> container.
<br><br>
Codice Fiscale is only applicable to buyers on the Italy and Spain sites. It is required that buyers on the Italy site provide their Codice Fiscale ID before buying an item, and sellers on the Spain site have the option of requiring buyers on the Spain site to provide their taxpayer ID.
false
GetSellerTransactions
No
Returns an array of order line item (transaction) data for the seller specified in the request. The results can be used to create a report of data that is commonly necessary for order processing. <br/><br/> Zero, one, or many <b>Transaction</b> objects can be returned in the <b>TransactionArray</b>. The set of order line items returned is limited to those that were modified between the times specified in the request's <b>ModTimeFrom</b> and <b>ModTimeTo</b> filters. The order line items returned are sorted by <b>Transaction.Status.LastTimeModified</b>, ascending order (that is, order line items that more recently were modified are returned last). This call also returns information about the seller whose order line items were requested. <br/><br/> If pagination filters were specified in the request, returns meta-data describing the effects of those filters on the current response and the estimated effects if the same filters are used in subsequent calls.
Container consisting of the total number of order line items that match the input criteria and the total number of pages that must be scrolled through to view all order line items. To scroll through each page of order line item data, make subsequent <b>GetSellerTransactions</b> calls, incrementing the <b>Pagination.PageNumber</b> field by a value of '1' each time.
GetSellerTransactions
DetailLevel: none, ReturnAll, ItemReturnDescription
Always
This flag indicates whether there are additional pages of order line items to view. This field will be returned as <code>true</code> if there are additional pages or order line items to <code>view</code>, or <code>false</code> if the current page of order line item data is the last page of data.
GetSellerTransactions
DetailLevel: none, ReturnAll, ItemReturnDescription
Always
This value indicates the number of order line items returned per page (per call) and is controlled by the <b>Pagination.EntriesPerPage</b> value passed in the call request. Unless it is the last (or possibly only) page of data (<b>HasMoreTransactions=false</b>), the <b>TransactionsPerPage</b> value should equal the <b>Pagination.EntriesPerPage</b> value passed in the call request. <br> <br> <span class="tablenote"><b>Note:</b> Due to the fact that item data on the eBay platform has a shorter retention period than order data, it is possible that some retrieved pages will contain no data. For pages that contain no data, the <b>ReturnedTransactionCountActual</b> value will be '0'. It is also possible that pages 2, 3, and 4 have no data, but pages 1 and 5 do have data. Therefore, we recommend that you scroll through each page of data (making subsequent <b>GetSellerTransactions</b> calls and incrementing the <b>Pagination.PageNumber</b> value by '1' each time) until you reach the last page, indicated by <b>HasMoreTransactions=false</b>. </span>
GetSellerTransactions
DetailLevel: none, ReturnAll, ItemReturnDescription
Always
This value indicates the page number of retrieved order line items that match the input criteria. This value is controlled by the <b>Pagination.PageNumber</b> value passed in the call request. To scroll through all pages of order line items that match the input criteria, you increment the <b>Pagination.PageNumber</b> value by <code>1</code> with each subsequent <b>GetSellerTransactions</b> call.
GetSellerTransactions
DetailLevel: none, ReturnAll, ItemReturnDescription
Always
This value indicates the total number of (non-empty) order line items retrieved in the current page of results. The <b>ReturnedTransactionCountActual</b> value will be lower than the <b>TransactionsPerPage</b> value if one or more empty order line items are retrieved on the page. <br> <br> <span class="tablenote"><b>Note:</b> Due to the fact that item data on the eBay platform has a shorter retention period than order data, it is possible that some retrieved pages will contain no data. For pages that contain no order line item data, the <b>ReturnedTransactionCountActual</b> value will be '0'. It is also possible that pages 2, 3, and 4 have no data, but pages 1 and 5 do have data. Therefore, we recommend that you scroll through each page of data (making subsequent <b>GetSellerTransactions</b> calls and incrementing the <b>Pagination.PageNumber</b> value by '1' each time) until you reach the last page, indicated by <b>HasMoreTransactions=false</b>. </span>
GetSellerTransactions
DetailLevel: none, ReturnAll, ItemReturnDescription
Always
Contains information about the seller whose order line items are being returned.
See the reference guide for information about the <b>Seller</b> object fields
that are returned.
GetSellerTransactions
DetailLevel: none, ReturnAll
Always
List of <b>Transaction</b> objects representing the seller's recent sales.
Each <b>Transaction</b> object contains the data for one purchase
(of one or more items in the same listing).
See the reference guide for more information about the fields that are returned
for each order line item.
GetSellerTransactions
DetailLevel: none, ReturnAll
Conditionally
Indicates whether the seller has the preference enabled that shows that the seller
prefers PayPal as the method of payment for an item. This preference is indicated on
an item's View Item page and is intended to influence a buyer to use PayPal
to pay for the item.
GetSellerTransactions
DetailLevel: none, ReturnAll, ItemReturnDescription
Always
Retrieves Selling Manager alerts.
This call is subject to change without notice; the deprecation process is
inapplicable to this call.
Using Selling Manager Calls in the Trading API
https://developer.ebay.com/DevZone/guides/features-guide/default.html#development/Listings-SellingManager.html
Selling Manager Pro page on the eBay Site
https://pages.ebay.com/help/sell/sm-getting-started.html
Type defining the call-specific response fields for the <b>GetSellingManagerAlerts</b>
call.
Container consisting of details related to a Selling Manager alert. Alert types include listing automation, inventory, item sold, and a general alert.
GetSellingManagerAlerts
Conditionally
Retrieves a log of emails sent, or scheduled to be sent, to buyers.
<br><br>
The standard Trading API
deprecation process is not applicable to this call.
Retrieves a log of emails sent, or scheduled to be sent, to buyers. Includes
success or failure status.
Using Selling Manager Calls in the Trading API
https://developer.ebay.com/DevZone/guides/features-guide/default.html#development/Listings-SellingManager.html
Selling Manager Pro page on the eBay Site
https://pages.ebay.com/help/sell/sm-getting-started.html
Unique identifier for the eBay listing associated with the Selling
Manager email log. Unless the <b>OrderID</b> or <b>OrderLineItemID</b> value is
specified in the request, the <b>ItemID</b> and <b>TransactionID</b> fields must be
used to identify the Selling Manager email log to retrieve. You can
use <b>GetSellingManagerSoldListings</b> to retrieve the <b>ItemID</b>, <b>TransactionID</b>
or <b>OrderLineItemID</b> values that correspond to the Selling Manager sale
record (<b>SaleRecordID</b>). All four of these fields are returned under the
<b>SellingManagerSoldTransaction</b> container of the
<b>GetSellingManagerSoldListings</b> request.
GetSellingManagerEmailLog
Conditionally
Unique identifier for the sales transaction associated with
the Selling Manager email log. Unless the <b>OrderID</b> or <b>OrderLineItemID</b>
value is specified in the request, the <b>ItemID</b> and <b>TransactionID</b> fields
must be used to identify the Selling Manager email log to retrieve.
You can use <b>GetSellingManagerSoldListings</b> to retrieve the <b>ItemID</b>,
<b>TransactionID</b> or <b>OrderLineItemID</b> values that correspond to the Selling
Manager sale record (<b>SaleRecordID</b>). All four of these fields are
returned under the <b>SellingManagerSoldTransaction</b> container of the
<b>GetSellingManagerSoldListings</b> request.
GetSellingManagerEmailLog
No
A unique identifier that identifies a single line item or multiple line item order associated with the Selling Manager email log.
<br><br>
If an <b>OrderID</b> is used in the request, the <b>OrderLineItemID</b> and
<b>ItemID</b>/<b>TransactionID</b> pair are not required.
<br><br>
<span class="tablenote"><b>Note: </b> As of June 2019, eBay has changed the format of order identifier values. The new format is a non-parsable string, globally unique across all eBay marketplaces, and consistent for both single line item and multiple line item orders. Unlike in the past, instead of just being known and exposed to the seller, these unique order identifiers will also be known and used/referenced by the buyer and eBay customer support.
<br><br>
For developers and sellers who are already integrated with the Trading API's order management calls, this change shouldn't impact your integration unless you parse the existing order identifiers (e.g., <b>OrderID</b> or <b>OrderLineItemID</b>), or otherwise infer meaning from the format (e.g., differentiating between a single line item order versus a multiple line item order). Because we realize that some integrations may have logic that is dependent upon the old identifier format, eBay is rolling out this Trading API change with version control to support a transition period of approximately 9 months before applications must switch to the new format completely.
<br><br>
During the transition period, for developers/sellers using a Trading WSDL older than Version 1113, they can use the <b>X-EBAY-API-COMPATIBILITY-LEVEL</b> HTTP header in API calls to control whether the new or old <b>OrderID</b> format is returned in call response payloads. To get the new <b>OrderID</b> format, the value of the <b>X-EBAY-API-COMPATIBILITY-LEVEL</b> HTTP header must be set to <code>1113</code>. During the transition period and even after, the new and old <b>OrderID</b> formats will still be supported/accepted in all Trading API call request payloads. After the transition period (which will be announced), only the new <b>OrderID</b> format will be returned in all Trading API call response payloads, regardless of the Trading WSDL version used or specified compatibility level.
</span>
<br>
<span class="tablenote"><b>Note: </b> For sellers integrated with the new order ID format, please note that the identifier for an order will change as it goes from unpaid to paid status. Sellers can check to see if an order has been paid by looking for a value of 'Complete' in the <b>CheckoutStatus.Status</b> field in the response of <b>GetOrders</b> or <b>GetOrderTransactions</b> call, or in the <b>Status.CompleteStatus</b> field in the response of <b>GetItemTransactions</b> or <b>GetSellerTransactions</b> call. When using a <b>GetSellingManagerEmailLog</b> call, either of these order IDs (paid or unpaid status) can be used to identify the order. Similarly, either of these order IDs (paid or unpaid status) can be used in <b>GetOrders</b> or <b>GetOrderTransactions</b> call to retrieve specific order(s).
</span>
40
GetSellingManagerEmailLog
No
Specifies the earliest (oldest) and latest (most recent) dates to use in a
date range filter based on email sent date. Each of the time ranges can be
up to 90 days.
GetSellingManagerEmailLog
No
A unique identifier for an eBay order line item that is associated with
the Selling Manager email log. This field is created as soon as there
is a commitment to buy (bidder wins the auction, buyer clicks buy button, or buyer purchases item through <b>PlaceOffer</b> call).
<br><br>
You can use <b>GetSellingManagerSoldListings</b> to retrieve the <b>ItemID</b>, <b>TransactionID</b> or <b>OrderLineItemID</b> values that correspond to the Selling Manager sale record (<b>SaleRecordID</b>). All four of these fields are returned under the <b>SellingManagerSoldTransaction</b> container of the <b>GetSellingManagerSoldListings</b> request. Unless an <b>OrderID</b> or an <b>ItemID</b>/<b>TransactionID</b> pair is specified in the <b>GetSellingManagerSaleRecord</b> request, the <b>OrderLineItemID</b> field is required.
<br>
GetSellingManagerEmailLog
Conditionally
Returns the log of emails not sent.
Email logs associated with this order.
GetSellingManagerEmailLog
Always
Retrieves a paginated list containing details of a user's Selling Manager Inventory. This call is subject to change without notice; the deprecation process is inapplicable to this call. The user must have a Selling Manager Pro subscription to use this call.
Retrieves a paginated listing of a user's Selling Manager Inventory.
GetSellingManagerInventoryFolder, GetSellingManagerTemplates
Using Selling Manager Calls in the Trading API
https://developer.ebay.com/DevZone/guides/features-guide/default.html#development/Listings-SellingManager.html
Selling Manager Pro page on the eBay Site
https://pages.ebay.com/help/sell/sm-getting-started.html
This field is used if the seller would like to sort Selling Manager Inventory results based on a specific aspect such as Product Name, Average Price, etc. See <b>SellingManagerProductSortCodeType</b> to read more about the available sorting options.
GetSellingManagerInventory
No
This field is included if the seller wants to view Selling Manager Inventory from a specific folder.
GetSellingManagerInventory
No
This container is used if the seller would like to control how many products are returned per page and which page to view.
GetSellingManagerInventory
No
This field allows the seller to sort in ascending or descending order (based on the selected aspect in the <b>Sort</b> field).
GetSellingManagerInventory
No
This container is used if the seller would like to search for Selling Manager Inventory based on certain identifiers like Item ID, listing title, buyer user ID, etc. The seller will specify one of the supported search types in <b>SellingManagerSearchTypeCodeType</b>, and then provides the value for that search type.
GetSellingManagerInventory
No
This field is used if the seller would like to retrieve all Selling Manager Inventory listed in a specific eBay Store Category.
GetSellingManagerInventory
No
One or more <b>Filter</b> fields can be used to retrieve Selling Manager Inventory that is in a certain state, such as active listings, inactive listings, or listings that are low in stock.
GetSellingManagerInventory
No
Contains a list of the products created by the seller. The list of products is returned as a set of tags, in which are returned zero, one, or multiple SellingManagerProductType objects. Each SellingManagerProductType object contains the information about for one Selling Manager product and any Selling Manager templates the product contains.
Returns the date the inventory counts were last calculated.
GetSellingManagerInventory
Conditionally
Container for information about the requested products and templates.
GetSellingManagerInventory
Conditionally
Contains the total number of pages (TotalNumberOfPages) and the total
number of products entries (TotalNumberOfEntries) that can be returned
on repeated calls with the same format and report criteria.
GetSellingManagerInventory
Conditionally
Retrieves Selling Manager Inventory folders.
This call is subject to change without notice; the deprecation process is
inapplicable to this call. The user must have a Selling Manager Pro subscription to use this call.
GetSellingManagerInventory
Using Selling Manager Calls in the Trading API
https://developer.ebay.com/DevZone/guides/features-guide/default.html#development/Listings-SellingManager.html
Selling Manager Pro page on the eBay Site
https://pages.ebay.com/help/sell/sm-getting-started.html
A unique identifier for a Selling Manager Inventory folder. The <b>FolderID</b> is used if the seller wants to retrieve a specific folder.
GetSellingManagerInventoryFolder
No
This field is used to specify the number of levels of subfolders to be returned in the response. If 0, the parent folder is returned. If 1, the parent and child folders are returned. If 2, the parent and two levels of child folders are returned. Ignored if the <b>FullRecursion</b> field is included and set to <code>True</code>.
<br/>
1
GetSellingManagerInventoryFolder
No
Displays the entire tree of a user's Selling Manager Inventory folders. If this is provided, the <b>FolderID</b> and <b>MaxDepth</b> fields are no longer applicable.
GetSellingManagerInventoryFolder
No
Returns the folder structure of the specified Selling Manager Inventory folder.
This container consists of detailed information on the Selling Manager Inventory folder that matches the input criteria, as well as detailed information about any child folders if <b>FullRecursion</b> was set to <code>true</code> or if the <b>MaxDepth</b> field is set to an integer value greater than <code>0</code>.
GetSellingManagerInventoryFolder
Always
Retrieves the set of Selling Manager automation rules associated with an item. This call is subject to change without notice; the deprecation process is inapplicable to this call. The user must have a Selling Manager Pro subscription to use this call.
SetSellingManagerItemAutomationRule
Using Selling Manager Calls in the Trading API
https://developer.ebay.com/DevZone/guides/features-guide/default.html#development/Listings-SellingManager.html
Selling Manager Pro page on the eBay Site
https://pages.ebay.com/help/sell/sm-getting-started.html
SetSellingManagerItemAutomationRule
The unique identifier of the listing whose Selling Manager automation rules you want to retrieve.
GetSellingManagerItemAutomationRule
Yes
Contains the set of automation rules associated with the specified listing.
The information for the automated listing rule associated with the item.
This field is only returned if the item was listed from a template.
The value in this field refers to that template's automated listing rule.
GetSellingManagerItemAutomationRule
Conditionally
The information for the automated relisting rule associated with the item.
GetSellingManagerItemAutomationRule
Conditionally
The information for the automated Second Chance Offer rule associated with the item.
GetSellingManagerItemAutomationRule
Conditionally
Contains fees that may be incurred when items are listed using the
automation rule (e.g., a scheduled listing fee). Use of an automation rule
does not in itself have a fee, but use can result in a fee.
GetSellingManagerItemAutomationRule
Conditionally
Retrieves the data for one or more Selling Manager sale records.
<br><br>
The standard Trading API deprecation process is not applicable to this call. The user must have a Selling Manager Pro subscription to use this call.
GetSellingManagerSoldListings
Using Selling Manager Calls in the Trading API
https://developer.ebay.com/DevZone/guides/features-guide/default.html#development/Listings-SellingManager.html
Selling Manager Pro page on the eBay Site
https://pages.ebay.com/help/sell/sm-getting-started.html
Unique identifier for the eBay listing associated with the Selling
Manager sale record. Unless the <b>OrderID</b> or <b>OrderLineItemID</b> value is
specified in the request, the <b>ItemID</b> and <b>TransactionID</b> fields must be
used to identify the Selling Manager sale record to retrieve. You can
use <b>GetSellingManagerSoldListings</b> to retrieve the <b>ItemID</b>, <b>TransactionID</b>
or <b>OrderLineItemID</b> values that correspond to the Selling Manager sale
record (<b>SaleRecordID</b>). All four of these fields are returned under the
<b>SellingManagerSoldTransaction</b> container of the
<b>GetSellingManagerSoldListings</b> request.
GetSellingManagerSaleRecord
Conditionally
Unique identifier for the sales transaction associated with the Selling
Manager sale record. Unless the <b>OrderID</b> or
<b>OrderLineItemID</b> value is specified in the request, the
<b>ItemID</b> and <b>TransactionID</b> fields must
be used to identify the Selling Manager sale record to retrieve. You can
use <b>GetSellingManagerSoldListings</b> to retrieve the
<b>ItemID</b>, <b>TransactionID</b> or
<b>OrderLineItemID</b> values that correspond to the Selling
Manager sale record (<b>SaleRecordID</b>). All four of these
fields are returned under the
<b>SellingManagerSoldTransaction</b> container of the
<b>GetSellingManagerSoldListings</b> request.
GetSellingManagerSaleRecord
Conditionally
A unique identifier that identifies a single line item or multiple line item order associated with the Selling Manager sale record(s).
<br><br>
If an <b>OrderID</b> is used in the request, the <b>OrderLineItemID</b> and
<b>ItemID</b>/<b>TransactionID</b> pair are not required.
<br><br>
<span class="tablenote"><b>Note: </b> As of June 2019, eBay has changed the format of order identifier values. The new format is a non-parsable string, globally unique across all eBay marketplaces, and consistent for both single line item and multiple line item orders. Unlike in the past, instead of just being known and exposed to the seller, these unique order identifiers will also be known and used/referenced by the buyer and eBay customer support.
<br><br>
For developers and sellers who are already integrated with the Trading API's order management calls, this change shouldn't impact your integration unless you parse the existing order identifiers (e.g., <b>OrderID</b> or <b>OrderLineItemID</b>), or otherwise infer meaning from the format (e.g., differentiating between a single line item order versus a multiple line item order). Because we realize that some integrations may have logic that is dependent upon the old identifier format, eBay is rolling out this Trading API change with version control to support a transition period of approximately 9 months before applications must switch to the new format completely.
<br><br>
During the transition period, for developers/sellers using a Trading WSDL older than Version 1113, they can use the <b>X-EBAY-API-COMPATIBILITY-LEVEL</b> HTTP header in API calls to control whether the new or old <b>OrderID</b> format is returned in call response payloads. To get the new <b>OrderID</b> format, the value of the <b>X-EBAY-API-COMPATIBILITY-LEVEL</b> HTTP header must be set to <code>1113</code>. During the transition period and even after, the new and old <b>OrderID</b> formats will still be supported/accepted in all Trading API call request payloads. After the transition period (which will be announced), only the new <b>OrderID</b> format will be returned in all Trading API call response payloads, regardless of the Trading WSDL version used or specified compatibility level.
</span>
<br>
<span class="tablenote"><b>Note: </b> For sellers integrated with the new order ID format, please note that the identifier for an order will change as it goes from unpaid to paid status. Sellers can check to see if an order has been paid by looking for a value of 'CheckoutComplete' in the <b>OrderStatus.CheckoutStatus</b> field in the response of <b>GetSellingManagerSaleRecord</b> or call. Sellers should not fulfill orders until buyer has made payment. When using a <b>GetSellingManagerSaleRecord</b> call to retrieve a sale record associated with a specific order, either of these order IDs (paid or unpaid status) can be used to identify the order.
</span>
40
GetSellingManagerSaleRecord
Conditionally
A unique identifier for an eBay order line item that is associated with
the Selling Manager sale record. This field is created as soon as there
is a commitment to buy (bidder wins the auction, buyer clicks buy button, or buyer purchases item through <b>PlaceOffer</b> call).
<br><br>
You can use <b>GetSellingManagerSoldListings</b> to retrieve the <b>ItemID</b>, <b>TransactionID</b> or <b>OrderLineItemID</b> values that correspond to the Selling Manager sale record (<b>SaleRecordID</b>). All four of these fields are returned under the <b>SellingManagerSoldTransaction</b> container of the <b>GetSellingManagerSoldListings</b> request. Unless an <b>OrderID</b> or an <b>ItemID</b>/<b>TransactionID</b> pair is specified in the <b>GetSellingManagerSaleRecord</b> request, the <b>OrderLineItemID</b> field is required.
<br>
GetSellingManagerSaleRecord
Conditionally
The base response to a <b>GetSellingManagerSaleRecord</b> call.
Contains the data in a Selling Manager Sale Record.
GetSellingManagerSaleRecord
Always
Returns a Selling Manager user's sold listings.
<br><br>
This call is subject to change without notice; the deprecation process is inapplicable to this call. The user must have a Selling Manager Pro subscription to use this call.
Retrieves information about items that a seller has sold.
GetSellingManagerSaleRecord
Using Selling Manager Calls in the Trading API
https://developer.ebay.com/DevZone/guides/features-guide/default.html#development/Listings-SellingManager.html
Selling Manager Pro page on the eBay Site
https://pages.ebay.com/help/sell/sm-getting-started.html
This container is used if the seller would like to search for Selling Manager Sele Records based on certain identifiers like Saler Record ID, Item ID, listing title, buyer user ID, etc. The seller will specify one of the supported search types in <b>SellingManagerSearchTypeCodeType</b>, and then provides the value for that search type.
GetSellingManagerSoldListings
No
This field is used if the seller would like to retrieve all Selling Manager Sale Records for products listed in a specific eBay Store Category.
GetSellingManagerSoldListings
No
One or more <b>Filter</b> fields can be used to retrieve Selling Manager Sale Records for orders that are in a certain state. See <b>SellingManagerSoldListingsPropertyTypeCodeType</b> for the supported values.
GetSellingManagerSoldListings
No
This field is included and set to <code>true</code> if the seller would like to retrieve one or more archived orders between 90 and 120 days old.
GetSellingManagerSoldListings
Conditionally
This field is used if the seller would like to sort Selling Manager Sale Record results based on a specific aspect such as purchase date, checkout status, total price, etc. See <b>SellingManagerSoldListingsSortTypeCodeType</b> to read more about the available sorting options.
GetSellingManagerSoldListings
No
This field allows the seller to sort in ascending or descending order (based on the selected aspect in the <b>Sort</b> field).
GetSellingManagerSoldListings
No
This container is used if the seller would like to control how many Sale Records are returned per page and which page to view.
GetSellingManagerSoldListings
No
This container allows the seller to retrieve orders that were purchased within a specified time range. A time range can be set up to 90 days in the past (or up to 120 days if the <b>Archived</b> field is included and set to <code>true</code>.
GetSellingManagerSoldListings
No
Returns a Selling Manager user's sold listings. Response can be filtered by date, search
values, and stores.
A <b>SaleRecord</b> container is returned for each order that matches the input criteria.
GetSellingManagerSoldListings
Always
Contains the total number of pages (<b>TotalNumberOfPages</b>) and the total number of products entries (<b>TotalNumberOfEntries</b>) that can be returned on repeated calls with the same format and report criteria.
GetSellingManagerSoldListings
Always
Retrieves the set of Selling Manager automation rules associated with a Selling Manager template. This call is subject to change without notice; the deprecation process is inapplicable to this call. The user must have a Selling Manager Pro subscription to use this call.
SetSellingManagerTemplateAutomationRule
Using Selling Manager Calls in the Trading API
https://developer.ebay.com/DevZone/guides/features-guide/default.html#development/Listings-SellingManager.html
Selling Manager Pro page on the eBay Site
https://pages.ebay.com/help/sell/sm-getting-started.html
SetSellingManagerTemplateAutomationRule
The unique ID of the Selling Manager Template whose Selling Manager
automation rules you want to retrieve.
You can obtain a <b>SaleTemplateID</b> by calling <b>GetSellingManagerInventory</b>.
GetSellingManagerTemplateAutomationRule
Yes
Contains the set of automation rules associated with the specified template.
The information for the automated listing rule associated with the template.
GetSellingManagerTemplateAutomationRule
Conditionally
The information for the automated relisting rule associated with the template.
GetSellingManagerTemplateAutomationRule
Conditionally
The information for the automated Second Chance Offer rule associated with the template.
GetSellingManagerTemplateAutomationRule
Conditionally
Contains fees that may be incurred when items are listed using the
automation rule (e.g., a scheduled listing fee). Use of an automation rule
does not in itself have a fee, but use can result in a fee.
GetSellingManagerTemplateAutomationRule
Conditionally
Retrieves Selling Manager templates. This call is subject to change without notice; the deprecation process is inapplicable to this call. The user must have a Selling Manager Pro subscription to use this call.
AddSellingManagerTemplate
Using Selling Manager Calls in the Trading API
https://developer.ebay.com/DevZone/guides/features-guide/default.html#development/Listings-SellingManager.html
Selling Manager Pro page on the eBay Site
https://pages.ebay.com/help/sell/sm-getting-started.html
The unique identifier of the Selling Manager Template whose data will be returned. A Selling Manager Template contains the data needed to list an item. One or more template IDs can be specified, each in its own field. You can obtain a <b>SaleTemplateID</b> by calling <b>GetSellingManagerInventory</b>.
GetSellingManagerTemplates
Yes
The base response of the <b>GetSellingManagerTemplates</b> call. A <b>SellingManagerTemplateDetails</b> container is returned for each Selling Manager Template that matches the input criteria.
This container consists of an array of Selling Manager Templates that match the input criteria.
GetSellingManagerTemplates
Always
Retrieves a session ID that identifies a user and your application when you make a <b>FetchToken</b> request.
ConfirmIdentity, FetchToken, GetTokenStatus, RevokeToken
Getting Tokens
http://developer.ebay.com/DevZone/guides/features-guide/default.html#basics/Tokens.html
Getting a Token via FetchToken
http://developer.ebay.com/DevZone/guides/features-guide/default.html#basics/Tokens-MultipleUsers.html#GettingaTokenviaFetchToken
Setting Up the Application to Receive Tokens
http://developer.ebay.com/Devzone/xml/docs/HowTo/Tokens/GettingTokens.html#step1
The eBay Registered URL must be specified in this field. An eBay Registered URL is created and associated with a developer's Sandbox or Production key set by logging into the user's developer account on <b>developer.ebay.com</b> and going to the <b>User Tokens</b> page. The <b>RuName</b> value passed in this field must match the one specified for the specific Sandbox or Production key set being used to make the <b>GetSessionID</b> call. For more information on adding and registering your <b class="con">RuName</b>, see the <a href="../../HowTo/Tokens/GettingTokens.html#step1">Setting Up an Application to Receive Tokens</a> tutorial.
GetSessionID
Yes
The base response of the <b>GetSessionID</b> call. This response will include the generated <b>SessionID</b> value, which is a unique identifier for authenticating data entry during the process that creates a user token.
A 40-character identifier supplied by eBay to an application. Used to confirm the
identities of the user and the application in a URL redirect during the
process in which the user agrees to let the application wield a user token that
grants the application the right to access eBay data on behalf of the user.
Subsequently also used as input for the <b>FetchToken</b> API call. The
<b>SessionID</b> value is valid for five minutes after it is retrieved.
GetSessionID
Always
This call retrieves all shipping discount profiles currently defined by the user, along with other Combined Invoice-related details such as packaging and handling costs.
SetShippingDiscountProfiles
Other Shipping Features
http://developer.ebay.com/DevZone/guides/features-guide/default.html#development/Shipping-OtherFeatures.html
http://developer.ebay.com/DevZone/guides/features-guide/default.html#development/Listing-AnItem.html#CombinedInvoice
Combined Invoice
The base response of the <b>GetShippingDiscountProfiles</b> call.
The three-digit code of the currency to be used for shipping cost discounts. A discount profile can only be associated with a listing if the <b>CurrencyID</b> value of the profile matches the <b>Item.Currency</b> value specified in a listing.
GetShippingDiscountProfiles
Always
http://developer.ebay.com/DevZone/guides/features-guide/default.html#development/Listing-AnItem.html#CombinedInvoice
Combined Invoice
This container consists of one or more flat-rate shipping discount rules that are set up for a seller's account. This container is returned as an empty element if no flat-rate shipping discount rules are currently set for the seller's account.
GetShippingDiscountProfiles
Always
This container consists of one or more calculated shipping discount rules that are set up for a seller's account. This container is returned as an empty element if no calculated shipping discount rules are currently set for the seller's account.
GetShippingDiscountProfiles
Always
This field indicates whether or not a seller has set up a promotional shipping discount rule in the seller's account. Only one promotional shipping discount may be defined for a seller's account at any given time. This field is returned whether <code>false</code> or <code>true</code>. If <code>true</code>, details of the rule can be found in the <b>PromotionalShippingDiscountDetails</b> container.
GetShippingDiscountProfiles
Always
This container consists of the handling discount applicable to a calculated shipping discount rule that is set up for a seller's account. This container is not returned if no calculated shipping discount rules are currently set for the seller's account.
GetShippingDiscountProfiles
Conditionally
http://developer.ebay.com/DevZone/guides/features-guide/default.html#development/Listing-AnItem.html#CombinedInvoice
Combined Invoice
This container consists of information related to the promotional shipping discount rule that is set up for a seller's account. This container is not returned if no promotional shipping discount rule is set up for the seller's account.
GetShippingDiscountProfiles
Conditionally
This container is deprecated.
This container is deprecated.
This field indicates the number of days after the sale of an item in which the buyer or seller can combine multiple and mutual order line items into one Combined Invoice order. In a Combined Invoice order, the buyer makes one payment for all order line items, hence only unpaid order line items can be combined into a Combined Invoice order.
GetShippingDiscountProfiles
Always
This call is used to retrieve detailed information on a seller's eBay Store, including store theme information and eBay Store category hierarchy.
SetStore
Managing eBay Stores
https://developer.ebay.com/DevZone/guides/features-guide/default.html#development/Sites-eBayStore.html
Include this field and set its value to <code>true</code> if you wish to restrict the call response to only the store category hierarchy data. If this field is not included or set to <code>false</code>, store category hierarchy and all store configuration data is returned.
false
GetStore
No
The unique identifier of an eBay Store category. This field is used if the user wants to isolate the category hierarchy data to one particular eBay category (and its subcategories if applicable). The <b>LevelLimit</b> value will determine how many additional levels of categories are returned.
GetStore
No
This field allows the seller to limit the number of levels of eBay Store categories that are returned. To return only top-level eBay Store categories, the user can include this field and set its value to <code>1</code> (and not use a <b>RootCategoryID</b> value). To retrieve a specific eBay Store Category and that category's child categories, the user could specify the unique eBay Store Category ID in the <b>RootCategoryID</b> field and then set the <b>LevelLimit</b> value to <code>2</code>.
<br/><br/>
If <b>LevelLimit</b> is omitted, the complete eBay Store Category hierarchy is returned, or all of specified store category's child categories. Currently, eBay Stores support only three levels of store categories.
GetStore
No
The unique identifier for an eBay Store owner. This field is only required if the user wants to view the eBay Store theme and category information for a different eBay Store owner. If this field is omitted, eBay Store theme and category information is returned for the eBay Store owner that is making the call.
GetStore
No
The base response of the <b>GetStore</b> call. This response consists of the data describing a seller's eBay store, and includes the eBay Store name, the description of the store, the URL to the eBay Store, the subscription level, store theme information, and eBay Store Category hierarchy.
This container consists of detailed information on the seller's eBay Store. The amount of information in this container will partially depend on the settings made in the call request.
GetStore
Always
This call is used to retrieve the status of an eBay Store Category hierarchy change that was made with a <b>SetStoreCategories</b> call.
SetStoreCategories
Managing eBay Stores
https://developer.ebay.com/DevZone/guides/features-guide/default.html#development/Sites-eBayStore.html
The unique identifier of an eBay Store Category hierarchy change task. A <b>TaskID</b> value is returned in the response of a successful <b>SetStoreCategories</b> call.
<br/><br/>
<span class="tablenote"><b>Note: </b> Depending on the breadth of changes being made to an eBay Store Category hierarchy, it is is possible that the <b>SetStoreCategories</b> call will complete the task simultaneously with the call response. A seller will know if an eBay Store Category hierarchy task was completed simultaneously if the <b>TaskID</b> value is returned as <code>0</code>, and the <b>Status</b> field is returned with a value of <code>Complete</code>. If the task was not completely simultaneously, the <b>TaskID</b> value will be a positive integer, and the <b>Status</b> field will show a value of <code>InProgress</code> or <code>Pending</code>.
</span>
GetStoreCategoryUpdateStatus
Yes
The base response of a <b>GetStoreCategoryUpdateStatus</b> call. The response includes the status of an eBay Store Category hierarchy change that was made with a <b>SetStoreCategories</b> call.
The enumeration value indicates the status of an update to the
eBay Store Category hierarchy.
GetStoreCategoryUpdateStatus
Always
This call is used to retrieve a specific custom page or all custom pages created for a seller's eBay Store. The eBay seller must have an eBay Store subscription to use this call.
SetStoreCustomPage
Managing Custom Pages
https://developer.ebay.com/DevZone/guides/features-guide/default.html#development/Sites-eBayStore.html#ManagingCustomPages
Managing eBay Stores
https://developer.ebay.com/DevZone/guides/features-guide/default.html#development/Sites-eBayStore.html
This field is used if the seller wants to retrieved detailed information on a specific custom page. If no <b>PageID</b> is specified, then all of the seller's custom pages are returned, but without the page content.
GetStoreCustomPage
No
The base response of the <b>GetStoreCustomPage</b> call.
This array consists of details for one or more of the seller's custom pages. A <b>CustomPage</b> container is returned for each custom page that matches the input criteria.
GetStoreCustomPage
Always
This call is used to retrieve the current list of eBay Store configuration settings.
Managing eBay Stores
https://developer.ebay.com/DevZone/guides/features-guide/default.html#development/Sites-eBayStore.html
The base response of the <b>GetStoreOptions</b> call.
This container consists of the current set of basic themes available for eBay Stores. Each basic theme definition consists of settings like colors, font style, and font size. This theme data can be reused in a <b>SetStore</b> call to set/modify the theme for an eBay Store.
GetStoreOptions
Always
This container consists of the current set of advanced themes available for eBay Stores. Each advanced theme definition consists of settings like colors, font style, and font size. This theme data can be reused in a <b>SetStore</b> call to set/modify the theme for an eBay Store. Unlike basic themes, you can use any color scheme with an advanced theme. These themes are suitable for more advanced customization.
GetStoreOptions
Always
An array of logo identifiers for numerous product categories. These <b>LogoID</b> values can be reused in a <b>SetStore</b> call to set the logo for an eBay Store.
GetStoreOptions
Always
This container consists of the different levels of eBay Store subscriptions along with the monthly subscription price.
GetStoreOptions
Always
This value indicates the maximum number of categories (meta and leaf) that can be set up in an eBay Store.
GetStoreOptions
Always
This is the maximum number of category levels that can be set up in an eBay Store.
GetStoreOptions
Always
This call is used to retrieve an eBay seller's Store preferences. This call does not have any call-specific request payload.
SetStorePreferences
Managing eBay Stores
https://developer.ebay.com/DevZone/guides/features-guide/default.html#development/Sites-eBayStore.html
Base response of the <b>GetStorePreferences</b> call.
This container consists of the seller's current eBay Store preferences. Currently, the only eBay Store preferences are related to putting an eBay Store on vacation mode, but more preferences may get added in the future.
GetStorePreferences
Always
This call returns a list of up to 10 eBay categories that have the highest percentage of listings whose listing titles or descriptions contain the keywords you specify.
https://developer.ebay.com/DevZone/guides/features-guide/default.html#development/Categories-KeywordSuggestions.html
Retrieving Suggested Categories Based on Keywords
This field is used to specify the search query, consisting of one or
more keywords to search for in listing titles and descriptions.
The words "and" and "or" are treated like any other
word.
350
GetSuggestedCategories
Yes
The base response of a <b>GetSuggestedCategories</b> call. This response includes an array of categories with the highest number
of listings whose listing titles or descriptions contain the keywords
specified in the <b>Query</b> field of the call request.
This container consists of an array of suggested listing categories for an item based on the keywords that were specified in the <b>Query</b> field of the call request. Up to 10 suggested categories may be returned. This container will always be returned unless the query in the request exceeds the maximum allowed characters. The quality/accuracy of the results may depend on the quality of the query string.
GetSuggestedCategories
Always
This integer value indicates the number of suggested categories that were found that matched the keywords.
GetSuggestedCategories
Always
The base request type of the <b>GetTaxTable</b> call, which retrieves information on the seller's Sales Tax Table. This information includes all of the site's tax jurisdictions, a boolean field to indicate if sales tax is applied to shipping and handling charges, and the sales tax rate for each jurisdiction (if a sales tax rate is set for that jurisdiction).
<br/><br/>
Sales tax tables are only supported on the eBay US and Candada marketplaces.
This call is used to retrieve information on the seller's Sales Tax Table.
SetTaxTable
DetailLevel
Enabling Multi-jurisdiction Sales Tax
http://developer.ebay.com/DevZone/guides/features-guide/default.html#development/Feature-SalesTax.html
The base response of the <b>GetTaxTable</b> call.
The last time (in GMT) that the tax table was updated. Only returned if the user previously created a tax table and if the site has jurisdictions. <b>LastUpdateTime</b> is useful for synchronization. If you cache the user's tax table, you can use <b>GetTaxTable</b> to check if it has changed and whether you need to update the cached tax table.
GetTaxTable
DetailLevel: ReturnAll, none
Conditionally
A container of tax jurisdiction information unique to a user/site combination. Returned as an empty container if no Sales Tax Table information exists for the seller's account and no <b>DetailLevel</b> is used. If <b>DetailLevel</b> is not specified, information is only returned for the jurisdictions for which the user provided tax information. If <b>DetailLevel</b> is set to <b>ReturnAll</b>, tax information is returned for all possible jurisdictions, whether specified by the user or not. <b>ShippingIncludedInTax</b> and <b>SalesTaxPercent</b> are returned but are empty.
GetTaxTable
DetailLevel: ReturnAll, none
Always
This call is used to get the current status of a user token. There are no call-specific fields in the request payload.
The base response of the <b>GetTokenStatus</b> call. This call retrieves the status of a user token.
This container value indicates the status and expiration date of a user token. If a user token was revoked, the date/time of the revocation is also returned under this container.
GetTokenStatus
Always
Retrieves data pertaining to a single eBay user. Callers can use this call to return their own user data or the data of another eBay user. Unless the caller passes in an <strong>ItemID</strong> value that identifies a current or past common order, not all data (like email addresses) will be returned in the response.
DetailLevel
Managing User Information
https://developer.ebay.com/DevZone/guides/features-guide/default.html#development/CRM-UserInformation.html
Specify the <strong>ItemID</strong> value for a successfully concluded listing in which the
requestor and target user were participants (one as seller and the other
as buyer). Necessary to return certain data (like an email address). Not
necessary if the requestor is retrieving their own data.
GetUser
Conditionally
Specify the user whose data you want returned by the call. If not specified, eBay returns data pertaining to the
requesting user (as specified with the <strong>eBayAuthToken</strong> value).
GetUser
No
This field is deprecated.
579
681
NoOp
If the <b>IncludeFeatureEligibility</b> flag is included and set to 'true', the call response will include a <b>QualifiesForSelling</b> flag which indicates if the eBay user is eligible to sell on eBay, and a <b>IncludeFeatureEligibility</b> container which indicates which selling features are available to the user.
GetUser
No
Base response of the <b>GetUser</b> call. This response includes detailed information about the user, including Feedback data, eBay registration date, selling feature eligibility, valid subsriptions, etc.
This container consists of detailed information about the user specified in the call request (through the <b>UserID</b> field) or the eBay user account that is tied to the <strong>eBayAuthToken</strong> value that is passed in the call request.
<br><br>
Some sensitive data will be masked/omitted if the returned eBay user is not the person making the <b>GetUser</b> call. More information on another eBay user will be revealed to the person making the call if that person has an order relationship for an eBay listing specified in the <strong>ItemID</strong> field of the call request.
GetUser
DetailLevel: none, ReturnSummary, ReturnAll
Always
This call is used to retrieve contact information for a specified eBay user, given that a bidding relationship (as either a buyer or seller) exists between the caller and the user.
A unique identifier for the eBay listing that the caller and order partner have in common.
GetUserContactDetails
Yes
An eBay user ID that uniquely identifies a given user for whom the caller is seeking information. Either a seller's or bidder's/buyer's user ID can be specified here, as long as an bidding/order relationship exists between the requester and the user specified by this field. That is, a bidder must be bidding on the seller's active auction item, or a prospective buyer has proposed a Best Offer on a listing.
GetUserContactDetails
Yes
An eBay user ID that uniquely identifies the person who is making the call. Either a seller's or bidder's/buyer's user ID can be specified here, as long as a bidding/order relationship exists between the requester and the user for whom information is being requested.
GetUserContactDetails
Yes
Returns contact information to a seller for both bidders
and users who have made offers (via Best Offer) during
an active listing.
An eBay ID that uniquely identifies the given user whose information is given in the call response.
GetUserContactDetails
Always
Contact information for the requested contact.
Note that the email address is NOT returned.
GetUserContactDetails
Always
The date and time that the requested contact
registered with eBay.
GetUserContactDetails
Always
Requests a list of disputes the requester is involved in as buyer or seller. eBay Money Back Guarantee Item Not Received and Return cases are not returned with this call. To retrieve eBay Money Back Guarantee cases, use the <b>Search Cases</b> call of the Post-Order API (or alternatively, the <b>getUserCases</b> call of the Resolution Case Management API.
Requests a list of disputes the requester is involved in as buyer or seller. eBay Money Back Guarantee Item Not Received and Return cases are not returned with this call.
DetailLevel
AddDispute, AddDisputeResponse, GetDispute, SellerReverseDispute
Unpaid Item Disputes
https://developer.ebay.com/DevZone/guides/features-guide/default.html#development/UPI-Disputes.html
Buyer Disputes
https://developer.ebay.com/DevZone/guides/features-guide/default.html#development/Disputes-Buyer.html
Getting Details About a Dispute
https://developer.ebay.com/DevZone/guides/features-guide/default.html#development/UPI-DisputesGettingDetails.html
An inclusive filter that isolates the returned disputes to a certain type such as Item Not Received or Unpaid Item disputes. eBay Money Back Guarantee cases are not retrieved with this call, even if the <b>ItemNotReceivedDisputes</b> filter is included in the request.
GetUserDisputes
No
One of the values defined in <b>DisputeSortTypeCodeType</b> is used here to control the order of disputes that are returned.
None
GetUserDisputes
No
A filter that retrieves disputes whose <b>DisputeModifiedTime</b> is later than or equal to this value. Specify the time value in GMT. See the eBay Features Guide for information about specifying time values. For more precise control of the date range filter, it is a good practice to also specify <b>ModTimeTo</b>. Otherwise, the end of the date range is the present time. Filtering by date range is optional. You can use date range filters in combination with other filters like <b>DisputeFilterType</b> to control the amount of data returned.
GetUserDisputes
No
A filter that retrieves disputes whose <b>DisputeModifiedTime</b> is earlier than or equal to this value. Specify the time value in GMT. See the eBay Features Guide for information about specifying time values. For more precise control of the date range filter, it is a good practice to also specify <b>ModTimeFrom</b>. Otherwise, all available disputes modified prior to the <b>ModTimeTo</b> value are returned. Filtering by date range is optional. You can use date range filters in combination with other filters like <b>DisputeFilterType</b> to control the amount of data returned.
GetUserDisputes
No
The virtual page number of the result set to display. A result set has a number of disputes divided into virtual pages, with 200 disputes per page. The response can only display one page. The first page in the result set is number 1. Required. If not specified, a warning is returned and <b>Pagination.PageNumber</b> is set to 1 by default.
GetUserDisputes
Yes
Returns a list of disputes that involve the calling user
as buyer or seller, in response to a <b>GetUserDisputesRequest</b>.
The index of the first dispute in the current result set, relative to the total number of disputes available. Primarily useful for interpreting paginated results. For example, if 228 disputes are available and 200 results are returned per page: The first page returns a <b>StartingDisputeID</b> value of 1 and the second page returns a <b>StartingDisputeID</b> value of 201.
GetUserDisputes
DetailLevel: ReturnSummary, ReturnAll, none
Always
The index of the last dispute in the current result set, relative to the total number of disputes available. Primarily useful for interpreting paginated results. For example, if 228 disputes are available and 200 results are returned per page: The first page returns an <b>EndingDisputeID</b> value of 200 and the second page returns an <b>EndingDisputeID</b> value of 228.
GetUserDisputes
DetailLevel: ReturnSummary, ReturnAll, none
Always
The array of disputes returned.
GetUserDisputes
DetailLevel: ReturnSummary, ReturnAll, none
Always
The number of disputes on each virtual page in the result set.
The virtual page returned is determined by <b>PageNumber</b>.
200
GetUserDisputes
DetailLevel: ReturnSummary, ReturnAll, none
Always
The page of the total result set returned in the call. The entire result set
is virtual and the call returns only one page of it.
GetUserDisputes
DetailLevel: ReturnSummary, ReturnAll, none
Always
The number of disputes that involve the requester as
buyer or seller and match a given filter type.
GetUserDisputes
DetailLevel: ReturnSummary, ReturnAll, none
Always
The result of the pagination, including the total number
of virtual pages in the result set and the total number of
disputes returned.
GetUserDisputes
DetailLevel: ReturnSummary, ReturnAll, none
Always
Retrieves the specified user preferences for the authenticated caller.
SetUserPreferences
Managing User Preferences
https://developer.ebay.com/DevZone/guides/features-guide/default.html#development/CRM-UserInformation.html#ManagingUserPreferences
If included and set to <code>true</code>, the seller's preference for receiving contact information for unsuccessful bidders is returned in the response.
false
GetUserPreferences
No
If included and set to <code>true</code>, the seller's combined invoice preferences are returned in the response. These preferences are used to allow Combined Invoice orders.
<br>
false
GetUserPreferences
No
http://developer.ebay.com/DevZone/guides/features-guide/default.html#development/Listing-AnItem.html#CombinedInvoice
Combined Invoice
This field is deprecated.
If included and set to <code>true</code>, the seller's payment preferences are returned in the response.
false
GetUserPreferences
No
If included and set to <code>true</code>, the seller's preferences for the end-of-auction email sent to the winning bidder is returned in the response. These preferences are only applicable for auction listings.
false
GetUserPreferences
No
If included and set to <code>true</code>, the seller's favorite item preferences are returned in the response.
false
GetUserPreferences
No
This field is deprecated.
If included and set to <code>true</code>, the seller's preference for sending an email to the buyer with the shipping tracking number is returned in the response.
false
GetUserPreferences
No
If included and set to <code>true</code>, the seller's preference for requiring that the buyer supply a shipping phone number upon checkout is returned in the response. Some shipping carriers require the receiver's phone number.
false
GetUserPreferences
No
If included and set to <code>true</code>, all of the seller's excluded shipping locations are returned in the response. The returned list mirrors the seller's current Exclude shipping locations list in My eBay's Shipping Preferences. An excluded shipping location in My eBay can be an entire geographical region (such as Middle East) or only an individual country (such as Iraq). Sellers can override these default settings for an individual listing by using the <b>Item.ShippingDetails.ExcludeShipToLocation</b> field in the <b>AddItem</b> family of calls.
false
GetUserPreferences
No
If included and set to <code>true</code>, the seller's Unpaid Item Assistant preferences are returned in the response. The Unpaid Item Assistant automatically opens an Unpaid Item dispute on the behalf of the seller. <br><br> <span class="tablenote"><strong>Note:</strong> To return the list of buyers excluded from the Unpaid Item Assistant mechanism, the <b>ShowUnpaidItemAssistanceExclusionList</b> field must also be included and set to <code>true</code> in the request. Excluded buyers can be viewed in the <b>UnpaidItemAssistancePreferences.ExcludedUser</b> field. </span>
false
GetUserPreferences
Conditionally
If included and set to <code>true</code>, the seller's preference for sending a purchase reminder email to buyers is returned in the response.
false
GetUserPreferences
No
If included and set to <code>true</code>, the list of eBay user IDs on the Unpaid Item Assistant Excluded User list is returned through the <b>UnpaidItemAssistancePreferences.ExcludedUser</b> field in the response. <br/><br/> For excluded users, an Unpaid Item dispute is not automatically filed through the UPI Assistance mechanism. The Excluded User list is managed through the <b>SetUserPreferences</b> call. <br><br> <span class="tablenote"><strong>Note:</strong> To return the list of buyers excluded from the Unpaid Item Assistant mechanism, the <b>ShowUnpaidItemAssistancePreference</b> field must also be included and set to <b>true</b> in the request. </span>
false
GetUserPreferences
No
If this flag is included and set to <code>true</code>, the seller's Business Policies profile information is returned in the response. This information includes a flag that indicates whether or not the seller has opted into Business Policies, as well as Business Policies profiles (payment, shipping, and return policy) active on the seller's account.
false
GetUserPreferences
No
If this flag is included and set to <code>true</code>, the <b>SellerReturnPreferences</b> container is returned in the response and indicates whether or not the seller has opted in to eBay Managed Returns.
<br><br>
eBay Managed Returns are currently only available on the US, UK, DE, AU, and CA (English and French) sites.
false
GetUserPreferences
No
If this flag is included and set to <code>true</code>, the seller's preference for offering the Global Shipping Program to international buyers will be returned in <strong>OfferGlobalShippingProgramPreference</strong>.
false
GetUserPreferences
No
If included and set to <code>true</code>, the seller's same-day handling cutoff time is returned in <strong>DispatchCutoffTimePreference.CutoffTime</strong>.
<br>
<br>
<span class="tablenote"><b>Note:</b> This field is not applicable for sellers who have opted into the Handling Time Option of eBay Guaranteed Delivery, as this field only shows a single order cutoff time, but with the Handling Time Option, a seller can set a different order cutoff time for each business day. Currently, eBay Guaranteed Delivery is only available in the US.</span>
<br>
false
GetUserPreferences
No
Specifying Shipping Services
http://developer.ebay.com/DevZone/guides/features-guide/default.html#development/Shipping-Services.html#SameDayHandling
details about dispatch cut off times
If included and set to <code>true</code>, the <strong>GlobalShippingProgramListingPreference</strong> field is returned. A returned value of <code>true</code> indicates that the seller's new listings will enable the Global Shipping Program by default.
false
GetUserPreferences
No
If included and set to <code>true</code>, the <strong>OverrideGSPServiceWithIntlServicePreference</strong> field is returned. A returned value of <code>true</code> indicates that for the seller's listings that specify an international shipping service for any Global Shipping-eligible country, the specified service will take precedence and be the listing's default international shipping option for buyers in that country, rather than the Global Shipping Program.
<br/><br/>
A returned value of <code>false</code> indicates that the Global Shipping program will take precedence over any international shipping service as the default option in Global Shipping-eligible listings for shipping to any Global Shipping-eligible country.
false
GetUserPreferences
No
If included and set to <code>true</code>, the <strong>PickupDropoffSellerPreference</strong> field is returned. A returned value of <code>true</code> indicates that the seller's new listings will by default be eligible to be evaluated for the Click and Collect feature.
<br/><br/>
With the Click and Collect feature, a buyer can purchase certain items on eBay and collect them at a local store. Buyers are notified by eBay once their items are available. The Click and Collect feature is only available to large merchants on the eBay UK (site ID 3), eBay Australia (Site ID 15), and eBay Germany (Site ID 77) sites.
<br/><br/>
<span class="tablenote"><b>Note:</b> The Click and Collect program no longer allows sellers to set the Click and Collect preference at the listing level.
</span>
false
GetUserPreferences
No
If included and set to <code>true</code>, the seller's preferences related to the Out-of-Stock feature will be returned. This feature is set using the <a href="SetUserPreferences.html#Request.OutOfStockControlPreference">SetUserPreferences</a> call.
false
GetUserPreferences
No
Using the Out-of-Stock Feature for more details
../../../../guides/features-guide/default.html#development/Listings-UseOutOfStock.html
To determine whether a seller can offer eBay Plus in qualified listings, include this field and set it to <code>true</code>.
<br/><br/>
eBay Plus is a premium account option for buyers, which provides benefits such as fast free domestic shipping and free returns on selected items. Top Rated eBay sellers must opt in to eBay Plus, and can offer the program on a per-listing basis.
<br/><br/>
The <strong>eBayPLUSPreference</strong> container is returned in the response with information about each country where the seller is eligible to offer eBay Plus on listings (one <strong>eBayPLUSPreference</strong> container per country), as well as the seller's opt-in status and listing preference for each country.
<br/><br/>
<span class="tablenote">
<strong>Note:</strong> Currently, eBay Plus is available only to buyers in Germany, Austria, and Australia.
</span>
false
GetUserPreferences
No
more details
Offering eBay Plus
../../../../guides/features-guide/default.html#development/Feature-eBayPlus.html
Contains some or all of the authenticated user's preferences. The preferences are
grouped in sets and are returned according to the flag settings in the request.
Container consisting of the seller's preference for receiving contact information for unsuccessful bidders. This container is returned when <b>ShowBidderNoticePreferences</b> is included and set to <code>true</code> in the request. This preference is only applicable for auction listings.
GetUserPreferences
Conditionally
Container consisting of the seller's Combined Invoice preferences. These preferences are used to allow Combined Invoice orders. This container is returned when <b>ShowCombinedPaymentPreferences</b> is included and set to <code>true</code> in the request.
GetUserPreferences
Conditionally
Combined Invoice
../../../../guides/features-guide/default.html#development/Listing-AnItem.html#CombinedInvoice
This container is deprecated.
Container consisting of the seller's payment preferences. This container is returned when <b>ShowSellerPaymentPreferences</b> is included and set to <code>true</code> in the request.
GetUserPreferences
Conditionally
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 returned when <b>ShowSellerFavoriteItemPreferences</b> is included and set to <code>true</code> in the request.
GetUserPreferences
Conditionally
Container consisting of the seller's preferences for the end-of-auction email sent to the winning bidder. This container is returned when <b>ShowEndOfAuctionEmailPreferences</b> is included and set to <code>true</code> in the request. These preferences are only applicable for auction listings.
GetUserPreferences
Conditionally
Container consisting of the seller's preference for sending an email to the buyer with the shipment tracking number. This container is returned when <b>ShowEmailShipmentTrackingNumberPreference</b> is included and set to <code>true</code> in the request.
GetUserPreferences
Conditionally
Container consisting of the seller's preference for requiring that the buyer supply a shipping phone number upon checkout. Some shipping carriers require the receiver's phone number. This container is returned when <b>ShowRequiredShipPhoneNumberPreference</b> is included and set to <code>true</code> in the request.
GetUserPreferences
Conditionally
This field is deprecated.
Container consisting of a seller's Unpaid Item Assistant preferences. The Unpaid Item Assistant automatically opens an Unpaid Item dispute on the behalf of the seller. This container is returned if <b>ShowUnpaidItemAssistancePreference</b> is included and set to <code>true</code> in the request.
<br><br>
<span class="tablenote"><b>Note:</b>
To return the list of buyers excluded from the Unpaid Item Assistant mechanism, the <b>ShowUnpaidItemAssistanceExclusionList</b> field must also be included and set to <code>true</code> in the request. Excluded buyers can be viewed in the <b>UnpaidItemAssistancePreferences.ExcludedUser</b> field.
</span>
GetUserPreferences
Conditionally
Container consisting of a list of the seller's excluded shipping locations. The returned list mirrors the seller's current <a href="http://cgi5.ebay.com/ws/eBayISAPI.dll?ExcludeShippingList" target="_blank">Exclude shipping locations</a> list in My eBay's shipping preferences. An excluded shipping location in My eBay can be an entire geographical region (such as Middle East) or only an individual country (such as Iraq).
<br/><br/>
Sellers can override these default settings for an individual listing by using the <b>Item.ShippingDetails.ExcludeShipToLocation</b> field in the Add/Revise/Relist calls. This container is returned if the <b>ShowSellerExcludeShipToLocationPreference</b> field is included and set to <code>true</code> in the request.
GetUserPreferences
Conditionally
Container consisting of a seller's preference for sending a purchase reminder email to buyers. This container is returned if the <b>ShowPurchaseReminderEmailPreferences</b> field is included and set to <code>true</code> in the request.
GetUserPreferences
Conditionally
This field is deprecated along with third-party checkout.
Parent response container consisting of high-level information for all Business Policies defined for the user's account. This container is returned if <b>ShowSellerProfilePreferences</b> is included and set to <code>true</code> in the <b>GetUserPreferences</b> request (and one or more Business Policies are defined for the user's account).
GetUserPreferences
Conditionally
Container consisting of the <b>OptedIn</b> flag that indicates whether or not the seller has opted in to eBay Managed Returns. This container is only returned if <b>ShowSellerReturnPreferences</b> is included and set to <code>true</code> in the request.
GetUserPreferences
Conditionally
This flag indicates whether the seller has opted in to the Global Shipping Program and is able to offer global shipping to international buyers. Returned when <b>ShowGlobalShippingProgramPreference</b> is included and set to <code>true</code>.
GetUserPreferences
Conditionally
Contains information about a seller's order cutoff time preferences for same-day shipping. If the seller specifies a value of '0' in <b>Item.DispatchTimeMax</b> to offer same-day handling when listing an item, the seller's shipping time commitment depends on the order cutoff time set for the listing site, as indicated by <b>DispatchCutoffTimePreference.CutoffTime</b>. Returned when <b>ShowDispatchCutoffTimePreferences</b> is included and set to <code>true</code>.
<br>
<br>
<span class="tablenote"><b>Note:</b> The order cutoff is may not be accurate for sellers who have opted into the Handling Time Option of eBay Guaranteed Delivery, as this field only shows a single order cutoff time, but with the Handling Time Option, a seller can set a different order cutoff time for each business day. Currently, eBay Guaranteed Delivery is only available in the US.</span>
<br>
Specifying Shipping Services
../../../../guides/features-guide/default.html#development/Shipping-Services.html#SameDayHandling
GetUserPreferences
Conditionally
If the <b>ShowGlobalShippingProgramListingPreference</b> field is submitted and set to <code>true</code>, this flag is returned. A returned value of <code>true</code> indicates that the seller's new listings will enable the Global Shipping Program by default.
GetUserPreferences
Conditionally
If the <b>ShowOverrideGSPServiceWithIntlServicePreference</b> field is submitted and set to <code>true</code>, this flag is returned. A returned value of <code>true</code> indicates that for the seller's listings that specify an international shipping service for any Global Shipping-eligible country, the specified service will take precedence and be the listing's default international shipping option for buyers in that country, rather than the Global Shipping Program.
<br/><br/>
A returned value of <code>false</code> indicates that the Global Shipping program will take precedence over any international shipping service as the default option in Global Shipping-eligible listings for shipping to any Global Shipping-eligible country.
GetUserPreferences
Conditionally
This boolean field is returned if the <b>ShowPickupDropoffPreferences</b> field is included and set to <code>true</code> in the request. This field will be returned as <code>true</code> if the seller has enabled the Click and Collect feature at the account level. All of the seller's new listings will by default be eligible to be evaluated for the Click and Collect feature. With the Click and Collect feature, a buyer can purchase certain items on eBay and collect them at a local store. Buyers are notified by eBay once their items are available. The Click and Collect feature is only available to large merchants on the eBay UK (site ID 3), eBay Australia (Site ID 15), and eBay Germany (Site ID 77) sites.
<br/><br/>
<span class="tablenote"><b>Note:</b> The Click and Collect program no longer allows sellers to set the Click and Collect preference at the listing level.
</span>
GetUserPreferences
Conditionally
This boolean field is returned if the <b>ShowOutOfStockControlPreference</b> field is included and set to <code>true</code> in the request. This field will be returned as <code>true</code> if the seller has set
<a href="SetUserPreferences.html#Request.OutOfStockControlPreference">SetUserPreferences.OutOfStockControlPreference</a> to <code>true</code>.
Using the Out-of-Stock Feature for more details
../../../../guides/features-guide/default.html#development/Listings-UseOutOfStock.html
GetUserPreferences
Conditionally
Contains information about each country where the seller is eligible to offer eBay Plus on listings (one <strong>eBayPLUSPreference</strong> container per country), as well as the seller's opt-in status and listing preference for each country.
<br/><br/>
eBay Plus is a premium account option for buyers, which provides benefits such as fast free domestic shipping and free returns on selected items. Top Rated eBay sellers must opt in to eBay Plus to offer the program on a per-listing basis.
<br/><br/>
<span class="tablenote">
<strong>Note:</strong> Currently, eBay Plus is available only to buyers in Germany, Austria, and Australia.
</span>
more details
Offering eBay Plus
../../../../guides/features-guide/default.html#development/Feature-eBayPlus.html
GetUserPreferences
Conditionally
Retrieves details for VeRO reason codes and their descriptions. You can specify a
reason code ID to get details for a specific reason on the site specified in the
request header. If <strong>ReasonCodeID</strong> is not passed in the request, all reason codes are
returned. Set <strong>ReturnAllSites</strong> to <code>true</code> to retrieve reason codes for all sites.
You must be a member of the Verified Rights Owner (VeRO) Program to use this call.
Retrieves details about VeRO reason codes for a given site or all sites. You must be a member of the Verified Rights Owner (VeRO) Program to use this call.
Unique identifier for a reason code. If this <strong>ReasonCodeID</strong> field is passed in, only the details related to this <strong>ReasonCodeID</strong> will be returned. If no reason code is specified, all reason codes are returned.
GetVeROReasonCodeDetails
No
Set to true to retrieve reason codes for all sites. If not specified, reason codes are returned for the site specified in the request header only. If a <strong>ReasonCodeID</strong> value is specified, this parameter is ignored.
false
GetVeROReasonCodeDetails
No
Base response of the <strong>GetVeROReasonCodeDetails</strong> call. This response will consists of one or more VeRO Program copyright/intellectual property infringement violation types.
This container consists of one or more VeRO Program copyright/intellectual property infringement violation types for one or more eBay sites.
GetVeROReasonCodeDetails
Always
Retrieves status information about VeRO reported items you have submitted. You
can receive the status of individual items you have reported or, by specifying
<strong>VeROReportPacketID</strong>, you can retrieve status for all items reported with a given
<strong>VeROReportItems</strong> request. You can also retrieve items that were reported during a
given time period. If no input parameters are specified, status is returned on all
items you have reported in the last two years.
You must be a member of the Verified Rights Owner (VeRO) Program to use this
call.
Retrieves status information about VeRO reported items. You must be a member of
the Verified Rights Owner (VeRO) Program to use this call.
Packet identifier associated with the reported items for which you want to
retrieve status. By default, reported item details are not returned when
you specify the packet ID in the request. Applies only to items reported
with the <strong>VeROReportItems</strong> call.
GetVeROReportStatus
No
Unique identifier for an eBay listing reported for alleged infringement. Applies to items reported with the <strong>VeROReportItems</strong> call or by other means (e.g., through the Web flow).
GetVeROReportStatus
No
Set to true to return reported item details when you specify <strong>VeROReportPacketID</strong> in the request.
false
GetVeROReportStatus
No
Limits returned items to only those that were submited on or after the
date-time specified. If specified, TimeTo must also be specified.
Express the date-time in the format YYYY-MM-DD HH:MM:SS, and in GMT.
(For information on how to convert between your local time zone
and GMT, see Time Values Note.) Applies to items reported with
VeROReportItems or by other means (e.g., through the web flow).
Infringement reporting data is maintained for two years after the date of
submission.
This field is ignored if <strong>VeROReportPacketID</strong> or <strong>ItemID</strong> is specified.
GetVeROReportStatus
No
Limits returned items to only those that were submited on or before the
date-time specified. If specified, TimeFrom must also be specified.
Express date-time in the format YYYY-MM-DD HH:MM:SS, and in GMT.
(For information on how to convert between your local time zone
and GMT, see Time Values Note.) Applies to items reported with
VeROReportItems or by other means (e.g., through the web flow).
Infringement reporting data is maintained for two years after the date of
submission.
This field is ignored if <strong>VeROReportPacketID</strong> or <strong>ItemID</strong> is specified.
GetVeROReportStatus
No
Contains the data controlling the pagination of the returned values: how
many items are returned per page of data (per call) and the number of the
page to return with the current call.
GetVeROReportStatus
No
Base response of the <strong>GetVeROReportStatus</strong> call. This response contains status information for items reported by the VeRO Program member.
Contains information regarding the pagination of data (if pagination is
used), including total number of pages and total number of entries.
GetVeROReportStatus
Conditionally
If true, there are more items yet to be retrieved. Additional
calls with higher page numbers or more items per page must
be made to retrieve these items. Not returned if no items match the
request.
GetVeROReportStatus
Conditionally
Indicates the maximum number of Reported Item objects that can be returned in any given call.
<br/>
1
200
GetVeROReportStatus
Conditionally
Indicates the page of data returned by the current call. For instance,
for the first set of items can be returned, this field has a value of
one.
<br/>
1
GetVeROReportStatus
Conditionally
The packet ID for status being returned.
GetVeROReportStatus
Conditionally
Status of the packet.
GetVeROReportStatus
Conditionally
This container of one or more reported items that match the input criteria in the call request. Returns empty if no items are available that match the request.
GetVeROReportStatus
Conditionally
This is the base request type for the <b>GeteBayDetails</b> call. This call retrieves the latest eBay feature-related metadata values that are supported when listing items. This metadata includes country codes, currency codes, Item Specifics thresholds, supported Return Policy values, available shipping carriers and shipping service options, and more. This call may be used to keep metadata up-to-date in your applications.
<br><br>
In some cases, the data returned in the response will vary according to the eBay site that you use for the request.
This call retrieves the latest eBay feature-related metadata values that are supported when listing items.
One or more <b>DetailName</b> fields may be used to control the the type of metadata that is returned in the response. If no <b>DetailName</b> fields are used, all metadata will be returned in the response. It is a good idea to familiarize yourself with the metadata that can be returned with <b>GeteBayDetails</b> by reading through the enumeration values in <a href="types/DetailNameCodeType.html">DetailNameCodeType</a>.
GeteBayDetails
No
Details about a specified site in response to <b>GeteBayDetailsRequest</b>. If no <b>DetailName</b> field is identified in the request, all elements of <b>GeteBayDetailsResponse</b> are returned. Otherwise, eBay returns only the elements corresponding to the specified <b>DetailName</b> fields. UpdateTime gives the time of modification of the most recently modified <b>DetailName</b>.
Details about a specified site in response to <b>GeteBayDetailsRequest</b>. If no <b>DetailName</b> field is identified in the request, all elements of <b>GeteBayDetailsResponse</b> are returned. Otherwise, eBay returns only the elements corresponding to the specified <b>DetailName</b> fields. <b>UpdateTime</b> gives the time of modification of the most recently modified <b>DetailName</b>.
Lists the country code and associated name of the countries supported by
the eBay system, regardless of the site specified in the request.
<br/><br/>
<span class="tablenote"><b>Note: </b>
This container is only returned if <b>CountryDetails</b> is included as a <b>DetailName</b> filter in the request, or if no <b>DetailName</b> filters are used in the request.
</span>
GeteBayDetails
Conditionally
Lists the currencies supported by the eBay system, regardless of the site
specified in the request.
<br/><br/>
<span class="tablenote"><b>Note: </b>
This container is only returned if <b>CurrencyDetails</b> is included as a
<b>DetailName</b> filter in the request, or if no <b>DetailName</b> filters are
used in the request.
</span>
GeteBayDetails
Conditionally
A dispatch time specifies the maximum number of business days a seller commits to for shipping an item to domestic buyers after receiving a cleared payment. Returns all dispatch times in the system, regardless of the site specified in the request.
<br/><br/>
<span class="tablenote"><b>Note: </b>
This container is only returned if <b>DispatchTimeMaxDetails</b> is included as a
<b>DetailName</b> filter in the request, or if no <b>DetailName</b>
filters are used in the request.
</span>
GeteBayDetails
Conditionally
Although the supported payment methods for the specified eBay site are returned, it is recommended that the seller use <b>GetCategoryFeatures</b> instead, and pass in <b>PaymentMethods</b> as a <b>FeatureID</b> value in the request.
<br/><br/>
<span class="tablenote"><b>Note: </b> This container is only returned if <b>PaymentOptionDetails</b> is included as a <b>DetailName</b> filter in the request, or if no <b>DetailName</b> filters are used in the request.
</span>
613
613
Avoid
Category.PaymentMethod
GeteBayDetails
Conditionally
Lists the cities and other domestic regions for the specified site's country.
<br/><br/>
<span class="tablenote"><b>Note: </b>
This container is only returned if <b>RegionDetails</b> is included as a
<b>DetailName</b> filter in the request, or if no <b>DetailName</b> filters are
used in the request.
</span>
GeteBayDetails
Conditionally
Lists the worldwide regions that can be set as shipping locations from the specified eBay site.
<br/><br/>
<span class="tablenote"><b>Note: </b>
This container is only returned if <b>ShippingLocationDetails</b> is included as a
<b>DetailName</b> filter in the request, or if no <b>DetailName</b>
filters are used in the request.
</span>
GeteBayDetails
Conditionally
Lists the shipping services supported by the specified eBay site. Returns only the shipping services that are applicable to the site specified in the request.
<br/><br/>
<span class="tablenote"><b>Note: </b>
This container is only returned if <b>ShippingServiceDetails</b> is included as a
<b>DetailName</b> filter in the request, or if no <b>DetailName</b>
filters are used in the request.
</span>
GeteBayDetails
Conditionally
Lists all available eBay sites and their associated <b>SiteID</b> numbers.
<br/><br/>
<span class="tablenote"><b>Note: </b>
This container is only returned if <b>SiteDetails</b> is included as a
<b>DetailName</b> filter in the request, or if no <b>DetailName</b>
filters are used in the request.
</span>
GeteBayDetails
Conditionally
Details the different tax jurisdictions or tax regions applicable to the
site specified in the request. Note that tax jurisdictions are only applicable to the following eBay sites: eBay US (Site ID 0), eBay Canada (Site ID 2), eBay Canada (French) (Site ID 210), and eBay India (Site ID 203). An empty response will be returned for any other Site ID that is passed in the HTTP header.
<br/><br/>
<span class="tablenote"><b>Note: </b>
This container is only returned if <b>TaxJurisdiction</b> is included as a
<b>DetailName</b> filter in the request, or if no <b>DetailName</b>
filters are used in the request.
</span>
TaxTable.TaxJurisdiction in SetTaxTable
SetTaxTable.html#Request.TaxTable.TaxJurisdiction
Item.UseTaxTable in AddItem
AddItem.html#Request.Item.UseTaxTable
GeteBayDetails
Conditionally
Lists eBay URLs that are applicable to the site specified in the request.
<br/><br/>
<span class="tablenote"><b>Note: </b>
This container is only returned if <b>URLDetails</b> is included as a
<b>DetailName</b> filter in the request, or if no <b>DetailName</b>
filters are used in the request.
</span>
GeteBayDetails
Conditionally
Lists the details of the time zones supported by the eBay system.
<br/><br/>
<span class="tablenote"><b>Note: </b>
This container is only returned if <b>TimeZoneDetails</b> is included as a
<b>DetailName</b> filter in the request, or if no <b>DetailName</b>
filters are used in the request.
</span>
GeteBayDetails
Conditionally
Lists the site's maximum thresholds for specifying Item Specifics.
<br/><br/>
<span class="tablenote"><b>Note: </b>
This container is only returned if <b>ItemSpecificDetails</b> is included as a
<b>DetailName</b> filter in the request, or if no <b>DetailName</b>
filters are used in the request.
</span>
GeteBayDetails
Conditionally
Units of measurement are no longer returned in GeteBayDetails, so this container is no longer applicable.
Lists the worldwide regions and individual countries that can be set as shipping locations from the specified eBay site.
<br/><br/>
<span class="tablenote"><b>Note: </b>
This container is only returned if <b>RegionOfOriginDetails</b> is included as a
<b>DetailName</b> filter in the request, or if no <b>DetailName</b>
filters are used in the request.
</span>
GeteBayDetails
Conditionally
Lists the various shipping packages supported by the specified site.
<br/><br/>
<span class="tablenote"><b>Note: </b>
This container is only returned if <b>ShippingPackageDetails</b> is included as a
<b>DetailName</b> filter in the request, or if no <b>DetailName</b>
filters are used in the request.
</span>
GeteBayDetails
Conditionally
Lists the shipping carriers supported by the specified site.
<br/><br/>
<span class="tablenote"><b>Note: </b>
This container is only returned if <b>ShippingCarrierDetails</b> is included as a
<b>DetailName</b> filter in the request, or if no <b>DetailName</b>
filters are used in the request.
</span>
GeteBayDetails
Conditionally
Lists the supported values that may be used for return policies on the specified eBay site, such as the return period, supported restocking fees, and refund options.
<br/><br/>
<span class="tablenote"><b>Note: </b>
This container is only returned if <b>ReturnPolicyDetails</b> is included as a
<b>DetailName</b> filter in the request, or if no <b>DetailName</b>
filters are used in the request.
</span>
<span class="tablenote"><b>Note: </b>
This container has been staged for deprecation. Although domestic return policy metadata is still getting returned at the moment, it is recommended that users start making plans to use the <b>GetCategoryFeatures</b> call instead to retrieve category-level, domestic return policy metadata.
</span>
GeteBayDetails
Conditionally
1077
Avoid
1147
GetCategoryFeatures
<span class="tablenote"><b>Note: </b>
This container has been deprecated. The <b>GetCategoryFeatures</b> call must be used instead to retrieve category-level, international return policy metadata.
</span>
1077
Avoid
1147
GetCategoryFeatures
Lists the minimum starting prices for the supported types of eBay listings.
<br/><br/>
<span class="tablenote"><b>Note: </b>
This container is only returned if <b>ListingStartPriceDetails</b> is included as a
<b>DetailName</b> filter in the request, or if no <b>DetailName</b>
filters are used in the request.
</span>
GeteBayDetails
Conditionally
Lists the threshold values that can be passed in through the <b>BuyerRequirementDetails</b> container in the Add/Revise/Relist API calls. Buyer Requirements allow the seller to block buyers who have unpaid item defects, policy violations, low Feedback scores, and/or other undesirable qualities/statistics. Buyer Requirements are set at the seller's account level, but by using a <b>BuyerRequirementDetails</b> container in an Add/Revise/Relist API call, the values in that container will override values set at the account level.
<br/><br/>
<span class="tablenote"><b>Note: </b>
This container is only returned if <b>BuyerRequirementDetails</b> is included as a
<b>DetailName</b> filter in the request, or if no <b>DetailName</b>
filters are used in the request.
</span>
GeteBayDetails
Conditionally
Details the listing features available for the eBay site specified in the request.
<br/><br/>
<span class="tablenote"><b>Note: </b>
This container is only returned if <b>ListingFeatureDetails</b> is included as a
<b>DetailName</b> filter in the request, or if no <b>DetailName</b>
filters are used in the request.
</span>
GeteBayDetails
Conditionally
Site-level validation rules for multi-variation listings (for example, the
maximum number of variations per listing). Use <b>GetCategoryFeatures</b> to
determine which categories on a site support variations. Use
<b>GetCategorySpecifics</b> for rules related to recommended or required variation
specifics.
<br/><br/>
<span class="tablenote"><b>Note: </b>
This container is only returned if <b>VariationDetails</b> is included as a
<b>DetailName</b> filter in the request, or if no <b>DetailName</b>
filters are used in the request.
</span>
GetCategoryFeatures
GetCategoryFeatures.html#Response.Category.VariationsEnabled
GetCategorySpecifics
GetCategorySpecifics.html
GeteBayDetails
Conditionally
Lists the locations supported by the <b>ExcludeShipToLocation</b> feature. These are
locations that a seller can list as areas where they will not ship an item.
<br/><br/>
<span class="tablenote"><b>Note: </b>
This container is only returned if <b>ExcludeShippingLocationDetails</b> is included as a
<b>DetailName</b> filter in the request, or if no <b>DetailName</b>
filters are used in the request.
</span>
GeteBayDetails
Conditionally
The time of the most recent modification to any feature detail. If specific
feature details are passed in the request, gives the most recent modification time
of those feature details.
GeteBayDetails
Always
Details the recoupment policies for the site specified in the request.
<br/><br/>
<span class="tablenote"><b>Note: </b>
This container is only returned if <b>RecoupmentPolicyDetails</b> is included as a
<b>DetailName</b> filter in the request, or if no <b>DetailName</b>
filters are used in the request.
</span>
GeteBayDetails
Conditionally
A shipping service category supported for the site.
<br/><br/>
<span class="tablenote"><b>Note: </b>
This container is only returned if <b>ShippingCategoryDetails</b> is included as a
<b>DetailName</b> filter in the request, or if no <b>DetailName</b>
filters are used in the request.
</span>
Each shipping service supported for a site is automatically categorized by eBay into one of the
shipping categories available for that site depending on how the shipping service shipping time
aligns with the shipping times specified by eBay for each category.
<br><br>
Notice that you cannot specify a <b>ShippingCategory</b>
as an input to any API call - eBay does this categorizing automatically. <b>ShippingCategory</b> is read-only data
that is returned in the <b>ShippingServiceDetails</b> container. One possible use of this data is to segregate shipping
services by <b>ShippingCategory</b> in a pick list. (For an example of this, see the Services pulldown menu in the
Give buyers shipping details form in the eBay Sell Your Item flow.)
<br><br>
One way to populate the picklist would be to call <b>GeteBayDetails</b>
with <b>DetailName</b> set to <b>ShippingServiceDetails</b>.
Then sort these results by <b>ShippingCategory</b> and populate the picklist.
GeteBayDetails
Conditionally
The <b>ProductDetails.ProductIdentifierUnavailableText</b>
field contains the actual text that should be passed into the relevant
product identification fields (EAN, ISBN, UPC, MPN/Brand) if eBay is
prompting/expecting one of these fields in the call request, but the identifiers do not exist/apply for the product. The text will vary based on the listing site. This text should only be used if no product ID exists for the product. If a product identifier value does actually exist for a product, but the seller passes in 'Does not apply' text, that listing may get penalized in search.
<br/><br/>
<span class="tablenote"><b>Note: </b>
This container is only returned if <b>ProductDetails</b> is included as a
<b>DetailName</b> filter in the request, or if no <b>DetailName</b>
filters are used in the request.
</span>
GeteBayDetails
Conditionally
Gets the official eBay system time in GMT.
The Timestamp field indicates the official eBay system time in GMT.
For information about converting between GMT and other time zones,
see "Time Values" in the Data Types appendix in the eBay Features guide.
Enables a buyer and seller to leave Feedback for their order partner at the
conclusion of a successful order.
GetItemsAwaitingFeedback, GetMyeBayReminders
Leaving and Retrieving Feedback
https://developer.ebay.com/DevZone/guides/features-guide/default.html#development/Sales-Feedback.html
Detailed Seller Ratings
https://developer.ebay.com/DevZone/guides/features-guide/default.html#development/Sales-Feedback.html#DetailedSellerRatings
Unique identifier for an eBay listing. A listing can have multiple
order line items, but only one <b>ItemID</b>. Unless an
<b>OrderLineItemID</b> is specified in the <b>LeaveFeedback</b> request, the <b>ItemID</b> is
required along with the <b>TargetUser</b> to identify an order line item
existing between the caller and the <b>TargetUser</b> that requires feedback. A
Feedback comment will be posted for this order line item. If there are
multiple order line items between the two order partners that still
require feedback, the <b>TransactionID</b> will also be required to isolate the
targeted order line item. Feedback cannot be left for order line items
with creation dates more than 60 days in the past.
LeaveFeedback
Conditionally
Textual comment that explains, clarifies, or justifies the feedback
score specified in <b>CommentType</b>.
<br>
80
LeaveFeedback
Yes
Score for the Feedback being left. May be Positive, Neutral, or Negative.
<br><br>
<span class="tablenote"><b>Note:</b>
Sellers can not leave neutral or negative feedback for buyers. In addition, buyers can not leave neutral or negative feedback within 7 days from the completion of the order for active Power Sellers who have been on eBay for 12 months.
</span>
LeaveFeedback
Withdrawn, IndependentlyWithdrawn
Yes
Unique identifier for an eBay order line item. If there
are multiple order line items between the two order partners that still
require Feedback, the <b>TransactionID</b> is required along with the
corresponding <b>ItemID</b> and <b>TargetUser</b> to isolate the targeted order line
item. If an <b>OrderLineItemID</b> is included in the response to identify a
specific order line item, none of the preceding fields (<b>ItemID</b>,
<b>TransactionID</b>, <b>TargetUser</b>) are needed. Feedback cannot be left for order
line items with creation dates more than 60 days in the past.
LeaveFeedback
Conditionally
Specifies the recipient user about whom the Feedback is being left.
LeaveFeedback
Yes
Container for detailed seller ratings (DSRs). If a buyer is providing DSRs, they are specified in this container. Sellers have access to the number of ratings they've received, as well as to the averages of the DSRs they've received in each DSR area (i.e., to the average of ratings in the item-description area, etc.).
Detailed Seller Ratings
http://developer.ebay.com/DevZone/guides/features-guide/default.html#development/Sales-Feedback.html
LeaveFeedback
No
<b>OrderLineItemID</b> is a unique identifier for an eBay order line item. If an <b>OrderLineItemID</b> is included in
the request, the <b>ItemID</b>, <b>TransactionID</b>, and <b>TargetUser</b> fields are not
required. Feedback cannot be left for order line items with creation
dates more than 60 days in the past.
<br>
100
LeaveFeedback
Conditionally
This field or the <b>ItemDeliveredWithinEDD</b> field should be included if it is the buyer leaving feedback for the seller. This field will inform eBay about whether or not the buyer received the order line item within the estimated delivery date, which is established once a buyer purchases or commits to buy an item.
<br>
<br>
<span class="tablenote"><b>Note:</b> A new "Late shipment rate" metric became a new component of Seller Standards beginning in February 2016. On-time shipping means that the seller shipped the item before the "handling time" expired and/or the item was received by the buyer within the estimated delivery date window, which is established once the buyer pays for the order line item. Previously, a seller's account could be dinged just for getting a low rating for the "shippping time" Detailed Seller Rating. </span>
LeaveFeedback
No
BuyerIndicatedItemArrivedWithinEDDRange, BuyerIndicatedItemNotArrivedWithinEDDRange
This field or the <b>ItemArrivedWithinEDDType</b> field should be included if it is the buyer leaving feedback for the seller. This field will inform eBay about whether or not the buyer received the order line item within the estimated delivery date window, which is established once a buyer purchases or commits to buy an item. The value of this field is set to <code>true</code> if the item did arrive within the estimated delivery date, or <code>false</code> if the item arrived past the estimated delivery date.
<br>
<br>
<span class="tablenote"><b>Note:</b> A new "Late shipment rate" metric became a new component of Seller Standards beginning in February 2016. On-time shipping means that the seller shipped the item before the "handling time" expired and/or the item was received by the buyer within the estimated delivery date window, which is established once the buyer pays for the order line item. Previously, a seller's account could be dinged just for getting a low rating for the "shippping time" Detailed Seller Rating. </span>
LeaveFeedback
Conditionally
Base response for the <b>LeaveFeedback</b> call. The response includes a <b>FeedbackID</b> value, which is automatically generated by eBay if the caller is successfully at submitting the Feedback entry.
The unique identifier of the Feedback entry that has been submitted by the caller.
LeaveFeedback
Always
Moves a Selling Manager inventory folder.
<br><br>
This call is subject to change without notice; the deprecation process is
inapplicable to this call. This call is only applicable and accessible by eBay sellers with a Selling Manager Pro subscription.
Using Selling Manager Calls in the Trading API
https://developer.ebay.com/DevZone/guides/features-guide/default.html#development/Listings-SellingManager.html
Selling Manager Pro page on the eBay Site
https://pages.ebay.com/help/sell/sellingmanager.html
Unique ID of the Selling Manager Inventory folder that will be moved. A user can retrieve <b>FolderID</b> values by using <b>GetSellingManagerInventoryFolder</b>.
MoveSellingManagerInventoryFolder
Yes
Unique ID of the Selling Manager Inventory folder that will be the new parent folder of the Selling Manager Inventory folder specified in the <b>FolderID</b> field. A user can retrieve <b>FolderID</b> values by using <b>GetSellingManagerInventoryFolder</b>. If this field is omitted, the Selling Manager Inventory folder specified in the <b>FolderID</b> field will be moved to the root level.
MoveSellingManagerInventoryFolder
Conditionally
Base response of the <b>MoveSellingManagerInventoryFolder</b> call. This response does not have any call-specific output fields.
Enables the authenticated user to to make a bid on an auction item, propose a Best Offer, or purchase a fixed-price/Buy It Now item. Note that this call cannot be used to purchase items that require immediate payment.
Enabling Best Offer
https://developer.ebay.com/DevZone/guides/features-guide/default.html#development/Feature-BestOffer.html
API License Agreement
https://developer.ebay.com/products/license
eBay User Agreement
https://pages.ebay.com/help/policies/user-agreement.html
PlaceOffer API License Agreement Addendum
https://developer.ebay.com/cms/files/placeoffer_api_license_addendum_uv_0.pdf
API Logo Usage Requirements
https://developer.ebay.com/promote/logos
Filing a Support Ticket
https://developer.ebay.com/my/support/tickets
eBay Partner Network
https://www.ebaypartnernetwork.com/
This container specifies the type of offer being made for the listing specified in the <b>ItemID</b> field. The <b>Offer.Action</b> is used to set the action that is being taken on the listing.
PlaceOffer
Yes
Unique identifier that identifies the listing for which the action is being submitted.
<br><br>
For a multiple-variation listing, you must also identify the specific variation within that listing using the <b>VariationSpecifics</b> container.
PlaceOffer
Yes
If a warning message is generated when the call is made, this <b>BlockOnWarning</b> will block the bid/buy action if set to <code>true</code>. If <b>BlockOnWarning</b>
is <code>false</code> or omitted, the bid/buy action is allowed, regardless of whether or not a warning message occurs.
<br>
False
PlaceOffer
No
Container for affiliate-related tags, which enable the tracking of user
activity. If you include the <b>AffiliateTrackingDetails</b> container in your <b>PlaceOffer</b> call, then
it is possible to receive affiliate commissions based on calls made by your
application. (See the <a href=
"http://www.ebaypartnernetwork.com/" target="_blank">eBay Partner Network</a>
for information about commissions.) Please note that affiliate tracking is not
available in the Sandbox environment, and that affiliate tracking is not
available when you make a Best Offer.
Affiliate Tracking Concepts
http://developer.ebay.com/DevZone/guides/features-guide/default.html#basics/eBay-AffiliateTrackingConcepts.html
PlaceOffer
No
This container is used to identify a specific variation within a multiple-variation listing identified by the <b>ItemID</b> value. This container is required when attempting to perform an action on a multiple-variation listing.
PlaceOffer
Conditionally
The <b>PlaceOffer</b> response notifies you about the success and result
of the call.
This container indicates the current bidding/purchase state of the order line item regarding the offer extended using <b>PlaceOffer</b>. The fields that are returned under this container will depend on the attempted action and the results of that action.
PlaceOffer
Always
Unique identifier for an eBay order line item. The
<b>TransactionID</b> field is only returned if the <b>Offer.Action</b> field was set
to <b>Purchase</b> in the input and the purchase was successful. A Purchase
action in <b>PlaceOffer</b> can be used for a fixed-price listing, or for an
auction listing where the Buy It Now option is available.
PlaceOffer
Conditionally
Container consisting of the status for a Best Offer. This container is
only returned if applicable based on the listing and the value set for
<b>Offer.Action</b> field in the request.
PlaceOffer
Conditionally
<b>OrderLineItemID</b> is a unique identifier for an eBay order line item. The <b>OrderLineItemID</b> field is only
returned if the <b>Offer.Action</b> field is set to <b>Purchase</b> in the input and
the purchase is successful. A Purchase action in <b>PlaceOffer</b> can be used
for a fixed-price listing, or for an auction listing where the Buy It
Now option is available.
<br>
PlaceOffer
Conditionally
Enables a seller to relist a fixed-price listing that has recently ended on a specified eBay site. A seller has to up to 90 days to relist an ended listing. When an item is relisted, it will receive a new <b>ItemID</b> value, but this item will remain on other users' Watch Lists after it is relisted. The seller has the opportunity to make changes to the listing through the <b>Item</b> container, and the seller can also use one or more <b>DeletedField</b> tags to remove an optional field/setting from the listing.
RelistItem, VerifyRelistItem
Relisting Items with Trading API
https://developer.ebay.com/DevZone/guides/features-guide/default.html#development/Listings-RelistingItems.html
Relisting items (eBay Help page)
https://pages.ebay.com/help/sell/relist.html
The <b>Item</b> container is used to configure the item that will be relisted. If the seller plans to relist the item with no changes, the only field under the <b>Item</b> container that is required is the <b>ItemID</b> field. In the <b>ItemID</b> field, the seller specifies the item that will be relisted. If the seller wishes to change anything else for the listing, the seller should include this field in the call request and give it a new value.
<br/><br/>
If the seller wants to delete one or more optional settings in the listing, the seller should use the <b>DeletedField</b> tag.
RelistFixedPriceItem
Yes
Specifies the name of the field to delete from a listing.
See <a href="http://developer.ebay.com/Devzone/guides/features-guide/default.html#development/Listings-RelistingItems.html">Relisting Items</a> for rules on deleting values when relisting items.
Also see the relevant field descriptions to determine when to use <b>DeletedField</b> (and potential consequences).
The request can contain zero, one, or many instances of <b>DeletedField</b> (one for each field to be deleted).
<br>
<br>
Some data (such as <b>Variation</b> nodes within <b>Variations</b>)
can't be deleted by using a <b>DeletedField</b> tag. See the relevant field
descriptions for how to delete such data.
<br>
<br>
Case-sensitivity must be taken into account when using a <b>DeletedField</b> tag to delete a field. The value passed into a <b>DeletedField</b> tag must either match the case of the schema element names in the full field path (Item.PictureDetails.GalleryURL), or the initial letter of each schema element name in the full field path must be lowercase (item.pictureDetails.galleryURL).
Do not change the case of letters in the middle of a field name.
For example, item.picturedetails.galleryUrl is not allowed.<br><br>
To delete a listing enhancement like 'BoldTitle', specify the value you are deleting;
for example, Item.ListingEnhancement[BoldTitle].
RelistFixedPriceItem
Conditionally
The base response type for the <b>RelistFixedPriceItem</b> call. The response includes the Item ID for the relisted item, the SKU value for the item (if any), listing recommendations (if applicable), the estimated fees for the relisted item (except the Final Value Fee, which isn't calculated until the item has sold), the start and end times of the listing, and other details.
The unique identifier for the relisted item. Note that the <b>ItemID</b> value changes when a listing is relisted, so this will not be the same <b>ItemID</b> value that was passed in the call request.
<br/><br/>
RelistFixedPriceItem
Always
The seller-defined SKU value for the new listing (if a SKU value exists for the item).
<br/><br/>
Note that variation-level SKU values will not be returned if a multiple-variation listing was relisted. The seller would have to make a <b>GetItem</b> call to get variation-level SKU values.
RelistFixedPriceItem
Conditionally
This container consists of the estimated listing fees for the relisted item. Each type of fee is returned even if it is not appplicable (has a value of <code>0.0</code>. The Final Value Fee (FVF) is not in this container, as this value cannot be determined until a sale is made.
RelistFixedPriceItem
Always
This timestamp indicates the date and time when the relisted item became active on the eBay site.
RelistFixedPriceItem
Always
Date and time when the relisted item is scheduled to end based on the start time and the listing duration value that was set in the <b>ListingDuration</b> field. If the value of <b>ListingDuration</b> was set to <code>GTC</code> (Good 'Til Cancelled), this value will be set 30 days ahead of the start time, although this value will be updated if the GTC listing is still alive and automatically renewed 30 days after start time.
<br><br>
<span class="tablenote"><b>Note: </b>
Starting July 1, 2019, the Good 'Til Cancelled renewal schedule will be modified from every 30 days to once per calendar month. For example, if a GTC listing is created July 5, the next monthly renewal date will be August 5. If a GTC listing is created on the 31st of the month, but the following month only has 30 days, the renewal will happen on the 30th in the following month. Finally, if a GTC listing is created on January 29-31, the renewal will happen on February 28th (or 29th during a 'Leap Year'). See the
<a href="https://pages.ebay.com/seller-center/seller-updates/2019-spring/marketplace-updates.html#good-til-cancelled" target="_blank">Good 'Til Cancelled listings update</a> in the <b>Spring 2019 Seller Updates</b> for more information about this change.
</span>
RelistFixedPriceItem
Always
Unique identifier of the primary eBay category in which the item was relisted. This field is only returned if the <b>Item.CategoryMappingAllowed</b> field was included and set to <code>true</code> in the request and the category ID passed in the <b>Item.PrimaryCategory</b> field was mapped to a new category ID by eBay. If the primary category has not changed or it has expired with no replacement, this field is not returned.
<br/><br/>
10
RelistFixedPriceItem
Conditionally
Unique identifier of the secondary eBay category (if one was used) in which the item was relisted. This field is only returned if the <b>Item.CategoryMappingAllowed</b> field was included and set to <code>true</code> in the request and the category ID passed in the <b>Item.SecondaryCategory</b> field was mapped to a new category ID by eBay. If the secondary category has not changed or it has expired with no replacement, this field is not returned.
<br/><br/>
10
RelistFixedPriceItem
Conditionally
This field is returned if an eBay special offer or promotion is applicable to the listing.
RelistFixedPriceItem
Conditionally
Provides a list of products recommended by eBay which match the item information
provided by the seller.
RelistFixedPriceItem
Conditionally
Container consisting of one or more <b>Recommendation</b> containers. Each <b>Recommendation</b> container provides a message to the seller on how a listing can be improved or brought up to standard in regards to top-rated seller/listing requirements, mandated or recommended Item Specifics, picture quality requirements, pricing and/or listing format recommendations, recommended keywords and/or Item Specifics in a Title, and/or a recommendation to offer fast handling (same-day handling or handling time of 1 day) and/or a free shipping option in order to qualify the listing for a Fast 'N Free badge.
<br><br>
This container is only returned if the <b>IncludeRecommendations</b>
flag was included and set to 'true' in the <b>RelistFixedPriceItem</b> request, and if
at least one listing recommendation exists for the newly relisted item. If one or more listing recommendations are returned, it will be at the seller's discretion about whether to revise the item based on eBay's listing recommendation(s).
RelistFixedPriceItem
Conditionally
Enables a seller to relist a listing that has recently ended on a specified eBay site. A seller has to up to 90 days to relist an ended listing. When an item is relisted, it will receive a new <b>ItemID</b> value, but this item will remain on other users' Watch Lists after it is relisted. The seller has the opportunity to make changes to the listing through the <b>Item</b> container, and the seller can also use one or more <b>DeletedField</b> tags to remove an optional field/setting from the listing.
RelistFixedPriceItem, VerifyRelistItem
Relisting Items with Trading API
https://developer.ebay.com/DevZone/guides/features-guide/default.html#development/Listings-RelistingItems.html
https://ebaydts.com/eBayKBDetails?KBid=1542
Best practices for relisting items
Relisting items (eBay Help page)
https://pages.ebay.com/help/sell/relist.html
The <b>Item</b> container is used to configure the item that will be relisted. If the seller plans to relist the item with no changes, the only field under the <b>Item</b> container that is required is the <b>ItemID</b> field. In the <b>ItemID</b> field, the seller specifies the item that will be relisted. If the seller wishes to change anything else for the listing, the seller should include this field in the call request and give it a new value.
<br/><br/>
If the seller wants to delete one or more optional settings in the listing, the seller should use the <b>DeletedField</b> tag.
RelistItem
Yes
Specifies the name of the field to delete from a listing.
See <a href="http://developer.ebay.com/Devzone/guides/features-guide/default.html#development/Listings-RelistingItems.html">Relisting Items</a> for rules on deleting values when relisting items.
Also see the relevant field descriptions to determine when to use <b>DeletedField</b> (and potential consequences).
The request can contain zero, one, or many instances of <b>DeletedField</b> (one for each field to be deleted).
<br><br>
Case-sensitivity must be taken into account when using a <b>DeletedField</b> tag to delete a field. The value passed into a <b>DeletedField</b> tag must either match the case of the schema element names in the full field path (Item.PictureDetails.GalleryURL), or the initial letter of each schema element name in the full field path must be lowercase (item.pictureDetails.galleryURL).
Do not change the case of letters in the middle of a field name.
For example, item.picturedetails.galleryUrl is not allowed.<br><br>
To delete a listing enhancement like 'BoldTitle', specify the value you are deleting;
for example, Item.ListingEnhancement[BoldTitle].
RelistItem
Conditionally
The base response type for the <b>RelistItem</b> call. The response includes the Item ID for the relisted item, the SKU value for the item (if any), listing recommendations (if applicable), the estimated fees for the relisted item (except the Final Value Fee, which isn't calculated until the item has sold), the start and end times of the listing, and other details.
The unique identifier for the relisted item. Note that the <b>ItemID</b> value changes when a listing is relisted, so this will not be the same <b>ItemID</b> value that was passed in the call request.
<br/><br/>
RelistItem
Always
This container consists of the estimated listing fees for the relisted item. Each type of fee is returned even if it is not appplicable (has a value of <code>0.0</code>. The Final Value Fee (FVF) is not in this container, as this value cannot be determined until a sale is made.
RelistItem
Always
This timestamp indicates the date and time when the relisted item became active on the eBay site.
RelistItem
Always
This timestamp indicates the date and time when the relisted item is scheduled to end on the eBay site. This date/time is calculated by using the <b>StartTime</b> and the the listing duration.
<br><br>
<span class="tablenote"><b>Note: </b>
Starting July 1, 2019, the Good 'Til Cancelled renewal schedule will be modified from every 30 days to once per calendar month. For example, if a GTC listing is created July 5, the next monthly renewal date will be August 5. If a GTC listing is created on the 31st of the month, but the following month only has 30 days, the renewal will happen on the 30th in the following month. Finally, if a GTC listing is created on January 29-31, the renewal will happen on February 28th (or 29th during a 'Leap Year'). See the
<a href="https://pages.ebay.com/seller-center/seller-updates/2019-spring/marketplace-updates.html#good-til-cancelled" target="_blank">Good 'Til Cancelled listings update</a> in the <b>Spring 2019 Seller Updates</b> for more information about this change.
</span>
RelistItem
Always
Unique identifier of the primary eBay category in which the item was relisted. This field is only returned if the <b>Item.CategoryMappingAllowed</b> field was included and set to <code>true</code> in the request and the category ID passed in the <b>Item.PrimaryCategory</b> field was mapped to a new category ID by eBay. If the primary category has not changed or it has expired with no replacement, this field is not returned.
<br/><br/>
10
RelistItem
Conditionally
Unique identifier of the secondary eBay category (if one was used) in which the item was relisted. This field is only returned if the <b>Item.CategoryMappingAllowed</b> field was included and set to <code>true</code> in the request and the category ID passed in the <b>Item.SecondaryCategory</b> field was mapped to a new category ID by eBay. If the secondary category has not changed or it has expired with no replacement, this field is not returned.
<br/><br/>
10
RelistItem
Conditionally
This field is returned if an eBay special offer or promotion is applicable to the listing.
RelistItem
Conditionally
Provides a list of products recommended by eBay which match the item information provided by the seller.
RelistItem
Conditionally
Container consisting of one or more <b>Recommendation</b> containers. Each <b>Recommendation</b> container provides a message to the seller on how a listing can be improved or brought up to standard in regards to top-rated seller/listing requirements, mandated or recommended Item Specifics, picture quality requirements, pricing and/or listing format recommendations, recommended keywords and/or Item Specifics in a Title, and/or a recommendation to offer fast handling (same-day handling or handling time of 1 day) and/or a free shipping option in order to qualify the listing for a Fast 'N Free badge.
<br><br>
This container is only returned if the <b>IncludeRecommendations</b>
flag was included and set to 'true' in the <b>RelistItem</b> request, and if
at least one listing recommendation exists for the newly relisted item. If
one or more listing recommendations are returned, it will be at the seller's
discretion about whether to revise the item based on eBay's listing
recommendation(s).
RelistItem
Conditionally
The call enables a user to remove one or more items from their Watch List. A user can view the items that they are currently watching by calling <b>GetMyeBayBuying</b>.
<br/><br/>
The user has the option of removing one or more single-variation listings, one or more product variations within a multiple-variation listing, or removing all items from the Watch List.
GetMyeBayBuying
The unique identifier of the item to be removed from the
user's Watch List. Multiple <b>ItemID</b> fields can be specified in the same request, but note that the <b>RemoveAllItems</b> field or <b>VariationKey</b> container cannot be specified if one or more <b>ItemID</b> fields are used.
<br/><br/>
RemoveFromWatchList
Conditionally
If this field is included and set to <code>true</code>, then all the items in the user's
Watch List are removed. Note that if the <b>RemoveAllItems</b> field is specified, one or more <b>ItemID</b> fields or the <b>VariationKey</b> cannot be used.
RemoveFromWatchList
Conditionally
This container is used if the user want to remove one or more product variations (within a multiple-variation listing) from the Watch List. Note that if the <b>VariationKey</b> container is used, one or more <b>ItemID</b> fields or the <b>RemoveAllItems</b> field cannot be used.
RemoveFromWatchList
Conditionally
The base response type for the <b>RemoveFromWatchList</b> call. The response includes the current count of items on the user's Watch List, as well as the maximum amount of items that can be on the user's Watch List at one time.
The current number of items in the user's Watch List (considering that the items specified in the call request were successfully removed).
RemoveFromWatchList
Always
The maximum number of items allowed in the user's Watch List. Currently this value is 300, and is the same for all sites and all users.
RemoveFromWatchList
Always
This call enables the seller to accept or decline a buyer's Best Offer on an item, or make a counter offer to the buyer's Best Offer. A seller can decline multiple Best Offers with one call, but the seller cannot accept or counter offer multiple Best Offers with one call. Best Offers are not applicable to auction listings.
<br/><br/>
<span class="tablenote"><b>Note: </b>
Historically, the Best Offer feature has not been available for auction listings, but beginning with Version 1027, sellers in the US, UK, and DE sites are able to offer the Best Offer feature in auction listings. The seller can offer Buy It Now or Best Offer in an auction listing, but not both.
</span>
GetBestOffers
Enabling Best Offer
http://developer.ebay.com/DevZone/guides/features-guide/default.html#development/Feature-BestOffer.html
The unique identifier of the listing to which the seller is responding to a Best Offer.
RespondToBestOffer
Yes
The unique identifier of a buyer's Best Offer for the order line item. This ID is created once the buyer makes a Best Offer. It is possible that a seller will get multiple Best Offers for an order line item, and if that seller would like to decline multiple/all of the Best Offers with one <b>RespondToBestOffer</b> call, the seller would pass in each of these identifiers in a separate <b>BestOfferID</b> field. However, the seller can only accept or counter offer one Best Offer at a time.
RespondToBestOffer
Yes
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. A seller can decline multiple Best Offers with one call, but the seller cannot accept or counter offer multiple Best Offers with one call.
RespondToBestOffer
Yes
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.
<br>
250
RespondToBestOffer
Conditionally
The seller inserts counter offer price into this field. This field is conditionally required and only applicable when the <b>Action</b> value is set to <code>Counter</code>, The counter offer price cannot exceed the Buy It Now price for a single quantity item. However, the dollar value in this field may exceed the Buy It Now price if the buyer is requesting or the seller is offering multiple quantity of the item (in a multiple-quantity listing). The quantity of the item must be specified in the <b>CounterOfferQuantity</b> field if the seller is making a counter offer.
RespondToBestOffer
Conditionally
The seller inserts the quantity of items in the counter offer into this field. This field is conditionally required and only applicable when the <b>Action</b> value is set to <code>Counter</code>, The counter offer price must be specified in the <b>CounterOfferPrice</b> field if the seller is making a counter offer. This price should reflect the quantity of items in the counter offer. So, if the seller's counter offer 'unit' price is 15 dollars, and the item quantity is '2', the dollar value passed into the <b>CounterOfferPrice</b> field would be <code>30.0</code>.
RespondToBestOffer
Conditionally
This is the base response type for the <b>RespondToBestOffer</b> call. Along with the standard output fields for Trading API calls, this type contains a <b>RespondToBestOffer</b> container that indicates whether or not the action specified in the call request (accept, decline, or counter offer) was successful.
The <b>BestOffer.CallStatus</b> value returned in this container will indicate whether or not the action specified in the call request (accept, decline, or counter offer) was successful. The accept and counter offer actions can only be applied toward a single Best Offer. However, multiple Best Offers on a listing can be declined with one call. All Best Offers must be successfully declined with the <b>RespondToBestOffer</b> call for the <b> BestOffer.CallStatus</b> value to be <code>Success</code>.
RespondToBestOffer
Always
Enables a seller to reply to Feedback that has been left for a user, or to post a
follow-up comment to a Feedback comment the user has left for someone else.
GetFeedback
A unique identifier for a Feedback record. Buying and selling partners
leave feedback for one another after the completion of an order.
Feedback is left at the order line item level, so a
Feedback comment for each order line item in a Combined Payment order is
expected from the buyer and seller. A unique <b>FeedbackID</b> is created
whenever a buyer leaves feedback for a seller, and vice versa. A
<b>FeedbackID</b> is created by eBay when feedback is left through the eBay
site, or through the <b>LeaveFeedback</b> call. <b>FeedbackIDs</b> can be retrieved
with the <b>GetFeedback</b> call. In the <b>RespondToFeedback</b> call, <b>FeedbackID</b> can
be used as an input filter to respond to a specific Feedback comment.
Since Feedback is always linked to a unique order line item, an
<b>ItemID</b>/<b>TransactionID</b> pair or an <b>OrderLineItemID</b> can also be used to
respond to a Feedback comment.
RespondToFeedback
Conditionally
Unique identifier for the eBay listing to which the user will be responding to Feedback. A listing can have multiple
order line items, but only one <b>ItemID</b> value. An <b>ItemID</b> can be
paired up with a corresponding <b>TransactionID</b> and used as an input filter
to respond to a Feedback comment in the <b>RespondToFeedback</b> call. Unless
the specific Feedback record is identified by a <b>FeedbackID</b> or an
<b>OrderLineItemID</b> in the request, an <b>ItemID</b>/<b>TransactionID</b> pair is
required.
RespondToFeedback
Conditionally
Unique identifier for an eBay order line item. A
<b>TransactionID</b> can be paired up with its corresponding <b>ItemID</b> and used as
an input filter to respond to a Feedback comment in the
<b>RespondToFeedback</b> call. Unless the specific Feedback record is
identified by a <b>FeedbackID</b> or an <b>OrderLineItemID</b> in the request, an
<b>ItemID</b>/<b>TransactionID</b> pair is required.
RespondToFeedback
No
The eBay user ID of the caller's order partner. The caller is either
replyting to or following up on this user's Feedback comment.
RespondToFeedback
Yes
Specifies whether the response is a reply or a follow-up to a Feedback
comment left by the user identified in the <b>TargetUserID</b> field.
RespondToFeedback
Yes
Textual comment that the user who is subject of feedback may leave in
response or rebuttal to the Feedback comment. Alternatively, when the
<b>ResponseType</b> is <b>FollowUp</b>, this value contains the text of the follow-up
comment.
<br>
80 (125 for the Taiwan site)
RespondToFeedback
Yes
<b>OrderLineItemID</b> is a unique identifier for an eBay order line item. Since Feedback is always linked to a
unique order line item, an <b>OrderLineItemID</b> can be used to respond
to a Feedback comment.
<br><br>
Unless an <b>ItemID</b>/<b>TransactionID</b> pair or a <b>FeedbackID</b> is used to identify
a Feedback record, the <b>OrderLineItemID</b> must be specified.
<br>
RespondToFeedback
Conditionally
Base response for the <b>RespondToFeedback</b>. This response will indicate the success or failure of the attempt to reply to Feedback that has been left for a user, or to post a follow-up comment to a Feedback comment a user has left for someone else. This response has no call-specific output fields.
Enables a seller to update the payment details, the shipping details,
and the status of an order.
CompleteSale
Processing Checkouts
https://developer.ebay.com/DevZone/guides/features-guide/default.html#development/Sales-Checkouts.html
Unique identifier for an eBay listing. A listing can have multiple order line items, but only one <b>ItemID</b> value. An <b>ItemID</b> value can be paired up with a corresponding <b>TransactionID</b> value to identify and order line item in a <b>ReviseCheckoutStatus</b> call.
<br><br>
Unless an <b>OrderLineItemID</b> value is used to identify a an order line item, or an <b>OrderID</b> value is used to identify an order, the <b>ItemID</b>/<b>TransactionID</b> pair must be specified.
<br><br>
If an <b>OrderID</b> or an <b>OrderLineItemID</b> value is specified, the <b>ItemID</b>/<b>TransactionID</b> pair is ignored if present in the same request.
<br/>
<br/>
It is also possible to identify an order line item with a
<b>ItemID</b>/<b>BuyerID</b> combination, but this is not the most ideal approach since an error is returned if there are multiple order line items for that combination.
<br/>
ReviseCheckoutStatus
Conditionally
Unique identifier for a sales transaction. This identifier is created as soon as there is a commitment to buy (bidder wins the auction, buyer clicks buy button, or buyer purchases item through <b>PlaceOffer</b> call). Since an auction listing can only have one sale/winning bidder during the duration of the listing, the <b>TransactionID</b> value for auction listings is always <code>0</code>. An <b>ItemID</b>/<b>TransactionID</b> pair can be used to identify an order line item in a <b>ReviseCheckoutStatus</b> call.
<br><br>
Unless an <b>OrderLineItemID</b> is used to identify an order line item,
or an <b>OrderID</b> value is used to identify an order, the <b>ItemID</b>/<b>TransactionID</b> pair must be
specified. For a multiple line item order, <b>OrderID</b>
should be used. If <b>OrderID</b> or <b>OrderLineItemID</b> are specified, the
<b>ItemID</b>/<b>TransactionID</b> pair is ignored if present in the same request.
<br>
ReviseCheckoutStatus
Conditionally
A unique identifier that identifies a single line item or multiple line item order.
<br><br>
If an <b>OrderID</b> is used in the request, the <b>OrderLineItemID</b> and
<b>ItemID</b>/<b>TransactionID</b> pair are ignored if they are specified in the same request.
<br><br>
<span class="tablenote"><b>Note: </b> As of June 2019, eBay has changed the format of order identifier values. The new format is a non-parsable string, globally unique across all eBay marketplaces, and consistent for both single line item and multiple line item orders. Unlike in the past, instead of just being known and exposed to the seller, these unique order identifiers will also be known and used/referenced by the buyer and eBay customer support.
<br><br>
For developers and sellers who are already integrated with the Trading API's order management calls, this change shouldn't impact your integration unless you parse the existing order identifiers (e.g., <b>OrderID</b> or <b>OrderLineItemID</b>), or otherwise infer meaning from the format (e.g., differentiating between a single line item order versus a multiple line item order). Because we realize that some integrations may have logic that is dependent upon the old identifier format, eBay is rolling out this Trading API change with version control to support a transition period of approximately 9 months before applications must switch to the new format completely.
<br><br>
During the transition period, for developers/sellers using a Trading WSDL older than Version 1113, they can use the <b>X-EBAY-API-COMPATIBILITY-LEVEL</b> HTTP header in API calls to control whether the new or old <b>OrderID</b> format is returned in call response payloads. To get the new <b>OrderID</b> format, the value of the <b>X-EBAY-API-COMPATIBILITY-LEVEL</b> HTTP header must be set to <code>1113</code>. During the transition period and even after, the new and old <b>OrderID</b> formats will still be supported/accepted in all Trading API call request payloads. After the transition period (which will be announced), only the new <b>OrderID</b> format will be returned in all Trading API call response payloads, regardless of the Trading WSDL version used or specified compatibility level.
</span>
<br>
<span class="tablenote"><b>Note: </b> For sellers integrated with the new order ID format, please note that the identifier for an order will change as it goes from unpaid to paid status. Sellers can check to see if an order has been paid by looking for a value of 'Complete' in the <b>CheckoutStatus.Status</b> field in the response of <b>GetOrders</b> or <b>GetOrderTransactions</b> call, or in the <b>Status.CompleteStatus</b> field in the response of <b>GetItemTransactions</b> or <b>GetSellerTransactions</b> call. Sellers should not fulfill orders until buyer has made payment. When using a <b>ReviseCheckoutStatus</b> call, either of these order IDs (paid or unpaid status) can be used to update an order. Similarly, either of these order IDs (paid or unpaid status) can be used in <b>GetOrders</b> or <b>GetOrderTransactions</b> call to retrieve specific order(s).
</span>
40
ReviseCheckoutStatus
No
The total amount paid by the buyer. For a motor vehicle listing that requires a deposit, the <b>AmountPaid</b> value is the total amount paid by the buyer for the deposit. <b>AmountPaid</b> is optional if <b>CheckoutStatus</b> is <code>Incomplete</code> and required if it is <code>Complete</code>.
ReviseCheckoutStatus
Conditionally
Payment method used by the buyer. This field may be needed if the order payment between the buyer and seller happens off of eBay's platform. If the payment happens on eBay's platform, this field will not be necessary.
<br><br>
See eBay's
<a href="https://www.ebay.com/help/policies/payment-policies/accepted-payments-policy?id=4269" target="_blank">Accepted Payments Policy</a> for more information about safe offline payment methods. Accepted payment methods will vary by category and by country.
ReviseCheckoutStatus
Conditionally
This field is included and its value is set to <code>Complete</code> if the seller is using the <b>ReviseCheckoutStatus</b> call to mark the order as 'Paid' by including the <b>PaymentStatus</b> field and setting its value to <code>Paid</code>.
ReviseCheckoutStatus
Conditionally
Complete
The shipping service selected by the buyer from among the shipping services offered by the seller (such as UPS Ground). For a list of valid values, call <b>GeteBayDetails</b> with the <b>DetailName</b> field set to <code>ShippingServiceDetails</code>. The <b>ShippingServiceDetails.ValidForSellingFlow</b> flag must also be present in the response. Otherwise, that particular shipping service option is no longer valid and cannot be offered to buyers through a listing.
<br/><br/>
<span class="tablenote"> <strong>Note:</strong> This field should not be used for orders being shipping through the Global Shipping program; specifying <code>InternationalPriorityShipping</code> as a value for this field will produce an error. </span>
ShippingServiceCodeType
ReviseCheckoutStatus
No
This field is included and set to <code>true</code> if sales tax for the order is applied against shipping costs (in addition to the item cost).
ReviseCheckoutStatus
No
false
This field is deprecated.
This field is no longer applicable as it is not longer possible for a seller to offer a buyer shipping insurance.
1031
Avoid
1085
This field is used to mark the order as paid or awaiting payment in eBay's system. This field may be needed if the order payment between the buyer and seller happens off of eBay's platform. If the payment happens on eBay's platform, this field will not be necessary. A user specifies <code>Pending</code> to indicate that the order is awaiting payment or if the the buyer has initiated payment, but the funds have not yet been sent to the seller's financial institution.
ReviseCheckoutStatus
No
Paid, Pending
This field may be used if the buyer and seller have agreed on making an adjustment to the order total. A positive value indicates that the amount is an extra charge being paid to the seller by the buyer. A negative value indicates that the amount is a discount given to the buyer by the seller.
ReviseCheckoutStatus
No
For internal use only. Do not use.
1007
1085
NoOp
The eBay user ID for the order's buyer. A single line item order can actually be identified by a <b>BuyerID</b>/<b>ItemID</b> pair, but this approach is not recommended since an error may occur if there are multiple order line items between the buyer and seller. <b>BuyerID</b> is ignored if any other valid filter or filter combination is used in the same request.
ReviseCheckoutStatus
Conditionally
This field is no longer applicable as it is not longer possible for a seller to offer a buyer shipping insurance.
1031
Avoid
1085
This field is used if sales tax is being applied to the order. If the sales tax amount is also being applied to the shipping charges (in addition to the item cost), the <b>ShippingIncludedInTax</b> boolean field should be included in the call request and set to <code>true</code>.
ReviseCheckoutStatus
No
This field is used to show the cost of shipping being applied to the order.
ReviseCheckoutStatus
No
Not supported.
20
ReviseCheckoutStatus
No
This container is used if payment for the order occurred off of eBay, and the seller wants to pass in the external payment reference ID.
ReviseCheckoutStatus
No
Not supported.
ReviseCheckoutStatus
No
This dollar value indicates the money due from the buyer upon delivery of the item.
<br><br>
This field should only be specified in the <b>ReviseCheckoutStatus</b> request if 'COD' (cash-on-delivery) was the payment method selected by the buyer and it is included as the <b>PaymentMethodUsed</b> value in the same request.
ReviseCheckoutStatus
No
Specifying the Cash on Delivery Option in Shipping Details
http://developer.ebay.com/DevZone/guides/features-guide/default.html#development/Shipping-OtherFeatures.html#SpecifyingtheCashonDeliveryOptioninShipp
A unique identifier for an eBay order line item. This identifier is created once there is a commitment to buy (bidder wins the auction, buyer clicks buy button, or buyer purchases item through <b>PlaceOffer</b> call).
<br><br>
Unless an <b>ItemID</b>/<b>TransactionID</b> pair is used to identify an order line item, or the <b>OrderID</b> is used to identify an order, the <b>OrderLineItemID</b> must be specified. For a multiple line item order, <b>OrderID</b> should be used. If <b>OrderLineItemID</b> is specified, the <b>ItemID</b>/<b>TransactionID</b> pair are ignored if present in the same request.
ReviseCheckoutStatus
Conditionally
The response of a <b>ReviseCheckoutStatus</b> call only includes the standard response fields for Trading API calls, such as the <b>Ack</b> field (to indicate the success or failure of the call), the timestamp, and an <b>Errors</b> container (if there were any errors and/or warnings).
Enables a seller to revise a fixed-price listing on a specified eBay site. To revise an active listing, the seller specifies the <b>ItemID</b> value for the listing. The seller makes one or multiple changes to the listing through the <b>Item</b> container, and the seller can also use one or more <b>DeletedField</b> tags to remove an optional field/setting from the listing.
ReviseItem
Revising a Listing
https://developer.ebay.com/DevZone/guides/features-guide/default.html#development/Listings-Revising.html
The <b>Item</b> container is used to make changes to the active listing. The seller must pass in the <b>ItemID</b> value for the listing that is being revised. For anything else that the seller wishes to change, such as quantity or price, the seller should include this field in the call request and give it a new value.
<br/><br/>
If the seller wants to delete one or more optional settings in the listing, the seller should use the <b>DeletedField</b> tag.
ReviseFixedPriceItem
Yes
Specifies the name of a field to delete from a listing. The request can
contain zero, one, or many instances of <b>DeletedField</b> (one for each field
to be deleted). See the relevant field descriptions to determine when to
use <b>DeletedField</b> (and potential consequences).
<br><br>
You cannot delete required fields from a listing.
<br><br>
Some fields are optional when you first list an item (e.g.,
<b>SecondaryCategory</b>), but once they are set they cannot be deleted when you
revise an item. Some optional fields cannot be deleted if the item has
bids and/or ends within 12 hours. Some optional fields cannot be deleted
if other fields depend on them.
<br><br>
Some data (such as <b>Variation</b> nodes within the <b>Variations</b> container) can't be deleted by
using <b>DeletedField</b>. See the relevant field descriptions for how to delete
such data.
<br><br>
Use values that match the case of the
schema element names (<b>Item.PictureDetails.GalleryURL</b>) or make the initial
letter of each field name lowercase (<b>item.pictureDetails.galleryURL</b>).
However, do not change the case of letters in the middle of a field name.
For example, <b>item.picturedetails.galleryUrl</b> is not allowed.
<br><br>
To delete a listing enhancement like <b>BoldTitle</b>, specify the value you are
deleting in square brackets ("[ ]"); for example,
<b>Item.ListingEnhancement[BoldTitle]</b>.
ReviseFixedPriceItem
Conditionally
The base response type for the <b>ReviseFixedPriceItem</b> call. The response includes the Item ID for the revised item, the SKU value for the item (if any), listing recommendations (if applicable), the estimated fees for the revised item (except the Final Value Fee, which isn't calculated until the item has sold), the start and end times of the listing, and other details.
The unique identifier for the revised listing. Note that the <b>ItemID</b> value does not change when a listing is revised, so this will be the same <b>ItemID</b> value that was passed in the call request.
<br/><br/>
ReviseFixedPriceItem
Always
The seller-defined SKU value for the revised listing (if a SKU value exists for the item).
<br/><br/>
Note that variation-level SKU values will not be returned if a multiple-variation listing was revised. The seller would have to make a <b>GetItem</b> call to get variation-level SKU values.
ReviseFixedPriceItem
Conditionally
This timestamp indicates the date and time when the listing was created on the eBay site. This value doesn't change when a listing is revised.
ReviseFixedPriceItem
Always
Date and time when the revised listing is scheduled to end based on the listing's start time and the listing duration value that was set for the listing. If the listing duration is 'GTC' (Good 'Til Cancelled), this value will be updated to 30 days in the future if the listing is automatically renewed after 30 days. GTC listings are automatically renewed if quantity still exists for the item.
<br><br>
<span class="tablenote"><b>Note: </b>
Starting July 1, 2019, the Good 'Til Cancelled renewal schedule will be modified from every 30 days to once per calendar month. For example, if a GTC listing is created July 5, the next monthly renewal date will be August 5. If a GTC listing is created on the 31st of the month, but the following month only has 30 days, the renewal will happen on the 30th in the following month. Finally, if a GTC listing is created on January 29-31, the renewal will happen on February 28th (or 29th during a 'Leap Year'). See the
<a href="https://pages.ebay.com/seller-center/seller-updates/2019-spring/marketplace-updates.html#good-til-cancelled" target="_blank">Good 'Til Cancelled listings update</a> in the <b>Spring 2019 Seller Updates</b> for more information about this change.
</span>
ReviseFixedPriceItem
Always
This container consists of the estimated listing fees for the revised listing. Each type of fee is returned even if it is not appplicable (has a value of <code>0.0</code>. The Final Value Fee (FVF) is not in this container, as this value cannot be determined until a sale is made.
ReviseFixedPriceItem
Always
eBay.com Fees
http://pages.ebay.com/help/sell/fees.html
Fees per Site
http://developer.ebay.com/DevZone/guides/features-guide/default.html#development/IntlDiffs-Fees.html
Final Value Fees and Credits
http://developer.ebay.com/DevZone/guides/features-guide/default.html#development/Sales-Completing.html
Final Value Fees
http://pages.ebay.com/help/sell/fvf.html
Unique identifier of the primary eBay category for the revised listing. This field is returned if the primary category was changed with the revision, and the primary category can only be changed if a fixed-price listing has no sales, and the listing does not end within 12 hours.
<br/><br/>
This field can also be returned if the <b>Item.CategoryMappingAllowed</b> field was included and set to <code>true</code> in the request and the category ID passed in the <b>Item.PrimaryCategory</b> field was mapped to a new category ID by eBay. If the primary category has not changed or it has expired with no replacement, this field is not returned.
<br/>
10
ReviseFixedPriceItem
Conditionally
Unique identifier of the secondary eBay category for the revised listing. This field is returned if the secondary category was changed with the revision, and the secondary category can only be changed if a fixed-price listing has no sales, and the listing does not end within 12 hours.
<br/><br/>
This field can also be returned if the <b>Item.CategoryMappingAllowed</b> field was included and set to <code>true</code> in the request and the category ID passed in the <b>Item.PrimaryCategory</b> field was mapped to a new category ID by eBay. If the primary category has not changed or it has expired with no replacement, this field is not returned.
<br/>
10
ReviseFixedPriceItem
Conditionally
This field is returned if an eBay special offer or promotion is applicable to the listing.
ReviseFixedPriceItem
Conditionally
Provides a list of products recommended by eBay which match the item information provided by the seller.
ReviseFixedPriceItem
Conditionally
Container consisting of one or more <b>Recommendation</b> containers. Each <b>Recommendation</b> container provides a message to the seller on how a listing can be improved or brought up to standard in regards to top-rated seller/listing requirements, mandated or recommended Item Specifics, picture quality requirements, pricing and/or listing format recommendations, recommended keywords and/or Item Specifics in a Title, and/or a recommendation to offer fast handling (same-day handling or handling time of 1 day) and/or a free shipping option in order to qualify the listing for a Fast 'N Free badge.
<br><br>
This container is only returned if the <b>IncludeRecommendations</b>
flag was included and set to 'true' in the <b>ReviseFixedPriceItem</b> request, and if
at least one listing recommendation exists for the listing about to be revised. If
one or more listing recommendations are returned, it will be at the seller's
discretion about whether to revise the item again based on eBay's listing
recommendation(s).
ReviseFixedPriceItem
Conditionally
Enables a seller to change the price and/or quantity of one to four
active, fixed-price listings. The fixed-price listing to modify is identified with the <b>ItemID</b> of the listing and/or the <b>SKU</b> value of the item (if a seller-defined SKU value exists for the listing). If the seller is modifying one or more variations within a multiple-variation listing, the <b>ItemID</b> and <b>SKU</b> fields in the <b>InventoryStatus</b> container become required, with the <b>ItemID</b> value identifying the listing, and the <b>SKU</b> value identifying the specific product variation within that multiple-variation listing. Each variation within a multiple-variation listing requires a seller-defined SKU value.
<br/><br/>
Whether updating the price and/or quantity of a single-variation listing or a specific variation within a multiple-variation listing, the limit of items or item variations that can be modified with one call is four.
Enables a seller to change the price and/or quantity of one or more fixed-price listings (single-variation or multiple-variation).
ReviseItem
Revising a Listing
https://developer.ebay.com/DevZone/guides/features-guide/default.html#development/Listings-Revising.html
One <b>InventoryStatus</b> container is required for each item or item variation that is being revised. Whether updating the price and/or quantity of a single-variation listing or a specific variation within a multiple-variation listing, the limit of items or item variations that can be modified with one call is four.
ReviseInventoryStatus
Yes
4
The base response type for the <b>ReviseInventoryStatus</b> call. The response includes a <b>Fees</b> container and an <b>InventoryStatus</b> container for each item and/or item variation that was revised.
One <b>InventoryStatus</b> container is returned for each item or item variation that was revised. Whether updating the price and/or quantity of a single-variation listing or a specific variation within a multiple-variation listing, the limit of items or item variations that can be modified with one call is four.
<br>
<br>
Note that all four elements of this container are returned even if these fields would not supplied in the call request. The <b>SKU</b> field is returned as an empty tag if it is not defined for a single-variation listing.
StartTime, EndTime
ReviseInventoryStatus
Always
4
A <b>Fees</b> container is returned for each fixed-price listing that was modified with the <b>ReviseInventoryStatus</b> call. This container consists of the estimated listing fees for the revised listing, and the listing is identified in the <b>ItemID</b> field. Each type of fee is returned even if it is not appplicable (has a value of <code>0.0</code>. The Final Value Fee (FVF) is not in this container, as this value cannot be determined until a sale is made. Note that these fees are at the listing level, so if multiple variations within a multiple-variation listing were modified, the fees in this container would be cumulative totals, and would not single out the fees associated with each modified item variation.
<br>
<br>
Please note that since fees are returned at the listing level, it is possible that the response will include one <b>Fees</b> container and four <b>InventoryStatus</b> containers if you made revisions to four different item variations within the same multiple-variation listing.
ReviseInventoryStatus
4
Always
eBay.com Fees
http://pages.ebay.com/help/sell/fees.html
Fees per Site
http://developer.ebay.com/DevZone/guides/features-guide/default.html#development/IntlDiffs-Fees.html
Final Value Fees and Credits
http://developer.ebay.com/DevZone/guides/features-guide/default.html#development/Sales-Completing.html
Final Value Fees
http://pages.ebay.com/help/sell/fvf.html
Enables a seller to revise a listing on a specified eBay site. To revise an active listing, the seller specifies the <b>ItemID</b> value for the listing. The seller makes one or multiple changes to the listing through the <b>Item</b> container, and the seller can also use one or more <b>DeletedField</b> tags to remove an optional field/setting from the listing.
<br>
<br>
After a multiple-quantity, fixed-price listing has one or more sales, or less than 12 hours remain before the listing is scheduled to end, you can not edit the values in the Listing Title, Primary Category, Secondary Category, Listing Duration, and Listing Type fields for that listing. The same applies to an auction listing that has at least one bid.
<br>
<br>
To revise a multiple-variation, fixed-price listing, the <b>ReviseFixedPriceItem</b> call should be used instead, as the <b>ReviseItem</b> call does not support variation-level edits.
ReviseFixedPriceItem, ReviseInventoryStatus
Revising a Listing
https://developer.ebay.com/DevZone/guides/features-guide/default.html#development/Listings-Revising.html
The <b>Item</b> container is used to make changes to the active listing. The seller must pass in the <b>ItemID</b> value for the listing that is being revised. For anything else that the seller wishes to change, such as quantity or price, the seller should include this field in the call request and give it a new value.
<br/><br/>
If the seller wants to delete one or more optional settings in the listing, the seller should use the <b>DeletedField</b> tag.
ReviseItem
Yes
Specifies the name of a field to delete from a listing. The request can
contain zero, one, or many instances of <b>DeletedField</b> (one for each field
to be deleted). See the relevant field descriptions to determine when to
use <b>DeletedField</b> (and potential consequences).
<br><br>
You cannot delete required fields from a listing.
<br><br>
Some fields are optional when you first list an item (e.g.,
<b>SecondaryCategory</b>), but once they are set they cannot be deleted when you
revise an item. Some optional fields cannot be deleted if the item has
bids and/or ends within 12 hours. Some optional fields cannot be deleted
if other fields depend on them.
<br><br>
Use values that match the case of the
schema element names (<b>Item.PictureDetails.GalleryURL</b>) or make the initial
letter of each field name lowercase (<b>item.pictureDetails.galleryURL</b>).
However, do not change the case of letters in the middle of a field name.
For example, <b>item.picturedetails.galleryUrl</b> is not allowed.
<br><br>
To delete a listing enhancement like <b>BoldTitle</b>, specify the value you are
deleting in square brackets ("[ ]"); for example,
<b>Item.ListingEnhancement[BoldTitle]</b>.
ReviseItem
No
When the <b>VerifyOnly</b> is included and set as <code>true</code>, the active listing is not actually revised, but the same response is returned and the seller gets to see the expected fees based on the changes made, and can also view any listing recommendations if the <b>Item.IncludeRecommedations</b> boolean field is included and set to <code>true</code>.
ReviseItem
No
The base response type for the <b>ReviseItem</b> call. The response includes the Item ID for the revised item, the SKU value for the item (if any), listing recommendations (if applicable), the estimated fees for the revised item (except the Final Value Fee, which isn't calculated until the item has sold), the start and end times of the listing, and other details.
The unique identifier for the revised listing. Note that the <b>ItemID</b> value does not change when a listing is revised, so this will be the same <b>ItemID</b> value that was passed in the call request.
<br/><br/>
ReviseItem
Always
This timestamp indicates the date and time when the listing was created on the eBay site. This value doesn't change when a listing is revised.
ReviseItem
Always
Date and time when the revised listing is scheduled to end based on the listing's start time and the listing duration value that was set for the listing. If the listing duration is 'GTC' (Good 'Til Cancelled), this value will be updated to 30 days in the future if the listing is automatically renewed after 30 days. GTC listings are automatically renewed if quantity still exists for the item. Note that GTC is not applicable to auction listings.
<br><br>
<span class="tablenote"><b>Note: </b>
Starting July 1, 2019, the Good 'Til Cancelled renewal schedule will be modified from every 30 days to once per calendar month. For example, if a GTC listing is created July 5, the next monthly renewal date will be August 5. If a GTC listing is created on the 31st of the month, but the following month only has 30 days, the renewal will happen on the 30th in the following month. Finally, if a GTC listing is created on January 29-31, the renewal will happen on February 28th (or 29th during a 'Leap Year'). See the
<a href="https://pages.ebay.com/seller-center/seller-updates/2019-spring/marketplace-updates.html#good-til-cancelled" target="_blank">Good 'Til Cancelled listings update</a> in the <b>Spring 2019 Seller Updates</b> for more information about this change.
</span>
ReviseItem
Always
This container consists of the estimated listing fees for the revised listing. Each type of fee is returned even if it is not appplicable (has a value of <code>0.0</code>. The Final Value Fee (FVF) is not in this container, as this value cannot be determined until a sale is made.
ReviseItem
Always
Unique identifier of the primary eBay category for the revised listing. This field is returned if the primary category was changed with the revision, and the primary category can only be changed if a fixed-price listing has no sales/auction listing has no bids, and the listing does not end within 12 hours.
<br/><br/>
This field can also be returned if the <b>Item.CategoryMappingAllowed</b> field was included and set to <code>true</code> in the request and the category ID passed in the <b>Item.PrimaryCategory</b> field was mapped to a new category ID by eBay. If the primary category has not changed or it has expired with no replacement, this field is not returned.
<br/><br/>
10
ReviseItem
Conditionally
Unique identifier of the secondary eBay category for the revised listing. This field is returned if the secondary category was changed with the revision, and the secondary category can only be changed if a fixed-price listing has no sales/auction listing has no bids, and the listing does not end within 12 hours.
<br/><br/>
This field can also be returned if the <b>Item.CategoryMappingAllowed</b> field was included and set to <code>true</code> in the request and the category ID passed in the <b>Item.PrimaryCategory</b> field was mapped to a new category ID by eBay. If the primary category has not changed or it has expired with no replacement, this field is not returned.
<br/><br/>
10
ReviseItem
Conditionally
This field is returned if the <b>VerifyOnly</b> field was included in the call request and set to <code>true</code>.
<br/><br/>
If the listing was revised in 'Verify Only' mode, the active listing is not actually revised, but the same response is returned and the seller gets to see the expected fees based on the changes made, and can also view any listing recommendations if the <b>Item.IncludeRecommedations</b> boolean input field was included and set to <code>true</code>.
ReviseItem
Conditionally
This field is returned if an eBay special offer or promotion is applicable to the listing.
ReviseItem
Conditionally
Provides a list of products recommended by eBay which match the item information
provided by the seller.
ReviseItem
Conditionally
Container consisting of one or more <b>Recommendation</b> containers. Each <b>Recommendation</b> container provides a message to the seller on how a listing can be improved or brought up to standard in regards to top-rated seller/listing requirements, mandated or recommended Item Specifics, picture quality requirements, pricing and/or listing format recommendations, recommended keywords and/or Item Specifics in a Title, and/or a recommendation to offer fast handling (same-day handling or handling time of 1 day) and/or a free shipping option in order to qualify the listing for a Fast 'N Free badge.
<br><br>
This container is only returned if the <b>IncludeRecommendations</b> flag was included and set to 'true' in the <b>ReviseItem</b> request, and if at least one listing recommendation exists for the listing about to be revised. If one or more listing recommendations are returned, it will be at the seller's discretion about whether to revise the item again based on eBay's listing recommendation(s).
ReviseItem
Conditionally
This call can be used to mark one or more messages as 'Read', to flag one or more messages, and/or to move one or more messages to another My Messages folder. Any of these actions can be applied on up to 10 messages with one call.
GetMyMessages
This container is used to specify up to 10 messages (specified with their <b>MessageID</b> values) on which to perform on or more actions. At least one <b>MessageID</b> value must be included in the request. <b>MessageID</b> values can be retrieved with the <b>GetMyMessages</b> call with the <b>DetailLevel</b> value set to <code>ReturnHeaders</code>.
<br>
<br>
<span class="tablenote"><b>Note:</b> Messages in the Sent folder of My Messages cannot be moved, marked as read, or flagged. </span>
ReviseMyMessages
Yes
This field is deprecated.
This boolean field is used to change the 'Read' status of the message(s) in the <b>MessageIDs</b> container. Including this field and setting its value to <code>true</code> will mark all messages in the <b>MessageIDs</b> container as 'Read'. Conversely, including this field and setting its value to <code>false</code> will mark all messages in the <b>MessageIDs</b> container as 'Unread'. The 'Read' status of a message can be retrieved by looking at the <b>Message.Read</b> boolean field of the <b>GetMyMessages</b> call response.
<br>
<br>
In each <b>ReviseMyMessages</b> call, at least one of the following fields must be specified in the request: <b>Read</b>, <b>Flagged</b>, and <b>FolderID</b>.
<br>
<br>
<span class="tablenote"><b>Note:</b> Messages in the Sent folder of My Messages cannot be moved, marked as read, or flagged. </span>
ReviseMyMessages
Conditionally
This boolean field is used to change the 'Flagged' status of the message(s) in the <b>MessageIDs</b> container. Including this field and setting its value to <code>true</code> will flag all messages in the <b>MessageIDs</b> container. Conversely, including this field and setting its value to <code>false</code> will unflag all messages in the <b>MessageIDs</b> container. The 'Flagged' status of a message can be retrieved by looking at the <b>Message.Flagged</b> boolean field of the <b>GetMyMessages</b> call response.
<br>
<br>
In each <b>ReviseMyMessages</b> call, at least one of the following fields must be specified in the request: <b>Read</b>, <b>Flagged</b>, and <b>FolderID</b>.
<br>
<br>
<span class="tablenote"><b>Note:</b> Messages in the Sent folder of My Messages cannot be moved, marked as read, or flagged. </span>
ReviseMyMessages
Conditionally
A unique identifier of My Messages folder. A <b>FolderID</b> value is supplied if the user want to move the message(s) in the <b>MessageIDs</b> container to a different folder. <b>FolderID</b> values can be retrieved with the <b>GetMyMessages</b> call with the <b>DetailLevel</b> value set to <code>ReturnSummary</code>. <br>
<br>
In each <b>ReviseMyMessages</b> call, at least one of the following fields must be specified in the request: <b>Read</b>, <b>Flagged</b>, and <b>FolderID</b>.
<br>
<br>
<span class="tablenote"><b>Note:</b> Messages in the Sent folder of My Messages cannot be moved, marked as read, or flagged. </span>
ReviseMyMessages
Conditionally
The response of a <b>ReviseMyMessages</b> call only includes the standard response fields for Trading API calls, such as the <b>Ack</b> field (to indicate the success or failure of the call), the timestamp, and an <b>Errors</b> container (if there were any errors and/or warnings).
This call can be used to add, remove, or rename a custom folder in <b>My eBay Messages</b>. Note that the Inbox and Sent folders cannot be removed or renamed in <b>My eBay Messages</b>.
<br/><br/>
A user can have up to 10 custom folders in <b>My eBay Messages</b>, and it is possible to add, remove, or rename up to 10 custom folders with one <b>ReviseMyMessagesFolders</b> call
GetMyMessages
This required field is used to indicate the type of operation to perform (add, remove, or rename a folder). See the enumeration descriptions below for more information on the usage, requirements, and limitations on each operation.
ReviseMyMessagesFolders
Yes
The eBay-generated unique identifier for a custom folder in <b>My eBay Messages</b>. The <b>FolderID</b> value is required for the 'Rename' and 'Remove' operations, but not for the 'Display' (add) operation. <b>FolderID</b> values can be retrieved by calling <b>GetMyMessages</b> with a <b>DetailLevel</b> value set to <code>ReturnSummary</code>, or the <b>FolderID</b> value for a <b>My eBay Messages</b> folder can be seen at the end of the browser's URL field when you navigate to that folder in <b>My eBay Messages</b>.
<br/><br/>
<span class="tablenote"><b>Note: </b> If multiple folders will be renamed with one call, the user must pay close attention to the order of the <b>FolderID</b> and <b>FolderName</b> fields, as eBay will process these requests in order according to the placement of the the <b>FolderID</b> and <b>FolderName</b> fields. So, the existing folder identified by the first <b>FolderID</b> field in the request payload will get renamed to the folder name passed into the first <b>FolderName</b> field in the request payload, and so on.
</span>
10
ReviseMyMessagesFolders
Conditionally
The user-specified name of the <b>My eBay Messages</b> folder. The <b>FolderName</b> value is required for the 'Display' (add) and 'Rename' operations, but not for the 'Remove' operation. In a 'Display' (add) operation, the name passed into the <b>FolderName</b> field is the name of the new folder. In a 'Rename' operation, the name passed into the <b>FolderName</b> field will be the new name of the existing folder that is specified through the corresponding <b>FolderID</b> field.
<br/><br/>
<b>FolderName</b> values can be retrieved by calling <b>GetMyMessages</b> with a <b>DetailLevel</b> value set to <code>ReturnSummary</code>, or the <b>FolderName</b> value for a <b>My eBay Messages</b> folder can be seen when you navigate to <b>My eBay Messages</b>.
<br/><br/>
<span class="tablenote"><b>Note: </b> If multiple folders will be renamed with one call, the user must pay close attention to the order of the <b>FolderID</b> and <b>FolderName</b> fields, as eBay will process these requests in order according to the placement of the the <b>FolderID</b> and <b>FolderName</b> fields. So, the existing folder identified by the first <b>FolderID</b> field in the request payload will get renamed to the folder name passed into the first <b>FolderName</b> field in the request payload, and so on.
</span>
15
10
ReviseMyMessagesFolders
Conditionally
The response of a <b>ReviseMyMessagesFolders</b> call only includes the standard response fields for Trading API calls, such as the <b>Ack</b> field (to indicate the success or failure of the call), the timestamp, and an <b>Errors</b> container (if there were any errors and/or warnings).
This call is uses to rename and/or move a Selling Manager Inventory folder.
This call is subject to change without notice; the deprecation process is
inapplicable to this call. The user must have a Selling Manager Pro subscription to use this call.
Revises the name of a Selling Manager Inventory folder.
GetSellingManagerInventoryFolder
Using Selling Manager Calls in the Trading API
https://developer.ebay.com/DevZone/guides/features-guide/default.html#development/Listings-SellingManager.html
Selling Manager Pro page on the eBay Site
https://pages.ebay.com/help/sell/sm-getting-started.html
This container is used to identify the Selling Manager Inventory folder that will be renamed and/or moved.
ReviseSellingManagerInventoryFolder
Yes
Returns the status of a revise folder operation.
This container will show the results of the action made on the Selling Manager Inventory folder.
ReviseSellingManagerInventoryFolder
Always
Revises a Selling Manager Product.
<br><br>
This call is subject to change without notice; the
deprecation process is inapplicable to this call. The user must have a Selling Manager Pro subscription to use this call.
Using Selling Manager Calls in the Trading API
https://developer.ebay.com/DevZone/guides/features-guide/default.html#development/Listings-SellingManager.html
Selling Manager Pro page on the eBay Site
https://pages.ebay.com/help/sell/sm-getting-started.html
The details of the product that is being revised.
ReviseSellingManagerProduct
Yes
The details of the folder for this product.
ReviseSellingManagerProduct
Conditionally
Specifies the name of a field to remove from a Selling Manager product.
The request can contain zero, one, or many instances of DeletedField (one for each field to be removed).
DeletedField accepts the following path names, which remove the corresponding fields:<br><br>
SellingManagerProductDetails.CustomLabel<br>
SellingManagerProductDetails.QuantityAvailable<br>
SellingManagerProductDetails.UnitCost<br>
These values are case-sensitive. Use values that match the case of the schema element names.
ReviseSellingManagerProduct
Conditionally
Specifies an eBay category associated with the product,
defines Item Specifics that are relevant to the product,
and defines variations available for the product
(which may be used to create multi-variation listings).
ReviseSellingManagerProduct
Yes
Response for revising a Selling Manager product.
The details of the product.
ReviseSellingManagerProduct
Always
Request type containing the input fields for the <b>ReviseSellingManagerSaleRecord</b>
call. The standard Trading API deprecation process is not applicable to this
call. The user must have a Selling Manager Pro subscription to use this call.
This call is used to revise a Selling Manager Sale Record. A Selling Manager Pro subscription is required to use this call.
GetSellingManagerSaleRecord
Using Selling Manager Calls in the Trading API
https://developer.ebay.com/DevZone/guides/features-guide/default.html#development/Listings-SellingManager.html
Selling Manager Pro page on the eBay Site
https://pages.ebay.com/help/sell/sm-getting-started.html
Unique identifier for an eBay listing. A listing can have multiple
order line items, but only one <b>ItemID</b> value. An <b>ItemID</b> can be
paired up with a corresponding <b>TransactionID</b> and used as an input filter
for <b>ReviseSellingManagerSaleRecord</b>. The <b>ItemID</b>/<b>TransactionID</b> pair
corresponds to a Selling Manager <b>SaleRecordID</b>, which can be retrieved
with the <b>GetSellingManagerSaleRecord</b> call.
<br><br>
Unless an <b>OrderLineItemID</b> is used to identify an order line item,
or the <b>OrderID</b> is used to identify an order, the <b>ItemID</b>/<b>TransactionID</b> pair must be
specified. If <b>OrderID</b> or <b>OrderLineItemID</b> are specified, the
<b>ItemID</b>/<b>TransactionID</b> pair is ignored if present in the same request.
ReviseSellingManagerSaleRecord
Conditionally
Unique identifier for an eBay sales transaction. This identifier is created once there is a commitment to buy (bidder wins the auction, buyer clicks buy button, or buyer purchases item through <b>PlaceOffer</b> call). Since an auction listing can only have one sales transaction during the duration of the listing, the <b>TransactionID</b> value for auction listings is always <code>0</code>.
<br><br>
The <b>ItemID</b>/<b>TransactionID</b> pair can be
used to identify an order line item in a <b>ReviseSellingManagerSaleRecord</b> call. The
<b>ItemID</b>/<b>TransactionID</b> pair corresponds to a Selling Manager <b>SaleRecordID</b>,
which can be retrieved with the <b>GetSellingManagerSaleRecord</b> call.
<br><br>
Unless an <b>OrderLineItemID</b> is used to identify an order line item,
or the <b>OrderID</b> is used to identify an order, the <b>ItemID</b>/<b>TransactionID</b> pair must be
specified. If <b>OrderID</b> or <b>OrderLineItemID</b> are specified, the
<b>ItemID</b>/<b>TransactionID</b> pair is ignored if present in the same request.
ReviseSellingManagerSaleRecord
Conditionally
A unique identifier that identifies a single line item or multiple line item order associated with the Selling Manager sale record(s).
<br><br>
If an <b>OrderID</b> is used in the request, the <b>OrderLineItemID</b> and
<b>ItemID</b>/<b>TransactionID</b> pair are ignored if they are specified in the same request.
<br><br>
<span class="tablenote"><b>Note: </b> As of June 2019, eBay has changed the format of order identifier values. The new format is a non-parsable string, globally unique across all eBay marketplaces, and consistent for both single line item and multiple line item orders. Unlike in the past, instead of just being known and exposed to the seller, these unique order identifiers will also be known and used/referenced by the buyer and eBay customer support.
<br><br>
For developers and sellers who are already integrated with the Trading API's order management calls, this change shouldn't impact your integration unless you parse the existing order identifiers (e.g., <b>OrderID</b> or <b>OrderLineItemID</b>), or otherwise infer meaning from the format (e.g., differentiating between a single line item order versus a multiple line item order). Because we realize that some integrations may have logic that is dependent upon the old identifier format, eBay is rolling out this Trading API change with version control to support a transition period of approximately 9 months before applications must switch to the new format completely.
<br><br>
During the transition period, for developers/sellers using a Trading WSDL older than Version 1113, they can use the <b>X-EBAY-API-COMPATIBILITY-LEVEL</b> HTTP header in API calls to control whether the new or old <b>OrderID</b> format is returned in call response payloads. To get the new <b>OrderID</b> format, the value of the <b>X-EBAY-API-COMPATIBILITY-LEVEL</b> HTTP header must be set to <code>1113</code>. During the transition period and even after, the new and old <b>OrderID</b> formats will still be supported/accepted in all Trading API call request payloads. After the transition period (which will be announced), only the new <b>OrderID</b> format will be returned in all Trading API call response payloads, regardless of the Trading WSDL version used or specified compatibility level.
</span>
<br>
<span class="tablenote"><b>Note: </b> For sellers integrated with the new order ID format, please note that the identifier for an order will change as it goes from unpaid to paid status. When using a <b>ReviseSellingManagerSaleRecord</b> call, either of these order IDs (paid or unpaid status) can be used to update a Sale Record.
</span>
40
ReviseSellingManagerSaleRecord
Conditionally
Container consisting of order costs, shipping details, order status, and
other information. The changes made under this container will update the
order in Selling Manager.
ReviseSellingManagerSaleRecord
Conditionally
A unique identifier for an eBay order line item. This identifier is created once there is a commitment to buy (bidder wins the auction, buyer clicks buy button, or buyer purchases item through <b>PlaceOffer</b> call).
<br><br>
Unless an <b>ItemID</b>/<b>TransactionID</b> pair is used to identify an order line item, or the <b>OrderID</b> is used to identify an order, the <b>OrderLineItemID</b> must be specified. For a multiple line item order, <b>OrderID</b> should be used. If <b>OrderLineItemID</b> is specified, the <b>ItemID</b>/<b>TransactionID</b> pair are ignored if present in the same request.
ReviseSellingManagerSaleRecord
Conditionally
The base response of the <b>ReviseSellingManagerSaleRecord</b> call.
Revises a Selling Manager template.
This call is subject to change without notice; the
deprecation process is inapplicable to this call. The user must have a Selling Manager Pro subscription to use this call.
GetSellingManagerTemplates
Using Selling Manager Calls in the Trading API
https://developer.ebay.com/DevZone/guides/features-guide/default.html#development/Listings-SellingManager.html
Selling Manager Pro page on the eBay Site
https://pages.ebay.com/help/sell/sm-getting-started.html
The unique identifier of the Selling Manager template. You can obtain a
<b>SaleTemplateID</b> value by calling <b>GetSellingManagerInventory</b>.
ReviseSellingManagerTemplate
Yes
Reserved for future use.
The name of the Selling Manager template.
ReviseSellingManagerTemplate
No
This container is used to modify the Selling Manager template. In the <b>Item.ItemID</b> field, you specify the same value as the
one specified in <b>SaleTemplateID</b>.
Other child elements hold the values for properties that are being changed.
Set values in the Item object only for those properties that are
changing. Use <b>DeletedField</b> to remove a property.
ReviseSellingManagerTemplate
Yes
Specifies the name of a field to remove from a template.
See the eBay Web Services guide for rules on removing values when revising items.
Also see the relevant field descriptions to determine when to use DeletedField (and potential consequences).
The request can contain zero, one, or many instances of DeletedField (one for each field to be removed).
DeletedField accepts the following path names, which remove the corresponding fields:
<br><br>
Item.ApplicationData<br>
Item.AttributeSetArray<br>
Item.ConditionID<br>
Item.ItemSpecifics<br>
Item.ListingCheckoutRedirectPreference.ProStoresStoreName<br>
Item.ListingCheckoutRedirectPreference.SellerThirdPartyUsername<br>
Item.ListingDesigner.LayoutID<br>
Item.ListingDesigner.ThemeID<br>
Item.ListingEnhancement[Value]<br>
Item.PayPalEmailAddress<br>
Item.PictureDetails.GalleryURL<br>
Item.PictureDetails.PictureURL<br>
Item.PostalCode<br>
Item.ProductListingDetails<br>
item.ShippingDetails.PaymentInstructions<br>
item.SKU<br>
Item.SubTitle<br><br>
These values are case-sensitive. Use values that match the case of the schema element names
(Item.PictureDetails.GalleryURL) or make the initial letter of each field name lowercase (item.pictureDetails.galleryURL).
However, do not change the case of letters in the middle of a field name (e.g., item.picturedetails.galleryUrl is not allowed).
<br><br>
Depending on how you have configured your pictures, you cannot necessarily delete
both GalleryURL and PictureURL from an existing listing.
If GalleryType was already set for the item you are revising, you cannot remove it.
This means you still need to include either a first picture
or a gallery URL in your revised listing.
ReviseSellingManagerTemplate
Conditionally
Use this field to verify the template instead of revising it.
ReviseSellingManagerTemplate
No
Returns the template ID and the estimated fees for the revised listing.
This sale template ID uniquely identifies the template that was revised
in the request. This sale template ID should match the
template ID specified in the request.
specified for the call.
ReviseSellingManagerTemplate
Always
Child elements contain the estimated listing fees for the revised item
listing. The fees do not include the Final Value Fee (FVF), which cannot
be determined until an item is sold. Revising an item does not itself
incur a fee. However, certain item properties are fee-based and result
in the return of fees in the call's response.
ReviseSellingManagerTemplate
Always
ID of the primary category in which the item was listed.
Only returned if you set Item.CategoryMappingAllowed to true in the request
and the ID passed in Item.PrimaryCategory was mapped to a new ID by eBay.
If the primary category has not changed or it has expired with no replacement,
CategoryID does not return a value.
ReviseSellingManagerTemplate
Conditionally
ID of the secondary category in which the item was listed.
Only returned if you set Item.CategoryMappingAllowed to true in the request
and the ID passed in Item.SecondaryCategory was mapped to a new ID by eBay.
If the secondary category has not changed or it has expired with no replacement,
Category2ID does not return a value.
ReviseSellingManagerTemplate
Conditionally
Instead of revising, only verifies the template.
ReviseSellingManagerTemplate
Always
The name of the sale template.
ReviseSellingManagerTemplate
Always
The details of the product that this template belongs to.
ReviseSellingManagerTemplate
Always
Revokes a token before it would otherwise expire.
Cancels notification subscriptions for the user/application if set to true. Default value is false.
RevokeToken
No
The response of a <b>RevokeToken</b> call only includes the standard response fields for Trading API calls, such as the <b>Ack</b> field (to indicate the success or failure of the call), the timestamp, and an <b>Errors</b> container (if there were any errors and/or warnings).
Creates a Selling Manager template based on an existing eBay listing.
This call is subject to change without notice; the
deprecation process is inapplicable to this call. The user must have a Selling Manager Pro subscription to use this call.
Using Selling Manager Calls in the Trading API
https://developer.ebay.com/DevZone/guides/features-guide/default.html#development/Listings-SellingManager.html
Selling Manager Pro page on the eBay Site
https://pages.ebay.com/help/sell/sm-getting-started.html
The unique identifier of the eBay listing which should be used as a model to create the Selling Manager template and save it to Selling Manager inventory.
SaveItemToSellingManagerTemplate
Yes
Associates the new template with a product.
SaveItemToSellingManagerTemplate
Yes
Name associated with the template. If no name is submitted, the template will be named automatically.
SaveItemToSellingManagerTemplate
Yes
The base response of the <b>SaveItemToSellingManagerTemplate</b> call. A successful call will return a <b>TemplateID</b> value for the newly-created Selling Manager template.
The unique identifier of the newly-created Selling Manager template. As long as the call was successful, this field is always returned.
SaveItemToSellingManagerTemplate
Always
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. If this action is successful, the seller receives a Final Value Fee
credit and the buyer's Unpaid Item strike are both reversed, if applicable.
The dispute might have resulted
in a strike to the buyer and a Final Value Fee credit to the seller. A buyer and
seller sometimes come to agreement after a dispute has been closed. In particular,
the seller might discover that the buyer actually paid, or the buyer might agree
to pay the seller's fees in exchange for having the strike removed.
<br><br>
A dispute can only be reversed if it was closed with <b>DisputeActivity</b> set to
<b>SellerEndCommunication</b>, <b>CameToAgreementNeedFVFCredit</b>, or
<b>MutualAgreementOrNoBuyerResponse</b>.
Enables a seller to "reverse" an Unpaid Item dispute that has been
closed, for example, if buyer and seller reach an agreement.
The seller's Final Value Fee credit and the buyer's strike are both reversed.
if applicable.
GetUserDisputes
Reversing a Closed Unpaid Item Dispute
https://developer.ebay.com/DevZone/guides/features-guide/default.html#development/UPI-DisputesReversing.html
Unpaid Item Disputes
https://developer.ebay.com/DevZone/guides/features-guide/default.html#development/UPI-Disputes.html
The unique identifier of the dispute that was returned when the dispute was created.
The dispute must be an Unpaid Item dispute that the seller opened.
SellerReverseDispute
Yes
The reason the dispute is being reversed.
SellerReverseDispute
Yes
The response of a <b>SellerReverseDispute</b> call only includes the standard response fields for Trading API calls, such as the <b>Ack</b> field (to indicate the success or failure of the call), the timestamp, and an <b>Errors</b> container (if there were any errors and/or warnings).
Enables a seller to send an order invoice to a buyer. Where applicable, updates
to shipping, payment methods, and sales tax made in this request are applied to
the specified order as a whole and to the individual order line items whose data
are stored in individual <b>Transaction</b> objects.
Unique identifier for an eBay listing. Unless <b>OrderID</b> or
<b>OrderLineItemID</b> is provided in the request, the <b>ItemID</b> (or <b>SKU</b>) is
required and must be paired with the corresponding <b>TransactionID</b> to
identify a single line item order. For a multiple line item order, <b>OrderID</b> should be used.
SendInvoice
Conditionally
Unique identifier for an eBay sales transaction. This identifier is created once there is a commitment from a buyer to purchase an item. Since an auction listing can only have one sales transaction during the duration of the listing, the <b>TransactionID</b> value for auction listings is always <code>0</code>. Unless <b>OrderID</b> or <b>OrderLineItemID</b> is provided in the request, the <b>TransactionID</b> is required and must be paired with the corresponding <b>ItemID</b> to identify a single line item order. For a multiple line item order, <b>OrderID</b> should be used.
SendInvoice
Conditionally
A unique identifier that identifies a single line item or multiple line
item order.
<br><br>
Unless the <b>ItemID</b> (or SKU) and corresponding <b>TransactionID</b>, or the <b>OrderLineItemID</b> is provided in the request to identify a single line item order, the <b>OrderID</b> must be specified. If <b>OrderID</b> is specified, <b>OrderLineItemID</b>, <b>ItemID</b>, <b>TransactionID</b>, and <b>SKU</b> are ignored if present in the same request.
<br><br>
<span class="tablenote"><b>Note: </b> As of June 2019, eBay has changed the format of order identifier values. The new format is a non-parsable string, globally unique across all eBay marketplaces, and consistent for both single line item and multiple line item orders. Unlike in the past, instead of just being known and exposed to the seller, these unique order identifiers will also be known and used/referenced by the buyer and eBay customer support.
<br><br>
For developers and sellers who are already integrated with the Trading API's order management calls, this change shouldn't impact your integration unless you parse the existing order identifiers (e.g., <b>OrderID</b> or <b>OrderLineItemID</b>), or otherwise infer meaning from the format (e.g., differentiating between a single line item order versus a multiple line item order). Because we realize that some integrations may have logic that is dependent upon the old identifier format, eBay is rolling out this Trading API change with version control to support a transition period of approximately 9 months before applications must switch to the new format completely.
<br><br>
During the transition period, for developers/sellers using a Trading WSDL older than Version 1113, they can use the <b>X-EBAY-API-COMPATIBILITY-LEVEL</b> HTTP header in API calls to control whether the new or old <b>OrderID</b> format is returned in call response payloads. To get the new <b>OrderID</b> format, the value of the <b>X-EBAY-API-COMPATIBILITY-LEVEL</b> HTTP header must be set to <code>1113</code>. During the transition period and even after, the new and old <b>OrderID</b> formats will still be supported/accepted in all Trading API call request payloads. After the transition period (which will be announced), only the new <b>OrderID</b> format will be returned in all Trading API call response payloads, regardless of the Trading WSDL version used or specified compatibility level.
</span>
<br>
<span class="tablenote"><b>Note: </b> For sellers integrated with the new order ID format, please note that the identifier for an order will change as it goes from unpaid to paid status. Sellers can check to see if an order has been paid by looking for a value of 'Complete' in the <b>CheckoutStatus.Status</b> field in the response of <b>GetOrders</b> or <b>GetOrderTransactions</b> call, or in the <b>Status.CompleteStatus</b> field in the response of <b>GetItemTransactions</b> or <b>GetSellerTransactions</b> call. When using a <b>SendInvoice</b> call, either of these order IDs (paid or unpaid status) can be used to update an order. Similarly, either of these order IDs (paid or unpaid status) can be used in <b>GetOrders</b> or <b>GetOrderTransactions</b> call to retrieve specific order(s).
</span>
40
SendInvoice
Conditionally
If the buyer has an International shipping address, use this container
to offer up to four International shipping services (or five if one of them is a Global Shipping Program service). If International
shipping services are offered, (domestic) <b>ShippingServiceOptions</b> should
not be included in the request.
<br>
SendInvoice
No
If the buyer has a domestic shipping address, use this container
to offer up to four domestic shipping services. If domestic
shipping services are offered, <b>InternationalShippingServiceOptions</b> should
not be included in the request.
<br>
SendInvoice
No
This container is used if the seller wishes to apply sales tax to the order. The amount of sales tax applied to the order is dependent on the sales tax rate in the buyer's state and whether sales tax is being applied to the cost of the order only or the cost of the order plus shipping and handling.
<br><br>
<span class="tablenote"><b>Note: </b> As of January 1, 2019, buyers in some US states will automatically be charged sales tax for eBay purchases. eBay will collect and remit this sales tax to the proper taxing authority on the buyer's behalf. So, if the order's buyer is in a state that is subject to 'eBay Collect and Remit Tax', the seller should not send the buyer any sales tax information, since eBay will be handling the sales tax instead without buyer's assistance. For a list of the US states that will become subject to 'eBay Collect and Remit' (and effective dates), see the <a href="https://www.ebay.com/help/selling/fees-credits-invoices/taxes-import-charges?id=4121#section4">eBay sales tax collection</a> help topic.
</span>
SendInvoice
No
This field is no longer applicable as it is no longer possible for a seller to offer a buyer shipping insurance.
1031
Avoid
1085
This field is no longer applicable as it is no longer possible for a seller to offer a buyer shipping insurance.
1031
Avoid
1085
This optional field allows a US or German seller to add specific payment methods that were not in the original listing. The only valid values for this field are 'PayPal' for a US listing (or 'CreditCard' for sellers opted in to eBay Managed Payments), or 'MoneyXferAcceptedInCheckout' (CIP+) for a listing on the Germany site.
SendInvoice
No
If the <b>PaymentMethods</b> field is used and set to <code>PayPal</code>, the seller provides his/her PayPal email address in this field.
SendInvoice
Conditionally
This field allows the seller to provide a message or instructions
regarding checkout/payment, or the return policy.
500
SendInvoice
No
This field is included and set to <code>true</code> if the seller wishes to receive an email copy of the invoice sent to the buyer.
true
SendInvoice
No
This dollar value indicates the money due from the buyer upon delivery of the item.
<br><br>
This field should only be specified in the <b>SendInvoice</b> request if 'COD'
(cash-on-delivery) was the payment method selected by the buyer and it is included
as the <b>PaymentMethods</b> value in the same request.
SendInvoice
No
Specifying the Cash on Delivery Option in Shipping Details
https://developer.ebay.com/DevZone/guides/features-guide/default.html#development/Shipping-OtherFeatures.html#SpecifyingtheCashonDeliveryOptioninShipp
The seller's unique identifier for an item that is being tracked by this
SKU. If <b>OrderID</b> or <b>OrderLineItemID</b> are not provided, both <b>SKU</b> (or
<b>ItemID</b>) and corresponding <b>TransactionID</b> must be provided to uniquely
identify a single line item order. For a multiple line item order, <b>OrderID</b> must be used.
<br>
<br>
This field can only be used if the <b>Item.InventoryTrackingMethod</b> field
(set with the <b>AddFixedPriceItem</b> or <b>RelistFixedPriceItem</b> calls) is set to
<code>SKU</code>.
50
SendInvoice
Conditionally
A unique identifier for an eBay order line item. This identifier is created as soon as there is a commitment to buy (bidder wins the auction, buyer clicks buy button, or buyer purchases item through <b>PlaceOffer</b> call).
<br>
<br>
Unless the <b>ItemID</b> (or <b>SKU</b>) and corresponding <b>TransactionID</b> is used to
identify a single line item order, or the <b>OrderID</b> is used to identify a
single or multiple line item order, the
<b>OrderLineItemID</b> must be specified. For a multiple line item order, <b>OrderID</b> should be used. If <b>OrderLineItemID</b> is specified,
<b>ItemID</b>, <b>TransactionID</b>, and <b>SKU</b> are ignored if present in the same
request.
SendInvoice
Conditionally
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. <br><br>
The currency used in this field must be the same currency of the listing site. A positive value in this field indicates that the amount is an extra charge being paid to the seller by the buyer, and a negative value indicates that the amount is a discount given to the buyer by the seller.
SendInvoice
Conditionally
The response of a <b>SendInvoice</b> call only includes the standard response fields for Trading API calls, such as the <b>Ack</b> field (to indicate the success or failure of the call), the timestamp, and an <b>Errors</b> container (if there were any errors and/or warnings).
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.
GetMessagePreferences
This container can be used to set customized ASQ subjects, or it can be used to reset the ASQ subjects to the eBay defaults. Up to nine customized ASQ subjects can be set.
SetMessagePreferences
Yes
The response of a <b>SetMessagePreferences</b> call only includes the standard response fields for Trading API calls, such as the <b>Ack</b> field (to indicate the success or failure of the call), the timestamp, and an <b>Errors</b> container (if there were any errors and/or warnings).
Manages notification and alert preferences for applications and users.
GetNotificationPreferences
Working with Platform Notifications
https://developer.ebay.com/DevZone/guides/features-guide/default.html#development/Notifications.html
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
<b>UserDeliveryPreferenceArray</b> input property specifies specific
notification subscriptions).
SetNotificationPreferences
No
Specifies events and whether or not they are enabled.
SetNotificationPreferences
No
Specifies user data for notification settings, such as mobile phone number.
SetNotificationPreferences
No
Characteristics or details of an event such as type, name and value.
Currently can only be set for wireless applications.
SetNotificationPreferences
No
Specifies up to 25 ApplicationDeliveryPreferences.DeliveryURLDetails.DeliveryURLName to associate with a user token sent in a SetNotificationPreferences request. To specify multiple DeliveryURLNames, create separate instances of ApplicationDeliveryPreferences.DeliveryURLDetails.DeliveryURLName, and then enable up to 25 DeliveryURLNames by including them in comma-separated format in this field.
SetNotificationPreferences
No
The response of a <b>SetNotificationPreferences</b> call only includes the standard response fields for Trading API calls, such as the <b>Ack</b> field (to indicate the success or failure of the call), the timestamp, and an <b>Errors</b> container (if there were any errors and/or warnings).
Creates or modifies a promotional sale. Promotional sales enable sellers
to apply discounts and/or free shipping across many listings. To use this call, the seller must be a registered eBay Store owner.
Creates or modifies a promotional sale. Promotional sales enable sellers
to apply discounts and/or free shipping across many listings.
SetPromotionalSaleListings, GetPromotionalSaleDetails
Putting Store Items on Sale
https://developer.ebay.com/DevZone/guides/features-guide/default.html#development/Sites-eBayStore.html#PuttingItemsonSale
The seller must include this field and set it to 'Add' to create a new promotional sale, or set it to 'Update' to modify an existing promotional sale, or set it to 'Delete' to delete a promotional sale.
SetPromotionalSale
Yes
This container must be included in each <b>SetPromotionalSale</b> call. The fields of this container that will be used will depend on whether the seller is adding a new promotional sale, updating an existing promotional sale, or deleting an existing promotional sale.
SetPromotionalSale
Yes
The base response of the <b>SetPromotionalSale</b> call. Contains the status of a promotional sale.
The enumeration value in this field indicates the status of the promotional sale action (add or delete). See <b>PromotionalSaleStatusCodeType</b> for more information on status values.
SetPromotionalSale
Always
The unique identifier of the new promotional sale, or in the case of a delete or modify action, the unique identifier of the existing promotional sale that was deleted or modified.
SetPromotionalSale
Always
Enables the seller to change the item listings that are affected by a promotional sale. To use this call, the seller must be a registered eBay Store owner.
SetPromotionalSale, GetPromotionalSaleDetails
Putting Store Items on Sale
http://developer.ebay.com/DevZone/guides/features-guide/default.html#development/Sites-eBayStore.html
The unique identifier of the seller's promotional sale. Based on the <b>Action</b>
value, listings will either be added to or removed from the promotional sale.
SetPromotionalSaleListings
Yes
This required field determines whether you are adding (specify 'Add') or
removing (specify 'Delete) one or more listings from the promotional sale
identified by the <b>PromotionalSaleID</b> value in the request.
<br><br>
If you specify 'Delete', you must include one or more <b>ItemID</b> values under the <b>PromotionalSaleItemIDArray</b> container, and you cannot use the other filter options in the request. If you specify 'Add', you can add one or more listings using any of the filtering options in the request. Active auction listings that have one or more bids cannot be added to or removed from a promotional sale.
SetPromotionalSaleListings
Add, Delete
Yes
Container consisting of one or more <b>ItemID</b> values. Based on the <b>Action</b> value, the listings identified by these <b>ItemID</b> values are either added to or removed from the promotional sale. <br><br> This container is required if listings are being removed (<b>Action</b>='Delete') from the promotional sale.
SetPromotionalSaleListings
Conditionally
If a <b>StoreCategoryID</b> value is included in the call request, all active items in this eBay Store category are added to the promotional sale. This field cannot be used if the <b>Action</b> field is set to 'Delete'.
SetPromotionalSaleListings
No
If a <b>CategoryID</b> value is included in the call request, all active items in this eBay category are added to the promotional sale. This field cannot be used if the <b>Action</b> field is set to 'Delete'.
SetPromotionalSaleListings
No
If this field is included and set to 'true' in the call request, all fixed-price listings are added to the promotional sale. This field cannot be used if the <b>Action</b> field is set to 'Delete'.
SetPromotionalSaleListings
No
This field is deprecated and should no longer be used because Store Inventory is no longer a supported listing format.
If this field is included and set to 'true' in the call request, all auction listings are added to the promotional sale. This field cannot be used if the <b>Action</b> field is set to 'Delete'.
SetPromotionalSaleListings
No
The base response of the <b>SetPromotionalSaleListings</b> call. Contains the status of a promotional sale.
The enumeration value in this field indicates the status of the promotional sale action (add or delete). See <b>PromotionalSaleStatusCodeType</b> for more information on status values.
SetPromotionalSaleListings
Always
Enables Selling Manager Pro subscribers to store standard feedback comments that can
be left for their buyers. Selling Manager Pro subscribers can also specify what
events, if any, will trigger an automated feedback response to buyers.
Enables Selling Manager and Selling Manager Pro subscribers to store feedback
comments for buyers and set automated feedback preferences (Selling Manager Pro
subscribers only).
Using Selling Manager Calls in the Trading API
https://developer.ebay.com/DevZone/guides/features-guide/default.html#development/Listings-SellingManager.html
Selling Manager Pro page on the eBay Site
https://pages.ebay.com/help/sell/sm-getting-started.html
Specifies the event that will trigger automated feedback to the buyer.
SetSellingManagerFeedbackOptions
No
Contains a set of comments from which one can be selected to leave
feedback for a buyer. If automated feedback is used, a comment is
selected from the set randomly. Stored comments cannot be replaced or
edited individually. Submitting a stored comments array replaces all
existing stored comments.
<br>
SetSellingManagerFeedbackOptions
No
Base response of <b>SetSellingManagerFeedbackOptions</b> call. This response provides confirmation that feedback comments and (optionally) automated feedback preferences were added successfully.
Revises, or adds to, the set of Selling Manager automation rules associated with an item.
<br>
<br>
This call is subject to change without notice; the deprecation process is inapplicable to this call. You must have a Selling Manager Pro subscription to use this call.
<br>
<br>
Using this call, you can add an automated relisting rule. You also can add a Second Chance Offer rule. Note that automated relisting rules can only be set on templates. An automated relisting rule for an item is inherited from a template.
<br>
<br>
This call also enables you to specify particular information about automation rules.
<br>
<br>
If a node is not passed in the call, the setting for the corresponding
automation rule remains unchanged.
Revises or adds to the set of Selling Manager automation rules associated with
a specific item.
GetSellingManagerItemAutomationRule
Using Selling Manager Calls in the Trading API
https://developer.ebay.com/DevZone/guides/features-guide/default.html#development/Listings-SellingManager.html
Selling Manager Pro page on the eBay Site
https://pages.ebay.com/help/sell/sellingmanager.html
The unique identifier of the listing whose automation rules you want to change.
SetSellingManagerItemAutomationRule
Yes
The information for the automated relisting rule to be associated with the listing.
SetSellingManagerItemAutomationRule
No
The information for the automated Second Chance Offer rule to be associated with the listing.
SetSellingManagerItemAutomationRule
No
Contains the set of automation rules associated with the specified item.
Contains the automated listing rule associated with this item.
SetSellingManagerItemAutomationRule
Conditionally
Contains the automated relisting rule associated with this item.
SetSellingManagerItemAutomationRule
Conditionally
Contains the automated Second Chance Offer rule associated with this item.
SetSellingManagerItemAutomationRule
Conditionally
Contains fees that may be incurred when items are listed using the automation rules (e.g., a scheduled listing fee). Use of an automation rule does not in itself have a fee, but use can result in a fee.
SetSellingManagerItemAutomationRule
Conditionally
Revises, or adds to, the Selling Manager automation rules associated with a template.
<br>
<br>
This call is subject to change without notice; the deprecation process is inapplicable to this call. You must have a Selling Manager Pro subscription to use this call.
<br>
<br>
Using this call, you can add either an automated listing or relisting rule, but not both. You also can add a Second Chance Offer rule.
<br>
<br>
This call also enables you to specify particular information about automation rules.
<br>
<br>
If a node is not passed in the call, the setting for the corresponding automation rule remains unchanged.
Revises or adds to the Selling Manager automation rules associated with a specific template.
GetSellingManagerTemplateAutomationRule
Using Selling Manager Calls in the Trading API
https://developer.ebay.com/DevZone/guides/features-guide/default.html#development/Listings-SellingManager.html
Selling Manager Pro page on the eBay Site
https://pages.ebay.com/help/sell/sellingmanager.html
The ID of the Selling Manager template whose automation rules you want to change. You can obtain a <b>SaleTemplateID</b> by calling <b>GetSellingManagerInventory</b>.
SetSellingManagerTemplateAutomationRule
Yes
The information for the automated listing rule to be associated with the template.
SetSellingManagerTemplateAutomationRule
No
The information for the automated relisting rule to be associated with the template.
SetSellingManagerTemplateAutomationRule
No
The information for the automated Second Chance Offer rule to be associated with the template.
SetSellingManagerTemplateAutomationRule
No
Contains the set of automation rules associated with the specified template.
Contains the automated listing rule associated with this template.
SetSellingManagerTemplateAutomationRule
Conditionally
Contains the automated relisting rule associated with this template.
SetSellingManagerTemplateAutomationRule
Conditionally
Contains the automated Second Chance Offer rule associated with this template.
SetSellingManagerTemplateAutomationRule
Conditionally
Contains fees that may be incurred when items are listed using the
automation rules (e.g., a scheduled listing fee). Use of an automation rule
does not in itself have a fee, but use can result in a fee.
SetSellingManagerTemplateAutomationRule
Conditionally
This call enables a seller to create and manage shipping discounts rules. These are the same shipping discount rules that can be created or managed in My eBay Shipping Preferences.
<br/><br/>
The types of shipping discount rules that can be created and managed with this call include flat-rate shipping rules, calculated shipping rules, and promotional shipping rules. This call can also be used by sellers to set whether or not they allow buyers to combine separate line items into one Combined Invoice order, and how many days they allow buyers to perform that action.
<br/><br/>
A seller can only create, update, or delete one discount rule type with each call. The action to take (either <code>Add</code>, <code>Update</code>, or <code>Delete</code>) is set and controlled with the <b>ModifyActionCode</b> field.
GetShippingDiscountProfiles
Shipping Cost Discount Profiles
https://developer.ebay.com/DevZone/guides/features-guide/default.html#development/Shipping-OtherFeatures.html#ShippingCostDiscountProfiles
The three-digit code of the currency to be used for shipping discounts on Combined Invoice orders. A discount profile can only be associated with a listing if the <b>CurrencyID</b> value of the profile matches the <b>Item.Currency</b> value specified in a listing. This field is required if the user is adding or updating one or more shipping discount profiles.
<br><br>
Note that There is a <b>currencyID</b> attribute on all <b>SetShippingDiscountProfiles</b> elements involving money. To avoid a call error, be sure to use the same currency type in these attributes as what is set for the <b>CurrencyID</b> field.
SetShippingDiscountProfiles
Conditionally
This field is used to specify the number of days after the purchase of an
item that the buyer or seller can combine multiple and mutual order
line items into one Combined Invoice order. In a Combined Invoice order,
the buyer makes one payment for all order line items, hence only unpaid
order line items can be combined into a Combined Invoice order.
SetShippingDiscountProfiles
Yes
This field is used to set which action is being taken (<code>Add</code>, <code>Update</code>, or <code>Delete</code>) in the call. If you are adding a shipping discount rule, you will have to supply a name for that shipping discount profile. If you want to update or delete a shipping discount profile, you'll have to provide the unique identifier of this rule through the corresponding containers. The unique identifiers of these rules can be retrieved with the <b>GetShippingDiscountRules</b> call, or the seller can view these identifiers in My eBay Shipping Preferences.
SetShippingDiscountProfiles
Yes
This container allows you to create, update, or delete a flat-rate shipping discount profile.
SetShippingDiscountProfiles
No
This container allows you to create, update, or delete a calculated shipping discount profile.
SetShippingDiscountProfiles
No
This container allows you to create, update, or delete a calculated handling discount profile.
SetShippingDiscountProfiles
No
This container allows you to create, update, or delete a promotional shipping discount profile.
SetShippingDiscountProfiles
No
This field is no longer applicable as it is not longer possible for a seller to offer a buyer shipping insurance.
1035
NoOp
1035
This field is no longer applicable as it is not longer possible for a seller to offer a buyer shipping insurance.
1035
NoOp
1035
The response of a <b>SetShippingDiscountProfiles</b> call only includes the standard response fields for Trading API calls, such as the <b>Ack</b> field (to indicate the success or failure of the call), the timestamp, and an <b>Errors</b> container (if there were any errors and/or warnings).
This call is used to set/modify the configuration of a seller's eBay Store. Configuration information includes store theme information and eBay Store category hierarchy.
GetStore
Editing the Store Settings
https://developer.ebay.com/DevZone/guides/features-guide/default.html#development/Sites-eBayStore.html#EditingtheStoreSettings
This container is used to set/modify the configuration of a seller's eBay Store.
SetStore
Yes
The response of a <b>SetStore</b> call only includes the standard response fields for Trading API calls, such as the <b>Ack</b> field (to indicate the success or failure of the call), the timestamp, and an <b>Errors</b> container (if there were any errors and/or warnings).
This call allows you to set or modify the category structure of an eBay Store. Sellers must have an eBay Store subscription in order to use this call.
Managing Store Categories
https://developer.ebay.com/DevZone/guides/features-guide/default.html#development/Sites-eBayStore.html#ManagingStoreCategories
Specifies the type of action (Add, Move, Delete, or Rename) to carry out
for the specified eBay Store categories.
SetStoreCategories
Yes
Items can only be contained within child categories. A parent category
cannot contain items. If adding, moving, or deleting categories displaces
items, you must specify a destination child category under which the
displaced items will be moved. The destination category must have no
child categories.
SetStoreCategories
Conditionally
When adding or moving store categories, specifies the category under
which the listed categories will be located. To add or move categories to
the top level, set the value to -999.
SetStoreCategories
Conditionally
Specifies the store categories on which to act.
SetStoreCategories
Yes
Base response of the <b>SetStoreCategories</b> call. Returns the status of the eBay Store category changes.
The task ID associated with the category structure change request. For a
simple change, the <b>SetStoreCategories</b> call is processed synchronously.
That is, simple changes are made immediately and then the response is
returned. For synchronous processing, the task ID in the response is 0.
If the category structure changes affect many listings, the changes will
be processed asynchronously and the task ID will be a positive number.
Use the non-zero task ID with <b>GetStoreCategoryUpdateStatus</b> to monitor
the status of asynchronously processed changes.
SetStoreCategories
Always
When an eBay Store category structure change is processed synchronously, the status
is returned as 'Complete' or 'Failed'. For asynchronously processed changes,
the status is reported as 'InProgress' or 'Pending'. Use <b>GetStoreCategoryUpdateStatus</b> to
monitor the status of asynchronously processed changes.
SetStoreCategories
Always
Contains hierarchy data for eBay Store categories that you have created/modified.
SetStoreCategories
Always
Creates or updates a custom page on a user's eBay Store. Sellers must have an eBay Store subscription in order to use this call.
GetStoreCustomPage
Managing Custom Pages
https://developer.ebay.com/DevZone/guides/features-guide/default.html#development/Sites-eBayStore.html#ManagingCustomPages
This container is used to create a new eBay Store custom page or modify an existing custom page.
SetStoreCustomPage
Yes
The base response for the <b>SetStoreCustomPage</b> call. This serves as
confirmation that the custom page was successfully submitted.
This container consists of details for the newly-added or modified eBay Store custom page.
SetStoreCustomPage
Always
Sets the preferences for a user's eBay Store. Sellers must have an eBay Store subscription in order to use this call.
GetStorePreferences
Managing eBay Store Preferences
https://developer.ebay.com/DevZone/guides/features-guide/default.html#development/Sites-eBayStore.html#ManagingaUsersStorePreferences
This container is used to set the eBay Store's preferences. Currently, the only applicable eBay Store preferences are Store vacation preferences.
SetStorePreferences
Yes
The base response for the <b>SetStorePreferences</b> call. There are no call-specific fields in this response, but the seller should look for an <b>Ack</b> value of <code>Success</code> to know that the preferences were successfully updated.
This call allows you to add or modify sales tax rates for one or more tax jurisdictions within the specified site. Any additions or modifications made with this call is saved in the seller's Sales Tax Table in My eBay.
<br/><br/>
Sales Tax Tables are only supported on the US and Canada (English and French versions) sites, so this call is only applicable to those sites. To view their current Sales Tax Table, a seller may go to the Sales Tax Table in My eBay, or they can make a <b>GetTaxTable</b> call.
GetTaxTable
Enabling Multi-jurisdiction Sales Tax
https://developer.ebay.com/DevZone/guides/features-guide/default.html#development/Feature-SalesTax.html
This table is used to set or modify sales tax rates for one or more tax jurisdictions within that country. A <b>TaxJurisdiction</b> container is required for each tax jurisdiction that is being added/updated.
SetTaxTable
Yes
The response of a <b>SetTaxTable</b> call only includes the standard response fields for Trading API calls, such as the <b>Ack</b> field (to indicate the success or failure of the call), the timestamp, and an <b>Errors</b> 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.
Unique identifier of the listing to which the My eBay note will be
attached. Notes can only be added to items that are
currently being tracked in My eBay.
SetUserNotes
Conditionally
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.
SetUserNotes
Yes
This field is needed if the <b>Action</b> is <code>AddOrUpdate</code>. The text supplied in this field will
completely replace any existing My eBay note for the
specified item.
255
SetUserNotes
Conditionally
Unique identifier for the order line item to which the My
eBay note will be attached. Notes can only be added to order line items
that are currently being tracked in My eBay. Buyers can
view user notes made on order line items in the
<b>PrivateNotes</b> field of the <b>WonList</b> container in <b>GetMyeBayBuying</b>, and
sellers can view user notes made on order line items in
the <b>PrivateNotes</b> field of the <b>SoldList</b> and <b>DeletedFromSoldList</b>
containers in <b>GetMyeBaySellinging</b>.
SetUserNotes
No
Container consisting of name-value pairs that identify (match) one
variation within a fixed-price, multiple-variation listing. The specified
name-value pair(s) must exist in the listing specified by either the
<b>ItemID</b> or <b>SKU</b> values specified in the request. If a specific order line
item is targeted in the request with an
<b>ItemID</b>/<b>TransactionID</b> pair or an <b>OrderLineItemID</b> value, any specified
<b>VariationSpecifics</b> container is ignored by the call.
SetUserNotes
No
SKU value of the item variation to which the My eBay note will be
attached. Notes can only be added to items that are currently being
tracked in My eBay. A SKU (stock keeping unit) value is defined by and
used by the seller to identify a variation within a fixed-price, multiple-
variation listing. The SKU value is assigned to a variation of an item
through the <b>Variations.Variation.SKU</b> element.
<br>
<br>
This field can only be used if the <b>Item.InventoryTrackingMethod</b> field
(set with the <b>AddFixedPriceItem</b> or <b>RelistFixedPriceItem</b> calls) is set to
SKU.
<br>
<br>
If a specific order line item is targeted in the request
with an <b>ItemID</b>/<b>TransactionID</b> pair or an <b>OrderLineItemID</b> value, any
specified <b>SKU</b> is ignored by the call.
SetUserNotes
No
A unique identifier for an eBay order line item. This field is created as
soon as there is a commitment to buy from the seller. <b>OrderLineItemID</b> can be used in the input instead of
an <b>ItemID</b>/<b>TransactionID</b> pair to identify an order line item.
<br>
<br>
Notes can only be added to order line items that are currently being
tracked in My eBay. Buyers can view user notes made on order line items in
the <b>PrivateNotes</b> field of the <b>WonList</b> container in <b>GetMyeBayBuying</b>, and
sellers can view user notes made on order line items in the <b>PrivateNotes</b>
field of the <b>SoldList</b> and <b>DeletedFromSoldList</b> containers in
<b>GetMyeBaySellinging</b>.
SetUserNotes
Conditionally
The response of a <b>SetUserNotes</b> call only includes the standard response fields for Trading API calls, such as the <b>Ack</b> field (to indicate the success or failure of the call), the timestamp, and an <b>Errors</b> container (if there were any errors and/or warnings).
This call allows an eBay user to set/modify numerous seller account preferences.
GetUserPreferences
Managing User Preferences
https://developer.ebay.com/DevZone/guides/features-guide/default.html#development/CRM-UserInformation.html#ManagingUserPreferences
This container is included if the seller wishes to receive contact information for unsuccessful bidders. This preference is only applicable for auction listings.
SetUserPreferences
No
This container is included if the seller wishes to set the preference for allowing Combined Invoice orders for cases where the buyer has multiple unpaid order line items from the same seller.
SetUserPreferences
No
This container is deprecated.
This container is included if the seller wishes to set various payment preferences. One or more preferences may be set or modified under this container. Payment preferences specified in a <b>SetUserPreferences</b> call override the settings in My eBay payment preferences.
SetUserPreferences
No
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. One or more preferences may be set or modified under this container.
SetUserPreferences
No
This container is included if the seller wishes to set preferences for the end-of-auction email sent to the winning bidder. These preferences allow the seller to customize the Email that is sent to buyer at the end of the auction. One or more preferences may be set or modified under this container. These preferences are only applicable for auction listings.
SetUserPreferences
No
This field is included and set to <code>true</code> if the seller wishes to email the shipment's tracking number to the buyer.
false
SetUserPreferences
No
This field is included and set to <code>true</code> if the seller wishes to require the buyer to provide a shipping phone number upon checkout. Some shipping carriers require the receiver's phone number.
false
SetUserPreferences
No
This container is included if the seller wishes to set Unpaid Item Assistant preferences. The Unpaid Item Assistant automatically opens an Unpaid Item case on the behalf of the seller if the buyer has not paid for the order after a specified number of days. One or more preferences may be set or modified under this container.
SetUserPreferences
No
http://pages.ebay.com/sell/UPI/upiassistant/index.html
Unpaid Item Assistant
http://pages.ebay.com/sell/UPI/standardprocess/index.html
Understanding the New Unpaid Item Process
This container is included if the seller wishes to set the preference for sending a purchase reminder email to buyers.
SetUserPreferences
No
This field is no longer applicable, as third-party checkout on eBay is no longer possible.
This container is included if the seller wishes to set the order cut off time for same-day shipping. If the seller specifies a value of <code>0</code> in <strong>Item.DispatchTimeMax</strong> to offer same day handling when listing an item, the seller's shipping time commitment depends on the order cut off time set for the listing site, as indicated by the <strong>DispatchCutoffTimePreference.CutoffTime</strong> field.
<br>
<br>
<span class="tablenote"><b>Note:</b> This field is not applicable for sellers who have opted into the Handling Time Option of eBay Guaranteed Delivery, as this field only shows a single order cutoff time, but with the Handling Time Option, a seller can set a different order cutoff time for each business day. Currently, eBay Guaranteed Delivery is only available in the US.</span>
SetUserPreferences
No
Specifying Shipping Services
http://developer.ebay.com/DevZone/guides/features-guide/default.html#development/Shipping-Services.html#SameDayHandling
details about dispatch cut off times
If this flag is included and set to <code>true</code>, the seller's new listings will enable the Global Shipping Program by default.
<br/><br/>
<span class="tablenote">
<strong>Note:</strong> This field is ignored for sellers who are not opted in to the Global Shipping Program (when GetUserPreferences returns <strong>OfferGlobalShippingProgramPreference</strong> with a value of <code>false</code>).
</span>
false
SetUserPreferences
No
If this flag is included and set to <code>true</code>, and the seller specifies an international shipping service to a particular country for a given listing, the specified service will take precedence and be the listing's default international shipping option for buyers in that country, rather than the Global Shipping Program. The Global Shipping Program will still be the listing's default option for shipping to any Global Shipping-eligible country for which the seller does <em>not</em> specify an international shipping service.
<br/><br/>
If this flag is set to <code>false</code>, the Global Shipping Program will be each Global Shipping-eligible listing's default option for shipping to any Global Shipping-eligible country, regardless of any international shipping service that the seller specifies for the listing.
false
SetUserPreferences
No
If this flag is included and set to <code>true</code>, it enables the Out-of-Stock feature. A seller would use this feature to keep Fixed-Price GTC (Good 'Til Canceled) listings alive even when the "quantity available" value goes to 0 (zero). This is useful when waiting for additional stock and eliminates the need to end the listing and then recreating it when stock arrives. <br/><br/>
While the "quantity available" value is 0, the listing would be hidden from eBay search and if that item was specifically searched for with <b>GetItem</b> (or related call), the element <b>HideFromSearch</b> would be returned as 'true' and <b>ReasonHideFromSearch</b> would be returned as 'OutOfStock'.
<br/><br/>
When stock is available, the seller can use the <b>Revise</b> calls to update the inventory of the item (through the <b>Item.Quantity</b> or <b>Item.Variations.Variation.Quantity</b> fields) and the listing would appear again.
<br/><br/>
You can return the value of this flag using the <a href="GetUserPreferences.html#Request.ShowOutOfStockControlPreference">GetUserPreferences</a> call and setting the <b>ShowOutOfStockControlPreference</b> field to 'true'. <br/><br/>
<span class="tablenote"><b>IMPORTANT: </b> When a listing using the Out-of-Stock feature has zero quantity, the seller has 90 days to add inventory without incurring a listing fee. Fees are changed at the end of each the billing cycle but are then refunded if the item is out-of-stock for an entire billing period. See <a href="../../../../guides/features-guide/default.html#development/Listings-UseOutOfStock.html#FeesForaListingWithZeroQuantity">Fees For a Listing With Zero Quantity</a> for details. </span>
false
SetUserPreferences
No
Using the Out-of-Stock Feature for more details
../../../../guides/features-guide/default.html#development/Listings-UseOutOfStock.html
The response of a <b>SetUserPreferences</b> call only includes the standard response fields for Trading API calls, such as the <b>Ack</b> field (to indicate the success or failure of the call), the timestamp, and an <b>Errors</b> container (if there were any errors and/or warnings).
Uploads a picture to the eBay Picture Service and returns a URL of the picture.
You will use this URL when creating, revising, or relisting an item with the Trading API.
Introduction to Pictures in Item Listings
https://developer.ebay.com/DevZone/guides/features-guide/default.html#development/Pictures-Intro.html
Working with Pictures in an Item Listing
https://developer.ebay.com/DevZone/guides/features-guide/default.html#development/Pictures-InListing.html
Including Pictures for Variations
https://developer.ebay.com/DevZone/guides/features-guide/default.html#development/Variations-Configuring.html#DefiningPicturesforVariations
A seller-defined name for the picture. This field is optional, but can make it easier for a seller to track than an arbitrary, eBay-assigned URL.
UploadSiteHostedPictures
No
Specifies the picture system version. Only version 2 is valid.
Available to support future changes in the picture system version.
2
UploadSiteHostedPictures
No
This enumeration value indicates the size of the picture that will be generated.
<br/><br/>
<span class="tablenote"><b>IMPORTANT: </b>
To get the standard website image sizing with Zoom, set this field to <b>Supersize</b>.
</span>
Standard
Large
UploadSiteHostedPictures
No
An optional reference ID to the binary attachment.
<br/><br/>
The <b>PictureData</b> field does not contain the binary attachment. The binary attachment is image data, including the headers, from a JPG, GIF, PNG, BMP, or TIF format image file. The binary attachment must be sent as a MIME attachment, in your POST request, after the XML input.
<br/><br/>
<span class="tablenote"><b>Note: </b>
This field is not applicable for eBay Large Merchant Services. Use the
<b>ExternalPictureURL</b> field instead.
</span>
UploadSiteHostedPictures
No
Determines if the uploaded picture is to replace all the pictures or to be added to the pictures currently available to a seller on the eBay site. The picture is available to the seller on the My Picture Uploads tab within the Sell Your Item pages.
<br/><br/>
The picture you upload (and its URL) is stored for a period of time on the EPS server. If, within that time, the picture is associated with an item, then the picture persists on the eBay site for the same time length as other pictures uploaded using the <b>UploadSiteHostedPictures</b> call.
<br/><br/>
The expiration date of the picture is returned in the <b>SiteHostedPictureDetails.UseByDate</b> field in the response.
UploadSiteHostedPictures
No
This field is used if the seller wishes to upload a picture to the EPS server that is currently on another external site. The URL of the picture you want to upload is passed in this field. Both http:// and https:// servers are supported.
You can include only one <b>ExternalPictureURL</b> field per call.
<br><br>
The eBay server uses the information in this field to retrieve a picture from an external web server. Once retrieved, the picture will be copied to eBay Picture Services and retained for 30 days if not associated with a listing. When associated with a listing, the duration is the length of the listing plus 90 days.
<br/><br/>
<span class="tablenote"><b>Note: </b>
Although both the HTTP and HTTPS protocols are currently supported, in the near future, eBay will no longer allow the hosting or transfer of images on a server using the the HTTP protocol.
</span>
1024
UploadSiteHostedPictures
Conditionally
1
This field is deprecated.
By default, an unpublished picture will be hosted on the EPS server for five days before being purged. However, the seller has the option of using this field to set an expiration date further into the future (up to 30 days). Similarly, when a listing ends or expires, the images associated with the listing remain on the EPS server for an additional 90 days. The value in this field will add on to those 90 days.
<br/><br/>
<span class="tablenote"><b>Note: </b>This call is restricted to applications that have been granted permission. Contact the eBay Developers Program to request permission.
</span>
1
30
5
UploadSiteHostedPictures
No
Contains information about a picture upload (i.e., information about a picture
upload containing a binary attachment of an image).
Specifies the picture system version that was used to upload pictures.
Only version 2 is valid.
UploadSiteHostedPictures
Always
The information about an <b>UploadSiteHostedPictures</b> upload, including the URL of the uploaded picture.
UploadSiteHostedPictures
Always
Validates the user response to a <b class="con">GetChallengeToken</b>
botblock challenge.
Validates the user response to a GetChallengeToken botblock challenge.
GetChallengeToken
Botblock token that was returned by <b>GetChallengeToken</b>.
ValidateChallengeInput
Yes
User response to a bot block challenge.
ValidateChallengeInput
Yes
This boolean field is included and set to 'true' if the challenge token should remain valid for up to two minutes.
false
ValidateChallengeInput
No
Base response of the <b>ValidateChallengeInput</b> call. The response indicates whether the botblock challenge was successful.
Indicates whether the token is valid.
ValidateChallengeInput
Always
Requests to enable a test user to sell items in the Sandbox environment.
GetUser
Value for the feedback score of a user. If no value is passed in the request,
or if the value is zero, the feedback score is unchanged. This element is not intended
for regularly testing feedback because the feedback value can change after the request.
ValidateTestUserRegistration
No
0
1000
Value for the date and time that a user's registration begins.
ValidateTestUserRegistration
No
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. You cannot
request to subscribe a user to both Selling Manager and
Selling Manager Pro. You cannot request to unsubscribe a user.
ValidateTestUserRegistration
No
Indicates if a user subscribes to Selling Manager Pro. You cannot
request to subscribe a user to both Selling Manager and
Selling Manager Pro. You cannot request to unsubscribe a user.
ValidateTestUserRegistration
No
The response of a <b>ValidateTestUserRegistration</b> call only includes the standard response fields for Trading API calls, such as the <b>Ack</b> field (to indicate the success or failure of the call), the timestamp, and an <b>Errors</b> container (if there were any errors and/or warnings).
Reports items that allegedly infringe your copyright, trademark, or other
intellectual property rights. You can report one or more items at a time with this
call. You must be a member of the Verified Rights Owner (VeRO) Program to use this
call.
Reports items that allegedly infringe your copyright, trademark, or other
intellectual property rights. You must be a member of the Verified Rights Owner
(VeRO) Program to use this call.
GetVeROReasonCodeDetails, GetVeROReportStatus
User ID of the VeRO member reporting the items.
VeROReportItems
Yes
Container (packet) for items being reported. You can report the same item
more than once in a packet if a different reason code is used each time.
VeROReportItems
No
Contains a packet ID and status for the items reported by the VeRO Program member.
A unique packet identifier for the items reported.
VeROReportItems
Conditionally
The processing status of the packet.
VeROReportItems
Conditionally
Enables a seller to test the definition of a new fixed-price listing by
submitting the definition to eBay without creating an actual listing.
AddFixedPriceItem
Listing an Item
https://developer.ebay.com/DevZone/guides/features-guide/default.html#development/Listing-AnItem.html
Root container holding all values that define a new
fixed-price listing.
VerifyAddFixedPriceItem
Yes
Returns the listing recommendations (if applicable), the estimated fees for the proposed new listing (except the Final Value Fee, which isn't calculated until the item has sold), and other details.
With a successful <b>VerifyAddFixedPriceItem</b> call, this field is always returned, but the returned value is always <code>0</code>, since this call only validates the data passed in through the request payload and does not actually create an active listing.
VerifyAddFixedPriceItem
Always
Item-level SKU for the new listing, if the seller specified
tem.SKU in the request. Variation SKUs are not returned
(see GetItem instead).
AddFixedPriceItem
Conditionally
Child elements contain the estimated listing fees for the new item listing.
The fees do not include the Final Value Fee (FVF), which cannot be determined
until an item is sold.
VerifyAddFixedPriceItem
Always
This field is deprecated.
579
NoOp
This field is deprecated.
579
NoOp
ID of the primary category in which the item would be listed.
Only returned if you set Item.CategoryMappingAllowed to true in the request
and the ID you passed in PrimaryCategory was mapped to a new ID by eBay.
If the primary category has not changed or it has expired with no replacement,
CategoryID does not return a value.
10
VerifyAddFixedPriceItem
Conditionally
ID of the secondary category in which the item would be listed.
Only returned if you set Item.CategoryMappingAllowed to true in the request
and the ID you passed in SecondaryCategory was mapped to a new ID by eBay.
If the secondary category has not changed or it has expired with no replacement,
Category2ID does not return a value.
10
VerifyAddFixedPriceItem
Conditionally
The nature of the discount, if a discount would have applied
had this actually been listed at this time.
VerifyAddFixedPriceItem
Conditionally
Container consisting of one or more <b>Recommendation</b> containers. Each <b>Recommendation</b> container provides a message to the seller on how a listing can be improved or brought up to standard in regards to top-rated seller/listing requirements, mandated or recommended Item Specifics, picture quality requirements, pricing and/or listing format recommendations, recommended keywords and/or Item Specifics in a Title, and/or a recommendation to offer fast handling (same-day handling or handling time of 1 day) and/or a free shipping option in order to qualify the listing for a Fast 'N Free badge.
<br><br>
This container is only returned if the <b>IncludeRecommendations</b> flag was included and set to 'true' in the <b>VerifyAddFixedPriceItem</b> request, and if at least one listing recommendation exists for the listing about to be listed. If one or more listing recommendations are returned, it will be at the seller's discretion about whether to revise the listing based on eBay's listing recommendation(s) before actually creating the listing through an <b>AddFixedPriceItem</b> call.
VerifyAddFixedPriceItem
Conditionally
Enables a seller to specify the definition of a new item and submit the definition to eBay without creating a listing.
<br><br>
Sellers who engage in cross-border trade on sites that require a recoupment agreement, must agree to the
recoupment terms before adding or verifying items. This agreement allows eBay to reimburse
a buyer during a dispute and then recoup the cost from the seller. The US site is a recoupment site, and
the agreement is located <a href="https://scgi.ebay.com/ws/eBayISAPI.dll?CBTRecoupAgreement">here</a>.
The list of the sites where a user has agreed to the recoupment terms is returned by the GetUser response.
AddItem, VerifyAddFixedPriceItem
Listing an Item
https://developer.ebay.com/DevZone/guides/features-guide/default.html#development/Listing-AnItem.html
Root container holding all values that define a new
listing.
VerifyAddItem
Yes
Returns the listing recommendations (if applicable), the estimated fees for the proposed new listing (except the Final Value Fee, which isn't calculated until the item has sold), and other details.
With a successful <b>VerifyAddItem</b> call, this field is always returned, but the returned value is always <code>0</code>, since this call only validates the data passed in through the request payload and does not actually create an active listing.
VerifyAddItem
Always
Child Fee containers provide the listing feature names, fees, and possible discounts for the new item listing. The fees do not include the Final Value Fee (FVF), which cannot be determined until an item is sold. <br /> <br /> There is no guarantee that a PromotionalDiscount returned with VerifyAddItem will be realized when the seller uses AddItem to list the same item. This is the result of the timing of certain promotions.
VerifyAddItem
Always
This field is deprecated.
579
NoOp
This field is deprecated.
579
NoOp
ID of the primary category in which the item would be listed.
Only returned if you set Item.CategoryMappingAllowed to true in the request
and the ID you passed in PrimaryCategory was mapped to a new ID by eBay.
If the primary category has not changed or it has expired with no replacement,
CategoryID does not return a value.
10
VerifyAddItem
Conditionally
ID of the secondary category in which the item would be listed.
Only returned if you set Item.CategoryMappingAllowed to true in the request
and the ID you passed in SecondaryCategory was mapped to a new ID by eBay.
If the secondary category has not changed or it has expired with no replacement,
Category2ID does not return a value.
10
VerifyAddItem
Conditionally
The nature of the discount, if a discount would have applied
had this actually been listed at this time.
VerifyAddItem
Conditionally
Provides a list of products recommended by eBay which match the item information provided by the seller.
VerifyAddItem
Conditionally
Container consisting of one or more <b>Recommendation</b> containers. Each <b>Recommendation</b> container provides a message to the seller on how a listing can be improved or brought up to standard in regards to top-rated seller/listing requirements, mandated or recommended Item Specifics, picture quality requirements, pricing and/or listing format recommendations, recommended keywords and/or Item Specifics in a Title, and/or a recommendation to offer fast handling (same-day handling or handling time of 1 day) and/or a free shipping option in order to qualify the listing for a Fast 'N Free badge.
<br><br>
This container is only returned if the <b>IncludeRecommendations</b>
flag was included and set to 'true' in the <b>VerifyAddItem</b> request, and if
at least one listing recommendation exists for the listing about to be listed. If
one or more listing recommendations are returned, it will be at the seller's
discretion about whether to revise the listing based on eBay's listing
recommendation(s) before actually creating the listing through an
<b>AddItem</b> call.
VerifyAddItem
Conditionally
Simulates the creation of a new Second Chance Offer
listing of an item without actually creating a listing.
GetAllBidders, AddSecondChanceItem
Making Second Chance Offers for Items
https://developer.ebay.com/DevZone/guides/features-guide/default.html#development/Sales-SecondChanceOffers.html
Specifies the bidder from the original, ended listing to whom the seller
is extending the second chance offer. Specify only one
<b>RecipientBidderUserID</b> per call. If multiple users are specified (each in a
<b>RecipientBidderUserID</b> node), only the last one specified receives the
offer.
VerifyAddSecondChanceItem
Yes
Specifies the amount the offer recipient must pay to purchase the item
from the Second Chance Offer listing. Use only when the original item was
an eBay Motors (or in some categories on U.S. and international sites for
high-priced items, such as items in many U.S. and Canada Business and
Industrial categories) and it ended unsold because the reserve price was
not met. Call fails with an error for any other item conditions.
VerifyAddSecondChanceItem
No
Specifies the length of time the Second Chance Offer listing will be
active. The recipient bidder has that much time to purchase the item or
the listing expires.
VerifyAddSecondChanceItem
Yes
This field is used to identify the recently-ended auction listing for which a Second Chance Offer will be made to one of the non-winning bidders on the recently-ended auction listing.
VerifyAddSecondChanceItem
Yes
Message content. Cannot contain HTML, asterisks, or quotes. This content
is included in the Second Chance Offer email sent to the recipient, which
can be retrieved with <b>GetMyMessages</b>.
1000
VerifyAddSecondChanceItem
No
Base response of the <b>VerifyAddSecondChanceItem</b> call.
Indicates the date and time when the the new
Second Chance Offer listing became active and
the recipient user could purchase the item.
VerifyAddSecondChanceItem
Always
Indicates the date and time when the Second Chance Offer listing expires, at which time
the listing ends (if the recipient user does
not purchase the item first).
VerifyAddSecondChanceItem
Always
Enable the seller to verify that the data they plan to pass into a <b>RelistItem</b> call will produce the results that you are expecting, including a successful call with no errors.
RelistItem
The <b>Item</b> container is used to configure the item that will be relisted. If the seller plans to relist the item with no changes, the only field under the <b>Item</b> container that is required is the <b>ItemID</b> field. In the <b>ItemID</b> field, the seller specifies the item that will be relisted. If the seller wishes to change anything else for the listing, the seller should include this field in the call request and give it a new value.
<br/><br/>
If the seller wants to delete one or more optional settings in the listing, the seller should use the <b>DeletedField</b> tag.
VerifyRelistItem
Yes
Specifies the name of the field to delete from a listing. See the eBay Features Guide for rules on deleting values when relisting items. Also see the relevant field descriptions to determine when to use <b>DeletedField</b> (and potential consequences).
The request can contain zero, one, or many instances of <b>DeletedField</b> (one for each field to be deleted).
<br><br>
Case-sensitivity must be taken into account when using a <b>DeletedField</b> tag to delete a field. The value passed into a <b>DeletedField</b> tag must either match the case of the schema element names in the full field path (Item.PictureDetails.GalleryURL), or the initial letter of each schema element name in the full field path must be lowercase (item.pictureDetails.galleryURL).
Do not change the case of letters in the middle of a field name.
For example, item.picturedetails.galleryUrl is not allowed.<br><br>
To delete a listing enhancement like 'BoldTitle', specify the value you are deleting;
for example, Item.ListingEnhancement[BoldTitle].
VerifyRelistItem
Conditionally
The base response type for the <b>VerifyRelistItem</b> call. The response includes the Item ID for the relisted item, the SKU value for the item (if any), listing recommendations (if applicable), the estimated fees for the relisted item (except the Final Value Fee, which isn't calculated until the item has sold), the start and end times of the listing, and other details.
With a successful <b>VerifyRelistItem</b> call, this field is always returned, but the returned value is always <code>0</code>, since this call only validates the data passed in through the request payload and does not actually relist an item.
VerifyRelistItem
Always
This container consists of the estimated listing fees for the item that is to be relisted. Each type of fee is returned even if it is not appplicable (has a value of <code>0.0</code>. The Final Value Fee (FVF) is not in this container, as this value cannot be determined until a sale is made.
VerifyRelistItem
Always
This timestamp indicates the date and time when the item to be relisted became active on the eBay site.
VerifyRelistItem
Always
This timestamp indicates the date and time when the item to be relisted is scheduled to end on the eBay site. This date/time is calculated by using the <b>StartTime</b> and the the listing duration.
<br><br>
<span class="tablenote"><b>Note: </b>
Starting July 1, 2019, the Good 'Til Cancelled renewal schedule will be modified from every 30 days to once per calendar month. For example, if a GTC listing is created July 5, the next monthly renewal date will be August 5. If a GTC listing is created on the 31st of the month, but the following month only has 30 days, the renewal will happen on the 30th in the following month. Finally, if a GTC listing is created on January 29-31, the renewal will happen on February 28th (or 29th during a 'Leap Year'). See the
<a href="https://pages.ebay.com/seller-center/seller-updates/2019-spring/marketplace-updates.html#good-til-cancelled" target="_blank">Good 'Til Cancelled listings update</a> in the <b>Spring 2019 Seller Updates</b> for more information about this change.
</span>
VerifyRelistItem
Always
This field is returned if an eBay special offer or promotion is applicable to the listing.
VerifyRelistItem
Conditionally
Provides a list of products recommended by eBay which match the item information provided by the seller.
VerifyRelistItem
Conditionally
Container consisting of one or more <b>Recommendation</b> containers. Each <b>Recommendation</b> container provides a message to the seller on how a listing can be improved or brought up to standard in regards to top-rated seller/listing requirements, mandated or recommended Item Specifics, picture quality requirements, pricing and/or listing format recommendations, recommended keywords and/or Item Specifics in a Title, and/or a recommendation to offer fast handling (same-day handling or handling time of 1 day) and/or a free shipping option in order to qualify the listing for a Fast 'N Free badge.
<br><br>
This container is only returned if the <b>IncludeRecommendations</b> flag was included and set to 'true' in the <b>VerifyRelistItem</b> request, and if at least one listing recommendation exists for the item about to be relisted. If one or more listing recommendations are returned, it will be at the seller's discretion about whether to revise the item based on eBay's listing recommendation(s) before actually relisting the item through a <b>RelistItem</b> call.
VerifyRelistItem
Conditionally
Base type definition of the request payload, which can carry any type of payload
content plus optional versioning information and detail level requirements. All
concrete request types (e.g., AddItemRequestType) are derived from the abstract
request type. The naming convention we use for the concrete type names is the name
of the service (the verb or call name) followed by "RequestType":
VerbNameRequestType
Detail levels are instructions that define standard subsets of
data to return for particular data components (e.g., each
Item, Transaction, or User) within the response payload.
For example, a particular detail level might cause the
response to include buyer-related data in every result
(e.g., for every Item), but no seller-related data.
<br/><br/>
Specifying a detail level is like using a
predefined attribute list in the SELECT clause of an SQL query.
Use the <b>DetailLevel</b> element to specify the required detail level
that the client application needs pertaining to the data components
that are applicable to the request.
<br><br>
The <b>DetailLevelCodeType</b> defines the
global list of available detail levels for all request types.
Most request types support certain detail
levels or none at all. If you pass a detail level that exists
in the schema but that isn't valid for a particular request,
eBay ignores it and processes the request without it.
<br/><br/>
For each request type, see the detail level tables in the
Input/Output Reference to determine which detail levels are
applicable and which elements are returned for each applicable
detail level.
<br><br>Note that <b>DetailLevel</b> is required input for
<b>GetMyMessages</b>. <br>
<br>
With <b>GetSellerList</b> and other calls that retrieve large data sets,
please avoid using <b>ReturnAll</b> when possible. For example, if you use
<b>GetSellerList</b>, use <b>GranularityLevel</b> instead, or use <b>GetSellerEvents</b>. If you do use 'ReturnAll' with
<b>GetSellerList</b>, use a small <b>Pagination.EntriesPerPage</b> value and a narrow
<b>EndTimeFrom</b>/<b>EndTimeTo</b> date range for better performance.
Yes
GetMyMessages
ReturnSummary, ReturnHeaders, ReturnMessages
Yes
GetAdFormatLeads
GetBestOffers
GetCategories
GetCategoryMappings
GetFeedback
GetOrders
GetSellerEvents
GetTaxTable
ReturnAll, none
No
GetCategoryFeatures
GetMyeBayBuying
GetMyeBaySelling
GetUser
GetUserDisputes
ReturnAll, ReturnSummary, none
No
GetItemTransactions
GetSellerList
GetSellerTransactions
GetOrderTransactions
ItemReturnDescription, ReturnAll, none
No
GetSellingManagerTemplates
GetItem
ItemReturnAttributes, ItemReturnDescription, ReturnAll, none
No
Use <b>ErrorLanguage</b> to return error strings for the call in a different language
from the language commonly associated with the site that the requesting user
is registered with. Below are some examples from different countries.
<br><br>
<table border="0">
<tr>
<th>ID</th>
<th>Country</th>
</tr>
<tr>
<td>en_AU</td>
<td>Australia</td>
</tr>
<tr>
<td>de_AT</td>
<td>Austria</td>
</tr>
<tr>
<td>nl_BE</td>
<td>Belgium (Dutch)</td>
</tr>
<tr>
<td>fr_BE</td>
<td>Belgium (French)</td>
</tr>
<tr>
<td>en_CA</td>
<td>Canada</td>
</tr>
<tr>
<td>fr_CA</td>
<td>Canada (French)</td>
</tr>
<tr>
<td>zh_CN</td>
<td>China</td>
</tr>
<tr>
<td>fr_FR</td>
<td>France</td>
</tr>
<tr>
<td>de_DE</td>
<td>Germany</td>
</tr>
<tr>
<td>zh_HK</td>
<td>Hong Kong</td>
</tr>
<tr>
<td>en_IN</td>
<td>India</td>
</tr>
<tr>
<td>en_IE</td>
<td>Ireland</td>
</tr>
<tr>
<td>it_IT</td>
<td>Italy</td>
</tr>
<tr>
<td>nl_NL</td>
<td>Netherlands</td>
</tr>
<tr>
<td>en_SG</td>
<td>Singapore</td>
</tr>
<tr>
<td>es_ES</td>
<td>Spain</td>
</tr>
<tr>
<td>de_CH</td>
<td>Switzerland</td>
</tr>
<tr>
<td>en_GB</td>
<td>United Kingdom</td>
</tr>
<tr>
<td>en_US</td>
<td> United States</td>
</tr>
</table>
No
Most Trading API calls support a <b>MessageID</b> element in the request
and a <b>CorrelationID</b> element in the response. If you pass in a
<b>MessageID</b> in a request, the same value will be returned in the
<b>CorrelationID</b> field in the response. Pairing these values can
help you track and confirm that a response is returned for every request and to
match specific responses to specific requests.
If you do not pass a <b>MessageID</b> value in the request,
<b>CorrelationID</b> is not returned.<br>
<br>
<span class="tablenote"><b>Note:</b>
<b>GetCategories</b> is designed to retrieve very large sets of metadata
that change once a day or less often. To improve performance, these calls return
cached responses when you request all available data (with no filters). When this
occurs, the <b>MessageID</b> and <b>CorrelationID</b> fields
aren't applicable. However, if you specify an input filter to reduce the amount of
data returned, the calls retrieve the latest data (not cached). When this occurs,
<b>MessageID</b> and <b>CorrelationID</b> are applicable.
</span>
No
The version number of the API code that you are
programming against (e.g., 859).
The version you specify for a call has these basic effects:
<b></b>
<ul>
<li>It indicates the version of the code lists and other
data that eBay should use to process your request.</li>
<li>It indicates the schema version you are using.</li>
</ul>
You need to use a version that is greater than or equal to the
lowest supported version.
<br>
<b>For the SOAP API:</b> If you are using the SOAP API,
this field is required. Specify the version of the WSDL your
application is using.<br>
<br>
<b>For the XML API:</b> If you are using the XML API,
this field has no effect. Instead, specify the version in the
<b>X-EBAY-API-COMPATIBILITY-LEVEL</b> HTTP header.
(If you specify <b>Version</b> in the body of an XML API request and it
is different from the value in the HTTP header, eBay returns an
informational warning that the value in the HTTP header was used
instead.)
Conditionally
HTTP Headers
https://developer.ebay.com/DevZone/guides/features-guide/default.html#Basics/Call-RoutingRequest.html#HTTPHeaders
eBay Schema Versioning Strategy
../../HowTo/eBayWS/eBaySchemaVersioning.html
Lowest Supported Version
../../HowTo/eBayWS/eBaySchemaVersioning.html#VersionSupportSchedule
The public IP address of the machine from which the request is sent.
Your application captures that IP address and includes it in
a call request. eBay evaluates requests for safety (also see
the <b>BotBlock</b> container
in the request and response of this call).
PlaceOffer
Yes
Error tolerance level for the call. This is a preference
that specifies how eBay should handle requests that contain
invalid data or that could partially fail. This gives you some control
over whether eBay returns warnings or blocking errors
and how eBay processes the invalid data.<br>
<br>
This field is only applicable to <b>AddItem</b> and related calls,
and only when the listing includes <b>ProductListingDetails</b>.
AddItem
AddItems
AddLiveAuctionItem
RelistItem
ReviseItem
ReviseLiveAuctionItem
VerifyAddItem
BestEffort
No
Pre-filling Item Specifics with Product Details
http://developer.ebay.com/DevZone/guides/features-guide/Development/ItemSpecifics-CatalogDetails.html
CompleteSale
BestEffort, FailOnError
FailOnError
No
A unique identifier for a particular call. If the same <b>InvocationID</b> is passed
in after it has been passed in once on a call that succeeded for a particular
application and user, then an error will be returned. The identifier can
only contain digits from 0-9 and letters from A-F. The
identifier must be 32 characters long. For example,
1FB02B2-9D27-3acb-ABA2-9D539C374228.
32
AddOrder
AddToItemDescription
PlaceOffer
ReviseCheckoutStatus
ReviseItem
No
You can use the <b>OutputSelector</b> field to restrict the data returned by a call. This field can make the call response easier to manage, especially when a large payload is returned. If you use the <b>OutputSelector</b> field, the output data will only include the field(s) you specified in the request, as well as all of its child fields (if a field is a container) and its parent fields (if any). Note that it is possible that a field included through an <b>OutputSelector</b> field may still not be returned if it is not applicable, or if it is not found based on other criteria set up in the request payload.
<br>
<br>
For example, if you are using <b>GetItem</b> and you only want to retrieve the URL of the View Item page (emitted in <b>ViewItemURL</b> field) and the item's Buy It Now price (emitted in <b>BuyItNowPrice</b> field), you would include two separate <b>OutputSelector</b> fields and set the value for each one as <b>ViewItemURL</b> and <b>BuyItNowPrice</b> as in the following example:
<br>
<br>
<pre>
<b>If the following output selectors are used:</b>
<br><br>...<br>
<code><OutputSelector>ViewItemURL</OutputSelector><br>
<OutputSelector>BuyItNowPrice</OutputSelector>
</code><br>...
<br><br>
<b>...the response might look like the following</b>
<br><br>
<code>
<Item><br>
<BuyItNowPrice currencyID="USD">0.0</BuyItNowPrice><br>
<ListingDetails><br>
<ViewItemURL>http://www.ebay.com/itm/Tag-Heuer-Mens-Watch/182879833261</ViewItemURL><br>
</ListingDetails><br>
</Item>
</code>
</pre>
GetAccount
GetAdFormatLeads
GetAllBidders
GetBestOffers
GetBidderList
GetCategories
GetCategoryFeatures
GetFeedback
GetItem
GetItemsAwaitingFeedback
GetItemShipping
GetItemTransactions
GetMemberMessages
GetMyeBayBuying
GetMyeBaySelling
GetMyMessages
GetNotificationPreferences
GetOrders
GetOrderTransactions
GetSellerEvents
GetSellerList
GetSellerTransactions
No
https://developer.ebay.com/DevZone/guides/features-guide/default.html#Basics/eBay-SelectingFields.html#WorkingwiththeOutputSelector
Working with the Output Selector
Controls whether or not to return warnings when the application passes
unrecognized or deprecated elements in a request.<br>
<br>
An unrecognized element is one that is not defined in any supported
version of the schema. Schema element names are case-sensitive,
so using <b>WarningLevel</b> can also help you remove any potential hidden
bugs within your application due to incorrect case or spelling in
field names before you put your application into the
Production environment.<br>
<br>
<b>WarningLevel</b> only validates elements; it doesn't validate
XML attributes. It also doesn't control warnings related to
user-entered strings or numbers, or warnings for
logical errors.<br>
<br>
We recommend that you only use this during development and debugging.
Do not use this in requests performed in the Production environment.
No
https://ebaydts.com/eBayKBDetails?KBid=499
Warning Level
This container is only used by the <b>PlaceOffer</b> call request if the previous <b>PlaceOffer</b> call resulted in a <b>BotBlock</b> container in the response. If the caller receives this container in the response, that caller must make another <b>PlaceOffer</b> call, this time, passing in the encrypted token and URL that is returned in the <b>BotBlock</b> container in the response. This safeguard lets eBay know that a real user is making a <b>PlaceOffer</b> call and not a bot.
PlaceOffer
Conditionally
Base type definition of a response payload that can carry any
type of payload content with following optional elements:
<ul>
<li>timestamp of response message</li>
<li>application-level acknowledgement</li>
<li>application-level (business-level) errors and warnings</li>
</ul>
This value represents the date and time when eBay processed the
request. The time zone of this value is GMT and the format is the
ISO 8601 date and time format (YYYY-MM-DDTHH:MM:SS.SSSZ). See the <b>Time
Values</b> section in the eBay Features Guide for information about this
time format and converting to and from the GMT time zone. <br>
<br>
<span class="tablenote"><b>Note:</b>
<b>GetCategories</b> and other Trading API calls are designed to retrieve very large sets
of metadata that change once a day or less often. To improve performance, these
calls return cached responses when you request all available data (with no
filters). When this occurs, this time value reflects the time the cached response
was created. Thus, this value is not necessarily when the request was processed.
However, if you specify an input filter to reduce the amount of data returned, the
calls retrieve the latest data (not cached). When this occurs, this time value does
reflect when the request was processed.</span>
OrderAck, SetShipmentTrackingInfo, SoldReport
Always
A token representing the application-level acknowledgement code that indicates
the response status (e.g., success). The <b>AckCodeType</b> list specifies
the possible values for the <b>Ack</b> field.
CompleteSale, GetPopularKeywords, SoldReport
PartialFailure
Always
CompleteSale
GetPopularKeywords
Always
Most Trading API calls support a <b>MessageID</b> element in the request
and a <b>CorrelationID</b> element in the response. If you pass in a
<b>MessageID</b> in a request, the same value will be returned in the
<b>CorrelationID</b> field in the response. Pairing these values can
help you track and confirm that a response is returned for every request and to
match specific responses to specific requests.
If you do not pass a <b>MessageID</b> value in the request,
<b>CorrelationID</b> is not returned.<br>
<br>
<span class="tablenote"><b>Note:</b>
<b>GetCategories</b> is designed to retrieve very large sets of metadata
that change once a day or less often. To improve performance, these calls return
cached responses when you request all available data (with no filters). When this
occurs, the <b>MessageID</b> and <b>CorrelationID</b> fields
aren't applicable. However, if you specify an input filter to reduce the amount of
data returned, the calls retrieve the latest data (not cached). When this occurs,
<b>MessageID</b> and <b>CorrelationID</b> are applicable.
</span>
OrderAck, SetShipmentTrackingInfo, SoldReport
Conditionally
A list of application-level errors (if any) that occurred when eBay
processed the request.
SoldReport
Conditionally
Error Handling
http://developer.ebay.com/DevZone/guides/features-guide/Basics/Call-ErrorHandling.html
Supplemental information from eBay, if applicable. May elaborate on
errors (such as how a listing violates eBay policies) or provide
useful hints that may help a seller increase sales. This data can
accompany the call's normal data result set or a result set that
contains only errors. <br>
<br>
Applications must recognize when the <b>Message</b> field is returned and
provide a means to display the listing hints and error message
explanations to the user. <br>
<br>
The string can return HTML, including TABLE, IMG, and HREF elements.
In this case, an HTML-based application should be able to include
the HTML as-is in the HTML page that displays the results.
A non-HTML application would need to parse the HTML
and convert the table elements and image references into UI elements
particular to the programming language used.
As usual for string data types, the HTML markup elements are escaped
with character entity references
(e.g.,<table><tr>...).
AddFixedPriceItem
AddItem
AddItems
AddToItemDescription
EndItem
PlaceOffer
RelistFixedPriceItem
RelistItem
RespondToWantItNowPost
ReviseFixedPriceItem
ReviseItem
VerifyAddFixedPriceItem
VerifyAddItem
Conditionally
Standard Data for All Calls
http://developer.ebay.com/DevZone/guides/features-guide/Basics/Call-StandardCallData.html
The version of the response payload schema. Indicates the version of the schema that eBay used to process the request. See the <b>Standard Data for All Calls</b> section in the eBay Features Guide for information on using the response version when troubleshooting <b>CustomCode</b> values that appear in the response.
OrderAck, SetShipmentTrackingInfo, SoldReport
Always
This refers to the specific software build that eBay used when processing the request
and generating the response. This includes the version number plus additional
information. eBay Developer Support may request the build information
when helping you resolve technical issues.
OrderAck, SetShipmentTrackingInfo, SoldReport
Always
Event name of the notification. Only returned by Platform Notifications.
Information that explains a failure due to a duplicate <b>InvocationID</b> being
passed in.
AddFixedPriceItem
AddItem
AddItems
AddLiveAuctionItem
AddOrder
AddSecondChanceItem
AddToItemDescription
PlaceOffer
RelistFixedPriceItem
RelistItem
ReviseCheckoutStatus
ReviseFixedPriceItem
ReviseItem
Conditionally
Recipient user ID of the notification. Only returned by Platform Notifications.
Unique Identifier of Recipient user ID of the notification. Only returned by
Platform Notifications (not for regular API call responses).
A Base64-encoded MD5 hash that allows the recipient of a Platform
Notification to verify this is a valid Platform Notification sent by
eBay.
Expiration date of the user's authentication token. Only returned
within the 7-day period prior to a token's expiration. To ensure
that user authentication tokens are secure and to help avoid a
user's token being compromised, tokens have a limited life span. A
token is only valid for a period of time (set by eBay). After this
amount of time has passed, the token expires and must be replaced
with a new token.
FetchToken, OrderAck, SetShipmentTrackingInfo, GetSessionID, SoldReport
Conditionally
This container is conditionally returned in the <b>PlaceOffer</b> call response if eBay wants to challenge the user making the call to ensure that the call is being made by a real user and not a bot. This container consist of an encrypted token, the URL of the image that should be displayed to the user, or the URL of an audio clip for sight-impaired users. After receiving this data in the response, the caller must make another <b>PlaceOffer</b> call, this time passing in the encrypted token and one of the URLs that was received in the previous call response.
PlaceOffer
Conditionally
An application subscribing to notifications can include an XML-compliant
string, not to exceed 256 characters, which will be returned. The string can
identify a particular user. Any sensitive information should be passed with due
caution.
<br><br>
To subscribe to and receive eBay Buyer Protection notifications, this field is
required, and you must pass in 'eBP notification' as a string.
SetNotificationPreferences
Conditionally
GetNotificationPreferences
Conditionally
This enumerated type identifies the possible values that can be returned in the <b>Ack</b> field in call responses. The <b>Ack</b> value will indicate if the call was completely successful, if the called failed, or if the call was partially successful, but with minor errors or warnings.
This value indicates that the call request was processed successfully without any issues.
This value indicates that the call request processing failed.
This value indicates that the call request was successful, but processing was not without any issues. These issues can be checked in the <b>Errors</b> container, that will also be returned when one or more known issues occur with the call request.
This value indicates that the call request partially failed. One or more issues that may be responsible for this partial failure can be checked in the <b>Errors</b> container, that will also be returned when one or more known issues occur with the call request.
Reserved for internal or future use.
Type used by the <b>BotBlock</b> container of the <b>PlaceOffer</b> call request. The <b>BotBlock</b> container is conditionally required in a <b>PlaceOffer</b> call request if the previous <b>PlaceOffer</b> call resulted in a <b>BotBlock</b> container being returned in the response. The <b>BotBlock</b> container in the response will contain an authentication token and a URL that will need to be passed into the <b>BotBlock</b> container of the <b>PlaceOffer</b> call request in the subsequent call.
This string value is an encrypted token that eBay generates and returns in the <b>BotBlock.BotBlockToken</b> field of the <b>PlaceOffer</b> call response when eBay is requiring that the user supply an authentication token and URL in order for eBay to process the <b>PlaceOffer</b> call. As soon as a user gets a <b>BotBlock</b> container returned in the <b>PlaceOffer</b> call response, that user should grab the authentication token and the URL and then run another <b>PlaceOffer</b> call, but this time using the <b>BotBlock</b> container and passing in the authentication token and the URL values.
PlaceOffer
Conditionally
This string value is a URL that eBay generates and returns in either the <b>BotBlock.BotBlockUrl</b> or <b>BotBlock.BotBlockAudioUrl</b> field (returned for site-impaired users) of the <b>PlaceOffer</b> call response when eBay is requiring that the user supply an authentication token and URL in order for eBay to process the <b>PlaceOffer</b> call. As soon as a user gets a <b>BotBlock</b> container returned in the <b>PlaceOffer</b> call response, that user should grab the authentication token and the URL and then run another <b>PlaceOffer</b> call, but this time using the <b>BotBlock</b> container and passing in the authentication token and the URL values.
PlaceOffer
Conditionally
This type is used by the <b>BotBlock</b> container that is returned in the <b>PlaceOffer</b> call response if eBay is requiring that the user supply an authentication token and URL in order for eBay to process the <b>PlaceOffer</b> call. The authentication token and URL values that are returned in the <b>PlaceOffer</b> call response are then passed in the <b>BotBlock</b> container of a subsequent <b>PlaceOffer</b> call.
This string value is an encrypted token that eBay generates and returns in the <b>BotBlock.BotBlockToken</b> field of the <b>PlaceOffer</b> call response when eBay is requiring that the user supply an authentication token and URL in order for eBay to process the <b>PlaceOffer</b> call. As soon as a user gets a <b>BotBlock</b> container returned in the <b>PlaceOffer</b> call response, that user should grab the authentication token and the URL and then run another <b>PlaceOffer</b> call, but this time using the <b>BotBlock</b> container and passing in the authentication token and the URL values.
PlaceOffer
Conditionally
This string value is a URL to an image that eBay generates and returns in the <b>PlaceOffer</b> call response when eBay is requiring that the user supply an authentication token and URL in order for eBay to process the <b>PlaceOffer</b> call. As soon as a user gets a <b>BotBlock</b> container returned in the <b>PlaceOffer</b> call response, that user should grab the authentication token and this <b>BotBlockUrl</b> and then run another <b>PlaceOffer</b> call, but this time using the <b>BotBlock</b> container and passing in the authentication token and this URL value in the <b>BotBlockUserInput</b> field. For site-impaired users, the <b>BotBlockAudioUrl</b> field might be returned instead, in which case, the <b>BotBlockAudioUrl</b> value should be passed into the<b>BotBlockUserInput</b> field instead.
PlaceOffer
Conditionally
This string value is a URL to an audio clip that eBay generates and returns in the <b>PlaceOffer</b> call response when eBay is requiring that the user supply an authentication token and URL in order for eBay to process the <b>PlaceOffer</b> call. As soon as a user gets a <b>BotBlock</b> container returned in the <b>PlaceOffer</b> call response, that user should grab the authentication token and this <b>BotBlockAudioUrl</b> and then run another <b>PlaceOffer</b> call, but this time using the <b>BotBlock</b> container and passing in the authentication token and this URL value in the <b>BotBlockUserInput</b> field.
<br><br>
<span class="tablenote"><b>Note:</b>
This field will generally only be returned for site-impaired users. If this field is not returned, but the <b>BotBlockUrl</b> field is returned instead, the <b>BotBlockUrl</b> value should be passed into the <b>BotBlockUserInput</b> field of the subsequent <b>PlaceOffer</b> call instead.
</span>
PlaceOffer
Conditionally
This enumerated type defines different payment methods that can be used by buyers to pay sellers for purchases. Supported payment methods vary by eBay marketplace, by eBay Category, and even by listing format. If a seller is listing, revising, or relisting an item with a Trading API call, the seller should use one of the following metadata calls to see which payment methods are supported at the site and category level:
<ul>
<li><b>GeteBayDetails</b>: through <b>PaymentOptionDetails</b> containers in the response, this call will show the seller all of the payment methods that are available for the specified marketplace. To retrieve this metadata, the seller should include the <b>DetailName</b> field in the request, and set its value to <code>PaymentOptionDetails</code></li>
<li><b>GetCategoryFeatures</b>: through <b>PaymentMethod</b> fields that are returned under the <b>SiteDefaults</b> container or under one or more <b>Category</b> containers in the response, this call will show the seller all of the payment methods that are available for the specified marketplace, including any category exceptions. To retrieve this metadata, the seller should include the <b>FeatureID</b> field in the request, and set its value to <code>PaymentMethods</code>. Note that <b>Category</b> containers will only be returned for categories that differ from Site Defaults as far as supported payment methods are concerned. </li>
</ul>
<br>
<span class="tablenote"><b>Note: </b>
If a seller is opted in to the new eBay Managed Payments program, a payment method does not need to be specified at listing time, as eBay manages the payment methods that are available to the buyer. Any payment method that is specified at listing time (or defined in a payment business policy) will be ignored and dropped from the listing, and the seller will get a warning message in the response. The eBay Managed Payments program is currently only available to a limited number of sellers on the US site, but this feature will be rolled out to more and more US sellers throughout 2019, and is expected to start being rolled out to some Germany sellers in Q3 of 2019.
</span>
StandardPayment, QIWI, Moneybookers, ProPay, Paymate, PaisaPayEscrow, PaisaPayEscrowEMI, ELV, PaisaPayAccepted, IntegratedMerchantCreditCard
This enumeration value indicates that no payment method has been specified for the listing. This may be the case for a classified ad listing, since payment happens outside of the eBay platform.
This enumeration value indicates that a money order or cashiers check is accepted for payment.
This enumeration value indicates that American Express is accepted for payment.
This enumeration value indicates that buyers should check the listing description for more details on payment. This may be the case for a classified ad listing, since payment happens outside of the eBay platform.
This enumeration value indicates that credit cards are accepted for payment.
<br/><br/>
<span class="tablenote"><b>Note: </b>
This enumeration value is also returned in the response of order management calls if the seller is opted in to eBay Managed Payments, and the buyer used an eBay gift card to pay the full or partial balance of the order.
</span>
This enumeration value indicates that a personal check is accepted for payment.
This enumeration value indicates that cash on delivery of item is accepted for payment.
This enumeration value indicates that Visa or MasterCard are accepted for payment.
This enumeration value indicates that PaisaPay is accepted for payment. This form of payment is only available to buyers in India.
This enumeration value may be returned if the payment method is unknown.
This enumeration value indicates that PayPal is accepted as a payment method. If PayPal is set by the seller as an accepted payment method, the seller must also supply their PayPal email address through the <b>Item.PayPalEmailAddress</b> field in an Add/Revise/Relist call. <br>
<br>
If you don't pass PayPal in the listing request but the seller's eBay
preferences are set to accept PayPal on all listings,
eBay will add PayPal as a payment method for you in most cases,
and we may return a warning. <br>
<br>
Except for sellers opted in to eBay Managed Payments, PayPal must be the only accepted payment method to enable the immediate payment feature (Item.AutoPay). PayPal must be accepted for charity listings. PayPal must be accepted for event ticket listings when the venue is in New York state or Illinois, so that eBay can offer buyer protection (per state law). (For some applications, it may be simplest to use errors returned from VerifyAddItem to flag the PayPal requirement for New York and Illinois ticket listings.) PayPal must be accepted for US eBay Motors listings that require a deposit (and it will not be set automatically based on the seller's preferences). Conversely, if PayPal is specified for US eBay Motors listings, deposit attributes must be specified.<br>
This enumeration value indicates that Discover Card is accepted for payment.
This enumeration value indicates that cash on pickup is accepted for payment.
This enumeration value indicates that a direct transfer of money is accepted for payment.
This enumeration value indicates that a direct transfer of money during checkout is accepted for payment.
This enumeration value may be returned if the payment method is unknown.
Reserved for future use.
Reserved for future use.
Reserved for future use.
Reserved for future use.
Reserved for internal or future use.
This enumeration value indicates that a loan check is accepted for payment. This option is generally only applicable to motor vehicle listings.
This enumeration value indicates that cash is accepted for payment. This option is generally only applicable to motor vehicle listings on the US and Canada sites.
Elektronisches Lastschriftverfahren (direct debit).
Only applicable to the Express Germany site, which has been shut down.
579
NoOp
This payment type is no longer applicable since eBay India is no longer a functioning site.
This payment type is no longer applicable since eBay India is no longer a functioning site.
<span class="tablenote"><b>Note: </b>
This enumeration value should no longer be passed in as an accepted payment method on any eBay marketplace. If this value is specified in an Add/Revise/Relist call, it will be ignored and dropped. eBay no longer supports electronic payments through Integrated Merchant Credit Card accounts. To accept online credit card payments from buyers, a seller must use specify 'PayPal' as a payment method, and the buyer can pay by credit card through their PayPal account, or the seller must opt in to eBay Managed Payments program, and eBay will process credit card payments.
</span>
<span class="tablenote"><b>Note:</b>
This payment method is no longer an acceptable form of payment. Sellers may no longer offer this payment method to buyers when creating new listings.
</span>
<br>
The Moneybookers payment method.
For more information, see http://www.moneybookers.com/partners/us/ebay.
Only applicable to the US site (and
to the Parts and Accessories category of the US eBay Motors site).
<span class="tablenote"><b>Note:</b>
This payment method is no longer an acceptable form of payment. Sellers may no longer offer this payment method to buyers when creating new listings.
</span>
<br>
The Paymate payment method. This payment method is only accepted on the eBay Australia site. For more information on setting up Paymate as an accepted payment method on the eBay Australia site,
see the <a href="http://www.paymate.com/cms/index.php/sellers/sell-on-ebay/selling-on-ebay" target="_blank">Sell with Paymate on eBay.com.au</a> help page.
<span class="tablenote"><b>Note:</b>
This payment method is no longer an acceptable form of payment. Sellers may no longer offer this payment method to buyers when creating new listings.
</span>
<br>
The ProPay payment method. US site only. For more information,
see http://www.Propay.com/eBay.
PayOnPickup payment method. PayOnPickup is the same as CashOnPickup.
For listings on the eBay US site, the user interface refers to this feature as Pay on pickup.
In the user interface of your application, please refer to the feature as Pay on pickup so that
the name in your user interface corresponds to the name on the eBay US site.
This enumeration value indicates that the Diners Club credit card is accepted for payment.
This value is no longer used.
This value indicates that a debit card can be used/was used to pay for the order. This payment method value must be passed in one of the <b>Item.PaymentMethods</b> fields if the seller is making the item available for eBay Now delivery. For eBay Now orders, the eBay Now valet accepts debit cards as a form of payment. This value is only applicable for eBay Now orders.
This enumeration value is returned in the response of order management calls if the seller is opted in to eBay Managed Payments, and the buyer has paid for the order with any accepted payment method except an eBay gift card. If the buyer used an eBay gift card to pay the full or partial balance of the order, the <code>CCAccepted</code> value will be returned instead.
<br/><br/>
This is not an enumeration value that a seller would pass in as an accepted payment method.
This buyer payment method is only applicable for the Germany site and is associated with the rollout of Progressive Checkout and the Pay Upon Invoice feature. 'PayUponInvoice' is not a payment method that is offered to the buyer, but instead, eBay/PayPal makes the determination (based on several factors) during checkout whether the buyer is eligible for 'Pay Upon Invoice'. If the buyer is offered the 'Pay Upon Invoice' option, that buyer is not required to pay for the order until an order invoice is sent by the seller. The seller must offer PayPal as a payment option or the 'Pay Upon Invoice' option will not be made available to the buyer under any circumstance.
<br><br>
Only select categories on the Germany site will support the 'Pay Upon Invoice' option, and orders going above the two-thousand dollar EURO mark will not be eligible for 'Pay Upon Invoice'.
<br><br>
Since the seller can not specify 'Pay Upon Invoice' as a payment method, this enumeration value cannot be passed into a <b>Item.PaymentMethods</b> field in an Add/Revise/Relist call.
This value indicates that QIWI can be used/was used by Russian buyers to pay for the order. This payment method value must be passed in one of the <b>Item.PaymentMethods</b> fields in an Add/Revise/Relist API call if the seller wants to make QIWI an available payment method for Russian buyers. QIWI works in conjunction with PayPal, so if 'QIWI' is set as an available payment method, 'PayPal' must be specified as well. This value can only be specified on the eBay US site, and it is only applicable for Russian buyers.
This value indicates that a PayPal credit card can be used/was used to pay for the order.
Security header used for SOAP API calls.
Authentication token representing the user who is making the
request. The user's token must be retrieved from eBay. To determine
a user's authentication token, see the Authentication and
Authorization information in the eBay Web Services guide. For calls
that list or retrieve item or transaction data, the user usually
needs to be the seller of the item in question or, in some cases,
the buyer. Similarly, calls that retrieve user or account data may
be restricted to the user whose data is being requested. The
documentation for each call includes information about such
restrictions.
2000
FetchToken
Yes
Getting Tokens
http://developer.ebay.com/DevZone/guides/features-guide/Basics/Tokens.html
Expiration date of the user's authentication token. Only returned
within the 7-day period prior to a token's expiration. To ensure
that user authentication tokens are secure and to help avoid a
user's token being compromised, tokens have a limited life span. A
token is only valid for a period of time (set by eBay). After this
amount of time has passed, the token expires and must be replaced
with a new token.
GetSessionID,FetchToken
Conditionally
Authentication information for the user on whose behalf the
application is making the request, and authorization information for
the application making the request. Only registered eBay users are
allowed to make API calls. To verify that a user is registered, your
application normally needs to pass a user-specific value called an
"authentication token" in the request. This is equivalent to signing
in on the eBay Web site. As API calls do not pass session
information, you need to pass the user's authentication token every
time you invoke a call on their behalf. All calls require an
authentication token, except the calls you use to retrieve a token
in the first place. For such calls, you use the eBay member's
username and password instead.
FetchToken
Yes
A Base64-encoded MD5 hash that allows the recipient of a Platform
Notification to verify this is a valid Platform Notification sent by
eBay.
Specifies standard subsets of data to return for each result
within the set of results in the response payload. If no
detail level is specified, a base set of data is returned.
The base set of data varies per call.
Returns all available data.
With <b>GetSellerList</b> and other calls that retrieve large data sets,
please avoid using <b>ReturnAll</b> when possible. For example, if you use
<b>GetSellerList</b>, use a <b>GranularityLevel</b> or use the
<b>GetSellerEvents</b> call instead. If you use <b>ReturnAll</b> with <b>GetSellerList</b>,
use a small <b>EntriesPerPage</b> value and a short
<b>EndTimeFrom</b>/<b>EndTimeTo</b> range for better performance.
Returns the description, plus the
<b>ListingDesigner</b> node and some additional information if applicable
For <b>GetItem</b>, returns Item Specifics and
Pre-filled Item Information, if any.
Also see the description of
<b>Item.ProductListingDetails</b> for <b>GetItem</b>.
If this value is used, the primary category and, if applicable, the secondary category is returned.
Returns the summary data.
For <b>GetMyMessages</b>, this detail level returns the same data
whether or not you include <b>MessageIDs</b> or <b>AlertIDs</b> in the
request. Returns up to 10 <b>FolderID</b> and <b>FolderName</b> values.
Currently, this detail level is the only way to retrieve
<b>FolderID</b> and <b>FolderName</b> values. See <b>GetMyMessages</b>
for a code sample that demonstrates
this.
Returns message headers.
For <b>GetMyMessages</b>, if you include <b>MessageIDs</b> or <b>AlertIDs</b> in
the request, this detail level returns header information,
without body text, for the specified message ID or alert ID
values. If you include a <b>FolderID</b>, header information is
returned only for the messages and alerts in the specified
folder.<br/><br/>
If you do not include <b>MessageIDs</b> or <b>AlertIDs</b>, this detail
level returns header information for Alerts and Messages as follows:
<ul>
<li>If all the Alerts have been read, they are sorted in date order,
with the most recent first.</li>
<li>If one of the Alerts has not been read, the Read Alerts come first,
sorted most recent first, followed by the Unread Alert(s).</li>
<li>All messages in ascending order by date received with the
oldest messages first.</li>
</ul>
<br/>
<span class="tablenote"><b>Note:</b>
Even when restricted by this detail level to return only header information, <b>GetMyMessages</b> may return a high volume of data.
</span>
Returns full message information.
For <b>GetMyMessages</b>, if you include <b>MessageIDs</b> or <b>AlertIDs</b> in
the request, this detail level returns message information
for the specified message ID or alert ID values. If you
include a <b>FolderID</b>, message information is returned only for
the messages and alerts in the specified folder.
Defines the action taken on a dispute with <b>AddDisputeResponse</b>. The value
you can use at a given time depends on the current value of <b>DisputeState</b>
(see the <a href="http://developer.ebay.com/DevZone/guides/features-guide/default.html#Development/UPI-Assistant.html">Unpaid Item Assistant</a> for more information). Some values are for
<i>Unpaid Item</i> disputes and some are for <i>Item Not Received</i> disputes.
<br/><br/>
<span class="tablenote"><strong>Note:</strong>
The <b>AddDisputeResponse</b> call cannot be used to communicate about an 'Item Not Received' or 'Significantly Not As Described' case initiated by a buyer through the eBay Money Back Guarantee program. The <a href="https://developer.ebay.com/Devzone/post-order/concepts/UsageGuide.html">Post-Order API</a> is used to respond to eBay Money Back Guarantee cases programmatically.
</span>
The seller wants to add a response to the dispute. For <i>Unpaid Item</i> disputes. The seller is limited to 25 responses.
The buyer has paid or the seller otherwise does not need to
pursue the dispute any longer. For <i>Unpaid Item</i> disputes.
The seller has made an agreement with the buyer and requires a
credit for a Final Value Fee already paid. For <i>Unpaid Item</i> disputes.
The seller wants to end communication or stop waiting for the
buyer. For <i>Unpaid Item</i> disputes.
The seller wants to end communication or stop waiting for the
buyer. Mutual agreement has been reached or the buyer has not
responded within four days. For <i>Unpaid Item</i> disputes.
The seller offers a full refund if the buyer did not receive
the item or a partial refund if the item is significantly not as
described. For <i>Item Not Received</i> and <i>Significantly Not As Described</i>
disputes.
<br/><br/>
This can be used when <b>DisputeState</b> is:
<br>
<code>NotReceivedNoSellerResponse</code><br>
<code>NotAsDescribedNoSellerResponse</code><br>
<code>NotReceivedMutualCommunication</code><br>
<code>NotAsDescribedMutualCommunication</code>
The seller has shipped the item or a replacement and provides
shipping information. For <i>Item Not Received</i> and <i>Significantly Not As Described</i> disputes.
<br/><br/>
This can be used when <b>DisputeState</b> is:
<br>
<code>NotReceivedNoSellerResponse</code><br>
<code>NotReceivedMutualCommunication</code>
The seller communicates with the buyer, offering a response or
comment. The seller is limited to 25 responses.
For <i>Item Not Received</i> and <i>Significantly Not As Described</i>
disputes.
<br/><br/>
This can be used when DisputeState is:<br>
<code>NotReceivedNoSellerResponse</code><br>
<code>NotAsDescribedNoSellerResponse</code><br>
<code>NotReceivedMutualCommunication</code><br>
<code>NotAsDescribedMutualCommunication</code>
The buyer has not received an expected full or partial refund from the
seller in an <i>Item Not Received</i> and <i>Significantly Not As Described</i> buyer
dispute.
<br/><br/>
This can be used when <b>DisputeState</b> is:<br>
<code>NotReceivedNoSellerResponse</code> <br>
<code>NotReceivedMutualCommunication</code> <br>
Reserved for internal or future use.
Indicates whether the seller is eligible for a Final Value Fee credit if the
dispute is resolved by the buyer and seller, or if eBay customer support makes a
decision on the dispute in the seller's favor. Note that even if the item is
eligible for a Final Value Fee credit, the credit is not guaranteed in any way.
<br/><br/>
<span class="tablenote"><strong>Note:</strong>
'Item Not Received' or 'Significantly Not As Described' cases, initiated by buyers through the eBay Money Back Guarantee program, are not returned with <b>GetDispute</b> or <b>GetUserDisputes</b>. The <a href="https://developer.ebay.com/Devzone/post-order/post-order_v2_casemanagement-caseId__get.html#overview">getCase</a> method of the <a href="https://developer.ebay.com/Devzone/post-order/concepts/UsageGuide.html">Post-Order API</a> is used to retrieve Money Back Guarantee cases programmatically.
</span>
The seller is not currently eligible for a Final Value Fee credit.
The seller is eligible for a Final Value Fee credit.
Reserved for internal or future use.
Enumerated type that contains the explanations for a buyer or seller opening a case
against one another. These values are specified in the <b>DisputeExplanation</b>
field of <b>AddDispute</b>, and are returned in the
<b>GetUserDisputes</b> and <b>GetDispute</b> calls. The
<b>DisputeReason</b> value will dictate what
<b>DisputeExplanation</b> values that can be used/returned.
<br/><br/>
<span class="tablenote"><strong>Note:</strong>
The dispute calls in the Trading API are not compatible with 'Item Not Received' or 'Significantly Not As Described' cases initiated by buyers through the eBay Money Back Guarantee program. The <a href="https://developer.ebay.com/Devzone/post-order/concepts/UsageGuide.html">Post-Order API</a> is used to retrieve and/or respond to eBay Money Back Guarantee cases programmatically.
</span>
BuyerNoLongerRegistered, PaymentMethodNotSupported, ShipCountryNotSupported
This value indicates that the buyer has not paid for the order line item, and has
not responded to the seller regarding payment. This value is allowed when the
<b>DisputeReason</b> value is <b>BuyerHasNotPaid</b>.
This value indicates that the buyer has not paid for the order line item, and
according to the seller, has refused to pay for the order line item. This value is
allowed when the <b>DisputeReason</b> value is
<b>BuyerHasNotPaid</b>.
This value indicates that the buyer has not paid for the order line item, and
is not cleared by eBay to pay. This value is allowed when the
<b>DisputeReason</b> value is
<b>BuyerHasNotPaid</b>.
This value indicates that the buyer has returned the item, and seller has agreed to
cancel the order and issue a refund to the buyer. This value is allowed when the
<b>DisputeReason</b> value is <b>TransactionMutuallyCanceled</b>.
This value indicates that the buyer and seller were unable to resolve a disagreement
over terms, and the seller is willing to cancel the order line item. This value is allowed when the
<b>DisputeReason</b> value is <b>TransactionMutuallyCanceled</b>.
This value indicates that the buyer no longer wants the item (buyer remorse), and
the seller is willing to cancel the order line item. This value is allowed when the
<b>DisputeReason</b> value is
<b>TransactionMutuallyCanceled</b>.
This value indicates that the buyer made a mistake by purchasing the item, and
the seller is willing to cancel the order line item. This value is allowed when the
<b>DisputeReason</b> value is
<b>TransactionMutuallyCanceled</b>.
This value is deprecated, and should not be used.
This value indicates that the buyer is requesting shipment of the item to an
unconfirmed (not on file with eBay) address. This value is allowed when the
<b>DisputeReason</b> value is <b>BuyerHasNotPaid</b> or
<b>TransactionMutuallyCanceled</b>.
This value is deprecated, and should not be used.
This value is deprecated.
This value can be used when no other explanation in <b>
DisputeExplanationCodeType</b> is appropriate for the situation. This value is
allowed when the <b>DisputeReason</b> value is
<b>BuyerHasNotPaid</b> or
<b>TransactionMutuallyCanceled</b>.
This value can be used when no other explanation in
<b>DisputeExplanationCodeType</b> is appropriate for the situation. This
value is allowed when the <b>DisputeReason</b> value is
<b>ItemNotReceived</b> or <b>SignificantlyNotAsDescribed</b>.
This value cannot be used in <b>AddDispute</b>.
This value indicates that the Unpaid Item case was opened by eBay through the Unpaid
Item Assistance mechanism. This value cannot be used in
<b>AddDispute</b>.
This value indicates that the buyer has not paid the seller for the order line item,
or has paid the seller but the payment has not cleared. This value is allowed when
the <b>DisputeReason</b> value is <b>BuyerHasNotPaid</b>.
This value indicates that the buyer is requesting shipment of the item to a country
that is on the seller's ship-to exclusion list. This value is allowed when the
<b>DisputeReason</b> value is <b>BuyerHasNotPaid</b> or
<b>TransactionMutuallyCanceled</b>.
This value indicates that the buyer has not paid for the order line item. This value
is allowed when the <b>DisputeReason</b> value is
<b>BuyerHasNotPaid</b>.
This value indicates that the Unpaid Item case was opened by eBay through the Unpaid
Item Assistance mechanism, and then was subsequently converted to a manual dispute,
either by the seller or by eBay. This value cannot be used in
<b>AddDispute</b>.
This value indicates that the seller ran out of stock on the item, cannot fulfill
the order, and has to cancel the order line item. This value is allowed when the
<b>DisputeReason</b> value is
<b>TransactionMutuallyCanceled</b>.
Reserved for internal or future use.
The number of disputes that match a given filter.
<br/><br/>
<span class="tablenote"><strong>Note:</strong>
'Item Not Received' or 'Significantly Not As Described' cases, initiated by buyers through the eBay Money Back Guarantee program, are not returned with <b>GetUserDisputes</b>. The <a href="https://developer.ebay.com/Devzone/post-order/post-order_v2_casemanagement-caseId__get.html#overview">getCase</a> method of the <a href="https://developer.ebay.com/Devzone/post-order/concepts/UsageGuide.html">Post-Order API</a> is used to retrieve Money Back Guarantee cases programmatically.
</span>
A filter used to reduce the number of disputes returned. The filter uses criteria
such as whether the dispute is awaiting a response, is closed, or is eligible for
credit. Both <i>Unpaid Item</i> and <i>Item Not Received</i> disputes can be returned for the
same filter value.
GetUserDisputes
DetailLevel: ReturnSummary, ReturnAll, none
Always
The number of disputes that match the filter.
In the <b>GetUserDisputes</b> response, not returned for the filter type
that was used in the request.
GetUserDisputes
DetailLevel: ReturnSummary, ReturnAll, none
Always
Enumeration type that specifies the dispute filters that can be used in the
<b>DisputeFilterType</b> field of the <b>GetUserDisputes</b> call.
<br/><br/>
<span class="tablenote"><strong>Note:</strong>
'Item Not Received' or 'Significantly Not As Described' cases, initiated by buyers through the eBay Money Back Guarantee program, are not returned with <b>GetUserDisputes</b>, regardless of what filter value is used. The <a href="https://developer.ebay.com/Devzone/post-order/post-order_v2_casemanagement-caseId__get.html#overview">getCase</a> method of the <a href="https://developer.ebay.com/Devzone/post-order/concepts/UsageGuide.html">Post-Order API</a> is used to retrieve Money Back Guarantee cases programmatically.
</span>
If used, this filter returns all open and closed disputes that involve the caller as a buyer
or seller.
If used, this filter returns all open disputes that involve the caller as a buyer
or seller and are awaiting a response from the caller. This is the default <b>DisputeFilterType</b> value. In other words, if no <b>DisputeFilterType</b> is specified in the request, only those disputes where the caller's response is due are returned.
If used, this filter returns all open disputes that involve the caller as a buyer or seller and
are awaiting a response from the other party.
If used, this filter returns all closed disputes that involve the caller as a buyer
or seller.
If used, this filter returns all disputes that involve the caller as a buyer
or seller and are eligible for a Final Value Fee credit, regardless of
whether or not the credit has been granted.
If used, this filter returns all open and closed <i>Unpaid Item</i> disputes that
involve the caller as a buyer or seller.
If used, this filter returns all open and closed <i>Item Not Received</i> disputes that involve the caller as a buyer or seller.
<br/><br/>
<span class="tablenote"><strong>Note:</strong>
This filter is only used to retrieve any 'Item Not Received' or 'Significantly Not As Described' disputes that a buyer initiated through their PayPal account. As noted above, the <b>GetUserDisputes</b> call will not return any eBay Money Back Guarantee cases.
</span>
Reserved for future use.
The unique identifier of a dispute between a buyer and seller regarding an order.
<br/><br/>
<span class="tablenote"><strong>Note:</strong>
The dispute calls in the Trading API are not compatible with 'Item Not Received' or 'Significantly Not As Described' cases initiated by buyers through the eBay Money Back Guarantee program. The <a href="https://developer.ebay.com/Devzone/post-order/concepts/UsageGuide.html">Post-Order API</a> is used to retrieve and/or respond to eBay Money Back Guarantee cases programmatically.
</span>
Defines who added a message to a dispute. Used for both <i>Unpaid Item</i> cases and <i>Item Not Received</i> disputes initiated by buyers through PayPal's platform.
<br/><br/>
<span class="tablenote"><strong>Note:</strong>
'Item Not Received' or 'Significantly Not As Described' cases, initiated by buyers through the eBay Money Back Guarantee program, are not returned with <b>GetDispute</b> or <b>GetUserDisputes</b>. The <a href="https://developer.ebay.com/Devzone/post-order/post-order_v2_casemanagement-caseId__get.html#overview">getCase</a> method of the <a href="https://developer.ebay.com/Devzone/post-order/concepts/UsageGuide.html">Post-Order API</a> is used to retrieve Money Back Guarantee cases programmatically.
</span>
The buyer of the item under dispute.
The seller of the item under dispute.
eBay, either an administrator or the site itself.
Reserved for internal or future use.
Contains a message posted to a dispute. The message can be posted
by the buyer, the seller, or an eBay representative.
<br/><br/>
<span class="tablenote"><strong>Note:</strong>
'Item Not Received' or 'Significantly Not As Described' cases, initiated by buyers through the eBay Money Back Guarantee program, are not returned with <b>GetDispute</b> or <b>GetUserDisputes</b>. The <a href="https://developer.ebay.com/Devzone/post-order/post-order_v2_casemanagement-caseId__get.html#overview">getCase</a> method of the <a href="https://developer.ebay.com/Devzone/post-order/concepts/UsageGuide.html">Post-Order API</a> is used to retrieve Money Back Guarantee cases programmatically.
</span>
An ID that uniquely identifies the message.
GetDispute
Always
GetUserDisputes
DetailLevel: ReturnAll, none
Conditionally
The party who posted the message: the buyer, the seller,
or an eBay representative.
GetDispute
Always
GetUserDisputes
DetailLevel: ReturnAll, none
Conditionally
The date and time the message was created, in GMT.
GetDispute
Always
GetUserDisputes
DetailLevel: ReturnAll, none
Conditionally
The text of the message.
GetDispute
Always
GetUserDisputes
DetailLevel: ReturnAll, none
Conditionally
Enumerated type that contains the top-level reasons for a buyer or seller to create a
case against one another. These values are specified in the
<b>DisputeReason</b> field of <b>AddDispute</b>, and are returned
in the <b>GetUserDisputes</b> and <b>GetDispute</b> calls.
The <b>DisputeReason</b> value will dictate what
<b>DisputeExplanation</b> values that can be used/returned.
<br/><br/>
<span class="tablenote"><strong>Note:</strong>
The dispute calls in the Trading API are not compatible with 'Item Not Received' or 'Significantly Not As Described' cases initiated by buyers through the eBay Money Back Guarantee program. The <a href="https://developer.ebay.com/Devzone/post-order/concepts/UsageGuide.html">Post-Order API</a> is used to retrieve and/or respond to eBay Money Back Guarantee cases programmatically.
</span>
The seller has opened a case against the buyer because the buyer has not paid for
the order line item. A seller can open an <i>Unpaid Item</i> case as early as two days after
the end of the auction listing. An exception to this rule occurs when the seller
allows combined payment orders. If the seller does allow the buyer to combine orders
and make one payment for those orders, the seller would not be able to open an Unpaid
Item case until after the time period to combine orders expires.
<br>
With the mutual consent of the buyer, the seller is canceling the order line item.
The buyer has opened a case against the seller because the item has not been
received by the buyer. A buyer can open an <i>Item Not Received</i> case after the
Estimated Delivery Date of the item has passed, or 7 days after payment if the
Estimated Delivery Date wasn't given by the seller. This value cannot be used in
<b>AddDispute</b>.
The buyer has opened a case against the seller because the item was received but
does not match the item description in the listing. A buyer can open an <i>Item
Significantly Not As Described</i> case immediately after receiving the item. This value
cannot be used in <b>AddDispute</b>.
The item was returned but no refund was given. This value cannot be used in
<b>AddDispute</b>.
Item was returned and seller was not paid. This value cannot be used in
<b>AddDispute</b>.
Reserved for future or internal use.
HalfDispute
Enumerated type that lists the different types of order disputes that can occur between buyer and seller.
<br/><br/>
<span class="tablenote"><strong>Note:</strong>
'Item Not Received' or 'Significantly Not As Described' cases, initiated by buyers through the eBay Money Back Guarantee program, are not returned with <b>GetDispute</b> or <b>GetUserDisputes</b>. The <a href="https://developer.ebay.com/Devzone/post-order/post-order_v2_casemanagement-caseId__get.html#overview">getCase</a> method of the <a href="https://developer.ebay.com/Devzone/post-order/concepts/UsageGuide.html">Post-Order API</a> is used to retrieve Money Back Guarantee cases programmatically.
</span>
This enumeration value indicates that the dispute is an Unpaid Item case created by the seller against the buyer. A seller should always try to resolve an Unpaid Item issue with the buyer before opening up a case with eBay. Sometimes, just sending payment reminders to the buyer or messaging the buyer through the Messaging platform can be helpful. The <a href="https://www.ebay.com/help/selling/getting-paid/resolving-unpaid-items-buyers?id=4137">Resolving unpaid items with buyers</a> help topic provides more details and tips on trying to work Unpaid Item issues out with the buyer.
This enumeration value indicates that the dispute is an Item Not Received case created by the buyer against the seller through PayPal's platform.
<br/><br/>
<span class="tablenote"><strong>Note:</strong>
As noted above, the <b>GetDispute</b> or <b>GetUserDisputes</b> calls will not return any eBay Money Back Guarantee cases.
</span>
This enumeration value is no longer applicable as the Half.com marketplace is shut down.
Reserved for internal or future use.
This enumerated type defines the possible reasons why an order dispute between a buyer and seller is resolved.
<br/><br/>
<span class="tablenote"><strong>Note:</strong>
The dispute calls in the Trading API are not compatible with 'Item Not Received' or 'Significantly Not As Described' cases initiated by buyers through the eBay Money Back Guarantee program. The <a href="https://developer.ebay.com/Devzone/post-order/concepts/UsageGuide.html">Post-Order API</a> is used to retrieve and/or respond to eBay Money Back Guarantee cases programmatically.
</span>
This enumeration value indicates that the dispute has not been resolved.
This enumeration value indicates that the buyer was able to provide proof of payment for an Unpaid Item case.
This enumeration value indicates that the buyer or seller had a technical problem with a computer.
This enumeration value indicates that the buyer and seller have not made any contact with one another.
This enumeration value indicates that the buyer or seller had a family emergency.
This enumeration value indicates that the buyer was able to provide proof of payment for an Unpaid Item case through the Feedback system.
This enumeration value indicates that the dispute was the buyer's first infraction, and thus resolved.
This enumeration value indicates that the buyer and seller came to an agreement.
This enumeration value indicates that the buyer successfully returned the item, and thus an Unpaid Item case was closed.
This enumeration value indicates that the buyer reimbursed the seller's listing fees.
This enumeration value indicates that the seller received payment for the item, and thus an Unpaid Item case was closed.
This enumeration value indicates that an undefined resolution occurred.
This enumeration value indicates that the claim was paid.
Reserved for future use.
Enumerated type that lists the actions that eBay may take once a dispute is resolved.
<br/><br/>
<span class="tablenote"><strong>Note:</strong>
'Item Not Received' or 'Significantly Not As Described' cases, initiated by buyers through the eBay Money Back Guarantee program, are not returned with <b>GetUserDisputes</b>. The <a href="https://developer.ebay.com/Devzone/post-order/post-order_v2_casemanagement-caseId__get.html#overview">getCase</a> method of the <a href="https://developer.ebay.com/Devzone/post-order/concepts/UsageGuide.html">Post-Order API</a> is used to retrieve Money Back Guarantee cases programmatically.
</span>
This enumeration value indicates that the buyer received an Unpaid Item Strike.
This enumeration value indicates that the buyer's account has been suspended, and buyer will be unable to use the eBay site.
This enumeration value indicates that the buyer's activity is restricted and will be unable to bid on or purchase items.
This enumeration value indicates that the seller received a Final Value Fee credit.
This enumeration value indicates that the seller's listing fees were credited.
This enumeration value indicates that the buyer has appealed the Unpaid Item Strike against their account.
This enumeration value indicates that the buyer's account has been reinstated.
This enumeration value indicates that all restrictions on the buyer's account have ended.
This enumeration value indicates that the seller's Final Value Fee credit was reversed.
This enumeration value indicates that the seller's listing fees credit was reversed.
This enumeration value indicates that a customer service ticket to suspend The buyer's account has been created.
This enumeration value indicates that the seller requested, but did not receive a Final Value Fee credit.
This enumeration value indicates that the buyer did not receive the item, and filed a claim against the seller.
This enumeration value indicates that an Unpaid Item was automatically relisted by the Unpaid Item Assistant mechanism.
This enumeration value indicates that an Unpaid Item was automatically revised by the Unpaid Item Assistant mechanism.
Reserved for future use.
Reserved for future use.
Reserved for future use.
This enumeration value indicates that the seller received a credit for feature fees.
This enumeration value indicates that the seller did not receive a credit for feature fees.
This enumeration value indicates that the seller's feature fees credit was reversed.
Reserved for internal or future use.
Contains all information about a dispute resolution. A dispute
can have a resolution even if the seller does not receive payment.
The resolution can have various results, including a Final Value Fee credit to
the seller or a strike to the buyer.
<br/><br/>
<span class="tablenote"><strong>Note:</strong>
'Item Not Received' or 'Significantly Not As Described' cases, initiated by buyers through the eBay Money Back Guarantee program, are not returned with <b>GetUserDisputes</b>. The <a href="https://developer.ebay.com/Devzone/post-order/post-order_v2_casemanagement-caseId__get.html#overview">getCase</a> method of the <a href="https://developer.ebay.com/Devzone/post-order/concepts/UsageGuide.html">Post-Order API</a> is used to retrieve Money Back Guarantee cases programmatically.
</span>
The action resulting from the resolution, affecting either
the buyer or the seller.
GetUserDisputes
DetailLevel: ReturnAll, none
Conditionally
CSGetDisputeSummary
Always
The reason for the resolution. The DisputeResolutionReason
results in the action described by the DisputeResolutionRecordType.
GetUserDisputes
DetailLevel: ReturnAll, none
Conditionally
CSGetDisputeSummary
Always
The date and time the dispute was resolved, in GMT.
GetUserDisputes
DetailLevel: ReturnAll, none
Conditionally
CSGetDisputeSummary
Always
Enumerated type that defines the values that can be used in the <b>DisputeSortType</b> filter of the <b>GetUserDisputes</b> request to control the order of disputes that are returned.
<br/><br/>
<span class="tablenote"><strong>Note:</strong>
'Item Not Received' or 'Significantly Not As Described' cases, initiated by buyers through the eBay Money Back Guarantee program, are not returned with <b>GetUserDisputes</b>. The <a href="https://developer.ebay.com/Devzone/post-order/post-order_v2_casemanagement-caseId__get.html#overview">getCase</a> method of the <a href="https://developer.ebay.com/Devzone/post-order/concepts/UsageGuide.html">Post-Order API</a> is used to retrieve Money Back Guarantee cases programmatically.
</span>
This is the default value. If this value is used in the <b>DisputeSortType</b> field, or if the <b>DisputeSortType</b> field is omitted from the <b>GetUserDisputes</b> request, retrieved disputes are sorted according to dispute creation time, in descending order.
If this value is used in the <b>DisputeSortType</b> field, retrieved disputes are sorted according to dispute creation time, in ascending order.
If this value is used in the <b>DisputeSortType</b> field, retrieved disputes are sorted according to dispute creation time, in descending order.
If this value is used in the <b>DisputeSortType</b> field, retrieved disputes are sorted according to dispute status, in ascending order.
If this value is used in the <b>DisputeSortType</b> field, retrieved disputes are sorted according to dispute status, in descending order.
If this value is used in the <b>DisputeSortType</b> field, retrieved disputes are sorted according to whether the disputes are eligible for a Final Value Fee credit to the seller, in ascending order. In other words, disputes ineligible for a FVF credit are listed before disputes that are eligible for a FVF credit.
If this value is used in the <b>DisputeSortType</b> field, retrieved disputes are sorted according to whether the disputes are eligible for a Final Value Fee credit to the seller, in descending order. In other words, disputes eligible for a FVF credit are listed before disputes that are not eligible for a FVF credit.
Reserved for internal or future use.
Enumerated type that defines the possible states of an order dispute between buyer and seller.
<br/><br/>
<span class="tablenote"><strong>Note:</strong>
'Item Not Received' or 'Significantly Not As Described' cases, initiated by buyers through the eBay Money Back Guarantee program, are not returned with <b>GetDispute</b> or <b>GetUserDisputes</b>. The <a href="https://developer.ebay.com/Devzone/post-order/post-order_v2_casemanagement-caseId__get.html#overview">getCase</a> method of the <a href="https://developer.ebay.com/Devzone/post-order/concepts/UsageGuide.html">Post-Order API</a> is used to retrieve Money Back Guarantee cases programmatically.
</span>
This enumeration value indicates that the dispute is currently in a locked state, and cannot be updated by any user.
This enumeration value indicates that the dispute is closed. In some cases, a closed case can be reversed with the <b>SellerReverseDispute</b> call.
This enumeration value indicates that eBay sent the buyer an Unpaid Item Reminder with a Pay Now option, and is waiting for the buyer's first response.
This enumeration value indicates that eBay sent the buyer an Unpaid Item Reminder, but without a Pay Now option, and is waiting for the buyer's first response.
This enumeration value indicates that eBay sent the buyer an Unpaid Item Reminder with a Pay Now option, was waiting for the buyer's first response, but the buyer has failed to respond to this reminder within the 7-day grace period.
This enumeration value indicates that eBay sent the buyer an Unpaid Item Reminder without a Pay Now option, was waiting for the buyer's first response, but the buyer has failed to respond to this reminder within the 7-day grace period.
This enumeration value indicates that the buyer and seller have communicated, and eBay offered the buyer a Pay Now option.
This enumeration value indicates that the buyer and seller have communicated, but eBay has not offered the buyer a Pay Now option.
This enumeration value indicates that the dispute is pending resolution. A dispute cannot be closed by the buyer or seller when it is in this state.
This enumeration value indicates that the buyer and seller have mutually agreed to cancel the transaction within the grace period.
This enumeration value indicates that the buyer and seller have mutually agreed to cancel the transaction, but the grace period has expired.
This enumeration value indicates that the buyer filed an Item Not Received dispute through PayPal account, and the seller has not yet responded. A seller may respond to a case in this state by using the <b>AddDisputeResponse</b> call and setting the <b>DisputeActivity</b> value to <code>SellerOffersRefund</code>, <code>SellerShippedItem</code>, or <code>SellerComment</code>.
This enumeration value indicates that the buyer filed an Item Not As Described dispute through PayPal account, and the seller has not yet responded. A seller may respond to a case in this state by using the <b>AddDisputeResponse</b> call and setting the <b>DisputeActivity</b> value to <code>SellerOffersRefund</code> or <code>SellerComment</code>.
This enumeration value indicates that the buyer filed an Item Not Received dispute through PayPal account, and the buyer and seller have communicated about the issue. A seller may respond to a case in this state by using the <b>AddDisputeResponse</b> call and setting the <b>DisputeActivity</b> value to <code>SellerOffersRefund</code>, <code>SellerShippedItem</code>, or <code>SellerComment</code>.
This enumeration value indicates that the buyer filed an Item Not As Described dispute through PayPal account, and the buyer and seller have communicated about the issue. A seller may respond to a case in this state by using the <b>AddDisputeResponse</b> call and setting the <b>DisputeActivity</b> value to <code>SellerOffersRefund</code>.
This enumeration value indicates that the seller filed an Unpaid Item dispute, and the seller says mutual agreement has been reached and is
waiting for the buyer to confirm, or the buyer is returning the item
to the seller.
This enumeration value indicates that the claim was assigned to an adjuster.
This enumeration value indicates that the buyer was contacted by eBay and asked to submit paperwork to support the claim.
This enumeration value indicates that the claim was closed due to buyer not responding to verification, or was missing paperwork.
This enumeration value indicates that the buyer's claim was denied.
This enumeration value indicates that paperwork was received from the buyer and the claim is being investigated.
This enumeration value indicates that the buyer's claim was approved for reimbursement and was sent to accounts payable for payment.
This enumeration value indicates that the buyer was reimbursed for the claim.
This enumeration value indicates that the issue has been resolved due to the seller sending the item or refunding the buyer.
This enumeration value indicates that the claim was submitted via Web.
This enumeration value indicates that the Unpaid Item dispute is open.
This enumeration value indicates that the Unpaid Item dispute filed by the Unpaid Item Assistance mechanism was disabled by eBay (for example, eBay detected that payment was initiated and the seller needs to manually handle this dispute).
This enumeration value indicates that the Unpaid Item dispute filed by the Unpaid Item Assistance mechanism was disabled by the seller (e.g. the buyer and seller have communicated about payment and the seller wishes to extend the time for payment and not let the automatic process close the dispute automatically).
Reserved for internal or future use.
Enumerated type that defines the possible statuses of an order dispute between buyer and seller. The <b>DisputeState</b> and <b>DisputeStatus</b> values returned for each dispute complement one another.
<br/><br/>
If the <b>DisputeSortType</b> filter is used in a <b>GetUserDisputes</b> call and set to <code>DisputeStatusAscending</code>, retrieved disputes will be sorted in the following order according to <b>DisputeStatus</b>:
<ol>
<li><code>WaitingForSellerResponse</code></li>
<li><code>WaitingForBuyerResponse</code></li>
<li><code>ClosedFVFCreditStrike</code></li>
<li><code>ClosedNoFVFCreditStrike</code></li>
<li><code>ClosedFVFCreditNoStrike</code></li>
<li><code>ClosedNoFVFCreditNoStrike</code></li>
<li><code>Closed</code></li>
<li><code>StrikeAppealedAfterClosing</code></li>
<li><code>FVFCreditReversedAfterClosing</code></li>
<li><code>StrikeAppealedAndFVFCreditReversed</code></li>
</ol><br/>
If the <b>DisputeSortType</b> value is set to <code>DisputeStatusDescending</code> instead, retrieved disputes will be sorted in the opposite order of the ones listed above.
<br/><br/>
<span class="tablenote"><strong>Note:</strong>
'Item Not Received' or 'Significantly Not As Described' cases, initiated by buyers through the eBay Money Back Guarantee program, are not returned with <b>GetDispute</b> or <b>GetUserDisputes</b>. The <a href="https://developer.ebay.com/Devzone/post-order/post-order_v2_casemanagement-caseId__get.html#overview">getCase</a> method of the <a href="https://developer.ebay.com/Devzone/post-order/concepts/UsageGuide.html">Post-Order API</a> is used to retrieve Money Back Guarantee cases programmatically.
</span>
This enumeration value indicates that the dispute is closed.
This enumeration value indicates that the dispute is waiting for the seller's response.
This enumeration value indicates that the dispute is waiting for the buyer's response.
This enumeration value indicates that the Unpaid Item dispute is closed, the seller received a Final Value Fee credit, and the buyer received a strike.
This enumeration value indicates that the Unpaid Item dispute is closed, the seller did not receive a Final Value Fee credit, and the buyer received a strike.
This enumeration value indicates that the Unpaid Item dispute is closed, the seller received a Final Value Fee credit, and the buyer did not receive a strike.
This enumeration value indicates that the Unpaid Item dispute is closed, the seller did not receive a Final Value Fee credit, and the buyer did not receive a strike.
This enumeration value indicates that the Unpaid Item dispute was closed with a buyer's strike, but the buyer has appealed that strike.
This enumeration value indicates that the seller's Final Value Fee credit was reversed after the Unpaid Item dispute was closed.
This enumeration value indicates that the seller's Final Value Fee credit was reversed and the buyer's strike was appealed after the Unpaid Item dispute was closed.
This enumeration value indicates that the claim was assigned to an adjuster.
This enumeration value indicates that the buyer was contacted by eBay and asked to submit paperwork.
This enumeration value indicates that the claim was closed due to the buyer not responding to verification or due to missing paperwork.
This enumeration value indicates that the claim was denied.
This enumeration value indicates that paperwork was received for the claim, and the claim is being investigated.
This enumeration value indicates that the claim was approved for reimbursement, and sent to accounts payable for payment.
This enumeration value indicates that the claim was paid.
This enumeration value indicates that the buyer's dispute against the seller was resolved, due to the seller sending the item or refunding the buyer.
This enumeration value indicates that the claim was submitted via Web.
This enumeration value indicates that an Unpaid Item dispute was opened by the seller against the buyer.
Reserved for internal or future use.
This type is used by the <b>DuplicateInvocationDetails</b> container that is returned in some calls if a duplicate <b>InvocationID</b> or <b>InvocationTrackingID</b> is used in the call request.
This value represents the duplicate <b>InvocationID</b> or <b>InvocationTrackingID</b> that was used in the call request.
AddItem
AddItems
AddOrder
AddSecondChanceItem
AddToItemDescription
PlaceOffer
RelistItem
ReviseCheckoutStatus
ReviseItem
Conditionally
This enumeration value indicates the status of the previous call that used the <b>InvocationID</b> or <b>InvocationTrackingID</b> specified in the <b>DuplicateInvocationID</b>.
AddFixedPriceItem
AddItem
AddItems
AddOrder
AddSecondChanceItem
AddToItemDescription
PlaceOffer
RelistItem
ReviseCheckoutStatus
ReviseItem
Conditionally
This unique identifier identifies the business item the previous API invocation
created. For example, the Item ID of the item created by an <b>AddItem</b> call.
AddItem
AddItems
AddOrder
AddSecondChanceItem
AddToItemDescription
PlaceOffer
RelistItem
ReviseCheckoutStatus
ReviseItem
Conditionally
An error has occurred either as a result of a problem in the sending
application or because the application's end-user has attempted to submit
invalid data (or missing data). In these cases, do not retry the request. The
problem must be corrected before the request can be made again. If the problem
is due to something in the application (such as a missing required field), the
application must be changed. If the problem is a result of end-user data, the
application must alert the end-user to the problem and provide the means for
the end-user to correct the data. Once the problem in the application or data
is resolved, resend the request to eBay with the corrected data.
Indicates that an error has occurred on the eBay system side, such as a
database or server down. An application can retry the request as-is a
reasonable number of times (eBay recommends twice). If the error persists,
contact Developer Technical Support. Once the problem has been resolved, the
request may be resent in its original form.
(out) Reserved for internal or future use.
Preferences that specify how eBay should handle certain requests that contain
invalid data or that could partially fail. These preferences give you some control
over whether eBay returns warnings or errors in response to invalid data and how
eBay handles listing requests when such data is passed in. For example, these
preferences are applicable to <b>AddItem</b> and related calls when Item Specifics are
specified, and to <b>CompleteSale</b>. See <a href="http://developer.ebay.com/devzone/guides/features-guide/default.html#Basics/Call-ErrorHandling.html">Error Handling</a>
for details about these preferences and their effects.
Apply validation rules that were in effect prior to the time
the call started supporting <b>ErrorHandling</b>.
Drop the invalid data, continue processing the request with the
valid data. If dropping the invalid data leaves the request in a
state where required data is missing, reject the request.<br>
<br>
If <b>BestEffort</b> is specified for <b>CompleteSale</b>, the Ack field in the
response could return PartialFailure if one change fails but
another succeeds. For example, if the seller attempts to
leave feedback twice for the same order line item, the feedback changes
would fail but any paid or shipped status changes would succeed.
If any of the item specifics data is invalid, drop all the data and
proceed with listing the item. If the category has required item specifics
and the data was dropped, reject the listing.
If any data is invalid, reject the request.
This type is used by the <b>ErrorParameters</b> container if one or more errors or warnings occur with the call, and if a specific request parameter has been pinpointed as the reason why the error or warning was triggered.
This is the value of the request parameter noted in the <b>ParamID</b> attribute. So, if the <b>ParamID</b> value was <b>ItemID</b>, the value in this field would be the actual value of that <b>ItemID</b>.
Conditionally
This is name of the request parameter that has been pinpointed as the reason why the error or warning was triggered. This value might be <b>ItemID</b>, in which case the identifier of that item would be returned in the <b>Value</b> field.
Conditionally
These are request errors (as opposed to system errors) that occur due to problems
with business-level data (e.g., an invalid combination of arguments) that
the application passed in.
A brief description of the condition that raised the error.
Conditionally
A more detailed description of the condition that raised the error.
Conditionally
A unique code that identifies the particular error condition that occurred.
Your application can use error codes as identifiers
in your customized error-handling algorithms. See the "Errors by Number" document.
other
Conditionally
Indicates whether the error message text is intended to be displayed to an end user
or intended only to be parsed by the application. If true or not present (the default),
the message text is intended for the end user. If false, the message text is intended for
the application, and the application should translate the error into a more appropriate message.
Only applicable to Item Specifics errors and warnings returned from listing requests.
AddItem
AddItems
AddLiveAuctionItem
RelistItem
ReviseItem
ReviseLiveAuctionItem
VerifyAddItem
Conditionally
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.
Conditionally
This optional element carries a list of context-specific
error variables that indicate details about the error condition.
These are useful when multiple instances of <b>ErrorType</b> are returned.
Conditionally
API errors are divided between two classes: system errors and request errors.
Conditionally
SOAP faults are used to indicate that an infrastructure error has occurred,
such as a problem on eBay's side with database or server going down, or a
problem with the client or server-side SOAP framework.
Error code can be used by a receiving application to debug a SOAP response
message that contains one or more SOAP fault details.
Each error code is uniquely defined for each fault scenario.
See the eBay documentation for more information.
Your application can use error codes as identifiers
in your customized error-handling algorithms.
Indicates whether the error is a severe error (causing the request to fail)
or an informational error (a warning).
Description of the condition that caused the SOAP fault.
Basic type for specifying measures and the system of measurement.
A decimal value (e.g., 10.25) is meaningful
as a measure when accompanied by a definition of the unit of measure (e.g., Pounds),
in which case the value specifies the quantity of that unit.
A MeasureType expresses both the value (a decimal) and, optionally, the unit and
the system of measurement.
Details such as shipping weights are specified as measure types.
Unit of measure. This attribute is shared by various fields,
representing units such as lbs, oz, kg, g, in, cm.
<br><br>
For weight, English major/minor units are pounds and ounces,
and metric major/minor units are kilograms and grams.
For length, the English unit is inches, and metric unit is centimeters.
<br><br>
To get the full list of package dimension and weight measurement units
(and all alternative spellings and abbreviations) supported by your site,
call <b>GeteBayDetails</b>.
AddItem
AddItems
No
GetItemShipping
GetSellerTransactions
GetShippingDiscountProfiles
Conditionally
GetItem
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally
GeteBayDetails
GeteBayDetails.html
The system of measurement (e.g., English).
AddItem
AddItems
No
GetItem
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally
GetShippingDiscountProfiles
Conditionally
This enumerated type defines the two measurement systems that are used globally.
This enumeration value indicates that the English system of measurement is being used. Also known as the Imperial System of Measurement. Weights in this system are expressed as pounds and ounces, and package dimensions are expressed as feet or inches.
This enumeration value indicates that the English system of measurement is being used. Weights in this system are expressed as kilograms and grams, and package dimensions are expressed as meters or centimeters.
Contains data for controlling pagination in API requests.
Pagination of returned data is required for some calls and not
needed in or not supported for some calls. See the documentation
for individual calls to determine whether pagination is supported,
required, or desirable.
This integer value is used to specify the maximum number of entries to return
in a single "page" of data. This value, along with the number of entries that
match the input criteria, will determine the total pages (see
<b>PaginationResult.TotalNumberOfPages</b>) in the result set.
<br/><br/>
The maximum and default values are not the same for all calls. For most <b>Trading API</b> calls, the maximum value is 200 and the default value is 25 entries per page.
<br>
GetAccount
GetCategoryListings
GetFeedback
GetItemsAwaitingFeedback
GetItemTransactions
GetLiveAuctionBidders
GetMemberMessages
GetMyeBayBuying
GetMyeBaySelling
GetMyMessages
GetSellerTransactions
GetSellingManagerInventory
GetSellingManagerSoldListings
GetVeROReportStatus
GetWantItNowSearchResults
No
1
100
25
GetOrders
No
GetBestOffers
No
20
1
50000
50
GetProductSearchResults
GetProductFamilyMembers
No
1
20
GetProducts
No
1
400
GetSearchResults
No
1
200
200
GetSellerPayments
No
200
200
200
GetUserDisputes
No
GetSellerList
Yes
100
GetPopularKeywords
No
Specifies the number of the page of data to return in the current call.
Default is 1 for most calls. For some calls, the default is 0. Specify a
positive value equal to or lower than the number of pages available (which you
determine by examining the results of your initial request).
See the documentation for the individual calls to determine the correct
default value.<br>
1
1
GetAccount
GetCategoryListings
GetBestOffers
GetFeedback
GetItemsAwaitingFeedback
GetItemTransactions
GetLiveAuctionBidders
GetMemberMessages
GetMyeBayBuying
GetMyeBaySelling
GetMyMessages
GetOrders
GetSearchResults
GetSellerTransactions
GetSellingManagerInventory
GetSellingManagerSoldListings
GetVeROReportStatus
GetWantItNowSearchResults
No
GetUserDisputes
Yes
0
2147483647
0
GetProductFamilyMembers
GetProductSearchResults
No
GetSellerList
Yes
1
2147483647
1
GetSellerPayments
No
1
2000
1
GetProducts
No
1
GetPopularKeywords
No
Basic type for specifying quantities.
SeverityCodeType - Type declaration to be used by other schema.
This code identifies the severity of an API error. A code indicates
whether there is an API-level error or warning that needs to be
communicated to the client.
The request was processed successfully, but something occurred that may affect your application or the user. For example, eBay may have changed a value the user sent in. In this case, eBay returns a normal, successful response and also returns the warning.
<br/><br/>
When a warning occurs, the error is returned in addition to the business data. In this case, you do not need to retry the request (as the original request was successful). However, depending on the cause or nature of the warning, you might need to contact either the end user or eBay to effect a long term solution to the problem to prevent it from reoccurring in the future.
The request that triggered the error was not processed successfully. When a serious application-level error occurs, the error is returned instead of the business data.
<br/><br/>
If the source of the problem is within the application (such as a missing required element), change the application before you retry the request.
<ul>
<li>If the problem is due to end-user input data, please alert the end-user to the problem and provide the means for them to correct the data. Once the problem in the application or data is resolved, you can attempt to re-send the request to eBay.
</li>
<li>If the source of the problem is on eBay's side, An application can retry the request as-is a reasonable number of times (eBay recommends twice). If the error persists, contact Developer Technical Support. Once the problem has been resolved, the request may be resent in its original form.
</li>
</ul>
<br/><br/>
See the <a href="http://developer.ebay.com/DevZone/guides/features-guide/default.html#Basics/Call-UsingLiveData.html#CompatibleApplicationCheck">Compatible Application Check</a> section of the
eBay Features Guide for more information.
Reserved for internal or future use.
Specifies a universally unique identifier for an item. This is used to ensure that you only
list a particular item once, particularly if you are listing many items at once.
The identifier can contain only digits
from 0-9 and letters from A-F. The identifier must be 32 characters long. For
example, 9CEBD9A6825644EC8D06C436D6CF494B.
Item.Site in AddItem
AddItem.html#Request.Item.UUID
The application ID that is unique to each application you (or your company)
has registered with the eBay Developers Program. If you are executing a call
in the Sandbox, this is the "AppId" value that eBay issued to you when you
received your Sandbox keys. If you are executing a call in Production, this is
the "AppId" value that eBay issued to you when you received your Production
keys.
FetchToken
Yes
The unique developer ID that the eBay Developers Program issued to you (or
your company). If you are executing a call in the Sandbox, this is the "DevId"
value that eBay issued to you when you received your Sandbox keys. Typically,
you receive your Sandbox keys when you register as a new developer. If you are
executing a call in Production, this is the "DevId" value that eBay issued to
you when you received your Production keys. Typically, you receive your
Production keys when you certify an application.
FetchToken
Yes
Authentication certificate that authenticates the application when making API
calls. If you are executing a call in the Sandbox, this is the "CertId" value
that eBay issued to you when you received your Sandbox keys. If you are
executing a call in Production, this is the "CertId" value that eBay issued to
you when you received your Production keys. This is unrelated to auth tokens.
FetchToken
Yes
eBay user ID (i.e., eBay.com Web site login name) for the user the application
is retrieving a token for. This is typically the application's end-user (not
the developer).
64
FetchToken
Yes
Password for the user specified in Username.
This enumerated type contains the list of values that can be passed in through the <b>WarningLevel</b> field of a call request.
The <b>WarningLevel</b> value is set to <code>Low</code> if the user does not wish to receive warnings when the application passes
unrecognized or deprecated elements in an API call request.
This is the default value if <b>WarningLevel</b> is not specified in the call request.
The <b>WarningLevel</b> value is set to <code>High</code> if the user wishes to receive warnings when the application passes unrecognized or deprecated elements in an API call request. Setting the <b>WarningLevel</b> value to <code>High</code> is not recommended in a production environment. Instead, it should only be used during the development/debugging stage.
eBay user ID (i.e., eBay.com Web site login name) for the user the application
is retrieving a token for. This is typically the application's end-user (not
the developer).
64
FetchToken
Yes
Password for the user specified in Username.
Authentication token representing the user who is making the request. The
user's token must be retrieved from eBay. To determine a user's authentication
token, see the Authentication and Authorization information in the eBay Web
Services guide. For calls that list or retrieve item or transaction data, the
user usually needs to be the seller of the item in question or, in some cases,
the buyer. Similarly, calls that retrieve user or account data may be
restricted to the user whose data is being requested. The documentation for
each call includes information about such restrictions.
2000
FetchToken
Yes
Getting Tokens
http://developer.ebay.com/DevZone/guides/features-guide/Basics/Tokens.html
This type is used by the <b>ASQPreferences</b> 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 boolean field can be used in the <b>SetMessagePreferences</b> call to reset all custom Ask Seller a Question (ASQ) subjects to their default eBay values. For any given <b>SetMessagePreferences</b> call, either <b>ResetDefaultSubjects</b> or one or more <b>Subject</b> fields can be used, but not both in the same call.
SetMessagePreferences
Conditionally
Each <b>Subject</b> field contains one custom Ask a Question (ASQ) subject. A maximum of nine custom ASQ subjects can be created. eBay's "General question about this item" subject will always be included in all listings.
<br><br>
For any given <b>SetMessagePreferences</b> call, either <b>ResetDefaultSubjects</b> or one or more <b>Subject</b> fields can be used, but not both in the same call. ASQ subjects are displayed on the drop-down list in the same order as they are passed in to the request. So, if the seller would like to rearrange the order of the ASQ subjects, they should keep this behavior in mind.
<br><br>
Note that the default ASQ subjects will display in the site's
language if retrieved from a site other than the seller's own.
For example, if a US seller sells on the German and French
sites, the default subjects will display in German and French,
respectively. However, if the seller adds custom subjects through the API on these sites, the custom subjects will display in the seller's own language - English in this use case.
<br><br>
The <b>GetMessagePreferences</b> call will retrieve all custom ASQ subjects that have been set by the seller. If custom ASQ subjects have not been set up by the seller, the eBay default ASQ subjects will be returned in the <b>Subject</b> fields instead.
60
9
GetMessagePreferences
Conditionally
SetMessagePreferences
Conditionally
Enumerated type that defines the possible values that can be returned in the <b>RuleCurrentStatus</b> output field of the <b>GetApiAccessRules</b> call. The <b>RuleCurrentStatus</b> is only returned if the daily, hourly, or periodic call limit for the corresponding API call has been exceeded, or if a call limit does not apply to the API call.
This value indicates that usage limits do not apply to the corresponding API call.
This value indicates that your application has exceeded its hourly hard call limit for the corresponding API call.
This value indicates that your application has exceeded its daily hard call limit for the corresponding API call.
This value indicates that your application has exceeded its periodic hard call limit for the corresponding API call. The period is defined in the <b>ApiAccessRule.Period</b> field and can be a calendar month or a specific number of days.
This value indicates that your application has exceeded its hourly soft call limit for the corresponding API call.
This value indicates that your application has exceeded its daily soft call limit for the corresponding API call.
This value indicates that your application has exceeded its periodic soft call limit for the corresponding API call. The period is defined in the <b>ApiAccessRule.Period</b> field and can be a calendar month or a specific number of days.
Reserved for internal or future use.
This enumerated type contains values that describe an application's current status
with respect to an API access rule.
This value indicates that the rule is turned off, and no rule validation
was performed.
This value indicates that the rule is turned on, and rule validation was
performed.
This value indicates that the application is blocked from making
requests to the call named in this rule.
Reserved for internal or future use.
Enumerated type that defines the fee/charge and credit transactions that occur on an eBay user's account. These values are returned in the <b>AccountEntry.AccountDetailsEntryType</b> output field of the <b>GetAccount</b> call.
CreditPromotedListingFeature, FeePromotedListingFeature, PictureManagerSubscriptionFee, PictureManagerSubscriptionFeeCredit, StoresSuccessfulListingFee, StoresSuccessfulListingFeeCredit, StoresReferralFee, StoresReferralCredit, eBayStoreInventorySubscriptionCredit, FeeGiftIcon, CreditGiftIcon, FeeHighlight, CreditHighlight, TradingLimitOverrideOn, TradingLimitOverrideOff, AutoTraderOn, AutoTraderOff, PaperInvoiceOn, PaperInvoiceOff, LACatalogFee, LAExtraItem, LACatalogItemFeeRefund, LACatalogInsertionRefund, LAFinalValueFee, LAFinalValueFeeRefund, LABuyerPremiumPercentageFee, LABuyerPremiumPercentageFeeRefund, LAAudioVideoFee, LAAudioVideoFeeRefund, SubscriptionAABasic, SubscriptionAAPro, CreditAABasic, CreditAAPro, FeePicturePack, CreditPicturePackPartial, CreditPicturePackFull, ElectronicInvoiceOn, ElectronicInvoiceOff, ExtendedAuctionFee, ExtendedAcutionCredit, BonusPointsAddition, BonusPointsReduction, BonusPointsPaymentAutomatic, BonusPointsPaymentManual, BonusPointsPaymentReversal, BonusPointsCashPayout, AutoPmntReqExempt, AutoPmntReqRein, SellerReportsBasicFee, SellerReportsBasicCredit, SellerReportsPlusFee, SellerReportsPlusCredit, BorderFee, BorderFeeCredit, FeeSearchableMobileDE, CreditSearchableMobileDE, EmailMarketingFee, EmailMarketingCredit, FeePictureShow, BasicUpgradePackBundleFee, BasicUpgradePackBundleFeeCredit, BasicBundleFee, BasicBundleFeeCredit, ImmoProFee, CreditImmoProFee, ImmoProFeatureFee, CreditImmoProFeatureFee, RealEstateProFee, CreditRealEstateProFee, RealEstateProFeatureFee, CreditRealEstateProFeatureFee
This enumeration value indicates that the account transaction type is unknown. Sometimes this value will get returned, but the corresponding <b>Description</b> field may provide more details, and the corresponding <b>GrossDetailAmount</b> field will indicate whether the transaction was a charge or a credit (indicated with a negative dollar value).
This enumeration value indicates that the account entry is an insertion fee for a listing.
This enumeration value indicates that the account entry is a listing upgrade fee for a listing title in boldface font.
This enumeration value indicates that the account entry is a listing upgrade fee for featuring the listing on an eBay marketplace's home page.
<br>
<br>
<span class="tablenote"><b>Note:</b>
This feature is no longer available to most marketplaces and sellers.
</span>
This enumeration value indicates that the account entry is a listing upgrade fee for featuring the listing on an eBay category page relevant to the item.
<br>
<br>
<span class="tablenote"><b>Note:</b>
This feature is no longer available to most marketplaces and sellers.
</span>
This enumeration value indicates that the account entry is a final value fee for a sale on the listing. This fee is charged when a listed item sells, and is a percentage of the final sale price. This fee does not take in account any shipping costs. The final value fee associated with shipping costs is returned in <b>FeeFinalValueShipping</b> entry.
This enumeration value indicates that the account entry is a payment by check made by a user to eBay.
This enumeration value indicates that the account entry is a payment by credit card made by a user to eBay.
This enumeration value indicates that the account entry is a courtesy credit issued by eBay to the user.
This enumeration value indicates that the account entry is a credit issued by eBay to the user due to no sale.
This enumeration value indicates that the account entry is a credit issued by eBay to the user due to a partial sale.
This enumeration value indicates that the account entry is a refund to a user's credit card issued by eBay.
This enumeration value indicates that the account entry is a refund check to a user issued by eBay.
This enumeration value indicates that the account entry is a finance charge to the user's account. A finance charge may be applicable if the user's monthly invoice balance is not paid in full by the due date.
This value is no longer applicable, and should not be returned.
This value is no longer applicable, and should not be returned.
This value is no longer applicable, and should not be returned.
This enumeration value indicates that the account entry is a credit issued to the seller for any listing fees for a duplicate listing that was removed by eBay.
This enumeration value indicates that the account entry is a fee charged by eBay for a partial sale.
This enumeration value indicates that the account entry is a reversal of an electronic transfer payment.
This enumeration value indicates that the account entry is a one-time payment made by a credit card.
This enumeration value indicates that the account entry is a fee charged by eBay for a returned check.
This enumeration value indicates that the account entry is a fee charged by eBay when a check must be redeposited to collect funds.
This enumeration value indicates that the account entry is a cash payment made on the user's account.
This enumeration value indicates that the account entry is an insertion fee credit issued by eBay to the seller. If a listed item does not sell or results in an Unpaid Item case/dispute, the seller can relist the item with no additional charge.
This enumeration value indicates that the account entry is a credit for a Bold title listing upgrade.
This enumeration value indicates that the account entry is a credit for a listing upgrade fee for featuring the listing on an eBay marketplace's home page.
<br>
<br>
<span class="tablenote"><b>Note:</b>
This feature is no longer available to most marketplaces and sellers.
</span>
This enumeration value indicates that the account entry is a credit for a listing upgrade fee for featuring the listing on an eBay category page relevant to the item.
<br>
<br>
<span class="tablenote"><b>Note:</b>
This feature is no longer available to most marketplaces and sellers.
</span>
This enumeration value indicates that the account entry is a credit for a final value fee for a sale on the listing. A final value fee may be credited back to a seller's account if the buyer never pays for the line item, or if the buyer cancels the order.
This enumeration value indicates that the account entry is a fee charged by eBay when the seller's check does not clear due to insufficient funds.
This enumeration value indicates that the account entry is a fee charged by eBay when the seller's check does not clear because the account has been closed.
This enumeration value may be returned if the account entry is just a memo/note, or if the account entry cannot be properly classified. The corresponding <b>Description</b> field may provide more details, and the corresponding <b>GrossDetailAmount</b> field will indicate whether the transaction was a charge or a credit (indicate with a negative dollar value).
This enumeration value may be returned if the account entry is a payment made to the account by money order.
This enumeration value may be returned if the account entry is an automatic monthly charge of the seller's invoice amount made by eBay to a credit card the seller has placed on file.
This enumeration value may be returned if the account entry is a one-time payment made with a user's credit card that is not on file with eBay for automatic monthly payments.
This enumeration value indicates that the user has been invoiced.
This enumeration value indicates that the user has been invoiced and that the balance will be charged to the credit card on file on the due date.
This enumeration value may be returned if the account entry is a credit transferred from another account to this account.
This enumeration value indicates that the account entry is a debit transferred from this account to another account.
This enumeration value indicates that the account entry is a credit balance for an account's invoice period, meaning that the seller should not pay.
This enumeration value may be returned for debits issued by eBay that are manually applied to the user's account, and not necessarily tied to a specific listing/line item.
This enumeration value may be returned for credits issued by eBay that are manually applied to the user's account, and not necessarily tied to a specific listing/line item.
This enumeration value indicates that the account entry is a promotional credit issued by eBay.
This enumeration value may be returned as a note that the user's credit card is not with eBay.
This enumeration value indicates that the account entry is an insertion
fee credit. If a listed item does not sell or results in an Unpaid Item case/dispute, the seller can relist the item with no additional charge.
This enumeration value may be returned as a note if a user's credit card payment is rejected.
This enumeration value is no longer applicable and should not be returned since gift services and the gift icon are no longer supported in any eBay marketplaces.
This enumeration value is no longer applicable and should not be returned since gift services and the gift icon are no longer supported in any eBay marketplaces.
This enumeration value indicates that the account entry is a fee charged by eBay for listing an item in the Picture Gallery. A buyer sees a picture of the item when browsing a category, before moving to the item's listing page.
This enumeration value indicates that the account entry is a fee charged by eBay for listing an item in the Featured section at the top of the Picture Gallery page.
This enumeration value indicates that the account entry is a credit issued by eBay for the Gallery fee charged when the item was listed.
This enumeration value indicates that the account entry is a credit issued by eBay for the Featured Gallery fee charged when the item was listed.
This enumeration value indicates that the account entry is a fee for moving the item.
This enumeration value indicates that the account entry is a credit that may be issued by eBay when listings are not available due to system downtime. The downtime can be a title search outage or a hard outage.
This enumeration value indicates that the account entry is a credit for a PSA payment.
This enumeration value indicates that the account entry is a credit for a PCGS fee.
This enumeration value indicates that the account entry is a fee charged by eBay when the seller sets a reserve price for an auction listing.
This enumeration value indicates that the account entry is a credit refunded to the seller for a reserve price that was set for an auction listing.
This enumeration value indicates that the account entry is a credit issued by eBay to the user's Visa credit card.
This enumeration value indicates that the account entry is a credit issued administratively.
This enumeration value indicates that the account entry is a charge issued administratively.
This enumeration value indicates that the account entry is a credit issued by eBay to a Store owner who has promoted items outside of eBay.
This enumeration value indicates that the account entry is a charge issued by eBay to a Store owner who has promoted items outside of eBay.
This enumeration value may be returned as a note about switching from one billing currency to another.
This enumeration value indicates that the account entry is a payment made to the account by a gift certificate.
This enumeration value indicates that the account entry is a payment made to the account by wire transfer.
This enumeration value indicates that the account entry is a payment made to the account through home bank.
This enumeration value indicates that the account entry is a one-time payment made to the account by electronic transfer.
This enumeration value indicates that the account entry is a credit made by eBay to the seller's account when a payment needs to be adjusted.
This enumeration value indicates that the account entry is a debit (deduction) made by eBay to the seller's account when a payment needs to be adjusted.
This enumeration value indicates that the account entry is an eBay write-off of an account charge.
This enumeration value indicates that the account entry is the recovery of an eBay write-off of an acccount charge.
This enumeration value indicates that the account entry is an eBay write-off of the account charges by eBay due to the seller declaring bankruptcy.
This enumeration value may be returned as a note that the eBay write-off of an account charge has been suspended.
This enumeration value indicates that the account entry is an eBay write-off of the account charges by eBay due to the decease of the seller.
This enumeration value indicates that the account entry is an eBay write-off of the account charges by eBay due to the decease of the seller.
This enumeration value indicates that the account entry is an eBay write-off of the account charges by eBay due to the wackiness of the seller.
This enumeration value indicates that the account entry is a reversal of the finance charge to the user's account. A finance charge may be applicable if the user's monthly invoice balance is not paid in full by the due date.
This enumeration value indicates that the account entry is a reversal of a Final Value Fee credit, resulting in the fee again being charged to the seller. The Final Value Fee can be credited as a result of an Unpaid Item Dispute, but if the buyer ultimately pays for the line item, the Final Value Fee will apply once again.
This enumeration value indicates that the account entry is a fee charged for currency conversion.
This enumeration value indicates that the account entry is a reversal of a check payment made with foreign funds.
This enumeration value may be returned to act as a note that there is an 'End of the Month' restriction for account activity.
This enumeration value may be returned if eBay is issuing a credit to the seller for multiple listing fees.
This enumeration value may be returned to act as a note that the user's account is on hold.
This enumeration value may be returned to act as a note to indicate that the state of the user's account has been reverted.
This enumeration value indicates that the account entry is a monthly payment made by automatic direct debit to the seller's checking account, when the account information is on file.
This enumeration value indicates that the account entry is a one-time payment made by direct debit to the seller's checking account, when the account information is not on file, but is provided for this payment.
This enumeration value indicates that the account entry is a payment made by direct debit from the seller's checking account when the seller has requested automatic monthly invoice payments.
This enumeration value indicates that the account entry is a reversal of a payment made by direct debit from the seller's checking account.
This enumeration value indicates that the account entry is a reversal of a payment made by direct debit from a seller's checking account when an item is returned by the buyer.
This enumeration value indicates that the account entry is a fee charged by eBay for adding a colored band to emphasize a listing.
<br>
<br>
<span class="tablenote"><b>Note:</b>
This feature is no longer available to most marketplaces and sellers.
</span>
This enumeration value indicates that the account entry is a credit issued to the seller by eBay for adding a colored band to emphasize a listing.
<br>
<br>
<span class="tablenote"><b>Note:</b>
This feature is no longer available to most marketplaces and sellers.
</span>
This enumeration value may be returned to act as a note to indicate that the user's account has been suspended as part of a bulk suspension initiated by eBay.
This enumeration value indicates that the account entry is a fee charged for a 30-day classified ad listing in a Real Estate category.
This enumeration value indicates that the account entry is a credit issue to a seller for a 30-day classified ad listing in a Real Estate category.
This enumeration value is only used internally.
This enumeration value is only used internally.
This enumeration value indicates that the account entry is a fee charged to a seller who did not provide a credit card or checking account number to verify identify.
This enumeration value indicates that the account entry is a credit issued to a seller who was charged an Equifax fee.
This enumeration value indicates that the account entry is a payment made by the seller for an Equifax fee.
This enumeration value indicates that the account entry is a credit issued by eBay to the seller for a payment made on an Equifax fee.
This enumeration value may be returned to act as a note to indicate that the user's two accounts (same owner, but different user IDs) have been merged into one account.
The Auto Trader feature is no longer available for motor vehicle listings.
The Auto Trader feature is no longer available for motor vehicle listings.
This enumeration value is no longer applicable as paper invoices are no longer available. Users must download their invoices from My eBay.
This enumeration value is no longer applicable as paper invoices are no longer available. Users must download their invoices from My eBay.
This enumeration value may be returned to act as a note to indicate that there has been a change in the status of the user's account.
This enumeration value indicates that the account entry is an automatic reversal of a Final Value Fee credit.
This enumeration value indicates that the account entry is a credit issued by eBay to the seller if a title search outage of one hour or longer occurs on the site.
This enumeration value is no longer applicable as Live Auction listings are no longer available on any eBay marketplace.
This enumeration value is no longer applicable as Live Auction listings are no longer available on any eBay marketplace.
This enumeration value is no longer applicable as Live Auction listings are no longer available on any eBay marketplace.
This enumeration value is no longer applicable as Live Auction listings are no longer available on any eBay marketplace.
This enumeration value is no longer applicable as Live Auction listings are no longer available on any eBay marketplace.
This enumeration value is no longer applicable as Live Auction listings are no longer available on any eBay marketplace.
This enumeration value is no longer applicable as Live Auction listings are no longer available on any eBay marketplace.
This enumeration value is no longer applicable as Live Auction listings are no longer available on any eBay marketplace.
This enumeration value is no longer applicable as Live Auction listings are no longer available on any eBay marketplace.
This enumeration value is no longer applicable as Live Auction listings are no longer available on any eBay marketplace.
This enumeration value is no longer applicable as the iPix photo feature is no longer available on any eBay marketplace.
This enumeration value is no longer applicable as the iPix photo feature is no longer available on any eBay marketplace.
This enumeration value is no longer applicable as the iPix photo feature is no longer available on any eBay marketplace.
This enumeration value is no longer applicable as the iPix photo feature is no longer available on any eBay marketplace.
A fee charged for listing an item for 10 days,
rather than one, three, five, or seven days.
This enumeration value indicates that the account entry is a credit issued to a seller for a 10-day auction listing.
This enumeration value indicates that the account entry is a temporary credit from eBay to the user.
This enumeration value indicates that the account entry is the reversal of a temporary credit from eBay to the user.
This enumeration value is no longer applicable as the Auction Assistant feature is no longer available on any eBay marketplace.
This enumeration value is no longer applicable as the Auction Assistant feature is no longer available on any eBay marketplace.
This enumeration value is no longer applicable as the Auction Assistant feature is no longer available on any eBay marketplace.
This enumeration value is no longer applicable as the Auction Assistant feature is no longer available on any eBay marketplace.
This enumeration value indicates that the account entry is a fee charged by eBay for a super-sized picture in a listing.
This enumeration value indicates that the account entry is a credit issued by eBay to the seller for a super-sized picture in a listing.
This enumeration value is no longer applicable as eBay no longer charges a fee for adding photos to listings.
This enumeration value is no longer applicable as eBay no longer charges a fee for adding photos to listings.
This enumeration value is no longer applicable as eBay no longer charges a fee for adding photos to listings.
This enumeration value indicates that the account entry is a monthly subscription fee charged for the user's eBay Store.
This enumeration value indicates that the account entry is a credit toward the user's eBay Store subscription fee.
This enumeration value indicates that the account entry is an insertion fee for a fixed-price listing.
This enumeration value indicates that the account entry is an insertion
fee credit for a fixed-price listing. If a listed item does not sell or results in an Unpaid Item case/dispute, the seller can relist the item with no additional charge.
This enumeration value indicates that the account entry is a final value fee for a sale on the fixed-price listing. This fee is charged when a listed item sells, and is a percentage of the final sale price.
This enumeration value indicates that the account entry is a credit for a final value fee for a sale on the fixed-price listing. A final value fee may be credited back to a seller's account if the buyer never pays for the line item, or if the buyer cancels the order.
This enumeration value is no longer applicable since paper invoices are no longer available, so electronic invoices are the only option. Users must download their invoices from My eBay.
This enumeration value is no longer applicable since paper invoices are no longer available, so electronic invoices are the only option. Users must download their invoices from My eBay.
This enumeration value acts as a note to indicate that a direct debit payment is pending.
This enumeration value acts as a note to indicate that a direct debit payment is confirmed.
This enumeration value indicates that the account entry is a fee charged by eBay for creating a fixed-price listing with a 10-day duration.
<br>
<br>
<span class="tablenote"><b>Note:</b>
This charge may only be applicable to motor vehicle listings on eBay Motors, eBay Canada (English and French versions), eBay UK, and eBay Italy. For all non-motor vehicle categories, the only available listing duration is 'GTC', or 'Good 'til Cancelled'.
</span>
This enumeration value indicates that the account entry is a credit issued by eBay to the seller for creating a fixed-price listing with a 10-day duration.
<br>
<br>
<span class="tablenote"><b>Note:</b>
The 10-day duration fee is only applicable to motor vehicle listings on eBay Motors, eBay Canada (English and French versions), eBay UK, and eBay Italy. For all non-motor vehicle categories, the only available listing duration is 'GTC', or 'Good 'til Cancelled'.
</span>
This enumeration value indicates that the account entry is a fee charged by eBay if the seller uses the 'Buy It Now' feature on an auction listing.
This enumeration value indicates that the account entry is a credit issued by eBay if the seller uses the 'Buy It Now' feature on an auction listing.
This enumeration value indicates that the account entry is a fee charged by eBay if the seller uses the scheduled listing feature for a listing. With scheduled listings, the seller schedules a listing to start at some later time (up to 3 weeks after) instead of immediately.
This enumeration value indicates that the account entry is a credit issued by eBay to the seller if the seller needs to be refunded for a scheduled listing. With scheduled listings, the seller schedules a listing to start at some later time (up to 3 weeks after) instead of immediately.
This enumeration value indicates that the account entry is the monthly subscription fee charged for the basic version of Selling Manager. For most eBay marketplaces and sellers, there is no subscription charge to use the basic version of Selling Manager.
This enumeration value indicates that the account entry is the monthly subscription fee charged for using the Selling Manager Pro product.
This enumeration value indicates that the account entry is a credit for the monthly subscription fee charged for the basic version of Selling Manager. For most eBay marketplaces and sellers, there is no subscription charge to use the basic version of Selling Manager.
This enumeration value indicates that the account entry is a credit for the monthly subscription fee charged for using the Selling Manager Pro product.
This enumeration value indicates that the account entry is a fee charged to the seller when a 'Good 'til Cancelled', fixed-price listing automatically renews after 30 days (as long as inventory is still available). This fee is similar to an insertion fee when a listing is first created. 'GTC' listings automatically renew every 30 days, and these renewed listings may incur insertion fees unless the seller has 'zero insertion fee' credits. eBay sellers with stores get more 'zero insertion fee' credits than other sellers.
<br><br>
<span class="tablenote"><b>Note: </b>
As of July 1, 2019, the Good 'Til Cancelled renewal schedule has been modified from every 30 days to once per calendar month. For example, if a GTC listing is created July 5, the next monthly renewal date will be August 5. If a GTC listing is created on the 31st of the month, but the following month only has 30 days, the renewal will happen on the 30th in the following month. Finally, if a GTC listing is created on January 29-31, the renewal will happen on February 28th (or 29th during a 'Leap Year'). See the
<a href="https://pages.ebay.com/seller-center/seller-updates/2019-spring/marketplace-updates.html#good-til-cancelled" target="_blank">Good 'Til Cancelled listings update</a> in the <b>Spring 2019 Seller Updates</b> for more information about this change.
</span>
This enumeration value indicates that the account entry is a credit issued by eBay to refund the seller for a 'Good 'til Cancelled' listing renewal/insertion fee. 'GTC' listings automatically renew every 30 days, and these renewed listings may incur insertion fees unless the seller has 'zero insertion fee' credits. eBay sellers with stores get more 'zero insertion fee' credits than other sellers.
<br><br>
<span class="tablenote"><b>Note: </b>
As of July 1, 2019, the Good 'Til Cancelled renewal schedule has been modified from every 30 days to once per calendar month. For example, if a GTC listing is created July 5, the next monthly renewal date will be August 5. If a GTC listing is created on the 31st of the month, but the following month only has 30 days, the renewal will happen on the 30th in the following month. Finally, if a GTC listing is created on January 29-31, the renewal will happen on February 28th (or 29th during a 'Leap Year'). See the
<a href="https://pages.ebay.com/seller-center/seller-updates/2019-spring/marketplace-updates.html#good-til-cancelled" target="_blank">Good 'Til Cancelled listings update</a> in the <b>Spring 2019 Seller Updates</b> for more information about this change.
</span>
This enumeration value indicates that the account entry is a fee for the seller using a Listing Designer theme and layout template for a listing.
This enumeration value indicates that the account entry is a credit issued by eBay to refund the seller using a Listing Designer theme and layout template for a listing.
This enumeration value is no longer applicable as there is no additional fee charged to the seller for creating a 10-day auction listing.
This enumeration value is no longer applicable as there is no additional fee charged to the seller for creating a 10-day auction listing.
This enumeration value is only for internal use, and indicates that the login attempt to PayPal using OTP ('One-Time Pin' or two-factor authentication) was successful.
This enumeration value is only for internal use, and indicates that the login attempt to PayPal using OTP ('One-Time Pin' or two-factor authentication) is pending.
This enumeration value is only for internal use, and indicates that the login attempt to PayPal failed.
This enumeration value indicates that the account entry is a charge back using PayPal as the payment method.
This enumeration value indicates that the account entry is a charge back.
This enumeration value indicates that the account entry is the reversal of a charge back.
This enumeration value indicates that the account entry is a refund using PayPal as the payment method.
This enumeration value is no longer applicable as the 'Anything Points' program is no longer available.
This enumeration value is no longer applicable as the 'Anything Points' program is no longer available.
This enumeration value is no longer applicable as the 'Anything Points' program is no longer available.
This enumeration value is no longer applicable as the 'Anything Points' program is no longer available.
This enumeration value is no longer applicable as the 'Anything Points' program is no longer available.
This enumeration value is no longer applicable as the 'Anything Points' program is no longer available.
This enumeration value indicates that the account entry is a credit to the seller's account for Value-Added Tax (VAT) previously paid by the seller.
This enumeration value indicates that the account entry is a debit to the seller's account for a Value-Added Tax (VAT) charge.
This enumeration value acts as a note to indicate that a VAT status change to the seller's account is pending.
This enumeration value acts as a note to indicate that a VAT status change to the seller's account is approved.
This enumeration value acts as a note to indicate that a VAT status change to the seller's account was denied.
This enumeration value acts as a note to indicate that a VAT status change to the seller's account was cancelled by an eBay customer support representative.
This enumeration value acts as a note to indicate that a VAT status change to the seller's account was cancelled by the user.
This enumeration value indicates that the account entry is a fee for the seller using a Listing Designer theme and layout template through the Selling Manager Pro UI, or through a Selling Manager Pro API call.
This enumeration value indicates that the account entry is a credit issued by eBay to the seller for a fee that was charged to the seller for using a Listing Designer theme and layout template through the Selling Manager Pro UI, or through a Selling Manager Pro API call.
This enumeration value is no longer applicable as <code>StoresFixedPrice</code> is no longer a valid listing type.
This enumeration value is no longer applicable as <code>StoresFixedPrice</code> is no longer a valid listing type.
This enumeration value is no longer applicable as there is no longer a referral fee charged to sellers when buyers are routed to their store through printed materials or emails.
This enumeration value is no longer applicable as there is no longer a referral fee charged to sellers when buyers are routed to their store through printed materials or emails.
This enumeration value indicates the account entry is a fee charged to the seller for adding a subtitle to a listing. Subtitles allow sellers to provide more keywords and/or descriptive information, and may increase buyers' interest.
This enumeration value indicates the account entry is a credit issued from eBay to compensate the seller for a subtitle fee charged to their account.
This enumeration value is no longer applicable as <code>StoresFixedPrice</code> is no longer a valid listing type.
This enumeration value is no longer applicable.
This enumeration value is no longer applicable.
This enumeration value is no longer applicable as the Picture Manager feature is no longer available.
This enumeration value is no longer applicable as the Picture Manager feature is no longer available.
This enumeration value is no longer applicable as the Seller Reports feature is no longer available.
This enumeration value is no longer applicable as the Seller Reports feature is no longer available.
This enumeration value is no longer applicable as the Seller Reports feature is no longer available.
This enumeration value is no longer applicable as the Seller Reports feature is no longer available.
This enumeration value acts as a note to indicate that the user's PayPal account information is linked with their eBay account.
This enumeration value acts as a note to indicate that the user's PayPal account information was linked with their eBay account by an eBay customer support represenative.
This enumeration value acts as a note to indicate that the user's PayPal account information is not linked with their eBay account.
This enumeration value is no longer applicable as borders around listing photos are no longer supported on any eBay marketplace.
This enumeration value is no longer applicable as borders around listing photos are no longer supported on any eBay marketplace.
This enumeration value is no longer applicable since placing eBay Germany motor vehicle listings on the mobile.de site is no longer supported.
This enumeration value indicates the account entry is a monthly subscription fee charged for Sales Reports Plus.
This enumeration value indicates the account entry is a credit to the seller applied towards the monthly subscription fee charged for Sales Reports Plus.
This enumeration value is no longer applicable since placing eBay Germany motor vehicle listings on the mobile.de site is no longer supported.
This enumeration value is no longer applicable since this eBay Stores marketing feature is no longer supported.
This enumeration value is no longer applicable since this eBay Stores marketing feature is no longer supported.
This enumeration value is no longer applicable since the picture slide show feature is no longer available.
This enumeration value is no longer applicable since the picture slide show feature is no longer available.
This enumeration value indicates the account entry is a fee charged to the seller for using the Pro Pack Bundle feature pack (currently available to US and Canada eBay motor vehicle sellers).
This enumeration value indicates the account entry is a credit towards the fee charged to the seller for using the Pro Pack Bundle feature pack (currently available to US and Canada eBay motor vehicle sellers).
This enumeration value is no longer applicable since this bundle pack is no longer available on any eBay marketplaces.
This enumeration value is no longer applicable since this bundle pack is no longer available on any eBay marketplaces.
This enumeration value indicates the account entry is a fee charged by eBay to the seller for using the Value Pack Bundle feature pack.
This enumeration value indicates the account entry is a credit towards the fee charged to the seller for using the Value Pack Bundle feature pack.
This enumeration value indicates the account entry is a fee charged by eBay to the seller for using the Pro Pack Plus Bundle feature pack.
This enumeration value indicates the account entry is a credit towards the fee charged by eBay to the seller for using the Pro Pack Plus Bundle feature pack.
This enumeration value indicates the account entry is the final entry in a user's account before it is closed or merged with another account.
This enumeration value is Reserved for future use.
This enumeration value indicates that the account entry is a fee charged to the seller for using an extended listing duration.
This enumeration value indicates that the account entry is a credit towards a fee charged to the seller for using an extended listing duration.
This enumeration value indicates that the account entry is a 'cross-border trade' fee, where the seller pays an additional listing fee to have his/her listing surface in the search on another eBay marketplace.
This enumeration value indicates that the account entry is a credit towards a 'cross-border trade' fee, where the seller pays an additional listing fee to have his/her listing surface in the search on another eBay marketplace.
This enumeration value indicates that the account entry is a fee for an expired Terapeak Research subscription.
This enumeration value indicates that the account entry is a credit towards a fee for an expired Terapeak Research subscription.
This enumeration value indicates that the account entry is a fee for a Terapeak Research basic subscription.
This enumeration value indicates that the account entry is a credit towards a fee for a Terapeak Research basic subscription.
This enumeration value indicates that the account entry is a fee for a Terapeak Research pro subscription.
This enumeration value is no longer applicable since a basic bundle pack is no longer available on any eBay marketplace.
This enumeration value is no longer applicable since a basic bundle pack is no longer available on any eBay marketplace.
This enumeration value indicates that the account entry is a credit towards a fee for a Terapeak Research pro subscription.
This enumeration value is no longer applicable as there are no longer any subscription fees to sell motor vehicles through Motors local listings.
This enumeration value is no longer applicable as there are no longer any subscription fees to sell motor vehicles through Motors local listings.
This enumeration value indicates that the account entry is an insertion fee for a Motors local listing.
This enumeration value indicates that the account entry is a credit towards an insertion fee for a Motors local listing.
This enumeration value indicates that the account entry is a final value fee for the sale of a motor vehicle through a Motors local listing.
This enumeration value indicates that the account entry is credit towards a final value fee for the sale of a motor vehicle through a Motors local listing.
This enumeration value indicates that the account entry is a 30-day duration listing fee for a Motors local listing.
This enumeration value indicates that the account entry is a credit towards a 30-day duration listing fee for a Motors local listing.
This enumeration value indicates that the account entry is an eBay Motors Pro fee. Applies to eBay Motors Pro registered dealers only.
This enumeration value indicates that the account entry is a credit towards an eBay Motors Pro fee. Applies to eBay Motors Pro registered dealers only.
This enumeration value indicates that the account entry is an eBay Motors Pro fee for a Feature pack. Applies to eBay Motors Pro registered dealers only.
This enumeration value indicates that the account entry is a credit towards an eBay Motors Pro fee for a Feature pack. Applies to eBay Motors Pro registered dealers only.
This enumeration value indicates that the account entry is a fee charged by eBay for listing an item with the Gallery Plus feature.
This enumeration value indicates that the account entry is a credit towards a fee charged by eBay for listing an item with the Gallery Plus feature.
This enumeration value indicates that the account entry is a fee for a private listing. With a private listing, bidders/buyers remain anonymous to other eBay users (besides the seller).
This enumeration value indicates that the account entry is a fee for a private listing. With a private listing, bidders/buyers remain anonymous to other eBay users (besides the seller).
This enumeration value is no longer applicable, and should not be returned.
This enumeration value is no longer applicable, and should not be returned.
This enumeration value is no longer applicable, and should not be returned.
This enumeration value is no longer applicable, and should not be returned.
This enumeration value is no longer applicable, and should not be returned.
This enumeration value is no longer applicable, and should not be returned.
This enumeration value is no longer applicable, and should not be returned.
This enumeration value is no longer applicable, and should not be returned.
This enumeration value indicates that the account entry is a seller discount against a final value fee, an insertion fee, a subscription fee, or other fee. See the corresponding <b>Description</b> and/or <b>Memo</b> fields for more information on the type of discount.
This enumeration value indicates that the account entry is a credit towards a final value fee for the shipping cost of an order. This fee is charged when a listed item sells, and is a percentage of the shipping cost. The final value fee associated with the final sale price is returned in a <b>FeeFinalValue</b> entry.
This enumeration value indicates that the account entry is a final value fee for the shipping cost of an order. This fee is charged when a listed item sells, and is a percentage of the shipping cost. The final value fee associated with the final sale price is returned in a <b>FeeFinalValue</b> entry.
This enumeration value indicates that the account entry is a return shipping fee if an item is returned by the buyer.
This enumeration value indicates that the account entry is a credit toward a return shipping fee if an item is returned by the buyer.
This enumeration value indicates that the account entry is a fee charged by eBay if the seller is using the Global Shipping Program to ship an item internationally.
This enumeration value indicates that the account entry is a credit towards a fee charged by eBay if the seller is using the Global Shipping Program to ship an item internationally.
This enumeration value indicates that the account entry is a fee charged to the seller's account if the seller ends an auction (with bids) early.
This enumeration value indicates that the account entry is a credit issued by eBay to the seller's account if a duplicate auction listing is ended administratively by eBay. A seller is only eligible for this credit if the auction listing had zero bids and was never surfaced in Search.
This enumeration value indicates that the account entry is a fee charged to the seller for printing out and using a FedEx shipping label from eBay.
This enumeration value indicates that the account entry is a credit issued by eBay to reimburse the seller for a FedEx shipping label. In some cases, this credit may be issued to the seller as a result of an Unpaid Item case that the seller has won against a buyer.
This enumeration value indicates that the account entry is a fee charged to the seller's account if eBay is forced to refund the buyer in a case where the buyer has used the eBay US Managed Returns process and return shipped the item to the seller, but the seller has not issued a refund to the buyer within seven business days after receiving the returned item. <br/><br/> This value is equal to the refund ("CreditReturnRefund") issued to the buyer.
This enumeration value indicates that the account entry is a credit issued to the buyer's account by eBay in a case where the buyer has used the eBay US Managed Returns process and return shipped the item to the seller, but the seller has not issued a refund to the buyer within seven business days after receiving the returned item. The buyer credit amounts to the total purchase price plus any shipping costs if the item was "not as described". <br/><br/> eBay then charges this expense to the seller's account, and this charge is attached to the "FeeReturnRefund" value.
This enumeration value indicates that the account entry is a fee charged for early termination of an eBay Stores subscription.
This enumeration value indicates that the account entry is a credit toward a fee charged for early termination of an eBay Stores subscription.
This enumeration value indicates that the account entry is a fee charged for early termination of a National Vehicle subscription.
This enumeration value indicates that the account entry is a credit toward a fee charged for early termination of a National Vehicle subscription.
This enumeration value indicates that the account entry is a monthly subscription fee charged for a National Vehicle subscription.
This enumeration value indicates that the account entry is a credit toward a monthly subscription fee charged for a National Vehicle subscription.
This enumeration value indicates that the account entry is a fee charged to the seller for printing out and using an Australia Post shipping label from eBay.
This enumeration value indicates that the account entry is a credit toward a fee charged to the seller for printing out and using an Australia Post shipping label from eBay. In some cases, this credit may be issued to the seller as a result of an Unpaid Item case that the seller has won against a buyer.
This enumeration value indicates that the account entry is a fee charged to the seller for printing out and using an FedEx shipping label from eBay in the Asia-Pacific geographical region.
This enumeration value indicates that the account entry is a credit toward a fee charged to the seller for printing out and using an FedEx shipping label from eBay in the Asia-Pacific geographical region. In some cases, this credit may be issued to the seller as a result of an Unpaid Item case that the seller has won against a buyer.
This enumeration value indicates that the account entry is a fee charged to the seller for printing out and using an Track & Trace (TNT) shipping label from eBay in the Asia-Pacific geographical region.
This enumeration value indicates that the account entry is a credit toward a fee charged to the seller for printing out and using an Track & Trace (TNT) shipping label from eBay in the Asia-Pacific geographical region.In some cases, this credit may be issued to the seller as a result of an Unpaid Item case that the seller has won against a buyer.
This enumeration value indicates that the account entry is a fee charged for eBay Money Back Guarantee reimbursement.
This enumeration value indicates that the account entry is a credit toward a fee charged for eBay Money Back Guarantee reimbursement.
This value is deprecated.
This value is deprecated.
This enumeration value indicates that the account entry is a fee charged for an Ad on eBay. This Ad fee is charged only for sellers who sign up to create Promoted Listings campaigns. When sellers advertise their listings, the listings are displayed on the search results pages based on buyer search query. When a buyer clicks on an ad and then goes on to purchase that same item within 30 days of click, the seller is charged an Ad fee. The Ad fee that is charged is at the rate set by seller themselves. They choose the bid percentage for each item listing.
This enumeration value indicates that the account entry is a credit issued by eBay for an Ad charge.
This enumeration value indicates that the account entry is a fee charged to the seller for printing out and using a Universal Business Integration (UBI) shipping label from eBay.
This enumeration value indicates that the account entry is a credit issued by eBay to reimburse the seller for a Universal Business Integration (UBI) shipping label. In some cases, this credit may be issued to the seller as a result of an Unpaid Item case that the seller has won against a buyer.
This enumeration value indicates that the account entry is an annual subscription fee charged for an eBay Plus subscription.
This enumeration value indicates that the account entry is a credit toward an annual subscription fee charged for an eBay Plus subscription.
This enumeration value indicates the charge is an eBay payment intermediation fee. This fee is only applicable for sellers in the eBay Managed Payments program, currently only available to a select number of sellers on the US site.
(out) Payment Intermediation Fee Credit
This enumeration value indicates the invoice charge is an eBay payment intermediation fee. This fee is only applicable for sellers in the eBay Managed Payments program, currently only available to a select number of sellers on the US site.
This enumeration value indicates the credit is a seller reimbursement for an eBay payment intermediation fee.
This enumeration value indicates the invoice credit is a seller reimbursement for an eBay payment intermediation fee.
This enumeration value indicates the invoice charge is a Final Value Fee (for item cost) charged to the seller's account after a buyer creates and wins a 'significantly not as described' (SNAD) case against the seller.
This enumeration value indicates the invoice charge is a Final Value Fee (for shipping cost) charged to the seller's account after a buyer creates and wins a 'significantly not as described' (SNAD) case against the seller.
This enumeration value indicates the invoice charge is for a 'Highline Search' fee, which is a capability that allows sellers to advertise multiple products at the same time, with ads appearing prominently on top of eBay's search results.
This enumeration value indicates the invoice credit is for a 'Highline Search' fee that was charged to the seller's account. The 'Highline Search' capability allows sellers to advertise multiple products at the same time, with ads appearing prominently on top of eBay's search results.
This enumeration value indicates the invoice credit is for a Final Value Fee (for item cost) that was charged to the seller's account after a buyer created a 'significantly not as described' (SNAD) case against the seller, but the seller won the dispute.
This enumeration value indicates the invoice credit is for a Final Value Fee (for shipping cost) that was charged to the seller's account after a buyer created a 'significantly not as described' (SNAD) case against the seller, but the seller won the dispute.
This enumeration value indicates the invoice charge is for a Premium Ad Fee.
This enumeration value indicates that a credit was issued for a Premium Ad Fee charge.
This enumeration value indicates the invoice charge is for a Per Listing Payments fee.
This enumeration value indicates that a credit was issued for a Per Listing Payments Fee charge.
This enumeration value indicates the invoice charge is for a Vehicles Listing Basic Package fee.
This enumeration value indicates that a credit was issued for a Vehicles Listing Basic Package fee charge.
This enumeration value indicates the invoice charge is for a Vehicles Listing Plus Package fee.
This enumeration value indicates that a credit was issued for a Vehicles Listing Plus Package fee charge.
This enumeration value indicates the invoice charge is for a Vehicles Listing Premium Package fee.
This enumeration value indicates that a credit was issued for a Vehicles Listing Premium Package fee charge.
This enumeration value indicates the invoice charge is for a Send Label fee.
This enumeration value indicates that a credit was issued for a Send Label fee charge.
This enumeration value indicates the invoice charge is for a UPS Label fee.
This enumeration value indicates that a credit was issued for a UPS Label fee charge.
This enumeration value indicates the invoice charge is for a Canada Post Label fee.
This enumeration value indicates that a credit was issued for a Canada Post Label fee charge.
This enumeration value indicates the invoice charge is for eBay having to resend/regenerate a shipping label for a seller. Sellers typically have 24 hours to reprint a shipping label 24 hours after the purchase of the shipping label. If a seller tries to reprint a purchased shipping label after this time, a small fee may apply.
This enumeration value indicates that a credit was issued for the fee charged by eBay to resend/regenerate a shipping label for the seller.
This enumeration value indicates that PayPal has pulled out the 'Collect and Remit' sales tax amount that was originally deposited to the seller's account. This enumeration value is only applicable to US sellers not opted in to eBay managed payments, and for orders that are subject to eBay 'Collect and Remit' sales tax. See the corresponding <b>OrderId</b> value to determine which eBay order this sales tax pertains to.
<br><br>
<span class="tablenote"><b>Note: </b>
For US sellers not opted in to eBay managed payments, PayPal will now deposit the entire order amount, including the 'Collect and Remit' sales tax, into the seller's account, and once the order funds clear, this sales tax will be pulled from the seller's account and submitted to the proper tax authority. This change just went into effect on October 24, 2019. Previous to this date, PayPal pulled out the 'Collect and Remit' sales tax before distributing order funds to the seller.
</span>
This enumeration value indicates that PayPal has deposited the 'Collect and Remit' sales tax amount (for the order identified by the corresponding <b>OrderId</b> field) to the seller's account. This enumeration value is only applicable to US sellers not opted in to eBay managed payments, and for orders that are subject to eBay 'Collect and Remit' sales tax. This sales tax will actually get pulled from the seller's account shortly after the order funds clear, and the seller should then see a <b>USInternetSalesTax</b> account entry with a matching amount.
<br><br>
<span class="tablenote"><b>Note: </b>
For US sellers not opted in to eBay managed payments, PayPal will now deposit the entire order amount, including the 'Collect and Remit' sales tax, into the seller's account, and once the order funds clear, this sales tax will be pulled from the seller's account and submitted to the proper tax authority. This change just went into effect on October 24, 2019. Previous to this date, PayPal pulled out the 'Collect and Remit' sales tax before distributing order funds to the seller.
</span>
This enumeration value indicates that PayPal has pulled out the 'Goods and Services' tax amount that was originally deposited to the seller's account. This enumeration value is only applicable to New Zealand sellers for orders that are subject to 'Goods and Services' tax. See the corresponding <b>OrderId</b> value to determine which eBay order this tax pertains to.
<br><br>
<span class="tablenote"><b>Note: </b>
PayPal will now deposit the entire order amount, including the 'Goods and Services' tax, into the seller's account, and once the order funds clear, this sales tax will be pulled from the seller's account and submitted to the proper tax authority. This change just went into effect on October 24, 2019. Previous to this date, PayPal pulled out the 'Goods and Services' tax before distributing order funds to the seller.
</span>
This enumeration value indicates that PayPal has deposited the 'Goods and Services' tax amount (for the order identified by the corresponding <b>OrderId</b> field) to the seller's account. This enumeration value is only applicable to New Zealand sellers for orders that are subject to 'Goods and Services' tax. This tax will actually get pulled from the seller's account shortly after the order funds clear, and the seller should then see a <b>NewZealandGST</b> account entry with a matching amount.
<br><br>
<span class="tablenote"><b>Note: </b>
PayPal will now deposit the entire order amount, including the 'Goods and Services' tax, into the seller's account, and once the order funds clear, this sales tax will be pulled from the seller's account and submitted to the proper tax authority. This change just went into effect on October 24, 2019. Previous to this date, PayPal pulled out the 'Goods and Services' tax before distributing order funds to the seller.
</span>
This enumeration value indicates that PayPal has pulled out the 'Goods and Services' tax amount that was originally deposited to the seller's account. This enumeration value is only applicable to Australian sellers for orders that are subject to 'Goods and Services' tax. See the corresponding <b>OrderId</b> value to determine which eBay order this tax pertains to.
<br><br>
<span class="tablenote"><b>Note: </b>
PayPal will now deposit the entire order amount, including the 'Goods and Services' tax, into the seller's account, and once the order funds clear, this sales tax will be pulled from the seller's account and submitted to the proper tax authority. This change just went into effect on October 24, 2019. Previous to this date, PayPal pulled out the 'Goods and Services' tax before distributing order funds to the seller.
</span>
This enumeration value indicates that PayPal has deposited the 'Goods and Services' tax amount (for the order identified by the corresponding <b>OrderId</b> field) to the seller's account. This enumeration value is only applicable to Australia sellers for orders that are subject to 'Goods and Services' tax. This tax will actually get pulled from the seller's account shortly after the order funds clear, and the seller should then see a <b>AustraliaGST</b> account entry with a matching amount.
<br><br>
<span class="tablenote"><b>Note: </b>
PayPal will now deposit the entire order amount, including the 'Goods and Services' tax, into the seller's account, and once the order funds clear, this sales tax will be pulled from the seller's account and submitted to the proper tax authority. This change just went into effect on October 24, 2019. Previous to this date, PayPal pulled out the 'Goods and Services' tax before distributing order funds to the seller.
</span>
(out) Co-Funding Charge
(out) Co-Funding Charge Credit
Type defining the array of <b>AccountEntry</b> objects that are conditionally returned in the <b>GetAccount</b> response.
Container consisting of detailed information for each debit or credit transaction that occurs on an eBay user's account.
GetAccount
Conditionally
Enumerated type defining the possible values that can be used in the <b>AccountEntrySortType</b> field of the <b>GetAccount</b> request to sort account entries returned in the response.
This is the default value. With this value set, account entries in the <b>GetAccount</b> response are sorted by transaction date (see <b>AccountEntry.Date</b> field) in ascending order (oldest transaction to most recent transaction). This value will produce the same results as the <b>AccountEntryCreatedTimeAscending</b> value.
With this value set, account entries in the <b>GetAccount</b> response are sorted by transaction date (see <b>AccountEntry.Date</b> field) in ascending order (oldest transaction to most recent transaction). This value will produce the same results as the <b>None</b> value.
With this value set, account entries in the <b>GetAccount</b> response are sorted by transaction date (see <b>AccountEntry.Date</b> field) in descending order (most recent transaction to oldest transaction).
With this value set, account entries in the <b>GetAccount</b> response are sorted by Item ID value (see <b>AccountEntry.ItemID</b> field) in ascending order (oldest eBay listing to most recent eBay listing).
With this value set, account entries in the <b>GetAccount</b> response are sorted by Item ID value (see <b>AccountEntry.ItemID</b> field) in descending order (most recent eBay listing to oldest eBay listing).
With this value set, account entries in the <b>GetAccount</b> response are sorted in alphabetical order according to each entry's <b>AccountEntry.Description</b> value. When account entries are sorted according to fee type, the secondary sort criterion is transaction date, and for account entries with identical fee types, the oldest account entries will appear first in the response.
With this value set, account entries in the <b>GetAccount</b> response are sorted in reverse alphabetical order according to each entry's <b>AccountEntry.Description</b> value. When account entries are sorted according to fee type, the secondary sort criterion is transaction date, and for account entries with identical fee types, the oldest account entries will appear first in the response.
(out) Reserved for internal or future use.
Type defining the <b>AccountEntry</b> container returned in the <b>GetAccount</b> response. Each <b>AccountEntry</b> container consists of detailed information for a single credit or debit transaction, or an administrative action which occurred on the eBay user's account.
This enumeration value indicates the type of transaction or administrative action that occurred on the eBay user's account. Possible values are defined in the <b>AccountDetailEntryCodeType</b> enumerated type.
GetAccount
Conditionally
The category of the monetary transaction or administrative action applied
to an eBay account.
GetAccount
Conditionally
This field is no longer returned. If the eBay user has an outstanding balance owed to eBay, the owed amount will be displayed in the <b>AccountSummary.CurrentBalance</b> field in the <b>GetAccount</b> response.
GetAccount
Conditionally
Timestamp indicating the date and time that the entry was posted to the account, in
GMT.
GetAccount
Conditionally
Gross fees that are assessed by eBay (net fees plus VAT, if any).
Returned even if VAT does not apply.
The value is positive for debits and negative for credits.
GetAccount
Conditionally
If the account entry is associated with an eBay listing, this field
shows the eBay <b>ItemID</b> value. If there is no correlation between the account entry and one of the user's eBay listings, '0' is returned in this field.
GetAccount
Conditionally
Memo line for the account entry. It can be an empty string.
GetAccount
Conditionally
The rate used for the currency conversion for a transaction.
GetAccount
Conditionally
Net fees that are assessed by eBay, excluding additional surcharges and VAT
(if any). Returned even if VAT does not apply. The value is positive for
debits (user pays eBay) and negative for credits (eBay pays user).
GetAccount
Conditionally
This value is the unique identifier for the account entry. This value is created by eBay once the transaction occurs on the user's account.
GetAccount
Conditionally
The applicable rate that was used to calculate the VAT (Value-Added Tax) for the transaction. When the <b>VATPercent</b> is specified for a listing, the item's VAT information appears on the View Item page. In addition, the seller can choose to print an invoice that includes the item's net price, VAT percent, VAT amount, and total price. Since VAT rates vary depending on the item and on the user's country of residence, a seller is responsible for entering the correct VAT rate; it is not calculated by eBay. VAT is only applicable to sellers located in a European Union (EU) country. If VAT does not apply to the account entry, this field is still returned but it's value will be '0'.
GetAccount
Conditionally
A description or comment about the monetary transaction or administrative action applied to an eBay user account.
GetAccount
Conditionally
<b>OrderLineItemID</b> is a unique identifier for an eBay order line item. This field is only returned if the account entry is associated with an order line item.
GetAccount
Conditionally
The unique identifier of an order line item. This field is only returned if the account entry is associated with an order line item.
GetAccount
Conditionally
This boolean field is returned as <code>true</code> if the seller received a discount on the Final Value Fee for the order line item. Only Top-Rated sellers are eligible for this Final Value Fee discount. The Final Value Fee discount percentage varies by country. For more information on becoming a Top-Rated Seller in the US and the requirements for Top-Rated Plus listings, see the <a href="https://www.ebay.com/help/selling/seller-levels-performance-standards/seller-levels-performance-standards?id=4080" target="_blank">Becoming a Top Rated Seller</a> help topic.
<br/><br/>
This field will not be returned until eBay bills the seller for the Final Value Fee for the eligible order line item.
GetAccount
Conditionally
This field is returned if the account fee or credit is associated with an entire (single or multiple line item) order, and not necessarily for a single line item within the order.
<br/><br/>
<span class="tablenote"><b>Note: </b> In June 2019, eBay introduced a new order ID format. However, both new and old order ID formats are still supported. For the new order ID format to appear in this field, the user must be using Version 1113 (or newer) of the Trading WSDL, or the user can use an older Trading WSDL and just set the <b>X-EBAY-API-COMPATIBILITY-LEVEL</b> request header to a value of '1113' (or higher). If the version context is not set to '1113' or newer, the old format order ID will appear in this field.
</span>
GetAccount
Conditionally
This enumerated type contains the suppported values that may be used in the <b>AccountHistorySelection</b> field to control the account entries that are returned in a <b>GetAccount</b> response.
This value should be used if the eBay user wants to see the account entries posted to the last invoice that was sent to the user by eBay. If this value is used, the <b>InvoiceDate</b>, <b>BeginDate</b>, and <b>EndDate</b> fields of the <b>GetAccount</b> request are no longer applicable and will be ignored if they are included in the call request.
This value should be used if the eBay user wants to see the account entries for a specific invoice that was sent to the user by eBay. If this value is used, the specific invoice is identified by including the <b>InvoiceDate</b> field and setting its value to the actual invoice date. If this value is used, the <b>BeginDate</b>, and <b>EndDate</b> fields of the <b>GetAccount</b> request are no longer applicable and will be ignored if they are included in the call request.
This value should be used if the eBay user wants to see account entries for a customized date range that can overlap multiple formal eBay invoices. If this value is used, then you also must specify <b>BeginDate</b> and <b>EndDate</b> to set the date range for which to retrieve account entries. If this value is used, then <b>InvoiceDate</b> is no longer applicable and will be ignored if it is included in the call request.
This value should be used if the eBay user wants to see the account entries related to a specific eBay order. If this value is used, the user must also include the <b>OrderID</b> field and sets its value to the identifier of the order for which they wish to retrieve account entries.
<br><br>
<span class="tablenote"><b>Note: </b> In June 2019, eBay introduced a new order ID format to both legacy (including Trading API) and REST-based APIs. At this time, both old and new format order IDs will be accepted in legacy API request payloads to identify orders. In legacy API response payloads, order IDs will appear in the new format if the user is using a Trading WSDL version of '1113' (or newer), or if the user sets the <code>X-EBAY-API-COMPATIBILITY-LEVEL</code> HTTP header to a value of '1113' (or newer). If the Trading WSDL version or compatibility level is less/older than '1113', old format order IDs will be returned in legacy API response payloads. Beginning as soon as March 2020, only new format order IDs will be returned regardless of version number.
</span>
(out) Reserved for internal or future use.
Enumerated type that lists the possible states of an eBay user account.
This value indicates that the eBay user account is active.
This value indicates that the eBay user account has been created, but is not yet active, pending additional information or processing by eBay.
This value indicates that the eBay user account is inactive. No new seller account entries would be posted by eBay to the account.
Reserved for internal or future use.
Summary data for the requesting user's seller account as a whole. This includes a
balance for the account, any past due amount and date, and defining data for
additional accounts (if the user has changed country of residency while having an
active eBay account).
Indicates the current state of the account (such as active or inactive).
Possible values are enumerated in <b>AccountStateCodeType</b>.
GetAccount
Conditionally
This field specifies the payment amount that has been made by the user for the specified/last invoice. This field is only returned if a payment has been made towards the invoice, and if the <b>AccountHistorySelection</b> input field's value was set to <code>LastInvoice</code> or <code>SpecifiedInvoice</code>. This field is not returned if the <b>AccountHistorySelection</b> input field's value was set to <code>BetweenSpecifiedDates</code> and a custom time period (overlapping multiple billing cycles) was specified. If a credit was issued by eBay to the user instead, this credit will be shown in the <b>InvoiceCredit</b> field.
GetAccount
Conditionally
This field specifies the credit amount that has been issued to the user's account by eBay for the specified/last invoice. This field is only returned if a credit has been issued towards the invoice, and if the <b>AccountHistorySelection</b> input field's value was set to <code>LastInvoice</code> or <code>SpecifiedInvoice</code>. This field is not returned if the <b>AccountHistorySelection</b> input field's value was set to <code>BetweenSpecifiedDates</code> and a custom time period (overlapping multiple billing cycles) was specified. If a payment was made by the user instead, this payment amount will be shown in the <b>InvoicePayment</b> field.
GetAccount
Conditionally
This field specifies the balance of any new fees that have been assessed toward the user's account since the last invoice was created. This field is only returned if the <b>AccountHistorySelection</b> input field's value was set to <code>LastInvoice</code>. This field is not returned if the <b>AccountHistorySelection</b> input field's value was set to <code>BetweenSpecifiedDates</code> or <code>SpecifiedInvoice</code>. If there have been no fees since the last invoice was created, this value will be <code>0.0</code>.
GetAccount
Conditionally
This container shows the identifier and current balance for another eBay account associated with the eBay user. This container will appear under the <b>AccountSummary</b> container for each additional account that the eBay user owns.
GetAccount
Conditionally
This value indicates the amount of money that is past due on the user's account. If no money is past due, this value will be <code>0.0</code>.
GetAccount
Conditionally
This string value represents the first four digits of the bank account the associated with the user account. This field is only applicable if a bank account is being used to pay monthly invoices.
4
GetAccount
Conditionally
This timestamp indicates the date and time when the owner of the account last changed the bank account on file as the primary payment method. This field may not be returned if the bank account on file has never been changed, or if the primary payment method is not a bank account.
GetAccount
Conditionally
This integer value indicates the day of the month on which eBay sends a billing invoice to the user. A value of <code>0</code> indicates that an invoice is sent on the last day of each month. A value of <code>15</code>15 indicates that an invoice is sent on the 15th day of each month.
GetAccount
Conditionally
This timestamp indicates the expiration date for the credit card that is currently on file and used to pay monthly invoices. This field may not be returned if the primary method is not a credit card.
GetAccount
Conditionally
This string value represents the last four digits of the credit card that the user selected as payment method for the account. This field is only applicable if a credit card is being used to pay monthly invoices.
GetAccount
Conditionally
This timestamp indicates the date and time when the owner of the account last changed the credit card on file as the primary payment method. This field may not be returned if the credit card on file has never been changed, or if the primary payment method is not a credit card.
GetAccount
Conditionally
This field shows the current balance for the user's account. This value can be <code>0.0</code>, a positive amount (debit), or a negative amount (credit).
<br><br>
This field is only returned if the <b>ExcludeBalance</b> flag is included in the call request and set to <code>false</code>.
GetAccount
Conditionally
Email address on file for the user account. You cannot retrieve an email address for any user with whom you do not have a transactional relationship, regardless of site. Email is only returned for applicable calls when you are retrieving your own user data OR when you and the other user are in a transactional relationship and the call is being executed within a certain amount of time after the transaction is created.
This field specifies the balance for the specified/last invoice. This field is only returned if the <b>AccountHistorySelection</b> input field's value was set to <code>LastInvoice</code> or <code>SpecifiedInvoice</code>. This field is not returned if the <b>AccountHistorySelection</b> input field's value was set to <code>BetweenSpecifiedDates</code> and a custom time period (overlapping multiple billing cycles) was specified. The value is positive for debits and negative for credits.
GetAccount
Conditionally
This timestamp indicates the date and time of the specified/last invoice. This field is only returned if the <b>AccountHistorySelection</b> input field's value was set to <code>LastInvoice</code> or <code>SpecifiedInvoice</code>. This field is not returned if the <b>AccountHistorySelection</b> input field's value was set to <code>BetweenSpecifiedDates</code> and a custom time period (overlapping multiple billing cycles) was specified.
GetAccount
Conditionally
This field shows the amount of the last payment that was made by the user.
GetAccount
Conditionally
This timestamp shows the date and time of the last payment that was made by the user.
GetAccount
Conditionally
This boolean field indicates whether or not the account has a past due balance. A value of <code>true</code> indicates that the account is past due, and a value of <code>false</code> indicates that the account is current. If the account is past due, the amount past due can be found in the <b>AmountPastDue</b> field.
GetAccount
Conditionally
This enumeration value indicates the primary payment method used by the user to pay monthly eBay invoices.
GetAccount
Conditionally
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.
This value indicates that the Classified Ad format feature is disabled for the site or category.
This value indicates that the Classified Ad format feature is enabled for the site or category.
This value indicates that the Classified Ad format is the only listing type supported by the eBay category. This value is not applicable at the eBay site level.
This value indicates that the lead-generation Classified Ad format feature is enabled for the site or category.
This value indicates that the lead-generation Classified Ad format is the only listing type supported by the eBay category. This value is not applicable at the eBay site level.
This value indicates that eBay Motors Local Market listings are enabled for the site or category.
(out) Reserved for internal or future use.
Type defining the <b>AdFormatEnabled</b> field that is returned under the <b>FeatureDefinitions</b> container if <code>AdFormatEnabled</code> is used as a <b>FeatureID</b> value in the request, or if no <b>FeatureID</b> values are used in the request. 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.
<br>
<br>
To verify if a specific eBay site supports Classified Ad listings (for most categories), look for a <code>true</code> value in the <b>SiteDefaults.AdFormatEnabled</b> field.
<br>
<br>
To verify if a specific category on a specific eBay site supports Classified Ad listings, pass in a <b>CategoryID</b> value in the request, and then look for a <code>true</code> value in the <b>AdFormatEnabled</b> field of the corresponding <b>Category</b> node (match up the <b>CategoryID</b> values if more than one Category IDs were passed in the request).
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 value will appear in the response if there is a new message from a prospective buyer that the seller has not yet responded to.
This value will appear in the response if the seller has already responded to the prospective buyer's message.
(out) Reserved for internal or future use.
This type is used by the <b>AdFormatLead</b> container that is returned in the <b>GetAdFormatLeads</b> call response. An <b>AdFormatLead</b> container will be returned for each user that has expressed interest in the Classified Ad listing that was specified by the seller in the <b>GetAdFormatLeads</b> call request. Each <b>AdFormatLead</b> container consists of prospective buyer contact information and other details associated with a lead for a Classified Ad listing.
This field shows the message that was sent from the prospective buyer to the seller. This will be the same content that is returned in the <b>AdFormatLead.MemberMessage.MemberMessageExchange.Question.Body</b> field (that is only displayed if the <b>IncludeMemberMessages</b> boolean field is included in the request and set to <code>true</code>). The advantage of retrieving the <b>MemberMessageExchange</b> node, however, is that you retrieve the entire exchange between the seller and the prospective buyer.
GetAdFormatLeads
DetailLevel: ReturnAll
Conditionally
This container consists of contact information for the prospective buyer.
This container will not be returned if the buyer did not provide any contact information.
GetAdFormatLeads
DetailLevel: ReturnAll
Conditionally
The time of day when the prospective buyer prefers to be contacted by the seller. This field is not returned if this information is unavailable.
GetAdFormatLeads
DetailLevel: ReturnAll
Conditionally
Email address for the prospective buyer. If the prospective buyer chooses to
hide his email address when contacting the seller, this element contains two
dashes (--) instead of an email address.
GetAdFormatLeads
DetailLevel: ReturnAll
Conditionally
Date and time (in GMT) that the lead was submitted.
GetAdFormatLeads
DetailLevel: ReturnAll
Conditionally
The unique identifier of the listing.
GetAdFormatLeads
DetailLevel: ReturnAll
Conditionally
The title of the listing.
80
GetAdFormatLeads
DetailLevel: ReturnAll
Conditionally
The eBay user ID of the user who is interested in the seller's item.
GetAdFormatLeads
DetailLevel: ReturnAll
Conditionally
Contains any mail message content shared between the seller and prospective buyer.
GetAdFormatLeads
DetailLevel: ReturnAll
Conditionally
The enumeration value in this field will indicate whether or not the seller has responded to the lead.
GetAdFormatLeads
DetailLevel: ReturnAll
Conditionally
The pay-per-lead feature is no longer available, and this field is scheduled to
be removed from the WSDL.
Email address for the prospective buyer as entered in the lead form on the View
Item page. Provides a way for sellers to contact prospective buyers who choose not to
log in to eBay. This applies to only eBay Motors and eBay Motors categories.
128
GetAdFormatLeads
DetailLevel: ReturnAll
Conditionally
Prospective buyer's time frame for purchasing a vehicle as entered in the
Lead form on View Item page for eBay Motors and eBay Motors categories.
Purchasing Time Frames include:
<ul>
<li>
within next 3 days
</li>
<li>
within a week
</li>
<li>
within a month
</li>
<li>
within three months
</li>
<li>
in more than three months
</li>
<li>
within an undecided time frame
</li>
</ul>
255
GetAdFormatLeads
DetailLevel: ReturnAll
Conditionally
The year of the vehicle the prospective buyer would like to trade in. Entered on
the lead form on the View Item page. Applies to eBay Motors and Motors categories
only.
32
GetAdFormatLeads
DetailLevel: ReturnAll
Conditionally
The make of the vehicle the prospective buyer would like to trade in. Entered on
the lead form on the View Item page. Applies to eBay Motors and Motors categories
only.
128
GetAdFormatLeads
DetailLevel: ReturnAll
Conditionally
The model of the vehicle the prospective buyer would like to trade in. Entered on the lead form on the View Item page. Applies to eBay Motors and Motors categories only.
128
GetAdFormatLeads
DetailLevel: ReturnAll
Conditionally
Prospective buyer answer whether or not the prospective buyer would like
financing. Entered on the lead form on the View Item page. Applies to eBay Motors
and Motors categories only. Financing response meanings: 0= no response,1= yes, 2=
no.
GetAdFormatLeads
DetailLevel: ReturnAll
Conditionally
This field corresponds to a configurable question on the lead form in the View
Item web page. The corresponding question is site-specific. To determine the
question for a specific site, you must view the form in the web flow for the given
site. This field applies to Classified Ad format listings in Motors categories
only.
GetAdFormatLeads
DetailLevel: ReturnAll
Conditionally
This field corresponds to a configurable question on the lead form in the View
Item web page. The corresponding question is site-specific. To determine the
question for a specific site, you must view the form in the web flow for the given
site. This field applies to Classified Ad format listings in Motors categories
only.
GetAdFormatLeads
DetailLevel: ReturnAll
Conditionally
Type defining the <b>AddItemRequestContainer</b> containers that are used in an <b>AddItems</b> call. An <b>AddItemRequestContainer</b> container is required for each item being created through an <b>AddItems</b> call. Each item being created through an <b>AddItems</b> call is identified through a unique <b>AddItemRequestContainer.MessageID</b> value that is defined by the seller.
Container holding all values that define a new listing. One <b>Item</b>
container is required for each <b>AddItemRequestContainer</b>.
AddItems
Yes
Most Trading API calls support a <b>MessageID</b> element in the request
and a <b>CorrelationID</b> element in the response. With
<b>AddItems</b>, a unique <b>MessageID</b> value is required for
each <b>AddItemRequestContainer</b> container that is used in the request. The
<b>CorrelationID</b> value returned under each
<b>AddItemResponseContainer</b> container is used to correlate each
item request container with its corresponding response container. The same <b>MessageID</b> value that you pass into a request will
be returned in the <b>CorrelationID</b> field in the response.
AddItems
Yes
Type defining the <b>AddItemResponseContainer</b> containers that are returned in an <b>AddItems</b> call. An <b>AddItemResponseContainer</b> container is returned for each item created through an <b>AddItems</b> call. Each item being created through an <b>AddItems</b> call is identified through a unique <b>AddItemRequestContainer.MessageID</b> value that is defined by the seller. To match up the <b>AddItemResponseContainer</b> to the <b>AddItemRequestContainer</b>, look for a <b>AddItemResponseContainer.CorrelationID</b> value that matches the <b>AddItemRequestContainer.MessageID</b> value in the request.
Unique identifier for the new listing. This field is returned as long as the listing was successfully created.
AddItems
Always
Starting date and time for the new listing. This value is based on the time the listing was received and processed, or the time the item will be listed if the seller included the <b>Item.ScheduleTime</b> field in the request and set a custom start time of the listing (in the future).
AddItems
Always
Date and time when the new listing is scheduled to end based on the start time and the listing duration value that was set in the <b>ListingDuration</b> field at listing time. If the value of <b>ListingDuration</b> was set to <code>GTC</code> (Good 'Til Cancelled) this value will be set 30 days ahead of the start time, although this value will be updated if the GTC listing is still alive and automatically renewed 30 days after start time. Note that GTC is not applicable to auction listings.
<br><br>
<span class="tablenote"><b>Note: </b>
As of July 1, 2019, the Good 'Til Cancelled renewal schedule has been modified from every 30 days to once per calendar month. For example, if a GTC listing is created July 5, the next monthly renewal date will be August 5. If a GTC listing is created on the 31st of the month, but the following month only has 30 days, the renewal will happen on the 30th in the following month. Finally, if a GTC listing is created on January 29-31, the renewal will happen on February 28th (or 29th during a 'Leap Year'). See the
<a href="https://pages.ebay.com/seller-center/seller-updates/2019-spring/marketplace-updates.html#good-til-cancelled" target="_blank">Good 'Til Cancelled listings update</a> in the <b>Spring 2019 Seller Updates</b> for more information about this change.
</span>
AddItems
Always
This container is an array of one or more fees associated with the creation of the listing. The fees do not include the Final Value Fee (FVF), which cannot be determined until an item is sold.
AddItems
Always
Final Value Fees And Credits
https://developer.ebay.com/DevZone/guides/features-guide/default.html#Development/Sales-Completing.html#FinalValueFeesandCredits
Fees Per Site
https://developer.ebay.com/DevZone/guides/features-guide/default.html#Development/IntlDiffs-Fees.html
Using Feature Packs
https://developer.ebay.com/DevZone/guides/features-guide/default.html#Development/Desc-FeaturePacks.html
The unique identifier of the primary category in which the item was listed. This field is only returned if the <b>Item.CategoryMappingAllowed</b> boolean field is set to <code>true</code> in the request (or omitted) and the Category ID passed in as the primary listing category was automatically mapped to a new Category ID by eBay. If the primary category ID passed in the request is still active/valid, this field is not returned.
<br/><br/>
<span class="tablenote"><b>Note: </b> The <b>Item.CategoryMappingAllowed</b> field value in the request now defaults to <code>true</code> if omitted. Previously, the default value was <code>false</code>, so a user had to include this field and set it to <code>true</code> in order for eBay to map an outdated Primary or Secondary Category ID to the updated Category ID.
</span>
10
AddItems
Conditionally
Unique identifier of the secondary category in which the item was listed. This field is only returned if the <b>Item.CategoryMappingAllowed</b> boolean field is set to <code>true</code> in the request (or omitted) and the Category ID passed in as the secondary listing category was automatically mapped to a new Category ID by eBay. If the secondary category ID passed in the request is still active/valid, this field is not returned.
<br/><br/>
<span class="tablenote"><b>Note: </b> The <b>Item.CategoryMappingAllowed</b> field value in the request now defaults to <code>true</code> if omitted. Previously, the default value was <code>false</code>, so a user had to include this field and set it to <code>true</code> in order for eBay to map an outdated Primary or Secondary Category ID to the updated Category ID.
</span>
10
AddItems
Conditionally
Most Trading API calls support a <b>MessageID</b> element in the request
and a <b>CorrelationID</b> element in the response. With
<b>AddItems</b>, a unique <b>MessageID</b> value is required for
each <b>AddItemRequestContainer</b> container that is used in the request. The
<b>CorrelationID</b> value returned under each
<b>AddItemResponseContainer</b> container is used to correlate each
item request container with its corresponding response container. The same <b>MessageID</b> value that you pass into a request will
be returned in the <b>CorrelationID</b> field in the response.
AddItems
Always
This container is an array of one or more errors and/or warnings (if any) that occurred when eBay attempted to create the corresponding listing. Note that one or more errors and/or warnings may also occur at the call-level.
<br>
<br>
This container is only returned if there were one or more warnings and/or errors that occurred with the creation of the corresponding listing.
AddItems
Conditionally
Supplemental information from eBay, if applicable. May elaborate on errors or
provide useful hints for the seller. This data can accompany the call's normal
data result set or a result set that contains only errors. The string can
return HTML, including TABLE, IMG, and HREF elements. In this case, an HTML-
based application should be able to include the HTML as-is in the HTML page
that displays the results. A non-HTML application would need to parse the HTML
and convert the table elements and image references into UI elements
particular to the programming language used. Because this data is returned as
a string, the HTML markup elements are escaped with character entity
references (e.g.,<table><tr>...).
AddItems
Conditionally
This container is an array of one or more listing fee/upgrade discount types being offered by eBay to the seller.
AddItems
Conditionally
Container consisting of one or more <b>Recommendation</b> containers. Each <b>Recommendation</b> container provides a message to the seller on how a listing can be improved or brought up to standard in regards to top-rated seller/listing requirements, mandated or recommended Item Specifics, picture quality requirements, pricing and/or listing format recommendations, recommended keywords and/or Item Specifics in a Title, and/or a recommendation to offer fast handling (same-day handling or handling time of 1 day) and/or a free shipping option in order to qualify the listing for a Fast 'N Free badge.
<br><br>
This container is only returned if the <b>IncludeRecommendations</b>
flag was included and set to 'true' in the <b>AddItems</b> request, and if
at least one listing recommendation exists for the newly created listing. If
one or more listing recommendations are returned for one or more of the newly
created listings, it will be at the seller's discretion about whether to revise the
item(s) based on eBay's listing recommendation(s).
AddItems
Conditionally
This type is used by the <b>AddMemberMessagesAAQToBidderRequestContainer</b> container. An <b>AddMemberMessagesAAQToBidderRequestContainer</b> container is required for each bidder the seller is sending a message to. The seller can communicate with up to 10 bidders with one <b>AddMemberMessagesAAQToBidder</b> call.
A <b>CorrelationID</b> value is required for
each <b>AddMemberMessagesAAQToBidderRequestContainer</b> container that is used in the request. The
<b>CorrelationID</b> value returned under each
<b>AddMemberMessagesAAQToBidderResponseContainer</b> container is used to correlate each
member message container in the request with its corresponding member message container in the
response. The same <b>CorrelationID</b> value that you pass into a request will
be returned in the <b>CorrelationID</b> field in the response.
AddMemberMessagesAAQToBidder
Yes
A unique identifier for an eBay listing. This field is required and identifies the active listing that is being discussed between the seller and the bidder.
AddMemberMessagesAAQToBidder
Yes
This container consists of message body, the recipient(s) of the message, and a boolean flag to control whether or not a copy of the message is sent to the sender's My eBay Inbox.
AddMemberMessagesAAQToBidder
Yes
This type is used by the <b>AddMemberMessagesAAQToBidderResponseContainer</b> container. A <b>AddMemberMessagesAAQToBidderResponseContainer</b> container is returned for each message that was sent from the seller to the bidders/potential buyers through a separate <b>AddMemberMessagesAAQToBidderRequestContainer</b>. The <b>Ack</b> value in each <b>AddMemberMessagesAAQToBidderResponseContainer</b> container indicates whether or not each message sent through the call was successful or not, and an <b>AddMemberMessagesAAQToBidderResponseContainer</b> is matched up to the corresponding <b>AddMemberMessagesAAQToBidderRequestContainer</b> through the <b>CorrelationID</b> value.
This is a unique identifier for a message that was sent through the <b>AddMemberMessagesAAQToBidder</b> call. The seller must provide a <b>CorrelationID</b> value for each message that is sent through an <b>AddMemberMessagesAAQToBidderRequestContainer</b> container in the request. The <b>CorrelationID</b> value returned under each <b>AddMemberMessagesAAQToBidderResponseContainer</b> container is used to correlate each member message container in the request with its corresponding member message container in the response.
AddMemberMessagesAAQToBidder
Always
This enumerated value indicates whether or not the corresponding message was successfully sent to the bidder(s)/potential buyer(s). If the value returned in this field is not <code>Success</code>, the message may have to be resent with another <b>AddMemberMessagesAAQToBidder</b> call.
AddMemberMessagesAAQToBidder
Always
Contains the data for one additional account. An additional account is
created when the user has an active account and changes country of
registry (i.e., registers with the eBay site for the new country). A
new account is created and the old account becomes inactive as an
additional account. A user who never changes country of residency while
having an account will never have any additional accounts.
Indicates the current balance of the additional account.
GetAccount
Conditionally
Indicates the currency in which monetary amounts for the additional account
are expressed.
GetAccount
Conditionally
Indicates the unique identifier for the additional account (the account ID).
GetAccount
Conditionally
Type defining the <b>AdditionalCompatibilityEnabled</b> field that is
returned under the <b>FeatureDefinitions</b> container of the
<b>GetCategoryFeatures</b> response (as long as
<code>AdditionalCompatibilityEnabled</code> is included as a <b>FeatureID</b> value in
the call request or no <b>FeatureID</b> values are passed into the call
request). This field is returned as an
empty element (a boolean value is not returned) if one or more eBay API-enabled sites
support the Boats Parts Compatibility feature.
<br/><br/>
To verify if a specific eBay site supports Boats Parts Compatibility (for most
categories), look for a <code>true</code> value in the
<b>SiteDefaults.AdditionalCompatibilityEnabled</b> field.
<br/><br/>
To verify if a specific category on a specific eBay site supports Boats Parts
Compatibility, pass in a <b>CategoryID</b> value in the request, and then
look for a <code>true</code> value in the <b>AdditionalCompatibilityEnabled</b> field
of the corresponding Category node (match up the <b>CategoryID</b> values
if more than one Category IDs were passed in the request).
This enumerated type contains the possible values that can be returned in the <b>type</b> attribute of the <b>AddressAttribute</b> field. Currently, this type only contains one enumeration value, but in the future, other address attributes may be created for this type.
This value indicates that the value returned in the <b>AddressAttribute</b> field is the reference ID for a "Click and Collect" order.
Reserved for internal or future use.
This type is used to display the value of the <b>type</b> attribute of the <b>AddressAttribute</b> field.
The only supported value for this attribute is <code>ReferenceNumber</code>, but in the future, other address attributes may be supported. The <code>ReferenceNumber</code> is a unique identifier for a 'Click and Collect' order. Click and Collect orders are only available on the eBay UK and eBay Australia sites.
GetOrders
DetailLevel: none, ReturnAll
Conditionally
OrderReport
Conditionally
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ReturnAll
Conditionally
Enumerated type used by <b>AddressType</b> to indicate whether a shipping address is on file with eBay or on file with PayPal.
This value indicates that the shipping address being referenced is on file with PayPal.
This value indicates that the shipping address being referenced is on file with eBay.
Reserved for internal or future use.
This enumerated type is deprecated.
This value is not used.
This value is not used.
This value is not used.
This enumerated type is deprecated.
This value is not used.
This value is not used.
This value is not used.
This value is not used.
Contains the data for an eBay user's address. This is the base type for a
number of user addresses, including seller payment address, buyer
shipping address and buyer and seller registration address.
The eBay user's name associated with an address on file with eBay.
<br>
128
GetItem
GetSellingManagerTemplates
RegistrationAddress
DetailLevel: none, ItemReturnAttributes, ItemReturnDescription, ReturnAll
Conditionally
GetUser
Conditionally
RegistrationAddress
DetailLevel: ReturnAll
GetUser
Conditionally
SellerPaymentAddress
DetailLevel: ReturnAll
GetUserContactDetails
Always
GetOrders
DetailLevel: none, ReturnAll
Conditionally
OrderReport
Conditionally
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetSellingManagerSoldListings
Conditionally
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ReturnAll
Conditionally
A concatenation of <b>Street1</b> and <b>Street2</b>, primarily used for a registration address.
GetBidderList
Conditionally
ShippingAddress
GetItem
GetSellingManagerTemplates
RegistrationAddress
DetailLevel: none, ItemReturnAttributes, ItemReturnDescription, ReturnAll
Conditionally
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ReturnAll
Conditionally
ShippingAddress
GetUser
Conditionally
RegistrationAddress
DetailLevel: ReturnAll
AddItem
AddItems
AddSellingManagerTemplate
RelistItem
ReviseItem
ReviseSellingManagerTemplate
VerifyAddItem
VerifyRelistItem
No
The first line of the user's street address.
<br>
64
GetBidderList
Conditionally
ShippingAddress
ReviseSellingManagerSaleRecord
No
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ReturnAll
Conditionally
ShippingAddress
ShipToAddress
GetAdFormatLeads
DetailLevel: ReturnAll
Conditionally
GetItem
GetSellingManagerTemplates
RegistrationAddress
DetailLevel: none, ItemReturnAttributes, ItemReturnDescription, ReturnAll
Conditionally
GetItem
GetSellingManagerTemplates
SellerContactDetails
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally
GetUser
Conditionally
RegistrationAddress
DetailLevel: ReturnAll
GetUser
Conditionally
SellerPaymentAddress
DetailLevel: ReturnAll
GetOrders
DetailLevel: none, ReturnAll
Always
OrderReport
Always
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
The second line of the user's street address (such as an apartment number or suite number).
Returned if the user specified a second street value for their address.
In case of <b>Item.SellerContactDetails</b>, <b>Street2</b> can be used to provide City, Address, State, and Zip code (if applicable).
<br>
64
GetBidderList
Conditionally
ShippingAddress
GetItem
GetSellingManagerTemplates
RegistrationAddress
DetailLevel: none, ItemReturnAttributes, ItemReturnDescription, ReturnAll
Conditionally
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
SellerContactDetails
Conditionally
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ReturnAll
Conditionally
ShippingAddress
ShipToAddress
GetUser
Conditionally
RegistrationAddress
DetailLevel: ReturnAll
GetUser
Conditionally
SellerPaymentAddress
DetailLevel: ReturnAll
GetOrders
DetailLevel: none, ReturnAll
Always
OrderReport
Always
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
AddItem
AddItems
AddSellingManagerTemplate
RelistItem
ReviseItem
ReviseSellingManagerTemplate
VerifyAddItem
VerifyRelistItem
No
The city associated with an address on file with eBay. Most addresses include a city name, but not all. For example, Singapore is an island city-state, so <code>SG</code> would appear in the <b>Country</b> field, and 'Singapore' or 'Republic of Singapore' would appear in the <b>CountryName<b> field, but the <b>CityName<b> field is not applicable.
<br>
64
GetSellingManagerSaleRecord
Conditionally
ShippingAddress
GetAdFormatLeads
DetailLevel: ReturnAll
Conditionally
ReviseSellingManagerSaleRecord
No
GetBidderList
Conditionally
ShippingAddress
GetItem
GetSellingManagerTemplates
RegistrationAddress
DetailLevel: none, ItemReturnAttributes, ItemReturnDescription, ReturnAll
Conditionally
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ReturnAll
Conditionally
ShippingAddress
ShipToAddress
GetUser
Conditionally
RegistrationAddress
DetailLevel: ReturnAll
GetUser
Conditionally
SellerPaymentAddress
DetailLevel: ReturnAll
GetUserContactDetails
Conditionally
GetOrders
DetailLevel: none, ReturnAll
Conditionally
OrderReport
Conditionally
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
The county associated with an address on file with eBay. This field should only be passed in or returned if applicable/defined.
AddItem
AddItems
AddSellingManagerTemplate
RelistItem
ReviseItem
ReviseSellingManagerTemplate
VerifyAddItem
VerifyRelistItem
No
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
SellerContactDetails
Conditionally
The state or province associated with an address on file with eBay. Whether it's a state or a province will depend on the region and/or country. This field should only be passed in or returned if applicable/defined.
<br>
64
GetAdFormatLeads
DetailLevel: ReturnAll
Conditionally
ReviseSellingManagerSaleRecord
No
GetBidderList
Conditionally
ShippingAddress
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ReturnAll
Conditionally
ShippingAddress
ShipToAddress
GetUser
Conditionally
RegistrationAddress
DetailLevel: ReturnAll
GetUser
Conditionally
SellerPaymentAddress
DetailLevel: ReturnAll
GetUserContactDetails
Conditionally
GetOrders
DetailLevel: none, ReturnAll
Conditionally
OrderReport
Conditionally
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
The two-digit code representing the country of the user.<br>
<br>
If not provided as input, eBay uses the country associated
with the eBay Site ID when the call is made.<br>
<br>
For a Global Shipping Program order, <b>GetSellerList</b> returns the country code of the buyer, not the international shipping provider.
GetAllBidders
GetUserContactDetails
Always
GetBidderList
GetUserPreferences
Conditionally
GetItem
GetSellingManagerTemplates
RegistrationAddress
ShippingAddress
DetailLevel: none, ItemReturnAttributes, ItemReturnDescription, ReturnAll
Conditionally
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ReturnAll
ShippingAddress
ShipToAddress
Conditionally
GetOrders
DetailLevel: none, ReturnAll
Always
OrderReport
Always
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetSellerList
Conditionally
HighBidder
DetailLevel: ItemReturnDescription, ReturnAll
GranularityLevel: Fine
ReviseSellingManagerSaleRecord
No
GetUser
Conditionally
RegistrationAddress
DetailLevel: ReturnAll
GetUser
Conditionally
SellerPaymentAddress
DetailLevel: ReturnAll
SetUserPreferences
No
The full name of the country associated with an address on file with eBay.
<br/>
eBay validates the content, but not the length for this field. Note: The eBay
database allocates up to 128 characters for this field.
GetBidderList
Conditionally
ShippingAddress
GetItem
GetSellingManagerTemplates
RegistrationAddress
DetailLevel: none, ItemReturnAttributes, ItemReturnDescription, ReturnAll
Conditionally
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ReturnAll
ShippingAddress
ShipToAddress
Conditionally
GetUser
Conditionally
RegistrationAddress
DetailLevel: ReturnAll, ReturnSummary, none
GetUser
Conditionally
SellerPaymentAddress
DetailLevel: ReturnAll
GetOrders
DetailLevel: none, ReturnAll
Always
OrderReport
Always
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
User's primary phone number. This may return a value of
<code>Invalid Request</code> if you are not authorized to see the
user's phone number.
<br/><br/>
In the US, the area code (3 digits), the prefix (3 digits), the line number (4
digits), and phone extension (if specified by the user) are returned in this field.
The extension can be one or more digits. Non-breaking spaces are used as delimiters
between these phone number components.
<br>
eBay validates the content (should only be integer values and delimiters), but not
the length for this field. Note: The eBay database allocates up to 128 characters
for this field.
GetItem
GetSellingManagerTemplates
RegistrationAddress
DetailLevel: none, ItemReturnAttributes, ItemReturnDescription, ReturnAll
Conditionally
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ReturnAll
ShippingAddress
ShipToAddress
Conditionally
GetBidderList
ShippingAddress
Conditionally
GetUser
Conditionally
RegistrationAddress
DetailLevel: ReturnAll
GetUser
Conditionally
SellerPaymentAddress
DetailLevel: ReturnAll
GetUserContactDetails
Always
GetOrders
DetailLevel: none, ReturnAll
Always
OrderReport
Always
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetAdFormatLeads
DetailLevel: ReturnAll
Conditionally
Standard ISO code for the country of the user's primary telephone phone number.
For Classified Ad listings, this code is used to look up the country's
international calling prefix. Both the ISO code and country phone prefix are
stored with listings of this type.
This field applies to Classified Ad listings only.
AddItem
AddItems
AddSellingManagerTemplate
RelistItem
ReviseItem
ReviseSellingManagerTemplate
VerifyAddItem
VerifyRelistItem
No
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
SellerContactDetails
Conditionally
Country Prefix of the secondary phone number. This value is derived from
inputs supplied for <b>PhoneCountryCode</b>.
This field applies to Classified Ad listings only.
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
SellerContactDetails
Conditionally
Area or City Code of a user's primary phone number.
This field applies to Classified Ad listings only.
AddItem
AddItems
AddSellingManagerTemplate
RelistItem
ReviseItem
ReviseSellingManagerTemplate
VerifyAddItem
VerifyRelistItem
No
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
SellerContactDetails
Conditionally
The local number portion of the user's primary phone number.
This field applies to Classified Ad listings only.
<br><br>
<b>Note:</b> The full primary phone number is constructed by
combining <b>PhoneLocalNumber</b> with <b>PhoneAreaOrCityCode</b> and <b>PhoneCountryPrefix</b>.
<br>
30
AddItem
AddItems
AddSellingManagerTemplate
RelistItem
ReviseItem
ReviseSellingManagerTemplate
VerifyAddItem
VerifyRelistItem
No
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
SellerContactDetails
Conditionally
User's postal code.<br>
<br>
For a Global Shipping Program order, <b>GetSellerList</b> and <b>GetMyeBaySelling</b> return the postal code of the buyer, not that of the international shipping provider.
<br>
24
GetBidderList
Conditionally
GetAdFormatLeads
DetailLevel: ReturnAll
Conditionally
GetSellerList
HighBidder
DetailLevel: ItemReturnDescription, ReturnAll
GranularityLevel: Fine
Conditionally
GetItem
GetSellingManagerTemplates
RegistrationAddress
ShippingAddress
DetailLevel: none, ItemReturnAttributes, ItemReturnDescription, ReturnAll
Conditionally
GetItemTransactions
GetSellerTransactions
ShippingAddress
ShipToAddress
DetailLevel: none, ReturnAll
Conditionally
GetUser
Conditionally
RegistrationAddress
DetailLevel: ReturnAll
GetUser
Conditionally
SellerPaymentAddress
DetailLevel: ReturnAll
GetMyeBaySelling
SoldList
DeletedFromSoldList
DetailLevel: none, ReturnAll
Conditionally
GetAllBidders
Always
GetOrders
DetailLevel: none, ReturnAll
Always
OrderReport
Always
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetSellingManagerSoldListings
Conditionally
Unique ID for a user's address in the eBay database.
This value can help prevent the need to
store an address multiple times across multiple orders.
The ID changes if a user changes their address.
<br>
<br>
<span class="tablenote"><b>Note:</b>
For orders subject to Australian 'Goods and Services' tax (GST), in addition to the unique identifier for the address, the last two digits of the user's Australian Business Number (ABN) will also appear in this field. Australian 'Goods and Services' tax (GST) is automatically charged to buyers outside of Australia when they purchase items on the eBay Australia site.
</span>
GetOrders
DetailLevel: none, ReturnAll
Always
OrderReport
Always
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ReturnAll
Conditionally
The realm to which the address belongs (e.g. eBay vs PayPal).
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetOrders
DetailLevel: none, ReturnAll
Always
OrderReport
Always
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ReturnAll
Conditionally
ShipToAddress
This is a unique identifier assigned to the customer address if the address is on file with PayPal. The <b>AddressOwner</b> field will indicate if the address is on file with eBay or PayPal. This field will only be applicable/returned if it is a PayPal-owned address. The ID changes if a user changes their address.
<br>
20
GetOrders
DetailLevel: none, ReturnAll
Always
OrderReport
Always
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ReturnAll
Conditionally
Seller's international name that is associated with the payment address.
This field is only applicable to seller payment/billing addresses.
GetUser
Conditionally
SellerPaymentAddress
DetailLevel: ReturnAll
GetBidderList
Conditionally
ShippingAddress
International state and city that is associated with the seller's payment address. This field is only applicable to seller payment/billing addresses.
GetUser
Conditionally
SellerPaymentAddress
DetailLevel: ReturnAll
GetBidderList
Conditionally
ShippingAddress
Seller's international street address that is associated with the payment address. This field is only applicable to seller payment/billing addresses.
GetUser
Conditionally
SellerPaymentAddress
DetailLevel: ReturnAll
GetBidderList
Conditionally
ShippingAddress
User's company name. This field should only be passed in or returned if applicable/defined.
GetUserContactDetails
Always
GetBidderList
Conditionally
ShippingAddress
AddItem
AddItems
AddSellingManagerTemplate
RelistItem
ReviseItem
ReviseSellingManagerTemplate
VerifyAddItem
VerifyRelistItem
No
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
SellerContactDetails
Conditionally
GetUser
Conditionally
RegistrationAddress
DetailLevel: ReturnAll
Displays the first name of the seller (in a business card
format) if the seller's <b>SellerBusinessCodeType</b> value is
<code>Commercial</code>.
GetItem
GetSellingManagerTemplates
Conditionally
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
GetAdFormatLeads
Conditionally
DetailLevel: ReturnAll
Displays the last name of the seller (in a business card
format) if the seller's <b>SellerBusinessCodeType</b> is set to
<code>Commercial</code>.
GetItem
GetSellingManagerTemplates
Conditionally
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
GetAdFormatLeads
Conditionally
DetailLevel: ReturnAll
Secondary Phone number of the lead. Not returned if information is unavailable.
GetAdFormatLeads
DetailLevel: ReturnAll
Conditionally
This tag tells whether current address is a default shipping address or one of the shipping addresses in address book.
GetItemTransactions
GetOrderTransactions
GetSellerTransactions
GetOrders
DetailLevel: none, ReturnAll
Conditionally
OrderReport
Conditionally
Uniquely identifies an order shipped using the Global Shipping Program. This value is generated by eBay when the order is completed. The international shipping provider uses the <b>ReferenceID</b> as the primary reference when processing the shipment. Sellers must include this value on the package immediately above the street address of the international shipping provider.
<br/><br/>
Example: "Reference #1234567890123456"
GetItemTransactions
GetOrderTransactions
GetSellerTransactions
GetOrders
SellerShipmentToLogisticsProvider.ShipToAddress
DetailLevel: none, ReturnAll
Conditionally
OrderReport
SellerShipmentToLogisticsProvider.ShipToAddress
Conditionally
This field shows an attribute for the address, and its corresponding value. Currently, this field is only used to display the reference ID for a "Click and Collect" order, but in the future, other address attributes may be returned in this field.
GetOrders
DetailLevel: none, ReturnAll
Conditionally
OrderReport
Conditionally
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ReturnAll
Conditionally
This enumeration type lists the values that will be returned to the seller in a <b>GetOrders</b> 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.
This value indicates that the shipping address provided by the buyer at checkout time is the buyer's default/primary shipping address.
This value indicates that the shipping address provided by the buyer at checkout time is one of the buyer's secondary shipping addresses on file with eBay.
This value indicates that the address is not valid, and an alternative address will have to be provided before the order is shipped.
(out) Reserved for internal or future use.
Type used by the <b>AffiliateTrackingDetails</b> container, which is included in the <b>PlaceOffer</b> 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.
<span class="tablenote"><b>Note: </b> If you are using
affiliate tracking, this field is required.
</span>
The value you specify in this field is obtained from your tracking partner.
For the eBay Partner Network, the <b>TrackingID</b> is the Campaign ID ("campid")
provided by the eBay Partner Network. A Campaign ID is a 10-digit, unique
number for associating traffic. A Campaign ID is valid across all
programs to which you have been accepted.
PlaceOffer
Conditionally
<span class="tablenote"><b>Note: </b> If you are using
affiliate tracking, this field is required.
</span>
Specifies your tracking partner for affiliate commissions.
Depending on your tracking partner, specify one of the
following values. Not all partners are valid for all sites.
For <b>PlaceOffer</b>, only eBay Partner Network is valid:
<br>
<br>9 = eBay Partner Network
<br>
<br>
For information about the eBay Partner Network, see
<a href="https://www.ebaypartnernetwork.com" target="_blank">eBay Partner Network</a>.
Affiliate Tracking Concepts
https://developer.ebay.com/DevZone/guides/features-guide/default.html#Basics/eBay-AffiliateTrackingConcepts.html
PlaceOffer
Conditionally
<span class="tablenote"><b>Note: </b> If you are using
affiliate tracking, this field is required.
</span>
Type of device or platform from which the call originated.
PlaceOffer
Conditionally
This field is not required, but an affiliate may want to use this identifier to better monitor marketing efforts. If you are using the eBay Partner Network, and you provide an <b>AffiliateUserID</b>, the tracking URL returned by eBay Partner Network will contain the <b>AffiliateUserID</b>, but it will be referred to as a "customid".
256
PlaceOffer
Conditionally
An eBay-defined complex type for specifying monetary amounts.
<br><br>
A double value (e.g., 1.00 or 1.0) is meaningful as a monetary amount when accompanied by a specification of the currency, in which case the value specifies the amount in that currency. An <b>AmountType</b> expresses both the value (a double) and the currency.
<br><br>
The <b>AmountType</b> data type is typically used to specify details such as prices, fees, costs, and payments. In some cases, a whole number (i.e., without a period) can be passed or returned as a monetary value. This is necessary to support certain currencies that are only expressed as whole numbers.
<br><br>
Because a double is used to represent the amount, this also means whole monetary amounts may be returned with only one 0 after the decimal. For example, a dollar value could be returned as 1.0 instead of 1.00 in calls like <b>AddItem</b>.
Three-digit code representing the currency type being used. <br>
<br>
In <b>Add</b>/<b>Revise</b>/<b>Relist</b> calls, the currency can be specified in
the <b>Item.Currency</b> field in requests instead.
If you do specify this attribute in <b>Add</b>/<b>Revise</b>/<b>Relist</b> calls,
the value must match the site currency (i.e., it must be the same
as the value in <b>Item.Currency</b>) unless otherwise stated.<br>
<br>
In <b>Add</b>/<b>Revise</b>/<b>Relist</b> calls, listing fees are returned in the
currency of the user's registration site.
For example, a user who is registered on the eBay US site always
sees their fees returned in USD, even when their listing request
is sent to another site, such as eBay UK or eBay Germany.
DeleteSellingManagerItemAutomationRule
DeleteSellingManagerTemplateAutomationRule
GetBidderList
GetSellingManagerTemplateAutomationRule
GetSellingManagerTemplates
GetSellingManagerItemAutomationRule
GetItemShipping
GetMyeBaySelling
SetSellingManagerItemAutomationRule
SetSellingManagerTemplateAutomationRule
Conditionally
GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
Conditionally
AddOrder
Order.Total
Yes
GetItem
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally
GetMyeBayBuying
DetailLevel: none, ReturnSummary, ReturnAll
Conditionally
GetShippingDiscountProfiles
Conditionally
SetShippingDiscountProfiles
Conditionally
RespondToBestOffer
ReviseCheckoutStatus
ReviseSellingManagerSaleRecord
No
InternationalShippingServiceOption
ShippingServiceOptions
ShippingServiceSelected
Always
GetBestOffers
DetailLevel: none, ReturnAll
Always
GetOrders
InternationalShippingServiceOption
ShippingServiceOptions
ShippingServiceSelected
DetailLevel: none, ReturnAll
Always
OrderReport
InternationalShippingServiceOption
ShippingServiceOptions
ShippingServiceSelected
Always
GetOrders
InternationalShippingServiceOption
ShippingServiceOptions
ShippingServiceSelected
DetailLevel: none, ReturnAll
Conditionally
OrderReport
InternationalShippingServiceOption
ShippingServiceOptions
ShippingServiceSelected
Conditionally
GetSellerTransactions
InternationalShippingServiceOption
ShippingServiceOptions
ShippingServiceSelected
DetailLevel: none
Conditionally
GetOrderTransactions
InternationalShippingServiceOption
ShippingServiceOptions
ShippingServiceSelected
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
PlaceOffer
ConvertedCurrentPrice
CurrentPrice
Always
PlaceOffer
MinimumToBid
Conditionally
AddItem
AddItems
AddSellingManagerTemplate
RelistItem
ReviseItem
ReviseSellingManagerTemplate
VerifyAddItem
No
Always
AddLiveAuctionItem
ReviseLiveAuctionItem
No
Always
GetAllBidders
GetStoreOptions
Yes
Always
RelistItem
No
AddTransactionConfirmationItem
Yes
SendInvoice
ShippingInsuranceCost, ShippingServiceCost,
ShippingServiceAdditionalCost, SalesTaxAmount, InsuranceFee
No
GetSellingManagerSaleRecord
AddItemFromSellingManagerTemplate
Always
Part of the mechanism for eBay to control which announcement messages are
to be made available to the user.
No message is to be made available.
A deprecation message is to be made available,
but only if today's date is between <b>AnnouncementMessageType.AnnouncementStartTime</b>
and <b>AnnouncementMessageType.EventTime</b>.
A mapping message is to be made available,
but only if today's date is after <b>AnnouncementMessageType.EventTime</b>.
Both "Deprecation" and "Mapping" enumerations are to apply.
Reserved for future use.
Type defining the <b>ShippingServiceDetails.DeprecationDetails</b> container that is returned in the <b>GeteBayDetails</b> response. The <b>ShippingServiceDetails.DeprecationDetails</b> container consists of information related to a deprecated shipping service.
The date on which an upcoming event can start to be announced.
GeteBayDetails
Conditionally
The date on which the event occurs. This is also the ending date of the
announcement that lead up to the event (see <b>AnnouncementStartTime</b>).
GeteBayDetails
Conditionally
Control of what messages to display.
GeteBayDetails
Conditionally
This type is used by the <b>ApiAccessRule</b> container that is returned in the <b>GetApiAccessRules</b> call response. An <b>ApiAccessRule</b> container will be returned for every Trading API call that the user/application has used. The <b>ApiAccessRule</b> container consists of hourly, daily, and periodic call limits for the call, the total number of times the call was used, and other information about usage of the call.
The value in this field can be the name of a Trading API call, or it can be <code>ApplicationAggregate</code> (returns totals for all calls),
<code>PasswordAuthenticationLimiter</code> (dummy call), or <code>NonUTF8UsageLimiter</code>. All of the other data in the <b>ApiAccessRule</b> container will pertain to this call, including the call limits.
GetApiAccessRules
Always
This boolean field will indicate whether or not the use of the call (indicated in <b>CallName</b> field) counts toward the application's
aggregate limit for all calls.
GetApiAccessRules
Always
This value indicates the total number of calls per day that the application can make to this call before being blocked.
The day starts at midnight, 00:00:00 PST (not GMT).
GetApiAccessRules
Always
This value indicates the total number of calls per day that the application can make to this call before you receive a warning.
The day starts at midnight, 00:00:00 PST.
GetApiAccessRules
Always
This value indicates the number of times that the application has used this
call today. The day starts at midnight, 00:00:00 PST.
GetApiAccessRules
Always
This value indicates the total number of calls per hour that the application can make to this call before being blocked. Each count begins at the top of each hour (e.g. 1:00:00).
GetApiAccessRules
Always
This value indicates the total number of calls per hour that the application can make to this call before you receive a warning. Each count begins at the top of each hour (e.g. 1:00:00).
GetApiAccessRules
Always
This value indicates the number of times that the application has used this
call during this hour. Each count begins at the top of each hour (e.g. 1:00:00).
GetApiAccessRules
Always
The length of time before your application's periodic usage counter restarts
for this call. If the number of calls you make exceeds the periodic hard limit
before the current period ends, further calls will be blocked until the next
period starts. Possible values: -1 (Periodic limit not enforced, could be any
negative integer), 0 (Calendar month), 30 (Number of days, could be any
positive integer). If the period is based on the calendar month, the usage
counters restart on the same day of every month, regardless of the number of
days in the month.
GetApiAccessRules
Always
This value indicates the number of calls per period that your application may make before a call is blocked, if the periodic limit is enforced. The length of the period is specified in the <b>Period</b> field.
GetApiAccessRules
Always
This value indicates the number of calls per period that your application may make before receiving a warning, if the periodic limit is enforced. The length of the period is specified in the <b>Period</b> field.
GetApiAccessRules
Always
This value indicates the number of times that the application has used this call during this period. <code>0</code> is returned if the periodic access rule has not been configured for the application. The length of the period is specified in <b>Period</b> field and the start date of the period is specified in <b>PeriodicStartDate</b> field.
GetApiAccessRules
Always
This timestamp (in GMT) marks the date and time when the access rule's period started. The period starts at midnight Pacific time. For example, if the period begins on June 29 in 2005 when California is on Pacific Daylight Time, the GMT value returned would be 2005-06-29T07:00:00.000Z If the period begins on December 29 in 2005 when California is on Pacific Standard Time, the GMT value returned would be 2005-12-29T08:00:00.000Z. This field is only returned when the eBay Developers Program has configured the start date for the access rule. The start date can vary per application and per call name.
GetApiAccessRules
Conditionally
This timestamp marks the date and time when the access rule was last modified by eBay.
GetApiAccessRules
Always
This enumeration value will only be returned if a hourly, daily, or periodic hard or soft call limit is exceeded by the application, or if call limits do not apply to the call.
GetApiAccessRules
Conditionally
This enumeration value will indicate whether the access rule is on or off, or if the application is currently being blocked due to exceeding a hard call limit.
GetApiAccessRules
Always
Type used by the <b>ApplicationDeliveryPreferences</b> container to control/indicate where and how Platform Notifications and/or Client Alerts are delivered to a user application, server, and/or email address.
The URL to which eBay delivers all Platform Notifications and Client Alerts sent to the application. For
delivery to a server, the URL begins with "<code>http://</code>" or "<code>https://</code>" and must be well
formed. For delivery to
an email address, the URL begins with ""<code>mailto://</code>" and specifies a valid email
address.
SetNotificationPreferences
No
GetNotificationPreferences
Conditionally
This field allows the user to enable or disable Platform Notifications and Client Alerts. Notice that disabling Platform Notifications and Client Alerts will not affect others preferences set in this container.
SetNotificationPreferences
No
GetNotificationPreferences
Conditionally
The email address to which eBay sends all application markup and markdown event
notifications. When setting the email address, input must be in the format
"<code>mailto://[email protected]</code>". Note that the <b>AlertEnable</b> field must be set to <code>Enable</code> for alert emails to be sent.
SetNotificationPreferences
No
GetNotificationPreferences
Conditionally
<b>For SetNotificationPreferences</b>: include and set <b>AlertEnable</b> to
<code>Enable</code> to receive application markup and markdown alerts, or set to <code>Disable</code> to
disable the alerts. If not included, the <b>AlertEnable</b> defaults to
its current value.
<br/><br/>
<b>For GetNotificationPreferences</b>: this field's value indicates
whether application markup and markdown alerts are enabled or disabled.
SetNotificationPreferences
No
GetNotificationPreferences
Conditionally
This field is deprecated and should no longer be used.
The means of receipt of notification. In most cases, it is Platform (typical API
calls and web interaction), so this is the default, if not specified. For
wireless applications, use SMS. Do not test Client Alerts in production if you
are currently using Platform Notifications.
SetNotificationPreferences
No
GetNotificationPreferences
Conditionally
Use this field to specify the API version for all notifications for the calling
application. If you do not specify PayloadVersion in
SetNotificationPreferences, the API version for notifications will be based on
the API version specified in your SetNotificationPreferences call.
SetNotificationPreferences
No
GetNotificationPreferences
Conditionally
Defines settings for notification URLs (including the URL name in DeliveryURLName). You
define settings for up to 25 notification URLs (including the URL name in
DeliveryURLName) in separate DeliveryURLDetails containers. Associate a user token with
notification URLs by using the token in a SetNotificationPreferences request that
specifies the URL name or names in SetNotificationPreferencesRequest.DeliveryURLName. Use
comma-separated format to specify multiple URL names in
SetNotificationPreferencesRequest.DeliveryURLName. Notifications will be sent to these
URL(s) if ApplicationDeliveryPreferencesType.ApplicationEnable is set to Enable.
SetNotificationPreferences
No
GetNotificationPreferences
Conditionally
This enumerated type list the possible devices that may be running a affiliate user's application. The affiliate must mark the type of device that is running their application when the <b>PlaceOffer</b> call is made.
This enumeration value indicates that the user's application is running in a browser.
This enumeration value indicates that the user's application is a wireless application.
This enumeration value indicates that the user's application is a desktop application.
This enumeration value indicates that the user's application is running through a television set-top box.
Reserved for future use.
This enumerated type is used by the <b>AspectUsage</b> field that is returned in <b>GetCategorySpecifics</b> 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.
This enumeration value indicates that the Item Specific in the corresponding <b>NameRecommendation.Name</b> field is defined/derived from an eBay catalog product. 'Product' Item Specifics are also referred to as Product Aspects in Web flows and other APIs. Generally, catalog product-based Item Specifics should not be modified if the seller created/revise/relisted the item based on an eBay catalog product.
This enumeration value indicates that the Item Specific in the corresponding <b>NameRecommendation.Name</b> field is an 'instance aspect', which is an Item Specific whose value will vary based on a particular instance of the product. When creating a listing, the seller should pass in the name-value pair for this Item Specific through the <b>Item.ItemSpecifics.NameValueList</b> container of an <b>AddItem</b> call.
Reserved for future use.
This type is only applicable for Half.com listings, and since the Half.com site was taken down, this type is no longer applicable.
<b>AttributeArrayType</b> and the <b>Attribute</b> element are only applicable for Half.com listings, and since the Half.com site was taken down, this field is no longer applicable.
1027
NoOp
1033
This enumerated type is deprecated.
This value is not used.
This value is not used.
This value is not used.
This value is not used.
This enumerated type is deprecated.
This type is deprecated.
This field is deprecated.
This type is deprecated.
This field is deprecated.
773
NoOp
889
Item.ItemSpecifics
This type is deprecated.
773
NoOp
889
Item.ItemSpecifics
This field is deprecated.
773
NoOp
889
Item.ItemSpecifics
This field is deprecated.
773
NoOp
889
Item.ItemSpecifics
This field is deprecated.
773
NoOp
889
Item.ItemSpecifics
This type is only applicable for Half.com listings, and since the Half.com site was taken down, this type is no longer applicable.
<b>AttributeType</b> 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.
1027
NoOp
1033
<b>AttributeType</b> 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.
1027
NoOp
1033
<b>AttributeType</b> 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.
1027
NoOp
1033
This enumeration type lists the types of user authentication tokens that can be used to access/use eBay APIs.
This value indicates that a Client Alerts token is required.
Reserved for internal or future use.
Enumerated type that defines the possible settings for the automated feedback mechanism embedded in the <b>SetSellingManagerFeedbackOptions</b> API call. This type is only applicable to Selling Manager Pro users.
If the <b>AutomatedLeaveFeedbackEvent</b> field is set to this value, the automated feedback mechanism will automatically leave feedback for the buyer once that buyer leaves positive feedback for the seller.
If the <b>AutomatedLeaveFeedbackEvent</b> field is set to this value, the automated feedback mechanism will automatically leave feedback for the buyer once that buyer pays for the line item.
If the <b>AutomatedLeaveFeedbackEvent</b> field is set to this value, the automated feedback mechanism will essentially be turned off. Automated feedback will not occur.
(out) Reserved for internal or future use.
This type has been deprecated.
This field is deprecated.
587
681
NoOp
Applicable to sites that support the Detailed Seller Rating (DSR) feature.
The <b>AverageRatingDetails</b> container consists of the average detailed seller ratings in an area. When buyers leave an overall Feedback rating (positive, neutral, or negative) for a seller, they also can leave ratings in four areas: item as described, communication, shipping time, and charges for shipping and handling. Users retrieve detailed ratings as averages of the ratings left by buyers.
The value shown in this field indicates the Detailed Seller Rating area. The corresponding <b>Rating</b> value is the average rating that the seller has received for this DSR area, and the <b>RatingCount</b> value is the total number of buyer ratings that the seller has received in this DSR area. When buyers leave an overall Feedback rating (positive, neutral, or negative) for a seller, they also can leave ratings in four areas: item as described, communication, shipping time, and charges for shipping and handling.
GetFeedback
Conditionally
DetailLevel: none, ReturnAll
This value is the seller's average rating (given by buyers) for the DSR area noted in the corresponding <b>RatingDetail</b> field.
GetFeedback
Conditionally
DetailLevel: none, ReturnAll
This value is the total count of buyer ratings given for the DSR area noted in the corresponding <b>RatingDetail</b> field.
GetFeedback
Conditionally
DetailLevel: none, ReturnAll
This type is used by the <b>AverageRatingSummary</b> container that is returned in the <b>GetFeedback</b> call to display the seller's rating information across the four different Detail Seller Rating areas. The Detail Seller Rating subject areas include Item as Described, Communication, Shipping Time, and Shipping and Handling charges.
This enumeration value will indicate whether the statistics in each AverageRatingDetails container is for the last year (<code>FiftyTwoWeeks</code>) or the last month (<code>ThirtyDays</code>).
GetFeedback
Conditionally
DetailLevel: none, ReturnAll
Applicable to sites that support the Detailed Seller Ratings feature.
Each <b>AverageRatingDetails</b> container consists of the average detailed seller ratings in an area. When buyers leave an overall Feedback rating (positive, neutral, or negative) for a seller, they also can leave ratings in four areas: item as described, communication, shipping time, and charges for shipping and handling.
GetFeedback
Conditionally
DetailLevel: none, ReturnAll
This enumerated type is deprecated.
This value is not used.
This value is not used.
Base64 is a binary-to-text encoding scheme that represents binary data in an ASCII string format by translating it into a radix-64 representation. The term "Base64" originates from a specific MIME content transfer encoding.
<br/><br/>
<span class="tablenote">
<strong>Note:</strong> This type contains the name or reference ID of the binary attachment, not the attachment data.
</span>
This optional attribute allows the binary attachment to be named.
UploadSiteHostedPictures
No
This type is deprecated.
This field is deprecated.
This type is deprecated.
Enumerated type that defines the possible values that can be passed in to the <b>Action</b> field in a <b>RespondToBestOffer</b> request.
This value should be passed in to the <b>Action</b> field to accept the Best Offer identified in the <b>BestOfferID</b> field. Note that only one Best Offer may be accepted in a single <b>RespondToBestOffer</b> call.
This value should be passed in to the <b>Action</b> field to decline one or more Best Offers identified by one or more <b>BestOfferID</b> fields. Note that multiple Best Offers may be declined in a single <b>RespondToBestOffer</b> call.
This value should be passed in to the <b>Action</b> field to counter a buyer's Best Offer or Counter Offer. Note that a seller may only counter one Best Offer in a single <b>RespondToBestOffer</b> call. If a seller is using the <b>RespondToBestOffer</b> call to counter a Best Offer, the counter offer price must be specified in the <b>CounterOfferPrice</b> field, and the quantity of items in the Best Offer must be specified in the <b>CounterOfferQuantity</b> field.
Reserved for internal or future use.
An array of one or more Best Offers. This type is used in the responses of the <b>GetBestOffers</b> and <b>RespondToBestOffer</b> calls.
For <b>GetBestOffers</b>, each <b>BestOffer</b> container consists of detailed information on the Best Offer/Counter Offer, including the type of Best Offer (Best Offer, Buyer/Seller Counter Offer), amount of the Best Offer/Counter Offer, and status of Best Offer/Counter Offer.
<br/><br/>
For <b>RespondToBestOffer</b>, each <b>BestOffer</b> container provides the status ('Success' or 'Failure') of the Best Offer action (Accept, Counter, or Decline), which are defined in <a href="types/BestOfferActionCodeType.html">BestOfferActionCodeType</a>.
RespondToBestOffer
Always
GetBestOffers
DetailLevel: none, ReturnAll
Always
Type defining the <b>BestOfferAutoAcceptEnabled</b> field that is
returned under the <b>FeatureDefinitions</b> container of the
<b>GetCategoryFeatures</b> response (as long as
<code>BestOfferAutoAcceptEnabled</code> or <code>BestOfferAutoDeclineEnabled</code> is included as a <b>FeatureID</b> value in
the call request or no <b>FeatureID</b> values are passed into the call
request). This field is returned as an
empty element (a boolean value is not returned) if one or more eBay API-enabled sites
support the Best Offer Auto Accept feature.
<br/><br/>
To verify if a specific eBay site supports the Best Offer Auto Accept feature (for most
categories), look for a <code>true</code> value in the
<b>SiteDefaults.BestOfferAutoAcceptEnabled</b> field.
<br/><br/>
To verify if a specific category on a specific eBay site supports the Best Offer Auto Accept feature, pass in a <b>CategoryID</b> value in the request, and then
look for a <code>true</code> value in the <b>BestOfferAutoAcceptEnabled</b> field
of the corresponding Category node (match up the <b>CategoryID</b> values
if more than one Category IDs were passed in the request).
Type defining the <b>BestOfferAutoDeclineEnabled</b> field that is
returned under the <b>FeatureDefinitions</b> container of the
<b>GetCategoryFeatures</b> response (as long as
<code>BestOfferAutoDeclineEnabled</code> or <code>BestOfferAutoAcceptEnabled</code> is included as a <b>FeatureID</b> value in
the call request or no <b>FeatureID</b> values are passed into the call
request). This field is returned as an
empty element (a boolean value is not returned) if one or more eBay API-enabled sites
support the Best Offer Auto Decline feature.
<br/><br/>
To verify if a specific eBay site supports the Best Offer Auto Decline feature (for most
categories), look for a <code>true</code> value in the
<b>SiteDefaults.BestOfferAutoDeclineEnabled</b> field.
<br/><br/>
To verify if a specific category on a specific eBay site supports the Best Offer Auto Decline feature, pass in a <b>CategoryID</b> value in the request, and then
look for a <code>true</code> value in the <b>BestOfferAutoDeclineEnabled</b> field
of the corresponding Category node (match up the <b>CategoryID</b> values
if more than one Category IDs were passed in the request).
Type defining the <b>BestOfferCounterEnabled</b> field that is
returned under the <b>FeatureDefinitions</b> container of the
<b>GetCategoryFeatures</b> response (as long as
<code>BestOfferCounterEnabled</code> is included as a <b>FeatureID</b> value in
the call request or no <b>FeatureID</b> values are passed into the call
request). This field is returned as an
empty element (a boolean value is not returned) if one or more eBay API-enabled sites
support the Best Offer Counter Offer feature.
<br/><br/>
To verify if a specific eBay site supports the Best Offer Counter Offer feature (for most
categories), look for a <code>true</code> value in the
<b>SiteDefaults.BestOfferCounterEnabled</b> field.
<br/><br/>
To verify if a specific category on a specific eBay site supports the Best Offer Counter Offer feature, pass in a <b>CategoryID</b> value in the request, and then
look for a <code>true</code> value in the <b>BestOfferCounterEnabled</b> field
of the corresponding Category node (match up the <b>CategoryID</b> values
if more than one Category IDs were passed in the request).
Type defining the <b>BestOfferDetails</b> container, which consists
of Best Offer details associated with a listing. The <b>BestOfferEnabled</b>
field in this container is used by <b>Add</b>/<b>Revise</b>/<b>Relist</b> calls to enable the Best Offer feature on a listing.
The number of Best Offers made for this item, if any. In other words, if there are no Best Offers made, this field will not appear in the response. This field is not applicable to the <b>Add</b>/<b>Revise</b>/<b>Relist</b> calls.
GetBidderList
GetSellerList
Conditionally
GetItem
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally
GetMyeBaySelling
ActiveList
DetailLevel: none, ReturnAll
Conditionally
GetSellerEvents
DetailLevel: none, ReturnAll
Conditionally
This field indicates whether or not the Best Offer feature is enabled for the listing. A seller can enable the Best Offer feature for a listing as long as the category supports the Best Offer feature. To see if an eBay category supports the Best Offer feature, run a <b>GetCategoryFeatures</b> call, including <code>BestOfferEnabled</code> as a <b>FeatureID</b> value in the call request payload.
<br/><br/>
A listing enabled with the Best Offer feature allows a buyer to bargain with the seller and make a lower-priced offer than the fixed price or the starting bid price for an auction listing. The seller can then decide whether to accept the buyer's Best Offer price or propose a counter offer higher than the Best Offer price, but lower than the fixed price or starting bid price.
<br/><br/>
<span class="tablenote"><b>Note: </b>
The Best Offer feature is now available for auction listings on the following sites: US, Canada, UK, Germany, Australia, France, Italy, and Spain. However, sellers must choose between offering Best Offer or Buy It Now on an auction listing, as both features cannot be enabled on the same auction listing. If an auction listing is enabled with Best Offer, this feature will no longer be applicable once the listing receives its first qualifying bid.
</span>
AddFixedPriceItem
AddItem
AddItems
AddSellingManagerTemplate
RelistItem
ReviseFixedPriceItem
ReviseItem
ReviseSellingManagerTemplate
SetSellingManagerTemplateAutomationRule
SetSellingManagerItemAutomationRule
VerifyAddFixedPriceItem
VerifyAddItem
VerifyRelistItem
No
GetItem
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally
GetSellerEvents
DetailLevel: none, ReturnAll
Conditionally
DeleteSellingManagerTemplateAutomationRule
DeleteSellingManagerItemAutomationRule
GetBidderList
GetSellingManagerTemplateAutomationRule
GetSellingManagerItemAutomationRule
SetSellingManagerTemplateAutomationRule
SetSellingManagerItemAutomationRule
GetSellingManagerTemplates
Conditionally
This is the amount of the buyer's current Best Offer. This field will not appear in the <b>GetMyeBayBuying</b> response if the buyer has not made a Best Offer. This field is also not applicable to the <b>Add</b>/<b>Revise</b>/<b>Relist</b> calls.
GetMyeBayBuying
BestOfferList
DetailLevel: none, ReturnAll
Conditionally
This enumeration value indicates the status of the latest
Best Offer from the buyer. This field is only applicable to the <b>GetMyeBayBuying</b> call, and will not appear in the
response if the buyer has not made a Best Offer.
GetMyeBayBuying
Conditionally
BestOfferList
DetailLevel: none, ReturnAll
Note: this field is no longer used. The Best Offer type is only returned in the <b>BestOfferCodeType</b> field of the <b>GetBestOffers</b> call, and the applicable values for Best Offer type (<code>BuyerBestOffer</code>, <code>BuyerCounterOffer</code>, <code>SellerCounterOffer</code>, etc.) are defined in <b>BestOfferTypeCodeType</b>.
This field is deprecated.
Type defining the <b>BestOfferEnabled</b> field that is
returned under the <b>FeatureDefinitions</b> container of the
<b>GetCategoryFeatures</b> response (as long as
<code>BestOfferEnabled</code> is included as a <b>FeatureID</b> value in
the call request or no <b>FeatureID</b> values are passed into the call
request). This field is returned as an
empty element (a boolean value is not returned) if one or more eBay API-enabled sites
support the Best Offer feature.
<br/><br/>
To verify if a specific eBay site supports the Best Offer feature (for most
categories), look for a <code>true</code> value in the
<b>SiteDefaults.BestOfferEnabled</b> field.
<br/><br/>
To verify if a specific category on a specific eBay site supports the Best Offer feature, pass in a <b>CategoryID</b> value in the request, and then
look for a <code>true</code> value in the <b>BestOfferEnabled</b> field
of the corresponding Category node (match up the <b>CategoryID</b> values
if more than one Category IDs were passed in the request).
GetCategoryFeatures
DetailLevel: none, ReturnSummary, ReturnAll
Conditionally
Unique identifier for a Best Offer. This identifier is created once a prospective buyer makes a Best Offer on an item.
Enumerated type that defines the possible values for the status of a Best Offer or a buyer's/seller's counter offer.
This value indicates that the buyer's Best Offer on an item is awaiting the
seller's response (accept, decline, counter offer). A buyer's Best Offer expires
after 48 hours without a seller's response.
Depending on context, this value can indicate that the buyer's Best Offer was
accepted by the seller, or that the seller's or buyer's counter offer was accepted by the other party.
Depending on context, this value can indicate that the buyer's Best Offer was
declined by the seller, or that the seller's or buyer's counter offer was declined by the other party.
Depending on context, this value can indicate that the buyer's Best Offer expired due to the passing of 48 hours with no seller response (accept, decline, counter offer), or that the seller's or buyer's counter offer expired due to the passing of 48 hours with no response from other party.
Depending on context, this value can indicate that the buyer has retracted the Best Offer, or that the seller's or buyer's counter offer has been retracted.
This value indicates that the Best Offer was ended by an eBay administrator.
Depending on context, this value can indicate that a buyer's Best Offer or that the seller's or buyer's counter offer is in the active state. The <code>Active</code> value can also be used in the <b>GetBestOffers</b> request to retrieve only active Best Offers.
Depending on context, this value can indicate that a buyer's Best Offer has been countered by the seller, or that the seller's or buyer's counter offer has been countered by the other party.
This value is used in the <b>GetBestOffers</b> request to retrieve all Best Offers in all states. This value is only applicable to the <b>GetBestOffers</b> call.
This value indicates that the buyer and seller have come to agreement on a Best Offer price, but the seller is still waiting for payment from the buyer. If the buyer does not pay within 48 hours, the Best Offer will expire.
This value indicates that the seller is waiting on the buyer to commit to buying the item at the counter offer price.
(out) Reserved for internal or future use.
Type defining the <b>BestOffer</b> container, which consists of information on one Best Offer or counter offer. This information includes the price of the offer, the expiration of the offer, and any messaging provided by the prospective buyer or seller.
Unique identifier for a Best Offer. This identifier is created once a prospective buyer makes a Best Offer on an item.
GetBestOffers
DetailLevel: none, ReturnAll
Always
PlaceOffer
Conditionally
Timestamp indicating when a Best Offer will naturally expire (if the
seller has not accepted or declined the offer).
GetBestOffers
DetailLevel: none, ReturnAll
Always
Container consisting of information about the prospective buyer who made the Best Offer.
GetBestOffers
DetailLevel: none, ReturnAll
Always
The amount of the Best Offer or counter offer. For this field to be returned, the user must have a relationship to the Best Offer, either as the seller, buyer, or potential buyer who has made the Best Offer or counter offer.
GetBestOffers
DetailLevel: none, ReturnAll
Conditionally
The status of the Best Offer or counter offer. For <b>PlaceOffer</b>, the only applicable values are <code>Accepted</code>, <code>AdminEnded</code>, <code>Declined</code>, and <code>Expired</code>.
GetBestOffers
DetailLevel: none, ReturnAll
Always
Accepted, AdminEnded, Declined, Expired
PlaceOffer
Conditionally
The quantity of the item for which the buyer is making a Best Offer. This value will usually be <code>1</code>, unless the buyer is making an offer on multiple quantity of a line item in a multi-quantity listing.
GetBestOffers
DetailLevel: none, ReturnAll
Always
A prospective buyer has the option to include a comment when placing a Best Offer or making a counter offer to the seller's counter offer. This field will display that comment.
500 (in bytes)
GetBestOffers
DetailLevel: ReturnAll
Conditionally
A seller has the option to include a comment when making a counter offer to the prospective buyer's Best Offer. This field will display that comment.
500 (in bytes)
GetBestOffers
DetailLevel: none, ReturnAll
Conditionally
This value indicates whether the corresponding offer is a Best Offer, a seller's counter offer, or a buyer counter offer to the seller's counter offer.
GetBestOffers
DetailLevel: none, ReturnAll
Always
The value in this field (<code>Success</code> or <code>Failure</code>) will indicate whether or not the seller's attempt to accept, decline, or counter offer a Best Offer was successful. This field is only used by the <b>RespondToBestOffer</b> response.
RespondToBestOffer
Always
This field is no longer applicable, as it formerly supported the Best Offer Beta feature which is no longer active.
This field is no longer applicable, as it formerly supported the Best Offer Beta feature which is no longer active.
Enumerated type that defines the possible offer types for the Best Offer feature.
This value indicates that the offer is an original Best Offer made by a prospective buyer to the seller.
This value indicates that the offer is a prospective buyer's counter offer against the seller's counter offer.
This value indicates that the offer is a seller's counter offer against the seller's original Best Offer.
Reserved for internal or future use.
This enumerated type lists the possible actions that can be made on a listing or Best Offer and the possible states of a bid or Best Offer.
NotUsed
This value indicates that the action or state is unknown.
This value is used in a <b>PlaceOffer</b> call if the buyer wants to bid on an auction listing. If this value is used, the prospective buyer must also include the <b>Offer.MaxBid</b> field in the <b>PlaceOffer</b> call and specify the maximum amount that they are willing to bid in an attempt to win the auction. eBay will automatically rebid on behalf of the buyer each time the buyer is outbid up until the time when their <b>Offer.MaxBid</b> value threshold is met. The <b>GetAllBidders</b> call will return this value as well if the buyer has set up automatic bidding using a maximum bid threshold.
This value is no longer applicable.
This value indicates that a buyer's Best Offer or a seller's or buyer's counter offer was retracted. This value cannot be used with the <b>PlaceOffer</b> call.
This value indicates that a buyer's Best Offer or a seller's or buyer's counter offer was automatically retracted. This value cannot be used with the <b>PlaceOffer</b> call.
This value indicates that a buyer's Best Offer or a seller's or buyer's counter offer was cancelled. This value cannot be used with the <b>PlaceOffer</b> call.
This value indicates that a buyer's Best Offer or a seller's or buyer's counter offer was automatically cancelled. This value cannot be used with the <b>PlaceOffer</b> call.
This value is returned in the <b>GetAllBidders</b> call if an absentee bid was made, which means that eBay made a bid on the auction listing on behalf of the buyer, who has set a maximum bid threshold. This value is not applicable for the <b>PlaceOffer</b> call, as the buyer would use the <code>Bid</code> value instead, as well as setting a <b>Offer.MaxBid</b> value that would specify the maxium amount that the buyer is willing to bid in an attempt to win the auction.
This value is returned in the <b>GetAllBidders</b> call if the buyer purchased an item in an auction listing using the Buy It Now feature. This value is not applicable for the <b>PlaceOffer</b> call, as the buyer would use the <code>Purchase</code> value instead.
This value is used in a <b>PlaceOffer</b> call if the buyer wants to purchase a fixed-price item or purchase an auction item enabled with the Buy It Now feature. Note that this call cannot be used to purchase items that require immediate payment. The <b>GetAllBidders</b> call will return this value as well if the buyer purchased the item. For items requiring immediate payment, the <b>PlaceOffer</b> call cannot be used for purchase.
Reserved for future or internal use.
This value is used in a <b>PlaceOffer</b> call if the buyer is proposing a Best Offer to the seller. The <b>GetAllBidders</b> call will return this value as well if the buyer proposed a Best Offer to the seller.
This value is used in a <b>PlaceOffer</b> call if the buyer is proposing a counter offer to the seller's proposed counter offer. The <b>GetAllBidders</b> call will return this value as well if the buyer proposed a counter offer to the seller's counter offer.
This value is used in a <b>PlaceOffer</b> call if the buyer is accepting a counter offer proposed by the seller. The <b>GetAllBidders</b> call will return this value as well if the buyer accepted a counter offer.
This value is used in a <b>PlaceOffer</b> call if the buyer is declining a counter offer proposed by the seller. The <b>GetAllBidders</b> call will return this value as well if the buyer declined a counter offer.
This type is deprecated.
This type is deprecated.
This type is deprecated.
This field is deprecated.
This field is deprecated.
This type is deprecated.
This field is deprecated.
This enumerated type is deprecated.
This value is not used.
This value is not used.
This value is not used.
This value is not used.
This value is not used.
This value is not used.
This value is not used.
This value is not used.
This type is deprecated.
This field is deprecated.
This field is deprecated.
This field is deprecated.
This enumerated type is deprecated.
This value is not used.
This value is not used.
This value is not used.
This type is deprecated.
This field is deprecated.
This field is deprecated.
This field is deprecated.
This field is deprecated.
This type 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 field is deprecated.
This type is deprecated.
This type is used by the <b>BidderNoticePreferences</b> container, which consists of the seller's preference for receiving contact information for unsuccessful bidders in auction listings.
This boolean field should be set to <b>true</b> in a <b>SetUserPreferences</b> call if the seller wishes to receive contact information for bidders who have bid on a seller's auction item, but did not win. This might be helpful to a seller if that seller wishes to proposed Second Chance Offers to these unsuccessful bidders if the seller has multiple, identical items, or if the winning bidder does not pay for the original auction item.
<br/><br/>
This field is always returned with <b>BidderNoticePreferences</b> container in the <b>GetUserPreferences</b> response.
GetUserPreferences
Conditionally
SetUserPreferences
Conditionally
This enumerated type is deprecated.
This value is not used.
This value is not used.
This value is not used.
This value is not used.
This enumerated type is deprecated.
This value is not used.
This value is not used.
This value is not used.
Type defining the <b>BiddingDetails</b> container, which consists of
information about the buyer's bidding history on a single auction item.
Converted value (from seller's currency to buyer's currency) of the amount in the <b>MaxBid</b> field. This field is only applicable and returned if the buyer purchased an item from an eBay site in another country. For active items, it is recommended to refresh the listing's data every 24 hours to pick up the current conversion rates.
GetMyeBayBuying
BidList
LostList
WonList
DeletedFromWonList
DeletedFromLostList
DetailLevel: none, ReturnAll
Conditionally
This value is the dollar value of the highest bid that the buyer placed on the
auction item.
GetMyeBayBuying
BidList
LostList
WonList
DeletedFromWonList
DeletedFromLostList
DetailLevel: none, ReturnAll
Conditionally
This value is the total number of bids that the buyer placed on the
auction item throughout the duration of the listing.
GetMyeBayBuying
BidList
LostList
WonList
DeletedFromWonList
DeletedFromLostList
DetailLevel: none, ReturnAll
Conditionally
This field will only be returned if the buyer won the auction item, and if it is returned, its value will always be <code>1</code>.
GetMyeBayBuying
BidList
LostList
WonList
DeletedFromWonList
DeletedFromLostList
DetailLevel: none, ReturnAll
Conditionally
This field is returned as <code>true</code> if the prospective buyer is the current high bidder in an active listing.
GetMyeBayBuying
BidList
DetailLevel: none, ReturnAll
Conditionally
This field is deprecated.
Type used by the <b>BiddingSummary</b> container, which is returned in the <b>GetAllBidders</b> response if the <b>IncludeBiddingSummary</b> boolean field is included and set to <code>true</code> in the call request. The <b>BiddingSummary</b> container consists of bidding history information for a specific bidder (specified in the <b>User.UserID</b> field).
This integer value indicates the length of time (in number of days) that is being used to calculate all counts in the <b>BiddingSummary</b> container. This value is generally <code>30</code> (days), which means that all counts in the container have been calculated from the present time and going back 30 days in the past.
<br/><br/>
This field is always returned with the <b>BiddingSummary</b> container.
GetAllBidders
Conditionally
This integer value indicates the total number of bids (from any and all eBay sellers) that the user has placed during the last 30 days (or the number of days specified in the <b>SummaryDays</b> field).
<br/><br/>
This field is always returned with the <b>BiddingSummary</b> container.
GetAllBidders
Conditionally
This integer value is actually a percentage value that indicates what percentage of the user's total number of bids during the last 30 days (or the number of days specified in the <b>SummaryDays</b> field) has been placed on auction items that the seller has listed. The percentage value is rounded up to the highest whole percentage number.
<br/><br/>
This field is always returned with the <b>BiddingSummary</b> container.
GetAllBidders
Conditionally
This integer value indicates the total number of bids to unique sellers that the user has placed during the last 30 days (or the number of days specified in the <b>SummaryDays</b> field).
<br/><br/>
This field is always returned with the <b>BiddingSummary</b> container.
GetAllBidders
Conditionally
This integer value indicates the total number of bids made with unique listing categories that the user has placed during the last 30 days (or the number of days specified in the <b>SummaryDays</b> field).
<br/><br/>
This field is always returned with the <b>BiddingSummary</b> container.
GetAllBidders
Conditionally
This integer value indicates the total number of bids that the user has retracted (from any and all sellers) during the last 30 days (or the number of days specified in the <b>SummaryDays</b> field).
<br/><br/>
This field is always returned with the <b>BiddingSummary</b> container.
GetAllBidders
Conditionally
This container provides information on each auction item that the user has placed a bid on during the last 30 days (or the number of days specified in the <b>SummaryDays</b> field).
GetAllBidders
Conditionally
This enumerated type contains the possible values that can be returned in the <b>ListingFeatureDetails.BoldTitle</b> field to indicate whether or not bold listing titles are supported by the eBay site specified in the <b>GeteBayDetails</b> call request.
This value indicates that bold listing titles are enabled for the eBay site specified in the <b>GeteBayDetails</b> call request.
This value indicates that bold listing titles are disabled for the eBay site specified in the <b>GeteBayDetails</b> call request.
Reserved for future use.
<span class="tablenote"><b>Note: </b> This enumerated type is deprecated as the Picture Border feature is no longer available on any eBay Marketplace sites.
</span>
This value indicates that picture borders are enabled for the eBay site specified in the <b>GeteBayDetails</b> call request.
This value indicates that picture borders are disabled for the eBay site specified in the <b>GeteBayDetails</b> call request.
Reserved for internal or future use.
Type defining the <b>BrandMPNIdentifierEnabled</b> field that is
returned under the <b>FeatureDefinitions</b> container of the
<b>GetCategoryFeatures</b> response (as long as
<code>BrandMPNIdentifierEnabled</code> is included as a <b>FeatureID</b> value in
the call request or no <b>FeatureID</b> values are passed into the call
request). This field is returned as an
empty element (a boolean value is not returned) if one or more eBay API-enabled sites
support the Brand/Manufacturer Part Number feature.
<br/><br/>
To verify if a specific eBay site supports the Brand/Manufacturer Part Number feature (for most
categories), look for a <code>true</code> value in the
<b>SiteDefaults.BrandMPNIdentifierEnabled</b> field.
<br/><br/>
To verify if a specific category on a specific eBay site supports the Brand/Manufacturer Part Number feature, pass in a <b>CategoryID</b> value in the request, and then
look for a <code>true</code> value in the <b>BrandMPNIdentifierEnabled</b> field
of the corresponding <b>Category</b> node (match up the <b>CategoryID</b> values
if more than one Category ID was passed in the request).
Type defining the <b>BrandMPN</b> container which is used to identify a product (through a unique product brand and Manufacturer Part Number combination).
<br>
<br>
<span class="tablenote"><b>Note:</b>
If a brand and/or MPN value is required for a category, it is highly recommended that the brand and MPN name/value pair is also passed in through an <b>ItemSpecifics.NameValueList</b> container, since brand and MPN values may be dropped from the listing if eBay is not able to find a eBay catalog product match based on the provided Brand/MPN pair.
</span>
The brand of the product. Both <b>Brand</b> and <b>MPN</b> should be specified if the <b>BrandMPN</b> container is used, or an error may occur. If Brand is a required or recommended item specific for a category, but an MPN is not applicable to the category/product, the Brand value should be specified in an <b>Item.ItemSpecifics.NameValueList</b> container instead.
<br>
<br>
<span class="tablenote"><b>Note:</b>
The <b>BrandMPN</b> container is not applicable for multiple-variation listings. For multiple-variation listings that use MPNs, the <b>Brand</b> value should be specified through an <b>ItemSpecifics.NameValueList</b> container, and the Manufacturer Part Numbers (MPNs) for each product variation should be specified through a <b>VariationSpecifics.NameValueList</b> container.
</span>
65
AddFixedPriceItem
AddItem
AddItems
AddSellingManagerTemplate
RelistFixedPriceItem
RelistItem
ReviseFixedPriceItem
ReviseItem
ReviseSellingManagerTemplate
VerifyAddFixedPriceItem
VerifyAddItem
VerifyRelistItem
Conditionally
GetItem
GetItems
GetSellingManagerTemplates
Conditionally
The manufacturer part number of the product. Use the
value specified by the manufacturer. Both <b>Brand</b> and <b>MPN</b> must be specified if the <b>BrandMPN</b> container is used or an error may occur.
<br/><br/>
If the listing is being posted to a category that expects an MPN value, but one doesn't exist for the product, the seller must pass in the text that can be found in the <b>ProductDetails.ProductIdentifierUnavailableText</b> field of the <b>GeteBayDetails</b> response. To get the <b>ProductDetails</b> container to return in the <b>GeteBayDetails</b> response, <code>ProductDetails</code> should be included as a <b>DetailName</b> value in the call request.
<br><br>
<span class="tablenote"><b>Note:</b>
The <b>BrandMPN</b> container is not applicable for multiple-variation listings. For multiple-variation listings that use MPNs, the <b>Brand</b> value should be specified through an <b>ItemSpecifics.NameValueList</b> container, and the Manufacturer Part Numbers (MPNs) for each product variation should be specified through a <b>VariationSpecifics.NameValueList</b> container.
</span>
65
AddFixedPriceItem
AddItem
AddItems
AddSellingManagerTemplate
RelistFixedPriceItem
RelistItem
ReviseFixedPriceItem
ReviseItem
ReviseSellingManagerTemplate
VerifyAddFixedPriceItem
VerifyAddItem
VerifyRelistItem
Conditionally
GetItem
GetItems
GetSellingManagerTemplates
Conditionally
This enumerated type is deprecated.
This value is not used.
This value is not used.
This value is not used.
This value is not used.
This value is not used.
This value is not used.
This value is not used.
Enumerated type that defines the eBay user's account type.
This value indicates that the eBay user's account is a Partially Provisioned Account
without buying and selling privileges on eBay.
This value indicates that the eBay user's account is a fully provisioned account with buying
and selling privileges on eBay.
Type used by the <b>BusinessSellerDetails</b> container, which is returned in an <b>Item</b> node if the item's seller is registered on eBay as a Business Seller.
This field shows the address on file for the Business Seller.
GetItem
GetSellingManagerTemplates
Conditionally
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
This field shows the Fax number on file for the Business Seller. This field is only returned if known and available.
GetItem
GetSellingManagerTemplates
Conditionally
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
This field shows the email address on file for the Business Seller.
GetItem
GetSellingManagerTemplates
Conditionally
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
This field shows any additional contact for the Business Seller in free-form text. This field is only returned if known and available.
GetItem
GetSellingManagerTemplates
Conditionally
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
This field shows the Trade Registration Number for the Business Seller.
GetItem
GetSellingManagerTemplates
Conditionally
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
This boolean field is returned as <code>true</code> if the Business Seller provides legal invoices to buyers.
GetItem
GetSellingManagerTemplates
Conditionally
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
This free-form text field provides the Business Seller's terms and conditions for doing business.
GetItem
GetSellingManagerTemplates
Conditionally
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
This container provides Value-Added Tax (VAT) details for the Business Seller, including the seller's VAT ID and the VAT percentage rate applicable to the item. VAT is similar to a sales and/or consumption tax, and it is only applicable to sellers selling on European sites.
GetItem
GetSellingManagerTemplates
Conditionally
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Type defining the <b>BuyerGuaranteeEnabled</b> field that is
returned under the <b>FeatureDefinitions</b> container of the
<b>GetCategoryFeatures</b> response (as long as
<code>BuyerGuaranteeEnabled</code> is included as a <b>FeatureID</b> value in
the call request or no <b>FeatureID</b> values are passed into the call
request). This field is returned as an
empty element (a boolean value is not returned) if one or more eBay API-enabled sites
support the Buyer Guarantee feature.
<br/><br/>
To verify if a specific eBay site supports the Buyer Guarantee feature (for most
categories), look for a <code>true</code> value in the
<b>SiteDefaults.BuyerGuaranteeEnabled</b> field.
<br/><br/>
To verify if a specific category on a specific eBay site supports the Buyer Guarantee feature, pass in a <b>CategoryID</b> value in the request, and then
look for a <code>true</code> value in the <b>BuyerGuaranteeEnabled</b> field
of the corresponding Category node (match up the <b>CategoryID</b> values
if more than one Category IDs were passed in the request).
Type defining the <b>BuyerPackageEnclosure</b> container, which is returned in <b>GetOrders</b> (and other order management calls) if the 'Pay Upon Invoice' option is being offered to the buyer, and the seller is including payment instructions in the shipping package. A <b>BuyerPackageEnclosure</b> container will be returned for each shipping package containing payment instructions. The 'Pay Upon Invoice' option is only available on the German site.
This attribute indicates the type of payment instructions included in the shipping package.
GetOrders
DetailLevel: none, ReturnAll
Conditionally
OrderReport
Conditionally
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ReturnAll
Conditionally
GetMyeBayBuying
WonList
DeletedFromWonList
DetailLevel: none, ReturnAll
Conditionally
Type defining the <b>BuyerPackageEnclosures</b> container, which is returned in <b>GetOrders</b> (and other order management calls) if the 'Pay Upon Invoice' option is being offered to the buyer, and the seller is including payment instructions in the shipping package(s). A <b>BuyerPackageEnclosure</b> container will be returned for each shipping package containing payment instructions. The 'Pay Upon Invoice' option is only available on the German site.
A <b>BuyerPackageEnclosure</b> container will be returned for each shipping package containing payment instructions. The 'Pay Upon Invoice' option is only available on the German site.
GetOrders
DetailLevel: none, ReturnAll
Conditionally
OrderReport
Conditionally
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetMyeBayBuying
WonList
DeletedFromWonList
DetailLevel: none, ReturnAll
Conditionally
This enumerated type identifies all of the payment methods supported for the 'Pay Upon Invoice' feature. The 'Pay Upon Invoice' feature is only available through the eBay Germany marketplace.
This enumeration value indicates that no payment method was specified by the seller.
This enumeration value indicates that a credit card was used to pay for the order.
This enumeration value indicates that a bank debit card was used to pay for the order.
This enumeration value indicates that PayPal was used to pay for the order.
This enumeration value indicates that Elektronisches Lastschriftverfahren (direct debit) was used to pay for the order.
This enumeration value indicates that an unknown credit card was used to pay for the order.
This enumeration value indicates that Elektronisches Lastschriftverfahren (direct debit) was used locally to pay for the order.
This enumeration value indicates that a Master Card credit card was used to pay for the order.
This enumeration value indicates that an American Express credit card was used to pay for the order.
This enumeration value indicates that a Visa credit card was used to pay for the order.
This enumeration value indicates that a Discover credit card was used to pay for the order.
This enumeration value indicates that a Diners Club credit card was used to pay for the order.
This enumeration value indicates that a JCB credit card was used to pay for the order.
This enumeration value indicates that a Switch debit card was used to pay for the order.
This enumeration value indicates that a Solo debit card was used to pay for the order.
This enumeration value indicates that Giropay was used to pay for the order.
This enumeration value indicates that BML was used to pay for the order.
This enumeration value indicates that the 'Pay Upon Invoice' option was offered to the buyer on the Germany site.
Reserved for internal or future use.
This enumeration type indicates the item's eligibility status for PayPal's buyer protection program or eBay's Money Back Guarantee program.
This value indicates that the item is ineligible for buyer protection. In many
cases, the item is ineligible for buyer protection due to the listing category.
This value indicates that the item is eligible for buyer protection.
This value indicates that customer support has marked the item as
ineligible per special criteria (e.g., seller's account closed).
This value indicates that customer support has marked the item as
eligible per special criteria.
This value indicates that the item is ineligible for coverage under any buyer
protection program.
Reserved for internal or future use.
Type defining the <strong>ApplyBuyerProtection</strong> container, which
consists of details related to whether or not the item is eligible for buyer protection
and which of the buyer protection programs will cover the item.
This value indicates the type of buyer protection program applicable for the item.
This field is always returned with the <strong>ApplyBuyerProtection</strong> container.
GetItemTransactions
Conditionally
GetOrderTransactions
Conditionally
GetSellerTransactions
Conditionally
GetItem
GetSellingManagerTemplates
Conditionally
This value indicates the item's eligibility for the buyer protection program listed
in the <strong>ApplyBuyerProtection.BuyerProtectionSource</strong> field.
This field is always returned with the
<strong>ApplyBuyerProtection</strong> container.
GetItemTransactions
Conditionally
GetOrderTransactions
Conditionally
GetSellerTransactions
Conditionally
GetItem
GetSellingManagerTemplates
Conditionally
This enumeration type indicates the applicable buyer protection program that the item is eligible to be covered under.
This value indicates that the item is possibly eligible for buyer protection under the eBay Money Back Guarantee program.
This value indicates that the item is possibly eligible for buyer protection under the PayPal Purchase Protection Program.
Reserved for internal or future use.
Type defining the <b>BuyerRequirementDetails</b> container, which allows the seller to set buyer requirements at the listing level. For the corresponding listing, all buyer requirement values/settings will overwrite values/settings in Buyer Requirements preferences in My eBay.
The seller includes and sets this field to <code>true</code> 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. Sellers add countries or regions to their ship-to exclusion list by adding those countries or regions using one or more <b>ExcludeShipToLocation</b> fields in an Add/Revise/Relist call.
<br>
false
AddFixedPriceItem
AddItem
AddItems
AddSellingManagerTemplate
RelistFixedPriceItem
RelistItem
ReviseFixedPriceItem
ReviseItem
ReviseSellingManagerTemplate
VerifyAddFixedPriceItem
VerifyAddItem
VerifyRelistItem
No
GetBidderList
GetSellerList
Conditionally
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally
This Buyer Requirements feature is only available to sellers on the China site, and is only applicable to fixed-price or auction Buy It Now items. <br/><br/> The seller includes and sets this field to <code>true</code> as a mechanism to block prospective buyers with a feedback score of 0 from buying items with a price of 100 RMB or higher.
<br/>
false
AddFixedPriceItem
AddItem
AddItems
AddSellingManagerTemplate
RelistFixedPriceItem
RelistItem
ReviseFixedPriceItem
ReviseItem
ReviseSellingManagerTemplate
VerifyAddFixedPriceItem
VerifyAddItem
VerifyRelistItem
No
GetBidderList
GetSellerList
Conditionally
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally
The seller uses this container as a mechanism to restrict the number of items (specifying a <b>MaximumItemCount</b> value) a prospective buyer can purchase from the seller during a 10-day period. The seller also has the option of setting a <b>MinimumFeedbackScore</b> requirement. If both fields of the <b>MaximumItemRequirements</b> container are set, the <b>MaximumItemCount</b> limit will only apply to those prospective buyers that don't equal or exceed the specified minimum Feedback Score.
AddFixedPriceItem
AddItem
AddItems
AddSellingManagerTemplate
RelistFixedPriceItem
RelistItem
ReviseFixedPriceItem
ReviseItem
ReviseSellingManagerTemplate
VerifyAddFixedPriceItem
VerifyAddItem
VerifyRelistItem
No
GetBidderList
GetSellerList
Conditionally
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally
The seller uses this container as a mechanism to block prospective buyers who have one or more Unpaid Item Strikes on their account during a specified time period. A buyer receives an Unpaid Item Strike is a seller files an Unpaid Item case against the buyer, and eBay rules in favor of the seller.
false
AddFixedPriceItem
AddItem
AddItems
AddSellingManagerTemplate
RelistFixedPriceItem
RelistItem
ReviseFixedPriceItem
ReviseItem
ReviseSellingManagerTemplate
VerifyAddFixedPriceItem
VerifyAddItem
VerifyRelistItem
No
GetBidderList
GetSellerList
Conditionally
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally
Type defining the <b>BuyerRoleMetrics</b> container, which consists of details relating to the eBay buyer's one-year history of leaving feedback for the seller.
This integer value indicates the number of positive feedback entries that the eBay user, acting in the buying role, has left for their order partner (seller) during the last one-year period, counting back from the present date.
GetFeedback
DetailLevel: none, ReturnAll
Conditionally
This integer value indicates the number of negative feedback entries that the eBay user, acting in the buying role, has left for their order partner (seller) during the last one-year period, counting back from the present date.
GetFeedback
DetailLevel: none, ReturnAll
Conditionally
This integer value indicates the number of neutral feedback entries that the eBay user, acting in the buying role, has left for their order partner (seller) during the last one-year period, counting back from the present date.
GetFeedback
DetailLevel: none, ReturnAll
Conditionally
This float value indicates the percentage of time that the eBay user, acting in the buying role, has left feedback for their order partner (seller) during the last one-year period, counting back from the present date.
GetFeedback
DetailLevel: none, ReturnAll
Conditionally
Type defining the <b>BuyerSatisfaction</b> container returned in the
<b>GetSellerDashboard</b> response. The <b>BuyerSatisfaction</b>
container consists of the seller's buyer satisfaction rating, as well as any alerts
related to customer service.
This field indicates the seller's buyer satisfaction rating. To determine this
rating, eBay considers your detailed seller ratings, your overall feedback rating,
and whatever buyer protection claims might exist on your account. eBay uses the
buyer satisfaction rating to see if you are eligible for certain rewards, or if you
need additional guidance to help you give better service.
GetSellerDashboard
Always
The <b>BuyerSatisfaction.Alert</b> container is only returned if eBay
has posted one or more informational or warning messages related to the seller's
buyer satisfaction rating.
GetSellerDashboard
Conditionally
This enumerated type contains the list of possible Buyer Satisfaction ratings for a seller.
NeedsWork
You are doing an excellent job as an eBay seller.
Be sure to continue providing members with a positive buying experience.
A buyer satisfaction rating of Excellent ensures that you are eligible
for eBay incentives.
You are doing a good job as an eBay seller.
Buyers have been satisfied with your customer service. Be sure to continue
providing members with a positive buying experience. A buyer satisfaction
rating of Good ensures that you are eligible for eBay incentives.
This value is no longer applicable.
You are not doing a good job as an eBay seller.
Some of your buyers have not been satisfied with your service.
Improve your customer service to earn a higher buyer satisfaction rating.
If your customer service continues to receive poor responses from customers,
your buyer satisfaction rating can drop and could put your eBay seller's
account at risk.
You are doing a very poor job as an eBay seller.
You need to improve your selling practices immediately. Too many of your
customers have not been satisfied with your customer service and you are
at risk of losing your eBay account.
You are doing an unacceptable job as an eBay seller.
Improve your selling practices immediately. Your account may be suspended
because of your unacceptable customer service.
Reserved for internal or future use.
This type is used by various <b>Get</b> calls, including <b>GetItem</b> and <b>GetOrders</b>. Only the order management calls return the <b>BuyerTaxIdentifier</b> container, and each call that uses <b>BuyerType</b> uses the <b>ShippingAddress</b> container a little differently.
This container uses <b>AddressType</b>, and each call that uses <b>BuyerType</b> uses the <b>ShippingAddress</b> container a little differently. See the Call Reference documentation for each call to see what fields of <b>AddressType</b> are used by each call.
Output only.
GetAllBidders
Always
GetBidderList
Conditionally
GetMyeBaySelling
SoldList
DeletedFromSoldList
DetailLevel: none, ReturnAll
Conditionally
GetOrderTransactions
BuyerInfo
DetailLevel: none, ReturnAll
Conditionally
GetSellerList
Conditionally
HighBidder
DetailLevel: ItemReturnDescription, ReturnAll
GranularityLevel: Fine
GetItem
GetSellingManagerTemplates
Conditionally
HighBidder
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ReturnAll
Conditionally
This container consists of taxpayer identification for the buyer. Although this container may be used for other purposes at a later date, it is currently used by sellers selling on the Italy or Spain site to retrieve the taxpayer ID of the buyer.
<br/><br/>
It is now required that buyers registered on the Italy site provide their Codice Fiscale ID (similar to the Social Security Number for US citizens) before buying an item on the Italy site.
<br/><br/>
On the Spain site, a Spanish seller has the option to require that Spanish buyers (registered on Spain site) provide a tax ID before checkout. This option is set by the seller at the account level. Once a Spanish buyer provides a tax ID, this tax ID is associated with his/her account, and once a tax ID is associated with the account, Spanish buyer will be asked to provide the tax ID during checkout on all eBay sites. Buyers with a registered address outside of Spain will not be asked to provide a tax ID during checkout.
<br/><br/>
This container is only returned for Spanish or Italian sellers when the buyer was asked to provide tax identifier information during checkout. A <strong>BuyerTaxIdentifier</strong> will be returned for each tax ID that is associated with the buyer's account.
GetOrders
DetailLevel:none,ReturnAll
Conditionally
OrderReport
Conditionally
GetOrderTransactions
DetailLevel:none,ItemReturnDescription, ReturnAll
Conditionally
GetItemTransactions
GetSellerTransactions
DetailLevel:none,ReturnAll
Conditionally
This type is deprecated.
Information that identifies a buying guide. A buying guide contains content about particular
product areas, categories, or subjects to help buyers decide which type of item
to purchase based on their particular interests.
Buying guides are useful to buyers who do not have a specific product in mind.
For example, a digital camera buying guide could help a buyer determine what kind of
digital camera is right for them.
URL of the buying guide home page for the site being searched.
Your application can present this URL as a link. Optionally,
you can use a value like "See all buying guides" as the link's
display name.
This type is not used by any Trading API calls.
Display name of the buying guide.
URL for the buying guide. Your application can
present this as a link. Use the value of Name as the link's display name.
Identifies the category (if any) that is associated
with the buying guide.
Identifies the product finder (if any) that is associated with the buying guide.
Only returned for product finder searches.
The title of the buying guide.
The text of the guide. If the guide is longer than
2000 characters, the text is cut off and it ends with "...".
See BuyingGuide.URL for a link to the full text of the review.
The time and date when the guide was posted.
The author's eBay user ID.
Type defining the <b>BuyingSummary</b> container returned in
<b>GetMyeBayBuying</b>. The <b>BuyingSummary</b> container
consists of data that summarizes the buyer's recent buying activity, including the
number of items the user has bid on, the number of items the user is winning, and the number of items
the user has won. The <b>BuyingSummary</b> container is only returned if
the <b>BuyingSummary.Include</b> field is included in the <b>GetMyeBayBuying</b> request and set to
<code>true</code>.
The number of auction items the user has bid on.
GetMyeBayBuying
DetailLevel: none, ReturnAll
Conditionally
The number of active auction listings in which the user is currently the highest bidder.
GetMyeBayBuying
DetailLevel: none, ReturnAll
Conditionally
The total cost of items that the user is currently the highest bidder on.
GetMyeBayBuying
DetailLevel: none, ReturnAll
Conditionally
The number of auction items that the user has won.
GetMyeBayBuying
DetailLevel: none, ReturnAll
Conditionally
The total cost of auction items that the user has won.
GetMyeBayBuying
DetailLevel: none, ReturnAll
Conditionally
The time period for which won items are displayed. Default is 31 days.
GetMyeBayBuying
DetailLevel: none, ReturnAll
Conditionally
The number of items the user has made Best Offers on.
GetMyeBayBuying
DetailLevel: none, ReturnAll
Conditionally
Type defining the <b>CalculatedHandlingDiscount</b> container that is used in the <b>SetShippingDiscountProfiles</b> call to specify the rules used to determine package handling costs for an order in which calculated shipping is used.
The type of discount that is detailed in the profile.
If the selection is <code>EachAdditionalAmount</code>, <code>EachAdditionalAmountOff</code> or
<code>EachAdditionalPercentOff</code>, the value is set in the child element of same
name in <b>CalculatedHandlingDiscount</b>. If the selection is <code>CombinedHandlingFee</code>,
specify the amount in <b>CalculatedHandlingDiscount.OrderHandlingAmount</b>.
If the selection is <code>IndividualHandlingFee</code>, the amount is determined by eBay
by adding the fees of the individual items.
GetShippingDiscountProfiles
Conditionally
SetShippingDiscountProfiles
Conditionally
If specified, this is the fixed shipping cost to charge for an order,
regardless of the number of items in the order.
This field is mutually exclusive with the other amount and percentage
fields within this type.
This field only applies when the specified <b>DiscountName</b> value is <code>CombinedHandlingFee</code>.
GetShippingDiscountProfiles
Conditionally
SetShippingDiscountProfiles
Conditionally
The packaging/handling cost for each item beyond the first item (where the
item with the highest packaging/handling cost is selected by eBay as the first
item). Let's say the buyer purchases three items, each assigned a
packaging/handling cost of $8, and the seller set <b>EachAdditionalAmount</b> to $6.
The packaging/handling cost for three items would normally be $24, but since
the seller specified $6, the total packaging/handling cost would be $8 + $6 +
$6, or $20.
This field is mutually exclusive with the other amount and percentage
fields within this type.
This field only applies when the <b>DiscountName</b> value is <code>EachAdditionalAmount</code>.
GetShippingDiscountProfiles
Conditionally
SetShippingDiscountProfiles
Conditionally
The amount by which to reduce the packaging/handling cost for each item beyond
the first item (where the item with the highest packaging/handling cost is
selected by eBay as the first item). Let's say the buyer purchases three
items, each assigned a packaging/handling cost of $8, and the seller set
<b>EachAdditionalAmountOff</b> to $2. The packaging/handling cost for three items
would normally be $24, but since the seller specified $2, the total
packaging/handling cost would be $24 - (two additional items x $2), or $20.
This field is mutually exclusive with the other amount and percentage
fields within this type.
This field only applies when the <b>DiscountName</b> value is <code>EachAdditionalOffAmount</code>.
GetShippingDiscountProfiles
Conditionally
SetShippingDiscountProfiles
Conditionally
The percentage by which to reduce the packaging/handling cost for each item
beyond the first item (where the item with the highest packaging/handling cost
is selected by eBay as the first item). Let's say the buyer purchases three
items, each assigned a packaging/handling cost of $8, and the seller set
<b>EachAdditionalPercentOff</b> to 0.25. The packaging/handling cost for three items
would normally be $24, but since the seller specified 0.25 ($2 out of 8), the
total packaging/handling cost would be $24 - (two additional items x $2), or
$20.
This field is mutually exclusive with the amount fields within this type.
This field only applies when the <b>DiscountName</b> value is <code>EachAdditionalPercentOff</code>.
GetShippingDiscountProfiles
Conditionally
SetShippingDiscountProfiles
Conditionally
This enumerated type is deprecated.
This value is not used.
This value is not used.
This value is not used.
Type used by the <b>CalculatedShippingDiscount</b> container, which is used in the <b>SetShippingDiscountProfiles</b> call to create one or more discounted calculated shipping rules. The <b>CalculatedShippingDiscount</b> container is returned in the response of all other calls that use this type.
This enumeration value indicates the type of calculated shipping discount rule that is being applied. Each rule is explained below.
GetShippingDiscountProfiles
IndividualItemWeight, CombinedItemWeight, WeightOff
Conditionally
SetShippingDiscountProfiles
IndividualItemWeight, CombinedItemWeight, WeightOff
Conditionally
GetItem
GetSellingManagerTemplates
IndividualItemWeight, CombinedItemWeight, WeightOff
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally
Shipping Cost Discount Profiles
https://developer.ebay.com/DevZone/guides/features-guide/default.html#Development/Shipping-OtherFeatures.html#ShippingCostDiscountProfiles
This container provides details of this particular calculated shipping discount profile.
<br><br>
<b>For SetShippingDiscountProfiles</b>: If the
<b>ModifyActionCode</b> value is set to <code>Update</code>, all details of the modified version of the profile must
be provided. If the
<b>ModifyActionCode</b> value is set to <code>Delete</code>, the <b>DiscountProfileID</b> is required,
the <b>MappingDiscountProfileID</b> is optional, and all other fields of the container are no longer applicable.
<br><br>
Restrictions on how many profiles can exist for a given
discount rule are discussed in the Features Guide documentation on Shipping Cost Discount Profiles.
GetShippingDiscountProfiles
Conditionally
SetShippingDiscountProfiles
IndividualItemWeight, CombinedItemWeight, WeightOff
Conditionally
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally
Shipping Cost Discount Profiles
https://developer.ebay.com/DevZone/guides/features-guide/default.html#Development/Shipping-OtherFeatures.html#ShippingCostDiscountProfiles
This type is deprecated.
This field is deprecated.
This field is deprecated.
This field is deprecated.
This field is deprecated.
This enumerated type is deprecated.
This value is not used.
This value is not used.
This value is not used.
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. Also returned
with the data for an item's transaction.
<br><br>
<span class="tablenote"><strong>Note:</strong>
The <strong>CalculatedShippingRate</strong> container should only be used to specify values for the <strong>InternationalPackagingHandlingCosts</strong>, <strong>OriginatingPostalCode</strong>, and/or <strong>PackagingHandlingCosts</strong> fields. The rest of the fields in the <strong>CalculatedShippingRate</strong> container should now be specified in the <strong>ShippingPackageDetails</strong> container instead.
</span>
The postal code for the location from which the package will be shipped. A postal code is required for calculated shipping. This field is not necessary if a postal code is already specified through the <strong>Item.PostalCode</strong> field. If a postal code is included in both fields, the value in <strong>Item.PostalCode</strong> field is used, and the value in <strong>OriginatingPostalCode</strong> is ignored.
AddFixedPriceItem
AddItem
AddItems
AddSellingManagerTemplate
RelistFixedPriceItem
RelistItem
ReviseFixedPriceItem
ReviseItem
ReviseSellingManagerTemplate
VerifyAddFixedPriceItem
VerifyAddItem
VerifyRelistItem
Conditionally
GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
Conditionally
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetBidderList
GetItemShipping
Conditionally
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally
GetItemTransactions
GetSellerTransactions
GetOrders
DetailLevel: none, ReturnAll
Conditionally
OrderReport
Conditionally
<span class="tablenote"><strong>Note:</strong>
The value for <strong>MeasurementUnit</strong> should now be specified in the <strong>ShippingPackageDetails</strong> container instead. If the <strong>MeasurementUnit</strong> field is passed in the <strong>CalculatedShippingRate</strong> container and in the <strong>ShippingPackageDetails</strong> container, the value in the <strong>ShippingPackageDetails</strong> container will take precedence.
</span>
997
Avoid
1033
ShippingPackageDetails.MeasurementUnit
Fees a seller might assess for the shipping of the item (in addition to
whatever the shipping service might charge).
Any packaging/handling cost specified on input is added to each shipping
service on output.
<br/><br/>
If domestic and international calculated shipping is offered for an item and
if packaging/handling cost is specified only for domestic shipping, that cost
will be applied by eBay as the international packaging/handling cost. (To
specify a international packaging/handling cost, you must always specify a
domestic packaging/handling cost, even if it is 0.) When UPS is one of the
shipping services offered by the seller, package dimensions are required on
list/relist/revise.
For calculated shipping only.
AddFixedPriceItem
AddItem
AddItems
AddSellingManagerTemplate
RelistFixedPriceItem
RelistItem
ReviseFixedPriceItem
ReviseItem
ReviseSellingManagerTemplate
VerifyAddFixedPriceItem
VerifyAddItem
VerifyRelistItem
No
GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
Conditionally
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetBidderList
GetItemShipping
Conditionally
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Always
GetItemTransactions
GetSellerTransactions
GetOrders
DetailLevel: none, ReturnAll
Conditionally
OrderReport
Conditionally
<span class="tablenote"><strong>Note:</strong>
The value for <strong>ShippingIrregular</strong> should now be specified in the <strong>ShippingPackageDetails</strong> container instead. If the <strong>ShippingIrregular</strong> field is passed in the <strong>CalculatedShippingRate</strong> container and in the <strong>ShippingPackageDetails</strong> container, the value in the <strong>ShippingPackageDetails</strong> container will take precedence. This field may be deprecated in the future.
</span>
997
Avoid
1033
ShippingPackageDetails.ShippingIrregular
Fees a seller might assess for the shipping of the item (in addition to
whatever the shipping service might charge).
Any packaging/handling cost specified on input is added to each shipping
service on output.
<br/><br/>
If domestic and international calculated shipping is offered for an item and
if packaging/handling cost is specified only for domestic shipping, that cost
will be applied by eBay as the international packaging/handling cost. (To
specify a international packaging/handling cost, you must always specify a
domestic packaging/handling cost, even if it is 0.)
For international calculated shipping only.
AddFixedPriceItem
AddItem
AddItems
AddSellingManagerTemplate
RelistItem
ReviseItem
ReviseSellingManagerTemplate
VerifyAddFixedPriceItem
VerifyAddItem
VerifyRelistItem
No
GetBidderList
GetItemShipping
GetSellerList
Conditionally
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Always
GetItemTransactions
GetSellerTransactions
GetOrders
DetailLevel: none, ReturnAll
Conditionally
OrderReport
Conditionally
Type used by the <b>CancelDetail</b> container, which consists of details related to an eBay order that has been cancelled or is in the process of possibly being cancelled.
This value indicates the reason why the order cancellation was initiated. This field is always returned with the <b>CancelDetail</b> container. Typical buyer-initiated cancellation reasons include <code>OrderPlacedByMistake</code>, <code>WontArriveInTime</code>, or <code>FoundCheaperPrice</code>. Sellers may initiate an order cancellation on behalf of the buyer. In this scenario, the seller should state the cancellation reason as <code>BuyerCancelOrder</code>. If the seller is cancelling an order because he/she is out of stock on an item, the seller should state the cancellation reason as <code>OutOfStock</code>. Unfortunately, in this scenario, the seller will receive a seller defect for this cancellation reason. Other order cancellation reasons are specific to eBay Scheduled Delivery orders. eBay Scheduled Delivery is similar to the eBay Now service in the US (now retired), and is only available in the UK. See <a href="types/CancelReasonCodeType.html">CancelReasonCodeType</a> for the complete list of enumeration values that can be returned in this field.
<br><br>
<span class="tablenote"><strong>Note:</strong>
Currently, the <b>CancelReason</b> field is being returned under the <b>Order</b> container and under the <b>CancelDetail</b> container. However, there are plans to deprecate this field from <b>OrderType</b> in the future.
</span>
CancelReasonCodeType
GetOrders
DetailLevel: none, ReturnAll
Conditionally
OrderReport
Conditionally
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
The detailed reason of why the order cancellation was initiated. This field is only returned if it is available for an order that has been cancelled, or if an order is going through the cancellation process.
<br><br>
<span class="tablenote"><strong>Note:</strong>
Currently, the <b>CancelReasonDetails</b> field is being returned under the <b>Order</b> container and under the <b>CancelDetail</b> container. However, there are plans to deprecate this field from <b>OrderType</b> in the future.
</span>
GetOrders
DetailLevel: none, ReturnAll
Conditionally
OrderReport
Conditionally
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
This value indicates which party initiated the cancellation of the eBay order. It will usually be <code>Buyer</code> or <code>Seller</code>, but it can also be <code>CS</code> (eBay Customer Support). See <a href="types/CancelInitiatorCodeType.html">CancelInitiatorCodeType</a> for the complete list of enumeration values that can be returned in this field. This field is always returned with the <b>CancelDetail</b> container.
CancelInitiatorCodeType
GetOrders
DetailLevel: none, ReturnAll
Conditionally
OrderReport
Conditionally
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
This timestamp indicates when the cancellation of the eBay order was initiated. This field is always returned with the <b>CancelDetail</b> container.
GetOrders
DetailLevel: none, ReturnAll
Conditionally
OrderReport
Conditionally
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
Timestamp indicating when the cancellation process of an eBay order has been completed, which will be indicated if the <b>Order.CancelStatus</b> field has a value of <code>CancelComplete</code>. This field will not be returned until the cancellation process is completed.
GetOrders
DetailLevel: none, ReturnAll
Conditionally
OrderReport
Conditionally
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
Enumerated type that defines the possible parties that can initiate the cancellation of an eBay order.
This value indicates that the party whom initiated the cancellation of the order is not known.
This value indicates that the seller initiated the cancellation of the order.
This value indicates that the buyer initiated the cancellation of the order.
This value indicates that eBay customer support initiated the cancellation of the order.
This value indicates that the cancellation of the order was initiated by the system.
This value is reserved for internal or future use.
This type is deprecated.
This field is deprecated.
This type is deprecated.
This field is deprecated.
This field is deprecated.
Enumerated type that defines all possible reasons why an eBay order can be cancelled.
BuyerNoShow, BuyerNotSchedule, BuyerRefused, ValetDeliveryIssues, ValetUnavailable
This value indicates that the eBay order was cancelled by the seller due to the fact that one or more order line items were out-of-stock. This reason given by the seller will result in a seller defect.
This value indicates that the eBay Scheduled Delivery order was cancelled due to the fact that the buyer was not at the expected delivery location to receive the order. This value is only applicable to eBay Scheduled Delivery orders, a service that is currently only available in the London area (UK).
This value indicates that the eBay Scheduled Delivery order was cancelled due to the fact that the buyer refused to accept the order. This value is only applicable to eBay Scheduled Delivery orders, a service that is currently only available in the London area (UK).
This value indicates that the eBay Scheduled Delivery order was cancelled due to the fact that the buyer did not successfully schedule the delivery of the order. This value is only applicable to eBay Scheduled Delivery orders, a service that is currently only available in the London area (UK).
This value indicates that the seller initiated the cancellation of the order but at the request of the buyer. This is a cancel reason that the seller gives to avoid a seller defect for the cancellation.
This value indicates that the eBay Scheduled Delivery order was cancelled due to the fact that the delivery person had an issue delivering the order to the buyer. This value is only applicable to eBay Scheduled Delivery orders, a service that is currently only available in the London area (UK).
This value indicates that the eBay Scheduled Delivery order was cancelled due to the fact that no delivery person was available to deliver the order to the buyer. This value is only applicable to eBay Scheduled Delivery orders, a service that is currently only available in the London area (UK).
This value indicates that the cancellation of the eBay order was initiated by the buyer because the order was placed by mistake.
This value indicates that the cancellation of the eBay order was initiated by the buyer because the buyer decided that the price for the item was too high.
This value indicates that the cancellation of the eBay order was initiated by the buyer because the buyer found the same item somewhere else at a cheaper price.
This value indicates that the cancellation of the eBay order was initiated by the buyer because the buyer realized that the order will not arrive soon enough.
This value indicates that the seller initiated the cancellation of the order but at the request of the buyer, or if the buyer supplied a bad/incorrect address at purchase time. This is a cancel reason that the seller can give to avoid a seller defect for the cancellation.
This value indicates that the eBay order was cancelled by the seller due to the fact that one or more order line items were out-of-stock, or due to another reason why the seller was unable to fulfill the order. This reason given by the seller will result in a seller defect.
This value is reserved for internal or future use.
Enumerated type that defines the possible states of an eBay order cancellation.
This value indicates that the order cancellation request is invalid.
This value indicates that the order cancellation request is not applicable.
This value indicates that the buyer has initiated the cancellation of the eBay order. It will be up to the seller to decide to approve or reject the cancellation request.
This value indicates that the cancellation of the eBay order has been initiated by the buyer and approved by the seller, but the cancellation request has yet to be completed.
This value indicates that the cancellation of the eBay order initiated by the buyer has been rejected by the seller.
This value indicates that the order cancellation request has been closed, with no refund issued to the buyer.
This value indicates that the order cancellation request has been closed, with a refund issued to the buyer.
This value indicates that the order cancellation request has been closed, and it is unknown whether or not a refund was issued to the buyer. This value will generally be returned when the payment method used to pay for the order was something other than PayPal.
This value indicates that since the buyer committed to buying the item but did not pay for it, the cancellation succeeded and no refund is needed.
This value indicates that the cancellation of the eBay order has been completed.
This value indicates that the cancellation of the eBay order has failed.
This value is reserved for internal or future use.
This type is deprecated.
587
NoOp
This field is deprecated.
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 field is deprecated.
This field is deprecated.
This field is deprecated.
This field is deprecated.
This field is deprecated.
This field is deprecated.
Type used by the <b>CategoryArray</b> container that is returned in <b>GetCategories</b>. All categories that match the input criteria of the <b>GetCategories</b> request payload are returned under the <b>CategoryArray</b> container
This container provides details about the eBay category identified in the <b>CategoryID</b> field. The <b>DetailLevel</b> field must be included and set to <code>ReturnAll</code> for <b>Category</b>, nodes to appear.
GetCategories
DetailLevel: ReturnAll
Conditionally
This type is deprecated. Use <b>DetailLevelCodeType</b> instead.
Return all available data.
Return the category feature definitions only.
(out) Reserved for internal or future use.
Type defining the <b>Category</b> container that is returned in the <b>GetCategoryFeatures</b> response. A <b>Category</b> node is returned for each category that is relevant/applicable to the input criteria in the <b>GetCategoryFeatures</b> request. The <b>CategoryID</b> value identifies the eBay category. The rest of the <b>CategoryFeatureType</b> fields that are returned will be dependent on which <b>FeatureID</b> value(s) are specified in the <b>GetCategoryFeatures</b> request.
Specifies the unique identifier of the eBay category. All eBay feature information that is returned under the corresponding <b>Category</b> container is relevant to this eBay category.
10
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
A <b>ListingDuration</b> field is returned for each listing type and listing duration combination that is supported for the category. The integer value indicates the number of days of the listing duration, and the <b>type</b> attribute identifies the supported listing type.
<br><br>
Only returned when this value (or this category's setting) overrides the value inherited from the category's parent or the site default. Will not be returned if one or more <a href="types/FeatureIDCodeType.html">FeatureID</a> values are used in the call request, and one of those values does not include <code>ListingDurations</code>.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
Indicates whether the category requires sellers to specify shipping details at listing time.
<br><br>
Only returned when this value (or this category's setting) overrides the value inherited from the category's parent or the site default. Will not be returned if one or more <a href="types/FeatureIDCodeType.html">FeatureID</a> values are used in the call request, and one of those values does not include <code>ShippingTermsRequired</code>.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
Indicates whether the category supports the Best Offer feature for listings.
<br><br>
Only returned when this value (or this category's setting) overrides the value inherited from the category's parent or the site default. Will not be returned if one or more <a href="types/FeatureIDCodeType.html">FeatureID</a> values are used in the call request, and one of those values does not include <code>BestOfferEnabled</code>.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
This field is deprecated.
Indicates whether a bidder must consent to the bid by confirming that
he or she read and agrees to the terms in eBay's privacy policy.
<br><br>
Only returned when this value (or this category's setting) overrides the value inherited from the category's parent or the site default. Will not be returned if one or more <a href="types/FeatureIDCodeType.html">FeatureID</a> values are used in the call request, and one of those values does not include <code>UserConsentRequired</code>.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
Indicates whether or not it is possible to enhance a listing by putting
it into a rotation for display on a special area of the eBay home page.
Support for this feature varies by site. Item or feedback restrictions may apply.
<br><br>
Only returned when this value (or this category's setting) overrides the value inherited from the category's parent or the site default. Will not be returned if one or more <a href="types/FeatureIDCodeType.html">FeatureID</a> values are used in the call request, and one of those values does not include <code>HomePageFeaturedEnabled</code>.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
Indicates whether the category supports the Pro Pack Bundle listing upgrade.
<br><br>
Only returned when this value (or this category's setting) overrides the value inherited from the category's parent or the site default. Will not be returned if one or more <a href="types/FeatureIDCodeType.html">FeatureID</a> values are used in the call request, and one of those values does not include <code>ProPack</code>.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
This field is deprecated.
Indicates whether the category supports the Value Pack bundle listing upgrade.
<br><br>
Only returned when this value (or this category's setting) overrides the value inherited from the category's parent or the site default. Will not be returned if one or more <a href="types/FeatureIDCodeType.html">FeatureID</a> values are used in the call request, and one of those values does not include <code>ValuePack</code>.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
Indicates whether the category supports the Pro Pack Plus bundle listing upgrade.
<br><br>
Only returned when this value (or this category's setting) overrides the value inherited from the category's parent or the site default. Will not be returned if one or more <a href="types/FeatureIDCodeType.html">FeatureID</a> values are used in the call request, and one of those values does not include <code>ProPackPlus</code>.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
Indicates whether the category supports Classified Ad listings.
<br><br>
Only returned when this value (or this category's setting) overrides the value inherited from the category's parent or the site default. Will not be returned if one or more <a href="types/FeatureIDCodeType.html">FeatureID</a> values are used in the call request, and one of those values does not include <code>AdFormatEnabled</code>.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
Indicates whether the category supports sellers offering a counter offer against a buyer's Best Offer, or a buyer offering a counter offer against the seller's counter offer.
<br><br>
Only returned when this value (or this category's setting) overrides the value inherited from the category's parent or the site default. Will not be returned if one or more <a href="types/FeatureIDCodeType.html">FeatureID</a> values are used in the call request, and one of those values does not include <code>BestOfferCounterEnabled</code>.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
Indicates whether the category supports the Best Offer Auto Decline feature.
<br><br>
Only returned when this value (or this category's setting) overrides the value inherited from the category's parent or the site default. Will not be returned if one or more <a href="types/FeatureIDCodeType.html">FeatureID</a> values are used in the call request, and one of those values does not include <code>BestOfferAutoDeclineEnabled</code>.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
Indicates whether the category supports the Speciality level subscription to Motors Local Market listings. This feature is only available to licensed vehicle dealers.
<br><br>
Only returned when this value (or this category's setting) overrides the value inherited from the category's parent or the site default. Will not be returned if one or more <a href="types/FeatureIDCodeType.html">FeatureID</a> values are used in the call request, and one of those values does not include <code>LocalMarketSpecialitySubscription</code>.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
Indicates whether the category supports the Regular level subscription to Motors Local Market listings. This feature is only available to licensed vehicle dealers.
<br><br>
Only returned when this value (or this category's setting) overrides the value inherited from the category's parent or the site default. Will not be returned if one or more <a href="types/FeatureIDCodeType.html">FeatureID</a> values are used in the call request, and one of those values does not include <code>LocalMarketRegularSubscription</code>.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
Indicates whether the category supports the Premium level subscription Motors Local Market listings. This feature is only available to licensed vehicle dealers.
<br><br>
Only returned when this value (or this category's setting) overrides the value inherited from the category's parent or the site default. Will not be returned if one or more <a href="types/FeatureIDCodeType.html">FeatureID</a> values are used in the call request, and one of those values does not include <code>LocalMarketPremiumSubscription</code>.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
Indicates whether the category supports a seller creating a Motors Local Market listing without a subscription. This feature is only available to licensed vehicle dealers.
<br><br>
Only returned when this value (or this category's setting) overrides the value inherited from the category's parent or the site default. Will not be returned if one or more <a href="types/FeatureIDCodeType.html">FeatureID</a> values are used in the call request, and one of those values does not include <code>LocalMarketNonSubscription</code>.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
This field is deprecated.
579
681
NoOp
This field is deprecated.
579
681
NoOp
This field is deprecated.
579
681
NoOp
Indicates the Minimum Reserve Price for an auction listing in this category. If there is no Minimum Reserve Price, a value of <code>0.0</code> is returned in this field.
<br><br>
Only returned when this value (or this category's setting) overrides the value inherited from the category's parent or the site default. Will not be returned if one or more <a href="types/FeatureIDCodeType.html">FeatureID</a> values are used in the call request, and one of those values does not include <code>MinimumReservePrice</code>.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
Indicates whether this category supports seller-level contact information for Classified Ad listings.
<br><br>
Only returned when this value (or this category's setting) overrides the value inherited from the category's parent or the site default. Will not be returned if one or more <a href="types/FeatureIDCodeType.html">FeatureID</a> values are used in the call request, and one of those values does not include <code>SellerContactDetailsEnabled</code>.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
Indicates whether the Transaction Confirmation Request feature is supported for this category.
<br><br>
Only returned when this value (or this category's setting) overrides the value inherited from the category's parent or the site default.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
This field is deprecated.
This field is deprecated.
This field is deprecated.
Indicates whether the payment method should be displayed to the user for
Classified Ad format listings.
Even if enabled, checkout may or may not be enabled.
<br><br>
Only returned when this value (or this category's setting) overrides the value inherited from the category's parent or the site default. Will not be returned if one or more <a href="types/FeatureIDCodeType.html">FeatureID</a> values are used in the call request, and one of those values does not include <code>ClassifiedAdPaymentMethodEnabled</code>.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
Indicates if shipping options are available for Classified Ad listings
in the category.
<br><br>
Only returned when this value (or this category's setting) overrides the value inherited from the category's parent or the site default. Will not be returned if one or more <a href="types/FeatureIDCodeType.html">FeatureID</a> values are used in the call request, and one of those values does not include <code>ClassifiedAdShippingMethodEnabled</code>.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
Indicates if Best offer is enabled for Classified Ad listings for this category.
<br><br>
Only returned when this value (or this category's setting) overrides the value inherited from the category's parent or the site default. Will not be returned if one or more <a href="types/FeatureIDCodeType.html">FeatureID</a> values are used in the call request, and one of those values does not include <code>ClassifiedAdBestOfferEnabled</code>.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
Indicates whether counter offers are allowed in Classified Ad listings
for this category.
<br><br>
Only returned when this value (or this category's setting) overrides the value inherited from the category's parent or the site default. Will not be returned if one or more <a href="types/FeatureIDCodeType.html">FeatureID</a> values are used in the call request, and one of those values does not include <code>ClassifiedAdCounterOfferEnabled</code>.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
Indicates whether automatic decline for best offers for Classified Ad listings is enabled for this category.
<br><br>
Only returned when this value (or this category's setting) overrides the value inherited from the category's parent or the site default. Will not be returned if one or more <a href="types/FeatureIDCodeType.html">FeatureID</a> values are used in the call request, and one of those values does not include <code>ClassifiedAdAutoDeclineEnabled</code>.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
Indicates whether the category supports the telephone as a contact method for Classified Ad listings.
<br><br>
Only returned when this value (or this category's setting) overrides the value inherited from the category's parent or the site default. Will not be returned if one or more <a href="types/FeatureIDCodeType.html">FeatureID</a> values are used in the call request, and one of those values does not include <code>ClassifiedAdContactByPhoneEnabled</code>.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
Indicates whether the category supports email as a contact method for Classified Ad listings.
<br><br>
Only returned when this value (or this category's setting) overrides the value inherited from the category's parent or the site default. Will not be returned if one or more <a href="types/FeatureIDCodeType.html">FeatureID</a> values are used in the call request, and one of those values does not include <code>ClassifiedAdContactByEmailEnabled</code>.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
Indicates whether listings in this category need to have a safe payment method.
<br><br>
Only returned when this value (or this category's setting) overrides the value inherited from the category's parent or the site default. Will not be returned if one or more <a href="types/FeatureIDCodeType.html">FeatureID</a> values are used in the call request, and one of those values does not include <code>SafePaymentRequired</code>.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
Indicates if pay-per-lead listings are allowed for this category. Pay-per-lead listings can be applicable if the value of <b>ListingType</b> is <code>LeadGeneration</code> and the value of <b>ListingSubtype</b> is <code>ClassifiedAd</code>.
<br><br>
Only returned when this value (or this category's setting) overrides the value inherited from the category's parent or the site default.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
Indicates whether the category supports the use of Item Specifics in listings. If enabled, sellers can use the <b>Item.ItemSpecifics</b> node in Add/Revise/Relist calls to specify Item Specific name-value pairs.
<br><br>
Only returned when this value (or this category's setting) overrides the value inherited from the category's parent or the site default. Will not be returned if one or more <a href="types/FeatureIDCodeType.html">FeatureID</a> values are used in the call request, and one of those values does not include <code>ItemSpecificsEnabled</code>.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
<span class="tablenote"><b>Note:</b>
This field is deprecated since it is only applicable to the eBay India site, and this marketplace is no longer available.</span>
Indicates whether the category supports the <code>PaisaPayEscrow</code> payment method. This feature is only applicable to the India site.
<br><br>
Only returned when this value (or this category's setting) overrides the value inherited from the category's parent or the site default. Will not be returned if one or more <a href="types/FeatureIDCodeType.html">FeatureID</a> values are used in the call request, and one of those values does not include <code>PaisaPayFullEscrowEnabled</code>.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
Indicates whether the category supports the capability to identify a product using the brand/manufacturer part number combination.
<br><br>
Only returned when this value (or this category's setting) overrides the value inherited from the category's parent or the site default. Will not be returned if one or more <a href="types/FeatureIDCodeType.html">FeatureID</a> values are used in the call request, and one of those values does not include <code>BrandMPNIdentifierEnabled</code>.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
Indicates whether the category supports the Best Offer Automatic Accept feature for Classified Ad listings.
<br><br>
Only returned when this value (or this category's setting) overrides the value inherited from the category's parent or the site default. Will not be returned if one or more <a href="types/FeatureIDCodeType.html">FeatureID</a> values are used in the call request, and one of those values does not include <code>ClassifiedAdAutoAcceptEnabled</code>.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
Indicates whether the category supports the Best Offer Automatic Accept feature for listings.
<br><br>
Only returned when this value (or this category's setting) overrides the value inherited from the category's parent or the site default. Will not be returned if one or more <a href="types/FeatureIDCodeType.html">FeatureID</a> values are used in the call request, and one of those values does not include <code>BestOfferAutoAcceptEnabled</code>.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
Indicates whether the category supports specifying that listings be displayed in the default search results of North America sites (US and Canada (English).
<br><br>
Only returned when this value (or this category's setting) overrides the value inherited from the category's parent or the site default. Will not be returned if one or more <a href="types/FeatureIDCodeType.html">FeatureID</a> values are used in the call request, and one of those values does not include <code>CrossBorderTradeEnabled</code>.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
Indicates whether the category supports specifying that listings be displayed in the default search results of the UK and Ireland sites.
<br><br>
Only returned when this value (or this category's setting) overrides the value inherited from the category's parent or the site default. Will not be returned if one or more <a href="types/FeatureIDCodeType.html">FeatureID</a> values are used in the call request, and one of those values does not include <code>CrossBorderTradeEnabled</code>.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
Indicates whether the category supports specifying that listings be displayed in the default search results of the Australia site.
<br><br>
Only returned when this value (or this category's setting) overrides the value inherited from the category's parent or the site default. Will not be returned if one or more <a href="types/FeatureIDCodeType.html">FeatureID</a> values are used in the call request, and one of those values does not include <code>CrossBorderTradeEnabled</code>.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
For the Australia site, if both <b>PayPalBuyerProtectionEnabled</b> and <b>BuyerGuaranteeEnabled</b> are returned, then buyer protection is allowed for this category.
<br><br>
Only returned when this value (or this category's setting) overrides the value inherited from the category's parent or the site default. Will not be returned if one or more <a href="types/FeatureIDCodeType.html">FeatureID</a> values are used in the call request, and one of those values does not include <code>PayPalBuyerProtectionEnabled</code>.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
For the Australia site, if both <b>PayPalBuyerProtectionEnabled</b> and <b>BuyerGuaranteeEnabled</b> are returned, then buyer protection is allowed for this category.
<br><br>
Only returned when this value (or this category's setting) overrides the value inherited from the category's parent or the site default. Will not be returned if one or more <a href="types/FeatureIDCodeType.html">FeatureID</a> values are used in the call request, and one of those values does not include <code>PayPalBuyerProtectionEnabled</code>.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
This field is deprecated.
This field is returned if the Featured Gallery feature is supported for the category. The time unit that is returned in this field indicates how long a gallery will be featured on eBay.
<br><br>
Only returned when this value (or this category's setting) overrides the value inherited from the category's parent or the site default. Will not be returned if one or more <a href="types/FeatureIDCodeType.html">FeatureID</a> values are used in the call request, and one of those values does not include <code>GalleryFeaturedDurations</code>.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
Indicates whether the category requires PayPal as a payment method.
<br><br>
Only returned when this value (or this category's setting) overrides the value inherited from the category's parent or the site default. Will not be returned if one or more <a href="types/FeatureIDCodeType.html">FeatureID</a> values are used in the call request, and one of those values does not include <code>PayPalRequired</code>.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
Specifies whether this category allows Classified Ad listings on eBay Motors. This element is applicable for eBay Motors Pro users.
<br><br>
Only returned when this value (or this category's setting) overrides the value inherited from the category's parent or the site default. Will not be returned if one or more <a href="types/FeatureIDCodeType.html">FeatureID</a> values are used in the call request, and one of those values does not include <code>eBayMotorsProAdFormatEnabled</code>.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
Indicates whether this category supports including the telephone in the seller's contact information. This element is for eBay Motors Pro users.
<br><br>
Only returned when this value (or this category's setting) overrides the value inherited from the category's parent or the site default. Will not be returned if one or more <a href="types/FeatureIDCodeType.html">FeatureID</a> values are used in the call request, and one of those values does not include <code>eBayMotorsProContactByPhoneEnabled</code>.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
Indicates which telephone option is enabled for the seller's contact information. This element is for eBay Motors Pro users.
<br><br>
Only returned when this value (or this category's setting) overrides the value inherited from the category's parent or the site default. Will not be returned if one or more <a href="types/FeatureIDCodeType.html">FeatureID</a> values are used in the call request, and one of those values does not include <code>eBayMotorsProContactByPhoneEnabled</code>.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
Indicates whether this category supports including the address in the seller's contact information. This element is for eBay Motors Pro users.
<br><br>
Only returned when this value (or this category's setting) overrides the value inherited from the category's parent or the site default. Will not be returned if one or more <a href="types/FeatureIDCodeType.html">FeatureID</a> values are used in the call request, and one of those values does not include <code>eBayMotorsProContactByAddressEnabled</code>.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
Indicates which address option is enabled for the seller's contact information. This element is for eBay Motors Pro users.
<br><br>
Only returned when this value (or this category's setting) overrides the value inherited from the category's parent or the site default. Will not be returned if one or more <a href="types/FeatureIDCodeType.html">FeatureID</a> values are used in the call request, and one of those values does not include <code>eBayMotorsProContactByAddressEnabled</code>.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
Indicates whether this category supports including the company name in the seller's contact information. This element is for eBay Motors Pro users.
<br><br>
Only returned when this value (or this category's setting) overrides the value inherited from the category's parent or the site default. Will not be returned if one or more <a href="types/FeatureIDCodeType.html">FeatureID</a> values are used in the call request, and one of those values does not include <code>eBayMotorsProCompanyNameEnabled</code>.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
Indicates whether this category supports including an email address in the seller's contact information. This element is for eBay Motors Pro users.
<br><br>
Only returned when this value (or this category's setting) overrides the value inherited from the category's parent or the site default. Will not be returned if one or more <a href="types/FeatureIDCodeType.html">FeatureID</a> values are used in the call request, and one of those values does not include <code>eBayMotorsProContactByEmailEnabled</code>.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
Indicates if Best Offer is supported for eBay Motors Classified Ad listings in this category. This element is for eBay Motors Pro users.
<br><br>
Only returned when this value (or this category's setting) overrides the value inherited from the category's parent or the site default. Will not be returned if one or more <a href="types/FeatureIDCodeType.html">FeatureID</a> values are used in the call request, and one of those values does not include <code>eBayMotorsProBestOfferEnabled</code>.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
Specifies whether this category allows auto-accept for Best Offers for eBay Motors Classified Ad listings. This element is for eBay Motors Pro users.
<br><br>
Only returned when this value (or this category's setting) overrides the value inherited from the category's parent or the site default. Will not be returned if one or more <a href="types/FeatureIDCodeType.html">FeatureID</a> values are used in the call request, and one of those values does not include <code>eBayMotorsProAutoAcceptEnabled</code>.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
Specifies whether this category allows auto-decline for Best Offers for eBay Motors Classified Ad listings. This element is for eBay Motors Pro users.
<br><br>
Only returned when this value (or this category's setting) overrides the value inherited from the category's parent or the site default. Will not be returned if one or more <a href="types/FeatureIDCodeType.html">FeatureID</a> values are used in the call request, and one of those values does not include <code>eBayMotorsProAutoDeclineEnabled</code>.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
Indicates if the payment method should be displayed to the user for this category in an eBay Motors Classified Ad listing. Even if enabled, checkout may or may not be enabled. This element is for eBay Motors Pro users.
<br><br>
Only returned when this value (or this category's setting) overrides the value inherited from the category's parent or the site default. Will not be returned if one or more <a href="types/FeatureIDCodeType.html">FeatureID</a> values are used in the call request, and one of those values does not include <code>eBayMotorsProPaymentMethodCheckOutEnabled</code>.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
Indicates if shipping options should be displayed to the user for this category in an eBay Motors Classified Ad listing. This element is for eBay Motors Pro users.
<br><br>
Only returned when this value (or this category's setting) overrides the value inherited from the category's parent or the site default. Will not be returned if one or more <a href="types/FeatureIDCodeType.html">FeatureID</a> values are used in the call request, and one of those values does not include <code>eBayMotorsProShippingMethodEnabled</code>.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
Indicates whether counter offers are allowed on Best Offers for this category in an eBay Motors Classified Ad listing. This element is for eBay Motors Pro users.
<br><br>
Only returned when this value (or this category's setting) overrides the value inherited from the category's parent or the site default. Will not be returned if one or more <a href="types/FeatureIDCodeType.html">FeatureID</a> values are used in the call request, and one of those values does not include <code>eBayMotorsProCounterOfferEnabled</code>.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
Specifies whether this category allows seller-level contact information for eBay Motors Classified Ad listings. A value of true means seller-level contact information is available for Classified Ad listings. This element is for eBay Motors Pro users.
<br><br>
Only returned when this value (or this category's setting) overrides the value inherited from the category's parent or the site default. Will not be returned if one or more <a href="types/FeatureIDCodeType.html">FeatureID</a> values are used in the call request, and one of those values does not include <code>eBayMotorsProSellerContactDetailsEnabled</code>.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
Specifies whether this category supports Motor Local Market Classified Ad listings. This element is for Local Market dealers.
<br><br>
Only returned when this value (or this category's setting) overrides the value inherited from the category's parent or the site default. Will not be returned if one or more <a href="types/FeatureIDCodeType.html">FeatureID</a> values are used in the call request, and one of those values does not include <code>LocalMarketAdFormatEnabled</code>.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
Indicates whether this category supports including the telephone in the seller's contact information. This element is for Local Market dealers.
<br><br>
Only returned when this value (or this category's setting) overrides the value inherited from the category's parent or the site default. Will not be returned if one or more <a href="types/FeatureIDCodeType.html">FeatureID</a> values are used in the call request, and one of those values does not include <code>LocalMarketContactByPhoneEnabled</code>.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
Indicates which telephone option is enabled for the seller's contact information. This element is for Local Market dealers.
<br><br>
Only returned when this value (or this category's setting) overrides the value inherited from the category's parent or the site default. Will not be returned if one or more <a href="types/FeatureIDCodeType.html">FeatureID</a> values are used in the call request, and one of those values does not include <code>LocalMarketContactByPhoneEnabled</code>.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
Indicates whether this category supports including the address in the seller's contact information. This element is for Local Market dealers.
<br><br>
Only returned when this value (or this category's setting) overrides the value inherited from the category's parent or the site default. Will not be returned if one or more <a href="types/FeatureIDCodeType.html">FeatureID</a> values are used in the call request, and one of those values does not include <code>LocalMarketContactByAddressEnabled</code>.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
Indicates which address option is enabled for the seller's contact information. This element is for Local Market dealers.
<br><br>
Only returned when this value (or this category's setting) overrides the value inherited from the category's parent or the site default. Will not be returned if one or more <a href="types/FeatureIDCodeType.html">FeatureID</a> values are used in the call request, and one of those values does not include <code>LocalMarketContactByAddressEnabled</code>.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
Indicates whether the category supports including a company name in the seller's contact information. This element is for Local Market dealers.
<br><br>
Only returned when this value (or this category's setting) overrides the value inherited from the category's parent or the site default. Will not be returned if one or more <a href="types/FeatureIDCodeType.html">FeatureID</a> values are used in the call request, and one of those values does not include <code>LocalMarketCompanyNameEnabled</code>.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
Indicates whether the category supports including an email address in the seller's contact information. This element is for Local Market dealers.
<br><br>
Only returned when this value (or this category's setting) overrides the value inherited from the category's parent or the site default. Will not be returned if one or more <a href="types/FeatureIDCodeType.html">FeatureID</a> values are used in the call request, and one of those values does not include <code>LocalMarketContactByEmailEnabled</code>.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
Indicates if Best Offer is enabled/required for Motors Local Market Classified Ad listings in this category. This element is for Local Market dealers.
<br><br>
Only returned when this value (or this category's setting) overrides the value inherited from the category's parent or the site default. Will not be returned if one or more <a href="types/FeatureIDCodeType.html">FeatureID</a> values are used in the call request, and one of those values does not include <code>LocalMarketBestOfferEnabled</code>.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
Specifies whether this category supports auto-accept for Best Offers for Motors Local Market Classified Ads. This element is for Local Market dealers.
<br><br>
Only returned when this value (or this category's setting) overrides the value inherited from the category's parent or the site default. Will not be returned if one or more <a href="types/FeatureIDCodeType.html">FeatureID</a> values are used in the call request, and one of those values does not include <code>LocalMarketAutoAcceptEnabled</code>.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
Specifies whether this category supports auto-decline for Best Offers for Motors Local Market Classified Ads. This element is for Local Market dealers.
<br><br>
Only returned when this value (or this category's setting) overrides the value inherited from the category's parent or the site default. Will not be returned if one or more <a href="types/FeatureIDCodeType.html">FeatureID</a> values are used in the call request, and one of those values does not include <code>LocalMarketAutoDeclineEnabled</code>.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
Indicates if the payment method should be displayed to the user for this category in an Motors Local Market Classified Ad listing. Even if enabled, checkout may or may not be enabled. This element is for Local Market dealers.
<br><br>
Only returned when this value (or this category's setting) overrides the value inherited from the category's parent or the site default. Will not be returned if one or more <a href="types/FeatureIDCodeType.html">FeatureID</a> values are used in the call request, and one of those values does not include <code>LocalMarketPaymentMethodCheckOutEnabled</code>.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
Indicates if shipping methods should be displayed to the user for this category in an Motors Local Market Classified Ad listing. Even if enabled, checkout may or may not be enabled. This element is for Local market dealers.
<br><br>
Only returned when this value (or this category's setting) overrides the value inherited from the category's parent or the site default. Will not be returned if one or more <a href="types/FeatureIDCodeType.html">FeatureID</a> values are used in the call request, and one of those values does not include <code>LocalMarketShippingMethodEnabled</code>.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
Indicates whether counter offers are allowed on Best Offers for this category for Motors Local Market Classified Ad listings. This element is for Local market dealers.
<br><br>
Only returned when this value (or this category's setting) overrides the value inherited from the category's parent or the site default. Will not be returned if one or more <a href="types/FeatureIDCodeType.html">FeatureID</a> values are used in the call request, and one of those values does not include <code>LocalMarketCounterOfferEnabled</code>.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
Specifies the whether this category allows seller-level contact information for Motors Local Market Classified Ad listings. This element is for Local Market dealers.
<br><br>
Only returned when this value (or this category's setting) overrides the value inherited from the category's parent or the site default. Will not be returned if one or more <a href="types/FeatureIDCodeType.html">FeatureID</a> values are used in the call request, and one of those values does not include <code>LocalMarketSellerContactDetailsEnabled</code>.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
Indicates which telephone option is included in the seller's contact information. This element is for For Sale By Owner listings.
<br><br>
Only returned when this value (or this category's setting) overrides the value inherited from the category's parent or the site default. Will not be returned if one or more <a href="types/FeatureIDCodeType.html">FeatureID</a> values are used in the call request, and one of those values does not include <code>ClassifiedAdContactByPhoneEnabled</code>.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
Indicates whether this category supports including an address in the seller's contact information. This element is for For Sale By Owner listings.
<br><br>
Only returned when this value (or this category's setting) overrides the value inherited from the category's parent or the site default. Will not be returned if one or more <a href="types/FeatureIDCodeType.html">FeatureID</a> values are used in the call request, and one of those values does not include <code>ClassifiedAdContactByAddressEnabled</code>.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
Indicates which address option is included in the seller's contact information. This element is for For Sale By Owner listings.
<br><br>
Only returned when this value (or this category's setting) overrides the value inherited from the category's parent or the site default. Will not be returned if one or more <a href="types/FeatureIDCodeType.html">FeatureID</a> values are used in the call request, and one of those values does not include <code>ClassifiedAdContactByAddressEnabled</code>.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
Indicates whether this category supports including a company name in the seller's contact information. This element is for For Sale By Owner listings.
<br><br>
Only returned when this value (or this category's setting) overrides the value inherited from the category's parent or the site default. Will not be returned if one or more <a href="types/FeatureIDCodeType.html">FeatureID</a> values are used in the call request, and one of those values does not include <code>ClassifiedAdCompanyNameEnabled</code>.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
The value in this field indicates whether the category supports Motors Local Market listings if the seller has a Specialty vehicle subscription.
<br><br>
Only returned when this value (or this category's setting) overrides the value inherited from the category's parent or the site default. Will not be returned if one or more <a href="types/FeatureIDCodeType.html">FeatureID</a> values are used in the call request, and one of those values does not include <code>SpecialitySubscription</code>.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
The value in this field indicates whether the category supports Motors Local Market listings if the seller has a Regular vehicle subscription.
<br><br>
Only returned when this value (or this category's setting) overrides the value inherited from the category's parent or the site default. Will not be returned if one or more <a href="types/FeatureIDCodeType.html">FeatureID</a> values are used in the call request, and one of those values does not include <code>RegularSubscription</code>.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
The value in this field indicates whether the category supports Motors Local Market listings if the seller has a Premium vehicle subscription.
<br><br>
Only returned when this value (or this category's setting) overrides the value inherited from the category's parent or the site default. Will not be returned if one or more <a href="types/FeatureIDCodeType.html">FeatureID</a> values are used in the call request, and one of those values does not include <code>PremiumSubscription</code>.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
The value in this field indicates whether the category supports Motors Local Market listings if the seller does not have a vehicle subscription.
<br><br>
Only returned when this value (or this category's setting) overrides the value inherited from the category's parent or the site default. Will not be returned if one or more <a href="types/FeatureIDCodeType.html">FeatureID</a> values are used in the call request, and one of those values does not include <code>NonSubscription</code>.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
<span class="tablenote"><b>Note:</b>
This field is deprecated since it is only applicable to the eBay India site, and this marketplace is no longer available.</span>
Indicates the escrow workflow version that applies to the category on the India site: Default Workflow, Workflow A or Workflow B.
<br><br>
Only returned when this value (or this category's setting) overrides the value inherited from the category's parent or the site default. Will not be returned if one or more <a href="types/FeatureIDCodeType.html">FeatureID</a> values are used in the call request, and one of those values does not include <code>INEscrowWorkflowTimeline</code>.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
This field is deprecated.
Indicates if the category allows the seller to revise the quantity of a multi-quantity, active listing.
<br><br>
Only returned when this value (or this category's setting) overrides the value inherited from the category's parent or the site default. Will not be returned if one or more <a href="types/FeatureIDCodeType.html">FeatureID</a> values are used in the call request, and one of those values does not include <code>ReviseQuantityAllowed</code>.
GetCategoryFeatures
DetailLevel: none, ReturnSummary, ReturnAll
Conditionally
Indicates if the category allows the seller to revise the price of a fixed-price listing.
<br><br>
Only returned when this value (or this category's setting) overrides the value inherited from the category's parent or the site default. Will not be returned if one or more <a href="types/FeatureIDCodeType.html">FeatureID</a> values are used in the call request, and one of those values does not include <code>RevisePriceAllowed</code>.
GetCategoryFeatures
DetailLevel: none, ReturnSummary, ReturnAll
Conditionally
Indicates if an eBay Store owner gets extended listing durations in a given category. When the value of this element is true, it means the listing duration values defined in <b>StoreOwnerExtendedListingDurations</b> are applicable to fixed-price listings in a given category.
<br><br>
Only returned when this value (or this category's setting) overrides the value inherited from the category's parent or the site default. Will not be returned if one or more <a href="types/FeatureIDCodeType.html">FeatureID</a> values are used in the call request, and one of those values does not include <code>StoreOwnerExtendedListingDurationsEnabled</code>.
GetCategoryFeatures
DetailLevel: none, ReturnSummary, ReturnAll
Conditionally
Provides additional listings durations that are available to eBay Store owners. The extended listing durations provided here in this element should be merged in with the baseline listing durations provided in the <b>ListingDurations</b> element. Applies to fixed-price Listings.
<br><br>
Only returned when this value (or this category's setting) overrides the value inherited from the category's parent or the site default. Will not be returned if one or more <a href="types/FeatureIDCodeType.html">FeatureID</a> values are used in the call request, and one of those values does not include <code>StoreOwnerExtendedListingDurations</code>.
GetCategoryFeatures
DetailLevel: none, ReturnSummary, ReturnAll
Conditionally
<b>For most sites:</b> If true, listings in this
category require a return policy. <br>
<br>
<b>For eBay Australia (AU) and
US eBay Motors Parts and Accessories:</b>
If true, the category supports but does not require a
return policy.
<br><br>
Only returned when this value (or this category's setting) overrides the value inherited from the category's parent or the site default. Will not be returned if one or more <a href="types/FeatureIDCodeType.html">FeatureID</a> values are used in the call request, and one of those values does not include <code>ReturnPolicyEnabled</code>.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
Indicates if a seller's stated handling time is enabled for a category. A handling time is generally needed for items that are shipped to the buyer, but not necessarily applicable to freight shipping or local pickup. <br>
<br>
The handling time is the maximum number of business days the seller
commits to for preparing an item to be shipped after receiving a
cleared payment. The seller's handling time does not include the
shipping time (the carrier's transit time).
<br>
For a list of the handling time values allowed for each site, use
<code>DispatchTimeMaxDetails</code> in <b>GeteBayDetails</b>.<br>
<br>
<span class="tablenote"><b>Note:</b>
Although the field name ends with "Enabled", a value of true means
that a handling time is NOT supported, and value of false means
that a handling time IS supported.</span><br>
Only returned when this value (or this category's setting) overrides the value inherited from the category's parent or the site default. Will not be returned if one or more <a href="types/FeatureIDCodeType.html">FeatureID</a> values are used in the call request, and one of those values does not include <code>HandlingTimeEnabled</code>.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
The maximum cost the seller can charge for the first domestic flat-rate shipping
service.
Mutually exclusive with the <b>Group</b><code>N</code><b>MaxFlatShippingCost</b> elements.
<br><br>
Only returned when this value (or this category's setting) overrides the value inherited from the category's parent or the site default. Will not be returned if one or more <a href="types/FeatureIDCodeType.html">FeatureID</a> values are used in the call request, and one of those values does not include <code>MaxFlatShippingCost</code>.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
https://developer.ebay.com/DevZone/guides/features-guide/default.html#Development/Shipping-TypesCosts.html#MaximumFlatRateShippingCost
Maximum Flat Rate Shipping Cost
Returns the applicable max cap per shipping cost for shipping service group1.
<br><br>
Only returned when this value (or this category's setting) overrides the value inherited from the category's parent or the site default. Will not be returned if one or more <a href="types/FeatureIDCodeType.html">FeatureID</a> values are used in the call request, and one of those values does not include <code>Group1MaxFlatShippingCost</code>.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
Returns the applicable max cap per shipping cost for shipping service group2.
<br><br>
Only returned when this value (or this category's setting) overrides the value inherited from the category's parent or the site default. Will not be returned if one or more <a href="types/FeatureIDCodeType.html">FeatureID</a> values are used in the call request, and one of those values does not include <code>Group2MaxFlatShippingCost</code>.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
Returns the applicable max cap per shipping cost for shipping service group3.
<br><br>
Only returned when this value (or this category's setting) overrides the value inherited from the category's parent or the site default. Will not be returned if one or more <a href="types/FeatureIDCodeType.html">FeatureID</a> values are used in the call request, and one of those values does not include <code>Group3MaxFlatShippingCost</code>.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
Indicates the acceptable payment methods that can be used when listing an item for sale in the corresponding category.
<br><br>
Only returned when this value (or this category's setting) overrides the value inherited from the category's parent or the site default. Will not be returned if one or more <a href="types/FeatureIDCodeType.html">FeatureID</a> values are used in the call request, and one of those values does not include <code>PaymentMethods</code>.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
If <code>true</code>, you can pass in <b>Item.Variations</b> in an
Add/Revise/Relist fixed-price item call when you list in this
category.<br>
<br>
Multi-variation listings contain items that are logically the same
product, but that vary in their manufacturing details or packaging.
For example, a particular brand and style of shirt could be
available in different sizes and colors, such as "large blue" and
"medium black" variations.
<br><br>
Only returned when this value (or this category's setting) overrides the value inherited from the category's parent or the site default. Will not be returned if one or more <a href="types/FeatureIDCodeType.html">FeatureID</a> values are used in the call request, and one of those values does not include <code>VariationsEnabled</code>.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
This field is deprecated.
Indicates whether the category supports free, automatic upgrades for Gallery Plus, which enhances pictures in search results.
<br><br>
Only returned when this value (or this category's setting) overrides the value inherited from the category's parent or the site default. Will not be returned if one or more <a href="types/FeatureIDCodeType.html">FeatureID</a> values are used in the call request, and one of those values does not include <code>FreeGalleryPlusEnabled</code>.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
Indicates whether the category supports free, automatic upgrades for Picture Pack, a discount package that includes super-sizing of pictures.
<br><br>
Only returned when this value (or this category's setting) overrides the value inherited from the category's parent or the site default. Will not be returned if one or more <a href="types/FeatureIDCodeType.html">FeatureID</a> values are used in the call request, and one of those values does not include <code>FreePicturePackEnabled</code>.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
Indicates whether the category supports parts compatibility by application
(<b>ByApplication</b>), by specification (<b>BySpecification</b>), or not at all
(<b>Disabled</b>). Categories cannot support both types of parts compatibility.
<br><br>
Parts Compatibility is supported in limited Parts & Accessories
categories for the eBay Motors (US) site (site ID 100) only.
<br><br>
Only returned when this value (or this category's setting) overrides the value inherited from the category's parent or the site default. Will not be returned if one or more <a href="types/FeatureIDCodeType.html">FeatureID</a> values are used in the call request, and one of those values does not include <code>CompatibilityEnabled</code>.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
This field specifies the minimum number of required compatible applications
for listing items. A value of "0" indicates it is not mandatory to specify
parts compatibilities when listing.
<br><br>
This applies to categories that are enabled for compatibility by application
only. Parts compatiblity by application can be specified by listing with a
catalog product that supports parts compatibility or by specifying parts
compatibility by application manually (<b class="con">
Item.ItemCompatibilityList</b>).
<br><br>
Only returned when this value (or this category's setting) overrides the value inherited from the category's parent or the site default. Will not be returned if one or more <a href="types/FeatureIDCodeType.html">FeatureID</a> values are used in the call request, and one of those values does not include <code>MinCompatibleApplications</code>.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
This field specifies the maximum number of compatible applications allowed
per item when adding or revising items. This is relevant for specifying parts
compatibility by application manually (<b class="con">
Item.ItemCompatibilityList</b>) only.
<br><br>
Applicable for the US site only.
<br><br>
For DE, UK, and AU sites, this field returns the same value as <b>MaxGranularFitmentCount</b>.
<br><br>
Only returned when this value (or this category's setting) overrides the value inherited from the category's parent or the site default. Will not be returned if one or more <a href="types/FeatureIDCodeType.html">FeatureID</a> values are used in the call request, and one of those values does not include <code>MaxCompatibleApplications</code>.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
Indicates whether the category supports (or requires) using <b>Item.ConditionID</b> to specify an item's condition in Add/Revise/Relist calls. See the <b>ConditionValues</b> type for a list of valid condition ID values.
<br><br>
Only returned when this value (or this category's setting) overrides the value inherited from the category's parent or the site default. Will not be returned if one or more <a href="types/FeatureIDCodeType.html">FeatureID</a> values are used in the call request, and one of those values does not include <code>ConditionEnabled</code>.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
Specifies the supported item conditions for the category, plus related policies and other details.
<br><br>
Only returned <b>ConditionEnabled</b> value is <code>Enabled</code> or <code>Required</code> and when any of the condition values are different from the category's parent or the site default. Will not be returned if one or more <a href="types/FeatureIDCodeType.html">FeatureID</a> values are used in the call request, and one of those values does not include <code>ConditionValues</code>.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
Some eBay sites may select a few categories and designate them as
"value categories". These are typically selected from
categories where buyers can find great deals. (Not all categories
with great deals are designated as value categories.)
This designation can change over time. <br>
<br>
While a category is designated as a value category (i.e.,
when <b>ValueCategory</b> is <code>true</code>), it is subject to the following rule:
Items in value categories can only be listed in one category.<br>
<br>
For example, if you attempt to list in two categories and the
primary category or secondary category is a value category,
then eBay drops the secondary category and lists the
item in the primary category only.
Similarly, if you attempt to add a secondary category to an existing
listing, or you change the category for an existing listing,
and if the primary or secondary category is a value category,
then eBay drops the secondary category.
<br><br>
Only returned when this value (or this category's setting) overrides the value inherited from the category's parent or the site default. Will not be returned if one or more <a href="types/FeatureIDCodeType.html">FeatureID</a> values are used in the call request, and one of those values does not include <code>ValueCategory</code>.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
Indicates whether a category supports (or requires) the creation of a listing using an eBay Catalog product. To create a listing based on an eBay Catalog product, the seller passed in Global Trade Item Number (GTIN) or eBay Product ID (ePID) value in an Add/Revise/Relist call and then eBay tries to match the product identifier to a product in the eBay Catalog. If a match is found, the listing picks up the details of the eBay Catalog product, including product title, product description, product aspects, primary eBay listing category ID, and links to any product stock photos.
<br><br>
Only returned when this value (or this category's setting) overrides the value inherited from the category's parent or the site default. Will not be returned if one or more <a href="types/FeatureIDCodeType.html">FeatureID</a> values are used in the call request, and one of those values does not include <code>ProductCreationEnabled</code>.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
Indicates whether or not European Article Numbers (EANs) are supported/required when listing products in the category. A value of <code>Disabled</code> indicates that EANs cannot be used for the category, a value of <code>Enabled</code> indicates that EANs can be used for the category, and a value of <code>Required</code> indicates that an EAN is required when listing a product in this category.
<br><br>
Only returned when this value (or this category's setting) overrides the value inherited from the category's parent or the site default. Will not be returned if one or more <a href="types/FeatureIDCodeType.html">FeatureID</a> values are used in the call request, and one of those values does not include <code>EANEnabled</code>.
<br>
<br>
<span class="tablenote"><b>Note:</b>
It is recommended that sellers always use <b>GetCategoryFeatures</b> to see if an eBay category requires a Global Trade Item Number (GTIN) or a Brand/MPN combination. So, that means that they should look for <b>EANEnabled</b>, <b>ISBNEnabled</b>, <b>UPCEnabled</b>, and <b>BrandMPNIdentifierEnabled</b> at the category level in the <b>GetCategoryFeatures</b> response. </span>
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
Indicates whether or not International Standard Book Numbers (ISBNs) are supported/required when listing products in the category. A value of <code>Disabled</code> indicates that ISBNs cannot be used for the category, a value of <code>Enabled</code> indicates that ISBNs can be used for the category, and a value of <code>Required</code> indicates that an ISBN is required when listing a product in this category.
<br><br>
Only returned when this value (or this category's setting) overrides the value inherited from the category's parent or the site default. Will not be returned if one or more <a href="types/FeatureIDCodeType.html">FeatureID</a> values are used in the call request, and one of those values does not include <code>ISBNEnabled</code>.
<br>
<br>
<span class="tablenote"><b>Note:</b>
It is recommended that sellers always use <b>GetCategoryFeatures</b> to see if an eBay category requires a Global Trade Item Number (GTIN) or a Brand/MPN combination. So, that means that they should look for <b>ISBNEnabled</b>, <b>EANEnabled</b>, <b>UPCEnabled</b>, and <b>BrandMPNIdentifierEnabled</b> at the category level in the <b>GetCategoryFeatures</b> response. </span>
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
Indicates whether or not Universal Product Codes (UPCs) are supported/required when listing products in the category. A value of <code>Disabled</code> indicates that UPCs cannot be used for the category, a value of <code>Enabled</code> indicates that UPCs can be used for the category, and a value of <code>Required</code> indicates that a UPC is required when listing a product in this category.
<br><br>
Only returned when this value (or this category's setting) overrides the value inherited from the category's parent or the site default. Will not be returned if one or more <a href="types/FeatureIDCodeType.html">FeatureID</a> values are used in the call request, and one of those values does not include <code>UPCEnabled</code>.
<br>
<br>
<span class="tablenote"><b>Note:</b>
It is recommended that sellers always use <b>GetCategoryFeatures</b> to see if an eBay category requires a Global Trade Item Number (GTIN) or a Brand/MPN combination. So, that means that they should look for <b>UPCEnabled</b>, <b>ISBNEnabled</b>, <b>EANEnabled</b>, and <b>BrandMPNIdentifierEnabled</b> at the category level in the <b>GetCategoryFeatures</b> response. </span>
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
Indicates the maximum number of compatible applications allowed per item when adding or revising items with compatibilities provided at the most detailed granularity. For example, in Car and Truck Parts on the US site, the most granular application would include Year, Make, Model, Trim, and Engine.
<br><br>
Only returned when this value (or this category's setting) overrides the value inherited from the category's parent or the site default. Will not be returned if one or more <a href="types/FeatureIDCodeType.html">FeatureID</a> values are used in the call request, and one of those values does not include <code>MaxGranularFitmentCount</code>.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
This field is for future use. It is currently returned as an empty field, but in the future, the string value in this field will indicate Parts Compatibility vehicle type (e.g. cars, motorcycles, boats).
<br><br>
Only returned when this value (or this category's setting) overrides the value inherited from the category's parent or the site default. Will not be returned if one or more <a href="types/FeatureIDCodeType.html">FeatureID</a> values are used in the call request, and one of those values does not include <code>CompatibleVehicleType</code>.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
This field is deprecated.
Indicates the Business Policies category group that may be used for Shipping profiles.
<br><br>
Only returned when this value (or this category's setting) overrides the value inherited from the category's parent or the site default. Will not be returned if one or more <a href="types/FeatureIDCodeType.html">FeatureID</a> values are used in the call request, and one of those values does not include <code>ShippingProfileCategoryGroup</code>.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
Indicates the Business Policies category group that may be used for Payment profiles.
<br><br>
Only returned when this value (or this category's setting) overrides the value inherited from the category's parent or the site default. Will not be returned if one or more <a href="types/FeatureIDCodeType.html">FeatureID</a> values are used in the call request, and one of those values does not include <code>PaymentProfileCategoryGroup</code>.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
Indicates the Business Policies category group that may be used for Return Policy profiles.
<br><br>
Only returned when this value (or this category's setting) overrides the value inherited from the category's parent or the site default. Will not be returned if one or more <a href="types/FeatureIDCodeType.html">FeatureID</a> values are used in the call request, and one of those values does not include <code>ReturnPolicyProfileCategoryGroup</code>.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
This field is deprecated.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
This field is deprecated.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
This field is returned as <code>true</code> if the corresponding category supports the use of a seller-provided title for a motor vehicle listing on the US or Canada Motors marketplaces. A seller-provided title is a descriptive title, given by the seller, that appears below eBay's pre-filled listing title for the motor vehicle. Visually, the seller-provided title is similar to a subtitle on other types of eBay listings (non-vehicle). A seller-provided title can assist in helping buyers discover the vehicle.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
This field is returned as <code>true</code> if the corresponding category supports the use of a deposit/down payment on a motor vehicle listing. In an <b>AddItem</b> call, the seller can configure a down payment for a motor vehicle listing using the <b>PaymentDetails</b> container.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
Indicates if the Global Shipping Program (GSP) is supported for the category.
<br><br>
Only returned when this value (or this category's setting) overrides the value inherited from the category's parent or the site default. Will not be returned if one or more <a href="types/FeatureIDCodeType.html">FeatureID</a> values are used in the call request, and one of those values does not include <code>GlobalShippingEnabled</code>.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
This field indicates whether or not the category (specified in the <b>Category.CategoryID</b> field) supports Boats and Motorcycles Parts compatibility. If <code>true</code>, parts compatibility name-value pairs for boats and motorcycles can be added to an item listed in the specified category.
<br><br>
Only returned when this value (or this category's setting) overrides the value inherited from the category's parent or the site default. Will not be returned if one or more <a href="types/FeatureIDCodeType.html">FeatureID</a> values are used in the call request, and one of those values does not include <code>AdditionalCompatibilityEnabled</code>.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
A <code>true</code> value in this field indicates that items listed in the category (specified in the <b>Category.CategoryID</b> field) may be enabled with the 'Click and Collect' feature. With the 'Click and Collect' feature, a buyer can purchase certain items on an eBay site and collect them at a local store. Buyers are notified by eBay once their items are available. A <code>false</code> value in this field indicates that items listed in the category are not eligible for the 'Click and Collect' feature.
<br/><br/>
The 'Click and Collect' feature is only available to large merchants on the eBay UK (site ID - 3), eBay Australia (Site ID - 15), and eBay Germany (Site ID - 77) sites.
<br><br>
Only returned when this value (or this category's setting) overrides the value inherited from the category's parent or the site default. Will not be returned if one or more <a href="types/FeatureIDCodeType.html">FeatureID</a> values are used in the call request, and one of those values does not include <code>PickupDropOffEnabled</code>.
<br>
<br>
<span class="tablenote"><b>Note:</b> For Click and Collect eligible sellers, the Click and Collect feature can only be enabled at the account level, and then each of the seller's listings within an Click and Collect enabled category will be automatically evaluated for Click and Collect eligibility.
</span>
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
A <code>true</code> value in this field indicates that digital gift cards (eBay gift cards or third-party gift cards) can be listed in the category specified in the <b>Category.CategoryID</b> field. A <code>false</code> value in this field indicates that digital gift cards can not be listed in the specified category.
<br/><br/>
Digital gift cards are currently only supported on the US site. There are some restrictions when it comes to selling gift cards, including the following:
<ul>
<li>Each seller can only have one gift card listing at any given time </li>
<li>The maximum dollar value of the gift card may not exceed 500.00</li>
<li>Prepaid credit cards from American Express, Discover, MasterCard, or Visa are not allowed</li>
</ul>
For more information on eBay's Gift Card policy, see the <a href="
http://pages.ebay.com/help/policies/gift.html" target="_blank">Gift cards policy Help page</a>.
<br><br>
Only returned when this value (or this category's setting) overrides the value inherited from the category's parent or the site default. Will not be returned if one or more <a href="types/FeatureIDCodeType.html">FeatureID</a> values are used in the call request, and one of those values does not include <code>DigitalGoodDeliveryEnabled</code>.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
This field is returned as <code>true</code> if the category supports the use of an eBay Product ID (e.g. ePID) in an Add/Revise/Relist API call to identify which motorcycles and/or scooters are compatible with a motor vehicle part or accessory. ePIDs can only be used to identify motorcycles and scooters on the Germany and UK sites.
<br/><br/>
For more information on using an ePID to identify a compatible motorcycle or scooter through an Add/Revise/Relist API call on the Germany or UK site, see the documentation for the <a href="
http://developer.ebay.com/Devzone/XML/docs/Reference/eBay/AddItem.html#Request.Item.ItemCompatibilityList.Compatibility.NameValueList">Compatibility.NameValueList</a> container.
<br><br>
Only returned when this value (or this category's setting) overrides the value inherited from the category's parent or the site default. Will not be returned if one or more <a href="types/FeatureIDCodeType.html">FeatureID</a> values are used in the call request, and one of those values does not include <code>EpidSupported</code>.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
This field is returned as <code>true</code> if the category supports the use of a K Type vehicle number in an Add/Revise/Relist API call to identify which cars and/or trucks are compatible with a motor vehicle part or accessory. K type vehicle numbers can only be used to identify cars and trucks on the Germany site.
<br/><br/>
For more information on using a K Type vehicle number to identify a compatible car or truck through an Add/Revise/Relist API call on the Germany site, see the documentation for the <a href="
http://developer.ebay.com/Devzone/XML/docs/Reference/eBay/AddItem.html#Request.Item.ItemCompatibilityList.Compatibility.NameValueList">Compatibility.NameValueList</a> container.
<br><br>
Only returned when this value (or this category's setting) overrides the value inherited from the category's parent or the site default. Will not be returned if one or more <a href="types/FeatureIDCodeType.html">FeatureID</a> values are used in the call request, and one of those values does not include <code>KTypeSupported</code>.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
This field indicates if the category supports Product-Based Shopping Experience listings (listings associated with eBay catalog products). PBSE is currently supported by the US, UK, Germany, Australia, and Canada (English) sites.
<br><br>
Only returned when this value (or this category's setting) overrides the value inherited from the category's parent or the site default. Will not be returned if one or more <a href="types/FeatureIDCodeType.html">FeatureID</a> values are used in the call request, and one of those values does not include <code>ProductRequiredEnabled</code>.
<br><br>
<span class="tablenote"><b>Note:</b>
Due to the rollback of the Product-Based Shopping Experience mandate for all eBay categories, the value for this field should never get returned as <code>Enabled</code> for any production categories.</span>
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
The values returned in this field indicate whether or not the seller accepts domestic returns for items listed in the associated marketplace and category. <br><br>While most categories return the <b>ReturnsAccepted</b> flag (indicating the category supports returns), some categories will also return the <b>ReturnsNotAccepted</b> flag to indicate the seller can choose to not accept returns for an item listed in that category. <br><br>The values returned in this field are pertinent only if <b>ReturnPolicyEnabled</b> in GetCategoryFeatures is set to <code>true</code> for the associated category, which indicates that items listed in the category must include a return policy. Here, it's worth noting that not accepting returns is a return policy. The values returned in this field are valid in AddItem and its related family of calls, and in the return policies you configure for use with the Account and Business Policies Management APIs.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
The values returned in this field indicate whether or not the seller can offer international returns. <br><br>The values returned in this field are pertinent only if <b>ReturnPolicyEnabled</b> in GetCategoryFeatures is set to <code>true</code> for the associated category, which indicates that items listed in the category must include a return policy. The values returned in this field are valid in AddItem and its related family of calls, and in the return policies you configure for use with the Account and Business Policies Management APIs.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
The values returned in this field indicate the return-duration options that are available for domestic returns for items listed in the associated marketplace and category. <br><br>The values returned in this field are pertinent only if <b>ReturnPolicyEnabled</b> in GetCategoryFeatures is set to <code>true</code> for the associated category, which indicates that items listed in the category must include a return policy. The values returned in this field are valid in AddItem and its related family of calls, and in the return policies you configure for use with the Account and Business Policies Management APIs.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
The values returned in this field indicate the return-duration options that are available for international returns for items listed in the associated marketplace and category. <br><br>The values returned in this field are pertinent only if <b>ReturnPolicyEnabled</b> in GetCategoryFeatures is set to <code>true</code> for the associated category, which indicates that items listed in the category must include a return policy. The values returned in this field are valid in AddItem and its related family of calls, and in the return policies you configure for use with the Account and Business Policies Management APIs.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
The values returned in this field indicate the available options for who pays the return shipping for domestic returns. Possible values are <code>BUYER</code> and <code>SELLER</code>. <br><br>The values returned in this field are pertinent only if <b>ReturnPolicyEnabled</b> in GetCategoryFeatures is set to <code>true</code> for the associated category, which indicates that items listed in the category must include a return policy. The values returned in this field are valid in AddItem and its related family of calls, and in the return policies you configure for use with the Account and Business Policies Management APIs.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
The values returned in this field indicate the available options for who pays the return shipping for international returns. Possible values are <code>BUYER</code> and <code>SELLER</code>. <br><br>The values returned in this field are pertinent only if <b>ReturnPolicyEnabled</b> in GetCategoryFeatures is set to <code>true</code> for the associated category, which indicates that items listed in the category must include a return policy. The values returned in this field are valid in AddItem and its related family of calls, and in the return policies you configure for use with the Account and Business Policies Management APIs.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
On the EBAY_US marketplace only, sellers can offer item replacement in addition to offering money back returns. This flag defines the availability of such options for the given US marketplace category. Sellers can offer item replacements only if returns are enabled (<b>returnPolicyEnabled</b> is set to <code>true</code>) for the item. You can specify item replacement in the AddItem family of calls and in the return policy settings of the Account and Business Policies Management APIs.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
In US, sellers can offer an item replacement for returns, in addition to offering money back returns. The values returned in this field indicate the availability of such options for the given marketplace and category. <br><br>The values returned in this field are pertinent only if <b>ReturnPolicyEnabled</b> in GetCategoryFeatures is set to <code>true</code> for the associated category, which indicates that items listed in the category must include a return policy. The values returned in this field are valid in AddItem and its related family of calls, and in the return policies you configure for use with the Account and Business Policies Management APIs.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
In some EU countries, sellers are legally required to describe the return policy they offer. The value returned by this field indicates if sellers can provide such a description within the given marketplace and category. <br><br>The values returned in this field are pertinent only if <b>ReturnPolicyEnabled</b> in GetCategoryFeatures is set to <code>true</code> for the associated category, which indicates that items listed in the category must include a return policy. The values returned in this field are valid in AddItem and its related family of calls, and in the return policies you configure for use with the Account and Business Policies Management APIs.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
Type defining the <b>CategoryGroup</b> container, which defines the category group to which the corresponding Business Policies profile will be applied, and a flag that indicates whether or not that Business Policies profile is the default for that category group.
Defines the name of the category group tied to a Business Policies profile. Valid values are
<code>ALL</code> (referring to all non-motor vehicle category groups) or <code>MOTORS_VEHICLE</code> (referring to
only motor vehicle category groups).
<br><br>
The <b>CategoryGroup</b> container is only returned in <b>GetUserPreferences</b>
if the <b>ShowSellerProfilePreferences</b> field is included in the request and set to <code>true</code>.
GetUserPreferences
Conditionally
This boolean value indicates whether the corresponding Business Policies profile is the default for the category group.
<br><br>
The <b>CategoryGroup</b> container is only returned in <b>GetUserPreferences</b>
if the <b>ShowSellerProfilePreferences</b> field is included in the request and set to <code>true</code>.
GetUserPreferences
Conditionally
This type is used by the <b>CategorySpecific</b> container in the <b>GetCategorySpecifics</b> request. The <b>CategorySpecific</b> container is used when a seller wants to pass in Item Specific name-value(s) pairs for a specific category to discover if eBay has better name or value recommendations for that Item Specific.
An eBay category ID is passed into this field to identify the eBay category for which the seller is providing Item Specific name-value(s) pairs. Multiple <b>CategoryID</b> fields can be passed in if the Item Specific name-value(s) pairs are applicable for multiple categories. However, more categories can result in longer call response times. If your request times out, specify fewer category IDs.
<br>
<br>
<span class="tablenote"><b>Note:</b>
The call request requires either one or more <b>CategoryID</b> values (at the root level), one or more <b>CategorySpecific.CategoryID</b> values, or the <b>CategorySpecificsFileInfo</b> boolean field. The <b>CategorySpecificsFileInfo</b> field is only used if the user plans to use the <b>downloadFile</b> call of the <b>FileTransfer</b> API to retrieve Item Specifics. <b>CategoryID</b> and <b>CategorySpecific.CategoryID</b> can both be used in the same call request.
</span>
10
100
GetCategorySpecifics
Conditionally
This container is used to input Item Specific name-value(s) pairs for a specific category to discover if eBay has better name or value recommendations for that Item Specific. The Item Specific name can be
an arbitrary name that the user wants to check, or it could
be a name that was returned in a prior <b>GetCategorySpecifics</b> response. At least one <b>NameValueList</b> container must be used if the <b>CategorySpecific</b> container is used.
GetCategorySpecifics
Conditionally
This type is used by the <b>CategoryMapping</b> fields that are returned in the <b>GetCategoryMappings</b> response to indicate any eBay Category IDs that have changed recently.
This attribute value is the unique identifier of an eBay category that has been recently updated to a new Category ID, which is specified in the <b>id</b> attribute. The user will want to use the Category ID value in the <b>id</b> attribute the next time they run a call that requires a Category ID. Note that Category IDs are unique to each eBay site. This attribute is always returned with the <b>CategoryMapping</b> field.
GetCategoryMappings
Conditionally
This attribute value is the unique identifier of the currently active eBay category. The user will want to use this Category ID value the next time they run a call that requires a Category ID. Note that Category IDs are unique to each eBay site. This attribute is always returned with the <b>CategoryMapping</b> field.
<br><br>
<span class="tablenote"><b>Note:</b>
Note that more than one <b>OldID</b> values may map into the same new category (same <b>id</b> value) since sometimes multiple eBay categories may be consolidated into a new, expanded category.
</span>
GetCategoryMappings
Conditionally
Container for data on one listing category. Many of the <b>CategoryType</b> fields are only returned in the <b>GetCategories</b> response. Add/Revise/Relist calls only use the <b>CategoryID</b> field to specify which eBay category in which to list the item.
If this field is returned as <code>true</code>, the corresponding category supports Best Offers. If this field is not present, the category does not support Best Offers. This field is not returned when <code>false</code>.
GetCategories
DetailLevel: ReturnAll
Conditionally
If this field is returned as <code>true</code>, the corresponding category supports immediate payment for listings. Unless the seller is opted in to eBay Managed Payments, PayPal must be an accepted payment method for a listing for the seller to require immediate payment from the buyer. This field is only returned when <code>true</code>.
GetCategories
DetailLevel: ReturnAll
Conditionally
Requiring Immediate Payment
https://developer.ebay.com/DevZone/guides/features-guide/default.html#Development/Listing-PaymentMethod.html#RequiringImmediatePayment
If this field is returned as <code>true</code>, the corresponding category supports business-to-business (B2B) VAT
listings. If this field is not present, the category does not B2B VAT listings. This field is not returned when <code>false</code>. This feature is applicable to the eBay Germany (DE), Austria (AT),
and Switzerland (CH) sites only.
GetCategories
DetailLevel: ReturnAll
Conditionally
Working with Business Features and VAT
https://developer.ebay.com/DevZone/guides/features-guide/default.html#Development/Sites-IntlDiffsVATB2B.html
If this field is deprecated..
This string value is the unique identifier of an eBay category.
In <b>GetItem</b> and related calls, see the <b>CategoryName</b> field for the text name of
the category. The parent category of this eBay category is only shown in <b>GetCategories</b>.
<br>
<br>
In an Add call, the <b>PrimaryCategory.CategoryID</b> is conditionally required unless the seller successfully uses the <b>ProductListingDetails</b> container to find an eBay catalog product match. When the seller successfully uses an eBay catalog product to create a listing, the listing title, listing description, item specifics, listing category, and stock photo defined in the catalog product is used to create the listing.
<br>
<br>
In an Add/Revise/Relist call, the <b>SecondaryCategory.CategoryID</b> is conditionally required if a Secondary listing Category is used.
<br><br>
<b>For ReviseItem only:</b> Previously, removing the listing from a secondary category was only possible within 12 hours of the listing's scheduled end time when an auction listing had no active bids or a multiple-quantity, fixed-price listing had no items sold, but this restriction no longer exists. Now, the secondary category can be dropped for any active listing at any time, regardless of whether an auction listing has bids or a fixed-price listing has sales. To drop a secondary category, the seller passes in a value of <code>0</code> in the <b>SecondaryCategory.CategoryID</b> field.
<br>
10
AddItem
AddItems
VerifyAddItem
AddFixedPriceItem
VerifyAddFixedPriceItem
RelistFixedPriceItem
ReviseFixedPriceItem
RelistItem
ReviseItem
ReviseSellingManagerTemplate
VerifyRelistItem
PrimaryCategory
Conditionally
AddItem
AddItems
VerifyAddItem
AddFixedPriceItem
VerifyAddFixedPriceItem
RelistFixedPriceItem
ReviseFixedPriceItem
RelistItem
ReviseItem
ReviseSellingManagerTemplate
VerifyRelistItem
SecondaryCategory
Conditionally
AddSellingManagerTemplate
PrimaryCategory
Yes
AddSellingManagerTemplate
SecondaryCategory
No
GetBidderList
PrimaryCategory
Always
GetBidderList
Conditionally
FreeAddedCategory
SecondaryCategory
GetCategories
DetailLevel: ReturnAll
Always
GetContextualKeywords
Always
GetCategory2CS
MappedCategoryArray
DetailLevel: ReturnAll
Always
GetCategory2CS
UnmappedCategoryArray
DetailLevel: ReturnAll
Conditionally
GetItem
GetSellingManagerTemplates
Always
PrimaryCategory
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
GetItem
Conditionally
FreeAddedCategory
SecondaryCategory
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
GetItemTransactions
GetSellerTransactions
DetailLevel: ReturnAll
Always
GetItemTransactions
GetSellerTransactions
DetailLevel: ReturnAll
Conditionally
GetSuggestedCategories
Conditionally
GetSellerList
Conditionally
FreeAddedCategory
SecondaryCategory
DetailLevel: ItemReturnDescription, ReturnAll
GetSellerList
Conditionally
PrimaryCategory
SecondaryCategory
DetailLevel: ItemReturnDescription, ReturnAll
This integer value indicates the level where the category fits in the eBay site's category hierarchy. For example, if this field has a value of <code>2</code>, then the category is two levels below the root category in the eBay site's category hierarchy.
GetCategories
DetailLevel: ReturnAll
Always
This string value is the display name of the eBay primary category, as it would appear on the eBay site. In <b>GetItem</b>, this will be a fully-qualified category name (e.g., Collectibles:Decorative Collectibles:Hummel, Goebel).
50
GetCategories
DetailLevel: ReturnAll
Always
50
GetContextualKeywords
Always
GetBidderList
Always
PrimaryCategory
GetBidderList
Conditionally
FreeAddedCategory
SecondaryCategory
GetItem
Always
PrimaryCategory
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
50
GetSellingManagerTemplates
Always
PrimaryCategory
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
GetItem
Conditionally
FreeAddedCategory
SecondaryCategory
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
50
GetSellingManagerTemplates
Conditionally
FreeAddedCategory
SecondaryCategory
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
50
GetSuggestedCategories
Conditionally
GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
Conditionally
This string value is the Category ID of the primary category's (indicated in the <b>CategoryID</b> field) parent category. The number of <b>CategoryParentID</b> values that are returned will depend on the <b>LevelLimit</b> value that is set (in <b>GetCategories</b>) and on how far up the primary category is in the eBay category hierarchy. <b>CategoryParentID</b> values are
returned in correct sequence, starting from the root category
and ending with the category that is the direct parent of
the primary category specified in <b>CategoryID</b>. The <b>CategoryID</b> and <b>CategoryParentID</b> values will be the same if the <b>LevelLimit</b> value is set to <code>1</code>.
10
GetCategories
DetailLevel: ReturnAll
Always
GetSuggestedCategories
Conditionally
This string value is the display name of the category indicated in the corresponding <b>CategoryParentID</b> field. If multiple parent categories are retrieved in the <b>GetSuggestedCategories</b> call, the matching <b>CategoryParentID</b> and <b>CategoryParentName</b> can be found by following the sequence in which these fields are returned. The primary category's ancestors are returned in sequence beginning with the root category all the way down to the primary category's direct parent category.
<br><br>
The <b>CategoryParentName</b> fields and the <b>CategoryName</b> field can be used to build
the fully-qualified category name and/or "breadcrumbs" browse path.
(e.g., Computers & Networking > Technology Books > Certification).
GetSuggestedCategories
Conditionally
This field is deprecated.
773
Avoid
FindProducts (Shopping API)
889
This field is deprecated.
773
Avoid
FindProducts (Shopping API)
889
This field is deprecated.
773
Avoid
FindProducts (Shopping API)
889
If this field is returned as <code>true</code>, the corresponding category is no longer a valid eBay category on the site, and items may not be listed in this category. This field is not returned when <code>false</code>.
GetCategories
DetailLevel: ReturnAll
Always
This field is deprecated.
If this field is returned as <code>true</code>, the corresponding category is an eBay leaf category, a category in which items may be listed. This field is not returned when <code>false</code>.
GetCategories
DetailLevel: ReturnAll
Always
If this field is returned as <code>true</code>, the corresponding category is an eBay virtual category, a category in which items may not be listed. This field is not returned when <code>false</code>.
GetCategories
DetailLevel: ReturnAll
Always
This field is deprecated.
This field is deprecated.
773
Avoid
889
If this field is returned as <code>true</code>, the corresponding category is an exception to the eBay site's standard Reserve Price policy on auction listings. For example, if the site's default setting is to allow setting a Reserve Price, but <b>ORPA</b> is returned as <code>true</code>, this particular category does not support setting a Reserve Price. Or, if the site's default setting is not to allow setting a Reserve Price, but <b>ORPA</b> is returned as <code>true</code>, this particular category is the exception to that rule and does support setting a Reserve Price. If <b>ORPA</b> is <code>true</code> for the corresponding category, you can generally assume that the category's subcategories inherit the same setting. 'ORPA' is an acronym for 'Override Reserve Price Allowed'.
<br>
<br>
This field is not returned when <code>false</code>.
GetCategories
DetailLevel: ReturnAll
Always
If this field is returned as <code>true</code>, the corresponding category is an exception to the eBay site's standard Reduce Reserve Price (on active auction listing) policy. For example, if the site's default setting is to allow reducing a Reserve Price for the active auction listing, but <b>ORRA</b> is returned as <code>true</code>, this particular category does not support reducing a Reserve Price. Or, if the site's default setting is not to allow reducting a Reserve Price, but <b>ORRA</b> is returned as <code>true</code>, this particular category is the exception to that rule and does support reducing a Reserve Price. If <b>ORRA</b> is <code>true</code> for the corresponding category, you can generally assume that the category's subcategories inherit the same setting. 'ORRA' is an acronym for 'Override Reduce Reserve Allowed'.
<br>
<br>
This field is not returned when <code>false</code>.
GetCategories
DetailLevel: ReturnAll
Conditionally
If this field is returned as <code>true</code>, the corresponding category does not support lot listings. A lot listing is a listing that features multiple related items that must be purchased by one buyer in one transaction. 'LSD' is an acronym for 'Lot Size Disabled'. 'Lot Size' refers to the <b>LotSize</b> field in the Add/Revise/Relisting calls that is conditionally required if the seller is creating a lot listing. The <b>LSD</b> field is not returned when <code>false</code>.
GetCategories
DetailLevel: ReturnAll
Always
This field is deprecated.
This type is deprecated.
This field is deprecated.
This type is deprecated.
773
Avoid
FindProducts (Shopping API)
889
This field is deprecated.
This field is deprecated.
This field is deprecated.
This field is deprecated.
This field is deprecated.
This field is deprecated.
This field is deprecated.
This enumerated type is deprecated.
773
NoOp
889
FindProducts (Shopping API)
This value is not used.
This value is not used.
This value is not used.
This type is deprecated.
This field is deprecated.
This type is deprecated.
773
Avoid
FindProducts (Shopping API)
889
This field is deprecated.
This field is deprecated.
This field is deprecated.
This field is deprecated.
Type defining the <b>CharityAffiliationDetail</b> container that is returned in the <b>GetUser</b> response. The <b>CharityAffiliationDetail</b> container consists of information on a nonprofit charity organization associated with the seller's account. A separate <b>CharityAffiliationDetail</b> container is returned for each nonprofit charity organization associated with the seller's account.
The affiliation ID for nonprofit charity organizations
registered with the PayPal Giving Fund.
GetUser
DetailLevel: none, ReturnSummary, ReturnAll
Conditionally
Indicates the affiliation status of the nonprofit charity
organization registered with the PayPal Giving Fund.
GetUser
DetailLevel: none, ReturnSummary, ReturnAll
Conditionally
Indicates the affiliation last used date of the nonprofit charity
organization registered with the PayPal Giving Fund.
GetUser
DetailLevel: none, ReturnSummary, ReturnAll
Conditionally
This type is used to hold an array of one or more eBay for Charity organizations that are affiliated with the seller's account.
A <b>CharityAffiliationDetail</b> container will be returned for each eBay for Charity organization that is associated with the seller's account.
GetUser
DetailLevel: none, ReturnSummary, ReturnAll
Conditionally
This type is deprecated. Replaced by <b>CharityAffiliationDetailType</b>
This attribute is deprecated. Replaced by the <b>CharityID</b> field of <b>CharityAffiliationDetailType</b>.
This attribute is deprecated. Replaced by the <b>AffiliationType</b> field of <b>CharityAffiliationDetailType</b>.
This enumeration type defines the possible values that can be returned for the <b>CharityAffiliationDetail.AffiliationType</b> field in the <b>GetUser</b> response.
This enumeration value indicates that the seller is selling to benefit a nonprofit charity organization identified through the <b>CharityID</b> field.
This enumeration value indicates that the seller is a direct, non-profit organization registered with the PayPal Giving Fund, and selling to directly benefit their association.
This enumeration value may be returned if a direct, non-profit organization has recently unregistered with the PayPal Giving Fund, or if a Community Seller has recently removed the charity feature from a listing.
Reserved for internal or future use.
This type is deprecated.
This field is deprecated.
655
NoOp
User.SellerInfo.CharityAffiliationDetails.CharityAffiliationDetail.CharityID
Defines the affiliation status for a nonprofit charity
organization registered with the eBay Giving Works provider.
Indicates the affiliation status of the nonprofit charity
organization registered with the eBay Giving Works provider.
GetUser
DetailLevel: none, ReturnSummary, ReturnAll
Conditionally
Type defining the <b>Charity</b> container, which consists of all details
related to a nonprofit charity organization.
The name of a nonprofit charity organization. The <b>Name</b> field is required for a non-registered charity organization, since these companies will not have a PayPal Giving Fund <b>CharityID</b>
<br/><br/>
150
GetCharities
Conditionally
This flag is for internal use only.
SetCharities
No
This field is for internal use only.
150
SetCharities
Conditionally
This field is for internal use only.
150
SetCharities
Conditionally
The mission statement of a nonprofit charity organization registered with the PayPal Giving Fund. The mission statement is returned in <b>GetCharities</b> and is displayed in listings if the nonprofit charity organization is registered with the PayPal Giving Fund.
<br/><br/>
511
GetCharities
Conditionally
This URL indicates the location of the nonprofit charity organization's logo image. The image file must be JPG or GIF format, and its size cannot exceed 50 KB. This logo is displayed in listings if the nonprofit charity organization is registered with the PayPal Giving Fund. A standard eBay for Charity logo is used in place of the charity organization's logo if the <b>LogoURL</b> or <b>LogoURLSelling</b> values are not provided, or these values point to bad URLs or to URLs containing no images or images not meeting eBay logo size and format requirements. This value is returned if set.
GetCharities
Conditionally
Enumeration value that indicates whether or not the charity is a valid eBay for Charity nonprofit organization.
Keyword string to be used for search purposes.
Integer value that indicates the nonprofit charity organization's region. Each nonprofit charity organization may be associated with only one region.
GetCharities
Conditionally
Integer value that indicates the domain (mission area) of the nonprofit charity organization. A nonprofit charity organization does not have to specify a charity domain, so it is possible that this field will not be returned in <b>GetCharities</b>. Each nonprofit charity organization can belong to as many as three charity domains.
GetCharities
Conditionally
A unique identifier created by eBay and assigned to registered nonprofit charity organizations. This identifier can be used as a filter in the <b>GetCharities</b> request, and it will always be returned if the nonprofit charity organization is registered with the PayPal Giving Fund.
An alternative to the <b>LogoURL</b> value. This URL indicates the location of the nonprofit charity organization's logo image. The image file must be JPG or GIF format, and its size cannot exceed 50 KB. This URL will be used if the <b>LogoURL</b> value points to a broken link or if that location either contains no image or contains an image that does not meet the eBay requirements - GIF or JPG file; maximum size of 50 KB. A nonprofit charity organization's logo is displayed in item listings if the nonprofit charity organization is registered with the PayPal Giving Fund. A standard eBay for Charity logo is used in place of the charity organization's logo if the Logo URL is not provided. This value is returned if set.
GetCharities
Conditionally
This boolean value indicates if the eBay Charity logo will appear in the listing.
GetCharities
Always
This field is deprecated.
659
672
NoOp
FeaturedInCheckout
This field provides a short description about the nonprofit charity organization's primary purpose. "I want to support" will be added to the beginning of the contents of this field. For example, if the description is "the fight against cancer", then on the checkout page "I want to support the fight against cancer" will be displayed. The description may contain a maximum of 115 characters. This value is returned if set.
<br/><br/>
4000
GetCharities
Conditionally
This field must be used with the DisplayNameInCheckout field to control the options that are visible
to a buyer during checkout. If the
DisplayNameInCheckout field is set to True, and the ShowMultipleDonationAmountInCheckout
field is set to False, a checkbox with the one dollar option will be displayed during checkout.
If the DisplayNameInCheckout field is set to False, and the ShowMultipleDonationAmountInCheckout
field is set to False, no options will be displayed during checkout.
<br><br>
Reserved for future use. If the DisplayNameInCheckout field is set to True, and the
ShowMultipleDonationAmountInCheckout field is set to True, a dropdown with multiple donation amounts
will be displayed during checkout. If the DisplayNameInCheckout field is set to False, and the
ShowMultipleDonationAmountInCheckout field is set to True, no options will be displayed during checkout,
but the multiple donation amount field will be set.
A unique identifier created and used by PayPal Giving Fund to identify a registered nonprofit charity organization. This field is only returned for charities that are registered with PayPal Giving Fund.
<br/><br/>
4000
GetCharities
Conditionally
An integer value that indicates a nonprofit charity organization's popularity rank in comparison with other registered eBay for Charity organizations. This value is determined and managed by PayPal Giving Fund and is based on various factors. This value is always returned for nonprofit organizations registered with PayPal Giving Fund.
SetCharities
No
This value is the Employer Identification Number (EIN) of the nonprofit charity
organization. A nonprofit company's EIN is used for tax purposes by the Internal
Revenue Service. This value is returned if the nonprofit organization has an EIN and
it has been set.
SetCharities
No
An alternative name for the nonprofit charity organization. This value is used by
PayPal to search for nonprofit organizations. This value is returned if set.
SetCharities
No
Container consisting of the address (including latitude and longitude) of a nonprofit
charity organization. This container is always returned if it is set.
SetCharities
No
Container consisting of the nonprofit charity organization's social networking site ID/handle.
A <b>NonProfitSocialAddress</b> container will exist for each social
networking site that the charity organization is associated with. Supported social
networking sites include Facebook, Twitter, LinkedIn, Google+, MySpace, and Orkut. One
or more of these containers are returned if set.
SetCharities
No
This attribute is a unique identifier used by the corresponding social networking site to
identify the nonprofit charity organization.
GetCharities
Conditionally
Type defining the <b>NonProfitSocialAddress</b> container, which identifies the
nonprofit organization's social networking site account ID. A <b>NonProfitSocialAddress</b>
container will exist for each social networking site that the charity organization is
associated with.
Enumeration value that indicates the social networking site that the nonprofit charity
organization is associated with. This is a required field for each social networking
account associated with the nonprofit organization.
512
SetCharities
Yes
The account ID/handle associated with the nonprofit charity organization's social
networking site. This is a required field for each social networking account associated
with the nonprofit organization.
512
SetCharities
No
Enumerated type that defines the social networking sites that are supported by PayPal Giving Fund.
This value indicates that the <b>Charity.NonProfitSocialAddress.SocialAddressId</b>
is associated with the nonprofit company's Facebook account.
This value indicates that the <b>Charity.NonProfitSocialAddress.SocialAddressId</b>
is associated with the nonprofit company's Twitter account.
This value indicates that the <b>Charity.NonProfitSocialAddress.SocialAddressId</b>
is associated with the nonprofit company's LinkedIn account.
This value indicates that the <b>Charity.NonProfitSocialAddress.SocialAddressId</b>
is associated with the nonprofit company's Google+ account.
This value indicates that the <b>Charity.NonProfitSocialAddress.SocialAddressId</b>
is associated with the nonprofit company's MySpace account.
This value indicates that the <b>Charity.NonProfitSocialAddress.SocialAddressId</b>
is associated with the nonprofit company's Orkut account.
Reserved for internal or future use.
Enumerated type defining the possible states for a seller's charity seller account.
RegisteredNoCreditCard, DirectDebitRejected
The seller's charity seller account is suspended.
The seller is a registered charity seller.
The seller is no longer a registered charity seller. The account with the PayPal Giving Fund is closed.
The credit card associated with a seller's charity seller account has expired.
The token associated with a seller's charity seller account has expired.
The credit card associated with a seller's charity seller account will expire in 15 (or fewer) days.
The seller is no longer a registered charity seller and has lost direct seller status.
The seller is a registered direct seller, but has no credit card associated with the charity seller account.
The seller is a registered charity seller with no donation payment method on file.
Reserved for internal or future use.
Contains information about one seller associated with a registered eBay for Charity nonprofit organization.
Indicates the status of the seller's charity seller account.
GetUser
DetailLevel: none, ReturnSummary, ReturnAll
Conditionally
Indicates the affiliation status for nonprofit charity organizations registered with the PayPal Giving Fund.
Indicates if the seller has accepted the PayPal Giving Fund Terms and Conditions.
GetUser
DetailLevel: none, ReturnSummary, ReturnAll
Conditionally
Enumerated type defining the possible states for a nonprofit charity organization registered with the PayPal Giving Fund.
The specified nonprofit charity organization is a valid nonprofit charity organization according to the requirements of the PayPal Giving Fund.
The specified nonprofit charity organization is no longer a valid nonprofit charity organization according to the requirements of the PayPal Giving Fund.
(out) Reserved for internal or future use.
This type is used to provide details about a nonprofit organization registered with the PayPal Giving Fund.
The name of the benefiting nonprofit charity organization selected by the
charity seller.
150
GetBidderList
Conditionally
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetItem
GetSellingManagerTemplates
GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
Conditionally
A unique identifier assigned to a nonprofit
charity organization by the PayPal Giving Fund. This value can contain up to 10 digits.
This value is superseded by <b>CharityID</b>.
AddItem
AddItems
AddSellingManagerTemplate
RelistItem
ReviseSellingManagerTemplate
VerifyAddItem
AddFixedPriceItem
VerifyAddFixedPriceItem
RelistFixedPriceItem
RelistFixedPriceItem
VerifyRelistItem
ReviseItem
ReviseFixedPriceItem
Conditionally
GetBidderList
Conditionally
GetItem
GetSellingManagerTemplates
GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
Conditionally
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
The percentage of the purchase price that the
seller chooses to donate to the selected nonprofit
organization. This percentage is displayed in the eBay for Charity listing.
<b>Possible values</b>: 10.0 to 100.0.
<b></b>
<ul>
<li>Percentages must increment by 5.0. </li>
<li>Minimum donation
percentages may be required for eBay for Charity listings, see
<a href="http://pages.ebay.com/help/sell/selling-nonprofit.html">
Selling to benefit nonprofit organizations</a> for
details. </li>
</ul>
<b>DonationPercent</b> is required input when creating eBay for Charity listings.
AddItem
AddItems
AddSellingManagerTemplate
RelistItem
ReviseSellingManagerTemplate
VerifyAddItem
AddFixedPriceItem
VerifyAddFixedPriceItem
RelistFixedPriceItem
RelistFixedPriceItem
VerifyRelistItem
ReviseItem
ReviseFixedPriceItem
Conditionally
GetBidderList
Conditionally
GetItem
GetSellingManagerTemplates
GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
Conditionally
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
A unique identification number assigned by the PayPal Giving Fund to
registered nonprofit charity organizations. This field is required when
creating eBay for Charity listings.
AddItem
AddItems
AddSellingManagerTemplate
RelistItem
ReviseSellingManagerTemplate
VerifyAddItem
AddFixedPriceItem
VerifyAddFixedPriceItem
RelistFixedPriceItem
RelistFixedPriceItem
VerifyRelistItem
ReviseItem
ReviseFixedPriceItem
Conditionally
GetBidderList
Conditionally
GetItem
GetSellingManagerTemplates
GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
Conditionally
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
The stated mission of the nonprofit charity organization. This mission is displayed in the eBay for Charity listing.
511
GetBidderList
Conditionally
GetItem
GetSellingManagerTemplates
GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
Conditionally
The URL of the nonprofit charity organization. This
URL is displayed in the eBay for Charity listing.
GetItem
GetSellingManagerTemplates
GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
Conditionally
GetBidderList
Conditionally
The status of the nonprofit charity organization.
GetBidderList
Conditionally
GetItem
GetSellingManagerTemplates
GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
Conditionally
If this field is returned as <code>true</code>, a percentage of item's purchase price will be donated to a nonprofit organization.
GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
Conditionally
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
This enumerated type is deprecated.
This value is not used.
This value is not used.
This value is not used.
This type is deprecated.
587
NoOp
This field is deprecated.
This field is deprecated.
This field is deprecated.
This field is deprecated.
Enumerated type that lists the possible checkout states of an order line item.
This value indicates that the buyer has paid and checkout is complete.
This value indicates that checkout is incomplete, generally because the buyer has not paid yet.
This value indicates that the buyer wants to confirm the total price of the order line item before making a payment.
This value indicates that the seller has just responded to the buyer concerning the total price of the order line item.
Reserved for future use.
Type defining the <b>CheckoutStatus</b> container that is returned in
<b>GetOrders</b> and <b>GetOrderTransactions</b> to indicate
the current checkout status of the order.
This value indicates the payment status of an order.
GetOrders
DetailLevel: none, ReturnAll
Always
OrderReport
Always
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Always
SoldReport
Always
Indicates the last time that there was a change in value of the
<b>CheckoutStatus.Status</b> field, such as 'Pending' to 'Complete'.
GetOrders
DetailLevel: none, ReturnAll
Always
OrderReport
Always
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Always
The payment method that the buyer selected to pay for the order.
<br><br>
<span class="tablenote"><b>Note: </b>
For sellers opted in to eBay Managed Payments, a payment method is not needed at listing time, but this field is still returned. For eBay Managed Payments orders, the value returned in this field will be <code>CreditCard</code>, unless an eBay gift card was used by the buyer to pay a partial or full balance of the order. If this is the case, the the value returned in this field will be <code>CCAccepted</code>. Either of these two values will be returned for eBay Managed Payments orders, regardless of the actual payment method that the buyer uses.
</span>
GetOrders
DetailLevel: none, ReturnAll
Always
OrderReport
Always
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Always
SoldReport
Always
Indicates the status of the order. This value is subject to change based on the status of the checkout flow. Generally speaking, the <b>Status</b> field reads <code>Incomplete</code> when payment has yet to be initiated, <code>Pending</code> when payment has been initiated but is in process, and <code>Complete</code> when the payment process has completed.
<br><br>
<b>Note</b>: If the <b>PaymentMethod</b> is <code>CashOnPickup</code>, the <b>Status</b> value
will read <code>Complete</code> right at checkout, even though the seller may not have been
officially paid yet, and the <b>eBayPaymentStatus</b> field will read <code>NoPaymentFailure</code>.
The <b>Status</b> value will remain as lt;code>Complete</code> even if the seller uses
<b>ReviseCheckoutStatus</b> to change the checkout status to <code>Pending</code>. However, the
<b>eBayPaymentStatus</b> value in <b>GetOrders</b> will change from <code>NoPaymentFailure</code> to
<code>PaymentInProcess</code>.
GetOrders
DetailLevel: none, ReturnAll
Always
OrderReport
Always
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Always
SoldReport
Always
This field being returned as <code>true</code> indicates that the order can be paid for through the seller's payment gateway account.
<br><br>
<span class="tablenote"><b>Note: </b>
As of May 1, 2019, no eBay marketplace support electronic payments through a seller's Integrated Merchant Credit Card (IMCC) account. To accept online credit card payments from buyers, a seller must use accept PayPal, or opt in to eBay Managed Payments program (if available to seller).
<br><br>
For sellers who are opted in to eBay Managed Payments, this field will actually be returned as <code>true</code>, but this will indicate that the seller is opted in to eBay Managed Payments, and does not indicate that the seller's IMCC account is being used for payments.
</span>
GetOrders
DetailLevel: none, ReturnAll
Always
OrderReport
Always
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Always
This container is no longer used.
The enumeration value in this field indicates which payment method was used by the German buyer who was offered the 'Pay Upon Invoice' option. This field will only be returned if a German buyer was offered the 'Pay Upon Invoice' option. Otherwise, the buyer's selected payment method is returned in the <b>PaymentMethod</b> field.
GetOrders
DetailLevel: none, ReturnAll
Conditionally
OrderReport
Conditionally
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
Type defining the <b>ClassifiedAdAutoAcceptEnabled</b> field that is
returned under the <b>FeatureDefinitions</b> container of the
<b>GetCategoryFeatures</b> response (as long as
'ClassifiedAdAutoAcceptEnabled' or 'ClassifiedAdAutoDeclineEnabled' is included as a <b>FeatureID</b> value in
the call request or no <b>FeatureID</b> values are passed into the call
request). This field is returned as an
empty element (a boolean value is not returned) if one or more eBay API-enabled sites
support the Classified Ad Auto Accept feature.
<br/><br/>
To verify if a specific eBay site supports the Classified Ad Auto Accept feature (for most
categories), look for a 'true' value in the
<b>SiteDefaults.ClassifiedAdAutoAcceptEnabled</b> field.
<br/><br/>
To verify if a specific category on a specific eBay site supports the Classified Ad Auto Accept feature, pass in a <b>CategoryID</b> value in the request, and then
look for a 'true' value in the <b>ClassifiedAdAutoAcceptEnabled</b> field
of the corresponding Category node (match up the <b>CategoryID</b> values
if more than one Category IDs were passed in the request).
Type defining the <b>ClassifiedAdAutoDeclineEnabled</b> field that is
returned under the <b>FeatureDefinitions</b> container of the
<b>GetCategoryFeatures</b> response (as long as
'ClassifiedAdAutoDeclineEnabled' or 'ClassifiedAdAutoAcceptEnabled' is included as a <b>FeatureID</b> value in
the call request or no <b>FeatureID</b> values are passed into the call
request). This field is returned as an
empty element (a boolean value is not returned) if one or more eBay API-enabled sites
support the Classified Ad Auto Decline feature.
<br/><br/>
To verify if a specific eBay site supports the Classified Ad Auto Decline feature (for most
categories), look for a 'true' value in the
<b>SiteDefaults.ClassifiedAdAutoDeclineEnabled</b> field.
<br/><br/>
To verify if a specific category on a specific eBay site supports the Classified Ad Auto Decline feature, pass in a <b>CategoryID</b> value in the request, and then
look for a 'true' value in the <b>ClassifiedAdAutoDeclineEnabled</b> field
of the corresponding Category node (match up the <b>CategoryID</b> values
if more than one Category IDs were passed in the request).
Enumerated type that defines the values used to indicate whether Best Offers for the Classified Ad listing format are enabled/disabled for all/most of a site's categories (<b>SiteDefaults.ClassifiedAdBestOfferEnabled</b>), or enabled/required/disabled for a specific eBay category (<b>Category.ClassifiedAdBestOfferEnabled</b>).
This value indicates that Classified Ad Best Offer feature is disabled for all/most of a site's categories (if returned in the <b>SiteDefaults.ClassifiedAdBestOfferEnabled</b> field), or disabled for a specific category (if returned in the <b>Category.ClassifiedAdBestOfferEnabled</b> field).
This value indicates that Classified Ad Best Offer feature is enabled for all/most of a site's categories (if returned in the <b>SiteDefaults.ClassifiedAdBestOfferEnabled</b> field), or enabled for a specific category (if returned in the <b>Category.ClassifiedAdBestOfferEnabled</b> field).
This value indicates that Classified Ad Best Offer feature is required for a specific category (if returned in the <b>Category.ClassifiedAdBestOfferEnabled</b> field). This value is not applicable at the site level (<b>SiteDefaults</b> container).
(out) Reserved for internal or future use.
Type defining the <b>ClassifiedAdBestOfferEnabled</b> field that is
returned under the <b>FeatureDefinitions</b> container of the
<b>GetCategoryFeatures</b> response (as long as
'ClassifiedAdBestOfferEnabled' is included as a <b>FeatureID</b> value in
the call request or no <b>FeatureID</b> values are passed into the call
request). This field is returned as an
empty element (a boolean value is not returned) if one or more eBay API-enabled sites
support the Classified Ad Best Offer feature.
<br/><br/>
To verify if a specific eBay site supports the Classified Ad Best Offer feature (for most
categories), look for a 'true' value in the
<b>SiteDefaults.ClassifiedAdBestOfferEnabled</b> field.
<br/><br/>
To verify if a specific category on a specific eBay site supports the Classified Ad Best Offer feature, pass in a <b>CategoryID</b> value in the request, and then
look for a 'true' value in the <b>ClassifiedAdBestOfferEnabled</b> field
of the corresponding Category node (match up the <b>CategoryID</b> values
if more than one Category IDs were passed in the request).
Indicates whether the category supports the use of a company name
when contacting the seller for Classified Ad format listings.
Added for the For Sale By Owner format.
Indicates whether the category supports the use of an address when
contacting the seller for Classified Ad format listings.
Added for the For Sale By Owner format.
Indicates if Email can be a contact method for the category
Indicates whether the telephone can be a contact method for the category.
Type defining the <b>ClassifiedAdCounterOfferEnabled</b> field that is
returned under the <b>FeatureDefinitions</b> container of the
<b>GetCategoryFeatures</b> response (as long as
'ClassifiedAdCounterOfferEnabled' is included as a <b>FeatureID</b> value in
the call request or no <b>FeatureID</b> values are passed into the call
request). This field is returned as an
empty element (a boolean value is not returned) if one or more eBay API-enabled sites
support the Classified Ad Best Offer Counter Offer feature.
<br/><br/>
To verify if a specific eBay site supports the Classified Ad Best Offer Counter Offer feature (for most
categories), look for a 'true' value in the
<b>SiteDefaults.ClassifiedAdCounterOfferEnabled</b> field.
<br/><br/>
To verify if a specific category on a specific eBay site supports the Classified Ad Best Offer Counter Offer feature, pass in a <b>CategoryID</b> value in the request, and then
look for a 'true' value in the <b>ClassifiedAdCounterOfferEnabled</b> field
of the corresponding Category node (match up the <b>CategoryID</b> values
if more than one Category IDs were passed in the request).
Defines the pay-per-lead feature. If the field is present, the corresponding feature applies to the category. The field is returned as an empty element (i.e., a boolean value is not returned).
Used to indicate whether the payment method will be displayed for a category
belonging to the Lead Generation Format.
Display the payment method and permit checkout.
Display the payment method and suppress checkout.
Do not display the payment method.
(out) Reserved for internal or future use.
Indicates whether Contact Seller is enabled Classified Ads.
Indicates which phone option the category supports for contacting
the seller for Classified Ad format listings.
Added for the For Sale By Owner format.
Indicates whether shipping options are available for the category.
Indicates which address option the category supports for
Classified Ad format listings.
Added for the For Sale By Owner format.
INVOICE
This enumerated type defines the collection methods that are used to collect either 'Collect and Remit' sales tax in the US, or 'Good and Services' tax in Australia and New Zealand.
<br>
<br>
<span class="tablenote"><b>Note: </b> Although the <b>CollectionMethod</b> field is returned for orders subject to 'Collect and Remit' sales tax or 'Good and Services' tax, the <b>CollectionMethod</b> field and <b>CollectionMethodCodeType</b> are currently not applicable.
</span>
<span class="tablenote"><b>Note: </b> This value is for future use.
</span>
This value is always returned, but because the <b>CollectionMethod</b> field and <b>CollectionMethodCodeType</b> are not currently applicable, this value does not have any purpose at this time.
Defines the Combined Fixed Price Treatment feature. If the field is present, the corresponding feature applies to the category.
The field is returned as an empty element (i.e., a boolean value is not returned).
Enumerated type that defines the seller's preference for allowing
<a href="http://developer.ebay.com/DevZone/guides/features-guide/default.html#development/Listing-AnItem.html#CombinedInvoice">Combined Invoice</a>
orders that pass on a shipping discounts to the buyer.
This value indicates that the seller does not allow Combined Invoice orders. In
other words, the buyer must pay for each order line item separately, and cannot
combine multiple single line item orders into one Combined Invoice order and make
one payment for that order.
This value indicates that the seller allows Combined Invoice orders, and that the
seller has one or more shipping discount rules (Flat, Calculated, or Promotional)
that can be applied at the listing level.
This value indicates that the seller allows Combined Invoice orders, and that the
seller will apply any shipping discounts after the creation of the Combined Invoice
order.
Reserved for internal or future use.
This enumerated type contains the list of values that can be used by the seller to set
the number of days after item purchase that an unpaid order can be combined with one
or more other mutual (same buyer and same seller) unpaid orders into one
<a href="http://developer.ebay.com/DevZone/guides/features-guide/default.html#development/Listing-AnItem.html#CombinedInvoice">Combined Invoice</a>
order. Either the buyer or the seller can initiate the Combined Invoice
process. Sellers can offer buyers shipping discounts through Combined Invoice orders,
and buyers only have to make one payment for multiple orders as opposed to a payment
for each order.
This value indicates that an unpaid order can be combined into a Combined Invoice
order within three days after purchase (creation of order).
This value indicates that an unpaid order can be combined into a Combined Invoice
order within five days after purchase (creation of order).
This value indicates that an unpaid order can be combined into a Combined Invoice
order within seven days after purchase (creation of order).
This value indicates that an unpaid order can be combined into a Combined Invoice
order within 14 days after purchase (creation of order).
This value indicates that an unpaid order can be combined into a Combined Invoice
order within 30 days after purchase (creation of order).
This value indicates that an order is not eligible to be combined into a Combined
Payment order.
This value is reserved for internal or future use.
Type used to indicate if the seller supports <a href="http://developer.ebay.com/DevZone/guides/features-guide/default.html#development/Listing-AnItem.html#CombinedInvoice">Combined Invoice</a>
orders, and if so, defines whether the seller specifies any shipping discount before or after purchase.
<br/><br/>
<span class="tablenote"><b>Note:</b> In the past, this type was also used to indicate more settings related to Combined Invoice discounts, including the number of days that buyers have to combine line items into a Combined Invoice, and detailed information on Calculated and Flat-Rate shipping discount profiles. However, these settings are now set through the <b>SetShippingDiscountProfiles</b> call (or through Shipping Preferences in My eBay), and retrieved with the <b>GetShippingDiscountProfiles</b> call.
</span>
DO NOT USE THIS CONTAINER. As an alternative, use <b>SetShippingDiscountProfiles</b> to set all Calculated Shipping rules and preferences, and use <b>GetShippingDiscountProfiles</b> to retrieve the same information.
Specifies whether or not a seller wants to allow buyers to combine single
order line items into a Combined Invoice order. A Combined Invoice order can
be created by the buyer or seller if multiple unpaid order line items exist
between the same buyer and seller. Often, a Combined Invoice order can
reduce shipping and handling expenses for the buyer and seller.
GetUserPreferences
Conditionally
SetUserPreferences
No
http://developer.ebay.com/DevZone/guides/features-guide/default.html#development/Listing-AnItem.html#CombinedInvoice
Combined Invoice
DO NOT USE THIS FIELD. As an alternative, use the <b>CombinedDuration</b> field in
<b>SetShippingDiscountProfiles</b> to specify the time period in which to allow
buyers to combine order line items into a Combined Invoice order, and use
<b>GetShippingDiscountProfiles</b> to retrieve the <b>CombinedDuration</b> value.
DO NOT USE THIS CONTAINER. As an alternative, use <b>SetShippingDiscountProfiles</b> to set all Flat Rate Shipping rules and preferences, and use <b>GetShippingDiscountProfiles</b> to retrieve the same information.
This enumerated type list the Feedback ratings that can be left by one eBay user for
another user regarding that user's experience with the another user during the
purchase/checkout flow of an order line item.
This value indicates that the submitting user's experience with the other user
(receiving feedback) was rated as a "Positive" experience. If an eBay user receives
a Positive rating for an order line item from a Verified User, their overall
Feedback score increases by a value of 1.
This value indicates that the submitting user's experience with the other user
(receiving feedback) was rated as a "Neutral" experience. If an eBay user receives
a Neutral rating for an order line item from a Verified User, their overall
Feedback score remains the same.
This value indicates that the submitting user's experience with the other user
(receiving feedback) was rated as a "Negative" experience. If an eBay user receives
a Negative rating for an order line item from a Verified User, their overall
Feedback score decreases by a value of 1.
This value indicates that a submitted Feedback entry was withdrawn. If a Feedback
entry is withdrawn, the effect of that entry on the overall Feedback score is
nullified. However, Feedback comments from the withdrawn entry are still visible.
This value indicates that a submitted Feedback entry was withdrawn based on the
decision of a third-party (such as eBay). If a Feedback
entry is withdrawn, the effect of that entry on the overall Feedback score is
nullified.
<br><br>
This value is only applicable to the eBay Motors site only.
This value is reserved for internal or future use.
Defines the vehicle type to which parts compatibility applies. If the field is
present, the corresponding feature applies to the site. The field is returned as an
empty element (e.g., a boolean value is not returned).
Enumerated type that contains values which indicate whether an order or order line item is complete, incomplete, or pending.
This value indicates that the order or order line item is in the incomplete state. Generally speaking, an order or order line item is considered incomplete when payment from the buyer has yet to be initiated.
This value indicates that the order or order line item is complete. Generally speaking, an order or order line item is complete when payment from the buyer has been initiated and has been processed.
<br><br>
<span class="tablenote"><b>Note:</b>
If the <b>PaymentMethodUsed</b> is <code>CashOnPickup</code>,
the <b>CheckoutStatus.Status</b> value in <b>GetOrders</b> will be
<code>Complete</code> at checkout time, even though the seller may not have been officially paid
yet. The <b>CheckoutStatus.Status</b> value in <b>GetOrders</b> will
remain as <code>Complete</code> even if the seller uses <b>ReviseCheckoutStatus</b> to
change the checkout status to <code>Pending</code>. However, the <b>eBayPaymentStatus</b>
value in <b>GetOrders</b> will change from <code>NoPaymentFailure</code> to
<code>PaymentInProcess</code>.
</span>
This value indicates that the order or order line item is in the pending state. Generally speaking, an order is considered pending when payment
from the buyer has been initiated but has yet to be fully processed.
<br><br>
<span class="tablenote"><b>Note:</b>
If the payment method is <code>CashOnPickup</code>, the
<b>CheckoutStatus.Status</b> value in <b>GetOrders</b> will read <code>Complete</code> at checkout time,
even though the seller may not have been officially paid yet. The
<b>CheckoutStatus.Status</b> value in <b>GetOrders</b> will remain as <code>Complete</code> even if the
seller uses <b>ReviseCheckoutStatus</b> to change the checkout status to <code>Pending</code>.
However, the <b>eBayPaymentStatus</b> value in <b>GetOrders</b> will change from
<code>NoPaymentFailure</code> to <code>PaymentInProcess</code>.
</span>
Reserved for internal or future use
Enumerated type that defines the values used to indicate whether Condition IDs are enabled/disabled for all/most of a site's categories (<b>SiteDefaults.ConditionEnabled</b>), or enabled/required/disabled for a specific eBay category (<b>Category.ConditionEnabled</b>).
This value indicates that Condition IDs are disabled for all/most of a site's categories (if returned in the <b>SiteDefaults.ConditionEnabled</b> field), or disabled for a specific category (if returned in the <b>Category.ConditionEnabled</b> field).
This value indicates that Condition IDs are enabled for all/most of a site's categories (if returned in the <b>SiteDefaults.ConditionEnabled</b> field), or enabled for a specific category (if returned in the <b>Category.ConditionEnabled</b> field).
This value indicates that Condition IDs are required for a specific category (if returned in the <b>Category.ConditionEnabled</b> field). This value is not applicable at the site level (<b>SiteDefaults</b> container).
(out) Reserved for internal or future use.
Type defining the <b>ConditionEnabled</b> field that is
returned under the <b>FeatureDefinitions</b> container of the
<b>GetCategoryFeatures</b> response (as long as
'ConditionEnabled' is included as a <b>FeatureID</b> value in
the call request or no <b>FeatureID</b> values are passed into the call
request). 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 Condition IDs to express the condition of an item.
<br/><br/>
To verify if a specific eBay site supports Condition IDs (for most
categories), look for a 'Enabled' value in the
<b>SiteDefaults.ConditionEnabled</b> field.
<br/><br/>
To verify if a specific category on a specific eBay site supports Condition IDs, pass in a <b>CategoryID</b> value in the request, and then
look for an 'Enabled' or 'Required' value in the <b>ConditionEnabled</b> field
of the corresponding Category node (match up the <b>CategoryID</b> values
if more than one Category IDs were passed in the request).
Type defining the <b>ConditionValues.Condition</b> container that is returned at the category level in the <b>GetCategoryFeatures</b> response if 'ConditionValues' is specified as a <b>FeatureID</b> value, or if no <b>FeatureID</b> values are specified. A <b>ConditionValues.Condition</b> container is returned for each supported item condition value for each eBay category returned in the response.
The numeric ID of a condition (e.g., 1000). Use the ID in
AddItem and related calls.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
The human-readable label for the condition (e.g., "New").
This value is typically localized for each site.
The display name can vary by category.
For example, condition ID 1000 could be called
"New: with Tags" in one category and "Brand New" in another.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
Defines the Item Condition feature. If a field of this type is present,
the corresponding feature applies to the site. The field is returned as
an empty element (e.g., a boolean value is not returned).
Fields in this type provide condition values and display names.
Defines an item condition that a category supports.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
URL to the eBay Web site's item condition help for the
category. This may include policies about how to assess the
condition of an item in the category. To reduce
item-not-as-described disputes, we recommend that
you refer sellers (and buyers) to these help pages.
These help pages may vary for some categories.<br>
<br>
The Sandbox might not return valid help URLs.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
Type defining the <b>ContactHoursDetails</b> container, which is used in Add/Revise/Relist calls to provide contact hours for the owner of a Classified Ad. The <b>ContactHoursDetails</b> container is only applicable to Classified Ad listings.
Indicates the local time zone of the values provided for Hours1From/Hours1To
and Hours2From/Hours2To. If you specify a contact hours time range with
Hours1From and Hours1To, you must provide a local time zone.
To retrieve a complete list of the TimeZoneID values
supported by eBay, call <b>GeteBayDetails</b> with <b>DetailName</b>
set to <b>TimeZoneDetails</b>.
AddItem
AddItems
AddSellingManagerTemplate
RelistItem
ReviseItem
ReviseSellingManagerTemplate
VerifyAddItem
VerifyRelistItem
No
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally
GetSellerList
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
Indicates the range of days for which the primary contact hours
specified by Hours1AnyTime or Hours1From and Hours1To apply.
If a value of None is provided for this field, the values provided for
Hours1AnyTime, Hours1From, Hours1To are ignored.
AddItem
AddItems
AddSellingManagerTemplate
RelistItem
ReviseItem
ReviseSellingManagerTemplate
VerifyAddItem
VerifyRelistItem
No
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally
GetSellerList
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
Indicates whether or not a user is available to be contacted 24 hours a day
during the range of days specified using the Hours1Days element.
True indicates the user is available 24 hours a day, false indicates otherwise.
In the case of this field being true, all values provided for Hours1From and
Hours1To will be ignored. In the case of this field being false,
the values provided Hours1From and Hours1To will be considered.
AddItem
AddItems
AddSellingManagerTemplate
RelistItem
ReviseItem
ReviseSellingManagerTemplate
VerifyAddItem
VerifyRelistItem
No
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally
GetSellerList
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
Indicates the starting time of day this eBay user is available for other eBay
members to contact for the range of days specified using Hours1Days.
Enter times in 30 minute increments from the top of the hour. That is, enter
values either on the hour (:00) or 30 minutes past the hour (:30).
Other values will be will be rounded down to the next closest 30 minute
increment. Times entered should be local to the value provided for TimeZoneID.
AddItem
AddItems
AddSellingManagerTemplate
RelistItem
ReviseItem
ReviseSellingManagerTemplate
VerifyAddItem
VerifyRelistItem
No
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally
GetSellerList
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
Indicates the ending time of day this eBay user is available for other eBay
members to contact them for the range of days specified using Hours1Days.
Enter times in 30 minute increments from the top of the hour. That is, enter
values either on the hour (:00) or 30 minutes past the hour (:30).
Other values will be will be rounded down to the next closest 30 minute
increment. Times entered should be local to the value provided for TimeZoneID.
AddItem
AddItems
AddSellingManagerTemplate
RelistItem
ReviseItem
ReviseSellingManagerTemplate
VerifyAddItem
VerifyRelistItem
No
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally
GetSellerList
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
Indicates the range of days for which the secondary contact hours
specified by Hours2AnyTime or Hours2From and Hours2To apply.
If a value of None is provided for this field, the values provided for
Hours2AnyTime, Hours2From, Hours2To are ignored.
<br>
<b>Note:</b> You cannot set Hours2Days to EveryDay. If Hours1Days
is set to EveryDay, secondary contact hours do not apply. Hours2Days cannot be
set to the same value as Hours1Days.
AddItem
AddItems
AddSellingManagerTemplate
RelistItem
ReviseItem
ReviseSellingManagerTemplate
VerifyAddItem
VerifyRelistItem
No
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally
GetSellerList
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
Indicates whether or not a user is available to be contacted 24 hours a day
during the range of days specified using the Hours2Days element.
True indicates the user is available 24 hours a day, false indicates otherwise.
In the case of this field being true, all values provided for Hours2From and
Hours2To will be ignored. In the case of this field being false,
the values provided Hours2From and Hours2To will be considered.
AddItem
AddItems
AddSellingManagerTemplate
RelistItem
ReviseItem
ReviseSellingManagerTemplate
VerifyAddItem
VerifyRelistItem
No
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally
GetSellerList
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
Indicates the starting time of day this eBay user is available for other eBay
members to contact for the range of days specified using Hours2Days.
Enter times in 30 minute increments from the top of the hour. That is, enter
values either on the hour (:00) or 30 minutes past the hour (:30).
Other values will be will be rounded down to the next closest 30 minute
increment. Times entered should be local to the value provided for TimeZoneID.
AddItem
AddItems
AddSellingManagerTemplate
RelistItem
ReviseItem
ReviseSellingManagerTemplate
VerifyAddItem
VerifyRelistItem
No
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally
GetSellerList
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
Indicates the ending time of day this eBay user is available for other eBay
members to contact them for the range of days specified using Hours1Days.
Enter times in 30 minute increments from the top of the hour. That is, enter
values either on the hour (:00) or 30 minutes past the hour (:30).
Other values will be will be rounded down to the next closest 30 minute
increment. Times entered should be local to the value provided for TimeZoneID.
AddItem
AddItems
AddSellingManagerTemplate
RelistItem
ReviseItem
ReviseSellingManagerTemplate
VerifyAddItem
VerifyRelistItem
No
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally
GetSellerList
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
Type defining the <b>ContextSearchAsset</b> container that is returned in the <b>GetContextualKeywords</b> response for each keyword that is found.
The name of the keyword that was found in the search.
64
GetContextualKeywords
Always
The eBay category in which the keyword is used.
GetContextualKeywords
Always
The ranking of the corresponding keyword/category combination relative to
other keywords that were returned in the response.
1
2147483647
GetContextualKeywords
Always
This enumerated type is used to indicate which flat-rate shipping cost group that a shipping service option belongs to.
This enumeration value indicates that the shipping service option belongs to flat-rate shipping cost group 1.
This enumeration value indicates that the shipping service option belongs to flat-rate shipping cost group 2.
This enumeration value indicates that the shipping service option belongs to flat-rate shipping cost group 3.
Reserved for internal or future use.
This enumerated type contains a partial list of ISO 3166 standard two-letter codes that represent countries around the world.
<br><br>
It is recommended that users use the <b>GeteBayDetails</b> call to see the full list of currently supported country codes,
and the English names associated with each code (e.g., KY="Cayman Islands"). Call
<b>GeteBayDetails</b> with <b>DetailName</b> set to <b>Country</b>, and then look for <b>CountryDetails.Country</b> fields in the response.
QP
Afghanistan.
Albania.
Algeria.
American Samoa.
Andorra.
Angola.
Anguilla.
Antarctica.
Antigua and Barbuda.
Argentina.
Armenia.
Aruba.
Australia.
Austria.
Azerbaijan.
Bahamas.
Bahrain.
Bangladesh.
Barbados.
Belarus.
Belgium.
Belize.
Benin.
Bermuda.
Bhutan.
Bolivia.
Bosnia and Herzegovina.
Botswana.
Bouvet Island.
Brazil.
British Indian Ocean Territory.
Brunei Darussalam.
Bulgaria.
Burkina Faso.
Burundi.
Cambodia.
Cameroon.
Canada.
Cape Verde.
Cayman Islands.
Central African Republic.
Chad.
Chile.
China.
Christmas Island.
Cocos (Keeling) Islands.
Colombia.
Comoros.
Congo.
Congo, The Democratic Republic of the.
Cook Islands.
Costa Rica.
Cote d'Ivoire.
Croatia.
Cuba.
Cyprus.
Czech Republic.
Denmark.
Djibouti.
Dominica.
Dominican Republic.
No longer in use.
Ecuador.
Egypt.
El Salvador.
Equatorial Guinea.
Eritrea.
Estonia.
Ethiopia.
Falkland Islands (Malvinas).
Faroe Islands.
Fiji.
Finland.
France.
French Guiana.
French Polynesia. Includes Tahiti.
French Southern Territories.
Gabon.
Gambia.
Georgia.
Germany.
Ghana.
Gibraltar.
Greece.
Greenland.
Grenada.
Guadeloupe.
Guam.
Guatemala.
Guinea.
Guinea-Bissau.
Guyana.
Haiti.
Heard Island and McDonald Islands.
Holy See (Vatican City state).
Honduras.
Hong Kong.
Hungary.
Iceland.
India.
Indonesia.
Islamic Republic of Iran.
Iraq.
Ireland.
Israel.
Italy.
Jamaica.
Japan.
Jordan.
Kazakhstan.
Kenya.
Kiribati.
Democratic People's Republic of Korea.
Republic of Korea.
Kuwait.
Kyrgyzstan.
Lao People's Democratic Republic.
Latvia.
Lebanon.
Lesotho.
Liberia.
Libyan Arab Jamahiriya.
Liechtenstein.
Lithuania.
Luxembourg.
Macao.
The Former Yugoslav Republic of Macedonia.
Madagascar.
Malawi.
Malaysia.
Maldives.
Mali.
Malta.
Marshall Islands.
Martinique.
Mauritania.
Mauritius.
Mayotte.
Mexico.
Federated States of Micronesia.
Republic of Moldova.
Monaco.
Mongolia.
Montserrat.
Morocco.
Mozambique.
Myanmar.
Namibia.
Nauru.
Nepal.
Netherlands.
Netherlands Antilles.
New Caledonia.
New Zealand.
Nicaragua.
Niger.
Nigeria.
Niue.
Norfolk Island.
Northern Mariana Islands.
Norway.
Oman.
Pakistan.
Palau.
Palestinian territory, Occupied.
Panama.
Papua New Guinea.
Paraguay.
Peru.
Philippines.
Pitcairn.
Poland.
Portugal.
Puerto Rico.
Qatar.
Reunion.
Romania.
Russian Federation.
Rwanda.
Saint Helena.
Saint Kitts and Nevis.
Saint Lucia.
Saint Pierre and Miquelon.
Saint Vincent and the Grenadines.
Samoa.
San Marino.
Sao Tome and Principe.
Saudi Arabia.
Senegal.
Seychelles.
Sierra Leone.
Singapore.
Slovakia.
Slovenia.
Solomon Islands.
Somalia.
South Africa.
South Georgia and the South Sandwich Islands.
Spain.
Sri Lanka.
Sudan.
Suriname.
Svalbard and Jan Mayen.
Swaziland.
Sweden.
Switzerland.
Syrian Arab Republic.
Taiwan, Province of China.
Tajikistan.
Tanzania, United Republic of.
Thailand.
Togo.
Tokelau.
Tonga.
Trinidad and Tobago.
Tunisia.
Turkey.
Turkmenistan.
Turks and Caicos Islands.
Tuvalu.
Uganda.
Ukraine.
United Arab Emirates.
United Kingdom.
United States.
NOTE: United States Minor Outlying Islands was
defined in the eBay list previously
but is no longer a viable option. This country
will remain on eBay country list for backward
compatibility. Use 'US' instead.
Uruguay.
Uzbekistan.
Vanuatu.
Venezuela.
Vietnam.
Virgin Islands, British.
Virgin Islands, U.S.
Wallis and Futuna.
Western Sahara.
Yemen.
No longer in use. See RS for Serbia and ME for Montenegro.
Zambia.
Zimbabwe.
NOTE: APO/FPO was defined in eBay list previously
but they are not defined in ISO 3166. This country
will remain on eBay country code list for backward
compatibility.
NOTE : Guernsey was defined in eBay list previously
but they are not defined in ISO 3166. This country
will remain on eBay country list for backward
compatibility.
NOTE: Jan Mayen was defined in eBay list previously
but they are not defined in ISO 3166. This country
will remain on eBay country list for backward
compatibility.
NOTE: Jersey was defined in eBay list previously
but they are not defined in ISO 3166. This country
will remain on eBay country list for backward
compatibility.
Jersey
Guernsey
Unknown country
Serbia
Montenegro.
(out) Reserved for internal or future use
Details about a specific country.
Two-letter code representing a country. These two-letter codes are typically used
in Add/Revise/Relist calls when referring to a country.
Item.Country in AddItem
AddItem.html#Request.Item.Country
GeteBayDetails
Conditionally
Full country name for display purposes. May be similar to (but not necessarily identical to)
CountryName in addresses (e.g., User.RegistrationAddress.CountryName in GetUser).
GeteBayDetails
Conditionally
Returns the latest version number for this field. The version can be used to
determine if and when to refresh cached client data.
GeteBayDetails
DetailLevel: none, ReturnSummary, ReturnAll
Always
Gives the time in GMT that the feature flags for the
details were last updated. This timestamp can be used to
determine if and when to refresh cached client data.
GeteBayDetails
DetailLevel: none, ReturnSummary, ReturnAll
Always
Type defining the <b>CrossBorderTradeAustraliaEnabled</b> field that is
returned under the <b>FeatureDefinitions</b> container of the
<b>GetCategoryFeatures</b> response (as long as
'CrossBorderTradeEnabled' is included as a <b>FeatureID</b> value in
the call request or no <b>FeatureID</b> values are passed into the call
request). This field is returned as an
empty element (a boolean value is not returned) if one or more eBay API-enabled sites
support Cross Border Trade listings on the eBay Australia site.
<br/><br/>
To verify if a specific eBay site supports Cross Border Trade listings on the eBay Australia site (for most
categories), look for a 'true' value in the
<b>SiteDefaults.CrossBorderTradeAustraliaEnabled</b> field.
<br/><br/>
To verify if a specific category on a specific eBay site supports Cross Border Trade listings on the eBay Australia site, pass in a <b>CategoryID</b> value in the request, and then
look for a 'true' value in the <b>CrossBorderTradeAustraliaEnabled</b> field
of the corresponding Category node (match up the <b>CategoryID</b> values
if more than one Category IDs were passed in the request).
Type defining the <b>CrossBorderTradeGBEnabled</b> field that is
returned under the <b>FeatureDefinitions</b> container of the
<b>GetCategoryFeatures</b> response (as long as
'CrossBorderTradeEnabled' is included as a <b>FeatureID</b> value in
the call request or no <b>FeatureID</b> values are passed into the call
request). This field is returned as an
empty element (a boolean value is not returned) if one or more eBay API-enabled sites
support Cross Border Trade listings on the eBay UK and eBay Ireland sites.
<br/><br/>
To verify if a specific eBay site supports Cross Border Trade listings on the eBay UK and eBay Ireland sites (for most
categories), look for a 'true' value in the
<b>SiteDefaults.CrossBorderTradeGBEnabled</b> field.
<br/><br/>
To verify if a specific category on a specific eBay site supports Cross Border Trade listings on the eBay UK and eBay Ireland sites, pass in a <b>CategoryID</b> value in the request, and then
look for a 'true' value in the <b>CrossBorderTradeGBEnabled</b> field
of the corresponding Category node (match up the <b>CategoryID</b> values
if more than one Category IDs were passed in the request).
Type defining the <b>CrossBorderTradeNorthAmericaEnabled</b> field that is
returned under the <b>FeatureDefinitions</b> container of the
<b>GetCategoryFeatures</b> response (as long as
'CrossBorderTradeEnabled' is included as a <b>FeatureID</b> value in
the call request or no <b>FeatureID</b> values are passed into the call
request). This field is returned as an
empty element (a boolean value is not returned) if one or more eBay API-enabled sites
support Cross Border Trade listings on the eBay US and eBay Canada sites.
<br/><br/>
To verify if a specific eBay site supports Cross Border Trade listings on the eBay US and eBay Canada sites (for most
categories), look for a 'true' value in the
<b>SiteDefaults.CrossBorderTradeNorthAmericaEnabled</b> field.
<br/><br/>
To verify if a specific category on a specific eBay site supports Cross Border Trade listings on the eBay US and eBay Canada sites, pass in a <b>CategoryID</b> value in the request, and then
look for a 'true' value in the <b>CrossBorderTradeNorthAmericaEnabled</b> field
of the corresponding Category node (match up the <b>CategoryID</b> values
if more than one Category IDs were passed in the request).
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 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 field is deprecated.
This field is deprecated.
This enumeration type contains a list of standard 3-digit ISO 4217 currency codes for
currency used in countries around the world.
<br/><br/>
When adding an item through <b>AddItem</b> (or related API call), the
<b>Item.Currency</b> value will default to the currency used on the listing
site. Otherwise, only the following currency types may be specified through an
Add/Revise/Relist call, since these are the currencies of all the countries where
the Trading API is supported:
<ul>
<li>USD - US Dollar</li>
<li>CAD - Canadian Dollar</li>
<li>GBP - British Pound</li>
<li>AUD - Australian Dollar</li>
<li>EUR - Euro</li>
<li>CHF - Swiss Franc</li>
<li>CNY - Chinese Renminbi</li>
<li>HKD - Hong Kong Dollar</li>
<li>PHP - Philippines Peso</li>
<li>PLN - Polish Zloty</li>
<li>SEK - Sweden Krona</li>
<li>SGD - Singapore Dollar</li>
<li>TWD - Taiwanese Dollar</li>
<li>MYR - Malaysian Ringgit</li>
</ul>
<br/>
Other currency codes in this enumerated type may be returned in
<b>GetItem</b> (and other calls) based on the buyer's and/or seller's
registration country. However, only the values listed above will be returned if you
call <b>GeteBayDetails</b> with <b>DetailName</b> set to
<b>CurrencyDetails</b>.
http://www.xe.com/iso4217.htm
This value is a 3-digit code for an Afghan afghani, a currency used in Afghanistan.
This value is a 3-digit code for an Albanian lek, a currency used in Albania.
This value is a 3-digit code for an Algerian dinar, a currency used in Algeria.
This value is a 3-digit code for an Andorran peseta, a currency used in Andorra.
This value is a 3-digit code for an Angolan kwanza, a currency used in Angola.
This value is a 3-digit code for an Argentine peso, a currency used in Argentina.
This value is a 3-digit code for an Armenian dram, a currency used in Armenia.
This value is a 3-digit code for an Aruban florin, a currency used in Aruba.
This value is a 3-digit code for an Azerbaijani manat, a currency used in Azerbaijan.
This value is a 3-digit code for a Bahamian dollar, a currency used in the Bahamas.
This value is a 3-digit code for a Bahraini dinar, a currency used in the Bahrain.
This value is a 3-digit code for a Bangladeshi taka, a currency used in Bangladesh.
This value is a 3-digit code for a Barbados dollar, a currency used in Barbados.
This value is a 3-digit code for a Belarusian ruble, a currency used in Belarus.
This value is a 3-digit code for a Belize dollar, a currency used in Belize.
This value is a 3-digit code for a Bermudian dollar, a currency used in Bermuda.
This value is a 3-digit code for a Bhutanese ngultrum, a currency used in Bhutan.
This value is a 3-digit code for an Indian rupee, a currency used in India.
This value is a 3-digit code for a Bolivian Mvdol, a currency used in Bolivia.
This value is a 3-digit code for a Boliviano, a currency used in Bolivia.
This value is a 3-digit code for a Bosnia and Herzegovina convertible mark, a
currency used in Bosnia and Herzegovina.
This value is a 3-digit code for a Botswana pula, a currency used in Botswana.
This value is a 3-digit code for a Brazilian real, a currency used in Brazil.
This value is a 3-digit code for a Brunei dollar, a currency used in Brunei and
Singapore.
This value is a 3-digit code for the old Bulgarian lev, a currency previously used
in Bulgaria. This currency has been replaced by the new Bulgarian lev (3-digit
code: BGN).
This value is a 3-digit code for a Bulgarian lev, a currency used in Bulgaria. This
currency replaced the old Bulgarian lev (3-digit code: BGL).
This value is a 3-digit code for a Burundian franc, a currency used in Burundi.
This value is a 3-digit code for a Cambodian riel, a currency used in Cambodia.
This value is a 3-digit code for a Canadian dollar, a currency used in Canada. This is
the value that should be passed in the <b>Item.Currency</b> field by the
seller when listing an item on the eBay Canada site (Site ID 2).
This value is a 3-digit code for a Cape Verde escudo, a currency used in Cape
Verde.
This value is a 3-digit code for a Cayman Islands dollar, a currency used in
the Cayman Islands.
This value is a 3-digit code for a Central African CFA franc, a currency used in
Cameroon, Central African Republic, Republic of the Congo, Chad, Equatorial
Guinea, and Gabon.
This value is a 3-digit code for a Unidad de Fomento, a currency used in Chile.
This value is a 3-digit code for a Chilean peso, a currency used in Chile.
This value is a 3-digit code for a Chinese yuan (also known as the renminbi), a
currency used in China.
This value is a 3-digit code for a Columbian peso, a currency used in Columbia.
This value is a 3-digit code for a Comoro franc, a currency used in Comoros.
This value is a 3-digit code for a Congolese franc, a currency used in Democratic
Republic of Congo.
This value is a 3-digit code for a Costa Rican colon, a currency used in Costa
Rica.
This value is a 3-digit code for a Croatian kuna, a currency used in Croatia.
This value is a 3-digit code for a Cuban peso, a currency used in Cuba.
This value is a 3-digit code for a Cypriot pound, a currency previously used in
Cyprus. This currency has been replaced by the Euro (3-digit code: EUR).
This value is a 3-digit code for a Czech koruna, a currency used in the Czech
Republic.
This value is a 3-digit code for a Danish krone, a currency used in Denmark,
the Faroe Islands, and Greenland.
This value is a 3-digit code for a Djiboutian franc, a currency used in Djibouti.
This value is a 3-digit code for a Dominican peso, a currency used in the Dominican
Republic.
This value is a 3-digit code for a Portuguese Timorese escudo, a currency
previously used in Portuguese Timor.
This value is an old 3-digit code for a Cape Verde escudo, a currency used in
Cape Verde. The 'ECV' code has been replaced by 'CVE'.
This value is a 3-digit code for an Ecuadorian sucre, a currency previously used in
Ecuador. This currency has been replaced by the US Dollar (3-digit code: USD).
This value is a 3-digit code for an Egyptian pound, a currency used in Egypt.
This value is a 3-digit code for a Salvadoran colon, a currency previously used in
El Salvador. This currency has been replaced by the US Dollar (3-digit code: USD).
This value is a 3-digit code for an Eritrean nakfa, a currency used in Eritrea.
This value is a 3-digit code for an Estonian kroon, a currency previously used in
Estonia. This currency has been replaced by the Euro (3-digit code: EUR).
This value is a 3-digit code for an Ethiopian birr, a currency used in Ethiopia.
This value is a 3-digit code for a Falkland Islands pound, a currency used in
the Falkland Islands.
This value is a 3-digit code for a Fiji dollar, a currency used in Fiji.
This value is a 3-digit code for a Gambian dalasi, a currency used in Gambia.
This value is a 3-digit code for a Georgian Iari, a currency used in the country of
Georgia.
This value is an old 3-digit code for a Ghanaian cedi, a currency used in Ghana.
The 'GHC' code has been replaced by 'GHS'.
This value is a 3-digit code for a Gibraltar pound, a currency used in Gibraltar.
This value is a 3-digit code for a Guatemalan quetzal, a currency used in
Guatemala.
This value is a 3-digit code for a Guinean franc, a currency used in Guinea.
This value is a 3-digit code for a Guinea-Bissau peso, a currency previously used
in Guinea-Bissau. This currency has been replaced by the West African CFA franc
(3-digit code: XOF).
This value is a 3-digit code for a Guyanese dollar, a currency used in Guyana.
This value is a 3-digit code for a Haitian gourde, a currency used in Haiti.
This value is a 3-digit code for a Honduran lempira, a currency used in Honduras.
This value is a 3-digit code for a Hong Kong dollar, a currency used in Hong Kong
and Macau. This is the value that should be passed in the
<b>Item.Currency</b> field by the seller when listing an item on the
eBay Hong Kong site (Site ID 201).
This value is a 3-digit code for a Hungarian forint, a currency used in Hungary.
This value is a 3-digit code for an Icelandic krona, a currency used in Iceland.
This value is a 3-digit code for an Indonesian rupiah, a currency used in
Indonesia.
This value is a 3-digit code for an Iranian rial, a currency used in Iran.
This value is a 3-digit code for an Iraqi dinar, a currency used in Iraq.
This value is a 3-digit code for an Israeli new shekel, a currency used in
Israel and in the Palestinian territories.
This value is a 3-digit code for a Jamaican dollar, a currency used in Jamaica.
This value is a 3-digit code for a Japanese yen, a currency used in Japan.
This value is a 3-digit code for a Jordanian dinar, a currency used in Jordan.
This value is a 3-digit code for a Kazahhstani tenge, a currency used in
Kazakhstan.
This value is a 3-digit code for a Kenyan shilling, a currency used in Kenya.
This value is a 3-digit code for an Australia dollar, a currency used in Australia.
This is the value that should be passed in the <b>Item.Currency</b>
field by the seller when listing an item on the eBay Australia site
(Site ID 15).
This value is a 3-digit code for a North Korean won, a currency used in North
Korea.
This value is a 3-digit code for a South Korean won, a currency used in South
Korea.
This value is a 3-digit code for a Kuwaiti dollar, a currency used in Kuwait.
This value is a 3-digit code for a Kyrgzstani som, a currency used in Kyrgystan.
This value is a 3-digit code for a Lao kip, a currency used in Laos.
This value is a 3-digit code for a Latvian lats, a currency used in Latvia.
This value is a 3-digit code for a Lebanese pound, a currency used in Lebanon.
This value is a 3-digit code for a Lesotho loti, a currency used in Lesotho.
This value is a 3-digit code for a Liberian dollar, a currency used in Liberia.
This value is a 3-digit code for a Libyan dinar, a currency used in Libya.
Swiss Franc.
For eBay, you can only specify this currency for listings you submit to the
Switzerland site (site ID 193).
This value is a 3-digit code for a Lithuanian litas, a currency used in Lithuania.
This value is a 3-digit code for a Macanese pataca, a currency used in Macao.
This value is a 3-digit code for a Macedonian denar, a currency used in Macedonia.
This value is a 3-digit code for a Malagay franc, a currency previously used
in Madagascar. This currency has been replaced by the Malagasy ariary
(3-digit code: MGA).
This value is a 3-digit code for a Malawian kwacha, a currency used in Malawi.
This value is a 3-digit code for a Malaysian Ringgit, a currency used in Malaysia.
This is the value that should be passed in the <b>Item.Currency</b>
field by the seller when listing an item on the eBay Malaysia site
(Site ID 207).
This value is a 3-digit code for a Maldivian rufiyaaa, a currency used in the
Maldives.
This value is a 3-digit code for a Maltese lira, a currency previously used in
Malta. This currency has been replaced by the Euro (3-digit code: EUR).
This value is a 3-digit code for a EURO, a currency used in Andorra, Austria,
Belgium, Cyprus, Estonia, Finland, France, Germany, Greece, Ireland, Italy, Kosovo,
Luxembourg, Malta, Monaco, Montenegro, Netherlands, Portugal, San Marino, Slovakia,
Slovenia, Spain, and Vatican City. This is the value that should be passed in the
<b>Item.Currency</b> field by the seller when listing an item on the
following sites: Austria (Site ID 16), Belgium_French (Site ID 23),
France (Site ID 71), Germany (Site ID 77), Italy (Site ID 101), Belgium_Dutch (Site
ID 123), Netherlands (Site ID 146), Spain (Site ID 186), and Ireland (Site ID 205).
This value is a 3-digit code for a Mauritanian ouguiya, a currency used in
Mauritania.
This value is a 3-digit code for a Mauritian rupee, a currency used in
Mauritius.
This value is a 3-digit code for a Mexican peso, a currency used in
Mexico.
This value is a 3-digit funds code for a Mexican peso, a currency used in
Mexico.
This value is a 3-digit code for a Moldovan leu, a currency used in
Moldova.
This value is a 3-digit code for a Mongolian tugrik, a currency used in
Mongolia.
This value is a 3-digit code for an Easy Caribbean dollar, a currency used in
Anguilla, Antigua and Barbuda, Dominica, Grenada, Montserrat, Saint Kitts and
Nevis, Saint Lucia, and Saint Vincent and the Grenadines.
This value is an old 3-digit code for a Mozambican metical, a currency used in
Mozambique. The 'MZM' code has been replaced by 'MZN'.
This value is a 3-digit code for a Myanma kyat, a currency used in
Myanmar.
This value is a 3-digit code for a South African rand, a currency used in
South Africa.
This value is a 3-digit code for a Namibian dollar, a currency used in
Namibia.
This value is a 3-digit code for a Nepalese rupee, a currency used in Nepal.
This value is a 3-digit code for a Netherlands Antillean guilder, a currency used
in Curacao and Sint Maarten.
This value is a 3-digit code for a CFP franc, a currency used in French Polynesia,
New Caledonia, and Wallis and Futuna.
This value is a 3-digit code for a New Zealand dollar, a currency used in the
Cook Islands, New Zealand, Niue, Pitcairn, and Tokelau, Ross Dependency.
This value is a 3-digit code for a Nicaraguan cordoba, a currency used in
Nicaragua.
This value is a 3-digit code for a Nigerian naira, a currency used in Nigeria.
This value is a 3-digit code for a Norwegian kron, a currency used in Norway,
Svalbard, Jan Mayen, Bouvet Island, Queen Maud Land, and Peter I Island.
This value is a 3-digit code for an Omani rial, a currency used in Oman.
This value is a 3-digit code for a Pakistani rupee, a currency used in Pakistan.
This value is a 3-digit code for a Panamanian balboa, a currency used in Panama.
This value is a 3-digit code for a Papua New Guinea kina, a currency used in
Papua New Guinea.
This value is a 3-digit code for a Paraguayan guarani, a currency used in
Paraguay.
This value is a 3-digit code for a Peruvian nuevo sol, a currency used in Peru.
This value is a 3-digit code for a Philippine peso, a currency used in the
Philippines. This is the value that should be passed in the
<b>Item.Currency</b> field by the seller when listing an item on the
eBay Philippines site (Site ID 211).
This value is a 3-digit code for a Polish zloty, a currency used in Poland. This
is the value that should be passed in the <b>Item.Currency</b> field
by the seller when listing an item on the eBay Poland site (Site ID 212).
This value is a 3-digit code for a US dollar, a currency used in the United
States, America Samoa, Barbados, Bermuda, British Indian Ocean Territory, British
Virgin Islands, Caribbean Netherlands, Ecuador, El Salvador, Guam, Haiti, Marshall
Islands, Federated States of Micronesia, Northern Mariana Islands, Palau, Panama,
Puerto Rico, Timor-Leste, Turks and Caicos Islands, US Virgin Islands, and
Zimbabwe. This is the value that should be passed in the
<b>Item.Currency</b> field by the seller when listing an item on the
eBay US or US eBay Motors site (Site ID 0).
This value is a 3-digit code for a Qatari riyal, a currency used in Qatar.
This value is a 3-digit code for the old Romanian leu, a currency previously used
in Romania. This currency has been replaced by the Romanian new leu (3-digit code:
RON).
This value is a 3-digit code for a Russian rouble, a currency used in Russia,
Abkhazia, and South Ossetia. This value replace the old 3-digit code for the
Russian rouble, 'RUR'.
This value is the old 3-digit code for a Russian rouble, a currency used in
Russia. This value was replaced by the new 3-digit code for the Russian rouble,
'RUB'.
This value is a 3-digit code for a Rwandan franc, a currency used in Rwanda.
This value is a 3-digit code for a Saint Helena pound, a currency used in Saint
Helena.
This value is a 3-digit code for a Samoan tala, a currency used in Samoa.
This value is a 3-digit code for a Sao Tome and Principe dobra, a currency used in
Sao Tome and Principe.
This value is a 3-digit code for a Saudi riyal, a currency used in Saudi Arabia.
This value is a 3-digit code for a Seychelles rupee, a currency used in Seychelles.
This value is a 3-digit code for a Sierra Leonean leone, a currency used in Sierra
Leone.
This value is a 3-digit code for a Singapore dollar, a currency used in Singapore
and Brunei. This is the value that should be passed in the
<b>Item.Currency</b> field by the seller when listing an item on the
eBay Singapore site (Site ID 216).
This value is a 3-digit code for a Slovak koruna, a currency previously used in
Slovakia. This currency has been replaced by the Euro (3-digit code: EUR).
This value is a 3-digit code for a Slovenian tolar, a currency previously used in
Slovenia. This currency has been replaced by the Euro (3-digit code: EUR).
This value is a 3-digit code for a Solomon Islands dollar, a currency used in
the Solomon Islands.
This value is a 3-digit code for a Somali shilling, a currency used in Somalia.
This value is a 3-digit code for a Sri Lankan rupee, a currency used in Sri Lanka.
This value is the 3-digit code for a Sudanese dinar, a currency previously used in
Sudan. The Sudanese dinar was replaced by the Sudanese pound, which has a 3-digit
code of 'SDG'.
This value is the 3-digit code for a Suriname guilder, a currency previously used
in Suriname. The Surinam guilder was replaced by the Surinamese dollar, which has
a 3-digit code of 'SRD'.
This value is a 3-digit code for a Swazi lilangeni, a currency used in Swaziland.
This value is a 3-digit code for a Swedish krona, a currency used in Swedn. This
is the value that should be passed in the <b>Item.Currency</b> field
by the seller when listing an item on the eBay Sweden site (Site ID 218).
This value is a 3-digit code for a Syrian pound, a currency used in Syria.
This value is a 3-digit code for the New Taiwan dollar, a currency used in Taiwan.
This value is a 3-digit code for a Tajikistani somoni, a currency used in
Tajikistan.
This value is a 3-digit code for a Tanzanian shilling, a currency used in
Tanzania.
This value is a 3-digit code for a Thai baht, a currency used in Thailand.
This value is a 3-digit code for a West African CFA franc, a currency used in
Benin, Burkina Faso, Cote d'Ivoire, Guinea-Bissau, Mali, Niger, Senegal, and
Togo.
This value is a 3-digit code for a Tongan pa'anga, a currency used in Tonga.
This value is a 3-digit code for a Trinidad and Tobago dollar, a currency used in
Trinidad and Tobago.
This value is a 3-digit code for a Tunisian dinar, a currency used in Tunisia.
This value is the old 3-digit code for a Turkish lira, a currency used in Turkey
and Northern Cyprus. This value was replaced by the new 3-digit code for the
Turkish lira, 'TRY'.
This value is the old 3-digit code for a Turkmenistani manat, a currency used in
Turkmenistan. This value was replaced by the new 3-digit code for
the Turkmenistani manat, 'TMT'.
This value is a 3-digit code for a Ugandan shilling, a currency used in Uganda.
This value is a 3-digit code for a Ukrainian hryvnia, a currency used in the
Ukraine.
This value is a 3-digit code for an United Arab Emirates dirham, a currency used
in the United Arab Emirates.
This value is a 3-digit code for a Pound sterling, a currency used in the United
Kingdom and British Crown dependencies. This is the value that should be passed in
the <b>Item.Currency</b> field by the seller when listing an item on
the eBay UK site (Site ID 3).
This value is a 3-digit code for a same-day transaction involving US dollars.
This value is a 3-digit code for a next-day transaction involving US dollars.
This value is a 3-digit code for a Uruguayan peso, a currency used in Uruguay.
This value is a 3-digit code for a Uzbekistan som, a currency used in the
Uzbekistan.
This value is a 3-digit code for a Vanuatu vatu, a currency used in Vanuatu.
This value is a 3-digit code for a Venezuelan bolivar, a currency previously used
in Venezuela. The Venezuela bolivar was replaced by the Venezuelan bolivar
fuerte, which has a 3-digit code of 'VEF'.
This value is a 3-digit code for a Vietnamese dong, a currency used in Vietnam.
This value is a 3-digit code for a Moroccan dirham, a currency used in Morocco.
This value is a 3-digit code for a Yemeni rial, a currency used in Yemen.
This value is a 3-digit code for a Yugoslav dinar, a currency previously used in
Yugoslavia. The Yugoslav dinar was replaced by the Serbian dinar, which has a 3-
digit code of 'RSD'.
This value is the old 3-digit code for a Zambian kwacha, a currency used in
Zambia. The 'ZMK' code has been replaced by 'ZMW'.
This value is the old 3-digit code for a Zimbabwean dollar, a currency previously
used in Zimbabwe. The US dollar replaced the Zimbabwean dollar as the official
currency in Zimbabwe.
This value is a 3-digit code for an Austrian schilling, a currency previously used
in Austria. This currency has been replaced by the Euro (3-digit code: EUR).
Reserved for internal or future use.
Type defining the <b>CurrencyDetails</b> container that is returned in the <b>GeteBayDetails</b> response if 'CurrencyDetails' is used as a <b>DetailName</b> value in the request, or no <b>DetailName</b> values are used in the request. A <b>CurrencyDetails</b> container is returned for each currency value that is available to use in the <b>Item.Currency</b> field in an Add/Revise/Relist call.
Three-digit currency codes as defined in ISO 4217. The currency codes returned in
<b>GeteBayDetails</b> can be used as values in the
<b>Currency</b> field of the Add/Revise/Relist and other Trading API
calls.
Item.Currency
AddItem.html#Request.Item.Currency
Item.StartPrice
AddItem.html#Request.Item.StartPrice
GeteBayDetails
Conditionally
Full currency name for display purposes.
GeteBayDetails
Conditionally
Returns the latest version number for this field. The version can be used
to determine if and when to refresh cached client data.
GeteBayDetails
DetailLevel: none, ReturnSummary, ReturnAll
Always
Gives the time in GMT that the feature flags for the
details were last updated. This timestamp can be used to determine if
and when to refresh cached client data.
GeteBayDetails
DetailLevel: none, ReturnSummary, ReturnAll
Always
This type is deprecated.
773
Avoid
FindProducts (Shopping API)
889
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 field is deprecated.
This field is deprecated.
Defines year, month, and day as individual components of a date.
Only applicable to use cases that support incomplete dates.
Otherwise, we use xs:dateTime (or xs:date, as appropriate).
A year in the form YYYY.
A calendar month (e.g., 2 or 02 for February).
For ticket searches, Month is required if
Day is specified.
A calendar day (e.g., 2 or 02). For ticket searches,
Day is only valid if Month is also specified.
Enumerated type that consists of all days of the week.
This enumeration value indicates the day of the week is Sunday.
This enumeration value indicates the day of the week is Monday.
This enumeration value indicates the day of the week is Tuesday.
This enumeration value indicates the day of the week is Wednesday.
This enumeration value indicates the day of the week is Thursday.
This enumeration value indicates the day of the week is Friday.
This enumeration value indicates the day of the week is Saturday.
Reserved for internal or future use.
Specifies the range of days the seller can be contacted.
Seller does not want to be contacted. Contact hours will not be supported for
any days. If contact hours are specified, they will be ignored.
Seller can be contacted any day during the specified contact hours.
Seller can be contacted Monday through Friday during the specified
contact hours.
Seller can be contacted Saturday or Sunday during the specified
contact hours.
(out) Reserved for internal or future use.
This type is used by the <b>DeliveryDetails</b> container that is returned by <b>GetOrders</b> and other order management calls. The <b>DeliveryDetails</b> container is only applicable and returned if the buyer purchased a digital gift card, and is either keeping the gift card or giving that gift card to another person.
This container consists of the name and email of the person who is receiving the digital gift card. If the buyer has purchased the gift card for themselves, the buyer's name and email will appear in this container. If the buyer is giving the gift card to another individual, that individual's name and email will appear in this container. This container is always returned for a digital gift card line item.
<br><br>
<b>For GetOrders, GetOrderTransactions, and GetItemTransactions only:</b> If using Trading WSDL Version 1019 or above, this container will only be returned to the buyer or seller, and no longer returned at all to third parties. If using a Trading WSDL older than Version 1019, real data is only returned to the buyer or seller, and dummy/masked data will be returned to all third parties.
GetOrders
DetailLevel: none, ReturnAll
Conditionally
OrderReport
Conditionally
GetOrderTransactions
DetailLevel: none, ReturnAll
Conditionally
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
This container consists of the name and email of the person who purchased the digital gift card. This container is only returned if the purchaser of the digital gift card is giving the gift card to someone else, and that individual's name and email will appear in the <strong>Recipient</strong> container.
<br><br>
<b>For GetOrders, GetOrderTransactions, and GetItemTransactions only:</b> If using Trading WSDL Version 1019 or above, this container will only be returned to the buyer or seller, and no longer returned at all to third parties. If using a Trading WSDL older than Version 1019, real data is only returned to the buyer or seller, and dummy/masked data will be returned to all third parties.
GetOrders
DetailLevel: none, ReturnAll
Conditionally
OrderReport
Conditionally
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
This enumeration type lists the possible delivery methods of a digital gift card. Currently, the only supported delivery method is by email.
This value indicates that the link to download the digital gift card will be delivered to the recipient by email.
This value is reserved for internal or future use.
This enumeration type lists the possible delivery status values of a digital gift card. Currently, the only supported delivery status value is 'Notified', which indicates that the link to download the digital gift card has been sent to the recipient by email.
This value indicates that the link to download the digital gift card has been sent to the recipient by email.
This value is reserved for internal or future use.
This type is used by the <b>DeliveryStatus</b> container, which will list the current status of whatever delivery method is being used (indicated in the <b>DigitalDeliverySelected.DeliveryMethod</b> field). Currently, the only supported delivery method is by email.
This value indicates the current delivery status for the digital gift card that is being delivered by email. Currently, the only supported delivery status value is 'Notified', which indicates that the link to download the digital gift card has been sent to the recipient by email.
DeliveryStatusEmailCodeType
GetOrders
DetailLevel: none, ReturnAll
Conditionally
OrderReport
Conditionally
GetOrderTransactions
DetailLevel: none, ReturnAll
Conditionally
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
Defines settings for a notification URL (including the URL name in DeliveryURLName).
The name of a notification delivery URL. You can list up to 25 instances of
DeliveryURLName, and then subscribe these URLs to notifications by listing them in comma-
separated format in the DeliveryURLName element outside of
ApplicationDeliveryPreferences.
GetNotificationPreferences
Conditionally
SetNotificationPreferences
No
The address of a notification delivery URL.
This address applies to the DeliveryURLName
within the same
ApplicationDeliveryPreferences.DeliveryURLDetails container.
For delivery to a server, the URL
begins with http:// or https:// and must be well
formed. Use a URL that is functional at the time of the
call. For delivery to an email address, the URL begins
with mailto: and specifies a valid email address.
SetNotificationPreferences
No
GetNotificationPreferences
Conditionally
The status of a notification delivery URL.
This status applies to the DeliveryURLName and delivery URL
within the same ApplicationDeliveryPreferences.DeliveryURLDetails container.
If the status is disabled, then notifications will not be sent to the delivery URL.
GetNotificationPreferences
Conditionally
SetNotificationPreferences
No
If present, the site defines category settings for whether the seller can specify a vehicle deposit for US eBay Motors listings.
For vehicles listed through the US eBay Motors site, DepositType
indicates how the buyer should pay the deposit amount. It is
used in conjunction with a buyer payment method (BuyerPaymentMethodCodeType).
(out) No deposit needed.
(out) Pay the deposit using PayPal, and then
use any of the other specified payment methods to pay the balance.
(out) No longer used.
(out) Reserved for internal or future use
Enumerated type containing the list of values that can be used when revising the
item description of an active listing through the Revise API calls.
Use this value in the <b>Item.DescriptionReviseMode</b> field if you want
to completely replace (overwrite) the item description of the active listing.
Use this value in the <b>Item.DescriptionReviseMode</b> field if you want
to prepend text to the item description of the active listing.
Use this value in the <b>Item.DescriptionReviseMode</b> field if you want
to append text to the item description of the active listing.
This value is reserved for internal or future use.
Enumerated type that defines Listing Designer template types.
This value indicates that the Listing Designer template is a layout template that controls how pictures and description text are
positioned on the View Item page.
This value indicates that the Listing Designer template is a theme template that determines which eBay-provided theme (e.g. Valentine's Day) is to be applied for presenting pictures and description text.
Reserved for future use.
Type that provides detailed information on a Listing Designer Theme or Layout.
This integer value is a unique identifier for the Listing Designer Theme group, such as Holiday/Seasonal, Special Events, or Patterns/Textures. This field is not applicable and will not be returned for a Listing Designer Layout.
GetDescriptionTemplates
Conditionally
This integer value is a unique identifier of the Listing Designer Theme or Layout.
GetDescriptionTemplates
Always
This URL is the path to a small image providing a sample of the appearance of a Listing Designer Theme or Layout.
GetDescriptionTemplates
Always
This string value is the name of the Listing Designer Theme or Layout.
GetDescriptionTemplates
Always
This string value is actually a CDATA representation of the Listing Designer template. Image-related elements in a template include <code>ThemeTop</code>, <code>ThemeUserCellTop</code>, <code>ThemeUserContent,</code>, <code>ThemeUserCellBottom</code>, and <code>ThemeBottom</code>. This field is not applicable and will not be returned for a Listing Designer Layout.
GetDescriptionTemplates
Conditionally
This enumeration value indicates that the information returned under the <b>DescriptionTemplate</b> container is related to a Listing Designer Theme or Layout.
GetDescriptionTemplates
Always
This enumerated type contains all data filters that can be used to control which metadata is returned in the response of a <b>GeteBayDetails</b> call. The user can use as little or as many values as desired. If none of these data filters are used, all applicable metadata will be returned.
UnitOfMeasurementDetails
This enumeration value can be included in a <b>DetailName</b> field if the user wishes to retrieve the two-digit country codes for all countries of the world. Among other things, the two-digit country codes can be used when a seller is creating a 'ship-to' and/or an 'exclude ship-to' location list.
<br/><br/>
The same <b>CountryDetails</b> metadata will be returned regardless of the value that is passed into the <b>X-EBAY-API-SITEID</b> request header.
This enumeration value can be included in a <b>DetailName</b> field if the user wishes to retrieve the three-digit currency codes for each country where the Trading API is supported. These three-digit currency codes are used when a seller is expressing a dollar value in Trading API calls. For example, the <b>currencyID</b> attribute value in the <b>StartPrice</b> field of an <b>AddItem</b> call.
<br/><br/>
The same <b>CurrencyDetails</b> metadata will be returned regardless of the value that is passed into the <b>X-EBAY-API-SITEID</b> request header.
This enumeration value can be included in a <b>DetailName</b> field if the user wishes to retrieve all payment methods that are accepted on the specified eBay site. Note that the accepted payment methods within an eBay site can vary by category and/or by listing format, so a user may also want to make a <b>GetCategoryFeatures</b> call to retrieve category-level payment method metadata. To retrieve the accepted payment methods for a specific category on a specific site with <b>GetCategoryFeatures</b>, the user specifies the listing category ID through the <b>CategoryID</b>, and sets the <b>FeatureID</b> value to <code>PaymentMethods</code>.
This enumeration value can be included in a <b>DetailName</b> field if the user wishes to retrieve the local regions within the specified country.
This enumeration value can be included in a <b>DetailName</b> field if the user wishes to retrieve the geographical regions and country codes that can be used when creating a 'ship-to' location list.
This enumeration value can be included in a <b>DetailName</b> field if the user wishes to retrieve the domestic and international shipping service options available on the specified eBay site. The returned metadata on each available shipping service will include the full name of the shipping service option (including carrier name), the actual shipping service enumeration value that will be used in an <b>AddItem</b> call, the expected shipping time range, the package types that can be used for that shipping service, and whether the shipping service is for domestic or international shipping. In addition to this information, the seller will have to look for a value of <code>true</code> in the <b>ValidForSellingFlow</b> field. If the value in this field is <code>false</code>, it indicates that the shipping service is no longer available for shipping.
This enumeration value can be included in a <b>DetailName</b> field if the user wishes to retrieve the eBay sites that are supported in Trading API calls. The <b>SiteID</b> values that are returned for each country are specified as an HTTP header if the seller wants to see site metadata returned for that particular site.
<br/><br/>
The same <b>SiteDetails</b> metadata will be returned regardless of the value that is passed into the <b>X-EBAY-API-SITEID</b> request header.
This enumeration value can be included in a <b>DetailName</b> field if the user wishes to retrieve the different tax jurisdictions (such as states or provinces) within the specified eBay site. The two-digit <b>JurisdictionID</b> codes that are returned are used when a seller is setting/configuring sales tax rates in a Sales Tax Table, or when creating a listing. For example, the <b>SalesTax.SalesTaxState</b> field of an <b>AddItem</b> call.
<br/><br/>
Sales tax jurisdictions are only applicable to the US and Canada, so the <b>TaxJurisdiction</b> metadata will only be returned for these sites:
<ul>
<li><b>eBay US<b>: <b>SiteID</b> <code>0</code></li>
<li><b>eBay Motors (US)<b>: <b>SiteID</b> <code>100</code></li>
<li><b>eBay Canada (English language)<b>: <b>SiteID</b> <code>2</code></li>
<li><b>eBay Canada (French language)<b>: <b>SiteID</b> <code>210</code></li>
</ul>
This enumeration value can be included in a <b>DetailName</b> field if the user wishes to retrieve the different eBay URLs associated with the specified eBay site.
This enumeration value can be included in a <b>DetailName</b> field if the user wishes to retrieve the names of the different global time zones. The returned information includes the number of hours that each time zone is either ahead or behind UTC time, and it also indicates if the time zone participates in 'Daylight Savings'.
<br/><br/>
The same <b>TimeZoneDetails</b> metadata will be returned regardless of the value that is passed into the <b>X-EBAY-API-SITEID</b> request header, although the metadata text will be localized for that site's language.
This enumeration value can be included in a <b>DetailName</b> field if the user wishes to retrieve the international regions and individual countries.
<br/><br/>
The same <b>RegionOfOriginDetails</b> metadata will be returned regardless of the value that is passed into the <b>X-EBAY-API-SITEID</b> request header.
This enumeration value can be included in a <b>DetailName</b> field if the user wishes to retrieve the handling time values (in number of business days) that the seller can set on a listing. The seller must ship an order line item within this time or risk getting a seller defect. For the US, the supported handling times are 0-3 days. Some listing categories support 'extended handling' time, and if this is the case, the handling times will be longer, and the <b>ExtendedHandling</b> field will be returned as <code>true</code>.
This enumeration value can be included in a <b>DetailName</b> field if the user wishes to retrieve the maximum thresholds for Item Specifics in listings. These thresholds include the maximum number of item specifics that can be used for an item (or item variation), as well as the maximum number of characters that can be used for Item Specific names and values.
This enumeration value is no longer applicable, and should not be used.
This enumeration value can be included in a <b>DetailName</b> field if the user wishes to retrieve the shipping package types that are supported by the specified eBay site. A seller can also just use the <b>ShippingServiceDetails</b> filter, and the supported shipping package types for each shipping service option will be returned.
Reserved for future use.
This enumeration value can be included in a <b>DetailName</b> field if the user wishes to retrieve the shipping carriers supported by the specified eBay site for domestic and international shipping.
This enumeration value can be included in a <b>DetailName</b> field if the user wishes to retrieve the minimum starting prices for each applicable listing format for the specified eBay site. The price input into the <b>StartPrice</b> field of an <b>AddItem</b> call must be at or above this minimum threshold value or the listing will be blocked.
This enumeration value can be included in a <b>DetailName</b> field if the user wishes to retrieve the return policy values that can be passed in through the <b>ReturnPolicy</b> container of an Add/Revise/Relist API call (or in a Return business policy). These values include the return period, the 'Money back' options that the seller can make available to the buyers, and who pays for return shipping (Buyer or Seller).
<br><br>
<span class="tablenote"><b>Note:</b> As of September 2018, the <b>GetCategoryFeatures</b> call started returning category-level metadata for both domestic and international return policies. Due to this update, developers may want to consider using that call for return policy metadata instead, as the <b>GeteBayDetails</b> call only retrieves site-level metadata, and does not distinguish between domestic and international metadata.</span>
This enumeration value can be included in a <b>DetailName</b> field if the user wishes to retrieve the Buyer Requirement values that can be passed in through the <b>BuyerRequirementDetails</b> container of an Add/Revise/Relist API call.
This enumeration value can be included in a <b>DetailName</b> field if the user wishes to retrieve the listing features/upgrades that are enabled or disabled for the specified site.
This enumeration value can be included in a <b>DetailName</b> field if the user wishes to retrieve the maximum thresholds when using multiple-variation listings.
This enumeration value can be included in a <b>DetailName</b> field if the user wishes to retrieve the geographical regions and individual countries that can be passed in to the <b>ShippingDetails.ExcludeShipToLocation</b> field in an Add/Revise/Relist API call. Multiple <b>ShippingDetails.ExcludeShipToLocation</b> can be used, and any region or country value that is passed in to one of these fields will exclude that region or country as a "ship-to" location.
This enumeration value can be included in a <b>DetailName</b> field if the user wishes to retrieve details on a site's recoupment policy.
This enumeration value can be included in a <b>DetailName</b> field if the user wishes to retrieve the shipping service categories (Standard, Expedited, Economy, etc.) supported for the site.
This enumeration value can be included in a <b>DetailName</b> field if the user wishes to retrieve the appropriate text to insert into a product identifier field (EAN, ISBN, UPC, MPN/Brand) if eBay is prompting/expecting one of these fields in the call request, but the identifiers do not exist/apply for the product. The <b>ProductDetails.ProductIdentifierUnavailableText</b> field that is returned in the response will contain the actual text that should be passed into the relevant product identification fields when creating a listing.
This enumerated type is a list of the systems used to deliver buyer/seller notifications.
This enumeration value indicates that buyer/seller notifications will be delivered through the Platform Notifications system.
This enumeration value indicates that buyer/seller notifications will be delivered through the SMS system to a wireless device.
This enumeration value indicates that buyer/seller notifications will be delivered through the Client Alerts system.
Reserved for internal or future use.
This type is used by the <b>DigitalDeliverySelected</b> container that is returned by <b>GetOrders</b> and other order management calls. The <b>DigitalDeliverySelected</b> container is only applicable and returned if the buyer purchased a digital gift card for themselves, or is giving the digital gift card to someone else as a gift.
This value indicates the method in which the digital gift card will be delivered to the buyer or to the person whom the purchaser is giving the digital gift card to. Currently, the only supported delivery method is by email.
DeliveryMethodCodeType
GetOrders
DetailLevel: none, ReturnAll
Conditionally
OrderReport
Conditionally
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
This container consists of the current status of whatever delivery method is being used (indicated in the <b>DigitalDeliverySelected.DeliveryMethod</b> field). Currently, the only supported delivery method is by email.
GetOrders
DetailLevel: none, ReturnAll
Conditionally
OrderReport
Conditionally
GetOrderTransactions
DetailLevel: none, ReturnAll
Conditionally
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ReturnAll
Conditionally
This container is returned by <b>GetOrders</b> and other order management calls to provide details on the recipient of a digital gift card that was purchased. The <b>DeliveryDetails</b> container is only returned if the buyer is buying a digital gift card and giving that gift card to another person.
GetOrders
DetailLevel: none, ReturnAll
Conditionally
OrderReport
Conditionally
GetOrderTransactions
DetailLevel: none, ReturnAll
Conditionally
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ReturnAll
Conditionally
This type is used to provide the name and email of both the purchaser of a digital gift card, and the recipient of the digital gift card.
This field displays the actual name (not the eBay user ID) of the sender/purchaser of the digital gift card (applicable for the <strong>Sender</strong> container) or the actual name of the recipient of the digital gift card (applicable for the <strong>Recipient</strong> container). Both the sender and recipient name is provided by the purchaser of the digital gift card at time of purchase.
<br><br>
<b>For GetItemTransactions only:</b> If using Trading WSDL Version 1019 or above, this field will only be returned to the buyer or seller, and no longer returned at all to third parties. If using a Trading WSDL older than Version 1019, real data is only returned to the buyer or seller, and a string value of <code>Unavailable</code> will be returned to all third parties.
GetOrders
DetailLevel: none, ReturnAll
Conditionally
OrderReport
Conditionally
GetOrderTransactions
DetailLevel: none, ReturnAll
Conditionally
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ReturnAll
Conditionally
This field displays the email address of the sender/purchaser of the digital gift card (applicable for the <strong>Sender</strong> container) or the email address of the recipient of the digital gift card (applicable for the <strong>Recipient</strong> container). Both the sender and recipient email address is provided by the purchaser of the digital gift card at time of purchase.
<br><br>
<b>For GetItemTransactions only:</b> If using Trading WSDL Version 1019 or above, this field will only be returned to the buyer or seller, and no longer returned at all to third parties. If using a Trading WSDL older than Version 1019, real data is only returned to the buyer or seller, and a string value of <code>Unavailable</code> will be returned to all third parties.
GetOrders
DetailLevel: none, ReturnAll
Conditionally
OrderReport
Conditionally
GetOrderTransactions
DetailLevel: none, ReturnAll
Conditionally
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ReturnAll
Conditionally
Type defining the <b>DigitalGoodDeliveryEnabled</b> field that is returned under the <b>FeatureDefinitions</b> container of the <b>GetCategoryFeatures</b> response (as long as <b>DigitalGoodDeliveryEnabled</b> is included as a <b>FeatureID</b> value in the call request or no <b>FeatureID</b> values are passed into the call request). The <b>DigitalGoodDeliveryEnabled</b> field is returned as an empty element (a boolean value is not returned) if one or more eBay API-enabled sites support digital gift card listings.
<br><br>
To verify if a specific eBay site supports digital gift card listings (for most categories), look for a <code>true</code> value in the <b>SiteDefaults.DigitalGoodDeliveryEnabled</b> field.
<br><br>
To verify if a specific category on a specific eBay site supports digital gift card listings, pass in a <b>DigitalGoodDeliveryEnabled</b> value in the request, and then look for a <code>true</code> value in the <b>DigitalGoodDeliveryEnabled</b> field of the corresponding <b>Category</b> node (match up the <b>CategoryID</b> values if more than one category ID was passed in the request).
This type is used by the <b>DigitalGoodInfo</b> container, which is used in <b>Add</b>/<b>Relist</b>/<b>Revise</b>/<b>Verify</b> listing calls to designate the listing as a digital gift card listing.
This field must be included in the request and set to <code>true</code> if the seller plans to list a digital gift card in a category that supports digital gift cards.
<br><br>
To verify if a specific category on a specific eBay site supports digital gift card listings, use the <a href="http://developer.ebay.com/DevZone/XML/docs/Reference/eBay/GetCategoryFeatures.html">GetCategoryFeatures</a> call, passing in a <b>CategoryID</b> value and a <b>DigitalGoodDeliveryEnabled</b> value in the <b>FeatureID</b> field. Look for a <code>true</code> value in the <b>DigitalGoodDeliveryEnabled</b> field of the corresponding <b>Category</b> node (match up the <b>CategoryID</b> values if more than one Category IDs were passed in the request).
AddFixedPriceItem
AddItem
AddItems
RelistFixedPriceItem
RelistItem
ReviseFixedPriceItem
ReviseItem
VerifyAddItem
VerifyAddFixedPriceItem
VerifyRelistItem
No
GetItem
Conditionally
This enumeration type lists the possible states of a purchased digital delivery card.
This enumeration value indicates that the digital gift card has yet to be activated by the buyer or recipient of gift card.
This enumeration value indicates that the digital gift card has been activated by the buyer or recipient of gift card.
This enumeration value indicates that the digital gift card has been downloaded by the buyer or recipient of gift card. The next step would be to activate the gift card.
This enumeration value indicates that the digital gift card has been deactivated.
This value is reserved for internal or future use.
This enumerated type is used to specify if the discount used for a promotional sale is a price (dollar value) discount or a percentage (of sale price) discount.
The enumeration value indicates that the discount being offered is a percentage discount, which means a percentage of the total price to the buyer is being discounted. So, if the total price for an order line item is $100, the <b>DiscountType</b> is <code>Percentage</code>, and the <b>DiscountValue</b> is <code>15.0</code> (percent), the buyer will pay just $85.00 for the order line item.
The enumeration value indicates that the discount being offered is a price discount, which means the total price to the buyer is being reduced by this amount. So, if the total price for an order line item is $100, the <b>DiscountType</b> is <code>Price</code>, and the <b>DiscountValue</b> is <code>20.0</code> (dollars), the buyer will pay just $80.00 for the order line item.
This value is reserved for future use.
This enumerated type is used by the seller to set the shipping discount type. Some of these shipping discount types apply to flat-rate shipping and others apply to calculated shipping.
The cost to ship each item beyond the first item (where the item with the
highest shipping cost is selected by eBay as the first item).
Let's say the buyer purchases three items, each set to ship for $8, and
the seller set EachAdditionalAmount to $6. The cost to ship three items would
normally be $24, but since the seller specified $6, the total shipping
cost would be $8 + $6 + $6, or $20.
For flat shipping discount profile only.
The amount by which to reduce the cost to ship each item beyond the
first item (where the item with the highest shipping cost is selected by eBay
as the first item).
Let's say the buyer purchases three items, each set to ship for $8, and
the seller set EachAdditionalAmountOff to $2. The cost to ship three items would
normally be $24, but since the seller specified $2, the total shipping
cost would be $24 - (two additional items x $2), or $20.
For flat shipping discount profile only.
The percentage by which to reduce the cost to ship each item beyond
the first item (where the item with the highest shipping cost is selected by
eBay as the first item).
Let's say the buyer purchases three items, each set to ship for $8, and
the seller set EachAdditionalPercentOff to 0.25. The cost to ship three items would
normally be $24, but since the seller specified 0.25 ($2 out of 8), the total shipping
cost would be $24 - (two additional items x $2), or $20.
For flat rate shipping discount profile only.
Shipping cost is the total of what it would cost to ship each item individually.
This is simply a way to define how shipping is to be calculated--there is no
discount for the buyer with this selection.
For calculated shipping discount profile only.
Shipping cost is based on the total weight of all individual items.
This is simply a way to define how shipping is to be calculated--there is no
discount for the buyer with this selection.
For calculated shipping discount profile only.
The amount of weight to subtract for each item beyond the first item
before shipping costs are calculated. For example, there may be less packing
material when the items are combined in one box than if they were shipped
individually. Let's say the buyer purchases three items, each 10 oz. in weight, and
the seller set WeightOff to 2 oz. The combined weight would be 30 oz., but since
the seller specified 2 oz. off, the total weight for shipping cost calculation
would be 30 oz. - (two additional items x 2 oz.), or 26 oz.
For calculated shipping discount profile only.
Shipping cost X applies if the total cost of items purchased is Y.
For promotional discount only.
Shipping cost X applies if the total number of items purchased is N.
For promotional discount only.
The shipping cost will not exceed this.
For promotional discount only.
Reserved for internal or future use.
Using this container, a seller can supply original retail price and
discount price for an item to clarify the discount treatment (also known
as strike-through pricing). This only applies to fixed-price listings and auction listings with the Buy It Now
option. This feature is available for large enterprise sellers via
white list. A seller can provide discount treatment regardless of
whether the listing includes a SKU.
The actual retail price set by the manufacturer (OEM).
eBay does not maintain or validate the <b>OriginalRetailPrice</b> supplied
by the seller. <b>OriginalRetailPrice</b> should always be more than
<b>StartPrice</b>. Compare the <b>StartPrice</b>/<b>BuyItNowPrice</b> to
<b>OriginalRetailPrice</b> to determine the amount of savings to the buyer.
AddFixedPriceItem
ReviseFixedPriceItem
RelistFixedPriceItem
VerifyAddFixedPriceItem
Conditionally
AddItem
ReviseItem
RelistItem
VerifyAddItem
Conditionally
GetItem
Conditionally
DetailLevel: none, ItemReturnDescription,
ItemReturnAttributes, ReturnAll
GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
Conditionally
Minimum Advertised Price (MAP) is an agreement between suppliers (or
manufacturers (OEM)) and the retailers (sellers) stipulating
the lowest price an item is allowed to be advertised at.
Sellers can offer prices below MAP by means of other discounts.
This only applies to fixed-price listings and auction listings with the Buy It Now option.
AddFixedPriceItem
ReviseFixedPriceItem
RelistFixedPriceItem
VerifyAddFixedPriceItem
Conditionally
AddItem
ReviseItem
RelistItem
VerifyAddItem
Conditionally
GetItem
Conditionally
DetailLevel: none, ItemReturnDescription,
ItemReturnAttributes, ReturnAll
GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
Conditionally
For MinimumAdvertisedPrice (MAP) listings only.
A seller cannot show the actual discounted price on eBay's View Item
page. Instead, the buyer can either click on a pop-up on eBay's
View Item page, or the discount price will be shown during checkout.
AddFixedPriceItem
ReviseFixedPriceItem
RelistFixedPriceItem
VerifyAddFixedPriceItem
Conditionally
AddItem
ReviseItem
RelistItem
VerifyAddItem
Conditionally
GetItem
Conditionally
DetailLevel: none, ItemReturnDescription,
ItemReturnAttributes, ReturnAll
GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
Conditionally
Based on <b>OriginalRetailPrice</b>,
<b>MinimumAdvertisedPrice</b>, and <b>StartPrice</b> values, eBay identifies
whether the listing falls under MAP or STP (aka
<b>OriginalRetailPrice</b>). <b>GetItem</b> returns this for items listed with one
of these discount pricing treatments. <b>GetSellerList</b> returns the
<b>DiscountPriceInfo</b> container. This field is not applicable for Add/Revise/Relist calls.
GetItem
Conditionally
DetailLevel: none, ItemReturnDescription,
ItemReturnAttributes, ReturnAll
GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
Conditionally
false
Used by the eBay UK and eBay Germany (DE) sites, this flag indicates that the discount
price (specified as <b>StartPrice</b>) is the price for which the seller offered the same (or
similar) item for sale on eBay within the previous 30 days. The discount price is always
in reference to the seller's own price for the item.
<br><br>
If this field is set to <code>true</code>, eBay displays 'Was' in the UK and 'Ursprunglich' in Germany, next
to the discounted price of the item. In the event both <b>SoldOffeBay</b> and <b>SoldOneBay</b> fields
are set to <code>true</code>, <b>SoldOneBay</b> takes precedence.
<br>
AddFixedPriceItem
ReviseFixedPriceItem
RelistFixedPriceItem
VerifyAddFixedPriceItem
Conditionally
AddItem
ReviseItem
RelistItem
VerifyAddItem
Conditionally
GetItem
Conditionally
DetailLevel: none, ItemReturnDescription,
ItemReturnAttributes, ReturnAll
GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
Conditionally
false
Used by the eBay UK and eBay Germany (DE) sites, this flag indicates that the discount
price (specified as StartPrice) is the price for which the seller offered the same (or
similar) item for sale on a Web site or offline store other than eBay in the previous 30
days. The discount price is always in reference to the seller's own price for the item.
<br><br>
If this field is set to <code>true</code>, eBay displays 'Was*' in the UK and 'Ursprunglich*' in Germany,
next to the discounted price of the item. In the event both <b>SoldOffeBay</b> and <b>SoldOneBay</b> fields
are set to <code>true</code>, <b>SoldOneBay</b> takes precedence.
<br>
AddFixedPriceItem
ReviseFixedPriceItem
RelistFixedPriceItem
VerifyAddFixedPriceItem
Conditionally
AddItem
ReviseItem
RelistItem
VerifyAddItem
Conditionally
GetItem
Conditionally
DetailLevel: none, ItemReturnDescription,
ItemReturnAttributes, ReturnAll
GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
Conditionally
false
Applicable only if the item was specifically made for sale through dedicated eBay outlet pages (e.g., eBay Fashion Outlet).<br>
<br>
The comparison price is the price of a comparable product sold
through non-outlet channels on eBay (or elsewhere), or not
specifically made for the outlet.<br>
<br>
In fashion, a "comparable" product shares the same design, but is
not considered an identical product. Some products are specifically
made for outlets, and may have a different SKU than the "comparable"
product. These made-for-outlet products may be manufactured in a
different place, with different materials, or according to different
specifications (i.e. different stitch pattern, seam reinforcement,
button quality, etc.)
AddFixedPriceItem
ReviseFixedPriceItem
RelistFixedPriceItem
VerifyAddFixedPriceItem
Conditionally
AddItem
ReviseItem
RelistItem
VerifyAddItem
Conditionally
GetItem
Conditionally
DetailLevel: none, ItemReturnDescription,
ItemReturnAttributes, ReturnAll
GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
Conditionally
Details of a flat or calculated shipping discount rule. Shipping Discount Rules can be set up through the <b>SetShippingDiscountProfiles</b> call or through My eBay.
The unique eBay-created unique identifier for the shipping discount, assigned when the shipping discount rule is created.
<br/>
In a <b>SetShippingDiscountProfiles</b> call,
<ul>
<li>If the value of <b>ModifyActionCode</b> is set to <code>Add</code>, this field is not applicable and is ignored <li>If provided.</li>
<li>If the value of <b>Mod <li>IfyActionCode</b> is set to <code>Update</code>, all fields of the modified rule must be provided, even if the values are not changing.</li>
<li>If the value of <b>ModifyActionCode</b> is set to <code>Delete</code>, either the <b>DiscountProfileID</b> value or is <b>DiscountProfileName</b> value is required, the <b>MappingDiscountProfileID</b> is optional, and all other fields of the <b>DiscountProfile</b> container are ignored.</li>
</ul>
GetShippingDiscountProfiles
Always
SetShippingDiscountProfiles
Conditionally
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally
The seller-provided title for the shipping discount rule.
<br/>
In a <b>SetShippingDiscountProfiles</b> call,
<ul>
<li>If the value of <b>ModifyActionCode</b> is set to <code>Add</code>, this field is ignored (if provided) if this is the first shipping discount rule being created, but this field is required if there is more than one existing shipping discount rule of that type (flat rate or calculated)</li>
<li>If the value of <b>ModifyActionCode</b> is set to <code>Update</code>, all fields of the modified rule must be provided, even if the values are not changing</li>
<li>If the value of <b>ModifyActionCode</b> is set to <code>Delete</code>, the <b>DiscountProfileID</b> is required, the <b>MappingDiscountProfileID</b> is optional, and all other fields of the <b>DiscountProfile</b> container are ignored</li>
<li>If the value of <b>ModifyActionCode</b> is set to <code>Delete</code>, either the <b>DiscountProfileID</b> value or is <b>DiscountProfileName</b> value is required, the <b>MappingDiscountProfileID</b> is optional, and all other fields of the <b>DiscountProfile</b> container are ignored</li>
</ul>
GetShippingDiscountProfiles
Conditionally
SetShippingDiscountProfiles
Conditionally
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally
The cost to ship each item beyond the first item (where the item with the highest shipping cost is selected by eBay as the first item). Let's say the buyer purchases three items, each set to ship for $8, and the seller set the <b>EachAdditionalAmount</b> to $6. The cost to ship three items would normally be $24, but since the seller specified $6, the total shipping cost would be $8 + $6 + $6, or $20. This field is only applicable for flat-rate shipping.
GetShippingDiscountProfiles
FlatShippingDiscount
Conditionally
SetShippingDiscountProfiles
FlatShippingDiscount
Conditionally
GetItem
GetSellingManagerTemplates
FlatShippingDiscount
InternationalFlatShippingDiscount
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally
The amount by which to reduce the cost to ship each item beyond the first item (where the item with the highest shipping cost is selected by eBay as the first item). Let's say the buyer purchases three items, each set to ship for $8, and the seller set <b>EachAdditionalAmountOff</b> to $2. The cost to ship three items would normally be $24, but since the seller specified $2, the total shipping cost would be <i>$24 - (two additional items x $2)</i>, or $20. This field is only applicable for flat-rate shipping.
GetShippingDiscountProfiles
FlatShippingDiscount
Conditionally
SetShippingDiscountProfiles
FlatShippingDiscount
Conditionally
GetItem
GetSellingManagerTemplates
FlatShippingDiscount
InternationalFlatShippingDiscount
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally
The percentage by which to reduce the cost to ship each item beyond the first item (where the item with the highest shipping cost is selected by eBay as the first item). Let's say the buyer purchases three items, each set to ship for $8, and the seller set <b>EachAdditionalPercentOff</b> to 0.25. The cost to ship three items would normally be $24, but since the seller specified 0.25 ($2 out of $8), the total shipping cost would be <i>$24 - (two additional items x $2)</i>, or $20. This field is only applicable for flat-rate shipping.
GetShippingDiscountProfiles
FlatShippingDiscount
Conditionally
SetShippingDiscountProfiles
FlatShippingDiscount
Conditionally
GetItem
GetSellingManagerTemplates
FlatShippingDiscount
InternationalFlatShippingDiscount
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally
The amount of weight to subtract for each item beyond the first item before shipping costs are calculated. For example, there may be less packing material when the items are combined in one box than if they were shipped individually. Let's say the buyer purchases three items, each 10 oz. in weight, and the seller set <b>WeightOff</b> to 2 oz. The combined weight would be 30 oz., but since the seller specified 2 oz. off, the total weight for shipping cost calculation would be <i>30 oz. - (two additional items x 2 oz.)</i>, or 26 oz. This field is only applicable for calculated shipping.
GetShippingDiscountProfiles
CalculatedShippingDiscount
Conditionally
SetShippingDiscountProfiles
CalculatedShippingDiscount
Conditionally
GetItem
GetSellingManagerTemplates
CalculatedShippingDiscount
InternationalCalculatedShippingDiscount
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally
For <b>SetShippingDiscountProfiles</b>, if <b>MappedDiscountProfileID</b> is omitted when
<b>ModifyActionCode</b> is set to <code>Delete</code>, any listings currently using the profile
identified by <b>DiscountProfileID</b> will have that profile removed.
GetShippingDiscountProfiles
CalculatedShippingDiscount
Conditionally
SetShippingDiscountProfiles
CalculatedShippingDiscount
Conditionally
GetItem
GetSellingManagerTemplates
CalculatedShippingDiscount
InternationalCalculatedShippingDiscount
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally
This enumerated type is used in the response of Add/Revise/Relist item calls to indicate if eBay has applied a Special offer or Promotional discount to the order line item.
An offer that applies to a limited number of listings during the offering
period. Example: "There is no insertion fee for up to 5 auctions when
listing between 12/1 and 12/10."
An offer that applies to an unlimited number of listings during the offering
period. Example: "Get subtitle for $0.10 in Tech category when listing between
12/25 and 12/28. No limit to the number of items listed during this period."
Reserved for future use
Contains a seller's cut off time preferences for same day handling for item shipping.
If the seller specifies a <strong>DispatchTimeMax</strong> value of <code>0</code> to indicate same day handling for an item, the seller's shipping commitment depends on the value of <strong>CutoffTime</strong> for the eBay site on which the item is listed.
<br/><br/>
For orders placed (and cleared payment received) before the indicated cut off time, the item must be shipped by the end of the current day. For orders completed on or after the cut off time, the item must be shipped by the end of the following day (excluding weekends and local holidays).
<br/><br/>
<span class="tablenote">
<strong>Note:</strong> This field is not applicable for sellers who have opted into the Handling Time Option of eBay Guaranteed Delivery, as this field only shows a single order cutoff time, but with the Handling Time Option, a seller can set a different order cutoff time for each business day. Currently, eBay Guaranteed Delivery is only available in the US.
</span>
<strong>CutoffTime</strong> has a default initial value for each eBay site, but you can use <strong>SetUserPreferences</strong> to override the default for individual sellers. The default value for most eBay sites is 2:00PM local time. Enter times in 30 minute increments from the top of the hour. That is, enter values either on the hour (:00) or 30 minutes past the hour (:30). Other values will be rounded down to the next closest 30 minute increment. Times entered should be local to the value provided for <strong>TimeZoneID</strong>.
<br/>
SetUserPreferences
Conditionally
GetUserPreferences
Conditionally
Same Day Handling
https://developer.ebay.com/DevZone/guides/features-guide/default.html#Development/Shipping-Services.html#SameDayHandling
details about dispatch cut off times
Details about the maximum number of business days required to ship an item to domestic buyers after receiving a cleared payment.
Integer value that indicates the maximum number of business days that the eBay site allows as a seller's handling time. The clock starts ticking when the buyer pays for the order. This means that if a buyer pays for the order on a Wednesday, the seller would have to ship the item by the next day (Thursday) if the <b>DispatchTimeMax</b> value is set to <code>1</code>. Typical values for this field are 0, 1, 2, 3, 4, 5, 10, 15, or 20.
<br/><br/>
A <b>DispatchTimeMax</b> value of <code>0</code> indicates <em>same day handling</em> for an item. In this case, the seller's handling time commitment depends on the <em>order cut off time</em> set in the seller's user preferences. This defaults to 2:00 PM local time on most eBay sites. For orders placed (and cleared payment received) before the local order cut off time, the item must be shipped by the end of the current day. For orders completed on or after the order cut off time, the item must be shipped by the end of the following day (excluding weekends and local holidays).
<br/><br/>
<span class="tablenote">
<strong>Note:</strong> If a same day shipping carrier is selected, and the carrier delivers on one or both weekend days, sellers on the eBay US site are assumed to be open for business on the same days, and those days will be used when calculating total shipping time.
</span>
If using <b>GeteBayDetails</b> specifically to return this value, the caller sets the DetailName field in the request to <b>DispatchTimeMaxDetails</b>.
<br/><br/>
When creating, revising, or relisting an item, the seller cannot set the <b>Item.DispatchTimeMax</b> value higher than the value returned in this field.
GeteBayDetails
Conditionally
Same Day Handling
https://developer.ebay.com/DevZone/guides/features-guide/default.html#Development/Shipping-Services.html#SameDayHandling
details about dispatch cut off times
Value and unit (e.g., 10 Days) for the maximum dispatch time.
Useful for display purposes.
GeteBayDetails
Conditionally
Returns the latest version number for this field. The version can be
used to determine if and when to refresh cached client data.
GeteBayDetails
DetailLevel: none, ReturnSummary, ReturnAll
Always
Gives the time in GMT that the feature flags for the
details were last updated. This timestamp can be used to determine
if and when to refresh cached client data.
GeteBayDetails
DetailLevel: none, ReturnSummary, ReturnAll
Always
A value of <code>true</code> indicates that the seller has specified a handling time of 4 business days or more (an <em>exception handling time</em>). Sellers should be aware that long handling times might adversely affect the buying decisions of potential customers.
GeteBayDetails
DetailLevel: none, ReturnSummary, ReturnAll
Always
This enumerated type is used to control how the "Buy It Now" button is displayed on a listing.
<br><br>
<span class="tablenote"><b>Note:</b> Sellers opted in to the new eBay Managed Payments program cannot control the display of the "Buy It Now" button in listings, and although the <b>DisplayPayNowButton</b> value can still be set in <b>SetUserPreferences</b> and returned in <b>GetUserPreferences</b>, the setting will not have any affect on any current or future listings for the seller. eBay Managed Payments is currently only available to a limited number of sellers on the US site. The rollout to more sellers in more countries will be a multi-year journey, but eBay expects to transition a majority of sellers Worldwide to Managed Payments by 2021.
</span>
<br>
This enumeration value indicates that the "Pay Now" button will be displayed no matter what payment method the buyer uses.
This enumeration value indicates that the "Pay Now" button will only be displayed if the buyer is using PayPal as the payment method.
Reserved for internal or future use
Type used by the <b>DisputeArray</b> container that is returned in the response of the <b>GetUserDisputes</b> call. The <b>DisputeArray</b> container holds an array of one or more disputes that match the filter criteria in the call request.
<br/><br/>
<span class="tablenote"><strong>Note:</strong>
'Item Not Received' or 'Significantly Not As Described' cases, initiated by buyers through the eBay Money Back Guarantee program, are not returned with <b>GetUserDisputes</b>. The <a href="https://developer.ebay.com/Devzone/post-order/post-order_v2_casemanagement-caseId__get.html#overview">getCase</a> method of the <a href="https://developer.ebay.com/Devzone/post-order/concepts/UsageGuide.html">Post-Order API</a> is used to retrieve Money Back Guarantee cases programmatically.
</span>
The information that describes a dispute, including
the buyer's name, the transaction ID, the dispute state
and status, whether the dispute is resolved,
and any messages posted to the dispute.
GetUserDisputes
DetailLevel: ReturnSummary, ReturnAll, none
Always
Contains all information describing a dispute.
<br/><br/>
<span class="tablenote"><strong>Note:</strong>
'Item Not Received' or 'Significantly Not As Described' cases, initiated by buyers through the eBay Money Back Guarantee program, are not returned with <b>GetDispute</b> or <b>GetUserDisputes</b>. The <a href="https://developer.ebay.com/Devzone/post-order/post-order_v2_casemanagement-caseId__get.html#overview">getCase</a> method of the <a href="https://developer.ebay.com/Devzone/post-order/concepts/UsageGuide.html">Post-Order API</a> is used to retrieve Money Back Guarantee cases programmatically.
</span>
The unique identifier of an eBay dispute.
GetDispute
Always
GetUserDisputes
DetailLevel: ReturnSummary, ReturnAll, none
Conditionally
A value to indicate the type of dispute.
GetDispute
Always
GetUserDisputes
DetailLevel: ReturnSummary, ReturnAll, none
Conditionally
The internal state of the dispute. The value determines
which values of <b>DisputeActivity</b> are valid when responding
to a dispute.
GetDispute
Always
GetUserDisputes
DetailLevel: ReturnSummary, ReturnAll, none
Conditionally
The status of the dispute, which provides additional
information about the dispute state.
GetDispute
Always
GetUserDisputes
DetailLevel: ReturnSummary, ReturnAll, none
Conditionally
The role of the person involved in the dispute who is
not taking action or requesting information. The role is
either <b>Buyer</b> or <b>Seller</b>.
GetUserDisputes
DetailLevel: ReturnSummary, ReturnAll, none
Conditionally
The user name of the person involved in the dispute who
is not taking action or requesting information.
GetUserDisputes
DetailLevel: ReturnSummary, ReturnAll, none
Conditionally
The role of the person involved in the dispute who is taking action or
requesting information. The role is either <b>Buyer</b> or <b>Seller</b>.
GetUserDisputes
DetailLevel: ReturnSummary, ReturnAll, none
Conditionally
The eBay user ID of the buyer involved in the dispute.
GetDispute
Always
The eBay user ID of the seller involved in the dispute.
GetDispute
Always
The unique identifier of the order line item (transaction) under dispute. An
order line item is created once there is a commitment from a
buyer to purchase an item. In the case of <b>GetDispute</b> and <b>GetUserDisputes</b>
responses, this value identifies the order line item involved in the
dispute.
GetDispute
Always
GetUserDisputes
DetailLevel: ReturnSummary, ReturnAll, none
Conditionally
Container consisting of high-level details about the item involved in the
dispute.
GetDispute
Always
GetUserDisputes
DetailLevel: ReturnSummary, ReturnAll, none
Conditionally
The top-level reason for the dispute. The value of <b>DisputeReason</b>
determines which values of <b>DisputeExplanation</b> are valid.
See <b>DisputeExplanationCodeList</b> for details.
GetDispute
Always
GetUserDisputes
DetailLevel: ReturnSummary, ReturnAll, none
Conditionally
The detailed explanation for the dispute. Valid values
depend on the value of <b>DisputeReason</b>. See <b>DisputeExplanationCodeList</b>
for details.
GetDispute
Always
GetUserDisputes
DetailLevel: ReturnSummary, ReturnAll, none
Conditionally
A value to indicate whether or not the seller is currently eligible for a
Final Value Fee credit. The seller becomes eligible for a Final Value Fee
credit after filing and winning an Unpaid Item case. This tag only
indicates credit eligibility and does not mean that the case can be closed.
The seller can open an Unpaid Item case as soon as two days after the listing ends.
<br>
GetDispute
Always
GetUserDisputes
DetailLevel: ReturnSummary, ReturnAll, none
Conditionally
The date and time the dispute was created, in GMT.
GetDispute
Always
GetUserDisputes
DetailLevel: ReturnSummary, ReturnAll, none
Conditionally
The date and time the dispute was modified, in GMT.
GetDispute
Always
GetUserDisputes
DetailLevel: ReturnSummary, ReturnAll, none
Conditionally
The action resulting from the dispute resolution. The
action might include a Final Value Fee credit to the seller, a strike
to the buyer, a reversal, or an appeal.
GetUserDisputes
DetailLevel: ReturnAll, none
Conditionally
A response or message posted to a dispute, either by
an application or by a user on the eBay site.
GetDispute
Always
GetUserDisputes
DetailLevel: ReturnAll, none
Conditionally
This field is returned as <code>true</code> if the buyer is eligible to appeal a closed Item Not Received dispute.
GetDispute
Always
This field is returned as <code>true</code> if the buyer used PayPal to pay for the item, and is eligible for PayPal's Standard Purchase Protection.
GetDispute
Always
<b>OrderLineItemID</b> is a unique identifier for an eBay order line item. In the case of <b>GetDispute</b> and <b>GetUserDisputes</b> responses, this value identifies the order line item involved in the dispute.
<br>
GetDispute
Always
GetUserDisputes
DetailLevel: ReturnSummary, ReturnAll, none
Conditionally
This type is deprecated.
This field is deprecated.
This field is deprecated.
This type defines the available options the seller has for handling domestic returns.
Defines the available options the seller has for handling domestic returns in the specified marketplace and category.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
On the EBAY_US marketplace only, sellers can offer item replacement in addition to offering money back returns. This flag defines the availability of such options for the given US marketplace category. Sellers can offer item replacements only if returns are enabled (<b>returnPolicyEnabled</b> is set to <code>true</code>) for the item. You can specify item replacement in the AddItem family of calls and in the return policy settings of the Account API.
This type defines the available options the seller has for accepting domestic returns.
Defines the available options the seller has for accepting domestic returns in the specified marketplace and category.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
The values returned in this field indicate whether or not the seller accepts domestic returns for items listed in the associated marketplace and category. <br><br>While most categories return the <b>ReturnsAccepted</b> flag (indicating the category supports returns), some categories will also return the <b>ReturnsNotAccepted</b> flag to indicate the seller can choose to not accept returns for an item listed in that category. <br><br>The values returned in this field are pertinent only if <b>ReturnPolicyEnabled</b> in GetCategoryFeatures is set to <code>true</code> for the associated category, which indicates that items listed in the category must include a return policy. Here, it's worth noting that not accepting returns is a return policy. The values returned in this field are valid in AddItem and its related family of calls, and in the return policies you configure for use with the Account API.
This type defines the available options for the return durations for domestic returns.
Defines the available options for the return durations for domestic returns in the specified marketplace and category. This is the time the buyer has to initiate a return once they receive the item.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
The values returned in this field indicate the return-duration options that are available for domestic returns for items listed in the associated marketplace and category. <br><br>The values returned in this field are pertinent only if <b>ReturnPolicyEnabled</b> in GetCategoryFeatures is set to <code>true</code> for the associated category, which indicates that items listed in the category must include a return policy. The values returned in this field are valid in AddItem and its related family of calls, and in the return policies you configure for use with the Account API.
This type defines the available options for who pays the return shipping costs for domestic returns.
Defines the available options for who pays the return shipping costs for domestic returns in the specified marketplace and category.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
The values returned in this field indicate the available options for who pays the return shipping for domestic returns. Possible values are <code>BUYER</code> and <code>SELLER</code>. <br><br>The values returned in this field are pertinent only if <b>ReturnPolicyEnabled</b> in GetCategoryFeatures is set to <code>true</code> for the associated category, which indicates that items listed in the category must include a return policy. The values returned in this field are valid in AddItem and its related family of calls, and in the return policies you configure for use with the Account API.
This type is deprecated.
Type defining the <b>EANEnabled</b> field that is returned under the <b>FeatureDefinitions</b> container of the <b>GetCategoryFeatures</b> response (as long as 'EANEnabled' is included as a <b>FeatureID</b> value in the call request or no <b>FeatureID</b> values are passed into the call request). This field is returned as an empty element (a boolean value is not returned) if one or more eBay API-enabled sites support the EAN product identifying feature.
<br><br>
To verify if a specific eBay site supports the EAN product identifying feature (for most categories), look for a 'true' value in the <b>SiteDefaults.EANEnabled</b> field.
<br><br>
To verify if a specific category on a specific eBay site supports the EAN product identifying feature, pass in a <b>CategoryID</b> value in the request, and then look for a 'true' value in the <b>EANEnabled</b> field of the corresponding <b>Category</b> node (match up the <b>CategoryID</b> values if more than one Category IDs were passed in the request).
This type is deprecated and has been replaced by <b>EANEnabledDefinitionType</b>.
This enumerated type contains a list of eBay subscriptions that an eBay user may be subscribed to.
PictureManagerLevel1, PictureManagerLevel2, PictureManagerLevel3, PictureManagerLevel4, PictureManagerLevel5, PictureManagerLevel6, PictureManagerLevel7, SellerAssistant, SellerAssistantPro, SellerReportsBasic
This eBay subscription is no longer available.
This eBay subscription is no longer available.
This value indicates that the user has a Basic eBay Store membership. See the <a href="http://pages.ebay.com/sellerinformation/stores/Subscriptions.html target="_blank">Welcome to eBay Stores</a> help page for more information on eBay Store subscriptions.
This value indicates that the user has a Premium eBay Store membership. See the <a href="http://pages.ebay.com/sellerinformation/stores/Subscriptions.html target="_blank">Welcome to eBay Stores</a> help page for more information on eBay Store subscriptions.
This value indicates that the user has a Anchor eBay Store membership. See the <a href="http://pages.ebay.com/sellerinformation/stores/Subscriptions.html target="_blank">Welcome to eBay Stores</a> help page for more information on eBay Store subscriptions.
This value indicates that the user has a Selling Manager subscription. Selling Manager is free to all sellers and can be subscribed to through the <b>Subscriptions</b> section of My eBay. See the <a href="http://pages.ebay.com/help/sell/selling-manager-subscription.html target="_blank">Selling Manager and Selling Manager Pro</a> help page for more information on Selling Manager.
This value indicates that the user has a Selling Manager Pro subscription. Selling Manager Pro is free to all sellers for the first 30 days, and a Selling Manager Pro subscription is included at no charge for eBay Store Premium and Anchor subscriptions. Selling Manager Pro can be subscribed to through the <b>Subscriptions</b> section of My eBay. See the <a href="http://pages.ebay.com/help/sell/selling-manager-subscription.html target="_blank">Selling Manager and Selling Manager Pro</a> help page for more information on Selling Manager Pro.
This value is no longer applicable because Picture Manager has been EOLed.
This value is no longer applicable because Picture Manager has been EOLed.
This value is no longer applicable because Picture Manager has been EOLed.
This value is no longer applicable because Picture Manager has been EOLed.
This value is no longer applicable because Picture Manager has been EOLed.
This value is no longer applicable because Picture Manager has been EOLed.
This value is no longer applicable because Picture Manager has been EOLed.
Basic Sales Reports are no longer available. Sellers should subsribe to Sales Reports Plus instead.
This value indicates that the user has a Sales Reports Plus subscription. A user can subscribe to Sales Report Plus through the <b>Subscriptions</b> section of My eBay. See the <a href="http://pages.ebay.com/help/sell/viewing-sales-reports.html target="_blank">Sales Report Plus</a> help page for more information.
This value indicates that the user has a File Exchange subscription. A user can subscribe to File Exchange through the <b>Subscriptions</b> section of My eBay. See the <a href="http://pages.ebay.com/sellerinformation/sellingresources/fileexchange.html target="_blank">File Exchange</a> help page for more information.
This value indicates that the Motors Dealer has a Local Market Specialty subscription. This type of account is used to sell in the Motorcycles, Powersports, and Other Vehicles and Trailers categories. Not Cars and Trucks.
This value indicates that the Motors Dealer has a Local Market Regular subscription. This type of account is used to sell in all eBay Motors categories.
This value indicates that the Motors Dealer has a Local Market Premium subscription. This type of account is used to sell in all eBay Motors categories.
This enumeration type is used to indicate whether an application/URL/device is enabled to receive notifications, or to indicate whether a specific notification event is enabled.
This enumeration value indicates that an application/URL/device is enabled to receive notifications, or to indicate that a specific notification event is enabled.
This enumeration value indicates that an application/URL/device is disabled, or being blocked from receiving notifications, or to indicate that a specific notification event is disabled.
Reserved for future use.
A container to specify a single eBay item to end.
The unique identifier of the eBay listing to end.
EndItems
Yes
The seller's reason for ending the listing early is input into this required field. The seller is not allowed to use the <code>ProductDeleted</code> value, as this ending reason can only be used internally by eBay to administratively end a listing due to the associated Catalog product being removed from the eBay Catalog.
EndItems
Yes
ProductDeleted
Most Trading API calls support a <b>MessageID</b> element in the request
and a <b>CorrelationID</b> element in the response. With
<b>EndItems</b>, the seller can pass in a different
<b>MessageID</b> value for
each <b>EndItemRequestContainer</b> container that is used in the request. The
<b>CorrelationID</b> value returned under each
<b>EndItemResponseContainer</b> container is used to correlate each
End Item request container with its corresponding End Item response container. The same <b>MessageID</b> value that you pass into a request will
be returned in the <b>CorrelationID</b> field in the response.
<br>
<br>
If you do not pass in a <b>MessageID</b> value in the request,
<b>CorrelationID</b> is not returned.
EndItems
No
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.
1027
NoOp
1033
This type includes the acknowledgement of the date and time when an eBay listing was ended due to the call to <b>EndItems</b>.
This timestamp indicates the date and time (returned in GMT) when the specified eBay listing was ended.
EndItem
EndItems
Always
Most Trading API calls support a <b>MessageID</b> element in the request
and a <b>CorrelationID</b> element in the response. With
<b>EndItems</b>, the seller can pass in a different
<b>MessageID</b> value for
each <b>EndItemRequestContainer</b> container that is used in the request. The
<b>CorrelationID</b> value returned under each
<b>EndItemResponseContainer</b> container is used to correlate each
End Item request container with its corresponding End Item response container. The same <b>MessageID</b> value that you pass into a request will
be returned in the <b>CorrelationID</b> field in the response.
<br>
<br>
If you do not pass in a <b>MessageID</b> value in the request,
<b>CorrelationID</b> is not returned.
EndItems
Conditionally
A list of application-level errors or warnings (if any) that were raised
when eBay processed the request. <br>
<br>
Application-level errors occur due to
problems with business-level data on the client side or on the eBay
server side. For example, an error would occur if the request contains
an invalid combination of fields, or it is missing a required field,
or the value of the field is not recognized. An error could also occur
if eBay encountered a problem in our internal business logic while
processing the request.<br>
<br>
Only returned if there were warnings or errors.
Conditionally
Contains the seller's preferences for the email that can be sent to the winner of an auction listing.
The seller can customize the text of the email that is sent to the winner of an auction listing. The text of the email is provided in this field. If the seller is going to customize the text of the email through this field, the seller must also include the <b>TextCustomized</b> field and set its value to <code>true</code>.The text of the custom message for the email.
<br>
<br>
This field is only returned if set for the account.
3948
GetUserPreferences
Conditionally
SetUserPreferences
No
The seller can include a customized logo in the email that is sent to the winner of an auction listing. The full URI to this logo image should be applied in this field. If the seller is going to include a customized logo in the email through this field, the seller must also include the <b>LogoCustomized</b> field and set its value to <code>true</code>, and include the <b>LogoType</b> field and set its value to <code>Customized</code>.
<br>
<br>
This field is only returned if a customized logo is being used for the customized email.
GetUserPreferences
Conditionally
SetUserPreferences
No
This field is needed in the <b>SetUserPreferences</b> call if the seller would like to use a customized or eBay Store logo. If the seller would like to use a customized logo, this field's value will be set to <code>Customized</code>. If the seller would like to use their eBay Store logo (if it exists), this field's value will be set to <code>Store</code>.
<br>
<br>
This field is always returned, and its value will be <code>None</code> if no logo is used in the customized email.
GetUserPreferences
Always
SetUserPreferences
None
Conditionally
This field is used in a <b>SetUserPreferences</b> call to set/change the setting of whether a customized email will be sent to the winning bidder or not.
<br>
<br>
This field is always returned to indicate whether or not a customized email will be sent to the winning bidder.
GetUserPreferences
Always
SetUserPreferences
No
This field is used in a <b>SetUserPreferences</b> call to set/change the setting of whether customized text will be used or not in the customized email that is sent to the winning bidder. Customized text is provided through the <b>LogoURL</b> field.
<br>
<br>
This field is always returned to indicate whether or not customized text is used in a customized email that is sent to the winning bidder.
GetUserPreferences
Conditionally
SetUserPreferences
No
This field is used in a <b>SetUserPreferences</b> call to set/change the setting of whether a customized logo will be used or not in the customized email that is sent to the winning bidder. The URI to a customized logo is provided through the <b>TemplateText</b> field. If the seller would like to use a customized logo, the <b>LogoType</b> field must also be included, and its value will be set to <code>Customized</code>.
<br>
<br>
This field is always returned to indicate whether or not a customized logo is used in a customized email that is sent to the winning bidder.
GetUserPreferences
Conditionally
SetUserPreferences
No
This field is deprecated.
889
NoOp
993
This enumeration type is used to indicate the type of logo that will be included in the customized email that will be sent by the seller to the winning bidder in an auction listing.
This enumeration value indicates that the PayPal Winning Bidder Notice logo will be used in the end of auction email to winning bidder.
This enumeration value indicates that the eBay seller's Store logo will be used in the end of auction email to winning bidder.
This enumeration value indicates that a custom logo will be used in the end of auction email to winning bidder. The location (URL) of this custom logo is specified in the <b>LogoURL</b> field.
Reserved for internal or future use.
This enumeration value indicates that no logo will be used in the end of auction email to winning bidder.
This type defines the reasons that a seller can end an item listing early. This value is required if the seller ends a listing early. This can be on an item that hasn't
sold and has no bids or on an item that has bids and the seller wants to sell the item to the high bidder now.
Use this enumeration value in an End listing call if the seller is ending a listing because the item was lost or is broken.
Use this enumeration value in an End listing call if the seller is ending a listing because the item is no longer available for sale.
Use this enumeration value in an End listing call if the seller is ending a listing because the start price or reserve price is incorrect.
Use this enumeration value in an End listing call if the seller is ending a listing because the listing contained an error (other than start price or reserve price).
Reserved for internal or future use.
Use this enumeration value in an End listing call if the seller is ending a listing because they want to sell an auction item to the current high bidder. A seller can end a listing early in order to sell to the current high bidder when the listing has qualifying bids (i.e., there is a current high bid that,
when applicable, meets the minimum reserve price) and there is more than 12 hours before the listing ends.
<br>
<b>Note</b>: In the last 12 hours of an item listing, you cannot end an item early if it has bids.
The vehicle was sold. Applies to local classified listings for vehicles only.
For internal use only. This enumeration value cannot be used by the seller in an End listing call, but it will get returned in <b>GetItem</b> if a listing was administratively ended by eBay if the item in a listing becomes unpurchasable due to the eBay Catalog product associated with the listing being removed from the catalog.
Type defining the <b>EpidSupported</b> field that is returned under the <b>FeatureDefinitions</b> container of the <b>GetCategoryFeatures</b> response (as long as <b>EpidSupported</b> is included as a <b>FeatureID</b> value in the call request, or no <b>FeatureID</b> values are passed into the call request). The <b>EpidSupported</b> field is returned as an empty element (a boolean value is not returned) if one or more eBay API-enabled sites support specifying parts compatibility through an eBay product ID (ePID).
<br><br>
At this time, this feature is only supported for motorcycle and scooter listings on the Germany and UK sites.
<br><br>
To verify if a specific category supports specifying parts compatibility through an ePID, pass in a <b>EpidSupported</b> value in the request, and then look for a <code>true</code> value in the <b>EpidSupported</b> field of the corresponding <b>Category</b> node (match up the <b>CategoryID</b> values if more than one category ID was passed in the request).
This enumerated type is deprecated.
This field is deprecated.
This field is deprecated.
This field is deprecated.
This field is deprecated.
Type used by the <b>ExcludeShippingLocationDetails</b> containers that are returned in the <b>GeteBayDetails</b> response. The values returned in the <b>ExcludeShippingLocationDetails.Location</b> fields are the values that can be specified when specifying excluded shipping locations in an Add/Revise/Relist item call, or in a shipping business policy.
The localized location name.
GeteBayDetails
Conditionally
The location or region code to be used with the AddItem family of calls. These
codes are also returned by GetItem. This code reflects the <a href=
"http://www.iso.org/iso/country_codes/iso_3166_code_lists/english_country_names_and_code_elements.htm"
>ISO 3166</a> codes.
GeteBayDetails
Conditionally
The region code to which the location belongs.
GeteBayDetails
Conditionally
Returns the current version number of the ExcludeShippingLocation data. Use
the version number to determine if you need to refresh your cached client data.
GeteBayDetails
Conditionally
The time in GMT that the feature flags for the details were last updated.
Use this timestamp to determine if you need to refresh your cached client data.
GeteBayDetails
Conditionally
This type is deprecated.
579
681
NoOp
This type is deprecated.
579
681
NoOp
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 field is deprecated.
This field is deprecated.
This field is deprecated.
This field is deprecated.
This field is deprecated.
This field is deprecated.
This field is deprecated.
This field is deprecated.
This field is deprecated.
This field is deprecated.
This field is deprecated.
This field is deprecated.
This field is deprecated.
This type is deprecated.
579
681
NoOp
This type is used to provide contact hours for a seller of a Classified Ad listing, including motor vehicles. There is also a boolean field in this type that indicates whether or not potential buyer can contact the seller by email.
This containers consists of fields that allows the seller of a Classified Ad listing to tell potential buyers what days and times they may be contacted to inquire about the listing.
AddItem
AddItems
AddSellingManagerTemplate
RelistItem
ReviseItem
ReviseSellingManagerTemplate
VerifyAddItem
VerifyRelistItem
No
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally
GetSellerList
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
A value of <code>true</code> in this field indicates that potential buyers can contact the seller of the Classified Ad listing by email.
AddItem
AddItems
AddSellingManagerTemplate
ReviseItem
ReviseSellingManagerTemplate
VerifyAddItem
RelistItem
VerifyRelistItem
No
GetItem
GetSellingManagerTemplates
Conditionally
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
This field is deprecated.
This container returns the URLs of the seller's self-hosted (hosted outside of eBay) pictures and the URL for the corresponding eBay
Picture Services (EPS), that was generated when the self-hosted picture was uploaded.
This container returns the <b>eBayPictureURL</b> (images hosted by eBay
Picture Services) and the <b>ExternalPictureURL</b> (images hosted outside of eBay) fields.
GetItem
Conditionally
This type is deprecated.
This field is deprecated.
This field is deprecated.
This type is deprecated.
This field is deprecated.
This enumerated type is deprecated.
This value is not used.
This value is not used.
This value is not used.
This value is not used.
This value is not used.
This value is not used.
This value is not used.
Container consisting of details related to payment of an eBay order on an
external system such as PayPal. This container is only returned if payment has
been made on an order. For <b>GetSellerTransaactions</b> and <b>GetItemTransactions</b>, this
container is not returned for multiple line item orders.
Unique identifier for a PayPal payment of an eBay order. If the order was purchased
with a payment method other than PayPal, "SIS" is returned, which stands for "Send
Information To Seller." This field is only returned after payment has been made.
ReviseCheckoutStatus
Conditionally
GetItemTransactions
GetSellerTransactions
DetailLevel: ReturnAll
Conditionally
GetOrders
DetailLevel: ReturnAll
Conditionally
OrderReport
Conditionally
SoldReport
Always
GetOrderTransactions
DetailLevel: ReturnAll
Conditionally
Timestamp for payment transaction.
ReviseCheckoutStatus
Conditionally
GetItemTransactions
GetSellerTransactions
DetailLevel: ReturnAll
Conditionally
GetOrders
DetailLevel: ReturnAll
Conditionally
OrderReport
Conditionally
GetOrderTransactions
DetailLevel: ReturnAll
Conditionally
SoldReport
Always
Fee Amount is a positive value and Credit Amount is a negative value.
GetItemTransactions
GetSellerTransactions
DetailLevel: ReturnAll
Conditionally
GetOrders
DetailLevel: ReturnAll
Conditionally
OrderReport
Conditionally
GetOrderTransactions
DetailLevel: ReturnAll
Conditionally
SoldReport
Always
If this dollar value is a positive amount, this is the amount that the buyer pays the seller through PayPal for purchase of the order. If this dollar value is a negative amount, this is the amount refunded to the buyer.
<br><br>
<span class="tablenote"><b>Note: </b> If a refund is due to the buyer, the amount in this field will not include any 'Collect and Remit' tax (mandated US state sales tax or 'Goods and Services' tax in Australia or New Zealand) charged to the buyer for one or more order line items, since this tax is collected by eBay and not by the seller.
</span>
<br>
<span class="tablenote"><b>Note: </b> As of November 2019, for orders subject to eBay 'Collect and Remit' taxes, PayPal has begun distributing order funds to the seller's account with the sales tax included. eBay 'Collect and Remit' tax includes US sales tax for numerous states, and 'Good and Services' tax that is applicable to Australian and New Zealand sellers. This 'Collect and Remit' tax amount for the order will be included in the <b>PaymentOrRefundAmount</b> value (for the payment scenario). To determine if 'Collect and Remit' taxes were added into <b>PaymentOrRefundAmount</b> value, the user can check for the <b>Transaction.eBayCollectAndRemitTaxes.TaxDetails</b> and the <b>Transaction.Taxes.TaxDetails</b> containers in the response. If both of these containers appear in the response with a <b>TaxDetails.TaxDescription</b> value of <code>SalesTax</code> (in US) or <code>GST</code> (in Australia or New Zealand), the tax amount that the buyer paid is in this amount.
<br><br>
Sellers should be aware that the sales tax that the buyer pays for the order will initially be included when the order funds are distributed to their PayPal account, but that PayPal will pull out the sales tax amount shortly after the payment clears, and will distribute the sales tax to the appropriate taxing authority. Previous to this change, PayPal would strip out the 'Collect and Remit' tax before distributing order funds to the seller's account.
<br><br>
This logic change does not apply to sellers who are in eBay managed payments, so the amount in this field will never reflect any 'Collect and Remit' tax, even if the order is subject to 'Collect and Remit' tax.
</span>
GetItemTransactions
GetSellerTransactions
DetailLevel: ReturnAll
Conditionally
GetOrders
DetailLevel: ReturnAll
Conditionally
OrderReport
Conditionally
GetOrderTransactions
DetailLevel: ReturnAll
Conditionally
SoldReport
Always
The current processing status of a PayPal payment for an eBay order.
GetItemTransactions
GetSellerTransactions
DetailLevel: ReturnAll
Conditionally
GetOrders
DetailLevel: ReturnAll
Conditionally
OrderReport
Conditionally
GetOrderTransactions
DetailLevel: ReturnAll
Conditionally
SoldReport
Conditionally
This type is used by the <b>FeatureDefinitions</b> container that is returned in the <b>GetCategoryFeatures</b> response to indicate which eBay features are available on one more eBay API-enabled sites. If no <b>FeatureID</b> field is included in the call request, all eBay features available for one more eBay API-enabled sites are returned. If one or more <b>FeatureID</b> fields are included in the call request, only those eBay features specified in each <b>FeatureID</b> field are returned in the response.
This field is returned as an empty element (a boolean value is not returned) if one or more eBay API-enabled sites support multiple listing durations. Listing durations will vary based on the selling format (auction, fixed-price, or classified ad) and the eBay category. This field will not be returned if one or more <b>FeatureID</b> fields are included in the call request and <code>ListingDurations</code> is not one of the values passed into those <a href="types/FeatureIDCodeType.html">FeatureID</a> fields.
GetCategoryFeatures
DetailLevel: none, ReturnSummary, ReturnAll
Conditionally
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. This field will not be returned if one or more <b>FeatureID</b> fields are included in the call request and <code>ShippingTermsRequired</code> is not one of the values passed into those <a href="types/FeatureIDCodeType.html">FeatureID</a> fields.
GetCategoryFeatures
DetailLevel: none, ReturnSummary, ReturnAll
Conditionally
This field is returned as an empty element (a boolean value is not returned) if one or more eBay API-enabled sites support the Best Offer feature. The Best Offer feature allows buyers and sellers to negotiate the price of the item. This field will not be returned if one or more <b>FeatureID</b> fields are included in the call request and <code>BestOfferEnabled</code> is not one of the values passed into those <a href="types/FeatureIDCodeType.html">FeatureID</a> fields.
<br/><br/>
<span class="tablenote"><b>Note: </b>
The Best Offer feature is now available for auction listings on the following sites: US, Canada, UK, Germany, Australia, France, Italy, and Spain. However, sellers must choose between offering Best Offer or Buy It Now on an auction listing, as both features cannot be enabled on the same auction listing.
</span>
GetCategoryFeatures
DetailLevel: none, ReturnSummary, ReturnAll
Conditionally
This field is deprecated.
This field is deprecated.
This field is returned as an empty element (a boolean value is not returned) if one or more eBay API-enabled sites support the temporary display of a seller's listing on a section of the eBay Home Page. This field will not be returned if one or more <b>FeatureID</b> fields are included in the call request and <code>HomePageFeaturedEnabled</code> is not one of the values passed into those <a href="types/FeatureIDCodeType.html">FeatureID</a> fields.
GetCategoryFeatures
DetailLevel: none, ReturnSummary, ReturnAll
Conditionally
This field is returned as an empty element (a boolean value is not returned) if one or more eBay API-enabled sites support the Pro Pack listing upgrade bundle. This field will not be returned if one or more <b>FeatureID</b> fields are included in the call request and <code>ProPackEnabled</code> is not one of the values passed into those <a href="types/FeatureIDCodeType.html">FeatureID</a> fields.
GetCategoryFeatures
DetailLevel: none, ReturnSummary, ReturnAll
Conditionally
This field is deprecated.
This field is returned as an empty element (a boolean value is not returned) if one or more eBay API-enabled sites support the Value Pack listing upgrade bundle. This field will not be returned if one or more <b>FeatureID</b> fields are included in the call request and <code>ValuePackEnabled</code> is not one of the values passed into those <a href="types/FeatureIDCodeType.html">FeatureID</a> fields.
GetCategoryFeatures
DetailLevel: none, ReturnSummary, ReturnAll
Conditionally
This field is returned as an empty element (a boolean value is not returned) if one or more eBay API-enabled sites support the Pro Pack Plus listing upgrade bundle. This field will not be returned if one or more <b>FeatureID</b> fields are included in the call request and <code>ProPackPlusEnabled</code> is not one of the values passed into those <a href="types/FeatureIDCodeType.html">FeatureID</a> fields.
GetCategoryFeatures
DetailLevel: none, ReturnSummary, ReturnAll
Conditionally
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. This field will not be returned if one or more <b>FeatureID</b> fields are included in the call request and <code>AdFormatEnabled</code> is not one of the values passed into those <a href="types/FeatureIDCodeType.html">FeatureID</a> fields.
GetCategoryFeatures
DetailLevel: none, ReturnSummary, ReturnAll
Conditionally
This field is returned as an empty element (a boolean value is not returned) if one or more eBay API-enabled sites support counter offers to Best Offers. The Best Offer feature allows buyers and sellers to negotiate the price of the item, and once a Best Offer price is proposed, the seller can send the buyer a counter offer, and a buyer may even send another counter offer to the seller's counter offer. This field will not be returned if one or more <b>FeatureID</b> fields are included in the call request and <code>BestOfferCounterEnabled</code> is not one of the values passed into those <a href="types/FeatureIDCodeType.html">FeatureID</a> fields.
<br/><br/>
<span class="tablenote"><b>Note: </b>
The Best Offer feature is now available for auction listings on the following sites: US, Canada, UK, Germany, Australia, France, Italy, and Spain. However, sellers must choose between offering Best Offer or Buy It Now on an auction listing, as both features cannot be enabled on the same auction listing.
</span>
GetCategoryFeatures
DetailLevel: none, ReturnSummary, ReturnAll
Conditionally
This field is returned as an empty element (a boolean value is not returned) if one or more eBay API-enabled sites support the Best Offer Auto-Decline feature. The Best Offer Auto-Decline feature allows a seller to set a lower threshold dollar value on a listing, and any Best Offer amount below this amount is automatically declined by the eBay system. This field will not be returned if one or more <b>FeatureID</b> fields are included in the call request and <code>BestOfferAutoDeclineEnabled</code> is not one of the values passed into those <a href="types/FeatureIDCodeType.html">FeatureID</a> fields.
<br/><br/>
<span class="tablenote"><b>Note: </b>
The Best Offer feature is now available for auction listings on the following sites: US, Canada, UK, Germany, Australia, France, Italy, and Spain. However, sellers must choose between offering Best Offer or Buy It Now on an auction listing, as both features cannot be enabled on the same auction listing.
</span>
GetCategoryFeatures
DetailLevel: none, ReturnSummary, ReturnAll
Conditionally
This field is returned as an empty element (a boolean value is not returned) if one or more eBay API-enabled sites support Motors Local Market listings for dealership subscribers with a specialty subscription. This field will not be returned if one or more <b>FeatureID</b> fields are included in the call request and <code>LocalMarketSpecialitySubscription</code> is not one of the values passed into those <a href="types/FeatureIDCodeType.html">FeatureID</a> fields.
<br><br>
See the <a href="
http://pages.ebay.com/help/sell/formats.html#market" target="_blank">Motors Local Market listing help topic</a> for more information.
GetCategoryFeatures
DetailLevel: none, ReturnSummary, ReturnAll
Conditionally
TThis field is returned as an empty element (a boolean value is not returned) if one or more eBay API-enabled sites support Motors Local Market listings for dealership subscribers with a regular subscription. This field will not be returned if one or more <b>FeatureID</b> fields are included in the call request and <code>LocalMarketRegularSubscription</code> is not one of the values passed into those <a href="types/FeatureIDCodeType.html">FeatureID</a> fields.
<br><br>
See the <a href="
http://pages.ebay.com/help/sell/formats.html#market" target="_blank">Motors Local Market listing help topic</a> for more information.
GetCategoryFeatures
DetailLevel: none, ReturnSummary, ReturnAll
Conditionally
This field is returned as an empty element (a boolean value is not returned) if one or more eBay API-enabled sites support Motors Local Market listings for dealership subscribers with a premium subscription. This field will not be returned if one or more <b>FeatureID</b> fields are included in the call request and <code>LocalMarketPremiumSubscription</code> is not one of the values passed into those <a href="types/FeatureIDCodeType.html">FeatureID</a> fields.
<br><br>
See the <a href="
http://pages.ebay.com/help/sell/formats.html#market" target="_blank">Motors Local Market listing help topic</a> for more information.
GetCategoryFeatures
DetailLevel: none, ReturnSummary, ReturnAll
Conditionally
This field is returned as an empty element (a boolean value is not returned) if one or more eBay API-enabled sites support Motors Local Market listings for dealerships without a subscription. This field will not be returned if one or more <b>FeatureID</b> fields are included in the call request and <code>LocalMarketNonSubscription</code> is not one of the values passed into those <a href="types/FeatureIDCodeType.html">FeatureID</a> fields.
<br><br>
See the <a href="
http://pages.ebay.com/help/sell/formats.html#market" target="_blank">Motors Local Market listing help topic</a> for more information.
GetCategoryFeatures
DetailLevel: none, ReturnSummary, ReturnAll
Conditionally
This field is deprecated.
579
681
NoOp
This field is deprecated.
579
681
NoOp
This field is deprecated.
579
681
NoOp
This field is returned as an empty element (a boolean value is not returned) if one or more eBay API-enabled sites require a minimum reserve price for an auction item. This feature is only applicable to auction listings. This field will not be returned if one or more <b>FeatureID</b> fields are included in the call request and <code>MinimumReservePrice</code> is not one of the values passed into those <a href="types/FeatureIDCodeType.html">FeatureID</a> fields.
GetCategoryFeatures
DetailLevel: none, ReturnSummary, ReturnAll
Conditionally
This field is deprecated.
GetCategoryFeatures
DetailLevel: none, ReturnSummary, ReturnAll
Conditionally
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. This feature is only applicable to classified ad listings. This field will not be returned if one or more <b>FeatureID</b> fields are included in the call request and <code>SellerContactDetailsEnabled</code> is not one of the values passed into those <a href="types/FeatureIDCodeType.html">FeatureID</a> fields.
GetCategoryFeatures
DetailLevel: none, ReturnSummary, ReturnAll
Conditionally
This field is deprecated.
This field is deprecated.
GetCategoryFeatures
DetailLevel: none, ReturnSummary, ReturnAll
Conditionally
This field is deprecated.
GetCategoryFeatures
DetailLevel: none, ReturnSummary, ReturnAll
Conditionally
This field is returned as an empty element (a boolean value is not returned) if one or more eBay API-enabled sites support allow dealership subscribers with a regular subscription to specify local market radius for Motors Local Market listings. This field will not be returned if one or more <b>FeatureID</b> fields are included in the call request and <code>LocalListingDistancesRegular</code> is not one of the values passed into those <a href="types/FeatureIDCodeType.html">FeatureID</a> fields.
GetCategoryFeatures
DetailLevel: none, ReturnSummary, ReturnAll
Conditionally
This field is returned as an empty element (a boolean value is not returned) if one or more eBay API-enabled sites allow dealership subscribers with a specialty subscription to specify local market radius for Motors Local Market listings. This field will not be returned if one or more <b>FeatureID</b> fields are included in the call request and <code>LocalListingDistancesSpecialty</code> is not one of the values passed into those <a href="types/FeatureIDCodeType.html">FeatureID</a> fields.
GetCategoryFeatures
DetailLevel: none, ReturnSummary, ReturnAll
Conditionally
This field is returned as an empty element (a boolean value is not returned) if one or more eBay API-enabled sites allow dealership subscribers without a subscription to specify local market radius for Motors Local Market listings. This field will not be returned if one or more <b>FeatureID</b> fields are included in the call request and <code>LocalListingDistancesNonSubscription</code> is not one of the values passed into those <a href="types/FeatureIDCodeType.html">FeatureID</a> fields.
GetCategoryFeatures
DetailLevel: none, ReturnSummary, ReturnAll
Conditionally
This field is returned as an empty element (a boolean value is not returned) if one or more eBay API-enabled sites allow for the display of acceptable payment methods for classified ad listings. This field will not be returned if one or more <b>FeatureID</b> fields are included in the call request and <code>ClassifiedAdPaymentMethodEnabled</code> is not one of the values passed into those <a href="types/FeatureIDCodeType.html">FeatureID</a> fields.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
This field is returned as an empty element (a boolean value is not returned) if one or more eBay API-enabled sites allow for the display of shipping service options for classified ad listings. This field will not be returned if one or more <b>FeatureID</b> fields are included in the call request and <code>ClassifiedAdShippingMethodEnabled</code> is not one of the values passed into those <a href="types/FeatureIDCodeType.html">FeatureID</a> fields.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
This field is returned as an empty element (a boolean value is not returned) if one or more eBay API-enabled sites support the Best Offer feature for classified ad listings. The Best Offer feature allows buyers and sellers to negotiate the price of the item. This field will not be returned if one or more <b>FeatureID</b> fields are included in the call request and <code>ClassifiedAdBestOfferEnabled</code> is not one of the values passed into those <a href="types/FeatureIDCodeType.html">FeatureID</a> fields.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
This field is returned as an empty element (a boolean value is not returned) if one or more eBay API-enabled sites support counter offers to Best Offers for classified ad listings. The Best Offer feature allows buyers and sellers to negotiate the price of the item, and once a Best Offer price is proposed, the seller can send the buyer a counter offer, and a buyer may even send another counter offer to the seller's counter offer. This field will not be returned if one or more <b>FeatureID</b> fields are included in the call request and <code>ClassifiedAdCounterOfferEnabled</code> is not one of the values passed into those <a href="types/FeatureIDCodeType.html">FeatureID</a> fields.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
This field is returned as an empty element (a boolean value is not returned) if one or more eBay API-enabled sites support the Best Offer Auto-Decline feature for classified ad listings. The Best Offer Auto-Decline feature allows a seller to set a lower threshold dollar value on a listing, and any Best Offer amount below this amount is automatically declined by the eBay system. This field will not be returned if one or more <b>FeatureID</b> fields are included in the call request and <code>ClassifiedAdAutoDeclineEnabled</code> is not one of the values passed into those <a href="types/FeatureIDCodeType.html">FeatureID</a> fields.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
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 a phone number when contacting the
seller about a classified ad listing. This field will not be returned if one or more <b>FeatureID</b> fields are included in the call request and <code>ClassifiedAdContactByPhoneEnabled</code> is not one of the values passed into those <a href="types/FeatureIDCodeType.html">FeatureID</a> fields.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
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 an email address when contacting the seller about a classified ad listing. This field will not be returned if one or more <b>FeatureID</b> fields are included in the call request and <code>ClassifiedAdContactByEmailEnabled</code> is not one of the values passed into those <a href="types/FeatureIDCodeType.html">FeatureID</a> fields.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
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. This field will not be returned if one or more <b>FeatureID</b> fields are included in the call request and <code>SafePaymentRequired</code> is not one of the values passed into those <a href="types/FeatureIDCodeType.html">FeatureID</a> fields.
<br><br>
For the US, Canada and Australia sites, users registered after January
17, 2007 are required to offer at least one safe payment method (i.e.
PayPal/PaisaPay, or one of the credit cards specified in
<b>Item.PaymentMethods</b>).
<br><br>
If a seller has a <code>SafePaymentExempt</code> status, they are exempt from the
requirement to offer at least one safe payment method when listing
an item on a site that has the safe payment requirement.
<br>
The safe payment requirement also applies to two-category listings that have
one ship-to or available-to location in the US, Canada, or Australia. The
French Canadian (CAFR) site is a special case, because listings on the CAFR
site with ship-to or available-to locations in Canada do not require a Safe
Payment method, yet listings on the CAFR site with ship-to or available-to
locations in the US or Australia do require a Safe Payment method.
<br><br>
The Business and Industrial, Motors, Real Estate, and Mature Audiences
categories, and all listings that don't support the <b>Item.PaymentMethods</b> field are
exempt from this requirement. Therefore, listings in those categories do not
require a safe payment method.
GetCategoryFeatures
DetailLevel: none, ReturnSummary, ReturnAll
Conditionally
This field is deprecated.
GetCategoryFeatures
DetailLevel: none, ReturnSummary, ReturnAll
Conditionally
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 Item Specifics in listings. Item Specifics are typical aspects that items in a specific category tend to have, and they allow sellers to provide descriptive details of an item in a structured manner. For example, in a jewelry category, sellers might describe lockets with Item Specifics name-value pairs like "Chain Length=18 in." and "Main Shape=Heart", or in a Washers & Dryers category, sellers might include "Type=Top-Loading". This field will not be returned if one or more <b>FeatureID</b> fields are included in the call request and <code>ItemSpecificsEnabled</code> is not one of the values passed into those <a href="types/FeatureIDCodeType.html">FeatureID</a> fields.
GetCategoryFeatures
DetailLevel: none, ReturnSummary, ReturnAll
Conditionally
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 PaisaPay Full Escrow as a payment method. This field will not be returned if one or more <b>FeatureID</b> fields are included in the call request and <code>PaisaPayFullEscrowEnabled</code> is not one of the values passed into those <a href="types/FeatureIDCodeType.html">FeatureID</a> fields.
GetCategoryFeatures
DetailLevel: none, ReturnSummary, ReturnAll
Conditionally
This field is deprecated.
This field is deprecated.
This field is deprecated.
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 Brand and MPN (Manufacturer Part Number) to identify a product. This field will not be returned if one or more <b>FeatureID</b> fields are included in the call request and <code>BrandMPNIdentifierEnabled</code> is not one of the values passed into those <a href="types/FeatureIDCodeType.html">FeatureID</a> fields.
GetCategoryFeatures
DetailLevel: none, ReturnSummary, ReturnAll
Conditionally
This field is returned as an empty element (a boolean value is not returned) if one or more eBay API-enabled sites support the Best Offer Auto-Accept feature. The Best Offer Auto-Accept feature allows a seller to set a threshold dollar value on a listing, and any Best Offer amount at or above this amount is automatically accepted by the eBay system. This field will not be returned if one or more <b>FeatureID</b> fields are included in the call request and <code>BestOfferAutoAcceptEnabled</code> is not one of the values passed into those <a href="types/FeatureIDCodeType.html">FeatureID</a> fields.
<br/><br/>
<span class="tablenote"><b>Note: </b>
The Best Offer feature is now available for auction listings on the following sites: US, Canada, UK, Germany, Australia, France, Italy, and Spain. However, sellers must choose between offering Best Offer or Buy It Now on an auction listing, as both features cannot be enabled on the same auction listing.
</span>
GetCategoryFeatures
DetailLevel: none, ReturnSummary, ReturnAll
Conditionally
This field is returned as an empty element (a boolean value is not returned) if one or more eBay API-enabled sites support the Best Offer Auto-Accept feature for classified ad listings. The Best Offer Auto-Accept feature allows a seller to set a threshold dollar value on a listing, and any Best Offer amount at or above this amount is automatically accepted by the eBay system. This field will not be returned if one or more <b>FeatureID</b> fields are included in the call request and <code>ClassifiedAdAutoAcceptEnabled</code> is not one of the values passed into those <a href="types/FeatureIDCodeType.html">FeatureID</a> fields.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
This field is returned as an empty element (a boolean value is not returned) if one or more eBay API-enabled sites support cross-border trading on the US and CA (English) sites. In cross-border trading, also referred to as International site visibility, a seller is able to post a listing to an additional eBay site for an additional small fee. This field will not be returned if one or more <b>FeatureID</b> fields are included in the call request and <code>CrossBorderTradeNorthAmericaEnabled</code> is not one of the values passed into those <a href="types/FeatureIDCodeType.html">FeatureID</a> fields.
GetCategoryFeatures
DetailLevel: none, ReturnSummary, ReturnAll
Conditionally
This field is returned as an empty element (a boolean value is not returned) if one or more eBay API-enabled sites support cross-border trading on the UK and Ireland sites. In cross-border trading, also referred to as International site visibility, a seller is able to post a listing to an additional eBay site for an additional small fee. This field will not be returned if one or more <b>FeatureID</b> fields are included in the call request and <code>CrossBorderTradeGBEnabled</code> is not one of the values passed into those <a href="types/FeatureIDCodeType.html">FeatureID</a> fields.
GetCategoryFeatures
DetailLevel: none, ReturnSummary, ReturnAll
Conditionally
This field is for future use, as cross-border trading (aka International site visibility) is not currently supported for Australia.
GetCategoryFeatures
DetailLevel: none, ReturnSummary, ReturnAll
Conditionally
This field is returned as an empty element (a boolean value is not returned) if one or more eBay API-enabled sites support PayPal Purchase Protection. This field will not be returned if one or more <b>FeatureID</b> fields are included in the call request and <code>PayPalBuyerProtectionEnabled</code> is not one of the values passed into those <a href="types/FeatureIDCodeType.html">FeatureID</a> fields.
GetCategoryFeatures
DetailLevel: none, ReturnSummary, ReturnAll
Conditionally
This field is deprecated.
GetCategoryFeatures
DetailLevel: none, ReturnSummary, ReturnAll
Conditionally
This field is deprecated.
This field is deprecated.
GetCategoryFeatures
DetailLevel: none, ReturnSummary, ReturnAll
Conditionally
This field is returned as an empty element (a boolean value is not returned) if one or more eBay API-enabled sites support PaisaPay Full Escrow workflow timeline.This field will not be returned if one or more <b>FeatureID</b> fields are included in the call request and <code>INEscrowWorkflowTimeline</code> is not one of the values passed into those <a href="types/FeatureIDCodeType.html">FeatureID</a> fields.
GetCategoryFeatures
DetailLevel: none, ReturnSummary, ReturnAll
Conditionally
This field is returned as an empty element (a boolean value is not returned) if one or more eBay API-enabled sites require that PayPal is included as an accepted payment method. This is not applicable to classified ad listings, as payment is handled by the buyer and seller, and not eBay. This field will not be returned if one or more <b>FeatureID</b> fields are included in the call request and <code>PayPalRequired</code> is not one of the values passed into those <a href="types/FeatureIDCodeType.html">FeatureID</a> fields.
GetCategoryFeatures
DetailLevel: none, ReturnSummary, ReturnAll
Conditionally
This field is returned as an empty element (a boolean value is not returned) if one or more eBay API-enabled sites support motor vehicle classified ad listings. This field will not be returned if one or more <b>FeatureID</b> fields are included in the call request and <code>eBayMotorsProAdFormatEnabled</code> is not one of the values passed into those <a href="types/FeatureIDCodeType.html">FeatureID</a> fields.
GetCategoryFeatures
DetailLevel: none, ReturnSummary, ReturnAll
Conditionally
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 a phone number when contacting the
seller about a motor vehicle classified ad listing. This field will not be returned if one or more <b>FeatureID</b> fields are included in the call request and <code>eBayMotorsProContactByPhoneEnabled</code> is not one of the values passed into those <a href="types/FeatureIDCodeType.html">FeatureID</a> fields.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
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 multiple phone numbers for the seller for a motor vehicle classified ad listing. This field will not be returned if one or more <b>FeatureID</b> fields are included in the call request and <code>eBayMotorsProContactByPhoneEnabled</code> is not one of the values passed into those <a href="types/FeatureIDCodeType.html">FeatureID</a> fields.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
TThis 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 an address when contacting the
seller about a motor vehicle classified ad listing. This field will not be returned if one or more <b>FeatureID</b> fields are included in the call request and <code>eBayMotorsProContactByAddressEnabled</code> is not one of the values passed into those <a href="types/FeatureIDCodeType.html">FeatureID</a> fields.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
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 multiple street address for the seller for a motor vehicle classified ad listing. This field will not be returned if one or more <b>FeatureID</b> fields are included in the call request and <code>eBayMotorsProContactByAddressEnabled</code> is not one of the values passed into those <a href="types/FeatureIDCodeType.html">FeatureID</a> fields.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
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 a company name when contacting the
seller about a motor vehicle classified ad listing. This field will not be returned if one or more <b>FeatureID</b> fields are included in the call request and <code>eBayMotorsProCompanyNameEnabled</code> is not one of the values passed into those <a href="types/FeatureIDCodeType.html">FeatureID</a> fields.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
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 an email address when contacting the seller about a motor vehicle classified ad listing. This field will not be returned if one or more <b>FeatureID</b> fields are included in the call request and <code>eBayMotorsProContactByEmailEnabled</code> is not one of the values passed into those <a href="types/FeatureIDCodeType.html">FeatureID</a> fields.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
This field is returned as an empty element (a boolean value is not returned) if one or more eBay API-enabled sites support the Best Offer feature is for motor vehicle classified ad listings. The Best Offer feature allows buyers and sellers to negotiate the price of the item. This field will not be returned if one or more <b>FeatureID</b> fields are included in the call request and <code>eBayMotorsProBestOfferEnabled</code> is not one of the values passed into those <a href="types/FeatureIDCodeType.html">FeatureID</a> fields.
GetCategoryFeatures
DetailLevel: none, ReturnSummary, ReturnAll
Conditionally
This field is returned as an empty element (a boolean value is not returned) if one or more eBay API-enabled sites support the Best Offer Auto-Accept feature for motor vehicle classified ad listings. The Best Offer Auto-Accept feature allows a seller to set a threshold dollar value on a listing, and any Best Offer amount at or above this amount is automatically accepted by the eBay system. This field will not be returned if one or more <b>FeatureID</b> fields are included in the call request and <code>eBayMotorsProAutoAcceptEnabled</code> is not one of the values passed into those <a href="types/FeatureIDCodeType.html">FeatureID</a> fields.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
This field is returned as an empty element (a boolean value is not returned) if one or more eBay API-enabled sites support the Best Offer Auto-Decline feature for motor vehicle classified ad listings. The Best Offer Auto-Decline feature allows a seller to set a lower threshold dollar value on a listing, and any Best Offer amount below this amount is automatically declined by the eBay system. This field will not be returned if one or more <b>FeatureID</b> fields are included in the call request and <code>eBayMotorsProAutoDeclineEnabled</code> is not one of the values passed into those <a href="types/FeatureIDCodeType.html">FeatureID</a> fields.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
This field is returned as an empty element (a boolean value is not returned) if one or more eBay API-enabled sites allow for the display of acceptable payment methods for motor vehicle classified ad listings. This field will not be returned if one or more <b>FeatureID</b> fields are included in the call request and <code>eBayMotorsProPaymentMethodCheckOutEnabled</code> is not one of the values passed into those <a href="types/FeatureIDCodeType.html">FeatureID</a> fields.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
This field is returned as an empty element (a boolean value is not returned) if one or more eBay API-enabled sites allow for the display of shipping service options for motor vehicle classified ad listings. This field will not be returned if one or more <b>FeatureID</b> fields are included in the call request and <code>eBayMotorsProShippingMethodEnabled</code> is not one of the values passed into those <a href="types/FeatureIDCodeType.html">FeatureID</a> fields.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
This field is returned as an empty element (a boolean value is not returned) if one or more eBay API-enabled sites support counter offers to Best Offers for motor vehicle classified ad listings. The Best Offer feature allows buyers and sellers to negotiate the price of the item, and once a Best Offer price is proposed, the seller can send the buyer a counter offer, and a buyer may even send another counter offer to the seller's counter offer. This field will not be returned if one or more <b>FeatureID</b> fields are included in the call request and <code>eBayMotorsProCounterOfferEnabled</code> is not one of the values passed into those <a href="types/FeatureIDCodeType.html">FeatureID</a> fields.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
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 motor vehicle classified ad listing. This feature is only applicable to motor vehicle classified ad listings. This field will not be returned if one or more <b>FeatureID</b> fields are included in the call request and <code>eBayMotorsProSellerContactDetailsEnabled</code> is not one of the values passed into those <a href="types/FeatureIDCodeType.html">FeatureID</a> fields.
GetCategoryFeatures
DetailLevel: none, ReturnSummary, ReturnAll
Conditionally
This field is returned as an empty element (a boolean value is not returned) if one or more eBay API-enabled sites support Motors Local Market listings. This field will not be returned if one or more <b>FeatureID</b> fields are included in the call request and <code>LocalMarketAdFormatEnabled</code> is not one of the values passed into those <a href="types/FeatureIDCodeType.html">FeatureID</a> fields.
GetCategoryFeatures
DetailLevel: none, ReturnSummary, ReturnAll
Conditionally
This field is returned as an empty element (a boolean value is not returned) if one or more eBay API-enabled sites allow the use of a phone number when contacting the
seller about a Motors Local Market listing. This field will not be returned if one or more <b>FeatureID</b> fields are included in the call request and <code>LocalMarketContactByPhoneEnabled</code> is not one of the values passed into those <a href="types/FeatureIDCodeType.html">FeatureID</a> fields.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
This field is returned as an empty element (a boolean value is not returned) if one or more eBay API-enabled sites allow the use of multiple phone numbers for the seller for a Motors Local Market listing. This field will not be returned if one or more <b>FeatureID</b> fields are included in the call request and <code>LocalMarketPhoneCount</code> is not one of the values passed into those <a href="types/FeatureIDCodeType.html">FeatureID</a> fields.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
This field is returned as an empty element (a boolean value is not returned) if one or more eBay API-enabled sites allow the use of an address when contacting the
seller about a Motors Local Market listing. This field will not be returned if one or more <b>FeatureID</b> fields are included in the call request and <code>LocalMarketContactByAddressEnabled</code> is not one of the values passed into those <a href="types/FeatureIDCodeType.html">FeatureID</a> fields.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
This field is returned as an empty element (a boolean value is not returned) if one or more eBay API-enabled sites allow the use of multiple street address for the seller for a Motors Local Market listing. This field will not be returned if one or more <b>FeatureID</b> fields are included in the call request and <code>LocalMarketStreetCount</code> is not one of the values passed into those <a href="types/FeatureIDCodeType.html">FeatureID</a> fields.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
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 a company name when contacting the
seller about a Motors Local Market listing. This field will not be returned if one or more <b>FeatureID</b> fields are included in the call request and <code>LocalMarketCompanyNameEnabled</code> is not one of the values passed into those <a href="types/FeatureIDCodeType.html">FeatureID</a> fields.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
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 an email address when contacting the seller about a Motors Local Market listing. This field will not be returned if one or more <b>FeatureID</b> fields are included in the call request and <code>LocalMarketContactByEmailEnabled</code> is not one of the values passed into those <a href="types/FeatureIDCodeType.html">FeatureID</a> fields.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
This field is returned as an empty element (a boolean value is not returned) if one or more eBay API-enabled sites support the Best Offer feature is for Motors Local Market listings. The Best Offer feature allows buyers and sellers to negotiate the price of the item. This field will not be returned if one or more <b>FeatureID</b> fields are included in the call request and <code>LocalMarketBestOfferEnabled</code> is not one of the values passed into those <a href="types/FeatureIDCodeType.html">FeatureID</a> fields.
GetCategoryFeatures
DetailLevel: none, ReturnSummary, ReturnAll
Conditionally
This field is returned as an empty element (a boolean value is not returned) if one or more eBay API-enabled sites support the Best Offer Auto-Accept feature for Motors Local Market listings. The Best Offer Auto-Accept feature allows a seller to set a threshold dollar value on a listing, and any Best Offer amount at or above this amount is automatically accepted by the eBay system. This field will not be returned if one or more <b>FeatureID</b> fields are included in the call request and <code>LocalMarketAutoAcceptEnabled</code> is not one of the values passed into those <a href="types/FeatureIDCodeType.html">FeatureID</a> fields.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
This field is returned as an empty element (a boolean value is not returned) if one or more eBay API-enabled sites support the Best Offer Auto-Decline feature for Motors Local Market listings. The Best Offer Auto-Accept feature allows a seller to set a threshold dollar value on a listing, and any Best Offer amount at or above this amount is automatically accepted by the eBay system. This field will not be returned if one or more <b>FeatureID</b> fields are included in the call request and <code>LocalMarketAutoDeclineEnabled</code> is not one of the values passed into those <a href="types/FeatureIDCodeType.html">FeatureID</a> fields.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
This field is returned as an empty element (a boolean value is not returned) if one or more eBay API-enabled sites allow for the display of acceptable payment methods for Motors Local Market listings. This field will not be returned if one or more <b>FeatureID</b> fields are included in the call request and <code>LocalMarketPaymentMethodCheckOutEnabled</code> is not one of the values passed into those <a href="types/FeatureIDCodeType.html">FeatureID</a> fields.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
This field is returned as an empty element (a boolean value is not returned) if one or more eBay API-enabled sites allow for the display of shipping service options for Motors Local Market listings. This field will not be returned if one or more <b>FeatureID</b> fields are included in the call request and <code>LocalMarketShippingMethodEnabled</code> is not one of the values passed into those <a href="types/FeatureIDCodeType.html">FeatureID</a> fields.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
This field is returned as an empty element (a boolean value is not returned) if one or more eBay API-enabled sites support counter offers to Best Offers for Motors Local Market listings. The Best Offer feature allows buyers and sellers to negotiate the price of the item, and once a Best Offer price is proposed, the seller can send the buyer a counter offer, and a buyer may even send another counter offer to the seller's counter offer. This field will not be returned if one or more <b>FeatureID</b> fields are included in the call request and <code>LocalMarketCounterOfferEnabled</code> is not one of the values passed into those <a href="types/FeatureIDCodeType.html">FeatureID</a> fields.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
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 Motors Local Market listings. This feature is only applicable to motor vehicle classified ad listings. This field will not be returned if one or more <b>FeatureID</b> fields are included in the call request and <code>LocalMarketSellerContactDetailsEnabled</code> is not one of the values passed into those <a href="types/FeatureIDCodeType.html">FeatureID</a> fields.
GetCategoryFeatures
DetailLevel: none, ReturnSummary, ReturnAll
Conditionally
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 multiple phone numbers for the seller for a classified ad listing. This field will not be returned if one or more <b>FeatureID</b> fields are included in the call request and <code>ClassifiedAdPhoneCount</code> is not one of the values passed into those <a href="types/FeatureIDCodeType.html">FeatureID</a> fields.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
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 an address when contacting the
seller about a classified ad listing. This field will not be returned if one or more <b>FeatureID</b> fields are included in the call request and <code>ClassifiedAdContactByAddressEnabled</code> is not one of the values passed into those <a href="types/FeatureIDCodeType.html">FeatureID</a>
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
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 multiple street addresses for the seller for a classified ad listing. This field will not be returned if one or more <b>FeatureID</b> fields are included in the call request and <code>ClassifiedAdStreetCount</code> is not one of the values passed into those <a href="types/FeatureIDCodeType.html">FeatureID</a> fields.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
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 a company name when contacting the
seller about a classified ad listing. This field will not be returned if one or more <b>FeatureID</b> fields are included in the call request and <code>ClassifiedAdCompanyNameEnabled</code> is not one of the values passed into those <a href="types/FeatureIDCodeType.html">FeatureID</a> fields.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
This field is deprecated.
GetCategoryFeatures
DetailLevel: none, ReturnSummary, ReturnAll
Conditionally
This field is deprecated.
GetCategoryFeatures
DetailLevel: none, ReturnSummary, ReturnAll
Conditionally
This field is deprecated.
GetCategoryFeatures
DetailLevel: none, ReturnSummary, ReturnAll
Conditionally
This field is deprecated.
GetCategoryFeatures
DetailLevel: none, ReturnSummary, ReturnAll
Conditionally
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 return policies in listings. This field will not be returned if one or more <b>FeatureID</b> fields are included in the call request and <code>ReturnPolicyEnabled</code> is not one of the values passed into those <a href="types/FeatureIDCodeType.html">FeatureID</a> fields.
GetCategoryFeatures
DetailLevel: none, ReturnSummary, ReturnAll
Conditionally
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 a stated handling time in listings. The handling time is the maximum number of business days the seller
commits to for preparing an item to be shipped after receiving a
cleared payment. The seller's handling time does not include the
shipping time (the carrier's transit time). This field will not be returned if one or more <b>FeatureID</b> fields are included in the call request and <code>HandlingTimeEnabled</code> is not one of the values passed into those <a href="types/FeatureIDCodeType.html">FeatureID</a> fields.
GetCategoryFeatures
DetailLevel: none, ReturnSummary, ReturnAll
Conditionally
This field is deprecated.
This field is returned as an empty element (a boolean value is not returned) if one or more eBay API-enabled sites allow the quantity of a listing to be revised during the life of the listing. This feature is not applicable to auction listings. This field will not be returned if one or more <b>FeatureID</b> fields are included in the call request and <code>ReviseQuantityAllowed</code> is not one of the values passed into those <a href="types/FeatureIDCodeType.html">FeatureID</a> fields.
GetCategoryFeatures
DetailLevel: none, ReturnSummary, ReturnAll
Conditionally
This field is returned as an empty element (a boolean value is not returned) if one or more eBay API-enabled sites allow the price of a listing to be revised during the life of the listing. This feature is not applicable to auction listings. This field will not be returned if one or more <b>FeatureID</b> fields are included in the call request and <code>RevisePriceAllowed</code> is not one of the values passed into those <a href="types/FeatureIDCodeType.html">FeatureID</a> fields.
GetCategoryFeatures
DetailLevel: none, ReturnSummary, ReturnAll
Conditionally
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. This field will not be returned if one or more <b>FeatureID</b> fields are included in the call request and <code>RevisePriceAllowed</code> is not one of the values passed into those <a href="types/FeatureIDCodeType.html">FeatureID</a> fields.
GetCategoryFeatures
DetailLevel: none, ReturnSummary, ReturnAll
Conditionally
This field is deprecated.
GetCategoryFeatures
DetailLevel: none, ReturnSummary, ReturnAll
Conditionally
This field is returned as an empty element (a boolean value is not returned) if one or more eBay API-enabled sites allow for the display of acceptable payment methods in listings. This field will not be returned if one or more <b>FeatureID</b> fields are included in the call request and <code>PaymentMethod</code> is not one of the values passed into those <a href="types/FeatureIDCodeType.html">FeatureID</a> fields.
GetCategoryFeatures
DetailLevel: none, ReturnSummary, ReturnAll
Conditionally
This field is returned as an empty element (a boolean value is not returned) if one or more eBay API-enabled sites allow for the applicable max cap per shipping cost for shipping service group1. This field will not be returned if one or more <b>FeatureID</b> fields are included in the call request and <code>Group1MaxFlatShippingCost</code> is not one of the values passed into those <a href="types/FeatureIDCodeType.html">FeatureID</a> fields.
GetCategoryFeatures
DetailLevel: none, ReturnSummary, ReturnAll
Conditionally
This field is returned as an empty element (a boolean value is not returned) if one or more eBay API-enabled sites allow for the applicable max cap per shipping cost for shipping service group2. This field will not be returned if one or more <b>FeatureID</b> fields are included in the call request and <code>Group2MaxFlatShippingCost</code> is not one of the values passed into those <a href="types/FeatureIDCodeType.html">FeatureID</a> fields.
GetCategoryFeatures
DetailLevel: none, ReturnSummary, ReturnAll
Conditionally
TThis field is returned as an empty element (a boolean value is not returned) if one or more eBay API-enabled sites allow for the applicable max cap per shipping cost for shipping service group3. This field will not be returned if one or more <b>FeatureID</b> fields are included in the call request and <code>Group3MaxFlatShippingCost</code> is not one of the values passed into those <a href="types/FeatureIDCodeType.html">FeatureID</a> fields.
GetCategoryFeatures
DetailLevel: none, ReturnSummary, ReturnAll
Conditionally
This field is returned as an empty element (a boolean value is not returned) if one or more eBay API-enabled sites do not impose a maximum flat-rate shipping cost if the item is being shipped internationally. This field will not be returned if one or more <b>FeatureID</b> fields are included in the call request and <code>MaxFlatShippingCostCBTExempt</code> is not one of the values passed into those <a href="types/FeatureIDCodeType.html">FeatureID</a> fields.
GetCategoryFeatures
DetailLevel: none, ReturnSummary, ReturnAll
Conditionally
This field is returned as an empty element (a boolean value is not returned) if one or more eBay API-enabled sites do not impose a maximum flat-rate shipping cost. This field will not be returned if one or more <b>FeatureID</b> fields are included in the call request and <code>MaxFlatShippingCost</code> is not one of the values passed into those <a href="types/FeatureIDCodeType.html">FeatureID</a> fields.
GetCategoryFeatures
DetailLevel: none, ReturnSummary, ReturnAll
Conditionally
This field is returned as an empty element (a boolean value is not returned) if one or more eBay API-enabled sites support multiple-variation listings for some categories. Multiple-variation listings contain items that are logically the same product, but that vary in color, size, or other aspect. For example, a particular brand and style of shirt could be available in different sizes and colors, such as "large blue" and "medium black" variations. This feature is only applicable to fixed-price listings. This field will not be returned if one or more <b>FeatureID</b> fields are included in the call request and <code>VariationsEnabled</code> is not one of the values passed into those <a href="types/FeatureIDCodeType.html">FeatureID</a> fields.
GetCategoryFeatures
DetailLevel: none, ReturnSummary, ReturnAll
Conditionally
This field is deprecated.
This field is returned as an empty element (a boolean value is not returned) if one or more eBay API-enabled sites support free, automatic upgrades for Gallery Plus for some categories. This field will not be returned if one or more <b>FeatureID</b> fields are included in the call request and <code>FreeGalleryPlusEnabled</code> is not one of the values passed into those <a href="types/FeatureIDCodeType.html">FeatureID</a> fields.
GetCategoryFeatures
DetailLevel: none, ReturnSummary, ReturnAll
Conditionally
This field is returned as an empty element (a boolean value is not returned) if one or more eBay API-enabled sites support a free Picture Pack upgrade for some categories. This field will not be returned if one or more <b>FeatureID</b> fields are included in the call request and <code>FreePicturePackEnabled</code> is not one of the values passed into those <a href="types/FeatureIDCodeType.html">FeatureID</a> fields.
GetCategoryFeatures
DetailLevel: none, ReturnSummary, ReturnAll
Conditionally
This field is returned as an empty element (a boolean value is not returned) if one or more eBay API-enabled sites support Parts Compatibility for some Parts & Accessories categories. Parts compatibility allows a seller to show a list of all the vehicles that a part or accessory is compatible with in a listing. This field will not be returned if one or more <b>FeatureID</b> fields are included in the call request and <code>ItemCompatibilityEnabled</code> is not one of the values passed into those <a href="types/FeatureIDCodeType.html">FeatureID</a> fields.
GetCategoryFeatures
DetailLevel: none, ReturnSummary, ReturnAll
Conditionally
This field is returned as an empty element (a boolean value is not returned) if one or more eBay API-enabled sites define a maximum limit for the number of compatible applications for items listed with parts compatibilities by application. Parts compatibility allows a seller to show a list of all the vehicles that a part or accessory is compatible with in a listing. This field will not be returned if one or more <b>FeatureID</b> fields are included in the call request and <code>MaxItemCompatibility</code> is not one of the values passed into those <a href="types/FeatureIDCodeType.html">FeatureID</a> fields.
GetCategoryFeatures
DetailLevel: none, ReturnSummary, ReturnAll
Conditionally
This field is returned as an empty element (a boolean value is not returned) if one or more eBay API-enabled sites define a minimum amount for the number of compatible applications for items listed with parts compatibilities by application. Parts compatibility allows a seller to show a list of all the vehicles that a part or accessory is compatible with in a listing. This field will not be returned if one or more <b>FeatureID</b> fields are included in the call request and <code>MinItemCompatibility</code> is not one of the values passed into those <a href="types/FeatureIDCodeType.html">FeatureID</a> fields.
GetCategoryFeatures
DetailLevel: none, ReturnSummary, ReturnAll
Conditionally
This field is returned as an empty element (a boolean value is not returned) if one or more eBay API-enabled sites support the textual description of an item's condition at listing time. This field will not be returned if one or more <b>FeatureID</b> fields are included in the call request and <code>ConditionEnabled</code> is not one of the values passed into those <a href="types/FeatureIDCodeType.html">FeatureID</a> fields.
GetCategoryFeatures
DetailLevel: none, ReturnSummary, ReturnAll
Conditionally
This field is returned as an empty element (a boolean value is not returned) if one or more eBay API-enabled sites support Condition IDs to specify an item's condition at listing time. This field will not be returned if one or more <b>FeatureID</b> fields are included in the call request and <code>ConditionValues</code> is not one of the values passed into those <a href="types/FeatureIDCodeType.html">FeatureID</a> fields.
GetCategoryFeatures
DetailLevel: none, ReturnSummary, ReturnAll
Conditionally
This field is returned as an empty element (a boolean value is not returned) if one or more eBay API-enabled sites support value categories. A Value category will typically have lower listing fees or another eBay promotion. This field will not be returned if one or more <b>FeatureID</b> fields are included in the call request and <code>ValueCategory</code> is not one of the values passed into those <a href="types/FeatureIDCodeType.html">FeatureID</a> fields.
GetCategoryFeatures
DetailLevel: none, ReturnSummary, ReturnAll
Conditionally
This field is returned as an empty element (a boolean value is not returned) if one or more eBay API-enabled sites support the creation of listings through the specification of Global Trade Identification Numbers (GTINs) like UPC, ISBN, EAN, or Brand/MPN combination. If a GTIN is matched to a product in eBay product catalog, a listing will automatically be created using the eBay catalog product's images, product aspects, description, and title. This field will not be returned if one or more <b>FeatureID</b> fields are included in the call request and <code>ProductCreationEnabled</code> is not one of the values passed into those <a href="types/FeatureIDCodeType.html">FeatureID</a> fields.
GetCategoryFeatures
DetailLevel: none, ReturnSummary, ReturnAll
Conditionally
This field is returned as an empty element (a boolean value is not returned) if one or more eBay API-enabled sites support the EAN product identifying feature. This field will be returned as long as <b>EANEnabled</b> is included as a <b>FeatureID</b> value in the call request or no <b>FeatureID</b> values are passed into the call request.
<br>
<br>
To verify if a specific eBay site supports the EAN product identifying feature (for most categories), look for a <code>true</code> value in the <b>SiteDefaults.EANEnabled</b> field.
<br>
<br>
To verify if a specific category on a specific eBay site supports the EAN product identifying feature, pass in a <b>CategoryID</b> value in the request, and then look for a <code>true</code> value in the <b>EANEnabled</b> field of the corresponding <b>Category</b> node (match up the <b>CategoryID</b> values if more than one Category IDs were passed in the request).
GetCategoryFeatures
DetailLevel: none, ReturnSummary, ReturnAll
Conditionally
This field is returned as an empty element (a boolean value is not returned) if one or more eBay API-enabled sites support the ISBN product identifying feature. This field will be returned as long as <b>ISBNEnabled</b> is included as a <b>FeatureID</b> value in the call request or no <b>FeatureID</b> values are passed into the call request.
<br>
<br>
To verify if a specific eBay site supports the ISBN product identifying feature (for most categories), look for a <code>true</code> value in the <b>SiteDefaults.ISBNEnabled</b> field.
<br>
<br>
To verify if a specific category on a specific eBay site supports the ISBN product identifying feature, pass in a <b>CategoryID</b> value in the request, and then look for a <code>true</code> value in the <b>ISBNEnabled</b> field of the corresponding <b>Category</b> node (match up the <b>CategoryID</b> values if more than one Category IDs were passed in the request).
GetCategoryFeatures
DetailLevel: none, ReturnSummary, ReturnAll
Conditionally
This field is returned as an empty element (a boolean value is not returned) if one or more eBay API-enabled sites support the UPC product identifying feature. This field will be returned as long as <b>UPCEnabled</b> is included as a <b>FeatureID</b> value in the call request or no <b>FeatureID</b> values are passed into the call request.
<br>
<br>
To verify if a specific eBay site supports the UPC product identifying feature (for most categories), look for a <code>true</code> value in the <b>SiteDefaults.UPCEnabled</b> field.
<br>
<br>
To verify if a specific category on a specific eBay site supports the UPC product identifying feature, pass in a <b>CategoryID</b> value in the request, and then look for a <code>true</code> value in the <b>UPCEnabled</b> field of the corresponding <b>Category</b> node (match up the <b>CategoryID</b> values if more than one Category IDs were passed in the request).
GetCategoryFeatures
DetailLevel: none, ReturnSummary, ReturnAll
Conditionally
This field is returned as an empty element (a boolean value is not returned) if one or more eBay API-enabled sites support the Parts Compatibility feature for motor vehicles. This field will not be returned if one or more <b>FeatureID</b> fields are included in the call request and <code>CompatibleVehicleType</code> is not one of the values passed into those <a href="types/FeatureIDCodeType.html">FeatureID</a> fields.
GetCategoryFeatures
DetailLevel: none, ReturnSummary, ReturnAll
Conditionally
This field is returned as an empty element (a boolean value is not returned) if one or more eBay API-enabled sites define a maximum limit for the number of fine-grained item compatibilities that can be applied to a listing. This field will not be returned if one or more <b>FeatureID</b> fields are included in the call request and <code>MaxGranularFitmentCount</code> is not one of the values passed into those <a href="types/FeatureIDCodeType.html">FeatureID</a> fields.
GetCategoryFeatures
DetailLevel: none, ReturnSummary, ReturnAll
Conditionally
This field is deprecated.
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. This field will not be returned if one or more <b>FeatureID</b> fields are included in the call request and <code>ShippingProfileCategoryGroup</code> is not one of the values passed into those <a href="types/FeatureIDCodeType.html">FeatureID</a> fields.
GetCategoryFeatures
DetailLevel: none, ReturnSummary, ReturnAll
Conditionally
TThis 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 payment business policies. This field will not be returned if one or more <b>FeatureID</b> fields are included in the call request and <code>PaymentProfileCategoryGroup</code> is not one of the values passed into those <a href="types/FeatureIDCodeType.html">FeatureID</a> fields.
GetCategoryFeatures
DetailLevel: none, ReturnSummary, ReturnAll
Conditionally
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 return business policies. This field will not be returned if one or more <b>FeatureID</b> fields are included in the call request and <code>ReturnPolicyProfileCategoryGroup</code> is not one of the values passed into those <a href="types/FeatureIDCodeType.html">FeatureID</a> fields.
GetCategoryFeatures
DetailLevel: none, ReturnSummary, ReturnAll
Conditionally
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 the VIN (Vehicle Identification Number) field to identify a motor vehicle and create a listing is supported. VINs are supported on the US, Canada, Canada-French, and Australia sites. This field will not be returned if one or more <b>FeatureID</b> fields are included in the call request and <code>VINSupported</code> is not one of the values passed into those <a href="types/FeatureIDCodeType.html">FeatureID</a> fields.
GetCategoryFeatures
DetailLevel: none, ReturnSummary, ReturnAll
Conditionally
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 the VRM (Vehicle Registration Mark) field to identify a motor vehicle and create a listing is supported. VRMs are only supported on the UK site. This field will not be returned if one or more <b>FeatureID</b> fields are included in the call request and <code>VRMSupported</code> is not one of the values passed into those <a href="types/FeatureIDCodeType.html">FeatureID</a> fields.
GetCategoryFeatures
DetailLevel: none, ReturnSummary, ReturnAll
Conditionally
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. This field will not be returned if one or more <b>FeatureID</b> fields are included in the call request and <code>SellerProvidedTitleSupported</code> is not one of the values passed into those <a href="types/FeatureIDCodeType.html">FeatureID</a> fields.
GetCategoryFeatures
DetailLevel: none, ReturnSummary, ReturnAll
Conditionally
This field is returned as an empty element (a boolean value is not returned) if one or more eBay API-enabled sites support deposits/down payments for motor vehicle listings. This field will not be returned if one or more <b>FeatureID</b> fields are included in the call request and <code>DepositSupported</code> is not one of the values passed into those <a href="types/FeatureIDCodeType.html">FeatureID</a> fields.
GetCategoryFeatures
DetailLevel: none, ReturnSummary, ReturnAll
Conditionally
This field is returned as an empty element (a boolean value is not returned) if one or more eBay API-enabled sites support the Global Shipping Program (GSP) as the method for shipping orders internationally. This field will not be returned if one or more <b>FeatureID</b> fields are included in the call request and <code>GlobalShippingEnabled</code> is not one of the values passed into those <a href="types/FeatureIDCodeType.html">FeatureID</a> fields.
GetCategoryFeatures
DetailLevel: none, ReturnSummary, ReturnAll
Conditionally
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. This field will be returned as long as <b>AdditionalCompatibilityEnabled</b> is included as a <b>FeatureID</b> value in the call request or no <a href="types/FeatureIDCodeType.html">FeatureID</a> values are passed into the call request.
<br>
<br>
To verify if a specific eBay site supports Boat or Motorcycle Parts Compatibility (for most categories), look for a <code>true</code> value in the <b>SiteDefaults.AdditionalCompatibilityEnabled</b> field.
<br>
<br>
To verify if a specific category on a specific eBay site supports Boat and Motorcycle Parts Compatibility, pass in a
<b>CategoryID</b> value in the request, and then look for a
<code>true</code>
<br> value in the <b>AdditionalCompatibilityEnabled</b> field of the corresponding <b>Category</b> node (match up the <b>CategoryID</b> values if more than one Category IDs were passed in the request).
GetCategoryFeatures
DetailLevel: none, ReturnSummary, ReturnAll
Conditionally
This field is returned as an empty element (a boolean value is not returned) if one or more eBay API-enabled sites support the Click and Collect feature. This field will be returned as long as <b>PickupDropOffEnabled</b> is included as a <b>FeatureID</b> value in the call request or no <a href="types/FeatureIDCodeType.html">FeatureID</a> values are passed into the call request.
<br>
<br>
To verify if a specific eBay site supports the Click and Collect feature (for most categories), look for a <code>true</code> value in the <b>SiteDefaults.PickupDropOffEnabled</b> field.
<br>
<br>
To verify if a specific category on a specific eBay site supports the Click and Collect feature, pass in a <b>CategoryID</b> value in the request, and then look for a <code>true</code> value in the <b>PickupDropOffEnabled</b> field of the corresponding <b>Category</b> node (match up the <b>CategoryID</b> values if more than one Category IDs were passed in the request).
<br>
<br>
<span class="tablenote"><b>Note:</b> For Click and Collect eligible sellers, the Click and Collect feature can only be enabled at the account level, and then each of the seller's listings within an Click and Collect enabled category will be automatically evaluated for Click and Collect eligibility.
</span>
GetCategoryFeatures
DetailLevel: none, ReturnSummary, ReturnAll
Conditionally
This field is returned as an empty element (a boolean value is not returned) if one or more eBay API-enabled sites support digital gift card listings. This field will be returned as long as <b>DigitalGoodDeliveryEnabled</b> is included as a <b>FeatureID</b> value in the call request or no <a href="types/FeatureIDCodeType.html">FeatureID</a> values are passed into the call request.
<br>
<br>
To verify if a specific eBay site supports digital gift card listings (for most categories), look for a <code>true</code> value in the <b>SiteDefaults.DigitalGoodDeliveryEnabled</b> field.
<br>
<br>
To verify if a specific category on a specific eBay site supports digital gift card listings, pass in a <b>CategoryID</b> value in the request, and then look for a <code>true</code> value in the <b>DigitalGoodDeliveryEnabled</b> field of the corresponding <b>Category</b> node (match up the <b>CategoryID</b> values if more than one Category IDs were passed in the request).
<br>
<br>
Digital gift cards are currently only supported on the US site. There are some restrictions when it comes to selling gift cards, including the following:
<ul>
<li>Each seller can only have one gift card listing at any given time </li>
<li>The maximum dollar value of the gift card may not exceed 500.00</li>
<li>Prepaid credit cards from American Express, Discover, MasterCard, or Visa are not allowed</li>
</ul>
For more information on eBay's Gift Card policy, see the <a href="
https://www.ebay.com/help/policies/prohibited-restricted-items/gift-cards-policy?id=4294" target="_blank">Gift cards policy</a> help page.
GetCategoryFeatures
DetailLevel: none, ReturnSummary, ReturnAll
Conditionally
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 an eBay Product ID (e.g. ePID) in an Add/Revise/Relist API call to identify which motorcycles and/or scooters are compatible with a motor vehicle part or accessory. ePIDs can only be used to identify motorcycles and scooters on the Germany and UK sites. This field will be returned as long as <b>EpidSupported</b> is included as a <b>FeatureID</b> value in the call request or no <a href="types/FeatureIDCodeType.html">FeatureID</a> values are passed into the call request.
<br/><br/>
For more information on using an ePID to identify a compatible motorcycle or scooter through an Add/Revise/Relist API call on the Germany or UK site, see the documentation for the <a href="
http://developer.ebay.com/Devzone/XML/docs/Reference/eBay/AddItem.html#Request.Item.ItemCompatibilityList.Compatibility.NameValueList">Compatibility.NameValueList</a> container.
GetCategoryFeatures
DetailLevel: none, ReturnSummary, ReturnAll
Conditionally
TThis 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 a K Type vehicle number in an Add/Revise/Relist API call to identify which cars and/or trucks are compatible with a motor vehicle part or accessory. K type vehicle numbers can only be used to identify cars and trucks on the Germany site. This field will be returned as long as <b>KTypeSupported</b> is included as a <b>FeatureID</b> value in the call request or no <a href="types/FeatureIDCodeType.html">FeatureID</a> values are passed into the call request.
<br/><br/>
For more information on using a K Type vehicle number to identify a compatible car or truck through an Add/Revise/Relist API call on the Germany site, see the documentation for the <a href="
http://developer.ebay.com/Devzone/XML/docs/Reference/eBay/AddItem.html#Request.Item.ItemCompatibilityList.Compatibility.NameValueList">Compatibility.NameValueList</a> container.
GetCategoryFeatures
DetailLevel: none, ReturnSummary, ReturnAll
Conditionally
This field is returned as an empty element (a boolean value is not returned) if one or more eBay API-enabled sites supports Product-Based Shopping Experience listings (listings associated with eBay catalog products). PBSE is currently supported by the US, UK, Germany, Australia, and Canada (English) sites. This field is only returned if <code>Enabled</code>.
<br><br>
Will not be returned if one or more <a href="types/FeatureIDCodeType.html">FeatureID</a> values are used in the call request, and one of those values does not include <code>ProductRequiredEnabled</code>.
<br><br>
<span class="tablenote"><b>Note:</b>
Due to the rollback of the Product-Based Shopping Experience mandate for all eBay categories, association with an eBay catalog product will no longer be required for any categories on any eBay marketplace.</span>
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
If present, this flag indicates the seller can set how to handle domestic returns.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
If present, this flag indicates the seller can set how to handle international returns.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
If present, this flag indicates the seller can set the time duration for domestic returns.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
If present, this flag indicates the seller can set the time duration for international returns.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
If present, this flag indicates the seller can set who pays the shipping for domestic returns.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
If present, this flag indicates the seller can set who pays the shipping for international returns.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
If present, this flag indicates the seller can set the method they use to refund domestic returns.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
If present, this flag indicates the seller can set the method they use to refund international returns.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
If present, this flag indicates the seller can choose to describe the return policy they offer (providing return-policy details is required in some EU countries).
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
Indicates whether the seller making the request can list with certain features.
A seller's eligibility is determined by their Feedback score.
Indicates whether the seller is eligible to create auction listings enabled with the 'Buy It Now' option. A value of <code>true</code> means that the seller is eligible; a value of <code>false</code> indicates that they are not eligible.
GetUser
DetailLevel: none, ReturnSummary, ReturnAll
Conditionally
Indicates whether the seller is eligible to specify the 'Buy It Now' option for multiple-quantity listings. A value of <code>true</code> means that the seller is eligible; a value of <code>false</code> indicates that they are not eligible.
GetUser
DetailLevel: none, ReturnSummary, ReturnAll
Conditionally
Indicates whether the seller is eligible to create fixed-price listings with a one-day listing duration. A value of <code>true</code> means that the seller is eligible; a value of <code>false</code> indicates that the seller is not eligible. Note that this field only controls user eligibility. The listing type and category must support this feature for this field to be applicable.
GetUser
DetailLevel: none, ReturnSummary, ReturnAll
Conditionally
Indicates whether or not the seller is eligible to create
multiple-variation, fixed-price listings.
GetUser
DetailLevel: none, ReturnSummary, ReturnAll
Always
Indicates whether the seller is eligible to create an auction listing with a one-day duration. Limitation: the Adult-Only and Motor Vehicle categories do not support one-day auctions, so the seller cannot create one-day auction listings in these categories, even if the seller has the eligibility.
GetUser
DetailLevel: none, ReturnSummary, ReturnAll
Conditionally
Enumerated type that lists all possible values that can be passed into the <b>FeatureID</b> field in a <b>GetCategoryFeatures</b> call. The <b>FeatureID</b> field is to used to check if specific listing features are enabled at the site or category level. Multiple <b>FeatureID</b> fields can be used in the request. If no <b>FeatureID</b> fields are used, the call retrieves data for all features defined within this enumerated type.
DutchBINEnabled, DigitalDeliveryEnabled, BasicUpgradePack, ExpressEnabled, ExpressPicturesRequired, ExpressConditionRequired, TransactionConfirmationRequestEnabled, StoreInventoryEnabled, MaximumBestOffersAllowed, ClassifiedAdMaximumBestOffersAllowed, ClassifiedAdContactByEmailAvailable, ClassifiedAdPayPerLeadEnabled, ISBNIdentifierEnabled, UPCIdentifierEnabled, EANIdentifierEnabled, CombinedFixedPriceTreatment, PayPalRequiredForStoreOwner, AttributeConversionEnabled, PaymentOptionsGroup, VINSupported, VRMSupported, DepositSupported, ProductCreationEnabled, SkypeMeTransactionalEnabled, SkypeMeNonTransactionalEnabled, PaisaPayFullEscrowEnabled, INEscrowWorkflowTimeline
If this value is specified, supported site-default and category-specific listing durations values for each listing type are returned in the <b>SiteDefaults.ListingDuration</b> and <b>Category.ListingDuration</b> fields of the <b>GetCategoryFeatures</b> response.
If this value is specified, the <b>SiteDefaults.BestOfferEnabled</b> and <b>Category.BestOfferEnabled</b> boolean fields in the <b>GetCategoryFeatures</b> response will indicate whether or not the specified eBay site supports the Best Offer feature, and which categories allow the Best Offer feature.
<br/><br/>
<span class="tablenote"><b>Note: </b>
The Best Offer feature can be set for auction listings on the US, Canada, UK, Germany, Australia, France, Italy, and Spain marketplaces, but keep in mind that Best Offer and Buy It Now cannot be used simultaneously in a listing. Also, once a qualifying bid is made on an auction listing, the Best Offer feature is disabled, and any pending offer or counteroffers are no longer valid.
</span>
This value is <b>deprecated</b>, as Dutch-style auctions are no longer available on any eBay sites.
If this value is specified, the <b>SiteDefaults.ShippingTermsRequired</b> and <b>Category.ShippingTermsRequired</b> boolean fields in the <b>GetCategoryFeatures</b> response will indicate whether or not the specified eBay site, and individual categories on that site, require at least one domestic shipping service option (with cost) to be specified before an item is listed.
If this value is specified, the <b>SiteDefaults.UserConsentRequired</b> boolean field in the <b>GetCategoryFeatures</b> response will indicate whether or not the specified eBay site requires a prospective bidder of an auction item to read and agree to the terms in eBay's privacy policy before bidding on the item.
If this value is specified, the <b>SiteDefaults.HomePageFeaturedEnabled</b> boolean field in the <b>GetCategoryFeatures</b> response will indicate whether or not the specified eBay site supports the featuring of items within a special area of eBay's home page. This is a listing enhancement that requires a fee, and support for this feature varies by site.
If this value is specified, the <b>SiteDefaults.AdFormatEnabled</b> and <b>Category.AdFormatEnabled</b> fields in the <b>GetCategoryFeatures</b> response will indicate whether or not the specified eBay site and individual categories support Classified Ad listings.
This value is <b>deprecated</b> and should no longer be used.
If this value is specified, the <b>SiteDefaults.BestOfferCounterEnabled</b> and <b>Category.BestOfferCounterEnabled</b> boolean fields in the <b>GetCategoryFeatures</b> response will indicate whether or not the specified eBay site supports the Best Offer counter offers, and which categories allow the Best Offer counter offers.
<br/><br/>
<span class="tablenote"><b>Note: </b>
The Best Offer feature can be set for auction listings on the US, Canada, UK, Germany, Australia, France, Italy, and Spain marketplaces, but keep in mind that Best Offer and Buy It Now cannot be used simultaneously in a listing. Also, once a qualifying bid is made on an auction listing, the Best Offer feature is disabled, and any pending offer or counteroffers are no longer valid.
</span>
If this value is specified, the <b>SiteDefaults.BestOfferAutoDeclineEnabled</b> and <b>Category.BestOfferAutoDeclineEnabled</b> boolean fields in the <b>GetCategoryFeatures</b> response will indicate whether or not the specified eBay site and individual categories support the Best Offer auto decline feature. With the Best Offer auto decline feature, the seller sets a price threshold, and all Best Offers and counter offers below this price value are automatically declined without any seller action.
<br/><br/>
<span class="tablenote"><b>Note: </b>
The Best Offer feature can be set for auction listings on the US, Canada, UK, Germany, Australia, France, Italy, and Spain marketplaces, but keep in mind that Best Offer and Buy It Now cannot be used simultaneously in a listing. Also, once a qualifying bid is made on an auction listing, the Best Offer feature is disabled, and any pending offer or counteroffers are no longer valid.
</span>
If this value is specified, the <b>SiteDefaults.ProPackEnabled</b> and <b>Category.ProPackEnabled</b> boolean fields in the <b>GetCategoryFeatures</b> response will indicate whether or not the specified eBay site and individual categories support the Pro Pack listing enhancement bundle.
This value is <b>deprecated</b> and should no longer be used.
If this value is specified, the <b>SiteDefaults.ValuePackEnabled</b> and <b>Category.ValuePackEnabled</b> boolean fields in the <b>GetCategoryFeatures</b> response will indicate whether or not the specified eBay site and individual categories support the Value Pack listing enhancement bundle. The Value Pack bundle includes the Gallery Plus feature, a listing subtitle, and use of a Listing Designer template.
If this value is specified, the <b>SiteDefaults.ProPackPlusEnabled</b> and <b>Category.ProPackPlusEnabled</b> boolean fields in the <b>GetCategoryFeatures</b> response will indicate whether or not the specified eBay site and individual categories support the Pro Pack Plus listing enhancement bundle. The Pro Pack Plus bundle includes the Bold Title, Border, Highlight, Featured, and Gallery features for a discounted price.
If this value is specified, the <b>SiteDefaults.LocalMarketSpecialitySubscription</b> boolean field in the <b>GetCategoryFeatures</b> response will indicate whether or not the specified eBay site supports Local Market listings for sellers with a specialty subscription to Local Market for Vehicles.
If this value is specified, the <b>SiteDefaults.LocalMarketRegularSubscription</b> boolean field in the <b>GetCategoryFeatures</b> response will indicate whether or not the specified eBay site supports Local Market listings for sellers with a regular subscription to Local Market for Vehicles.
If this value is specified, the <b>SiteDefaults.LocalMarketPremiumSubscription</b> boolean field in the <b>GetCategoryFeatures</b> response will indicate whether or not the specified eBay site supports Local Market listings for sellers with a premium subscription to Local Market for Vehicles.
If this value is specified, the <b>SiteDefaults.LocalMarketNonSubscription</b> boolean field in the <b>GetCategoryFeatures</b> response will indicate whether or not the specified eBay site supports Local Market listings for sellers without a subscription to Local Market for Vehicles.
This value is <b>deprecated</b> and should no longer be used.
This value is <b>deprecated</b> and should no longer be used.
This value is <b>deprecated</b> and should no longer be used.
If this value is specified, the <b>SiteDefaults.SellerContactDetailsEnabled</b> and <b>Category.SellerContactDetailsEnabled</b> boolean fields in the <b>GetCategoryFeatures</b> response will indicate whether or not the specified eBay site and individual categories allow the seller to provide contact information within a Classified Ad listing. This feature is only applicable to Classified Ad listings.
Reserved for internal or future use.
If this value is specified, the <b>SiteDefaults.MinimumReservePrice</b> and <b>Category.MinimumReservePrice</b> fields in the <b>GetCategoryFeatures</b> response will indicate whether or not the specified eBay site and individual categories require a minimum Reserve Price for auction listings. This feature is only applicable to Auction listings and only if the seller decides to set a Reserve Price for the auction.
This value is <b>deprecated</b> and should no longer be used.
This value is <b>deprecated</b> and should no longer be used.
If this value is specified, the integer values in the <b>LocalListingDistancesRegular</b>, <b>LocalListingDistancesSpecialty</b>, and <b>LocalListingDistancesNonSubscription</b> fields in the <b>GetCategoryFeatures</b> response will indicate the radius (in miles) of the selling area for Local Market Vehicle listings, based on Local Market subscription status of the motor vehicle seller (specialty subscription, regular subscription, or no subscription).
This enumeration value is no longer applicable, as Skype communication between eBay members is no longer supported.
This enumeration value is no longer applicable, as Skype communication between eBay members is no longer supported.
If this value is specified, the <b>SiteDefaults.ClassifiedAdPaymentMethodEnabled</b> and <b>Category.ClassifiedAdPaymentMethodEnabled</b> fields in the <b>GetCategoryFeatures</b> response will indicate whether or not (and when) accepted payment methods are displayed to buyers for the specified eBay site and for individual categories. This feature is only applicable for Classified Ad listings.
If this value is specified, the <b>SiteDefaults.ClassifiedAdShippingMethodEnabled</b> and <b>Category.ClassifiedAdShippingMethodEnabled</b> boolean fields in the <b>GetCategoryFeatures</b> response will indicate whether or not the specified eBay site and individual categories support the display of available shipping methods to buyers. This feature is only applicable for Classified Ad listings.
If this value is specified, the <b>SiteDefaults.ClassifiedAdBestOfferEnabled</b> and <b>Category.ClassifiedAdBestOfferEnabled</b> boolean fields in the <b>GetCategoryFeatures</b> response will indicate whether or not the specified eBay site and individual categories support the Best Offer feature for Classified Ad listings.
If this value is specified, the <b>SiteDefaults.ClassifiedAdCounterOfferEnabled</b> and <b>Category.ClassifiedAdCounterOfferEnabled</b> boolean fields in the <b>GetCategoryFeatures</b> response will indicate whether or not the specified eBay site and individual categories support Best Offer counter offers for Classified Ad listings. This feature is only applicable for Classified Ad listings.
If this value is specified, the <b>SiteDefaults.ClassifiedAdAutoDeclineEnabled</b> and <b>Category.ClassifiedAdAutoDeclineEnabled</b> boolean fields in the <b>GetCategoryFeatures</b> response will indicate whether or not the specified eBay site and individual categories support the Best Offer auto decline feature for Classified Ad listings. With the Best Offer auto decline feature, the seller sets a price threshold, and all Best Offers and counter offers below this price value are automatically declined without any seller action. This feature is only applicable for Classified Ad listings.
If this value is specified, the <b>SiteDefaults.ClassifiedAdContactByEmailEnabled</b> and <b>Category.ClassifiedAdContactByEmailEnabled</b> boolean fields in the <b>GetCategoryFeatures</b> response will indicate whether or not the specified eBay site and individual categories allow the seller to provide a contact email address within a Classified Ad listing. This feature is only applicable to Classified Ad listings.
If this value is specified, the <b>SiteDefaults.ClassifiedAdContactByPhoneEnabled</b> and <b>Category.ClassifiedAdContactByPhoneEnabled</b> boolean fields in the <b>GetCategoryFeatures</b> response will indicate whether or not the specified eBay site and individual categories allow the seller to provide a contact phone number within a Classified Ad listing. This feature is only applicable to Classified Ad listings.
If this value is specified, the <b>SiteDefaults.SafePaymentRequired</b> and <b>Category.SafePaymentRequired</b> boolean fields in the <b>GetCategoryFeatures</b> response will indicate whether or not the specified eBay site, and individual categories on that site, require that the seller set at least one accepted payment method in the listing that is certified by eBay to be a "safe payment method".
This value is <b>deprecated</b> and should no longer be used.
This value is <b>deprecated</b> and should no longer be used.
This value is <b>deprecated</b> and should no longer be used. To verify if the seller's contact information can be shared with prospective buyers in the listing, use the <b>SellerContactDetailsEnabled</b> enumeration value instead.
This value is <b>deprecated</b> and should no longer be used.
If this value is specified, the <b>SiteDefaults.ItemSpecificsEnabled</b> and <b>Category.ItemSpecificsEnabled</b> fields in the <b>GetCategoryFeatures</b> response will indicate if the eBay site and individual categories support the use of Item Specifics in listings.
<span class="tablenote"><b>Note:</b>
This value is deprecated since it is only applicable to the eBay India site, and this marketplace is no longer available.</span>
If this value is specified, the <b>SiteDefaults.PaisaPayFullEscrowEnabled</b> and <b>Category.PaisaPayFullEscrowEnabled</b> boolean fields in the <b>GetCategoryFeatures</b> response will indicate whether or not the specified eBay site and individual categories on that site support Paisa Pay Full Escrow as an accepted payment method. This field is only relevant to listings on the eBay India site, which is the only site where Paisa Pay is available.
This value is deprecated and should no longer be used. Use <b>ISBNEnabled</b> instead.
This value is deprecated and should no longer be used. Use <b>UPCEnabled</b> instead.
This value is deprecated and should no longer be used. Use <b>EANEnabled</b> instead.
If this value is specified, the <b>Category.BrandMPNIdentifierEnabled</b> boolean field in the <b>GetCategoryFeatures</b> response will indicate whether or not individual categories on the specified site support the ability of a seller to identify a product through a Brand/Manufacturer Part Number (MPN) combination.
If this value is specified, the <b>SiteDefaults.ClassifiedAdAutoAcceptEnabled</b> and <b>Category.ClassifiedAdAutoAcceptEnabled</b> boolean fields in the <b>GetCategoryFeatures</b> response will indicate whether or not the specified eBay site and individual categories support the Best Offer auto accept feature for Classified Ad listings. With the Best Offer auto accept feature, the seller sets a price threshold, and all Best Offers and counter offers at or above this price value are automatically accepted without any seller action. This feature is only applicable for Classified Ad listings.
If this value is specified, the <b>SiteDefaults.BestOfferAutoAcceptEnabled</b> and <b>Category.BestOfferAutoAcceptEnabled</b> boolean fields in the <b>GetCategoryFeatures</b> response will indicate whether or not the specified eBay site and individual categories support the Best Offer auto accept feature. With the Best Offer auto accept feature, the seller sets a price threshold, and all Best Offers and counter offers at or above this price value are automatically accepted without any seller action.
<br/><br/>
<span class="tablenote"><b>Note: </b>
The Best Offer feature can be set for auction listings on the US, Canada, UK, Germany, Australia, France, Italy, and Spain marketplaces, but keep in mind that Best Offer and Buy It Now cannot be used simultaneously in a listing. Also, once a qualifying bid is made on an auction listing, the Best Offer feature is disabled, and any pending offer or counteroffers are no longer valid.
</span>
If this value is specified, the <b>CrossBorderTradeNorthAmericaEnabled</b>, <b>CrossBorderTradeGBEnabled</b>, and <b>CrossBorderTradeAustraliaEnabled</b> fields in the <b>GetCategoryFeatures</b> response will indicate whether or not the specified eBay site and individual categories support the International Site Visibility (Cross-Border Trade) feature, and on which sites. With the International Site Visibility feature, the seller is able to create a listing and make this listing available on multiple eBay sites (not just their domestic eBay site).
If this value is specified, the <b>SiteDefaults.PayPalBuyerProtectionEnabled</b> and <b>Category.PayPalBuyerProtectionEnabled</b> boolean fields in the <b>GetCategoryFeatures</b> response will indicate whether or not the specified eBay site and individual categories are enabled with PayPal Purchase Protection. Of course, an eligible item must be purchased with PayPal to be eligible for PayPal Purchase Protection.
If this value is specified, the <b>SiteDefaults.BuyerGuaranteeEnabled</b> and <b>Category.BuyerGuaranteeEnabled</b> boolean fields in the <b>GetCategoryFeatures</b> response will indicate whether or not the specified eBay site and individual categories are enabled with the Australian version of the Buyer Protection program. This enumeration value is only applicable to the eBay Australia site.
<span class="tablenote"><b>Note:</b>
This value is deprecated since it is only applicable to the eBay India site, and this marketplace is no longer available.</span>
If this value is specified, the <b>Category.INEscrowWorkflowTimeline</b> fields in the <b>GetCategoryFeatures</b> response will indicate the escrow workflows that will be used for individual categories on the eBay India site. This enumeration value is only applicable to the eBay India site, and only if Paisa Pay Full Escrow is an accepted payment method.
This value is <b>deprecated</b> and should no longer be used.
If this value is specified, the <b>SiteDefaults.GalleryFeaturedDurations</b> container in the <b>GetCategoryFeatures</b> response will indicate the listing duration times that the Featured Gallery feature may be enabled for a listing.
If this value is specified, the <b>SiteDefaults.PayPalRequired</b> and <b>Category.PayPalRequired</b> boolean fields in the <b>GetCategoryFeatures</b> response will indicate whether or not the specified eBay site and individual categories require PayPal as one of the accepted payment methods in a listing. This value is not applicable in countries where PayPal is not available.
If this value is specified, the <b>SiteDefaults.eBayMotorsProAdFormatEnabled</b> and <b>Category.eBayMotorsProAdFormatEnabled</b> boolean fields in the <b>GetCategoryFeatures</b> response will indicate whether or not the specified eBay site and individual categories allow motor vehicles to be sold through Classified Ads. This value is only applicable for eBay Motors Pro users.
If this value is specified, the <b>SiteDefaults.eBayMotorsProContactByPhoneEnabled</b> and <b>Category.eBayMotorsProContactByPhoneEnabled</b> boolean fields in the <b>GetCategoryFeatures</b> response will indicate whether or not the specified eBay site and individual categories allow eBay Motors Pro users to provide contact phone numbers within a Motor Vehicles Classified Ad listing. The <b>Category.eBayMotorsProPhoneCount</b> field indicates how many contact phone numbers are supported in each listing. This feature is only applicable to Motor Vehicles Classified Ad listings.
If this value is specified, the <b>SiteDefaults.eBayMotorsProContactByAddressEnabled</b> and <b>Category.eBayMotorsProContactByAddressEnabled</b> boolean fields in the <b>GetCategoryFeatures</b> response will indicate whether or not the specified eBay site and individual categories allow eBay Motors Pro users to provide contact street addresses within a Motor Vehicles Classified Ad listing. The <b>Category.eBayMotorsProStreetCount</b> field indicates how many contact street addresses are supported in each listing. This feature is only applicable to Motor Vehicles Classified Ad listings.
If this value is specified, the <b>SiteDefaults.eBayMotorsProCompanyNameEnabled</b> and <b>Category.eBayMotorsProCompanyNameEnabled</b> boolean fields in the <b>GetCategoryFeatures</b> response will indicate whether or not the specified eBay site and individual categories allow eBay Motors Pro users to provide a company name within a Motor Vehicles Classified Ad listing. This feature is only applicable to Motor Vehicles Classified Ad listings.
If this value is specified, the <b>SiteDefaults.eBayMotorsProContactByEmailEnabled</b> and <b>Category.eBayMotorsProContactByEmailEnabled</b> boolean fields in the <b>GetCategoryFeatures</b> response will indicate whether or not the specified eBay site and individual categories allow eBay Motors Pro users to provide a contact email address within a Motor Vehicles Classified Ad listing. This feature is only applicable to Motor Vehicles Classified Ad listings.
If this value is specified, the <b>SiteDefaults.eBayMotorsProBestOfferEnabled</b> and <b>Category.eBayMotorsProBestOfferEnabled</b> boolean fields in the <b>GetCategoryFeatures</b> response will indicate whether or not the specified eBay site and individual categories support the Best Offer feature for Motor Vehicles Classified Ad listings.
If this value is specified, the <b>SiteDefaults.eBayMotorsProAutoAcceptEnabled</b> and <b>Category.eBayMotorsProAutoAcceptEnabled</b> boolean fields in the <b>GetCategoryFeatures</b> response will indicate whether or not the specified eBay site and individual categories support the Best Offer auto accept feature for Motor Vehicles Classified Ad listings. With the Best Offer auto accept feature, the seller sets a price threshold, and all Best Offers and counter offers at or above this price value are automatically accepted without any seller action. This feature is only applicable for Motor Vehicles Classified Ad listings, and is only available to eBay Motors Pro users.
If this value is specified, the <b>SiteDefaults.eBayMotorsProAutoDeclineEnabled</b> and <b>Category.eBayMotorsProAutoDeclineEnabled</b> boolean fields in the <b>GetCategoryFeatures</b> response will indicate whether or not the specified eBay site and individual categories support the Best Offer auto decline feature for Motor Vehicles Classified Ad listings. With the Best Offer auto decline feature, the seller sets a price threshold, and all Best Offers and counter offers below this price value are automatically declined without any seller action. This feature is only applicable for Motor Vehicles Classified Ad listings, and is only available to eBay Motors Pro users.
If this value is specified, the <b>SiteDefaults.eBayMotorsProPaymentMethodCheckOutEnabled</b> and <b>Category.eBayMotorsProPaymentMethodCheckOutEnabled</b> fields in the <b>GetCategoryFeatures</b> response will indicate whether or not (and when) accepted payment methods are displayed to buyers for the specified eBay site and for individual categories. This feature is only applicable for Motor Vehicles Classified Ad listings, and is only available to eBay Motors Pro users.
If this value is specified, the <b>SiteDefaults.eBayMotorsProShippingMethodEnabled</b> and <b>Category.eBayMotorsProShippingMethodEnabled</b> boolean fields in the <b>GetCategoryFeatures</b> response will indicate whether or not the specified eBay site and individual categories support the display of available shipping methods to buyers. This feature is only applicable for Motor Vehicles Classified Ad listings, and is only available to eBay Motors Pro users.
If this value is specified, the <b>SiteDefaults.eBayMotorsProCounterOfferEnabled</b> and <b>Category.eBayMotorsProCounterOfferEnabled</b> boolean fields in the <b>GetCategoryFeatures</b> response will indicate whether or not the specified eBay site and individual categories support Best Offer counter offers for Motor Vehicles Classified Ad listings. This feature is only applicable for Motor Vehicles Classified Ad listings, and is only available to eBay Motors Pro users.
If this value is specified, the <b>SiteDefaults.eBayMotorsProSellerContactDetailsEnabled</b> and <b>Category.eBayMotorsProSellerContactDetailsEnabled</b> boolean fields in the <b>GetCategoryFeatures</b> response will indicate whether or not the specified eBay site and individual categories allow the seller to provide contact information within a Motor Vehicles Classified Ad listing. This feature is only applicable for Motor Vehicles Classified Ad listings, and is only available to eBay Motors Pro users.
If this value is specified, the <b>SiteDefaults.LocalMarketAdFormatEnabled</b> and <b>Category.LocalMarketAdFormatEnabled</b> fields in the <b>GetCategoryFeatures</b> response will indicate whether or not the specified eBay site and individual categories allow motor vehicles to be sold through Local Market Classified Ads. Motors Local Market listings are only available to eBay sellers who are Licensed Vehicle Dealers on eBay.
If this value is specified, the <b>SiteDefaults.LocalMarketContactByPhoneEnabled</b> and <b>Category.LocalMarketContactByPhoneEnabled</b> boolean fields in the <b>GetCategoryFeatures</b> response will indicate whether or not the specified eBay site and individual categories allow eBay Licensed Vehicle Dealers to provide contact phone numbers within a Motors Local Market listing. The <b>Category.LocalMarketPhoneCount</b> field indicates how many contact phone numbers are supported in each listing. This feature is only applicable to Motors Local Market listings.
If this value is specified, the <b>SiteDefaults.LocalMarketContactByAddressEnabled</b> and <b>Category.LocalMarketContactByAddressEnabled</b> boolean fields in the <b>GetCategoryFeatures</b> response will indicate whether or not the specified eBay site and individual categories allow eBay Licensed Vehicle Dealers to provide contact street addresses within a Motors Local Market listing. This feature is only applicable to Motors Local Market listings.
If this value is specified, the <b>SiteDefaults.LocalMarketCompanyNameEnabled</b> and <b>Category.LocalMarketCompanyNameEnabled</b> boolean fields in the <b>GetCategoryFeatures</b> response will indicate whether or not the specified eBay site and individual categories allow eBay Licensed Vehicle Dealers to provide a company name within a Motors Local Market listing. This feature is only applicable to Motors Local Market listings.
If this value is specified, the <b>SiteDefaults.LocalMarketContactByEmailEnabled</b> and <b>Category.LocalMarketContactByEmailEnabled</b> boolean fields in the <b>GetCategoryFeatures</b> response will indicate whether or not the specified eBay site and individual categories allow eBay Licensed Vehicle Dealers to provide contact email addresses within a Motors Local Market listing. This feature is only applicable to Motors Local Market listings.
If this value is specified, the <b>SiteDefaults.LocalMarketBestOfferEnabled</b> and <b>Category.LocalMarketBestOfferEnabled</b> boolean fields in the <b>GetCategoryFeatures</b> response will indicate whether or not the specified eBay site and individual categories support the Best Offer feature for Motors Local Market listings.
If this value is specified, the <b>SiteDefaults.LocalMarketAutoAcceptEnabled</b> and <b>Category.LocalMarketAutoAcceptEnabled</b> boolean fields in the <b>GetCategoryFeatures</b> response will indicate whether or not the specified eBay site and individual categories support the Best Offer auto accept feature for Motors Local Market listings. With the Best Offer auto accept feature, the seller sets a price threshold, and all Best Offers and counter offers at or above this price value are automatically accepted without any seller action. This feature is only applicable for Motors Local Market listings, and is only available to eBay Licensed Vehicle Dealers.
If this value is specified, the <b>SiteDefaults.LocalMarketAutoDeclineEnabled</b> and <b>Category.LocalMarketAutoDeclineEnabled</b> boolean fields in the <b>GetCategoryFeatures</b> response will indicate whether or not the specified eBay site and individual categories support the Best Offer auto decline feature for Motors Local Market listings. With the Best Offer auto decline feature, the seller sets a price threshold, and all Best Offers and counter offers below this price value are automatically declined without any seller action. This feature is only applicable for Motors Local Market listings, and is only available to eBay Licensed Vehicle Dealers.
If this value is specified, the <b>SiteDefaults.LocalMarketPaymentMethodCheckOutEnabled</b> and <b>Category.LocalMarketPaymentMethodCheckOutEnabled</b> fields in the <b>GetCategoryFeatures</b> response will indicate whether or not (and when) accepted payment methods are displayed to buyers for the specified eBay site and for individual categories. This feature is only applicable for Motors Local Market listings, and is only available to eBay Licensed Vehicle Dealers.
If this value is specified, the <b>SiteDefaults.LocalMarketShippingMethodEnabled</b> and <b>Category.LocalMarketShippingMethodEnabled</b> boolean fields in the <b>GetCategoryFeatures</b> response will indicate whether or not the specified eBay site and individual categories support the display of available shipping methods to buyers. This feature is only applicable for Motors Local Market listings, and is only available to eBay Licensed Vehicle Dealers.
If this value is specified, the <b>SiteDefaults.LocalMarketCounterOfferEnabled</b> and <b>Category.LocalMarketCounterOfferEnabled</b> boolean fields in the <b>GetCategoryFeatures</b> response will indicate whether or not the specified eBay site and individual categories support Best Offer counter offers for Motors Local Market listings. This feature is only applicable for Motors Local Market listings, and is only available to eBay Licensed Vehicle Dealers.
If this value is specified, the <b>SiteDefaults.LocalMarketSellerContactDetailsEnabled</b> and <b>Category.LocalMarketSellerContactDetailsEnabled</b> boolean fields in the <b>GetCategoryFeatures</b> response will indicate whether or not the specified eBay site and individual categories allow the seller to provide contact information within a Motors Local Market listing. This feature is only applicable for Motors Local Market listings, and is only available to eBay Licensed Vehicle Dealers.
If this value is specified, the <b>SiteDefaults.ClassifiedAdContactByAddressEnabled</b> and <b>Category.ClassifiedAdContactByAddressEnabled</b> boolean fields in the <b>GetCategoryFeatures</b> response will indicate whether or not the specified eBay site and individual categories allow sellers to provide contact street addresses within a Classified Ad listing. The <b>Category.ClassifiedAdStreetCount</b> field indicates how many street addresses are allowed in each listing. This feature is only applicable to Classified Ad listings.
If this value is specified, the <b>SiteDefaults.ClassifiedAdCompanyNameEnabled</b> and <b>Category.ClassifiedAdCompanyNameEnabled</b> boolean fields in the <b>GetCategoryFeatures</b> response will indicate whether or not the specified eBay site and individual categories allow sellers to provide a company name within a Classified Ad listing. This feature is only applicable to Classified Ad listings.
If this value is specified, the <b>SiteDefaults.SpecialitySubscription</b> boolean field in the <b>GetCategoryFeatures</b> response will indicate whether or not the specified eBay site supports Motors National listings for sellers with a specialty dealer subscription for selling motor vehicles.
If this value is specified, the <b>SiteDefaults.RegularSubscription</b> boolean field in the <b>GetCategoryFeatures</b> response will indicate whether or not the specified eBay site supports Motors National listings for sellers with a regular dealer subscription for selling motor vehicles.
If this value is specified, the <b>SiteDefaults.PremiumSubscription</b> boolean field in the <b>GetCategoryFeatures</b> response will indicate whether or not the specified eBay site supports Motors National listings for sellers with a premium dealer subscription for selling motor vehicles.
If this value is specified, the <b>SiteDefaults.NonSubscription</b> boolean field in the <b>GetCategoryFeatures</b> response will indicate whether or not the specified eBay site supports Motors National listings for sellers without a dealer subscription for selling motor vehicles.
If this value is specified, the <b>SiteDefaults.IntangibleEnabled</b> and <b>Category.IntangibleEnabled</b> boolean fields in the <b>GetCategoryFeatures</b> response will indicate whether or not the specified eBay site and individual categories allow sellers to sell intangible items.
This value is <b>deprecated</b> and should no longer be used.
If this value is specified, the <b>SiteDefaults.ReviseQuantityAllowed</b> and <b>Category.ReviseQuantityAllowed</b> boolean fields in the <b>GetCategoryFeatures</b> response will indicate whether or not the specified eBay site and individual categories allow sellers to revise quantity in a multi-quantity, fixed-price listing while the listing is in a semi- or fully-restricted mode (such as when the listing already has sales or when the listing is scheduled to end within 12 hours). This value is only applicable to fixed-price listings.
If this value is specified, the <b>SiteDefaults.RevisePriceAllowed</b> and <b>Category.RevisePriceAllowed</b> boolean fields in the <b>GetCategoryFeatures</b> response will indicate whether or not the specified eBay site and individual categories allow sellers to revise the price in a fixed-price listing while the listing is in a semi- or fully-restricted mode (such as when the listing already has sales or when the listing is scheduled to end within 12 hours). This value is only applicable to fixed-price listings.
If this value is specified, the <b>SiteDefaults.StoreOwnerExtendedListingDurationsEnabled</b> and <b>Category.StoreOwnerExtendedListingDurationsEnabled</b> boolean fields in the <b>GetCategoryFeatures</b> response will indicate whether or not the specified eBay site and individual categories allow eBay Store sellers to create fixed-price listings with longer listing durations than sellers without eBay Stores. This value is only applicable to fixed-price listings.
If this value is specified, the <b>SiteDefaults.StoreOwnerExtendedListingDurations</b> container in the <b>GetCategoryFeatures</b> response will indicate the extended listing duration times that eBay Store sellers may set when creating a fixed-price listing. This value is only applicable to fixed-price listings. The site and category must support extended listing durations (<b>StoreOwnerExtendedListingDurationsEnabled</b>=true).
If this value is specified, the <b>SiteDefaults.ReturnPolicyEnabled</b> and <b>Category.ReturnPolicyEnabled</b> boolean fields in the <b>GetCategoryFeatures</b> response will indicate whether or not the specified eBay site and individual categories allow eBay sellers to create a return policy for the listing.
If this value is specified, the <b>SiteDefaults.HandlingTimeEnabled</b> and <b>Category.HandlingTimeEnabled</b> boolean fields in the <b>GetCategoryFeatures</b> response will indicate whether or not the specified eBay site and individual categories require eBay sellers to set a handling time for products sold within the listing. The handling time is the maximum number of business days the seller commits to for preparing an item to be shipped after receiving a cleared payment. The seller's handling time does not include the shipping time (the carrier's transit time).
If this value is specified, the <b>SiteDefaults.PaymentMethod</b> and <b>SiteDefaults.PaymentMethod</b> fields in the <b>GetCategoryFeatures</b> response will indicate the accepted payment methods at the eBay site level and within the individual categories.
If this value is specified, the <b>Category.MaxFlatShippingCost</b> fields in the <b>GetCategoryFeatures</b> response will indicate the maximum flat-rate shipping costs that the seller may charge the buyer to ship one item domestically. At least one available shipping service option has to be under this value. Handling cost (if any) goes toward this maximum cost threshold.
If this value is specified, the <b>SiteDefaults.MaxFlatShippingCostCBTExempt</b> boolean field in the <b>GetCategoryFeatures</b> response will indicate whether or not sellers, who sell items to domestic buyers, but are shipping the item from another country, are exempt from the <b>MaxFlatShippingCost</b> threshold.
If this value is specified, the <b>Category.Group1MaxFlatShippingCost</b> fields in the <b>GetCategoryFeatures</b> response will indicate the maximum flat-rate shipping costs that the seller may charge the buyer to ship one item domestically using a Group 1 shipping service. At least one available Group 1 shipping service option has to be under this value. Handling cost (if any) goes toward this maximum cost threshold.
If this value is specified, the <b>Category.Group2MaxFlatShippingCost</b> fields in the <b>GetCategoryFeatures</b> response will indicate the maximum flat-rate shipping costs that the seller may charge the buyer to ship one item domestically using a Group 2 shipping service. At least one available Group 2 shipping service option has to be under this value. Handling cost (if any) goes toward this maximum cost threshold.
If this value is specified, the <b>Category.Group3MaxFlatShippingCost</b> fields in the <b>GetCategoryFeatures</b> response will indicate the maximum flat-rate shipping costs that the seller may charge the buyer to ship one item domestically using a Group 3 shipping service. At least one available Group 3 shipping service option has to be under this value. Handling cost (if any) goes toward this maximum cost threshold.
If this value is specified, the <b>SiteDefaults.VariationsEnabled</b> and <b>Category.VariationsEnabled</b> boolean fields in the <b>GetCategoryFeatures</b> response will indicate whether or not the specified eBay site and individual categories support multi-variation listings. Variations are items within the same listing that are logically the same product, but differ slightly in size, color, or other aspect.
This value is <b>deprecated</b> and should no longer be used.
If this value is specified, the <b>SiteDefaults.FreeGalleryPlusEnabled</b> and <b>Category.FreeGalleryPlusEnabled</b> boolean fields in the <b>GetCategoryFeatures</b> response will indicate whether or not the specified eBay site and individual categories support a free Gallery Plus upgrade. The Gallery Plus feature includes the picture zoom-in option (when you hover the mouse over the picture) and the ability to enlarge the photo by clicking a link.
If this value is specified, the <b>SiteDefaults.FreePicturePackEnabled</b> and <b>Category.FreePicturePackEnabled</b> boolean fields in the <b>GetCategoryFeatures</b> response will indicate whether or not the specified eBay site and individual categories support a free Picture Pack upgrade. The Picture Pack feature is only available for eBay Motors vehicle listings. The Picture Pack feature includes up to 12 supersized photos with the zoom-in feature enabled for each one.
If this value is specified, the <b>SiteDefaults.ItemCompatibilityEnabled</b> and <b>Category.ItemCompatibilityEnabled</b> fields in the <b>GetCategoryFeatures</b> response will indicate whether or not the specified eBay site and individual categories support the Parts Compatibility feature, and if so, the mode of compatibility that is used (by application or by specification). The Parts Compatibility feature allows sellers to list their motor vehicles parts and accessories items with parts compatibility name-value pairs specific to motor vehicles, and allows potential buyers to search for these items using parts compatibility search fields.
If this value is specified, the <b>Category.MinCompatibleApplications</b> fields in the <b>GetCategoryFeatures</b> response will indicate the minimum number of compatible applications that must be specified when listing a motor vehicle part or accessory in the given category.
If this value is specified, the <b>Category.MaxCompatibleApplications</b> fields in the <b>GetCategoryFeatures</b> response will indicate the maximum number of compatible applications that can be specified when listing a motor vehicle part or accessory in the given category.
If this value is specified, the <b>Category.ConditionEnabled</b> fields in the <b>GetCategoryFeatures</b> response will indicate which individual categories support (and even require) the use of <b>ConditionID</b> values to specify the condition of an item within a listing.
If this value is specified, the <b>Category.Condition</b> containers in the <b>GetCategoryFeatures</b> response will include Condition ID values and item conditions like 'Very Good', 'Acceptable', 'Used', etc. for all categories that support the use of Condition ID values.
If this value is specified, the <b>Category.ValueCategory</b> boolean fields in the <b>GetCategoryFeatures</b> response will indicate the categories that are considered by eBay to be 'Value Categories'. 'Value Categories' are generally categories where buyers can find good deals on items. If sellers decide to list within a value category, only this category may be used, and a secondary category is not supported.
This enumeration value is no longer applicable. Use the <code>ProductRequiredEnabled</code> enumeration value instead to see if a category supports listings that are associated with an eBay Catalog product.
If this value is specified, the <b>Category.EANEnabled</b> fields in the <b>GetCategoryFeatures</b> response will indicate whether or not items listed in the corresponding category may utilize EANs to identify a product. A value of <code>Disabled</code> indicates that EANs cannot be used for the category, a value of <code>Enabled</code> indicates that EANs can be used for the category, and a value of <code>Required</code> indicates that an EAN is required when listing a product in this category.
If this value is specified, the <b>Category.ISBNEnabled</b> fields in the <b>GetCategoryFeatures</b> response will indicate whether or not items listed in the corresponding category may utilize ISBNs to identify a product. A value of <code>Disabled</code> indicates that ISBNs cannot be used for the category, a value of <code>Enabled</code> indicates that ISBNs can be used for the category, and a value of <code>Required</code> indicates that an ISBN is required when listing a product in this category.
If this value is specified, the <b>Category.UPCEnabled</b> fields in the <b>GetCategoryFeatures</b> response will indicate whether or not items listed in the corresponding category may utilize UPCs to identify a product. A value of <code>Disabled</code> indicates that UPCs cannot be used for the category, a value of <code>Enabled</code> indicates that UPCs can be used for the category, and a value of <code>Required</code> indicates that a UPC is required when listing a product in this category.
If this value is specified, the <b>Category.MaxGranularFitmentCount</b> fields in the <b>GetCategoryFeatures</b> response will indicate how many Parts Compatibility name-value pairs may be passed in for each motor vehicle aspect (Year, Make, and Model) in a motor vehicle parts and accessory listing. granularity. This field is only applicable to motor vehicle parts and accessory listings.
If this value is specified, the <b>Category.CompatibleVehicleType</b> fields in the <b>GetCategoryFeatures</b> response will indicate the type of vehicle that parts compatibility name-value pairs in a listing will be referring to, such as 'cars and trucks', 'all-terrain vehicles (ATV)', 'boats', and 'motorcycles'. This field is only applicable to motor vehicle parts and accessory listings.
This value is <b>deprecated</b> and should no longer be used.
If this value is specified, the <b>Category.ShippingProfileCategoryGroup</b> fields in the <b>GetCategoryFeatures</b> response will indicate which shipping business policy category group that each category will inherit as the default category group. Currently, there are only two Business Policies category groups - 'MOTORS_VEHICLE' covers all motor-vehicle related categories, and 'ALL' covers all other categories.
If this value is specified, the <b>Category.PaymentProfileCategoryGroup</b> fields in the <b>GetCategoryFeatures</b> response will indicate which payment business policy category group that each category will inherit as the default category group. Currently, there are only two Business Policies category groups - 'MOTORS_VEHICLE' covers all motor-vehicle related categories, and 'ALL' covers all other categories.
If this value is specified, the <b>Category.ReturnPolicyProfileCategoryGroup</b> fields in the <b>GetCategoryFeatures</b> response will indicate which return policy business policy category group that each category will inherit as the default category group. Currently, there are only two Business Policies category groups - 'MOTORS_VEHICLE' covers all motor-vehicle related categories, and 'ALL' covers all other categories.
This value is <b>deprecated</b> and should no longer be used.
This value is <b>deprecated</b> and should no longer be used.
If this value is specified, the <b>SiteDefaults.SellerProvidedTitleSupported</b> and <b>Category.SellerProvidedTitleSupported</b> fields in the <b>GetCategoryFeatures</b> response will indicate if the eBay site and individual categories support the use of a seller-provided title for a motor vehicle listing on the US or Canada Motors marketplaces. A seller-provided title is a descriptive title, given by the seller, that appears below eBay's pre-filled listing title for the motor vehicle.
This value is <b>deprecated</b> and should no longer be used.
If this value is specified, the <b>SiteDefaults.GlobalShippingEnabled</b> and <b>Category.GlobalShippingEnabled</b> fields in the <b>GetCategoryFeatures</b> response will indicate if the eBay site and individual categories support the Global Shipping Program (GSP) as a means for shipping items internationally. The GSP feature is only applicable to shipping items internationally.
If this value is specified, the <b>SiteDefaults.AdditionalCompatibilityEnabled</b> and <b>Category.AdditionalCompatibilityEnabled</b> fields in the <b>GetCategoryFeatures</b> response will indicate whether or not the specified eBay site and individual categories support the second-generation Parts Compatibility feature where parts-compatibility name-value pairs can be passed in for boats, motorcycles, and other vehicles instead of just cars and trucks. This feature is only applicable to motor vehicle parts and accessory listings.
If this value is specified, the <b>Category.PickupDropOffEnabled</b> fields in the <b>GetCategoryFeatures</b> response will indicate that items listed in the corresponding category may be enabled with the 'Click and Collect' feature. With the 'Click and Collect' feature, a buyer can purchase certain items on the eBay site and collect them at a local store. Buyers are notified by eBay once their items are available. A <code>false</code> value in this field indicates that items listed in the category are not eligible for the 'Click and Collect' feature.
<br/><br/>
The 'Click and Collect' feature is only available to large merchants on the eBay UK (site ID - 3), eBay Australia (Site ID - 15), and eBay Germany (Site ID - 77) sites.
If this value is specified, the <b>Category.DigitalGoodDeliveryEnabled</b> fields in the <b>GetCategoryFeatures</b> response will indicate that digital gift cards can be listed in the corresponding category. A <code>false</code> value in this field indicates that digital gift cards may not be listed in the category.
<br/><br/>
Digital gift cards are currently only supported on the US site. There are some restrictions when it comes to selling gift cards, including the following:
<ul>
<li>Each seller can only have one gift card listing at any given time;</li>
<li>The maximum dollar value of the gift card may not exceed 500.00; and</li>
<li>prepaid credit cards from American Express, Discover, MasterCard, or Visa are not allowed.</li>
</ul>
For more information on eBay's Gift Card policy, see the <a href="http://pages.ebay.com/help/policies/gift.html">Gift cards policy</a> Help page.
This value is used to see if an eBay Product ID (e.g. ePID) can be used in an Add/Revise/Relist API call to identify which motorcycles and/or scooters are compatible with a motor vehicle part or accessory is supported. ePIDs can only be used to identify motorcycles and scooters on the Germany and UK sites.
<br/><br/>
For more information on using an ePID to identify a compatible motorcycle or scooter through an Add/Revise/Relist API call on the Germany or UK site, see the documentation for the <a href="
http://developer.ebay.com/Devzone/XML/docs/Reference/eBay/AddItem.html#Request.Item.ItemCompatibilityList.Compatibility.NameValueList">Compatibility.NameValueList</a> container.
This value is used to see if a K Type vehicle number in an Add/Revise/Relist API call to identify which cars and/or trucks are compatible with a motor vehicle part or accessory is supported. K type vehicle numbers can only be used to identify cars and trucks on the Germany site.
<br/><br/>
For more information on using a K Type vehicle number to identify a compatible car or truck through an Add/Revise/Relist API call on the Germany site, see the documentation for the <a href="
http://developer.ebay.com/Devzone/XML/docs/Reference/eBay/AddItem.html#Request.Item.ItemCompatibilityList.Compatibility.NameValueList">Compatibility.NameValueList</a> container.
This value is used to see if the site supports Product-Based Shopping Experience listings (listings associated with an eBay catalog product).
<br><br>
The <b>Category.ProductRequiredEnabled</b> field will only be returned if the category requires association with an eBay Catalog product.
<br><br>
<span class="tablenote"><b>Note:</b>
Due to the rollback of the Product-Based Shopping Experience mandate for all eBay categories, the value for this field should never get returned as <code>Enabled</code> for <b>SiteDefaults</b> or for any categories.</span>
Use this ID to return the values you can specify for whether or not a seller accepts domestic returns.
<br><br>
The values returned in this field are pertinent only if <b>ReturnPolicyEnabled</b> in GetCategoryFeatures is set to <code>true</code> for the associated marketplace and category.
Use this ID to return the values you can specify for whether or not a seller accepts international returns.
<br><br>
The values returned in this field are pertinent only if <b>ReturnPolicyEnabled</b> in GetCategoryFeatures is set to <code>true</code> for the associated marketplace and category.
Use this ID to return the values you can specify for the return duration for domestic returns.
<br><br>
The values returned in this field are pertinent only if <b>ReturnPolicyEnabled</b> in GetCategoryFeatures is set to <code>true</code> for the associated marketplace and category.
Use this ID to return the values you can specify for the return duration for international returns.
<br><br>
The values returned in this field are pertinent only if <b>ReturnPolicyEnabled</b> in GetCategoryFeatures is set to <code>true</code> for the associated marketplace and category.
Use this ID to return the values you can specify for who pays any return shipping costs for domestic returns.
<br><br>
The values returned in this field are pertinent only if <b>ReturnPolicyEnabled</b> in GetCategoryFeatures is set to <code>true</code> for the associated marketplace and category.
Use this ID to return the values you can specify for who pays any return shipping costs for international returns.
<br><br>
The values returned in this field are pertinent only if <b>ReturnPolicyEnabled</b> in GetCategoryFeatures is set to <code>true</code> for the associated marketplace and category.
In US, sellers can offer item replacement in addition to offering a money-back refund for domestic returns. Use this ID to return whether or not the seller can offer <code>MoneyBackorReplacement</code> for the specified category.
<br><br>
The values returned in this field are pertinent only if <b>ReturnPolicyEnabled</b> in GetCategoryFeatures is set to <code>true</code> for the associated marketplace and category.
In US, sellers can offer item replacement in addition to offering a money-back refund for international returns. Use this ID to return whether or not the seller can offer <code>MoneyBackorReplacement</code> for the specified category.
<br><br>
The values returned in this field are pertinent only if <b>ReturnPolicyEnabled</b> in GetCategoryFeatures is set to <code>true</code> for the associated marketplace and category.
In some EU countries, sellers are legally required to describe the return policy they offer. The value returned by this field indicates if sellers can provide such description within the given marketplace and category.
<br><br>
The values returned in this field are pertinent only if <b>ReturnPolicyEnabled</b> in GetCategoryFeatures is set to <code>true</code> for the associated marketplace and category.
Enumerated type that indicates if the Featured First listing upgrade is enabled for the specified site, and whether it is restricted to a specific seller level.
<br/><br/>
<span class="tablenote"><strong>Note:</strong>
Beginning in mid-August 2019, the Featured First listing upgrade can no longer be added for new listings in any eBay marketplace. Existing listings enabled with this feature will still be honored until mid-September 2019, at which time the feature will be fully disabled.
</span>
This enumeration value indicates that the Featured First listing upgrade is enabled for all sellers on the site.
This enumeration value indicates that the Featured First listing upgrade is not available for any sellers on the site.
This enumeration value indicates that the Featured First listing upgrade is only enabled for Power Sellers on the site.
This enumeration value indicates that the Featured First listing upgrade is only enabled for Top-Rated Sellers on the site.
Reserved for internal or future use.
Enumerated type that indicates if the Featured Plus listing upgrade is enabled for the specified site, and whether it is restricted to a specific seller level.
This enumeration value indicates that the Featured Plus listing upgrade is enabled for all sellers on the site.
This enumeration value indicates that the Featured Plus listing upgrade is not available for any sellers on the site.
This enumeration value indicates that the Featured Plus listing upgrade is only enabled for Power Sellers on the site.
This enumeration value indicates that the Featured Plus listing upgrade is only enabled for Top-Rated Sellers on the site.
Reserved for internal or future use.
This enumerated type consists of the different Federal Express shipping rates that sellers can offer to buyers. The shipping rates for the major US shipping carriers can be selected in the Shipping rate preferences in My eBay, or through the <b>SetUserPreferences</b> call.
This enumeration value indicates that the seller offers buyers the standard Federal Express shipping rates.
This enumeration value indicates that the seller offers buyers Federal Express counter rates.
This enumeration value indicates that the seller offers buyers discounted Federal Express shipping rates. Buyers will get these discounted shipping rates as long as they use the eBay-generated shipping labels.
Reserved for internal or future use
Identifies the name and cost of a listing feature that a member pays to eBay. These listing feature names, fees, and possible discounts are intended only as
an aid to help estimate the fees for a listing.
This is the name of the listing feature, such as <code>ListingFee</code>, <code>SubtitleFee</code>, or <code>BoldFee</code>.
Fees Resulting from Listing an Item
http://developer.ebay.com/DevZone/guides/features-guide/default.html#development/Listing-Fees.html
AddFixedPriceItem
AddItem
AddItems
AddSellingManagerTemplate
AddLiveAuctionItem
RelistFixedPriceItem
RelistItem
ReviseInventoryStatus
ReviseFixedPriceItem
ReviseItem
ReviseLiveAuctionItem
VerifyAddFixedPriceItem
VerifyAddItem
VerifyRelistItem
Always
AddItemFromSellingManagerTemplate
GetSellingManagerTemplateAutomationRule
GetSellingManagerItemAutomationRule
SetSellingManagerTemplateAutomationRule
SetSellingManagerItemAutomationRule
GetSellingManagerTemplateAutomationRule
DeleteSellingManagerItemAutomationRule
DeleteSellingManagerTemplateAutomationRule
ReviseSellingManagerTemplate
Conditionally
Amount of the fee that eBay will charge the member for the associated listing
feature.
eBay.com Fees
http://pages.ebay.com/help/sell/fees.html
A current schedule of listing features and their associated fees.
Fees Resulting from Listing an Item
http://developer.ebay.com/Devzone/XML/docs/Reference/eBay/types/ListingFeesType.html
A table listing the type of fees that can be charged when you list an item.
AddFixedPriceItem
AddItem
AddItems
AddSellingManagerTemplate
AddLiveAuctionItem
RelistFixedPriceItem
RelistItem
ReviseFixedPriceItem
ReviseInventoryStatus
ReviseItem
ReviseLiveAuctionItem
VerifyAddFixedPriceItem
VerifyAddItem
VerifyRelistItem
Always
AddItemFromSellingManagerTemplate
GetSellingManagerTemplateAutomationRule
GetSellingManagerItemAutomationRule
SetSellingManagerTemplateAutomationRule
SetSellingManagerItemAutomationRule
GetSellingManagerTemplateAutomationRule
DeleteSellingManagerItemAutomationRule
DeleteSellingManagerTemplateAutomationRule
ReviseSellingManagerTemplate
Conditionally
This field exists in the response when the user has selected a feature that
participates in a promotional discount.
<br/><br/>
<span class="tablenote"><b>Note: </b>
Verify calls might not return the PromotionalDiscount fee in the response.
</span>
Standard selling fees
http://pages.ebay.com/help/sell/fees.html
A current schedule of listing features and their associated fees.
AddFixedPriceItem
AddItem
AddItems
AddSellingManagerTemplate
AddLiveAuctionItem
RelistFixedPriceItem
ReviseInventoryStatus
RelistItem
ReviseFixedPriceItem
ReviseItem
ReviseLiveAuctionItem
VerifyAddFixedPriceItem
VerifyAddItem
VerifyRelistItem
Always
AddItemFromSellingManagerTemplate
GetSellingManagerTemplateAutomationRule
GetSellingManagerItemAutomationRule
SetSellingManagerTemplateAutomationRule
SetSellingManagerItemAutomationRule
GetSellingManagerTemplateAutomationRule
DeleteSellingManagerItemAutomationRule
DeleteSellingManagerTemplateAutomationRule
ReviseSellingManagerTemplate
Conditionally
Contains one or more stored comments for use as feedback to buyers.
This comment is for use as feedback for buyers. No more than ten (10)
comments can be stored.
SetSellingManagerFeedbackOptions
Yes
This type is used by the <b>FeedbackDetailArray</b> container that is returned in the <b>GetFeedback</b> call. The <b>FeedbackDetailArray</b> container consists of an array of one or more Feedback entries. The Feedback entries that are returned will depend on the fields/values included in the call request.
This container consists of detailed information for a Feedback entry on a specific order line item. For Feedback entries that were left for the buyer by the seller, some of the fields in this container will not be returned to users who were not involved in the transaction as either the buyer or seller.
GetFeedback
DetailLevel: ReturnAll
Conditionally
Container consisting of detailed information on a Feedback entry for a specific
order line item. This container will only be returned for a detail level of <code>ReturnAll</code>. For Feedback entries that were left for the buyer by the seller, some of the fields of this container will not be returned to users who were not involved in the transaction as either the buyer or seller.
The eBay User ID of the user who left the Feedback entry.
GetFeedback
DetailLevel: ReturnAll
Conditionally
This enumeration value is the Feedback Rating Star of the user indicated in the <b>CommentingUser</b> field. See <a href="types/FeedbackRatingStarCodeType.html">FeedbackRatingStarCodeType</a> for the full list of Feedback Rating Stars, and the Feedback score ranges associated with those stars.
GetFeedback
DetailLevel: ReturnAll
Conditionally
This integer value is the Feedback score of the user indicated in the <b>CommentingUser</b> field.
GetFeedback
DetailLevel: ReturnAll
Conditionally
This free-form text is the actual comment that the commenting user left for their order partner. The Feedback comment's purpose is to explain, clarify, or justify the Feedback rating specified
in the <b>CommentType</b> field.
<br><br>
The comment is returned as text in the language that the comment was originally left
in. This comment will still be displayed even if a submitted Feedback entry is
withdrawn.
80 (125 for Taiwan)
GetFeedback
DetailLevel: ReturnAll
Conditionally
This timestamp (in GMT) indicates the date/time that the Feedback entry was submitted to eBay.
GetFeedback
DetailLevel: ReturnAll
Conditionally
This value indicates the rating of the Feedback left by the user identified in the <b>CommentingUser</b> field.
<br><br>
A <b>Positive</b> rating increases a user's Feedback score, a <b>Negative</b> rating decreases a user's Feedback score, and a <b>Neutral</b> rating does not affect a user's Feedback score.
<br><br>
Sellers cannot leave <b>Neutral</b> or <b>Negative</b> ratings for buyers.
GetFeedback
DetailLevel: ReturnAll
Conditionally
This free-form text is the comment that the recipient of the Feedback may leave in response or rebuttal to the Feedback. Responses to Feedback comments cannot be submitted or edited via the API.
80 (125 for Taiwan)
GetFeedback
DetailLevel: ReturnAll
Conditionally
This free-form text is the explanation that a user can give to a response. Follow-ups to Feedback comments cannot be submitted or edited via the API.
80 (125 for Taiwan)
GetFeedback
DetailLevel: ReturnAll
Conditionally
The unique identifier of the eBay listing associated with the Feedback entry. For Feedback entries that were left for the buyer by the seller, an <b>ItemID</b> value will not be returned to a user that was not involved in the transaction as either the buyer or seller.
GetFeedback
DetailLevel: ReturnAll
Conditionally
Indicates whether the recipient of the Feedback entry is the buyer
or the seller for the corresponding order line item.
GetFeedback
DetailLevel: ReturnAll
Conditionally
The title of the item listing for which Feedback was provided. The title is returned as CDATA. This value can be returned as part of the Detailed Seller Ratings feature. Not returned if a listing ended more than 90 days ago. For Feedback entries that were left for the buyer by the seller, an <b>ItemTitle</b> value will not be returned to a user that was not involved in the transaction as either the buyer or seller.
80
Detailed Seller Ratings
https://developer.ebay.com/DevZone/guides/features-guide/default.html#Development/Sales-Feedback.html#DetailedSellerRatings
GetFeedback
DetailLevel: ReturnAll
Conditionally
The purchase price for the item that was associated with the Feedback entry.
This value can be returned as part of the Detailed Seller Ratings feature.
Not returned if a listing ended more than 90 days ago. For Feedback entries that were left for the buyer by the seller, an <b>ItemPrice</b> value will not be returned to a user that was not involved in the transaction as either the buyer or seller.
Detailed Seller Ratings
https://developer.ebay.com/DevZone/guides/features-guide/default.html#Development/Sales-Feedback.html#DetailedSellerRatings
GetFeedback
DetailLevel: ReturnAll
Conditionally
Unique identifier for the Feedback entry.
GetFeedback
DetailLevel: ReturnAll
Conditionally
Unique identifier for an eBay order line item for which the Feedback entry was left. This field is not returned if the Feedback entry was left for an auction listing, since all auction listings have a <b>TransactionID</b> value of 0. For Feedback entries that were left for the buyer by the seller, a <b>TransactionID</b> value will not be returned to a user that was not involved in the transaction as either the buyer or seller.
GetFeedback
DetailLevel: ReturnAll
Conditionally
This boolean value indicates whether or not eBay replaced the Feedback comment with a message that the Feedback comment was removed.
GetFeedback
DetailLevel: ReturnAll
Conditionally
This boolean value indicates whether or not eBay replaced the response to the Feedback comment with a message that the response to the Feedback comment was removed.
GetFeedback
DetailLevel: ReturnAll
Conditionally
This boolean value indicates whether or not eBay replaced the follow-up to the Feedback comment with a message that the follow-up to the Feedback comment was removed.
GetFeedback
DetailLevel: ReturnAll
Conditionally
This boolean value indicates whether or not the Feedback entry will affect the user's Feedback score. Only Feedback left by verified users can count toward the aggregate score of another user. If a unverified user leaves a Feedback entry, then later becomes verified, that Feedback entry will still have no affect on the recipient user's Feedback score. Or, if a user is verified and at some later date changes to unverified status, the Feedback entry left while the user was verified remains in effect.
true
GetFeedback
DetailLevel: ReturnAll
Conditionally
(GetUser) ItemDetails
GetUser.html#Response.User.SiteVerfied
This flag indicates whether or not a Feedback entry was revised (rating was
changed).
GetFeedback
DetailLevel: ReturnAll
Conditionally
The unique identifier for an eBay order line item. For Feedback entries that were left for the buyer by the seller, an <b>OrderLineItemID</b> value will not be returned to a user that was not involved in the transaction as either the buyer or seller.
<br>
GetFeedback
DetailLevel: ReturnAll
Conditionally
Type defining the Feedback details for an order line item, including the eBay User ID
of the user the feedback is intended for, the Feedback rating, and the Feedback comment.
Textual comment that explains, clarifies, or justifies the Feedback rating specified
in <b>CommentType</b>. This field is required in <b>CompleteSale</b> if the
<b>FeedbackInfo</b> container is used.
<br><br>
This comment will still be displayed even if submitted Feedback is withdrawn.
80
CompleteSale
Conditionally
GetSellerTransactions
DetailLevel: none, ReturnAll
Conditionally
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
This value indicates the Feedback rating for the user specified in the
<b>TargetUser</b> field. This field is required in <b>CompleteSale</b> if the
<b>FeedbackInfo</b> container is used.
<br><br>
A Positive rating increases the user's Feedback score, a Negative rating decreases
the user's Feedback score, and a Neutral rating does not affect the user's Feedback
score. eBay users also have the right to withdraw feedback for whatever reason.
<br><br>
Sellers cannot leave Neutral or Negative ratings for buyers.
CompleteSale
Positive
Conditionally
GetItemsAwaitingFeedback
Conditionally
FeedbackReceived
GetSellerTransactions
DetailLevel: none, ReturnAll
Conditionally
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetMyeBayBuying
WonList
DeletedFromWonList
DetailLevel: none, ReturnAll
Conditionally
GetMyeBaySelling
SoldList
DeletedFromSoldList
DetailLevel: none, ReturnAll
Conditionally
This eBay User ID identifies the recipient user for whom the feedback is being left.
This field is required in <b>CompleteSale</b> if the
<b>FeedbackInfo</b> container is used.
CompleteSale
No
GetSellerTransactions
DetailLevel: none, ReturnAll
Conditionally
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
Container for a set of feedback statistics. Contains zero one or
multiple FeedbackPeriod objects. Output only, for the summary
feedback data returned by GetFeedback.
Contains one feedback statistic giving length of the period being reported
(e.g. last 7 days prior to the call), and total number of feedback entries
(of the type given by the container, e.g. positive feedback) submitted during
the indicated period. Returned if no detail level is specified.
GetFeedback
DetailLevel: none, ReturnAll
Conditionally
This type is used by the <b>FeedbackPeriod</b> containers that are returned in the <b>GetFeedback</b> call to indicate how many Negative, Neutral, Positive, Retracted, and Total Feedback entries a user has received within different periods of time, typically 30 days, 180 days, and 365 days.
This integer value indicates the total number of days in the time period for the Feedback count. Typically, the returned time periods are 30 days, 180 days, and 365 days. This field is always returned with the <b>FeedbackPeriod</b> container.
GetFeedback
DetailLevel: none, ReturnAll
Conditionally
This integer value indicates the total number of Feedback entries that occurred within the time period specified in the <b>PeriodInDays</b> field. This field is always returned with the <b>FeedbackPeriod</b> container.
GetFeedback
DetailLevel: none, ReturnAll
Conditionally
Applicable to sites that support the Detailed Seller Ratings feature.
The FeedbackRatingDetailCodeType is the list of areas for detailed seller ratings. When buyers leave an overall Feedback rating (positive, neutral, or negative) for a seller, they also can leave ratings in four areas: item as described, communication, shipping time, and charges for shipping and handling. Users retrieve detailed ratings as averages of the ratings left by buyers.
Detailed seller rating in the area of "item as described."
Detailed seller rating in the area of "communication."
Detailed seller rating in the area of "shipping time." Inapplicable to
motor vehicle items.
Detailed seller rating in the area of "charges for shipping and handling."
Inapplicable to motor vehicle items.
(out) Reserved for internal or future use.
The color of a feedback score star visually denotes the
range in which the member's summary feedback score falls. The score
is the net positive feedback minus the net negative feedback left
for the member.
No graphic displayed, feedback score 0-9.
Yellow Star, feedback score 10-49.
Blue Star, feedback score 50-99.
Turquoise Star, feedback score 100-499.
Purple Star, feedback score 500-999.
Red Star, feedback score 1,000-4,999
Green Star, feedback score 5,000-9,999.
Yellow Shooting Star, feedback score 10,000-24,999.
Turquoise Shooting Star, feedback score 25,000-49,999.
Purple Shooting Star, feedback score 50,000-99,999.
Red Shooting Star, feedback score 100,000-499,999.
Green Shooting Star, feedback score 500,000-999,999.
Silver Shooting Star, feedback score 1,000,000 and above.
Reserved for internal or future use.
This type is deprecated.
587
681
NoOp
This enumerated type is used to indicate the type of response to a Feedback entry.
This enumeration value is used in the <b>ResponseType</b> field of a <b>RespondToFeedback</b> call if the user is replying to a Feedback entry left by another user.
This enumeration value is used in the <b>ResponseType</b> field of a <b>RespondToFeedback</b> call if the user is following up on a Feedback entry comment left by another user.
Reserved for future use.
This enumerated type is used to indicate the length of the time period for which Detailed Seller Ratings are evaluated under the <b>AverageRatingSummary</b> container returned in the <b>GetFeedback</b> call.
This enumeration value indicates that the Detailed Seller Rating statistics shown under each <b>AverageRatingDetails</b> container were compiled over the last 30 days.
This enumeration value indicates that the Detailed Seller Rating statistics shown under each <b>AverageRatingDetails</b> container were compiled over the last 52 weeks, or one year.
Reserved for internal or future use.
Specifies all feedback summary information (except Score). Contains
FeedbackPeriodArrayType objects that each convey feedback counts for positive,
negative, neutral, and total feedback counts - for various time periods each. Also
conveys counts of bid retractions for the predefined time periods.
Bid retractions count, for multiple predefined time periods preceding
the call. Returned if no detail level is specified.
GetFeedback
DetailLevel: none, ReturnAll
Conditionally
Negative feedback entries count, for multiple predefined time periods preceding
the call. Returned if no detail level is specified.
GetFeedback
DetailLevel: none, ReturnAll
Conditionally
Neutral feedback entries count, for multiple predefined time periods preceding
the call. Returned if no detail level is specified.
GetFeedback
DetailLevel: none, ReturnAll
Conditionally
Positive feedback entries count, for multiple predefined time periods
preceding the call. Returned if no detail level is specified.
GetFeedback
DetailLevel: none, ReturnAll
Conditionally
Total feedback score, for multiple predefined time periods preceding the
call. Returned if no detail level is specified.
GetFeedback
DetailLevel: none, ReturnAll
Conditionally
Number of neutral comments received from suspended users. Returned if no
detail level is specified.
GetFeedback
DetailLevel: none, ReturnAll
Conditionally
Total number of negative Feedback comments, including weekly repeats. Returned if no detail level is specified.
GetFeedback
DetailLevel: none, ReturnAll
Conditionally
Total number of positive Feedback comments, including weekly repeats. Returned if no detail level is specified.
GetFeedback
DetailLevel: none, ReturnAll
Conditionally
Total number of neutral Feedback comments, including weekly repeats. Returned if no detail level is specified.
GetFeedback
DetailLevel: none, ReturnAll
Conditionally
Container for information about detailed seller ratings (DSRs)
that buyers have left for a seller.
Sellers have access to the number of ratings they've received, as well as
to the averages of DSRs they've received in each
DSR area (i.e., to the average of ratings in the item-description area, etc.).
The DSR feature is available on the United Kingdom site
and on the following other sites: AU (site ID 15), BEFR (site ID 23),
BENL (site ID 123), FR (site ID 71), IE (site ID 205), IN (site ID 203),
IT (site ID 101), and PL (site ID 212). The DSR feature is available on the other
API-enabled country sites, including the US site (site ID 0).
Detailed Seller Ratings
https://developer.ebay.com/DevZone/guides/features-guide/default.html#Development/Sales-Feedback.html#DetailedSellerRatings
GetFeedback
Conditionally
DetailLevel: none, ReturnAll
Container for information about 1 year feedback metric as seller.
GetFeedback
Conditionally
DetailLevel: none, ReturnAll
Container for information about 1 year feedback metric as buyer.
GetFeedback
Conditionally
DetailLevel: none, ReturnAll
This enumerated type consists of the values that may be used in the request of a <b>GetFeedback</b> call in order to retrieve a specific type of Feedback.
This enumeration value will be used in the <b>FeedbackType</b> field of a <b>GetFeedback</b> call if the user only wants to retrieve the Feedback data that they have received acting as a seller.
This enumeration value will be used in the <b>FeedbackType</b> field of a <b>GetFeedback</b> call if the user only wants to retrieve the Feedback data that they have received acting as a buyer.
This enumeration value will be used in the <b>FeedbackType</b> field of a <b>GetFeedback</b> call if the user wants to retrieve the Feedback data that they have received acting as a seller and buyer.
This enumeration value will be used in the <b>FeedbackType</b> field of a <b>GetFeedback</b> call if the user wants to retrieve the Feedback they have left for their order partners while acting as a seller or buyer.
Reserved for internal or future use.
Type used to express all fees associated with listing an item. These are the fees that the seller will pay to eBay.
A <b>Fee</b> container is returned for each listing fee associated with listing an item. Each <b>Fee</b> container consists of the fee type, the amount of the fee, and any applicable eBay promotional discount on that listing fee. A <b>Fee</b> container is returned for each listing feature, even if the associated cost is 0.
AddFixedPriceItem
AddItem
AddItems
AddLiveAuctionItem
RelistFixedPriceItem
RelistItem
ReviseFixedPriceItem
ReviseItem
ReviseLiveAuctionItem
VerifyAddFixedPriceItem
VerifyAddItem
ReviseInventoryStatus
VerifyRelistItem
Always
AddItemFromSellingManagerTemplate
AddSellingManagerTemplate
GetSellingManagerTemplateAutomationRule
GetSellingManagerItemAutomationRule
SetSellingManagerTemplateAutomationRule
SetSellingManagerItemAutomationRule
GetSellingManagerTemplateAutomationRule
DeleteSellingManagerItemAutomationRule
DeleteSellingManagerTemplateAutomationRule
ReviseSellingManagerTemplate
Conditionally
This type is deprecated, as shipping insurance is no longer applicable or supported in eBay APIs.
Shipping insurance is no longer applicable or supported in eBay APIs.
Shipping insurance is no longer applicable or supported in eBay APIs.
Shipping insurance is no longer applicable or supported in eBay APIs.
Shipping insurance is no longer applicable or supported in eBay APIs.
Shipping insurance is no longer applicable or supported in eBay APIs.
Shipping insurance is no longer applicable or supported in eBay APIs.
Shipping insurance is no longer applicable or supported in eBay APIs.
This type is deprecated, as shipping insurance is no longer applicable or supported in eBay APIs.
This field is deprecated.
This field is deprecated.
Details of an individual discount profile defined by the
user for flat-rate shipping.
The type of discount or rule that is being used by the profile.
The value corresponding to the selected rule is set in the same-named field
of <b>FlatShippingDiscount.DiscountProfile</b>.
GetShippingDiscountProfiles
EachAdditionalAmount, EachAdditionalAmountOff, EachAdditionalPercentOff
Conditionally
SetShippingDiscountProfiles
EachAdditionalAmount, EachAdditionalAmountOff, EachAdditionalPercentOff
Conditionally
GetItem
GetSellingManagerTemplates
EachAdditionalAmount, EachAdditionalAmountOff, EachAdditionalPercentOff
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally
Shipping Cost Discount Profiles
https://developer.ebay.com/DevZone/guides/features-guide/default.html#Development/Shipping-OtherFeatures.html#ShippingCostDiscountProfiles
Details of this particular flat-rate shipping discount profile. If the value of <b>ModifyActionCode</b> is <code>Modify</code>, all details of the new version of the profile must be provided. If <b>ModifyActionCode</b> is <code>Delete</code>, <b>DiscountProfileID</b> is required, <b>MappingDiscountProfileID</b> is optional, and all other fields of <b>DiscountProfile</b> are ignored.
GetShippingDiscountProfiles
Conditionally
SetShippingDiscountProfiles
EachAdditionalAmount, EachAdditionalAmountOff, EachAdditionalPercentOff
Conditionally
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally
Shipping Cost Discount Profiles
https://developer.ebay.com/DevZone/guides/features-guide/default.html#Development/Shipping-OtherFeatures.html#ShippingCostDiscountProfiles
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 enumerated type is deprecated.
This value is not used.
This value is not used.
This value is not used.
This value is not used.
Type defining the <b>FreeGalleryPlusEnabled</b> field that is returned under the <b>FeatureDefinitions</b> container of the <b>GetCategoryFeatures</b> response (as long as <code>FreeGalleryPlusEnabled</code> is included as a <b>FeatureID</b> value in the call request, or no <b>FeatureID</b> values are passed into the call request). This field is returned as an empty element (a boolean value is not returned) if one or more eBay API-enabled sites support the Free Gallery Plus feature for one or multiple categories.
Type defining the <b>FreePicturePackEnabled</b> field that is returned under the <b>FeatureDefinitions</b> container of the <b>GetCategoryFeatures</b> response (as long as <code>FreePicturePackEnabled</code> is included as a <b>FeatureID</b> value in the call request, or no <b>FeatureID</b> values are passed into the call request). This field is returned as an empty element (a boolean value is not returned) if one or more eBay API-enabled sites support the Free Picture Pack feature for one or multiple categories.
This enumerated type is deprecated.
This value is not used.
This value is not used.
This value is not used.
This value is not used.
Enumeration type that returns the status of the gallery image generation. That status returns either a value of 'Success' or a value that indicates why the gallery image has not been generated.
The Gallery image was successfully generated.
The Gallery image has not yet been generated.
The URL for the image file is not valid.
The URL does not start with <code>http:// </code> or <code>https:// </code>.
There is a problem with the image file.
The server containing the image file was unavailable.
The image file could not be found.
The image file failed to transfer.
The image file is not in JPG, BMP, GIF, TIF, or PNG format.
We were not able to process the image file.
Reserved for internal <b>only</b>.
Indicates which Gallery image enhancements to apply to the listing.
Featured
Gallery is supported free on all sites. So this field is useful only for removing an existing feature setting when using <b>RelistItem</b>.
Highlights the listing by randomly placing it at the top of the search results.
When the Featured First listing upgrade is selected for an item listing, the listing also automatically gets the
Gallery and Plus functionality at no extra cost.
<br><br>
A user can see if a site supports the Featured First listing upgrade by using the <b>GeteBayDetails</b> call and passing in <code>ListingFeatureDetails</code> in the <b>DetailName</b> field. In the response, the value of the <b>ListingFeatureDetails.FeaturedFirst</b> field will show a value other than <code>Disabled</code> if the eBay site supports the Featured First listing upgrade.
<br/><br/>
<span class="tablenote"><strong>Note:</strong>
Beginning in mid-August 2019, the Featured First listing upgrade can no longer be added for new listings in any eBay marketplace. Existing listings enabled with this feature will still be honored until mid-September 2019, at which time the feature will be fully disabled.
<br/><br/>
After August 1, 2019, if this value is used in an Add/Revise/Relist call, sellers will get a warning message about this value/feature being deprecated. In mid-August 2019, sellers will no longer be able to use this value for new listings or for revising existing listings.
</span>
This feature, which is free on all sites, adds a Gallery image in the search results. A Gallery image is an image that was uploaded and copied to EPS (eBay Picture Service). This copy is stored for 30 days or until the image is associated with a listing. Once the image is associated with a listing, the period is extended to 90 days after the item's sale_end date and is extended again if the item is relisted or used in subsequent listings. As part of storing a copy, EPS also makes additional sizes available (thumbnail, main image, supersize, popup, etc.), which are used by the various Gallery enhancements.
<br/><br/>
All images must comply to the <a href="http://developer.ebay.com/DevZone/guides/features-guide/default.html#development/Pictures-Intro.html">Picture Requirements.</a>
Adds a Gallery Plus icon to the listing.
<br/><br/>
When Plus is selected in a request that specifies at least two images (using ItemType.PictureDetailsType.PictureURL), the Gallery Plus feature automatically includes a Gallery Showcase of all the listing's images.
<br><br>
The Gallery Showcase displays when hovering over or clicking on the listing's Gallery Plus icon in the search results. The Showcase window displays a large (400px x 400px) preview image which is first image specified PictureURL, as well as up to 11 (64 px x 64 px) selectable thumbnails for the remaining EPS images. Clicking on the preview image displays the item's listing page.
<br/><br/>
If Plus is selected and the request includes only one EPS image or any self-hosted images, the listing includes a Gallery Plus icon that, when hovered over or clicked, displays a large (400px x 400px) preview image of the item. Clicking the image displays the View Item page for that listing.
<br><br>
When using RelistItem or ReviseItem (item has no bids and more than 12 hours before the listing's end), Plus can be unselected in the request. However, the Plus fee will still apply if a previous request selected Plus. There is at most one Plus fee per listing.
<br><br>
When "Plus" is included in an item listing, the listing also automatically gets the
Gallery functionality at no extra cost. "Gallery" does not need to be specified
separately in the listing.
<br><br>
Listing images that are originally smaller than 400px x 400px are centered in the
preview frame. Images that are originally larger than 400px x 400px are scaled down
to 400px on their longest side (maintaining their original aspect ratio).
Reserved for internal use <b>only</b>.
This enumerated type is deprecated.
This value is not used.
This value is not used.
This value is not used.
This value is not used.
This value is not used.
This value is not used.
This enumerated type is used to indicate if an eBay site or category supports Motors National Listings and/or Motors Local Market listings.
If this enumeration value is returned, the eBay site or category only supports Motors National Listings for the corresponding Motors dealer subscription level/type.
If this enumeration value is returned, the eBay site or category only supports Motors Local Market Listings for the corresponding Motors dealer subscription level/type.
If this enumeration value is returned, the eBay site or category supports Motors National Listings and Motors Local Market listing for the corresponding Motors dealer subscription level/type.
Reserved for internal or future use.
This enumerated type defines the values that can be used in the <b>CallMode</b> field of the <b>GetAllBidders</b> call request to control which type of auction bidders are returned in the response.
This enumeration value is used if the user wants to retrieve all bidders on an active or recently-ended auction listing. This value can be used by any user, and it is the default value if the <b>CallMode</b> field is not included in the call request.
This enumeration value is used if the user wants to retrieve all non-winning bidders for a recently-ended auction listing. This value can be only be used by the seller of the item.
This enumeration value is used if the user wants to retrieve all non-winning bidders, for a recently-ended auction listing, who are eligible for, and who accept Second Chance Offers. This value can be only be used by the seller of the item. See <"http://pages.ebay.com/help/sell/second_chance_offer.html#when" target="_blank">When to use a Second Chance Offer</a> for more information on Second Chance Offers.
Reserved for internal or future use.
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 field is deprecated.
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 field is deprecated.
This field is deprecated.
This field is deprecated.
This field is deprecated.
<span class="tablenote"><b>Note: </b> This enumerated type is deprecated as the Gift Icon feature is no longer available on any eBay Marketplace sites.
</span>
The listing feature is enabled for the site.
The listing feature is disabled for the site.
Reserved for internal or future use.
This type is used by the <b>GiftSummary</b> container that is returned in <b>GetOrders</b> and other order management calls if a buyer has purchased a digital gift card but has sent it to another individual as a gift. The <b>GiftSummary</b> container consists of the message that the buyer wrote for the recipient of the digital gift card.
This free-form text contains the message that the purchaser of the digital gift card left for the recipient of the gift card.
<br><br>
<b>For GetItemTransactions only:</b> If using Trading WSDL Version 1019 or above, this field will only be returned to the buyer or seller, and no longer returned at all to third parties. If using a Trading WSDL older than Version 1019, real data is only returned to the buyer or seller, and a string value of <code>Unavailable</code> will be returned to all third parties.
GetOrders
DetailLevel: none, ReturnAll
Conditionally
OrderReport
Conditionally
GetOrderTransactions
DetailLevel: none, ReturnAll
Conditionally
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ReturnAll
Conditionally
Specifies whether the Global Shipping Program (GSP) is enabled or not. The field is
returned as an empty element (i.e., a boolean value is not returned).
Specifies a predefined subset of fields to return. The predefined set of fields
can vary for different calls. Only applicable to certain calls (see request types
that include a GranularityLevel property). For calls that support this filter, see
the <a href="http://developer.ebay.com/DevZone/guides/features-guide/default.html#basics/eBay-SelectingFields.html">eBay Features Guide</a> for a list of the output fields that are returned for
each level. Only one level can be specified at a time. For GetSellerList, use
DetailLevel or GranularityLevel in a given request, but not both. For
GetSellerList, if GranularityLevel is specified, DetailLevel is ignored.
(in) For each record in the response, retrieves less data than Medium.
See the <a href="http://developer.ebay.com/DevZone/guides/features-guide/default.html#basics/eBay-SelectingFields.html">eBay Features Guide</a> for a list of the output fields
that are returned when this level is specified.
For each record in the response, retrieves more data than Medium.
See the <a href="http://developer.ebay.com/DevZone/guides/features-guide/default.html#basics/eBay-SelectingFields.html">eBay Features Guide</a> for a list of the output fields
that are returned when this level is specified.
For each record in the response, retrieves more data than Coarse and less data
than Fine. See the <a href="http://developer.ebay.com/DevZone/guides/features-guide/default.html#basics/eBay-SelectingFields.html">eBay Features Guide</a> for a list of the output fields
that are returned when this level is specified.
About shipping service group 1.
About shipping service group 2.
About shipping service group 3.
This type is used to specify how many of the corresponding Product Identifier types are required to be specified at listing time.
<br/><br/>
<span class="tablenote"><strong>Note:</strong>
This type and the <b>ProductIdentifiers</b> container was originally introduced into the Trading schema with the intention of separating Global Trade Item Numbers (GTINs) and other descriptive item specifics, but <b>ProductIdentifiers</b> container was never wired on/returned in <b>GetCategorySpecifics</b>. Instead, users will still find one or more relevant GTIN types under a <b>Recommendations.NameRecommendation.Name</b> field.
</span>
<span class="tablenote"><strong>Note:</strong>
<strong>GroupValidationRulesTypetype</strong> and the <b>ProductIdentifiers</b> container were originally introduced into the Trading schema with the intention of separating Global Trade Item Numbers (GTINs) and other descriptive item specifics, but these schema elements were never wired on/returned in <b>GetCategorySpecifics</b>. Instead, users will still find one or more relevant GTIN types under a <b>Recommendations.NameRecommendation.Name</b> field.
</span>
How packaging/handling cost is to be determined for <a href="http://developer.ebay.com/DevZone/guides/features-guide/default.html#development/Listing-AnItem.html#CombinedInvoice">Combined Invoice</a>
orders.
After eBay assigns the highest packaging/handling cost to the first item, the
packaging/handling cost for each additional item is $n.
After eBay assigns the highest packaging/handling cost to the first item, the
packaging/handling cost for each additional item is to be reduced by amount N.
After eBay assigns the highest packaging/handling cost to the first item, the
packaging/handling cost for each additional item is to be reduced by N percent.
The total packaging/handling cost is to be the sum of the
packaging/handling costs of the individual items.
The packaging/handling cost is to be N for the entire order.
Reserved for internal or future use.
Defines the feature that specifies whether a handling time (dispatch time)
could be enabled on the site.
<span class="tablenote"><b>Note: </b> This enumerated type is deprecated as the Highlighted listing feature is no longer available on any eBay Marketplace sites.
</span>
The listing feature is enabled for the site.
The listing feature is disabled for the site.
Reserved for internal or future use.
This type is deprecated.
This field is deprecated.
This field is deprecated.
This field is deprecated.
Enumerated type containing a list of visit counter styles that can be used in an eBay listing to track page visits.
No hit counter. The number of page views will not be available.
A basic style hit counter (US only). Non-US sites will return errors if they use HonestyStyle as input, and should use BasicStyle instead.
US
A green LED, computer-style hit counter (US only). Non-US sites will return errors if they use GreenLED as input, and should use RetroStyle instead.
US
A hidden hit counter (US only). The number of page views will only be available to
the item's seller. For faster "View Item" page loads, use HiddenStyle.
US
A basic style hit counter.
A retro, computer-style hit counter.
A hidden hit counter. The number of page views will only be available to
the item's seller.
Reserved for internal or future use
Specifies whether a listing feature is available for the site specified in the request.
The listing feature is enabled for the site.
The listing feature is disabled for the site.
Reserved for internal or future use.
Defines whether Home Page Featured is available on the site.
<span class="tablenote"><b>Note:</b>
This enumerated type is deprecated since it is only applicable to the eBay India site, and this marketplace is no longer available.</span>
Default Escrow timelines apply.
Special Escrow timelines for Workflow A applies.
Special Escrow timelines for Workflow B applies.
(out) Reserved for internal or future use.
<span class="tablenote"><b>Note:</b>
This type is deprecated since it is only applicable to the eBay India site, and this marketplace is no longer available.</span>
Type defining the <b>ISBNEnabled</b> field that is returned under the <b>FeatureDefinitions</b> container of the <b>GetCategoryFeatures</b> response (as long as 'ISBNEnabled' is included as a <b>FeatureID</b> value in the call request or no <b>FeatureID</b> values are passed into the call request). This field is returned as an empty element (a boolean value is not returned) if one or more eBay API-enabled sites support the ISBN product identifying feature.
<br><br>
To verify if a specific eBay site supports the ISBN product identifying feature (for most categories), look for a 'true' value in the <b>SiteDefaults.ISBNEnabled</b> field.
<br><br>
To verify if a specific category on a specific eBay site supports the ISBN product identifying feature, pass in a <b>CategoryID</b> value in the request, and then look for a <code>true</code> value in the <b>ISBNEnabled</b> field of the corresponding <b>Category</b> node (match up the <b>CategoryID</b> values if more than one Category IDs were passed in the request).
This type is deprecated. It was replaced by <b>ISBNEnabledDefinitionType</b>.
Enumerated type that defines the possible states of a buyer's Item Not Received (INR) inquiry.
This value indicates that the INR inquiry is invalid.
This value indicates that the INR inquiry is not applicable.
This value indicates that the INR inquiry is pending a response from the buyer.
This value indicates that the INR inquiry is pending a response from the seller.
This value indicates that the INR inquiry was closed with a refund issued to the buyer.
This value indicates that the INR inquiry was closed with no refund issued to the buyer.
This value indicates that the INR inquiry was escalated to an eBay Money Back Guarantee case, and it is pending a response from the buyer.
This value indicates that the INR inquiry was escalated to an eBay Money Back Guarantee case, and it is pending a response from the seller.
This value indicates that the INR inquiry was escalated to an eBay Money Back Guarantee case, and it is pending a response from eBay Customer Support.
This value indicates that the INR inquiry was escalated to an eBay Money Back Guarantee case, but it was closed with a refund issued to the buyer.
This value indicates that the INR inquiry was escalated to an eBay Money Back Guarantee case, but it was closed with no refund issued to the buyer.
Reserved for internal or future use.
This type is deprecated, as shipping insurance is no longer applicable or supported in eBay APIs.
This type is deprecated, as shipping insurance is no longer applicable or supported in eBay APIs.
The seller offers the buyer the choice of paying
for shipping insurance or not.
The seller requires that the buyer pay for
shipping insurance.
The seller does not offer shipping insurance to the buyer.
The seller is not charging separately for shipping
insurance costs; any insurance is already included in the
base shipping cost.
Shipping insurance is not offered as a separate option on the site
where the item is listed. (Some shipping services, such as
DE_InsuredExpressOrCourier, include insurance as part of the service.) If
another insurance option is specified in the listing request and the site does
not support shipping insurance as a separate option, eBay will reset the
insurance option to this value. At the time of this writing, this option is
only meaningful for the eBay Germany, Austria, and Switzerland sites.
Reserved for internal or future use
This type is deprecated, as shipping insurance is no longer applicable or supported in eBay APIs.
Shipping insurance was not offered.
Shipping insurance was offered but not selected.
Shipping insurance was offered and selected.
Shipping insurance was required.
Shipping insurance was included in Shipping and Handling fee.
(out) Reserved for internal or future use.
<span class="tablenote"><b>Note: </b>
As of May 1, 2019, eBay no longer support electronic payments through Integrated Merchant Credit Card accounts. To accept online credit card payments from buyers, a seller must use specify PayPal as an accepted payment method, or opt in to eBay Managed Payments program (if the program is available to that seller).
</span>
<br/>
This type is used by the <b>IntegratedMerchantCreditCardInfo</b> container that is returned in the <b>GetUser</b> response if the seller has a payment gateway account on one or more eBay marketplaces.
<span class="tablenote"><b>Note: </b>
As of May 1, 2019, eBay no longer support electronic payments through Integrated Merchant Credit Card accounts. To accept online credit card payments from buyers, a seller must use specify PayPal as an accepted payment method, or opt in to eBay Managed Payments program (if the program is available to that seller).
</span>
<br/>
This enumeration value indicates the eBay marketplace on which the seller has a payment gateway account, an account that allows the seller to accept credit card payments from buyers.
GetUser
Conditionally
This type defines the available options the seller has for handling international returns.
Defines the available options the seller has for handling international returns in the specified marketplace and category.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
In US, sellers can offer an item replacement for returns, in addition to offering money back returns. The values returned in this field indicate the availability of such options for the given marketplace and category. <br><br>The values returned in this field are pertinent only if <b>ReturnPolicyEnabled</b> in GetCategoryFeatures is set to <code>true</code> for the associated category, which indicates that items listed in the category must include a return policy. The values returned in this field are valid in AddItem and its related family of calls, and in the return policies you configure for use with the Account API.
This type defines the available options the seller has for accepting international returns.
Defines the available options the seller has for accepting international returns in the specified marketplace and category.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
The values returned in this field indicate whether or not the seller can offer international returns. <br><br>The values returned in this field are pertinent only if <b>ReturnPolicyEnabled</b> in GetCategoryFeatures is set to <code>true</code> for the associated category, which indicates that items listed in the category must include a return policy. The values returned in this field are valid in AddItem and its related family of calls, and in the return policies you configure for use with the Account API.
This type defines the available options for the return durations for international returns.
Defines the available options for the return durations for international returns in the specified marketplace and category. This is the time the buyer has to initiate a return once they receive the item.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
The values returned in this field indicate the return-duration options that are available for international returns for items listed in the associated marketplace and category. <br><br>The values returned in this field are pertinent only if <b>ReturnPolicyEnabled</b> in GetCategoryFeatures is set to <code>true</code> for the associated category, which indicates that items listed in the category must include a return policy. The values returned in this field are valid in AddItem and its related family of calls, and in the return policies you configure for use with the Account API.
This type defines the available options for who pays the return shipping costs for international returns.
Defines the available options for who pays the return shipping costs for international returns in the specified marketplace and category.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
The values returned in this field indicate the available options for who pays the return shipping for international returns. Possible values are <code>BUYER</code> and <code>SELLER</code>. <br><br>The values returned in this field are pertinent only if <b>ReturnPolicyEnabled</b> in GetCategoryFeatures is set to <code>true</code> for the associated category, which indicates that items listed in the category must include a return policy. The values returned in this field are valid in AddItem and its related family of calls, and in the return policies you configure for use with the Account API.
Container consisting of shipping costs and other details related to an international
shipping service. If one or more international shipping services are provided, the
seller must specify at least one domestic shipping service as well.
An international shipping service being offered by the seller to ship an item to
a buyer. For a list of valid values, call <b>GeteBayDetails</b>
with <b>DetailName</b> set to <b>ShippingServiceDetails</b>.
<br/><br/>
To view the full list of International shipping service options in the response,
look for the <b>ShippingService</b> fields in the <b>ShippingServiceDetails</b> containers that
contain a <b>InternationalService</b> = <code>true</code> field, as this indicates that the <b>ShippingService</b>
value is an International shipping service option.
<br/><br/>
The <b>ShippingServiceDetails.ValidForSellingFlow</b> flag must
also be present. Otherwise, that particular shipping service option is no longer
valid and cannot be offered to buyers through a listing.
<br><br>
For flat and calculated shipping.
ShippingServiceCodeType
SendInvoice
No
AddFixedPriceItem
AddItem
AddItems
AddOrder
AddSellingManagerTemplate
RelistFixedPriceItem
RelistItem
ReviseFixedPriceItem
ReviseItem
ReviseSellingManagerTemplate
VerifyAddFixedPriceItem
VerifyAddItem
VerifyRelistItem
Conditionally
GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
Conditionally
GetBidderList
GetItemShipping
Conditionally
GetItem
GetSellingManagerTemplates
Conditionally
DetailLevel: none, ItemReturnDescription,
ItemReturnAttributes, ReturnAll
GetOrders
DetailLevel: none, ReturnAll
Conditionally
OrderReport
Conditionally
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetItemTransactions
DetailLevel: none, ReturnAll
Conditionally
GeteBayDetails
http://developer.ebay.com/Devzone/XML/docs/Reference/eBay/GeteBayDetails.html
The base cost of shipping the item using the shipping service specified in the <b>ShippingService</b> field.
In the case of a multiple-quantity, fixed-price listing, the <b>ShippingServiceAdditionalCost</b> field shows the cost to ship each additional item if the buyer purchases multiple quantity of the same line item.
<br>
<br>
When returned by <b>GetItemShipping</b>, it includes the packaging and
handling cost. For flat and calculated shipping.
<br>
<br>
If a shipping service has been specified (even LocalPickup), <b>GetItem</b> returns
the shipping service cost, even if the cost is zero. Otherwise, cost is not
returned.
<br>
<br>
If this is for calculated shipping for a listing that has not
yet ended, note that the cost cannot be determined until the listing
has ended and the buyer has specified a postal code.
<br>
<br>
For <b>GetItemShipping</b>, promotional shipping savings is reflected in the cost, if
applicable. If the promotional shipping option is lower than other shipping
services being offered, the savings is reflected in the returned shipping
cost.
The shipping service named Promotional Shipping Service (or whatever is
the localized name for it) is included among the shipping services.
If the promotional shipping cost is lower than the cost of other shipping
services being offered, it is presented first in the list. (The LOWEST shipping
service cost is always presented first, regardless of whether there is
promotional shipping.)
SendInvoice
No
AddFixedPriceItem
AddItem
AddItems
AddOrder
AddSellingManagerTemplate
RelistFixedPriceItem
RelistItem
ReviseFixedPriceItem
ReviseItem
ReviseSellingManagerTemplate
VerifyAddFixedPriceItem
VerifyAddItem
VerifyRelistItem
Conditionally
GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
Conditionally
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription,
ItemReturnAttributes, ReturnAll
Conditionally
GetBidderList
GetItemShipping
Conditionally
GetOrders
DetailLevel: none, ReturnAll
Conditionally
OrderReport
Conditionally
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetItemTransactions
DetailLevel: none, ReturnAll
Conditionally
Specifying Shipping Types and Costs
https://developer.ebay.com/DevZone/guides/features-guide/default.html#Development/Shipping-TypesCosts.html
The cost of shipping each additional item if the same buyer purchases multiple quantity of the same line item. This field is required when creating a multiple-quantity, fixed-price listing. Generally, the seller will give the buyer a shipping discount if that buyer purchases multiple quantity of the item, so this value should usually be less than the value set for <b>ShippingServiceCost</b>.
<br/><br/>
The value of this field can even be set to <code>0</code> if the seller wants to encourage buyers to buy multiple quantity of the item, or it could be that the seller can fit multiple quantities of the line item in a single shipping package, so the seller is just passing this shipping savings onto the buyer. This field is not applicable for single-quantity listings.
SendInvoice
No
AddFixedPriceItem
AddItem
AddItems
AddOrder
AddSellingManagerTemplate
RelistFixedPriceItem
RelistItem
ReviseFixedPriceItem
ReviseItem
ReviseSellingManagerTemplate
VerifyAddFixedPriceItem
VerifyAddItem
VerifyRelistItem
Conditionally
GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
Conditionally
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription,
ItemReturnAttributes, ReturnAll
Conditionally
GetBidderList
GetItemShipping
Conditionally
GetOrders
DetailLevel: none, ReturnAll
Conditionally
OrderReport
Conditionally
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetItemTransactions
DetailLevel: none, ReturnAll
Conditionally
This integer value controls the order (relative to other shipping services) in
which the corresponding <b>ShippingService</b> will appear in the View Item and
Checkout page. Sellers can specify up to five international shipping services
(with five <b>InternationalShippingServiceOption</b> containers), so valid values are
1, 2, 3, 4, and 5. A shipping service with a <b>ShippingServicePriority</b> value of <code>1</code>
appears at the top. Conversely, a shipping service with a
<b>ShippingServicePriority</b> value of 5 appears at the bottom of a list of five
shipping service options. If the Global Shipping Program is enabled on the listing for international shipping, only four additional shipping services may be specified.
<br><br>
This field is applicable to Flat and Calculated shipping.
SendInvoice
No
AddFixedPriceItem
AddItem
AddItems
AddOrder
AddSellingManagerTemplate
RelistFixedPriceItem
RelistItem
ReviseFixedPriceItem
ReviseItem
ReviseSellingManagerTemplate
VerifyAddFixedPriceItem
VerifyAddItem
VerifyRelistItem
Conditionally
GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
Conditionally
GetBidderList
GetItemShipping
Conditionally
GetItem
GetSellingManagerTemplates
Conditionally
DetailLevel: none, ItemReturnDescription,
ItemReturnAttributes, ReturnAll
GetOrders
DetailLevel: none, ReturnAll
Conditionally
OrderReport
Conditionally
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetItemTransactions
DetailLevel: none, ReturnAll
Conditionally
An international location or region to where the item seller will ship the item.
<br/><br/>
Use <b>GeteBayDetails</b> with <b>DetailName</b> set to
<b>ShippingLocationDetails</b> to determine which locations are valid per site.
In the <b>GeteBayDetails</b> response, look for the ShippingLoca<b>tionDetails.ShippingLocation</b> fields.
<br/><br/>
For the <b>AddItem</b> family of calls, this field is required if any international shipping service is specified.
<br><br>
<b>For GetOrders, GetOrderTransactions, and GetItemTransactions only:</b> If using Trading WSDL Version 1019 or above, <b>ShipToLocation</b> fields will only be returned to the buyer or seller, and no longer returned at all to third parties. If using a Trading WSDL older than Version 1019, <b>ShipToLocation</b> fields are only returned to the buyer or seller, and a string value of <code>Unavailable</code> will be returned to all third parties.
ShippingRegionCodeType, CountryCodeType
SendInvoice
No
GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
Conditionally
GetBidderList
GetItemShipping
Conditionally
GetItem
GetSellingManagerTemplates
Conditionally
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
GetOrders
DetailLevel: none, ReturnAll
Conditionally
OrderReport
Conditionally
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetItemTransactions
DetailLevel: none, ReturnAll
Conditionally
AddFixedPriceItem
AddItem
AddItems
AddOrder
AddSellingManagerTemplate
RelistFixedPriceItem
RelistItem
ReviseFixedPriceItem
ReviseItem
ReviseSellingManagerTemplate
VerifyAddFixedPriceItem
VerifyAddItem
VerifyRelistItem
Conditionally
https://developer.ebay.com/DevZone/guides/features-guide/default.html#Development/Shipping-Locations.html#ShipToLocation
Ship-To Locations
This field is no longer applicable as it is not longer possible for a seller to offer a buyer shipping insurance.
1081
NoOp
1081
The total cost of customs and taxes for the international leg of an order shipped using the Global Shipping Program. This amount is calculated and supplied for each item by the international shipping provider when a buyer views the item properties.
0
GetItemShipping
Conditionally
GetOrders
DetailLevel: none, ReturnAll
Conditionally
OrderReport
Conditionally
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetItemTransactions
DetailLevel: none, ReturnAll
Conditionally
The last time of day that an order using the specified shipping service will be accepted by the seller. The cut off time applies and is returned only when the <strong>ShippingService</strong> field contains the name of a qualifying time-sensitive shipping service, such as <code>eBayNowImmediateDelivery</code>.
<br><br>
The cut off time is set by eBay and determined in part by the policies and locations of the seller and the shipping carrier.
GetItemShipping
Conditionally
This is used in the <b>ReviseInventoryStatus</b> response to provide the set of fees associated with each unique <b>ItemID</b>.
The unique identifier of the listing being changed. <br>
<br> The <b>ReviseInventoryStatus</b> response includes a separate
set of fees for each item that was successfully revised.<br>
<br>
Use the <b>ItemID</b> to correlate the Fees data with the Inventory Status data in the response.
ReviseInventoryStatus
Always
Contains the data for one fee (such as name and amount).
ReviseInventoryStatus
Always
This type is used by the <b>ReviseInventoryStatus</b> call to update the price and/or quantity of an item or an item variation within a single-variation or multiple-variation, fixed-price listing.
This value is the seller-defined SKU value of the item being revised.
<br>
<br>
For a single-variation listing, either the <b>ItemID</b> of the listing or the <b>SKU</b> value of the item (if it exists) is required, and which one to use will depend on the value of the <b>InventoryTrackingMethod</b> setting. If the value of <b>InventoryTrackingMethod</b> is <code>ItemID</code>, the <b>ItemID</b> field should be used. If the value of <b>InventoryTrackingMethod</b> is <code>SKU</code>, the <b>SKU</b> field should be used. <code>ItemID</code> is the default value of <b>InventoryTrackingMethod</b>, and its value can only be set/changed to <code>SKU</code> through either an <b>AddFixedPriceItem</b> or <b>RelistFixedPriceItem</b> call.
<br>
<br>
For a multiple-variation listing, the <b>SKU</b> value of the item variation is required in order to identify a specific item variation. An <b>ItemID</b> field is also required if the <b>InventoryTrackingMethod</b> value is set to <code>ItemID</code>. However, if the <b>InventoryTrackingMethod</b> value is set to <code>SKU</code>, only the <b>SKU</b> value of the item variation is needed to identify a specific item variation. Note that a seller-defined <b>SKU</b> value is required when a seller creates a multiple-variation listing, regardless of whether they decide to track inventory by Item ID or SKU.
<br>
<br>
The <b>SKU</b> field is always returned in the response, and if a SKU value doesn't exist for a single-variation listing, it is returned as an empty tag.
ReviseInventoryStatus
Conditionally
ReviseInventoryStatus
Always
The unique identifier of the listing being revised.
<br>
<br>
For a single-variation listing, either the <b>ItemID</b> of the listing or the <b>SKU</b> value of the item (if it exists) is required, and which one to use will depend on the value of the <b>InventoryTrackingMethod</b> setting. If the value of <b>InventoryTrackingMethod</b> is <code>ItemID</code>, the <b>ItemID</b> field should be used. If the value of <b>InventoryTrackingMethod</b> is <code>SKU</code>, the <b>SKU</b> field should be used. <code>ItemID</code> is the default value of <b>InventoryTrackingMethod</b>, and its value can only be set/changed to <code>SKU</code> through either an <b>AddFixedPriceItem</b> or <b>RelistFixedPriceItem</b> call.
<br>
<br>
For a multiple-variation listing, the <b>SKU</b> value of the item variation is required in order to identify a specific item variation. An <b>ItemID</b> field is also required if the <b>InventoryTrackingMethod</b> value is set to <code>ItemID</code>. However, if the <b>InventoryTrackingMethod</b> value is set to <code>SKU</code>, only the <b>SKU</b> value of the item variation is needed to identify a specific item variation. Note that a seller-defined <b>SKU</b> value is required when a seller creates a multiple-variation listing, regardless of whether they decide to track inventory by Item ID or SKU.
<br>
<br>
Please note that the same <b>ItemID</b> value can be used
multiple times in the same call if you revise several
item variations from the same multiple-variation listing.
<br>
<br>
The <b>ItemID</b> field is always returned in the response, even if an <b>ItemID</b> value was not included in the request.
ReviseInventoryStatus
Conditionally
ReviseInventoryStatus
Always
This field is used to set the revised price of the listing (or of a
variation within a multiple-variation listing).
<br>
<br>
In each <b>InventoryStatus</b> container, either <b>StartPrice</b> or <b>Quantity</b> (or both) are required.
<br>
<br>
The <b>StartPrice</b> field is always returned in the response and reveals the current price of the item or item variation, regardless of whether the price was changed or not through a <b>StartPrice</b> field in the call request.
Insertion Fees
http://pages.ebay.com/help/sell/insertion-fee.html
eBay.com Listing Fees
http://pages.ebay.com/help/sell/fees.html
ReviseInventoryStatus
Conditionally
ReviseInventoryStatus
Always
This field is used to set the revised quantity of the listing (or of a
variation within a multiple-variation listing).
<br>
<br>
In each <b>InventoryStatus</b> container, either <b>StartPrice</b> or <b>Quantity</b> (or both) are required.
<br>
<br>
The <b>Quantity</b> field is always returned in the response, regardless of whether the quantity was changed or not through a <b>Quantity</b> field in the call request. However, the <b>Quantity</b> field in the response is actually a total of the quantity available for sale plus the quantity already sold for the item or item variation. For example, suppose the item or item variation originally had a quantity of 10, and then a quantity of 8 was sold. Now, you restock your inventory, and you pass in a quantity of 10 in the <b>ReviseInventoryStatus</b> request. In this case, the response of this <b>ReviseInventoryStatus</b> call would show a quantity of 18 (10 available + 8 sold). To determine the quantity available, use the <b>GetItem</b> or <b>GetSellerList</b> call, and subtract the <b>SellingStatus.QuantitySold</b> value from the <b>Quantity</b> value. Or, you can also use the <b>GetMyeBaySelling</b> call, search for the correct item or item variation in the response by <b>ItemID</b> or <b>SKU</b> value, and then look at the <b>QuantityAvailable</b> field for that item or item variation.
<br> <br>
It is a good idea to maintain an adequate quantity available for fixed-price GTC listings to prevent the search rankings from dropping. Best Match search ranking is based on buyer activity, and one of the factors affecting search ranking for fixed-price listings is the recent sales score. Fixed-price items that are selling the fastest are given a relative lift in search results.
ReviseInventoryStatus
Conditionally
ReviseInventoryStatus
Always
Defines options to track a listing by the eBay item ID or the seller's SKU.
In some calls, elements of this type are only returned in the response when
the value is set to SKU on the item.
Indicates the seller prefers to track the listing by its eBay item ID.
This is the default for all listings.
Indicates the seller prefers to track the listing by their own SKU.
<br/><br/>
When you track by SKU, it means you can pass in your SKU instead of
the eBay item ID in other calls that support SKU as an input field.
If you choose SKU as your tracking preference for a listing,
the value in <b>Item.SKU</b> must be unique across your active listings.
You cannot create new listings with the same <b>Item.SKU</b> value while
the listing is active (that is, until the existing listing with that
SKU has ended).
<br/><br/>
However, you can use <b>ReviseInventoryStatus</b> to update the quantity
and/or price for the existing SKU as needed. When revising a listing
where the <b>InventoryTrackingMethod</b> was set to SKU, you must pass in both
the <b>InventoryTrackingMethod</b> tag (with the value set to SKU) and the SKU
tag with the SKU value from your original listing.
Reserved for internal or future use.
Container for a list of items. Can contain zero, one, or multiple
<b>ItemType</b> objects, each of which conveys the data for one item listing.
Contains the data properties that define one item listing. <b>GetSellerEvents</b> and
<b>GetSellerList</b> only return items if any are available for the seller within the
time window specified in the request.<br>
<br>
Some optional fields are only returned if the seller defined them for the
item. Some fields are only returned under particular conditions specified in
the individual field descriptions. For example, a buyer's contact information
might only be returned if the member who is making the request (as identified
in the <b>eBayAuthToken</b>) has an order relationship with that buyer. <br>
<br>
For calls that support detail levels, the set of fields returned is also
controlled by the value of <b>DetailLevel</b> in the request. For some calls, other
parameters in the request can also control the data returned for each item.
For example, <b>GranularityLevel</b> controls the fields to return for each item in
the <b>GetSellerList</b>
response.
GetBidderList
Always
GetSellerList
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetSellerEvents
DetailLevel: none, ReturnAll
Conditionally
3000
GetMyeBayBuying
BestOfferList
BidList
LostList
UserDefinedList
WatchList
DeletedFromLostList
DetailLevel: none, ReturnAll
Conditionally
GetMyeBaySelling
ActiveList
ScheduledList
UnsoldList
BidList
DeletedFromUnsoldList
DetailLevel: none, ReturnAll
Conditionally
This enumerated type list the possible status values regarding whether or not a buyer received an order line item within the estimated delivery date timeframe.
BuyerIndicatedItemArrivedWithinEDDRange, BuyerIndicatedItemNotArrivedWithinEDDRange
<b>This value is for internal use only.<b>
<b>This value is for internal use only.<b>
This value indicates that the buyer indicated that the order line item did arrive within the estimated delivery date when they left feedback for the transaction.
This value indicates that the buyer indicated that the order line item did not arrive within the estimated delivery date when they left feedback for the transaction.
Reserved for internal or future use.
A collection of details about the Best Offers received for a specific item. Empty if there are no Best Offers. Includes the buyer and seller messages only if
the <code>ReturnAll</code> detail level is used.
A collection of details about the Best Offers received for a specific item. Empty if there are no Best Offers. Includes the buyer and seller messages only if the <code>ReturnAll</code> detail level is used.
GetBestOffers
DetailLevel: none, ReturnAll
Conditionally
All Best Offers for the item according to the filter or Best Offer
ID (or both) used in the input.
For the notification client usage, this response includes a
single Best Offer.
Indicates whether the eBay user is in the Buyer or
Seller role for the corresponding Best Offer.
GetBestOffers
DetailLevel: none, ReturnAll
Conditionally
All Best Offers for the item according to the filter or
Best Offer ID (or both) used in the input. The buyer and
seller messages are returned only if the detail level is
defined. Includes the buyer and seller message only if
detail level <code>ReturnAll</code> is used.
Only returned if a Best Offer has been made.
GetBestOffers
DetailLevel: none, ReturnAll
Conditionally
The item for which Best Offers are being returned.
Only returned if a Best Offer has been made.
GetBestOffers
DetailLevel: none, ReturnAll
Conditionally
This type is used by the <b>ItemBidDetails</b> container that is returned in <b>GetAllBidders<b>. The <b>ItemBidDetails</b> container shows a few details about a user's bid on an auction listing. An <b>ItemBidDetails</b> container is returned for each bid that a user makes during the life of an auction listing. An <b>ItemBidDetails</b> container will only be returned to the seller of the auction listing or to an actual bidder for the listing.
The unique identifier of an item listed on the eBay site.
<br><br>
Since a bidder's user information is anonymous, this tag will contain the real ID value only for that bidder, and the seller of an item that the user is
bidding on. For all other users, the real ID value will be replaced with the anonymous value, according to these rules:
<br><br>
When bidding on items listed on the US site: UserID is replaced with the value "a****b" where a and b are random characters from the UserID. For example, if the UserID = IBidALot, it might be displayed as, "I****A". <br>
Note that in this format, the anonymous bidder ID stays the same for every auction.
<br><br>
(<b>GetMyeBayBuying</b> only) when bidding on items listed on the US site: UserID is replaced with the value "a****b" where a and b are random characters from the UserID.
<br><br>
When bidding on items listed on the UK and AU sites: UserID is replaced with the value "Bidder X" where X is a number indicating the order of that user's first bid. For example, if the user was the third bidder,
UserID = Bidder 3. <br>
Note that in this format, the anonymous bidder ID stays the same for a given auction, but is different for different auctions. For example, a bidder who is the third and then the seventh bidder in an auction will be listed for both bids as "Bidder 3". However, if that same bidder is the first bidder on a different auction, the bidder will be listed for that auction as "Bidder 1",
not "Bidder 3".
<br><br>
(<b>GetMyeBayBuying</b> only) when bidding on items listed on the UK and AU sites: UserID is replaced with the string "High Bidder".
<br><br>
(<b>GetBestOffers</b> only) - all sites: The last part of the user ID is replaced with asterisks for users that submit best offers on an item. The seller of the item will be able to see the full User ID.
https://developer.ebay.com/DevZone/guides/features-guide/default.html#Development/CRM-UserInformation.html#WorkingwithAnonymousUserInformation
Working with Anonymous User Information
GetAllBidders
Conditionally
Unique identifier of the eBay category that the auction item is listed under.
GetAllBidders
Conditionally
The total number of bids that the user has placed on the auction item.
GetAllBidders
Conditionally
The eBay ID of the seller who listed the item.
<br><br>
This will be returned with the anonymous
value "Seller X", where X indicates where the seller falls
in the sequence of sellers that the user has purchased items
from. For example, if the seller is the third seller that
the user has purchased items from, the value "Seller 3" is
returned.
https://developer.ebay.com/DevZone/guides/features-guide/default.html#Development/CRM-UserInformation.html#WorkingwithAnonymousUserInformation
Working with Anonymous User Information
GetAllBidders
Conditionally
This timestamp indicates the date/time at which the user placed the last bid on the auction item.
GetAllBidders
Conditionally
Used to indicate whether the parts compatibility feature is enabled for a
category.
Parts Compatibility is not supported for the given category.
Parts Compatibility may be entered by application only for the given category.
Entering parts compatibility by application specifies the assemblies (e.g., a
specific year, make, and model of car) to which the item applies. Parts
compatibility by application can be specified by listing with a catalog
product that supports parts compatibility or by specifying parts compatibility
by application manually (<b> Item.ItemCompatibilityList</b>).
Parts Compatibility may be entered by specification only for the given
category. Entering parts compatibility by specification involves specifying
the part's relevant dimensions or characteristics (e.g., Section Width, Aspect
Ratio, Rim Diammeter, Load Index, and Speed Rating values for a tire) using
attributes.
(out) Reserved for internal or future use.
Defines the parts compatibility feature. If the field is present, the
corresponding feature applies to the site. The field is returned as an empty
element (e.g., a boolean value is not returned).
<br><br>
Parts compatibility listings contain information to determine the assemblies with
which a part is compatible. For example, an automotive part or accessory listed
witih parts compatibility can be matched with vehicles (e.g., specific years,
makes, and models) with which the part or accessory can be used.
<br><br>
There are two ways to enter parts compatibility: by application and by
specification.
<ul>
<li> Entering parts compatibility by application specifies the assemblies
(e.g., a specific year, make, and model of car) to which the item applies. This
can be done automatically by listing with a catalog product that supports parts
compatibility, or manually, using <b
class="con">Item.ItemCompatibilityList</b> when listing or revising an
item. </li>
<li>Entering parts compatibility by specification involves specifying the
part's relevant dimensions and characteristics necessary to determine the
assemblies with which the part is compatible (e.g., Section Width, Aspect Ratio,
Rim Diammeter, Load Index, and Speed Rating values for a tire) using
attributes.</li>
</ul>
A list of compatible applications specified as name and value pairs. Describes an
assembly with which a part is compatible (i.e., parts compatibility by application). For
example, to specify a part's compatibility with a vehicle, the name would map to
standard vehicle characteristics (e.g., Year, Make, Model, Trim, and Engine). The
values would desribe the specific vehicle, such as a 2006 Honda Accord.
Details for an individual compatible application, consisting of the name-value pair and related parts compatibility notes. When revising or relisting, the <b>Delete</b> field can be used to delete individual parts compatibility nodes.
<br/><br/>
<span class="tablenote">
<strong>Note:</strong> For the <b>GetItem</b> call, <strong>Compatibility</strong> includes only parts compatibility details that were specified manually; that is, they do not correspond to an eBay catalog product. To retrieve parts compatibility details that <em>do</em> correspond to eBay catalog products, use the eBay Product API's <b>getProductCompatibilities</b> call.
</span>
AddFixedPriceItem
AddItem
AddItemFromSellingManagerTemplate
AddItems
AddSellingManagerTemplate
RelistFixedPriceItem
RelistItem
ReviseFixedPriceItem
ReviseItem
ReviseSellingManagerTemplate
VerifyAddFixedPriceItem
VerifyAddItem
VerifyRelistItem
Conditionally
GetItem
Conditionally
Product API ProductCompatibilities call reference
http://developer.ebay.com/Devzone/product/CallRef/getProductCompatibilities.html
information about retrieving parts compatibility details that correspond to eBay catalog products.
Set this value to true to delete or replace all existing parts compatibility information when you revise or relist an item. If set to true, all existing item parts compatibility nodes are removed from the listing. If new item compatibilities are specified in the request, they replace the removed compatibilities.
<br/><br/>
<span class="tablenote">
<strong>Note:</strong> To ensure that buyer expectations are upheld, you cannot delete or replace an item parts compatibility list if the listing has bids or if the auction ends within 12 hours.
</span>
false
RelistFixedPriceItem
RelistItem
ReviseFixedPriceItem
ReviseItem
Conditionally
All information corresponding to an individual parts compatibility by application.
Removes individual parts compatibility nodes from the compatibility list. Set
to <code>true</code> within the compatibility to delete.
<br/><br/>
<span class="tablenote"><b>Note: </b>
This field can only be used with <b>Revise</b> calls or when revising a template.
</span>
If the listing has bids or ends within 12 hours, you cannot delete item parts
compatibilities.
false
ReviseFixedPriceItem
ReviseItem
ReviseSellingManagerTemplate
Conditionally
A name-value pair describing a single compatible application. The
allowed names and values are specific to the primary category in which the
item is listed. For example, when listing in a Parts & Accessories
category, where the applications are vehicles, the allowed names might include
Year, Make, and Model, and the values would correspond to specific vehicles in
eBay's catalog. For details and examples, see the
<a href="http://developer.ebay.com/DevZone/guides/features-guide/default.html#development/CompatibleParts-Listing.html#SpecifyingPartsCompatibilityManually"
target="_blank">Features Guide</a>.
<br><br>
The eBay Germany, UK, Austria, France, Italy, and Spain sites support the use of <em>K type</em> vehicle numbers to specify vehicle
parts compatibility. To use a K type number, set the <b>Name</b> field to "<code>KType</code>"
and set the corresponding <b>Value</b> field to the appropriate K type number.
<br><br>
The DE and UK eBay sites also support the use of an <em>eBay Product ID</em> (or <em>ePID</em>)
number/value pair to specify motorcycle and scooter parts compatibility (currently, only DE supports scooter parts
compatibily). To use an ePID number to specify part compatibilities, set the <b>Name</b>
field to "<code>ePID</code>" and the corresponding <b>Value</b> field to the ePID
number that matches the motorcycle for the part(s) you are listing. Motorcycle ePID numbers are provided
by the <em>Master Motorcycle List</em> (MML) file, which contains the ePID numbers and
their associated vehicle mappings). For motorcycles, an ePID number contains the vehicle make, model, CCM,
year, and submodel data. Please use the following links to obtain the DE and UK MML data files:
<br><br>
- DE seller help page: http://verkaeuferportal.ebay.de/fahrzeugteile-und-zubehoer-optimal-einstellen<br>
- UK seller help page: http://pages.ebay.co.uk/help/sell/contextual/master-motorcycle-list-manually.html
AddFixedPriceItem
AddItem
AddItemFromSellingManagerTemplate
AddItems
AddSellingManagerTemplate
RelistFixedPriceItem
RelistItem
ReviseFixedPriceItem
ReviseItem
ReviseSellingManagerTemplate
VerifyAddFixedPriceItem
VerifyAddItem
VerifyRelistItem
Conditionally
Product Metadata API Call Reference
http://developer.ebay.com/DevZone/product-metadata/CallRef/index.html
information on retrieving parts compatibility search names and corresponding values needed to specify compatibility by application manually
GetItem
Conditionally
The seller may optionally enter any notes pertaining to the parts compatibility being specified.
Use this field to specify the placement of the part on a vehicle or the type of vehicle a part fits.
AddFixedPriceItem
AddItem
AddItemFromSellingManagerTemplate
AddItems
AddSellingManagerTemplate
RelistFixedPriceItem
RelistItem
ReviseFixedPriceItem
ReviseItem
ReviseSellingManagerTemplate
VerifyAddFixedPriceItem
VerifyAddItem
VerifyRelistItem
Conditionally
GetItem
Conditionally
Specifies a predefined subset of item conditions. The predefined set of fields
can vary for different calls.
The seller specified the Item Condition as New, or
did not specify a condition.
(Excludes items that the seller listed as Used.)
The seller specified the Item Condition as Used, or
did not specify a condition.
(Excludes items that the seller listed as New.)
(out) Reserved for internal or future use.
This enumerated type is deprecated.
This value is not used.
This value is not used.
This value is not used.
This value is not used.
This value is not used.
Type defining the <b>PromotionalSaleItemIDArray</b> container, which
consists of an array of listings to which a Promotional Sale applies.
A unique identifier for an item listing.
<br/><br/>
For <b>SetPromotionalSaleListings</b>, the seller passes in the
<b>ItemID</b> value for each listing that he/she wishes to become
part of the Promotional Sale identified by the
<b>PromotionalSaleID</b> value.
<br/><br/>
For <b>GetPromotionalSaleDetails</b>, each listing returned in the
response is a part of the Promotional Sale identified by the
<b>PromotionalSaleID</b> value.
GetPromotionalSaleDetails
Conditionally
SetPromotionalSaleListings
No
Type that represents the unique identifier for an eBay listing.
Defines how a list of items should be returned.
Specifies whether or not to include the container in the response.
Set the value to true to return the default set of fields for the
container. Not needed if you set a value for at least one other field
in the container.
<br><br>
If you set DetailLevel to ReturnAll, set Include to false to exclude
the container from the response.
GetMyeBayBuying
GetMyeBaySelling
No
Specifies the listing type of items in the returned list.
GetMyeBayBuying
BestOfferList
No
Auction, FixedPriceItem, StoresFixedPrice, AdType
GetMyeBaySelling
ActiveList
No
Auction, FixedPriceItem, StoresFixedPrice, AdType
Specifies the sort order of the result. Default is Ascending.
GetMyeBayBuying
BestOfferList
BidList
DeletedFromLostList
DeletedFromWonList
LostList
WatchList
WonList
No
GetMyeBaySelling
ActiveList
BidList
DeletedFromSoldList
DeletedFromUnsoldList
ScheduledList
SoldList
UnsoldList
No
GetItemsAwaitingFeedback
No
Specifies the time period during which an item was won or lost. Similar to the
period drop-down menu in the My eBay user interface. For example, to return
the items won or lost in the last week, specify a DurationInDays of 7.
0
60
GetMyeBayBuying
BestOfferList
DeletedFromLostList
DeletedFromWonList
LostList
WonList
No
GetMyeBaySelling
DeletedFromSoldList
DeletedFromUnsoldList
SoldList
UnsoldList
No
Specifies whether or not to include Item.PrivateNotes and Item.eBayNotes
in the response.
GetMyeBayBuying
BestOfferList
BidList
DeletedFromWonList
DeletedFromLostList
LostList
WatchList
WonList
No
GetMyeBaySelling
ActiveList
BidList
DeletedFromSoldList
DeletedFromUnsoldList
ScheduledList
SoldList
UnsoldList
No
false
Specifies how to create virtual pages in the returned list.
<br>
Default for EntriesPerPage with GetMyeBayBuying is 200.
GetMyeBayBuying
BestOfferList
BidList
DeletedFromLostList
DeletedFromWonList
LostList
WatchList
WonList
No
GetMyeBaySelling
ActiveList
BidList
DeleteFromSoldList
DeleteFromUnsoldList
ScheduledList
SoldList
UnsoldList
No
Filter to reduce the SoldList response based on whether the seller (or eBay) marked the applicable order as Paid and/or Shipped
in My eBay.<br>
<br>
(Sellers can use CompleteSale or the eBay Web site UI to mark an
order as Paid or Shipped in My eBay. Sellers can also specify
PaymentStatus in ReviseCheckoutStatus to mark an order as
Paid or awaiting payment in My eBay.)
GetMyeBaySelling
SoldList
All
No
Specifies the details of policy violations if the item was administratively canceled.
The details are the policy ID and the policy text.
Policy ID of the violated policy which resulted in item being administratively canceled.
GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
GranularityLevel: Fine
Conditionally
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally
Brief information of the violated policy which resulted in item being administratively canceled.
GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
GranularityLevel: Fine
Conditionally
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally
Type used by the <b>SellerItemRatingDetailArray</b> container in the <b>LeaveFeedback</b> request payload. This container is used by an eBay buyer to leave one or more Detailed Seller Ratings for their order partner concerning an order line item.
The <b>ItemRatingDetails</b> container is used by an eBay buyer to leave a Detailed Seller Rating for their order partner concerning an order line item. Detailed Seller Ratings are left concerning Communication, Item as Described, Shipping and Handling Charges, and Shipping Time. The buyer gives the seller a rating between 1 to 5 (5 being the best) in these areas.
<br><br>
Applicable to sites that support the Detailed Seller Ratings feature.
LeaveFeedback
No
Applicable to sites that support the Detailed Seller Ratings feature.
The <b>ItemRatingDetailsType</b> contains detailed seller ratings for an order line item in one area. When buyers leave an overall Feedback rating (positive, neutral, or negative) for a seller, they also can leave ratings in four areas: item as described, communication, shipping time, and charges for shipping and handling. Users retrieve detailed ratings as averages of the ratings left by buyers.
The area of a specific detailed seller rating for an order line item.
When buyers leave an overall Feedback rating (positive, neutral, or negative)
for a seller, they also can leave ratings in four areas: item as described,
communication, shipping time, and charges for shipping and handling.
LeaveFeedback
No
A detailed seller rating for an order line item applied to the area
in the corresponding RatingDetail field. Valid input values are
numerical integers 1 though 5.
LeaveFeedback
No
This enumerated type is deprecated.
This value is not used.
This value is not used.
Sort items by price, with the highest price first.
This value is not used.
This value is not used.
This value is not used.
This value is not used.
This enumerated type contains the possible values that can be used when sorting results in the <b>GetItemsAwaitingFeedback</b>, <b>GetMyeBayBuying</b>, and <b>GetMyeBaySelling</b> calls. Assume that each of sort values can be used in any of the three calls above unless it is specifically called out that a certain enumeration value will not work/is not applicable to a call.
ClassifiedAdPayPerLeadFee, ClassifiedAdPayPerLeadFeeDescending, WonPlatform, SoldPlatform, WonPlatformDescending, SoldPlatformDescending
This enumeration value is used to sort listings and orders according to Item ID value in ascending order.
This enumeration value is used to sort listings according to item price value in ascending order.
<br/><br/>
This enumeration value is not applicable to the <b>GetItemsAwaitingFeedback</b> call.
This enumeration value is used to sort listings or orders according to the starting price value in ascending order.
<br/><br/>
This enumeration value is not applicable to the <b>GetItemsAwaitingFeedback</b> call.
This enumeration value is used to sort listings or orders according to listing title in ascending (alphabetical) order.
This enumeration value is used to sort auction listings according to the number of bids received in ascending order. This enumeration value is only applicable to auction listings, and is not applicable to the <b>GetItemsAwaitingFeedback</b> call.
This enumeration value is used to sort fixed-price listings and orders according to item quantity in ascending order. This enumeration value is only applicable to fixed-price listings, and is not applicable to the <b>GetItemsAwaitingFeedback</b> call.
This enumeration value is used to sort listings and orders according to start time in ascending order.
<br/><br/>
This enumeration value is not applicable to the <b>GetItemsAwaitingFeedback</b> call.
This enumeration value is used to sort listings and orders according to end time in ascending order.
This enumeration value is used to sort listings and orders according to the seller's user ID in ascending (alphabetical) order.
<br/><br/>
This enumeration value is not applicable to the <b>GetItemsAwaitingFeedback</b> or <b>GetMyeBaySelling</b> calls.
This enumeration value is used to sort active listings and orders according to the time left before listing ends (in ascending order).
<br/><br/>
This enumeration value is not applicable to the <b>GetItemsAwaitingFeedback</b> call.
This enumeration value is used by the <b>GetMyeBaySelling</b> call to sort listings according to the listing duration in ascending order.
<br/><br/>
This enumeration value is not applicable to the <b>GetItemsAwaitingFeedback</b> or <b>GetMyeBayBuying</b> calls.
This enumeration value is used to sort listings and orders according to the listing type in ascending order.
<br/><br/>
This enumeration value is not applicable to the <b>GetItemsAwaitingFeedback</b> call.
This enumeration value is used to sort listings and orders according to the current/final price in ascending order.
<br/><br/>
This enumeration value is not applicable to the <b>GetItemsAwaitingFeedback</b> call.
This enumeration value is used to sort auction listings and orders according to the reserve price in ascending order. This enumeration value is only applicable when a seller wants to retrieve information on their own auction listings that have reserve prices set on them. This enumeration is not applicable to the <b>GetItemsAwaitingFeedback</b> or <b>GetMyeBayBuying</b> calls.
This enumeration value is used by a buyer to sort auction listings and orders according to the maximum bid price that they placed on an auction listing in ascending order. This enumeration value is only applicable to auction listings, and is not applicable to the <b>GetItemsAwaitingFeedback</b> or <b>GetMyeBaySelling</b> calls.
This enumeration value is used to sort auction listings according to the number of unique bidders in ascending order. This enumeration value is only applicable to auction listings, and is not applicable to the <b>GetItemsAwaitingFeedback</b> or <b>GetMyeBayBuying</b> calls.
This enumeration value is used to sort auction listings according to the user ID of the highest bidder in ascending order. This enumeration value is only applicable to auction listings, and is not applicable to the <b>GetItemsAwaitingFeedback</b> or <b>GetMyeBayBuying</b> calls.
This enumeration value is used by the <b>GetMyeBaySelling</b> call to sort listings according to the buyer's user ID in ascending order.
<br/><br/>
This enumeration value is not applicable to the <b>GetItemsAwaitingFeedback</b> or <b>GetMyeBayBuying</b> calls.
This enumeration value is used by the <b>GetMyeBaySelling</b> call to sort listings according to the buyer's location in ascending order.
<br/><br/>
This enumeration value is not applicable to the <b>GetItemsAwaitingFeedback</b> or <b>GetMyeBayBuying</b> calls.
This enumeration value is used by the <b>GetMyeBaySelling</b> call to sort listings according to the buyer's email address in ascending order.
<br/><br/>
This enumeration value is not applicable to the <b>GetItemsAwaitingFeedback</b> or <b>GetMyeBayBuying</b> calls, and a buyer's email address will only be exposed to the seller within two weeks of order purchase.
This enumeration value is used by the <b>GetMyeBayBuying</b> call to sort listings and orders according to the seller's email address in ascending order.
<br/><br/>
This enumeration value is not applicable to the <b>GetItemsAwaitingFeedback</b> or <b>GetMyeBaySelling</b> calls.
This enumeration value is used to sort orders according to item price value in ascending order.
<br/><br/>
This enumeration value is not applicable to the <b>GetItemsAwaitingFeedback</b> call.
This enumeration value is used by the <b>GetMyeBaySelling</b> call to sort listings and orders according to the number of users watching the listing in ascending order.
<br/><br/>
This enumeration value is not applicable to the <b>GetItemsAwaitingFeedback</b> or <b>GetMyeBayBuying</b> calls.
This enumeration value is used by the <b>GetMyeBaySelling</b> call to sort active listings according to the number of Best Offers that the listing has received in ascending order.
<br/><br/>
This enumeration value is not applicable to the <b>GetItemsAwaitingFeedback</b> or <b>GetMyeBayBuying</b> calls.
This enumeration value is used by the <b>GetMyeBaySelling</b> call to sort listings and orders according to the number of questions that the listing has received in ascending order.
<br/><br/>
This enumeration value is not applicable to the <b>GetItemsAwaitingFeedback</b> or <b>GetMyeBayBuying</b> calls.
This enumeration value is used to sort orders according to the cost to ship one unit of the order line item in ascending order.
<br/><br/>
This enumeration value is not applicable to the <b>GetItemsAwaitingFeedback</b> call.
This enumeration value is used to sort orders according to the type of feedback that a user received in ascending order. The Feedback ratings are defined in <b>CommentTypeCodeType</b>.
This enumeration value is used to sort orders according to the type of feedback that a user left for another user in ascending order. The Feedback ratings are defined in <b>CommentTypeCodeType</b>.
This enumeration value is used to sort listings and orders according to the eBay user ID of the order partner/owner of listing in ascending order.
This enumeration value is used by the <b>GetMyeBaySelling</b> call to sort order line items according to the quantity sold in ascending order.
<br/><br/>
This enumeration value is not applicable to the <b>GetItemsAwaitingFeedback</b> or <b>GetMyeBayBuying</b> calls.
This enumeration value is used by the buyer in a <b>GetMyeBayBuying</b> call to sort all Best Offers made in ascending order according to the dollar amount of the Best Offer. This sort option is only applicable if the buyer has at least one pending Best Offer on an order line item.
<br/><br/>
This enumeration value is not applicable to the <b>GetItemsAwaitingFeedback</b> or <b>GetMyeBaySelling</b> calls.
This enumeration value is used to sort order line items according to quantity available for purchase in ascending order.
<br/><br/>
This enumeration value is not applicable to the <b>GetItemsAwaitingFeedback</b> call, and it is only relevant to the <b>WatchList</b> container of the <b>GetMyeBayBuying</b> call.
This enumeration value is used to sort purchased line items according to the quantity purchased by the buyer in ascending order.
<br/><br/>
This enumeration value is not applicable to the <b>GetItemsAwaitingFeedback</b> call.
This enumeration value is no longer applicable as Half.com has been shut down, and eBay marketplace is the only remaining platform.
This enumeration value is no longer applicable as Half.com has been shut down, and eBay marketplace is the only remaining platform.
This enumeration value is used by the <b>GetMyeBaySelling</b> call to sort listings according to the listing duration in descending order.
<br/><br/>
This enumeration value is not applicable to the <b>GetItemsAwaitingFeedback</b> or <b>GetMyeBayBuying</b> calls.
This enumeration value is used to sort listings and orders according to the listing type in descending order.
<br/><br/>
This enumeration value is not applicable to the <b>GetItemsAwaitingFeedback</b> call.
This enumeration value is used to sort listings and orders according to the current/final price in descending order.
<br/><br/>
This enumeration value is not applicable to the <b>GetItemsAwaitingFeedback</b> call.
This enumeration value is used by the <b>GetMyeBaySelling</b> call to sort auction listings and orders according to the reserve price in descending order. This enumeration value is only applicable when a seller wants to retrieve information on their own auction listings that have reserve prices set on them.
<br/><br/>
This enumeration is not applicable to the <b>GetItemsAwaitingFeedback</b> or <b>GetMyeBayBuying</b> calls.
This enumeration value is used by the <b>GetMyeBayBuying</b> call to sort auction listings and orders according to the maximum bid price that a buyer placed on an auction listing in descending order.
<br/><br/>
This enumeration value is only applicable to auction listings, and is not applicable to the <b>GetItemsAwaitingFeedback</b> or <b>GetMyeBaySelling</b> calls.
This enumeration value is used by the <b>GetMyeBaySelling</b> call to sort auction listings according to the number of unique bidders in descending order.
<br/><br/>
This enumeration value is only applicable to auction listings, and is not applicable to the <b>GetItemsAwaitingFeedback</b> or <b>GetMyeBayBuying</b> calls.
This enumeration value is used by the <b>GetMyeBaySelling</b> call to sort auction listings according to the user ID of the highest bidder in descending order.
<br/><br/>
This enumeration value is only applicable to auction listings, and is not applicable to the <b>GetItemsAwaitingFeedback</b> or <b>GetMyeBayBuying</b> calls.
This enumeration value is used by the <b>GetMyeBaySelling</b> call to sort listings according to the buyer's user ID in descending order.
<br/><br/>
This enumeration value is not applicable to the <b>GetItemsAwaitingFeedback</b> or <b>GetMyeBayBuying</b> calls.
This enumeration value is used by the <b>GetMyeBaySelling</b> call to sort listings according to the buyer's location in descending order.
<br/><br/>
This enumeration value is not applicable to the <b>GetItemsAwaitingFeedback</b> or <b>GetMyeBayBuying</b> calls.
This enumeration value is used by the <b>GetMyeBaySelling</b> call to sort listings according to the buyer's email address in descending order. A buyer's actual email address will only be exposed to the seller within two weeks of order purchase.
<br/><br/>
This enumeration value is not applicable to the <b>GetItemsAwaitingFeedback</b> or <b>GetMyeBayBuying</b> calls.
This enumeration value is used by the <b>GetMyeBayBuying</b> call to sort listings and orders according to the seller's email address in descending order.
<br/><br/>
This enumeration value is not applicable to the <b>GetItemsAwaitingFeedback</b> or <b>GetMyeBaySelling</b> calls.
This enumeration value is used to sort orders according to item price value in descending order.
<br/><br/>
This enumeration value is not applicable to the <b>GetItemsAwaitingFeedback</b> call.
This enumeration value is used by the <b>GetMyeBaySelling</b> call to sort listings and orders according to the number of users watching the listing in descending order.
<br/><br/>
This enumeration value is not applicable to the <b>GetItemsAwaitingFeedback</b> or <b>GetMyeBayBuying</b> calls.
This enumeration value is used by the <b>GetMyeBaySelling</b> call to sort listings and orders according to the number of questions that the listing has received in descending order.
<br/><br/>
This enumeration value is not applicable to the <b>GetItemsAwaitingFeedback</b> or <b>GetMyeBayBuying</b> calls.
This enumeration value is used to sort orders according to the cost to ship one unit of the order line item in descending order.
<br/><br/>
This enumeration value is not applicable to the <b>GetItemsAwaitingFeedback</b> call.
This enumeration value is used to sort orders according to the type of feedback that a user received in descending order. The Feedback ratings are defined in <b>CommentTypeCodeType</b>.
This enumeration value is used to sort orders according to the type of feedback that a user left for another user in descending order. The Feedback ratings are defined in <b>CommentTypeCodeType</b>.
This enumeration value is used to sort listings and orders according to the eBay user ID of the order partner/owner of listing in descending order.
This enumeration value is used by the <b>GetMyeBaySelling</b> call to sort order line items according to the quantity sold in descending order.
<br/><br/>
This enumeration value is not applicable to the <b>GetItemsAwaitingFeedback</b> or <b>GetMyeBayBuying</b> calls.
This enumeration value is used by the <b>GetMyeBaySelling</b> call to sort active listings according to the number of Best Offers that the listing has received in descending order.
<br/><br/>
This enumeration value is not applicable to the <b>GetItemsAwaitingFeedback</b> or <b>GetMyeBayBuying</b> calls.
This enumeration value is used to sort order line items according to quantity available for purchase in descending order.
<br/><br/>
This enumeration value is not applicable to the <b>GetItemsAwaitingFeedback</b> call, and it is only relevant to the <b>WatchList</b> container of the <b>GetMyeBayBuying</b> call.
This enumeration value is used to sort purchased line items according to the quantity purchased by the buyer in descending order.
<br/><br/>
This enumeration value is not applicable to the <b>GetItemsAwaitingFeedback</b> call.
This enumeration value is used by the <b>GetMyeBayBuying</b> call to sort all Best Offers made in descending order according to the dollar amount of the Best Offer. This sort option is only applicable if the buyer has at least one pending Best Offer on an order line item.
<br/><br/>
This enumeration value is not applicable to the <b>GetItemsAwaitingFeedback</b> or <b>GetMyeBaySelling</b> calls.
This enumeration value is used to sort listings and orders according to Item ID value in descending order.
This enumeration value is used to sort listings according to item price value in descending order.
<br/><br/>
This enumeration value is not applicable to the <b>GetItemsAwaitingFeedback</b> call.
This enumeration value is used to sort listings or orders according to the starting price value in descending order.
<br/><br/>
This enumeration value is not applicable to the <b>GetItemsAwaitingFeedback</b> call.
This enumeration value is used to sort listings or orders according to listing title in descending (alphabetical) order.
This enumeration value is used to sort auction listings according to the number of bids received in descending order.
<br/><br/>
This enumeration value is only applicable to auction listings, and is not applicable to the <b>GetItemsAwaitingFeedback</b> call.
This enumeration value is used to sort fixed-price listings and orders according to item quantity in descending order.
<br/><br/>
This enumeration value is only applicable to fixed-price listings, and is not applicable to the <b>GetItemsAwaitingFeedback</b> call.
This enumeration value is used to sort listings and orders according to start time in descending order.
<br/><br/>
This enumeration value is not applicable to the <b>GetItemsAwaitingFeedback</b> call.
This enumeration value is used to sort listings and orders according to end time in descending order.
This enumeration value is used by the <b>GetMyeBayBuying</b> call to sort listings and orders according to the seller's user ID in descending order.
<br/><br/>
This enumeration value is not applicable to the <b>GetItemsAwaitingFeedback</b> or <b>GetMyeBaySelling</b> calls.
This enumeration value is used to sort active listings and orders according to the time left before listing ends (in descending order).
<br/><br/>
This enumeration value is not applicable to the <b>GetItemsAwaitingFeedback</b> call.
This enumeration value is no longer applicable as Half.com has been shut down, and eBay marketplace is the only remaining platform.
This enumeration value is no longer applicable as Half.com has been shut down, and eBay marketplace is the only remaining platform.
This enumeration value is used by the seller of a classified ad listing in a <b>GetMyeBaySelling</b> call to sort classified ad listings according to the total number of leads (prospective buyer inquiries) in ascending order. Each lead involves an email to the buyer, and the <b>LeadCount</b> value includes read and unread emails.
<br/><br/>
This enumeration value is not applicable to the <b>GetItemsAwaitingFeedback</b> or <b>GetMyeBayBuying</b> calls.
This enumeration value is used by the seller of a classified ad listing in a <b>GetMyeBaySelling</b> call to sort classified ad listings according to the number of new leads (prospective buyer inquiries) in ascending order. Each lead involves an email to the buyer, and the <b>NewLeadCount</b> value only includes unread emails.
<br/><br/>
This enumeration value is not applicable to the <b>GetItemsAwaitingFeedback</b> or <b>GetMyeBayBuying</b> calls.
This enumeration value is used by the seller of a classified ad listing in a <b>GetMyeBaySelling</b> call to sort classified ad listings according to the total number of leads (prospective buyer inquiries) in descending order. Each lead involves an email to the buyer, and the <b>LeadCount</b> value includes read and unread emails.
<br/><br/>
This enumeration value is not applicable to the <b>GetItemsAwaitingFeedback</b> or <b>GetMyeBayBuying</b> calls.
This enumeration value is used by the seller of a classified ad listing in a <b>GetMyeBaySelling</b> call to sort classified ad listings according to the number of new leads (prospective buyer inquiries) in descending order. Each lead involves an email to the buyer, and the <b>NewLeadCount</b> value only includes unread emails.
<br/><br/>
This enumeration value is not applicable to the <b>GetItemsAwaitingFeedback</b> or <b>GetMyeBayBuying</b> calls.
The pay-per-lead feature is no longer available, so this value is no longer
applicable.
The pay-per-lead feature is no longer available, so this value is no longer
applicable.
Reserved for internal or future use.
This type is used by the <b>ItemSpecificDetails</b> container that is returned in the <b>GeteBayDetails</b> call. The <b>ItemSpecificDetails</b> container consists of maximum threshold values that must be adhered to when creating, revising, or relisting items with Item Specifics. Item Specifics are used to provide descriptive details of an item in a structured manner.
This value is the maximum number of Item Specifics name-value pairs that can be used when creating, revising, or relisting an item on the specified site. Item Specifics are used to provide descriptive details of an item in a structured manner.
Setting Item Specifics in AddItem
AddItem.html#Request.Item.ItemSpecifics
instructions on adding Item Specifics when creating a listing
GeteBayDetails
Conditionally
This value is the maximum number of corresponding name values that can be used per Item Specific when creating, revising, or relisting an item on the specified site. An example of an Item Specific that might have multiple values is 'Features'. A product can have multiple features, hence multiple features can be passed in through multiple <b>ItemSpecifics.NameValueList.Value</b> fields.
<br><br>
Once you know the site threshold, it can also be helpful to know specific Item Specifics in a listing category that can have more than value, such as 'Features'. To retrieve this information, you can call <b>GetCategorySpecifics</b> for a category and check the <b>NameRecommendation.ValidationRules.MaxValues</b> field for each Item Specific in the response.
Item Specifics Max Values in GetCategorySpecifics Response
GetCategorySpecifics.html#Response.Recommendations.NameRecommendation.ValidationRules.MaxValues
Setting one or more values for Item Specific in AddItem
AddItem.html#Request.Item.ItemSpecifics.NameValueList.Value
GeteBayDetails
Conditionally
This value is the maximum number of characters that can be used for an Item Specific value on the specified site.
Setting Item Specific values in AddItem
AddItem.html#Request.Item.ItemSpecifics.NameValueList.Value
GeteBayDetails
Conditionally
This value is the maximum number of characters that can be used for an Item Specific name on the specified site.
Setting Item Specific names in AddItem
AddItem.html#Request.Item.ItemSpecifics.NameValueList.Name
GeteBayDetails
Conditionally
This string indicates the version of the Item Specifics metadata.
GeteBayDetails
DetailLevel: none, ReturnSummary, ReturnAll
Always
This timestamp indicates the date and time when the Item Specifics metadata was last updated. Time is in Greenwich Mean Time (GMT) time. This timestamp can be useful in determining if and when to refresh cached client data.
GeteBayDetails
DetailLevel: none, ReturnSummary, ReturnAll
Always
This enumerated type is used by <b>GetItem</b>, and indicates the source for an Item Specific.
Attribute
This enumeration value indicates that the corresponding Item Specific was specified by the seller in Add/Revise/Relist call or flow. In an Add/Revise/Relist API call, Item Specifics for a listing are specified through the <b>ItemSpecifics.NameValueList</b> or <b>VariationSpecifics.NameValueList</b> (for a variation in a multiple-variation listing) containers.
This value is no longer applicable and should not be returned.
This enumeration value indicates that the corresponding Item Specific was derived from a product in the eBay Catalog, and was automatically picked up by the listing when the seller created, revised, or relisted an item referencing and matching an eBay catalog product through the use of an ePID or GTIN value in the <b>ProductListingDetails</b> container.
Reserved for future use.
This enumerated type is used to indicate whether an eBay marketplace and/or category supports the use of Item Specifics when creating, revising, or relisting an item.
This enumeration value indicates that the seller may not use Item Specifics for the specified eBay marketplace or corresponding category.
This enumeration value indicates that the seller may use Item Specifics for the specified eBay marketplace or corresponding category.
(out) Reserved for internal or future use.
Defines the Item Specific feature. If the field is present, the corresponding feature applies to the site. The field is returned as an empty element (e.g., a boolean value is not returned).
This type is deprecated.
This type is used by the <b>ItemTransactionIDArray</b> container in the <b>GetOrderTransactions</b> call. The <b>ItemTransactionIDArray</b> container is used to specify one or more specific order line items to retrieve.
An <b>ItemTransactionID</b> container is required to specify a specific order line item to retrieve.
<br><br>
The seller has the option of using an <b>OrderLineItemID</b>, a <b>SKU</b> value (if it exists for the order line item and the <b>InventoryTrackingMethod</b> is set to <code>SKU</code>), or an <b>ItemID</b>/<b>TransactionID</b> pair to identify an order line item.
GetOrderTransactions
Conditionally
This type is used by the <b>ItemTransactionID</b> container in the <b>GetOrderTransactions</b> call. This container is used to specify a specific order line item to retrieve.
Unique identifier for an eBay listing. A multiple-quantity listing can have multiple order line items, but only one <b>ItemID</b>. Unless an <b>OrderLineItemID</b> or <b>SKU</b> value is specified in the same node, this field is required for each <b>ItemTransactionID</b> node included in the request.
<br>
GetOrderTransactions
Conditionally
Unique identifier for an eBay order line item. The
<b>TransactionID</b> should match the <b>ItemID</b> specified in each <b>ItemTransactionID</b>
node included in the request. Optionally, an <b>OrderLineItemID</b> or <b>SKU</b> value can
substitute for the <b>ItemID</b>/<b>TransactionID</b> pair.
<br>
GetOrderTransactions
Conditionally
A SKU (stock keeping unit) is a unique identifier defined and used by the
seller to identify a product or variation of an item. Unless an <b>OrderLineItemID</b> value or <b>ItemID</b>/<b>TransactionID</b> pair is
specified in the same node, this field is required for each
<b>ItemTransactionID</b> node included in the request. To retrieve order line items
associated with a SKU, the <b>InventoryTrackingMethod</b> field must be set to SKU.
The <b>InventoryTrackingMethod</b> field is set through <b>AddFixedPriceItem</b> or
<b>RelistFixedPriceItem</b>.
<br>
50
GetOrderTransactions
Conditionally
<b>OrderLineItemID</b> is a unique identifier for an eBay order line item. If an <b>OrderLineItemID</b> is included in an
<b>ItemTransactionID</b> node in the request, the <b>ItemID</b>, <b>TransactionID</b>, and <b>SKU</b>
fields are not required and are ignored if they are included in the request.
<br>
GetOrderTransactions
Conditionally
Contains the data defining one item. A seller populates an object of this type at listing time with the definition of a new item. A seller also uses an object of this type to relist or revise an item. Calls that retrieve item data (such as the <b>GetSellerList</b> call) return an object of this type, filled with the item's data.
AttributeConversionEnabled, BasicUpgradePack, ClassifiedAdContactByEmailAvailable, ClassifiedAdMaximumBestOffersAllowed, ClassifiedAdPayPerLeadEnabled, CombinedFixedPriceTreatment, DepositSupported, DigitalDeliveryEnabled, DutchBINEnabled, EANIdentifierEnabled, ExpressConditionRequired
Return custom, application-specific data associated with the item.
The data you specify is stored by eBay with the item for your own
reference, but it is not used by eBay in any way. Use
<b>ApplicationData</b> to store special information for yourself, such as
a part number. For a SKU in an eBay.com listing, use the <b>SKU</b>
element instead. To remove this value when revising or relisting an
item, use <b>DeletedField</b>.
32
AddFixedPriceItem
AddItem
AddItems
AddSellingManagerTemplate
RelistFixedPriceItem
RelistItem
ReviseFixedPriceItem
ReviseItem
ReviseSellingManagerTemplate
VerifyAddFixedPriceItem
VerifyAddItem
VerifyRelistItem
No
GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
GranularityLevel: Coarse, Medium, Fine
Conditionally
GetBidderList
Conditionally
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
This field has been deprecated, and should no longer be used.
This field has been deprecated, and should no longer be used.
1027
NoOp
1033
This field is deprecated, and should no longer be used.
If <code>true</code>, the seller requests immediate payment for the item.
If <code>false</code> or not specified, immediate payment is not requested.
(In responses, does not indicate whether the item is actually still a
candidate for purchase via immediate payment.)<br>
<br>
Only applicable to items listed on PayPal-enabled sites
in categories that support immediate payment (see <b>AutoPayEnabled</b> in
<b>GetCategories</b>), or if the seller is opted into the new eBay Managed Payments program.
<br>
<br>
To create an Immediate Payment listing, <b>AutoPay</b> must be <code>true</code>,
<b>PayPalEmailAddress</b> must be a valid PayPal email address for the seller, and the only included
<b>PaymentMethods</b> value must be <code>PayPal</code>.
<br/><br/>
For a non-Immediate Payment listing,
the <b>AutoPay</b> flag is not required since it defaults to <code>false</code>.
false
AddFixedPriceItem
AddItem
AddItems
AddSellingManagerTemplate
RelistFixedPriceItem
RelistItem
ReviseFixedPriceItem
ReviseItem
ReviseSellingManagerTemplate
VerifyAddFixedPriceItem
VerifyAddItem
VerifyRelistItem
No
GetBidderList
Always
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Always
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Always
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Always
GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
GranularityLevel: Coarse, Medium, Fine
Conditionally
Requiring Immediate Payment
https://developer.ebay.com/DevZone/guides/features-guide/default.html#development/Listing-PaymentMethod.html
Listing US and CA eBay Motors Items
https://developer.ebay.com/DevZone/guides/features-guide/default.html#development/Sites-eBayMotors.html#RequiringImmediatePaymentofaVehicleDepos
Detailed information about a bid. For <b>GetMyeBayBuying</b>, returned as a self-closed element if no bids meet the request criteria.
GetMyeBayBuying
BidList
LostList
WonList
DeletedFromWonList
DeletedFromLostList
DetailLevel: none, ReturnAll
Conditionally
GetMyeBaySelling
BidList
DetailLevel: none, ReturnAll
Conditionally
Flag to indicate an item's eligibility for the PayPal Buyer Protection
program. This field is only returned if <code>true</code>. If this field is not returned, the item is not eligible for PayPal Buyer Protection. For more information on
items that are eligible for PayPal Buyer Protection, see the
<a href="https://pages.ebay.com/help/buy/paypal-buyer-protection.html#paypal">PayPal Buyer Protection</a> help page.
GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
GranularityLevel: Coarse, Medium, Fine
Conditionally
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally
GetBidderList
Conditionally
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
Miscellaneous Item Field Differences
https://developer.ebay.com/DevZone/guides/features-guide/default.html#development/IntlDiffs-Misc.html
This field is only applicable for auction listings. By specifying a 'Buy It Now' price, a seller is allowing prospective buyers the opportunity to purchase the item in the auction listing at this price immediately. When a buyer uses the 'Buy It Now' option to purchase the item, the auction listing will end immediately.
<br/><br/>
By including this field and specifying a 'Buy It Now' price, the seller is enabling the 'Buy It Now' feature on the auction listing. If the seller includes this field for any other listing type other than an auction, this field and its price will just be ignored.
<br/><br/>
The price in this field must be at least 30 percent higher than the starting bid price (which is specified in an Add call through the <b>Item.StartPrice</b> field). Once a bid is made on an auction listing, and the bid meets or exceeds the <b>Item.ReservePrice</b> value (if set), the 'Buy It Now' option becomes unavailable, and this field will no longer be applicable. If there is no Reserve Price, the first bid will nullify the 'Buy It Now' option.
<br><br>
Keep in mind that <b>GetItem</b> (and other 'Get' calls that retrieve the Item details) may still return the <b>BuyItNowPrice</b> field for an auction item even if the 'Buy It Now' option is no longer available. Instead, a user should look for the <b>ListingDetails.BuyItNowAvailable</b> boolean field in the <b>GetItem</b> response to determine if the 'Buy It Now' option is still available for the auction item.
<br/><br/>
<span class="tablenote"><b>Note: </b> For the US site, new eBay sellers are subject to <a href="https://developer.ebay.com/DevZone/guides/features-guide/default.html#development/Listing-Policies.html#SellerLimits">Seller Limits</a>, which limit the quantity of items that may be listed and/or the total cumulative value of these listings. While subject to these selling limits, an eBay seller can use the <b>GetMyeBaySelling</b> call to retrieve both the remaining number of listings they can create and the remaining cumulative value of these listings. These values are shown in the <b>Summary.QuantityLimitRemaining</b> and <b>Summary.AmountLimitRemaining</b> fields in the <b>GetMyeBaySelling</b> response. If a call to add an item or revise an item would result in the exceeding of these limits, the add item or revise item call will fail. These fields will only be returned if the seller is subject to seller limits.
</span>
AddItem
AddItems
AddSellingManagerTemplate
RelistItem
ReviseItem
ReviseSellingManagerTemplate
VerifyAddItem
VerifyRelistItem
No
GetBestOffers
DetailLevel: none, ReturnAll
Conditionally
GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
GranularityLevel: Medium, Fine
Conditionally
GetItemTransactions
GetSellerTransactions
DetailLevel: ReturnAll
Conditionally
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetMyeBayBuying
WatchList
BestOfferList
BidList
DetailLevel: none, ReturnAll
Conditionally
GetMyeBaySelling
ActiveList
ScheduledList
SoldList
UnsoldList
DeletedFromSoldList
DeletedFromUnsoldList
DetailLevel: none, ReturnAll
Conditionally
GetBidderList
Always
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Always
GetSellerEvents
DetailLevel: ReturnAll
Conditionally
<span class="tablenote"><b>Note: </b> This field's value now defaults to <code>true</code> if this field is omitted. Previously, the default value was <code>false</code>, so a user had to include this field and set it to <code>true</code> in order for eBay to map an outdated Primary or Secondary Category ID to the updated Category ID.
</span>
This boolean field controls whether or not eBay automatically maps outdated Category ID(s) specified in a
<b>PrimaryCategory</b> and/or <b>SecondaryCategory</b> container(s) to the updatd Category ID(s) no longer exists in the
current category structure: If you pass a value of <code>true</code> in
<b>CategoryMappingAllowed</b> or just omit the field, eBay will look up the current Category ID(s) that have replaced the specified Category ID(s). If you pass a value of <code>false</code>, eBay will not do any mapping, and the call may fail if specified Category ID(s) are no longer valid IDs for a eBay leaf category. The new Category ID(s) will be returned in the <b>CategoryID</b> and <b>Category2ID</b> fields (if secondary category is used) of the Add/Revise/Relist call response.
<br/><br/>
true
AddFixedPriceItem
AddItem
AddItemFromSellingManagerTemplate
AddItems
AddSellingManagerTemplate
RelistFixedPriceItem
RelistItem
ReviseFixedPriceItem
ReviseItem
ReviseSellingManagerTemplate
VerifyAddFixedPriceItem
VerifyAddItem
VerifyRelistItem
No
Maintaining Category Data
https://developer.ebay.com/DevZone/guides/features-guide/default.html#development/Categories-DataMaintenance.html
This container identifies the nonprofit organization that will benefit with a percentage of the proceeds from the sale of an item through an auction or fixed-price listing. Charity names and IDs can be found by going to <a href="https://charity.ebay.com/charity-auctions/my-causes" target="_blank">eBay for Charity</a> page and doing a search for a charity registered with the PayPal Giving Fund. The donation percentage can be set in 5 percent increments from 10 percent to 100 percent. If a benefitting charity is specified, the seller must also accept PayPal as a payment method for the item (see <b>Item.PaymentMethods</b>).
<br><br>
When it comes to revising an auction or fixed-price listing, you can add a benefitting charity (as long as there is at least 12 hours left before end of listing/close of auction), but you cannot remove or change a nonprofit company once one is already established in the original listing.
<br><br>
<b>For Revise calls</b>: The non-profit organization and donation percentage can now be modified in a Revise call as long as there are no active bids on an auction listing, or no pending Best Offers/Counter Offers on a listing.
<br><br>
This container will only be returned in Get calls for listings that will benefit a nonprofit organization if the item sells.
AddFixedPriceItem
AddItem
AddItems
AddSellingManagerTemplate
RelistFixedPriceItem
RelistItem
ReviseFixedPriceItem
ReviseItem
ReviseSellingManagerTemplate
VerifyAddFixedPriceItem
VerifyAddItem
VerifyRelistItem
No
GetBidderList
Conditionally
GetItem
GetSellingManagerTemplates
DetailLevel: ItemReturnDescription, ReturnAll
Conditionally
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
GranularityLevel: Coarse, Medium, Fine
Conditionally
Miscellaneous Item Field Differences
https://developer.ebay.com/DevZone/guides/features-guide/default.html#development/IntlDiffs-Misc.html
Identifying Listings that Benefit Nonprofits
https://developer.ebay.com/DevZone/guides/features-guide/default.html#development/Feature-NonprofitSupport.html
This two-digit enumeration value indicates the country of the seller's registration address. <b>CountryCodeType</b> defines the supported values. The <a href="https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/GeteBayDetails.html">GeteBayDetails</a> call can also be used (include the <b>DetailName</b> field and set its value to <b>CountryDetails</b>) to see the full list of supported country codes.
<br><br>
In an Add/Revise/Relist/Verify call, this field is required.
AddFixedPriceItem
AddItem
AddItems
AddSellingManagerTemplate
VerifyAddFixedPriceItem
VerifyAddItem
Yes
GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
GranularityLevel: Coarse
Conditionally
RelistItem
ReviseItem
RelistFixedPriceItem
ReviseFixedPriceItem
ReviseSellingManagerTemplate
VerifyRelistItem
No
GetBidderList
Always
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Always
GetSellerTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
This field is deprecated, and should not longer be used.
In an Add/Revise/Relist/Verify call, this required three-digit enumeration value defines the currency associated with the listing site. The item price and all costs passed in the call request will be using this currency. Similarly, the listing fees and other cost-related data will be using this currency. Since the Trading API can only be used for a select number of eBay sites, only a subset of values are supporting when adding/revising/relisting an item. These supported values are discussed in the top section of <b>CurrencyCodeType</b>.
<br><br>
In 'Get' calls, it is possible that any of the values in <b>CurrencyCodeType</b> may appear, as some cost-related fields will show the buyer's currency type.
CAD, CNY, HKD, AUD, CHF, MYR, EUR, PHP, PLN, USD, SGD, SEK, TWD, GBP
AddFixedPriceItem
AddItem
AddItems
AddSellingManagerTemplate
AddFixedPriceItem
VerifyAddFixedPriceItem
VerifyAddItem
Yes
GetBidderList
Always
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Always
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Always
GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
GranularityLevel: Coarse, Medium, Fine
Conditionally
GetBestOffers
DetailLevel: none, ReturnAll
Conditionally
GetSellerEvents
DetailLevel: none, ReturnAll
Conditionally
Field Differences for eBay Sites
https://developer.ebay.com/DevZone/guides/features-guide/default.html#development/IntlDiffs-Fields.html
The seller's description of the item.
In listing requests, you can submit your description
using CDATA if you want to use HTML or XML-reserved characters in the
description. However, a seller can not use any active content in their listing description. Active content includes animation or video via JavaScript, Flash, plug-ins, or form actions. All active content will be blocked/removed from a listing. Removing/blocking active content will lead to faster load times of listings, make listings more mobile-friendly, improve SEO performance, and lead to a more secure eBay Marketplace. For more tips on creating listings that are even more mobile-friendly, see this <a href="https://pages.ebay.com/sell/itemdescription/mobilefriendlyguidelines.html" target="_blank">Best practices</a> document.
<br><br>
For more information about eBay phasing out active content, see this
<a href="https://pages.ebay.com/sellerinformation/news/fallupdate16/active-content.html" target="_blank">Seller Update</a> page. For more information about eBay's JavaScript/Active Content policy, see the <a href="https://pages.ebay.com/help/policies/listing-javascript.html" target="_blank">JavaScript policy</a> page.
<br><br>
In the listing description, sellers are only allowed to provide links to product videos, freight shipping services, or other legally required information, and when providing these links in the listing description, the secure 'https' protocol must be used instead of 'http'. In addition, any valid links to sites outside of eBay should use the <em>target="_blank"</em> attribute in the <b>a href</b> tag so a new browser window will be loaded when the link is clicked instead of buyers being redirected off of eBay. For more information on using links in the listing description, see eBay's <a href="http://pages.ebay.com/help/policies/listing-links.html" target="_blank">Links policy</a>. For more information about the stronger security standards that eBay is using, see the <a href="https://pages.ebay.com/seller-center/seller-updates/2018-fall/marketplace-update.html#use-secure-https" target="_blank">Use secure HTTPS for enhanced browser security</a> topic in the 2018 Fall Seller Update. The <a href="https://developer.ebay.com/api-docs/sell/compliance/resources/listing_violation/methods/getListingViolations" target="_blank">getListingViolations</a> method of the Compliance API can be used to see if any of the seller's active listings are not 'HTTPS' compliant.
<br><br>
If you embed pictures in the description (by using IMG tags) instead of using
<b>PictureURL</b>, but you want a camera icon to appear in search and listing pages,
specify the following null-image URL in the <b>PictureURL</b> field:
https://pics.ebay.com/aw/pics/dot_clear.gif. See <a href="https://developer.ebay.com/DevZone/guides/features-guide/default.html#development/Pictures-InListing.html">Working with Pictures in an Item Listing</a> in the eBay Features Guide.
<br><br>
This field is conditionally required for all listings. The exception is when the seller specifies a product identifier, such as a GTIN or ePID, through the <b>ProductListingDetails</b> container and a product match is found in the eBay product catalog. If a matching product is found in the eBay product catalog, the item description will be created automatically (as long as the <b>ProductListingDetails.IncludeeBayProductDetails</b> value is <code>true</code>).
<br>
500000 (some sites may allow more, but the exact number may vary)
AddFixedPriceItem
AddItem
AddItems
AddSellingManagerTemplate
RelistFixedPriceItem
RelistItem
ReviseFixedPriceItem
ReviseItem
ReviseSellingManagerTemplate
VerifyAddFixedPriceItem
VerifyAddItem
VerifyRelistItem
Conditionally
IncludeeBayProductDetails
#Request.Item.ProductListingDetails.IncludeeBayProductDetails
GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
Conditionally
GetItem
GetSellingManagerTemplates
DetailLevel: ItemReturnDescription, ReturnAll
Always
IncludeeBayProductDetails
#Response.Item.ProductListingDetails.IncludeeBayProductDetails
This field is conditionally required if the listing is being revised through a Revise call, and the <b>Item.Description</b> field is one of the fields being changed. The enumeration value passed in this field specifies whether the text provided in the <b>Item.Description</b> field will prepend, append, or replace the existing text in the current <b>Item.Description</b> field.
ReviseItem
ReviseSellingManagerTemplate
ReviseFixedPriceItem
Conditionally
This field is deprecated, and should no longer be used.
Indicates whether an optional hit counter is displayed on the item's listing
page and, if so, what type. See <b>HitCounterCodeType</b> for specific values.
<br/>
Restriction: <HitCounter>HiddenStyle</HitCounter> is not enabled on the Germany, Austria, Switzerland, or Poland sites.
NoHitCounter
AddFixedPriceItem
AddItem
AddItems
AddSellingManagerTemplate
RelistFixedPriceItem
RelistItem
ReviseFixedPriceItem
ReviseItem
ReviseSellingManagerTemplate
VerifyAddFixedPriceItem
VerifyAddItem
VerifyRelistItem
No
GetBidderList
Always
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Always
GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
GranularityLevel: Coarse, Medium, Fine
Always
GetSellerEvents
DetailLevel: none, ReturnAll
Always
The unique identifier of the eBay listing. This identifier is generated
by eBay and returned in the response of an Add call if an item is successfully listed. Once an item is successfully created, the <b>ItemID</b> cannot be modified. <br>
<br>
<span class="tablenote"><b>Note:</b> Although we represent
item IDs as strings in the schema, we recommend you store them as 64-bit
signed integers. If you choose to store item IDs as strings, allocate at
least 19 characters (assuming decimal digits are used) to hold them. Your code should be prepared to
handle IDs of up to 19 digits. </span>
AddOrder
GetBestOffers
RelistItem
ReviseItem
VerifyRelistItem
Yes
RelistFixedPriceItem
ReviseFixedPriceItem
Conditionally
GetBidderList
GetDispute
Always
GetOrders
DetailLevel: none, ReturnAll
Always
OrderReport
Always
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Always
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Always
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Always
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Always
GetBestOffers
DetailLevel: none, ReturnAll
Conditionally
GetItemsAwaitingFeedback
GetMemberMessages
Conditionally
GetUserDisputes
DetailLevel: ReturnSummary, ReturnAll, none
Conditionally
GetMyeBayBuying
BestOfferList
BidList
LostList
SecondChanceOffer
WatchList
WonList
DeletedFromWonList
DeletedFromLostList
DetailLevel: none, ReturnAll
Conditionally
GetMyeBaySelling
ActiveList
BidList
ScheduledList
SoldList
UnsoldList
DeletedFromSoldList
DeletedFromUnsoldList
DetailLevel: none, ReturnAll
Conditionally
GetSellerEvents
DetailLevel: none, ReturnAll
Conditionally
GetSellerEvents
DetailLevel: none, ReturnAll
Conditionally
GetSellerList
DetailLevel: none, ItemReturnDescription, ReturnAll
GranularityLevel: Coarse, Medium, Fine
Conditionally
Various details about a listing, some of which are calculated or
derived after the item is listed. These include the start and end
time, converted (localized) prices, and certain flags that indicate
whether the seller specified fields whose values are not visible to
the requesting user. For <b>GetMyeBayBuying</b>, returned as a self-closed element if no listings meet the request criteria.
<br/><br/>
In an Add/Revise/Relist call, this container is used to set the Best Offer Auto-Accept and Best Offer Auto-Decline threshold values.
GetBestOffers
DetailLevel: none, ReturnAll
Always
GetBidderList
GetDispute
Always
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Always
GetSellerEvents
DetailLevel: none, ReturnAll
Conditionally
GetCategoryListings
GetItemsAwaitingFeedback
GetMemberMessages
Conditionally
GetMyeBayBuying
BestOfferList
BidList
LostList
SecondChanceOffer
WatchList
WonList
DeletedFromWonList
DeletedFromLostList
DetailLevel: none, ReturnAll
Conditionally
GetMyeBaySelling
ActiveList
BidList
ScheduledList
SoldList
UnsoldList
DeletedFromSoldList
DeletedFromUnsoldList
DetailLevel: none, ReturnAll
Conditionally
GetItemTransactions
GetSellerTransactions
DetailLevel: ReturnAll
Conditionally
GetSellerList
DetailLevel: none, ItemReturnDescription, ReturnAll
GranularityLevel: Coarse, Medium, Fine
Conditionally
AddFixedPriceItem
AddItem
AddItems
AddSellingManagerTemplate
RelistFixedPriceItem
RelistItem
ReviseFixedPriceItem
ReviseItem
ReviseSellingManagerTemplate
VerifyAddFixedPriceItem
VerifyAddItem
VerifyRelistItem
No
Contains the detail data for the Listing Designer theme and template (if either are used), which can optionally be used to enhance the appearance of the description area of an item's description.
AddFixedPriceItem
AddItem
AddItems
AddSellingManagerTemplate
RelistFixedPriceItem
RelistItem
ReviseFixedPriceItem
ReviseItem
ReviseSellingManagerTemplate
VerifyAddFixedPriceItem
VerifyAddItem
VerifyRelistItem
No
GetBidderList
Conditionally
GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
Conditionally
GetItem
GetSellingManagerTemplates
DetailLevel: ItemReturnDescription, ReturnAll
Conditionally
Describes the number of days the seller wants the listing to be active (available for bidding/buying). The duration specifies the seller's initial intent at listing time.
<br/><br/>
The end time for a listing is calculated by adding the duration to the item's start time. If the listing ends early, the value of the listing duration does not change. When a listing's duration is changed, any related fees (e.g., 10-day fee) may be debited or credited (as applicable).
<br><br>
The valid choice of values depends on the listing format (see <b>Item.ListingType</b>). For
a list of valid values, call <b>GetCategoryFeatures</b> with <b>DetailLevel</b> set to <b>ReturnAll</b>
and look for <b>ListingDurations</b> information.
<br><br>
When you revise a listing, the duration cannot be reduced if it will result in ending the listing within 24 hours of the current date-time. You are only allowed to increase the duration of the listing if fewer than 2 hours have passed since you initially listed the item and the listing has no bids. You can decrease the value of this field only if the listing has no bids (or no items have sold) and the listing does not end within 12 hours.
<br>
<br>
<span class="tablenote"><b>Note: </b> As of April 1, 2019, 'GTC' is the only supported listing duration for all eBay marketplaces with the following exceptions:
<ul>
<li>The following eBay Motors US categories are exempt from this change: <em>Cars & Trucks</em> (6001), <em>Motorcycles</em> (6024), <em>Other Vehicles & Trailers</em> (6038), <em>Boats</em> (26429), <em>Powersports</em> (66466).</li>
<li>All child categories under <em>Cars, Motorcycles & Vehicles</em> (9800) categories on the eBay UK and eBay Italy sites are also exempt from this change. </li>
</ul>
If any other listing duration value besides <code>GTC</code> is specified in this field, it will be ignored, and <code>GTC</code> will be used instead.
</span>
ListingDurationCodeType
GetCategoryFeatures
GetCategoryFeatures.html#Response.FeatureDefinitions.ListingDurations
Fees per Site
https://developer.ebay.com/DevZone/guides/features-guide/default.html#development/IntlDiffs-Fees.html
AddFixedPriceItem
AddItem
AddItems
AddSellingManagerTemplate
VerifyAddFixedPriceItem
VerifyAddItem
Yes
RelistItem
ReviseItem
ReviseSellingManagerTemplate
RelistFixedPriceItem
ReviseFixedPriceItem
VerifyRelistItem
No
GetBidderList
Conditionally
GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
Conditionally
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally
GetMyeBaySelling
ScheduledList
UnsoldList
ActiveList
DetailLevel: none, ReturnAll
Conditionally
Describes listing upgrades that sellers can select for a fee, such as the
<b>BoldTitle</b> upgrade. Also includes feature packs for saving on listing upgrades.
See <a href="https://pages.ebay.com/help/sell/ia/promoting_your_item.html">Listing Upgrades</a>
in the eBay site help.
<br><br>
You cannot remove listing upgrades when you revise a listing. When you
relist an item, use <b>DeletedField</b> to remove a listing upgrades.
AddFixedPriceItem
AddItem
AddItems
AddSellingManagerTemplate
RelistFixedPriceItem
RelistItem
ReviseFixedPriceItem
ReviseItem
ReviseSellingManagerTemplate
VerifyAddFixedPriceItem
VerifyAddItem
VerifyRelistItem
No
GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
Conditionally
GetBidderList
GetCategoryListings
Conditionally
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally
The selling format of the eBay listing, such as auction (indicated with <code>Chinese</code> value), fixed-price (indicated with <code>FixedPriceItem</code> value), or classified ad (indicated with <code>AdType</code> value).
<br><br>
If this field is not included in an <b>AddItem</b>, <b>AddItems</b>, <b>AddSellingManagerTemplate</b>, or <b>VerifyAddItem</b> call, the listing type defaults to auction
<br><br>
For <b>AddFixedPriceItem</b>, <b>RelistFixedPriceItem</b>, or <b>VerifyAddFixedPriceItem</b> call, this field must be included and set to <code>FixedPriceItem</code>, since these calls only work with fixed-price listings.
<br><br>
This field is not applicable to Revise calls because the selling format of active listings cannot be changed.
Unknown, Auction, PersonalOffer, Shopping, Half
AddFixedPriceItem
AddItem
AddItems
AddSellingManagerTemplate
RelistFixedPriceItem
RelistItem
ReviseSellingManagerTemplate
VerifyAddFixedPriceItem
VerifyAddItem
VerifyRelistItem
Conditionally
GetBidderList
Unknown, Auction, Half, PersonalOffer
Always
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription,
ItemReturnAttributes, ReturnAll
Unknown, Auction, Half
Always
GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
Unknown, Auction, Half, PersonalOffer, Shopping
Conditionally
GetItemTransactions
GetSellerTransactions
Unknown, Auction, Half, Shopping
DetailLevel: none, ItemReturnDescription, ReturnAll
Always
GetOrderTransactions
Unknown, Auction, Half, Shopping
DetailLevel: none, ItemReturnDescription, ReturnAll
Always
GetCategoryListings
Unknown, Auction, Half, PersonalOffer
Conditionally
GetMyeBayBuying
BidList
LostList
WatchList
WonList
DeletedFromWonList
DeletedFromLostList
DetailLevel: none, ReturnAll
Unknown, Auction, Half
Conditionally
GetMyeBaySelling
ActiveList
BidList
ScheduledList
SoldList
UnsoldList
DeletedFromSoldList
DeletedFromUnsoldList
DetailLevel: none, ReturnAll
Unknown, Auction, Half
Conditionally
GetSellerEvents
DetailLevel: ReturnAll
Unknown, Auction, Half, Shopping
Conditionally
Different Ways of Selling
https://pages.ebay.com/help/sell/ia/formats.html
Basic Building Blocks
https://developer.ebay.com/DevZone/guides/features-guide/default.html#basics/eBay-BuildingBlocks.html#ListingTypes
GetCategoryFeatures
GetCategoryFeatures.html#Response.FeatureDefinitions.ListingDurations
Fees per Site
https://developer.ebay.com/DevZone/guides/features-guide/default.html#development/IntlDiffs-Fees.html
Indicates the geographical location of the item (along with the value in the <b>Country</b> field).
When you revise a listing, you can add or change this value only if the
listing has no bids (or no items have sold) and it does not end within
12 hours.
<br><br>
If you do not specify <b>Location</b>, you must specify <b>Item.PostalCode</b>. If you
specify a postal code, but do not specify a location, then the location is
given a default value derived from the postal code.
<br><br>
For the Classified Ad format for motors vehicle listings, the value
provided in the <b>Location</b> field is used as item location only if the
<b>SellerContactDetails.Street</b> and the <b>SellerContactDetails.Street2</b> are empty.
Else, the <b>SellerContactDetails.Street</b> and the <b>SellerContactDetails.Street2</b>
will be used for item location.
<br>
45
AddFixedPriceItem
AddItem
AddItems
AddSellingManagerTemplate
RelistFixedPriceItem
RelistItem
ReviseFixedPriceItem
ReviseItem
ReviseSellingManagerTemplate
VerifyAddFixedPriceItem
VerifyAddItem
VerifyRelistItem
Conditionally
GetBidderList
Always
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Always
GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
GranularityLevel: Coarse, Medium, Fine
Conditionally
GetCategoryListings
Conditionally
A lot is a set of two or more similar items included in a single listing that must be purchased together in a single order line item. The <b>Item.LotSize</b> value is the number of items in the lot. This field is required if two or more items are including in one listing.
<br><br>
Lots can be used for auction and fixed-price listings. Lot items can be listed only in lot-enabled categories. Call <b>GetCategories</b> to determine if a category supports lots. If the returned <b>CategoryArray.Category.LSD</b> (<b>LotSize</b> Disabled) value is <code>true</code>, the category does not support lots.
<br>
100000
AddItem
AddItems
AddSellingManagerTemplate
RelistItem
ReviseItem
ReviseSellingManagerTemplate
VerifyAddItem
VerifyRelistItem
No
GetBidderList
Conditionally
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally
GetItemTransactions
GetSellerTransactions
DetailLevel: ReturnAll
Conditionally
This field is deprecated.
This field is deprecated.
This container is used in an <b>Add/Revise/Relist/Verify</b> call if the seller is selling a motor vehicle, and is requiring an initial deposit on that vehicle. This container is only applicable for motor vehicle listings.
<br>
<br>
<span class="tablenote"><b>Note: </b> If you set up a payment policy via the <a href="https://developer.ebay.com/api-docs/sell/account/resources/payment_policy/methods/createPaymentPolicy">Account API</a> or the <a href="https://developer.ebay.com/Devzone/business-policies/CallRef/addSellerProfile.html">Business Polices Managment API</a>, then you should not populate the fields in this <b>PaymentDetails</b> container. Instead, indicate your payment policy using the <b>SellerProfiles.SellerPaymentProfile</b> container.
</span>
<br>
This container will only be returned in 'Get' calls for motor vehicle listings where an initial deposit is required for that vehicle.
AddItem
AddItems
AddSellingManagerTemplate
RelistItem
ReviseItem
ReviseSellingManagerTemplate
VerifyAddItem
VerifyRelistItem
No
GetBidderList
Conditionally
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally
Listing US and CA eBay Motors Items
https://developer.ebay.com/DevZone/guides/features-guide/default.html#development/Sites-eBayMotors.html#PaymentMethodsforMotors
Identifies the payment method (such as PayPal) that the seller will accept
when the buyer pays for the item. For Add/Revise/Relist calls, at least
one payment method must be specified unless the seller is opted in to the new eBay Managed Payments program.
<br>
<br>
<span class="tablenote"><b>Note: </b> If you set up a payment policy via the <a href="https://developer.ebay.com/api-docs/sell/account/resources/payment_policy/methods/createPaymentPolicy">Account API</a> or the <a href="https://developer.ebay.com/Devzone/business-policies/CallRef/addSellerProfile.html">Business Polices Managment API</a>, then you should not populate this field. Instead, indicate your payment policy using the <b>SellerProfiles.SellerPaymentProfile</b> container.
</span>
<br>
<span class="tablenote"><b>Note:</b> The new eBay Managed Payments program is currently only available to a limited number of sellers on the US site. For sellers in the eBay Managed Payments program, a payment method does not need to be specified at listing time. Any payment method that is specified at listing time (or defined in a payment business policy) will be ignored and dropped from the listing, and the seller will get a warning message in the response. Immediate payment is supported for sellers in the eBay Managed Payments program, so they can include the <b>AutoPay</b> field in the request and set its value to <code>true</code>.
</span>
<br>
<span class="tablenote"><b>Note:</b> As of May 1, 2019, eBay no longer supports electronic payments through a seller's Integrated Merchant Credit Card account. To accept online credit card payments from buyers, a seller must either specify <code>PayPal</code> as an accepted payment method, or opt in to the eBay Managed Payments program. If <code>IMCC</code> is passed in as a value, this value will be ignored and dropped (and listing will possibly get blocked if <code>IMCC</code> is the only specified payment method).
</span><br>
Use <b>GetCategoryFeatures</b> to determine the payment methods that are allowed for a category on a site. For example, the response data of <b>GetCategoryFeatures</b> will show that on the US site, most categories only allow electronic payments. Also use <b>GetCategoryFeatures</b> to determine the default payment methods for a site.
<br><br>
Do not use <b>GeteBayDetails</b> to determine the payment methods for a site.
<br><br>
If you specify multiple <b>PaymentMethods</b> fields, the repeating fields must be contiguous. For example, you can specify <b>PayPalEmailAddress</b> after a list of
repeating <b>PaymentMethods</b> fields, but not between them:<br>
<br>
<code>
<PaymentMethods>VisaMC</PaymentMethods><br>
<PaymentMethods>PayPal</PaymentMethods><br>
<PayPalEmailAddress>[email protected]</PayPalEmailAddress>
</code>
<br><br>
In general, if you separate repeating instances of a field, the results will
be unpredictable. This rule applies to all repeating fields
(<code>maxOccurs="unbounded"</code> or greater than 1) in the schema. See <a href="https://developer.ebay.com/DevZone/guides/features-guide/default.html#basics/Call-APISchema.html#OverviewoftheAPISchema">Overview of the API Schema</a> in the eBay Features Guide.
<br>
<br>
<span class="tablenote"><b>Note:</b>
Required or allowed payment methods vary by site and category. Refer to <a href="https://developer.ebay.com/DevZone/guides/features-guide/default.html#development/Listing-PaymentMethod.html">
Determining the Payment Methods Allowed for a Category</a> in the eBay Features Guide
to help you determine which payment methods you
are required or allowed to specify.
</span><br>
Payment methods are not applicable to any classified ad listings, as any agreement and payment is handled off of the eBay platform.
<br>
<br>
<b>For <b>ReviseItem</b> and <b>RelistItem</b> only:</b>
A listing must have at least one valid payment method.
When you revise or relist an item and you specify a payment method
that is invalid for the target site, eBay ignores the
invalid payment method, applies the other valid
changes, and returns a warning to indicate that the
invalid payment method was ignored.
<br/><br/>
If multiple payment methods were
invalid, the warning indicates that they were all ignored.
If you modify the listing so that it includes no valid
payment methods, an error is returned. This situation could occur when
the seller removes all valid payment methods or when all
the payment methods specified for the item are no longer valid
on the target site.
Specifying a Payment Method
https://developer.ebay.com/DevZone/guides/features-guide/default.html#development/Listing-PaymentMethod.html#DeterminingthePaymentMethodsAllowedforaC
Listing an Item
https://developer.ebay.com/DevZone/guides/features-guide/default.html#development/Listing-AnItem.html
(SetUserPreferences) SellerPaymentPreferences
SetUserPreferences.html#Request.SellerPaymentPreferences
AddFixedPriceItem
AddItem
AddItemFromSellingManagerTemplate
AddItems
AddSellingManagerTemplate
RelistFixedPriceItem
RelistItem
ReviseFixedPriceItem
ReviseItem
VerifyAddFixedPriceItem
VerifyAddItem
VerifyRelistItem
Conditionally
ReviseSellingManagerTemplate
IntegratedMerchantCreditCard
Conditionally
GetBidderList
GetItems
GetSellingManagerTemplates
IntegratedMerchantCreditCard
Conditionally
GetItem
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
IntegratedMerchantCreditCard
Conditionally
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ReturnAll
IntegratedMerchantCreditCard
Always
GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
GranularityLevel: Fine
IntegratedMerchantCreditCard
Conditionally
Valid PayPal email address for the PayPal account that the seller will use
if they offer PayPal as a payment method for the listing.
<br>
<br>
<span class="tablenote"><b>Note: </b> If you set up a payment policy via the <a href="https://developer.ebay.com/api-docs/sell/account/resources/payment_policy/methods/createPaymentPolicy">Account API</a> or the <a href="https://developer.ebay.com/Devzone/business-policies/CallRef/addSellerProfile.html">Business Polices Managment API</a>, then you should not populate this field. Instead, indicate your payment policy using the <b>SellerProfiles.SellerPaymentProfile</b> container.
</span>
<br>
eBay uses this to identify the correct PayPal account when the buyer pays via PayPal during
the checkout process. (As a seller can have more than one PayPal account,
you cannot necessarily rely on PayPal account data returned from <b>GetUser</b> for
details about the account associated with the PayPal email address that the
seller specifies.)<br>
<br>
Required if seller has chosen PayPal as a payment method (<b>PaymentMethods</b>)
for the listing.<br>
<br>
For digital listings, the seller needs to use an email address that is
associated with a PayPal Premier or PayPal business account. <br>
<br>
<b>For ReviseItem and RelistItem only:</b> To remove this value
when you revise or relist an item, use <b>DeletedField</b>. When you revise a
listing, if the listing has bids (or items have been sold) or it ends within
12 hours, you can add <b>PayPalEmailAddress</b>, but you cannot remove
it.
Listing an Item
https://developer.ebay.com/DevZone/guides/features-guide/default.html#development/Listing-AnItem.html
(SetUserPreferences) SellerPaymentPreferences
SetUserPreferences.html#Request.SellerPaymentPreferences
AddFixedPriceItem
AddItem
AddItemFromSellingManagerTemplate
AddItems
AddSellingManagerTemplate
RelistFixedPriceItem
RelistItem
ReviseFixedPriceItem
ReviseItem
ReviseSellingManagerTemplate
VerifyAddFixedPriceItem
VerifyAddItem
VerifyRelistItem
Conditionally
GetBidderList
Conditionally
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally
This container is used in an Add/Revise/Relist call to set the primary listing category. This field is conditionally required in an Add call unless the seller successfully uses the <b>ProductListingDetails</b> container to find an eBay catalog product match. When the seller successfully uses an eBay catalog product to create a listing, the listing title, listing description, Item Specifics, listing category, and stock photo defined in the catalog product is used to create the listing.<br>
<br>
If you do not know the appropriate eBay category for your product, you can use the <b>GetSuggestedCategories</b> call. Once you know your category, and want to know which listing features it supports, you can use the
<b>GetCategoryFeatures</b> call. To discover if the category requires or recommends GTIN types and other Item Specifics, you can use the <b>GetCategorySpecifics</b> call.
<br>
<br>
If you do use an eBay catalog product, it is advised that you do not include this field, as any primary category ID you specify in this field may get dropped if this category is different than the primary category defined in the eBay catalog product.
<br>
<br>
<b>For ReviseItem only:</b> When revising a listing,
you can change the primary category only if an auction listing
has no bids or a multiple-quantity, fixed-price listing has no sales, and the listing does not end
within 12 hours. If you change the listing category, any Item Specifics that
were previously specified may be dropped from the listing if they aren't
valid for the new category. <br>
<br>
When you list an event ticket on the US site, you must specify one of the leaf categories under the Tickets & Experiences meta category.
AddFixedPriceItem
AddItem
AddItems
AddSellingManagerTemplate
VerifyAddFixedPriceItem
VerifyAddItem
Conditionally
RelistItem
ReviseItem
ReviseSellingManagerTemplate
RelistFixedPriceItem
ReviseFixedPriceItem
VerifyRelistItem
No
GetBidderList
Always
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Always
GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
GranularityLevel: Coarse, Medium, Fine
Conditionally
Applying Categories
https://developer.ebay.com/DevZone/guides/features-guide/default.html#development/Categories.html
Maintaining Category Data
https://developer.ebay.com/DevZone/guides/features-guide/default.html#development/Categories-DataMaintenance.html
A <code>true</code> value in this field indicates that the listing is private. In a private listing, a bidder or buyer's user ID will not be exposed to any other eBay user besides the seller of the listing. Sellers may want to use this option when they believe that a listing's potential bidders/buyers would not want their user IDs exposed to other users.
<br>
false
AddFixedPriceItem
AddItem
AddItems
AddSellingManagerTemplate
RelistFixedPriceItem
RelistItem
ReviseFixedPriceItem
ReviseItem
ReviseSellingManagerTemplate
VerifyAddFixedPriceItem
VerifyAddItem
VerifyRelistItem
No
GetBidderList
Always
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Always
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Always
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Always
GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
Conditionally
This container is used to provide one or more product identifiers for a product, and if desired by the seller, or required by eBay, the product can be matched to an eBay Catalog product. If a seller's product is matched to an eBay Catalog product, the product details associated with that catalog product will be prefilled for the listing. Product details defined for a catalog product include the product title, product description, product aspects, and stock image(s) of the product.
<br>
<br>
In some eBay categories, one or more product identifier types (e.g. UPC or ISBN) may be required, but the category may not have any eBay Catalog products defined, or the category does not allow listings to be created using a catalog product. Note that the <b>GetCategorySpecifics</b> call or the <b>GetCategoryFeatures</b> call can be used to retrieve supported/required product identifier types.
<br>
<br>
<span class="tablenote"><b>Note:</b>
If a product identifier type is required, the corresponding field must be used, even if the seller is not interested in finding an eBay catalog product match. A large percentage of eBay US categories require one or more product identifier types when listing an item. See the <a href="http://pages.ebay.com/sell/item_specifics/product_identifiers.html" target="_blank">Structured Data - Product Identifiers</a> help page for more information on which eBay US categories require which product identifier types. If known, an ePID (specified through the <b>ProductReferenceID</b> field) is always the best bet to find an eBay catalog product match, although an <b>EAN</b>, <b>ISBN</b>, <b>UPC</b>, or Brand/MPN pair can also be used in an attempt to find a catalog product match. If a Brand/MPN pair is required for the product, these values must be input through the <b>BrandMPN</b> container.
</span>
<br>
When you use <b>ProductListingDetails</b>, in an Add/Revise/Relist call, you must specify at least one GTIN, a <b>ProductReferenceID</b> (also known as an ePID), a Brand/MPN pair, or <b>TicketListingDetails</b>. If you specify more than one GTIN value, eBay uses the first one that matches a product in eBay's catalog.
<br>
<br>
<b>For ReviseItem and RelistItem only:</b> When you revise a
listing, if it has bids or it ends within 12 hours, you cannot change the
product identifier and you cannot remove existing product listing details data. However, you can
change or add preferences such as <b>IncludeStockPhotoURL</b>,
<b>UseStockPhotoURLAsGallery</b>, and <b>IncludePrefilledItemInformation</b>. To delete all
catalog data when you revise or relist an item, specify
Item.ProductListingDetails in <b>DeletedField</b> and don't pass
<b>ProductListingDetails</b> in the request.
AddFixedPriceItem
AddItem
AddItems
AddSellingManagerTemplate
RelistFixedPriceItem
RelistItem
ReviseFixedPriceItem
ReviseItem
ReviseSellingManagerTemplate
VerifyAddFixedPriceItem
VerifyAddItem
VerifyRelistItem
Conditionally
GetBidderList
Conditionally
GetItem
GetSellingManagerTemplates
DetailLevel: ItemReturnAttributes, ReturnAll
Conditionally
<b>For <b>AddItem</b> family of calls:</b> The <b>Quantity</b> value for auction listings must always be <code>1</code>. For a fixed-price listing, the <b>Quantity</b> value indicates the number of identical items the seller has available for sale in the listing. If variations are specified in <b>AddFixedPriceItem</b> or <b> VerifyAddFixedPriceItem</b>, the <b>Item.Quantity</b> is not required since the quantity of variations is specified in <b>Variation.Quantity</b> instead. See the <a href="https://pages.ebay.com/help/sell/listing-variations.html">Creating a listing with variations</a> eBay Help page for more information on variations.
<br><br>
<b>For ReviseItem and ReviseFixedPriceItem:</b>
This value can only be changed for a fixed-price listing with no variations. The
quantity of variations is controlled in the <b>Variation.Quantity</b> field and the <b>Item.Quantity</b>
value for an auction listing should always be <code>1</code>.
<br><br>
<b>For RelistItem and RelistFixedPriceItem:</b>
Like most fields, when you use <b>RelistItem</b> or <b>RelistFixedPriceItem</b>,
<b>Quantity</b> retains its original value unless you specifically change
it. This means that the item is relisted with the value that was
already in <b>Quantity</b>, not with the remaining quantity available.
For example, if the original <b>Quantity</b> value was <code>10</code>, and three items have been sold,
eBay sets the relisted item's <b>Quantity</b> to <code>10</code> by default, and not <code>7</code>.
So, we strongly recommend that you always
set <b>Quantity</b> to the correct value (your actual quantity available)
in your relist requests.<br>
<br>
When eBay auto-renews a GTC listing (<b>ListingDuration</b> = <b>GTC</b>)
on your behalf, eBay relists with correct quantity available.
<br>
<br>
<b>For GetSellerEvents:</b> <b>Quantity</b> is only returned
for listings where item quantity is greater than 1.
<br><br>
<b>For GetItem and related calls:</b>
This is the total of the number of items available for sale plus the quantity
already sold. To determine the number of items available, subtract
<b>SellingStatus.QuantitySold</b> from this value.
<br><br>
<b>For order line item calls with variations:</b>
In <b>GetItemTransactions</b>, <b>Item.Quantity</b> is the same as <b>GetItem</b> (the
total quantity across all variations). In <b>GetSellerTransactions</b>,
<b>Transaction.Item.Quantity</b> is the total quantity of the applicable
variation (quantity available plus quantity sold).
<br>
<br>
<span class="tablenote"><b>Note: </b> For the US site, new eBay sellers are subject to <a href="https://developer.ebay.com/DevZone/guides/features-guide/default.html#development/Listing-Policies.html#SellerLimits">Seller Limits</a>, which limit the quantity of items that may be listed and/or the total cumulative value of these listings. While subject to these selling limits, an eBay seller can use the <b>GetMyeBaySelling</b> call to retrieve both the remaining number of listings they can create and the remaining cumulative value of these listings. These values are shown in the <b>Summary.QuantityLimitRemaining</b> and <b>Summary.AmountLimitRemaining</b> fields in the <b>GetMyeBaySelling</b> response. If a call to add an item or revise an item would result in the exceeding of these limits, the add item or revise item call will fail. These fields will only be returned if the seller is subject to seller limits.
</span>
Listing Policies
https://developer.ebay.com/DevZone/guides/features-guide/default.html#development/Listing-Policies.html#SellerLimits
Selecting a Selling Format
https://pages.ebay.com/help/sell/formats.html
AddFixedPriceItem
AddItem
AddItems
AddSellingManagerTemplate
RelistFixedPriceItem
RelistItem
ReviseFixedPriceItem
VerifyAddFixedPriceItem
VerifyAddItem
VerifyRelistItem
Conditionally
ReviseItem
ReviseSellingManagerTemplate
No
GetBidderList
GetDispute
Always
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Always
GetItemTransactions
GetSellerTransactions
DetailLevel: ReturnAll
Always
GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
GranularityLevel: Coarse, Medium, Fine
Conditionally
GetMyeBaySelling
ActiveList
ScheduledList
SoldList
UnsoldList
DeletedFromSoldList
DeletedFromUnsoldList
DetailLevel: none, ReturnAll
Conditionally
GetSellerEvents
DetailLevel: none, ReturnAll
Conditionally
GetSellerEvents
DetailLevel: none, ReturnAll
Conditionally
A note that a user makes on an item from their My eBay account. <b>GetMyeBayBuying</b> and <b>GetMyeBaySelling</b> return this field, and only if you pass in the <b>IncludeNotes</b> field in the request, and set its value to <b>true</b>. This field will only be returned if set for an item, and only returned to the user who created the note.
<br><br>
Not supported as input in <b>ReviseItem</b>. Use <b>SetUserNotes</b> instead.
<br><br>
<b>For GetMyeBayBuying</b> In <b>WatchList</b>, notes for variations are only
returned at the Item level, not the variation level. They are only set if you
specified <b>ItemID</b> (if no purchases) or <b>ItemID</b> and <b>VariationSpecifics</b> (if there are
purchases) in <b>SetUserNotes</b> (or selected the equivalent in the My eBay UI on the
site).
<br><br>
In <b>WonList</b>, notes for variations are only returned at the Item level, not the
variation level. They are only set if you specified <b>ItemID</b> and <b>TransactionID</b> in
<b>SetUserNotes</b> (or selected the equivalent in the My eBay UI on the site).
AddFixedPriceItem
AddItems
AddSellingManagerTemplate
RelistFixedPriceItem
RelistItem
ReviseFixedPriceItem
VerifyAddFixedPriceItem
VerifyAddItem
VerifyRelistItem
No
GetMyeBayBuying
GetMyeBaySelling
Conditionally
This field is deprecated.
Applicable only to relisting an item. If true, creates a link in the item's
old listing for the item that points to the new relist page, which
accommodates users who might still look for the item under its old item ID.
RelistItem
No
RelistFixedPriceItem
No
The lowest price at which the seller is willing to sell an auction item. (<b>StartPrice</b>
must be lower than <b>ReservePrice</b> .) Not all categories support a Reserve Price.
Use <b>GetCategories</b> to see if a category supports a Reserve Price.
In calls that retrieve item data, the <b>ReservePrice</b> field will only be returned to the auction item's seller, and only if a Reserve Price has been set up. A Reserve Price is not applicable to fixed-price or classified ad listings.<br>
<br>
You can remove the Reserve price of a US eBay Motors listing if the category allows it, the current Reserve Price has not been met, and the Reserve Price is at least $2.00 more than the current high bid. In this case, if the item has bids, the Reserve Price is set to $1.00 over the current high bid. The next bid meets the Reserve Price and wins. See <i>Fees Overview</i> below for information about fee credits that may be available when the Reserve Price is removed for a Motors listing.
16
AddItem
AddItems
AddSellingManagerTemplate
RelistItem
ReviseItem
ReviseSellingManagerTemplate
VerifyAddItem
VerifyRelistItem
No
GetBidderList
Conditionally
GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
GranularityLevel: Fine
Conditionally
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally
GetMyeBaySelling
ActiveList
ScheduledList
SoldList
UnsoldList
DeletedFromSoldList
DeletedFromUnsoldList
DetailLevel: none, ReturnAll
Conditionally
Revising Items
https://developer.ebay.com/DevZone/guides/features-guide/default.html#development/Listings-Revising.html#RevisingUSeBayMotorsListings
Reserve Price (eBay site help)
https://pages.ebay.com/help/sell/reserve.html
Fees Overview (eBay site help)
https://pages.ebay.com/help/sell/fees.html
Determining Whether a Category Supports Reserve Prices
https://developer.ebay.com/DevZone/guides/features-guide/default.html#development/Categories-FeatureSupport.html#DeterminingWhetheraCategorySupportsReser
This container is returned if a listing has been revised in any way since it first became active. One or more boolean fields will be returned under this container based on the type of revision(s) that occured, including a general revision, a price change, or a feature added or removed.
GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
GranularityLevel: Coarse, Medium, Fine
Conditionally
GetBidderList
Always
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Always
Allows the user to specify a time in the future that the listing becomes active on eBay.
To schedule the listing start time, specify a time in the future in GMT
format. In <b>GetItem</b> and related calls, the scheduled time is returned in
<b>StartTime</b>. For <b>ReviseItem</b>, you can modify this value if the currently
scheduled start time is in the future (listing has yet to go live).
<br><br>
When you schedule a start time, the start time is randomized within 15-minute
intervals. Randomized start times applies to the following sites:
<br>
<code>AT, BEFR, BENL, CH, DE, ES, FR, IE, IT, NL, PL, UK</code>
<br><br>
Also see the following article in the Knowledge Base: <a href=
"https://ebaydts.com/eBayKBDetails?KBid=1473"
>Why scheduled time is sometimes getting reset</a>.
AddFixedPriceItem
AddItem
AddItems
RelistFixedPriceItem
RelistItem
ReviseFixedPriceItem
ReviseItem
ReviseSellingManagerTemplate
VerifyAddFixedPriceItem
VerifyAddItem
VerifyRelistItem
No
The unique identifer for a secondary category. This field is only applicable if the seller decides to list the item under two categories.
<br>
<br>
You cannot list US eBay Motors vehicles in two categories. However, you can
list Parts & Accessories in two categories. The Final Value Fee is based
on the primary category in which the item is listed. Furthermore, you can
list the same item in an eBay Motors Parts & Accessories category and in
an eligible eBay category, as long as the primary category is associated
with the site on which you are listing. That is, the two categories can be a
mix of Motors Parts & Accessories and eBay site categories. (Real
Estate, Mature Audience (adult), and Business & Industrial categories
are not eligible for listing in two categories in this manner.) For example,
if you list on Motors, the primary category could be 6750 (eBay Motors >
Parts & Accessories > Apparel & Merchandise > Motorcycle >
Jackets & Leathers), and the secondary category could be 57988 (eBay
> Clothing, Shoes > Accessories > Men's Clothing > Outerwear).
If you list on the main eBay site, the primary category could be 57988 and
the secondary category could be 6750. <br>
<br>
If eBay has designated a category as a value category
(see ValueCategory in <b>GetCategoryFeatures</b>), items in that category
cannot be listed in two categories.
For example, if your <b>AddItem</b> request
includes a primary or secondary category that is a value category, then eBay drops <b>SecondaryCategory</b> and lists
the item with only the <b>PrimaryCategory</b> you selected.
Also, if the listing request includes Item Specifics
(in <b>ItemSpecifics</b>) that are associated with <b>SecondaryCategory</b>, eBay drops those values when we drop <b>SecondaryCategory</b>. (The same logic is used if you revise an existing
listing to add a secondary category or to change one of the categories: If either the primary or secondary category is a value category, eBay drops the secondary category from your request.)<br>
<br>
To remove this value when relisting an item, use <b>DeletedField</b>.
<br><br>
<b>For ReviseItem only:</b> When revising a listing within 12 hours of the listing's scheduled end time, you can only add or change the secondary category when an auction listing has no active bids or a multiple-quantity, fixed-price listing has no items sold. If you change the secondary category, any corresponding Item Specifics that were previously specified may be dropped from the listing if they aren't valid for the category.
<br>
<br>
<b>For ReviseItem only:</b> Previously, removing the listing from a secondary category was only possible within 12 hours of the listing's scheduled end time when an auction listing had no active bids or a multiple-quantity, fixed-price listing had no items sold, but this restriction no longer exists. Now, the secondary category can be dropped for any active listing at any time, regardless of whether an auction listing has bids or a fixed-price listing has sales. To drop a secondary category, the seller passes in a value of <code>0</code> in the <b>SecondaryCategory.CategoryID</b> field.
10
Categories
https://developer.ebay.com/DevZone/guides/features-guide/default.html#development/Categories.html
AddFixedPriceItem
AddItem
AddItems
AddSellingManagerTemplate
RelistFixedPriceItem
RelistItem
ReviseFixedPriceItem
ReviseItem
ReviseSellingManagerTemplate
VerifyAddFixedPriceItem
VerifyAddItem
VerifyRelistItem
No
GetBidderList
Conditionally
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally
GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
Conditionally
The unique identifier for a secondary category that eBay has added as a free promotion. You cannot add
this yourself. This container is only returned if the item was listed in a single category and
eBay added a free secondary category.
GetBidderList
Conditionally
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally
GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
Conditionally
Container for information about this listing's seller.
<br><br>
Returned by <b>GetItemsAwaitingFeedback</b> if Buyer is making the request.
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Always
GetItemTransactions
DetailLevel: none, ReturnAll
Conditionally
GetItemsAwaitingFeedback
DetailLevel: none, ReturnAll
Conditionally
GetCategoryListings
Conditionally
GetMyeBayBuying
BestOfferList
BidList
LostList
WatchList
WonList
DeletedFromWonList
DeletedFromLostList
DetailLevel: none, ReturnAll
Conditionally
GetMyeBaySelling
BidList
DetailLevel: none, ReturnAll
Conditionally
GetBidderList
Always
AddItem
AddItems
AddSellingManagerTemplate
ReviseItem
ReviseSellingManagerTemplate
VerifyAddItem
Conditionally
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.
GetBidderList
GetDispute
Always
GetSellerEvents
DetailLevel: none, ReturnAll
Always
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Always
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ReturnAll
Always
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Always
GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
GranularityLevel: Fine
Conditionally
GetCategoryListings
GetMemberMessages
Conditionally
GetMyeBayBuying
BestOfferList
BidList
LostList
WatchList
WonList
DeletedFromWonList
DeletedFromLostList
DetailLevel: none, ReturnAll
Conditionally
GetMyeBaySelling
ActiveList
BidList
ScheduledList
SoldList
UnsoldList
DeletedFromSoldList
DeletedFromUnsoldList
DetailLevel: none, ReturnAll
Conditionally
GetSellerEvents
DetailLevel: none, ReturnAll
Conditionally
The shipping-related details for an order, including flat and calculated shipping costs.
<br>
<br>
<span class="tablenote"><b>Note: </b> For sellers who are using a shipping (aka Fulfillment) business policy to create/revise/relist an item, none of the fields under the <b>ShippingDetails</b> container are necessary. A fulfillment business policy can be set up and/or modified in My eBay, or via the <a href="https://developer.ebay.com/api-docs/sell/account/resources/fulfillment_policy/methods/createFulfillmentPolicy">Account API</a> or the <a href="https://developer.ebay.com/Devzone/business-policies/CallRef/addSellerProfile.html">Business Polices Managment API</a>. A fulfillment business policy is associated to a listing through the <b>Item.SellerProfiles.SellerShippingProfile</b> container.
<br>
<br>
If you <i>do not</i> use a fulfillment business policy, many of the fields under this <b>ShippingDetails</b> container become required in your request.
</span>
<br>
New users who list their first items in selected categories on the US site
must specify at least one domestic shipping service. This applies to a
category if <b>GetCategoryFeatures</b> returns <code>true</code> for
<b>Category.ShippingTermsRequired</b>.
<br>
<br>
For multi-quantity, fixed-price listings, a seller can revise all shipping details of the
listing (except for sales tax and for shipping type of Freight) for all
unsold items. This applies to both domestic and international shipping.
Checkout is not affected for those who bought items prior to the seller's
shipping changes—the shipping details that were in effect at the time of
purchase are used for that buyer at the time of checkout.
<br>
<br>
Shipping details are not applicable to any classified ad listings, as shipping/delivery/pickup is handled by the buyer and seller off of the eBay platform.
<br>
<br>
<span class="tablenote"><b>Note: </b> To create a listing that is 'Local Pickup only' (buyer picks up, with no shipping/delivery available), the user does the following two things:
<ul>
<li>Either omit the entire <strong>ShippingDetails</strong> container, or pass in an empty <strong>ShippingDetails</strong> container - <ShippingDetails/> </li>
<li>Pass in one <strong>ShipToLocations</strong> field, with its value set to <code>None</code> - <ShipToLocations>None</ShipToLocations></li>
</ul>
</span>
<br>
For <b>GetMyeBayBuying, GetMyeBaySelling</b>: <b>ShippingDetails</b> is not returned.
AddFixedPriceItem
AddItem
AddItems
AddSellingManagerTemplate
RelistFixedPriceItem
RelistItem
ReviseFixedPriceItem
ReviseItem
ReviseSellingManagerTemplate
VerifyAddFixedPriceItem
VerifyAddItem
VerifyRelistItem
Conditionally
GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
GranularityLevel: Coarse, Medium, Fine
Conditionally
GetBidderList
Conditionally
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally
GetMyeBayBuying
BestOfferList
BidList
DeletedFromLostList
DeletedFromWonList
WatchList
WonList
DetailLevel: none, ReturnAll
Conditionally
GetMyeBaySelling
DetailLevel: none, ReturnAll
Conditionally
Determining Shipping Costs for a Listing
https://developer.ebay.com/DevZone/guides/features-guide/default.html#development/Shipping-DeterminingCosts.html
Revising Items
https://developer.ebay.com/DevZone/guides/features-guide/default.html#development/Listings-Revising.html
restrictions on changing item properties with ReviseItem
An international location or region to which the seller is willing to ship,
regardless of shipping service. The country of the listing site is added by eBay.
<br>
<br>
<span class="tablenote"><b>Note: </b> If you set up a fulfillment policy via the <a href="https://developer.ebay.com/api-docs/sell/account/resources/fulfillment_policy/methods/createFulfillmentPolicy">Account API</a> or the <a href="https://developer.ebay.com/Devzone/business-policies/CallRef/addSellerProfile.html">Business Polices Managment API</a>, then you should not populate the <b>ShipToLocations</b> field. Instead, indicate your fulfillment policy using the <b>SellerProfiles.SellerShippingProfile</b> container.
</span>
<br>
Use <b>GeteBayDetails</b> with a <b>DetailName</b> of <b>ShippingLocationDetails</b> to
determine which international locations are valid for the site. Omit
<b>ShipToLocations</b> if you want to ship only within the country of the listing site.
To state that you do not wish to ship at all, set <b>ShipToLocations</b> to <code>None</code>.
<b>ReviseItem</b> can add a <b>ShipToLocations</b>. On output, <b>ShipToLocations</b> is the
collection of all input item-level <b>ShipToLocations</b> plus international shipping
service-level ShipToLocation values.
<br><br>
If you have specified a region to which you will ship (such as Asia), you can
use <b>ExcludeShipToLocation</b> to exclude certain countries within that region to
where you will not ship (such as Afghanistan).
<br>
<br>
<span class="tablenote"><b>Note: </b> To create a listing that is 'Local Pickup only' (buyer picks up, with no shipping/delivery available), the user does the following two things:
<ul>
<li>Either omit the entire <strong>ShippingDetails</strong> container, or pass in an empty <strong>ShippingDetails</strong> container - <ShippingDetails/> </li>
<li>Pass in one <strong>ShipToLocations</strong> field, with its value set to <code>None</code> - <ShipToLocations>None</ShipToLocations></li>
</ul>
</span>
ShippingRegionCodeType, CountryCodeType
AddFixedPriceItem
AddItem
AddItems
AddSellingManagerTemplate
RelistFixedPriceItem
RelistItem
ReviseFixedPriceItem
ReviseItem
ReviseSellingManagerTemplate
VerifyAddFixedPriceItem
VerifyAddItem
VerifyRelistItem
No
GetBidderList
Always
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Always
GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
GranularityLevel: Coarse, Medium, Fine
Conditionally
Specifying Locations to Where You Ship
https://developer.ebay.com/DevZone/guides/features-guide/default.html#development/Shipping-Locations.html#ShipToLocation
GeteBayDetails
The name of the site on which the item is listed. The listing site affects
the business logic and validation rules that are applied to the request,
which in turn affect the values that are returned in the response, as well
as values that appear on the eBay site. For example, the listing site
can affect the validation of <b>Category</b> in listing requests, international
business seller requirements, the values of converted (localized) prices in
responses, the item-related time stamps that are displayed on the eBay site, the visibility of the item in some types of searches (e.g.,
<b>GetCategoryListings</b>), and other information. In some cases, the rules are
determined by a combination of the site, the user's registration address,
and other information. You cannot change the site when you revise a
listing.<br>
<br>
When you specify <b>Item.Site</b> in <b>AddItem</b> or <b>AddFixedPriceItem</b>, it must be consistent with the
numeric site ID that you specify in the request URL (for the SOAP API) or
the <b>X-EBAY- API-SITEID</b> header (for the XML API).
AddFixedPriceItem
AddItem
AddItems
RelistFixedPriceItem
RelistItem
VerifyAddFixedPriceItem
VerifyAddItem
VerifyRelistItem
Yes
AddSellingManagerTemplate
No
GetBidderList
GetDispute
Always
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Always
GetItemTransactions
GetSellerTransactions
DetailLevel: ReturnAll
Conditionally
GetOrders
DetailLevel: none, ReturnAll
Conditionally
OrderReport
Conditionally
GetCategoryListings
Conditionally
GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
GranularityLevel: Coarse, Medium, Fine
Conditionally
GetMyeBayBuying
BestOfferList
BidList
LostList
SecondChanceOffer
WatchList
WonList
DeletedFromWonList
DeletedFromLostList
DetailLevel: none, ReturnAll
Conditionally
GetMyeBaySelling
BidList
DetailLevel: none, ReturnAll
Conditionally
GetSellerEvents
DetailLevel: none, ReturnAll
Conditionally
eBay Sites and Environments
https://developer.ebay.com/DevZone/guides/features-guide/default.html#basics/eBay-SitesEnvironments.html
Specifying the Target Site
https://developer.ebay.com/DevZone/guides/features-guide/default.html#basics/Call-StandardCallData.html#SpecifyingtheTargetSite
Field Differences for eBay Sites
https://developer.ebay.com/DevZone/guides/features-guide/default.html#development/IntlDiffs-Fields.html
The original price of the item at listing or re-listing time. If this
value changes when the item is revised, the new value becomes the original
price.
<br><br>
<b>For auction listings:</b> Competitive bidding starts at this
value. Once at least one bid has been placed, <b>StartPrice</b> remains the same but
<b>CurrentPrice</b> is incremented to the amount of each succeeding bid. If <b>ReservePrice</b> is
also specified, the value of <b>StartPrice</b> must be lower than the value of
<b>ReservePrice</b>.
<br><br>
<b>For input on fixed-price listings (<b>FixedPriceItem</b>): </b>
This is the constant price at which a buyer may purchase the item.
<br><br>
<b>GetMyeBaySelling</b> does not return <b>Item.StartPrice</b>
for fixed price items—it returns <b>Item.SellingStatus.CurrentPrice</b>.
<br><br>
<b>For AddFixedPriceItem and VerifyAddFixedPriceItem:</b>
Required when no variations are specified. If variations are specified,
use <b>Variation.StartPrice</b> for each variation instead.
<br><br>
<b>For Revise calls:</b>
If the <b>StartPrice</b> value for a fixed-price item is changed with a Revise call, the <b>MinimumBestOfferPrice</b> and <b>BestOfferAutoAcceptPrice</b> fields in the <b>ListingDetails</b> container will be dropped (if set), basically turning off the Best Offer Auto Accept and/or Auto Decline features. If the seller wanted to reintroduce either of these Best Offer threshold values in the listing again, an additional Revise call would have to be made, passing in the desired threshold values.
<br><br>
<span class="tablenote"><b>Note: </b> For the US site, new eBay sellers are subject to <a href="https://developer.ebay.com/DevZone/guides/features-guide/default.html#development/Listing-Policies.html#SellerLimits">Seller Limits</a>, which limit the quantity of items that may be listed and/or the total cumulative value of these listings. While subject to these selling limits, an eBay seller can use the <b>GetMyeBaySelling</b> call to retrieve both the remaining number of listings they can create and the remaining cumulative value of these listings. These values are shown in the <b>Summary.QuantityLimitRemaining</b> and <b>Summary.AmountLimitRemaining</b> fields in the <b>GetMyeBaySelling</b> response. If a call to add an item or revise an item would result in the exceeding of these limits, the add item or revise item call will fail. These fields will only be returned if the seller is subject to seller limits.
</span>
Listing Policies
https://developer.ebay.com/DevZone/guides/features-guide/default.html#development/Listing-Policies.html#SellerLimits
AddFixedPriceItem
AddItem
AddItems
AddSellingManagerTemplate
RelistFixedPriceItem
ReviseFixedPriceItem
VerifyAddFixedPriceItem
VerifyAddItem
Yes
ReviseItem
ReviseSellingManagerTemplate
RelistItem
VerifyRelistItem
No
GetBidderList
Always
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Always
GetMyeBayBuying
BidList
LostList
WatchList
WonList
DeletedFromWonList
DeletedFromLostList
DetailLevel: none, ReturnAll
Conditionally
GetMyeBaySelling
ActiveList
BidList
ScheduledList
SoldList
UnsoldList
DeletedFromSoldList
DeletedFromUnsoldList
DetailLevel: none, ReturnAll
Conditionally
GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
GranularityLevel: Fine
Conditionally
GetItemTransactions
GetSellerTransactions
DetailLevel: ReturnAll
Conditionally
This container provides details about the seller's eBay store.
<br><br>
In an Add/Revise/Relist call, the seller can include this container to set/change which customized eBay store category that the item will be placed in.
<br><br>
For 'Get' calls, this container is returned if the seller of the item has an eBay store.
AddFixedPriceItem
AddItem
AddItems
AddSellingManagerTemplate
RelistFixedPriceItem
RelistItem
ReviseFixedPriceItem
ReviseItem
ReviseSellingManagerTemplate
VerifyAddFixedPriceItem
VerifyAddItem
VerifyRelistItem
No
GetBidderList
Conditionally
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally
GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
GranularityLevel: Coarse, Medium, Fine
Conditionally
Subtitle to use in addition to the title. Provides more keywords when buyers
search in titles and descriptions. You cannot use HTML in the Subtitle. (HTML
characters will be interpreted literally as plain text.) If you pass any
value, this feature is applied (with applicable fees).<br>
<br>
When you revise a item, you can add, change, or remove the
subtitle.
<br>
55
AddFixedPriceItem
AddItem
AddItems
AddSellingManagerTemplate
RelistFixedPriceItem
RelistItem
ReviseFixedPriceItem
ReviseItem
ReviseSellingManagerTemplate
VerifyAddFixedPriceItem
VerifyAddItem
VerifyRelistItem
No
GetBidderList
GetCategoryListings
Conditionally
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally
GetMyeBayBuying
BestOfferList
BidList
LostList
SecondChanceOffer
WatchList
WonList
DeletedFromWonList
DeletedFromLostList
DetailLevel: none, ReturnAll
Conditionally
Relisting Items
https://developer.ebay.com/DevZone/guides/features-guide/default.html#development/Listings-RelistingItems.html#RemovingaFieldWhenRelistinganItem
(RelistItem) DeletedField
RelistItem.html#Request.DeletedField
Listing US and CA eBay Motors Items
https://developer.ebay.com/DevZone/guides/features-guide/default.html#development/Sites-eBayMotors.html#SpecifyingaSubtitleforaMotorsVehicleList
Time left before the listing ends.
The duration is represented in the ISO 8601 duration format (PnYnMnDTnHnMnS).
See Data Types in the Trading API Guide for information about this format.
For ended listings, the time left is PT0S (zero seconds).
GetBidderList
Always
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Always
GetMyeBayBuying
BestOfferList
BidList
SecondChanceOffer
WatchList
Conditionally
DetailLevel: none, ReturnAll
GetMyeBaySelling
ActiveList
BidList
ScheduledList
SoldList
UnsoldList
DeletedFromSoldList
DeletedFromUnsoldList
DetailLevel: none, ReturnAll
Conditionally
GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
GranularityLevel: Coarse, Medium, Fine
Conditionally
This field is used to specify the title of the listing. This field is conditionally required in an Add call unless the seller successfully uses the <b>ProductListingDetails</b> container to find an eBay catalog product match. When the seller successfully uses an eBay catalog product to create a listing, the listing title, listing description, Item Specifics, and stock photo defined in the catalog product are used to create the listing. <br>
<br>
You cannot use HTML or JavaScript in the Title. (HTML characters will be
interpreted literally as plain text.)<br>
<br>
The listing title can only be changed if the active listing has yet to have any bids or sales, and the listing does not end within 12 hours.
<br>
80
AddFixedPriceItem
AddItem
AddItems
AddSellingManagerTemplate
VerifyAddFixedPriceItem
VerifyAddItem
Conditionally
RelistItem
ReviseItem
ReviseSellingManagerTemplate
RelistFixedPriceItem
ReviseFixedPriceItem
VerifyRelistItem
No
GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
GranularityLevel: Coarse, Medium, Fine
Conditionally
GetCategoryListings
GetItemsAwaitingFeedback
GetMemberMessages
Conditionally
GetItemTransactions
GetSellerTransactions
DetailLevel: ReturnAll
Conditionally
GetMyeBayBuying
BestOfferList
BidList
LostList
SecondChanceOffer
WatchList
WonList
DeletedFromWonList
DeletedFromLostList
DetailLevel: none, ReturnAll
Conditionally
GetMyeBaySelling
ActiveList
ScheduledList
SoldList
UnsoldList
DeletedFromSoldList
DeletedFromUnsoldList
BidList
DetailLevel: none, ReturnAll
Conditionally
GetBidderList
GetDispute
Always
GetOrders
DetailLevel: none, ReturnAll
Always
OrderReport
Always
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Always
GetSellerEvents
DetailLevel: none, ReturnAll
Conditionally
Use an <b>UUID</b> value to ensure that you only list (or relist) a particular item once. This field can be particularly useful if you are listing many items on a daily basis and/or many items at once with an <b>AddItems</b> call. If your call request does not generate a response, or if you get one or more (blocking) errors, be sure to use the same <b>UUID</b> value when you attempt to list or relist the same item with another call request.
<br><br>
If you pass in a <b>UUID</b> value that has already been used to successfully create or relist an item, you will receive an error message that includes the Item ID for that listing and a boolean value indicating whether the duplicate <b>UUID</b> was sent by the same application.
<br><br>
We recommend that you use the <b>Item.UUID</b> field for add and relist calls (for example, <b>AddItem</b> and <b>RelistItem</b>), but use the <b>Item.InvocationID</b> field instead when using a revise call.
<br><br>
The <b>UUID</b> can only contain digits from 0-9 and letters from A-F and must be 32 characters long. The <b>UUID</b> value must be unique across all of the seller's eBay across all eBay marketplaces.
<br>
32
AddFixedPriceItem
AddItem
AddItems
AddSellingManagerTemplate
RelistFixedPriceItem
RelistItem
ReviseFixedPriceItem
VerifyAddFixedPriceItem
VerifyAddItem
VerifyRelistItem
No
GetBidderList
Conditionally
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally
This container is used in an Add/Revise/Relist call to set the VAT (Value-added Tax) percentage rate that will be charged to buyers when an item is purchased from the listing, and to enable Business Seller-related features.
<br><br>
This container is returned in 'Get' calls only if VAT is applicable to the listing, and unless the person making the 'Get' call owns the listing, only the <b>VATPercent</b> field is returned (if applicable). However, Business Seller-related information will be returned to all users in 'Get' calls under the <b>SellerInfo</b> and <b>BusinessSellerDetails</b> containers.
<br>
<br>
<span class="tablenote"><b>Note:</b>
VAT is not applicable to all countries, including the US. Allowed VAT percentage rates can vary by region/country, so sellers should be aware of the rates they are legally required/allowed to charge. Sellers must be registered as Business Sellers on the site they are selling on in order to use the Business Seller-related fields.
</span>
AddFixedPriceItem
AddItem
AddItems
AddSellingManagerTemplate
RelistFixedPriceItem
RelistItem
ReviseFixedPriceItem
ReviseItem
ReviseSellingManagerTemplate
VerifyAddFixedPriceItem
VerifyAddItem
VerifyRelistItem
Conditionally
GetBidderList
Conditionally
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally
Working with Business Features and VAT
https://developer.ebay.com/devzone/guides/features-guide/default.html#development/Sites-IntlDiffsVATB2B.html
Business Feature Field Differences
https://developer.ebay.com/devzone/guides/features-guide/default.html#development/IntlDiffs-B2BFields.html
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. If the seller turns on the Store vacation setting, the listing will be hidden from search result pages.
<br/><br/>
Store vacation settings, including this note, are set through the <b>Messages</b> tab in My eBay, or this message can also be set through the <b>SetStorePreferences</b> call.
<br/><br/>
The Store vacation setting is only applicable for sellers with eBay stores.
GetBidderList
Conditionally
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnAttributes, ItemReturnDescription, ReturnAll
Conditionally
GetSellerEvents
DetailLevel: ReturnAll
Conditionally
The number of watches placed on this item from buyers' My eBay accounts.
Specify <b>IncludeWatchCount</b> as <code>true</code> in the request.
Returned by <b>GetMyeBaySelling</b> only if greater than 0.
GetSellerEvents
DetailLevel: ReturnAll
Conditionally
GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
Conditionally
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally
GetMyeBaySelling
Conditionally
This value indicates the number of page views for the listing. This number is calculated by eBay and is returned in 'Get' calls if the <b>HitCounter</b> value is set to <code>BasicStyle</code>,
<code>RetroStyle</code>, or <code>HiddenStyle</code>. If the <b>HitCounter</b> value is set to <code>HiddenStyle</code> or <code>NoHitCounter</code>, <b>HitCount</b> is only returned if the
one making the call is the item's seller.
GetBidderList
Conditionally
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally
GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
GranularityLevel: Coarse, Medium, Fine
Conditionally
GetSellerEvents
DetailLevel: none, ReturnAll
Conditionally
If <code>true</code>, all buyer requirements (from <b>Item.BuyerRequirementDetails</b>
or Buyer requirements preferences in My eBay) are ignored.
<br>
<br>
If <code>false</code> (or omitted): <b>Item.BuyerRequirementDetails</b> or Buyer
requirements preferences are used, with <b>Item.BuyerRequirementDetails</b>
having the higher precedence.
<br>
false
AddFixedPriceItem
AddItem
AddItems
AddSellingManagerTemplate
RelistFixedPriceItem
RelistItem
ReviseFixedPriceItem
ReviseItem
ReviseSellingManagerTemplate
VerifyAddFixedPriceItem
VerifyAddItem
VerifyRelistItem
No
GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
Conditionally
GetBidderList
Conditionally
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally
<b>For Add/Revise/Relist/Verify calls</b>: This container is used to enable the Best Offer feature on a listing. Note that the Best Offer feature can be set for auction listings on the US, Canada, UK, Germany, Australia, France, Italy, and Spain marketplaces, but a seller can only use Best Offer or Buy It Now, but not both. Once an auction listing receives a qualifying bid, the Best Offer feature will be turned off and any pending Best Offers or Counteroffers will no longer be valid.
<br><br>
For <b>GetItem</b> and other calls that retrieve item data, this container will include the status (<b>GetMyeBayBuying</b> only) and dollar amount of the latest Best Offer on a fixed-price listing, and the number of Best Offers received for the fixed-price listing.
AddFixedPriceItem
AddItem
AddItems
AddSellingManagerTemplate
RelistItem
ReviseFixedPriceItem
ReviseItem
ReviseSellingManagerTemplate
VerifyAddFixedPriceItem
VerifyAddItem
VerifyRelistItem
No
GetBidderList
Conditionally
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally
GetSellerEvents
DetailLevel: none, ReturnAll
Conditionally
GetMyeBayBuying
BestOfferList
Conditionally
DetailLevel: none, ReturnAll
GetMyeBaySelling
ActiveList
Conditionally
DetailLevel: none, ReturnAll
If <code>true</code>, eBay provided a central location as a result of the user
not specifying a location. This typically occurs when the seller
specifies <b>PostalCode</b> without Location.
GetBidderList
Conditionally
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally
Indicates whether the seller's tax table is to be used when applying and
calculating sales tax for an order line item. A sales tax table can be
created programmatically using the <b>SetTaxTable</b> call, or it can be created
manually in My eBay's Payment Preferences. If <b>UseTaxTable</b> is set to <code>true</code>,
the values contained in the seller's sales tax table will supersede the values contained in the <b>Item.ShippingDetails.SalesTax</b> container (if included in the request).
AddFixedPriceItem
AddItem
AddItems
AddSellingManagerTemplate
RelistFixedPriceItem
RelistItem
ReviseFixedPriceItem
ReviseItem
ReviseSellingManagerTemplate
VerifyAddFixedPriceItem
VerifyAddItem
VerifyRelistItem
No
Enabling Multi-jurisdiction Sales Tax
https://developer.ebay.com/DevZone/guides/features-guide/default.html#development/Feature-SalesTax.html
This field is deprecated.
Applicable for listings in vehicle categories on the US eBay Motors site and
eBay Canada site. (No business effect if specified for other categories or
sites, as the Web site will not display the information to buyers.)
<b></b>
<ul>
<li>If <code>true</code>,
the buyer is responsible for vehicle pickup or shipping. </li>
<li>If <code>false</code>, specify
vehicle shipping arrangements in the item description. (The
description can also include vehicle shipping arrangements when this value is
<code>true</code>.) </li>
</ul>
<b></b>
If the item has bids or ends within 12 hours, you cannot modify this
flag. Do not specify <b>ShippingDetails.ShippingServiceOptions</b>
for vehicle listings.
<br><br>
If <code>true</code> and the listing is on the US eBay Motors site, and you want the
listing to be visible on the eBay Canada site, set <b>Item.ShipToLocations</b> to CA.
<br><br>
If <code>true</code> and the listing is on the eBay Canada site, and you want your listing
to be visible on the US eBay Motors site, set <b>Item.ShipToLocations</b> to US.
<br>
true
AddItem
AddItems
AddSellingManagerTemplate
RelistItem
ReviseItem
ReviseSellingManagerTemplate
VerifyAddItem
VerifyRelistItem
No
GetBidderList
Conditionally
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally
This field is deprecated.
675
NoOp
759
Returns a note from eBay displayed below items in the user's My
eBay account.
GetMyeBayBuying
DetailLevel: none, ReturnAll
Conditionally
GetMyeBaySelling
ActiveList
ScheduledList
UnsoldList
Conditionally
DetailLevel: none, ReturnAll
Specifies the number of questions buyers have posted about the
item. Returned only if greater than 0.
GetMyeBaySelling
Conditionally
This boolean field is returned as <code>true</code> if the item in this listing was relisted. When an item is relisted, a brand new Item ID value is automatically created by eBay. This field is only returned for an original listing whose item has been relisted, so a <code>false</code> value should never get returned.
<br><br>
<span class="tablenote"><b>Note: </b>
A new listing will not return this field.
</span>
GetMyeBaySelling
Conditionally
UnsoldList
This integer value indicates the quantity of an item that is still available for purchase in a multiple-quantity, fixed-price listing. This field is not applicable to auction listings.
GetMyeBayBuying
WatchList
DetailLevel: none, ReturnAll
Conditionally
GetMyeBaySelling
ActiveList
BidList
ScheduledList
SoldList
UnsoldList
DeletedFromSoldList
DeletedFromUnsoldList
DetailLevel: none, ReturnAll
Conditionally
A SKU (Stock Keeping Unit) value is a seller-defined identifier for a product. Each product within a seller's inventory should be unique. Most large-volume sellers use SKUs, but eBay only requires a SKU value if the <b>InventoryTrackingMethod</b> field is included in an <b>AddFixedPriceItem</b> call and its value is set to <code>SKU</code>. Setting the <b>InventoryTrackingMethod</b> field to <code>SKU</code> allows the seller to use a SKU value instead of an <b>ItemID</b> value as a unique identifier
in calls such as <b>GetItem</b> and <b>ReviseInventoryStatus</b>
<br><br>
A seller can specify a SKU when listing an item with <b>AddItem</b>
and related calls. eBay preserves the SKU on the item, enabling you
to obtain it before and after an order line item is created.
(<b>SKU</b> is recommended as an alternative to <b>ApplicationData</b>.)
<br>
<br>
If both <b>ItemID</b> and <b>SKU</b> are specified in calls that support the use of
SKU as a unique identifier, the <b>ItemID</b> value takes precedence.<br>
<br>
If a seller wants to use SKUs for multiple-variation listings, the SKU value for each product variation is actually specified at the variation level (Item.Variations.Variation.<b>SKU</b>) field, and the Item.<b>SKU</b>) field should not be included in the call request.
<br>
<br>
<span class="tablenote"><b>Note:</b>
The eBay site cannot identify listings by SKU. For example,
My eBay pages and Search pages all identify listings by item ID.
When a buyer contacts you via eBay's messaging functionality, eBay
uses the item ID as the identifier. Buyer-focused APIs (like the
Shopping API) also do not support SKU as an identifier.
</span>
<b>For revising and relisting only:</b>
To remove a SKU when you revise or relist an item, use <b>DeletedField</b>.
(You cannot remove a SKU when <b>Item.InventoryTrackingMethod</b> is set
to SKU.)<br>
<br>
For <b>GetItem</b>, <b>GetMyeBaySelling</b>, and other 'Get' call, the <b>SKU</b> value will only be returned if defined for the listing.
<br>
50
AddFixedPriceItem
AddItem
AddItems
AddSellingManagerTemplate
RelistFixedPriceItem
RelistItem
ReviseFixedPriceItem
ReviseItem
ReviseSellingManagerTemplate
VerifyAddFixedPriceItem
VerifyAddItem
VerifyRelistItem
No
GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
Conditionally
GetBidderList
Conditionally
GetOrders
DetailLevel: none, ReturnAll
Conditionally
OrderReport
Conditionally
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ReturnAll
Conditionally
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally
GetMyeBaySelling
Conditionally
eBay Merchant Data API
AddFixedPriceItem and ReviseFixedPriceItem
https://developer.ebay.com/DevZone/merchant-data/CallRef/index.html
This field is deprecated.
Postal code of the place where the item is located. This value is used for
proximity searches. To remove this value when revising or relisting an item,
use <b>DeletedField</b>. If you do not specify <b>PostalCode</b>, you must specify
<b>Item.Location</b>. If you specify <b>PostalCode</b>, but do not specify <b>Item.Location</b>,
then <b>Item.Location</b> is given a default value derived from the postal code.
AddFixedPriceItem
AddItem
AddItems
AddSellingManagerTemplate
RelistFixedPriceItem
RelistItem
ReviseFixedPriceItem
ReviseItem
ReviseSellingManagerTemplate
VerifyAddFixedPriceItem
VerifyAddItem
VerifyRelistItem
No
GetBidderList
Conditionally
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Always
This container consists of the data associated with photos within the listing. With most eBay sites and categories, a seller can add up to 12 photos to their listings free of charge. These photos can be hosted by eBay Picture Services (EPS), or the seller can host pictures on a non-eBay server. If pictures are externally-hosted, they must be hosted on a site that is using the 'https' protocol.
<br/><br/>
It is required that all listings have at least one picture. eBay Motors listings can have up to 24 pictures.
AddFixedPriceItem
AddItem
AddItems
AddSellingManagerTemplate
RelistFixedPriceItem
RelistItem
ReviseFixedPriceItem
ReviseItem
ReviseSellingManagerTemplate
VerifyAddFixedPriceItem
VerifyAddItem
VerifyRelistItem
Conditionally
GetBidderList
GetCategoryListings
Conditionally
GetMyeBayBuying
BestOfferList
BidList
SecondChanceOffer
WatchList
LostList
WonList
DeletedFromWonList
DeletedFromLostList
DetailLevel: none,ReturnAll
Conditionally
GetMyeBaySelling
ActiveList
ScheduledList
SoldList
UnsoldList
DeletedFromSoldList
DeletedFromUnsoldList
BidList
DetailLevel: none, ReturnAll
Conditionally
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally
GetSellerList
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
Introduction to Pictures in Item Listings
https://developer.ebay.com/DevZone/guides/features-guide/default.html#development/Pictures-Intro.html
Adding photos to your listing
https://pages.ebay.com/help/sell/pictures.html
Specifies the maximum number of business days the seller
commits to for preparing an item to be shipped after receiving a
cleared payment. This time does not include the shipping time (the carrier's transit time).
<br><br>
<span class="tablenote"><b>Note:</b> If the seller opts into the eBay Guaranteed Delivery feature and wants to make a listing eligible for eBay Guaranteed Delivery, the <b>DispatchTimeMax</b> value must be set to <code>0</code> or <code>1</code> (days) and cumulative value of <b>DispatchTimeMax</b> plus the transit time of the shipping service (returned in <b>ShippingServiceDetails.ShippingTimeMax</b> field of <b>GeteBayDetails</b>) must be 3 business days or less to be eligible for this feature. See the <a href="https://pages.ebay.com/seller-center/shipping/ebay-guaranteed-delivery.html" target="_blank">eBay Guaranteed Delivery</a> page in Seller Center for more information on this program.
</span>
<br>
<b>For Add/Revise/Relist calls:</b> Required for
listings in certain categories when certain shipping services
(with delivery) are offered. See <b>HandlingTimeEnabled</b> in
<b>GetCategoryFeatures</b>.<br>
<br>
The seller sets this to a positive integer value corresponding to the number of days. For a list of allowed values
on each eBay site, use <b>DispatchTimeMaxDetails</b> in <b>GeteBayDetails</b>.
(Typical values are <code>1</code>, <code>2</code>, <code>3</code>, <code>4</code>, <code>5</code>, <code>10</code>, <code>15</code>, or <code>20</code>, but this can vary
by site and these may change over time.)<br>
<br>
Valid for flat and calculated shipping. Does not apply when
there is no shipping, when it is local pickup only or it is freight shipping. For example, when <b>ShippingService</b> = <code>Pickup</code> or
<b>ShipToLocations</b> = <code>None</code>, then <b>DispatchTimeMax</b> is not required (or it can be <code>0</code>).<br>
<br>
<b>For ReviseItem only:</b>
If the listing has bids or sales and it ends within 12 hours, you can't change this value.
If the listing is a GTC listing that has sales or ends within 12 hours
(one or the other, but not both), you can add or change this value.
If the listing has no bids or sales and more than 12 hours remain before
the listing ends, you can add or change the dispatch (handling) time.<br>
<br>
<b>For GetItem:</b> <b>GetItem</b> returns <b>DispatchTimeMax</b>
only when shipping service options are specified for the item and
the seller specified a dispatch time.
AddFixedPriceItem
AddItem
AddItems
AddSellingManagerTemplate
RelistFixedPriceItem
RelistItem
ReviseFixedPriceItem
ReviseItem
ReviseSellingManagerTemplate
VerifyAddFixedPriceItem
VerifyAddItem
VerifyRelistItem
Conditionally
GetBidderList
Conditionally
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription,
ItemReturnAttributes, ReturnAll
Conditionally
Handling Time and Estimated Delivery Time
https://developer.ebay.com/DevZone/guides/features-guide/default.html#development/Shipping-Services.html#HandlingTimeandEstimatedDeliveryTime
(GetCategoryFeatures) SiteDefaults.HandlingTimeEnabled
GetCategoryFeatures.html#Response.SiteDefaults.HandlingTimeEnabled
This field is deprecated. This information is returned in <b>BestOfferDetails</b>.
This field is deprecated.
This container is used by sellers of Classified Ad listings to provide contact information.
Classified Ad Listings
https://developer.ebay.com/DevZone/guides/features-guide/default.html#development/Specialty-ClassifiedAds.html
AddItem
AddItems
AddSellingManagerTemplate
RelistItem
ReviseItem
ReviseSellingManagerTemplate
VerifyAddItem
VerifyRelistItem
No
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally
GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
Conditionally
The number of questions asked about this item. Applies to eBay Motors Pro
applications only.
GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
Conditionally
Some listings on the eBay platform originate from eBay affiliates.
Depending on the relationship the affiliate has with eBay, there are times
when the affiliate retains ownership of the listing. When this occurs
the representation of the listing on eBay is considered a proxy item. Proxy
items can only be edited using API requests from the applications that
originally listed them.
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnAttributes, ItemReturnDescription,
ReturnAll
Conditionally
GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
GranularityLevel: Coarse, Medium, Fine
Conditionally
Extended contact information for sellers using the Classified Ad format.
Specifies the days and hours when the seller can be contacted.
To remove seller contact information when revising or relisting an item, use
<b>DeletedField</b>.
AddItem
AddItems
AddSellingManagerTemplate
RelistItem
ReviseItem
ReviseSellingManagerTemplate
VerifyAddItem
VerifyRelistItem
No
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally
GetSellerList
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
Specifies the number of leads (emails) buyers have posted about the item.
You must be the seller of the item to retrieve the lead count.
GetMyeBaySelling
ActiveList
UnsoldList
DetailLevel: none, ReturnAll
Conditionally
Specifies the number of new leads (unanswered emails) buyers have posted
about the item.
GetMyeBaySelling
ActiveList
DetailLevel: none, ReturnAll
Conditionally
This container is a list of Item Specific <b>Name</b>/<b>Value</b> pairs used by the seller to provide desciptive details of an item in a structured manner.
<br><br>
If creating, revising, or relisting an item with an <b>Add</b>, <b>Revise</b>, or <b>Relist</b> call, it is recommended that you use the <b>GetCategorySpecifics</b> call to retrieve mandatory and recommended Item Specifics for a listing category.
<br><br>
<b>For ReviseItem only:</b> When you revise a listing, if an auction listing has one or more bids and ends within 12 hours, you cannot change or add Item Ppecifics. If the auction listing has bids but ends in more than 12 hours, you cannot change existing Item Specifics, but you can add Item Specifics that were not previously included.
<br><br>
If your listing is in a eBay product catalog-enabled category, certain <b>Name</b>/<b>Value</b> pairs will be accepted as product identifying information. The <b>Name</b> can be <code>Brand</code>, <code>MPN</code>, or a Global Trade Item Number (GTIN). GTINs are a set of globally recognized identifiers, including <code>EAN</code>, <code>ISBN</code>, and <code>UPC</code>. However, the <b>Values</b> provided for these <b>Name</b>s must comply with eBay's constraints or they will not be recognized as product identifiers. The <b>Value</b> for Brand must be an actual brand name (except that if the item is not branded, <b>Value</b> can be <code>Unbranded</code>.) The <b>Value</b> for Brand or MPN cannot contain only special characters (e.g. <code>%$*#@</code>). All GTINs must comply with international formatting standards. For more details, see <a href="https://developer.ebay.com/devzone/guides/features-guide/default.html#development/ItemSpecifics-Listing.html" target="_blank">Listing with Item Specifics</a>.
<br><br>
If the <b>ProductListingDetails</b> container in an Add/Revise/Relist call is successfully used to find and use an eBay catalog product to create/revise listing, the seller should not remove or change the value of any Item Specific name or value that is defined as part of the eBay catalog product definition.
<br><br>
<span class="tablenote"><b>Note:</b> If a listing is associated with an eBay catalog product, the seller does not need to pass in any Item Specifics that are already defined in the eBay catalog product. Sellers can make a <b>GetCategorySpecifics</b> call to see if the listing category supports any 'instance aspects', which can be thought of as Item Specifics that are unique to the specific item that is being listed. Instance aspects are identified in the <b>GetCategorySpecifics</b> response by looking for a value of <code>Instance</code> in one or more <b>NameRecommendation.ValidationRules.aspectUsage</b> fields. Many categories support the following instance aspects: <em>Custom Bundle</em>, <em>Bundle Description</em>, <em>Modified Item</em>, <em>Modification Description</em>, and <em>California Prop 65 Warning</em>. These instance aspects allow the seller to provide more information about product bundles or modified products in a structured way. Depending on the category, there are other instance aspects as well. For more information about creating bundle listings or modified product listings, see the <a href="https://developer.ebay.com/api-docs/sell/static/inventory/pbse-special-listings.html" target="_blank">Associating catalog products to special listings</a> topic.
</span>
<span class="tablenote"><b>Note:</b> To specify an item's condition, use the <b>ConditionID</b> field instead of a condition Item Specific. Use <b>GetCategoryFeatures</b> to see which categories support <b>ConditionID</b> and to get a list of valid condition IDs. (If you specify <b>ConditionID</b> and you also specify <b>Condition</b> as a Item Specific, eBay drops the condition Item Specific.)
</span>
<b>For GetItem</b>: This list is returned only when you specify <b>IncludeItemSpecifics</b> in the request (and the seller included Item Specifics in their listing).
<br><br>
To delete all Item Specifics when you revise or relist, specify <b>Item.ItemSpecifics</b> in <b>DeletedField</b>, and don't pass <b>ItemSpecifics</b> in the request.
Working with Item Specifics
https://developer.ebay.com/Devzone/guides/features-guide/default.html#development/ItemSpecifics.html
AddFixedPriceItem
AddItem
AddItems
AddSellingManagerTemplate
RelistFixedPriceItem
RelistItem
ReviseFixedPriceItem
ReviseItem
ReviseSellingManagerTemplate
VerifyAddFixedPriceItem
VerifyAddItem
AddSellingManagerTemplate
ReviseSellingManagerTemplate
VerifyRelistItem
Conditionally
GetItem
GetSellingManagerTemplates
Conditionally
DetailLevel: none, ItemReturnDescription,
ItemReturnAttributes, ReturnAll
This field is deprecated.
The email and phone lead fee for a pay-per-lead item.
GetMyeBaySelling
Conditionally
DetailLevel: ReturnAll
This field is deprecated.
Different Buyer protection schemes and the various status associated with each one of them.
GetItem
GetSellingManagerTemplates
Conditionally
Indicates a specific type of lead generation format listing, such as
classified ad or local market best offer listing. Only applicable when
<b>ListingType</b> = <b>LeadGeneration</b>.
<br/><br/>
<span class="tablenote"><b>Note:</b>
<b>ListingSubtype2</b> replaces the deprecated <b>ListingSubtype</b> field.
If both are specified in a request, <b>ListingSubtype2</b> takes precedence.
</span>
About Local Market Listings
https://pages.ebay.com/help/sell/motors-selling-locally.html
Advertising with Classified Ads
https://pages.ebay.com/help/sell/f-ad.html
AddItem
AddItems
AddSellingManagerTemplate
RelistItem
ReviseItem
ReviseSellingManagerTemplate
VerifyRelistItem
No
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnAttributes, ItemReturnDescription, ReturnAll
Conditionally
GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
Conditionally
Indicates whether the seller allows the bidder to request mechanical
inspection services from RAC. For the Car category listings on the UK site.
false
GetItem
GetSellingManagerTemplates
Conditionally
Specifies whether the following Business Seller fields have been updated for
the item specified in the request: First Name, Last Name, Fax, Email
Address, Additional Contact Information, Trade Registration Number, VAT
Identification Number.
ReviseItem
ReviseSellingManagerTemplate
No
Specifies whether the Return Policy Details have been updated
for the item specified in the request.
ReviseItem
ReviseSellingManagerTemplate
No
Specifies the details of policy violations if the item was administratively
canceled.
GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
Conditionally
GetItem
GetSellingManagerTemplates
Conditionally
This field is used by sellers who want their listing to be returned in the search
results for other eBay sites. This feature is currently only supported by the US, UK,
eBay Canada, and eBay Ireland sites. See <a href="
https://pages.ebay.com/help/sell/globalexposure.html">Getting exposure on
international sites</a> for full requirements on using this feature. There is a
small listing fee for each country specified as a Cross Border Trade country.
<br><br>
US listings that offer shipping to Canada, North America, or worldwide are
automatically returned on eBay.ca at no extra charge, so US listings that offer
shipping to these locations do not need to specify Canada as a Cross Border Trade
country.
Making Listings Available by Default on Another Site
https://developer.ebay.com/DevZone/guides/features-guide/default.html#development/Feature-MultipleSiteListing.html
AddFixedPriceItem
AddItem
AddItems
AddSellingManagerTemplate
RelistFixedPriceItem
RelistItem
ReviseFixedPriceItem
ReviseItem
ReviseSellingManagerTemplate
VerifyAddFixedPriceItem
VerifyAddItem
VerifyRelistItem
No
GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
GranularityLevel: Coarse, Medium, Fine
Conditionally
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Always
Returns the seller's information (in a business card format)
if the seller's <b>SellerBusinessCodeType</b> is set to <code>Commercial</code>.
This is only applicable for sites where Business Seller options
are supported.
GetItem
GetSellingManagerTemplates
Conditionally
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
For the Australia site, <b>BuyerGuaranteePrice</b> is the PayPal Buyer Protection
coverage, offered for the item at the time of purchase. Details of coverage
are in the following sections of the View Item page: the Buy Safely section
and the Payment Details section.
GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
GranularityLevel: Coarse, Medium, Fine
Conditionally
GetBidderList
Conditionally
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes,
ReturnAll
Conditionally
When this container is present in an <b>AddItem</b> or <b>AddFixedPriceItem</b> call, all
buyer requirements for the resulting listing are set by this container.
Furthermore, individual buyer requirements cannot be modified or added when
including this container in a <b>ReviseItem</b> call.
The <b>ReviseItem</b> call needs to
provide the entire set of buyer requirements to modify or add any of the
requirements.
<br/><br/>
Unless otherwise specified, most buyer requirements are only
returned if the caller is the seller. All global My eBay Buyer Requirements
are overridden by the contents of this container. This means that buyer
requirements set in My eBay cannot be combined with buyer requirements
included in this container.
AddFixedPriceItem
AddItem
AddItems
AddSellingManagerTemplate
RelistItem
ReviseItem
ReviseSellingManagerTemplate
VerifyAddFixedPriceItem
VerifyAddItem
VerifyRelistItem
No
GetBidderList
Conditionally
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally
Selecting Buyer Requirements (eBay help)
https://pages.ebay.com/help/sell/buyer-requirements.html
Describes the seller's return policy. Most categories on most
eBay sites require the seller to clearly specify whether or not
returns are accepted (see <b>ReturnsAcceptedOption</b>). <br>
<br>
<span class="tablenote"><b>Note: </b> If you set up a return policy via the <a href="https://developer.ebay.com/api-docs/sell/account/resources/return_policy/methods/createReturnPolicy">Account API</a> or the <a href="https://developer.ebay.com/Devzone/business-policies/CallRef/addSellerProfile.html">Business Polices Managment API</a>, then you should not populate the fields in this <b>ReturnPolicy</b> container. Instead, indicate your return policy using the <b>SellerProfiles.SellerReturnProfile</b> container.
<br>
<br>
However, if you <i>do not</i> configure a return policy, all the fields in this <b>ReturnPolicy</b> container that are marked <b>conditional</b> must be populated in your request.
</span>
<br>
<b>For the <b>AddItem</b> family of calls:</b> Required for
most categories on most sites. Use <b>ReturnPolicyEnabled</b>
in <b>GetCategoryFeatures</b> to determine which categories require this
field. Also use <b>ReturnPolicyDetails</b> in <b>GeteBayDetails</b> to determine
which <b>ReturnPolicy</b> fields can be used on each site.<br>
<br>
Australia (AU) and US eBay Motors
Parts and Accessories categories typically support but do not
require a return policy. (However, we strongly recommend that
you specify a clear return policy whenever possible.)<br>
<br>
<b>For ReviseItem only:</b> If the listing has bids or
sales and it ends within 12 hours, you can't change the return policy
details. If the listing is a GTC listing that has sales or ends within 12
hours (one or the other, but not both), you can add a return policy to the
GTC listing (but you can't change return policy details if already present).
If the listing has no bids or sales and more than 12 hours remain before the
listing ends, you can add or change the return policy. When you revise your
return policy, you only need to specify the fields you want to add or
change. You don't need to specify all the other <b>ReturnPolicy</b> fields again.
The other fields will retain their existing settings.<br>
<br>
<b>For the GetItem family of calls:</b> Only returned if the
site you sent the request to supports the seller's return policy. Typically,
the return policy details are only returned when the request is sent to the
listing site.
<br><br>
<span class="tablenote"><b>Note:</b> The <b>GeteBayDetails</b> call can be used to retrieve site-wide return policy metadata, but it is recommended that sellers use the <b>GetCategoryFeatures</b> call instead, as this call was recently updated to retrieve category-level metadata for both domestic and international return policies.</span>
MoneyBack
AddFixedPriceItem
AddItem
AddItems
AddSellingManagerTemplate
VerifyAddFixedPriceItem
VerifyAddItem
Conditionally
ReviseFixedPriceItem
ReviseItem
ReviseSellingManagerTemplate
RelistFixedPriceItem
RelistItem
VerifyRelistItem
MoneyBack
No
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes,
ReturnAll
Conditionally
GetBidderList
GranularityLevel: Medium, Fine
Conditionally
GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
GranularityLevel: Coarse, Medium, Fine
Conditionally
Offering a Clear Return Policy
https://developer.ebay.com/DevZone/guides/features-guide/default.html#development/Feature-ReturnPolicy.html
(GetCategoryFeatures) Category.ReturnPolicyEnabled
categories that require a return policy
GetCategoryFeatures.html#Response.Category.ReturnPolicyEnabled
(GeteBayDetails) ReturnPolicyDetails
return policy fields that each site reports
GeteBayDetails.html#Response.ReturnPolicyDetails
Enables you to view the sites on which an item can be purchased,
based on the payment methods offered for the item.
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Always
Indicates whether you prefer to track your eBay listings by eBay Item ID or
by your own SKU. <br>
<br>
If a seller will be converting an existing eBay listing into the new Inventory model using the <b>bulkMigrateListings</b> call of the <b>Inventory API</b>, the <b>InventoryTrackingMethod</b> value must be set to <code>ItemID</code> (default value), but the item must also have a SKU value (Item.<b>SKU</b> or Variation.<b>SKU</b>) associated with it.
<b>For GetItem and related calls</b>:
Only returned when the value is <code>SKU</code>; not returned when the value is <code>ItemID</code>.
AddFixedPriceItem
VerifyAddFixedPriceItem
RelistFixedPriceItem
No
ItemID
GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
Conditionally
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ReturnAll
Conditionally
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes,
ReturnAll
Conditionally
eBay Merchant Data API
AddFixedPriceItem and ReviseFixedPriceItem
https://developer.ebay.com/DevZone/merchant-data/CallRef/index.html
Indicates whether the item can be paid for through a payment gateway
(Payflow) account. If <b>IntegratedMerchantCreditCardEnabled</b> is <code>true</code>, then
integrated merchant credit card (IMCC) is enabled for credit cards because
the seller has a payment gateway account. Therefore, if
<b>IntegratedMerchantCreditCardEnabled</b> is <code>true</code>, an AmEx, Discover, or VisaMC
is returned for an item, then on checkout, an online credit-card payment is
processed through a payment gateway account. A payment gateway account is
used by sellers to accept online credit cards (Visa, MasterCard, American
Express, and Discover).
<br><br>
<span class="tablenote"><b>Note: </b>
As of May 1, 2019, eBay no longer supports electronic payments through Integrated Merchant Credit Card accounts. To accept online credit card payments from buyers, a seller must specify PayPal as an accepted payment method, or opt in to eBay Managed Payments program (if the program is available to that seller).
</span>
GetItem
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes,
ReturnAll
Conditionally
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ReturnAll
Always
GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
GranularityLevel: Fine
Conditionally
GetItems
GetSellingManagerTemplates
GetSellingManagerSoldListings
Conditionally
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetOrders
DetailLevel: none, ReturnAll
Conditionally
OrderReport
Conditionally
Variations are multiple similar (but not identical) items in a
single fixed-price listing. For example, a T-shirt listing
could contain multiple items of the same brand
that vary by color and size (like "Blue, Large" and
"Black, Medium"). Each variation specifies a combination of one of
these colors and sizes. Each variation can have a different
quantity and price. You can buy multiple items from one
variation at the same time. (That is, one order line item can contain
multiple items from a single variation.) <br>
<br>
If you list in two categories, both categories must support
listing with variations. See <b>VariationsEnabled</b> in
<b>GetCategoryFeatures</b> to determine applicable categories.<br>
<br>
<b>For ReviseFixedPriceItem and
RelistFixedPriceItem:</b> Once a listing has been submitted with variations,
you can't delete all the variations when you revise or relist the listing (because
it would be considered a different listing). You also can't add or change variation
specifics (because they are unique identifiers). However, you can delete or replace
individual variations as needed to match your current inventory. If a variation has
no purchases, use the <b>Variation.Delete</b> field to delete the variation. If it has
inventory, set the Quantity to 0.<br>
<br>
As a best practice, if you want to revise multiple variations in
the same listing at the same time (i.e., within a very short period),
use a single <b>ReviseFixedPriceItem</b> request and include all the
variation revisions in the same request. If your application design
requires you to revise each variation individually, then avoid using
multiple parallel threads. Instead, use a serial, synchronous
process. That is, wait until each revision has been
processed by eBay before submitting the next revision request for
another variation in the same listing.<br>
<br>
<b>For GetItem and related calls</b> Only returned
when a listing has variations.
<br><br>
<b>For GetSellerList:</b> Only returned when a listing
has variations, <b>IncludeVariations</b> was set to <code>true</code> in the request,
the <b>DetailLevel</b> was set to <b>ReturnAll</b>, and an applicable pagination
value and time range were specified.<br>
<br>
<b>For GetItemTransactions</b> Only returned in Item
when a listing has variations and <b>IncludeVariations</b> was set to <code>true</code>
in the request. (Also see <b>Variation</b> returned in <b>Transaction</b> for
information about which variation was actually purchased.)
<br>
<br>
<b>For GetSellerEvents, GetMyeBayBuying, and GetMyeBaySelling:</b> Only returned
when a listing has variations and <b>HideVariations</b> was set to <code>false</code>
or not specified in the request.
Multi-Variation Listings
https://developer.ebay.com/DevZone/guides/features-guide/default.html#development/Variations.html
AddFixedPriceItem
ReviseFixedPriceItem
RelistFixedPriceItem
VerifyAddFixedPriceItem
No
Qualifications for Listing with Variations
https://developer.ebay.com/DevZone/guides/features-guide/default.html#development/Variations.html
GetItem
Conditionally
DetailLevel: none, ItemReturnDescription,
ItemReturnAttributes, ReturnAll
GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
Conditionally
GetMyeBayBuying
LostList
WatchList
WonList
DeletedFromWonList
DeletedFromLostList
DetailLevel: none, ReturnAll
Conditionally
GetMyeBaySelling
ActiveList
DeletedFromSoldList
DeletedFromUnsoldList
ScheduledList
SoldList
UnsoldList
DetailLevel: none, ReturnAll
Conditionally
AddSellingManagerTemplate
ReviseSellingManagerTemplate
No
GetSellingManagerInventory
Conditionally
GetSellerEvents
DetailLevel: none, ReturnAll
Conditionally
GetItemTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
A list of parts compatibility information specified as name and value pairs.
Describes an assembly with which a part is compatible (i.e., compatibility by
application). For example, to specify a part's compatibility with a vehicle,
the name (search name) would map to standard vehicle characteristics (e.g.,
Year, Make, Model, Trim, and Engine). The values would describe the specific
vehicle, such as a 2006 Honda Accord. Use the <b>Product Metadata API</b> to
retrieve valid search names and corresponding values.
<br><br>
<b>For the <b>AddItem</b> family of calls:</b> Use this for specifying
parts compatibility by application manually. This can only be used in
categories that support parts compatibility by application. Use <b
class="con">GetCategoryFeatures</b> with the <b>CompatibilityEnabled</b>
feature ID to determine which categories support parts compatibility by
application.
<br><br>
<b>For ReviseFixedPriceItem and ReviseItem:</b> When you revise a
listing, if the listing has bids and/or ends within 12 hours, item
compatibilities cannot be deleted. You may add item compatibilities at any
time.
<br><br>
<b>For GetItem:</b> <b
class="con">ItemCompatibilityList</b> is only returned if the
seller included item compatibility in the listing and <b
class="con">IncludeItemCompatibilityList</b> is set to <code>true</code> in the
<b>GetItem</b> request.
<br><br>
AddFixedPriceItem
AddItem
AddItems
AddSellingManagerTemplate
RelistFixedPriceItem
RelistItem
ReviseFixedPriceItem
ReviseItem
ReviseSellingManagerTemplate
VerifyAddFixedPriceItem
VerifyAddItem
VerifyRelistItem
No
Product Metadata API Call Reference
https://developer.ebay.com/DevZone/product-metadata/CallRef/index.html
information on retrieving compatibility search names and corresponding values needed to specify compatibility by application manually
Listing Items with Parts Compatibility
https://developer.ebay.com/DevZone/guides/features-guide/default.html#development/CompatibleParts.html
GetItem
Conditionally
Indicates the number of compatible applications specified for the given item.
Applies to items listed with fitment by application only (either manually or
with a catalog product that supports compatibility).
<br><br>
Not returned if the item has no specified compatible applications. Not
returned if <b>IncludeItemCompatibilityList</b> is
specified in the request.
<br><br>
To retrieve the list of compatibility information, set <b>
IncludeItemCompatibilityList</b> to <code>true</code> in the request.
<br><br>
Parts Compatibility is supported in limited Parts & Accessories
categories for the eBay Motors (US) site (site ID 100) only.
GetItem
Conditionally
This is a numeric identifier for an item's condition. All numeric Condition ID values map to an item condition string value. For example, numeric identifer <code>1000</code> maps to <code>New</code> condition.
<br><br>
Most eBay categories require an item condition, but a few eBay categories do not. To verify if the listing category requires an item condition, and if so, what are the supported item condition and <b>ConditionID</b> values, you can call <b>GetCategoryFeatures</b>. In this <b>GetCategoryFeatures</b> call, you'd pass in the listing <b>CategoryID</b> value and two <b>FeatureID</b> fields - one of these fields set to <code>ConditionEnabled</code>, and the other field set to <code>ConditionValues</code>.
<br><br>
In the <b>GetCategoryFeatures</b> response, look at the Category.<b>ConditionEnabled</b> to see if item condition is required for the category. Then look at the Category.<b>ConditionValues</b> container in the response for the full list of Condition IDs that you can pass in through the <b>ConditionID</b> field of an Add/Revise/Relist/Verify call. Note that the Condition.<b>DisplayName</b> value in the response is the actual condition value that will appear in the actual eBay listing.
<br>
<br>
If you pass in a <b>ConditionID</b> value
that is not valid for the category, or if you don't pass in a <b>ConditionID</b> value at all for a category that requires it, the listing request fails.
<br><br>
If you are listing in two categories (using a secondary category), it is the primary listing category that determines which <b>ConditionID</b> values are supported.
<br><br>
<b>For Revise/Relist calls:</b> In most cases, you can change the <b>ConditionID</b> value (if applicable/warranted), with the exception being an auction listing that has one or more bids, or any listing that is scheduled to end in 12 hours or less. <br>
<br>
<b>For GetItem:</b> The
<b>ConditionID</b> value is always returned if set for the listing. <b>GetItem</b> also returns
the item condition string value in the <b>ConditionDisplayName</b> field.
Specifying an Item's Condition
https://developer.ebay.com/DevZone/guides/features-guide/default.html#development/Desc-ItemCondition.html
ConditionValues in GetCategoryFeatures
GetCategoryFeatures.html#Response.Category.ConditionValues
Item Condition Look-up Table (and Automatic Mapping)
https://pages.ebay.com/sellerinformation/news/itemconditionlookup.html
AddFixedPriceItem
AddItem
AddItems
AddSellingManagerTemplate
RelistFixedPriceItem
RelistItem
ReviseFixedPriceItem
ReviseItem
ReviseSellingManagerTemplate
VerifyAddFixedPriceItem
VerifyAddItem
VerifyRelistItem
Conditionally
ItemSpecifics
#Request.Item.ItemSpecifics
LookupAttributeArray
#Request.Item.LookupAttributeArray
GetItem
Conditionally
DetailLevel: none, ItemReturnDescription,
ItemReturnAttributes, ReturnAll
ItemSpecifics
#Response.Item.ItemSpecifics
This string field is used by the seller to more clearly describe the condition of items that are not brand new.
<br>
<br>
The <b>ConditionDescription</b> field is available for all categories, including categories where the condition type is not applicable (e.g., Antiques). This field is applicable for all item conditions except 'New', 'Brand New', 'New with tags', and 'New in box'. If <b>ConditionDescription</b> is used with these conditions (Condition IDs 1000-1499), eBay will simply ignore this field if included, and eBay will return a warning message to the user.
<br>
<br>
This field should only be used to further clarify the condition of the used item. For example, "The right leg of the chair has a small scratch, and on the seat back there is a light blue stain about the shape and size of a coin." It should not be used for branding, promotions, shipping, returns, payment or other information unrelated to the condition of the item. Make sure that the condition type (<b>Item.ConditionID</b>), condition description, item description (<b>Item.Description</b>), and the listing's pictures do not contradict one another.
<br><br>
<span class="tablenote"><strong>Note:</strong>
The <b>ConditionDescription</b> field is optional For <b>Add</b>/<b>Revise</b>/<b>Relist</b> API calls.
<b>ConditionDescription</b> is currently supported on the eBay US and US eBay Motors (0), UK (3), CA (2), CAFR (210), AU (15), AT (16), BEFR (23), BENL (123), FR (71), DE (77), IT (101), NL (146), ES (186), CH (193), IE (205) and PL (212) sites.
</span>
<br>
The <b>ConditionDescription</b> field is returned by <b>GetItem</b> (and other related calls that return the Item object) if a condition description is specified in the listing.
<br>
1000
AddFixedPriceItem
AddItem
AddSellingManagerTemplate
AddItems
VerifyAddFixedPriceItem
VerifyAddItem
RelistFixedPriceItem
RelistItem
ReviseFixedPriceItem
ReviseItem
ReviseSellingManagerTemplate
VerifyRelistItem
Conditionally
GetSellerList
Conditionally
DetailLevel: ItemReturnDescription, ReturnAll
GranularityLevel: Coarse, Fine, Medium
GetSellingManagerTemplates
Conditionally
DetailLevel: none, ItemReturnAttributes, ItemReturnDescription, ReturnAll
The human-readable label for the item condition.
Display names are localized for the site on
which they're listed (not necessarily the site on which
they're viewed).<br>
<br>
Most categories use the same display name for the
same condition ID. Some categories may override the display name
based on buyer expectations for items in the category.
For example, condition ID 1000 could be called
"New" in one category and "New with tags" in another.<br>
<br>
Behind the scenes, eBay's search engine uses the ID
(not the display name) to determine whether items are
new, used, or refurbished.<br>
<br>
Only returned when the seller specified <b>ConditionID</b> in their
listing.
50
GetItem
Conditionally
DetailLevel: none, ItemReturnDescription,
ItemReturnAttributes, ReturnAll
Tax exception category code. This is to be used only
by sellers who have opted into sales tax being calculated
by a sales tax calculation vendor. If you are interested
in becoming a tax calculation vendor partner with eBay,
contact [email protected].
AddFixedPriceItem
AddItem
AddItems
RelistFixedPriceItem
RelistItem
ReviseFixedPriceItem
ReviseItem
VerifyAddFixedPriceItem
VerifyAddItem
Conditionally
GetItem
DetailLevel: ReturnAll
Conditionally
Indicates the type of message that will be returned describing the quantity
available for the item.
GetItem
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally
GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
GranularityLevel: Coarse, Medium, Fine
Conditionally
The quantity threshold above which the seller prefers not to show the actual
quantity available. Returned when the quantity available is greater than the
value of quantity threshold. Currently, 10 is the only available value for
this threshold.
GetItem
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally
GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
GranularityLevel: Coarse, Medium, Fine
Conditionally
This container provides information for an item that has a Strikethrough Price (STP) or a Minimum Advertised Price (MAP) discount pricing treatment. STP and MAP apply only to fixed-price listings. STP is available on the US, eBay Motors, UK, Germany, Canada (English and French), France, Italy, and Spain sites, while MAP is available only on the US site.
<br><br>
Discount pricing is available to qualified sellers (and their associated developers) who participate in the Discount Pricing Program. Once qualified, sellers receive a 'special account flag' (SAF) that allows them to apply Discount Pricing to both single-variation and multi-variation items. STP is intended for eBay partners and their sellers only.
<br><br>
As a seller listing Discount Price items, you are required to maintain records of your discount pricing in the event you are called upon to substantiate your item pricing.
<br><br>
<b>For AddFixedPriceItem, RelistFixedPriceItem, ReviseFixedPriceItem, and VerifyAddFixedPriceItem</b>: If you are listing variations (MSKU items), use <b>Variation.DiscountPriceInfo</b> for each variation.
AddFixedPriceItem
ReviseFixedPriceItem
RelistFixedPriceItem
VerifyAddFixedPriceItem
No
AddItem
ReviseItem
RelistItem
VerifyAddItem
VerifyRelistItem
No
GetItem
Conditionally
DetailLevel: none, ItemReturnDescription,
ItemReturnAttributes, ReturnAll
GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
Conditionally
A descriptive free-text title for a US or CA eBay Motors vehicle listing. This title appears below eBay's pre-filled listing title on the View Item page (not at the top of the View Item page). It's also appended to the listing title in search results (like a subtitle) on the US eBay Motors site. Keywords in this title help buyers find or distinguish your listing.
<br><br>
Applicable to listings in US eBay Motors Cars and Trucks, Motorcycle, and some of the Powersport, Boats and RV campers categories; or to Cars and Trucks listings on CA eBay Motors.
<br><br>
This replaces the older US and Canada eBay Motors Subtitle attribute (attribute ID 4148).
<br>
80
AddFixedPriceItem
AddItem
AddItems
VerifyAddFixedPriceItem
VerifyAddItem
Conditionally
RelistFixedPriceItem
RelistItem
ReviseFixedPriceItem
ReviseItem
No
This field displays the Vehicle Identification Number, which is a unique serial number for a motor vehicle.
<br><br>
This field is applicable to listings in US eBay Motors Cars and Trucks (6001), Motorcycles (6024), Commercial Trucks (63732), RVs and Campers (50054), ATVs (6723), Snowmobiles (42595), and UTVs (173665); and to Cars and Trucks listings in CA, CAFR and AU eBay Motors. For vehicle categories that do not use VIN, call <b>GetCategorySpecifics</b> to determine applicable Item Specifics (such as 'Hull ID Number' for Boats).
<br><br>
For the US, CA, and CAFR eBay Motors sites, required for cars and trucks from model year 1981 and later. (The US developed national standards for VIN values in 1981.)
<br><br>
For the eBay Australia site, required for vehicles from model year 1989 or later. For the eBay Australia site, only appears on the View Item page if you also specify the date of first registration in the listing's Item Specifics.
<br><br>
Appears in the VIN field in the Item Specifics section of eBay's View Item page.
<br>
17
AddFixedPriceItem
AddItem
AddItems
VerifyAddFixedPriceItem
VerifyAddItem
Conditionally
RelistFixedPriceItem
RelistItem
ReviseFixedPriceItem
ReviseItem
No
This field is deprecated.
Vehicle Registration Mark, which is a unique identifier for a motor vehicle in the UK.
<br><br>
Applicable to listings in UK eBay Motors Cars and Trucks, Motorcycle, and some Powersport categories.
<br><br>
Appears as a VRM field in the Item Specifics section of eBay's View Item page. On the View Item page, the VRM value is masked (i.e., only a portion of the value is shown to users). In the <b>GetItem</b> response, the VRM is only returned if the call is made by the seller (i.e., the AuthToken is associated with the vehicle's seller).
AddFixedPriceItem
AddItem
AddItems
VerifyAddFixedPriceItem
VerifyAddItem
Conditionally
RelistFixedPriceItem
RelistItem
ReviseFixedPriceItem
ReviseItem
No
This field is deprecated.
This container is used to set the minimum number of event tickets that should remain available after a buyer makes a purchase. This functionality allows the seller to avoid the possibility of being left with just one event ticket after a sale.
<br><br>
This container can be used when adding, revising, or relisting event tickets, and it will only be returned in <b>GetItem</b> if set for the listing.
AddFixedPriceItem
ReviseFixedPriceItem
RelistFixedPriceItem
VerifyAddFixedPriceItem
No
AddItem
ReviseItem
RelistItem
VerifyAddItem
VerifyRelistItem
No
GetItem
Conditionally
DetailLevel: none, ItemReturnDescription,
ItemReturnAttributes, ReturnAll
This container is used if the seller would like to use/reference Business Policies to create, revise, relist, or verify their listing. The seller's account must be opted in to Business Policies to use this container. If this container is used, exactly one Payment Business Policy, one Shipping Business Policy, and one Return Business Policy is applied to the listing. If the seller's account is not opted in to Business Policies, that seller may not use this container. Sellers must opt-in to Business Policies through My eBay or by using the <b>optInToProgram</b> call of the <b>eBay Account API</b>.
<br><br>
If Business Policies are applied to a listing, all payment, shipping, and return policy settings in these policies will override any other payment, shipping, or return policy legacy fields that are included in the call request.
<br><br>
This container is only returned in 'Get' calls if Business Policies are set for the listing, and the person making the API call is the seller of the listing.
AddFixedPriceItem
ReviseFixedPriceItem
RelistFixedPriceItem
VerifyAddFixedPriceItem
Conditionally
AddItem
AddItems
ReviseItem
RelistItem
VerifyAddItem
AddSellingManagerTemplate
ReviseSellingManagerTemplate
AddItemFromTemplate
AddTemplate
ReviseTemplate
VerifyRelistItem
Conditionally
GetItem
Conditionally
DetailLevel: none, ItemReturnDescription,
ItemReturnAttributes, ReturnAll
GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
Conditionally
GetSellerEvents
GetItems
GetMyeBaySelling
GetSellingManagerTemplates
Conditionally
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 Business Policies shipping profile referenced in the <b>SellerProfiles.SellerShippingProfile.ShippingProfileID</b> field. Shipping costs include the cost to ship one item, the cost to ship each additional identical item, and any shipping surcharges applicable to domestic shipping services.
<br><br>
A <b>ShippingServiceCostOverrideList.ShippingServiceCostOverride</b> container is required for each domestic and/or international shipping service that is defined in the <b>domesticShippingPolicyInfoService</b> and <b>intlShippingPolicyInfoService</b> containers of the Business Policies shipping profile.
<br><br>
Shipping service cost overrides are a listing-level concept, and the shipping costs specified through each <b>ShippingServiceCostOverrideList.ShippingServiceCostOverride</b> container will not change the shipping costs defined for the same shipping services in the Business Policies shipping profile.
<br><br>
<b>For Revise and Relist calls</b>: To delete all shipping service cost overrides when you revise or relist, specify <b>Item.ShippingServiceCostOverrideList</b> in <b>DeletedField</b>, and don't pass <b>ShippingServiceCostOverrideList</b> in the request.
AddFixedPriceItem
AddItem
AddItems
VerifyAddItem
VerifyAddFixedPriceItem
VerifyRelistItem
RelistFixedPriceItem
RelistItem
ReviseFixedPriceItem
ReviseItem
AddSellingManagerTemplate
ReviseSellingManagerTemplate
No
GetItem
GetItems
GetSellerList
GetSellingManagerTemplates
Conditionally
This field is reserved for internal or future use.
Container consisting of dimension and size details related to a shipping package in which an item will be sent. The information in this container is applicable if the seller is using calculated shipping or flat rate shipping using shipping rate tables with weight surcharges. This container is only returned in the <b>Get</b> calls if specified for the item.
AddFixedPriceItem
AddItem
AddItems
VerifyAddItem
AddSellingManagerTemplate
VerifyAddFixedPriceItem
Conditionally
RelistFixedPriceItem
RelistItem
VerifyRelistItem
ReviseFixedPriceItem
ReviseItem
ReviseSellingManagerTemplate
No
GetItem
Conditionally
This boolean field is returned as <code>true</code> if the listing was created by a Top-Rated Seller and the listing has all of the requirements that qualifies it as a Top-Rated Plus listing. The Top-Rated Seller program is only available on the US, UK, and Germany sites. See the
<a href="https://pages.ebay.com/help/sell/top-rated.html#what">Top-Rated Seller requirements</a> help topic for more information on qualifying as a Top-Rated Seller and the <a href="https://pages.ebay.com/help/sell/top-rated.html#plus">Top-Rated Plus listing requirements</a> help topic for more information on what a listing must offer to qualify as a Top-Rated Plus listing and get the Top-Rated Plus badge. Information on the overall program can be found on the <a href="https://pages.ebay.com/sellerinformation/build-your-business-online/status-standards/top-rated-seller.html">Top-Rated Seller home page</a> in the Seller Center.
GetItem
Conditionally
This container is used by the seller to restrict the quantity of items that may be purchased by one buyer during the duration of a fixed-price listing (single or multi-variation). This is an optional container that can be used with an <b>Add</b>, <b>Revise</b>, or <b>Relist</b> call.
<br><br>
This container is not applicable to auction listings.
AddFixedPriceItem
AddItem
AddItems
RelistFixedPriceItem
RelistItem
ReviseFixedPriceItem
ReviseItem
VerifyAddItem
VerifyAddFixedPriceItem
VerifyRelistItem
No
This value sets the minimum price threshold for a seller's product price in a fixed-price listing. Regardless of the product price on eBay Value Box or Amazon listings, the seller's product price will not be reduced lower than this dollar value.
<br><br>
This value is only applicable to sellers enabled to use the <b>Dynamic Pricing</b> API, and if a dynamic pricing rule is assigned to the listing's product.
ReviseItem
ReviseFixedPriceItem
No
This value sets the maximum price threshold for a seller's product price in a fixed-price listing. Regardless of the product price on Amazon or eBay Value Box, the seller's product price will not be raised higher than this dollar value.
<br><br>
This value is only applicable to sellers enabled to use the <b>Dynamic Pricing</b> API, and if a dynamic pricing rule is assigned to the listing's product. If this field is not specified through the <b>Dynamic Pricing</b> API, an eBay system-level threshold is used to avoid any undesirable results.
ReviseItem
ReviseFixedPriceItem
No
This boolean field is returned as <code>true</code> if the item is eligible is to be shipped internationally via eBay's Global Shipping Program. With the Global Shipping Program, the buyer pays a single shipping fee for the order, which includes the domestic shipping leg, the international shipping leg, and handling charges, and import charges.
<br/><br/>
eBay uses a shipping partner that allows the seller to ship the package to a domestic location and then the shipping partner takes care of the rest, including the international shipping leg.
GetItem
DetailLevel: none, ItemReturnAttributes, ItemReturnDescription, ReturnAll
Conditionally
This container provides information about the weight, volume or other quantity measurement of a listed item. The European Union requires listings for certain types of products to include the price per unit so buyers can accurately compare prices. eBay uses the <b>UnitType</b> and <b>UnitQuantity</b> values and the item's listed price to calculate and display the per-unit price on eBay EU sites.
<br/><br/>
This container will only be returned if price per unit information exists for the listing, and the <b>IncludeItemSpecifics</b> field was included in the call request and set to <code>true</code>.
GetItem
DetailLevel: none, ItemReturnDescription,
ItemReturnAttributes, ReturnAll
Conditionally
The identifier of the original listing that contained the item before the item was relisted. This field is only returned for an item that was relisted.
GetItem
GetItems
DetailLevel: none, ItemReturnAttributes, ItemReturnDescription, ReturnAll
Conditionally
This string value provides more details about the item's condition.
GetItem
GetItems
DetailLevel: none, ItemReturnAttributes, ItemReturnDescription, ReturnAll
Conditionally
This boolean field is returned as <code>true</code> if the listing has been hidden from all searches occurring on eBay. If a listing is hidden from eBay searches, the reason can be found in the <b>ReasonHideFromSearch</b> field.
GetItem
GetSellerList
GetMyeBaySelling
GetSellingManagerTemplates
Conditionally
This field is returned only when the listing is currently being hidden from any searches occurring on eBay. Listings may be hidden from search if an active listing is currently out of stock or if the listing has been determined by eBay to be a duplicate listing.
GetItem
GetSellerList
GetMyeBaySelling
GetSellingManagerTemplates
Conditionally
This boolean field should be included and set to <code>true</code> if the seller wishes to see listing recommendations in the call response via the <b>ListingRecommendations</b> container. Listing recommendations provide one or more messages to the seller on recommendations on:
<b></b>
<ul>
<li>improving a listing </li>
<li>bringing a listing up to standard in regards to Top-Rated seller/listing requirements </li>
<li>mandated or recommended Item Specifics </li>
<li>picture quality requirements </li>
<li>pricing and/or listing format recommendations </li>
<li>recommended keywords and/or Item Specifics in a Title </li>
<li>offering fast handling (same-day handling or handling time of 1 day) and/or a free shipping option in order to qualify the listing for a Fast 'N Free badge </li>
</ul>
AddFixedPriceItem
AddItem
AddItems
RelistFixedPriceItem
RelistItem
ReviseFixedPriceItem
ReviseItem
VerifyAddItem
VerifyAddFixedPriceItem
VerifyRelistItem
No
This container is used in <b>Add</b>/<b>Revise</b>/<b>Relist</b>/<b>Verify</b> listing calls by the seller to enable a listing with the 'In-Store Pickup' feature. The 'In-Store Pickup' feature is only available to a limited number of large retail merchants in the US, Canada, UK, Germany, and Australia marketplaces.
<br/><br/>
This container is returned in the 'Get' calls if the listing is enabled with the In-Store Pickup feature.
AddFixedPriceItem
AddItem
AddItems
RelistFixedPriceItem
RelistItem
ReviseFixedPriceItem
ReviseItem
VerifyAddItem
VerifyAddFixedPriceItem
VerifyRelistItem
GetSellerList
No
GetItem
GetSellerList
GetItemShipping
Conditionally
The unique identifier of the eBay site on which the item is listed. If the Site ID is already passed in as an HTTP header, this field is not needed. If Site ID is specified in the HTTP header and through this request field, the value in this field will override the value in the HTTP headerWhen this is given we would ignore the site Id, which is given in header. See <strong>SiteCodeType</strong> for a full list of Site IDs for the eBay sites that are compatible with the Trading API.
AddFixedPriceItem
AddItem
AddItems
RelistFixedPriceItem
RelistItem
VerifyAddItem
VerifyAddFixedPriceItem
VerifyRelistItem
Conditionally
GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
Conditionally
This boolean field is returned as <code>true</code> if the actual quantity of a multiple-quantity, fixed-price listing (indicated in the <b>Item.Quantity</b> field) can not be accurately determined by eBay.
GetItem
Conditionally
This field is only returned if <code>true</code>, and indicates that the 'Click and Collect' feature is available for this item. With Click and Collect, buyers are able to purchase from thousands of sellers on the eBay UK, Australia, and Germany sites, and then pick up their order from the nearest 'eBay Collection Point'. Note that an item may be eligible for Click and Collect, but this logistics option will only surface if the prospective buyer is within the vicinity of an 'eBay Collection Point'.
<br/><br/>
The Click and Collect feature is only available on the eBay UK, Australia, and Germany sites. For more information about Click and Collect, see the
<a href="https://ebay.co.uk/clickandcollect/">Click and Collect</a> home page on the eBay UK site, the <a href="https://sellercentre.ebay.com.au/click-and-collect">Click and Collect</a> home page on the eBay Australia site, or the <a href="https://pages.ebay.de/einkaufen/click-and-collect.html">Click and Collect</a> home page on the eBay Germany site.
<br>
<br>
Not all categories on the UK, Australia, and Germany sites support Click and Collect listings. To verify if a specific category on these eBay sites support Click and Collect listings, use the <a href="https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/GetCategoryFeatures.html">GetCategoryFeatures</a> call, passing in one or more <b>CategoryID</b> values and a <b>PickupDropOffEnabled</b> value in the <b>FeatureID</b> field.
<br/><br/>
Look for a <code>true</code> value in the <b>PickupDropOffEnabled</b> field of the corresponding <b>Category</b> node (match up the <b>CategoryID</b> values if more than one Category IDs were passed in the request).
<br>
<br>
<span class="tablenote"><b>Note:</b> For Click and Collect eligible sellers, the Click and Collect feature can only be enabled at the account level, and then each of the seller's listings will be automatically evaluated for Click and Collect eligibility.
</span>
GetItem
Conditionally
For 'Click and Collect' eligible sellers, this field was once used to set 'Click and Collect' eligibility at the listing level. However, now the seller can only opt in to 'Click and Collect' at the account level, and then each of their listings will be automatically evaluated for 'Click and Collect' eligibility.
<br/><br/>
<span class="tablenote"><b>Note:</b> Until this field is fully deprecated in the Trading WSDL (and in Add/Revise/Relist/Verify calls), it can still be used, but it will have no functional affect. However, if set in an Add/Revise/Relist/Verify call, it will get returned in <b>GetItem</b>, but it won't be a true indicator if the item is available for the 'Click and Collect' logistics type. Instead, the <b>Item.AvailableForPickupDropOff</b> field should be referenced to see if the item is available for 'Click and Collect'.
</span>
GetItem
Conditionally
<span class="tablenote"><b>Note:</b> This field is no longer applicable as eBay Live Auctions are no longer being held as of September 1, 2018. If this field is used in an Add/Revise/Relist call, it will be ignored and dropped.
</span>
This container is used in <b>Add</b>/<b>Revise</b>/<b>Relist</b>/<b>Verify</b> listing calls to designate the listing as a digital gift card listing. It is also returned in <strong>GetItem</strong> to indicate that the listing contains a digital gift card.
AddFixedPriceItem
AddItem
AddItems
RelistFixedPriceItem
RelistItem
ReviseFixedPriceItem
ReviseItem
VerifyAddItem
VerifyAddFixedPriceItem
VerifyRelistItem
No
GetItem
Conditionally
If <code>true</code>, this item is being offered under the eBay Plus program. eBay Plus is a premium account option for buyers, which provides benefits such as fast free domestic shipping and free returns on selected items. Top-Rated eBay sellers must opt in to eBay Plus to be able to offer the program on qualifying listings. Sellers must commit to next-day delivery of those items.
<br/><br/>
<span class="tablenote"><b>Note:</b> Currently, eBay Plus is available only to buyers in Germany, Austria, and Australia marketplaces.
</span>
more details
Offering eBay Plus
https://developer.ebay.com/DevZone/guides/features-guide/default.html#development/Feature-eBayPlus.html
AddFixedPriceItem
AddItem
AddItems
AddSellingManagerTemplate
RelistFixedPriceItem
RelistItem
ReviseFixedPriceItem
ReviseItem
ReviseSellingManagerTemplate
VerifyAddItem
VerifyAddFixedPriceItem
VerifyRelistItem
No
GetItem
GetSellerList
GetSellerEvents
GetSellingManagerTemplates
Conditionally
If <code>true</code>, this item is eligible to be listed under the eBay Plus program. eBay Plus is a premium account option for buyers, which provides benefits such as fast free domestic shipping and free returns on selected items. Top-Rated eBay sellers must opt in to eBay Plus to be able offer the program on qualifying listings. Sellers must commit to next-day delivery of those items.
<br/><br/>
<span class="tablenote"><b>Note:</b> Currently, eBay Plus is available only to buyers in Germany, Austria, and Australia marketplaces.
</span>
more details
Offering eBay Plus
https://developer.ebay.com/DevZone/guides/features-guide/default.html#development/Feature-eBayPlus.html
GetItem
GetItems
GetSellerList
GetSellerEvents
GetSellingManagerTemplates
Conditionally
The boolean value that is returned in this field will indicate whether or not a digital gift card can be delivered by email to the buyer or recipient of the gift card. This field is only applicable to digital gift card listings.
GetItem
Conditionally
This boolean field indicates whether or not the listing description is HTTPS secure/compliant. To be HTTPS secure/compliant, the <b>Item.Description</b> field may not contain any links to site pages that use the HTTP (and not HTTPS) protocol. This field will be returned with each listing that is found unless one or more <b>OutputSelector</b> fields are used and <code>Item.IsSecureDescription</code> is not one of the values passed in to one of these fields.
<br/><br/>
If this field is returned as <code>true</code>, the listing is HTTPs secure/compliant, and the whole listing description will appear on the View Item page for the listing. If this field is returned as <code>false</code>, the listing is not HTTPs secure/compliant, and only a partial/brief listing description will appear on the View Item page for the listing, with a link to the full listing description that will load in another tab.
<br/><br/>
If the listing description is not HTTPS compliant, the fix is to call <b>ReviseItem</b> or <b>ReviseFixedPriceItem</b> and update the <b>Item.Description</b> field, removing all links to HTTP pages.
<br/><br/>
For more information about why eBay made this change, please see the <a href="http://pages.ebay.com/seller-center/seller-updates/2017-fall/policy-updates.html" target="_blank">Policy Updates</a> page of the Fall 2017 Seller Updates page.
GetItem
GetSellerList
GetSellerEvents
GetSellingManagerTemplates
Conditionally
FixedPriceExcludeStoreInventory, ExcludeStoreInventory, AllItemTypes, AllFixedPriceItemTypes, AdFormat
Enumerated type containing values that provide more information on the type of
filtering the buyer used when setting up a Saved Search in My eBay.
When setting up filtering for the Saved Search, the buyer was only looking for
auction items (with or without the Buy It Now option), so only selected the <b>Auction</b> checkbox in the
<b>Format</b> dialog box. When this filter is used in a Saved Search,
fixed-price items and classified ad listings are not retrieved for the buyer.
When setting up filtering for the Saved Search, the buyer was looking for all
fixed-price items and auction items with Buy It Now available, so only selected the
<b>Buy It Now</b> checkbox in the <b>Format</b> dialog box.
When this filter is used in a Saved Search, auction items (without the Buy It Now
option) and classified ad listings are not retrieved for the buyer.
When setting up filtering for the Saved Search, the buyer was looking for all
items closely associated with the search term, so selected all buying formats
(Auction, Buy It Now, and Classified Ads). All items are retrieved for the buyer,
including auction items (with or without the Buy It Now option), fixed-price
items, and classified ad listings.
When setting up filtering for the Saved Search, the buyer was only looking for
items sold by sellers with eBay stores, so selected the
<b>Sellers with eBay stores</b> checkbox in the
<b>Seller</b> dialog box. When this filter is used in a Saved Search,
only items for sale in an eBay store are retrieved for the buyer.
Excludes listings that have listing type set to StoresFixedPrice.
Excludes listings that have listing type set to AdType.
Excludes auction listings in which BuyItNowEnabled is false.
Excludes listings that have listing type set to StoresFixedPrice.
Retrieves listings whether or not listing type is set to StoresFixedPrice;
include auction items.
Retrieves fixed-price items.
Whether StoresFixedPrice items are retrieved does not depend on the site default.
The StoresFixedPrice items are retrieved after the basic fixed price items.
Items are retrieved whether or not listing type is set to StoresFixedPrice.
Does not retrieve items for which listing type is AdType.
Does not retrieve auction items for which BuyItNowEnabled is false.
Reserved for internal or future use.
When setting up filtering for the Saved Search, the buyer was only looking for
classified ad listings, so only selected the <b>Classified ads</b> checkbox in the
<b>Format</b> dialog box. When this filter is used in a Saved Search,
auction (with or without the Buy It Now option) and fixed-price items
are not retrieved for the buyer.
Restricts listings to return only items that have the Ad Format feature.
This type is deprecated.
This field is deprecated.
This field is deprecated.
This field is deprecated.
Type defining the <b>KTypeSupported</b> field that is returned under the <b>FeatureDefinitions</b> container of the <b>GetCategoryFeatures</b> response (as long as <b>KTypeSupported</b> is included as a <b>FeatureID</b> value in the call request, or no <b>FeatureID</b> values are passed into the call request). The <b>KTypeSupported</b> field is returned as an empty element (a boolean value is not returned) if one or more eBay API-enabled sites support specifying parts compatibility through a K Type vehicle number.
<br><br>
At this time, this feature is only supported for car and truck listings on the Germany site.
<br><br>
To verify if a specific category supports specifying parts compatibility through a K Type vehicle number, pass in a <b>KTypeSupported</b> value in the request, and then look for a <code>true</code> value in the <b>KTypeSupported</b> field of the corresponding <b>Category</b> node (match up the <b>CategoryID</b> values if more than one category ID was passed in the request).
This type is deprecated.
773
Avoid
FindProducts (Shopping API)
889
This field is deprecated.
This field is deprecated.
This type provides information about one order line item in a Global Shipping package. The package can contain multiple units of a given order line item.
The number of units of the order line item in this package; this is required for customs. The seller must ensure that this matches the quantity of the order line item enclosed in the package.
<br/><br/>
This value must be a positive integer, and it can't be greater than the quantity of this item specified in the original transaction.
CompleteSale
AddShipment
ReviseShipment
ReviseSellingManagerSaleRecord
SetShipmentTrackingInfo
No
GetSellingManagerSaleRecord
GetSellingManagerSoldListings
Conditionally
The Country of Manufacture for the order line item; this is required for customs. This should identify the country in which more than 50% of the value of the item was created.
<br/><br/>
This value must conform to the ISO 3166 two-letter country code standard.
To see the list of currently supported codes, and the English names associated with each code
(e.g., KY="Cayman Islands"), call <b>GeteBayDetails</b>
with <b>DetailName</b> set to <b>CountryDetails</b>.
CompleteSale
AddShipment
ReviseShipment
ReviseSellingManagerSaleRecord
SetShipmentTrackingInfo
No
GetSellingManagerSaleRecord
GetSellingManagerSoldListings
Conditionally
The item description of the order line item, based on its <strong>ItemID</strong>.
CompleteSale
AddShipment
ReviseShipment
ReviseSellingManagerSaleRecord
SetShipmentTrackingInfo
No
GetSellingManagerSaleRecord
GetSellingManagerSoldListings
Conditionally
Unique identifier for the eBay listing associated with the order line item. A multiple-quantity listing can have multiple order line items, but only one <b>ItemID</b> value. Unless an <b>OrderLineItemID</b> or <b>SKU</b> value is specified in the same node, this field is required for each <b>ItemTransactionID</b> node included in the request.
CompleteSale
AddShipment
ReviseShipment
ReviseSellingManagerSaleRecord
SetShipmentTrackingInfo
No
GetSellingManagerSaleRecord
GetSellingManagerSoldListings
Conditionally
Unique identifier for an eBay order line item (transaction). The <b>TransactionID</b> should match the <b>ItemID</b> specified in each <b>ItemTransactionID</b> node included in the request. Optionally, an <b>OrderLineItemID</b> value can substitute for the <b>ItemID</b>/<b>TransactionID</b> pair.
CompleteSale
AddShipment
ReviseShipment
ReviseSellingManagerSaleRecord
SetShipmentTrackingInfo
No
GetSellingManagerSaleRecord
GetSellingManagerSoldListings
Conditionally
This type is deprecated.
This field is deprecated.
This type has been deprecated, as Pro Stores and other third-party checkouts have been deprecated.
This field is deprecated.
This field is deprecated.
Contains the IDs for the Listing Designer theme and template (if either are
used) associated with an item, which can optionally be used to enhance the
appearance of the item's description. Cannot be used with Photo Display.
Identifies the Layout template to use when displaying the
item's description. Call <b>GetDescriptionTemplates</b> for valid IDs.
Set to false in <b>GetDescriptionTemplates</b> (or do not specify
<b>LayoutID</b>) to get the standard layout. If a Listing Designer
layout is used (except standard layout), <b>PhotoDisplayType</b> must
be false (or not be specified).
When relisting an item, <b>LayoutID</b> is removed from the listing if you specify
<b>ListingDesignerType</b> without <b>LayoutID</b>. Alternatively, to remove this value
when revising or relisting an item, use <b>DeletedField</b>.
AddFixedPriceItem
AddItem
AddItems
AddSellingManagerTemplate
RelistFixedPriceItem
RelistItem
ReviseFixedPriceItem
ReviseItem
ReviseSellingManagerTemplate
VerifyAddFixedPriceItem
VerifyAddItem
VerifyRelistItem
No
GetBidderList
Conditionally
GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
Conditionally
GetItem
GetSellingManagerTemplates
DetailLevel: ItemReturnDescription, ReturnAll
Always
If true, indicates that the item's picture will be enlarged to fit description
of the item.
AddFixedPriceItem
AddItem
AddItems
AddSellingManagerTemplate
RelistFixedPriceItem
RelistItem
ReviseFixedPriceItem
ReviseItem
ReviseSellingManagerTemplate
VerifyAddFixedPriceItem
VerifyAddItem
VerifyRelistItem
No
GetBidderList
Conditionally
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally
GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
Conditionally
ID for the Listing Designer theme template to use when
displaying the item's description.
When relisting, if you specify <b>ListingDesignerType</b> without
<b>ThemeID</b>, <b>ThemeID</b> is removed from the listing. Alternatively, to remove
this value when revising or relisting an item, use <b>DeletedField</b>.
AddFixedPriceItem
AddItem
AddItems
AddSellingManagerTemplate
RelistFixedPriceItem
RelistItem
ReviseFixedPriceItem
ReviseItem
ReviseSellingManagerTemplate
VerifyAddFixedPriceItem
VerifyAddItem
VerifyRelistItem
No
GetBidderList
Conditionally
GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
Conditionally
GetItem
GetSellingManagerTemplates
DetailLevel: ItemReturnDescription, ReturnAll
Always
Various details about a listing. Some of the details are calculated or derived after
an item is listed. The details in this type include the start and end time and
the converted (localized) prices. The details in this type also include
input values applicable to the Best Offer feature.
Additional details in this type include flags indicating if a seller
specified fields whose values are not visible to the requesting user.
If <code>true</code>, the item is listed in a Mature category. Users must accept
the Mature Category agreement on the eBay site to retrieve
items listed in Mature categories. (Users do not need to sign
this agreement to be able to list items in Mature Categories.)
GetBidderList
Always
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Always
GetItemTransactions
GetSellerTransactions
DetailLevel: ReturnAll
Conditionally
GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
GranularityLevel: Medium, Fine
Conditionally
Applicable for Real Estate auctions only. If <code>true</code>, buyers and sellers
are expected to follow through on the sale. If false, bids for the
Real Estate auction are only expressions of interest.
GetBidderList
Always
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Always
GetItemTransactions
GetSellerTransactions
DetailLevel: ReturnAll
Conditionally
GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
GranularityLevel: Medium, Fine
Conditionally
Indicates whether or not the seller's Checkout Enabled preference is turned on (at account level or at listing level). This preference is managed through Payment Preferences in My eBay. If this preference is enabled, a Pay Now button will appear in checkout flow pages and in the email notifications that are sent to buyers. This preferance is enabled by default if PayPal is one of the payment methods.
GetBidderList
Always
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Always
GetItemTransactions
GetSellerTransactions
DetailLevel: ReturnAll
Conditionally
GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
GranularityLevel: Medium, Fine
Conditionally
Converted value of the <b>BuyItNowPrice</b> in the currency of
the site that returned this response.
For active items, refresh this value every 24 hours to
pick up the current conversion rates.
GetItemTransactions
GetSellerTransactions
DetailLevel: ReturnAll
Conditionally
GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
GranularityLevel: Medium, Fine
Conditionally
GetMyeBayBuying
SecondChanceOffer
BestOfferList
BidList
WatchList
DetailLevel: none, ReturnAll
Conditionally
GetMyeBaySelling
ScheduledList
SoldList
UnsoldList
DeletedFromSoldList
DeletedFromUnsoldList
ActiveList
DetailLevel: none, ReturnAll
Conditionally
GetBidderList
Always
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Always
Converted value of the <b>StartPrice</b> in the currency of
the site that returned this response.
For active items, refresh this value every 24 hours to
pick up the current conversion rates.<br>
<br>
In multi-variation listings, this value matches the lowest-priced
variation that is still available for sale.
GetItemTransactions
GetSellerTransactions
DetailLevel: ReturnAll
Conditionally
GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
GranularityLevel: Fine
Conditionally
GetMyeBayBuying
BidList
LostList
WatchList
WonList
DeletedFromWonList
DeletedFromLostList
DetailLevel: none, ReturnAll
Conditionally
GetMyeBaySelling
ActiveList
BidList
ScheduledList
SoldList
UnsoldList
DeletedFromSoldList
DeletedFromUnsoldList
DetailLevel: none, ReturnAll
Conditionally
GetBidderList
Always
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Always
Converted value of the <b>ReservePrice</b> in the currency of the
site that returned this response. Only returned for listings with
a reserve price when the requesting user is the listing's seller.
For active items, refresh this value every 24 hours to
pick up the current conversion rates.
Not applicable to Fixed Price listings.
GetBidderList
Conditionally
GetMyeBaySelling
ActiveList
ScheduledList
SoldList
UnsoldList
DeletedFromSoldList
DeletedFromUnsoldList
DetailLevel: none, ReturnAll
Conditionally
GetItemTransactions
GetSellerTransactions
DetailLevel: ReturnAll
Conditionally
GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
GranularityLevel: Fine
Conditionally
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally
If <code>true</code>, the seller specified a value in <b>ReservePrice</b>.
GetBidderList
Always
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Always
GetItemTransactions
GetSellerTransactions
DetailLevel: ReturnAll
Conditionally
GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
GranularityLevel: Medium, Fine
Conditionally
Indicates the new item ID for a re-listed item. When an item is
re-listed, the item ID for the new item is added to the
old listing, so buyers can navigate to
the new listing. This value only appears when the old listing is
retrieved. The <b>RelistedItemID</b> of the original item will reflect the last relist.
GetBidderList
Conditionally
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally
GetItemTransactions
GetSellerTransactions
DetailLevel: ReturnAll
Conditionally
GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
Conditionally
The item ID for the original listing from which a second chance offer
is made. This value is only returned when the data for the second chance
offer listing is retrieved.
Output only.
GetBidderList
Conditionally
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally
The <b>StartTime</b> value returned by non-search calls such as
<b>GetItem</b> is the time stamp (in GMT) for when
the item was listed.
GetBidderList
GetDispute
Always
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Always
GetMemberMessages
Conditionally
GetItemTransactions
GetSellerTransactions
DetailLevel: ReturnAll
Conditionally
GetSellerList
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetMyeBayBuying
BestOfferList
BidList
LostList
WatchList
WonList
DeletedFromWonList
DeletedFromLostList
DetailLevel: none, ReturnAll
Conditionally
GetMyeBaySelling
ActiveList
BidList
ScheduledList
SoldList
UnsoldList
DeletedFromSoldList
DeletedFromUnsoldList
DetailLevel: none, ReturnAll
Conditionally
GetSellerEvents
DetailLevel: none, ReturnAll
Conditionally
Time stamp (in GMT) when the listing is scheduled to end
(calculated based on the values of <b>StartTime</b> and <b>ListingDuration</b> )
or the actual end time if the item has ended.
GetBidderList
GetDispute
Always
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Always
GetItemTransactions
GetSellerTransactions
DetailLevel: ReturnAll
Conditionally
GetSellerList
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetBestOffers
DetailLevel: none, ReturnAll
Conditionally
GetItemsAwaitingFeedback
GetMemberMessages
Conditionally
GetMyeBayBuying
BidList
LostList
SecondChanceOffer
WatchList
WonList
DeletedFromWonList
DeletedFromLostList
DetailLevel: none, ReturnAll
Conditionally
GetMyeBaySelling
BidList
DeletedFromSoldList
DeletedFromUnsoldList
SoldList
UnsoldList
DetailLevel: none, ReturnAll
Conditionally
GetSellerEvents
DetailLevel: none, ReturnAll
Conditionally
The URL of the Web page where a user can view the listing.
On the US site, this is called the View Item page.
If you enabled affiliate tracking in a search-related call
(for example, if you used the <b>AffiliateTrackingDetails</b> container
in an applicable call), <b>ViewItemURL</b> contains
a string that includes affiliate tracking information
(see the <a href=
"https://www.ebaypartnernetwork.com" target="_blank">eBay Partner Network</a>).
GetBidderList
Always
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Always
GetMyeBayBuying
WatchList
DetailLevel: none, ReturnAll
Conditionally
GetItemTransactions
GetSellerTransactions
DetailLevel: ReturnAll
Conditionally
GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
Conditionally
Indicates whether the item has any unanswered questions. Use
<b>GetMemberMessages</b> to retrieve unanswered questions for the item if this flag
indicates that there are any.
GetBidderList
Always
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Always
GetItemTransactions
DetailLevel: ReturnAll
Conditionally
GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
Conditionally
Indicates whether the item has any publicly displayed messages. Use
<b>GetMemberMessages</b> to retrieve public messages for the item if this flag
indicates that there are any.
GetBidderList
Always
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Always
GetItemTransactions
GetSellerTransactions
DetailLevel: ReturnAll
Conditionally
GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
Conditionally
Indicates whether the Buy It Now feature is available for an auction listing. As a general rule, once an auction listing has bids (and the high bid exceeds the reserve price, if any), the Buy It Now feature becomes disabled for the listing.
GetBidderList
Conditionally
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally
Type of seller account. This value is not returned for most sites.
This value is not returned for the German site
(site ID 77) or US eBay Motors site (site ID 0).
Specifies the minimum acceptable Best Offer price. If a buyer
submits a Best Offer that is below this value, the offer is automatically
declined. This applies only to items listed in categories that
support the Best Offer auto-decline feature.
<br/><br/>
In order for this setting to hava an effect, Best Offer must be enabled
for the listing, and this value will only be exposed to the seller who listed the item.
<br/><br/>
<b>For Revise and Relist calls:</b>
If a seller wanted to disable the Best Offer auto-accept and/or Best Offer auto-reject feature when revising or relisting an item, the full path to one or both of these two corresponding fields would be provided in a <b>DeletedField</b> tag, like the following: <br/>
<pre><code>
<DeletedField>Item.ListingDetails.MinimumBestOfferPrice</DeletedField>
</code></pre>
<br>
<span class="tablenote"><b>Note:</b>
The Best Offer feature is now available for auction listings on the following sites: US, Canada, UK, Germany, Australia, France, Italy, and Spain. However, sellers must choose between offering Best Offer or Buy It Now on an auction listing, as both features cannot be enabled on the same auction listing. As of January 2019, the value set in this field for an auction listing can be more than the auction start price.
</span>
AddFixedPriceItem
AddItem
AddItems
AddSellingManagerTemplate
ReviseFixedPriceItem
ReviseItem
ReviseSellingManagerTemplate
RelistItem
RelistFixedPriceItem
VerifyAddFixedPriceItem
VerifyAddItem
VerifyRelistItem
No
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally
GetItemTransactions
GetSellerTransactions
DetailLevel: ReturnAll
Conditionally
GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
Conditionally
This field is deprecated.
547
629
NoOp
This field is needed if the seller is selling a motor vehicle through a Motors Local Listing. The string value supplied in this field actually sets the radius of the area (in miles) in which the vehicle will be available and exposed to interested local buyers. The seller's supplied <b>PostalCode</b> or <b>Location</b> field value will be used as the center point for this radius.
<br/><br/>
There is a closed set of radius values that can be set in this field, and it depends on the seller's subscription level. The user can call
<b>GetCategoryFeatures</b>, including <code>LocalListingDistances</code> as a <b>FeatureID</b> value to retrieve the local listing distances supported by a given site, category, and Local Market subscription level.
AddItem
AddItems
AddSellingManagerTemplate
AddFixedPriceItem
Conditionally
Indicates the item ID of the original item listing from which a
Transaction Confirmation Request (TCR) was created. This value is only
returned when the data for a TCR is retrieved.
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally
GetItemTransactions
GetSellerTransactions
DetailLevel: ReturnAll
Conditionally
GetSellerList
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetBidderList
Conditionally
This URL takes you to the same View Item page as ViewItemURL,
but this URL is optimized to support natural search.
That is, this URL is designed to make items on eBay easier to find via
popular Internet search engines. The URL includes the item title along with other optimizations. To
note, "?" (question mark) optimizes to "_W0QQ", "&" (ampersand) optimizes
to "QQ", and "=" (equals sign) optimizes to "Z".
<br><br>
If you are an eBay affiliate, use this URL to promote your affiliate
information.
<br><br>
<span class="tablenote"><b>Note:</b>
This URL may include additional query parameters that don't appear in <b>ViewItemURL</b>
and vice versa. You should not modify the query syntax. For example, eBay won't
recognize the URL if you change QQ to ?.
</span>
GetBidderList
Conditionally
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally
GetItemTransactions
GetSellerTransactions
DetailLevel: ReturnAll
Conditionally
GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
Conditionally
This field is deprecated.
The price at which Best Offers are automatically accepted. Similar in use to <b>MinimumBestOfferPrice</b>. If a buyer submits a Best Offer that is at or above this value, the offer is automatically accepted by the seller. This applies only to items listed in categories that support the <b>BestOfferAutoAcceptPrice</b> feature.
<br/><br/>
For this setting to have an effect, the Best Offer feature must be
enabled for the listing, and only the seller who listed the item will see
<b>BestOfferAutoAcceptPrice</b> in a call response.
<br/><br/>
<b>For Revise and Relist calls:</b>
If a seller wanted to disable the Best Offer Auto-Accept and/or Best Offer Auto-Reject feature when revising or relisting an item, the full path to one or both of these two corresponding fields would be provided in a <b>DeletedField</b> tag, like the following: <br/>
<pre><code>
<DeletedField>Item.ListingDetails.BestOfferAutoAcceptPrice</DeletedField>
</code></pre>
AddFixedPriceItem
AddItem
AddItems
AddSellingManagerTemplate
ReviseFixedPriceItem
ReviseItem
ReviseSellingManagerTemplate
RelistItem
RelistFixedPriceItem
VerifyAddFixedPriceItem
VerifyAddItem
VerifyRelistItem
No
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally
GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
Conditionally
This field is only returned if the item was ended early (before listing duration expired) by the seller (through an API call or on the Web site) or ended administratively by eBay. The value in this field indicates the seller's reason for ending the
listing early.
GetItem
Conditionally
This enumerated type contains the list of values that can be used by the seller to set the duration (number of days or Good 'Til Cancelled) of a listing.
<br><br>
Listing durations available to the seller vary based on the site, category, listing type, and the seller's selling profile, so it is a best practice for the seller to call <b>GetCategoryFeatures</b> with <b>ListingDurations</b> included as a <b>FeatureID</b> value in the call request. The <b>GetCategoryFeatures</b> response will include the complete list of listing duration values that can be used for the various listing types.
<br>
<br>
<span class="tablenote"><b>Note: </b> As of April 1, 2019, <code>GTC</code> (Good 'Til Cancelled) is the only supported listing duration for fixed-price listings on all eBay marketplaces and categories except for motor vehicle listings on eBay Motors US, and on the eBay UK and eBay Italy sites. Sellers do not have to take any action on existing listings with listing durations other than GTC, but if/when these items need to be relisted, only GTC will be supported. If any other listing duration value besides <code>GTC</code> is specified in this field, it will be ignored, and GTC will be used instead.
</span>
This value is used to set the duration of the listing to one day. A one-day listing duration is typically only available to sellers with a Feedback score of 10 or higher, so sellers with a Feedback score of less than 10 may be restricted from using a one-day listing duration. The seller can call <b>GetCategoryFeatures</b> with <b>ListingDurations</b> included as a <b>FeatureID</b> value in the call request to see if the one-day listing duration is available. <br><br>
A one-day listing duration is generally applicable to an auction listing or to a Real Estate Classified Ad.
This value is used to set the duration of the listing to three days.
This value is used to set the duration of the listing to five days.
This value is used to set the duration of the listing to seven days.
This value is used to set the duration of the listing to 10 days.
This value is used to set the duration of the listing to 14 days.
This value is used to set the duration of the listing to 21 days. <br/><br/>
<span class="tablenote"><b>Note: </b> A 21-day listing duration was typically only applicable to eBay Motors Local Market vehicle listings, but this listing duration is no longer valid/supported. </span>
This value is used to set the duration of the listing to 30 days.
<br/><br/>
<span class="tablenote"><b>Note: </b> In October 2018, this listing duration was enabled for eBay Motors Local Listings, and replaced the formerly supported <code>Days_21</code> enumeration value.
</span>
This value is used to set the duration of the listing to 60 days.
<br><br>
A 60-day listing duration is typically only applicable to Classified Ad listings in specific categories.
This value is used to set the duration of the listing to 90 days.
<br><br>
A 90-day listing duration is generally only applicable to a Real Estate Classified Ad.
This value is used to set the duration of the listing to 120 days.
<br><br>
An 120-day listing duration is typically only applicable to Classified Ad listings in specific categories.
This value is used to set the duration of the listing to 'Good 'Til Cancelled. This option is available for fixed-price and Classified Ad listings. "Good 'Til Cancelled" fixed-price listings will be relisted automatically every 30 days until all inventory is sold out (e.g., <b>Item.Quantity</b>=0 in a single-variation fixed-price listing, or all occurences of <b>Item.Variations.Variation.Quantity</b>=0 in a multi-variation fixed-price listing), or the seller ends the fixed-price listing.
<br>
<br>
<span class="tablenote"><b>Note: </b> As of April 1, 2019, <code>GTC</code> (Good 'Til Cancelled) is the only supported listing duration for fixed-price listings on all eBay marketplaces and categories except for motor vehicle listings on eBay Motors US, and on the eBay UK and eBay Italy sites. Sellers do not have to take any action on existing listings with listing durations other than GTC, but if/when these items need to be relisted, only GTC will be supported. If any other listing duration value besides <code>GTC</code> is specified in this field, it will be ignored, and GTC will be used instead.
</span>
<br>
<span class="tablenote"><b>Note: </b>
As of July 1, 2019, the Good 'Til Cancelled renewal schedule has been modified from every 30 days to once per calendar month. For example, if a GTC listing is created July 5, the next monthly renewal date will be August 5. If a GTC listing is created on the 31st of the month, but the following month only has 30 days, the renewal will happen on the 30th in the following month. Finally, if a GTC listing is created on January 29-31, the renewal will happen on February 28th (or 29th during a 'Leap Year'). See the
<a href="https://pages.ebay.com/seller-center/seller-updates/2019-spring/marketplace-updates.html#good-til-cancelled" target="_blank">Good 'Til Cancelled listings update</a> in the <b>Spring 2019 Seller Updates</b> for more information about this change.
</span>
This value is reserved for internal or future use.
Type used by the <b>ListingDurations</b> container that is returned for each listing type supported for the eBay site. <b>ListingDurations</b> container shows the supported listing duration times for each listing type.
All values returned in the <b>Duration</b> fields indicate the listing durations that are supported for that listing type. The allowed durations vary according to the type of listing. The value <code>GTC</code> means Good 'Til Canceled. The complete list of enumeration values that may be returned in this field is shown in <b>ListingDurationCodeType</b>.
ListingDurationCodeType
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
The integer value in this attribute identifies the type of listing to which the set of durations applies. To match a <b>durationSetID</b> value to a specific listing type, see the <b>Category.ListingDuration</b> field in the call response.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
A type used by the <b>ListingDurations</b> container node that is returned in the response of <b>GetCategoryFeatures</b> call. A <b>ListingDurations</b> container is returned for each listing type supported for the eBay site, and the supported listing duration times for those listing types.
A <b>ListingDurations</b> container is returned for each listing type supported for the eBay site, and the supported listing duration times for those listing types. The <b>durationSetID</b> attribute value indicates the listing type.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
This attribute indicates the current version of the Listing Durations data. This can be helpful to let users know when modifications have been made to Listing Durations.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
Identifies the type of listing as an attribute on the <b>ListingDuration</b> node.
The type of listing a set of durations describes.
GetCategoryFeatures
DetailLevel: ReturnAll
Unknown, Auction, Half
Conditionally
<span class="tablenote"><b>Note:</b>
This enumerated type is no longer applicable, as the Featured First listing feature is being deprecated for all sites. If a seller attempts to add Featured First as a listing enhancement (including <b>ListingEnhancement</b> field in an <b>AddItem</b> call and setting its value to <code>Featured</code>), it is allowed, but a warning will be returned announcing the deprecation of the feature. Starting August 15, 2019, this feature cannot be added when creating a new listing or revising an existing listing. For existing listings that already have the feature, the seller will not be able to change the duration to <code>Lifetime</code>. On September 15, 2019, this feature will be wired off. If a seller revises an existing listing that had this feature set, the <b>GalleryType</b> value will automatically default to <code>Gallery</code>.
</span>
<br>
This enumerated type contains the list of values that can be used by the seller to set the duration of a Featured Gallery in a fixed-price listing. Once set for a listing, the Featured Gallery duration can be increased from 'Days_7' to 'Lifetime' (throughout life of listing), but the duration cannot be decreased from 'Lifetime' to 'Days_7'.
This value sets the Featured Gallery duration to one day. This
value is deprecated.
This value sets the Featured Gallery duration to two days. This
value is deprecated.
This value sets the Featured Gallery duration to three days. This
value is deprecated.
This value sets the Featured Gallery duration to four days. This
value is deprecated.
This value sets the Featured Gallery duration to five days. This
value is deprecated.
This value sets the Featured Gallery duration to six days. This
value is deprecated.
This value sets the Featured Gallery duration to seven days. If a
listing has a Featured Gallery duration of seven days, it is possible to revise that
item and set the Featured Gallery duration to 'Lifetime' (throughout
life of listing) (
This value sets the Featured Gallery duration to eight days. This
value is deprecated.
This value sets the Featured Gallery duration to nine days. This
value is deprecated.
This value sets the Featured Gallery duration to 10 days. This
value is deprecated.
This value sets the Featured Gallery duration to 11 days. This
value is deprecated.
This value sets the Featured Gallery duration to 12 days. This
value is deprecated.
This value sets the Featured Gallery duration to 13 days. This
value is deprecated.
This value sets the Featured Gallery duration to 14 days. This
value is deprecated.
This value sets the Featured Gallery duration to 15 days. This
value is deprecated.
This value sets the Featured Gallery duration to 16 days. This
value is deprecated.
This value sets the Featured Gallery duration to 17 days. This
value is deprecated.
This value sets the Featured Gallery duration to 18 days. This
value is deprecated.
This value sets the Featured Gallery duration to 19 days. This
value is deprecated.
This value sets the Featured Gallery duration to 20 days. This
value is deprecated.
This value sets the Featured Gallery duration to 21 days. This
value is deprecated.
This value sets the Featured Gallery duration to 22 days. This
value is deprecated.
This value sets the Featured Gallery duration to 23 days. This
value is deprecated.
This value sets the Featured Gallery duration to 24 days. This
value is deprecated.
This value sets the Featured Gallery duration to 25 days. This
value is deprecated.
This value sets the Featured Gallery duration to 26 days. This
value is deprecated.
This value sets the Featured Gallery duration to 27 days. This
value is deprecated.
This value sets the Featured Gallery duration to 28 days. This
value is deprecated.
This value sets the Featured Gallery duration to 29 days. This
value is deprecated.
This value sets the Featured Gallery duration to 30 days. This
value is deprecated.
This value sets the Featured Gallery duration to 31 days. This
value is deprecated.
This value sets the Featured Gallery duration to 32 days. This
value is deprecated.
This value sets the Featured Gallery duration to 33 days. This
value is deprecated.
This value sets the Featured Gallery duration to 34 days. This
value is deprecated.
This value sets the Featured Gallery duration to 35 days. This
value is deprecated.
This value sets the Featured Gallery duration to 36 days. This
value is deprecated.
This value sets the Featured Gallery duration to 37 days. This
value is deprecated.
This value sets the Featured Gallery duration to 38 days. This
value is deprecated.
This value sets the Featured Gallery duration to 39 days. This
value is deprecated.
This value sets the Featured Gallery duration to 40 days. This
value is deprecated.
This value sets the Featured Gallery duration to 41 days. This
value is deprecated.
This value sets the Featured Gallery duration to 42 days. This
value is deprecated.
This value sets the Featured Gallery duration to 43 days. This
value is deprecated.
This value sets the Featured Gallery duration to 44 days. This
value is deprecated.
This value sets the Featured Gallery duration to 45 days. This
value is deprecated.
This value sets the Featured Gallery duration to 46 days. This
value is deprecated.
This value sets the Featured Gallery duration to 47 days. This
value is deprecated.
This value sets the Featured Gallery duration to 48 days. This
value is deprecated.
This value sets the Featured Gallery duration to 49 days. This
value is deprecated.
This value sets the Featured Gallery duration to 50 days. This
value is deprecated.
This duration enables the Featured Gallery feature for the life of the listing. Once the
Featured Gallery duration is set to 'Lifetime' for a listing, it cannot be changed.
This value is reserved for internal or future use.
Defines the Listing Enhancement Duration feature.
If the field is present, the corresponding feature applies to the category.
The field is returned as an empty element (i.e., a boolean value is not returned).
<span class="tablenote"><b>Note:</b>
This type is no longer applicable, as the Featured Gallery listing feature is being deprecated for all sites. If a seller attempts to add Featured Gallery as a listing enhancement, it is allowed, but a warning will be returned announcing the deprecation of the feature. Starting August 15, 2019, this feature cannot be added when creating a new listing or revising an existing listing. For existing listings that already have the feature, the seller will not be able to change the duration to <code>Lifetime</code>. On September 15, 2019, this feature will be wired off. If a seller revises an existing listing that had this feature set, the <b>GalleryType</b> value will automatically default to <code>Gallery</code>.
</span>
<br>
Type used by the <b>GalleryFeaturedDurations</b> container that is returned at the <b>SiteDefaults</b> and <b>Category</b> level in a <b>GetCategoryFeatures</b> response. <b>GalleryFeaturedDurations</b> container consists of the supported time durations that a picture gallery can be featured
<span class="tablenote"><b>Note:</b>
<b>Duration</b> fields are currently still being returned in <b>GetCategoryFeatures</b> response, but Featured Gallery listing feature is being deprecated for all sites. If a seller attempts to add Featured Gallery as a listing enhancement, it is allowed, but a warning will be returned announcing the deprecation of the feature. Starting August 15, 2019, this feature cannot be added when creating a new listing or revising an existing listing. For existing listings that already have the feature, the seller will not be able to change the duration to <code>Lifetime</code>. On September 15, 2019, this feature will be wired off. If a seller revises an existing listing that had this feature set, the <b>GalleryType</b> value will automatically default to <code>Gallery</code>.
</span>
<br>
Each returned <b>Duration</b> field indicates a supported time duration that a picture gallery can be featured.
The <code>Lifetime</code> value indicates that the Featured Gallery enhancement will be active for the lifetime of the listing.
ListingEnhancementDurationCodeType
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
Type defining all listing upgrades that may be available to the seller when listing an
item. The listing upgrades that are available vary by site and by the seller's
account status. To discover which listing upgrades are available,
call <b>GeteBayDetails</b>, pass in the appropriate <b>SiteID</b> value and set the <b>DetailName</b> input
filter to <code>ListingFeatureDetails</code>, and then look for the <b>ListingFeatureDetails</b> container
in the response. Listing upgrades will either be listed as <code>Enabled</code> or <code>Disabled</code>.
BasicUpgradePackBundle, Border, Featured, Highlight, ProPackBundle, ProPackPlusBundle, HomePageFeatured
<span class="tablenote"><b>Note:</b>
The Picture Border feature is no longer available on any eBay Marketplace sites, so this value should not be used in Add/Revise/Relist calls, and will not be returned in 'Get' calls.
</span>
<br>
If specified, the seller wants to add a border around the listing's pictures. Applicable listing fees apply.
<br>
<br>
This value is used if the seller wants the listing title to
be in boldface type. This feature will incur a listing fee.
Note that this enhancement will not put the listing subtitle in boldface type (if a subtitle is used).
<br>
<br>
Currently, Bold Titles are only supported on eBay US, both Canada sites, eBay Netherlands, and eBay Poland.
<span class="tablenote"><b>Note:</b>
The Featured listing feature is no longer available on any eBay Marketplace sites, so this value should not be used in Add/Revise/Relist calls, and will not be returned in 'Get' calls.
</span>
<br>
Listing is a "Featured Plus" item. The item will display
prominently in the Featured Items section of its category list, and it will
stand out on search results pages. It will also display in the regular, non-
featured item list. Only available to users with a Feedback rating of 10 or
greater.
<span class="tablenote"><b>Note:</b>
The Highlighted listing feature is no longer available on any eBay Marketplace sites, so this value should not be used in Add/Revise/Relist calls, and will not be returned in 'Get' calls.
</span>
<br>
Listing is highlighted in a different color in lists.
<span class="tablenote"><b>Note:</b>
The Featured Gallery listing feature is no longer available on any eBay sites, so this value should not be used in Add/Revise/Relist calls, and will not be returned in 'Get' calls.
</span>
<br>
Listing will have a chance to rotate into a special display
on eBay's Home page. Your item is very likely to show up on the Home page,
although eBay does not guarantee that your item will be highlighted
in this way. This is the highest level of visibility on eBay.
<span class="tablenote"><b>Note:</b>
The Pro Pack Bundle is no longer available on any eBay Marketplace sites, so this value should not be used in Add/Revise/Relist calls, and will not be returned in 'Get' calls.
</span>
<br>
Listing is using ProPackBundle (a feature pack).
Applies only to vehicle listings on eBay Motors (US and Canada), and
to the Parts and Accessories category in the eBay Motors US site.
Contains the BoldTitle, Border, Featured and Highlight features.
<span class="tablenote"><b>Note:</b>
The Basic Upgrade Pack Bundle is no longer available on any eBay Marketplace sites, so this value should not be used in Add/Revise/Relist calls, and will not be returned in 'Get' calls.
</span>
If this value is specified in an Add/Revise/Relist call, a Value Pack bundle is applied to the listing. The Value Pack bundle includes the Gallery Plus feature, a listing subtitle, and use of a Listing Designer template for a discounted price. Support for this feature varies by site and category.
<span class="tablenote"><b>Note:</b>
The Pro Pack Plus Bundle is no longer available on any eBay Marketplace sites, so this value should not be used in Add/Revise/Relist calls, and will not be returned in 'Get' calls.
</span>
<br>
Support for this feature varies by site and category.
A ProPackPlusBundle listing is using ProPackPlus bundle (a feature pack),
which combines the features of BoldTitle, Border, Highlight, Featured (which
is equivalent to a GalleryType value of Featured), and
Gallery, for a discounted price.
Note that if, for example, in AddItem, if you use ProPackPlusBundle and
a GalleryType value of Gallery, then the resulting item will have a GalleryType
value of Featured.
Reserved for internal or future use.
eBay Listing Enhancements Codes
Code List Agency - eBay, Inc.
Code List Version - 1.0
This type is used by the <b>ListingFeatureDetails</b> container in the <b>GeteBayDetails</b> response. This container indicates the listing features that are enabled or disabled for an eBay site.
Border, Highlight, ProPack, GiftIcon
The enumeration value returned in this field indicates whether or not the Bold Title featured is enabled for the eBay site. If this feature is available for an eBay site, the seller can pass in <code>BoldTitle</code> as an enumeration value in the <b>ListingEnhancement</b> field of an Add/Revise/Relist call.
GeteBayDetails
Always
<span class="tablenote"><b>Note:</b>
The Picture Border feature is no longer available on any eBay Marketplace sites, so this value should not be used in Add/Revise/Relist calls, and will not be returned in 'Get' calls.
</span>
<br>
Defines the availability of the Picture Border feature for the site.
GeteBayDetails
Always
<span class="tablenote"><b>Note:</b>
The Highlight feature is no longer available on any eBay Marketplace sites, so this value should not be used in Add/Revise/Relist calls, and will not be returned in 'Get' calls.
</span>
<br>
Defines the availability of the Highlight feature for the site.
GeteBayDetails
Always
<span class="tablenote"><b>Note:</b>
The Gift Icon feature is no longer available on any eBay Marketplace sites.
</span>
<br>
Defines the availability of the Gift Icon feature for the site.
GeteBayDetails
Always
The enumeration value returned in this field indicates whether or not the Home Page Featured feature is enabled for the eBay site. If this feature is available for an eBay site, the seller can pass in <code>HomePageFeatured</code> as an enumeration value in the <b>ListingEnhancement</b> field of an Add/Revise/Relist call.
GeteBayDetails
Always
The enumeration value returned in this field indicates whether or not the Featured First feature is enabled for the eBay site. As of October 2017, this listing feature is only available to Top-Rated Sellers on the Germany site.
GeteBayDetails
Always
The enumeration value returned in this field indicates whether or not the Featured Plus feature is enabled for the eBay site.
GeteBayDetails
Always
<span class="tablenote"><b>Note:</b>
The Pro Pack Bundle feature is no longer available on any eBay Marketplace sites.
</span>
<br>
Defines the availability of the Pro Pack Bundle for the site.
GeteBayDetails
Always
Returns the current version of details.
GeteBayDetails
DetailLevel: none, ReturnSummary, ReturnAll
Always
Gives the time in GMT that the feature flags for the
details were last updated.
GeteBayDetails
DetailLevel: none, ReturnSummary, ReturnAll
Always
This enumerated type is deprecated.
This value is not used.
This value is not used.
This value is not used.
This value is not used.
Type defining the <b>Recommendation</b> container(s) that are
conditionally returned in all Add/Revise/Relist/Verify API calls.
Each <b>Recommendation</b> container provides a message to the seller on
how a listing can be improved or brought up to standard in regards to top-rated seller/listing requirements, mandated or recommended Item Specifics, picture quality requirements, pricing and/or listing format recommendations, recommended keywords and/or Item Specifics in a Title, and/or a recommendation to use Fast 'N Free shipping.
<br><br>
One or more <b>Recommendation</b> containers can be returned for each
listing.
This value indicates the specific type of listing recommendation being provided to
the seller. Possible values include the following:
<ul>
<li>eTRS - this recommendation type advises the seller that the listing
is not meeting a specific Top-Rated listing requirement, such as same-day or 1-day handling or a 14-day (or longer) Money Back Return Policy;</li>
<li>ItemSpecifics - this recommendation type advises the seller that the
listing is missing a required or recommended Item Specifics name/value pair;</li>
<li>Picture - this recommendation type advises the seller that a specific
picture in the listing is not meeting a specific picture qualityrequirement;</li>
<li>Price - this recommendation type provides a recommended price and/or a recommended price range for auction and fixed-price listings. These price recommendation values are based on similar items that have recently sold on eBay. Along with pricing recommendations, a recommended listing format (auction vs. fixed-price) is also returned. This recommendation type is currently only supported on the US, UK, and DE sites; </li>
<li>Title - this recommendation type provides guidance on forming an effective listing title, and will suggest valuable keywords or recommended Item Specifics that the listing title is missing. This recommendation type will also call out keywords that do not accurately describe the item. The keywords or Item Specifics are called out in the response. This recommendation type is currently only supported on the US, UK, DE, and AU sites; and</li>
<li>FnF - this recommendation type advises the seller to offer expedited shipping for the item (same-day shipping or handling time of 1 day) and/or offer at least one free shipping service option.</li>
</ul>
128
AddFixedPriceItem
AddItem
AddItems
RelistFixedPriceItem
RelistItem
ReviseFixedPriceItem
ReviseItem
VerifyAddItem
VerifyAddFixedPriceItem
VerifyRelistItem
Conditionally
This value indicates the group that a specific listing recommendation belongs to.
There may be multiple groups for each listing recommendation type. For example,
two groups of the <b>eTRS</b> listing recommendation type are
'SHIPPING' and 'RETURNS'.
256
AddFixedPriceItem
AddItem
AddItems
RelistFixedPriceItem
RelistItem
ReviseFixedPriceItem
ReviseItem
VerifyAddItem
VerifyAddFixedPriceItem
VerifyRelistItem
Conditionally
The <b>FieldName</b> value will vary based on the recommendation type. The <b>FieldName</b> values for each recommendation type are summarized below:
<br><br>
For <b>eTRS</b> listing recommendations, the <b>FieldName</b> value will indicate the specific Trading API field that the seller needs to update to bring the listing up to top-rated listing standards. For example, if the <b>Recommendation.Type</b> value is 'eTRS' and the <b>Recommendation.Group</b> value is 'SHIPPING', the <b>FieldName</b> value may be 'DispatchTimeMax'. If the seller is returned a listing recommendation like this, it would most likely indicate that the seller must reduce the handling time (<b>DispatchTimeMax</b> value) in the listing to '0' (same-day shipping) or '1' (one-day handling time) in order for the listing to qualify as a top-rated listing and receive a Top Rated Plus seal in View Item and Search Results pages.
<br><br>
For an <b>ItemSpecifics</b> listing recommendation, the <b>FieldName</b> value will be the name of the recommended Item Specific. If the seller gets a <b>ItemSpecifics</b> listing recommendation, the seller will perform a <b>ReviseItem</b>/<b>ReviseFixedPriceItem</b> call, passing in the recommended Item Specific (with one or more values) through the <b>ItemSpecifics.NameValueList</b> container. If available, eBay will also return recommended Item Specific value(s) through the <b>Recommendation.Value</b> field.
<br><br>
For a <b>Picture</b> listing recommendation, the <b>FieldName</b> value will be the URL of the image that needs to be brought up to picture quality standards. If the seller gets a <b>Picture</b> listing recommendation for this image in the listing, the seller will need to make the required picture quality update, and then perform a <b>ReviseItem</b>/<b>ReviseFixedPriceItem</b> call, passing in the URL of the image through the <b>PictureURL</b> field in the <b>PictureDetails</b> container.
<br><br>
If the seller gets a <b>Picture</b> listing recommendation for this image in the listing, the seller will need to make the required picture quality update, and then perform a <b>ReviseItem</b>/<b>ReviseFixedPriceItem</b> call, passing in the URL of the image through the <b>PictureURL</b> field in the <b>PictureDetails</b> container.
<br><br>
For a <b>Price</b> listing recommendation, the <b>FieldName</b> value will be one of the following:
<ul>
<li><b>BuyItNowPrice</b>: the recommended price for an item in a fixed-price listing or for the "Buy It Now" price in an auction listing; this value will be shown in the <b>Recommendation.Value</b> field. Upon getting a <b>BuyItNowPrice</b> recommendation, the seller may consider revising their listing with a price matching or closer to the recommended price.</li>
<li><b>ListingType</b>: this value is returned if a different listing type (auction vs. fixed-price) is being suggested for the item. Upon getting a <b>ListingType</b> recommendation, the seller may consider the recommended listing type the next time they list a similar item.</li>
<li><b>StartPrice</b>: the recommended starting bid price for an item in an auction listing; this value will be shown in the <b>Recommendation.Value</b> field. Upon getting a <b>StartPrice</b> recommendation, the seller may consider the recommended starting bid price the next time they list a similar item.</li>
</ul>
Two other pricing recommendations, <b>BuyItNowPriceRange</b> and <b>StartPriceRange</b>, are supported in the Listing Recommendation API, but are not yet supported by the Trading API.
<br><br>
For a <b>Title</b> listing recommendation, the <b>FieldName</b> value will be 'Title' for any of the three use cases - missing keywords, missing Item Specifics, or inaccurate keywords. Upon getting a <b>Title</b> recommendation, the seller may consider the <b>Title</b> recommendation (adding keywords, adding Item Specifics, removing inaccurate keywords) the next time they list a similar item.
<br><br>
For an <b>FnF</b> listing recommendation, either one or two <b>recommendation</b> containers will be returned, based on whether a listing needs fast handling (same-day handling or handling time of 1 day), at least one free shipping service, or both. These two <b>fieldName</b> values are described below:
<ul>
<li><strong>shipsWithinDays</strong>: this <strong>fieldName</strong> value is returned if the seller needs to implement fast handling (same-day handling or a handling time of 1 day). To implement fast handling, the seller will perform a <strong>ReviseItem</strong>/<strong>ReviseFixedPriceItem</strong> call, passing a value of '0' or '1' into the <strong>DispatchTimeMax</strong> field.</li>
<li><strong>shippingServiceCost</strong>: this <strong>fieldName</strong> value is returned if the seller needs to offer a free shipping service option in the listing. To add a free shipping service option, the seller will perform a <strong>ReviseItem</strong>/<strong>ReviseFixedPriceItem</strong> call, passing in one or more <b>ShippingDetails.ShippingServiceOptions</b> containers where the shipping service is free (<b>ShippingServiceOptions.FreeShipping</b> boolean value set to 'true').</li>
</ul>
<br><br>
This <b>FieldName</b> field is always returned with each <b>Recommendation</b> container.
256
AddFixedPriceItem
AddItem
AddItems
RelistFixedPriceItem
RelistItem
ReviseFixedPriceItem
ReviseItem
VerifyAddItem
VerifyAddFixedPriceItem
VerifyRelistItem
Conditionally
This code value provides a generic, "human-friendly" message summarizing what is wrong with the listing, or how it can be improved. These values include:
<ul>
<li>FIELD_VALUE_INCORRECT</li>
<li>FIELD_VALUE_RECOMMENDATION</li>
<li>MANDATED_FIELD_VALUE_MISSING</li>
<li>MANDATORY_STANDARDS_NOT_MET</li>
<li>RECOMMENDED_FIELD_VALUE_MISSING</li>
<li>RECOMMENDED_FIELD_VALUE_TO_REMOVE</li>
<li>RECOMMENDED_STANDARDS_NOT_MET</li>
</ul>
This field is always returned with each <b>recommendation</b> container.
128
AddFixedPriceItem
AddItem
AddItems
RelistFixedPriceItem
RelistItem
ReviseFixedPriceItem
ReviseItem
VerifyAddItem
VerifyAddFixedPriceItem
VerifyRelistItem
Conditionally
The <b>Value</b> field is only applicable for <b>ItemSpecifics</b>, <b>Pricing</b>, and <b>Title</b> listing recommendation types, and it is only returned for these recommendation types.
<br><br>
For the <b>ItemSpecifics</b> recommendation type, the value in the <b>Value</b> field is a recommended value for the recommended Item Specific name found in the <b>Recommendation.FieldName</b> field. Each Item Specific name can have more than one recommended value, so it is possible to have multiple <b>Recommendation.Value</b> fields for that recommendation. It is also possible that a recommended Item Specific name will have no recommended values, hence no <b>Recommendation.FieldName</b> values are returned.
<br><br>
For the <b>Pricing</b> recommendation type, the value in the <b>Value</b> field is either:
<ul>
<li>a recommended value for the starting bid price (if <b>Recommendation.FieldName</b> value is 'StartPrice');</li>
<li>a recommended value for a fixed-price item (if <b>Recommendation.FieldName</b> value is 'BuyItNowPrice'); or</li>
<li>a recommended value for the listing type (if <b>Recommendation.FieldName</b> value is 'ListingType'). </li>
</ul>
For the <b>Title</b> recommendation type, the value in the <b>value</b> field is either:
<ul>
<li>a recommended keyword to include in the listing Title (if <b>Recommendation.Code</b> value is 'RECOMMENDED_FIELD_VALUE_MISSING');</li>
<li>a recommended keyword to remove (to maintain accuracy) in the listing Title (if <b>Recommendation.Code</b> value is 'RECOMMENDED_FIELD_VALUE_TO_REMOVE');</li>
<li>a recommended Item Specific to include in the listing Title (if <b>Recommendation.Code</b> value is 'FIELD_VALUE_RECOMMENDATION');</li>
</ul>
Each <b>Title</b> recommendation can have more than one keyword or Item Specific value, so it is possible to have multiple <b>Recommendation.Value</b> fields for that recommendation.
128
AddFixedPriceItem
AddItem
AddItems
RelistFixedPriceItem
RelistItem
ReviseFixedPriceItem
ReviseItem
VerifyAddItem
VerifyAddFixedPriceItem
VerifyRelistItem
Conditionally
This textual message is the detailed description of a specific action that a seller can take to improve the quality of the listing, or bring it up to Picture or eTRS standards. For some recommendations, the fields may be revised on an active listing through a <b>ReviseItem</b> or <b>ReviseFixedPriceItem</b> call of the Trading API. For other recommendations, it may not be possible to revise the fields on an active listing.
<br><br>
This field is returned in the <b>Recommendation</b> container when available/applicable.
4000
AddFixedPriceItem
AddItem
AddItems
RelistFixedPriceItem
RelistItem
ReviseFixedPriceItem
ReviseItem
VerifyAddItem
VerifyAddFixedPriceItem
VerifyRelistItem
Conditionally
This container contains price guidance information, which includes the minimum and maximum recommended prices for the item, which are based on recent sales of similar items. This container is only returned for price recommendations and when the pricing data is available.
<br><br>
A <b>Metadata</b> container is returned for each price guidance parameter that is applicable/available for the pricing recommendation.
AddFixedPriceItem
AddItem
AddItems
RelistFixedPriceItem
RelistItem
ReviseFixedPriceItem
ReviseItem
VerifyAddItem
VerifyAddFixedPriceItem
VerifyRelistItem
Conditionally
Type defining the <b>ListingRecommendations</b> container that is
conditionally returned in all Add/Revise/Relist/Verify API calls. A
<b>ListingRecommendations</b> container consists of one or
more <b>Recommendation</b> containers, and each
<b>Recommendation</b> container provides a message to the seller on how a
listing can be improved or brought up to standard in regards to top-rated seller/listing requirements, mandated or recommended Item Specifics, picture quality requirements, pricing and/or listing format recommendations, recommended keywords and/or Item Specifics in a Title, and/or a recommendation to use Fast 'N Free shipping.
<br><br>
The <b>ListingRecommendations</b> container is only returned if the
<b>IncludeRecommendations</b> flag is included and set to 'true' in the
API call request.
Each <b>Recommendation</b> container provides a message to the seller on how a listing can be improved or brought up to standard in regards to top-rated seller/listing requirements, mandated or recommended Item Specifics, picture quality requirements, pricing and/or listing format recommendations, recommended keywords and/or Item Specifics in a Title, and/or a recommendation to use Fast 'N Free shipping. <br><br> One or more <b>Recommendation</b> containers can be returned for each listing.
AddFixedPriceItem
AddItem
AddItems
RelistFixedPriceItem
RelistItem
ReviseFixedPriceItem
ReviseItem
VerifyAddItem
VerifyAddFixedPriceItem
VerifyRelistItem
Conditionally
Type defining the <b>ListingStartPriceDetails</b> container returned in
<b>GeteBayDetails</b>. The <b>ListingStartPriceDetails</b>
container lists the minimum start price for auction listings, the minimum sale price
for fixed-price listings, and the minimum percentage value that a Buy It Now price for
an auction listing must be above the minimum start price for that same listing.
<br><br>
The <b>ListingStartPriceDetails</b> container is returned if
<b>ListingStartPriceDetails</b> is included as a <b>DetailName</b>
filter in the request, or if no lt;b>DetailName</b> filters are used in the request.
This value is a string description of the listing type for which the pricing data
is intended, such as "Pricing for the auction-like listings".
GeteBayDetails
Conditionally
This value indicates the listing type of the listing, and is a value defined in
<b>ListingTypeCodeType</b> enumerated type. The only possible values for
this field are 'Chinese' (auction listing) and 'FixedPriceItem'.
Chinese, FixedPriceItem
GeteBayDetails
Conditionally
For auction listings, the <b>StartPrice</b> indicates the lowest dollar
value that can be set for the item's Starting bid.
<br><br>
For fixed-price listings, the <b>StartPrice</b> indicates the lowest
dollar value that can be set for the item's sale price.
GeteBayDetails
Conditionally
Returns the latest version number for this field. The version can be used to
determine if and when to refresh cached client data.
GeteBayDetails
DetailLevel: none, ReturnSummary, ReturnAll
Always
Gives the time in GMT that the feature flags for the
details were last updated. This timestamp can be used to determine
if and when to refresh cached client data.
GeteBayDetails
DetailLevel: none, ReturnSummary, ReturnAll
Always
This field is only returned and applicable for auction listings.
<br><br>
This float value indicates the minimum percentage value that a Buy It Now price for
an auction listing must be above the Starting bid price for that same listing.
<br><br>
On the US eBay Motors site (Site ID 100), this field only applies to the Parts and
Accessories categories.
GeteBayDetails
Conditionally
Specifies an active or ended listing's status in eBay's processing
workflow. If a listing ends with a sale (or sales), eBay needs to
update the sale details (e.g., total price and buyer/high bidder)
and the final value fee. This processing can take several minutes.
If you retrieve a sold item and no details about the buyer/high
bidder are returned or no final value fee is available, use this
listing status information to determine whether eBay has finished
processing the listing.
The listing is still active or the listing has ended with
a sale but eBay has not completed processing the sale details
(e.g., total price and high bidder). A multi-item listing is
considered active until all items have winning bids or
purchases or the listing ends with at least one winning bid or
purchase. If the listing has ended with a sale but this Active
status is returned, please allow several minutes for eBay to
finish processing the listing.
The listing has ended. If the listing ended with a sale,
eBay has completed processing of the sale. All sale information
returned from eBay (e.g., total price and high bidder) should be
considered accurate and complete. However, the final value fee is
not yet available.
The listing has closed and eBay has completed processing the sale. All
sale information returned from eBay (e.g., total price and high bidder) should
be considered accurate and complete. Although the Final Value Fee (FVF) for
FixedPriceItem and StoresFixedPrice items is returned by GetSellerTransactions
and GetItemTransactions, all other listing types (excluding Buy It Now
purchases) require the listing status to be Completed before the Final Value
Fee is returned.
Reserved for internal or future use.
Reserved for internal or future use.
This enumerated type defines the two subtypes that can be used if the main listing type (in <strong>ListingType</strong> field) is <code>LeadGeneration</code>. A <strong>ListingSubtype2</strong> value must be specified if the <strong>ListingType</strong> value is set to <code>LeadGeneration</code>.
This value indicates that the lead generation listing is a classifed ad. Note that only some eBay categories support classified ad listings. Use the <strong>GetCategoryFeatures</strong> call (with <strong>FeatureID</strong> value set to <code>AdFormatEnabled</code>) to see which categories support classified ad listings.
This value indicates that the lead generation listing is a US Motors Local Market listing. Note that only some eBay Motors categories support Motors Local Market listings. Use the <strong>GetCategoryFeatures</strong> call (with the <strong>SITEID</strong> header set to <code>100</code> and the <strong>FeatureID</strong> value set to <code>LocalMarketAdFormatEnabled</code>) to see which eBay Motors categories support Motors Local Market listings.
Reserved for internal or future use
This type 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 type is deprecated.
This field is deprecated.
This field is deprecated.
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 enumerated type contains the valid selling formats for eBay listings.
StoresFixedPrice, Dutch, Live, Express, Half, Shopping
Unknown or undefined auction type. Applicable to
user preferences and other informational use cases.
This value indicates an auction listing. In an auction listing, prospective buyers engage in a competitive bidding process, although Buy It Now may be offered as long as no bids have been placed. Auctions occur on the eBay marketplace site, and the auction listings will also appear in the seller's eBay Store (if the seller has an eBay Store).
<br><br>
Although listing durations may vary by eBay marketplace and category, typical listing durations for auctions are 3, 5, 7, and 10 days. It is recommended that the seller uses the <b>GetCategoryFeatures</b> call to retrieve the actual listing durations that are supported for auctions on a particular marketplace and category.
This value is no longer applicable.
This value is no longer applicable.
This enumeration value is only applicable to the <b>GetMyeBaySelling</b> call. This value is used in the <b>ActiveList.ListingType</b> field if the seller only wants to retrieve active listings that are in the auction format.
This enumeration value represents a classified ad in a Real Estate category. This listing type is only used to solicit inquiries from interested parties. To express interest, a buyer fills in a contact form that eBay forwards to the seller as a lead. This format does not enable buyers and sellers to transact online through eBay, and eBay Feedback is not available for ad format listings.
<br><br>
Although listing durations may vary by eBay marketplace and category, typical listing durations for real estate ads are 30 and 90 days. It is recommended that the seller uses the <b>GetCategoryFeatures</b> call to retrieve the actual listing durations that are supported for real estate ads on a particular marketplace and category.
This value is no longer applicable.
Second chance offer made to a non-winning bidder on an ended listing.
A seller can make an offer to a non-winning bidder when either the winning bidder
has failed to pay for an item or the seller has a duplicate of the item.
A seller can create a Second Chance Offer immediately after a listing ends and up to
60 days after the end of the listing.
<br/><br/>
eBay does not charge an Insertion Fee,
but if the bidder accepts the offer, the regular Final Value Fee is charged.
In the case of an Unpaid Item, the seller should ensure that everything has
been done to resolve the issue with the winning bidder before sending a
Second Chance Offer to another bidder.
<br/><br/>
See the Unpaid Items Process for details.
Make sure you're aware of other rules and restrictions surrounding Second Chance Offers.
Use <b>AddSecondChanceItem</b> to submit Second Chance Offers.
Listed on eBay, but does not appear when browsing or searching listings.
With this listing format, the selling is offering the item at a fixed price, although it is still possible for the seller to negotiate the price with prospective buyers using the Best Offer feature. A fixed-price listing can offer a single item, or if the seller has multiple quantity of the same item, multiple quantity of that same item can be made available for sale through the same listing. Additionally, the seller can set up a multiple-variation, fixed-price listing, where similar items can be sold through the same listing. An example of a multiple-variation, fixed-price listing might be a t-shirt (or another article of clothing) that is available in multiple color and size combinations.
<br><br>
Traditionally, listing durations for fixed-prices listings have varied by eBay marketplace and category. Typical listing durations for fixed-price listings ranged from three to 30 days, or GTC (Good 'Til Cancelled). As of April 1, 2019, 'GTC' is the only supported listing duration for all eBay marketplaces with the following exceptions:
<ul>
<li>The following eBay Motors US categories are exempt from this change: <em>Cars & Trucks</em> (6001), <em>Motorcycles</em> (6024), <em>Other Vehicles & Trailers</em> (6038), <em>Boats</em> (26429), <em>Powersports</em> (66466).</li>
<li>All child categories under <em>Cars, Motorcycles & Vehicles</em> (9800) categories on the eBay UK and eBay Italy sites are also exempt from this change. </li>
</ul>
<br>
With the 'GTC' listing duration, the listing will remain active as long as the listing shows that inventory is available for purchase (available quantity is '1' or more). For sellers listing motor vehicles on the eBay US Motors, eBay UK, or eBay Italy sites, it is recommended that the seller uses the <b>GetCategoryFeatures</b> call to retrieve the supported listing durations for their particular marketplace and category.
<br>
<br>
<span class="tablenote"><b>Note: </b> For active fixed-price listings with listing durations other than 'GTC', sellers do not have to take any action. For listings that are automatically renewed by eBay, the renewed listings will automatically be set to 'GTC'. For any listings that are relisted by the seller, the only listing duration value that will be accepted is 'GTC'.
</span>
<br>
<span class="tablenote"><b>Note: </b>
As of July 1, 2019, the Good 'Til Cancelled renewal schedule has been modified from every 30 days to once per calendar month. For example, if a GTC listing is created July 5, the next monthly renewal date will be August 5. If a GTC listing is created on the 31st of the month, but the following month only has 30 days, the renewal will happen on the 30th in the following month. Finally, if a GTC listing is created on January 29-31, the renewal will happen on February 28th (or 29th during a 'Leap Year'). See the
<a href="https://pages.ebay.com/seller-center/seller-updates/2019-spring/marketplace-updates.html#good-til-cancelled" target="_blank">Good 'Til Cancelled listings update</a> in the <b>Spring 2019 Seller Updates</b> for more information about this change.
</span>
<span class="tablenote"><b>Note: </b> This listing type is no longer applicable as the Half.com site has been shut down.
</span>
This enumeration value represents a (non-Real Estate) classified ad listing. The <code>AdType</code> enumeration value represents Real Estate classified ads. This listing type is only used to solicit inquiries from interested parties. To express interest, a buyer fills in a contact form that eBay forwards to the seller as a lead. This format does not enable buyers and sellers to transact online through eBay, and eBay Feedback is not available for ad format listings. Non-Real Estate classified ads are only available in a limited number of eBay categories, including Business and Industrial categories, Travel, ans Specialty Services.
<br><br>
Although listing durations may vary by eBay marketplace and category, typical listing durations for (non-Real Estate) classified ads are 30, 60, and 90 days. It is recommended that the seller uses the <b>GetCategoryFeatures</b> call to retrieve the actual listing durations that are supported for real estate ads on a particular marketplace and category.
This value is no longer applicable.
This value is no longer applicable, as Shopping.com is no longer a property of eBay, Inc.
Reserved for internal or future use.
Defines the LocalListingDistancesNonSubscription feature. This feature displays all the supported local
listing distances for items listed by sellers who have not subscribed to either Local Market for Vehicles
or Local Market for Specialty Vehicles.
Defines the LocalListingDistancesRegular feature. This feature displays all the supported local listing
distances for items listed by sellers subscribed to Local Market for Vehicles.
Defines the LocalListingDistancesSpecialty feature. This feature displays the supported local listing
distances for items listed by sellers subscribed to Local Market for Specialty Vehicles.
Defines the AdFormatEnabled feature. If the field is present, the corresponding feature applies to the category. This field is returned as an empty element (e.g., a boolean value is not returned).
Added for Local Market users.
Indicates whether automatic acceptance of Best Offers is allowed for this category for Motors Local Market listings. Returned only if this category overrides the site default.
Indicates whether automatic declination of Best Offers is allowed for this category for Motors Local Market listings. Returned only if this category overrides the site default.
Indicates whether Contact Seller is enabled for Classified Ads.
Added for Local Market users.
Indicates whether the category supports the use of the company name to contact
the seller for Classified Ad format listings. Added for Local Market users.
Indicates whether the category supports using an address when
contacting the seller for Classified Ad format listings.
Added for Local Market users.
Indicates whether the category supports the use of email to contact the
seller for Classified Ad format listings.Added for Local market users.
Indicates whether the category supports using the telephone
as a contact method.
Added for Local Market users.
Indicates whether counter offers to Best Offers are allowed for this category for Motors Local Market listings. Returned only if this category overrides the site default.
Defines the LocalMarketNonSubscription feature. If the field is present,
the corresponding feature applies to the category. The field is returned
as an empty element (i.e., a boolean value is not returned).
Indicates whether the category supports the use of payment method checkOut
for Classified Ad format listings. Added for Local market users.
Indicates which phone option the category supports when contacting
the seller about listings in Classified Ad format.
Added for Local Market users.
Defines the LocalMarketPremiumSubscription feature. If this field is
present, the corresponding feature applies to the category. The field
is returned as an empty element (i.e., a boolean value is not returned).
Defines the LocalMarketRegularSubscription feature. If this field
is present, the corresponding feature applies to the category. The
field is returned as an empty element (i.e., a boolean value is not
returned). A subscription for Local Market for Vehicles will be
returned by GetUser if a dealer has subscribed to any of the following
Local Market Regular sub-types: Vehicles Regular Six Months,
Vehicles Regular Special Promotion, Vehicles Regular Multistore
Level S, Vehicles Regular Multistore Level M, or Vehicles Regular
Multistore Level L. Each of these sub-types has a separate discount
and billing cycle.
Defines the SellerContactDetailsEnabled feature. If the field is
present, the category allows retrieval of seller-level contact
information. The field is returned as an empty element
(e.g., a boolean value is not returned).
Added for Local Market users.
Indicates if shipping options are available for Classified Ad
format listings in the category.
Added for Local Market users.
Defines the LocalMarketSpecialitySubscription feature. If this field
is present, the corresponding feature applies to the category. The field is returned as an empty element (i.e., a boolean value is not returned).
Indicates which address option the category supports for Classified Ad
format listings.
Added for Local Market users.
This type is deprecated.
This field is deprecated.
This field is deprecated.
This enumerated type is used by <b>OrderType</b> and <b>TransactionType</b> to indicate which logistics plan was selected by the buyer at the order or order line item level. Currently, this type is only supporting the "Click and Collect" and digital gift card use cases, but more logistics plan types may be added in the future.
This value indicates that the buyer has selected "Click and Collect" as the logistics plan. With the 'Click and Collect' feature, a buyer can purchase certain items on eBay and collect them at a local store. Buyers are notified by eBay once their items are available. The "Click and Collect" feature is only available to large merchants on the eBay UK (site ID - 3), eBay Australia (Site ID - 15), and eBay Germany (Site ID - 77) sites.
This value indicates that the order or order line item is a digital gift card that will be delivered to the buyer or the recipient of the gift card by email.
This value is reserved for internal or future use.
This enumerated type is deprecated.
This field is deprecated.
This field is deprecated.
This field is deprecated.
This field is deprecated.
This type is deprecated.
773
NoOp
889
Item.ConditionID
This field is deprecated.
This type is deprecated.
773
NoOp
889
Item.ConditionID
This field is deprecated.
This field is deprecated.
This enumerated type is deprecated.
This field is deprecated.
This field is deprecated.
This field is deprecated.
This field is deprecated.
Describes an individual mark-up or mark-down event. eBay will automatically
mark an application as down if attempts to deliver a notification fail
repeatedly. eBay may mark an application down manually under certain
circumstances.
Whether the application has been marked up or marked down.
GetNotificationsUsage
Conditionally
Time when the application was marked up or marked down.
GetNotificationsUsage
Conditionally
Describes how the application was marked down, automatically or
manually. When an application is automatically marked down, eBay will
ping the application periodically, and if communication is restored, eBay
will automatically mark the application up. If your application is marked
down manually, you must contact eBay Developer Support to get your
application marked up. A Reason is not provided for mark up events.
GetNotificationsUsage
Conditionally
Valid application status codes, either MarkUp (application was marked up,
communication is restored) or MarkDown (application was marked down, no
communication).
Status indicating the application was or is marked up.
Status indicating the application was marked down.
Reserved for future internal or external use.
List of objects representing markup or markdown events for a given application
and time period. If no time period is specified in the request, the information
for only one day (24 hours before the time the call is made to the time the call
is made) is included. The maximum time period is allowed is 3 days (72 hours
before the call is made to the time the call is made).
Details for a MarkDown or MarkUp event.
GetNotificationsUsage
Conditionally
Type used by the <b>MaxFlatShippingCostCBTExempt</b> field that is returned under the <b>FeatureDefinitions</b> container. The <b>MaxFlatShippingCostCBTExempt</b> field is returned as empty and indicates that a maximum flat-rate shipping cost is not imposed by the corresponding eBay site if the item is being shipped internationally. This field will not be returned if one or more <b>FeatureID</b> fields are included in the call request and <b>MaxFlatShippingCostCBTExempt</b> is not one of the values passed into those <b>FeatureID</b> fields.
Type used by the <b>MaxFlatShippingCost</b> field that is returned under the <b>FeatureDefinitions</b> container. The <b>MaxFlatShippingCost</b> field is returned as empty and indicates that a maximum flat-rate shipping cost threshold is enforced for some categories on the corresponding eBay site. This field will not be returned if one or more <b>FeatureID</b> fields are included in the call request and <b>MaxFlatShippingCost</b> is not one of the values passed into those <b>FeatureID</b> fields.
Type used by the <b>MaxGranularFitmentCount</b> field that is returned under the <b>FeatureDefinitions</b> container. The <b>MaxGranularFitmentCount</b> field is returned as empty and indicates that a maximum parts compatibility threshold is applicable to some motor vehicle parts and accessory categories on the corresponding eBay site. This field will not be returned if one or more <b>FeatureID</b> fields are included in the call request and <b>MaxGranularFitmentCount</b> is not one of the values passed into those <b>FeatureID</b> fields.
Defines the maximum limit on compatible applications as part of the parts
compatibility feature. If the field is present, the corresponding feature applies
to the site. The field is returned as an empty element (e.g., a boolean value is
not returned).
<br><br>
Parts compatibility listings contain information to determine the assemblies with
which a part is compatible. For example, an automotive part or accessory listed
witih parts compatibility can be matched with vehicles (e.g., specific years,
makes, and models) with which the part or accessory can be used.
<br><br>
There are two ways to enter parts compatibility: by application and by
specification.
<ul>
<li> Entering parts compatibility by application specifies the assemblies
(e.g., a specific year, make, and model of car) to which the item applies. This can
be done automatically by listing with a catalog product that supports parts
compatibility, or manually, using <b
class="con">Item.ItemCompatibilityList</b> when listing or revising an
item. </li>
<li>Entering parts compatibility by specification involves specifying the
part's relevant dimensions and characteristics necessary to determine the
assemblies with which the part is compatible (e.g., Section Width, Aspect Ratio,
Rim Diammeter, Load Index, and Speed Rating values for a tire) using
attributes.</li>
</ul>
Although the <b>MaximumBuyerPolicyViolations</b> container is still returned in <b>GeteBayDetails</b>, a Maximum Buyer Policy Violations threshold value can no longer be set at the account or listing level, so this type is no longer applicable.
As a Maximum Buyer Policy Violations threshold value can no longer be set at the account or listing level, this field is no longer applicable.
GeteBayDetails
Conditionally
As a Maximum Buyer Policy Violations threshold value can no longer be set at the account or listing level, this field is no longer applicable.
GeteBayDetails
Conditionally
This type is deprecated as sellers can no longer set a buyer policy violation threshold Buyer Requirement at the listing-level in Add/Revise/Relist calls.
This field is deprecated.
4
1065
NoOp
1065
This field is deprecated.
Days_30
1065
NoOp
1065
This type is used by the <b>MaximumItemRequirements</b> container that is returned under the <b>BuyerRequirementDetails</b> in the <b>GeteBayDetails</b>. The Maximum Item Requirement settings of Buyer Requirements allow a seller to restrict the quantity of a line item that may be purchased during a consecutive 10-day period.
Values returned in this field indicate the maximum quantity of an order line item that one buyer can purchase during a consecutive 10-day period.
GeteBayDetails
Conditionally
A Minimum Feedback Score threshold can be added to the Maximum Item Requirement rule if the seller only wishes to restrict possible buyers with low Feedback scores. The values returned in this field indicate the minimum Feedback Score thresholds that can be used.
GeteBayDetails
Conditionally
Type used by the <b>MaximumItemRequirements</b> container to specify the maximum quantity of an order line item that a prospective buyer may purchase during any given 10-day period.
This field is conditionally required if the <b>MaximumItemRequirements</b>
container is used.
<br/><br/>
The value of this field specifies the maximum quantity of an order line item that a prospective buyer may
purchase from the seller during any given 10-day period. The prospective buyer will be blocked
from bidding/buying once this value is reached.
<br/><br/>
<b>Valid values
for the US site:</b> 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 25, 50, 75, and 100.
<br/>
To see the valid values for your site, call <b>GeteBayDetails</b>
with <b>DetailName</b> set to <b>BuyerRequirementDetails</b>,
and then look for the <b>BuyerRequirementDetails.MaximumItemRequirements.MaximumItemCount</b> fields.
<br/><br/>
If the <b>MaximumItemRequirements.MinimumFeedbackScore</b> field is also
specified, the <b>MaximumItemCount</b> limit will only apply to those
prospective buyers who don't meet the specified Minimum Feedback Score threshold.
Buyers Who May Bid on Several of My Items and Not Pay
http://pages.ebay.com/help/sell/contextual/understand-buyer-requirement.html
AddFixedPriceItem
AddItem
AddItems
AddSellingManagerTemplate
RelistFixedPriceItem
RelistItem
ReviseFixedPriceItem
ReviseItem
ReviseSellingManagerTemplate
VerifyAddItem
VerifyRelistItem
Conditionally
GetBidderList
GetSellerList
Conditionally
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription,
ItemReturnAttributes, ReturnAll
Conditionally
This is an optional field that is ignored if a <b>MaximumItemCount</b>
value has not been provided.
<br><br>
If this field is used, a prospective buyer is blocked from bidding/buying if they have
reached or exceeded the <b>MaximumItemCount</b> and their feedback score
is less than the value of this field.
<br/><br/>
<b>Valid values for the US site:</b> 0, 1, 2, 3, 4, and 5.
<br/>
To see the valid values for your site, call <b>GeteBayDetails</b>
with <b>DetailName</b> set to <b>BuyerRequirementDetails</b>,
and then look for the <b>BuyerRequirementDetails.MaximumItemRequirements.MinimumFeedbackScore</b> fields.
AddFixedPriceItem
AddItem
AddItems
AddSellingManagerTemplate
RelistFixedPriceItem
RelistItem
ReviseFixedPriceItem
ReviseItem
ReviseSellingManagerTemplate
VerifyAddItem
VerifyRelistItem
No
GetBidderList
GetSellerList
Conditionally
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription,
ItemReturnAttributes, ReturnAll
Conditionally
Type defining the <b>MaximumUnpaidItemStrikesCount</b> container that is returned
in the <b>GeteBayDetails</b> response. The <b>MaximumUnpaidItemStrikesCount</b>
container consists of multiple <b>Count</b> fields with values that can be
used in the <b>BuyerRequirementDetails.MaximumUnpaidItemStrikesInfo.Count</b>
field when using the Trading API to add, revise, or relist an item.
<br><br>
The <b>Item.MaximumUnpaidItemStrikesInfo</b> container in Add/Revise/Relist
API calls is used to block buyers with unpaid item strikes equal to or exceeding
the specified <b>Count</b> value during the specified <b>Period</b>
value from buying/bidding on the item.
GeteBayDetails
Conditionally
Each value returned in each <b>MaximumUnpaidItemStrikesCount.Count</b> field
can be used in the <b>BuyerRequirementDetails.MaximumUnpaidItemStrikesInfo.Count</b>
field when using the Trading API to add, revise, or relist an item.
GeteBayDetails
Conditionally
Type used by the <b>MaximumUnpaidItemStrikesDuration</b> container that is returned in <b>GeteBayDetails</b>. The <b>MaximumUnpaidItemStrikesDuration</b> container indicates the periods of time that can be used when evaluating how many unpaid item strikes against a buyer during this given period will exclude the prospective buyer from purchasing the line item.
GeteBayDetails
Conditionally
The period is the number of days (last 60 days, last 180 days, etc.)
during which the buyer's unpaid item strikes are calculated.
This is applicable only to sellers.
GeteBayDetails
Conditionally
The description of the period, such as 'month', 'quarter', or 'half a year'.
The data in this field can be used as a label in your application's display.
This is applicable only to sellers.
GeteBayDetails
Conditionally
Details of a buyer's maximum unpaid item strikes in a pre-defined time period. This is applicable only to sellers.
The number of the maximum unpaid item strikes. This is applicable only to sellers.
GeteBayDetails
Conditionally
Range of time used to determine maximum unpaid item count. This is applicable only to sellers.
GeteBayDetails
Conditionally
Type defining the <b>MaximumUnpaidItemStrikesInfo</b> container, which is
used by the seller as a mechanism to block prospective buyers who have unpaid item
strikes on their account exceeding the value set in the <b>Count</b>
field during a specified time period (set in the <b>Period</b> field).
This integer value sets the maximum number of unpaid item strikes that a prospective buyer
is allowed to have during a specified time period
(<b>MaximumUnpaidItemStrikesInfo.Period</b>) before being blocked from
buying/bidding on the item.
<br><br>
To retrieve a list of allowed values for this field, the seller should call
<b>GeteBayDetails</b>, including <b>BuyerRequirementDetails</b> in
the <b>DetailName</b> field of the request, and then look for the
<b>BuyerRequirementDetails.MaximumUnpaidItemStrikesInfo.MaximumUnpaidItemStrikesCount.Count</b>
fields in the response.
<br>
2
AddItem
AddFixedPriceItem
AddItems
AddSellingManagerTemplate
RelistItem
ReviseItem
ReviseSellingManagerTemplate
VerifyAddItem
VerifyRelistItem
2, 3, 4, 5
Conditionally
GetBidderList
GetSellerList
2, 3, 4, 5
Conditionally
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
2, 3, 4, 5
Conditionally
This enumerated value defines the length of time over which a prospective buyer's
unpaid item strikes will be counted. If the prospective buyer's number of unpaid item
strikes during this defined period exceeds the value set in the <b>Count</b>
field, that prospective buyer is blocked from buying/bidding on the item.
<br/><br/>
If the <b>Count</b> value is 2, and the specified <b>Period</b>
is 'Days_30' (counting back 30 days from the present day), any prospective buyer that has
had three or more unpaid item strikes is blocked from buying/bidding on the item.
<br>
Days_30
AddItem
AddFixedPriceItem
AddItems
AddSellingManagerTemplate
RelistItem
ReviseItem
ReviseSellingManagerTemplate
VerifyAddItem
VerifyRelistItem
Days_30, Days_180, Days_360
Conditionally
GetBidderList
GetSellerList
Days_30, Days_180, Days_360
Conditionally
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Days_30, Days_180, Days_360
Conditionally
Type is used by the <b>MemberMessage</b> container that is returned in the <b>GetMemberMessages</b> and <b>GetAdFormatLeads</b> calls. The <b>MemberMessage</b> container will consists of one or more member messages that meet the input criteria in the call request.
Each <b>MemberMessageExchange</b> container consists of detailed information about a member-to-member message.
GetAdFormatLeads
DetailLevel: ReturnAll
Conditionally
GetMemberMessages
Conditionally
Container for message metadata.
The item about which the question was asked. Returned if the parent container is returned.
GetMemberMessages
Conditionally
Contains all the information about the question being asked. Returned if the
parent container is returned.
GetAdFormatLeads
DetailLevel: ReturnAll
Conditionally
GetMemberMessages
Conditionally
An answer to the question. Returned if the parent container is returned.
<br/><br/>
For GetAdFormatLeads, returned if the seller responded to the
lead's question. Contains the body of the seller's response
message.
GetAdFormatLeads
DetailLevel: ReturnAll
Conditionally
GetMemberMessages
Conditionally
Status of the message. Returned if the parent container is returned.
GetMemberMessages
Conditionally
Date the message was created. Returned if the parent container is returned.
GetAdFormatLeads
DetailLevel: ReturnAll
Conditionally
Date the message was last modified. Returned if the parent container is returned.
GetMemberMessages
Conditionally
Media details stored as part of the message.
GetMemberMessages
Conditionally
Container for individual message information.
Type of message being retrieved. Note that some message
types can only be created via the eBay Web site.
GetMemberMessages
Conditionally
Context of the question (e.g. Shipping, General).
AddMemberMessageAAQToPartner
Yes
GetMemberMessages
Conditionally
Indicates if a copy of the messages is to be emailed
to the sender. If omitted, this defaults to whatever
the user set in preferences.
omitted
AddMemberMessageAAQToPartner
AddMemberMessageRTQ
AddMemberMessagesAAQToBidder
No
This field is deprecated.
579
655
NoOp
Indicates if the member message is viewable in the item listing.
AddMemberMessageRTQ
No
GetMemberMessages
Conditionally
The eBay user ID of the person who asked the question or sent
the message.
GetMemberMessages
Conditionally
SenderEmail contains the static email address of an eBay member,
used within the "reply to"
email address when the eBay member sends a message.
(Each eBay member is assigned a static alias. The alias is
used within a static email address.)
SenderEmail is returned if MessageType is AskSellerQuestion.
SenderEmail is also returned in the AskSellerQuestion notification.
The following functionality of this field has been deprecated:
return of a dynamic email address.
GetMemberMessages
Conditionally
Recipient's eBay user ID. For
AddMemberMessagesAAQToBidder, it must be the seller of an
item, that item's bidder, or a user who has made an
offer on that item using Best Offer. Note: maxOccurs is a shared schema
element and needs to be unbounded for AddMemberMessagesAAQToBidder.
For AddMemberMessageRTQ, this field is mandatory if ItemID is not in the request.
For all other uses, there can only be one RecipientID.
AddMemberMessageAAQToPartner
AddMemberMessageRTQ
AddMemberMessagesAAQToBidder
Yes
AddMemberMessageRTQ
GetMemberMessages
Conditionally
Subject of this email message.
GetMemberMessages
Conditionally
AddMemberMessageAAQToPartner
Yes
Content of the message is input into this string field. HTML formatting is not
allowed in the body of the message. If plain HTML is used, an error occurs and the
message will not go through. If encoded HTML is used, the message may go through but
the formatting will not be successful, and the recipient of the message will just
see the HTML formatting tags.
2000
AddMemberMessageAAQToPartner
AddMemberMessageRTQ
Yes
1000
AddMemberMessagesAAQToBidder
Yes
GetAdFormatLeads
DetailLevel: ReturnAll
Conditionally
4000
GetMemberMessages
Conditionally
ID that uniquely identifies a message for a given user.
<br><br>
This value is not the same as the value used for the
GetMyMessages MessageID. However, this MessageID value can be
used as the GetMyMessages ExternalID.
GetMemberMessages
Conditionally
ID number of the question to which this message is responding.
AddMemberMessageRTQ
Yes
Media details attached to the message.
AddMemberMessageAAQToPartner
AddMemberMessageRTQ
AddMemberMessageCEM
AddMemberMessageAAQToSeller
No
GetMemberMessages
Conditionally
Type used by the <b>Program</b> container that is returned in the response of the <b>GetUser</b> call if the seller is enrolled in one or more eBay membership programs, such as eBay Plus. The <b>Program</b> container provides the eBay site, program (such as '<code>EBAYPLUS</code>'), and the membership expiration date.
<br/><br/>
<span class="tablenote"><b>Note:</b> Currently, eBay Plus is available only to buyers in Germany, Austria, and Australia marketplaces in the near future.
</span>
This value indicates the name of the membership program, such as <code>EBAYPLUS</code>. This field will always be returned with each <b>Program</b> container.
GetUser
DetailLevel: none,ReturnAll
Conditionally
This enumeration value indicates the eBay site for which the seller is enrolled in a membership program. This field will always be returned with each <b>Program</b> container.
GetUser
DetailLevel: none,ReturnAll
Conditionally
This dateTime value is the expiration date of the seller's membership within the program specified in the <b>ProgramName</b> field. This field will always be returned with each <b>Program</b> container.
GetUser
DetailLevel: none,ReturnAll
Conditionally
Type used by the <b>Membership</b> container that is returned in the response of the <b>GetUser</b> call if the seller is enrolled in one or more eBay membership programs such as eBay Plus.
<br/><br/>
<span class="tablenote"><b>Note:</b> Currently, eBay Plus is available only to buyers in Germany, Austria, and Australia marketplaces in the near future.
</span>
A <b>Program</b> container will be returned for each eBay membership program for which the seller is enrolled. This container provides the the eBay site, the membership program (such as '<code>EBAYPLUS</code>'), and the membership expiration date.
GetUser
DetailLevel: none,ReturnAll
Conditionally
This type is deprecated.
This value is not used.
This value is not used.
This value is not used.
This enumerated type is deprecated.
This value is not used.
This value is not used.
This value is not used.
Container for the image file that is to be sent in a message, which lets sellers share photos in messages using the API.
The photo must be uploaded by the seller or buyer to
<a href="http://developer.ebay.com/devzone/xml/docs/reference/ebay/uploadsitehostedpictures.html">EPS (eBay Picture Services)</a>
using a separate API call or the web flow. After the image is on the eBay server, you can
use <b>AddMemberMessage</b> calls to pass the URL of the image in a message. The
uploaded images will be available as part of the email as a thumbnail image.
Clicking on the thumbnail, opens a larger version of the image in a filmstrip.
The image name will be displayed on the title of the filmstrip component.
These uploaded images will also be returned as <b>MessageMediaType</b> arrays in the
<b>GetMemberMessages</b> and <b>GetMyMessages</b> API response. It doesn't matter if an image was uploaded using the web flow or using the API, it can be accessed using either the web flow or the API and web.
URL of an image to be included in a message.
The image must be uploaded to
<a href="http://developer.ebay.com/devzone/xml/docs/reference/ebay/uploadsitehostedpictures.html">EPS
(eBay Picture Services)</a>
using a separate API call or the web flow. This URL will be
validated and if it doesn't exist, the request will fail.
200
AddMemberMessageAAQToPartner
AddMemberMessageRTQ
Conditionally
GetMemberMessages
GetMyMessages
Conditionally
The name of the image. This will be displayed on the flimstrip.
100
AddMemberMessageAAQToPartner
AddMemberMessageRTQ
Conditionally
GetMemberMessages
GetMyMessages
Conditionally
This enumerated type is used to indicate whether or not a question has been answered.
The question has been answered at least once.
The question has not yet been answered.
Reserved for future or internal use.
Member to Member message initiated by bidder/potential bidder
to a seller of a particular item.
Member to Member message initiated as a response
to an Ask A Question message.
Member to Member message initiated by any eBay member
to another eBay member.
Member message between order partners within 90 days
after creation of the order.
Member to Member message initiated as a response
to a Contact eBay Member message.
Reserved
Member to Member message initiated by any eBay member
to another eBay member who has posted on a community forum
within the past 7 days.
Reserved
Reserved for future or internal use.
All message types.
Member to Member message initiated by sellers to their
bidders during an active listing.
Reserved
Member message initiated after eBay receives an email sent by an
eBay member's email client to another eBay member.
Indicates that an inquiry has been sent to the seller regarding the
corresponding classified ad listing.
Indicates that a Best Offer has been made on the seller's corresponding
classified ad listing. This message type is only applicable to Classified
categories that allow the Best Offer feature, such as motor vehicles.
This type is used by the <b>Metadata</b> container to provide price guidance information, which includes the minimum and maximum recommended prices for the item, which are based on recent sales of similar items.
The name of the price guidance parameter is returned in this field. Any of the following price guidance parameters may be returned in a <b>Metadata</b> container:
<ul>
<li><b>AppliesTo</b>: this parameter indicates the type of listing that the <b>MaxRecommendedValue</b> and <b>MinRecommendedValue</b> values pertain to. The corresponding <b>value</b> values that can be returned with the <b>AppliesTo</b> parameter is 'Auction' and 'FixedPrice'. </li>
<li><b>Currency</b>: this parameter indicates the type of currency being used for the <b>MaxRecommendedValue</b> and <b>MinRecommendedValue</b> values. The currency values (returned in corresponding <b>value</b> field) are based on the currency codes defined in the <a href="http://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO 4217 - Currency Codes</a> standard. </li>
<li><b>MaxRecommendedValue</b>: this parameter indicates the upper end of the recommended price range for the item. Based on the recent sales of similar items, eBay recommends a price range through the <b>MaxRecommendedValue</b> and <b>MinRecommendedValue</b> parameters. A dollar value is returned in the corresponding <b>value</b> field. </li>
<li><b>MinRecommendedValue</b>: this parameter indicates the lower end of the recommended price range for the item. Based on the recent sales of similar items, eBay recommends a price range through the <b>MaxRecommendedValue</b> and <b>MinRecommendedValue</b> parameters. A dollar value is returned in the corresponding <b>value</b> field. </li>
<li><b>SimilarItems</b>: this parameter and its corresponding <b>value</b> values indicates which eBay item listings were used to determine the <b>MinRecommendedValue</b> and <b>MaxRecommendedValue</b> values. The values returned in the <b>value</b> fields are Item IDs.</li>
</ul>
AddFixedPriceItem
AddItem
AddItems
RelistFixedPriceItem
RelistItem
ReviseFixedPriceItem
ReviseItem
VerifyAddItem
VerifyAddFixedPriceItem
VerifyRelistItem
Conditionally
The corresponding value(s) for the price guidance parameter (returned in <b>Name</b> field of the same <b>Metadata</b> container. For the <b>AppliesTo</b> parameter, this value will either be 'Auction' or 'FixedPrice'. For the <b>Currency</b> parameter, this value will be a three-digit representation of a currency (as defined in the <a href="http://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO 4217 - Currency Codes</a> standard). For the <b>MaxRecommendedValue</b> and <b>MinRecommendedValue</b> parameters, this value will be a dollar value. For the <b>SimilarItems</b> parameters, this value will be an Item ID value, and it's possible that numerous Item IDs will be returned.
AddFixedPriceItem
AddItem
AddItems
RelistFixedPriceItem
RelistItem
ReviseFixedPriceItem
ReviseItem
VerifyAddItem
VerifyAddFixedPriceItem
VerifyRelistItem
Conditionally
Defines the minimum requirement for compatible applications as part of the parts
compatibility feature. If the field is present, the corresponding feature applies
to the site. The field is returned as an empty element (e.g., a boolean value is
not returned).
<br><br>
Parts compatibility listings contain information to determine the assemblies with
which a part is compatible. For example, an automotive part or accessory listed
witih parts compatibility can be matched with vehicles (e.g., specific years,
makes, and models) with which the part or accessory can be used.
<br><br>
There are two ways to enter parts compatibility: by application and by
specification.
<ul>
<li> Entering parts compatibility by application specifies the assemblies
(e.g., a specific year, make, and model of car) to which the item applies. This can
be done automatically by listing with a catalog product that supports parts
compatibility, or manually, using <b
class="con">Item.ItemCompatibilityList</b> when listing or revising an
item. </li>
<li>Entering parts compatibility by specification involves specifying the
part's relevant dimensions and characteristics necessary to determine the
assemblies with which the part is compatible (e.g., Section Width, Aspect Ratio,
Rim Diammeter, Load Index, and Speed Rating values for a tire) using
attributes.</li>
</ul>
This enumerated type defines the special price treatments that can be set up for listings enabled with the Minimum Advertised Price feature. The Minimum Advertised Price (MAP) feature is only supported on the eBay US site.
This enumeration value indicates that the buyer must add the item to his/her cart before the discounted price can be displayed. To enable this pricing treatment when adding/revising/relisting an item, include the <b>DiscountPriceInfo.MinimumAdvertisedPriceExposure</b> field in an Add/Revise/Relist calls and set its value to <code>PreCheckout</code>.
This enumeration value indicates that the discounted price will only be shown to the buyer once the buyer reaches the eBay Checkout page. To enable this pricing treatment when adding/revising/relisting an item, include the <b>DiscountPriceInfo.MinimumAdvertisedPriceExposure</b> field in an Add/Revise/Relist calls and set its value to <code>DuringCheckout</code>.
This enumeration value indicates that the discounted price is shown on the View Item page, and the buyer is not required to add the item to his/her cart or click Buy button to view the discounted price. To enable this pricing treatment when adding/revising/relisting an item, include the <b>DiscountPriceInfo.MinimumAdvertisedPriceExposure</b> field in an Add/Revise/Relist call and set its value to <code>None</code>.
Reserved for future use.
Type defining the <b>MinimumFeedbackScore</b> container that is returned in <b>GeteBayDetails</b>. The <b>MinimumFeedbackScore</b> container consists of the values that can be used as the threshold value for a buyer's Minimum Feedback Score in Buyer Requirements. The Feedback Score for a potential buyer must be greater than or equal to the specified value, or that buyer is blocked from buying the item. <br/><br/> For the <b>MinimumFeedbackScore</b> container to appear in the <b>GeteBayDetails</b> response, <b>BuyerRequirementDetails</b> must be one of the values passed into the <b>DetailName</b> field in the <b>GeteBayDetails</b> request (or, no <b>DetailName</b> filters should be used).
<br><br>
<span class="tablenote"><b>Note:</b> Although the <b>MinimumFeedbackScore</b> container is still returned in <b>GeteBayDetails</b>, sellers can no longer set a buyer's Minimum Feedback Score threshold Buyer Requirement at the listing-level in Add/Revise/Relist calls.
</span>
Each value that is returned in this field can be used as an account-level Minimum Feedback Score. Sellers can no longer set a buyer's Minimum Feedback Score threshold Buyer Requirement at the listing-level in Add/Revise/Relist calls. The Feedback Score for a potential buyer must be greater than or equal to the specified value in the seller's account settings, or that buyer is blocked from buying the item. <br/><br/> One or more <b>FeedbackScore</b> fields are always returned with the <b>MinimumFeedbackScore</b> container.
1065
NoOp
1065
Defines the Minimum Reserve Price feature. If the field is present, the feature applies to the category. The field is returned as an empty element (i.e., a boolean value is not returned).
This enumerated type is deprecated.
This value is not used.
This value is not used.
(out) Reserved for internal or future use
This enumerated type defines the values that can be used when adding, modiying, or
deleting a shipping discount profile (through the <b>ModifyActionCode</b>
field in <b>SetShippingDiscountProfiles</b>), or when adding, modiying, or
deleting a promotional sale (through the <b>Action</b>
field in <b>SetPromotionalSale</b>), or when adding or removing one or more
listings from the promotional sale (through the <b>Action</b>
field in <b>SetPromotionalSaleListings</b>).
<br/><br/>
For <b>SetPromotionalSaleListings</b>, the specified action ('Add' or
'Delete') will apply to all listings specified in the <b>PromotionalSaleItemIDArray</b>
container. A promotional sale can also be applied to all listings of a specified
category (using <b>CategoryID</b> in the
<b>SetPromotionalSaleListings</b> request). However, an entire category
of listings cannot be removed from a promotional sale. In other words, the
<b>Action </b> field cannot be set to 'Delete' if a
<b>CategoryID</b> is specified.
For <b>SetPromotionalSale</b>, this value is used in the request to
create a new promotional sale.
<br/><br/>
For <b>SetPromotionalSaleListings</b>, this value is used in the request
to apply an existing promotional sale to one or more active items or to an entire
category of active items.
<br/><br/>
For <b>SetShippingDiscountProfiles</b>, this value is used in the request
to create a new shipping discount profile.
For <b>SetPromotionalSale</b>, this value is used in the request to
delete an existing promotional sale.
<br/><br/>
For <b>SetPromotionalSaleListings</b>, this value is used in the request
to remove one or more active items from an existing promotional sale. This value
cannot be used if a <b>CategoryID</b> is specified in the request.
<br/><br/>
For <b>SetShippingDiscountProfiles</b>, this value is used in the request
to delete an existing shipping discount profile.
For <b>SetPromotionalSale</b>, this value is used in the request to
modify an existing promotional sale.
<br/><br/>
For <b>SetShippingDiscountProfiles</b>, this value is used in the request
to modify an existing shipping discount profile.
Reserved for future use.
This type is used by the <b>ModifyNameList</b> container in a <b>ReviseFixedPriceItem</b> or <b>RelistFixedPriceItem</b> call to rename one or more Variation Specific names for a multiple-variation listing.
A <b>ModifyName</b> container is needed for each Variation Specific name that the seller wishes to change in a multiple-variation listing.
<br><br>
You cannot change the name of an Item Specific that is required for the listing category. Use the <b>GetCategoryFeatures</b> or <b>GetCategorySpecifics</b> calls to determine which Item Specifics names are required for a category.
<br><br>
To get a current list of Variation Specifics defined for a multiple-variation listing, the seller can use <b>GetItem</b>, and then view all Variation Specific names in the <b>VariationSpecificsSet</b> container in the response.
RelistFixedPriceItem
ReviseFixedPriceItem
No
5
Type used by the <b>ModifyName</b> container in a <b>ReviseFixedPriceItem</b> or <b>RelistFixedPriceItem</b> call to rename a Variation Specific name for a multiple-variation listing. A <b>ModifyName</b> container is needed for each Variation Specific name that the seller wishes to change the name of in a multiple-variation listing.
In this field, the seller identifies the current name (e.g., Material) of a Variation Specific in the active listing that the seller wishes to change. If this field is used, the <b>NewName</b> field must also be specified.
<br>
40
ReviseFixedPriceItem
RelistFixedPriceItem
Conditionally
In this field, the seller states the new name of the Variation Specific (e.g., Fabric).
<br>
<br>
In addition to changing a Variation Specific name through the <b>ModifyName</b> container, the seller must also include the new Variation Specific name (and its available values) in the <b>VariationSpecificsSet</b> container, and omit the original name.
<br>
<br>
Note that variations that were sold while they used the old name will also be changed to use the new name in eBay's system.
<br>
<br>
If you are making other changes to a variation (such as adding new
values or pictures), use consistent names to avoid unexpected
results. For example, specify the same new name to identify the
Variation Specific in the <b>Pictures</b> container and in the <b>VariationSpecifics</b> containers for each variation within the listing.
<br>
40
RelistFixedPriceItem
ReviseFixedPriceItem
Conditionally
Defines the Motors Local Market feature. If the Motors Local Market field is present, the corresponding feature applies to the Motors Local Market category. The field is returned as an empty element (e.g., a boolean value is not returned).
This type provides information about the shipping service, cost, address, and delivery estimates for the domestic leg of a Global Shipping Program shipment. This type is only applicable for international shipments using the GSP program.
Contains information about the shipping service and cost of the domestic leg of a Global Shipping Program shipment.
GetOrders
DetailLevel: none, ReturnAll
Conditionally
OrderReport
Conditionally
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ReturnAll
Conditionally
Contains shipping address information for the domestic leg of a Global Shipping Program shipment. This container includes the ReferenceID field, which can be printed on the package to give the international shipping provider a unique identifier for the order.
GetOrders
DetailLevel: none, ReturnAll
Conditionally
OrderReport
Conditionally
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ReturnAll
Conditionally
The integer value returned here indicates the minimum number of business days that the corresponding shipping service (indicated in <b>ShippingServiceDetails.ShippingService</b> field) will take to be delivered to eBay's domestic shipping partner.
<br><br>
This minimum shipping time does not include the seller's handling time, and the clock starts on the shipping time only after the seller has delivered the item to the shipping carrier for shipment to eBay's domestic shipping partner. 'Business days' can vary by shipping carrier and by country, but 'business days' are generally Monday through Friday, excluding holidays. This field is returned if defined for that particular shipping service option.
GetOrders
DetailLevel: none, ReturnAll
Conditionally
OrderReport
Conditionally
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ReturnAll
Conditionally
The integer value returned here indicates the maximum number of business days that the corresponding shipping service (indicated in <b>ShippingServiceDetails.ShippingService</b> field) will take to be delivered to eBay's domestic shipping partner.
<br><br>
This maximum shipping time does not include the seller's handling time, and the clock starts on the shipping time only after the seller has delivered the item to the shipping carrier for shipment to eBay's domestic shipping partner. 'Business days' can vary by shipping carrier and by country, but 'business days' are generally Monday through Friday, excluding holidays. This field is returned if defined for that particular shipping service option.
GetOrders
DetailLevel: none, ReturnAll
Conditionally
OrderReport
Conditionally
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ReturnAll
Conditionally
This type provides information about the domestic leg of a Global Shipping Program shipment.
<br/><br/>
<span class="tablenote">
<strong>Note:</strong> The <strong>LogisticsProviderShipmentToBuyer</strong> field is reserved for the exclusive use of the international shipping provider.
</span>
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.
GetOrders
DetailLevel: none, ReturnAll
Conditionally
OrderReport
Conditionally
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ReturnAll
Conditionally
Reserved for use by the international shipping provider.
This type specifies the shipping service and cost of the domestic leg of a Global Shipping Program shipment.
The shipping service specified for the domestic leg of a Global Shipping Program shipment. For the domestic leg, the value of this field can be any available shipping service that ships to the domestic address of the international shipping provider.
GetOrders
DetailLevel: none, ReturnAll
Conditionally
OrderReport
Conditionally
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ReturnAll
Conditionally
The total shipping cost of the domestic leg of a Global Shipping Program shipment.
GetOrders
DetailLevel: none, ReturnAll
Conditionally
OrderReport
Conditionally
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ReturnAll
Conditionally
This type is deprecated.
685
785
NoOp
This field is deprecated.
This type is deprecated.
685
785
NoOp
This field is deprecated.
This type is deprecated.
685
785
NoOp
This enumerated type is deprecated.
This field is deprecated.
This field is deprecated.
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 field is deprecated.
This field is deprecated.
This field is deprecated.
This field is deprecated.
This field is deprecated.
This field is deprecated.
This field is deprecated.
This field is deprecated.
This field is deprecated.
This field is deprecated.
This field is deprecated.
This field is deprecated.
This field is deprecated.
This field is deprecated.
This field is deprecated.
This field is deprecated.
Contains a list of up to 10 external message IDs.
Currently available on the US site. A message ID that uniquely identifies a message
for a given user. If provided at the time of message creation, this ID can be used
to retrieve messages, and will take precedence over the message ID. A total of 10
message IDs can be specified.
GetMyMessages
No
Type defining the <b>ExternalMessageID</b> field used in
<b>GetMyMessages</b> to identify a specific eBay message to retrieve.
Up to 10 <b>ExternalMessageID</b> values can be specified in one API call.
The <b>ExternalMessageIDs</b> container is only available for use on the
eBay US site (SiteID 0).
This enumerated type contains the operations that can be used in a <b>ReviseMyMessagesFolders</b> call.
This enumeration value is used to create one or more custom folders in <b>My eBay Messages</b>. For a 'Display' operation, the new folder name(s) are specified in one or more <b>FolderName</b> fields. The maximum length of a folder name is 15 characters. Up to 10 new folders can be created with one <b>ReviseMyMessagesFolders</b> call, but this is also limited by how many custom folders exist at the time of the call, as only a maximum of 10 custom folders are supported in <b>My eBay Messages</b>.
This enumeration value is used to rename one or more existing folders in <b>My eBay Messages</b>. For a 'Rename' operation, the unique identifier(s) of the message folder(s) to rename are specified in one or more <b>FolderID</b> fields, and the new name for the folder(s) are specified in one or more <b>FolderName</b> fields.
<br/><br/>
The <b>FolderID</b> and <b>FolderName</b> values can be retrieved by calling <b>GetMyMessages</b> with a <b>DetailLevel</b> value set to <code>ReturnSummary</code>, or these folder names and identifiers can be found by navigating to <b>My eBay Messages</b> (Folder ID values are displayed at the end of the browser's URL when that folder is opened).
<br/><br/>
The maximum length of a folder name is 15 characters. The Inbox and Sent folders cannot be renamed.
<br/><br/>
<span class="tablenote"><b>Note: </b> If multiple folders will be renamed with one call, the user must pay close attention to the order of the <b>FolderID</b> and <b>FolderName</b> fields, as eBay will process these requests in order according to the placement of the the <b>FolderID</b> and <b>FolderName</b> fields. So, the existing folder identified by the first <b>FolderID</b> field in the request payload will get renamed to the folder name passed into the first <b>FolderName</b> field in the request payload, and so on.
</span>
This enumeration value is used to remove one or more custom folders in <b>My eBay Messages</b>. For a 'Remove' operation, the folder(s) to remove are specified in one or more <b>FolderID</b> fields. The <b>FolderID</b> values for a <b>My eBay Messages</b> folders can be retrieved by calling <b>GetMyMessages</b> with a <b>DetailLevel</b> value set to <code>ReturnSummary</code>, or these folder IDs can be found by navigating to a specific folder in <b>My eBay Messages</b>, and the ID value for the opened folder is displayed at the end of the browser's URL.
<br/><br/>
A <b>My eBay Messages</b> folder must be empty before being removed, and an error is returned if a user tries to remove a non-empty folder.
<br/><br/>
The Inbox and Sent folders cannot be removed under any circumstance.
Reserved for future or internal use.
Summary details for a specified My Messages folder.
NewAlertCount, TotalAlertCount
An ID that uniquely identifies a My Messages
folder. Always returned for detail level
ReturnSummary.
GetMyMessages
DetailLevel: ReturnSummary
Conditionally
The name of a specified My Messages folder. For
GetMyMessages, Inbox (FolderID = 0) and Sent (FolderID = 1)
are not returned.
GetMyMessages
DetailLevel: ReturnSummary
Conditionally
This field has been deprecated, starting with the 685 release. Alerts are now
synonymous with Flagged messages, and are added to the
Summary.FlaggedMessageCount value.
GetMyMessages
DetailLevel: ReturnSummary
Conditionally
The number of new messages in a given folder.
Always returned for detail level ReturnSummary.
GetMyMessages
DetailLevel: ReturnSummary
Conditionally
This field has been deprecated, starting with the 685 release. Alerts are now
synonymous with Flagged messages, and are added to the
Summary.FlaggedMessageCount value.
GetMyMessages
DetailLevel: ReturnSummary
Conditionally
The total number of messages in a given
folder. Always returned for detail level
ReturnSummary.
GetMyMessages
DetailLevel: ReturnSummary
Conditionally
The total number of new high priority messages that a given user has.
GetMyMessages
DetailLevel: ReturnSummary
Conditionally
The total number of high priority messages that a given user has.
GetMyMessages
DetailLevel: ReturnSummary
Conditionally
Details relating to a My Messages folder.
An ID that uniquely identifies a My Messages folder.
GetMyMessages
Conditionally
Alerts
Messages
DetailLevel: ReturnHeaders, ReturnMessages
The name of a specified My Messages folder.
This type is deprecated.
This field is deprecated.
This field is deprecated.
Type used by the <b>Messages</b> container that is returned in <b>GetMyMessages</b>. The <b>Messages</b> container consists of an array of one or more messages.
A <b>Message</b> container is returned for each message that matches the input criteria in the call request. Each <b>Message</b> container consists of detailed information on a message. The amount of information that is returned in each <b>Message</b> container is partially dependent on the value that is set in the required <b>DetailLevel</b> field.
GetMyMessages
DetailLevel: ReturnHeaders, ReturnMessages
Conditionally
Contains a list of up to 10 MessageID values.
An ID that uniquely identifies a message for a given user.
DeleteMyMessages
Conditionally
GetMyMessages
Conditionally
ReviseMyMessages
Conditionally
Type defining the <b>MessageID</b> field used in
<b>GetMyMessages</b>, <b>ReviseMyMessages</b>, and
<b>DeleteMyMessages</b> to identify a specific eBay message to retrieve,
revise, or delete, respectively. Up to 10 <b>MessageID</b> values can be
specified in one API call.
Container for the message information for each message specified in
MessageIDs. The amount and type of information returned varies based on
the requested detail level.
Display name of the eBay user that sent the message.
GetMyMessages
DetailLevel: ReturnHeaders, ReturnMessages
Conditionally
Displayable user ID of the recipient.
GetMyMessages
DetailLevel: ReturnHeaders, ReturnMessages
Conditionally
Displayable name of the user or eBay
application to which the message is sent. Only
returned for M2M, and if a value exists.
GetMyMessages
DetailLevel: ReturnHeaders, ReturnMessages
Conditionally
Subject of the message.
GetMyMessages
DetailLevel: ReturnHeaders, ReturnMessages
Conditionally
ID that uniquely identifies a message for a given user.
<br/>
<br/>
This value is not the same as the value used for the
GetMemberMessages MessageID. Use the GetMemberMessages value
(used as the GetMyMessages ExternalID) instead.
GetMyMessages
DetailLevel: ReturnHeaders, ReturnMessages
Conditionally
ID used by an external application to uniquely identify a
message. Returned only when specified by the external
application on message creation.
<br><br>
This value is equivalent to the value used for MessageID in
GetMemberMessages.
GetMyMessages
DetailLevel: ReturnHeaders, ReturnMessages
Conditionally
Content type of the body text. The three acceptable values
are "TEXT", "HTML", and "XML" (Note: This is case sensitive).
Contains the message content, and
can contain a threaded message.
This field can contain plain text or HTML,
depending on the format of the original message.
The API does not check the email-format preferences
in My Messages on the eBay Web site.
2 megabytes in size
GetMyMessages
DetailLevel: ReturnMessages
Conditionally
Indicates if the message is displayed with a flag in the seller's
My Messages mailbox on eBay.
It is strongly recommended that the seller act on the message by the
specified date (or within 60 days, if not specified).
GetMyMessages
DetailLevel: ReturnHeaders, ReturnMessages
Conditionally
Indicates if a message has been viewed by a given user. Note that retrieving
a message with the API does not mark it as read.
GetMyMessages
DetailLevel: ReturnHeaders, ReturnMessages
Conditionally
Date and time that a message was created by the sender.
Date and time that a message was received by My Messages and stored in a
database for the recipient.
GetMyMessages
DetailLevel: ReturnHeaders, ReturnMessages
Conditionally
Date and time at which a message expires.
GetMyMessages
DetailLevel: ReturnHeaders, ReturnMessages
Conditionally
Unique identifier of an eBay listing. This field is returned if the corresponding message is associated with a specific listing.
GetMyMessages
DetailLevel: ReturnHeaders
Conditionally
Details relating to the response to a message.
GetMyMessages
DetailLevel: ReturnHeaders, ReturnMessages
Conditionally
Details relating to the forwarding of a
message. Only returned if the message is forwarded.
Details relating to a My Messages folder.
GetMyMessages
DetailLevel: ReturnHeaders, ReturnMessages
Conditionally
Message body in plain text format. The message body is displayed in plain text
even if the eBay user's Preferred Email Format preference on My eBay is set to HTML.
Graphics and text formatting are dropped if the eBay user's preference is set to
HTML.
GetMyMessages
DetailLevel: ReturnMessages
Conditionally
Type of message being retrieved through GetMyMessages. This is available only on
the US site.
GetMyMessages
Conditionally
Specifies an active or ended listing's status in eBay's processing workflow.
If a listing ends with a sale (or sales), eBay needs to update the sale
details (e.g., total price and buyer/high bidder) and the final value fee.
This processing can take several minutes. If you retrieve a sold item and no
details about the buyer/high bidder are returned or no final value fee is
available, use this listing status information to determine whether eBay has
finished processing the listing.
<br><br> <span class="tablenote"><b>Note:</b>
For GetMyMessages, the listing status reflects the status of the listing at the time
the question was created. The listing status for this call must not match the listing
status returned by other calls (such as GetItemTransactions). This is returned only if
Messages.Message.MessageType is AskSellerQuestion. This tag is no longer returned
in the Sandbox environment.
</span>
GetMyMessages
Conditionally
ComingSoon
Currently available only on the US site. Context of the question (e.g. Shipping, General).
Corresponds to the message subject. Applies if Messages.Message.MessageType is AskSellerQuestion.
GetMyMessages
Conditionally
ComingSoon
Indicates if there has been a reply to the message.
GetMyMessages
DetailLevel: ReturnHeaders, ReturnMessages
Conditionally
Indicates if this message is marked as a high-priority message.
GetMyMessages
Conditionally
Date and time for the ended item.
GetMyMessages
Conditionally
Title of the item listing.
55
GetMyMessages
Conditionally
Media details stored as part of the message.
GetMyMessages
DetailLevel: ReturnHeaders, ReturnMessages
Conditionally
Details relating to the response to a message.
Whether a message can be responded
to. To respond to a message, use the URL
in ResponseURL. You may need to log into the eBay
Web site to complete the response.
GetMyMessages
Conditionally
Alerts
Messages
DetailLevel: ReturnHeaders, ReturnMessages
A URL that the recipient must visit to respond to a
message. Responding may require logging
into the eBay Web site.
GetMyMessages
Conditionally
Alerts
DetailLevel: ReturnMessages
GetMyMessages
Conditionally
Messages
DetailLevel: ReturnHeaders, ReturnMessages
The date and time the user responded to a
message
Summary data for a given user's alerts and messages.
This includes the numbers of new alerts and messages,
unresolved alerts, flagged messages, and total alerts
and messages.
Folder summary for each folder. Always
returned for detail level ReturnSummary.
GetMyMessages
DetailLevel: ReturnSummary
Conditionally
This field has been deprecated.
The number of new messages that a given user has. Always returned for detail level ReturnSummary.
GetMyMessages
DetailLevel: ReturnSummary
Conditionally
This field is deprecated.
The number of messages that have been flagged.
Always returned for detail level ReturnSummary.
GetMyMessages
DetailLevel: ReturnSummary
Conditionally
This field has been deprecated.
The total number of messages for a given user.
Always returned for detail level ReturnSummary.
GetMyMessages
DetailLevel: ReturnSummary
Conditionally
The total number of new high priority messages that a given user has.
GetMyMessages
DetailLevel: ReturnSummary
Conditionally
The total number of high priority messages that a given user has.
GetMyMessages
DetailLevel: ReturnSummary
Conditionally
A list of favorite searches a user has saved on the My eBay page.
The total number of favorite searches saved.
GetMyeBayBuying
DetailLevel: none, ReturnAll
Conditionally
A favorite search the user has saved, with a name and a search query.
GetMyeBayBuying
DetailLevel: none, ReturnAll
Conditionally
Type defining the <b>FavoriteSearch</b> container returned in
<b>GetMyeBayBuying</b>. The <b>FavoriteSearch</b> container
consists of options and filtering used in a buyer's Saved Search on My eBay, and is
only returned in <b>GetMyeBayBuying</b> if the <b>FavoriteSearches</b>
container is included the request, and if there is at least one Saved Search for
the buyer.
The name of the buyer's Saved Search on My eBay. The name defaults to the user's
original search string, or the user has the option of modifying the name of the
Saved Search.
GetMyeBayBuying
DetailLevel: none, ReturnAll
Conditionally
This is the URL of the buyer's Saved Search on My eBay.
GetMyeBayBuying
DetailLevel: none, ReturnAll
Conditionally
This string is the original search string of the buyer's Saved Search on My eBay.
This is the string that the user input into the search field.
GetMyeBayBuying
DetailLevel: none, ReturnAll
Conditionally
This is the unique identifier (Category ID) of the category in which the user was
searching for the item for the Saved Search. Specifying a category in a query
restricts the search to a specific category. If the Saved Search is not restricted
to a specific category, the <b>CategoryID</b> field will not appear
in the request.
GetMyeBayBuying
DetailLevel: none, ReturnAll
Conditionally
This enumeration value indicates the "Sort by" value that the user specified in the
Saved Search. Some of the ways buyers can sort items include by Best Match
(generally, the default), item price, item price + shipping, listing end time, and
item distance (relative to the buyer's shipping address). Available sort values
may vary for each search, but below is the complete set of values that may be
returned in this field.
GetMyeBayBuying
DetailLevel: none, ReturnAll
Conditionally
The <b>SortOrder</b> value works in conjunction with the
<b>ItemSort</b> value, and indicates whether Saved Search results are returned
in ascending (low to high values) or descending (high to low values) order.
GetMyeBayBuying
DetailLevel: none, ReturnAll
Conditionally
The <b>EndTimeFrom</b> and <b>EndTimeFrom</b> values indicates that
a date range has been specified in the Saved Search. Only listings ending during
the date range defined with the <b>EndTimeFrom</b> and
<b>EndTimeFrom</b> values are retrieved in the search results.
<br/><br/>
The <b>EndTimeFrom</b> value indicates the beginning of the date range.
GetMyeBayBuying
DetailLevel: none, ReturnAll
Conditionally
The appearance of <b>EndTimeFrom</b> and <b>EndTimeFrom</b>
values in the response indicates that a date range has been specified in the Saved
Search. Only listings ending during the date range defined with the
<b>EndTimeFrom</b> and <b>EndTimeFrom</b> values are
retrieved in the search results.
<br/><br/>
The <b>EndTimeTo</b> value indicates the ending of the date range.
GetMyeBayBuying
DetailLevel: none, ReturnAll
Conditionally
The appearance of a <b>MaxDistance</b> value in the response indicates
that a proximity (Items near me) filter has been specified in the Saved Search.
<br/><br/>
The <b>MaxDistance</b> value is the maximum distance (in miles) away
from the buyer's postal code (specified or default) that an item may be
located (based on the <b>PostalCode</b> value returned in the
<b>FavoriteSearch</b> container). In a Saved Search, a buyer can
supply a postal code or can base that postal code on a major city. If neither one
of these methods for selecting a postal code is used, the postal code defaults to
the buyer's primary shipping address. Only items located within the
<b>MaxDistance</b> value are returned in the search results.
GetMyeBayBuying
DetailLevel: none, ReturnAll
Conditionally
The <b>PostalCode</b> value is either the postal code for the buyer's
primary shipping address, or it is the postal code specified through the proximity
(Items near me) filter of a Saved Search. In a Saved Search, a buyer can supply a
postal code or can base that postal code on a major city.
GetMyeBayBuying
DetailLevel: none, ReturnAll
Conditionally
Enumerated value that provides more information on the type of listing type
filtering the buyer used when setting up a Saved Search in My eBay.
GetMyeBayBuying
DetailLevel: none, ReturnAll
Conditionally
The appearance of a <b>PriceMax</b> value indicates that a maximum price
filter has been specified in the Saved Search. Only listings with an item price at
or below the <b>PriceMax</b> value are retrieved in the search results.
<br/><br/>
<b>PriceMax</b> can be used in conjunction with
<b>PriceMin</b> in a Saved Search to specify a price range. Only
listings with item prices within this price range are retrieved in the search
results.
GetMyeBayBuying
DetailLevel: none, ReturnAll
Conditionally
The appearance of a <b>PriceMin</b> value indicates that a minimum price
filter has been specified in the Saved Search. Only listings with an item price at
or above the <b>PriceMin</b> value are retrieved in the search results.
<br/><br/>
<b>PriceMin</b> can be used in conjunction with
<b>PriceMax</b> in a Saved Search to specify a price range. Only
listings with item prices within this price range are retrieved in the search
results.
GetMyeBayBuying
DetailLevel: none, ReturnAll
Conditionally
The appearance of a <b>Currency</b> value indicates that a currency
filter has been specified in the Saved Search. Only listings with the specified
<b>Currency</b> value are retrieved in the search results.
GetMyeBayBuying
DetailLevel: none, ReturnAll
Conditionally
The BidCountMax value in a My eBay Favorite Search. The BidCountMax limits the search
results to items with a maximum number of bids.
GetMyeBayBuying
DetailLevel: none, ReturnAll
Conditionally
The BidCountMin value in a My eBay Favorite Search. The BidCountMin limits the
results of a search to items with a maximum number of bids.
GetMyeBayBuying
DetailLevel: none, ReturnAll
Conditionally
The SearchFlag value in a My eBay Favorite Search. The SearchFlag allows you to
specify whether you want to include charity listings, free-shipping listings, and
listings with other features in your search.
GetMyeBayBuying
DetailLevel: none, ReturnAll
Conditionally
This field is no longer applicable, as filtering by a payment method in an advanced item search is no longer supported/applicable.
The PreferredLocation value of a My eBay Favorite Search. The PreferredLocation
specifies the criteria for filtering search results by site, where site is determined
by the site ID in the request.
GetMyeBayBuying
DetailLevel: none, ReturnAll
Conditionally
The SellerID value in a My eBay Favorite Search. The SellerID is the eBay ID of a
specific seller.
GetMyeBayBuying
DetailLevel: none, ReturnAll
Conditionally
The SellerIDExclude value in a My eBay Favorite Search. The SellerIDExclude limits
the search results to exclude items sold by a specific seller or by specific sellers.
GetMyeBayBuying
DetailLevel: none, ReturnAll
Conditionally
The ItemsAvailableTo value in a My eBay Favorite Search. ItemsAvailableTo limits the
result set to just those items available to the specified country.
GetMyeBayBuying
DetailLevel: none, ReturnAll
Conditionally
The ItemsLocatedIn value in a My eBay Favorite Search. ItemsLocatedIn limits the
result set to just those items located in the specified country.
GetMyeBayBuying
DetailLevel: none, ReturnAll
Conditionally
The SellerBusinessType value in a My eBay Favorite Search. The SellerBusinessType
limits the search results to those of a particular seller business type such as
commercial or private. SellerBusinessType is only available for sites that have
business seller features enabled.
GetMyeBayBuying
DetailLevel: none, ReturnAll
Conditionally
The Condition value in a My eBay Favorite Search. Condition limits the results to new
or used items, plus items that have no condition specified.
GetMyeBayBuying
DetailLevel: none, ReturnAll
Conditionally
The Quantity value in a My eBay Favorite Search. The Quantity limits the search
results to listings that offer a certain number of items matching the query. The
Quantity field is used with QuantityOperator to specify that you are seeking listings
with quantities greater than, equal to, or less than the value you specify in
Quantity.
GetMyeBayBuying
DetailLevel: none, ReturnAll
Conditionally
The Quantity Operator value in a My eBay Favorite Search. The Quantity Operator
limits the results to listings with quantities greater than, equal to, or less than
the value you specify in Quantity.
GetMyeBayBuying
DetailLevel: none, ReturnAll
Conditionally
A list of favorite sellers the user has saved on the My eBay page.
The total number of favorite sellers saved.
100
GetMyeBayBuying
DetailLevel: none, ReturnAll
Conditionally
A favorite seller the user has saved, with a user ID and store name.
GetMyeBayBuying
DetailLevel: none, ReturnAll
Conditionally
Characteristics of the My eBay Favorite Seller.
The favorite seller's eBay user ID.
GetMyeBayBuying
DetailLevel: none, ReturnAll
Conditionally
The name of the store owned by the favorite seller, if applicable.
GetMyeBayBuying
DetailLevel: none, ReturnAll
Conditionally
A list of possible My eBay Second Chance Offers.
The total number of My eBay Second Chance Offers available.
A Second Chance Offer item.
Specifies how to return the result list for My eBay features such as saved
searches, favorite sellers, and second chance offers.
Specifies whether or not to include the container in the response.
Set the value to true to return the default set of fields for the
container. Not needed if you set a value for at least one other field
in the container.
<br><br>
If you set DetailLevel to ReturnAll, set Include to false to exclude
the container from the response.
GetMyeBayBuying
No
Specifies whether or not to include the item count in the response.
Set the value to true to return the default set of fields for the
container. Not needed if you set a value for at least one other field
in the container.
<br><br>
If you set DetailLevel to ReturnAll, set Include to false to exclude
the container from the response.
GetMyeBayBuying
No
This field is not supported.
Specifies whether or not to include FavoriteSellerCount in the response.
Set the value to true to return the default set of fields for the
container. Not needed if you set a value for at least one other field
in the container.
<br><br>
If you set DetailLevel to ReturnAll, set Include to false to exclude
the container from the response.
GetMyeBayBuying
No
Specifies the sort order of the result. Default is Ascending.
GetMyeBayBuying
No
Specifies the maximum number of items in the returned list.
If not specified, returns all items in the list.
GetMyeBayBuying
No
Specifies that only the user defined list whose name matches
the given name should be in the returned list. If the user does
not have a matching record, no data is returned. If this
element is omitted, the information for all records is returned.
For use only within the UserDefinedLists element.
GetMyeBayBuying
FavoriteSearches
FavoriteSellers
SecondChanceOffer
No
Specify true to return the full user defined list contents in
the response's UserDefinedList containers. A value of
false means only a summary of the user defined list will be
returned. The default value is false.
GetMyeBayBuying
FavoriteSearches
FavoriteSellers
SecondChanceOffer
No
Contains summary information about the items the seller is selling.
The number of currently active auctions that will sell. That
is, there is at least one bidder, and any reserve price has
been met. Equivalent to the "Will Sell" value in My eBay.
GetMyeBaySelling
DetailLevel: none, ReturnAll
Conditionally
The total number of currently active auctions for a given
seller. Note that this does not include listings that are
FixedPriceItem or StoresFixedPrice. Equivalent to the
"Auction Quantity" value in My eBay.
GetMyeBaySelling
DetailLevel: none, ReturnAll
Conditionally
The total number of bids made on the seller's active listings.
GetMyeBaySelling
DetailLevel: none, ReturnAll
Conditionally
For all items that the seller has for sale, the total
selling values of those items having bids and where the
Reserve price is met (if a Reserve price is specified).
GetMyeBaySelling
DetailLevel: none, ReturnAll
Conditionally
The total number of items that the seller has sold in the
past 31 days.
GetMyeBaySelling
DetailLevel: none, ReturnAll
Conditionally
The total monetary value of the items the seller has sold.
GetMyeBaySelling
DetailLevel: none, ReturnAll
Conditionally
The average duration, in days, of all items sold.
GetMyeBaySelling
DetailLevel: none, ReturnAll
Conditionally
The total number of Classified Ad listings listed by the
seller.
GetMyeBaySelling
DetailLevel: none, ReturnAll
Conditionally
The total number of leads from the seller's classified
ad listings. Number indicates the total number of emails
received for the listings
GetMyeBaySelling
DetailLevel: none, ReturnAll
Conditionally
The total number of offers received on active Classified
Ad listings.
GetMyeBaySelling
DetailLevel: none, ReturnAll
Conditionally
The total number of Classified Ad listings that have an
associated lead.
GetMyeBaySelling
DetailLevel: none, ReturnAll
Conditionally
The quantity of items that this seller can list. This number refers to the total quantity of items in all listings.
For example, if the seller's limit was a quantity of 100, this could be 100 listings of one item each, or one listing with a quantity of 100 items.
The seller will be unable to list additional items or quantities of items for sale in excess of this number for the
current month unless the seller requests an increase from eBay using the "Request higher selling limits" link in the All Selling section
of My eBay. (Under "Selling Limits".) Notice that the amount limit (see AmountLimitRemaining) may be reached
before the quantity limit is reached.
GetMyeBaySelling
DetailLevel: none, ReturnAll
Conditionally
Seller Limits
https://developer.ebay.com/DevZone/guides/features-guide/default.html#Development/Listing-Policies.html#SellerLimits
The total value of the items listed price that this seller can list. This amount is the total of the prices
specified upon listing. For example, for fixed price listings, this is the total of the fixed price amounts.
For auction listings, this is the total of the starting prices.
The seller will be unable to list an item if the amount of the item's fixed price or starting price (for auctions)
exceeds the amount limit.
This is part of the seller limit, which can be increased by requesting an increase from eBay using the
"Request higher selling limits" link in the All Selling section
of My eBay. (Under "Selling Limits".) Notice that the quantity limit (see QuantityLimitRemaining) may be reached
before the amount limit is reached.
GetMyeBaySelling
DetailLevel: none, ReturnAll
Conditionally
Seller Limits
https://developer.ebay.com/DevZone/guides/features-guide/default.html#Development/Listing-Policies.html#SellerLimits
This type is used by the <b>NameRecommendation</b> container that is returned in <b>GetCategorySpecifics</b>. A <b>NameRecommendation</b> container is returned for every mandatory and recommended Item Specific for a category, and provides the recommended/most popular values for the Item Specific, as well as details, instructions, and constraint information for each Item Specific name-value pairs.
This string field is the name of the mandatory or recommended Item Specific or Product Identifier type (e.g. Brand/MPN). The seller should use the actual string in this field when creating, revising, or relisting an item with this Item Specific. The number of Item Specifics that are returned can be controlled with the <b>MaxNames</b> field in the call request.
<br/><br/>
This field is always returned with each <b>NameRecommendation</b> container.
Using MaxNames filter
#Request.MaxNames
Setting Item Specifics in AddItem
AddItem.html#Request.Item.ItemSpecifics.NameValueList.Name
GetCategorySpecifics
Always
This container provides details, instructions, and constraint information for each Item Specific name-value pairs. The fields that are returned under the <b>ValidationRules</b> container will vary per Item Specific.
<br/><br/>
Three key fields to look for are <b>MinValues</b>, <b>MaxValues</b>, and <b>VariationSpecifics</b>. If the <b>MinValues</b> appears for an Item Specific (usually with a value of '1'), it indicates that the Item Specific is required for the category. For many Item Specifics, the <b>MaxValues</b> field is returned with a value of '1', but the value will be higher for Item Specifics that support more than one value. The <b>VariationSpecifics</b> field is only returned (with a value of 'Disabled') when a seller is not allowed to pass in that Item Specific at the variation level in a multiple-variation listing.
<br/><br/>
This field is always returned with each <b>NameRecommendation</b> container.
GetCategorySpecifics
Always
Each <b>ValueRecommendation</b> container shows a common/recommended/popular value for the corresponding Item Specific. Values are not returned for every Item Specific, including some instance aspects (such as 'Bundle Description') where the text that is passed in for the Item Specific value may vary widely per seller, or if eBay does not have recommended values available for the Item Specific. The number of values that are returned for each Item Specific can be controlled with the <b>MaxValuesPerName</b> field in the call request.
<br/><br/>
<span class="tablenote"><b>Note: </b> For unique product identifying aspects, such as MPN, UPC, ISBN, or EAN, instead of an actual value being returned, boilerplate text is used, such as 'Does Not Apply'. If an MPN or GTIN is required, but the seller does not have the identifier, he/she can pass in the boilerplate text as an alternative to the actual identifier.
</span>
<br/>
In addition to the recommended value(s) for an Item Specific, a <b>ValueRecommendation.ValidationRules</b> container will be returned if the <b>IncludeConfidence</b> filter is included in the call request and set to <code>true</code>. The return 'Confidence' value is a percentage value that indicates how confident eBay is that the recommended value is a valid value for the corresponding Item Specific. The <b>ValueRecommendation.ValidationRules</b> container may also get returned for the 'Brand' Item Specific if the particular product brand in that listing category requires an association with an eBay catalog product.
Using MaxValuesPerName filter
#Request.MaxValuesPerName
Using IncludeConfidence filter
#Request.IncludeConfidence
Setting Item Specific values in AddItem
AddItem.html#Request.Item.ItemSpecifics.NameValueList.Value
GetCategorySpecifics
Conditionally
This field contains a URL to a relevant eBay help page that may provide more information about a particular Item Specific. This field is only returned if a relevant eBay help page is available. If this field is returned, the <b>HelpText</b> field may also be returned and provide some context on the content of the help page.
GetCategorySpecifics
Conditionally
This field is not currently returned in <b>GetCategorySpecifics</b> for any Item Specific.
The text in this field may provide some context on the content of the help page linked to in the <b>HelpURL</b> field. This field is only returned if the <b>HelpURL</b> field is returned, and is available.
GetCategorySpecifics
Conditionally
A list of one or more valid names and corresponding values. Currently
used to identify Item Specifics and individual variations within a multiple-variation listing.
<b>For the <b>AddItem</b> family of calls:</b>
Contains the name and value(s) for an Item Specific.
Only required when the <b>ItemSpecifics</b> container is
specified.<br>
<br>
<span class="tablenote"><b>Note: </b> The maximum number of item specifics that may be defined for a listing has increased from 30 to 45.
</span><br>
<b>For the AddFixedPriceItem family of calls:</b>
The same NameValueList schema is used for the
<b>ItemSpecifics</b> node, the <b>VariationSpecifics</b> node, and the
<b>VariationSpecifcsSet</b> node.<br>
<br>
If the listing has variations, any name that you use in the
<b>VariationSpecifics</b> and <b>VariationSpecificsSet</b> nodes can't be used
in the <b>ItemSpecifics</b> node.<br>
When you list with Item Variations:<br>
<b></b>
<ul>
<li>Specify shared Item Specifics (e.g., Brand) in the <b>ItemSpecifics</b> node. </li>
<li>Specify up to five <b>VariationSpecifics</b> in each Variation node. </li>
<li>Specify all applicable names with all their supported values in the <b>VariationSpecificSet</b> node. </li>
</ul>
See the Variation sample in the
<b>AddFixedPriceItem</b> call reference for examples.<br>
<br>
<b>For PlaceOffer:</b> Required if the item being
purchased includes Item Variations.
<br>
<br>
<b>For AddToWatchList and RemoveFromWatchList:</b> The <b>ItemID</b> value of the multiple-variation listing and the name-value pair to identify each variation in the listing are required.
<br>
<br>
<span class="tablenote"><b>Note:</b> As of August 30, 2018, California will require sellers to display a Proposition 65 warning on online retail sites if products contain chemicals and/or substances that may impact the health of California buyers. This requirement is applicable to most eBay US categories, including eBay Motors, Motors Parts & Accessories, and catalog-enabled categories. The warning message can be customized by the seller, but should contain the following basic information:
<ul>
<li>The name of at least one listed chemical that prompted the warning</li>
<li>Text stating that the product 'can expose you to' the chemical(s) in the product </li>
<li>The URL for OEHHA's new Proposition 65 warnings website, which is <a href="www.P65Warnings.ca.gov" target="_blank">www.P65Warnings.ca.gov</a></li>
</ul>
Unlike standard item specifics that allow a maximum of 65 characters in the <b>Value</b> field, the matching value for the 'California Prop 65 Warning' item specific allows up to 800 characters of text. When a seller passes in this item specific, eBay will automatically insert a warning symbol icon for the listing.
</span><br>
AddFixedPriceItem
AddItem
AddItems
AddSellingManagerTemplate
RelistFixedPriceItem
RelistItem
ReviseFixedPriceItem
ReviseItem
ReviseSellingManagerTemplate
VerifyAddFixedPriceItem
VerifyAddItem
VerifyRelistItem
ItemSpecifics
45
Conditionally
AddFixedPriceItem
ReviseFixedPriceItem
RelistFixedPriceItem
VerifyAddFixedPriceItem
Variations
Conditionally
2
5
AddSellingManagerProduct
ReviseSellingManagerProduct
ItemSpecifics
45
No
GetSellingManagerInventory
Conditionally
AddToWatchList
RemoveFromWatchList
Conditionally
GetCategorySpecifics
Conditionally
GetItem
No
GetItem
GetSellingManagerTemplates
Conditionally
DetailLevel: none, ItemReturnDescription,
ItemReturnAttributes, ReturnAll
GetSellerEvents
DetailLevel: none, ReturnAll
Conditionally
GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
Variation
Conditionally
GetItemTransactions
GetSellerTransactions
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetMyeBayBuying
LostList
WatchList
WonList
DeletedFromWonList
DeletedFromLostList
DetailLevel: none, ReturnAll
Conditionally
GetMyeBaySelling
ActiveList
DeletedFromSoldList
DeletedFromUnsoldList
ScheduledList
SoldList
UnsoldList
DetailLevel: none, ReturnAll
Conditionally
GetOrders
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
OrderReport
Conditionally
PlaceOffer
Conditionally
SetUserNotes
No
GetItemTransactions
Conditionally
ActiveInventoryReport
Conditionally
SoldReport
Conditionally
This type is used to set or identify either an Item Specific name/value pair for a category/item/variation, or to identify a Parts Compatibility name/value pair.
Depending on the call and context, this value is either a name of an Item/Category/Variation Specific, or a Parts Compatibility name.
<br>
<br>
<b>For the AddItem and AddFixedPriceItem families of
calls:</b> In the <b>Item.ItemSpecifics</b> context, this can be any
name that the seller wants to use. However, to help buyers find
items more easily, it is a good idea to try to use a recommended
name when possible (see <b>GetCategorySpecifics</b>).
You can't specify the same name twice within the same listing.
<br>
<br>
<b>For the <b>AddFixedPriceItem</b> family of calls:</b>
In the <b>VariationSpecifics</b> context, this can be any name that
the seller wants to use, unless the <b>VariationsEnabled</b> flag
is false for the name in the <b>GetCategorySpecifics</b> response.
For example, for some categories eBay may recommend that you only
use "Brand" as a shared name at the Item level, not in variations.
<br>
<br>
<b>For the <b>AddFixedPriceItem</b> family of calls:</b>
In the <b>Compatibility.NameValueList</b> context, this value is a motor vehicle aspect such as <em>Year</em>, <em>Make</em>, and <em>Model</em>. A <b>Compatibility.NameValueList</b> container is applicable for motor vehicle parts and accessories listings.
<br>
<br>
<b>For GetCategorySpecifics:</b>
This is a recommended (popular) name to use for items in the
specified category (e.g., "Brand" might be recommended,
not "Manufacturer").
</span>
<br>
<br>
<b>For PlaceOffer:</b> Required if the item being
purchased includes Item Variations.
<br>
<br>
<span class="tablenote"><b>Note:</b> For mandatory and recommended item specifics that are returned in the <b>GetCategorySpecifics</b> call, the seller should pass in the name of these item specifics just as they are shown in the <b>GetCategorySpecifics</b> response. Similarly, for catalog-enabled categories, the seller should pass in the name of instance aspects just as they are shown in the <b>GetCategorySpecifics</b> response. Instance aspects are additional details unique to a specific item or listing that a seller can include along with the product aspects that are already defined in the eBay catalog product associated with the listing. Instance aspects common to many catalog-enabled categories include 'Bundle Description' and 'Modification Description'. As of August 30, 2018, eBay US sellers who ship to California are required to pass in a 'California Prop 65 Warning' item specific if the item in the listing contains one or more chemicals known to be harmful to human health. This item specific is passed at the listing level for both single-variation and multiple-variation listings. The 'California Prop 65 Warning' is considered an instance specific because it will be retained on the listing even when the seller lists using an eBay catalog product. The 'California Prop 65 Warning' may be applicable in most eBay US categories, including eBay Motors, Motors Parts & Accessories, and catalog-enabled categories.
</span>
<span class="tablenote"><b>Note:</b>
If Brand and MPN (Manufacturer Part Number) are being used to identify product variations in a multiple-variation listing, the Brand must be specified at the item level (<b>ItemSpecifics</b> container) and the MPN for each product variation must be specified at the variation level (<b>VariationSpecifics</b> container). The Brand name must be the same for all variations within a single listing.
</span>
65
AddItem
AddItemFromSellingManagerTemplate
AddItems
AddSellingManagerTemplate
RelistItem
ReviseItem
ReviseSellingManagerTemplate
VerifyAddItem
VerifyRelistItem
No
AddFixedPriceItem
ReviseFixedPriceItem
RelistFixedPriceItem
VerifyAddFixedPriceItem
Conditionally
AddSellingManagerProduct
ReviseSellingManagerProduct
No
AddSellingManagerTemplate
ReviseSellingManagerTemplate
No
GetSellingManagerInventory
Conditionally
AddToWatchList
RemoveFromWatchList
Conditionally
GetCategorySpecifics
Conditionally
GetItem
No
GetItem
GetSellingManagerTemplates
Conditionally
DetailLevel: none, ItemReturnDescription,
ItemReturnAttributes, ReturnAll
GetSellerEvents
DetailLevel: none, ReturnAll
Conditionally
GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
Conditionally
GetItemTransactions
GetSellerTransactions
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetMyeBayBuying
LostList
WatchList
WonList
DeletedFromWonList
DeletedFromLostList
DetailLevel: none, ReturnAll
Conditionally
GetMyeBaySelling
ActiveList
DeletedFromSoldList
DeletedFromUnsoldList
ScheduledList
SoldList
UnsoldList
DetailLevel: none, ReturnAll
Conditionally
GetOrders
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
OrderReport
Conditionally
PlaceOffer
Conditionally
SetUserNotes
No
ActiveInventoryReport
Conditionally
SoldReport
Conditionally
Depending on the call and context, this value is either the value of an Item/Category/Variation Specific, a Parts Compatibility value, or a product identifier.<br>
<br>
<b>For the <b>AddItem</b> family of calls:</b>
If you specify multiple values for Item Specifics,
eBay only stores the first one,
unless <b>GetCategorySpecifics</b> indicates
that the corresponding name supports multiple values.
<br>
<br>
<b>For the <b>AddFixedPriceItem</b> family of calls:</b>
If you specify multiple values for Item Specifics or
Variation Specifics,
eBay only stores the first one,
unless <b>GetCategorySpecifics</b> indicates
that the corresponding name supports multiple values.<br>
<br>
In <b>VariationSpecificSet</b>, you typically specify multiple
Value fields for each name. For example, if <b>Name</b> = <code>Size</code>,
you would specify all size values that you wan to offer in the
listing.
<br>
<br>
For the <b>Compatibility.NameValueList</b> context, this is the corresponding value of a motor vehicle aspect such as <em>Year</em>, <em>Make</em>, and <em>Model</em>. A <b>Compatibility.NameValueList</b> container is applicable for motor vehicle parts and accessories listings.
<br>
<br>
<b>For GetCategorySpecifics:</b> The most highly recommended values are returned first. For these calls,
Value is only returned when recommended values are available.<br>
<br>
<b>For PlaceOffer:</b> Required if the item being
purchased includes Item Variations.<br>
<br>
<br>
<span class="tablenote"><b>Note:</b> The standard maximum length for the value of an item specific is 65, but the maximum allowed length increases for instance aspects such as 'Bundle Description' and 'Modification Description'. The maximum allowed length for these instance aspects are returned in the <b>GetCategorySpecifics</b> call. The maximum allowed length for the new 'California Prop 65 Warning' item specific is 800 characters. For more information about the 'California Prop 65 Warning' item specific, see the <b>ItemSpecifics.NameValueList</b> field description.
</span>
65 (but longer for some instance aspects, including 800 for 'California Prop 65 Warning')
AddItem
AddItemFromSellingManagerTemplate
AddItems
AddSellingManagerTemplate
RelistItem
ReviseItem
ReviseSellingManagerTemplate
VerifyAddItem
VerifyRelistItem
No
AddFixedPriceItem
ReviseFixedPriceItem
RelistFixedPriceItem
VerifyAddFixedPriceItem
Conditionally
AddToWatchList
RemoveFromWatchList
Conditionally
50
AddSellingManagerProduct
ReviseSellingManagerProduct
No
AddSellingManagerTemplate
ReviseSellingManagerTemplate
No
GetSellingManagerInventory
Conditionally
GetCategorySpecifics
Conditionally
GetItem
No
GetItem
GetSellingManagerTemplates
Conditionally
DetailLevel: none, ItemReturnDescription,
ItemReturnAttributes, ReturnAll
GetSellerEvents
DetailLevel: none, ReturnAll
Conditionally
GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
Conditionally
GetItemTransactions
GetSellerTransactions
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetMyeBayBuying
LostList
WatchList
WonList
DeletedFromWonList
DeletedFromLostList
DetailLevel: none, ReturnAll
Conditionally
GetMyeBaySelling
ActiveList
DeletedFromSoldList
DeletedFromUnsoldList
ScheduledList
SoldList
UnsoldList
DetailLevel: none, ReturnAll
Conditionally
GetOrders
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
OrderReport
Conditionally
PlaceOffer
Conditionally
SetUserNotes
No
ActiveInventoryReport
Conditionally
SoldReport
Conditionally
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.
GetItem
DetailLevel: none, ItemReturnDescription,
ItemReturnAttributes, ReturnAll
Variation
Conditionally
Information about a parent name-value pair that indicates the
relationships between Item Specifics.
The name of another Item Specific that the current value depends on.
For example, in a clothing category, "Size Type" could be recommended
as a parent of Size.
GetCategorySpecifics
Conditionally
The value of another Item Specific that the current value depends on.
For example, in a clothing category, if "Size Type" is the <b>ParentName</b>,
then "Petite" could be recommended as a parent value for <b>Size</b> = <code>Medium</code>.
GetCategorySpecifics
ValueRecommendation
Conditionally
Type defining the <b>NonProfitAddress</b> container, which consists of the address (including latitude and longitude) of a nonprofit charity organization.
The street address of a nonprofit charity organization.
512
SetCharities
Yes
GetCharities
Always
The second line (if needed) of a nonprofit charity organization. This field is often
used for a suite number, floor number, or P.O. Box.
512
SetCharities
No
GetCharities
Conditionally
The city in which a nonprofit charity organization is located.
128
SetCharities
Yes
GetCharities
Always
The state in which a nonprofit charity organization is located.
128
SetCharities
Yes
GetCharities
Always
The zip code of a nonprofit charity organization.
12
SetCharities
Yes
GetCharities
Always
The latitude value of a nonprofit charity organization. Latitude and longitude
coordinates pinpoint the location of the organization relative to the earth, and are
useful for search purposes. The <b>Latitude</b> and <b>Longitude</b>
fields are only returned in <b>GetCharities</b> if set by the organization.
-90
90
SetCharities
No
GetCharities
Conditionally
The longitude value of a nonprofit charity organization. Latitude and longitude
coordinates pinpoint the location of the organization relative to the earth, and are
useful for search purposes. The <b>Latitude</b> and <b>Longitude</b>
fields are only returned in <b>GetCharities</b> if set by the organization.
-180
180
SetCharities
No
GetCharities
Conditionally
Enumeration value that indicates whether or not a nonprofit charity organization is
registered with the PayPal Giving Fund. See the <a href="http://pages.ebay.com/help/sell/nonprofit.html#enrolling">Enrolling your nonprofit</a> help topic for more information on registering with
the PayPal Giving Fund and the benefits that come with being a registered eBay for Charity organization.
SetCharities
Yes
GetCharities
Always
Enumerated type that indicates whether or not a nonprofit charity organization is
registered with the PayPal Giving Fund. See the <a href="http://pages.ebay.com/help/sell/nonprofit.html#enrolling">Enrolling your nonprofit</a> help topic for more information on registering with
the PayPal Giving Fund and the benefits that come with being a registered eBay for Charity organization.
This value indicates that the address contained in the <b>NonProfitAddress</b>
container is for a non-registered charity organization.
This value indicates that the address contained in the <b>NonProfitAddress</b>
container is for a charity organization registered with the PayPal Giving Fund.
This value is reserved for internal or future use.
This is for FSBO.
Each of the subscriptions will have following options, which will define
"National" vs "Local" ad format listing.
"LocalOptional" : This will allow national and local listing.
"LocalOnly" : Seller can have Local listings only.
"NationalOnly" : Seller can not opt into local only exposure. It has to be
national listing.
This enumerated type is deprecated.
Type used by the <b>NotificationDetailsArray</b> container that is returned by the <b>GetNotificationsUsage</b> call. The <b>NotificationDetailsArray</b> container consists of one or more notifications that match the input criteria in the call request.
<br><br>
This container is only returned if an <b>ItemID</b> value was specified in the request, and there were notifications related to this listing during the specified time range.
Each <b>NotificationDetails</b> container consists of detailed information about one notification. <b>NotificationDetails</b> container(s) are only returned if an <b>ItemID</b> value was specified in the request, and there were one or more notifications related to this listing during the specified time range.
GetNotificationsUsage
Conditionally
Information about a single notification. Notification information includes
the reference ID, notification type, current status, time delivered, error code,
and error message for the notification. If notification details are included in
the response, all of the detail fields are returned.
Returns the destination address for the notification. This is the value set
using SetNotificationPreferences.
GetNotificationsUsage
Conditionally
Reference identifier for the notification.
Date and time when this notification will be removed from the
eBay system.
GetNotificationsUsage
Conditionally
Returns the notification type. Possible values include: AskSellerQuestion,
AuctionCheckoutComplete, BestOffer, CheckoutBuyerRequestTotal, EndOfAuction,
Feedback, FixedPriceEndOfTransaction, FixedPriceTransaction, ItemNotReceived,
MyMessages, OutBid, SecondChanceOffer, UPIBuyerResponseDispute, UPISellerClosedDispute,
UPISellerOpenedDispute, and UPISellerRespondedToDispute.
GetNotificationsUsage
Conditionally
Returns the total number of retries for the given notification.
GetNotificationsUsage
Conditionally
Returns the notification status. Possible values include Delivered,
Failed, Rejected, and MarkedDown.
GetNotificationsUsage
Conditionally
Returns the time when the notification is scheduled for retry.
This won't be included if the DeliveryStatus is Delivered.
GetNotificationsUsage
Conditionally
Returns the time when the notification was delivered.
GetNotificationsUsage
Conditionally
Returns the error message.
GetNotificationsUsage
Conditionally
Returns the delivery URL name for the notification. This is the value set
using SetNotificationPreferences.
GetNotificationsUsage
Conditionally
This type is used by the <b>UserDeliveryPreferenceArray</b> container of the <b>SetNotificationPreferences</b> and <b>GetNotificationPreferences</b> calls. The <b>UserDeliveryPreferenceArray</b> container consists of one or more notifications and whether or not each notification is enabled or disabled.
In a <b>SetNotificationPreferences</b> call, one <b>NotificationEnable</b> container is used for each notification that the user either wants to subsribe to or disable.
<br><br>
If a <b>UserDeliveryPreferenceArray</b> container is used, at least one <b>NotificationEnable</b> container must be specified.
<br><br>
In a <b>GetNotificationPreferences</b> call, one <b>NotificationEnable</b> container is returned for each notification that the user has set a preference on - enabled or disabled.
SetNotificationPreferences
Conditionally
GetNotificationPreferences
Conditionally
Specifies a notification event and whether the
notification is enabled or disabled.
The name of the notification event.
GetNotificationPreferences
FeedbackForSeller
Conditionally
SetNotificationPreferences
None, FeedbackForSeller
No
Whether the event is enabled or disabled.
GetNotificationPreferences
Conditionally
SetNotificationPreferences
No
Defines all property names that can be used.
Property name for WatchedItemEndingSoon events, enabling a user to specify a time in minutes
before the end of the listing. Acceptable values: 5, 10, 15, 30, 60, 75, and 180. For example,
to receive a WatchedItemEndingSoon notification 30 minutes before the item listing ends,
specify 30.
Reserved for future use.
Defines properties associated with a particular event.
The name of the notification event.
GetNotificationPreferences
ItemsCanceled
Conditionally
SetNotificationPreferences
ItemsCanceled
No
Specify property name associated with an particular event.
GetNotificationPreferences
Conditionally
SetNotificationPreferences
No
Specifies the value for the property.
GetNotificationPreferences
Conditionally
SetNotificationPreferences
No
Valid notification status codes
Status indicating the notification is newly created
Status indicating the notification was failed
Status indicating the end user application is marked down
Status indicating the notification is pending
Status indicating the notification is failed pending
Status indicating the notification is marked down pending
Status indicating the notification was successfully delivered
Status indicating the notification was unable to deliver
Status indicating the notification was rejected
Status indicating the notification was cancelled
Reserved for future internal or external use
Enumerated type that contains the complete list of platform notifications that
can be sent out to subscribed users, servers, or applications. Some notifications are
only sent to buyers or sellers, and some are sent to both buyers and sellers.
FeedbackForSeller, MyMessagesAlertHeader, MyMessagesAlert, Checkout, ThirdPartyCartCheckout, ItemAddedToBidGroup, ItemRemovedFromBidGroup, AddToWatchList, PlaceOffer, RemoveFromWatchList, AddToBidGroup, RemoveFromBidGroup, ItemsCanceled, ReadyToShip, ReadyForPayout, UnmatchedPaymentReceived, RefundSuccess, RefundFailure
This notification is for internal or future use.
This notification is sent to a subscribed buyer when another buyer has outbid
(placed a higher bid) the subscribed buyer on an auction listing, and
the subscribed buyer is no longer the current high bidder.
<br><br>
This notification is only applicable for auction listings.
This notification is sent to all subscribed bidders of an auction item and to
the subscribed seller of the auction item as soon as the auction listing ends
with or without a winning bidder. This notification will also be sent to
subscribed bidders and the subscribed seller if the auction ends as a
result of a buyer using the auction listing's Buy It Now feature.
<br><br>
This notification is only applicable for auction listings.
This notification is sent to the subscribed seller when the winning bidder
or buyer has paid for the auction or fixed-price item and completed the checkout process.
<br><br>
For multiple line item orders, an <b>AuctionCheckoutComplete</b> notification is only generated for one of the line items in the order.
This notification is sent to a subscribed seller when a buyer/winning bidder
is requesting a total price before paying for the item.
<br><br>
This notification is applicable for auction listings and for fixed-price listings that do not require immediate payment.
This notification is sent to a subscribed buyer or seller when that buyer or seller has left Feedback for the other party in the order, or has received Feedback from the other party in the order. Feedback is given at the order line item level.
This notification is deprecated. Use the <b>Feedback</b> notification instead.
415
Avoid
Feedback
This notification is sent to a subscribed seller each time a buyer purchases an item in a single or multiple-quantity, fixed-price listing.
<br><br>
This notification is only applicable for fixed-price listings.
This notification is sent to a subscribed buyer when that buyer is offered a Second Chance Offer from the seller, after that buyer failed to win the original auction of the item.
<br><br>
If subscribed to by a buyer and when applicable, this notification will appear in the <b>GetItem</b> call response.
This notification is sent to a subscribed seller when an eBay user has used the Ask a Question feature on the seller's active listing. An eBay user does not have to be an active bidder on an auction listing to ask a seller a question.
<br><br>
If subscribed to by a seller and when applicable, this notification will appear in the <b>GetMemberMessages</b> call response.
This notification is sent to a subscribed seller each time one of the subscribed seller's items is listed or relisted. This notification is also triggered when the Unpaid Item Assistant mechanism relists an item for the seller.
This notification is sent to a subscribed seller when one of the subscribed seller's items is revised.
<br><br>
If subscribed to by a seller and when applicable, this notification will appear in the <b>GetItem</b> call response.
This notification is sent to a subscribed seller each time a buyer responds to an Unpaid Item or Cancel Transaction case that the subscribed seller has opened up against the buyer.
This notification is sent to a subscribed buyer if a seller opens up an Unpaid Item or Cancel Transaction case against the subscribed buyer.
<br><br>
If subscribed to by a buyer and when applicable, this notification will appear through the <b>GetDispute</b> call response.
This notification is sent to a subscribed buyer each time a seller responds to an Item Not Received or (Item) Significantly Not As Described case that the subscribed buyer has opened up against the seller.
<br><br>
If subscribed to by a buyer and when applicable, this notification will appear in the <b>GetDispute</b> call response.
This notification is sent to the subscribed buyer and seller if the seller closes an Unpaid Item or Cancel Transaction case against the buyer.
<br><br>
If subscribed to by a buyer or seller, and when applicable, this notification will appear in the <b>GetDispute</b> call response.
This notification is sent to a subscribed seller if a potential buyer has made a Best Offer on a Best Offer-enabled listing.
<br><br>
If subscribed to by a seller and when applicable, this notification will appear in the <b>GetBestOffers</b> call response.
<br/><br/>
<span class="tablenote"><b>Note: </b>
The Best Offer feature can be set for auction listings on the US, Canada, UK, Germany, Australia, France, Italy, and Spain marketplaces, but keep in mind that Best Offer and Buy It Now cannot be used simultaneously in a listing. Also, once a qualifying bid is made on an auction listing, the Best Offer feature is disabled, and any pending offer or counteroffers are no longer valid.
</span>
This notification is deprecated and can no longer be used.
This notification is deprecated. Use <b>MyMessagesHighPriorityMessage</b> instead.
This notification is sent to a subscribed buyer or seller when eBay sends a message to that user's InBox.
<br><br>
If subscribed to by a buyer or seller, and when applicable, this notification will appear in the <b>GetMyMessages</b> call response. For this notification to be returned in <b>GetMyMessages</b>, the <b>DetailLevel</b> value in the <b>GetMyMessages</b> request must be set to <code>ReturnHeaders</code>.
<br><br>
<b>MyMessageseBayMessageHeader</b> and <b>MyMessageseBayMessage</b> cannot be subscribed
to at the same time or specified in the same call.
This notification is sent to a subscribed buyer or seller when eBay sends a message to that user's InBox.
<br><br>
If subscribed to by a buyer or seller, and when applicable, this notification will appear in the <b>GetMyMessages</b> call response. For this notification to be returned in <b>GetMyMessages</b>, the <b>DetailLevel</b> value in the <b>GetMyMessages</b> request must be set to <code>ReturnMessages</code>.
<br><br>
<b>MyMessageseBayMessageHeader</b> and <b>MyMessageseBayMessage</b> cannot be subscribed
to at the same time or specified in the same call.
This notification is sent to a subscribed buyer or seller when another eBay user sends a message to that user's InBox.
<br><br>
If subscribed to by a buyer or seller, and when applicable, this notification will appear in the <b>GetMyMessages</b> call response. For this notification to be returned in <b>GetMyMessages</b>, the <b>DetailLevel</b> value in the <b>GetMyMessages</b> request must be set to <code>ReturnHeaders</code>.
<br><br>
<b>MyMessagesM2MMessageHeader</b> and <b>MyMessagesM2MMessage</b> cannot
be subscribed to at the same time or specified in the same call.
This notification is sent to a subscribed buyer or seller when another eBay user sends a message to that user's InBox.
<br><br>
If subscribed to by a buyer or seller, and when applicable, this notification will appear in the <b>GetMyMessages</b> call response. For this notification to be returned in <b>GetMyMessages</b>, the <b>DetailLevel</b> value in the <b>GetMyMessages</b> request must be set to <code>ReturnMessages</code>.
<br><br>
<b>MyMessagesM2MMessageHeader</b> and <b>MyMessagesM2MMessage</b> cannot
be subscribed to at the same time or specified in the same call.
This notification is sent to a subscribed seller when a buyer opens an Item Not Received dispute against that seller.
<br><br>
If subscribed to by the seller and when applicable, this notification will appear in the <b>GetDispute</b> call response.
This notification is sent to a subscribed seller when a buyer responds to an Item Not Received dispute opened by that buyer.
<br><br>
If subscribed to by the seller and when applicable, this notification will appear in the <b>GetDispute</b> call response.
This notification is sent to a subscribed seller when a buyer closes an Item Not Received dispute opened by that buyer.
<br><br>
If subscribed to by the seller and when applicable, this notification will appear in the <b>GetDispute</b> call response.
This notification is sent to a subscribed buyer when a seller responds to an Item Not Received dispute opened by the buyer.
<br><br>
If subscribed to by the buyer and when applicable, this notification will appear in the <b>GetDispute</b> call response.
This notification is deprecated. Use <b>AuctionCheckoutComplete</b> instead.
This notification is sent to a subscribed buyer when a listing that the buyer is watching is ending soon. This event has a <b>TimeLeft</b> property that defines the 'ending soon' threshold value.
This notification is sent to a subscribed buyer or seller when a listing ends. This notification can be triggered by an
<b>ItemWon</b>, an <b>ItemSold</b>, or an <b>ItemUnsold</b> event.
This notification is sent to a subscribed buyer or seller when a listing is administratively taken down by eBay.
This notification is sent to a subscribed seller when an eBay listing ends in a sale.
This notification is sent to a subscribed seller when the duration of an eBay listing has been extended.
This notification is sent to a subscribed buyer or seller when that user has modified their eBay user ID.
This notification is sent to a subscribed buyer or seller when that user has changed the email address associated with the user account. This notification is available for Client Alerts and for SMS only. Not applicable to Platform Notifications.
This notification is sent to a subscribed buyer or seller when that user has changed the password used for login. This notification is available for Client Alerts and for SMS only. Not applicable to Platform Notifications.
This notification is sent to a subscribed buyer or seller when that user has changed the password hint. This notification is available for Client Alerts and for SMS only. Not applicable to Platform Notifications.
This notification is sent to a subscribed seller when that seller has changed the payment methods used to pay seller fees for the account. This notification is available for Client Alerts and for SMS only. Not applicable to Platform Notifications.
This notification is sent to a subscribed buyer or seller when that eBay user's account is suspended. This notification is available for Client Alerts and for SMS only. Not applicable to Platform Notifications.
An informational alert about account activity. A buyer or seller can subscribe to receive an account activity summary via SMS or Client Alerts. The user can specify the period (time range) for the account summary and can select how often the summary is to be sent. It is not triggered by an event but rather by an eBay daemon process that monitors a schedule database.
This notification is deprecated.
621
707
NoOp
This notification is sent to a subscribed seller when the seller has
revised a listing and added a nonprofit organization to receive a percentage (10 percent up to 100 percent) of the proceeds.
This notification is sent to a subscribed buyer when that buyer adds an item to the Watch List.
<br><br>
If subscribed to by a buyer and when applicable, this notification will appear in the <b>GetItem</b> call response.
This notification is sent to a subscribed buyer when that buyer removes an item from the Watch List.
<br><br>
If subscribed to by a buyer and when applicable, this notification will appear in the <b>GetItem</b> call response.
This notification is deprecated.
This notification is deprecated.
This notification is sent to a subscribed buyer or seller when that user leaves feedback for an order partner.
<br><br>
If subscribed to by a buyer or seller, and when applicable, this notification will appear in the <b>GetFeedback</b> call response.
This notification is sent to a subscribed buyer or seller when that user receives feedback from an order partner.
<br><br>
If subscribed to by a buyer or seller, and when applicable, this notification will appear in the <b>GetFeedback</b> call response.
This notification is sent to a subscribed buyer or seller when that user's Feedback star has changed.
Sent to a subscribing third party when a user's Feedback star level changes.
<br><br>
If subscribed to by a buyer or seller, and when applicable, this notification will appear in the <b>GetUser</b> call response.
This notification is sent to a subscribed buyer when that buyer places a bid for an auction item.
<br><br>
If subscribed to by a buyer and when applicable, this notification will appear in the <b>GetItem</b> call response.
This notification is sent to a subscribed seller each time a prospective buyer places a bid for the seller's auction item.
<br><br>
If subscribed to by a seller and when applicable, this notification will appear in the <b>GetItem</b> call response.
This notification is sent to a subscribed buyer if that buyer is the winner of an auction item.
<br><br>
If subscribed to by a buyer and when applicable, this notification will appear in the <b>GetItem</b> call response.
This notification is sent to a subscribed buyer if that buyer did not end up as the highest bidder for an auction item.
<br><br>
If subscribed to by a buyer and when applicable, this notification will appear in the <b>GetItem</b> call response.
This notification is sent to a subscribed seller when an auction listing ends with no winning bidder or when a fixed-price listing ends with no sale(s).
<br><br>
If subscribed to by a seller and when applicable, this notification will appear in the <b>GetItem</b> call response.
This notification is sent to a subscribed buyer when a seller makes a counter offer to the buyer's Best Offer on an item.
<br><br>
If subscribed to by a buyer and when applicable, this notification will appear in the <b>GetBestOffers</b> call response.
This notification is sent to a subscribed buyer when a seller declines the buyer's Best Offer on an item.
<br><br>
If subscribed to by a buyer and when applicable, this notification will appear in the <b>GetBestOffers</b> call response.
This notification is sent to a subscribed seller each time a prospective buyer places a Best Offer on an item.
This notification is deprecated. Use <b>ItemAddedToWatchList</b> notification instead.
This notification is deprecated. Use <b>BidPlaced</b> notification instead.
This notification is deprecated. Use <b>ItemRemovedFromWatchList</b> notification instead. ItemRemovedFromWatchList
This notification is deprecated.
This notification is deprecated.
This notification is deprecated.
This notification is sent to a subscribed buyer or seller if that user's authentication token is revoked.
<br><br>
If subscribed to by a buyer or seller, and when applicable, this notification will appear in the <b>GetTokenStatus</b> call response.
This notification is sent to a subscribed seller when that seller's Bulk Data Exchange job completes.
Reserved for future use.
This notification is sent to a subscribed buyer and seller when that seller has marked an item as 'shipped'.
This notification is sent to a subscribed buyer and seller when that seller has marked an order as 'paid'.
This notification is sent to a subscribing buyer or seller when a response to the eBay Money Back Guarantee case is due from that user. When an eBay Money Back Guarantee case is opened, this notification is only sent to the seller involved in the case and not the buyer.
This notification is sent to the subscribed buyer or seller when a response to the eBay Money Back Guarantee case is due from the other party in the case.
This notification is sent to the subscribed buyer or seller when an eBay Money Back Guarantee case is escalated to eBay customer support.
This notification is sent to the subscribed buyer or seller when the decision of an eBay Money Back Guarantee case is appealed.
This notification is sent to the subscribed seller when payment (to eBay or buyer) related to the outcome of an eBay Money Back Guarantee case is due.
This notification is sent to the subscribed seller when payment (to eBay or buyer) related to the outcome of an eBay Money Back Guarantee case is processed.
This notification is sent to the subscribed buyer or seller when an appeal of an eBay Money Back Guarantee case decision has been closed.
This notification is sent to the subscribed buyer or seller when an eBay Money Back Guarantee case has been closed.
This notification is sent to a subscribed buyer or seller when that user receives a high-priority message in InBox.
<br><br>
If subscribed to by a buyer or seller, and when applicable, this notification will appear in the <b>GetMyMessages</b> call response. For this notification to be returned in <b>GetMyMessages</b>, the <b>DetailLevel</b> value in the <b>GetMyMessages</b> request must be set to <code>ReturnMessages</code>.
<br><br>
<b>MyMessagesHighPriorityMessage</b>, <b>MyMessagesM2MMessage</b>, and <b>MyMessagesHighPriorityMessageHeader</b> cannot
be subscribed to at the same time or specified in the same call.
This notification is sent to a subscribed buyer or seller when that user receives a high-priority message in InBox.
<br><br>
If subscribed to by a buyer or seller, and when applicable, this notification will appear in the <b>GetMyMessages</b> call response. For this notification to be returned in <b>GetMyMessages</b>, the <b>DetailLevel</b> value in the <b>GetMyMessages</b> request must be set to <code>ReturnHeaders</code>.
<br><br>
<b>MyMessagesHighPriorityMessage</b>, <b>MyMessagesM2MMessage</b>, and <b>MyMessagesHighPriorityMessageHeader</b> cannot
be subscribed to at the same time or specified in the same call.
This notification is sent to a subscribed buyer or seller when an eBay Money Back Guarantee case has been put on hold by eBay customer support.
This notification is sent to a subscribed seller after the buyer's payment on an order has cleared.
This notification is sent to a subscribed seller when eBay is prepared to send the seller's funds for an order that was previously placed on hold.
This notification is sent to a subscribed buyer when the listing of the auction item where the buyer has an active bid is about
to end. This event has a <b>TimeLeft</b> property that defines the 'ending soon' threshold value.
This notification is sent to a subscribed buyer when an item in the buyer's shopping cart is about
to end. This event has a <b>TimeLeft</b> property that defines the 'ending soon' threshold value.
This notification is sent to a subscribed buyer or seller when a return request involving those users is created.
This notification is sent to a subscribed seller when a return request is waiting for information from the seller, like a Return Merchandise Authorization (RMA) number or a correct return address.
This notification is sent to a subscribed buyer or seller when information from the seller (e.g. a Return Merchandise Authorization number) is overdue.
This notification is sent to a subscribed buyer or seller when the buyer has shipped a return item back to the seller.
This notification is sent to a subscribed buyer or seller when a return item is received by the seller.
This notification is sent to a subscribed buyer or seller when a refund to the buyer is overdue on a return.
This notification is sent to a subscribed buyer or seller when a return request is closed.
This notification is sent to a subscribed buyer or seller when a return request is escalated into a eBay Money Back Guarantee case.
This notification is sent to a subscribed seller when a buyer has requested an order cancellation.
This notification is no longer applicable. Do not use.
This notification is sent to a subscribed seller when a refund to the buyer has been successfully processed.
This notification is sent to a subscribed seller when a refund to the buyer has failed.
This notification is sent to a subscribed seller when the buyer has opened up an Item Not Received inquiry against an order line item.
This notification is sent to a subscribed seller alerting the seller that the buyer will soon be eligible to escalate an Item Not Received inquiry into an eBay Money Back Guarantee case.
This notification is sent to a subscribed seller alerting the seller that he/she should provide shipment tracking information to the buyer in order to expedite the closure of an Item Not Received inquiry, and to avoid the possibility that the buyer will escalate the inquiry into an eBay Money Back Guarantee case.
This notification is sent to a subscribed seller when an Item Not Received inquiry against an order line item has closed.
This notification is sent to a subscribed seller when an Item Not Received inquiry against an order line item has been escalated to an eBay Money Back Guarantee case.
This notification is sent to a subscribed buyer when an In-Store Pickup or Click and Collect order is ready to be picked up at the merchant's store.
This notification is sent to a subscribed seller when the quantity of a multiple-quantity, Good 'Til Cancelled, fixed-price listing has reached '0'. This notification will only be sent if the seller has the out-of-stock feature turned on in My eBay Preferences.
This notification is sent to a subscribed seller if an eBay courier was unable to deliver an eBay Scheduled Delivery order to a buyer. This notification is only applicable for eBay Scheduled Delivery orders, which are only available in the London (UK) area.
This notification is no longer applicable.
This notification is sent to a subscribed buyer if payment is still due for an order.
This notification is sent to a subscribed seller if an eBay courier has picked up an eBay On Demand Delivery order from a store for delivery to a buyer. This notification is only applicable for eBay On Demand Delivery orders, which are only available in the London (UK) area.
This notification is sent to a subscribed seller if an eBay On Demand Delivery order has been cancelled. This notification is only applicable for eBay On Demand Delivery orders, which are only available in the London (UK) area.
This notification is sent to a subscribed buyer or seller if the status of a member-to-member message has changed.
A template for an SMS notification message.
The SMS message.
Conditionally
The EIAS userId.
This type is deprecated.
eBLSchemaSOAP, CustomCode
New Schema format (used by the new schema XML API and SOAP API).
Reserved for internal or future use
Defines roles for platform notifications.
(in) Specifies that you want to set or return application-level
preferences. Default value.
(in) Specifies that you want to set or return user-level preferences.
(in) Specifies that you want to set or return user data-level preferences.
(in) Specifies that you want to set or return event-level preferences.
Reserved for future use
Summary information about notifications delivered, failed, errors, queued for
a given application ID and time period.
Returns the number of notifications delivered successfully during the given
time period.
GetNotificationsUsage
Always
Returns the number of new notifications that were queued during
the given time period.
GetNotificationsUsage
Always
Returns the number of pending notifications in the queue during
the given time period.
GetNotificationsUsage
Always
Returns the number of notifications that permanently failed during
the given time period.
GetNotificationsUsage
Always
Returns the number of notifications for which there were delivery errors
during the given time period.
GetNotificationsUsage
Always
User data related to notifications.
User data related to SMS notifications. SMS is currently reserved for future use.
SetNotificationPreferences
Conditionally
GetNotificationPreferences
Conditionally
User account activity summary alert delivery schedule.
Returned if PreferenceLevel is set to UserData in
GetNotificationPreferences.
See "Working with Platform Notifications" for instructions on
"Informational Alerts".
SetNotificationPreferences
Conditionally
GetNotificationPreferences
Conditionally
An application subscribing to notifications can include an XML-compliant
string, not to exceed 256 characters, which will be returned in the
notification payload. The string can contain user-specific information to
identify a particular user. Any sensitive information should be passed with due
caution and proper encryption.
SetNotificationPreferences
Conditionally
GetNotificationPreferences
Conditionally
This type is deprecated, as the maximum number of policy violations for a buyer is no longer a valid Buyer Requirement at the account or listing level.
GeteBayDetails
Conditionally
This field is deprecated.
1065
NoOp
1065
Type used by the <b>BidArray</b> container that is returned in the <b>GetAllBidders</b> response. The <b>BidArray</b> container is an array of all bids made on an auction listing that is specified in the call request.
Each <b>Offer</b> container consists of detailed information on each bid made on an auction listing that is specified in the call request. Information in this container includes the amount of the bid, the time of the bid, and data for the user making the bid.
GetAllBidders
Conditionally
<b>DO NOT USE THIS TYPE</b>. This type is only for internal or future use.
<b>DO NOT USE THIS FIELD</b>. This field is only for internal or future use.
Contains information pertaining to an offer made on an item listing and
the current bidding or purchase state of the listing.
Indicates the type of offer being made on the specified listing.
If the item is Best Offer-enabled and the buyer
makes a Best Offer (or a counter offer), then after
the <b>PlaceOffer</b> call,
the buyer can get the status of the Best Offer
(and a seller-counter-offer, etc.)
using the <b>GetBestOffers</b> call. See the
<a href="http://developer.ebay.com/DevZone/guides/features-guide/default.html#development/Feature-BestOffer.html">eBay Features Guide</a>
for information about Best Offer-enabled listings and about <b>GetBestOffers</b>.
GetAllBidders
Always
Absentee, Bid, BuyItNow, Cancelled, Counter, Decline, Offer, Purchase, Retraction, Unknown
PlaceOffer
Bid, Purchase, Accept, Counter, Decline, Offer
Yes
Three-digit currency code for the currency used for the auction. Valid values can
be viewed in the <b>CurrencyCodeType</b> code list.
GetAllBidders
Always
The unique identifier of an eBay listing item listed on the eBay site.
Returned by eBay when the item is created.
533
629
NoOp
PlaceOfferRequest.ItemID,ItemBidDetails.ItemID
Amount of the offer placed. For auction listings, the amount
bid on the item (subject to outbid by other buyers). For fixed-price
listings, the fixed sale price at which the item is purchased. For
auction listings with an active Buy It Now option, this amount
will be either the Buy It Now price for purchase or the amount of a bid,
depending on the offer type (as specified in <b>Action</b>). For <b>PlaceOffer</b>,
the <b>CurrencyID</b> attribute is ignored if provided. Regarding Value-Added Tax (VAT):
Even if VAT applies, you do not need to add VAT to the <b>MaxBid</b> value.
If VAT applies to the listing, the seller can specify a VAT percent value
when they list the item.
GetAllBidders
Always
PlaceOffer
Yes
<b>DO NOT USE THIS FIELD</b>. This field is only for internal or future use.
Specifies the quantity of items from the specified listing that the user tendering the offer intends to purchase, bid on, or make a Best Offer on. For auctions, the value is always <b>1 </b>. For multiple-quantity listings, this value must be greater than zero but not exceeding the quantity available for sale in the listing.
GetAllBidders
Always
PlaceOffer
Yes
Indicates the user's preference to accept second chance offers. If <code>true</code>,
the user is willing to be the recipient of second chance offers.
GetAllBidders
Always
Unique ID identifying the currency in which the localized offer amounts are
expressed.
GetAllBidders
Always
Timestamp indicating the date and time that the bid was placed.
GetAllBidders
Always
This amount indicates the highest bid that the corresponding bidder has made on the auction item. If that specific bidder has only made one bid on the auction listing, this value will be the same value as in the <b>MaxBid</b> field, but if the bidder has made multiple bids on the auction item, the <b>HighestBid</b> will show the highest of the bidder's bids, but <b>MaxBid</b> will show the value of the corresponding bid.
GetAllBidders
Always
Dollar amount of the bid in the user's currency. This field is always returned but its amount will be the same as the value in the <b>MaxBid</b> field, unless currency conversion was actually performed.
GetAllBidders
Always
The unique identifier of the order line item (transaction). An order line item
is created when a winning bidder commits to purchasing an
item.
This container consists of detailed information on the user that made the bid. Some information in this container will be masked unless the call is made by the owner of the listing.
GetAllBidders
Always
If <code>true</code>, confirms that the bidder read and agrees to eBay's
privacy policy. Applies if the subject item is in a category
that requires user consent. If user consent, which is
confirmation that a bidder read and agrees to eBay's privacy
policy, is required for a category that the subject item is in,
this value must be <code>true</code> for a bid to occur.
PlaceOffer
No
This field is deprecated.
A message from the buyer to the seller. Applies if the buyer
is using <b>PlaceOffer</b> to perform a Best Offer-related
action (Best Offer, Counter Offer, etc.).
PlaceOffer
No
The unique identifier of a Best Offer on an item. This value must be specified as input to <b>PlaceOffer</b> if a
buyer is performing any action against a Best Offer or Counter Offer.
PlaceOffer
Conditionally
The maximum bid placed by the user making the call. This field is only returned if the corresponding bid was made by the user making the call.
GetAllBidders
Conditionally
Type used by the <b>OrderArray</b> container that is returned in order management calls. The <b>OrderArray</b> container consists of one or more eBay orders that match the input criteria.
Details of an eBay order. One eBay order can have one or more order line items (<b>Transaction</b> objects).
GetOrders
DetailLevel: none, ReturnAll
Always
OrderReport
Always
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Always
http://developer.ebay.com/DevZone/guides/features-guide/default.html#development/Listing-AnItem.html#CombinedInvoice
Combined Invoice
Type defining the <b>OrderIDArray</b> container, which consists of an array of order IDs. The <b>OrderIDArray</b> container is used to specify one or more orders to retrieve in a <b>GetOrders</b> or <b>GetOrderTransactions</b> call.
A unique identifier for an eBay order. If one or more <b>OrderID</b> values are used in a <b>GetOrders</b> or <b>GetOrderTransactions</b> call, any order status or date range filters are ignored.
<br><br>
<span class="tablenote"><b>Note: </b> As of June 2019, eBay has changed the format of order identifier values. The new format is a non-parsable string, globally unique across all eBay marketplaces, and consistent for both single line item and multiple line item orders. Unlike in the past, instead of just being known and exposed to the seller, these unique order identifiers will also be known and used/referenced by the buyer and eBay customer support.
<br><br>
For developers and sellers who are already integrated with the Trading API's order management calls, this change shouldn't impact your integration unless you parse the existing order identifiers (e.g., <b>OrderID</b> or <b>OrderLineItemID</b>), or otherwise infer meaning from the format (e.g., differentiating between a single line item order versus a multiple line item order). Because we realize that some integrations may have logic that is dependent upon the old identifier format, eBay is rolling out this Trading API change with version control to support a transition period of approximately 9 months before applications must switch to the new format completely.
<br><br>
During the transition period, for developers/sellers using a Trading WSDL older than Version 1113, they can use the <b>X-EBAY-API-COMPATIBILITY-LEVEL</b> HTTP header in API calls to control whether the new or old <b>OrderID</b> format is returned in call response payloads. To get the new <b>OrderID</b> format, the value of the <b>X-EBAY-API-COMPATIBILITY-LEVEL</b> HTTP header must be set to <code>1113</code>. During the transition period and even after, the new and old <b>OrderID</b> formats will still be supported/accepted in all Trading API call request payloads. After the transition period (which will be announced), only the new <b>OrderID</b> format will be returned in all Trading API call response payloads, regardless of the Trading WSDL version used or specified compatibility level.
</span>
<br>
<span class="tablenote"><b>Note: </b> For sellers integrated with the new order ID format, please note that the identifier for an order will change as it goes from unpaid to paid status. Sellers can check to see if an order has been paid by looking for a value of 'Complete' in the <b>CheckoutStatus.Status</b> field in the response of <b>GetOrders</b> or <b>GetOrderTransactions</b> call, or in the <b>Status.CompleteStatus</b> field in the response of <b>GetItemTransactions</b> or <b>GetSellerTransactions</b> call. When using a <b>GetOrders</b> or <b>GetOrderTransactions</b> call to retrieve specific order(s), either of these order IDs (paid or unpaid status) can be used to retrieve an order.
</span>
40
GetOrders
DetailLevel: none, ReturnAll
Conditionally
GetOrderTransactions
Conditionally
Type that represents the unique identifier for an eBay order.
<br><br>
<span class="tablenote"><b>Note: </b> As of June 2019, eBay has changed the format of order identifier values. The new format is a non-parsable string, globally unique across all eBay marketplaces, and consistent for both single line item and multiple line item orders. Unlike in the past, instead of just being known and exposed to the seller, these unique order identifiers will also be known and used/referenced by the buyer and eBay customer support.
<br><br>
For developers and sellers who are already integrated with the Trading API's order management calls, this change shouldn't impact your integration unless you parse the existing order identifiers (e.g., <b>OrderID</b> or <b>OrderLineItemID</b>), or otherwise infer meaning from the format (e.g., differentiating between a single line item order versus a multiple line item order). Because we realize that some integrations may have logic that is dependent upon the old identifier format, eBay is rolling out this Trading API change with version control to support a transition period of approximately 9 months before applications must switch to the new format completely.
<br><br>
During the transition period, for developers/sellers using a Trading WSDL older than Version 1113, they can use the <b>X-EBAY-API-COMPATIBILITY-LEVEL</b> HTTP header in API calls to control whether the new or old <b>OrderID</b> format is returned in call response payloads. To get the new <b>OrderID</b> format, the value of the <b>X-EBAY-API-COMPATIBILITY-LEVEL</b> HTTP header must be set to <code>1113</code>. During the transition period and even after, the new and old <b>OrderID</b> formats will still be supported/accepted in all Trading API call request payloads. After the transition period (which will be announced), only the new <b>OrderID</b> format will be returned in all Trading API call response payloads, regardless of the Trading WSDL version used or specified compatibility level.
</span>
<br>
<span class="tablenote"><b>Note: </b> For sellers integrated with the new order ID format, please note that the identifier for an order will change as it goes from unpaid to paid status. Sellers can check to see if an order has been paid by looking for a value of 'Complete' in the <b>CheckoutStatus.Status</b> field in the response of <b>GetOrders</b> or <b>GetOrderTransactions</b> call, or in the <b>Status.CompleteStatus</b> field in the response of <b>GetItemTransactions</b> or <b>GetSellerTransactions</b> call. When using a <b>GetOrders</b> or <b>GetOrderTransactions</b> call to retrieve specific order(s), either of these order IDs (paid or unpaid status) can be used to retrieve an order.
</span>
This enumerated type is deprecated
Enumerated type that defines the possible values for order states. Some of these values can be used as <b>OrderStatus</b> filters in the <b>GetOrders</b> request payload, and some of these values may be returned in any of the order management calls under the <b>OrderStatus</b> field. See the individual value descriptions for more information on how they are used and/or when they are returned.
Authenticated, Default, Invalid, Shipped
This value indicates that the order is not yet complete. An order in the <code>Active</code> state means that the buyer has not initiated payment for the order. While an order is in this state, it can be combined into a <a href="https://developer.ebay.com/DevZone/guides/features-guide/default.html#development/Listing-AnItem.html#CombinedInvoice">Combined Invoice</a>, a buyer can request a cancellation, and/or a seller can update payment details (including a change in order price) or shipping details (including shipping cost and shipping service).
<br><br>
This value can be used a filter value in the <b>OrderStatus</b> field of the <b>GetOrders</b> request payload, and it can also be returned in any of the order management calls.
This value can be used a filter value in the <b>OrderStatus</b> field, and if used, all inactive orders will be returned.
This value indicates that the order is paid for and complete. An order in the <code>Completed</code> state means that no other changes to the order can be made.
<br><br>
This value can be used a filter value in the <b>OrderStatus</b> field of the <b>GetOrders</b> request payload, and it can also be returned in any of the order management calls.
This value indicates that the order has been cancelled. Depending on whether payment was made or not, the seller may also need to refund the buyer after an order is cancelled.
<br><br>
This value can be used a filter value in the <b>OrderStatus</b> field of the <b>GetOrders</b> request payload, and it can also be returned in any of the order management calls.
This enumeration value was only used for the deprecated Half.com site, so is no longer applicable and should not be used as an <b>OrderStatus</b> value in the <b>GetOrders</b> request payload.
This value is not used.
This enumeration value is no longer applicable and should not be used as an <b>OrderStatus</b> value in the <b>GetOrders</b> request payload.
This enumeration value indicates that the order is currently in the state of being processed, but is not yet complete.
<br><br>
This value is not supported by the <b>OrderStatus</b> field of the <b>GetOrders</b> request payload, but it can be returned in any of the order management calls.
This enumeration value is no longer applicable and should not be used as an <b>OrderStatus</b> value in the <b>GetOrders</b> request payload.
Reserved for internal or future use.
This enumeration value is passed into the <b>OrderStatus</b> of <b>GetOrders</b> to retrieve orders in all states. This is the default value. This value is not applicable to the response payloads of the order management calls.
This value indicates that a buyer has initiated a cancellation request on the order. If a seller sees an order in this state, that seller must either approve or reject the cancellation request through My eBay Web flows or through the Post-Order API cancellation calls.
<br/><br/>
This enumeration value cannot be used as an <b>OrderStatus</b> value in the <b>GetOrders</b> request payload.
All applicable sold listings, regardless of
their Paid or Shipped status.
Sold listings that have not yet been marked as
Paid in My eBay.
Sold listings that have not yet been marked as
Shipped in My eBay.
Sold listings that have been marked as
Paid and Shipped in My eBay.
Reserved for future or internal use.
Type used by the <b>OrderTransactionArray</b> container that is returned in the <b>GetMyeBaySelling</b> and <b>GetMyeBayBuying</b> calls. The <b>OrderTransactionArray</b> container consists a list of orders and each order line item in that order.
This container consists of detailed information on a specific order and each order line item in that order.
GetMyeBayBuying
Conditionally
WonList
DeletedFromWonList
DetailLevel: none, ReturnAll
GetMyeBaySelling
SoldList
DeletedFromSoldList
DetailLevel: none, ReturnAll
Conditionally
Contains an order or a transaction. A transaction is the sale of one or
more items from a seller's listing to a buyer. An order combines two or more transactions
into a single payment.
Contains the information describing an order.
GetMyeBayBuying
Conditionally
WonList
DeletedFromWonList
DetailLevel: none, ReturnAll
GetMyeBaySelling
SoldList
DeletedFromSoldList
DetailLevel: none, ReturnAll
Conditionally
Contains the information describing a transaction.
GetMyeBayBuying
WonList
DeletedFromWonList
DetailLevel: none, ReturnAll
Conditionally
GetMyeBaySelling
SoldList
DeletedFromSoldList
DetailLevel: none, ReturnAll
Conditionally
This type is used to express the details of an order. An order may contain one or more line items (purchases) from the same buyer. Regardless of how many line items an order has, only one payment is made for the order.
<br><br>
The <b>GetOrders</b> and <b>GetOrderTransactions</b> calls return many of the fields of this type.
<br><br>
The <b>GetItemTransactions</b> and <b>GetSellerTransactions</b> calls will only return order-level details if the <b>IncludeContainingOrder</b> boolean field is included in the call request and set to <code>true</code>.
<br><br>
The <b>AddOrder</b> call is used to combine two or more unpaid order line items (between the same seller and buyer) into a 'Combined Invoice' order. While combining these order line items into one 'Combined Invoice' order, the seller can make adjustments to accepted payment methods, shipping details (including costs), and the total cost of the order. Sometimes, sellers will reduce the cost of shipping if one or more order line items can be shipped together in the same package.
<br><br>
The <b>GetMyeBaySelling</b> call returns order details if the seller wishes to view listings that have sold, and the <b>GetMyeBayBuying</b> call returns order details if the buyer wishes to view items they have won or purchased.
A unique identifier for a single or multiple line item eBay order. In the <b>ContainingOrder</b> container of a <b>GetItemTransactions</b> or <b>GetSellerTransactions</b> response, this identifier identifies the parent order of the order line item. A single buyer payment is made for each order.
<br/><br/>
<b>For order management calls only:</b> This field is returned with the correct order ID only to the buyer, the seller, and PayPal (if PayPal is the payment method). For third parties (except PayPal):
<ul>
<li>If using a Trading WSDL older than version 1019, the Order ID will be returned to third parties as dummy data in the form of <code>1000000000000</code> or <code>1000000000000-1000000000000</code>.</li>
<li>If using Trading WSDL version 1019 or newer, the Order ID will be returned to third parties as an empty field (<code><OrderID/></code>).</li>
</ul>
<br/>
<span class="tablenote"><b>Note: </b> As of June 2019, eBay has changed the format of order identifier values. The new format is a non-parsable string, globally unique across all eBay marketplaces, and consistent for both single line item and multiple line item orders. Unlike in the past, instead of just being known and exposed to the seller, these unique order identifiers will also be known and used/referenced by the buyer and eBay customer support.
<br><br>
For developers and sellers who are already integrated with the Trading API's order management calls, this change shouldn't impact your integration unless you parse the existing order identifiers (e.g., <b>OrderID</b> or <b>OrderLineItemID</b>), or otherwise infer meaning from the format (e.g., differentiating between a single line item order versus a multiple line item order). Because we realize that some integrations may have logic that is dependent upon the old identifier format, eBay is rolling out this Trading API change with version control to support a transition period of approximately 9 months before applications must switch to the new format completely.
<br><br>
During the transition period, for developers/sellers using a Trading WSDL older than Version 1113, they can use the <b>X-EBAY-API-COMPATIBILITY-LEVEL</b> HTTP header in API calls to control whether the new or old <b>OrderID</b> format is returned in call response payloads. To get the new <b>OrderID</b> format, the value of the <b>X-EBAY-API-COMPATIBILITY-LEVEL</b> HTTP header must be set to <code>1113</code>. During the transition period and even after, the new and old <b>OrderID</b> formats will still be supported/accepted in all Trading API call request payloads. After the transition period (which will be announced), only the new <b>OrderID</b> format will be returned in all Trading API call response payloads, regardless of the Trading WSDL version used or specified compatibility level.
</span>
<br>
<span class="tablenote"><b>Note: </b> For sellers integrated with the new order ID format, please note that the identifier for an order will change as it goes from unpaid to paid status. Sellers can check to see if an order has been paid by looking for a value of 'Complete' in the <b>CheckoutStatus.Status</b> field in the response of <b>GetOrders</b> or <b>GetOrderTransactions</b> call, or in the <b>Status.CompleteStatus</b> field in the response of <b>GetItemTransactions</b> or <b>GetSellerTransactions</b> call. Sellers should not fulfill orders until buyer has made payment. When using a <b>GetOrders</b> or <b>GetOrderTransactions</b> call to retrieve specific order(s), either of these order IDs (paid or unpaid status) can be used to retrieve an order.
</span>
40
GetMyeBayBuying
WonList
DeletedFromWonList
DetailLevel: none, ReturnAll
Conditionally
GetMyeBaySelling
SoldList
DeletedFromSoldList
DetailLevel: none, ReturnAll
Conditionally
GetOrders
DetailLevel: none, ReturnAll
Always
OrderReport
Always
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Always
GetItemTransactions
GetSellerTransactions
ContainingOrder
DetailLevel: none, ReturnAll
Conditionally
This enumeration value indicates the current status of the order.
GetOrders
All, Authenticated, Default, Inactive, Invalid, Shipped
DetailLevel: none, ReturnAll
Always
OrderReport
All, Authenticated, Default, Inactive, Invalid, Shipped
Always
GetOrderTransactions
All, Authenticated, Default, Inactive, Invalid, Shipped
DetailLevel: none, ItemReturnDescription, ReturnAll
Always
GetItemTransactions
GetSellerTransactions
All, Authenticated, Default, Inactive, Invalid, Shipped
DetailLevel: none, ReturnAll
Conditionally
This value indicates the dollar amount by which the buyer has adjusted the order total. Adjustments to order costs may include shipping and handling, buyer discounts, or added services. A positive amount indicates the amount is an extra charge being paid to the seller by the buyer. A negative value indicates this amount is a credit given to the buyer by the seller.
GetOrders
DetailLevel: none, ReturnAll
Always
OrderReport
Always
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Always
This value indicates the total amount paid by the buyer for the order. This amount includes the sale price of each line item, shipping and handling charges, additional services, and any sales tax that the seller has applied towards the order. This value is only returned after the buyer has paid for the order.
<br><br>
<span class="tablenote"><b>Note: </b> As of November 2019, for orders subject to eBay 'Collect and Remit' taxes, PayPal has begun distributing order funds to the seller's account with the sales tax included. eBay 'Collect and Remit' tax includes US sales tax for numerous states, and 'Good and Services' tax that is applicable to Australian and New Zealand sellers. This 'Collect and Remit' tax amount for the order will be included in the <b>AmountPaid</b> value. To determine if 'Collect and Remit' taxes were added into <b>AmountPaid</b> value, the user can check for the <b>Transaction.eBayCollectAndRemitTaxes.TaxDetails</b> and the <b>Transaction.Taxes.TaxDetails</b> containers in the response. If both of these containers appear in the response with a <b>TaxDetails.TaxDescription</b> value of <code>SalesTax</code> (in US) or <code>GST</code> (in Australia or New Zealand), the tax amount that the buyer paid is in this amount.
<br><br>
Sellers should be aware that the sales tax that the buyer pays for the order will initially be included when the order funds are distributed to their PayPal account, but that PayPal will pull out the sales tax amount shortly after the payment clears, and will distribute the sales tax to the appropriate taxing authority. Previous to this change, PayPal would strip out the 'Collect and Remit' tax before distributing order funds to the seller's account.
<br><br>
This logic change does not apply to sellers who are in eBay managed payments, so the amount in this field will never reflect any 'Collect and Remit' tax, even if the order is subject to 'Collect and Remit' tax.
</span>
GetOrders
DetailLevel: none, ReturnAll
Conditionally
OrderReport
Conditionally
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
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. This field is always returned even when it is '0.0'.
GetOrders
DetailLevel: none, ReturnAll
Always
OrderReport
Always
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Always
This container indicates the current status of the order, including a timestamp that indicates the last time that the status of the order changed. For orders that have been paid for, the <b>Status</b> value will show as <code>Complete</code>.
GetOrders
DetailLevel: none, ReturnAll
Always
OrderReport
Always
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Always
Container consisting of order-level shipping details. More shipping-related details can be found at the line item level for each line item in the order.
<br><br>
In an <b>AddOrder</b> call, the seller can use the <b>ShippingDetails</b> container to make adjustments to shipping details, including the available shipping service options and shipping cost. Sometimes, sellers will reduce the cost of shipping if one or more order line items can be shipped together in the same package.
GetOrders
DetailLevel: none, ReturnAll
Always
OrderReport
Always
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Always
AddOrder
No
GetMyeBayBuying
WonList
DeletedFromWonList
DetailLevel: none, ReturnAll
Conditionally
ShippingServiceOptions, ShippingType
This value indicates whether a 'Combined Invoice' order was initiated/created by the buyer or by the seller. This field is only returned for Combined Invoice orders.
<br><br>
An <b>AddOrder</b> call can be used by a seller or buyer to combine two or more unpaid order line items into a 'Combined Invoice' order. Once two or more line items are successfully combined into one order, the buyer only needs to make one payment (instead of multiple payments - one for each order line item). The <b>CreatingUserRole</b> field is required in the <b>AddOrder</b> call request.
<br><br>
<span class="tablenote"><b>Note: </b> Except for listings that required immediate payment, buyers also may have the opportunity to combine multiple line items (from the same seller) into a 'Combined Invoice' order through the buy/checkout flow. This may include accepted Best Offers or auctions that the buyer wins.
</span>
http://developer.ebay.com/DevZone/guides/features-guide/default.html#development/Listing-AnItem.html#CombinedInvoice
Combined Invoice
GetOrders
DetailLevel: none, ReturnAll
Conditionally
OrderReport
Conditionally
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
AddOrder
Yes
Timestamp that indicates the date and time that the order was created.
<br><br>
<span class="tablenote"><b>Note: </b> For
single line item orders, this timestamp value is often the same as the <b>CreatedDate</b> field in the corresponding
<b>Transaction</b> container.
</span>
GetOrders
DetailLevel: none, ReturnAll
Always
OrderReport
Always
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Always
A <b>PaymentMethods</b> field will appear for each payment method available to the buyer for the order's purchase. However, once the buyer pays for the order, any and all of these <b>PaymentMethods</b> fields will stop being returned, and instead, the actual payment method used will be returned in the <b>PaymentMethod</b> field of the <b>CheckoutStatus</b> container.
<br>
<br>
In an <b>AddOrder</b> call, the seller can use one or more <b>PaymentMethods</b> fields to override whatever available payment methods were already defined for each individual line item. For sellers opted in to eBay Managed Payments, only the <code>CreditCard</code> enumeration value should be passed into this field or the call may fail.
<br>
<br>
<span class="tablenote"><b>Note:</b> For sellers opted in to the new eBay Managed Payments program, the enumeration value returned in this field will be <code>CreditCard</code>, regardless of which payment method that the buyer used (or is planning to use). <br><br>Similarly, for an <b>AddOrder</b> call, a seller opted in to eBay Managed Payments should only pass a value of <code>CreditCard</code> into this field.<br><br> eBay Managed Payments is currently only available to a limited number of sellers on the US site. For sellers in the eBay Managed Payments program, a payment method does not need to be specified at listing/checkout time.
</span><br>
<span class="tablenote"><b>Note:</b> As of May 1, 2019, eBay no longer supports electronic payments through a seller's Integrated Merchant Credit Card account. To accept online credit card payments from buyers, a seller must either specify <code>PayPal</code> as an accepted payment method, or opt in to the eBay Managed Payments program. If <code>IMCC</code> is passed in as a value, this value will be ignored and dropped (and listing will possibly get blocked if <code>IMCC</code> is the only specified payment method).
</span>
AddOrder
Conditionally
CreditCard, DirectDebit
GetOrders
DetailLevel: none, ReturnAll
Always
OrderReport
Always
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Always
The email address of the seller involved in the order. The email address of the seller is only returned if it is the same seller making the call.
GetOrders
DetailLevel: none, ReturnAll
Conditionally
OrderReport
Conditionally
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
AddOrder
No
Container holding the shipping address of the buyer involved in the order.
<br>
<br>
<span class="tablenote"><b>Note:</b> For GetOrderTransactions, the buyer's shipping address may also be returned at the order line item level in the <b>Transaction.Buyer.BuyerInfo.ShippingAddress</b> container.
</span><br>
GetOrders
DetailLevel: none, ReturnAll
Always
OrderReport
Always
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Always
Container consisting of details about the domestic or international shipping
service selected by the buyer for delivery of the order. Note that more shipping service information may be returned at the order line item level in the <strong>Transaction.ShippingServiceSelected</strong> container.
GetOrders
DetailLevel: none, ReturnAll
Always
OrderReport
Always
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Always
The cumulative item cost for all line items in the order. This value does not take into account any shipping/handling costs, sales tax costs, or any discounts. For a single line item order, the amount in this field should be the same as the amount in the <strong>Transaction.TransactionPrice</strong> field. For a multiple line item order, the amount in this field should equal the cumulative amount of each <strong>Transaction.TransactionPrice</strong> fields for each order line item.
GetMyeBayBuying
WonList
DeletedFromWonList
DetailLevel: none, ReturnAll
Conditionally
GetMyeBaySelling
SoldList
DeletedFromSoldList
DetailLevel: none, ReturnAll
Conditionally
GetOrders
DetailLevel: none, ReturnAll
Always
OrderReport
Always
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Always
The <b>Total</b> amount shows the total cost for the order, including total item cost (shown in <b>Subtotal</b> field), shipping charges (shown in <b>ShippingServiceSelected.ShippingServiceCost</b> field), and seller-applied sales tax (shown in <b>SalesTax.SalesTaxAmount</b> field).
<br><br>
In an <b>AddOrder</b> call, the seller can pass in the <b>Total</b> amount for the 'Combined Invoice' order, and this is what the buyer will be expected to pay for the order.
<br><br>
<span class="tablenote"><b>Note: </b> As of November 2019, for orders subject to eBay 'Collect and Remit' taxes, PayPal has begun distributing order funds to the seller's account with the sales tax included. eBay 'Collect and Remit' tax includes US sales tax for numerous states, and 'Good and Services' tax that is applicable to Australian and New Zealand sellers. This 'Collect and Remit' tax amount for the order will be included in the <b>Total</b> value. To determine if 'Collect and Remit' taxes were added into <b>Total</b> value, the user can check for the <b>Transaction.eBayCollectAndRemitTaxes.TaxDetails</b> and the <b>Transaction.Taxes.TaxDetails</b> containers in the response. If both of these containers appear for one or more transactions in the response with a <b>TaxDetails.TaxDescription</b> value of <code>SalesTax</code> (in US) or <code>GST</code> (in Australia or New Zealand), the tax amount that the buyer paid is in this amount. For a multiple line item order, the seller will need to look at and add up the <b>TaxDetails.TaxAmount</b> values for each line item to see how much sales tax is applicable for the whole order.
<br><br>
Sellers should be aware that the sales tax that the buyer pays for the order will initially be included when the order funds are distributed to their PayPal account, but that PayPal will pull out the sales tax amount shortly after the payment clears, and will distribute the sales tax to the appropriate taxing authority. Previous to this change, PayPal would strip out the 'Collect and Remit' tax before distributing order funds to the seller's account.
<br><br>
This logic change does not apply to sellers who are in eBay managed payments, so the amount in this field will never reflect any 'Collect and Remit' tax, even if the order is subject to 'Collect and Remit' tax.
</span>
GetOrders
DetailLevel: none, ReturnAll
Always
OrderReport
Always
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Always
AddOrder
Yes
Container consisting of payment details for an eBay order, including an identifier for the monetary transaction and a field to express any fees or credits applied to the monetary transaction. This field is only returned after payment for the order has occurred.
<br><br>
<span class="tablenote">
<strong>Note:</strong> The <strong>MonetaryDetails</strong> container also shows payment information for the order. In the future, it is possible that the <strong>ExternalTransaction</strong> container will be deprecated, so you are encouraged to start using <strong>MonetaryDetails</strong> as soon as possible.
</span>
GetOrderTransactions
GetOrders
DetailLevel: ReturnAll
Conditionally
OrderReport
Conditionally
Container consisting of one or more line items that comprise an order. The data for each order line item in the order is stored in a separate <b>Transaction</b> container.
<br><br>
Under the <b>TransactionArray</b> container in an <b>AddOrder</b> call, a seller or buyer specifies two or more (up to 40) order line items into a 'Combined Invoice' order.
http://developer.ebay.com/DevZone/guides/features-guide/default.html#development/Listing-AnItem.html#CombinedInvoice
Combined Invoice
GetOrders
DetailLevel: none, ReturnAll
Always
OrderReport
Always
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Always
GetMyeBayBuying
WonList
DeletedFromWonList
DetailLevel: none, ReturnAll
Conditionally
GetMyeBaySelling
SoldList
DeletedFromSoldList
DetailLevel: none, ReturnAll
Conditionally
AddOrder
Yes
The eBay user ID of the order's buyer.
GetOrders
DetailLevel: none, ReturnAll
Always
OrderReport
Always
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Always
Timestamp indicating the date and time of order payment. This field is not
returned until payment has been made by the buyer.
<br><br>
This time is specified in GMT (not Pacific time).
See <a href="http://developer.ebay.com/DevZone/guides/features-guide/default.html#basics/DataTypes.html#ConvertingBetweenUTCGMTandLocalTime"> eBay Features Guide</a>
for information about converting between GMT and other time zones.
GetOrders
DetailLevel: none, ReturnAll
Conditionally
OrderReport
Conditionally
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
Timestamp indicating the date and time of order shipment. This field is not returned until shipment tracking is provided for all line items in the order, or if the order has been marked as 'shipped' by the seller.
<br><br>
This time is specified in GMT (not Pacific time).
See <a href="http://developer.ebay.com/DevZone/guides/features-guide/default.html#basics/DataTypes.html"> eBay Features Guide</a>
for information about converting between GMT and other time zones.
GetOrders
DetailLevel: none, ReturnAll
Conditionally
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
This field being returned with a value of <code>true</code> indicates that the order can be paid for with a credit card through the seller's payment gateway account.
<br><br>
<span class="tablenote"><b>Note: </b>
As of May 1, 2019, eBay no longer supports electronic payments through Integrated Merchant Credit Card accounts. To accept online credit card payments from buyers, a seller must specify PayPal as an accepted payment method, or opt in to eBay Managed Payments program (if the program is available to that seller).
</span>
GetOrders
DetailLevel: none, ReturnAll
Always
OrderReport
Always
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Always
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ReturnAll
Conditionally
Reserved for future use.
This field is returned if the buyer left a message for the seller during
checkout.
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetOrders
DetailLevel: none, ReturnAll
Conditionally
OrderReport
Conditionally
Unique identifier for the user that does not change when the eBay user name
is changed. Use when an application needs to associate a new eBay user name
with the corresponding eBay user.
<br><br>
Since a bidder's user info is anonymous, this tag will be returned only to that bidder, and to the seller of an item that the user is bidding on.
GetOrders
DetailLevel: none, ReturnAll
Conditionally
OrderReport
Conditionally
This field indicates the type and/or status of a payment hold on the item. It is always returned for <b>GetOrders</b> and <b>GetOrderTransactions</b>, even if there are no payment holds (in which case, an enumeration value of <code>None</code> is shown).
GetOrders
DetailLevel: none
Always
OrderReport
Always
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Always
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ReturnAll
Conditionally
This container consists of information related to the payment hold
on the order, including the reason why the buyer's payment for the order is
being held, the expected release date of the funds into the seller's
account, and possible action(s) the seller can take to expedite the payout
of funds into their account. This container is only returned if a payment hold has placed on the order.
<br><br>
See <b>PaymentHoldReasonCodeType</b> for some details on why/when a seller's funds may be held, or visit the <a href="https://www.ebay.com/help/selling/getting-paid/getting-paid-items-youve-sold/pending-payments?id=4816">Pending payments</a> help topic for more information on eBay's payment hold policies.
GetOrders
DetailLevel: none
Conditionally
OrderReport
Conditionally
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ReturnAll
Conditionally
The amount of the refund due to, or already issued to the buyer for the order. This field is only returned in <b>GetMyeBaySelling</b> if a buyer refund is due, or was issued for the order.
GetMyeBaySelling
SoldList
DetailLevel: none, ReturnAll
Conditionally
This string value indicates the result of a seller's refund to the buyer. Its value are 'Success', 'Failure' or 'Pending'. This field is only returned in <b>GetMyeBaySelling</b> if the buyer has received a refund from the seller, or is due to receive a refund.
GetMyeBaySelling
SoldList
DetailLevel: none, ReturnAll
Conditionally
<span class="tablenote"><b>Note: </b> This container was only used for Half.com orders, and since the Half.com site was taken down, this container is no longer applicable.
</span>
1027
NoOp
1033
If <strong>IsMultilegShipping</strong> is <code>true</code>, at least one order line item in the order will use the Global Shipping Program (GSP) to ship internationally. With GSP, the shipment has a domestic leg and an international leg. In the domestic leg, the seller ships the item to eBay's shipping partner. This shipping address can be found in the <strong>MultiLegShippingDetails.SellerShipmentToLogisticsProvider.ShipToAddress</strong> container. eBay's shipping partner will be responsible for the international leg of the shipment and the order's final destination.
GetOrders
DetailLevel: none, ReturnAll
Conditionally
OrderReport
Conditionally
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ReturnAll
Conditionally
This container consists of details about the domestic leg of a Global Shipping Program (GSP) shipment. With GSP, the shipment has a domestic leg and an international leg. In the domestic leg, the seller ships the item to eBay's shipping partner.
<br/><br/>
This container is only returned if the order has one or more order line items that require shipping through GSP. It is not returned if <strong>IsMultilegShipping</strong> is <code>false</code>.
GetOrders
DetailLevel: none, ReturnAll
Conditionally
OrderReport
Conditionally
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ReturnAll
Conditionally
Contains information about each monetary transaction that occurs for the order, including order payment, any refund, a credit, etc. Both the payer and payee are shown in this container.
<br/><br/>
<span class="tablenote">
<strong>Note:</strong> <strong>MonetaryDetails</strong> can already be used instead of the older <strong>ExternalTransaction</strong> container, and the <strong>ExternalTransaction</strong> container may eventually get deprecated. Due to this possibility, you are encouraged to start using <strong>MonetaryDetails</strong> as soon as it is convenient.
</span>
GetOrders
DetailLevel:ReturnAll
Conditionally
OrderReport
Conditionally
GetOrderTransactions
DetailLevel:ItemReturnDescription, ReturnAll
Conditionally
GetItemTransactions
GetSellerTransactions
DetailLevel:ReturnAll
Conditionally
Container consisting of an array of <strong>PickupOptions</strong> containers. Each <strong>PickupOptions</strong> container consists of the pickup method and its priority. The priority of each pickup method controls the order (relative to other pickup methods) in which the corresponding pickup method will appear in the View Item and Checkout page.
<br/><br/>
For <strong>GetOrders</strong> and <strong>GetOrderTransactions</strong>, this container is always returned prior to order payment if the seller created/revised/relisted the item with the <strong>EligibleForPickupInStore</strong> and/or <strong>EligibleForPickupDropOff</strong> flag in the call request set to 'true'. If and when the In-Store pickup method (US only) or 'Click and Collect' pickup method (UK and Australia only) is selected by the buyer and payment for the order is made, this container will no longer be returned in the response, and will essentially be replaced by the <strong>PickupMethodSelected</strong> container.
<br/><br/>
<span class="tablenote">
<strong>Note:</strong> A seller must be eligible for the In-Store Pickup feature or Click and Collect feature to list an item that is eligible for In-Store Pickup or Click and Collect. At this time, the In-Store Pickup and Click and Collect features are generally only available to large retail merchants, and can only be applied to multiple-quantity, fixed-price listings.
</span>
GetOrders
DetailLevel: none, ReturnAll
Conditionally
OrderReport
Conditionally
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetMyeBayBuying
WonList
DeletedFromWonList
DetailLevel: none, ReturnAll
Conditionally
Container consisting of details related to the selected pickup method, including the pickup method type, the merchant's store ID, the status of the pickup, and the pickup reference code (if provided by merchant).
<br/><br/>
This container is only returned when the buyer has selected the In-Store Pickup or Click and Collect option and has paid for the order. All fields in the <strong>PickupMethodSelected</strong> container are static, except for the <strong>PickupStatus</strong> field, which can change states based on the notifications that a merchant sends to eBay through the Inbound Notifications API.
<br/><br/>
<span class="tablenote">
<strong>Note:</strong> A seller must be eligible for the In-Store Pickup or Click and Collect feature to list an item that is eligible for these features. At this time, the In-Store Pickup and Click and Collect features are generally only available to large retail merchants, and can only be applied to multiple-quantity, fixed-price listings.
</span>
GetOrders
DetailLevel: none, ReturnAll
Conditionally
OrderReport
Conditionally
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetMyeBayBuying
WonList
DeletedFromWonList
DetailLevel: none, ReturnAll
Conditionally
This is the eBay user ID of the order's seller.
GetOrders
DetailLevel: none, ReturnAll
Conditionally
OrderReport
Conditionally
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
This is a unique identifier for the seller that does not change when the eBay user name is changed. This is useful when an application needs to associate a new eBay user name with the corresponding eBay user.
GetOrders
DetailLevel: none, ReturnAll
Conditionally
OrderReport
Conditionally
This value indicates the reason why the order cancellation was initiated. This field is only returned if an order cancellation has been initiated by the buyer or seller. Typical buyer-initiated cancellation reasons include 'OrderPlacedByMistake', 'WontArriveInTime', or 'FoundCheaperPrice'. Sellers may initiate an order cancellation on behalf of the buyer. In this scenario, the seller should state the cancellation reason as 'BuyerCancelOrder'. If the seller is cancelling an order because he/she is out of stock on an item, the seller should state the cancellation reason as 'OutOfStock'. Unfortunately, in this scenario, the seller will receive a seller defect for this cancellation reason. See <a href="types/CancelReasonCodeType.html">CancelReasonCodeType</a> for the complete list of enumeration values that can be returned in this field.
<br><br>
<span class="tablenote"><strong>Note:</strong>
Currently, the <b>CancelReason</b> field is being returned under the <b>Order</b> container and under the <b>CancelDetail</b> container. However, there are plans to deprecate this field from <b>OrderType</b> in the future.
</span>
CancelReasonCodeType
GetOrders
DetailLevel: none, ReturnAll
Conditionally
OrderReport
Conditionally
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
The current status for the order cancellation request (if it exists for the order). This field is only returned if a cancellation request has been made on the order, or if the order is currently going through the cancellation process, or if the order has already been cancelled.
GetOrders
DetailLevel: none, ReturnAll
Conditionally
OrderReport
Conditionally
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
The detailed reason for the cancellation of an eBay order. This field is only returned if it is available when a cancellation request has been made on the order, or if the order is currently going through the cancellation process, or if the order has already been cancelled.
<br><br>
<span class="tablenote"><strong>Note:</strong>
Currently, the <b>CancelReasonDetails</b> field is being returned under the <b>Order</b> container and under the <b>CancelDetail</b> container. However, there are plans to deprecate this field from <b>OrderType</b> in the future.
</span>
GetOrders
DetailLevel: none, ReturnAll
Conditionally
OrderReport
Conditionally
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
<span class="tablenote"><strong>Note:</strong>
This field is no longer applicable/used. It was previously used for eBay Now and 'eBay On Demand Delivery' orders - two features that have been deprecated.
</span>
1095
1095
NoOp
This container consists of details related to an eBay order that has been cancelled or is in the process of possibly being cancelled. Order cancellation requests can be viewed and managed with the cancellation API calls that are available in the <a href="https://developer.ebay.com/Devzone/post-order/index.html#CallIndex">Post Order API</a>.
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetOrders
DetailLevel: none, ReturnAll
Conditionally
OrderReport
Conditionally
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
This field will be returned at the order level only if the buyer purchased a digital gift card, which is delivered by email, or if the buyer purchased an item that is enabled with the 'Click and Collect' feature.
<br/><br/>
Currently, <strong>LogisticsPlanType</strong> has two applicable values: <code>PickUpDropOff</code>, which indicates that the buyer selected the 'Click and Collect' option. With Click and Collect, buyers are able to purchase from thousands of sellers on the eBay UK and Australia sites, and then pick up their order from the nearest 'eBay Collection Point', including over 750 Argos stores in the UK. The Click and Collect feature is only available on the eBay UK and Australia sites; or, <code>DigitalDelivery</code>, which indicates that the order is a digital gift card that will be delivered to the buyer or recipient of the gift card by email.
LogisticsPlanCodeType
GetOrders
DetailLevel:none,ReturnAll
Conditionally
OrderReport
Conditionally
GetOrderTransactions
DetailLevel:none,ItemReturnDescription, ReturnAll
Conditionally
GetItemTransactions
GetSellerTransactions
DetailLevel:none,ReturnAll
Conditionally
This container consists of taxpayer identification for the buyer. Although this container may be used for other purposes at a later date, it is currently used by sellers selling on the Italy or Spain site to retrieve the taxpayer ID of the buyer.
<br/><br/>
It is now required that buyers registered on the Italy site provide their Codice Fiscale ID (similar to the Social Security Number for US citizens) before buying an item on the Italy site.
<br/><br/>
On the Spain site, a Spanish seller has the option to require that Spanish buyers (registered on Spain site) provide a tax ID before checkout. This option is set by the seller at the account level. Once a Spanish buyer provides a tax ID, this tax ID is associated with his/her account, and once a tax ID is associated with the account, Spanish buyer will be asked to provide the tax ID during checkout on all eBay sites. Buyers with a registered address outside of Spain will not be asked to provide a tax ID during checkout.
<br/><br/>
This container is only returned for Spanish or Italian sellers when the buyer was asked to provide tax identifier information during checkout. A <strong>BuyerTaxIdentifier</strong> container will be returned for each tax ID that is associated with the buyer's account.
GetOrders
DetailLevel:none,ReturnAll
Conditionally
OrderReport
Conditionally
GetOrderTransactions
DetailLevel:none,ItemReturnDescription, ReturnAll
Conditionally
GetItemTransactions
GetSellerTransactions
DetailLevel:none,ReturnAll
Conditionally
This container is returned in <b>GetOrders</b> (and other order management calls) if the 'Pay Upon Invoice' option is being offered to the buyer, and the seller is including payment instructions in the shipping package(s) for the order. The 'Pay Upon Invoice' option is only available on the Germany site.
GetOrders
DetailLevel:none,ReturnAll
Conditionally
OrderReport
Conditionally
GetOrderTransactions
DetailLevel:none,ItemReturnDescription, ReturnAll
Conditionally
GetItemTransactions
GetSellerTransactions
DetailLevel:none,ReturnAll
Conditionally
GetMyeBayBuying
WonList
DeletedFromWonList
DetailLevel: none, ReturnAll
Conditionally
A unique identifier for an eBay order in the new eBay REST API model. <b>ExtendedOrderID</b> values will be used to identify orders in REST-based APIs, including the Post-Order API and the Fulfillment API.
<br><br>
<b>For GetOrders, GetOrderTransactions, and GetItemTransactions only:</b> If using Trading WSDL Version 1019 or above, this field will only be returned to the buyer or seller, and no longer returned at all to third parties. If using a Trading WSDL older than Version 1019, the correct Order ID is returned to the buyer or seller, but a dummy Order ID value of <code>1000000000000</code> will be returned to all third parties.
<br><br>
<span class="tablenote"><b>Note: </b> As of June 2019, eBay has changed the format of order identifier values, and this new format is relevant to both legacy and REST API-based order ID fields. The new format is a non-parsable string, globally unique across all eBay marketplaces, and consistent for both single line item and multiple line item orders. Unlike in the past, instead of just being known and exposed to the seller, these unique order identifiers will also be known and used/referenced by the buyer and eBay customer support.
<br><br>
For developers and sellers who are already integrated with the Trading API's order management calls, this change shouldn't impact your integration unless you parse the existing order identifiers (e.g., <b>OrderID</b> or <b>OrderLineItemID</b>), or otherwise infer meaning from the format (e.g., differentiating between a single line item order versus a multiple line item order). Because we realize that some integrations may have logic that is dependent upon the old identifier format, eBay is rolling out this Trading API change with version control to support a transition period of approximately 9 months before applications must switch to the new format completely.
<br><br>
During the transition period, for developers/sellers using a Trading WSDL older than Version 1113, they can use the <b>X-EBAY-API-COMPATIBILITY-LEVEL</b> HTTP header in API calls to control whether the new or old <b>OrderID</b> format is returned in call response payloads. To get the new <b>OrderID</b> format, the value of the <b>X-EBAY-API-COMPATIBILITY-LEVEL</b> HTTP header must be set to <code>1113</code>. During the transition period and even after, the new and old <b>OrderID</b> formats will still be supported/accepted in all Trading API call request payloads. After the transition period (which will be announced), only the new <b>OrderID</b> format will be returned in all Trading API call response payloads, regardless of the Trading WSDL version used or specified compatibility level.
</span>
GetOrders
DetailLevel: none, ReturnAll
Conditionally
OrderReport
Conditionally
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
If <code>true</code>, the order contains a transaction for an item that was purchased under the eBay Plus program. eBay Plus is a premium account option for buyers, which provides benefits such as fast free domestic shipping and free returns on selected items. Top-Rated eBay sellers must opt in to eBay Plus to be able offer the program on qualifying listings. Sellers must commit to next-day delivery of those items.
<br/><br/>
<span class="tablenote"><b>Note:</b> Currently, eBay Plus is available only to buyers in Germany, Austria, and Australia.
</span>
more details
Offering eBay Plus
../../../../guides/features-guide/default.html#development/Feature-eBayPlus.html
GetOrders
GetOrderTransactions
Conditionally
OrderReport
Conditionally
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
This boolean field is returned as <code>true</code> if one or more line items in the order are subject to a tax (US sales tax or Australian Goods and Services tax) that eBay will collect and remit to the proper taxing authority on the buyer's behalf. This field is also returned if <code>false</code> (not subject to eBay Collect and Remit). A <b>Transaction.eBayCollectAndRemitTaxes</b> container is returned for any order line items subject to such a tax, and the type and amount of this tax is displayed in the <b>Transaction.eBayCollectAndRemitTaxes.TaxDetails</b> container.
<br/><br/>
Australian 'Goods and Services' tax (GST) is automatically charged to buyers outside of Australia when they purchase items on the eBay Australia site. Sellers on the Australia site do not have to take any extra steps to enable the collection of GST, as this tax is collected by eBay and remitted to the Australian government. For more information about Australian GST, see the <a href="https://www.ebay.com.au/help/selling/fees-credits-invoices/taxes-import-charges?id=4121">Taxes and import charges</a> help topic.
<br/><br/>
As of July 1, 2019, buyers in 22 US states will automatically be charged sales tax for eBay purchases, and at least six more US states are scheduled to be subject to eBay Collect and Remit Tax by the end of 2019. eBay will collect and remit this sales tax to the proper taxing authority on the buyer's behalf. Sellers do not have to take any extra steps to enable the collection of this sales tax. If the seller is employing a Sales Tax Table for the listing, and a sales tax rate is established for a state that is subject to 'eBay Collect and Remit', this sales tax rate will be ignored by eBay. For a list of the US states that are or will become subject to 'eBay Collect and Remit Tax' (and effective dates), see the <a href="https://www.ebay.com/help/selling/fees-credits-invoices/taxes-import-charges?id=4121#section4">eBay sales tax collection</a> help topic.
GetOrders
Always
OrderReport
Always
GetOrderTransactions
Always
GetItemTransactions
Always
GetSellerTransactions
Always
This field indicates the total number of line items in the order. This field is returned under the <b>ContainingOrder</b> container of a <b>GetItemTransactions</b> or <b>GetSellerTransactions</b> call. In order for the <b>ContainingOrder</b> container to be returned, a user must include the <b>IncludeContainingOrder</b> field in the call request and set its value to <b>true</b>.
<br/><br/>
<span class="tablenote"><b>Note:</b> This field is automatically returned if the user is using Version 1113 of the Trading WSDL (or newer, as versions roll out). If the user is using Versions 1107 or 1111 of the Trading WSDL, this field will only be returned if the user includes the <b>X-EBAY-API-COMPATIBILITY-LEVEL</b> HTTP header and sets its value to <code>1113</code>. If a user is using a Trading WSDL older than 1107, this field will not be returned.
</span>
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ReturnAll
Conditionally
Contains a paginated list of items.
An array of one or more items returned under one or more containers in a <b>GetMyeBayBuying</b> or <b>GetMyeBaySelling</b> call response.
GetMyeBayBuying
BidList
BestOfferList
LostList
WatchList
DeletedFromLostList
DetailLevel: none, ReturnAll
Conditionally
GetMyeBaySelling
ActiveList
ScheduledList
UnsoldList
BidList
DeletedFromUnsoldList
DetailLevel: none, ReturnAll
Conditionally
This container shows the total numer of items that matched the input criteria and the total number of the results set. Users can use the <b>Pagination.PageNumber</b> field in the request to toggle through different pages in the results set.
GetMyeBayBuying
BidList
LostList
WatchList
WonList
BestOfferList
DeletedFromLostList
DeletedFromWonList
DetailLevel: none, ReturnAll
Conditionally
GetMyeBaySelling
ActiveList
ScheduledList
SoldList
UnsoldList
BidList
DeletedFromSoldList
DeletedFromUnsoldList
DetailLevel: none, ReturnAll
Conditionally
Contains a paginated list of orders.
Contains the list of orders.
GetMyeBayBuying
WonList
DeletedFromWonList
DetailLevel: none, ReturnAll
Conditionally
GetMyeBaySelling
SoldList
DeletedFromSoldList
DetailLevel: none, ReturnAll
Conditionally
Specifies information about the list, including number of pages and
number of entries.
GetMyeBayBuying
WonList
DeletedFromWonList
DetailLevel: none, ReturnAll
Conditionally
GetMyeBaySelling
SoldList
DeletedFromSoldList
DetailLevel: none, ReturnAll
Conditionally
Contains a paginated list of order line items.
Contains a list of Transaction objects. Returned as an
empty tag if no applicable order line items exist.
GetItemsAwaitingFeedback
Always
Provides information about the list of order line items,
including number of pages and number of entries.
GetItemsAwaitingFeedback
Always
Shows the pagination of data returned by call requests.
Pagination of returned data is not needed nor
supported for every Trading API call. See the documentation for
individual calls to determine whether pagination is
supported, required, or desirable.
Indicates the total number of pages of data that could be returned by repeated
requests. Returned with a value of 0 if no pages are available.
GetSellingManagerSoldListings
No
GetAccount
GetItemsAwaitingFeedback
GetMemberMessages
Always
GetFeedback
Always
DetailLevel: none, ReturnAll
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Always
GetSellingManagerSoldListings
GetVeROReportStatus
Conditionally
GetMyeBayBuying
BidList
BestOfferList
LostList
WatchList
WonList
DeletedFromWonList
DeletedFromLostList
DetailLevel: none, ReturnAll
Conditionally
GetMyeBaySelling
ActiveList
BidList
DeletedFromSoldList
DeletedFromUnsoldList
ScheduledList
SoldList
UnsoldList
DetailLevel: none, ReturnAll
Conditionally
GetOrders
DetailLevel: none, ReturnAll
Always
GetSellerList
DetailLevel: none, ItemReturnDescription, ReturnAll
Always
GetUserDisputes
DetailLevel: ReturnSummary, ReturnAll, none
Always
GetSellingManagerInventory
Conditionally
GetBestOffers
DetailLevel: none, ReturnAll
Conditionally
Indicates the total number of entries that could be returned by repeated
call requests. Returned with a value of 0 if no entries are available.
GetSellingManagerSoldListings
No
GetItemsAwaitingFeedback
GetMemberMessages
Always
GetFeedback
Always
DetailLevel: none, ReturnAll
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Always
GetAccount
Always
GetSellingManagerSoldListings
GetVeROReportStatus
Conditionally
GetMyeBayBuying
BidList
BestOfferList
LostList
WatchList
WonList
DeletedFromWonList
DeletedFromLostList
DetailLevel: none, ReturnAll
Conditionally
GetMyeBaySelling
ActiveList
BidList
DeletedFromSoldList
DeletedFromUnsoldList
ScheduledList
SoldList
UnsoldList
DetailLevel: none, ReturnAll
Conditionally
GetOrders
DetailLevel: none, ReturnAll
Always
GetSellerList
DetailLevel: none, ItemReturnDescription, ReturnAll
Always
GetSellingManagerInventory
Conditionally
GetBestOffers
DetailLevel: none, ReturnAll
Conditionally
Specifies the payment status of an order, as
seen by the buyer and seller.
PaymentPendingWithEscrow, PaidWithEscrow, EscrowPaymentCancelled, PaymentPendingWithPaisaPay, PaidWithPaisaPay, PaymentPendingWithPaisaPayEscrowm PaidWithPaisaPayEscrow, PaisaPayNotPaid,
The buyer has completed checkout, but eBay has not recognized that the buyer has paid for the order. It is possible that the buyer has paid with an 'offline' payment method, but the order has not been marked as paid.
The buyer has not completed the checkout process and so has not made payment.
The buyer has made a PayPal payment, but the seller has not yet received it.
The buyer has made a PayPal payment, and the payment is complete.
But please also see the documentation for PaymentHoldStatus and its applicable values.
PaymentHoldStatus contains the current status of a hold on a PayPal payment.
The order is marked as paid by either the buyer or seller.
No longer an applicable value.
No longer an applicable value.
No longer an applicable value.
PaisaPay is a deprecated payment method, so this value is no longer applicable.
PaisaPay is a deprecated payment method, so this value is no longer applicable.
The buyer has made a payment other than PayPal, but the
payment is still being processed.
PaisaPay is a deprecated payment method, so this value is no longer applicable.
PaisaPay is a deprecated payment method, so this value is no longer applicable.
PaisaPay is a deprecated payment method, so this value is no longer applicable.
The buyer's payment was refunded.
The selected payment method is COD and the buyer will make the payment upon delivery.
The buyer has paid for the order with the COD payment method.
Reserved for future use.
The order has been paid for.
This value indicates that the buyer was offered the 'Pay Upon Invoice' option. The 'Pay Upon Invoice' option is only available to eligible German buyers as part of Progressive Checkout on the German site. If a German buyer is offered the 'Pay Upon Invoice' option, that buyer is not required to pay for the order until after receiving an order invoice from the seller.
This type is no longer applicable/used, as the the Paisa Pay Escrow payment feature was only applicable to the eBay India site, and this site is no longer a functional eBay marketplace for sellers.
Enumerated type that defines PayPal account levels.
This enumeration value indicates that the user's PayPal account is unverified.
This enumeration value indicates that the user's international PayPal account is unverified.
This enumeration value indicates that the user's PayPal account is verified.
This enumeration value indicates that the user's international PayPal account is verified.
This enumeration value indicates that the user's PayPal account is a trusted account.
This enumeration value indicates that the user's PayPal account information is unknown.
This enumeration value indicates that the user's PayPal account is invalid.
Reserved for internal or future use
Enumerated type that defines PayPal account states.
This enumeration value indicates that the user's PayPal account is active.
This enumeration value indicates that the user's PayPal account is closed.
This enumeration value indicates that the user's PayPal account is in a highly restricted state.
This enumeration value indicates that the user's PayPal account is in a low restricted state.
This enumeration value indicates that the user's PayPal account is locked.
Reserved for internal or future use
This enumeration value indicates that the user's PayPal account is wired off.
This enumeration value indicates that the state of the user's PayPal account is unknown.
This enumeration value indicates that the user's PayPal account is invalid.
Enumerated type that defines PayPal account types.
This enumeration value indicates that the user's PayPal account is a Personal account.
This enumeration value indicates that the user's PayPal account is a Premier account.
This enumeration value indicates that the user's PayPal account is a Business account.
This enumeration value indicates that the user's PayPal account type is unknown.
This enumeration value indicates that the user's PayPal account is invalid.
Reserved for internal or future use
Defines the PayPal Buyer Protection feature.
If the field is present, the corresponding feature applies to the category.
The field is returned as an empty element (i.e., a boolean value is not returned).
Defines the PayPal Required feature. If the field is
present, the corresponding feature applies to the category. The field is returned
as an empty element (i.e., a boolean value is not returned).
If the field is present, the corresponding feature applies to the category. The
field is returned as an empty element (i.e., a boolean value is not returned).
Type defining the <b>PaymentDetails</b> container, which is used by the seller to
specify amounts and due dates for deposits and full payment on motor vehicle listings.
This integer value indicates the number of hours that a buyer has (after he/she commits to
buy) to make a deposit to the seller as a down payment on a motor vehicle. <b>Valid values:</b> 24, 48 (default), and 72.
<br/><br/>
The deposit amount is specified in the <b>DepositAmount</b> field. If not
specified, the <b>DepositAmount</b> value defaults to 0.0, in which case, a
deposit on the vehicle is not required.
<br>
24
72
48
AddItem
AddItems
AddSellingManagerTemplate
RelistItem
ReviseItem
ReviseSellingManagerTemplate
VerifyAddItem
VerifyRelistItem
No
GetBidderList
Conditionally
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally
This integer value indicates the number of days that a buyer has (after he/she commits to
buy) to make full payment to the seller and close the remaining balance on a motor vehicle.
<b>Valid values:</b> 3, 7 (default), 10, and 14.
<br/><br/>
In order for a buyer to make a full payment on an US or CA motor vehicle, at least one of
the following <b>PaymentMethods</b> values must be specified for the
listing:
<ul>
<li>CashInPerson</li>
<li>LoanCheck</li>
<li>MOCC (money order or cashier's check)</li>
<li><b>PaymentSeeDescription</b> (indicates to prospective buyers that payment instructions
are in the item's description</li>
<li>PersonalCheck</li>
</ul>
3
14
7
AddItem
AddItems
AddSellingManagerTemplate
RelistItem
ReviseItem
ReviseSellingManagerTemplate
VerifyAddItem
VerifyRelistItem
No
GetBidderList
Conditionally
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally
This dollar value indicates the amount of the deposit that a buyer must make on a purchased
motor vehicle (eBay Motors US and CA). The deposit amount can be as high as $2,000.00.
<br/><br/>
If not
specified, this value defaults to '0.0'. If the seller is requiring that the buyer put down
a deposit on the vehicle, the seller must include and set the <b>DepositType</b>
field to <code>OtherMethod</code> and specify an <b>HoursToDeposit</b> value.
If specified, then also specify <b>HoursToDeposit</b>
<br>
<br>
Deposits can only be paid using PayPal, so if <b>DepositAmount</b> is
specified (and not '0.0'), then the listing must offer
'PayPal' as a payment method (in addition to the payment methods
offered for the full payment). Unlike other listings, PayPal is not
automatically added to a Motors listing even if the seller has a
PayPal preference set in My eBay. The seller also needs to have a
linked PayPal account in order to require a deposit.<br>
<br>
The deposit amount appears in the shipping, payment details and return policy section of the
View Item page.<br>
<br>
<b>For ReviseItem and related calls</b>: If the listing
has no bids, the seller can add or lower a deposit; and they can
increase the deposit if the listing doesn't require Immediate Payment.
The seller can also remove the Immediate Payment option (if any).
If the listing has bids, the seller can only lower an existing
deposit; but not add or increase a deposit. The seller can't remove
Immediate Payment when a listing with a deposit has bids.
<br>
2000.0
AddItem
AddItems
AddSellingManagerTemplate
RelistItem
ReviseItem
ReviseSellingManagerTemplate
VerifyAddItem
VerifyRelistItem
Conditionally
GetBidderList
Conditionally
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally
This field applies to eBay Motors (US and CA) vehicles listings. If the seller is requiring
that the buyer make a deposit on the vehicle, the <b>DepositType</b> value must be
included and set to <code>OtherMethod</code>. Otherwise, specify <code>None</code> (or don't pass in <b>DepositType</b>).
None
AddItem
AddItems
AddSellingManagerTemplate
RelistItem
ReviseItem
ReviseSellingManagerTemplate
VerifyAddItem
VerifyRelistItem
Conditionally
GetBidderList
Conditionally
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally
This type defines the <b>PaymentHoldDetails</b> container, which
consists of information related to the payment hold on the order, including the
reason why the buyer's payment for the order is being held, the expected
release date of the funds into the seller's account, and possible action(s) the
seller can take to expedite the payout of funds into their account.
Timestamp that indicates the expected date in which eBay/PayPal will
distribute the funds to the seller's account. This is not a firm date and
is subject to change. This field is only returned after checkout is complete and if the <b>PaymentHoldStatus</b> indicates a hold has been placed on payment.
GetOrders
DetailLevel: none
Conditionally
OrderReport
Conditionally
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetMyeBaySelling
DetailLevel: none,ReturnAll
Conditionally
Container consisting of one or more <b>RequiredSellerAction</b> fields.
<b>RequiredSellerAction</b> fields provide possible actions that a seller can take to
expedite the release of funds into their account.
GetOrders
DetailLevel: none
Always
OrderReport
Always
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Always
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetMyeBaySelling
DetailLevel: none,ReturnAll
Conditionally
Integer value that indicates the number of possible actions that a seller
can take to possibly expedite the release of funds into their account. This
value should equal the number of <b>RequiredSellerAction</b>
fields contained in the <b>RequiredSellerActionArray</b>
container.
GetOrders
DetailLevel: none
Always
OrderReport
Always
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Always
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
Enumerated value that indicates why the buyer's payment for the order is
being held by PayPal instead of being distributed to the seller's account.
A seller's funds for an order can be held by PayPal for as little as three
days after the buyer receives the order, but the hold can be up to 21 days
based on the scenario, and in some cases, the seller's lack of action in
helping to expedite the release of funds.
GetOrders
DetailLevel: none
Conditionally
OrderReport
Conditionally
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetMyeBaySelling
DetailLevel: none,ReturnAll
Conditionally
Enumerated type that contains all possible reasons why the buyer's payment for
the order is being held by PayPal instead of being distributed to the seller's
account. A seller's funds for an order can be held by PayPal for as little as
three days after the buyer receives the order, but the hold can be up to 21
days based on the scenario, and in some cases, the seller's lack of action in
helping to expedite the release of funds.
SellerIsOnBlackList, None
This value indicates that the buyer's payment for the order is being held
by PayPal because the seller is new to selling on eBay. Sellers are
considered "new" until they have met all three criteria below:
<ul>
<li>More than 90 days have passed since first successful sale</li>
<li>More than 25 domestic sales</li>
<li>More than $250.00 in total sales</li>
</ul>
This value indicates that the buyer's payment for the order is being held
by PayPal because the seller has been classified as a Below Standard
seller.
This value indicates that the buyer's payment for the order is being held
by PayPal because an eBay Money Back Guarantee case has been filed against
the order. If this value is returned, the seller can expedite the release
of PayPal funds into their account by resolving the eBay Money Back Guarantee
case, as indicated by a value of 'ResolveeBPCase' returned in a
<b>PaymentHoldDetails.RequiredSellerActionArray.RequiredSellerAction</b>
field.
This value indicates that the buyer's payment for the order is being held
by PayPal because the seller has recently been reinstated as an active eBay
seller after their account went through a suspension/restricted period.
<br/><br/>
After a seller's account is suspended and then reinstated, that seller is
treated as a new seller, and must meet the same requirements that a new
seller must meet to get beyong the "New Seller" status.
This value indicates that the buyer's payment for the order is being held
by PayPal because the seller is classified as a casual seller on eBay.
This value indicates that the buyer's payment for the order is being held
by PayPal because the seller's PayPal account (identified in
<b>Transaction.PayPalEmailAddress</b>) is new and is not
fully set up to receive funds.
This value indicates that the reason for the buyer's payment for the order
being held by PayPal is not known.
This value is reserved for internal or future use.
This value is returned if the reason for the buyer's payment for the order
being held by PayPal cannot be classified by any of the other enumeration
values.
This value is reserved for internal or future use.
This value is reserved for internal or future use.
Enumerated type that contains the list of possible values that can be returned
in the PaymentHoldStatus container.
ReleaseFailed
This value indicates a possible issue with a buyer. If this value is returned,
the TransactionArray.Transaction.SellerPaidStatus field is returned as NotPaid
in GetMyeBaySelling, and the TransactionArray.Transaction.BuyerPaidStatus field
is returned as PaidWithPayPal in GetMyeBayBuying.
This value indicates a possible issue with a seller. If this value is returned,
the TransactionArray.Transaction.SellerPaidStatus field is returned as
PaidWithPayPal in GetMyeBaySelling, and the
TransactionArray.Transaction.BuyerPaidStatus field is returned as PaidWithPayPal
in GetMyeBayBuying.
This value indicates that a payment hold on the item has been released.
This value indicates that there is no payment hold on the item.
This value indicates that there is a "new seller hold" on the item. PayPal
may hold payments to a new seller for up to 21 days.
Sellers are
considered "new" until they have met all three criteria below:
<ul>
<li>More than 90 days have passed since first successful sale</li>
<li>More than 25 domestic sales</li>
<li>More than $250.00 in total sales</li>
</ul>
This value indicates that there is a payment hold on the item.
This value indicates that the process for the release of funds for the
order has been initiated.
This value indicates that the funds are available in the seller's PayPal
account.
This value is no longer used.
This value is reserved for internal or future use.
This type is deprecated.
This field is deprecated.
This type contains information about one or more payments made by the buyer to pay for an order.
This container consists of detailed information about each payment made by the buyer to pay for an order. In many cases, there may be only one payment - the payment made from the buyer to the seller, but in the case of an order going through the Global Shipping Program, one payment goes to the seller for the price of the order, and then an import charge and a portion of the shipping charges may go to eBay Global Shipping Program partner. In the case of an order that is subject to Australia import tax, one payment goes to the seller for the total price of the order, and the import tax goes to eBay for remittance to the Australian government.
<br><br>
<span class="tablenote"><b>Note: </b> Australia import tax is only applicable to the Australia site.
</span>
GetOrders
DetailLevel: none, ReturnAll
Conditionally
OrderReport
Conditionally
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ReturnAll
Conditionally
This enumerated type indicates the type of payment instructions included in the shipping package.
This enumeration value indicates that payment instructions were included in the shipping package for the 'Pay Upon Invoice' order.
Reserved for internal or future use.
Defines the Payment Method feature. If the field is
present, the corresponding feature applies to the category. The field is returned
as an empty element (i.e., a boolean value is not returned).
<span class="tablenote"><b>Note:</b>
This enumerated type is no longer applicable, as filtering by a payment method in an advanced item search is no longer supported.
</span>
This enumeration value indicates that the item may be purchased using PayPal as the payment method.
PaisaPay is no longer a supported payment method, so this value is no longer applicable.
PaisaPay is no longer a supported payment method, so this value is no longer applicable.
This enumeration value is reserved for future use.
PaisaPay is no longer a supported payment method, so this value is no longer applicable.
This type is used by the <b>PaymentOptionDetails</b> containers that are returned in <b>GeteBayDetails</b> if the <code>PaymentOptionDetails</code> value is used in a <b>DetailName</b> field in the call request.
<br><br>
<span class="tablenote"><b>Note: </b> Although site-level payment options are still returned in <b>GeteBayDetails</b>, it may be better to use the <b>GetCategoryFeatures</b> call instead, as this call returns the specific payment options that are accepted in specific categories.
</span>
<br>
<span class="tablenote"><b>Note: </b> For sellers opted in to the new eBay Managed Payments program, an accepted payment method is no longer necessary as listing time, so no payment options will be passed in to a <b>PaymentMethods</b> fields in an Add/Revise/Relist call.
</span>
This enumeration value is the enumeration that the seller would pass in to one of the <b>PaymentMethods</b> fields in an Add/Revise/Relist call (or in to a Payment busines policy).
613
613
Avoid
Category.PaymentMethod
GeteBayDetails
Conditionally
This field is a text-based/user-friendly description of the payment option.
613
613
Avoid
Category.PaymentMethod
GeteBayDetails
Conditionally
This string value indicates the version number of the update made to any payment options returned in <b>GeteBayDetails</b>.
613
613
Avoid
Category.PaymentMethod
GeteBayDetails
Conditionally
This timestamp indicates the date and time of the last update made to any payment options returned in <b>GeteBayDetails</b>.
613
613
Avoid
Category.PaymentMethod
GeteBayDetails
Conditionally
This enumerated type is deprecated.
This value is not used.
This value is not used.
This value is not used.
This value is not used.
This type is deprecated.
Type defining the values that can be returned in the <b>eBayPaymentStatus</b>
field of order management calls. These values indicate the current status of the buyer's
payment for an order.
This value indicates that the buyer's payment for the order has cleared. A
<b>CheckoutStatus.eBayPaymentStatus</b> value of 'NoPaymentFailure'
and a <b>CheckoutStatus.Status</b> value of 'Complete' indicates that
checkout is complete.
This value indicates that the buyer's eCheck bounced. This value is only applicable
if the seller accepts eChecks as a form of payment.
This value indicates that the buyer's payment via a credit card failed. This value
is only applicable if the seller accepts credit cards as a form of payment.
This value indicates that the seller reported the buyer's payment as failed.
This value indicates that the buyer's PayPal payment is in process. This value
is only applicable if the buyer has selected PayPal as the payment method.
This value indicates that the buyer's non-PayPal payment is in process. This value
is only applicable if the buyer has selected a payment method other than PayPal.
Reserved for internal or future use.
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 field is deprecated.
This field is deprecated.
This field is deprecated.
Type defining the possible states of a payment transaction. This type is used by several containers in order management-related calls.
This value indicates that the payment transaction failed.
This value indicates that the payment transaction succeeded.
This value indicates that the payment transaction is pending.
Reserved for internal or future use.
This type contains details about the allocation of funds to one payee from a buyer payment for a specified order.
The current status of a buyer payment that is allocated to a specified payee.
GetOrders
DetailLevel: none, ReturnAll
Conditionally
OrderReport
Conditionally
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ReturnAll
Conditionally
This field indicates the eBay user or eBay partner who submitted the payment.
<br><br>
<b>For GetOrders, GetOrderTransactions, and GetItemTransactions only:</b> If using Trading WSDL Version 1019 or above, this field will only be returned to the buyer or seller, and no longer returned at all to third parties. If using a Trading WSDL older than Version 1019, the correct payer is returned to the buyer or seller, but the identity of the payer will be masked to all third parties.
GetOrders
DetailLevel: none, ReturnAll
Conditionally
OrderReport
Conditionally
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ReturnAll
Conditionally
The person or organization who is to receive the payment allocation.
GetOrders
DetailLevel: none, ReturnAll
Conditionally
OrderReport
Conditionally
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ReturnAll
Conditionally
The date and time when the payment is received by the payee.
GetOrders
DetailLevel: none, ReturnAll
Conditionally
OrderReport
Conditionally
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ReturnAll
Conditionally
The amount of the payment that is allocated to the payee.
<br><br>
<span class="tablenote"><b>Note: </b> As of November 2019, for orders subject to eBay 'Collect and Remit' taxes, PayPal has begun distributing order funds to the seller's account with the sales tax included. eBay 'Collect and Remit' tax includes US sales tax for numerous states, and 'Good and Services' tax that is applicable to Australian and New Zealand sellers. This 'Collect and Remit' tax amount for the order will be included in the <b>PaymentAmount</b> value (if the corresponding monetary transaction is buyer payment for an order). To determine if 'Collect and Remit' taxes were added into <b>PaymentAmount</b> value, the user can check for the <b>Transaction.eBayCollectAndRemitTaxes.TaxDetails</b> and the <b>Transaction.Taxes.TaxDetails</b> containers in the response. If both of these containers appear in the response with a <b>TaxDetails.TaxDescription</b> value of <code>SalesTax</code> (in US) or <code>GST</code> (in Australia or New Zealand), the tax amount that the buyer paid is in this amount.
<br><br>
Sellers should be aware that the sales tax that the buyer pays for the order will initially be included when the order funds are distributed to their PayPal account, but that PayPal will pull out the sales tax amount shortly after the payment clears, and will distribute the sales tax to the appropriate taxing authority. Previous to this change, PayPal would strip out the 'Collect and Remit' tax before distributing order funds to the seller's account.
<br><br>
This logic change does not apply to sellers who are in eBay managed payments, so the amount in this field will never reflect any 'Collect and Remit' tax, even if the order is subject to 'Collect and Remit' tax.
</span>
GetOrders
DetailLevel: none, ReturnAll
Conditionally
OrderReport
Conditionally
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ReturnAll
Conditionally
A unique transaction ID for the payment.
<br/><br/>
This field is not returned if the <strong>Payee</strong> field's <strong>type</strong> attribute is <code>eBayPartner</code>.
<br><br>
<b>For GetOrders, GetOrderTransactions, and GetItemTransactions only:</b> If using Trading WSDL Version 1019 or above, this field will only be returned to the buyer or seller, and no longer returned at all to third parties. If using a Trading WSDL older than Version 1019, the correct payment identifier is returned to the buyer or seller, but the payment identifier will be masked to all third parties.
GetOrders
DetailLevel: none, ReturnAll
Conditionally
OrderReport
Conditionally
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ReturnAll
Conditionally
Fee Amount is a positive value and Credit Amount is a negative value.
<br/><br/>
This field is not returned if the <strong>Payee</strong> field's <strong>type</strong> attribute is <code>eBayPartner</code>.
GetOrders
DetailLevel: none, ReturnAll
Conditionally
OrderReport
Conditionally
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ReturnAll
Conditionally
The payment transaction ID.
<br/><br/>
<b>For GetOrders, GetOrderTransactions, and GetItemTransactions only:</b> If using Trading WSDL Version 1019 or above, this field will only be returned to the buyer or seller, and no longer returned at all to third parties. If using a Trading WSDL older than Version 1019, the correct payment identifier is returned to the buyer or seller, but the payment identifier will be masked to all third parties.
GetOrders
DetailLevel: none, ReturnAll
Conditionally
OrderReport
Conditionally
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ReturnAll
Conditionally
<br>
<span class="tablenote"><b>Note: </b> This type is only applicable to the <b>GetSellerPayments</b> call, which is only relevant to Half.com orders, and since the Half.com site has been shut down, this type is no longer applicable.
</span>
<span class="tablenote"><b>Note: </b> <b>PaymentTypeCodeType</b> and all of its values will no longer be applicable since the Half.com site has been shut down.
</span>
<span class="tablenote"><b>Note: </b> <b>PaymentTypeCodeType</b> and all of its values will no longer be applicable since the Half.com site has been shut down.
</span>
<span class="tablenote"><b>Note: </b> <b>PaymentTypeCodeType</b> and all of its values will no longer be applicable since the Half.com site has been shut down.
</span>
<span class="tablenote"><b>Note: </b> <b>PaymentTypeCodeType</b> and all of its values will no longer be applicable since the Half.com site has been shut down.
</span>
<span class="tablenote"><b>Note: </b> <b>PaymentTypeCodeType</b> and all of its values will no longer be applicable since the Half.com site has been shut down.
</span>
<span class="tablenote"><b>Note: </b> <b>PaymentTypeCodeType</b> and all of its values will no longer be applicable since the Half.com site has been shut down
</span>
<span class="tablenote"><b>Note: </b> <b>PaymentTypeCodeType</b> and all of its values will no longer be applicable since the Half.com site has been shut down.
</span>
<span class="tablenote"><b>Note: </b> <b>PaymentTypeCodeType</b> and all of its values will no longer be applicable since the Half.com site has been shut down.
</span>
This type is deprecated.
This field is deprecated.
This type defines the <strong>MonetaryDetails</strong> container, which consists of detailed information about one or more exchanges of funds that occur between the buyer, seller, eBay, and eBay partners during the lifecycle of an order, as well as detailed information about a merchant's refund (or store credit) to a buyer who has returned an In-Store Pickup item.
<br/><br/>
<span class="tablenote">
<strong>Note:</strong> At this time, the In-Store Pickup feature is generally only available to large retail merchants, and can only be applied to multi-quantity, fixed-price listings.
</span>
Contains information about how different portions of the funds exchanged for a specified order are allocated among payees. Each allocated portion is represented by a <strong>Payment</strong> container.
GetOrders
DetailLevel: none, ReturnAll
Conditionally
OrderReport
Conditionally
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ReturnAll
Conditionally
This container consists of an array of one or more <strong>Refund</strong> containers, and each <strong>Refund</strong> container consists of detailed information about a merchant's refund (or store credit) to a buyer who has returned an In-Store Pickup item.
<br/><br/>
This container is only returned if the buyer has returned an In-Store Pickup item to the merchant at a physical store, and the merchant has notified eBay through the <strong>ORDER.RETURNED</strong> notification of the Inbound Notifications API.
<br/><br/>
<span class="tablenote">
<strong>Note:</strong> At this time, the In-Store Pickup feature is generally only available to large retail merchants, and can only be applied to multi-quantity, fixed-price listings.
</span>
GetOrders
DetailLevel: none, ReturnAll
Conditionally
OrderReport
Conditionally
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ReturnAll
Conditionally
This enumerated type is deprecated.
This value is not used.
This value is not used.
This value is not used.
Type defining the <b>Performance</b> container returned in the
<b>GetSellerDashboard</b> response. The <b>Performance</b>
container consists of the seller's overall selling performance rating on all eBay sites
on which the seller is sellling, as well as any alerts related to performance.
The eBay site(s) on which the seller's performance is being evaluated.
<br />
A seller's performance status is evaluated for three specific regions: US,
UK/Ireland, and Germany/Switzerland/Austria. The <b>Site</b> field is
repeated to show all sites in each region, if applicable.
GetSellerDashboard
Always
This field indicates the seller's performance rating. This rating is an overall
performance for the eBay site(s) found in the <b>Site</b> field(s).
GetSellerDashboard
Always
The <b>Performance.Alert</b> container is only returned if eBay has
posted one or more informational or warning messages related to the seller's
performance rating.
GetSellerDashboard
Conditionally
Enumerated type that defines eBay Seller Levels.
This enumeration value indicates that the user's Seller Level is Top-Rated.
This enumeration value indicates that the user's Seller Level is Above Standard.
This enumeration value indicates that the user's Seller Level is Standard.
This enumeration value indicates that the user's Seller Level is Below Standard.
Reserved for internal use.
Type defining the time periods used when evaluating the number of unpaid item strikes that a buyer has against their account. A seller can set up listing-level Buyer Requirements in an Add/Revise/Relist call that will block a buyer if that buyer has a specified number of unpaid item strikes against their account during a specified time period.
Days_1, Days_540
This value is no longer applicable.
This value indicates that the evaluation period is set back 30 days from the
present date.
This value indicates that the evaluation period is set back 180 days (approximately 6 months) from the present date.
This value indicates that the evaluation period is set back 360 days (approximately 12 months) from the present date.
This value is no longer applicable.
This value is reserved for future or internal use.
Specifies the type of image display used in a listing. Some options are
only available if images are hosted through eBay Picture Services (EPS).
Cannot be used with Listing Designer layouts (specified in Item.ListingDesigner).
SiteHostedPictureShow, SlideShow, VendorHostedPictureShow
No special image display options. Valid for US Motors listings.
This value is no longer applicable.
Increase the size of each image and allow buyers to enlarge images
further. Only available for site-hosted (EPS) images. Not valid for US Motors
listings. For all sites that do not automatically upgrade SuperSize to
PicturePack (see note below), specifying no SuperSize-qualified images is now
accepted in the request.
<br><br>
<span class="tablenote"><b>Note:</b>
SuperSize is automatically upgraded to PicturePack for the same SuperSize
fee on the US Motors Parts & Accessories Category and US (site ID 0)
and CA (site ID 2) and CAFR (site ID 210). This upgrade applies
only to EPS images.
</span>
Increase the number of images displayed. This is only available for
images hosted with eBay. See GetCategoryFeatures and the
online Help (on the eBay site) for additional information.
<br><br>
Picture Pack applies to all sites
(including US Motors), except for NL (site ID 146). You can specify a minimum of
one EPS picture, or no SuperSize-qualified EPS pictures in the request. For
the NL site, PicturePack is replaced with SuperSize.
This value is no longer applicable.
This value is no longer applicable.
This is valid for US Motors listing only. For other listings, use SuperSize.
Reserved for internal use <b>only</b>.
This type defines the <strong>PickupDetails</strong> container, which contains an array of <strong>PickupOptions</strong> containers. Each <strong>PickupOptions</strong> container consists of the pickup method and its priority.
<br/><br/>
<span class="tablenote">
<strong>Note:</strong> At this time, the In-Store Pickup and Click and Collect features are generally only available to large retail merchants, and can only be applied to multi-quantity, fixed-price listings. In-Store Pickup is only applicable to the US site, and Click and Collect is only applicable to the UK, Germany, and Australia sites.
</span>
Container consisting of a pickup method and the priority of the pickup method. The priority of each pickup method controls the order (relative to other pickup methods) in which the corresponding pickup method will appear in the View Item and Checkout page.
<br/><br/>
This container is always returned prior to order payment if the seller created/revised/relisted the item with the <strong>EligibleForPickupInStore</strong> and/or <strong>EligibleForPickupDropOff</strong> flag in the call request set to 'true'. If and when the In-Store pickup method (US only) or 'Click and Collect' pickup method (UK and Australia only) is selected by the buyer and payment for the order is made, this container will no longer be returned in the response, and will essentially be replaced by the <strong>PickupMethodSelected</strong> container.
<br/><br/>
<span class="tablenote">
<strong>Note:</strong> At this time, the In-Store Pickup and Click and Collect features are generally only available to large retail merchants, and can only be applied to multi-quantity, fixed-price listings. In-Store Pickup is only applicable to the US site, and Click and Collect is only applicable to the UK, Germany, and Australia sites.
</span>
GetOrders
DetailLevel: none, ReturnAll
Conditionally
OrderReport
Conditionally
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetMyeBayBuying
WonList
DeletedFromWonList
DetailLevel: none, ReturnAll
Conditionally
SoldReport
Conditionally
The <b>PickupDropOffEnabled</b> field is returned as an empty element (a boolean value is not returned) if one or more eBay API-enabled sites support the "Click and Collect" feature. This field will be returned as long as 'PickupDropOffEnabled' is included as a <b>FeatureID</b> value in the call request or no <b>FeatureID</b> values are passed into the call request.
<br/><br/>
The 'Click and Collect' feature is only available to large merchants on the eBay UK (site ID - 3), eBay Australia (Site ID - 15), and eBay Germany (Site ID - 77) sites.
<br/><br/>
To verify if a specific category supports the the "Click and Collect" feature, pass in a <b>CategoryID</b> value in the request, and then look for a 'true' value in the <b>PickupDropOffEnabled</b> field of the corresponding Category node (match up the <b>CategoryID</b> values if more than one Category IDs were passed in the request).
<br>
<br>
<span class="tablenote"><b>Note:</b> For Click and Collect eligible sellers, the Click and Collect feature can only be enabled at the account level, and then each of the seller's listings within an Click and Collect enabled category will be automatically evaluated for Click and Collect eligibility.
</span>
Complex type defining the <b>PickupInStoreDetails</b> container, that is used in Add/Revise/Relist calls to enable the listing for In-Store Pickup or Click and Collect.
<br/><br/>
<span class="tablenote">
<strong>Note:</strong> At this time, In-Store Pickup as a fulfillment method is only available to a limited number of large retail merchants in the US, Canada, UK, Germany, and Australia marketplaces, and can only be applied to multiple-quantity, fixed-price listings. The Click and Collect feature is only available to large merchants on the UK, Australia, and Germany marketplaces.
</span>
<b>For Add/Revise/Relist/Verify calls</b>: this field is included to enable the listing for In-Store Pickup. To enable the listing for In-Store Pickup, the seller includes this boolean field and sets its value to <code>true</code>. In-Store Pickup as a fulfillment method is only available to a limited number of large retail merchants in the US, Canada, UK, Germany, and Australia marketplaces. The In-Store Pickup feature can only be applied to multiple-quantity, fixed-price listings.
<br/><br/>
In addition to setting the <b>EligibleForPickupInStore</b> boolean field to <code>true</code>, the merchant must also perform the following actions in an <b>Add/Revise/Relist/Verify</b> call to enable the In-Store Pickup option on a multiple-quantity, fixed-price listing:
<ul>
<li>Have inventory for the product at one or more physical stores tied to the seller's account. By using the REST-based <b>Inventory API</b>, sellers can associate physical stores to their account by using the <b>Create Inventory Location</b> call, and then, using the <b>Create Inventory Item</b> call, they can add inventory to specific stores;</li>
<li>Include the seller-defined SKU value of the product(s) in the call request. For a single-variation listing, the SKU value would be specified in the <b>Item.SKU</b> field, and for a multiple-variation listing, the SKU value(s) would be specified in the <b>Item.Variations.Variation.SKU</b> field(s);</li>
<li>Set an immediate payment requirement on the item.
</li>
</ul>
When a seller is successful at listing an item with the In-Store Pickup feature enabled, prospective buyers within a reasonable distance (25 miles or so) from one of the seller's stores (that has stock available) will see the "Available for In-Store Pickup" option on the listing, along with information on the closest store that has the item.
<br/><br/>
This field is returned in the 'Get' calls if the listing is enabled with the In-Store Pickup feature.
false
AddFixedPriceItem
AddItem
AddItems
RelistFixedPriceItem
RelistItem
ReviseFixedPriceItem
ReviseItem
VerifyAddItem
VerifyAddFixedPriceItem
VerifyRelistItem
Conditionally
GetSellerList
GetItemShipping
GetItem
Conditionally
For sellers opted in to Click and Collect, this field was once used to set Click and Collect eligibility at the listing level. However, now the seller can only opt in to Click and Collect at the account level, and then each of their listings will be automatically evaluated by eBay for Click and Collect eligibility.
<br/><br/>
<span class="tablenote"><b>Note:</b> Until this field is fully deprecated in the Trading WSDL (and in Add/Revise/Relist/Verify calls), it can still be used, but it will have no functional affect. However, if set in an Add/Revise/Relist/Verify call, it will get returned in <b>GetItem</b>, but it won't be a true indicator if the item is actually available for the Click and Collect fulfillment method. Instead, the <b>Item.AvailableForPickupDropOff</b> field should be referenced to see if the listing actually has inventory that is available for pickup via the Click and Collect fulfillment method.
</span>
GetSellerList
GetItemShipping
GetItem
Conditionally
Simple type defining all possible local pickup methods for buyers. A <strong>PickupMethodCodeType</strong> value is always returned under the <strong>PickupOptions</strong> and <strong>PickupMethodSelected</strong> containers.
This value indicates that the buyer will pick up the In-Store Pickup item at the merchant's physical store.
<br/><br/>
<span class="tablenote">
<strong>Note:</strong> A merchant must be eligible for the In-Store Pickup feature to list an item that is eligible for In-Store Pickup. At this time, the In-Store Pickup feature is generally only available to large retail merchants in US, and can only be applied to multi-quantity, fixed-price listings.
</span>
This value indicates that the buyer will pick up the "Click and Collect" item at the merchant's physical store.
<br/><br/>
<span class="tablenote">
<strong>Note:</strong> A merchant must be eligible for the "Click and Collect" feature to list an item that is eligible for "Click and Collect". At this time, the "Click and Collect" feature is only available to large merchants on the eBay UK (site ID - 3), eBay Australia (Site ID - 15), and eBay Germany (Site ID - 77) sites. sites.
Reserved for internal or future use.
Type defining the <strong>PickupMethodSelected</strong> container, which consists of details related to the selected local pickup method (In-Store Pickup or "Click and Collect"), including the pickup method, the merchant's store ID, the status of the pickup, and the pickup reference code (if provided by merchant).
<br/><br/>
<span class="tablenote">
<strong>Note:</strong> At this time, the In-Store Pickup feature is generally only available to large retail merchants in US, and can only be applied to multi-quantity, fixed-price listings. The "Click and Collect" feature is only available to large merchants on the eBay UK (site ID - 3), eBay Australia (Site ID - 15), and eBay Germany (Site ID - 77) sites.
</span>
This value indicates the local pickup method that was selected by the buyer at checkout. This field is always returned with the <strong>PickupMethodSelected</strong> container.
<br/><br/>
<span class="tablenote">
<strong>Note:</strong> Merchants must be eligible for the In-Store Pickup or "Click and Collect" feature to list items that are eligible for these local pickup methods.
</span>
PickupMethodCodeType
GetOrders
DetailLevel: none, ReturnAll
Conditionally
OrderReport
Conditionally
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetMyeBayBuying
WonList
DeletedFromWonList
DetailLevel: none, ReturnAll
Conditionally
SoldReport
Conditionally
The unique identifier of the merchant's store where the item will be picked up. The <strong>PickupStoreID</strong> is picked up by eBay based on the <strong>LocationID</strong> value that is set by the merchant in the <strong>Inventory Management API</strong>. This field is always returned with the <strong>PickupMethodSelected</strong> container.
<br/><br/>
<span class="tablenote">
<strong>Note:</strong> A seller must be eligible for the In-Store Pickup feature to list an item that is eligible for In-Store Pickup. At this time, the In-Store Pickup feature is generally only available to large retail merchants in US, and can only be applied to multi-quantity, fixed-price listings. Merchants/developers can test In-Store Pickup functionality in the Sandbox environment, including listing items enabled with the In-Store Pickup feature, creating store locations and adding inventory to these stores using the Inventory Management API, and informing eBay of In-Store Pickup status changes using the Inbound Notifications API.
</span>
GetOrders
DetailLevel: none, ReturnAll
Conditionally
OrderReport
Conditionally
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetMyeBayBuying
WonList
DeletedFromWonList
DetailLevel: none, ReturnAll
Conditionally
SoldReport
Conditionally
This field indicates the current status of the local pickup order. The value of the <strong>PickupStatus</strong> field can change during the lifecycle of the order based on the notifications that a merchant sends to eBay through the <strong>Inbound Notifications API</strong>. This field is always returned with the <strong>PickupMethodSelected</strong> container.
<br/><br/>
<span class="tablenote">
<strong>Note:</strong> A seller must be eligible for the In-Store Pickup or Click and Collect features to list an item that is eligible for these features. At this time, these features are generally only available to large retail merchants in US, and can only be applied to multi-quantity, fixed-price listings. Merchants/developers can test In-Store Pickup functionality in the Sandbox environment, including listing items enabled with the In-Store Pickup feature, creating store locations and adding inventory to these stores using the Inventory Management API, and informing eBay of In-Store Pickup status changes using the Inbound Notifications API.
</span>
GetOrders
DetailLevel: none, ReturnAll
Conditionally
OrderReport
Conditionally
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetMyeBayBuying
WonList
DeletedFromWonList
DetailLevel: none, ReturnAll
Conditionally
SoldReport
Conditionally
The unique reference number defined by the merchant to track In-Store Pickup orders. The <strong>MerchantPickupCode</strong> is picked up by eBay if it is set by the merchant through the payload of a notification sent to eBay through the <strong>Inbound Notifications API</strong>. This field is only returned with the <strong>PickupMethodSelected</strong> container if it set by the merchant.
<br><br>
<b>For GetOrders, GetOrderTransactions, and GetItemTransactions only:</b> If using Trading WSDL Version 1019 or above, this field will only be returned to the buyer or seller, and no longer returned at all to third parties. If using a Trading WSDL older than Version 1019, the real reference number is only returned to the buyer or seller, and a string value of <code>Unavailable</code> will be returned to all third parties.
<br/><br/>
<span class="tablenote">
<strong>Note:</strong> A seller must be eligible for the In-Store Pickup feature to list an item that is eligible for In-Store Pickup. At this time, the In-Store Pickup feature is generally only available to large retail merchants in US, and can only be applied to multi-quantity, fixed-price listings. Merchants/developers can test In-Store Pickup functionality in the Sandbox environment, including listing items enabled with the In-Store Pickup feature, creating store locations and adding inventory to these stores using the Inventory Management API, and informing eBay of In-Store Pickup status changes using the Inbound Notifications API.
</span>
GetOrders
DetailLevel: none, ReturnAll
Conditionally
OrderReport
Conditionally
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetMyeBayBuying
WonList
DeletedFromWonList
DetailLevel: none, ReturnAll
Conditionally
SoldReport
Conditionally
Timestamp indicating the date/time when the order is expected to be fulfilled by the merchant and available for pick up by the buyer.
GetOrders
DetailLevel: none, ReturnAll
Conditionally
OrderReport
Conditionally
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
The unique identifier of the merchant's store where the "Click and Collect" item will be picked up. This field will only be returned if supplied by the merchant.
GetOrders
DetailLevel: none, ReturnAll
Conditionally
OrderReport
Conditionally
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetMyeBayBuying
WonList
DeletedFromWonList
DetailLevel: none, ReturnAll
Conditionally
Type defining the <strong>PickupOptions</strong> container, which consists of a pickup method and the priority of the pickup method.
<br/><br/>
<span class="tablenote">
<strong>Note:</strong> At this time, the In-Store Pickup and Click and Collect features are generally only available to large retail merchants in US, and can only be applied to multi-quantity, fixed-price listings.
</span>
This value indicates an available pickup method. This field is always returned with the <strong>PickupOptions</strong> container.
<br/><br/>
<span class="tablenote">
<strong>Note:</strong> At this time, 'InStorePickup' and 'PickUpDropOff' are the only available pickup methods; however, additional pickup methods may be added to the list in future releases.
</span>
<br/>
<span class="tablenote">
<strong>Note:</strong> A seller must be eligible for the In-Store Pickup or Click and Collect feature to list an item that is eligible for In-Store Pickup or Click and Collect. At this time, In-Store Pickup is generally only available to large retail merchants in US, and the 'Click and Collect' feature is only available to large merchants on the eBay UK (site ID - 3), eBay Australia (Site ID - 15), and eBay Germany (Site ID - 77) sites.
</span>
PickupMethodCodeType
GetOrders
DetailLevel: none, ReturnAll
Conditionally
OrderReport
Conditionally
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetMyeBayBuying
WonList
DeletedFromWonList
DetailLevel: none, ReturnAll
Conditionally
SoldReport
Conditionally
This integer value indicates the priority of the pickup method. The priority of each pickup method controls the order (relative to other pickup methods) in which the corresponding pickup method will appear in the View Item and Checkout page. This field is always returned with the <strong>PickupOptions</strong> container.
<br/><br/>
<span class="tablenote">
<strong>Note:</strong> A seller must be eligible for the In-Store Pickup or Click and Collect features to list an item that is eligible for In-Store Pickup or Click and Collect. At this time, In-Store Pickup is generally only available to large retail merchants in US, and the 'Click and Collect' feature is only available to large merchants on the eBay UK (site ID - 3), eBay Australia (Site ID - 15), and eBay Germany (Site ID - 77) sites.
</span>
GetOrders
DetailLevel: none, ReturnAll
Conditionally
OrderReport
Conditionally
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetMyeBayBuying
WonList
DeletedFromWonList
DetailLevel: none, ReturnAll
Conditionally
SoldReport
Conditionally
Simple type defining all possible states for an In-Store Pickup order. The value of the <strong>PickupStatus</strong> field (returned under the <strong>PickupMethodSelected</strong> container) can change during the lifecycle of the order based on the notifications that a merchant sends to eBay through the <strong>Inbound Notifications API</strong>.
<br/><br/>
<span class="tablenote">
<strong>Note:</strong> At this time, the In-Store Pickup feature is generally only available to large retail merchants in US, and can only be applied to multi-quantity, fixed-price listings.
</span>
This value indicates that the current status value of the In-Store Pickup order is invalid.
This value indicates that the current status value of the In-Store Pickup order is not applicable.
This status indicates that the In-Store Pickup order has yet to be acknowledged by the merchant. This is typically the state before the merchant sends the <strong>ORDER.READY_FOR_PICKUP</strong> notification to eBay through the <strong>Inbound Notifications API</strong>.
This status indicates that the In-Store Pickup order is ready to be picked up by the buyer. This state occurs after the merchant sends the <strong>ORDER.READY_FOR_PICKUP</strong> notification to eBay through the <strong>Inbound Notifications API</strong>.
This status indicates that the In-Store Pickup order has been picked up by the buyer. This state occurs after the merchant sends the <strong>ORDER.PICKEDUP</strong> notification to eBay through the <strong>Inbound Notifications API</strong>.
This status indicates that the In-Store Pickup order has been cancelled by the merchant, because the product was out of stock. This state occurs after the merchant sends the <strong>ORDER.PICKUP_CANCELED</strong> notification (with the <strong>CANCEL_TYPE</strong> parameter in the notification payload set to "OUT_OF_STOCK") to eBay through the <strong>Inbound Notifications API</strong>.
This status indicates that the In-Store Pickup order has been cancelled by the merchant, because the buyer rejected the item. This state occurs after the merchant sends the <strong>ORDER.PICKUP_CANCELED</strong> notification (with the <strong>CANCEL_TYPE</strong> parameter in the notification payload set to "BUYER_REJECTED") to eBay through the <strong>Inbound Notifications API</strong>.
This status indicates that the In-Store Pickup order has been cancelled by the merchant, because the buyer never showed up to pick up the item. This state occurs after the merchant sends the <strong>ORDER.PICKUP_CANCELED</strong> notification (with the <strong>CANCEL_TYPE</strong> parameter in the notification payload set to "BUYER_NO_SHOW") to eBay through the <strong>Inbound Notifications API</strong>.
This status indicates that the In-Store Pickup order has been cancelled, and the exact reason is not available.
This value is reserved for internal or future use.
Contains the data for the pictures associated with an item.
<a name="galleryTypeField"></a>
This field is used to specify the type of picture gallery to use for the listing. If this field is omitted, a standard picture gallery is used for the listing. There is no listing fee for a standard picture gallery.
<br/><br/>
To use the Gallery Plus feature, you must include this field and set its value to <code>Plus</code>. To use the Featured Gallery feature (a feature that includes the Gallery Plus feature, you must include this field and set its value to <code>Featured</code>.
<br/><br/>
The Gallery image will be the first URL passed
into the first <b>PictureURL</b> field, so if you want a specific picture to be the Gallery image, you should make sure you pass the URL for this picture in the first <b>PictureURL</b> field.
<br/><br/>
When revising a listing, if you disable the Gallery Plus or Featured Gallery feature by including the <b>GalleryType</b> and setting its value to <code>Gallery</code>, the original feature fee for either of these features will not be credited to the seller.
<br/><br/>
<span class="tablenote"><b>Note:</b>
The Featured Gallery listing feature is being deprecated for all sites. If a seller attempts to set the value of <b>GalleryType</b> to <code>Featured</code>, it is allowed, but a warning will be returned announcing the deprecation of the feature. Starting August 15, 2019, this feature cannot be added when creating a new listing or revising an existing listing. For existing listings that already have the feature, the seller will not be able to change the duration to <code>Lifetime</code>. On September 15, 2019, this feature will be wired off. If a seller revises an existing listing that had this feature set, the <b>GalleryType</b> value will automatically default to <code>Gallery</code>.
</span>
Gallery
AddItem
AddItems
AddSellingManagerTemplate
RelistItem
ReviseItem
ReviseSellingManagerTemplate
VerifyAddItem
VerifyRelistItem
Conditionally
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally
GetSellerList
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
AddFixedPriceItem
RelistFixedPriceItem
ReviseFixedPriceItem
VerifyAddFixedPriceItem
No
Specifies the type of image display used in a listing. Some options are
only available if images are hosted through eBay Picture Services (EPS).
eBay determines this by parsing the associated <b>PictureURL</b>.
<br><br>
You cannot use <b>PhotoDisplay</b> in combination with Listing Designer layouts.
Specify <code>None</code> or do not add <b>PhotoDisplay</b> when <b>ListingDesigner.LayoutID</b>
is a value other than 0.
<br><br>
Some <b>PhotoDisplay</b> options can result in listing fees, even when the item is relisted. If you are relisting an item that was originally listed with a <b>PhotoDisplay</b> option, and you do not want that <b>PhotoDisplay</b> enhancement in your relisted item, you need to specifically
remove <b>PhotoDisplay</b> in your <b>RelistItem</b> call (or <b>RelistFixedPriceItem</b>, as applicable) by
setting <b>PhotoDisplay</b> to <code>None</code>. Use <b>VerifyRelistItem</b> to review your listing fees before you
relist an item.
PicturePack
AddItem
AddItems
AddSellingManagerTemplate
RelistItem
ReviseItem
ReviseSellingManagerTemplate
VerifyAddItem
VerifyRelistItem
Conditionally
GetBidderList
SlideShow
Conditionally
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
SlideShow
Always
AddFixedPriceItem
RelistFixedPriceItem
ReviseFixedPriceItem
VerifyAddFixedPriceItem
No
Contains the URL for a picture of the item.
The URL can be from the eBay Picture Services (images previously uploaded) or from a server outside of eBay (self-hosted).
You can pass in up to 12 picture URLs (for most categories and marketplaces) for each listing, but you cannot mix self-hosted and EPS-hosted URLs in the same listing. The <b>UploadSiteHostedPictures</b> call can be used to upload pictures to EPS. Note that if pictures are externally-hosted, they must be hosted on a site that is using the 'https' protocol. URLs using the 'http' protocol will not be allowed.
<br/><br/>
<span class="tablenote"><b>Note: </b>
If a URL contains spaces, those spaces can be replaced with <code>%20</code>. For example, <code>https://example.com/my image.jpg</code> must be submitted as <code>https://example.com/my%20image.jpg</code> to replace the space in the image file name. However, a semicolon character (;) cannot be replaced with <code>%20</code>, so a semicolon cannot be a part of the URL, as an error will occur.
</span>
On the US and Canada eBay Motors sites (for all vehicle listings) a listing can contain up to 24 pictures. The Gallery image will be the first <b>PictureURL</b>
in the array of <b>PictureURL</b> fields.
<br/><br/>
<span class="tablenote"><b>Note: </b>
All images, whether they are hosted by EPS or self-hosted, must comply with eBay picture requirements, including the requirement that all images must be at least 500 pixels on its longest side. If the image does not satisfy the 500 pixels requirement, the listing may be blocked. For more information about other requirements and tips for adding pictures to listings, see the <a href="https://www.ebay.com/help/selling/listings/adding-pictures-listings?id=4148">Adding pictures to your listings</a> help page.
</span>
To specify multiple pictures, send each URL in a separate, <b>PictureDetails.PictureURL</b> element. The first URL passed in defaults to be the 'gallery image', and will be the first picture that is shown when a user lands on the View Item page.
<br><br>
<br><br>
If a listing uses a single, self-hosted picture (except in the case of a multiple-variation listing), the picture will be copied to eBay Picture Services (EPS) and the <b>PictureDetails.PictureURL</b> value returned by <b>GetItem</b> will be an EPS URL.
<br/><br/>
<b>For VerifyAddItem only:</b> You must include a picture even when using <b>VerifyAddItem</b>. If you don't have a image file, you can use the following
fake eBay Picture Services URL (https://i2.ebayimg.com/abc/M28/dummy.jpg) with this call.
<br><br>
<b>For ReviseItem and RelistItem only:</b> To remove a picture when
revising or relisting an item, specify <b>PictureDetails</b> with all the pictures that you want the listing to include. That is, you need to completely replace the original set
of URLs with the revised set. You cannot remove all the <b>PictureURL</b> fields from a listing because each listing requires at least one picture.
<br/><br/>
<b>Remember</b>: The 'gallery image' will be the first <b>PictureURL</b> in the array of <b>PictureURL</b> fields. So, if the first image passed in when relisting/revising is different from when the listing was created, the 'gallery image' will be changed.
<br/><br/>
<span class="tablenote">
<strong>Note:</strong> For some large merchants, there are no limitations on when pictures can be added or removed from a fixed-price listing, even when the listing has had transactions or is set to end within 12 hours.
</span>
500
AddItem
AddItems
AddSellingManagerTemplate
RelistItem
ReviseItem
ReviseSellingManagerTemplate
VerifyAddItem
VerifyRelistItem
Conditionally
GetBidderList
Conditionally
GetItem
GetSellingManagerTemplates
Conditionally
DetailLevel: none, ItemReturnDescription,
ReturnAll
24
AddFixedPriceItem
RelistFixedPriceItem
ReviseFixedPriceItem
VerifyAddFixedPriceItem
Conditionally
Introduction to Pictures in Listings
https://developer.ebay.com/DevZone/guides/features-guide/default.html#Development/Pictures-Intro.html
Working with Pictures in an Item Listing
https://developer.ebay.com/DevZone/guides/features-guide/default.html#Development/Pictures-InListing.html
The service hosting the pictures in <b>PictureURL</b>, if any. This information is
primarily useful for Picture Manager subscribers, who pay a flat subscription
fee instead of individual picture fees per listing. Only returned when <b>PictureURL</b> is returned.
GetItem
GetSellingManagerTemplates
DetailLevel: ItemReturnAttributes, ReturnAll
Conditionally
EPS
AddFixedPriceItem
RelistFixedPriceItem
ReviseFixedPriceItem
VerifyAddFixedPriceItem
No
Indicates if the gallery image upload failed and gives a reason
for the failure, such as 'InvalidUrl' or 'ServerDown'. It is not
returned if the gallery image is uploaded successfully.
GetItem
Conditionally
Indicates the reason the
gallery generation failed, such as, URL for the image is not valid.
This field is returned when <b>GalleryStatus</b> field is returned
and does not appear when the gallery generation is successful.
<br/>
1024
GetItem
Conditionally
When returned this contains the original URL of a self-hosted pictures, associated with the item when the item was listed.
<br/>
500
1
GetItem
Conditionally
DetailLevel: none, ItemReturnDescription, ReturnAll
Using a Self-Hosted Picture
https://developer.ebay.com/devzone/guides/features-guide/default.html#Development/Pictures-InListing.html#UsingaSelfHostedPicture
This container returns the URLs of the seller's self-hosted (hosted outside of eBay) pictures and the URL for the corresponding eBay Picture Services (EPS), that was generated when the self-hosted picture was uploaded.
GetItem
Conditionally
Indicates the format of the picture returned. Sometimes this is different than the format of the uploaded picture.
Indicates the picture was returned in JPG format. Uploaded pictures in JPG, TIF, or BMP will be returned as JPG.
Indicates the picture was returned in GIF format.
Indicates the picture was returned in PNG format.
Reserved for internal use <b>only</b>.
This enumerated type is deprecated.
This value is not used.
This value is not used.
This value is not used.
This value is not used.
This value is not used.
This value is not used.
This enumerated type is deprecated.
This value is not used.
This value is not used.
This value is not used.
This value is not used.
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 field is deprecated.
This type is deprecated.
This field is deprecated.
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 enumerated type is deprecated.
This value is not used.
This value is not used.
This value is not used.
This value is not used.
This value is not used.
This value is not used.
This value is not used.
This type is deprecated.
This field is deprecated.
This field is deprecated.
This field is deprecated.
This field is deprecated.
This enumerated type is deprecated.
This value is not used.
This value is not used.
This value is not used.
This value is not used.
This value is not used.
This value is not used.
This type is deprecated.
This field is deprecated.
This field is deprecated.
This field is deprecated.
Specifies whether to generate the 'standard' set of images for each picture or to also generate a super-sized image.
<br/><br/>
<b>Note:</b> This type is used only for images that will be used in a listing.
Large
Indicates to generate the "Standard" set of images, which is a set of 7 images of various sizes, for each <b>ExternalPictureURL</b> submitted in the request.
This is the default. <b>Note:</b> This field is used only for images that will be used in a listing.
Indicates to generate the "Standard" set <i>plus</i> a super-sized image for each <b>ExternalPictureURL</b> submitted in the request.
In order to include the super-sized image in the Add Item calls, you must also specify <b>Item.PictureDetails.PhotoDisplay.Supersize</b> or <b>Item.PictureDetails.PhotoDisplay.PicturePack</b>.
<b>Note:</b> This field is used only for images that will be used in a listing.
This field is no longer returned.
Reserved for internal use <b>only</b>.
URL and size information for each generated and stored picture.
This data is provided for use in application previews of pictures.
This data is used for display control for specific pictures in the generated imageset.
This container is supplied for all generated pictures.
URL for the picture.
UploadSiteHostedPictures
Always
Height of the picture in pixels.
UploadSiteHostedPictures
Always
Width of the picture in pixels.
UploadSiteHostedPictures
Always
PictureManager
Enumerated type used to specify where a listing's image(s) are hosted.
This value indicates that the image(s) specified in the <b>PictureURL</b> field(s) are hosted by eBay Picture Services.
This value is deprecated.
This value indicates that the image(s) specified in the <b>PictureURL</b> field(s) are hosted by a third-party vendor. Note that if pictures are externally-hosted, they must be hosted on a site that is using the 'https' protocol.
(out) Reserved for internal or future use.
This container returns the URLs of the seller's self-hosted (hosted outside of eBay) pictures and the URL for the corresponding eBay Picture Services (EPS), that was generated when the picture was uploaded.
The URL of an eBay Picture Services (EPS) image. This image is created when a seller uploads a self-hosted image using the <b>UploadSiteHostedPictures</b>, <b>AddItem</b> or <b>AddFixedPriceItem</b> call.
<br>
150
24
GetItem
Conditionally
DetailLevel: none,ItemReturnDescription,ReturnAll
The URL of a seller's self-hosted image(s).
<br>
150
GetItem
Conditionally
DetailLevel: none, ItemReturnDescription, ReturnAll
Values to be used in choosing that an uploaded picture is added to the available pictures on the eBay site.
Specifies that an uploaded picture is added to the pictures available to a
seller on the eBay site.
Specifies, first, that all pictures available to a seller on the eBay site are
removed, and then second, that the currently uploaded picture is made
available to the seller.
Reserved for internal use ONLY.
This enumerated type is deprecated.
This value is not used.
This value is not used.
This value is not used.
Defines variation-specific pictures associated with one
<b>VariationSpecificName</b> (e.g., Color) whose values differ across variations.
One aspect of the variations that will be illustrated in the
pictures for all variations. For example, if each variation
is visually distinguished by color and the pictures show
the different colors available, then specify "Color" as the name.
The name must match one of the names specified in the
<b>VariationSpecifics</b> container.
<br><br>
This field is required in each <b>Item.Variations.Pictures</b> container that is used.
40
AddFixedPriceItem
ReviseFixedPriceItem
RelistFixedPriceItem
VerifyAddFixedPriceItem
Conditionally
AddSellingManagerProduct
ReviseSellingManagerProduct
No
AddSellingManagerTemplate
ReviseSellingManagerTemplate
No
GetSellingManagerInventory
Conditionally
GetItem
Conditionally
DetailLevel: none, ItemReturnDescription,
ItemReturnAttributes, ReturnAll
A container consisting of one or more picture URLs associated with a variation
specific value (e.g., color=blue). For example, suppose a listing contains blue
and black color variations, and <b>VariationSpecificName=Color</b>.
In this case, one picture set could contain pictures of the blue shirts (e.g.,
front view, back view, and close-up of a trim detail), and another picture set
could contain pictures of the black shirts.
<br><br>
A variation specific picture set can consist of up to 12 images hosted by eBay
Picture Services (EPS) or self-hosted (hosted outside of eBay) pictures.
The eBay Picture Services and self-hosted images can never
be combined into the same variation specific picture set.
<br><br>
At least one picture set is required if the <b>Pictures</b> node
is present in the request. You are not required to provide pictures
for all values that correspond to the variation specific name.
For example, a listing could have pictures depicting the blue and
black color variations, but not the pink variations.
<br/><br/>
<span class="tablenote"><b>Note: </b>
All images must comply with the <a href="http://developer.ebay.com/DevZone/guides/features-guide/default.html#development/Pictures-Intro.html">Picture Requirements</a>.
</span>
AddFixedPriceItem
VerifyAddFixedPriceItem
RelistFixedPriceItem
ReviseFixedPriceItem
Conditionally
AddSellingManagerProduct
ReviseSellingManagerProduct
No
AddSellingManagerTemplate
ReviseSellingManagerTemplate
No
GetSellingManagerInventory
Conditionally
GetItem
Conditionally
DetailLevel: none, ItemReturnDescription,
ItemReturnAttributes, ReturnAll
This type has been deprecated.
This field is deprecated.
This field is deprecated.
This enumerated type is deprecated.
This value is not used.
This value is not used.
This value is not used.
This value is not used.
This value is not used.
This type is deprecated, as the maximum number of policy violations for a buyer is no longer a valid Buyer Requirement at the account or listing level.
GeteBayDetails
Conditionally
1065
NoOp
1065
1065
NoOp
1065
Type defining the <b>PowerSellerStatus</b> container returned in the
<b>GetSellerDashboard</b> response. The <b>PowerSellerStatus</b>
container is only returned if the seller making the call is a Power Seller.
This field indicates the seller's eBay PowerSeller tier. PowerSellers are
distinguished in five tiers based on average monthly sales. Benefits and services vary
for each tier. eBay calculates eligibility for each tier on a monthly basis.
GetSellerDashboard
Conditionally
eBay US PowerSeller Requirements and Levels
http://pages.ebay.com/services/buyandsell/powerseller/criteria.html
The <b>PowerSellerStatus.Alert</b> container is only returned if eBay
has posted one or more informational or warning messages related to the seller's
PowerSeller status.
GetSellerDashboard
Conditionally
Specifies the criteria for filtering search results by site, where site is determined by the site ID in the request.
(in) Items listed in the currency implied by the site specified in the
request.
(in) Items located in the country implied by the site specified in the
request.
(in) Items available to the country implied by the site specified in the
request. For the US site, this implies listings from ALL English-language
countries that are available to the US.
(in) Items listed on the site specified in the request, regardless of listing
currency.
(in) Items located in Belgium or listed on one of the two Belgian sites.
(out) Reserved for internal or future use.
Indicates category support for listing of Local Market items by sellers
subscribed to Local Market for Premium Vehicles.
Each of the subscriptions will have following options, which will define
"National" vs "Local" ad format listing.
"LocalOptional" : This will allow national and local listing.
"LocalOnly" : Seller can have Local listings only.
"NationalOnly" : Seller can not opt into local only exposure. It has to be
national listing.
This type is deprecated.
This field is deprecated.
This enumerated type defines the available discount price treatments that can be set up by eligible sellers.
This enumeration value indicates that Strikethrough Pricing is enabled for the order line item. If this value is returned, the price in the <b>OriginalRetailPrice</b> field will be crossed out in the View Item page.
This enumeration value indicates that Minimum Advertised Pricing is enabled for the order line item. If this value is returned, the minimum advertised price is found in the <b>MinimumAdvertisedPrice</b> field.
This enumeration value indicates that neither Strikethrough Pricing or Minimum Advertised Pricing is enabled for the order line item.
This enumeration value indicates that Made For Outlet Comparison Pricing is enabled for the order line item. If this value is returned, the Made For Outlet Comparison price is found in the <b>MadeForOutletComparisonPrice</b> field.
Reserved for future use.
<span class="tablenote"><b>Note: </b> This enumerated type is deprecated as the Pro Pack Bundle feature is no longer available on any eBay Marketplace sites.
</span>
This value indicates that the Pro Pack listing upgrade is available for all sellers on the listing site.
This value indicates that the Pro Pack listing upgrade is not available to any sellers on the listing site.
This value indicates that the Pro Pack listing upgrade is only available to seller with Power Seller status on the listing site.
This value indicates that the Pro Pack listing upgrade is only available to Top Rated sellers on the listing site.
Reserved for internal or future use.
Defines the ProPack feature (a feature pack). If the field is present, the corresponding feature applies to the category. The field is returned as an empty element (i.e., a boolean value is not returned).
Defines the ProPackPlus feature (a feature pack). If the field is present, the corresponding feature applies to the category. The field is returned as an empty element (i.e., a boolean value is not returned).
This type is deprecated.
This field is deprecated.
This field is deprecated.
This type is deprecated.
This field is deprecated.
This field is deprecated.
This field is deprecated.
Values indicate whether product creation is enabled, disabled or required for a category.
Product creation is not supported for the category.
AddItem family calls can still list with product.
Product Creation is supported for the category.
AddItem family calls can still list with product but can go through new product creation flow.
Product Creation is required for the category.
AddItem family calls have to list with a product. If no product exists can go through new product creation flow.
(out) Reserved for internal or future use.
Defines the product creation enable feature. If a field of this type is present, the corresponding feature applies to the site. The field is returned as an empty element (e.g., a boolean value is not returned).
This type defines the <b>ProductDetails</b> container that is returned in the <b>GeteBayDetails</b> response if the <code>ProductDetails</code> value is used in a <b>DetailName</b> field (or no <b>DetailName</b> fields are used).
<br><br>
The <b>ProductDetails</b> container shows the substitute text that can be used in place of an actual product identifier (e.g. EAN, ISBNs, UPC, or MPN) in case the product does not have a product identifier and/or the product identifier is not known by the seller.
This field contains the actual text that should be passed into the relevant product identifier fields (e.g. <b>ProductListingDetails.UPC</b> in an <b>AddItem<.b> call) when creating a listing. Some eBay categories require one or more Global Trade Item Numbers (GTINs), so either the actual GTIN or this substitute text must be passed into the relevant fields.
GeteBayDetails
Conditionally
This type is deprecated.
773
Avoid
FindProducts (Shopping API)
889
This field is deprecated.
This field is deprecated.
This field is deprecated.
This type is deprecated.
773
Avoid
FindProducts (Shopping API)
889
This field is deprecated.
This field is deprecated.
This enumeration type contains the values that may be returned in the <b>EANEnabled</b>, <b>ISBNEnabled</b>, and <b>UPCEnabled</b> fields at the site level (<b>SiteDefaults</b> container) and category level (<b>Category</b> nodes) to indicate which sites and categories support, require, or do not support the use of product identifiers to help create a listing.
This enumeration value indicates that a product identifier (EAN, ISBN, UPC) may not be used to help create a listing. If returned at the site level (<b>SiteDefaults</b> container), most categories on the site (specified in the X-EBAY-API-SITEID) do not support the use of product identifiers. If returned at the category level (<b>Category</b> nodes), that specific category does not support the use of product identifiers.
This enumeration value indicates that a product identifier (EAN, ISBN, UPC) may be used to help create a listing. If returned at the site level (<b>SiteDefaults</b> container), most categories on the site (specified in the X-EBAY-API-SITEID) support the use of product identifiers. If returned at the category level (<b>Category</b> nodes), that specific category supports the use of product identifiers.
This enumeration value indicates that a product identifier (EAN, ISBN, UPC) is required when creating a listing. If returned at the site level (<b>SiteDefaults</b> container), most categories on the site (specified in the X-EBAY-API-SITEID) require the use of product identifiers. If returned at the category level (<b>Category</b> nodes), that specific category requires the use of product identifiers when creating a listing.
This value is for future use.
<span class="tablenote"><strong>Note:</strong>
This type and the <b>ProductIdentifiers</b> container were originally introduced into the Trading schema with the intention of separating Global Trade Item Numbers (GTINs) and other descriptive item specifics, but the <b>ProductIdentifiers</b> container was never wired on/returned in <b>GetCategorySpecifics</b>. Instead, users will still find one or more relevant GTIN types under a <b>Recommendations.NameRecommendation.Name</b> field in the <b>GetCategorySpecifics</b> response.
</span>
<span class="tablenote"><strong>Note:</strong>
The <b>ProductIdentifiers</b> container was originally introduced into the Trading schema with the intention of separating Global Trade Item Numbers (GTINs) and other descriptive item specifics, but this container was never wired on/returned in <b>GetCategorySpecifics</b>. Instead, users will still find one or more relevant GTIN types under a <b>Recommendations.NameRecommendation.Name</b> field.
</span>
<span class="tablenote"><strong>Note:</strong>
The <b>ProductIdentifiers</b> container was originally introduced into the Trading schema with the intention of separating Global Trade Item Numbers (GTINs) and other descriptive item specifics, but this container was never wired on/returned in <b>GetCategorySpecifics</b>. Instead, users will still find one or more relevant GTIN types under a <b>Recommendations.NameRecommendation.Name</b> field.
</span>
This type is deprecated.
This field is deprecated.
This field is deprecated.
This field is deprecated.
This field is deprecated.
This field is deprecated.
Type used by the <b>ProductListingDetails</b> container, which is used by a seller in an add/revise/relist call to identify a product through a Global Trade Item Number (EAN, ISBN, or UPC) or an eBay Product ID (e.g. 'ePID'). If a specified product identifier is matched to a product in the eBay catalog, some of the details for the product listing, such as listing category, product title, product description, product aspects, and stock photo are prefilled for the listing.
<br>
<br>
<span class="tablenote"><b>Note:</b>
If a Brand/MPN pair is required for the product, these values must still be input through the <b>BrandMPN</b> container.
</span>
If this value is <code>true</code>, the listing will use the eBay catalog product's stock photo. In an Add/Revise/Relist call, this field is set to <code>true</code> by default. If you will be using an eBay catalog product to list your item, it is always advised to include the stock photo. Sellers can also add their own pictures using one or more <b>Item.PictureDetails.PictureURL</b> fields. Seller photos are particularly recommended for used and modified products to give prospective buyers a clear sense of exactly what they are purchasing.
In <b>GetItem</b> and other 'Get' calls, the URL of the stock photo will be returned in the <b>StockPhotoURL</b> field.
<br/><br/>
AddFixedPriceItem
AddItem
AddItems
AddSellingManagerTemplate
RelistFixedPriceItem
RelistItem
ReviseFixedPriceItem
ReviseItem
ReviseSellingManagerTemplate
VerifyAddItem
VerifyAddFixedPriceItem
VerifyRelistItem
No
true
GetBidderList
Conditionally
GetItem
GetSellingManagerTemplates
DetailLevel: ItemReturnAttributes, ReturnAll
Conditionally
Using a Stock Photo in an Item Listing
https://developer.ebay.com/DevZone/guides/features-guide/default.html#Development/Pictures-InListing.html#UsingaStockPhotoinanItemListing
If this value is <code>true</code>, the listing will use the eBay catalog product's stock photo as the Gallery thumbnail photo. In an Add/Revise/Relist call, this field is set to <code>true</code> by default. If this field is set to <code>true</code>, the <b>IncludeStockPhotoURL</b> field must also be set to <code>true</code> or this field will have no effect. Sellers can also add their own pictures using one or more <b>Item.PictureDetails.PictureURL</b> fields, but none of these photos will be the Gallery thumbnail photo.
<br><br>
AddFixedPriceItem
AddItem
AddItems
AddSellingManagerTemplate
RelistFixedPriceItem
RelistItem
ReviseFixedPriceItem
ReviseItem
ReviseSellingManagerTemplate
VerifyAddItem
VerifyAddFixedPriceItem
VerifyRelistItem
No
true
GetBidderList
Conditionally
GetItem
GetSellingManagerTemplates
DetailLevel: ItemReturnAttributes, ReturnAll
Conditionally
https://developer.ebay.com/DevZone/guides/features-guide/default.html#Development/Pictures-InResults.html#UsinganeBayStockPhotoasaGalleryPicture
Using an eBay Stock Photo as a Gallery Picture
The full URL for the eBay catalog product's stock photo. This field is only returned if the seller used an eBay catalog product to list the item, and the
<b>IncludeStockPhotoURL</b> field was set to <code>true</code>.
GetBidderList
Conditionally
GetItem
GetSellingManagerTemplates
DetailLevel: ItemReturnAttributes, ReturnAll
Conditionally
Copyright statement indicating the source of the product information. This information will be
included in the listing if the seller used an eBay catalog product to list the item.
GetBidderList
Conditionally
GetItem
GetSellingManagerTemplates
DetailLevel: ItemReturnAttributes, ReturnAll
Conditionally
In an Add/Revise/Relist call, this field is used to pass in the eBay Product ID (e.g. ePID), which is the unique identifier of an eBay catalog product. Although an eBay catalog product match can be found using one or more GTIN values, passing in an ePID value is the best way to try and discover the appropriate eBay catalog product. For more information on finding a product in the eBay catalog, see the <a href="https://developer.ebay.com/api-docs/sell/static/inventory/pbse_playbook_intro.html" target="_blank">Product-Based Shopping Experience Playbook</a>.
<br>
<br>
This field is also returned in <b>GetItem</b> if the listing is associated with a eBay catalog product.
<br>
38 (42 with "EPID")
AddFixedPriceItem
AddItem
AddItems
AddSellingManagerTemplate
RelistFixedPriceItem
RelistItem
ReviseFixedPriceItem
ReviseItem
ReviseSellingManagerTemplate
VerifyAddFixedPriceItem
VerifyAddItem
VerifyRelistItem
Conditionally
GetItem
GetSellingManagerTemplates
Conditionally
DetailLevel: none, ItemReturnDescription,
ItemReturnAttributes, ReturnAll
This field is no longer applicable and should not be used.
This field is no longer applicable and should not be used.
If the seller attempts to use <b>ProductListingDetails</b> in an Add/Revise/Relist call to find an eBay catalog product match, and multiple matches are found, the call will actually fail. This field can be included and set to <code>true</code> if the seller wants to see the eBay catalog products that were found through error messages in the call response. This flag will not have an effect if only one catalog product matchi is found, or if the <b>UseFirstProduct</b> field is used and set to <code>true</code> and a catalog product is found to create/revise the listing. <br>
<br>
If this field is omitted or set to <code>false</code>, and multiple catalog products are found, the call will fail and no information about the matching catalog products will be returned.
<br>
AddFixedPriceItem
AddItem
AddItems
AddSellingManagerTemplate
RelistFixedPriceItem
RelistItem
ReviseFixedPriceItem
ReviseItem
ReviseSellingManagerTemplate
VerifyAddFixedPriceItem
VerifyAddItem
VerifyRelistItem
No
false
This field is used if the seller wants to, or is required to identify a product using an ISBN (International Standard Book Number) value. An ISBN is a unique identifer for books. Both 10 and 13-character ISBNs are supported. When specifying a 13-character ISBN, the value must begin with either '978' or '979'. The seller can use the <b>GetCategoryFeatures</b> or <b>GetCategorySpecifics</b> calls to see if an ISBN is supported/required for a category.
<br/><br/>
If the <b>IncludeeBayProductDetails</b> field is omitted or included and set to <code>true</code>, eBay will use the ISBN value passed into this field to try and find a matching eBay catalog product. If a match is found, the listing will pick up the product details of the catalog product, including the product title, product description, item specifics, and stock photo. If the seller is passing in an ePID through the <b>ProductReferenceID</b> field, this field is not needed, as all product identifiers will get picked up automatically by the listing if a matching catalog product is found.
<br/><br/>
This field is only applicable for single-variation listings. For multiple-variation listings, if the category/product requires an ISBN value, this value should be passed into the <b>Variation.VariationProductListingDetails.ISBN</b> field instead.
<br/><br/>
<span class="tablenote"><b>Note: </b>
If the listing is being posted to a category that expects an ISBN value, but one doesn't exist for the product, the seller must pass in the text that can be found in the <b>ProductDetails.ProductIdentifierUnavailableText</b> field of the <b>GeteBayDetails</b> response. To get the <b>ProductDetails</b> container to return in the <b>GeteBayDetails</b> response, <code>ProductDetails</code> should be included as a <b>DetailName</b> value in the call request.
</span>
AddFixedPriceItem
AddItem
AddItems
AddSellingManagerTemplate
RelistFixedPriceItem
RelistItem
ReviseFixedPriceItem
ReviseItem
ReviseSellingManagerTemplate
VerifyAddFixedPriceItem
VerifyAddItem
VerifyRelistItem
Conditionally
GetItem
GetSellingManagerTemplates
DetailLevel: ItemReturnAttributes, ReturnAll
Conditionally
This field is used if the seller wants to, or is required to identify a product using a UPC (Universal Product Code) value. A UPC is a commonly used identifer for many different products. The seller can use the <b>GetCategoryFeatures</b> or <b>GetCategorySpecifics</b> calls to see if a UPC is supported/required for a category.
<br/><br/>
<span class="tablenote"><b>Note: </b>
The <b>UPC</b> (and UPC values) are typically only applicable to US products listed on US eBay marketplace. If a European seller is selling a European-based product (with an EAN value) on the US site, instead of using the <b>EAN</b> field, the seller will use the <b>UPC</b> field to pass in the EAN value.
</span>
<br/>
If the <b>IncludeeBayProductDetails</b> field is omitted or included and set to <code>true</code>, eBay will use the UPC value passed into this field to try and find a matching eBay catalog product. If a match is found, the listing will pick up the product details of the catalog product, including the product title, product description, item specifics, and stock photo. If the seller is passing in an ePID through the <b>ProductReferenceID</b> field, this field is not needed, as all product identifiers will get picked up automatically by the listing if a matching catalog product is found.
<br/><br/>
This field is only applicable for single-variation listings. For multiple-variation listings, if the category/product requires a UPC value, this value should be passed into the <b>Variation.VariationProductListingDetails.UPC</b> field instead.
<br/><br/>
<span class="tablenote"><b>Note: </b>
If the listing is being posted to a category that expects a UPC value, but one doesn't exist for the product, the seller must pass in the text that can be found in the <b>ProductDetails.ProductIdentifierUnavailableText</b> field of the <b>GeteBayDetails</b> response. To get the <b>ProductDetails</b> container to return in the <b>GeteBayDetails</b> response, <code>ProductDetails</code> should be included as a <b>DetailName</b> value in the call request.
</span>
AddFixedPriceItem
AddItem
AddItems
AddSellingManagerTemplate
RelistFixedPriceItem
RelistItem
ReviseFixedPriceItem
ReviseItem
ReviseSellingManagerTemplate
VerifyAddFixedPriceItem
VerifyAddItem
VerifyRelistItem
Conditionally
GetItem
GetSellingManagerTemplates
DetailLevel: ItemReturnAttributes, ReturnAll
Conditionally
This field is used if the seller wants to, or is required to identify a product using an EAN (European Article Number) value. An EAN is a unique 8 or 13-digit identifier that many industries (such as book publishers) use to identify products. The seller can use the <b>GetCategoryFeatures</b> or <b>GetCategorySpecifics</b> calls to see if an EAN is supported/required for a category.
<br/><br/>
<span class="tablenote"><b>Note: </b>
The <b>EAN</b> (and EAN values) are typically only applicable to European products listed on European eBay marketplaces. If a US seller is selling a US-based product (with a UPC value) on a European site (such as eBay UK), instead of using the <b>UPC</b> field, the seller will use the <b>EAN</b> field to pass in the UPC value.
</span>
<br/>
If the <b>IncludeeBayProductDetails</b> field is omitted or included and set to <code>true</code>, eBay will use the EAN value passed into this field to try and find a matching eBay catalog product. If a match is found, the listing will pick up the product details of the catalog product, including the product title, product description, item specifics, and stock photo. If the seller is passing in an ePID through the <b>ProductReferenceID</b> field, this field is not needed, as all product identifiers will get picked up automatically by the listing if a matching catalog product is found.
<br/><br/>
This field is only applicable for single-variation listings. For multiple-variation listings, if the category/product requires an EAN value, this value should be passed into the <b>Variation.VariationProductListingDetails.EAN</b> field instead.
<br/><br/>
<span class="tablenote"><b>Note: </b>
If the listing is being posted to a category that expects an EAN value, but one doesn't exist for the product, the seller must pass in the text that can be found in the <b>ProductDetails.ProductIdentifierUnavailableText</b> field of the <b>GeteBayDetails</b> response. To get the <b>ProductDetails</b> container to return in the <b>GeteBayDetails</b> response, <code>ProductDetails</code> should be included as a <b>DetailName</b> value in the call request.
</span>
AddFixedPriceItem
AddItem
AddItems
AddSellingManagerTemplate
RelistFixedPriceItem
RelistItem
ReviseFixedPriceItem
ReviseItem
ReviseSellingManagerTemplate
VerifyAddFixedPriceItem
VerifyAddItem
VerifyRelistItem
Conditionally
GetItem
GetSellingManagerTemplates
DetailLevel: ItemReturnAttributes, ReturnAll
Conditionally
This container is used if the seller wants to, or is required to identify a product using an Brand/Manufacturer Part Number (MPN) pair. The seller can use the <b>GetCategoryFeatures</b> or <b>GetCategorySpecifics</b> calls to see if a Brand/MPN pair is supported/required for a category. Both the <b>Brand</b> and <b>MPN</b> fields are required if the category/product requires an MPN value.
<br/><br/>
If the <b>IncludeeBayProductDetails</b> field is omitted or included and set to <code>true</code>, eBay will use the Brand/MPN pair to try and find a matching eBay catalog product. If a match is found, the listing will pick up the product details of the catalog product, including the product title, product description, item specifics, and stock photo. If the seller is passing in an ePID through the <b>ProductReferenceID</b> field, this field is not needed, as all product identifiers associated with the catalog product will get picked up automatically by the listing if a matching catalog product is found.
<br/><br/>
This container is only applicable for single-variation listings. For multiple-variation listings, if the category requires Brand/MPN pairs, the product brand (shared by all variations in this listing) is passed in through the item-level item specifics (<b>Item.ItemSpecifics.NameValueList</b>), and the MPN value for each variation in the listing is passed in through the variation-level item specifics (<b>Variation.VariationSpecifics.NameValueList</b>).
<br/><br/>
<span class="tablenote"><b>Note: </b>
If the listing is being posted to a category that requires or recommends a Brand and MPN value, the Brand and MPN values for the product should always be passed in through separate <b>ItemSpecifics.NameValueList</b> containers since the Brand and MPN values passed in through the <b>ProductListingDetails.BrandMPN</b> will not get picked up by the generated/revised listing unless the the Brand/MPN pair is successfully matched to an eBay catalog product. If an MPN doesn't exist for a product, or the seller does not have it available, the seller must pass in the text that can be found in the <b>ProductDetails.ProductIdentifierUnavailableText</b> field of the <b>GeteBayDetails</b> response. To get the <b>ProductDetails</b> container to return in the <b>GeteBayDetails</b> response, <code>ProductDetails</code> should be included as a <b>DetailName</b> value in the call request.
</span>
<br>
AddFixedPriceItem
AddItem
AddItems
AddSellingManagerTemplate
RelistFixedPriceItem
RelistItem
ReviseFixedPriceItem
ReviseItem
ReviseSellingManagerTemplate
VerifyAddFixedPriceItem
VerifyAddItem
VerifyRelistItem
Conditionally
GetItem
GetSellingManagerTemplates
DetailLevel: ItemReturnAttributes, ReturnAll
Conditionally
This container is only applicable when a seller is creating/revising an event tickets listing.
AddFixedPriceItem
AddItem
AddItems
AddSellingManagerTemplate
RelistFixedPriceItem
RelistItem
ReviseFixedPriceItem
ReviseItem
ReviseSellingManagerTemplate
VerifyAddFixedPriceItem
VerifyAddItem
VerifyRelistItem
Conditionally
GetItem
GetSellingManagerTemplates
DetailLevel: ItemReturnAttributes, ReturnAll
Conditionally
This field can be included and set to <code>true</code> if the seller wants to use the first eBay catalog product that is found to create/revise the listing. eBay will search for an eBay catalog product match if the seller provides an ePID or one or more GTIN values. If this field is omitted, or included and set to <code>false</code>, the call will fail if more than one eBay catalog product is found.
<br>
AddFixedPriceItem
AddItem
AddItems
AddSellingManagerTemplate
RelistFixedPriceItem
RelistItem
ReviseFixedPriceItem
ReviseItem
ReviseSellingManagerTemplate
VerifyAddFixedPriceItem
VerifyAddItem
VerifyRelistItem
No
false
This boolean field controls whether or not an eBay catalog product is used to create or revise a listing. If an ePID or GTIN value is provided through the <b>ProductListingDetails</b> container when adding, revising, or relisting an item, the default behavior is for eBay to try and find a match for the product in the eBay catalog, and then automatically create/revise the listing using the product title, product description, item specifics, and stock photo defined for the catalog product.
<br><br>
If the seller wants to use an eBay catalog product to create/revise a listing, the seller can include this field and set its value to <code>true</code>, or just omit this field, as it default value is <code>true</code>. If a seller doesn't want use an eBay catalog product to create/revise their listing, this field should be included and set to <code>false</code>. If the seller declines to use an eBay catalog product, they will be required to pass in their own listing title, listing description, item specifics, a listing category, and at least one picture.
<br><br>
AddFixedPriceItem
AddItem
AddItems
AddSellingManagerTemplate
RelistFixedPriceItem
RelistItem
ReviseFixedPriceItem
ReviseItem
ReviseSellingManagerTemplate
VerifyAddItem
VerifyAddFixedPriceItem
VerifyRelistItem
No
true
GetBidderList
Conditionally
GetItem
GetSellingManagerTemplates
DetailLevel: ItemReturnAttributes, ReturnAll
Conditionally
This container is for future use. If it used, it will be ignored.
This type is deprecated.
This field is deprecated.
This enumerated type contains the values that indicate whether or not a product brand within an eBay category requires association with an eBay catalog product.
<br>
<br>
<span class="tablenote"><b>Note:</b>
Due to the rollback of the Product-Based Shopping Experience mandate for all eBay categories (and brands within those categories), the <b>ValidationRules.ProductRequired</b> field will not get returned for any brands within any eBay category. Due to this fact, the <b>ProductRequiredCodeType</b> is currently not applicable.
</span>
If this enumeration value is returned for a product brand within a category, the eBay seller is not expected to use an eBay catalog product when creating or revising their listing in this category for this product brand.
If this enumeration value is returned for a product brand within a category, the eBay seller should use an eBay catalog product when creating or revising their listing in this category for this product brand. Using an eBay catalog product for the specific category/brand to create/revise the listing is not a hard mandate, but it is necessary if the seller would like the listing to appear in product-based listing search results.
Reserved for internal or future use.
This enumerated type is used by the <b>ProductRequiredEnabled</b> field that can be returned under the <b>SiteDefaults</b> and/or <b>Category</b> containers of a <b>GetCategoryFeatures</b> response.
<br>
<br>
<span class="tablenote"><b>Note:</b>
Due to the rollback of the Product-Based Shopping Experience mandate for all eBay categories, the <b>ProductRequiredEnabled</b> field no longer has any practical use since it will show as Disabled for <b>SiteDefaults</b> and all <b>Category</b> nodes. Due to this fact, the <b>ProductRequiredEnabledCodeType</b> is currently not applicable.
</span>
This value indicates that the category does not require product-based listings (associated with an eBay catalog product).
<br>
<br>
<span class="tablenote"><b>Note:</b>
Due to the rollback of the Product-Based Shopping Experience mandate for all eBay categories, this value should get returned for <b>SiteDefaults</b> and all <b>Category</b> nodes.
</span>
This value indicates that the category requires listings within the category to be associated with an eBay catalog product.
<br>
<br>
<span class="tablenote"><b>Note:</b>
Due to the rollback of the Product-Based Shopping Experience mandate for all eBay categories, this value should never get returned for <b>SiteDefaults</b> or for any <b>Category</b> nodes.
</span>
(out) Reserved for internal or future use.
Type defining the <b>ProductRequiredEnabled</b> field that is returned under the <b>FeatureDefinitions</b> container of the <b>GetCategoryFeatures</b> response (as long as <b>ProductRequiredEnabled</b> is included as a <a href="types/FeatureIDCodeType.html">FeatureID</a> value in the call request or no <b>FeatureID</b> values are passed into the call request). The <b>ProductRequiredEnabled</b> field is returned as an empty element (a boolean value is not returned) if one or more eBay API-enabled sites support the Product-Based Shopping Experience.
<br>
<br>
<span class="tablenote"><b>Note:</b>
Due to the rollback of the Product-Based Shopping Experience mandate for all eBay categories, the <b>FeatureDefinitions.ProductRequiredEnabled</b> field no longer has any practical use. Due to this fact, the <b>ProductRequiredEnabledDefinitionType</b> is currently not applicable.
</span>
This type is deprecated.
773
NoOp
889
FindProducts (Shopping API)
This field is deprecated.
This field is deprecated.
This field is deprecated.
This field is deprecated.
This type is deprecated.
773
Avoid
FindProducts (Shopping API)
889
This field is deprecated.
This field is deprecated.
This field is deprecated.
This field is deprecated.
This type is deprecated.
773
Avoid
FindProducts (Shopping API)
889
This field is deprecated.
This field is deprecated.
This field is deprecated.
This field is deprecated.
This field is deprecated.
This field is deprecated.
This field is deprecated.
This field is deprecated.
This field is deprecated.
This field is deprecated.
This field is deprecated.
This field is deprecated.
This enumerated type is deprecated.
773
Avoid
FindProducts (Shopping API)
889
This value is not used.
This value is not used.
This value is not used.
This value is not used.
This value is not used.
This value is not used.
This value is not used.
This value is not used.
This value is not used.
This value is not used.
This value is not used.
This enumerated type is deprecated.
773
Avoid
FindProducts (Shopping API)
889
This value is not used.
This value is not used.
This value is not used.
This value is not used.
This value is not used.
This value is not used.
Identifies an individual product suggestion. The product details include the EPID, Title, Stock photo url and if it is
an exact match.
The title of the product from the eBay catalog.
80
AddFixedPriceItem
AddItem
RelistFixedPriceItem
RelistItem
ReviseFixedPriceItem
ReviseItem
VerifyAddItem
VerifyRelistItem
Conditionally
The product reference Id of the product
The eBay Product ID, a global reference ID for an eBay catalog product. The
ePID is a fixed reference to a product (regardless of version).
AddFixedPriceItem
AddItem
RelistFixedPriceItem
RelistItem
ReviseFixedPriceItem
ReviseItem
VerifyAddItem
VerifyRelistItem
Conditionally
Fully qualified URL for a stock image (if any) that is associated with the
eBay catalog product. The URL is for the image eBay usually displays in
product search results (usually 70px tall). It may be helpful to calculate the
dimensions of the photo programmatically before displaying it.
AddFixedPriceItem
AddItem
RelistFixedPriceItem
RelistItem
ReviseFixedPriceItem
ReviseItem
VerifyAddItem
VerifyRelistItem
Conditionally
If true, indicates that the product is an exact match, suitable for listing
the item.
AddFixedPriceItem
AddItem
RelistFixedPriceItem
RelistItem
ReviseFixedPriceItem
ReviseItem
VerifyAddItem
VerifyRelistItem
Conditionally
Provides a list of products recommended by eBay, which match the item information
provided by the seller.
Contains details for one or more individual product suggestions. The product
details include the EPID, Title, Stock photo url and whether or not the product
is an exact match for the submitted item. This product information can be used
to list subsequent items.
AddFixedPriceItem
AddItem
RelistFixedPriceItem
RelistItem
ReviseFixedPriceItem
ReviseItem
VerifyAddItem
VerifyRelistItem
Conditionally
This type is deprecated.
773
Avoid
FindProducts (Shopping API)
889
This field is deprecated.
This field is deprecated.
This field is deprecated.
This field is deprecated.
This field is deprecated.
This field is deprecated.
This field is deprecated.
This field is deprecated.
This field is deprecated.
This enumerated type is deprecated.
773
NoOp
889
FindProducts (Shopping API)
This value is not used.
This value is not used.
This value is not used.
This value is not used.
Enumerated type that defines the category group values. Business Policies profiles (Payment,
Shipping, and Return Policy) are linked to category groups.
Default value.
None.
For Business Policies, the 'ALL' enumeration value represents all eBay categories except for motor vehicles.
For Business Policies, the 'MOTORS_VEHICLE' enumeration value represents all motor vehicle categories.
Type defining the <b>PaymentProfileCategoryGroup</b>, <b> ReturnPolicyProfileCategoryGroup</b>, and <b>ShippingProfileCategoryGroup</b> fields, which are all returned in the <b>GetCategoryFeature</b> response if these Business Policies profile types apply to the category. Each of these fields is returned as an empty element.
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 field is deprecated.
This field is deprecated.
This type is deprecated.
521
603
NoOp
This field is deprecated.
This field is deprecated.
This field is deprecated.
This field is deprecated.
This enumerated type is deprecated.
This value is not used.
This value is not used.
This value is not used.
This value is not used.
This value is not used.
This enumerated type is deprecated.
This value is not used.
This value is not used.
This value is not used.
This enumerated type is deprecated.
This value is not used.
This value is not used.
This value is not used.
This type is deprecated.
521
603
NoOp
This field is deprecated.
This type is deprecated.
521
603
NoOp
This field is deprecated.
This field is deprecated.
This field is deprecated.
This field is deprecated.
This field is deprecated.
This field is deprecated.
This field is deprecated.
This field is deprecated.
This field is deprecated.
This type is deprecated.
This value is not used.
This value is not used.
This value is not used.
This value is not used.
This value is not used.
This value is not used.
This value is not used.
This value is not used.
This value is not used.
This value is not used.
This type is used by the <strong>PromotionalSaleDetails</strong> container returned in the <strong>GetPromotionalSaleDetails</strong> call. The <strong>PromotionalSaleDetails</strong> container consists of one or promotional sales that match the input criteria.
<br/><br/>
Promotional Sales are only available to eBay sellers who are eBay Store subscribers.
Each <strong>PromotionalSale</strong> container consists of detailed information on a seller's promotional sale. Each promotional sale that matches the input criteria is returned.
<br/><br/>
Promotional Sales are only available to eBay sellers who are eBay Store subscribers.
GetPromotionalSaleDetails
Conditionally
If a seller has reduced the price of a listed item with the Promotional Price Display
feature, this type contains the original price of the discounted item and other
information.
Original price of an item whose price a seller has reduced with the Promotional Price
Display feature.
GetBidderList
Conditionally
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally
GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
Conditionally
GetMyeBayBuying
WatchList
DetailLevel: none, ReturnAll
Conditionally
GetMyeBaySelling
ActiveList
DetailLevel: none, ReturnAll
Conditionally
Start time of a discount for an item whose price a seller has reduced with the
Promotional Price Display feature.
GetBidderList
Conditionally
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally
GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
Conditionally
GetMyeBayBuying
WatchList
DetailLevel: none, ReturnAll
Conditionally
GetMyeBaySelling
ActiveList
DetailLevel: none, ReturnAll
Conditionally
End time of a discount for an item whose price a seller has reduced with the
Promotional Price Display feature.
GetBidderList
Conditionally
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally
GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
Conditionally
GetMyeBayBuying
WatchList
DetailLevel: none, ReturnAll
Conditionally
GetMyeBaySelling
ActiveList
DetailLevel: none, ReturnAll
Conditionally
Values indicate the status of a sale. Used for the Promotional Price Display
feature, which enables sellers to apply discounts across many listings.
The promotional sale is active.
The promotional sale is scheduled. That is, the start time is in the future.
The status of the promotional sale is pending. When first scheduling a Sale,
if you select over 200 listings to be in any given Sale, it will take some
time for eBay to process the request.
The promotional sale is inactive, the sale has ended. You can reschedule a
sale once it has ended, but you will need to wait at least 24 hours before it
can become active.
The promotional sale has been deleted. Deleted promotional sales cannot be
updated or reactivated.
Reserved for internal or future use.
Details for a single promotional sale.
Unique ID of a promotional sale (discount and/or free shipping) for items.
This field is an input field only for the SetPromotionalSale call
and only if you are not adding a new promotional sale.
GetPromotionalSaleDetails
Conditionally
SetPromotionalSale
Conditionally
Name of a promotional sale for items.
SetPromotionalSale
Conditionally
GetPromotionalSaleDetails
Conditionally
Items covered by a promotional sale.
GetPromotionalSaleDetails
Conditionally
Status of a promotional sale for items.
GetPromotionalSaleDetails
Conditionally
Type of a promotional sale discount for items (for example, percentage).
Applies to price discount sales only.
SetPromotionalSale
Conditionally
GetPromotionalSaleDetails
Conditionally
Value of a promotional sale discount for items, a percentage discount
or a fixed amount reduction. Percentage discounts must be at least 5% and
cannot exceed 75% of the original listing price. Fixed amount discounts
will be in the currency of the original listing.
Applies to price discount sales only.
SetPromotionalSale
Conditionally
GetPromotionalSaleDetails
Conditionally
Start date of a promotional sale for items. Promotional sales can start
immediately or be scheduled to start at a later date. Some sites require
items to have been listed for a specific duration before they can be added
to a promotional sale (for example, on the US site, items must have been
listed for a day before they can be added to a promotional sale).
SetPromotionalSale
Conditionally
GetPromotionalSaleDetails
Conditionally
End date of a promotional sale discount for items. Maximum listing durations
vary by site from 14 days to 45 days. The minimum promotional sale duration is 1 day for most sites, but 3 days on some sites.
SetPromotionalSale
Conditionally
GetPromotionalSaleDetails
Conditionally
Type of promotional sale: price discount, free shipping, or both.
SetPromotionalSale
Conditionally
GetPromotionalSaleDetails
Conditionally
Values specify or indicate the type of promotional sale offered.
Promotional sales give store owners the ability to apply discounts and/or
free shipping across many listings for a specific duration.
Sale offers price discount only.
Sale offers free shipping only.
Sale offers both price discount and free shipping.
Reserved for internal or future use.
Details of a promotional shipping discount.
The type of promotional shipping discount that is detailed in the profile. If the discount type is <code>MaximumShippingCostPerOrder</code>, see <b>ShippingCost</b>. If the discount type is <code>ShippingCostXForAmountY</code>, see <b>ShippingCost</b> and <b>OrderAmount</b>. If the discount type is <code>ShippingCostXForItemCountN</code>, see <b>ShippingCost</b> and <b>ItemCount</b>.
GetShippingDiscountProfiles
MaximumShippingCostPerOrder, ShippingCostXForAmountY, ShippingCostXForItemCountN
Conditionally
SetShippingDiscountProfiles
MaximumShippingCostPerOrder, ShippingCostXForAmountY, ShippingCostXForItemCountN
Conditionally
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
MaximumShippingCostPerOrder, ShippingCostXForAmountY, ShippingCostXForItemCountN
Conditionally
This is shipping cost X when <b>DiscountName</b> is either <code>ShippingCostXForAmountY</code> or
<code>ShippingCostXForItemCountN</code>, and is the maximum cost when <b>DiscountName</b> is
<code>MaximumShippingCostPerOrder</code>.
GetShippingDiscountProfiles
Conditionally
SetShippingDiscountProfiles
Conditionally
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally
This is the cost Y of the order (not including shipping cost)
when <b>DiscountName</b> is set to <code>ShippingCostXForAmountY</code>.
GetShippingDiscountProfiles
Conditionally
SetShippingDiscountProfiles
Conditionally
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally
This is the number of items when <b>DiscountName</b> is set to <code>ShippingCostXForItemsY</code>.
GetShippingDiscountProfiles
Conditionally
SetShippingDiscountProfiles
Conditionally
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally
This enumerated type is deprecated.
This value is not used.
This value is not used.
This value is not used.
This value is not used.
This value is not used.
This value is not used.
This value is not used.
This value is not used.
This value is not used.
Contains a seller's preference for sending a "Payment Reminder Email" to buyers.
If true, a payment reminder Email is sent to buyers.
GetUserPreferences
Conditionally
SetUserPreferences
No
Indicates the text message type of the item's quantity availability.
(out) The message "Limited quantity available" is shown in the web
flow (e.g., for a flash sale or a Daily Deal).
(out) The message "More than 10 available" is shown in the web flow.
10 is the value of QuantityThreshold tag based on the seller's
preference.
Reserved for internal or future use.
Type defining the <b>QuantityInfo</b> container, which consists of the <b>MinimumRemnantSet</b> field, which sets the minimum amount of event tickets that can remain in the fixed-price listing's inventory after a buyer purchases one or more tickets (but not all) from the listing.
Enables a seller to avoid being left with quanity of <code>1</code> in an event listing. A typical use case is event tickets in reserved,
adjacent seats, or items that typically only sell if more than
one can be purchased at once.
<br>
<br>
Specify the minimum number of items that
should remain if a buyer doesn't purchase all the items.
Based on the value of <b>MinimumRemnantSet</b> and the listing's
available quantity (<b>Quantity</b>-<b>QuantitySold</b>), eBay calculates the quantity that a buyer can purchase in one transaction.
For example, suppose you list 5 tickets, and you want at least
2 tickets remaining for the final buyer to purchase.
In this case, you would set <b>MinimumRemnantSet</b> value to <code>2</code>.
This means a buyer can purchase 1, 2, 3, or 5 tickets, but not 4
(because 4 would leave the seller with 1 ticket).<br>
<br>
To remove this restriction when you revise or relist,
set <b>MinimumRemnantSet</b> to 1.<br>
<br>
Applicable to multiple-quantity, fixed-price listings.
Currently supported for US and CA event ticket listings.
<br>
AddFixedPriceItem
ReviseFixedPriceItem
RelistFixedPriceItem
VerifyAddFixedPriceItem
Conditionally
AddItem
ReviseItem
RelistItem
VerifyAddItem
Conditionally
GetItem
Conditionally
DetailLevel: none, ItemReturnDescription,
ItemReturnAttributes, ReturnAll
1
Enumerated type used by the <b>QuantityOperator</b> field that is returned under the <b>FavoriteSearch</b> container in a <b>GetMyeBayBuying</b> call. The values in this type indicate how the quantity of the item that the prospective desires compares to the quantity available.
This enumeration value indicates that the quantity sought (specified in <b>Quantity</b> field) is less than the quantity available (specified in <b>TotalAvailable</b> field).
This enumeration value indicates that the quantity sought (specified in <b>Quantity</b> field) is less than or equal to the quantity available (specified in <b>TotalAvailable</b> field).
This enumeration value indicates that the quantity sought (specified in <b>Quantity</b> field) is equal to the quantity available (specified in <b>TotalAvailable</b> field).
This enumeration value indicates that the quantity sought (specified in <b>Quantity</b> field) is greater than the quantity available (specified in <b>TotalAvailable</b> field).
This enumeration value indicates that the quantity sought (specified in <b>Quantity</b> field) is greater than or equal to the quantity available (specified in <b>TotalAvailable</b> field).
Reserved for internal or future use.
This type defines the <b>QuantityRestrictionPerBuyer</b> container, which is
used by the seller to restrict the quantity of items that may be purchased by one buyer
during the duration of a fixed-price listing (single or multi-variation).
This integer value indicates the maximum quantity of items that a single buyer may
purchase during the duration of a fixed-price listing (single or multi-variation).
The buyer is blocked from the purchase if that buyer is attempting to purchase a
quantity of items that will exceed this value. Previous purchases made by the buyer
are taken into account. For example, if <b>MaximumQuantity</b> is set to
'5' for an item listing, and <em>Buyer1</em> purchases a quantity of
three, <em>Buyer1</em> is only allowed to purchase an additional
quantity of two in subsequent orders on the same item listing.
<br/><br/>
This field is required if the <b>QuantityRestrictionPerBuyer</b>
container is used.
<br>
1
AddFixedPriceItem
AddItem
AddItems
VerifyAddItem
VerifyAddFixedPriceItem
Conditionally
RelistFixedPriceItem
RelistItem
VerifyRelistItem
ReviseFixedPriceItem
ReviseItem
Conditionally
Enumerated type used by the member messaging calls to indicate the type of question that was asked.
This enumeration value indicates that a general question was asked about the order line item.
This enumeration value indicates that a question about shipping the order line item was asked.
This enumeration value indicates that a payment question was asked about the order line item.
This enumeration value indicates that a question was asked about a shipment that involves multiple packages.
This enumeration value indicates that question was asked about a customized subject.
Reserved
This enumeration value indicates that question does not have a subject.
Reserved for future or internal use.
The status of a payment.
Order line item payment has been canceled.
(Reserved for future use.)
Order line item payment is completed.
Order line item is awaiting payment.
(out) Reserved for internal or future use.
This enumerated type is deprecated.
This value is not used.
This value is not used.
This value is not used.
This type is used to reference a seller's specific domestic and/or international shipping rate tables. Shipping rate tables allow sellers to configure specific shipping costs based on the shipping destinations and level of service (e.g. economy, standard, expedite, and one-day). Generally speaking, sellers want to use these shipping rate tables so they can charge a higher shipping cost to the buyer whenever shipping costs are higher for them as well. For example, shipping to Alaska or Hawaii is generally more expensive than shipping to any other of the 48 US states, or in regards to international shipping, shipping to some regions and countries are more expensive than others.
<br><br>
Sellers configure domestic, international, and regional shipping rate tables in My eBay Shipping Preferences. To apply shipping rate tables, the shipping cost type must be flat-rate.
<br><br>
For domestic shipping rate tables, the three supported domestic regions are Alaska & Hawaii, US Protectorates (e.g. Puerto Rico and Guam), and APO/FPO destinations, which are US military bases/locations outside of the continental US. In addition to setting one flat rate based on the destination and service level, the seller also has the option of adding an extra charge based on the weight of the shipping package, or they can add a surcharge instead.
<br><br>
For international shipping rate tables, specific rates may be set up for any and all geographical regions and individual countries within those regions. Similar to domestic shipping rate tables, the seller has the option of adding an extra charge based on the weight of the shipping package. Sellers cannot add a surcharge for international shipping.
<br/><br/>
<span class="tablenote"><b>Note: </b> The capability to create and use multiple domestic and international shipping rate tables (up to 40 per seller account) has rolled out to the US, Australia, UK, Germany, Canada (English and French), and Italy sites. For other sites, only one domestic and one international shipping rate table may be set up per seller. Until the seller's account is updated with the new shipping rate tables in My eBay, the seller will continue to use the <b>DomesticRateTable</b> and <b>InternationalRateTable</b> tags and pass in <code>Default</code> as the value. Once the seller's account is updated with the new shipping rate tables in My eBay, the seller will be required to use the new <b>DomesticRateTableId</b> and <b>InternationalRateTableId</b> tags, and the <b>DomesticRateTable</b> and <b>InternationalRateTable</b> tags will not work. Note that shipping rate tables can also be applied to Shipping business policies that are applied against a listing. The new shipping rate tables have all of the functionality of the old shipping rate tables, plus the seller has access to all domestic regions and not just the special regions (such as Alaska & Hawaii, US Protectorates, and APO/FPO locations in US).</span>
This field is used in an Add/Revise/Relist/Verify call to apply the domestic shipping rate table to the listing. Domestic rate tables can be used only for items listed on the eBay US, Australia, UK, Germany, Canada (English and French), and Italy sites.
<br><br>
In all cases, sellers pass in a string value of <code>Default</code> to apply the domestic shipping rate table. The shipping rates and/or surcharges set up in the domestic shipping rate table will only be applicable based on the location of the buyer, and if that shipping service level is covered in one of the specified shipping service options in the listing. Basically, domestic shipping costs and surcharges are set in one or more <b>ShippingServiceOptions</b> containers in the listing, and based on the settings and costs in the domestic shipping rate table, these shipping costs and/or surcharges may be overridden based on the buyer's location. For example, if the buyer lives in Alaska, and the domestic shipping rate table has one or more shipping rates set up for the <em>Alaska & Hawaii</em> domestic region, the buyer will see these rates in the View Item page and not the rates/costs that are defined in the <b>ShippingServiceOptions</b> containers.
<br><br>
If a seller is revising or relisting an item, the domestic shipping rate table can be unassociated from the listing by using the empty tag: <code><DomesticRateTable /></code>
<br><br>
This field is returned in the 'Get' calls if a domestic rate table is being applied to the listing, and it is only returned for the seller who listed the item.
<br/><br/>
<span class="tablenote"><b>Note: </b> The capability to create and use multiple domestic and international shipping rate tables (up to 40 per seller account) has rolled out to the US, Australia, UK, Germany, Canada (English and French), and Italy sites. Currently, for sites other than the ones stated, only one domestic and one international shipping rate table may be set up per seller. Until the seller's account is updated with the new shipping rate tables in My eBay, the seller will continue to use the <b>DomesticRateTable</b> and <b>InternationalRateTable</b> tags and pass in <code>Default</code> as the value. Once the seller's account is updated with the new shipping rate tables in My eBay, the seller will be required to use the new <b>DomesticRateTableId</b> and <b>InternationalRateTableId</b> tags, and the <b>DomesticRateTable</b> and <b>InternationalRateTable</b> tags will not work. Note that shipping rate tables can also be applied to Shipping business policies that are applied against a listing. The new shipping rate tables have all of the functionality of the old shipping rate tables, plus the seller has access to all domestic regions and not just the special regions (such as Alaska & Hawaii, US Protectorates, and APO/FPO locations in US).</span>
50
AddFixedPriceItem
AddItem
AddItems
AddSellingManagerTemplate
RelistFixedPriceItem
RelistItem
ReviseFixedPriceItem
ReviseItem
VerifyAddFixedPriceItem
VerifyAddItem
VerifyRelistItem
ReviseSellingManagerTemplate
Conditionally
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnAttributes, ItemReturnDescription, ReturnAll
Conditionally
GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
Conditionally
Using Shipping Rate Tables
http://developer.ebay.com/DevZone/guides/features-guide/default.html#development/Shipping-TypesCosts.html#UsingShippingRateTables
more information on using shipping rate tables.
This field is used in an Add/Revise/Relist/Verify call to apply the international shipping rate table to the listing. Domestic rate tables can be used only for items listed on the eBay US, UK, and DE sites.
<br><br>
In all cases, sellers pass in a string value of <code>Default</code> to apply the international shipping rate table. The shipping rates set up in the international shipping rate table will only be applicable based on the location of the buyer, and if that shipping service level is covered in one of the specified international shipping service options in the listing. Basically, international shipping costs are set in one or more <b>InternationalShippingServiceOption</b> containers in the listing, and based on the settings and costs in the international shipping rate table, these shipping costs may be overridden based on the buyer's location. For example, if the buyer lives in Argentina, and the international shipping rate table has one or more shipping rates set up for the country of <em>Argentina</em>, the buyer will see these rates in the View Item page and not the rates/costs that are defined in the <b>InternationalShippingServiceOption</b> containers.
<br><br>
If a seller is revising or relisting an item, the international shipping rate table can be unassociated from the listing by using the empty tag: <code><InternationalRateTable /></code>
<br><br>
This field is returned in the 'Get' calls if an international rate table is being applied to the listing, and it is only returned for the seller who listed the item.
<br><br>
<span class="tablenote"><b>Note: </b> The capability to create and use multiple domestic and international shipping rate tables (up to 40 per seller account) has rolled out to the US, Australia, UK, Germany, Canada (English and French), and Italy sites. Currently, for sites other than the ones stated, only one domestic and one international shipping rate table may be set up per seller. Until the seller's account is updated with the new shipping rate tables in My eBay, the seller will continue to use the <b>DomesticRateTable</b> and <b>InternationalRateTable</b> tags and pass in <code>Default</code> as the value. Once the seller's account is updated with the new shipping rate tables in My eBay, the seller will be required to use the new <b>DomesticRateTableId</b> and <b>InternationalRateTableId</b> tags, and the <b>DomesticRateTable</b> and <b>InternationalRateTable</b> tags will not work. Note that shipping rate tables can also be applied to Shipping business policies that are applied against a listing. The new shipping rate tables have all of the functionality of the old shipping rate tables, plus the seller has access to all domestic regions and not just the special regions (such as Alaska & Hawaii, US Protectorates, and APO/FPO locations in US).</span>
50
AddFixedPriceItem
AddItem
AddItems
AddSellingManagerTemplate
RelistFixedPriceItem
RelistItem
ReviseFixedPriceItem
ReviseItem
VerifyAddFixedPriceItem
VerifyAddItem
VerifyRelistItem
ReviseSellingManagerTemplate
Conditionally
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnAttributes, ItemReturnDescription, ReturnAll
Conditionally
GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
Conditionally
Using Shipping Rate Tables
http://developer.ebay.com/DevZone/guides/features-guide/default.html#development/Shipping-TypesCosts.html#UsingShippingRateTables
more information on using shipping rate tables.
<span class="tablenote"><b>Note: </b>This field is only available for sellers on the US, Australia, UK, Germany, Canada (English and French), and Italy sites. The unique shipping rate identifiers that will be passed into this field can be retrieved using the <b>getRateTables</b> call of the <b>Account API</b>, or these identifiers can be viewed in the displayed URL when the seller selects a specific shipping rate table in the Shipping rate tables UI in My eBay.
</span>
<br>
This field is included in an Add/Revise/Relist/Verify call if the seller wants to apply a customized domestic shipping rate table to the listing. The string value that is supplied in this field is the unique identifier of the shipping rate table. If the <b>DomesticRateTableId</b> field is used, the seller must make sure that the <b>DomesticRateTable</b> and <b>InternationalRateTable</b> fields are not used, as the old and new rate tables cannot be used together or an error will occur.
<br><br>
In domestic shipping rate tables, sellers customize the flat-rate cost of shipping based on shipping destination (region/state/province) and shipping service level (one-day, expedited, standard, economy in US). In addition to setting one flat rate based on the destination and service level, the seller also has the option of adding an extra charge based on the weight of the shipping package, or they can add a surcharge instead.
<br><br>
If the seller is using the Revise or Relist call, they must include the <b>DomesticRateTableId</b> field or the domestic shipping rate table currently being applied to the listing will be unassociated from the listing. If they want to continue using the same domestic shipping rate table, the seller will pass in this identifier. The seller can also change the domestic shipping rate table by passing in the identifier for a different domestic shipping rate table.
<br><br>
If a seller is revising or relisting an item, the domestic shipping rate table can be unassociated from the listing by using the empty tag: <code><DomesticRateTableId /></code>
<br><br>
This field is returned in the 'Get' calls if a customized domestic rate table is being applied to the listing, and it is only returned for the seller who listed the item.
<br><br>
<span class="tablenote"><b>Note: </b> The capability to create and use multiple domestic and international shipping rate tables (up to 40 per seller account) has rolled out to the US, Australia, UK, Germany, Canada (English and French), and Italy sites. For other sites, only one domestic and one international shipping rate table may be set up per seller. Until the seller's account is updated with the new shipping rate tables in My eBay, the seller will continue to use the <b>DomesticRateTable</b> and <b>InternationalRateTable</b> tags and pass in <code>Default</code> as the value. Once the seller's account is updated with the new shipping rate tables in My eBay, the seller will be required to use the new <b>DomesticRateTableId</b> and <b>InternationalRateTableId</b> tags, and the <b>DomesticRateTable</b> and <b>InternationalRateTable</b> tags will not work. Note that shipping rate tables can also be applied to Shipping business policies that are applied against a listing. The new shipping rate tables have all of the functionality of the old shipping rate tables, plus the seller has access to all domestic regions and not just the special regions (such as Alaska & Hawaii, US Protectorates, and APO/FPO locations in US).</span>
50
AddFixedPriceItem
AddItem
AddItems
AddSellingManagerTemplate
RelistFixedPriceItem
RelistItem
ReviseFixedPriceItem
ReviseItem
VerifyAddFixedPriceItem
VerifyAddItem
VerifyRelistItem
ReviseSellingManagerTemplate
Conditionally
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnAttributes, ItemReturnDescription, ReturnAll
Conditionally
GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
Conditionally
<span class="tablenote"><b>Note: </b>This field is only available to sellers on the US, Australia, UK, Germany, Canada (English and French), and Italy sites. The unique shipping rate identifiers that will be passed into this field can be retrieved using the <b>getRateTables</b> call of the <b>Account API</b>, or these identifiers can be viewed in the displayed URL when the seller selects a specific shipping rate table in the Shipping rate tables UI in My eBay.
</span>
<br>
This field is included in an Add/Revise/Relist/Verify call if the seller wants to apply a customized international shipping rate table to the listing. The string value that is supplied in this field is the unique identifier of the shipping rate table. If the <b>InternationalRateTableId</b> field is used, the seller must make sure that the <b>DomesticRateTable</b> and <b>InternationalRateTable</b> fields are not used, as the old and new rate tables cannot be used together or an error will occur.
<br><br>
In international shipping rate tables, sellers customize the flat-rate cost of shipping based on shipping destination (continent/region/country) and shipping service level (expedited, standard, economy in US). In addition to setting one flat rate based on the destination and service level, the seller also has the option of adding an extra charge based on the weight of the shipping package. Unlike domestic shipping, sellers cannot add a surcharge for international shipping.
<br><br>
If the seller is using the Revise or Relist call, they must include the <b>InternationalRateTableId</b> field or the international shipping rate table currently being applied to the listing will be unassociated from the listing. If they want to continue using the same international shipping rate table, the seller will pass in this identifier. The seller can also change the international shipping rate table by passing in the identifier for a different international shipping rate table.
<br><br>
If a seller is revising or relisting an item, the domestic shipping rate table can be unassociated from the listing by using the empty tag: <code><InternationalRateTableId /></code>
<br><br>
This field is returned in the 'Get' calls if a customized international rate table is being applied to the listing, and it is only returned for the seller who listed the item.
<br/><br/>
<span class="tablenote"><b>Note: </b> The capability to create and use multiple domestic and international shipping rate tables (up to 40 per seller account) has rolled out to the US, Australia, UK, Germany, Canada (English and French), and Italy sites. For other sites, only one domestic and one international shipping rate table may be set up per seller. Until the seller's account is updated with the new shipping rate tables in My eBay, the seller will continue to use the <b>DomesticRateTable</b> and <b>InternationalRateTable</b> tags and pass in <code>Default</code> as the value. Once the seller's account is updated with the new shipping rate tables in My eBay, the seller will be required to use the new <b>DomesticRateTableId</b> and <b>InternationalRateTableId</b> tags, and the <b>DomesticRateTable</b> and <b>InternationalRateTable</b> tags will not work. Note that shipping rate tables can also be applied to Shipping business policies that are applied against a listing. The new shipping rate tables have all of the functionality of the old shipping rate tables, plus the seller has access to all domestic regions and not just the special regions (such as Alaska & Hawaii, US Protectorates, and APO/FPO locations in US).</span>
50
AddFixedPriceItem
AddItem
AddItems
AddSellingManagerTemplate
RelistFixedPriceItem
RelistItem
ReviseFixedPriceItem
ReviseItem
VerifyAddFixedPriceItem
VerifyAddItem
VerifyRelistItem
ReviseSellingManagerTemplate
Conditionally
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnAttributes, ItemReturnDescription, ReturnAll
Conditionally
GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
Conditionally
A container for VeRO reason code details.
The short description of the infringement associated with the reason code ID.
GetVeROReasonCodeDetails
Always
The long description of the infringement associated with the reason code ID.
GetVeROReasonCodeDetails
Always
A unique identifier assigned to a reason code.
GetVeROReasonCodeDetails
Always
Enumerated type that defines the possible reasons why a listing
is being hidden from search on the eBay site.
This value indicates that the listing is being hidden from search on the eBay site because the listing has been determined by eBay to be a duplicate listing.
<br/><br/>
This enumeration value is associated with eBay Duplicate Listings Policy, which is applicable on the US, CA, CA-FR, and eBay Motors (Parts and Accessories only) sites. Event Tickets, Real Estate, and Motor Vehicle categories are excluded from this policy. For more information, read <a href="http://pages.ebay.com/help/policies/listing-multi.html">eBay's Duplicate Listings Policy</a> help page.
This value indicates that the listing is currently hidden from search because the quantity in the listing is zero. However, the listing is still alive and will reappear in the search results when the quantity is set to something greater than zero. The 'Out-of-stock' option is set by the seller at the account level. This option can be enabled in My eBay Site Preferences, or the seller can use the <a href="http://developer.ebay.com/DevZone/XML/docs/Reference/ebay/SetUserPreferences.html#Request.OutOfStockControlPreference">OutOfStockControlPreference</a> field in the <b>SetUserPreferences</b> call.
A seller can make a Transaction Confirmation Request (TCR) for an item. This code
list contains values to specify the current relationship between the seller and
the potential buyer. For a seller to make a Transaction Confirmation Request (TCR)
for an item, the potential buyer must meet one of the criteria in this code list.
Indicates that the recipient has one or more bids on the item; the relationship is "bidder."
Indicates that the recipient has one or more Best Offers on the item; the
relationship is "Best Offer buyer."
Indicates that the recipient has asked the seller a question about the item;
the relationship is "a member with an ASQ question."
Indicates that the recipient has a postal code; the relationship is "a member
with a postal code."
Reserved for internal or future use.
This enumerated type is deprecated.
This value is not used.
This value is not used.
This value is not used.
This value is not used.
This value is not used.
This value is not used.
This type was replaced by <b>ListingRecommendationType</b>
This type is used by the <b>ValidationRules</b> containers returned in the <b>GetCategorySpecifics</b> response, which contains some rules and limits for the recommended Item Specific name (specified in the <b>NameRecommendation.Name</b> field) and corresponding value(s) (specified in the <b>ValueRecommendation.Value</b> field). These rules and limits will apply when the recommended Item Specific is subsequently used in an Add/Revise/Relist call.
The data type (e.g., date) that eBay expects the value to
adhere to in listing requests.
Only returned if the data type is not Text.
In some cases, more details about the data type are returned
in the <b>ValueFormat</b> field.<br>
<br>
As buyers may search on the value you specify in <b>AddItem</b>,
the ISBN, UPC, or EAN should match the value that was specified by
the publisher or manufacturer.
<br><br>
<span class="tablenote"><b>Note:</b>
The <code>Numeric</code> enumeration value is returned for whole integers (no decimal point), and the <code>Decimal</code> enumeration value is returned for numbers with decimals.
</span>
CustomCode, Date, Decimal, EAN, ISBN, Text, UPC
GetCategorySpecifics
NameRecommendation.ValidationRules
Conditionally
Minimum number of values that you can specify for this Item Specific
in listing requests. Not returned if zero (0).<br>
<br>
If this field is returned, it indicates that the Item Specific is required
in listing requests in the corresponding category.
If the <b>Relationship</b> field is also present, it means this Item Specific is
required when you specify its parent value in listing requests.
GetCategorySpecifics
NameRecommendation.ValidationRules
Conditionally
Maximum number of values that you can specify for this Item Specific
in listing requests (like AddItem) in the specified
category.<br>
<br>
Most Item Specifics can only have one value. When this is
greater than 1, your application can present the value
recommendations (if any) as a multi-select list to the seller.
(See <b>SelectionMode</b> to determine whether the seller needs to
choose from eBay's recommendations or not.)
GetCategorySpecifics
NameRecommendation.ValidationRules
Conditionally
Controls whether you can specify your own name and value
in listing requests, or if you need to use a name and/or value
that eBay has defined.
GetCategorySpecifics
NameRecommendation.ValidationRules
FreeText, Prefilled, SelectionOnly
Conditionally
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.
<br/><br/>
<span class="tablenote"><b>Note: </b> Currently, the <b>AspectUsage</b> field will only be returned for some item/instance aspects (and not product aspects). Examples of common instance aspects that are shared by many eBay categories include 'Custom Bundle', 'Bundle Description', 'Modified Item', 'Modification Description', and 'California Prop 65 Warning'. Many instance aspect values are allowed more characters than the standard 65 max character threshold, and sellers can look at the corresponding <b>MaxValueLength</b> field to get the maximum number of characters allowed for that particular instance aspect value.
</span>
GetCategorySpecifics
NameRecommendation.ValidationRules
Product, Instance
Conditionally
This integer value will state the maximum length of the instance aspect's value. The seller must make sure not to exceed this value when setting instance aspects on a listing. This field is only returned for instance aspects (<b>AspectUsage</b>=<code>Instance</code>). The standard maximum length for an item specific value is 65 characters.
GetCategorySpecifics
NameRecommendation.ValidationRules
Conditionally
The enumeration value returned in this field will indicate whether or not the corresponding product brand requires listings within that category to be associated with an eBay catalog product. To create a listing that is associated with an eBay catalog product, the seller uses the <b>ProductListingDetails</b> container of the <b>AddItem</b> call. To find a matching product in the eBay catalog, the seller can use the new <b>eBay Catalog API</b> or <b>FindProducts</b> call of the <b>eBay Shopping API</b>.
<br>
<br>
This field is only returned for the 'Brand' <b>NameRecommendation</b> container, and only if that particular product brand within that Product-Based Shopping Experience-enabled category requires a catalog product.
<br>
<br>
<span class="tablenote"><b>Note:</b>
Due to the rollback of the Product-Based Shopping Experience mandate for all eBay categories (and brands within those categories), the <b>ValidationRules.ProductRequired</b> field will not get returned for any brands within any eBay category. Due to this fact, the <b>ProductRequired</b> field is currently not applicable.
</span>
GetCategorySpecifics
ValueRecommendation.ValidationRules
Conditionally
This field is returned for each item specific that is returned in the response. The enumeration value returned will indicate whether the item specific is required, recommended, or optional.
<br><br>
<span class="tablenote"><b>Note:</b> Previously, returned item specifics were only 'marked' as required or optional. With the introduction of this new field, eBay is able to specify to sellers which item specifics are highly recommended, although not required. The item specifics that are recommended can possibly improve search results and/or sales conversion if the seller includes them in the listing.
</span>
GetCategorySpecifics
NameRecommendation.ValidationRules
Required, Recommended, Optional
Conditionally
Indicates eBay's confidence that this is the right name or value,
given the data you specified your request. The confidence is based
on historical items in the same category, with similar titles
(if specified).<br>
<br>
This field is only returned when <b>IncludeConfidence</b> is included in the request and set to <code>true</code>.
This field is not returned when <b>SelectionMode</b> is set to <code>Prefilled</code>.
0
100
GetCategorySpecifics
Conditionally
Indicates the Item Specific's logical dependency on another
Item Specific, if any.
<br>
<br>
For example, in a clothing category, Size Type could be
recommended as a parent of Size, because Size=XL would
mean something different to buyers when
Size Type=Juniors or Size Type=Regular. <br>
<br>
Or in the US (in the future), a list of cities can vary depending
on the state, so State could be recommended as a parent of City.<br>
<br>
Currently, categories only recommend a maximum of one parent
for an Item Specific.
For example, Size=XL could have a Size Type=Juniors
parent in a Juniors clothing category.
In the future, some categories may recommend multiple parents.
For example, City=Mountain View could have parents like
State=California, State=New York, and State=North Carolina.<br>
<br>
If an Item Specific has value dependencies (i.e., if it has value recommendations that contain <b>Relationship</b>), then
all of its value recommendations are returned (regardless of the
number you specified in <b>MaxValuesPerName</b>).
GetCategorySpecifics
Conditionally
Indicates whether the name (e.g., Color) can (or must) be used to
classify the variation pictures.
GetCategorySpecifics
NameRecommendation.ValidationRules
Conditionally
Indicates whether the recommended name/value pair can be used in
an <b>Item.Variations</b> container in a fixed-price listing call.
For example, a given category could disable a name like Brand
in variation specifics (if Brand is only allowed in the item specifics at the Item level). The same category could
enable a name like Size for variation specifics
(in addition to recommending it for item specifics).
If not returned, then the name/value can be used for
both variation specifics and item specifics.
GetCategorySpecifics
NameRecommendation.ValidationRules
Conditionally
The format of the data type (e.g., date format) that eBay
expects the item specific's value to adhere to in listing requests.
A data type identified by the <b>ValueType</b> field may have different
representations, and <b>ValueFormat</b> specifies the precise format
that is required.
GetCategorySpecifics
NameRecommendation.ValidationRules
Conditionally
This type is used to provide details about recommended Item Specifics and Product Identifier types.
The unique identifier of the leaf category for which the recommended Item Specifics and Product Identifier types apply to.
This is always a category ID that you specified in the request.<br>
<br>
This field is always returned with each <b>Recommendations</b> container.
10
GetCategorySpecifics
Conditionally
<span class="tablenote"><strong>Note:</strong>
This container was originally introduced into the Trading schema with the intention of separating Global Trade Item Numbers (GTINs) and other descriptive item specifics, but this container was never wired on/returned in <b>GetCategorySpecifics</b>. Instead, users will still find one or more relevant GTIN types under a <b>Recommendations.NameRecommendation.Name</b> field.
</span>
This container consists of Item Specific name/value pairs that are mandatory, recommended, or optional for the specified category. The value returned in the corresponding <b>UsageConstraint</b> field, just introduced in Version 1111, will indicate if the Item Specific is required, recommended, or optional when listing in that category.
<br/><br/>
If no relevant Item Specific name/value pairs are found for the category, this container will not be returned.
GetCategorySpecifics
Conditionally
This field is only returned if the user includes a timestamp in the <b>LastUpdateTime</b> field in the call request payload. If this field is returned as <code>true</code>, the Item Specific metadata for the specified category has changed since the date/time specified in the <b>LastUpdateTime</b> field. In this case, we suggest you retrieve the latest metadata for the category. If this field is returned as <code>false</code>, the Item Specific metadata for this category has not changed since the date/time specified in the <b>LastUpdateTime</b> field.
GetCategorySpecifics
Conditionally
Type used by the <strong>RecoupmentPolicyConsent</strong> container that is returned in the <strong>GetItem</strong> call response to indicate which sites the user (specified in <strong>UserID</strong> field of call request) has signed a cross-border trade Recoupment Policy Agreement.
A unique identifier for an eBay site. Each site where the user (specified in <strong>UserID</strong> field of call request) has signed a cross-border trade Recoupment Policy Agreement is returned. The enumeration values that represent these eBay sites can be found in <strong>SiteCodeType</strong>.
GetUser
DetailLevel: none, ReturnSummary, ReturnAll
Conditionally
<span class="tablenote"><b>Note: </b> This type was only used for Half.com order refunds, and since the Half.com site has been shut down, this type is no longer applicable.
</span>
Type used by the <strong>RefundArray</strong> container, which consists of an array of Half.com refunds.
<span class="tablenote"><b>Note: </b> <b>RefundArrayType</b> and the <b>Refund</b> field are no longer applicable since the Half.com site has been shut down.
</span>
This container consists of information about a Half.com refund. It is only returned if a Half.com order is going through (or has completed) the refund process.
1027
NoOp
1033
This enumerated type contains the possible refund, exchange, or store credit options that a
seller may offer a buyer when the buyer wants to return the item.
Exchange, MerchandiseCredit
This value indicates that the seller will refund the buyer the cost of the item, excluding shipping and handling costs and any restocking fee (US only).
<br><br>
The seller should use the <b>ReturnPolicy.Description</b> field in the Add API call to explain how the refund will be handled (such as whether the refund will occur via PayPal).
<span class="tablenote"><b>Note:</b>
This value is deprecated on the US site, and all listings attempting to use this
value will be blocked.
</span>
This value indicates that the seller will exchange the returned item for another item.
The seller should use the <b>ReturnPolicy.Description</b> field in the Add API call to explain how this will occur (such as whether the seller will send an identical item in place of the returned item).
<span class="tablenote"><b>Note:</b>
This value is deprecated on the US site, and all listings attempting to use this value are blocked.
</span>
The seller will give the buyer a credit toward the purchase of another item. The seller should use the <b>ReturnPolicy.Description</b> field in the Add API call to explain how the buyer can redeem this credit.
<span class="tablenote"><b>Note:</b>
This value has been deprecated and US sellers that are willing to refund buyers or offer an identical replacement item should use the <code>MoneyBackOrReplacement</code> value instead.
</span>
This value indicates that the seller will refund the buyer the cost of the item, excluding shipping and handling costs and any restocking fee (US only), or the seller will exchange the returned item for another identical item.
<br><br>
The seller should use the <b>ReturnPolicy.Description</b> field in the Add API call to explain how the refund will be handled, such as whether the refund will occur via PayPal, or how the exchange will occur, such as whether the seller will send an identical item in place of the returned item.
<span class="tablenote"><b>Note:</b>
This value is only available on the US site. US sellers should use this value if they are willing to refund buyers or offer an identical replacement item.
</span>
This value indicates that the seller will refund the buyer the cost of the item (excluding shipping and handling costs and any restocking fee) through eBay returns, or the seller will replace the returned item with another identical item.
<br><br>
The seller should use the <b>ReturnPolicy.Description</b> field in the Add API call to explain to buyer that are refunds and replacements will be handled through the eBay returns process.
Reserved for internal or future use.
Type defining the <b>ReturnPolicyDetails.Refund</b> container that is returned in <b>GeteBayDetails</b>. All of the values (along with descriptions for each value) that can be used as a Refund Option when listing an item is returned under the <b>ReturnPolicyDetails.Refund</b> container.
<br><br>
<span class="tablenote"><b>Note:</b> The <b>GeteBayDetails</b> call returns site-default Return Policy settings. For most categories within a given eBay site, the supported Return Policy options/values are the same, but there a few exceptions. To discover what refund options that a particular category supports, call <b>GetCategoryFeatures</b> and include <code>DomesticRefundMethodValues</code> and/or <code>InternationalRefundMethodValues</code> as <b>FeatureID</b> values to see the refund options available for domestic and international returns, respectively.
</span>
Indicates how the seller will compensate the buyer for a returned item. This value can be passed in the Add/Revise/Relist/VerifyAdd API calls.
<br/><br/>
Currently, on the US site (and many other sites), the seller must offer either a <b>MoneyBack</b> or a <b>MoneyBackOrExchange</b> refund option. Consider using the <b>MoneyBackOrExchange</b> option when you have the depth of inventory to support replacement of the original item. Otherwise, use the <b>MoneyBack</b> option if you have limited inventory.
RefundOptionsCodeType
GeteBayDetails
Conditionally
Display string that applications can use to present <b>RefundOption</b> in
a more user-friendly format (such as in a drop-down list).
Not applicable as input to the AddItem family of calls. (Use <b>RefundOption</b> instead.)
GeteBayDetails
Conditionally
This enumerated type is deprecated.
This value is not used.
This value is not used.
This value is not used.
This type is deprecated.
This field is deprecated.
This type 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.
Type defining the <strong>Refunds</strong> container, which contains an array of <strong>Refund</strong> containers. A <strong>Refund</strong> container consists of detailed information on an In-Store Pickup item refund.
<br/><br/>
<span class="tablenote">
<strong>Note:</strong> At this time, the In-Store Pickup feature is generally only available to large retail merchants on the US site, and can only be applied to multi-quantity, fixed-price listings.
</span>
This container consists of detailed information on an In-Store Pickup item refund. This container is only returned if the merchant is refunding (or providing a store credit) the buyer for an In-Store Pickup item. A separate <strong>Refund</strong> container will be returned for each <strong>ORDER.RETURNED</strong> notification that the merchant sends to eBay through the <strong>Inbound Notifications API</strong>.
<br/><br/>
<span class="tablenote">
<strong>Note:</strong> A seller must be eligible for the In-Store Pickup feature to list an item that is eligible for In-Store Pickup. At this time, the In-Store Pickup feature is generally only available to large retail merchants on the US site, and can only be applied to multi-quantity, fixed-price listings. Eligible Merchants/developers can test In-Store Pickup functionality in the Sandbox environment, including listing items enabled with the In-Store Pickup feature, creating store locations and adding inventory to these stores using the Inventory Management API, and informing eBay of In-Store Pickup status changes using the Inbound Notifications API.
</span>
GetOrders
DetailLevel: none, ReturnAll
Conditionally
OrderReport
Conditionally
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ReturnAll
Conditionally
This type is deprecated.
This field is deprecated.
This type is deprecated.
This field is deprecated.
This enumerated type is deprecated.
This value is not used.
This value is not used.
This value is not used.
This value is not used.
<span class="tablenote"><b>Note: </b> This type was only used for Half.com order refunds, and since the Half.com site has been shut down, this type is no longer applicable.
</span>
<span class="tablenote"><b>Note: </b> <b>RefundReasonCodeType</b> and all of its values are no longer applicable since the Half.com site has been shut down.
</span>
Seller is unable to ship the product to the buyer.
<span class="tablenote"><b>Note: </b> <b>RefundReasonCodeType</b> and all of its values are no longer applicable since the Half.com site has been shut down.
</span>
Seller shipped the wrong item to the buyer.
<span class="tablenote"><b>Note: </b> <b>RefundReasonCodeType</b> and all of its values are no longer applicable since the Half.com site has been shut down.
</span>
The buyer returned the item due to its quality.
<span class="tablenote"><b>Note: </b> <b>RefundReasonCodeType</b> and all of its values are no longer applicable since the Half.com site has been shut down.
</span>
The buyer returned the item due to damage.
<span class="tablenote"><b>Note: </b> <b>RefundReasonCodeType</b> and all of its values are no longer applicable since the Half.com site has been shut down.
</span>
The buyer decided they did not want the item.
<span class="tablenote"><b>Note: </b> <b>RefundReasonCodeType</b> and all of its values are no longer applicable since the Half.com site has been shut down.
</span>
The seller has another reason for issuing a Half.com refund.
<span class="tablenote"><b>Note: </b> <b>RefundReasonCodeType</b> and all of its values are no longer applicable since the Half.com site has been shut down.
</span>
(out) Reserved for internal or future use.
This enumerated type is deprecated.
This value is not used.
This value is not used.
This value is not used.
This value is not used.
This type is deprecated.
This field is deprecated.
Type defining the <strong>Refund</strong> container, which consists of detailed information on an In-Store Pickup item refund.
<br/><br/>
<span class="tablenote">
<strong>Note:</strong> At this time, the In-Store Pickup feature is generally only available to large retail merchants in US, and can only be applied to multi-quantity, fixed-price listings.
</span>
This value indicates the success or failure of the attempt by the merchant to refund or provide store credit to the buyer for a returned In-Store Pickup item. This field is always returned with the <strong>Refund</strong> container.
<br/><br/>
<span class="tablenote">
<strong>Note:</strong> A seller must be eligible for the In-Store Pickup feature to list an item that is eligible for In-Store Pickup. At this time, the In-Store Pickup feature is generally only available to large retail merchants in US, and can only be applied to multi-quantity, fixed-price listings. Merchants/developers can test In-Store Pickup functionality in the Sandbox environment, including listing items enabled with the In-Store Pickup feature, creating store locations and adding inventory to these stores using the Inventory Management API, and informing eBay of In-Store Pickup status changes using the Inbound Notifications API.
</span>
Pending
GetOrders
DetailLevel: none, ReturnAll
Conditionally
OrderReport
Conditionally
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ReturnAll
Conditionally
This value indicates whether the merchant refunded or provided a store credit to the buyer for the returned In-Store Pickup item. Applicable values are 'REFUND' and 'STORE_CREDIT'. This value is picked up by eBay when the merchant passes in the <strong>REFUND_TYPE</strong> parameter through the payload of an <strong>ORDER.RETURNED</strong> notification sent to eBay.
<br/><br/>
<span class="tablenote">
<strong>Note:</strong> A seller must be eligible for the In-Store Pickup feature to list an item that is eligible for In-Store Pickup. At this time, the In-Store Pickup feature is generally only available to large retail merchants in US, and can only be applied to multi-quantity, fixed-price listings. Merchants/developers can test In-Store Pickup functionality in the Sandbox environment, including listing items enabled with the In-Store Pickup feature, creating store locations and adding inventory to these stores using the Inventory Management API, and informing eBay of In-Store Pickup status changes using the Inbound Notifications API.
</span>
GetOrders
DetailLevel: none, ReturnAll
Conditionally
OrderReport
Conditionally
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ReturnAll
Conditionally
This field is the eBay user ID of the buyer who is receiving the refund or store credit from the merchant. This field is always returned with the <strong>Refund</strong> container.
<br/><br/>
<b>For GetOrders, GetOrderTransactions, and GetItemTransactions only:</b> If using Trading WSDL Version 1019 or above, this field will only be returned to the buyer or seller, and no longer returned at all to third parties. If using a Trading WSDL older than Version 1019, the correct refund recipient is returned to the buyer or seller, but the refund recipient will be masked to all third parties.
<br/><br/>
<span class="tablenote">
<strong>Note:</strong> A seller must be eligible for the In-Store Pickup feature to list an item that is eligible for In-Store Pickup. At this time, the In-Store Pickup feature is generally only available to large retail merchants in US, and can only be applied to multi-quantity, fixed-price listings. Merchants/developers can test In-Store Pickup functionality in the Sandbox environment, including listing items enabled with the In-Store Pickup feature, creating store locations and adding inventory to these stores using the Inventory Management API, and informing eBay of In-Store Pickup status changes using the Inbound Notifications API.
</span>
GetOrders
DetailLevel: none, ReturnAll
Conditionally
OrderReport
Conditionally
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ReturnAll
Conditionally
This date/time value is the timestamp for the refund transaction. This field is not returned if the refund was not successful (RefundStatus=FAILED).
<br/><br/>
<span class="tablenote">
<strong>Note:</strong> A seller must be eligible for the In-Store Pickup feature to list an item that is eligible for In-Store Pickup. At this time, the In-Store Pickup feature is generally only available to large retail merchants in US, and can only be applied to multi-quantity, fixed-price listings. Merchants/developers can test In-Store Pickup functionality in the Sandbox environment, including listing items enabled with the In-Store Pickup feature, creating store locations and adding inventory to these stores using the Inventory Management API, and informing eBay of In-Store Pickup status changes using the Inbound Notifications API.
</span>
GetOrders
DetailLevel: none, ReturnAll
Conditionally
OrderReport
Conditionally
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ReturnAll
Conditionally
This dollar value is the amount of the refund to the buyer for this specific refund transaction. This field is not returned if the merchant issued the buyer a store credit instead of a refund (RefundType=STORE_CREDIT).
<br/><br/>
<span class="tablenote">
<strong>Note:</strong> A seller must be eligible for the In-Store Pickup feature to list an item that is eligible for In-Store Pickup. At this time, the In-Store Pickup feature is generally only available to large retail merchants in US, and can only be applied to multi-quantity, fixed-price listings. Merchants/developers can test In-Store Pickup functionality in the Sandbox environment, including listing items enabled with the In-Store Pickup feature, creating store locations and adding inventory to these stores using the Inventory Management API, and informing eBay of In-Store Pickup status changes using the Inbound Notifications API.
</span>
GetOrders
DetailLevel: none, ReturnAll
Conditionally
OrderReport
Conditionally
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ReturnAll
Conditionally
This value is a merchant-defined identifier used to track In-Store Pickup refunds. This value is picked up by eBay when the merchant passes in the <strong>REFUND_ID</strong> parameter through the payload of an <strong>ORDER.RETURNED</strong> notification sent to eBay. This field is not returned if the merchant does not set this value through <strong>ORDER.RETURNED</strong> notification.
<br/><br/>
<b>For GetOrders, GetOrderTransactions, and GetItemTransactions only:</b> If using Trading WSDL Version 1019 or above, this field will only be returned to the buyer or seller, and no longer returned at all to third parties. If using a Trading WSDL older than Version 1019, the correct payment identifier is returned to the buyer or seller, but the payment identifier will be masked to all third parties.
<br/><br/>
<span class="tablenote">
<strong>Note:</strong> A seller must be eligible for the In-Store Pickup feature to list an item that is eligible for In-Store Pickup. At this time, the In-Store Pickup feature is generally only available to large retail merchants in US, and can only be applied to multi-quantity, fixed-price listings. Merchants/developers can test In-Store Pickup functionality in the Sandbox environment, including listing items enabled with the In-Store Pickup feature, creating store locations and adding inventory to these stores using the Inventory Management API, and informing eBay of In-Store Pickup status changes using the Inbound Notifications API.
</span>
GetOrders
DetailLevel: none, ReturnAll
Conditionally
OrderReport
Conditionally
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ReturnAll
Conditionally
This dollar value is the total amount of the refund to the buyer for the In-Store Pickup order. Typically, this dollar value will be the same as the <strong>RefundAmount</strong> value, unless the merchant is issuing multiple refund transactions to the buyer, in which case, the <strong>FeeOrCreditAmount</strong> value will be the cumulative amount for multiple refund transactions. This field is not returned if the merchant issued the buyer a store credit instead of a refund (RefundType=STORE_CREDIT).
<br/><br/>
<span class="tablenote">
<strong>Note:</strong> A seller must be eligible for the In-Store Pickup feature to list an item that is eligible for In-Store Pickup. At this time, the In-Store Pickup feature is generally only available to large retail merchants in US, and can only be applied to multi-quantity, fixed-price listings. Merchants/developers can test In-Store Pickup functionality in the Sandbox environment, including listing items enabled with the In-Store Pickup feature, creating store locations and adding inventory to these stores using the Inventory Management API, and informing eBay of In-Store Pickup status changes using the Inbound Notifications API.
</span>
GetOrders
DetailLevel: none, ReturnAll
Conditionally
OrderReport
Conditionally
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ReturnAll
Conditionally
This type is deprecated.
This field is deprecated.
This field is deprecated.
This field is deprecated.
This field is deprecated.
<span class="tablenote"><b>Note: </b> This type is only used for Half.com order refunds, and since the Half.com site has been shut down, this type will also be deprecated.
</span>
Contains information about a single Half.com refund.
<span class="tablenote"><b>Note: </b> <b>RefundType</b> and all of its fields are no longer applicable since the Half.com site has been shut down.
</span>
Total amount refunded by the seller for this order line item.
1027
NoOp
1033
<span class="tablenote"><b>Note: </b> <b>RefundType</b> and all of its fields are no longer applicable since the Half.com site has been shut down.
</span>
Total amount refunded to the buyer for this order line item.
1027
NoOp
1033
<span class="tablenote"><b>Note: </b> <b>RefundType</b> and all of its fields are no longer applicable since the Half.com site has been shut down.
</span>
The date and time at which the refund was issued.
1027
NoOp
1033
<span class="tablenote"><b>Note: </b> <b>RefundType</b> and all of its fields are no longer applicable since the Half.com site has been shut down.
</span>
The unique identifier of the refund.
<br/><br/>
<b>For GetOrders, GetOrderTransactions, and GetItemTransactions only:</b> If using Trading WSDL Version 1019 or above, this field will only be returned to the buyer or seller, and no longer returned at all to third parties. If using a Trading WSDL older than Version 1019, the real refund identifier is only returned to the buyer or seller, and a string value of <code>Unavailable</code> will be returned to all third parties.
1027
NoOp
1033
<span class="tablenote"><b>Note: </b> <b>RefundType</b> and all of its fields are no longer applicable since the Half.com site has been shut down.
</span>
<span class="tablenote"><b>Note: </b> <b>RefundType</b> and all of its fields are no longer applicable since the Half.com site has been shut down.
</span>
The total amount of the refund requested.
1027
NoOp
1033
<span class="tablenote"><b>Note: </b> <b>RefundType</b> and all of its fields are no longer applicable since the Half.com site has been shut down.
</span>
<span class="tablenote"><b>Note: </b> <b>RefundType</b> and all of its fields are no longer applicable since the Half.com site has been shut down.
</span>
<span class="tablenote"><b>Note: </b> <b>RefundType</b> and all of its fields are no longer applicable since the Half.com site has been shut down.
</span>
<span class="tablenote"><b>Note: </b> <b>RefundType</b> and all of its fields are no longer applicable since the Half.com site has been shut down.
</span>
<span class="tablenote"><b>Note: </b> <b>RefundType</b> and all of its fields are no longer applicable since the Half.com site has been shut down.
</span>
<span class="tablenote"><b>Note: </b> <b>RefundType</b> and all of its fields are no longer applicable since the Half.com site has been shut down.
</span>
<span class="tablenote"><b>Note: </b> <b>RefundType</b> and all of its fields are no longer applicable since the Half.com site has been shut down.
</span>
<span class="tablenote"><b>Note: </b> <b>RefundType</b> and all of its fields are no longer applicable since the Half.com site has been shut down.
</span>
<span class="tablenote"><b>Note: </b> This type is only used for Half.com order refunds, and since the Half.com site has been shut down, this type will also be deprecated.
</span>
Explanation of the reason that the refund is being issued. Applicable to Half.com
refunds only.
<span class="tablenote"><b>Note: </b> <b>RefundTypeCodeType</b> and all of its values are no longer applicable since the Half.com site has been shut down.
</span>
The seller has issued a refund for the transaction price that
was originally paid to the seller.
(The seller's shipping reimbursement is not included
if Half.com calculates the refund amount).
<span class="tablenote"><b>Note: </b> <b>RefundTypeCodeType</b> and all of its values are no longer applicable since the Half.com site has been shut down.
</span>
The seller has issued a refund for the transaction price and
shipping reimbursement that was originally paid to the seller.
(The buyer's return shipping costs
might not be included if Half.com calculates the refund amount.)
<span class="tablenote"><b>Note: </b> <b>RefundTypeCodeType</b> and all of its values are no longer applicable since the Half.com site has been shut down.
</span>
The seller has issued a refund amount that is different from
the full refund (with or without shipping). If specified,
it may be helpful to explain the amount in your note to the buyer.
<span class="tablenote"><b>Note: </b> <b>RefundTypeCodeType</b> and all of its values are no longer applicable since the Half.com site has been shut down.
</span>
(out) Reserved for internal or future use.
Enumerated type defining the refund types that a merchant can offer a buyer who is returning an In-Store Pickup item to the store.
This value indicates that the merchant issued a store credit to the buyer for the amount of the returned item(s).
This value indicates that the merchant issued a cash refund (or debit card/credit card reversal) to the buyer for the amount of the returned item(s).
This value is reserved for internal or future use.
This enumerated type is deprecated.
This value is not used.
This value is not used.
This value is not used.
(out) Reserved for internal or future use.
This type is no longer used; replaced by <b>ShippingLocationDetails</b>.
This field is deprecated.
This field is deprecated.
This field is deprecated.
This field is deprecated.
This type is no longer used; replaced by <b>ShippingLocationDetails</b>.
String identifier for a continent, a geographic region, or a country.
Full name of the continent, geographic region, or country; useful for display
purposes.
Indicates the status of the Region of Origin value. Only Region of Origin values
in the 'Active' state can be used.
Returns the latest version number for this field. The version can be
used to determine if and when to refresh cached client data.
Gives the time in GMT that the feature flags for the details were last
updated. This timestamp can be used to determine if and when to refresh
cached client data.
Indicates category support for listing of Local Market items by sellers
subscribed to Local Market for Regular Vehicles.
Each of the subscriptions will have following options, which will define
"National" vs "Local" ad format listing.
"LocalOptional" : This will allow national and local listing.
"LocalOnly" : Seller can have Local listings only.
"NationalOnly" : Seller can not opt into local only exposure. It has to be
national listing.
Specifies how to return certain reminder types from the user's My eBay account.
The length of time the reminder has existed in the user's My eBay account,
in days. Valid values are 1-60.
GetMyeBayReminders
No
Whether to include information about this type of reminder in the response.
When true, the container is returned with default input parameters.
GetMyeBayReminders
No
This type contains the counts of various eBay Buying and Seller Reminders that are returned in the <b>GetMyeBayReminders</b> call.
The number of reminders requesting that the buyer send payment.
GetMyeBayReminders
Conditionally
BuyingReminders
The number of reminders that feedback has not yet been received by the buyer or seller.
GetMyeBayReminders
Conditionally
The number of reminders that feedback has not yet been sent by the buyer or seller.
GetMyeBayReminders
Conditionally
The number of reminders advising the buyer that the buyer has been
outbid.
GetMyeBayReminders
Conditionally
BuyingReminders
The number of reminders that the seller has not yet received a payment.
GetMyeBayReminders
Conditionally
SellingReminders
The number of reminders requesting that the seller review second
chance offers.
GetMyeBayReminders
Conditionally
SellingReminders
The number of reminders advising the seller that shipping is
needed.
GetMyeBayReminders
Conditionally
SellingReminders
The number of reminders advising the seller that relisting is needed.
GetMyeBayReminders
Conditionally
SellingReminders
The number of new leads the seller has recieved.
GetMyeBayReminders
Conditionally
SellingReminders
The number of reminders advising the buyer to send documents for credit card processing.
GetMyeBayReminders
Conditionally
SellingReminders
The number of reminders requesting the buyer to process request time extension submitted by the seller.
GetMyeBayReminders
Conditionally
SellingReminders
The number of reminders requesting the Buyer to confirm item receipt to seller.
GetMyeBayReminders
Conditionally
SellingReminders
The number of reminders to the buyer on refund on hold.
GetMyeBayReminders
Conditionally
SellingReminders
The number of reminders to the buyer on refund cancelled.
GetMyeBayReminders
Conditionally
SellingReminders
The number of reminders requesting the seller to provide shipping details
GetMyeBayReminders
Conditionally
SellingReminders
The number of reminders to the seller on item receipt confirmation pending from buyer
GetMyeBayReminders
Conditionally
SellingReminders
The number of reminders to the seller on refunds initiated
GetMyeBayReminders
Conditionally
SellingReminders
The number of reminders to the seller on pending shipping time extension requests with the buyer
GetMyeBayReminders
Conditionally
SellingReminders
The number of reminders to the seller on declined shipping time extension requests by the buyer
GetMyeBayReminders
Conditionally
SellingReminders
This type defines the <b>RequiredSellerActionArray</b> container,
which may contain one or more <b>RequiredSellerAction</b> fields.
This field contains a possible action that a seller can take to expedite the
release of a payment hold. There can be one or more <b>RequiredSellerAction</b>
fields in the <b>RequiredSellerActionArray</b> container.
GetOrders
DetailLevel: none
Conditionally
OrderReport
Conditionally
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetMyeBaySelling
DetailLevel: none, ReturnSummary, ReturnAll
Conditionally
Enumerated type that defines the list of possible actions that a seller can
take to expedite the release of funds for an order into their account.
SetupPayoutMethod, UpdatePayoutMethod, None
This value indicates that there is an open eBay Money Back Guarantee case
involving the seller and the item. The seller must address and get
the case resolved before the funds can be scheduled for release to the
seller's account. See the
<a href="http://developer.ebay.com/Devzone/guides/features-guide/default.html#development/Post-Order.html">Resolving Order Issues</a>
page for information about retrieving and managing eBay Money Back Guarantee cases.
This value indicates that the seller must mark the order line item as shipped to expedite
the release of funds into their account. The seller can use the <b>CompleteSale</b>
call to mark an item as shipped. If an order line item is marked as shipped, it is possible
that the seller's funds for the order will be released as soon as seven days after the latest
estimated delivery date.
This value indicates that the seller should contact eBay Customer Support to discover
the next required action to expedite the release of funds into their account.
This value indicates that the seller must resolve the PayPal Buyer Protection case filed
against the order line item to expedite the release of funds into their account.
This value is no longer used.
This value is no longer used.
This value is no longer used.
This value indicates that the seller must provide the buyer the tracking information for
the order line item to expedite the release of funds into their account. The seller can
use the <b>CompleteSale</b> call to provide tracking information for an
order line item. If the tracking information for an order line item is provided, it is
possible that the seller's funds for the order will be released as soon as three days
after eBay has confirmed that the item has been delivered.
This value indicates that the buyer has not received the item, and the buyer has contacted
the seller through the eBay system in an effort to resolve the issue with the seller. The
seller must make it right with the buyer in order to expedite the release of funds into
their account.
This value indicates that the buyer has received the item, but the item is not as
described in the listing; hence, the buyer has contacted the seller through the eBay
system in an effort to resolve the issue with the seller. The seller must make it right
with the buyer in order to expedite the release of funds into their account.
This value is reserved for internal or future use.
This value indicates that the buyer is returning the item through eBay's managed return
process. Upon receiving the returned item from the buyer, the seller must issue a refund
to the buyer within five business days, and shortly after this happens, eBay will credit
the seller's account with the Final Value Fee that was originally assessed on the sale
of the item.
This type is deprecated.
773
Avoid
FindProducts (Shopping API)
889
This field is deprecated.
This field is deprecated.
This field is deprecated.
This field is deprecated.
This field is deprecated.
This field is deprecated.
This field is deprecated.
This type is deprecated, as sellers are no longer allowed to set a restocking fee through a listings's return policy.
This value indicates that the seller will not charge a restocking fee to the
buyer if the item is returned.
This value indicates that the seller charges the buyer a restocking fee of 10
percent of the item's purchase price if the item is returned.
This value indicates that the seller charges the buyer a restocking fee of 15
percent of the item's purchase price if the item is returned.
This value indicates that the seller charges the buyer a restocking fee of up to 20
percent of the item's purchase price if the item is returned.
This is no longer a valid value.
(out) Reserved for internal or future use.
This type is deprecated, as sellers are no longer allowed to set a restocking fee through a listings's return policy.
1061
NoOp
1061
1061
NoOp
1061
In some EU countries, sellers are legally required to describe the return policy they offer. The value returned by this field indicates if sellers can provide such description within the given marketplace and category. <br><br>The values returned in this field are pertinent only if <b>ReturnPolicyEnabled</b> in GetCategoryFeatures is set to <code>true</code> for the associated category, which indicates that items listed in the category must include a return policy. The values returned in this field are valid in AddItem and its related family of calls, and in the return policies you configure for use with the Account API.
Type defining the <b>ReturnPolicyDetails</b> container, which is returned in <b>GeteBayDetails</b>, and provides the seller with the Return Policy features (and applicable values) that are supported by the listing site. This container is only returned if <b>ReturnPolicyDetails</b> is included as a <b>DetailName</b>
filter in the call request, or if no <b>DetailName</b> filters are used in the request.
<br/><br/>
<span class="tablenote"><b>Note: </b>
The <b>GeteBayDetails</b> call returns site-default Return Policy settings. For most categories within a given eBay site, the supported Return Policy options/values are the same, but there a few exceptions. To discover what Return Policy features/settings that a particular category supports, call <b>GetCategoryFeatures</b> and include any or all of the domestic and or international Return Policy-related <b>FeatureID</b> values to see the Return Policy features/settings available for domestic and international returns, respectively.
</span>
This container consists of the supported refund/exchange/replacement item options that the seller may make available to the buyer in case the buyer wants to return the original item. Enumeration value(s) returned in <b>RefundOption</b> field(s) can be used in the <b>ReturnPolicy.RefundOption</b> field in an Add/Revise/Relist API call.
<br/><br/>
<span class="tablenote"><b>Note: </b>
To discover what refund options that a particular category supports, call <b>GetCategoryFeatures</b> and include <code>DomesticRefundMethodValues</code> and/or <code>InternationalRefundMethodValues</code> as <b>FeatureID</b> values to see the refund options available for domestic and international returns, respectively.
</span>
GeteBayDetails
Conditionally
This container consists of the supported time periods within which the buyer can return the item, starting from the day they receive the item. Enumeration value(s) returned in <b>ReturnsWithinOption</b> field(s) can be used in the <b>ReturnPolicy.ReturnsWithinOption</b> field in an Add/Revise/Relist API call.
<br/><br/>
<span class="tablenote"><b>Note: </b>
To discover what return durations that a particular category supports, call <b>GetCategoryFeatures</b> and include <code>DomesticReturnsDurationValues</code> and/or <code>InternationalReturnsDurationValues</code> as <b>FeatureID</b> values to see the return durations available for domestic and international returns, respectively.
</span>
GeteBayDetails
Conditionally
This container consists of the enumeration values that can be passed into the <b>ReturnPolicy.ReturnsAcceptedOption</b> field when using an Add/Revise/Relist API call. This value will indicate whether or not the seller allows the buyer to return the item.
<br/><br/>
<span class="tablenote"><b>Note: </b>
To discover the enumeration values that a particular category supports, call <b>GetCategoryFeatures</b> and include <code>DomesticReturnsAcceptedValues</code> and/or <code>InternationalReturnsAcceptedValues</code> as <b>FeatureID</b> values to see the <b>ReturnPolicy.ReturnsAcceptedOption</b> and <b>ReturnPolicy.InternationalReturnsAcceptedOption</b> values supported for domestic and international returns, respectively.
</span>
GeteBayDetails
Conditionally
This field is returned with a value of <code>true</code> if the site supports a text description of the seller's Return Policy in listings. If the site does support a text description of the seller's Return Policy, it is set through the <b>ReturnPolicy.Description</b> field in an Add/Revise/Relist API call. Currently, the only eBay sites that support Return Policy descriptions are Germany, Austria, France, Italy, and Spain.
<br/><br/>
<span class="tablenote"><b>Note: </b>
To discover if a Return Policy desciption is supported by a particular category, call <b>GetCategoryFeatures</b> and include <code>ReturnPolicyDescriptionEnabled</code> as a <b>FeatureID</b> value to see if the category supports the use of a Return Policy description.
</span>
GeteBayDetails
Conditionally
This field is no longer applicable, as sellers are no longer allowed to offer any type of warranty through a listings's return policy.
1061
NoOp
1061
This field is no longer applicable, as sellers are no longer allowed to offer any type of warranty through a listings's return policy.
1061
NoOp
1061
This field is no longer applicable, as sellers are no longer allowed to offer any type of warranty through a listings's return policy.
1061
NoOp
1061
This field is no longer applicable, as sellers are no longer allowed to specify a European Article Number (EAN) through a listings's return policy.
997
NoOp
997
ProductListingDetails.EAN
This container consists of the enumeration values that can be passed into the <b>ReturnPolicy.ShippingCostPaidByOption</b> or <b>ReturnPolicy.InternationalShippingCostPaidByOption</b> field when using an Add/Revise/Relist API call. This value will indicate whether the buyer or seller is responsible for return shipping cost. The enumeration value(s) returned in <b>ShippingCostPaidByOption</b> field(s) can be used in the <b>ReturnPolicy.ShippingCostPaidByOption</b> field in an
GeteBayDetails
Conditionally
This type is deprecated, as sellers are no longer allowed to set a restocking fee through a listings's return policy.
1061
NoOp
1061
Returns the latest version number for the Return Policy Details metadata set. The version can be used to determine if and when to refresh cached client data.
GeteBayDetails
DetailLevel: none, ReturnSummary, ReturnAll
Always
This timestamp in GMT indicate when the Return Policy Details metadata were last updated. This timestamp can be used to determine if and when to refresh cached client data.
GeteBayDetails
DetailLevel: none, ReturnSummary, ReturnAll
Always
Defines the feature that specifies whether a return policy
could be enabled on the site.
Type used to express the details of the return policy for an item.
<br><br>
To get the metadata on the values you can use for specific marketplaces, call <b>GeteBayDetails</b> with <b>DetailName</b> set to <code>ReturnPolicyDetails</code>, and then review the <b>ReturnPolicyDetails</b> fields in the response.
<br><br>
<span class="tablenote"><b>Note:</b> Historically, the <b>GeteBayDetails</b> call has been used to retrieve return policy metadata. However, the <b>GetCategoryFeatures</b> call now returns category-level metadata for both domestic and international return policies, and developers should make plans to use that call for this metadata.</span>
This field indicates how the seller compensates buyers for <a href="http://developer.ebay.com/DevZone/guides/features-guide/default.html#development/Post-Order-Returns.html#return-reasons" target="_blank">returns</a>. You must set this value to <code>MoneyBack</code> for all eBay marketplaces except for the US marketplace.
<br><br>
On <code>EBAY_US</code>: You can set this value to either <code>MoneyBack</code> or <code>MoneyBackOrReplacement</code>. If a seller has the depth of inventory to support an exchange for an identical item, you can set <code>MoneyBackOrReplacement</code>. Otherwise, set this value to <code>MoneyBack</code>.
<br><br>
<b>For ReviseItem only:</b> You cannot change the value of this field if the listing has bids or sales, or if the listing ends within 12 hours. For more details, see the <b>ReturnPolicy</b> description.
RefundOptionsCodeType
AddFixedPriceItem
AddItem
AddItems
AddSellingManagerTemplate
ReviseFixedPriceItem
ReviseItem
ReviseSellingManagerTemplate
RelistFixedPriceItem
RelistItem
VerifyAddFixedPriceItem
VerifyAddItem
VerifyRelistItem
No
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally
GetBidderList
GranularityLevel: Medium, Fine
Conditionally
GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
GranularityLevel: Coarse, Medium, Fine
Conditionally
(GeteBayDetails) RefundOption
GeteBayDetails.html#Response.ReturnPolicyDetails.Refund.RefundOption
Display string that buyer applications can use to present <b>RefundOption</b> in a more user-friendly format to buyers. For example, in <b>GetItem</b> and related calls, this value is usually localized and can contain spaces. If necessary, you can predict the choice of values based on the <b>Refund.Description</b> options returned by <b>GeteBayDetails</b>.
<br><br>
This field is applicable to only the US marketplace and is not applicable as input to the <b>Add</b>/<b>Revise</b>/<b>Relist</b> family of calls. (Use <b>RefundOption</b> instead.)
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally
GetBidderList
GranularityLevel: Medium, Fine
Conditionally
GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
GranularityLevel: Coarse, Medium, Fine
Conditionally
Specifies the amount of time the buyer has to return an item. The return period begins when the item is marked "delivered" at the buyer's specified ship-to location. Most marketplaces and categories support 30-day and 60-day return periods. eBay sites often set 30-days as the default value for this field and sellers are obligated to honor the values that are set for a listing. This value is required if <b>ReturnsAcceptedOption=ReturnsAccepted</b>.
<br><br>
<b>Applicable values:</b> Retrieve the values supported by a marketplace by calling <b>GeteBayDetails</b> with <b>DetailName</b> set to <code>ReturnPolicyDetails</code>, then review <b>ReturnPolicyDetails.ReturnsWithin.ReturnsWithinOption</b> in the response.
<br/><br/>
<b>For ReviseItem only:</b> You cannot change the value of this field if the listing has bids or sales, or if the listing ends within 12 hours. For more details, see the <b>ReturnPolicy</b> description.
<br/><br/>
<span class="tablenote"><b>Note:</b> In version 1061, the options for this field were reduced. An error will be thrown if you attempt to list an item with this field set to a value that is not accepted by the target marketplace. See the <a href="/devzone/xml/docs/releasenotes.html#1061">Release Notes</a> for details.</span>
<br>
ReturnsWithinOptionsCodeType
AddFixedPriceItem
AddItem
AddItems
AddSellingManagerTemplate
ReviseFixedPriceItem
ReviseItem
ReviseSellingManagerTemplate
RelistFixedPriceItem
RelistItem
VerifyAddFixedPriceItem
VerifyAddItem
VerifyRelistItem
Conditionally
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally
GetBidderList
GranularityLevel: Medium, Fine
Conditionally
GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
GranularityLevel: Coarse, Medium, Fine
Conditionally
(GeteBayDetails) ReturnsWithinOption
GeteBayDetails.html#Response.ReturnPolicyDetails.ReturnsWithin.ReturnsWithinOption
Display string that buyer applications can use to present <b>ReturnsWithinOption</b> in a more user-friendly format to buyers. For example, in <b>GetItem</b> and related calls, this value is usually localized and can contain spaces.
<br/><br/>
If necessary, you can predict the choice of values based on the <b>ReturnsWithin.Description</b> options returned by <b>GeteBayDetails</b>.
<br><br>
Not applicable as input to the <b>AddItem</b> family of calls. (Use <b>ReturnsWithinOption</b> instead.)
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally
GetBidderList
GranularityLevel: Medium, Fine
Conditionally
GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
GranularityLevel: Coarse, Medium, Fine
Conditionally
This required field indicates whether or not the seller accepts returns.
<br><br>
Applicable values are <code>ReturnsAccepted</code> or <code>ReturnsNotAccepted</code>. When set to <code>ReturnsAccepted</code>, this option indicates the seller allows items to be returned. Specify <b>ReturnsNotAccepted</b> for an item if the seller does not accept returns.
<br><br>
On the eBay DE, IE, and UK, registered business sellers must accept returns for fixed-price items (including auction items with Buy It Now and any other fixed price formats) when the category requires a return policy. On some European sites, such as eBay Germany (DE), registered business sellers are required to accept returns. Use the Trading call <b>GetUser</b> to determine the status of an eBay business seller in DE, IE, and UK. Review the <b>User.SellerInfo.SellerBusinessType</b> field in the response.
<br> <br>
<span class="tablenote"><b>Note:</b> In order for Top-Rated sellers to receive a Top-Rated Plus seal for their listings, returns must be accepted for their items (<b>ReturnsAcceptedOption</b> = <code>ReturnsAccepted</code>) and handling time should be set to zero-day (same-day shipping) or one-day shipping. Set the handling time (in days) using the <b>Item.DispatchTimeMax</b> field.</span>
<br>
Top-Rated listings qualify for the greatest average boost in Best Match and for the 20 percent Final Value Fee discount. For more information on eBay's Top-Rated seller program, see the <a href="http://pages.ebay.com/help/sell/top-rated.html">Becoming a Top Rated Seller and qualifying for Top Rated Plus</a> page.</p>
<br>
<b>For ReviseItem only:</b> You cannot change the value of this field if the listing has bids or sales, or if the listing ends within 12 hours. For more details, see the <b>ReturnPolicy</b> description.
ReturnsAcceptedOptionsCodeType
AddFixedPriceItem
AddItem
AddItems
AddSellingManagerTemplate
AddLiveAuctionItem
VerifyAddFixedPriceItem
VerifyAddItem
Conditionally
ReviseFixedPriceItem
ReviseItem
ReviseSellingManagerTemplate
ReviseLiveAuctionItem
RelistFixedPriceItem
RelistItem
VerifyRelistItem
No
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally
GetBidderList
GranularityLevel: Medium, Fine
Conditionally
GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
GranularityLevel: Coarse, Medium, Fine
Conditionally
(GeteBayDetails) ReturnsAcceptedOption
GeteBayDetails.html#Response.ReturnPolicyDetails.ReturnsAccepted.ReturnsAcceptedOption
Returns and the Law (UK)
http://pages.ebay.co.uk/businesscentre/law-policies/returns.html
Display string that buyer applications can use to present <b>ReturnsAcceptedOption</b> in a more user-friendly format to buyers. For example, in <b>GetItem</b> and related calls, this value is usually localized and can contain spaces.
<br/><br/>
If necessary, you can predict the choice of values based on the <b>ReturnsAccepted.Description</b> options returned by <b>GeteBayDetails</b>.
<br><br>
Not applicable as input to the <b>AddItem</b> family of calls. (Use <b>ReturnsAcceptedOption</b> instead.)
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally
GetBidderList
GranularityLevel: Medium, Fine
Conditionally
GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
GranularityLevel: Coarse, Medium, Fine
Conditionally
This field contains the seller's detailed explanation for their return policy and is displayed in the Return Policy section of the View Item page. This field is valid in only the following marketplaces (the field is otherwise ignored):
<ul>
<li>Germany (DE)</li>
<li>Austria (AT)</li>
<li>France (FR)</li>
<li>Italy (IT)</li>
<li>Spain (ES)</li>
</ul>
Where valid, sellers can use this field to add details about their return policies. eBay uses this text string as-is in the additional details section of the View Item page. Avoid HTML and avoid character entity references (such as &pound; or &#163;). If you include special characters in the return policy description, use the literal UTF-8 or ISO-8559-1 character (e.g. £).
<br><br>
<b>For AddItem, VerifyAddItem, and RelistItem:</b> If the seller accepts returns (<b>ReturnsAcceptedOption</b> = <code>ReturnsAccepted</code>) but does not specify this field when listing the item, <b>GetItem</b> returns this as an empty node.
<br><br>
<b>For ReviseItem only:</b> You cannot change the value of this field if the listing has bids or sales, or if the listing ends within 12 hours. For more details, see the <b>ReturnPolicy</b> description.
<br>
8000 (for DE, AT); 5000 (for FR, IT, ES)
AddFixedPriceItem
AddItem
AddItems
AddSellingManagerTemplate
ReviseFixedPriceItem
ReviseItem
ReviseSellingManagerTemplate
RelistFixedPriceItem
RelistItem
VerifyAddFixedPriceItem
VerifyAddItem
VerifyRelistItem
No
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally
GetBidderList
GranularityLevel: Medium, Fine
Conditionally
GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
GranularityLevel: Coarse, Medium, Fine
Conditionally
(GeteBayDetails) ReturnPolicyDetails.Description
sites that support this field
GeteBayDetails.html#Response.ReturnPolicyDetails.Description
This field is deprecated as of release 1061 and any values supplied in this field are ignored. eBay no longer supports warranty policies for returns.
WarrantyOfferedCodeType
1061
NoOp
1139
This field is deprecated as of release 1061 and any values supplied in this field are ignored. eBay no longer supports warranty policies for returns.
1061
NoOp
1139
This field is deprecated as of release 1061 and any values supplied in this field are ignored. eBay no longer supports warranty policies for returns.
WarrantyTypeOptionsCodeType
1061
NoOp
1139
This field is deprecated as of release 1061 and any values supplied in this field are ignored. eBay no longer supports warranty policies for returns.
1061
NoOp
1139
This field is deprecated as of release 1061 and any values supplied in this field are ignored. eBay no longer supports warranty policies for returns.
WarrantyDurationOptionsCodeType
1061
NoOp
1139
This field is deprecated as of release 1061 and any values supplied in this field are ignored. eBay no longer supports warranty policies for returns.
1061
NoOp
1139
This option specifies either the buyer or the seller as the party who pays for return shipping charges. Accepted values are <code>Buyer</code> or <code>Seller</code>. eBay sites often set <code>Seller</code> as the default value for this field, and sellers are obligated to honor the values that are set for a listing. This value is required if <b>ReturnsAcceptedOption=ReturnsAccepted</b>.
<br><br>
Depending on the seller's return policy and the specifics of a return, either the buyer or the seller can be responsible for the return shipping costs. Note that the seller is always responsible for return shipping costs for SNAD-related issues.
<br><br>
Use <b>GeteBayDetails</b> (with <b>DetailName=ReturnPolicyDetails</b>) and review the returned <b>ReturnPolicyDetails.ShippingCostPaidBy</b> values to see the values supported by a marketplace.
<br><br>
<b>For ReviseItem only:</b> You cannot change the value of this field if the listing has bids or sales, or if the listing ends within 12 hours. For more details, see the <b>ReturnPolicy</b> description.
ShippingCostPaidByOptionsCodeType
AddFixedPriceItem
AddItem
AddItems
AddSellingManagerTemplate
ReviseFixedPriceItem
ReviseItem
ReviseSellingManagerTemplate
RelistFixedPriceItem
RelistItem
VerifyAddFixedPriceItem
VerifyAddItem
VerifyRelistItem
No
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally
GetBidderList
GranularityLevel: Medium, Fine
Conditionally
GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
GranularityLevel: Coarse, Medium, Fine
Conditionally
(GeteBayDetails) ShippingCostPaidByOption
sites that support this field, and applicable values
GeteBayDetails.html#Response.ReturnPolicyDetails.ShippingCostPaidBy.ShippingCostPaidByOption
This is a display string that buyer applications can use to present <b>ShippingCostPaidByOption</b> in a more user-friendly format to buyers. For example, in <b>GetItem</b> and related calls, this value is usually localized and can contain spaces.
<br/><br/>
If necessary, you can predict the choice of values based on the <b>ShippingCostPaidBy.Description</b> options returned by <b>GeteBayDetails</b>.
<br><br>
Not applicable as input to the <b>AddItem</b> family of calls. (Use <b>ShippingCostPaidByOption</b> instead.)
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally
GetBidderList
GranularityLevel: Medium, Fine
Conditionally
GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
GranularityLevel: Coarse, Medium, Fine
Conditionally
This field is deprecated as of release 1061 and any values supplied in this field are ignored. eBay no longer allows sellers to charge a restocking fee when returning items.
1061
NoOp
1139
This field is deprecated as of release 1061 and any values supplied in this field are ignored. eBay no longer allows sellers to charge a restocking fee when returning items.
RestockingFeeCodeType
1061
NoOp
1139
GeteBayDetails.ReturnPolicyDetails
applicable values for RestockingFeeValueOption
GeteBayDetails.html#Response.ReturnPolicyDetails.RestockingFeeValue
This field is deprecated as of release 1061 and any values supplied in this field are ignored. eBay no longer supports extended holiday returns.
1061
NoOp
1139
This field indicates how the seller compensates buyers for <a href="http://developer.ebay.com/DevZone/guides/features-guide/default.html#development/Post-Order-Returns.html#return-reasons" target="_blank">returns</a>. You must set this value to <code>MoneyBack</code> for all eBay marketplaces except for the US marketplace.
<br><br>
On <code>EBAY_US</code>: You can set this value to either <code>MoneyBack</code> or <code>MoneyBackOrReplacement</code>. If a seller has the depth of inventory to support an exchange for an identical item, you can set <code>MoneyBackOrReplacement</code>. Otherwise, set this value to <code>MoneyBack</code>.
<br><br>
<b>For ReviseItem only:</b> You cannot change the value of this field if the listing has bids or sales, or if the listing ends within 12 hours. For more details, see the <b>ReturnPolicy</b> description.
RefundOptionsCodeType
AddFixedPriceItem
AddItem
AddItems
AddSellingManagerTemplate
AddLiveAuctionItem
GetItemRecommendations
ReviseFixedPriceItem
ReviseItem
ReviseSellingManagerTemplate
ReviseLiveAuctionItem
RelistFixedPriceItem
RelistItem
VerifyAddFixedPriceItem
VerifyAddItem
VerifyRelistItem
No
No
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally
GetBidderList
GranularityLevel: Medium, Fine
Conditionally
GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
GranularityLevel: Coarse, Medium, Fine
Conditionally
This optional field indicates whether or not the seller accepts international returns (returns that need to be shipped via an international shipping service).
<br><br>
Applicable values are <code>ReturnsAccepted</code> or <code>ReturnsNotAccepted</code>. When set to <code>ReturnsAccepted</code>, this option indicates the seller allows international returns. If the seller does not accept international returns, they can specify <b>ReturnsNotAccepted</b>.
<br><br>
On the eBay DE, IE, and UK, registered business sellers must accept returns for fixed-price items (including auction items with Buy It Now and any other fixed price formats) when the category requires a return policy. On some European sites, such as eBay Germany (DE), registered business sellers are required to accept returns. Use the Trading call <b>GetUser</b> to determine the status of an eBay business seller in DE, IE, and UK. Review the <b>User.SellerInfo.SellerBusinessType</b> field in the response.
<br><br>
<b>For ReviseItem only:</b> You cannot change the value of this field if the listing has bids or sales, or if the listing ends within 12 hours. For more details, see the <b>ReturnPolicy</b> description.
ReturnsAcceptedOptionsCodeType
AddFixedPriceItem
AddItem
AddItems
AddSellingManagerTemplate
AddLiveAuctionItem
VerifyAddFixedPriceItem
VerifyAddItem
Conditionally
GetItemRecommendations
ReviseFixedPriceItem
ReviseItem
ReviseSellingManagerTemplate
ReviseLiveAuctionItem
RelistFixedPriceItem
RelistItem
VerifyRelistItem
No
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally
GetBidderList
GranularityLevel: Medium, Fine
Conditionally
GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
GranularityLevel: Coarse, Medium, Fine
Conditionally
A buyer can return an item that was shipped via an international shipping service to the seller within the period of time specified by this field. The time period begins the day the buyer receives the item.
<br><br>
<b>Applicable values:</b> To get the applicable <b>ReturnsWithinOption</b> values for your site, call <b>GeteBayDetails</b> with <b>DetailName</b> set to <code>ReturnPolicyDetails</code>.
<br><br>
<b>For AddItem, VerifyAddItem, and RelistItem:</b> If the seller accepts international returns (InternationalReturnsAcceptedOption is set to ReturnsAccepted) but does not specify this field for a listing, eBay sets a default value (often Days_30) and the seller is obligated to honor this setting.
<br><br>
<b>For ReviseItem only:</b> You cannot change the value of this field if the listing has bids or sales, or if the listing ends within 12 hours. For more details, see the <b>ReturnPolicy</b> description.
<br><br>
<span class="tablenote"><b>Note:</b> The <b>GetCategoryFeatures</b> call now returns category-level metadata for both domestic and international return policies, and developers should make plans to use that call for this metadata.</span>
ReturnsWithinOptionsCodeType
AddFixedPriceItem
AddItem
AddItems
AddSellingManagerTemplate
AddLiveAuctionItem
GetItemRecommendations
ReviseFixedPriceItem
ReviseItem
ReviseSellingManagerTemplate
ReviseLiveAuctionItem
RelistFixedPriceItem
RelistItem
VerifyAddFixedPriceItem
VerifyAddItem
VerifyRelistItem
Conditionally
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally
GetBidderList
GranularityLevel: Medium, Fine
Conditionally
GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
GranularityLevel: Coarse, Medium, Fine
Conditionally
This option specifies either the buyer or the seller as the party who pays for international return shipping charges. Accepted values are <code>Buyer</code> or <code>Seller</code>. eBay sites often set <code>Seller</code> as the default value for this field, and sellers are obligated to honor the values that are set for a listing. This value is required if <b>ReturnsAcceptedOption=ReturnsAccepted</b>.
<br><br>
Depending on the seller's return policy and the specifics of a return, either the buyer or the seller can be responsible for the return shipping costs. Note that the seller is always responsible for return shipping costs for SNAD-related issues.
<br><br>
<b>For AddItem, VerifyAddItem, and RelistItem:</b> If the seller accepts returns (<b>InternationalReturnsAcceptedOption</b> = <code>ReturnsAccepted</code>) but does not set this field when listing an item, some eBay sites may set a default value (like Buyer). Because sellers are obligated to honor the policies specified on their View Item pages, be sure this is set to the value desired by the seller.
<br><br>
<b>For ReviseItem only:</b> You cannot change the value of this field if the listing has bids or sales, or if the listing ends within 12 hours. For more details, see the <b>ReturnPolicy</b> description.
ShippingCostPaidByOptionsCodeType
AddFixedPriceItem
AddItem
AddItems
AddSellingManagerTemplate
AddLiveAuctionItem
GetItemRecommendations
ReviseFixedPriceItem
ReviseItem
ReviseSellingManagerTemplate
ReviseLiveAuctionItem
RelistFixedPriceItem
RelistItem
VerifyAddFixedPriceItem
VerifyAddItem
VerifyRelistItem
No
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally
GetBidderList
GranularityLevel: Medium, Fine
Conditionally
GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
GranularityLevel: Coarse, Medium, Fine
Conditionally
Enumerated type that defines the possible states of an eBay return request.
This value indicates that the return request is invalid.
This value indicates that the return request is not applicable.
This value indicates that the return request has been initiated by the buyer and is pending approval by the seller.
This value indicates that the buyer's return request was rejected by the seller.
This value indicates that a return request was successfully opened by the buyer.
This value indicates that the buyer has return shipped the item(s) in the return request back to the seller.
This value indicates that the seller has received the item(s) that the buyer return shipped.
This value indicates that a return request was closed with a refund issued to the buyer.
This value indicates that a return request was closed after being escalated to an eBay return case.
This value indicates that a return request was closed with no refund issued to the buyer.
This value indicates that a return request was escalated to an eBay return case, and the case is awaiting a response from the buyer.
This value indicates that a return request was escalated to an eBay return case, and the case is awaiting a response from the seller.
This value indicates that a return request was escalated to an eBay return case, and the case is awaiting a response from eBay Customer Support.
This value indicates that a return request was escalated to an eBay return case, but the case was closed with a refund issued to the buyer.
This value indicates that a return request was escalated to an eBay return case, but the case was closed with no refund issued to the buyer.
This value indicates that a return request was escalated to an eBay return case.
This value indicates that the return request is currently in the pending state.
This value indicates that the return request was closed with a refund to the buyer.
This value indicates that the return request was closed with no refund to the buyer.
Reserved for internal or future use.
Specified whether returns are accepted.
The seller accepts returns, subject to other details
specified in the policy.
The seller does not accept returns.
(out) Reserved for internal or future use.
This enum defines the different options that are available for specifying whether or not the seller accepts returns.
<code>ReturnsAccepted</code> indicates the seller does accept returns.
<code>ReturnsNotAccepted</code> indicates the seller does <i>not</i> accept returns.
Type defining the <b>ReturnPolicyDetails.ReturnsAccepted</b> container that is returned in <b>GeteBayDetails</b>. This container contains the values that may be used in the <b>ReturnPolicy.ReturnsAcceptedOption</b> field of Add/Revise/Relist API calls.
<br><br>
<span class="tablenote"><b>Note:</b> The <b>GeteBayDetails</b> call returns site-default Return Policy settings. For most categories within a given eBay site, the supported Return Policy options/values are the same, but there a few exceptions. To discover what returns accepted options that a particular category supports, call <b>GetCategoryFeatures</b> and include <code>DomesticReturnsAcceptedValues</code> and/or <code>InternationalReturnsAcceptedValues</code> as <b>FeatureID</b> values to see the returns accepted options available for domestic and international returns, respectively.
</span>
Whether the seller allows the buyer to return the item.
This value can be passed in the AddItem family of calls.
ReturnsAcceptedOptionsCodeType
GeteBayDetails
Conditionally
Display string that applications can use to present ReturnsAcceptedOption in
a more user-friendly format (such as in a drop-down list).
Not applicable as input to the AddItem family of calls. (Use ReturnsAcceptedOption instead.)
GeteBayDetails
Conditionally
This enum defines the different options that are available for specifying the available return durations. This is the amount of time the seller gives the buyer for initiating a return once they receive the item.
<code>Days_14</code> indicates the buyer has 14 days to initiate a return.
<code>Days_30</code> indicates the buyer has 30 days to initiate a return.
<code>Days_60</code> indicates the buyer has 60 days to initiate a return.
This enum defines the different options that are available for specifying the available refund methods.
<code>MoneyBack</code> indicates the seller will refund the cost of the item returned.
Available on the US marketplace only, <code>MoneyBackorReplacement</code> indicates the seller will refund the cost of the item returned or they will replace the returned item.
This enum defines the different options that are available for specifying the return shipment payee.
<code>Buyer</code> indicates the buyer is responsible for paying for the return shipping.
<code>Seller</code> indicates the seller is responsible for paying for the return shipping.
This enumerated type contains the list of values that can be used by the seller in an Add/Revise/Relist call to set the number of days (after the purchase date) that a buyer has to return an item (if the return policy states that items can be returned) for a refund or an exchange. These same values are also returned in the <b>GeteBayDetails</b> call.
<br><br>
<span class="tablenote"><b>Note:</b> The <b>GeteBayDetails</b> call returns site-default Return Policy settings. For most categories within a given eBay site, the supported Return Policy options/values are the same, but there a few exceptions. To discover what return durations that a particular category supports, call <b>GetCategoryFeatures</b> and include <code>DomesticReturnsDurationValues</code> and/or <code>InternationalReturnsDurationValues</code> as <b>FeatureID</b> values to see the return durations available for domestic and international returns, respectively.
</span>
Days_3, Days_7, Days_10, Months_1
This value is deprecated. Listings created or revised with this value will be
blocked.
This value is deprecated. Listings created or revised with this value will be
blocked.
This value is deprecated. Listings created or revised with this value will be
blocked.
The seller specifies this value to enable a 14-day return policy. A buyer must
return an item within 14 days after purchase in order to receive a refund or
an exchange/replacement item.
The seller specifies this value to enable a 30-day return policy. A buyer must
return an item within 30 days after purchase in order to receive a refund or
an exchange/replacement item.
<br/><br/>
<span class="tablenote"><b>Note: </b> To qualify as a Top-Rated Plus listing, a 30-day (or longer) return period must be set.
</span>
The seller specifies this value to enable a 60-day return policy. A buyer must
return an item within 60 days after purchase in order to receive a refund or
an exchange/replacement item.
The seller specifies this value to enable a one-month return policy. A buyer must return an item within one month after purchase in order to receive a refund or an exchange.
<br/>
<span class="tablenote"><b>Note: </b> This value, historically only supported on the DE and AT sites, is scheduled to be deprecated, and DE and AT sellers may be blocked if they do use this value. Use <code>Days_30</code> instead.
</span>
This value is reserved for internal or future use.
Type defining the <b>ReturnPolicyDetails.ReturnsWithin</b> container that is returned in <b>GeteBayDetails</b>. This container contains the values that may be used in the <b>ReturnPolicy.ReturnsWithinOption</b> field of Add/Revise/Relist API calls.
<br><br>
<span class="tablenote"><b>Note:</b> The <b>GeteBayDetails</b> call returns site-default Return Policy settings. For most categories within a given eBay site, the supported Return Policy options/values are the same, but there a few exceptions. To discover what return durations that a particular category supports, call <b>GetCategoryFeatures</b> and include <code>DomesticReturnsDurationValues</code> and/or <code>InternationalReturnsDurationValues</code> as <b>FeatureID</b> values to see the return durations available for domestic and international returns, respectively.
</span>
Value indicates the number of days that a buyer has to return an item from the day they receive the item. This value can be passed in the Add/Revise/Relist family of API calls. Supported values can vary by eBay site.
ReturnsWithinOptionsCodeType
GeteBayDetails
Conditionally
Display string that applications can use to present ReturnsWithinOption in
a more user-friendly format (such as in a drop-down list).
Not applicable as input to the AddItem family of calls. (Use ReturnsWithinOption instead.)
GeteBayDetails
Conditionally
This type is deprecated.
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 field is deprecated.
If the field is present, the corresponding feature applies to the category. The
field is returned as an empty element (i.e., a boolean value is not returned).
If the field is present, the corresponding feature applies to the category. The
field is returned as an empty element (i.e., a boolean value is not returned).
Contains data indicating whether an item has been revised since the
listing became active and, if so, which among a subset of properties
have been changed by the revision.
This field is returned as <code>true</code> if the original listing has been revised. This field is always returned with the <b>ReviseStatus</b> container.
GetBidderList
Always
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Always
GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
Conditionally
This field is returned as <code>true</code> if a Buy It Now price has been added to the auction listing. This field is only returned if the original auction listing did not have a Buy It Now price, but a revision to that original listing included adding a Buy It Now price.
GetBidderList
Conditionally
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally
This field is returned as <code>true</code> if the Buy It Now price on the original auction listing was lowered as part of a revision to the original auction listing. This field is only returned if the Buy It Now price on the original auction listing was lowered as part of a revision to the original auction listing.
GetBidderList
Conditionally
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally
This field is returned as <code>true</code> if the Reserve price on the original auction listing was lowered as part of a revision to the original auction listing. This field is only returned if the Reserve price on the original auction listing was lowered as part of a revision to the original auction listing.
GetBidderList
Conditionally
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally
This field is returned as <code>true</code> if the Reserve price on the original auction listing was removed as part of a revision to the original auction listing. This field is only returned if the Reserve price on the original auction listing was removed as part of a revision to the original auction listing.
GetBidderList
Conditionally
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally
This type is deprecated.
This field is deprecated.
A list of stock-keeping unit (SKU) identifiers that a seller uses in listings.
A SKU (stock keeping unit) is an identifier defined by a seller.
Some sellers use SKUs to track complex flows of products
and information on the client side.
A seller can specify a SKU when listing an item with AddItem
and related calls. eBay preserves the SKU on the item, enabling you
to obtain it before and after an order line item is created.
(SKU is recommended as an alternative to ApplicationData.)<br>
<br>
A SKU is not required to be unique. A seller can specify a
particular SKU value on one item or on multiple items.
Different sellers can use the same SKUs.<br>
<br>
If the SKU is unique across a seller's active listings, and if
the seller listed the item by using AddFixedPriceItem
or RelistFixedPriceItem, the seller can also set
Item.InventoryTrackingMethod to SKU. This allows the seller to use
SKU instead of ItemID as a unique identifier in subsequent calls,
such as GetItem and ReviseInventoryStatus.<br>
<br>
<span class="tablenote"><b>Note:</b>
AddFixedPriceItem and RelistFixedPriceItem are defined in
the Merchant Data API (part of Large Merchant Services).
</span>
50
GetSellerTransactions
GetSellerList
No
Primitive type that represents a stock-keeping unit (SKU).
The usage of this string may vary in different contexts.
For usage information and rules, see the fields that reference this type.
Type of SMS subscription error.
Aggregator not available.
Phone number invalid.
Phone number has changed.
The carrier has changed.
The user has requested to be unregistered.
(out) Reserved for internal or future use.
User data related to notifications. Note that SMS is currently reserved for future use.
The wireless phone number to be used for receiving SMS messages.
Max length of phone number varies by country.
varies by country
SetNotificationPreferences
No
GetNotificationPreferences
Conditionally
Registered/Unregistered/Pending.
SetNotificationPreferences
Failed, Pending, Registered, Unregistered
No
GetNotificationPreferences
Conditionally
The wireless carrier ID.
SetNotificationPreferences
No
GetNotificationPreferences
Conditionally
Reason for SMS subscription error (postback from thired-party integrator).
SetNotificationPreferences
No
GetNotificationPreferences
Conditionally
ID of item to unsubscribe from SMS notification.
SetNotificationPreferences
No
GetNotificationPreferences
Conditionally
The current state of user SMS subscription.
(out) Registered.
(out) Unregistered.
(out) Pending subscription.
(out) Subscription failed.
(out) Reserved for internal or future use.
For the US, Canada and Australia sites, users are
required to offer at least one safe payment method (i.e. PayPal/PaisaPay, or one
of the credit cards specified in Item.PaymentMethods).
<br>
If a seller has a 'SafePaymentExempt' status, they are exempt from the category
requirement to offer at least one safe payment method when listing an item on a
site that has the safe payment requirement.
<br>
The safe payment requirement also applies to two-category listings that have one
ship-to or available-to location in the US, Canada, or Australia. The French
Canadian (CAFR) site is a special case, because listings on the CAFR site with
ship-to or available-to locations in Canada do not require a Safe Payment method,
yet listings on the CAFR site with ship-to or available-to locations in the US or
Australia do require a safe payment method.
<br>
The Business and Industrial, Motors, Real Estate, and Mature Audiences categories,
and all listings that don't support Item.PaymentMethods are exempt from this
requirement. Therefore, listings in those categories do not require a safe payment
method.
<br>
Currently, this field contains no other special meta-data.(An empty element is
returned.)
<br>
Use SiteDefaults.SafePaymentRequired and Category.SafePaymentRequired to determine
which categories require a safe payment method.
This type is used to show sales tax-related details for a tax jurisdiction. The concept of 'sales tax' is only applicable to eBay US and Canada (English and French) sites.
This float value is the sales tax percentage rate applicable to the corresponding tax jurisdiction (US state or Canadian province). Sellers are responsible for providing accurate sales tax rates for each jurisdiction. This sales tax rate comes into play when a buyer from that tax jurisdiction makes a purchase from the seller. The value passed in is stored with a precision of 3 digits after the decimal point (##.###).
<br><br>
This field is only returned in order management calls if sales tax applies to the order line item, and is only in <b>GetItem</b> (and other 'Get' calls) if sales tax is applicable to the listing or order line item, and the seller is the person making the call.
<br><br>
<span class="tablenote"><b>Note: </b> As of November 1, 2019, buyers in over 30 US states will automatically be charged sales tax for eBay purchases. eBay will collect and remit this sales tax to the proper taxing authority on the buyer's behalf. So, if a sales tax rate is applied to the listing by the seller for a state that is subject to eBay 'Collect and Remit', the sales tax rate in this field is ignored by eBay during the checkout process. For a list of US states that are subject to eBay 'Collect and Remit' taxes (and effective dates), see the <a href="https://www.ebay.com/help/selling/fees-credits-invoices/taxes-import-charges?id=4121#section4">eBay sales tax collection</a> help topic.
</span>
AddFixedPriceItem
AddItem
AddItems
AddSellingManagerTemplate
AddOrder
RelistFixedPriceItem
RelistItem
ReviseFixedPriceItem
ReviseItem
ReviseSellingManagerSaleRecord
ReviseSellingManagerTemplate
SendInvoice
VerifyAddFixedPriceItem
VerifyAddItem
VerifyRelistItem
No
GetBidderList
GetItemShipping
GetSellingManagerSaleRecord
GetTaxTable
Conditionally
GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
GranularityLevel: Fine
Conditionally
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnAttributes, ItemReturnDescription, ReturnAll
Conditionally
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetOrders
DetailLevel: none, ReturnAll
Conditionally
OrderReport
Conditionally
This is the unique, two-digit identifier of the tax jurisdiction (such as 'CA' for California). To retrieve all two-digit identifiers for all states/territories/provinces for a site, a seller can either use a <b>GetTaxTable</b> call with <b>DetailLevel</b> set to <code>ReturnAll</code>, or they can use the <b>GeteBayDetails</b> call with <b>DetailLevel</b> name set to <code>TaxJurisdiction</code>. Please note that both <b>GetTaxTable</b> and <b>GeteBayDetails</b> calls use a <b>JurisdictionID</b> field to express these tax jurisdiction identifiers instead of <b>SalesTaxState</b>, but the values used in these fields are the same.
<br/><br/>
The <b>SalesTaxState</b> field is conditionallly required in an Add/Revise/Relist/Verify call if the seller is applying sales tax to a listing, and is returned with each <b>SalesTax</b> container to identify the tax jurisdiction.
AddFixedPriceItem
AddItem
AddItems
AddSellingManagerTemplate
AddOrder
RelistFixedPriceItem
RelistItem
ReviseFixedPriceItem
ReviseItem
ReviseSellingManagerTemplate
SendInvoice
VerifyAddFixedPriceItem
VerifyAddItem
VerifyRelistItem
No
GetBidderList
GetItemShipping
Conditionally
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnAttributes, ItemReturnDescription, ReturnAll
Conditionally
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetOrders
DetailLevel: none, ReturnAll
Conditionally
OrderReport
Conditionally
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
Conditionally
This field is included in an Add/Revise/Relist/Verify call and set to <code>true</code> if the seller wants sales tax for the jurisdiction to apply to the cumulative amount of item cost and shipping charges. This value defaults to <code>false</code> if not specified.
<br><br>
This field is always returned with the <b>SalesTax</b> container (whether <code>true</code> or <code>false</code>).
<br><br>
<span class="tablenote"><b>Note: </b> As of January 1, 2019, buyers in some US states will automatically be charged sales tax for eBay purchases. eBay will collect and remit this sales tax to the proper taxing authority on the buyer's behalf. So, if a <code>true</code> value is set for this field for a state that is subject to 'eBay Collect and Remit', this setting is ignored by eBay during checkout process. For a list of the US states that will become subject to 'eBay Collect and Remit' (and effective dates), see the <a href="https://www.ebay.com/help/selling/fees-credits-invoices/taxes-import-charges?id=4121#section4">eBay sales tax collection</a> help topic.
</span>
AddFixedPriceItem
AddItem
AddItems
AddSellingManagerTemplate
AddOrder
RelistFixedPriceItem
RelistItem
ReviseFixedPriceItem
ReviseItem
ReviseSellingManagerTemplate
SendInvoice
VerifyAddFixedPriceItem
VerifyAddItem
VerifyRelistItem
No
False
GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
GranularityLevel: Fine
Conditionally
GetBidderList
GetItemShipping
Conditionally
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnAttributes, ItemReturnDescription, ReturnAll
Conditionally
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetOrders
DetailLevel: none, ReturnAll
Conditionally
OrderReport
Conditionally
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
The amount of sales tax calculated for an order based on the item price and the sales tax rate for the buyer's tax jurisdiction.
<br><br>
GetItemTransactions can return incorrect sales tax if the name of a state is not
abbreviated (e.g. if the value is "Illinois" rather than "IL") in
<b>TransactionArray.Transaction.Buyer.BuyerInfo.ShippingAddress.StateOrProvince</b>. If
the name of a state is not abbreviated, sales tax should be obtained by using
the <b>OrderLineItemID</b> to call <b>GetOrderTransactions</b>.
SendInvoice
No
GetItemShipping
Conditionally
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetOrders
DetailLevel: none, ReturnAll
Conditionally
OrderReport
Conditionally
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
This type is deprecated.
This field is deprecated.
This field is deprecated.
Contains information for scheduling limits for the user.
Maximum number of minutes that a listing may be scheduled in advance of its going live.
GetUser
DetailLevel: none, ReturnAll
Conditionally
Minimum number of minutes that a listing may be scheduled in advance of its going live.
GetUser
DetailLevel: none, ReturnAll
Conditionally
Maximum number of Items that a user may schedule.
GetUser
DetailLevel: none, ReturnAll
Conditionally
This type is deprecated.
This field is deprecated.
This field is deprecated.
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 enumerated type lists the possible values that can be returned under the
<b>FavoriteSearch.SearchFlag</b> field of a
<b>GetMyeBayBuying</b> response. These values are output only and are
controlled by the filter types used in a buyer's Saved Search.
NowAndNew, DigitalDelivery, Picture, Gallery, WorldOfGood, GetItFast, Gift
This value being returned in the <b>FavoriteSearch.SearchFlag</b>
field indicates that the buyer selected the <b>eBay for Charity</b>
option in the Saved Search.
This value is no longer applicable as Gift Icon and Gift Services are deprecated.
This value is no longer applicable as the Now and New feature is deprecated.
This value being returned in the <b>FavoriteSearch.SearchFlag</b>
field indicates that the buyer selected the <b>Local pickup</b>
option in the Saved Search. A buyer would select the <b>Local Pickup</b>
filter in a Saved Search to restrict retrieved listings to those that offer 'local pickup'
as an option to buyers.
This value being returned in the <b>FavoriteSearch.SearchFlag</b>
field indicates that the buyer selected the <b>Free shipping</b>
option in the Saved Search. A buyer would select the <b>Free shipping</b>
filter in a Saved Search to restrict retrieved listings to those that offer a free
shipping option to that specific buyer (the availability of free shipping may
be dependent on the buyer's location).
This value is no longer applicable as there is always a gallery picture by
default since all listings must have at least one picture.
This value is no longer applicable as there is now a requirement that all
listings have at least one picture.
This value is no longer applicable as the Get It Fast feature is deprecated.
This value being returned in the <b>FavoriteSearch.SearchFlag</b>
field indicates that the buyer selected the <b>Items listed as lots</b>
option in the Saved Search. A buyer would select the <b>Items listed as lots</b>
filter in a Saved Search to restrict retrieved listings to those that are offering
a "lot" of items in one listing. Specifically, a "lot" is defined as, "a group of
similar or identical items that are sold together to one buyer."
This value is only applicable to the German site and if the user is searching for
motor vehicle listings. This value being returned in the
<b>FavoriteSearch.SearchFlag</b> field indicates that the buyer
selected a filter in a Saved Search to restrict retrieved eBay Germany motor
vehicle listings that are also being displayed on the mobile.de vehicle
marketplace.
This value is no longer applicable as the World of Good site no longer exists.
This value is no longer applicable.
Reserved for internal or future use.
Provides information about the visibility level you've earned for your eBay listings.
When you have a better search standing, your listings may receive higher
placement in Best Match search results.
Your earned search standing status. To qualify for a Standard or Raised
search standing, make sure your ratings meet or exceed the required minimum
levels in buyer satisfaction (see <b>BuyerSatisfaction.Status</b> in this call) and
detailed seller ratings (DSRs). See <b>GetFeedback</b> for details.
GetSellerDashboard
Always
(GetFeedback) FeedbackSummary.SellerRatingSummaryArray
GetFeedback.html#Response.FeedbackSummary.SellerRatingSummaryArray
The Search standing that you have earned.
Your listings may receive higher placement in search results
that are sorted by Best Match.
You earn this standing when you provide excellent customer service to eBay buyers
(such as good BuyerSatisfaction.Status and high detailed seller ratings).
If you already have a raised search standing, you can still boost your
ratings and increase the visibility of your items by maintaining or
improving your customer service.
Listings recieve standard placement in search results that are sorted by Best Match.
Your listings may receive lower placement in search results that
are sorted by Best Match.
You earn this standing when you have not been successful in providing
eBay buyers with the customer service they expect.
You can still take positive steps to improve your customer service
and increase your ratings.
Reserved for internal or future use.
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 recipient must purchase the Second Chance or Transaction Confirmation Request item within this time or the offer will expire. Second Chance Offers are only applicable for closed auction listings and Transaction Confirmation Requests are only applicable for an eBay Motors listing that were closed and converted to a Transaction Confirmation Request.
The seller specifies this value to make the Second Chance offer available to the bidder for one day. This value will affect the <b>EndTime</b> value returned in the <b>AddSecondChanceItem</b> or <b>AddTransactionConfirmationItem</b> responses.
The seller specifies this value to make the Second Chance offer available to the bidder for three days. This value will affect the <b>EndTime</b> value returned in the <b>AddSecondChanceItem</b> or <b>AddTransactionConfirmationItem</b> responses.
The seller specifies this value to make the Second Chance offer available to the bidder for five days. This value will affect the <b>AddSecondChanceItem</b> or <b>AddTransactionConfirmationItem</b> responses.
The seller specifies this value to make the Second Chance offer available to the bidder for seven days. This value will affect the <b>EndTime</b> value returned in the <b>AddSecondChanceItem</b> or <b>AddTransactionConfirmationItem</b> responses.
This value is reserved for internal or future use.
This enumerated type contains the values that will be returned in a <b>GetCategorySpecifics</b> call. The value that is returned will determine how a seller uses/sets mandatory and recommended Item Specifics.
Automatic criteria. Reserved for future use.
Manual criteria. Reserved for future use.
Indicates that mandatory and recommended Item Specifics will be pre-filled after a successful <b>Add</b>/<b>Revise</b>/<b>Relist</b> call if eBay is able to match a provided eBay Product ID (ePID), Global Trade Identification Number (UPC, EAN, ISBN), or Brand/MPN pair to an eBay catalog product.
Indicates that the seller must use the exact string provided in the corresponding <b>NameRecommendation.Name</b> field when creating, revising, or relisting an item and using that particular Item Specific.
Indicates that the seller is allowed to specify their own value(s) for the corresponding Item Specific when creating, revising, or relisting an item and using that particular Item Specific.
Reserved for future use.
Type defining the <b>SellerAccount</b> container returned in the
<b>GetSellerDashboard</b> response.
This field indicates the status of your seller's account. Specifically, you'll find out if your
account is current and active, or if your account has a past due balance or is on
hold. For more details about your account, you can go to your Seller Account page
on the eBay site (login to My eBay), or you can call <b>GetAccount</b>.
GetSellerDashboard
Always
GetAccount
GetAccount.html
The <b>SellerAccount.Alert</b> container is only returned if eBay has
posted one or more informational or warning messages to the seller's account.
GetSellerDashboard
Conditionally
Enumerated type that contains the different states of a seller's account.
Your account is current.
Your account is past due.
Your account is on hold and risking suspension.
Reserved for internal or future use.
Type of seller account. This value is returned if the user is a
business seller with a site ID of 77 (Germany), 3 (UK), 205 (Ireland) or 0 (US Motors).
Type of seller account not defined.
Private seller account.
Commercial seller account.
Reserved for internal or future use.
Defines the SellerContactDetailsEnabled feature. If the field is present, the
category allows retrieval of seller-level contact information. The field is
returned as an empty element (e.g., a boolean value is not returned).
Alerts can be either informational or a warning that identifies a problem.
The alert message is informational in nature.
<br><br>
Some examples: you might get a PowerSeller status message if your PowerSeller
level has been increased, a policy-compliance message if you have no recent
policy violations, a buyer-satisfaction message if you are providing excellent
customer service, or a seller-account message if there is a new notice available
about your payment status.
The alert message is a warning that identifies a problem.
<br><br>
For example, you might get a PowerSeller status warning if you missed the
PowerSeller sales requirements in the past month. Or you might get a
policy-compliance warning if you recently listed an item with excessive
shipping costs, or a seller-account warning if a collections message
asks you to pay now to make sure no restrictions are placed on your account.
The alert message is a strong warning that indicates a serious problem.
<br><br>
For example, you might get a PowerSeller status strong warning if you have lost
your PowerSeller status because of policy violations, or you might get a
policy-compliance strong warning if your account has been restricted.
Reserved for internal (or future) use.
A message to help the you understand your status as a seller (PowerSeller status,
policy compliance status, etc.).
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.
This field is present if an alert has been issued to your account.
GetSellerDashboard
Conditionally
The warning or informational alert text. When you parse this text, note that
some alerts may use plain text while others can include HTML. Returned only
if the seller has been issued an alert.
GetSellerDashboard
Conditionally
Type defining the <b>SellerDiscounts</b> container, which consists of one or
more <b>SellerDiscount</b> nodes, as well as the original purchase price and
shipping cost of the order line item.
The original purchase price of the order line item (before any seller discounts are
applied).
GetItemTransactions
GetOrders
GetOrderTransactions
GetSellerTransactions
DetailLevel: none, ReturnAll
Conditionally
OrderReport
Conditionally
The original shipping cost for the order line item (before any seller
discounts are applied).
GetItemTransactions
GetOrders
GetOrderTransactions
GetSellerTransactions
DetailLevel: none, ReturnAll
Conditionally
OrderReport
Conditionally
The original shipping service offered by the seller to ship an item to a buyer.
ShippingServiceCodeType
GetOrders
DetailLevel: none, ReturnAll
Conditionally
OrderReport
Conditionally
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ReturnAll
Conditionally
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.
GetItemTransactions
GetOrders
GetOrderTransactions
GetSellerTransactions
DetailLevel: none, ReturnAll
Conditionally
OrderReport
Conditionally
Type that defines the <b>SellerDiscount</b> container, which contains the ID,
name, and amount of the seller discount.
Unique identifier for a seller discount campaign. This ID is automatically
created when the seller creates the discount campaign. This field is always returned
with the <b>SellerDiscount</b> container.
GetItemTransactions
GetOrders
GetOrderTransactions
GetSellerTransactions
DetailLevel: none, ReturnAll
Conditionally
OrderReport
Conditionally
The name of the seller discount campaign. This field will only be
returned with the <b>SellerDiscount</b> container if defined
for the seller discount campaign.
GetItemTransactions
GetOrders
GetOrderTransactions
GetSellerTransactions
DetailLevel: none, ReturnAll
Conditionally
OrderReport
Conditionally
The dollar amount of the order line item discount. The original purchase price (denoted
in <b>OriginalItemPrice</b>) will be reduced by this value. The amount of the
item discount will depend on the rules defined in the the seller discount
campaign.
<br/><br/>
<span class="tablenote">
<strong>Note:</strong> Prior to Version 895, this field worked a little differently. Instead of this field showing the amount of the discount, it was actually showing the final item price after the discount was applied. So, if an item price is 10.0 dollars and the discount is 2.0 dollars, someone using Version 895 (and going forward) will see a value of '2.0' (amount of the discount) in this field, but anyone using Version 893 or lower will see a value of '8.0' (item price after discount) in this field.
</span>
GetItemTransactions
GetOrders
GetOrderTransactions
GetSellerTransactions
DetailLevel: none, ReturnAll
Conditionally
OrderReport
Conditionally
The dollar amount of the shipping discount applied to the order line item.
GetItemTransactions
GetOrders
GetOrderTransactions
GetSellerTransactions
DetailLevel: none, ReturnAll
Conditionally
OrderReport
Conditionally
Type used by the <b>SellerExcludeShipToLocationPreferences</b> container which is returned in the <b>GetUserPreferences</b> response to indicate which geographical regions and/or individual countries the seller has added as excluded ship-to locations.
One <b>ExcludeShipToLocation</b> field is returned for each geographical region or country excluded
as a possible shipping location in the seller's My eBay Shipping Preferences.
Sellers can also exclude Alaska/Hawaii and Army Post Office/Fleet Post Office as
possible shipping locations. For excluded countries, "http://www.iso.org/iso/country_codes/iso_3166_code_lists/english_country_names_and_code_elements.htm">ISO 3166</a>
country codes are returned.
<br><br>
Domestically, the seller can specify Alaska/Hawaii, US Protectorates (including
American Samoa, Guam, Mariana Island, Marshall Islands, Micronesia, Palau,
Puerto Rico, and U.S. Virgin Islands) as places he/she will not ship to.
Internationally, the sellers can exclude entire regions (including Africa, Asia,
Central America and Caribbean, Europe, Middle East, North America, Oceania,
Southeast Asia, and South America) or specific countries within those regions.
<br><br>
If a buyer's primary ship-to location is a location that you have listed as
an excluded ship-to location (or if the buyer does not have a primary ship-to
location), they will receive an error message if they attempt to buy or place
a bid on your item.
<br><br>
To see the valid exclude ship-to locations for a specified site, call
<b>GeteBayDetails</b> with a <b>DetailName</b> field set to <b>ExcludeShippingLocationDetails</b>.
<br><br>
<span class="tablenote"><strong>Note:</strong>
To enable your default Exclude Ship-To List, you must enable Exclude
Shipping Locations and Buyer Requirements in your My eBay Site Preferences.
For details, see the KnowledgeBase Article <a href=
"https://ebaydts.com/eBayKBDetails?KBid=1495"
>HowTo: ExcludeShipToLocation</a>.
</span>
GetUserPreferences
Conditionally
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.
The keywords in the item title for the automatic item search criteria.
GetUserPreferences
Conditionally
SetUserPreferences
No
(For eBay Store owners only) The store custom category for the automatic item search criteria.
GetUserPreferences
Conditionally
SetUserPreferences
No
The listing format (fixed price, auction, etc) for the automatic item search criteria.
GetUserPreferences
Auction, StoresFixedPrice, LeadGeneration,
FixedPriceItem
Conditionally
SetUserPreferences
Auction, StoresFixedPrice, LeadGeneration,
FixedPriceItem
No
The sort order chosen from the standard ebay sorts for the automatic search criteria.
GetUserPreferences
Conditionally
SetUserPreferences
No
Specifies the lower limit of price range for the automatic search criteria.
GetUserPreferences
Conditionally
SetUserPreferences
No
Specifies the upper limit of price range for the automatic search criteria.
GetUserPreferences
Conditionally
SetUserPreferences
No
Specifies the list of favorite items.
GetUserPreferences
Conditionally
SetUserPreferences
No
PowerSeller discount information (e.g., to show in a Seller Dashboard). As a
PowerSeller, you can earn discounts on your monthly invoice Final Value Fees based
on how well you're doing as a seller.
PowerSeller discount as a percentage. For example, a 5% discount is returned
as 0.05.
GetSellerDashboard
Conditionally
This type was deprecated along with the Seller Guarantee feature.
(out) Not eligible for Seller Level Guarantee
(out) Regular eligibility level
(out) Premium eligibility level
(out) Ultra eligibility level
(out) Reserved for internal or future use.
Indicates the user's eBay PowerSeller tier. PowerSellers are distinguished in 5
tiers based on average monthly sales. Benefits and services vary for each tier.
eBay calculates eligibility for each tier monthly.
Bronze (lowest tier)
Silver (between Bronze and Gold)
Gold (between Silver and Platinum)
Platinum (between Gold and Titanium)
Titanium (highest tier)
Not a PowerSeller (eBay has not yet evaluated your PowerSeller status, or
you have not chosen to be a member of the PowerSeller program,
or you lost your PowerSeller status due to a policy violation.)
Reserved for internal or future use
This enumerated type is deprecated.
This value is not used.
This value is not used.
This value is not used.
This value is not used.
This enumerated type defines the payment methods that an eBay user can use to pay fees on monthly eBay invoice.
This enumeration value indicates that eBay does not currently have a payment method on file for the eBay user.
This enumeration value indicates that eBay will use the credit card on file to process the eBay user's monthly invoice.
This enumeration value indicates that eBay will use the user's PayPal account to process the monthly invoice.
This enumeration value indicates that eBay will debit the bank account on file to process the eBay user's monthly invoice.
This enumeration value indicates that eBay will debit the bank account on file to process the eBay user's monthly invoice. A signature will be needed from the eBay user before a payment can be processed.
This enumeration value indicates that the eBay user will use eBay Direct Pay to pay the monthly invoice.
(out) Reserved for internal or future use
This enumeration value indicates that eBay will debit the bank account on file to process the eBay user's monthly invoice. However, the bank account information must be verified before a payment can be processed.
Type defining the <b>SellerPaymentPreferences</b> container, which
consists of the seller's payment preferences. Payment preferences specified in a
<b>SetUserPreferences</b> call override the settings in My eBay payment preferences.
<br><br>
<span class="tablenote"><b>Note:</b> Sellers opted in to the new eBay Managed Payments program cannot control some of the settings under the <b>SellerPaymentPreferences</b> container, and although some of these fields can still be set in <b>SetUserPreferences</b> and returned in <b>GetUserPreferences</b>, the settings will not have any affect on any current or future listings for the seller. eBay Managed Payments is currently only available to a limited number of sellers on the US site. The rollout to more sellers in more countries will be a multi-year journey, but eBay expects to transition a majority of sellers Worldwide to Managed Payments by 2021.
</span>
<br>
Sellers include this field and set it to <code>true</code> if they want buyers to mail payment
to the payment address specified in the
<b>SellerPaymentPreferences.SellerPaymentAddress</b> field. A payment
address only comes into play if the item's category allows offline payments, and the
seller has allowed the buyer to mail a payment. This payment address will only be
displayed to winning bidders and buyers.
GetUserPreferences
Conditionally
SetUserPreferences
No
If set, this field determines whether a Pay Now button is displayed for all of the user's listings. The user has the option of using a PayPal only version of the Pay Now button or a Pay Now button for all payment methods.
<br><br>
<span class="tablenote"><b>Note:</b> Sellers opted in to the new eBay Managed Payments program cannot control the display of the "Buy It Now" button in listings, and although the <b>DisplayPayNowButton</b> value can still be set in <b>SetUserPreferences</b> and returned in <b>GetUserPreferences</b>, the setting will not have any affect on any current or future listings for the seller. eBay Managed Payments is currently only available to a limited number of sellers on the US site. The rollout to more sellers in more countries will be a multi-year journey, but eBay expects to transition a majority of sellers Worldwide to Managed Payments by 2021.
</span>
<br>
GetUserPreferences
Conditionally
SetUserPreferences
No
Specifies whether a seller wants to let buyers know that PayPal payments
are preferred.
<br><br>
<span class="tablenote"><b>Note:</b> Sellers opted in to the new eBay Managed Payments program cannot control the display of the "PayPal Preferred" setting in listings, and although the <b>PayPalPreferred</b> boolean value can still be set in <b>SetUserPreferences</b> and returned in <b>GetUserPreferences</b>, the setting will not have any affect on any current or future listings for the seller. eBay Managed Payments is currently only available to a limited number of sellers on the US site. The rollout to more sellers in more countries will be a multi-year journey, but eBay expects to transition a majority of sellers Worldwide to Managed Payments by 2021.
</span>
GetUserPreferences
Conditionally
SetUserPreferences
No
Specifies the default email address the seller uses for receiving PayPal payments.
GetUserPreferences
Conditionally
SetUserPreferences
No
Indicates whether PayPal is always accepted for the seller's listings.
<br><br>
<span class="tablenote"><b>Note:</b> Sellers opted in to the new eBay Managed Payments program cannot control the "PayPal Always On" setting in listings, and although the <b>PayPalAlwaysOn</b> boolean value can still be set in <b>SetUserPreferences</b> and returned in <b>GetUserPreferences</b>, the setting will not have any affect on any current or future listings for the seller. eBay Managed Payments is currently only available to a limited number of sellers on the US site. The rollout to more sellers in more countries will be a multi-year journey, but eBay expects to transition a majority of sellers Worldwide to Managed Payments by 2021.
</span>
GetUserPreferences
Conditionally
SetUserPreferences
No
Specifies the address the seller uses to receive mailed payments from buyers.
GetUserPreferences
Conditionally
SetUserPreferences
No
This enumeration value indicates the type of UPS shipping rates that are available to the seller.
GetUserPreferences
Conditionally
SetUserPreferences
No
This enumeration value indicates the type of FedEx shipping rates that are available to the seller.
GetUserPreferences
Conditionally
SetUserPreferences
No
This enumeration value indicates the type of US Postal Service shipping rates that are available to the seller.
GetUserPreferences
Conditionally
SetUserPreferences
No
Type defining the <b>SellerPaymentProfile</b> container, which is used in an Add/Revise/Relist/Verify Trading API call to reference a Business Policies payment profile.
The unique identifier of a Business Policies payment profile. A <b>PaymentProfileID</b> and/or a <b>PaymentProfileName</b> value is used in the Add/Revise/Relist/Verify call to reference and use the payment policy values of a Business Policies payment profile. If both fields are provided and their values don't match, the <b>PaymentProfileID</b> takes precedence.
<br/><br/>
Payment profile IDs can be retrieved with the <b>getPaymentPolicies</b> call of the <b>Account API</b> or with the <b>getSellerProfiles</b> call of the <b>Business Policies Management API</b>. Business Policy IDs can also be retrieved through the Business Policies section of My eBay.
<br/><br/>
In the 'Get' calls, the <b>PaymentProfileID</b> value will always be returned if Business Policies are set for the listing, and the person making the API call is the seller of the listing. The <b>PaymentProfileName</b> value will be returned if a name is assigned to the payment profile.
AddFixedPriceItem
ReviseFixedPriceItem
RelistFixedPriceItem
VerifyAddFixedPriceItem
Conditionally
AddItem
AddItems
ReviseItem
RelistItem
VerifyAddItem
AddItemFromSellingManagerTemplate
AddItemFromTemplate
AddTemplate
ReviseTemplate
VerifyRelistItem
Conditionally
GetItem
Conditionally
DetailLevel: none, ItemReturnDescription,
ItemReturnAttributes, ReturnAll
GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
Conditionally
GetSellerEvents
GetItems
GetMyeBaySelling
GetSellingManagerTemplates
Conditionally
The name of a Business Policies payment profile. A <b>PaymentProfileID</b> and/or a <b>PaymentProfileName</b> value is used in the Add/Revise/Relist/Verify call to reference and use the payment policy values of a Business Policies payment profile. If both fields are provided and their values don't match, the <b>PaymentProfileID</b> takes precedence.
<br/><br/>
In the 'Get' calls, the <b>PaymentProfileID</b> value will always be returned if Business Policies are set for the listing, and the person making the API call is the seller of the listing. The <b>PaymentProfileName</b> value will be returned if a name is assigned to the payment profile.
AddFixedPriceItem
ReviseFixedPriceItem
RelistFixedPriceItem
VerifyAddFixedPriceItem
Conditionally
AddItem
AddItems
ReviseItem
RelistItem
VerifyAddItem
AddItemFromSellingManagerTemplate
AddItemFromTemplate
AddTemplate
ReviseTemplate
VerifyRelistItem
Conditionally
GetItem
Conditionally
DetailLevel: none, ItemReturnDescription,
ItemReturnAttributes, ReturnAll
GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
Conditionally
GetSellerEvents
GetItems
GetMyeBaySelling
GetSellingManagerTemplates
Conditionally
<span class="tablenote"><b>Note: </b> This type is deprecated since it was only applicable to the Half.com, and the Half.com site was shut down.
</span>
<span class="tablenote"><b>Note: </b> <b>SellerPaymentType</b> and all of its fields are no longer applicable since the Half.com site was shut down.
</span>
1027
NoOp
1033
<span class="tablenote"><b>Note: </b> <b>SellerPaymentType</b> and all of its fields are no longer applicable since the Half.com site was shut down.
</span>
1027
NoOp
1033
<span class="tablenote"><b>Note: </b> <b>SellerPaymentType</b> and all of its fields are no longer applicable since the Half.com site was shut down.
</span>
1027
NoOp
1033
<span class="tablenote"><b>Note: </b> <b>SellerPaymentType</b> and all of its fields are no longer applicable since the Half.com site was shut down.
</span>
1027
NoOp
1033
<span class="tablenote"><b>Note: </b> <b>SellerPaymentType</b> and all of its fields are no longer applicable since the Half.com site was shut down.
</span>
1027
NoOp
1033
<span class="tablenote"><b>Note: </b> <b>SellerPaymentType</b> and all of its fields are no longer applicable since the Half.com site was shut down.
</span>
1027
NoOp
1033
<span class="tablenote"><b>Note: </b> <b>SellerPaymentType</b> and all of its fields are no longer applicable since the Half.com site was shut down.
</span>
1027
NoOp
1033
<span class="tablenote"><b>Note: </b> <b>SellerPaymentType</b> and all of its fields are no longer applicable since the Half.com site was shut down.
</span>
1027
NoOp
1033
<span class="tablenote"><b>Note: </b> <b>SellerPaymentType</b> and all of its fields are no longer applicable since the Half.com site was shut down.
</span>
1027
NoOp
1033
<span class="tablenote"><b>Note: </b> <b>SellerPaymentType</b> and all of its fields are no longer applicable since the Half.com site was shut down.
</span>
1027
NoOp
1033
<span class="tablenote"><b>Note: </b> <b>SellerPaymentType</b> and all of its fields are no longer applicable since the Half.com site was shut down.
</span>
1027
NoOp
1033
<span class="tablenote"><b>Note: </b> <b>SellerPaymentType</b> and all of its fields are no longer applicable since the Half.com site was shut down.
</span>
1027
NoOp
1033
<span class="tablenote"><b>Note: </b> <b>SellerPaymentType</b> and all of its fields are no longer applicable since the Half.com site was shut down.
</span>
1027
NoOp
1033
Type defining the <b>SellerProfilePreferences</b> container. This container
consists of a flag that indicates whether or not the seller has opted into Business
Policies, as well as a list of Business Policies profiles that have been set up for the
seller's account.
Boolean flag indicating whether or not a seller has opted in to Business
Policies. Sellers must opt in to Business Policies to create and manage payment,
return policy, and shipping profiles.
GetUserPreferences
Conditionally
SetUserPreferences
No
Container consisting of one or more Business Policies profiles active for a
seller's account. This container is only returned if <b>SellerProfileOptedIn</b> = SellerProfilePreferences
and the seller has one or more Business Policies profiles active on the account.
GetUserPreferences
Conditionally
SetUserPreferences
No
Type defining the <b>SellerProfiles</b> container, which consists of references to a seller's payment, shipping, and return policy profiles.
The <b>SellerShippingProfile</b> container is used in an Add/Revise/Relist/Verify Trading API call to reference and use the values of a Business Policies shipping policy profile. Business Policies shipping profiles contain detailed information on domestic and international shipping, including shipping service options, handling time, package handling costs, excluded ship-to locations, and shipping insurance information.
<br/><br/>
This container is only returned in 'Get' calls if Business Policies are set for the listing, and the person making the API call is the seller of the listing.
AddFixedPriceItem
ReviseFixedPriceItem
RelistFixedPriceItem
VerifyAddFixedPriceItem
Conditionally
AddItem
AddItems
ReviseItem
RelistItem
VerifyAddItem
AddSellingManagerTemplate
ReviseSellingManagerTemplate
AddItemFromTemplate
AddTemplate
ReviseTemplate
VerifyRelistItem
Conditionally
GetItem
Conditionally
DetailLevel: none, ItemReturnDescription,
ItemReturnAttributes, ReturnAll
GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
Conditionally
GetSellerEvents
GetItems
GetMyeBaySelling
GetSellingManagerTemplates
Conditionally
The <b>SellerReturnProfile</b> container is used in an Add/Revise/Relist/Verify Trading API call to reference and use the values of a Business Policies return policy profile. Business Policies return policy profiles contain detailed information on the seller's return policy, including who pays for the return shipping, how many days the buyer has to return the item for a refund, and the refund option (if any).
<br/><br/>
This container is only returned in 'Get' calls if Business Policies are set for the listing and the person making the API call is the seller of the listing.
AddFixedPriceItem
ReviseFixedPriceItem
RelistFixedPriceItem
VerifyAddFixedPriceItem
Conditionally
AddItem
AddItems
ReviseItem
RelistItem
VerifyAddItem
AddSellingManagerTemplate
AddItemFromTemplate
AddTemplate
ReviseTemplate
ReviseSellingManagerTemplate
VerifyRelistItem
Conditionally
GetItem
Conditionally
DetailLevel: none, ItemReturnDescription,
ItemReturnAttributes, ReturnAll
GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
Conditionally
GetSellerEvents
GetItems
GetMyeBaySelling
GetSellingManagerTemplates
Conditionally
The <b>SellerPaymentProfile</b> container is used in an Add/Revise/Relist/Verify Trading API call to reference and use the values of a Business Policies payment profile. Business Policies payment profiles contain accepted payment methods, a flag to set up the immediate payment feature, a payment instructions field, and a field to specify the seller's PayPal email address.
<br/><br/>
This container is only returned in 'Get' calls if Business Policies are set for the listing, and the person making the API call is the seller of the listing.
AddFixedPriceItem
ReviseFixedPriceItem
RelistFixedPriceItem
VerifyAddFixedPriceItem
Conditionally
AddItem
AddItems
ReviseItem
RelistItem
VerifyAddItem
AddSellingManagerTemplate
AddItemFromTemplate
AddTemplate
ReviseTemplate
ReviseSellingManagerTemplate
VerifyRelistItem
Conditionally
GetItem
Conditionally
DetailLevel: none, ItemReturnDescription,
ItemReturnAttributes, ReturnAll
GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
Conditionally
GetSellerEvents
GetItems
GetMyeBaySelling
GetSellingManagerTemplates
Conditionally
If present, the site defines category settings for whether the seller can provide their own title for a US or CA eBay Motors listing.
Type defining the <b>SellerRatingSummaryArray</b> container that is returned
in the <b>GetFeedback</b> response. The <b>SellerRatingSummaryArray</b>
container consists of an array of <b>AverageRatingSummary</b> containers,
which provide details on Detailed Seller Ratings (DSRs), including the type of rating
(Communication, Item As Described, Shipping and Handling Charges, or Shipping Time), the
seller's average rating for that DSR type, the total number of DSR ratings, and the
period in which those ratings were received (the last year or the last 30 days).
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).
GetFeedback
Conditionally
DetailLevel: none, ReturnAll
Details the recoupment policy on this site. There are two sites involved in recoupment - the listing site
and the user registration site, each of which must agree before eBay enforces recoupment for a seller and listing.
Indicates whether recoupment policy is enforced on the site on which the item is listed.
GeteBayDetails
Always
Indicates whether recoupment policy is enforced on the registration site for which the call is made.
GeteBayDetails
Always
Returns the latest version number for this field. The version can be
used to determine if and when to refresh cached client data.
GeteBayDetails
Always
Gives the time in GMT that the feature flags for the details were last
updated. This timestamp can be used to determine if and when to refresh
cached client data.
GeteBayDetails
Always
Type defining the <b>SellerReturnPreferences</b> container, which consists of the <b>OptedIn</b> flag that indicates whether or not the seller has opted in to eBay Managed Returns.
This flag indicates whether or not an eligible seller has opted in to eBay
Managed Returns through the Return Preferences of My eBay.
GetUserPreferences
Conditionally
Type defining the <b>SellerReturnProfile</b> container, which is used in an Add/Revise/Relist/Verify Trading API call to reference a Business Policies return policy profile. Business Policies return policy profiles contain detailed information on the seller's return policy, including the refund option and how many days the buyer has to return the item for a refund.
The unique identifier of a Business Policies return policy profile. A <b>ReturnProfileID</b> and/or a <b>ReturnProfileName</b> value is used in the Add/Revise/Relist/Verify call to reference and use the return policy values of a Business Policies return policy profile. If both fields are provided and their values don't match, the <b>ReturnProfileID</b> takes precedence.
<br/><br/>
Return Policy profile IDs can be retrieved with the <b>getReturnPolicies</b> call of the <b>Account API</b> or with the <b>getSellerProfiles</b> call of the <b>Business Policies Management API</b>. Business Policy IDs can also be retrieved through the Business Policies section of My eBay.
<br/><br/>
In the 'Get' calls, the <b>ReturnProfileID</b> value will always be returned if Business Policies are set for the listing, and the person making the API call is the seller of the listing. The <b>ReturnProfileName</b> value will be returned if a name is assigned to the return policy profile.
AddFixedPriceItem
ReviseFixedPriceItem
RelistFixedPriceItem
VerifyAddFixedPriceItem
Conditionally
AddItem
AddItems
ReviseItem
RelistItem
VerifyAddItem
AddItemFromSellingManagerTemplate
AddItemFromTemplate
AddTemplate
ReviseTemplate
VerifyRelistItem
Conditionally
GetItem
Conditionally
DetailLevel: none, ItemReturnDescription,
ItemReturnAttributes, ReturnAll
GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
Conditionally
GetSellerEvents
GetItems
GetMyeBaySelling
GetSellingManagerTemplates
Conditionally
The name of a Business Policies return policy profile. A <b>ReturnProfileID</b> and/or a <b>ReturnProfileName</b> value is used in the Add/Revise/Relist/Verify call to reference and use the return policy values of a Business Policies return policy profile. If both fields are provided and their values don't match, the <b>ReturnProfileID</b> takes precedence.
<br/><br/>
In the 'Get' calls, the <b>ReturnProfileID</b> value will always be returned if Business Policies are set for the listing, and the person making the API call is the seller of the listing. The <b>ReturnProfileName</b> value will be returned if a name is assigned to the return policy profile.
AddFixedPriceItem
ReviseFixedPriceItem
RelistFixedPriceItem
VerifyAddFixedPriceItem
Conditionally
AddItem
AddItems
ReviseItem
RelistItem
VerifyAddItem
AddItemFromSellingManagerTemplate
AddItemFromTemplate
AddTemplate
ReviseTemplate
VerifyRelistItem
Conditionally
GetItem
Conditionally
DetailLevel: none, ItemReturnDescription,
ItemReturnAttributes, ReturnAll
GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
Conditionally
GetSellerEvents
GetItems
GetMyeBaySelling
GetSellingManagerTemplates
Conditionally
Specifies 1 year feedback metrics for a seller.
Count of positive feedback entries given as a seller.
GetFeedback
DetailLevel: none, ReturnAll
Conditionally
Count of negative feedback entries given as a seller.
GetFeedback
DetailLevel: none, ReturnAll
Conditionally
Count of neutral feedback entries given as a seller.
GetFeedback
DetailLevel: none, ReturnAll
Conditionally
Percentage of leaving feedback as a seller.
GetFeedback
DetailLevel: none, ReturnAll
Conditionally
Number of buyers who bought more than once from this seller.
GetFeedback
DetailLevel: none, ReturnAll
Conditionally
Percentage of repeat buyers.
GetFeedback
DetailLevel: none, ReturnAll
Conditionally
Count of unique buyers from this seller.
GetFeedback
DetailLevel: none, ReturnAll
Conditionally
Percentage of number of times a member has sold successfully vs. the number of
times a member has bought an item in the preceding 365 days.
GetFeedback
DetailLevel: none, ReturnAll
Conditionally
The count of Cross-Border Trade order line items.
GetFeedback
DetailLevel: none, ReturnAll
Conditionally
The percentage of order line items that are Cross-Border Trade order line items.
GetFeedback
DetailLevel: none, ReturnAll
Conditionally
Type defining the <b>SellerShippingProfile</b> container, which is used in an Add/Revise/Relist Trading API call to reference a Business Policies shipping policy profile. Business Policies shipping profiles contain detailed information on domestic and international shipping, including shipping service options, handling time, package handling costs, excluded ship-to locations, and shipping insurance information.
The unique identifier of a Business Policies shipping profile. A <b>ShippingProfileID</b> and/or a <b>ShipppingProfileName</b> value is used in the Add/Revise/Relist/Verify call to reference and use the Shippping values of a Business Policies shipping profile. If both fields are provided and their values don't match, the <b>ShipppingProfileID</b> takes precedence.
<br/><br/>
Shipping profile IDs can be retrieved with the <b>getFulfillmentPolicies</b> call of the <b>Account API</b> or with the <b>getSellerProfiles</b> call of the <b>Business Policies Management API</b>. Business Policy IDs can also be retrieved through the Business Policies section of My eBay.
<br/><br/>
In the 'Get' calls, the <b>ShipppingProfileID</b> value will always be returned if Business Policies are set for the listing, and the person making the API call is the seller of the listing. The <b>ShipppingProfileName</b> value will be returned if a name is assigned to the shipping profile.
AddFixedPriceItem
ReviseFixedPriceItem
RelistFixedPriceItem
VerifyAddFixedPriceItem
Conditionally
AddItem
AddItems
ReviseItem
RelistItem
VerifyAddItem
AddItemFromSellingManagerTemplate
AddItemFromTemplate
AddTemplate
ReviseTemplate
VerifyRelistItem
Conditionally
GetItem
Conditionally
DetailLevel: none, ItemReturnDescription,
ItemReturnAttributes, ReturnAll
GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
Conditionally
GetSellerEvents
GetItems
GetMyeBaySelling
GetSellingManagerTemplates
Conditionally
The name of a Business Policies shipping profile. A <b>ShippingProfileID</b> and/or a <b>ShippingProfileName</b> value is used in the Add/Revise/Relist/Verify call to reference and use the shipping values of a Business Policies shipping profile. If both fields are provided and their values don't match, the <b>ShippingProfileID</b> takes precedence.
<br/><br/>
In the 'Get' calls, the <b>ShippingProfileID</b> value will always be returned if Business Policies are set for the listing, and the person making the API call is the seller of the listing. The <b>ShippingProfileName</b> value will be returned if a name is assigned to the payment profile.
AddFixedPriceItem
ReviseFixedPriceItem
RelistFixedPriceItem
VerifyAddFixedPriceItem
Conditionally
AddItem
AddItems
ReviseItem
RelistItem
VerifyAddItem
AddItemFromSellingManagerTemplate
AddItemFromTemplate
AddTemplate
ReviseTemplate
VerifyRelistItem
Conditionally
GetItem
Conditionally
DetailLevel: none, ItemReturnDescription,
ItemReturnAttributes, ReturnAll
GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
Conditionally
GetSellerEvents
GetItems
GetMyeBaySelling
GetSellingManagerTemplates
Conditionally
Information about a user returned in the context of an item's seller.
PaisaPay is no longer a supported payment method, so this field is no longer applicable.
Indicates whether the user as a seller by default allows buyers to edit the
total cost of an item (while in checkout). (Sellers enable this property in
their My eBay user preferences on the eBay site.)
GetBidderList
Always
GetUser
DetailLevel: none, ReturnSummary, ReturnAll
Conditionally
GetItem
GetSellingManagerTemplates
Always
Seller
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
GetSellerList
SellerInfo
DetailLevel: none, ItemReturnDescription, ReturnAll
GranularityLevel: Fine
Always
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ReturnAll
Always
Currency type in which the user is billed seller fees.
This flag indicates whether or not the seller's Checkout Enabled preference is turned on (at account level or at
listing level). This preference is managed through Payment Preferences in My eBay. If this preference is enabled,
a Pay Now button will appear in checkout flow pages and in the email notifications that are sent to buyers. This
preferance is enabled by default if PayPal is one of the payment methods.
GetBidderList
Always
GetUser
DetailLevel: none, ReturnSummary, ReturnAll
Conditionally
GetItem
GetSellingManagerTemplates
Always
Seller
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ReturnAll
Always
GetSellerList
SellerInfo
DetailLevel: none, ItemReturnDescription, ReturnAll
GranularityLevel: Fine
Always
If true, this flag indicates that the seller has stored bank account information on file
with eBay. A seller must have stored bank account information on file with eBay in order
to use 'CashOnPickup' as a payment method (known as 'Pay upon Pickup' on the site). This
field is applicable to all eBay sites that support 'CashOnPickup' as a payment method.
GetBidderList
Always
GetUser
DetailLevel: none, ReturnSummary, ReturnAll
Conditionally
GetSellerList
SellerInfo
DetailLevel: none, ItemReturnDescription, ReturnAll
GranularityLevel: Fine
Always
GetItem
GetSellingManagerTemplates
Always
Seller
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ReturnAll
Always
If true, indicates that the user is in good standing with eBay. (One of the
requirements for listing a new item with Immediate Payment.)
GetBidderList
Always
GetUser
DetailLevel: none, ReturnSummary, ReturnAll
Conditionally
GetItem
GetSellingManagerTemplates
Always
Seller
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
GetSellerList
SellerInfo
DetailLevel: none, ItemReturnDescription, ReturnAll
GranularityLevel: Fine
Always
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ReturnAll
Always
This field is deprecated.
Indicates whether the user is subject to VAT. Users who have registered with
eBay as VAT-exempt are not subject to VAT.
GetBidderList
Always
GetUser
DetailLevel: none, ReturnSummary, ReturnAll
Conditionally
GetItem
GetSellingManagerTemplates
Always
Seller
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
GetSellerList
SellerInfo
DetailLevel: none, ItemReturnDescription, ReturnAll
GranularityLevel: Fine
Always
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ReturnAll
Always
This field is deprecated.
773
Avoid
889
The user's eBay PowerSeller tier. Possible values are enumerated in the SellerLevelCodeType code list.
SellerInfo.SellerLevel is no longer returned in the GetUser, GetBidderList, GetSellerList, GetItem, and
GetItemTransactions responses for the US, DE/AT/CH, and UK/IE sites, for version 629 and later. If you are using
a version older than 629, SellerInfo.SellerLevel will still be returned. Developers should note that
SellerInfo.SellerLevel could potentially be removed from other sites as well.
GetBidderList
Always
GetSellerList
SellerInfo
DetailLevel: none, ItemReturnDescription, ReturnAll
GranularityLevel: Fine
Always
GetUser
DetailLevel: none, ReturnSummary, ReturnAll
Conditionally
GetItem
GetSellingManagerTemplates
Always
Seller
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ReturnAll
Always
Address used by eBay for purposes of billing the user for seller fees.
GetUser
DetailLevel: ReturnAll
Conditionally
Container for scheduling limits for the user.
Conveys the minimum and maximum
minutes the user may schedule listings in advance, as well as the maximum
number of items the user may schedule.
GetUser
DetailLevel: none, ReturnAll
Conditionally
Boolean value indicates whether or not the seller is an eBay Store owner.
GetBidderList
Always
GetSellerList
SellerInfo
DetailLevel: none, ItemReturnDescription, ReturnAll
GranularityLevel: Fine
Conditionally
GetUser
DetailLevel: none, ReturnSummary, ReturnAll
Conditionally
GetItem
GetSellingManagerTemplates
Always
Seller
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ReturnAll
Always
The URL for the seller's eBay Store. This field is only returned if the seller is a store
owner. To determine if a seller is a Store owner, check for the <b>User.SellerInfo.StoreOwner</b>
and a value of true. The eBay Stores domain that is returned in this field is based on the
<b>SITEID</b> header that is passed in the request, and not on the user's
registration address, as was the case prior to version 757. So, if the seller's
registration county is the UK, but a <b>SITEID</b> value of 71 (France) is
passed into the call, the eBay Stores domain that is returned would be stores.ebay.fr.
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ReturnAll
Always
GetSellerList
SellerInfo
DetailLevel: none, ItemReturnDescription, ReturnAll
GranularityLevel: Fine
Conditionally
GetUser
DetailLevel: none, ReturnSummary, ReturnAll
Conditionally
Type of seller account. This value is returned if the German
(ID 77), UK (ID 3), Ireland (ID 205), or US eBay Motors (ID 0) sites are specified.
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally
GetUser
DetailLevel: none, ReturnSummary, ReturnAll
Conditionally
If true, the user is registered as a vehicle dealer on the eBay Motors site.
GetUser
DetailLevel: none, ReturnSummary, ReturnAll
Conditionally
The site associated with the seller's eBay Store.
GetUser
Conditionally
Indicates the method the seller selected to pay eBay with for
the account.
The payment methods vary from one eBay site to the next.
GetUser
DetailLevel: none, ReturnSummary, ReturnAll
Conditionally
This field is deprecated.
Indicates whether or not the seller is a registered charity
seller. If <b>CharityRegistered</b> is <code>false</code>, the user must
register their nonprofit organization with the PayPal Giving Fund to list eBay for Charity items.
eBay for Charity
http://pages.ebay.com/help/sell/nonprofit.html
GetUser
DetailLevel: none, ReturnSummary, ReturnAll
Always
If this field is <code>true</code>, 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 <b>Item.PaymentMethods</b>) when listing items. This value should only return <code>true</code>
for sellers who registered before January 17, 2007. Otherwise, it should
return <code>false</code>. This setting overrides both the site and category values for
<b>SafePaymentRequired</b>.
false
GetBidderList
Always
Seller
DetailLevel: none, ReturnAll
GetItem
GetSellingManagerTemplates
Always
Seller
DetailLevel: none, ItemReturnAttributes, ItemReturnDescription,ReturnAll
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Always
GetUser
DetailLevel: none, ReturnSummary, ReturnAll
Always
GetSellerList
Seller
DetailLevel: none, ItemReturnDescription, ReturnAll
GranularityLevel: Fine
Always
This field is deprecated since eBay India is no longer a functioning marketplace.
GetUser
DetailLevel: none, ReturnAll
Conditionally
This container consists of one or more of nonprofit organizations associated with the seller's account. This container will not be returned if the user is not affiliated with any nonprofit organizations. A seller must be registered with the PayPal Giving Fund to be affiliated with an eBay for Charity nonprofit organization.
eBay for Charity
http://pages.ebay.com/help/sell/nonprofit.html
GetUser
DetailLevel: none, ReturnSummary, ReturnAll
Conditionally
Percentage of the number of times a member has sold successfully vs.
the number of times a member has bought an item in the preceding 365 days.
GetUser
DetailLevel: none, ReturnSummary, ReturnAll
Conditionally
<span class="tablenote"><b>Note: </b>
As of May 1, 2019, eBay no longer support electronic payments through Integrated Merchant Credit Card accounts. To accept online credit card payments from buyers, a seller must use specify PayPal as an accepted payment method, or opt in to eBay Managed Payments program (if the program is available to that seller).
</span>
This container is returned if the seller has a payment gateway account on one or more eBay marketplaces.
GetUser
DetailLevel: none, ReturnSummary, ReturnAll
Conditionally
Contains eligibility details about seller- or platform-based features. This is returned only
if IncludeFeatureEligibility is set to true in the request.
GetUser
DetailLevel: none, ReturnSummary, ReturnAll
Conditionally
This boolean field indicates if the seller is certified as a
<em>Top Rated Seller</em>. Only Top Rated Sellers can qualify for Top Rated Plus listings, which receive the Top Rated Plus seal, and will help those listings stand out. Top Rated Plus listings also receive a 20 percent discount on the Final Value Fee.
<br/><br/>
This field is only returned for the following sites: US (EBAY-US), Motors (EBAY-MOTOR), AT (EBAY-AT), CH (EBAY-CH), DE (EBAY-DE), IE (EBAY-IE), UK (EBAY-GB), and AU (EBAY-AU). The Top Rated Seller and Top Rated Plus listing requirements will differ by site. Below are some links to Help pages that discusss these requirements:
<ul>
<li>eBay US: <a href="http://pages.ebay.com/help/sell/top-rated.html">Becoming a Top Rated Seller and qualifying for Top Rated Plus</a></li>
<li>eBay US Motors: <a href="http://pages.ebay.com/help/sell/top-rated.html#becoming">Becoming a Top Rated Seller in Motors vehicles categories</a></li>
<li>eBay UK/IE: <a href="http://pages.ebay.co.uk/help/sell/top-rated.html">eBay Top-rated Seller status and the eBay Premium Service</a></li>
<li>eBay DE/AT/CH: <a href="http://pages.ebay.de/help/sell/top-rated/2.html">
Anforderungen fur den Verkaufer mit Top-Bewertung</a></li>
<li>eBay AU: <a href="http://pages.ebay.com.au/help/sell/top-rated.html">
Becoming a Top Rated Seller and qualifying for eBay Premium Service</a></li>
</ul>
Top Rated Sellers, registered in the US, can qualify for Top Rated Seller programs in other countries as long as they meet the selling requirments in those countries. However, even if US sellers qualify for programs in other countries, they will not receive the Final Value Fee discount on sales in those countries. For more information, see the <a href="http://pages.ebay.com/help/sell/top-rated.html#qualifying">
Qualifying for Top Rated Seller status on other eBay sites</a> help topic.
GetBidderList
Conditionally
GetSellerList
SellerInfo
DetailLevel: none, ItemReturnDescription, ReturnAll
GranularityLevel: Fine
Conditionally
GetUser
DetailLevel: none, ReturnSummary, ReturnAll
Conditionally
GetItem
GetSellingManagerTemplates
Conditionally
Seller
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ReturnAll
Conditionally
Top Rated Seller Resource Center
http://pages.ebay.com/sellerinformation/sellingresources/toprated.html
more information about how to become a Top Rated Seller and qualify for Top Rated Plus on the eBay US site
Seller Help Page
http://pages.ebay.com/help/sell/top-rated.html
more information about how to qualify as a Top Rated Seller on the eBay US, AT, CH, DE, IE and UK sites
Contains Top Rated Seller program details for the seller.
GetUser
DetailLevel: none, ReturnSummary, ReturnAll
Conditionally
The list of the sites where a seller has agreed to the cross-border recoupment terms.
<br><br>
Sellers who engage in cross-border trade on sites that require a recoupment agreement, must
agree to the recoupment terms before adding items to the site. This agreement allows eBay to
reimburse a buyer during a dispute and then recoup the cost from the seller.
GetUser
DetailLevel: none, ReturnSummary, ReturnAll
Always
If true, the seller has configured a domestic shipping rate table on the DE, UK or US website.
GetUser
DetailLevel: none, ReturnSummary, ReturnAll
Conditionally
If true, the seller has configured an international shipping rate table on the US, UK or DE website.
GetUser
DetailLevel: none, ReturnSummary, ReturnAll
Conditionally
This field is no longer used.
This field is no longer used.
This type is deprecated.
This field is deprecated.
This field is deprecated.
This field is deprecated.
This enumerated type is deprecated.
This value is not used.
This value is not used.
This value is not used.
This value is not used.
Type defining the Alert container, which contains summary information on one type of
Selling Manager alert.
This field indicates the type of Selling Manager alert returned to the seller. This
field is always returned with the <b>Alert</b> container in the
<b>GetSellingManagerAlerts</b> response.
GetSellingManagerAlerts
Conditionally
This value indicates an alert related to a sold item. This field is only returned
if <b>AlertType</b>='Sold'.
GetSellingManagerAlerts
Conditionally
This value indicates an alert related to the seller's inventory, such as a
restocking alert. This field is only returned if
<b>AlertType</b>='Inventory'.
GetSellingManagerAlerts
Conditionally
This value indicates an alert related to listing automation, and may be received
when a listing does not conform to listing automation rules. This field is only
returned if <b>AlertType</b>='Automation'.
GetSellingManagerAlerts
Conditionally
This value indicates an alert related to a PaisaPay issue. This field is only
returned if <b>AlertType</b>='PaisaPay'.
GetSellingManagerAlerts
Conditionally
This value indicates a general alert was received, such as negative feedback
received or an unpaid item dispute. This field is only returned if <b>
AlertType</b>='General'.
GetSellingManagerAlerts
Conditionally
Represents the duration for which this alert is computed. This field is only
returned if the alert is based on duration.
GetSellingManagerAlerts
Conditionally
This field indicates the number of items affected by the alert. This field is not
returned if the count is 0.
GetSellingManagerAlerts
Conditionally
PaisaPay
This enumerated type defines the types of alerts that may me returned in the <b>GetSellingManagerAlerts</b> response
This enumeration value indicates that the alert is related to a sales transaction. See the corresponding <b>Alert.SoldAlert</b> value for more information on the alert.
This enumeration value indicates that the alert is related to the seller's inventory. See the corresponding <b>Alert.InventoryAlert</b> value for more information on the alert.
This enumeration value indicates that the alert is related to an Selling Manager automation alert. See the corresponding <b>Alert.AutomationAlert</b> value for more information on the alert.
This enumeration value is no longer applicable, so should not get returned.
This enumeration value indicates that the alert is related to either one of the following: negative feedback received; a bad email template, or an unpaid item dispute requires attention. See the corresponding <b>Alert.GeneralAlert</b> value for more information on the alert.
(out) Reserved for internal or future use.
Defines the options available for an Automated Listing Rule that
keeps a fixed number of items on the site
The day of the week on which items should be listed.
GetSellingManagerTemplateAutomationRule
Conditionally
GetSellingManagerItemAutomationRule
SetSellingManagerItemAutomationRule
Conditionally
SetSellingManagerTemplateAutomationRule
No
SetSellingManagerTemplateAutomationRule
Conditionally
DeleteSellingManagerItemAutomationRule
Conditionally
DeleteSellingManagerTemplateAutomationRule
Conditionally
The number of weeks between rule executions.
GetSellingManagerTemplateAutomationRule
GetSellingManagerItemAutomationRule
SetSellingManagerItemAutomationRule
Conditionally
SetSellingManagerTemplateAutomationRule
No
SetSellingManagerTemplateAutomationRule
Conditionally
DeleteSellingManagerItemAutomationRule
Conditionally
DeleteSellingManagerTemplateAutomationRule
Conditionally
The time at which items should be listed.
GetSellingManagerTemplateAutomationRule
Conditionally
GetSellingManagerItemAutomationRule
SetSellingManagerItemAutomationRule
Conditionally
SetSellingManagerTemplateAutomationRule
No
SetSellingManagerTemplateAutomationRule
Conditionally
DeleteSellingManagerItemAutomationRule
Conditionally
DeleteSellingManagerTemplateAutomationRule
Conditionally
The date from which the rule is active.
GetSellingManagerItemAutomationRule
GetSellingManagerTemplateAutomationRule
SetSellingManagerItemAutomationRule
Conditionally
SetSellingManagerTemplateAutomationRule
No
SetSellingManagerTemplateAutomationRule
Conditionally
DeleteSellingManagerItemAutomationRule
Conditionally
DeleteSellingManagerTemplateAutomationRule
Conditionally
The date after which the rule is disabled.
GetSellingManagerTemplateAutomationRule
Conditionally
GetSellingManagerItemAutomationRule
SetSellingManagerItemAutomationRule
Conditionally
SetSellingManagerTemplateAutomationRule
No
SetSellingManagerTemplateAutomationRule
Conditionally
DeleteSellingManagerItemAutomationRule
Conditionally
DeleteSellingManagerTemplateAutomationRule
Conditionally
The number of current, listed items required for the rule to no longer be run.
GetSellingManagerItemAutomationRule
GetSellingManagerTemplateAutomationRule
SetSellingManagerItemAutomationRule
Conditionally
SetSellingManagerTemplateAutomationRule
No
SetSellingManagerTemplateAutomationRule
Conditionally
DeleteSellingManagerItemAutomationRule
Conditionally
DeleteSellingManagerTemplateAutomationRule
Conditionally
Sets a minimum inventory level for listings of associated products
to occur.
GetSellingManagerTemplateAutomationRule
Conditionally
GetSellingManagerItemAutomationRule
SetSellingManagerItemAutomationRule
Conditionally
SetSellingManagerTemplateAutomationRule
No
SetSellingManagerTemplateAutomationRule
Conditionally
DeleteSellingManagerItemAutomationRule
Conditionally
DeleteSellingManagerTemplateAutomationRule
Conditionally
Defines the options available for an automated listing rule that
keeps a minimum number of items on the site.
The minimum number of listings that should be active on the site.
GetSellingManagerTemplateAutomationRule
Conditionally
GetSellingManagerItemAutomationRule
Conditionally
SetSellingManagerItemAutomationRule
Conditionally
SetSellingManagerTemplateAutomationRule
No
SetSellingManagerTemplateAutomationRule
Conditionally
DeleteSellingManagerItemAutomationRule
Conditionally
DeleteSellingManagerTemplateAutomationRule
Conditionally
The start time of the time interval during which new listings should start.
GetSellingManagerTemplateAutomationRule
Conditionally
GetSellingManagerItemAutomationRule
Conditionally
SetSellingManagerItemAutomationRule
Conditionally
SetSellingManagerTemplateAutomationRule
No
SetSellingManagerTemplateAutomationRule
Conditionally
DeleteSellingManagerItemAutomationRule
Conditionally
DeleteSellingManagerTemplateAutomationRule
Conditionally
The end time of the time interval during which new listings should start.
GetSellingManagerTemplateAutomationRule
Conditionally
GetSellingManagerItemAutomationRule
Conditionally
SetSellingManagerItemAutomationRule
Conditionally
SetSellingManagerTemplateAutomationRule
No
SetSellingManagerTemplateAutomationRule
Conditionally
DeleteSellingManagerItemAutomationRule
Conditionally
DeleteSellingManagerTemplateAutomationRule
Conditionally
Provides a number of minutes for spacing start times of listings.
Used when you list multiple items at the same time. Delays subsequent
listings by the specified number of minutes.
GetSellingManagerTemplateAutomationRule
Conditionally
GetSellingManagerItemAutomationRule
Conditionally
SetSellingManagerItemAutomationRule
Conditionally
SetSellingManagerTemplateAutomationRule
No
SetSellingManagerTemplateAutomationRule
Conditionally
DeleteSellingManagerItemAutomationRule
Conditionally
DeleteSellingManagerTemplateAutomationRule
Conditionally
Sets a minimum inventory level for listings of associated products
to occur.
GetSellingManagerTemplateAutomationRule
Conditionally
GetSellingManagerItemAutomationRule
Conditionally
SetSellingManagerItemAutomationRule
Conditionally
SetSellingManagerTemplateAutomationRule
No
SetSellingManagerTemplateAutomationRule
Conditionally
DeleteSellingManagerItemAutomationRule
Conditionally
DeleteSellingManagerTemplateAutomationRule
Conditionally
Provides information about an automated listing rule.
Automated listing rules cannot be combined with automated relisting rules.
A template can have one set of information per automated listing rule specified.
The source template ID for the rule that was retrieved.
In the case of automated listing rules retrieved for an item, even if the item
does not have an associated automation rule, an automated listing rule is
inherited from the source template.
GetSellingManagerTemplateAutomationRule
Conditionally
GetSellingManagerItemAutomationRule
Conditionally
SetSellingManagerItemAutomationRule
Conditionally
SetSellingManagerTemplateAutomationRule
No
SetSellingManagerTemplateAutomationRule
Conditionally
DeleteSellingManagerItemAutomationRule
Conditionally
DeleteSellingManagerTemplateAutomationRule
Conditionally
Specifies an automated listing rule that keeps a minimum number of listings on the site.
GetSellingManagerTemplateAutomationRule
Conditionally
GetSellingManagerItemAutomationRule
Conditionally
SetSellingManagerItemAutomationRule
Conditionally
SetSellingManagerTemplateAutomationRule
No
SetSellingManagerTemplateAutomationRule
Conditionally
DeleteSellingManagerItemAutomationRule
Conditionally
DeleteSellingManagerTemplateAutomationRule
Conditionally
Specifies an automated listing rule that lists items according to a specified schedule.
GetSellingManagerTemplateAutomationRule
Conditionally
GetSellingManagerItemAutomationRule
Conditionally
SetSellingManagerItemAutomationRule
Conditionally
SetSellingManagerTemplateAutomationRule
No
SetSellingManagerTemplateAutomationRule
Conditionally
DeleteSellingManagerItemAutomationRule
Conditionally
DeleteSellingManagerTemplateAutomationRule
Conditionally
Enumerated type that defines the values that control how soon the item is relisted after the original listing ends.
If this value is set, the item is relisted immediately after the original listing ends.
If this value is set, the item is relisted after a specified number of days and/or hours. If this value is set, the <b>RelistAfterDays</b> and/or the <b>RelistAfterHours</b> fields must also be set.
If this value is set, the item is relisted at a specific time of day, either the day when the listing ends (if the specified time has not passed), or the day after (if the specified time has already passed on that day). If this value is set, the <b>RelistAtSpecificTimeOfDay</b> field must also be set.
(out) Reserved for internal or future use.
Provides information about an automated relisting rule.
Automated relisting rules cannot be combined with automated listing rules.
A template can have one set of information per automated relisting rule specified.
The type of auto-relist rule for the item.
GetSellingManagerTemplateAutomationRule
Conditionally
GetSellingManagerItemAutomationRule
Conditionally
SetSellingManagerTemplateAutomationRule
No
SetSellingManagerTemplateAutomationRule
Conditionally
SetSellingManagerItemAutomationRule
No
SetSellingManagerItemAutomationRule
Conditionally
DeleteSellingManagerItemAutomationRule
Conditionally
DeleteSellingManagerTemplateAutomationRule
Conditionally
The condition under which relist occurs.
GetSellingManagerTemplateAutomationRule
Conditionally
GetSellingManagerItemAutomationRule
Conditionally
SetSellingManagerTemplateAutomationRule
No
SetSellingManagerTemplateAutomationRule
Conditionally
SetSellingManagerItemAutomationRule
No
SetSellingManagerItemAutomationRule
Conditionally
DeleteSellingManagerItemAutomationRule
Conditionally
DeleteSellingManagerTemplateAutomationRule
Conditionally
Used when RelistCondition equals RelistAfterDaysHours; specifies
the number days after the item ends that it should be relisted.
GetSellingManagerTemplateAutomationRule
Conditionally
GetSellingManagerItemAutomationRule
Conditionally
SetSellingManagerTemplateAutomationRule
No
SetSellingManagerTemplateAutomationRule
Conditionally
SetSellingManagerItemAutomationRule
No
SetSellingManagerItemAutomationRule
Conditionally
DeleteSellingManagerItemAutomationRule
Conditionally
DeleteSellingManagerTemplateAutomationRule
Conditionally
Used when RelistCondition equals RelistAfterDaysHours; specifies
the number hours after the item ends that it should be relisted.
GetSellingManagerTemplateAutomationRule
Conditionally
GetSellingManagerItemAutomationRule
Conditionally
SetSellingManagerTemplateAutomationRule
No
SetSellingManagerTemplateAutomationRule
Conditionally
SetSellingManagerItemAutomationRule
No
SetSellingManagerItemAutomationRule
Conditionally
DeleteSellingManagerItemAutomationRule
Conditionally
DeleteSellingManagerTemplateAutomationRule
Conditionally
Used when RelistCondition equals RelistAtSpecificTimeOfDay; specifies the time
of day the item should be relisted.
GetSellingManagerTemplateAutomationRule
Conditionally
GetSellingManagerItemAutomationRule
Conditionally
SetSellingManagerTemplateAutomationRule
Conditionally
SetSellingManagerItemAutomationRule
No
SetSellingManagerItemAutomationRule
Conditionally
DeleteSellingManagerItemAutomationRule
Conditionally
DeleteSellingManagerTemplateAutomationRule
Conditionally
Specifies whether Best Offer should be enabled on the auto-relisted item.
GetSellingManagerTemplateAutomationRule
Conditionally
GetSellingManagerItemAutomationRule
Conditionally
SetSellingManagerTemplateAutomationRule
No
SetSellingManagerTemplateAutomationRule
Conditionally
SetSellingManagerItemAutomationRule
No
SetSellingManagerItemAutomationRule
Conditionally
DeleteSellingManagerItemAutomationRule
Conditionally
DeleteSellingManagerTemplateAutomationRule
Conditionally
Specifies that item is not listed if inventory levels on the associated
product are at or below the specified level.
GetSellingManagerTemplateAutomationRule
Conditionally
GetSellingManagerItemAutomationRule
Conditionally
SetSellingManagerTemplateAutomationRule
No
SetSellingManagerTemplateAutomationRule
Conditionally
SetSellingManagerItemAutomationRule
No
SetSellingManagerItemAutomationRule
Conditionally
DeleteSellingManagerItemAutomationRule
Conditionally
DeleteSellingManagerTemplateAutomationRule
Conditionally
Specifies the type of auto relist that will be performed.
If the item is unsold, relist the item once.
Relist the item continuously, until it is sold.
Relist the item continuously.
(out) Reserved for internal or future use.
Defines the options available for an automated
Second Chance Offer rule.
The condition under which a Second Chance Offer should be sent.
SetSellingManagerItemAutomationRule
No
SetSellingManagerItemAutomationRule
Conditionally
GetSellingManagerTemplateAutomationRule
Conditionally
GetSellingManagerItemAutomationRule
Conditionally
SetSellingManagerTemplateAutomationRule
No
SetSellingManagerTemplateAutomationRule
Conditionally
DeleteSellingManagerItemAutomationRule
Conditionally
DeleteSellingManagerTemplateAutomationRule
Conditionally
Used when SecondChanceOfferCondition is equal to
BidsGreaterThanAmount or BidsGreaterThanCostPlusAmount. Specifies
the amount associated with the SecondChanceOfferCondition.
SetSellingManagerItemAutomationRule
No
SetSellingManagerItemAutomationRule
Conditionally
GetSellingManagerTemplateAutomationRule
Conditionally
GetSellingManagerItemAutomationRule
Conditionally
SetSellingManagerTemplateAutomationRule
No
SetSellingManagerTemplateAutomationRule
Conditionally
DeleteSellingManagerItemAutomationRule
Conditionally
DeleteSellingManagerTemplateAutomationRule
Conditionally
Used when SecondChanceOfferCondition is equal
to BidsGreaterThanCostPlusPercentage to specify the amount of profit
associated with the SecondChanceOfferCondition.
SetSellingManagerItemAutomationRule
No
SetSellingManagerItemAutomationRule
Conditionally
GetSellingManagerTemplateAutomationRule
Conditionally
GetSellingManagerItemAutomationRule
Conditionally
SetSellingManagerTemplateAutomationRule
No
SetSellingManagerTemplateAutomationRule
Conditionally
DeleteSellingManagerItemAutomationRule
Conditionally
DeleteSellingManagerTemplateAutomationRule
Conditionally
Specifies the length of time the Second Chance Offer listing will be active.
The recipient bidder has that much time to purchase the item or the offer expires.
SetSellingManagerItemAutomationRule
No
SetSellingManagerItemAutomationRule
Conditionally
GetSellingManagerTemplateAutomationRule
Conditionally
GetSellingManagerItemAutomationRule
Conditionally
SetSellingManagerTemplateAutomationRule
No
SetSellingManagerTemplateAutomationRule
Conditionally
DeleteSellingManagerItemAutomationRule
Conditionally
DeleteSellingManagerTemplateAutomationRule
Conditionally
Do not list if inventory levels on the associated product
are at or below the specified amount.
SetSellingManagerItemAutomationRule
No
SetSellingManagerItemAutomationRule
Conditionally
GetSellingManagerTemplateAutomationRule
Conditionally
GetSellingManagerItemAutomationRule
Conditionally
SetSellingManagerTemplateAutomationRule
No
SetSellingManagerTemplateAutomationRule
Conditionally
DeleteSellingManagerItemAutomationRule
Conditionally
DeleteSellingManagerTemplateAutomationRule
Conditionally
SellingManagerAutoSecondChanceOfferTypeCodeType - Specifies the type of Second Chance Offer automation rule that will be added to an item.
Sends a Second Chance Offer to all bidders who bid more than a specific amount.
Sends a Second Chance Offer to all bidders who bid more than the cost plus a specific amount.
Sends a Second Chance Offer to all bidders who bid more than the cost plus a specific percentage.
(out) Reserved for internal or future use.
Indicates the filters for Selling Manager automation listings.
Item failed to be listed using automation rules.
Relist item automation rule failed.
Item failed to be listed with Second Chance offer automation rule.
(out) Reserved for internal or future use.
Contains list of Email log.
Specifies the type of Selling Manager email.
GetSellingManagerEmailLog
Always
Template name of the custom email.
GetSellingManagerEmailLog
Conditionally
Success or failure state of this email.
GetSellingManagerEmailLog
Always
Date on which this email event occurred.
GetSellingManagerEmailLog
Always
Specifies the Selling Manager email status.
Email sent successfully.
Sending of email failed.
Email is not yet sent and is in Queue.
(out) Reserved for internal or future use.
Specifies the Selling Manager email type enumeration values.
Email logged manually. For example, the seller manually adds an entry to
track email sent to a buyer offline.
Winning Buyer Notification.
Payment Reminder emails.
Payment received notification.
Request shipping address email.
Feedback Reminder emails.
Shipment sent email.
Personalized emails.
Invoice notification emails.
Custom email template 1.
Custom email template 2.
Custom email template 3.
Custom email template 4.
Custom email template 5.
Custom email template 6.
Custom email template 7.
Custom email template 8.
Custom email template 9.
Custom email template 10.
Custom email template 11.
Custom email template 12.
Custom email template 13.
Custom email template 14.
Custom email template 15.
Custom email template 16.
Custom email template 17.
Custom email template 18.
Custom email template 19.
Custom email template 20.
(out) Reserved for internal or future use.
Contains information about a Selling Manager folder.
Unique ID of the folder. Originally returned in the AddSellingManagerInventoryFolder response.
GetSellingManagerInventoryFolder
ReviseSellingManagerInventoryFolder
Always
GetSellingManagerInventoryFolder
ReviseSellingManagerInventoryFolder
Yes
ReviseSellingManagerProduct
No
Unique ID of the parent folder. If it exists, it is returned.
ReviseSellingManagerInventoryFolder
No
GetSellingManagerInventoryFolder
Conditionally
Level of this folder in the folder tree hierarchy. Root folder is at level 1.
ReviseSellingManagerInventoryFolder
No
GetSellingManagerInventoryFolder
Always
Name assigned to the folder by the user in the AddSellingManagerInventoryFolder or
the ReviseSellingManagerInventoryFolder call.
ReviseSellingManagerInventoryFolder
Yes
GetSellingManagerInventoryFolder
ReviseSellingManagerInventoryFolder
Always
Comments associated with the folder. Returned if it exists.
GetSellingManagerInventoryFolder
ReviseSellingManagerInventoryFolder
Conditionally
Container for sub-folder information. Returned if requested.
GetSellingManagerInventoryFolder
ReviseSellingManagerInventoryFolder
Conditionally
Date when this folder was created.
ReviseSellingManagerInventoryFolder
GetSellingManagerInventoryFolder
Always
Container for other alerts for Selling Manager.
Items that received negative feeback.
Unpaid item disputes require your response.
Emails not set because of HTML or active content.
(out) Reserved for internal or future use.
Indicates the filters for Selling Manager Inventory listings.
Products which are out of stock.
Products that are active.
Products that are inactive.
Products low on inventory.
Products with listings.
Products without listings.
(out) Reserved for internal or future use.
This type contains details on the status of an order.
Indicates the current status of the checkout flow for the order.
GetSellingManagerSaleRecord
GetSellingManagerSoldListings
Conditionally
The paid status of the order.
GetSellingManagerSaleRecord
GetSellingManagerSoldListings
Conditionally
ReviseSellingManagerSaleRecord
No
The shipped status of the order.
GetSellingManagerSaleRecord
GetSellingManagerSoldListings
Conditionally
ReviseSellingManagerSaleRecord
No
The success or failure of a buyer's online payment.
GetSellingManagerSaleRecord
Conditionally
Unique identifier of the PayPal transaction for the order.
GetSellingManagerSaleRecord
Conditionally
The payment method the buyer selected for paying the seller
for the order. If checkout is incomplete,
PaymentMethodUsed is set to whatever the buyer selected as his
or her preference on the Review Your Purchase page.
GetSellingManagerSaleRecord
GetSellingManagerSoldListings
Conditionally
ReviseSellingManagerSaleRecord
No
The type of feedback received (if feedback was received).
GetSellingManagerSaleRecord
GetSellingManagerSoldListings
Conditionally
Whether the seller has left feedback.
GetSellingManagerSaleRecord
GetSellingManagerSoldListings
Conditionally
The total emails sent.
GetSellingManagerSaleRecord
GetSellingManagerSoldListings
Conditionally
Contains the current status of a hold on a PayPal payment.
The payment hold that is referred to as a "payment review" hold
results from a possible issue with a buyer.
The payment hold referred to as
a "merchant hold" results from a possible issue with a seller.
For more information, please see the link below.
PayPal Holds on Payments
https://developer.ebay.com/DevZone/guides/features-guide/default.html#Development/Sales-Checkouts.html#PayPalHoldsonPayments
GetSellingManagerSaleRecord
GetSellingManagerSoldListings
Conditionally
The custom invoice number.
GetSellingManagerSaleRecord
Conditionally
The date on which the seller marks the item as shipped, either set by default as
the date date the item was marked shipped or set explicitly by the seller using
the Edit Sales Record page. Note that sellers have the ability to set this value
up to 3 calendar days in the future.
GetSellingManagerSaleRecord
GetSellingManagerSoldListings
Conditionally
Date on which the order was paid.
GetSellingManagerSaleRecord
GetSellingManagerSoldListings
Conditionally
The time that the last email was sent.
GetSellingManagerSaleRecord
Conditionally
The time the invoice was sent. This is a seller-entered value for VAT-enabled
sites. It is returned only for business sellers in VAT-enabled sites.
GetSellingManagerSaleRecord
Conditionally
Indicates whether the order can be paid for through a payment gateway
(Payflow) account. If <b>IntegratedMerchantCreditCardEnabled</b> is <code>true</code>, then
integrated merchant credit card (IMCC) is enabled for credit cards because
the seller has a payment gateway account. Therefore, if
<b>IntegratedMerchantCreditCardEnabled</b> is <code>true</code>, and AmEx, Discover, or VisaMC
is returned for an item, then on checkout, an online credit-card payment is
processed through a payment gateway account. A payment gateway account is
used by sellers to accept online credit cards (Visa, MasterCard, American
Express, and Discover).
<br><br>
<span class="tablenote"><b>Note: </b>
Beginning on May 1, 2019, eBay will no longer support electronic payments through Integrated Merchant Credit Card accounts. To accept online credit card payments from buyers, a seller must use specify PayPal as an accepted payment method, or opt in to eBay Managed Payments program (if the program is available to that seller).
</span>
GetSellingManagerSaleRecord
GetSellingManagerSoldListings
Conditionally
Mark paid status type.
The status of the order is "paid."
The status of the order is "partially paid."
The status of the order is "unpaid."
The status of the order is "pending."
The status of the order is "refunded."
(out) Reserved for internal or future use.
Container for the PaisaPay alert types.
PaisaPay items awaiting shipment.
PaisaPay items for which time extension requests are rejected by the buyers.
PaisaPay items for which the item receipt has not yet been confirmed by the buyer or not
yet been auto-confirmed by the system.
PaisaPay items for which buyers have filed "Item not received".
PaisaPay items for which the seller has requested a time extension to enter the
shipping information.
(out) Reserved for internal or future use.
Returned if the user is a Selling Manager user. Defines product information for Selling Manager users.
The name of a Selling Manager product. The AddSellingManagerProduct call is used to create a
Selling Manager product.
ReviseSellingManagerProduct
No
GetItemTransactions
GetSellerTransactions
Conditionally
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
AddSellingManagerTemplate
GetSellingManagerTemplates
GetSellingManagerInventory
ReviseSellingManagerProduct
ReviseSellingManagerTemplate
Always
The ID of a Selling Manager product. When you call AddSellingManagerProduct, a product ID is
returned for the product created. When you use this ID to make subsequent calls, such as
AddSellingManagerTemplate, the ProductID you provide on input is returned in the output.
ReviseSellingManagerProduct
Yes
AddSellingManagerProduct
AddSellingManagerTemplate
DeleteSellingManagerProduct
GetSellingManagerTemplates
GetSellingManagerInventory
ReviseSellingManagerProduct
ReviseSellingManagerTemplate
Always
Custom label of this product.
AddSellingManagerProduct
ReviseSellingManagerProduct
No
AddSellingManagerProduct
DeleteSellingManagerProduct
GetSellingManagerTemplates
GetSellingManagerInventory
ReviseSellingManagerProduct
Conditionally
ReviseSellingManagerTemplate
Always
Quantity of items in the seller's inventory for this product.
AddSellingManagerProduct
ReviseSellingManagerProduct
No
AddSellingManagerProduct
AddSellingManagerTemplate
GetSellingManagerTemplates
GetSellingManagerInventory
ReviseSellingManagerProduct
Always
ReviseSellingManagerTemplate
Always
Cost of each item of this product.
AddSellingManagerProduct
ReviseSellingManagerProduct
No
GetSellingManagerTemplates
GetSellingManagerInventory
ReviseSellingManagerTemplate
Always
AddSellingManagerProduct
ReviseSellingManagerProduct
Conditionally
ID of the inventory folder that contains the product. Value is initially returned in
the AddSellingManagerInventoryFolder response.
GetSellingManagerInventory
Always
ReviseSellingManagerTemplate
Always
Specifies whether a restock alert is triggered for the product or not.
GetSellingManagerInventory
GetSellingManagerInventory
ReviseSellingManagerProduct
Conditionally
ReviseSellingManagerTemplate
Always
ReviseSellingManagerProduct
No
Specifies the quantity at which a restock alert should be triggered.
GetSellingManagerInventory
ReviseSellingManagerProduct
ReviseSellingManagerTemplate
GetSellingManagerTemplates
GetSellingManagerInventory
Conditionally
ReviseSellingManagerProduct
No
Primary vendor information. Vendor information is returned only if it has been
set.
GetSellingManagerInventory
GetSellingManagerTemplates
GetSellingManagerInventory
ReviseSellingManagerTemplate
Conditionally
Seller's note about this product.
GetSellingManagerInventory
Conditionally
GetSellingManagerTemplates
ReviseSellingManagerTemplate
Always
Describes the inventory status of a specific Selling Manager Product
Quantity of products scheduled to be listed.
GetSellingManagerInventory
Conditionally
Quantity of products actively listed.
GetSellingManagerInventory
Conditionally
Quantity of products sold.
GetSellingManagerInventory
Conditionally
Quantity of product unsold.
GetSellingManagerInventory
Conditionally
Percentage of ended listings that sold.
GetSellingManagerInventory
Conditionally
Average selling price for the product.
GetSellingManagerInventory
Conditionally
Sorting specifications for retrieved Selling Manager Inventory products.
Sort products by by quantity currently listed.
Sort unlisted products by availability to list.
Sort by average price of sold items.
Sort by average unit cost of items.
Sort products by label.
Sort by product name.
Sort by submitted date.
Sort by quantity scheduled to be listed.
Sort by quantity sold.
Sort by the percentage of ended listings that had a sale.
Sort by number of unsold items.
Sort products by folder name.
This type is used by the <b>AddSellingManagerProduct</b> and <b>ReviseSellingManagerProduct</b> calls to add/revise listing-level Item Specifics and/or to define multiple variations for a new or existing Selling Manager Product record.
<br><br>
This type is also used by the respone of the <b>GetSellingManagerInventory</b> call.
This optional field sets the primary eBay listing category for the Selling Manager Product. If the primary eBay listing category ID is not specified with <b>AddSellingManagerProduct</b> or <b>ReviseSellingManagerProduct</b> call, the seller can pass in this information with a subsequent <b>AddSellingManagerTemplate</b> call.
<br><br>
The <b>GetSuggestedCategories</b> or <b>GetCategories</b> call can be used to retrieve eBay leaf category IDs.
<br><br>
This field is returned in a <b>GetSellingManagerInventory</b> call
only if it is defined for the Selling Manager Product.
AddSellingManagerProduct
ReviseSellingManagerProduct
No
GetSellingManagerInventory
Conditionally
This container is used to define/revise multiple variations for a new or existing Selling Manager Product record. This container is only applicable if the new or existing Selling Manager Product record will ultimately be converted to a multiple-variation, fixed-price listing on an eBay Marketplace.
<br><br>
Note that Item Specifics that all product variations share are actually set in the <b>ItemSpecifics</b> container, the <b>Variations.Pictures</b> container is used to specify URLs for all pictures that will end up in the listing, the <b>Variations.VariationSpecificsSet</b> container is used to set all available options for the aspects that all product variations share (such as 'Color' and 'Size'), and a <b>Variations.Variation</b> container is need to define each variation, including its defining aspects (such as 'Blue, Large'), quantity available, price, SKU value (if applicable) and any eBay Product ID (ePID) or GTIN (UPC, EAN, ISBN) value asssociated with the variation.
<br><br>
Not all eBay listing categories support multiple-variation listings, so it might be a good idea to run a <b>GetCategoryFeatures</b> call on one or more categories, and include a <b>FeatureID</b> filter set to a value of <code>ItemSpecificsEnabled</code>. If the listing category supports multiple-variation listings, a <code>ItemSpecificsEnabled</code> tag will get returned for the category with a value of <code>Enabled</code>.
<br><br>
This container is returned in a <b>GetSellingManagerInventory</b> call only if variations are defined in the Selling Manager Product.
AddSellingManagerProduct
No
ReviseSellingManagerProduct
Conditionally
GetSellingManagerInventory
Conditionally
This container is used to define/revise listing-level Item Specifics for a single-variation or multiple-variation listing. Item Specifics give sellers a structured way to describe details of their items through name-value pairs.
<br><br>
Each Item Specific requires its own <b>ItemSpecifics.NameValueList</b> container, and it is possible that a single Item Specific can more than one applicable value. An example of this would be a 'Features' Item Specific. A product can have multiple features, hence multiple features can be passed in through multiple <b>ItemSpecifics.NameValueList.Value</b> fields.
<br><br>
Many listing categories have mandatory Item Specifics, and just about all listing categories have recommended Item Specifics. To retrieve mandatory and recommended Item Specifics for a category, the <b>GetCategorySpecifics</b> call can be used.
<br><br>
This container is returned in a <b>GetSellingManagerInventory</b> call only if Item Specifics are defined for the Selling Manager Product.
AddSellingManagerProduct
No
ReviseSellingManagerProduct
No
GetSellingManagerInventory
Conditionally
Describes a Selling Manager Product
Container for information about the product.
GetSellingManagerInventory
Conditionally
Contains the list of the seller's templates contained in the product, one
SellingManagerTemplateType object per template.
GetSellingManagerInventory
Conditionally
Container for statistics about the product.
GetSellingManagerInventory
Conditionally
Specifies an eBay category associated with the product,
defines Item Specifics that are relevant to the product,
and defines variations available for the product
(which may be used to create multivariation listings).
GetSellingManagerInventory
Conditionally
For searches of Selling Manager listings, specifies search type, such as <b>ProductID</b> or <b>BuyerUserID</b>,
and search value.
Specifies the type of value, such as <b>ProductID</b> or <b>BuyerUserID</b>, for the search.
GetSellingManagerSoldListings
GetSellingManagerInventory
No
String identifying the value, matching the <b>SearchType</b>, that the search should return listings
for. For example, when <b>ProductID</b> is specified as the <b>SearchType</b>, <b>SearchValue</b> must be a valid
<b>ProductID</b>.
GetSellingManagerSoldListings
GetSellingManagerInventory
No
Specifies search term types for Selling Manager listings.
Search for listings based on Buyer ID.
Search for listings based on Buyers email.
Search for listings based on Buyers full name.
Search for listings based on ItemID.
Search for listings based on Item Title.
Search for listings based on Product ID.
Search for listings based on Product Name.
Search for listings based on SKU.
Search for listings based on the sale record ID.
<br/><br/>
When an item is sold, Selling Manager generates a sale record.
A sale record contains buyer information, shipping, and other information.
A sale record is displayed in the Sold view in Selling Manager.
<br/><br/>
In the following calls,
the value for the sale record ID is in the <b>SellingManagerSalesRecordNumber</b> field:
<b>GetItemTransactions</b>, <b>GetSellerTransactions</b>, <b>GetOrders</b>, <b>GetOrderTransactions</b>.
In the Selling Manager calls, the value for the sale record ID is in the
<b>SaleRecordID</b> field. The sale record ID can be for a single or multiple line item order.
<br/><br/>
For orders that occurred within the last 30 days, passing only the <b>SaleRecordID </b> into the <b>GetSellingManagerSoldListings</b>
request will return the sale record. However, for sales that occurred more than 30 days ago, the <b>SaleDateRange</b> container
must also be used, passing in a date range that includes the date on which the specific sale occurred.
Reserved for internal or future use.
Contains values for shipped status.
The shipped status is "shipped."
The shipped status is "unshipped."
(out) Reserved for internal or future use.
Indicates the filters for Selling Manager sold listings.
Item is not paid and not shipped.
Item is paid but not shipped.
Item is paid but not shipped.
Item is paid for and is shipped.
An alert has been issued about a listing that is paid with no feedback left.
Payment Reminder emails not sent due to system error.
Payment received notification not sent due to system error.
Request shipping address emails not sent due to system error.
Request shipping address emails not sent due to system error.
Personalized emails not sent due to system error.
Winning Buyer Notification not sent due to system error.
Final value fee credit requests can be filed.
If true, indicates that the PayPal Payment Received alert has been issued.
Automated feedback message is not sent.
Feedback Reminder emails not sent due to system error.
Item is not shipped.
Listing eligible for unpaid item reminder
Escrow status is Cancelled.
Escrow status is Completed.
Escrow status is Initiated.
Escrow status is in refund state.
Item is shipped and Escrow status is in Release payment.
Payment is confirmed and item can be shipped to buyer.
All Escrow states.
Item is shipped and feedback is not yet received.
New international sale.
Charity filter.
Payment is overdue.
Payment is done with PaisaPay Escrow.
Failed to send custom email template 1.
Failed to send custom email template 2.
Failed to send custom email template 3.
Failed to send custom email template 4.
Failed to send custom email template 5.
Failed to send custom email template 6.
Failed to send custom email template 7.
Failed to send custom email template 8.
Failed to send custom email template 9.
Failed to send custom email template 10.
Failed to send custom email template 11.
Failed to send custom email template 12.
Failed to send custom email template 13.
Failed to send custom email template 14.
Failed to send custom email template 15.
Failed to send custom email template 16.
Failed to send custom email template 17.
Failed to send custom email template 18.
Failed to send custom email template 19.
Failed to send custom email template 20.
Reserved for future use. If a buyer requests to return an item, the seller's response is required.
(out) Reserved for internal or future use.
SellingManagerSoldListingsSortType - Specifies the fields that can be used to sort the listings.
Sorts listings by sales Record ID.
Sorts listings by Buyer email or ID.
Sorts listings by sale format.
Sorts listings by Custom label.
Sorts listings by Total Price.
Sorts listings by Sale Date.
Sorts listings by Paid Date.
Sorts listings by Emails sent.
Sorts listings by Checkout status.
Sorts by Paid status.
Sorts by Shipped state.
Sorts by feedback left.
Sorts by FeedbackReceived.
Sorts by Shipped Date.
Sorts by buyer Postal code.
Sorts by Days since sale.
Sort by Start price.
Sort by ReservePrice.
Sorts by Sold site.
Sorts by Shipping cost.
Sorts by Listed site.
(out) Reserved for internal or future use.
Contains information about a sale record.
Information about one line item in the order.
GetSellingManagerSaleRecord
GetSellingManagerSoldListings
Always
Shipping address of a buyer.
GetSellingManagerSaleRecord
GetSellingManagerSoldListings
Always
ReviseSellingManagerSaleRecord
No
The shipping-related details for an order,
including flat and calculated shipping costs and shipping insurance costs.
GetSellingManagerSaleRecord
GetSellingManagerSoldListings
Always
ReviseSellingManagerSaleRecord
No
The cost of cash-on-delivery.
GetSellingManagerSaleRecord
GetSellingManagerSoldListings
Conditionally
ReviseSellingManagerSaleRecord
No
Total cost in the order.
GetSellingManagerSaleRecord
GetSellingManagerSoldListings
Always
Total item quantity.
GetSellingManagerSoldListings
Always
GetSellingManagerSaleRecord
Conditionally
A SMPro seller can record the cost of the item, as calculated by the seller, in
this field.
GetSellingManagerSaleRecord
GetSellingManagerSoldListings
Conditionally
ReviseSellingManagerSaleRecord
No
Rate of applicable value added tax.
GetSellingManagerSaleRecord
Conditionally
ReviseSellingManagerSaleRecord
No
Total cost of shipping insurance.
GetSellingManagerSaleRecord
Always
Amount of applicable value added tax insurance fee.
GetSellingManagerSaleRecord
Conditionally
VAT shipping fee.
GetSellingManagerSaleRecord
Conditionally
Total shipping fee.
GetSellingManagerSaleRecord
Conditionally
The seller records in this field a net total amount obtained according to the
seller's method of calculation. This field is returned for VAT transactions
only.
GetSellingManagerSaleRecord
Conditionally
VAT total amount.
GetSellingManagerSaleRecord
Conditionally
The shipping cost paid by the seller to ship the order line item.
<br/><br/>
For multiple line item orders, it is possible that one order line item will have the shipping cost and the value for the other order line item will be 0.00.
<br/><br/>
<span class="tablenote">
<strong>Note:</strong> This is different from the field of the same name returned by GetOrders and its related calls, which contains the shipping cost paid by the buyer.
</span>
GetSellingManagerSaleRecord
Always
ReviseSellingManagerSaleRecord
No
Discount, or charge, to which the buyer and seller have agreed.
If this value is a positive value,
the amount is the extra money that the buyer pays the seller.
If this value is a negative value,
the amount is a discount the seller gives the buyer.
GetSellingManagerSaleRecord
Always
ReviseSellingManagerSaleRecord
No
Notes from the seller to the buyer.
GetSellingManagerSaleRecord
Always
ReviseSellingManagerSaleRecord
No
Notes from the buyer to the seller.
GetSellingManagerSaleRecord
Conditionally
Notes to self from seller.
GetSellingManagerSaleRecord
Conditionally
ReviseSellingManagerSaleRecord
No
Status of the order regarding payment, shipping, feedback, and other
communications.
GetSellingManagerSoldListings
GetSellingManagerSaleRecord
Always
ReviseSellingManagerSaleRecord
No
The status of an unpaid item regarding final value, state of communications
between buyer and seller, and the filing of an Unpaid Item.
GetSellingManagerSoldListings
Always
GetSellingManagerSaleRecord
Conditionally
Amount of the accepted offer for the listing.
GetSellingManagerSoldListings
Always
GetSellingManagerSaleRecord
Conditionally
Number of emails sent regarding this order.
GetSellingManagerSaleRecord
Always
Number of days since the sale.
GetSellingManagerSoldListings
Always
GetSellingManagerSaleRecord
Conditionally
The user ID of the buyer.
GetSellingManagerSaleRecord
GetSellingManagerSoldListings
Always
The email of the buyer.
GetSellingManagerSaleRecord
GetSellingManagerSoldListings
Always
The sale record ID. Applicable to Selling Manager users.
When an item is sold, Selling Manager generates a sale record.
A sale record contains buyer information, shipping, and other information.
A sale record is displayed in the Sold view in Selling Manager.
Each sale record has a sale record ID. In the following calls,
the value for the sale record ID is in the SellingManagerSalesRecordNumber field:
GetItemTransactions, GetSellerTransactions, GetOrders, GetOrderTransactions.
In the Selling Manager calls, the value for the sale record ID is in the
SaleRecordID field. The sale record ID can be for single or multiple line item orders.
GetSellingManagerSoldListings
Always
GetSellingManagerSaleRecord
Conditionally
The sale date.
GetSellingManagerSoldListings
Always
GetSellingManagerSaleRecord
Conditionally
This field is no longer used.
This field is no longer used.
Contains information about a single line item (transaction) in an order created
through Selling Manager.
Seller's customized invoice number.
GetSellingManagerSaleRecord
Conditionally
Unique identifier for an eBay order line item. An order line
item is created once there is a commitment from a buyer to
purchase an item. Since an auction listing can only have one order line
item during the duration of the listing, the <b>TransactionID</b>
for auction listings is always 0. Along with its corresponding <b>ItemID</b>, a
<b>TransactionID</b> is used and referenced during an order checkout flow and
after checkout has been completed.
GetSellingManagerSoldListings
GetSellingManagerSaleRecord
Always
Unique identifier for a Selling Manager sale record. This field is created
at the same time as the order line item (transaction). A sale record is
displayed in the Sold view in Selling Manager and contains information on
the buyer and shipping. In the <b>GetItemTransactions</b>, <b>GetSellerTransactions</b>,
<b>GetOrders</b>, and <b>GetOrderTransactions</b> calls, the <b>SaleRecordID</b> value is
reflected in the <b>ShippingDetails.SellingManagerSalesRecordNumber</b> field.
<br/><br/>
For orders that occurred within the last 30 days, passing only the SaleRecordID into the GetSellingManagerSoldListings
request will return the sale record. However, for sales that occurred more than 30 days ago, the SaleDateRange container
must also be used, passing in a date range that includes the date on which the specific sale occurred.
GetSellingManagerSoldListings
GetSellingManagerSaleRecord
Always
Unique identifier for an eBay listing.
GetSellingManagerSoldListings
GetSellingManagerSaleRecord
Always
Total number of identical items sold in the order line item.
GetSellingManagerSoldListings
GetSellingManagerSaleRecord
Always
Price per item.
GetSellingManagerSaleRecord
Always
This value is calculated by multplying the <b>ItemPrice</b> value by the
<b>QuantitySold</b> value.
GetSellingManagerSaleRecord
Always
The title of the item listing.
80
GetSellingManagerSoldListings
GetSellingManagerSaleRecord
Always
The item listing type.
GetSellingManagerSoldListings
Conditionally
Boolean value indicating whether the item is a relisted item.
GetSellingManagerSoldListings
Conditionally
Number of users watching the item.
GetSellingManagerSoldListings
GetSellingManagerSoldListings
Conditionally
Start price of the item.
GetSellingManagerSoldListings
Conditionally
Reserve Price of the item (if a Reserve Price was set for the item).
GetSellingManagerSoldListings
Conditionally
Boolean value indicating whether or not a Second Chance offer was sent by
the seller to an eligible bidder.
GetSellingManagerSoldListings
Conditionally
Custom label associated with this order line item.
GetSellingManagerSoldListings
Conditionally
The platform on which the item was sold.
GetSellingManagerSoldListings
Conditionally
The platform on which the item was listed.
GetSellingManagerSoldListings
Conditionally
Container consisting of tracking information for the shipment.
GetSellingManagerSaleRecord
Conditionally
This field is returned as 'true' if the item is listed as a charity item.
GetSellingManagerSoldListings
Conditionally
In a fixed-priced listing, a seller can offer variations of the same item.
For example, the seller could create a fixed-priced listing for a t-shirt
design and offer the shirt in different colors and sizes. In this case, each
color and size combination is a separate variation. Each variation can have
a different quantity and price. Due to the possible price differentiation,
buyers can buy multiple items from this listing at the same time, but all of
the items must be of the same variation. One order line item is created
whether one or multiple items of the same variation are purchased.
<br><br>
The <b>Variation</b> node contains information about which variation was purchased.
Therefore, applications that process order line items should always check to see
if this node is present.
GetSellingManagerSoldListings
GetSellingManagerSaleRecord
Conditionally
A unique identifier for an eBay order line item. .
GetSellingManagerSoldListings
Always
GetSellingManagerSaleRecord
Always
Type used by the <strong>SellingManagerTemplateDetailsArray</strong> container that is returned in the <strong>GetSellingManagerInventory</strong> and <strong>GetSellingManagerTemplates</strong> calls. The <strong>SellingManagerTemplateDetailsArray</strong> container consists of one or more Selling Manager Templates that match the input criteria.
This container consists of detailed information for one Selling Manager Template.
<br/><br/>
<strong>For GetSellingManagerTemplates</strong>: A <strong>SellingManagerTemplateDetails</strong> container is returned for each Selling Manager Template that matches the input criteria.
<br/><br/>
<strong>For GetSellingManagerInventory</strong>: A <strong>SellingManagerTemplateDetails</strong> container is returned for each Selling Manager Template that is associated with the corresponding Selling Manager Product (if any).
GetSellingManagerTemplates
Always
GetSellingManagerInventory
Conditionally
Describes a Selling Manager Template
ID of the template.
GetSellingManagerTemplates
GetSellingManagerInventory
Always
Name of the template.
GetSellingManagerTemplates
GetSellingManagerInventory
Always
Success ratio.
GetSellingManagerTemplates
GetSellingManagerInventory
Always
The details of the product that this template belongs to.
GetSellingManagerTemplates
GetSellingManagerInventory
Always
ItemType object that contains the data for the specified template.
GetSellingManagerTemplates
GetSellingManagerInventory
Always
Describes vendor information.
Primary vendor name. Vendor information is returned only if it has been set.
AddSellingManagerTemplate
GetSellingManagerInventory
GetSellingManagerTemplates
ReviseSellingManagerTemplate
Conditionally
Contact information of vendor. Vendor information is returned only if it has been set.
AddSellingManagerTemplate
GetSellingManagerInventory
GetSellingManagerTemplates
ReviseSellingManagerTemplate
Conditionally
Contains various details about the current status of a listing. These
values are computed by eBay and cannot be specified at listing time.
Number of bids placed so far against the auction item.
GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
GranularityLevel: Fine
Variation
Conditionally
GetMyeBayBuying
BidList
LostList
WatchList
WonList
DeletedFromWonList
DeletedFromLostList
DetailLevel: none, ReturnAll
Conditionally
GetMyeBaySelling
ActiveList
UnsoldList
DeleteFromUnsoldList
BidList
Variations
DetailLevel: none, ReturnAll
Conditionally
GetBidderList
Always
GetItemTransactions
DetailLevel: none, ReturnAll, ItemReturnDescription
Item.SellingStatus
Conditionally
GetSellerTransactions
DetailLevel: none, ReturnAll, ItemReturnDescription
Conditionally
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Variation
Always
GetSellerEvents
DetailLevel: none, ReturnAll
Item
Conditionally
The minimum amount a progressive bid must be above the current high bid to be accepted. This field is only
applicable to auction listings. The value of this field will always be '0.00' for Classified Ad and fixed-price
listings.
GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
GranularityLevel: Fine
Variation
Conditionally
GetBidderList
Always
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Variation
Always
Converted value of the <b>CurrentPrice</b> in the currency of the site that
returned this response. For active items, refresh the listing's data every 24
hours to pick up the current conversion rates. Only returned when the item's
<b>CurrentPrice</b> on the listing site is in different currency than the currency of
the host site for the user/application making the API call. <b>ConvertedCurrentPrice</b>
is not returned for Classified listings (Classified listings are not available
on all sites).<br>
<br>
In multi-variation listings, this value matches the lowest-priced
variation that is still available for sale.
GetBidderList
GetDispute
PlaceOffer
Conditionally
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Variation
Conditionally
GetItemTransactions
DetailLevel: none, ReturnAll, ItemReturnDescription
Item.SellingStatus
Conditionally
GetSellerTransactions
DetailLevel: none, ReturnAll, ItemReturnDescription
Conditionally
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
GranularityLevel: Fine
Variation
Conditionally
GetMyeBayBuying
BestOfferList
BidList
LostList
WatchList
WonList
DeletedFromWonList
DeletedFromLostList
DetailLevel: none, ReturnAll
Conditionally
GetMyeBaySelling
ActiveList
BidList
ScheduledList
SoldList
UnsoldList
DeletedFromSoldList
DeletedFromUnsoldList
Variations
DetailLevel: none, ReturnAll
Conditionally
The current price of the item in the original listing currency.
<br><br>
For auction listings, this price is the starting minimum price (if the listing has no bids) or the current highest bid (if bids have been placed) for the item. This does not reflect the <b>BuyItNow</b> price.
<br><br>
For fixed-price and ad format listings, this is the current listing price.
<br><br>
In multi-variation, fixed-price listings, this value matches the lowest-priced variation that is still available for sale.
GetBidderList
GetDispute
PlaceOffer
Always
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Variation
Always
GetItemTransactions
DetailLevel: none, ReturnAll, ItemReturnDescription
Item.SellingStatus
Always
GetSellerTransactions
DetailLevel: none, ReturnAll, ItemReturnDescription
Always
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
GranularityLevel: Fine
Variation
Conditionally
GetMemberMessages
Conditionally
GetMyeBayBuying
BestOfferList
BidList
LostList
WatchList
WonList
DeletedFromWonList
DeletedFromLostList
DetailLevel: none, ReturnAll
Conditionally
GetMyeBaySelling
BidList
ActiveList
ScheduledList
SoldList
UnsoldList
DeletedFromSoldList
DeletedFromUnsoldList
Variations
DetailLevel: none, ReturnAll
Conditionally
GetSellerEvents
DetailLevel: none, ReturnAll
Item
Conditionally
For ended auction listings that have a winning bidder,
this field is a container for the high bidder's user ID.
For ended, single-item, fixed-price listings,
this field is a container for the user ID of the purchaser.
This field isn't returned for auctions with no bids, or for active fixed-price listings.
<br/><br/>
In the case of <b>PlaceOffer</b>, for auction listings,
this field is a container for the high bidder's user ID.
In the <b>PlaceOffer</b> response, the following applies:
For multiple-quantity, fixed-price listings,
the high bidder is only returned if there is just one order line item
(or only for the first order line item that is created).
PlaceOffer
Conditionally
GetBidderList
DetailLevel: ReturnAll
GranularityLevel: Medium
Variation
Conditionally
GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
GranularityLevel: Fine
Variation
Conditionally
GetItem
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Variation
Conditionally
GetMyeBayBuying
BidList
LostList
WatchList
DeletedFromLostList
DetailLevel: none, ReturnAll
Conditionally
GetMyeBaySelling
BidList
ActiveList
Variations
DetailLevel: none, ReturnAll
Conditionally
GetSellerEvents
DetailLevel: ReturnAll
Item
Conditionally
Applicable to Ad type listings only. Indicates how many leads to
potential buyers are associated with this item. Returns 0 (zero) for listings in other formats. You must be the seller of the item to retrieve the lead count.
GetSellerList
DetailLevel: ReturnAll
Variation
Conditionally
GetBidderList
Conditionally
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Variation
Conditionally
Smallest amount the next bid on the item can be. Returns same value as
<b>Item.StartPrice</b> (if no bids have yet been placed) or <b>CurrentPrice</b> plus
<b>BidIncrement</b> (if at least one bid has been placed). Only applicable to
auction listings. Returns null for fixed-price
and Ad type listings.
<br><br>
In multi-variation listings, this value matches the lowest-priced
variation that is still available for sale.
PlaceOffer
Conditionally
GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
GranularityLevel: Fine
Variation
Conditionally
GetBidderList
Always
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Variation
Always
The total number of items purchased so far (in the listing's lifetime).
Subtract this from <b>Quantity</b> to determine the quantity available.
<br><br>
If the listing has Item Variations,
then in <b>GetItem</b> (and related calls) and <b>GetItemTransactions</b>,
<b>Item.SellingStatus.QuantitySold</b> contains the sum of all quantities
sold across all variations in the listing, and <b>Variation.SellingStatus.QuantitySold</b> contains the number
of items sold for that variation.
<br/><br/>
In <b>GetSellerTransactions</b>,
<b>Transaction.Item.SellingStatus.QuantitySold</b> contains the number
of items sold in that order line item.<br>
<br>
For order line item calls, also see <b>Transaction.QuantityPurchased</b> for
the number of items purchased in the order line item.<br>
In multi-variation listings, this value matches total quantity sold
across all variations.
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ReturnAll, ItemReturnDescription
Always
GetBidderList
Always
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Always
GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
GranularityLevel: Fine
Item
Conditionally
GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
Variation
Conditionally
GetSellerEvents
DetailLevel: none, ReturnAll
Conditionally
GetMyeBaySelling
ActiveList
SoldList
UnsoldList
ScheduledList
DeletedFromSoldList
DeletedFromUnsoldList
DetailLevel: none, ReturnAll
Conditionally
Indicates whether the reserve price has been met for the listing. Returns
true if the reserve price was met or no reserve price was specified.
PlaceOffer
Conditionally
GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
GranularityLevel: Fine
Variation
Conditionally
GetMyeBayBuying
BidList
DetailLevel: none, ReturnAll
Conditionally
GetBidderList
Always
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Variation
Always
GetMyeBaySelling
ActiveList
BidList
ScheduledList
SoldList
UnsoldList
Variations
DetailLevel: none, ReturnAll
Conditionally
Part of the Second Chance Offer feature, indicates whether the seller can
extend a second chance offer for the item.
GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
GranularityLevel: Fine
Variation
Conditionally
GetBidderList
Always
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Variation
Always
Number of bidders for an item. Only applicable to auction listings.
Only returned for the seller of the item.
GetMyeBaySelling
ActiveList
UnsoldList
Variations
DetailLevel: none, ReturnAll
Conditionally
Specifies an active or ended listing's status in eBay's processing workflow.
<b></b>
<ul>
<li>If a listing ends with a sale (or sales), eBay needs to update the sale details
(e.g., total price and buyer/high bidder) and the final value fee. This processing
can take several minutes.</li>
<li>If you retrieve a sold item and no details about the buyer/high bidder
are returned or no final value fee is available, use this listing status information
to determine whether eBay has finished processing the listing.</li>
</ul>
GetAllBidders
GetBidderList
Always
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Variation
Always
GetItemTransactions
DetailLevel: none, ReturnAll, ItemReturnDescription
Item.SellingStatus
Always
GetSellerTransactions
DetailLevel: none, ReturnAll, ItemReturnDescription
Always
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
GranularityLevel: Fine
Variation
Conditionally
GetSellerEvents
Item
DetailLevel: none, ReturnAll
Conditionally
A seller is changed a Final Value Fee (FVF) when the item is sold, ends with a
winning bid, or is purchased. This fee applies whether or not the sale is completed with the buyer and
is generated before the buyer makes a payment.
<br/><br/>
The FVF is calculated using a percentage. This percentage is based on whether the seller has a
Store subscription or not. If a seller does have a Store subscription, the FVF is calculated based on
the level of that plan. For complete information about selling fees and eBay Store subscription plans, see the
<a href="http://www.feectr.ebay.com/feecenter/home">Fee Center Home Page</a>.
<br/><br/>
The Final Value Fee for each order line
item is returned by <b>GetSellerTransactions</b>, <b>GetItemTransactions</b>, <b>GetOrders</b>,
and <b>GetOrderTransactions</b>, regardless of the checkout status.
<br><br>
If a seller requests a Final Value Fee credit, the value of
<b>Transaction.FinalValueFee</b> will not change if a credit is
issued. The credit only appears in the seller's account data.
GetBidderList
Conditionally
GetItemTransactions
DetailLevel: none, ReturnAll, ItemReturnDescription
Item.SellingStatus
Conditionally
GetSellerTransactions
DetailLevel: none, ReturnAll, ItemReturnDescription
Conditionally
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
If a seller has reduced the price of a listed item with the Promotional Price Display feature,
this field contains the original price of the discounted item, along with the start-time
and end-time of the discount.
GetBidderList
Conditionally
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Variation
Conditionally
GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
Variation
Conditionally
GetMyeBayBuying
WatchList
DetailLevel: none, ReturnAll
Conditionally
GetMyeBaySelling
ActiveList
Variations
DetailLevel: none, ReturnAll
Conditionally
If included in the response as <code>true</code>, indicates that the listing was administratively
canceled due to a violation of eBay's listing policies and that the item can be relisted
using <b>RelistItem</b>.
<br/><br/>
<span class="tablenote"><b>Note: </b>
<b>GetItem</b> returns an error (invalid item ID)
in the response if <b>Item.SellingStatus.AdminEnded</b> = <code>true</code> and the requesting user is not the seller of the item.
</span>
GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
Variation
Conditionally
GetItem
GetSellingManagerTemplates
Variation
Conditionally
If this flag appears in the <b>GetItem</b> response, the auction has ended due to the
item being sold to a seller using the <b>Buy It Now</b> option.
This flag is not relevant for fixed-priced listings.
GetItem
Conditionally
Indicates the total quantity of items sold and picked up by buyers using the In-Store Pickup option. This value is the total number of items purchased by one or more buyers using the In-Store Pickup option, and is not the total number of In-Store Pickup orders. So, if two buyers selected the In-Store Pickup option, but each of these buyers bought a quantity of five of these items (in same purchase), the <b>Item.SellingStatus.QuantitySoldByPickupInStore</b> value would be '10' and not '2'.
<br>
<br>
In the case of multi-variation, fixed-price listings, each <b>Item.Variations.Variation.SellingStatus.QuantitySoldByPickupInStore</b> value indicates the total quantity of that corresponding item variation (for example, large blue shirts) sold and picked up by buyers using the In-Store Pickup option, and the <b>Item.SellingStatus.QuantitySoldByPickupInStore</b> value would be the total quantity of all item variations sold for the listing.
<br>
<br>
This field is returned only if the listing is eligible for In-Store Pickup (<b>EligibleForPickupInStore</b> is returned as <code>true</code>).
<br/><br/>
<span class="tablenote">
<strong>Note:</strong> At this time, the In-Store Pickup feature is generally only available to large retail merchants, and can only be applied to multi-quantity, fixed-price listings.
</span>
GetItem
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Always
This container is only returned if the buyer is attempting to bid on an auction item. To bid on an auction item, the buyer sets the value of the <b>Offer.Action</b> field to <code>Bid</code>, and sets the maximum bid amount in the <b>Offer.MaxBid</b> field.
<br><br>
The <b>SuggestedBidValues</b> container consists of an array of incremental bid values (up to the dollar value in the <b>Offer.MaxBid</b> field) that eBay will bid on behalf of the buyer each time that buyer is outbid for the auction item.
PlaceOffer
Conditionally
Contains summary information about the items the seller is selling.
The number of currently active auctions that will sell. That
is, there is at least one bidder, and any reserve price has
been met. Equivalent to the "Will Sell" value in My eBay.
GetMyeBaySelling
DetailLevel: none, ReturnAll
Always
The total number of currently active auctions for a given
seller. Equivalent to the
"Auction Quantity" value in My eBay.
GetMyeBaySelling
DetailLevel: none, ReturnAll
Always
The total number of bids made on the seller's active auction listings.
GetMyeBaySelling
DetailLevel: none, ReturnAll
Always
The total value of all items the seller has for sale in all listings.
GetMyeBaySelling
DetailLevel: none, ReturnAll
Always
The total number of items the seller has sold.
GetMyeBaySelling
DetailLevel: none, ReturnAll
Always
https://ebaydts.com/eBayKBDetails?KBid=1111
Discrepancies Between Results of GetMyeBaySelling and GetSellerTransactions
The total monetary value of the items the seller has sold.
GetMyeBaySelling
DetailLevel: none, ReturnAll
Always
https://ebaydts.com/eBayKBDetails?KBid=1111
Discrepancies Between Results of GetMyeBaySelling and GetSellerTransactions
The average duration, in days, of all items sold.
GetMyeBaySelling
DetailLevel: none, ReturnAll
Always
Specifies the action to take for an item's My eBay notes.
Creates or replaces an item's My eBay notes. Note that if
the specified item already has notes in My eBay, the new
notes will completely replace the existing notes. They will
not be appended.
Deletes any existing My eBay notes for the specified item.
Specifying Delete when no notes exist does nothing, but does
not return an error.
Reserved for internal or future use.
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.
<br/><br/>
Also returned with the data for an item's transaction.
<br/><br/>
<span class="tablenote"><strong>Note:</strong>
The <strong>ShippingPackageDetails</strong> container should now be used instead of the <strong>CalculatedShippingRate</strong> container to specify values for the <strong>MeasurementUnit</strong>, <strong>PackageDepth</strong>, <strong>PackageWidth</strong>, <strong>PackageLength</strong>, <strong>ShippingIrregular</strong>, <strong>ShippingPackage</strong>, <strong>WeightMajor</strong>, and/or <strong>WeightMinor</strong> fields. The <strong>CalculatedShippingRate</strong> container should only be used to specify values for the <strong>InternationalPackagingHandlingCosts</strong>, <strong>OriginatingPostalCode</strong>, and/or <strong>PackagingHandlingCosts</strong> fields.
</span>
Specifies the unit type of the weight and dimensions of a
shipping package.
If <b>MeasurementUnit</b> is used, it overrides the system specified by measurementSystem.
If <b>MeasurementUnit</b> and measurementSystem are not specified, the following defaults
will be used:
<br><br>
English: US<br>
Metric: CA, CAFR, AU
<br><br>
CA and CAFR supports both English and Metric, while other sites
only support the site's default.
<br><br>
Use <b>MeasurementUnit</b> with weight and package dimensions. For example,
to represent a 5 lbs 2 oz package:
<br><br>
<code>
<MeasurementUnit>English</MeasurementUnit>
<br>
<WeightMajor>5</WeightMajor>
<br>
<WeightMinor>2</WeightMinor>
</code>
AddItem
AddItems
AddSellingManagerTemplate
RelistItem
ReviseItem
ReviseSellingManagerTemplate
VerifyAddItem
AddFixedPriceItem
VerifyAddFixedPriceItem
RelistFixedPriceItem
ReviseFixedPriceItem
VerifyRelistItem
Conditionally
https://developer.ebay.com/DevZone/guides/features-guide/default.html#Development/Shipping-TypesCosts.html#PackageDimensionsandWeight
Package Dimensions and Weight
Depth of the package, in whole number of inches, needed to ship the item.
This is validated against the selected shipping service.
Upon mismatch, a message is returned, such as, "Package
dimensions exceeds maximum allowable limit for
service XXXXX," where XXXXX is the name of the shipping service.
For calculated shipping only. Only returned if the seller
specified the value for the item. (In many cases, the seller
only specifies the weight fields.)
<br><br>
<b>Developer impact:</b> UPS requires dimensions for any Ground packages that are 3
cubic feet or larger and for all air packages, if they are to provide correct
shipping cost. If package dimensions are not included for an item listed with
calculated shipping, the shipping cost returned will be an estimate based on
standard dimensions for the defined package type. eBay enforces a dimensions
requirement on listings so that buyers receive accurate calculated shipping
costs.
AddFixedPriceItem
AddItem
AddItems
AddSellingManagerTemplate
RelistFixedPriceItem
RelistItem
ReviseFixedPriceItem
ReviseItem
ReviseSellingManagerTemplate
VerifyAddFixedPriceItem
VerifyAddItem
VerifyRelistItem
Conditionally
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetBidderList
GetItemShipping
Conditionally
GetItem
GetSellingManagerTemplates
Conditionally
DetailLevel: none, ItemReturnDescription,
ItemReturnAttributes, ReturnAll
GetItemTransactions
GetSellerTransactions
GetOrders
DetailLevel: none, ReturnAll
Conditionally
OrderReport
Conditionally
https://developer.ebay.com/DevZone/guides/features-guide/default.html#Development/Shipping-TypesCosts.html#PackageDimensionsandWeight
Package Dimensions and Weight
Length of the package, in whole number of inches, needed to ship the item.
Upon mismatch, a message is returned, such as, "Package
dimensions exceeds maximum allowable limit for
service XXXXX," where XXXXX is the name of the shipping service.
For calculated shipping only. Only returned if the seller
specified the value for the item. (In many cases, the seller
only specifies the weight fields.)
AddFixedPriceItem
AddItem
AddItems
AddSellingManagerTemplate
RelistFixedPriceItem
RelistItem
ReviseFixedPriceItem
ReviseItem
ReviseSellingManagerTemplate
VerifyAddFixedPriceItem
VerifyAddItem
VerifyRelistItem
Conditionally
GetBidderList
GetItemShipping
Conditionally
GetItem
GetSellingManagerTemplates
Conditionally
DetailLevel: none, ItemReturnDescription,
ItemReturnAttributes, ReturnAll
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetItemTransactions
GetSellerTransactions
GetOrders
DetailLevel: none, ReturnAll
Conditionally
OrderReport
Conditionally
https://developer.ebay.com/DevZone/guides/features-guide/default.html#Development/Shipping-TypesCosts.html#PackageDimensionsandWeight
Package Dimensions and Weight
Width of the package, in whole number of inches, needed to ship the item.
Upon mismatch, a message is returned, such as, "Package
dimensions exceeds maximum allowable limit for
service XXXXX," where XXXXX is the name of the shipping service.
For calculated shipping only. Only returned if the seller
specified the value for the item. (In many cases, the seller
only specifies the weight fields.)
AddFixedPriceItem
AddItem
AddItems
AddSellingManagerTemplate
RelistFixedPriceItem
RelistItem
ReviseFixedPriceItem
ReviseItem
ReviseSellingManagerTemplate
VerifyAddFixedPriceItem
VerifyAddItem
VerifyRelistItem
Conditionally
GetBidderList
GetItemShipping
Conditionally
GetItem
GetSellingManagerTemplates
Conditionally
DetailLevel: none, ItemReturnDescription,
ItemReturnAttributes, ReturnAll
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetItemTransactions
GetSellerTransactions
GetOrders
DetailLevel: none, ReturnAll
Conditionally
OrderReport
Conditionally
https://developer.ebay.com/DevZone/guides/features-guide/default.html#Development/Shipping-TypesCosts.html#PackageDimensionsandWeight
Package Dimensions and Weight
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. For calculated
shipping only.
AddFixedPriceItem
AddItem
AddItems
AddSellingManagerTemplate
RelistFixedPriceItem
RelistItem
ReviseFixedPriceItem
ReviseItem
ReviseSellingManagerTemplate
VerifyAddFixedPriceItem
VerifyAddItem
VerifyRelistItem
No
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
Conditionally
GetBidderList
GetItemShipping
Conditionally
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally
GetItemTransactions
GetSellerTransactions
GetOrders
DetailLevel: none, ReturnAll
Conditionally
OrderReport
Conditionally
The nature of the package used to ship the item(s).
Required for calculated shipping only.
AddFixedPriceItem
AddItem
AddItems
AddSellingManagerTemplate
RelistFixedPriceItem
RelistItem
ReviseFixedPriceItem
ReviseItem
ReviseSellingManagerTemplate
VerifyAddFixedPriceItem
VerifyAddItem
VerifyRelistItem
Conditionally
GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
Conditionally
GetBidderList
GetItemShipping
Conditionally
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally
GetItemTransactions
GetSellerTransactions
GetOrders
DetailLevel: none, ReturnAll
Conditionally
OrderReport
Conditionally
<b>WeightMajor</b> and <b>WeightMinor</b> are used to specify the weight of a
shipping package. <b>WeightMajor</b> is used to specify the weight of the package in pounds (in US) or kilograms (all countries that use metric system). Although <b>MeasureType</b> is of decimal type, decimal values should not be used in <b>WeightMajor</b> and <b>WeightMinor</b>.
If a shipping package was 5 pounds and 1.8 ounces, the 1.8 ounces should be rounded up to an even 2 ounces. The same is for kilograms. If the package is 2.267 kilgram, you would round up the grams. Below shows you how to represent a package weight of 5 lbs 2 oz and and 2 kg 3 gr:
<br/><br/>
<code>
<WeightMajor unit="lbs">5</WeightMajor><br/>
<WeightMinor unit="oz">2</WeightMinor><br/>
<WeightMajor unit="kg">2</WeightMajor><br/>
<WeightMinor unit="gr">3</WeightMinor>
</code>
<br/><br/>
If a package weighed 14 oz or 324 gr, below is how you would represent this weight:
<br/><br/>
<code>
<WeightMajor unit="lbs">0</WeightMajor><br/>
<WeightMinor unit="oz">14</WeightMinor><br/>
<WeightMajor unit="kg">0</WeightMajor><br/>
<WeightMinor unit="gr">324</WeightMinor>
</code>
<br/><br/>
If a package weighed exactly 2 lbs or 105 kg, below is how you would represent this weight:
<br/><br/>
<code>
<WeightMajor unit="lbs">2</WeightMajor><br/>
<WeightMinor unit="oz">0</WeightMinor><br/>
<WeightMajor unit="kg">105</WeightMajor><br/>
<WeightMinor unit="gr">0</WeightMinor>
</code>
<br/><br/>
In all cases, both the <b>WeightMajor</b> and <b>WeightMinor</b> should be specified in an Add/Revise/Relist/Verify call, even if either's value is '0'.
<br><br>
The <b>WeightMajor</b> and <b>WeightMinor</b> are applicable for calculated shipping or for flat-rate shipping if shipping rate tables are specified and the shipping rate table uses weight surcharges.
AddFixedPriceItem
AddItem
AddItems
AddSellingManagerTemplate
RelistFixedPriceItem
RelistItem
ReviseFixedPriceItem
ReviseItem
ReviseSellingManagerTemplate
VerifyAddFixedPriceItem
VerifyAddItem
VerifyRelistItem
Conditionally
GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
Conditionally
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetBidderList
GetItemShipping
Conditionally
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally
GetItemTransactions
GetSellerTransactions
GetOrders
DetailLevel: none, ReturnAll
Conditionally
OrderReport
Conditionally
<b>WeightMajor</b> and <b>WeightMinor</b> are used to specify the weight of a
shipping package. <b>WeightMinor</b> is used to specify the weight of the package in ounces (in US) or grams (all countries that use metric system). Although <b>MeasureType</b> is of decimal type, decimal values should not be used in <b>WeightMajor</b> and <b>WeightMinor</b>.
If a shipping package was 5 pounds and 1.8 ounces, the 1.8 ounces should be rounded up to an even 2 ounces. The same is for kilograms. If the package is 2.267 kilgram, you would round up the grams. Below shows you how to represent a package weight of 5 lbs 2 oz and and 2 kg 3 gr:
<br/><br/>
<code>
<WeightMajor unit="lbs">5</WeightMajor><br/>
<WeightMinor unit="oz">2</WeightMinor><br/>
<WeightMajor unit="kg">2</WeightMajor><br/>
<WeightMinor unit="gr">3</WeightMinor>
</code>
<br/><br/>
If a package weighed 14 oz or 324 gr, below is how you would represent this weight:
<br/><br/>
<code>
<WeightMajor unit="lbs">0</WeightMajor><br/>
<WeightMinor unit="oz">14</WeightMinor><br/>
<WeightMajor unit="kg">0</WeightMajor><br/>
<WeightMinor unit="gr">324</WeightMinor>
</code>
<br/><br/>
If a package weighed exactly 2 lbs or 105 kg, below is how you would represent this weight:
<br/><br/>
<code>
<WeightMajor unit="lbs">2</WeightMajor><br/>
<WeightMinor unit="oz">0</WeightMinor><br/>
<WeightMajor unit="kg">105</WeightMajor><br/>
<WeightMinor unit="gr">0</WeightMinor>
</code>
<br/><br/>
In all cases, both the <b>WeightMajor</b> and <b>WeightMinor</b> should be specified in an Add/Revise/Relist/Verify call, even if either's value is '0'.
<br><br>
The <b>WeightMajor</b> and <b>WeightMinor</b> are applicable for calculated shipping or for flat-rate shipping if shipping rate tables are specified and the shipping rate table uses weight surcharges.
<br/><br/>
0
15 for ounces; 999 for grams
AddFixedPriceItem
AddItem
AddItems
AddSellingManagerTemplate
RelistFixedPriceItem
RelistItem
ReviseFixedPriceItem
ReviseItem
ReviseSellingManagerTemplate
VerifyAddFixedPriceItem
VerifyAddItem
VerifyRelistItem
Conditionally
GetBidderList
GetItemShipping
Conditionally
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
Conditionally
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally
GetItemTransactions
GetSellerTransactions
GetOrders
DetailLevel: none, ReturnAll
Conditionally
OrderReport
Conditionally
Status of the delivery.
Created (default).
Dropped off.
In transit.
Delivered.
Returned.
Cancelled.
Label printed.
Unconfirmed.
Unknown.
Error.
Reserved for future use.
This type provides information about one or more order line items in a Global Shipping Program package.
Contains information about one order line item in a Global Shipping Program package. The package can contain multiple units of a given order line item, and multiple order line items.
CompleteSale
AddShipment
ReviseShipment
ReviseSellingManagerSaleRecord
SetShipmentTrackingInfo
No
GetSellingManagerSaleRecord
GetSellingManagerSoldListings
Conditionally
This type details the shipping carrier and shipment tracking number associated with a
package shipment. It also contains information about the line items shipped through the Global Shipping program.
The name of the shipping carrier used to ship the item. This field and the <strong>ShipmentTrackingNumber</strong> field are mutually dependent. When you submit <strong>ShippingCarrierUsed</strong>, you must also supply a value for <strong>ShipmentTrackingNumber</strong>. When you submit <strong>ShipmentTrackingNumber</strong>, you must also supply a value for <strong>ShippingCarrierUsed</strong>.
<br/><br/>
When the site ID is Austria, Poland, or UK, <strong>ShippingCarrierUsed</strong> can be any value, because it is not checked by eBay. For all other sites, only the following characters are allowed: letters (<code>a-z</code>, <code>A-Z</code>), numbers (<code>0-9</code>), space, and dash (<code>-</code>). The site ID is specified in the <b>CompleteSale</b> request header.
<br/><br/>
<span class="tablenote">
<strong>Note:</strong> Commonly used shipping carriers can be found by calling <b>GeteBayDetails</b> with <b>DetailName</b> set to <code>ShippingCarrierDetails</code> and examining the returned <b>ShippingCarrierDetails.ShippingCarrier</b> field. <a href="http://developer.ebay.com/Devzone/XML/docs/Reference/eBay/types/ShippingCarrierCodeType.html">ShippingCarrierCodeType</a> also has a list of valid shipping carriers, but eBay cannot guarantee that this enumerated type contains a full, updated list of shipping carriers.
</span>
<strong>For the CompleteSale call</strong>:
<ul>
<li>This field is not case sensitive in the <strong>CompleteSale</strong> request.</li>
<li>When using UPS Mail Innovations, supply the value <code>UPS-MI</code>. Buyers will subsequently be sent to the UPS Mail Innovations website for tracking status. </li>
<li>When using FedEx SmartPost, supply the value <code>FedEx</code>. Buyers will subsequently be sent to the FedEx web site for tracking status. </li>
</ul>
<strong>For the Get calls</strong>: When using the Global Shipping Program, this field returns a value of <code>PBI</code>.
ShippingCarrierCodeType
CompleteSale
SetShipmentTrackingInfo
Conditionally
GetSellingManagerSaleRecord
Conditionally
GetItemTransactions
GetOrderTransactions
GetSellerTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetOrders
DetailLevel: none, ReturnAll
Conditionally
The tracking number assigned by the shipping carrier to the item shipment. This field and the <b>ShippingCarrierUsed</b> field are mutually dependent. When you submit <strong>ShipmentTrackingNumber</strong>, you must also supply a value for <strong>ShippingCarrierUsed</strong>. When you submit <strong>ShippingCarrierUsed</strong>, you must also supply a value for <strong>ShipmentTrackingNumber</strong>.
<br/><br/>
The format of the tracking number must be consistent with the format used by the specified shipping carrier (<strong>ShippingCarrierUsed</strong>). Typically, you should avoid spaces and hyphens.
Returned only if set.
<br><br>
<b>For GetOrders, GetOrderTransactions, and GetItemTransactions only:</b> If using Trading WSDL Version 1019 or above, this field will only be returned to the buyer or seller, and no longer returned at all to third parties. If using a Trading WSDL older than Version 1019, the real tracking number is only returned to the buyer or seller, and a string value of <code>Unavailable</code> will be returned to all third parties.
CompleteSale
SetShipmentTrackingInfo
Conditionally
GetSellingManagerSaleRecord
Conditionally
GetItemTransactions
GetOrderTransactions
GetSellerTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetOrders
DetailLevel: none, ReturnAll
Conditionally
Contains information about one or more order line items in a Global Shipping Program package. Required or returned if the value of <strong>ShippingCarrierUsed</strong> is <code>PBI</code>.
CompleteSale
ReviseSellingManagerSaleRecord
SetShipmentTrackingInfo
No
GetSellingManagerSaleRecord
GetSellingManagerSoldListings
Conditionally
Type defining the <b>Shipment</b> container, which is used by
the seller in <b>CompleteSale</b> to provide shipping information. The
<b>Shipment</b> container is also returned in the
<b>GetSellingManagerSaleRecord</b> response.
Depth dimension of the package needed to ship the item after it is sold.
<br>
For calculated shipping only.
Length dimension of the package needed to ship the item after it is sold.
<br>
For calculated shipping only.
Width dimension of the package needed to ship the item after it is sold.
<br>
For calculated shipping only.
The address from which the item is being shipped.
The address to which the item is to be shipped.
This field is deprecated.
635
733
NoOp
ShipmentType.ShipmentTrackingDetails
The size of the package used to ship the item(s). See ShippingPackageCodeType
for its possible values. Input.
The size of the package used to ship the item(s). See ShippingPackageCodeType
for its possible values. Input.
This field is deprecated.
635
733
NoOp
ShipmentType.ShipmentTrackingDetails
The 'unit' attribute can have a value of lbs.
The 'unit' attribute is optional and assumed to be the
minor compared to the value of 'unit' in WeightMajor.
Revise only
Revise only
Revise only
Revise only
Status, for revise only
The date and time that the seller handed off the package(s) to the shipping
carrier. If this field is not included in the request, the timestamp of the call
execution is used as the shipped time. Note that sellers have the ability to set
this value up to 3 calendar days in the future.
SetShipmentTrackingInfo
No
CompleteSale
No
<span class="tablenote"><b>Note: </b> This field is only applicable for Half.com listings, and since API support for Half.com listings is being deprecated, this field is no longer applicable.
</span>
This string field allows a seller to provide notes to the buyer regarding shipment of a Half.com item. Only alphanumeric characters can be used in this field. This is an optional field that is only applicable to Half.com items.
1027
NoOp
1033
Container consisting of the tracking number and shipping carrier associated with
the shipment of one item (package).
<br><br>
Because an order can have multiple line items and/or packages, there can be
multiple <b>ShipmentTrackingDetails</b> containers under the
<b>Shipment</b> container.
CompleteSale
SetShipmentTrackingInfo
No
GetSellingManagerSaleRecord
Conditionally
GetItemTransactions
GetOrderTransactions
GetSellerTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetOrders
DetailLevel: none, ReturnAll
Conditionally
Contains information about one or more order line items in a Global Shipping Program package. Required or returned if the value of <strong>ShippingCarrierUsed</strong> is <code>PBI</code>.
AddShipment
ReviseShipment
ReviseSellingManagerSaleRecord
No
GetSellingManagerSoldListings
Conditionally
Identifies a shipping carrier used to ship an order, and the countries served by that carrier.
<br/><br/>
<span class="tablenote">
<strong>Note:</strong> Commonly used shipping carriers can also be found by calling <b>GeteBayDetails</b> with <b>DetailName</b> set to <b>ShippingCarrierDetails</b> and examining the returned <strong>ShippingCarrierDetails.ShippingCarrier</strong> field.
</span>
United Parcel Service
<br/>
In CompleteSale call requests, the value <code>UPS</code> also represents UPS Mail Innovations. Available in US, IE, UK, FR, IT, DE, CH, ES, AT, CN, BE, PL, NL.
U.S. Postal Service
<br/>
Available in US, CN, UK, DE.
FedEx
<br/>
In CompleteSale call requests, the value <code>FedEx</code> also represents FedEx SmartPost. Available in US, IE, UK, FR, IT, DE, CH, AU, ES, AT, CN, BE, PL, NL.
Deutsche Post
<br/>
Available in US, UK, DE.
DHL Express
<br/>
Available in IE, US, ID, MX, MY, CA, UK, FR, IT, HK, TW, DE, CH, KR, AU, ES, AT, CN, SG, BE, TH, NL.
Hermes Group
<br/>
Available in US, AT, UK, DE.
iloxx eService
<br/>
Available in US, UK, DE.
Use this code for any carrier not listed here.
Coliposte Domestic
<br/>
Available in US, UK, DE.
Coliposte International
<br/>
Available in US, UK, DE.
Chronopost
<br/>
Available in US, FR, UK, DE.
Correos
<br/>
Available in ES, US, UK, DE.
Seur (reserved for future use).
Nacex
<br/>
Available in ES, US, UK, DE.
4PX
<br/>
Available in US.
4PX China
<br/>
Available in US, CN, UK.
4PX Express
<br/>
Available in UK, DE.
4PX Express Co. Ltd
<br/>
Available in US, UK, DE.
n/a
<br/>
Not currently supported.
A-1 Courier
<br/>
Available in US.
ABF Freight
<br/>
Available in US.
AeroPost
<br/>
Available in JM, GT, CR, PA, TT, SV, CO, HN, CL, DO.
Allied Express
<br/>
Available in AU.
AMWST
<br/>
Available in US.
An Post
<br/>
Available in IE.
APC Postal Logistics
<br/>
Available in UK.
Aramex
<br/>
Available in US, BH, IL, AE, IN, UA, KW, SA, QA.
Arvato
<br/>
Available in US, CA, UK, FR, IT, GR, DE, CH, AT, BE, NL, SI, LT, SK.
ASM
<br/>
Available in ES.
Australia Post
<br/>
Available in US, UK, DE, AU.
Australian Air Express
<br/>
Available in AU.
Averitt Express
<br/>
Available in US.
bpost
<br/>
Also coded as <code>BELGIANPOST</code>. Available in US, UK, DE, MO, BE.
BRT Bartolini
<br/>
Available in IT.
Belgian Post Group
<br/>
Also coded as <code>BPost</code>. Available in US, UK, DE MO, BE.
BKNS
<br/>
Available in US.
Blue Package Delivery
<br/>
Available in US.
BusinessPost
<br/>
Available in UK.
Canpar Courier
<br/>
Available in US, CA, IT, UK, DE, AU
Central Freight Lines
<br/>
Available in US.
CEVA Logistics
<br/>
Available in US, IT.
China Post
<br/>
Available in US, UK, DE.
Chronoexpres
<br/>
Available in ES.
Chukou1
<br/>
Available in US.
Chunghwa Post
<br/>
Available in US, UK, DE.
CitiPost
<br/>
Available in US, IE, CA, UK, FR, IT, HK, DE, AU, ES, CN, BE, UZ, PL, NL.
Citylink
<br/>
Available in IE.
Click & Quick
<br/>
Available in IT.
XPO Logistics (formerly Con-way Freight)
<br/>
Con-way Freight is now part of XPO Logistics. Available in US.
Colissimo
<br/>
Available in FR.
CollectPlus
<br/>
Available in UK.
CPC Logistics
<br/>
Available in US, CA, UK, DE.
DAI Post
<br/>
Available in UK, AU.
Day & Ross
<br/>
Available in US, CA, UK, AU.
DB Schenker
<br/>
Available in US.
DHL Express
<br/>
Available in IT, DE.
DHL Global Mail
<br/>
Formerly coded as <code>DHLG</code>. Available in US, UK, DE.
DHL EKB
<br/>
Available in US.
n/a
<br/>
Use <code>DHLGlobalMail</code> instead.
Die Schweizerische Post
<br/>
Available in CH.
DPD (Dynamic Parcel Distribution)
<br/>
Available in IE, BG, AT, UK, HR, BE, HU, PL, CZ, DE, NL, CH.
DPX Thailand
<br/>
Available in US, TH.
n/a
<br/>
Not currently supported.
E-go
<br/>
Available in AU.
n/a
<br/>
Not currently supported.
DPD France (formerly Exapaq)
<br/>
Exapaq is now part of DPD France. Available in FR.
Fastway
<br/>
Available in IE.
Fastway Couriers
<br/>
Available in AU.
FedEx SmartPost
<br/>
In CompleteSale call requests only, specify FedEx SmartPost with the value <code>FedEx</code>. Available in US, UK, DE.
Flyt
<br/>
Available in US.
Flyt Express
<br/>
Available in UK, DE.
Flyt Express US Direct line
<br/>
Available in US, UK, DE.
n/a
<br/>
Not currently supported.
FulfilExpress-AccStation
<br/>
Available in US, UK, DE.
FulfilExpress-eForCity
<br/>
Available in US, UK, DE.
FulfilExpress-EverydaySource
<br/>
Available in US, UK, DE.
FulfilExpress-iTrimming
<br/>
Available in US, UK, DE.
GLS (General Logistics Systems)
<br/>
Available in IE, ES, AT, IT, FR, BE, DE, NL.
MXD Group (formerly Home Direct USA)
<br/>
Home Direct USA is now part of MXD Group. Available in US.
n/a
<br/>
Use <code>Yodel</code> instead.
Hong Kong Post
<br/>
Available in US, UK, DE, AU.
Hunter Express
<br/>
Available in AU.
India Post
<br/>
Available in US, UK, DE.
Indonesia Post
<br/>
Available in US, UK, DE.
Interlink Express
<br/>
Available in UK.
InterPost
<br/>
Available in IE, US, CA, UK, FR, IT, HK, DE, RO, AU, ES, AT, CN, CY, BE, PL, NL.
IoInvio
<br/>
Available in IT.
UPS i-parcel
<br/>
Available in US, MX, MY, SG, HK, ZA, TR, CH, JP, BR.
Israel Post
<br/>
Available in US.
Japan Post
<br/>
Available in US, UK, DE.
Kiala (UPS Access Point)
<br/>
Available in ES, US, FR, UK, BE, DE, NL.
Korea Post
<br/>
Available in US, UK, DE.
La Poste
<br/>
Available in US, FR, UK, DE.
Landmark Global
<br/>
Available in US, NZ, NO.
n/a
<br/>
Not currently supported.
n/a
<br/>
Not currently supported.
Malaysia Post
<br/>
Available in US, UK, DE.
Manna Distribution Services
<br/>
Available in US.
Metapack
<br/>
Available in UK.
MNG Kargo
<br/>
Available in US, UK, TR.
Mondial Relay
<br/>
Available in FR.
MRW
<br/>
Available in ES.
MSI Transportation
<br/>
Available in US.
New England Motor Freight
<br/>
Available in US.
Old Dominion Freight Line
<br/>
Available in US.
n/a
<br/>
Not currently supported.
OnTrac Shipping
<br/>
Available in US.
Osterreichische Post
<br/>
Available in AT.
UPS Freight (formerly Overnite)
<br/>
Overnite is now part of UPS Freight. Available in US.
International Bridge Domestic delivery
<br/>
Available in US.
Parcelforce
<br/>
Available in US, UK, DE.
PHLPost (Philippine Postal Corporation)
<br/>
Available in US, UK, DE.
Pilot Freight Services
<br/>
Available in US.
PITT OHIO
<br/>
Available in US.
Poczta Polska
<br/>
Available in PL.
Pocztex
<br/>
Available in PL.
Post Italiano
<br/>
Available in US, UK, DE.
PostNL
<br/>
Available in NL.
PostNord
<br/>
Available in UK, NO.
Poste Italiane
<br/>
Available in IT.
LaserShip (formerly Prestige Expedite)
<br/>
Prestige Expedite is now part of LaserShip. Available in US.
Quantium Solutions
<br/>
Available in US, UK, DE, AU.
Reddaway
<br/>
Available in US.
Royal Mail
<br/>
Available in US, UK, DE.
n/a
<br/>
Not currently supported.
Saia LTL Freight
<br/>
Available in US.
SDA Express Courier
<br/>
Available in IT.
n/a
<br/>
Not currently supported.
n/a
<br/>
Not currently supported.
Singapore Post
<br/>
Available in US, UK, DE.
Siodemka (DPD Poland)
<br/>
Available in PL.
Sioli & Fontana
<br/>
Available in US, CA, IT.
Skynet (Malaysia)
<br/>
Available in US, MY.
Smart Send Courier Service
<br/>
Available in AU.
SGT Corriere Espresso
<br/>
Available in IT.
Spediamo
<br/>
Available in IT.
Spee-Dee Delivery Service
<br/>
Available in US.
StarTrack
<br/>
Available in AU.
Suntek Express LTD
<br/>
Available in US, UK, DE.
Swiss Post
<br/>
Available in US, UK, CH.
TELE
<br/>
Available in US.
Temando (shipping broker)
<br/>
Available in AU.
Thailand Post
<br/>
Available in US, UK, DE.
n/a
<br/>
Not currently supported.
n/a
<br/>
Not currently supported.
n/a
<br/>
Not currently supported.
Toll (Japan Post)
<br/>
Available in AU.
TPG Logistics
<br/>
Available in US, UK, DE.
n/a
<br/>
Not currently supported.
UBI Smart Parcel
<br/>
Available in US.
UK Mail
<br/>
Available in UK.
UPS Mail Innovations
<br/>
In CompleteSale call requests only, specify UPS Mail Innovations with the value <code>UPS</code>. Available in US, UK, DE.
n/a
<br/>
Not currently supported.
n/a
<br/>
Not currently supported.
USPS Commercial ePacket
<br/>
Available in US, CA.
USPS Priority Mail International
<br/>
Available in US, CA.
Vietnam Post
<br/>
Available in US, UK, DE.
Vitran Express
<br/>
Available in US.
n/a
<br/>
Not currently supported.
WIN.IT America
<br/>
Available in US, UK, DE, AU.
n/a
<br/>
Not currently supported.
wnDirect
<br/>
Available in US, CA, IT, FR, UK, RU, AU.
WPX Delivery Solutions
<br/>
Available in US.
YANWEN Express
<br/>
Available in US, UK, DE.
Yodel
<br/>
Available in UK.
YRC Freight
<br/>
Available in US.
Reserved for internal or future use
Details about type of Carrier used to ship an item.
Numeric identifier.
Some applications use this ID
to look up shipping Carriers more efficiently.
GeteBayDetails
Conditionally
Display string that applications can use to present a list of shipping carriers in
a more user-friendly format (such as in a drop-down list).
GeteBayDetails
Conditionally
The code for the shipping carrier.
<br/><br/>
<span class="tablenote">
<strong>Note:</strong> Commonly used shipping carriers can also be found by calling <b>GeteBayDetails</b> with <b>DetailName</b> set to <code>ShippingCarrierDetails</code> and examining the returned <b>ShippingCarrierDetails.ShippingCarrier</b> field.
</span>
GeteBayDetails
Conditionally
Returns the latest version number for this field. The version can be
used to determine if and when to refresh cached client data.
GeteBayDetails
DetailLevel: none, ReturnSummary, ReturnAll
Always
Gives the time in GMT that the feature flags for the details were last
updated. This timestamp can be used to determine if and when to refresh
cached client data.
GeteBayDetails
DetailLevel: none, ReturnSummary, ReturnAll
Always
This type defines the <b>ShippingCategoryDetails</b> container. When the <b>DetailName</b> field
is set to ShippingCategoryDetails in a <b>GeteBayDetails</b> request, one
<b>ShippingCategoryDetails</b> container is returned for each valid shipping category
used on the eBay site. Besides being useful to view the list of valid shipping
categories, this container is also useful to discover when the last update to
shipping categories was made by eBay.
Indicates the shipping category. Shipping categories include the following: ECONOMY, STANDARD, EXPEDITED, ONE_DAY, PICKUP, OTHER, and NONE. International shipping services are generally grouped into the NONE category. For more information on these shipping categories, and which services fall into which category, see the <a href="http://pages.ebay.com/sellerinformation/shipping/chooseservice.html">Shipping Basics</a> page on the eBay Shipping Center site.
<br/><br/>
<span class="tablenote">
<strong>Note:</strong> This field is returned only for those sites that support shipping categories: US (0), CA (2), CAFR (210), UK (3), AU (15), FR (71), DE (77), IT (101) and ES (186).
</span>
GeteBayDetails
Conditionally
Display string that applications can use to present a list of shipping categories in a more user-friendly format (such as in a drop-down list). This field is localized per site.
GeteBayDetails
Conditionally
The current version number for shipping categories. Sellers can compare this
version number to their version number to determine if and when to refresh
cached client data.
GeteBayDetails
DetailLevel: none, ReturnSummary, ReturnAll
Always
Indicates the time of the last version update.
GeteBayDetails
DetailLevel: none, ReturnSummary, ReturnAll
Always
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. One of these values is set by the seller when establishing/setting a return policy for an item.
<br><br>
<span class="tablenote"><b>Note:</b> The <b>GeteBayDetails</b> call returns site-default Return Policy settings. For most categories within a given eBay site, the supported Return Policy options/values are the same, but there a few exceptions. To discover what return shipping 'payee' values that a particular category supports, call <b>GetCategoryFeatures</b> and include <code>DomesticReturnsShipmentPayeeValues</code> and/or <code>InternationalReturnsShipmentPayeeValues</code> as <b>FeatureID</b> values to see the return shipping 'payee' values available for domestic and international returns, respectively.
</span>
EUBuyer_CancelRightsUnder40, EUSeller_CancelRights, EUSeller_ReturnRights
This value indicates that the buyer is responsible for paying the return shipping cost. Note that the buyer will not be responsible for return shipping cost if the the buyer's reason for the return is related to the received item not being as described in the listing, or if the item has arrived damaged or with missing parts.
This value indicates that the seller is responsible for paying the return shipping cost.
(out) Reserved for internal or future use.
This value is no longer applicable.
This value is no longer applicable.
This value is no longer applicable.
This type defines the <b>ShippingCostPaidBy</b> container that is returned in <b>GeteBayDetails</b> if <b>ReturnPolicyDetails</b> is set as a <b>DetailName</b> value (or if no value is included in the request).
<br><br>
<span class="tablenote"><b>Note:</b> The <b>GeteBayDetails</b> call returns site-default Return Policy settings. For most categories within a given eBay site, the supported Return Policy options/values are the same, but there a few exceptions. To discover what return shipping 'payee' values that a particular category supports, call <b>GetCategoryFeatures</b> and include <code>DomesticReturnsShipmentPayeeValues</code> and/or <code>InternationalReturnsShipmentPayeeValues</code> as <b>FeatureID</b> values to see the return shipping 'payee' values available for domestic and international returns, respectively.
</span>
The party who pays the shipping cost for a returned item.
This value can be passed in the Add/Revise/Relist calls.
ShippingCostPaidByOptionsCodeType
GeteBayDetails
Conditionally
Display string that applications can use to present <b>ShippingCostPaidByOption</b> in a more user-friendly format (such as in a drop-down list). Not applicable as input to the Add/Revise/Relist calls. (Use <b>ShippingCostPaidBy</b> instead.)
GeteBayDetails
Conditionally
Type defining the <b>ShippingDetails</b> container, which contains the shipping-related
details for an order line item (pre-checkout) or order (post-checkout).
<br/><br/>
<span class="tablenote">
<strong>IMPORTANT:</strong> To avoid loss of shipping details when revising a listing, you must include all <strong>ShippingDetails</strong> fields that were originally provided. Do not omit any tag, even if its value does not change. Omitting a shipping field when revising an item will remove that detail from the listing.
</span>
This field is deprecated and has been replaced by the <b>ShippingDetails.PaymentEdited</b> field.
This field is deprecated.
663
NoOp
759
Indicates whether eBay's Global Shipping Program is offered for the listing. If the value of <strong>GlobalShipping</strong> is <code>True</code>, international shipping through the Global Shipping Program is available for the listing, and eBay automatically sets one of the available shipping service options to <code>International Priority Shipping</code>. If the value of <strong>GlobalShipping</strong> is <code>false</code>, the seller is responsible for specifying one or more international shipping service options if the seller is willing to ship internationally.
<br/><br/>
When calling <strong>RelistFixedPriceItem</strong>, <strong>RelistItem</strong>, <strong>ReviseFixedPriceItem</strong> or <strong>ReviseItem</strong>, you can omit this field if its value doesn't need to change.
<br/><br/>
Before using this field for a listing, ensure that the seller and the item being listed are eligible for the Global Shipping Program.
AddFixedPriceItem
VerifyAddFixedPriceItem
AddItem
VerifyAddItem
AddItems
RelistFixedPriceItem
RelistItem
VerifyRelistItem
ReviseFixedPriceItem
ReviseItem
Conditionally
GetItem
GetSellerList
GetMyeBaySelling
DetailLevel: none, ItemReturnAttributes, ItemReturnDescription, ReturnAll
Conditionally
International Shipping with the Global Shipping Program
https://developer.ebay.com/DevZone/guides/features-guide/default.html#Development/Shipping-Managing.html#InternationalShippingwiththeGlobalShippi
information about Global Shipping Program eligibility
Details pertinent to one or more items for which calculated shipping has been
offered by the seller, such as package dimension and weight and
packaging/handling costs. If your call specifies a large-dimension item listed
with UPS, see <a href=
"https://ebaydts.com/eBayKBDetails?KBid=1159"
>Dimensional Weight limit on UPS shipping services results in failure of
shipping calculator</a>.
<br><br>
<span class="tablenote"><strong>Note:</strong>
The <strong>CalculatedShippingRate</strong> container should only be used to specify values for the <strong>InternationalPackagingHandlingCosts</strong>, <strong>OriginatingPostalCode</strong>, and/or <strong>PackagingHandlingCosts</strong> fields. The rest of the fields in the <strong>CalculatedShippingRate</strong> container are used to specify package dimensions and package weight, and these values should now be specified in the <strong>ShippingPackageDetails</strong> container instead.
</span>
AddFixedPriceItem
AddItem
AddItems
AddSellingManagerTemplate
RelistFixedPriceItem
RelistItem
ReviseFixedPriceItem
ReviseItem
ReviseSellingManagerTemplate
VerifyAddFixedPriceItem
VerifyAddItem
VerifyRelistItem
Conditionally
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnAttributes, ItemReturnDescription, ReturnAll
Conditionally
GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
Conditionally
GetItemShipping
Conditionally
GetItemTransactions
GetSellerTransactions
GetOrders
DetailLevel: none, ReturnAll
Conditionally
OrderReport
Conditionally
Whether the seller specified payment and shipping instructions during checkout
(for example, to update the details of an order). Valid for flat and calculated
shipping.
GetItemShipping
Conditionally
GetItemTransactions
GetOrderTransactions
GetSellerTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
Whether or not the buyer selected to pay for insurance as an option offered by
the seller. This only has a value after the buyer has gone through checkout and
selected the insurance preference.
<br><br>
Valid only on the following sites: FR and IT
1031
Avoid
1085
Whether the seller allows the buyer to edit the payment amount for the order.
(Sellers enable this property in their My eBay user preferences on the eBay site.)
GetItemShipping
Conditionally
GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
Conditionally
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
This free-form string field gives sellers the ability add detailed payment instructions to their listings.
The payment instructions appear on eBay's View Item and Checkout pages.
<br><br>
Sellers can use this field to specify payment instructions, how soon the item will shipped, feedback
instructions, and other items that the buyer should be aware of when they bid on or buy an item.
eBay recommends sellers use this field to clarify payment policies for motor vehicle listings on eBay Motors.
For example, sellers can include the specifics on the deposit (if required), pickup/delivery arrangements,
and full payment details on the vehicle.
<br><br>
The field allows only 500 characters as input, but due to the way the eBay web site UI treats characters,
this field can return more than 500 characters in the response. For example, characters like & and '
(ampersand and single quote) count as 5 characters each.
<br><br>
This field can be specified regardless of the shipping type. Use <b>DeletedField</b> to remove
this value when revising or relisting an item.
<br><br>
Applicable to eBay Motors (usually used to elaborate on the return policy).
<br>
500
AddFixedPriceItem
AddItem
AddItems
AddSellingManagerTemplate
RelistFixedPriceItem
RelistItem
ReviseFixedPriceItem
ReviseItem
ReviseSellingManagerTemplate
VerifyAddFixedPriceItem
VerifyAddItem
VerifyRelistItem
No
GetBidderList
GetItemShipping
Conditionally
GetItem
GetSellingManagerTemplates
Conditionally
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
Offering a Clear Return Policy
https://developer.ebay.com/DevZone/guides/features-guide/default.html#Development/Feature-ReturnPolicy.html
This container shows the sales tax rate percentage for a specific tax jurisdiction. Additionally, it indicates whether or not the seller applies sales tax to shipping charges in addition to the item cost. The concept of 'sales tax' is only applicable to eBay US and Canada (English and French) sites.
<br><br>
This container can be used in an Add/Revise/Relist/Verify call to set sales tax settings for a specific tax jurisdiction, but it is actually a better practice if a user sets up sales tax rates through the Sales Tax Table tool in My eBay (or by using the <b>SetTaxTable</b> call). A seller's Sales Tax Table is applied to the listing by including the <b>UseTaxTable</b> field in the request and setting its value to <code>true</code>. The <b>GetTaxTable</b> call can be used to retrieve the current sales tax rates for different tax jurisdictions.
<br><br>
This container is only returned in order-related 'Get' calls if sales tax is applicable to the order line item.
<br><br>
<span class="tablenote"><b>Note: </b> As of November 1, 2019, buyers in over 30 US states will automatically be charged sales tax for eBay purchases. eBay will collect and remit this sales tax to the proper taxing authority on the buyer's behalf. So, if a sales tax rate is applied by the seller for a state that is subject to 'eBay Collect and Remit', this sales tax rate will be ignored by eBay during checkout process. For a list of the US states that will become subject to 'eBay Collect and Remit' (and effective dates), see the <a href="https://www.ebay.com/help/selling/fees-credits-invoices/taxes-import-charges?id=4121#section4">eBay sales tax collection</a> help topic.
</span>
<br>
<span class="tablenote"><b>Note: </b> For eBay managed payment orders that are subject to 'Collect and Remit' taxes, these taxes will only be shown in the <b>eBayCollectAndRemitTaxes</b> container for line items, and the <b>SalesTax</b> will not be returned at all. For non-eBay managed payment orders, the 'Collect and Remit' taxes will be shown in both the <b>eBayCollectAndRemitTaxes</b> and <b>SalesTax</b> containers.
</span>
AddFixedPriceItem
AddItem
AddItems
AddSellingManagerTemplate
AddOrder
RelistFixedPriceItem
RelistItem
ReviseFixedPriceItem
ReviseItem
ReviseSellingManagerSaleRecord
ReviseSellingManagerTemplate
VerifyAddFixedPriceItem
VerifyAddItem
VerifyRelistItem
No
GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
GranularityLevel: Fine
Conditionally
GetBidderList
GetItemShipping
Conditionally
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnAttributes, ItemReturnDescription, ReturnAll
Conditionally
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetOrders
DetailLevel: none, ReturnAll
Conditionally
OrderReport
Conditionally
GetSellingManagerSaleRecord
DetailLevel: none
Conditionally
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
Enabling Multi-Jurisdiction Sales Tax
https://developer.ebay.com/DevZone/guides/features-guide/default.html#Development/Feature-SalesTax.html
For most applicable calls, returns the words No Error or returns an error message
related to an attempt to calculate shipping rates. For calculated shipping only.
<br><br>
The message text explains that a postal code is needed to calculate
shipping. Only returned when <b>ItemDetails</b> is set to <code>Fine</code>.
GetItemShipping
Conditionally
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ReturnAll
Conditionally
A shipping rate scale for shipping through USPS that affects the shipping cost calculated for USPS (lower if <strong>ShippingRateType</strong> is <code>DailyPickup</code>). <strong>ShippingRateType</strong> is returned only if the value of <strong>ShippingService</strong> is one of the USPS shipping services. For calculated shipping only.
GetItemShipping
Conditionally
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
https://developer.ebay.com/DevZone/guides/features-guide/default.html#Development/Shipping-TypesCosts.html#UPSRateScales
UPS Rate Scales
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. A separate <b>ShippingServiceOptions</b> container is needed for each domestic shipping service option that is available to ship the item. Unless a fulfillment business policy is being used, generally at least one <b>ShippingServiceOptions</b> container will be required.
<br><br>
If you specify multiple <b>ShippingServiceOptions</b> nodes, the repeating nodes must be
contiguous. For example, you can insert <b>InternationalShippingServiceOption</b> nodes
after a list of repeating <b>ShippingServiceOptions</b> nodes, but not between them:
<br><br>
<code>
<ShippingServiceOptions>...</ShippingServiceOptions><br>
<ShippingServiceOptions>...</ShippingServiceOptions><br>
<ShippingServiceOptions>...</ShippingServiceOptions><br>
<InternationalShippingServiceOption>...</InternationalShippingServiceOption><br>
<InternationalShippingServiceOption>...</InternationalShippingServiceOption>
</code>
<br><br>
If you specify <b>ShippingDetails</b> when you revise or relist an item but you omit
<b>ShippingServiceOptions</b>, eBay will drop the domestic shipping services from the
listing. This may also have unintended side effects, as other fields that depend
on this data may be dropped as well.
<br/><br/>
To retain the shipping services and
dependent fields when you modify other shipping details, it may be simplest to
specify all <b>ShippingDetails</b> that you still want to include in the listing.
<br><br>
A seller can offer up to four domestic shipping services and up to five
international shipping services. However, if the seller is opted in to the Global Shipping Program, only four other international shipping services may be offered (regardless of whether or not Global Shipping is offered for the listing). All specified domestic and international
shipping services must be the same shipping type (for example, Flat versus
Calculated).
<br/><br/>
<span class="tablenote"><b>Note: </b>
If the seller has set the shipping cost model to 'Flat' or 'Calculated' (<b>ShippingDetails.ShippingType</b> field), at least one actual shipping service option must be specified through a <b>ShippingServiceOptions</b> container. In the past, eBay allowed users to set the shipping cost model to 'Flat' or 'Calculated', and then just pass in one <b>ShippingServiceOptions</b> container with the <b>ShippingServiceOptions.ShipppingService</b> value set to a 'Local Pickup' option. Now, sellers must pass in at least one actual domestic shipping service option in addition to any 'Local Pickup' option, or the listing will be blocked with the following error: <em>17510 - You must specify at least one domestic shipping service, other than or in addition to Local Pickup.</em>
</span>
<br>
For <b>GetItemShipping</b>, results are filtered: if any service is not available
in the buyer's region, it is removed. If no services remain after this
filtering, a warning is returned.
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnAttributes, ItemReturnDescription, ReturnAll
Always
AddFixedPriceItem
AddItem
AddItems
AddSellingManagerTemplate
RelistFixedPriceItem
RelistItem
ReviseFixedPriceItem
ReviseItem
ReviseSellingManagerTemplate
VerifyAddFixedPriceItem
VerifyAddItem
VerifyRelistItem
Conditionally
GetMyeBayBuying
BestOfferList
BidList
DeletedFromWonList
WonList
WatchList
DetailLevel: none, ReturnAll
Conditionally
GetMyeBaySelling
GetItemTransactions
DetailLevel: none, ReturnAll
Conditionally
GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
Conditionally
GetItemShipping
GetSellingManagerSaleRecord
DetailLevel: none
Conditionally
GetOrders
DetailLevel: none, ReturnAll
Conditionally
OrderReport
Conditionally
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
AddOrder
ReviseSellingManagerSaleRecord
No
https://developer.ebay.com/DevZone/guides/features-guide/default.html#Basics/Call-APISchema.html#Repeating
Repeating (Unbounded) Fields
rules regarding repeating instances of a nodes (nodes for which maxOccurs is "unbounded" or is greater than 1)
Shipping costs and options related to an international shipping service. If used, at least one domestic shipping service must also be provided in <b>ShippingServiceOptions</b>.
<br><br>
If you specify multiple <b>InternationalShippingServiceOption</b> nodes, the repeating nodes must be contiguous. That is, you cannot insert other nodes between <b>InternationalShippingServiceOption</b> nodes.
<br><br>
All specified domestic and international shipping services must be the same shipping type (for example, Flat versus Calculated).
<br><br>
A seller can offer up to four domestic shipping services and up to five international shipping services. However, if the seller is opted in to the Global Shipping Program, only four other international shipping services may be offered (regardless of whether or not Global Shipping is offered for the listing).
<br><br>
If you specify <b>ShippingDetails</b> when you revise or relist an item but you omit <b>InternationalShippingServiceOption</b>, eBay will drop the international shipping services (except the Global Shipping Program) from the listing. This may also have unintended side effects, as other fields that depend on this data may be dropped as well. To retain the shipping services and dependent fields when you modify other shipping details, it may be simplest to specify all <b>ShippingDetails</b> that you still want to include in the listing.
<br><br>
For <b>GetItemShipping</b>, results are filtered: if any service is not available in the buyer's region, it is removed. If no services remain after this filtering, a warning is returned.
AddFixedPriceItem
AddItem
AddItems
AddSellingManagerTemplate
AddOrder
RelistFixedPriceItem
RelistItem
ReviseFixedPriceItem
ReviseItem
ReviseSellingManagerTemplate
VerifyAddFixedPriceItem
VerifyAddItem
VerifyRelistItem
No
GetBidderList
GetItemShipping
DetailLevel: none
Conditionally
GetOrders
DetailLevel: none, ReturnAll
Conditionally
OrderReport
Conditionally
GetItem
GetSellingManagerTemplates
Conditionally
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
Conditionally
GetItemTransactions
DetailLevel: none, ReturnAll
Conditionally
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetMyeBayBuying
BestOfferList
BidList
DeletedFromWonList
WonList
WatchList
DetailLevel: none, ReturnAll
Conditionally
https://developer.ebay.com/DevZone/guides/features-guide/default.html#Basics/Call-APISchema.html#Repeating
Repeating (Unbounded) Fields
rules regarding repeating instances of a nodes (nodes for which maxOccurs is "unbounded" or is greater than 1)
The shipping cost model offered by the seller. This is not returned for
various calls since shipping type can be deduced: if a <b>CalculatedShippingRate</b>
structure is returned by the call, the shipping type is Calculated. Otherwise,
it is one of the other non-Calculated shipping types.
<br><br>
<b>GetItemShipping and GetItemTransactions</b>:
If the type was a mix of flat and calculated services, this is
set simply to Flat or Calculated because it is the buyer's
selection that results in one of these.
<br><br>
<b>GetMyeBayBuying</b>:
If the seller has set the <b>ShipToLocation</b> to <code>Worldwide</code> for an item, but has not specified any international shipping service options, <code>NotSpecified</code> is returned as the <b>ShippingType</b> value.
AddFixedPriceItem
AddItem
AddItems
AddSellingManagerTemplate
RelistFixedPriceItem
RelistItem
ReviseFixedPriceItem
ReviseItem
ReviseSellingManagerTemplate
VerifyAddFixedPriceItem
VerifyAddItem
VerifyRelistItem
Free, Freight
No
GetSellingManagerSoldListings
Always
GetItemShipping
Always
Free, Freight
GetBidderList
Free
Conditionally
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Free, Freight
Conditionally
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnAttributes, ReturnAll
Free, Freight
Conditionally
GetMyeBayBuying
GetMyeBaySelling
Free, Freight
Conditionally
The sale record ID. Applicable to Selling Manager users.
When an item is sold, Selling Manager generates a sale record.
A sale record contains buyer information, shipping, and other information.
A sale record is displayed in the Sold view in Selling Manager.
Each sale record has a sale record ID.
<br/><br/>
In the following calls,
the value for the sale record ID is in the <b>SellingManagerSalesRecordNumber</b> field:
<b>GetItemTransactions</b>, <b>GetSellerTransactions</b>, <b>GetOrders</b>, <b>GetOrderTransactions</b>.
In the Selling Manager calls, the value for the sale record ID is in the
<b>SaleRecordID</b> field.
<br><br>
<b>For GetOrders, GetOrderTransactions, and GetItemTransactions only:</b> If using Trading WSDL Version 1019 or above, this field will only be returned to the buyer or seller, and no longer returned at all to third parties. If using a Trading WSDL older than Version 1019, the real record number is only returned to the buyer or seller, and a dummy value of <code>0</code> will be returned to all third parties.
<br/><br/>
The sale record ID can be for a single or a multiple line item order.
GetItemTransactions
GetOrderTransactions
GetSellerTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetOrders
DetailLevel: none, ReturnAll
Conditionally
OrderReport
Conditionally
This field is deprecated.
Tax details for a jurisdiction, such as a state or province. If no tax table
is associated with the item, a tax table is not returned.
<br><br>
For <b>GetItem</b>, a tax table is returned if it exists when:
<ul>
<li><b>DetailLevel</b> is set to <code>ReturnAll</code> or <b>ItemReturnDescription</b> (in this case,
the value of <b>IncludeTaxTable</b> does not matter)</li>
<li><b>IncludeTaxTable</b> is set to <code>true</code> and <b>DetailLevel</b> is not set or it is set
to <code>ItemReturnAttributes</code></li>
</ul>
GetItem
GetSellingManagerTemplates
DetailLevel: ItemReturnDescription, ReturnAll
Conditionally
GetBidderList
Conditionally
GetOrderTransactions
DetailLevel: ReturnAll
Conditionally
GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
GranularityLevel: Coarse, Medium, Fine
Conditionally
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ReturnAll
Conditionally
GetOrders
DetailLevel: none, ReturnAll
Conditionally
OrderReport
Conditionally
This field is deprecated.
The shipping service actually used by the seller to ship the item(s) to the
buyer.
ShippingServiceCodeType
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
The field is deprecated.
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
<b>FlatShippingDiscount</b> or <b>CalculatedShippingDiscount</b>).
<br/><br/>
On output, this is the ID
of the shipping discount offered and corresponds to whichever is returned:
<b>FlatShippingDiscount</b> or <b>CalculatedShippingDiscount</b>. Only returned if the calling user is the seller.
<br/><br/>
If the user created a shipping discount profile,
use the <b>ShippingDiscountProfileID</b>.
<br><br>
In the <b>RelistItem</b> and <b>ReviseItem</b> family of calls, you can remove the existing
<b>ShippingDiscountProfileID</b> associated with the item by supplying a value of 0 (zero).
<br><br>
Only returned if the calling user is the seller.
AddFixedPriceItem
AddItem
AddItems
AddSellingManagerTemplate
RelistFixedPriceItem
RelistItem
ReviseFixedPriceItem
ReviseItem
ReviseSellingManagerTemplate
VerifyAddFixedPriceItem
VerifyAddItem
VerifyRelistItem
Conditionally
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnAttributes, ItemReturnDescription, ReturnAll
Conditionally
https://developer.ebay.com/DevZone/guides/features-guide/default.html#Development/Shipping-OtherFeatures.html#ShippingCostDiscountProfiles
Shipping Cost Discount Profiles
If a flat rate shipping discount was offered for the domestic shipping
services, this contains the details of the flat rate shipping discount.
Otherwise, it is not returned. Only returned if the calling user is the seller.
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnAttributes, ItemReturnDescription, ReturnAll
Conditionally
https://developer.ebay.com/DevZone/guides/features-guide/default.html#Development/Shipping-OtherFeatures.html#ShippingCostDiscountProfiles
Shipping Cost Discount Profiles
If a calculated shipping discount was offered for the domestic shipping
services, this contains the details of the calculated shipping discount.
Otherwise, it is not returned. Only returned if the calling user is the seller.
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnAttributes, ItemReturnDescription, ReturnAll
Conditionally
https://developer.ebay.com/DevZone/guides/features-guide/default.html#Development/Shipping-OtherFeatures.html#ShippingCostDiscountProfiles
Shipping Cost Discount Profiles
On input, this specifies whether to offer the promotional shipping discount for
the domestic shipping services of this listing (only applicable if the seller
has a promotional shipping discount in effect at the moment).
<br><br>
Returned on output only if the seller is making the call. This indicates
whether the promotional shipping discount is being offered for the domestic
shipping services of this listing (if the listing is still active—this is only
possible if the seller has a promotional shipping discount in effect at the
moment) or whether the discount was offered at the time the listing ended.
AddFixedPriceItem
AddItem
AddItems
AddSellingManagerTemplate
RelistFixedPriceItem
RelistItem
ReviseFixedPriceItem
ReviseItem
ReviseSellingManagerTemplate
VerifyAddFixedPriceItem
VerifyAddItem
VerifyRelistItem
Conditionally
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnAttributes, ItemReturnDescription, ReturnAll
Conditionally
https://developer.ebay.com/DevZone/guides/features-guide/default.html#Development/Shipping-OtherFeatures.html#ShippingCostDiscountProfiles
Shipping Cost Discount Profiles
On input, this is the ID of the shipping discount to offer for the
international shipping services (where the shipping discount is either
of type <b>FlatShippingDiscount</b> or <b>CalculatedShippingDiscount</b>).
<br><br>
In the <b>RelistItem</b> and <b>ReviseItem</b> family of calls, you can remove the existing
<b>InternationalShippingDiscountProfileID</b> associated with the item by supplying a
value of 0 (zero).
<br><br>
Returned on output only if the seller is making the call. The value is
the ID of the shipping discount offered and corresponds to whichever
is returned: <b>FlatShippingDiscount</b> or <b>CalculatedShippingDiscount</b>.
<br><br>
If the user created a shipping discount profile, use
<b>InternationalShippingDiscountProfileID</b>.
AddFixedPriceItem
AddItem
AddItems
AddSellingManagerTemplate
RelistFixedPriceItem
RelistItem
ReviseFixedPriceItem
ReviseItem
ReviseSellingManagerTemplate
VerifyAddFixedPriceItem
VerifyAddItem
VerifyRelistItem
Conditionally
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnAttributes, ItemReturnDescription, ReturnAll
Conditionally
https://developer.ebay.com/DevZone/guides/features-guide/default.html#Development/Shipping-OtherFeatures.html#ShippingCostDiscountProfiles
Shipping Cost Discount Profiles
This value is returned only if the seller is making the call. If a flat
rate shipping discount was offered for the international shipping
services, this contains the details of the flat rate shipping discount.
Otherwise, it is not returned.
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnAttributes, ItemReturnDescription, ReturnAll
Conditionally
https://developer.ebay.com/DevZone/guides/features-guide/default.html#Development/Shipping-OtherFeatures.html#ShippingCostDiscountProfiles
Shipping Cost Discount Profiles
This value is returned only if the seller is making the call. If a
calculated shipping discount was offered for the international shipping
services, this contains the details of the calculated shipping
discount. Otherwise, it is not returned.
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnAttributes, ItemReturnDescription, ReturnAll
Conditionally
https://developer.ebay.com/DevZone/guides/features-guide/default.html#Development/Shipping-OtherFeatures.html#ShippingCostDiscountProfiles
Shipping Cost Discount Profiles
On input, this specifies whether to offer the promotional shipping
discount for the listing's international shipping services (only
applicable if the seller has a promotional shipping discount in effect
at the moment).
<br><br>
Returned on output only if the seller is making the call. This value
indicates whether the promotional shipping discount is being offered
for the international shipping services of this listing (if the listing
is still active—this is only possible if the seller has a promotional
shipping discount in effect at the moment) or whether the discount was
offered at the time the listing ended.
AddFixedPriceItem
AddItem
AddItems
AddSellingManagerTemplate
RelistFixedPriceItem
RelistItem
ReviseFixedPriceItem
ReviseItem
ReviseSellingManagerTemplate
VerifyAddFixedPriceItem
VerifyAddItem
VerifyRelistItem
Conditionally
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnAttributes, ItemReturnDescription, ReturnAll
Conditionally
https://developer.ebay.com/DevZone/guides/features-guide/default.html#Development/Shipping-OtherFeatures.html#ShippingCostDiscountProfiles
Shipping Cost Discount Profiles
This value is returned only if the seller is making the call. Contains details of the promotional shipping discount, if such is being offered while the listing is active or if it was offered at the time the listing ended.
GetShippingDiscountProfiles
Conditionally
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnAttributes, ItemReturnDescription, ReturnAll
Conditionally
https://developer.ebay.com/DevZone/guides/features-guide/default.html#Development/Shipping-OtherFeatures.html#ShippingCostDiscountProfiles
Shipping Cost Discount Profiles
This dollar value indicates the money due from the buyer upon delivery of the item.
<br><br>
This field should only be specified in the request if 'COD' (cash-on-delivery) is a
valid payment method for the site and it is included as a <b>PaymentMethods</b>
value in the same request.
<br><br>
This field is only returned if set for the listing.
<br><br>
To see if 'COD' is a supported payment method for a site, call <b>GetCategoryFeatures</b>, specifying the listing category ID, and including the <b>FeatureID</b> field set to <b>PaymentMethods</b>. Look for
a value of 'CashOnPickup' in one of the <b>Category.PaymentMethod</b>
fields in the response.
AddFixedPriceItem
AddItem
AddItems
AddOrder
AddSellingManagerTemplate
RelistFixedPriceItem
RelistItem
ReviseFixedPriceItem
ReviseItem
ReviseSellingManagerTemplate
VerifyAddFixedPriceItem
VerifyAddItem
VerifyRelistItem
Conditionally
GetItemShipping
Conditionally
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnAttributes, ItemReturnDescription, ReturnAll
Conditionally
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetOrders
DetailLevel: none, ReturnAll
Conditionally
OrderReport
Conditionally
GetOrderTransactions
Order
DetailLevel: none, ItemReturnDescription, ReturnAll
Transaction
Conditionally
Specifying the COD Option in Shipping Details
https://developer.ebay.com/DevZone/guides/features-guide/default.html#Development/Shipping-OtherFeatures.html#SpecifyingtheCashonDeliveryOptioninShipp
Use this field to specify an international country or region, or a special domestic
location, such as 'PO Box' (in US) or 'Packstation' (in DE), to where you
will not ship the associated item. Repeat this element in the call request for each
location that you want to exclude as a shipping destination for your item.
<br><br>
Set <b>ShipToRegistrationCountry</b> to <code>true</code> to have your <b>ExcludeShipToLocation</b>
settings applied to your listing. The locations you have excluded display in
the Shipping and Handling section of your item listing.
<br><br>
If a buyer's primary ship-to location is a location that you have listed as
an excluded ship-to location (or if the buyer does not have a primary ship-to
location), they will receive an error message if they attempt to buy or place
a bid on your item.
<br><br>
The exclude ship-to location values are eBay regions and countries. To see
the valid exclude ship-to locations for a specified site, call <b>GeteBayDetails</b>
with <b>DetailName</b> set to <b>ExcludeShippingLocationDetails</b>,
and then look for the <b>ExcludeShippingLocationDetails.Location</b> fields in the response.
Repeat <b>GeteBayDetails</b> for each site on which you list.
<br><br>
This field works in conjunction with <b>Item.ShipToLocation</b>s to create a set of
international countries and regions to where you will, and will not, ship.
You can list a region in the <b>ShipToLocations</b> field, then exclude specific
countries within that region with this field (for example, you can specify
Africa in <b>ShipToLocations</b>, yet exclude Chad with a <b>ExcludeShipToLocation</b>
setting). In addition, if your <b>ShipToLocations</b> is <code>Worldwide</code>, you can use
this field to specify both regions and countries that you want to exclude
from your shipping destinations.
<br><br>
You can specify a default set of locations to where you will not ship in My
eBay. If you create an Exclude Ship-To List, it is, by default, in effect
when you list items. However, if you specify any value in this field on
input, it nullifies the default settings in your Exclude Ship-To List. (If
you use <b>ExcludeShipToLocation</b> when you list an item, you will need to list
all the locations to where you will not ship the associated item, regardless
of the default settings in your Exclude Ship-To List.)
<br><br>
Specify <code>none</code> in this field to override the default Exclude Ship-To List you
might have set up in My eBay and indicate that you do not want to exclude any
shipping locations from the respective item listing.
<br><br>
<span class="tablenote"><strong>Note:</strong>
To enable your default Exclude Ship-To List, you must enable Exclude
Shipping Locations and Buyer Requirements in your My eBay Site Preferences.
For details, see the KnowledgeBase Article <a href=
"https://ebaydts.com/eBayKBDetails?KBid=1495"
>HowTo: ExcludeShipToLocation</a>.
</span>
ShippingRegionCodeType, CountryCodeType
GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
Conditionally
GetItem
Conditionally
DetailLevel: none, ItemReturnAttributes, ItemReturnDescription, ReturnAll
GetItemShipping
Conditionally
GetItemTransactions
GetOrderTransactions
GetSellerTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
AddFixedPriceItem
AddItem
AddItemFromSellingManagerTemplate
AddItems
RelistFixedPriceItem
RelistItem
ReviseFixedPriceItem
ReviseItem
ReviseTemplate
VerifyAddFixedPriceItem
VerifyAddItem
VerifyRelistItem
Conditionally
Sellers can set up a global Exclude Ship-To List through their My eBay account.
The Exclude Ship-To List defines the countries to where the seller does not
ship, by default.
<br><br>
This flag returns true if the Exclude Ship-To List is enabled by the seller for
the associated item. If <code>false</code>, the seller's Exclude Ship-To List is either not
set up, or it has been overridden by the seller when they listed the item with
ExcludeShipToLocation fields.
<br><br>
In the response, <b>ExcludeShipToLocation</b> fields detail the locations to where the
seller will not ship the item, regardless of the value returned in this field.
GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
GranularityLevel: Fine
Conditionally
GetBidderList
Conditionally
GetItem
DetailLevel: none, ItemReturnAttributes, ItemReturnDescription, ReturnAll
VerifyRelistItem
Conditionally
Container for the shipping carrier and tracking information associated with the
shipment of an order.
<br><br>
As each package has a unique tracking number, this container should be
repeated for each package in the order.
<br>
<br>
<span class="tablenote"><b>Note:</b>
Top-rated sellers must have a record of uploading shipment tracking
information (through site or through API) for at least 90 percent of their order line
items (purchased by U.S. buyers) to keep their status as Top-rated sellers. For more
information on eBay's Top-rated seller program, see the <a href="http://pages.ebay.com/help/sell/top-rated.html">Becoming a Top Rated Seller and qualifying for Top Rated Plus</a> page.
</span>
<br>
<span class="tablenote"><b>Note:</b>
Shipment tracking information does not appear in Merchant Data API's <b>OrderReport</b> or <b>SoldReport</b> responses, because once shipment tracking information is provided to the buyer, the order/order line item is considered acknowledged, and acknowledged orders do not show up in <b>OrderReport</b> or <b>SoldReport</b> responses.
</span>
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetOrders
DetailLevel: none, ReturnAll
Conditionally
This container is used to reference and apply a seller's specific domestic and/or international shipping rate tables to a listing. Shipping rate tables allow sellers to configure specific shipping costs based on the shipping destinations and level of service (e.g. economy, standard, expedited, and one-day). Generally speaking, sellers want to use these shipping rate tables so they can charge a higher shipping cost to the buyer whenever shipping costs are higher for them as well. For example, shipping to Alaska or Hawaii is generally more expensive than shipping to any other of the 48 US states, or in regards to international shipping, shipping to some regions and countries are more expensive than others.
<br><br>
Sellers configure domestic and international shipping rate tables in My eBay Shipping Preferences. To apply shipping rate tables, the shipping cost type must be flat-rate.
<br><br>
For domestic shipping rate tables, the three supported domestic regions are Alaska & Hawaii, US Protectorates (e.g. Puerto Rico and Guam), and APO/FPO destinations, which are US military bases/locations outside of the continental US. In addition to setting one flat rate based on the destination and service level, the seller also has the option of adding an extra charge based on the weight of the shipping package, or they can add a surcharge instead. To determine if a domestic shipping rate table is set up for the seller's account, the <b>GetUser</b> call can be used, and then the seller will look for a value of <code>true</code> in the <b>User.SellerInfo.DomesticRateTable</b> field. Although the <b>GetUser</b> call can be used to see if a domestic shipping rate table exists for the seller's account, details of the shipping rate table, including all specified costs for the different regions, can only be viewed and modified in My eBay Shipping Preferences. This functionality is not yet available in any public APIs.
<br><br>
For international shipping rate tables, specific rates may be set up for any and all of the nine geographical regions and individual countries within those regions. Similar to domestic shipping rate tables, the seller has the option of adding an extra charge based on the weight of the shipping package. Sellers cannot add a surcharge for international shipping. To determine if a international shipping rate table is set up for the seller's account, the <b>GetUser</b> call can be used, and then the seller will look for a value of <code>true</code> in the <b>User.SellerInfo.InternationalRateTable</b> field. Although the <b>GetUser</b> call can be used to see if an international shipping rate table exists for the seller's account, details of the shipping rate table, including all specified costs for the different regions/countries, can only be viewed and modified in My eBay Shipping Preferences. This functionality is not yet available in any public APIs.
<br/><br/>
If you are applying a domestic or international shipping rate table that specifies a surcharge by weight, you must specify the item weight in the <b>ShippingPackageDetails</b> container's <b>WeightMajor</b> and <b>WeightMinor</b> fields, even though the listing is using flat-rate shipping. Do not use any other fields in the <b>ShippingPackageDetails</b> container because none of those fields are applicable in this use case.
<br><br>
This container is only returned in the 'Get' calls if one or more shipping rate tables have been applied to the listing, and if the call is being made by the seller who listed the item.
<br/><br/>
<span class="tablenote"><b>Note: </b> The capability to create and use multiple domestic and international shipping rate tables (up to 40 per seller account) has rolled out to the US, Australia, UK, Germany, Canada (English and French), and Italy sites. For other sites, only one domestic and one international shipping rate table may be set up per seller. Whether a seller is using the old default domestic and international shipping rate tables or the new shipping rate tables, these shipping rate tables are set up in My eBay Shipping Preferences or as part of a Shipping Business Policy. If using the Trading API to create a listing that will use the new shipping rate tables, the <b>DomesticRateTableId</b> and <b>InternationalRateTableId</b> fields are used to reference and apply these new shipping rate tables to the listing. If desired, sellers can still use the old default shipping rate tables, but they are not allowed to mix and match old and new shipping rate tables, meaning that they will get an error if they pass in both the old fields (<b>DomesticRateTable</b> and <b>InternationalRateTable</b>) and the new fields (<b>DomesticRateTableId</b> and <b>InternationalRateTableId</b>). The new shipping rate tables have all of the functionality of the old shipping rate tables, plus the seller has access to all domestic regions and not just the special regions (such as Alaska & Hawaii, US Protectorates, and APO/FPO locations in US).</span>
AddFixedPriceItem
AddItem
AddItems
AddSellingManagerTemplate
RelistFixedPriceItem
RelistItem
ReviseFixedPriceItem
ReviseItem
VerifyAddFixedPriceItem
VerifyAddItem
VerifyRelistItem
ReviseSellingManagerTemplate
No
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnAttributes, ItemReturnDescription, ReturnAll
Conditionally
GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
Conditionally
Using Shipping Rate Tables
http://developer.ebay.com/DevZone/guides/features-guide/default.html#development/Shipping-TypesCosts.html#UsingShippingRateTables
more information on using shipping rate tables.
This type is not currently in use.
This field is not currently in use.
This field is not currently in use.
Miscellaneous details of the shipment.
Confirmation requested.
Signature requested upon receipt.
Stealth postage.
Saturday delivery.
Other.
Not defined.
(out) Reserved for internal or future use.
This type is deprecated, as Shipping Insurance can no longer be offered by the seller to the buyer in the APIs.
orders.
Whether the seller offers shipping insurance and, if
so, whether the insurance is optional or required. Flat and
calculated shipping.
1031
NoOp
1031
A pairing of range of item price total and insurance cost.
For SetShippingDiscountProfiles, if InsuranceOption is Optional or Required, you must
submit all range pairs. For those ranges that do not apply, set the cost to 0.
1031
NoOp
1031
Details about a region or location to which the seller is willing to ship.
Short name or abbreviation for a region (e.g., Asia) or location (e.g. Japan).
ShippingDetails.InternationalShippingServiceOption in AddItem
AddItem.html#Request.Item.ShippingDetails.InternationalShippingServiceOption
GeteBayDetails
Conditionally
Display string that applications can use to present a list of shipping locations in
a more user-friendly format (such as in a drop-down list). This field is localized
in the language of the site.
GeteBayDetails
Conditionally
Returns the latest version number for this field. The version can be
used to determine if and when to refresh cached client data.
GeteBayDetails
DetailLevel: none, ReturnSummary, ReturnAll
Always
Gives the time in GMT that the feature flags for the details were last
updated. This timestamp can be used to determine if and when to refresh
cached client data.
GeteBayDetails
DetailLevel: none, ReturnSummary, ReturnAll
Always
This type is reserved for internal or future use.
This field is reserved for internal or future use.
This field is reserved for internal or future use.
The nature of the package used to ship the item(s).
Required for calculated shipping only. Not all package types
are supported by a specific shipping service (ShippingServiceCodeType).
None
Letter
LargeEnvelope
USPS Large Package/Oversize 1
Very Large Package/Oversize 2
Extra Large Package/Oversize 3
UPS Letter
USPS Flat Rate Envelope
Package/thick envelope
Roll
Europallet
Onewaypallet
Bulky goods
Furniture
Cars
Motorbikes
Caravan
Industry vehicles
Parcel or padded Envelope
Small Canada Post Box
Medium Canada Post Box
Large Canada Post Box
Small Canada Post Bubble Mailer
Medium Canada Post Bubble Mailer
Large Canada Post Bubble Mailer
Padded Bags
Tough Bags
Expandable Tough Bags
Mailing Boxes
Winepak
Reserved for internal or future use.
Details about type of package used to ship an item.
Numeric identifier.
Some applications use this ID to look up shipping packages more efficiently.
GeteBayDetails
Conditionally
Display string that applications can use to present a list of shipping package
options in a more user-friendly format (such as in a drop-down list).
GeteBayDetails
Conditionally
A supported value for the site that can be used in the
<b>Item.ShippingPackageDetails.ShippingPackage</b> or
<b>Item.ShippingDetails.CalculatedShippingRate.ShippingPackage</b> fields
of an Add/Revise/Relist API call.
GeteBayDetails
Conditionally
Indicates if the package type is the default for the specified site.
GeteBayDetails
Conditionally
This field is returned as 'true' if the shipping package supports the use of
package dimensions.
false
GeteBayDetails
Conditionally
Returns the latest version number for this field. The version can be
used to determine if and when to refresh cached client data.
GeteBayDetails
DetailLevel: none, ReturnSummary, ReturnAll
Always
Gives the time in GMT that the feature flags for the details were last
updated. This timestamp can be used to determine if and when to refresh
cached client data.
GeteBayDetails
DetailLevel: none, ReturnSummary, ReturnAll
Always
Type defining the <b>ShippingPackageInfoType</b> container, which is returned in order management calls. The <b>ShippingPackageInfoType</b> container provides information on delivery times and tracking information for a shipping package.
The unique identifier of the store from where the order will be delivered. This field is only applicable to 'In-Store Pickup' and 'Click and Collect' orders.
GetOrders
DetailLevel: none, ReturnAll
Conditionally
OrderReport
Conditionally
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ReturnAll
Conditionally
This enumeration value indicates whether or not the order has been picked up from the store indicated by the <b>StoreID</b> value. This field is only applicable to 'In-Store Pickup' and 'Click and Collect' orders.
ShippingTrackingEventCodeType
GetOrders
DetailLevel: none, ReturnAll
Conditionally
OrderReport
Conditionally
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ReturnAll
Conditionally
The <b>ScheduledDeliveryTimeMin</b> and <b>ScheduledDeliveryTimeMax</b> timestamps indicate the delivery window for which the buyer can expect to receive the order. The <b>ScheduledDeliveryTimeMin</b> value indicates the earliest time that the buyer can expect to receive the order.
<br><br>
The <b>ScheduledDeliveryTimeMin</b> and <b>ScheduledDeliveryTimeMax</b> fields will start being returned once the seller marks the order as shipped/provides tracking information. Until then, the <b>EstimatedDeliveryTimeMin</b> and <b>EstimatedDeliveryTimeMax</b> dates are returned instead.
<br><br>
<span class="tablenote"><b>Note:</b>
This field does not appear in Merchant Data API's <b>OrderReport</b> or <b>SoldReport</b> responses, because once shipment tracking information is provided to the buyer, the order/order line item is considered acknowledged, and acknowledged orders do not show up in <b>OrderReport</b> or <b>SoldReport</b> responses.
</span>
GetOrders
DetailLevel: none, ReturnAll
Conditionally
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ReturnAll
Conditionally
The <b>ScheduledDeliveryTimeMin</b> and <b>ScheduledDeliveryTimeMax</b> timestamps indicate the delivery window for which the buyer can expect to receive the order. The <b>ScheduledDeliveryTimeMax</b> value indicates the latest time that the buyer can expect to receive the order.
<br><br>
The <b>ScheduledDeliveryTimeMin</b> and <b>ScheduledDeliveryTimeMax</b> fields will start being returned once the seller marks the order as shipped/provides tracking information. Until then, the <b>EstimatedDeliveryTimeMin</b> and <b>EstimatedDeliveryTimeMax</b> dates are returned instead.
<br><br>
<span class="tablenote"><b>Note:</b>
This field does not appear in Merchant Data API's <b>OrderReport</b> or <b>SoldReport</b> responses, because once shipment tracking information is provided to the buyer, the order/order line item is considered acknowledged, and acknowledged orders do not show up in <b>OrderReport</b> or <b>SoldReport</b> responses.
</span>
GetOrders
DetailLevel: none, ReturnAll
Conditionally
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ReturnAll
Conditionally
This timestamp indicates when the order was actually delivered to the buyer. This field is only returned after the order has been delivered to the buyer.
<br><br>
<span class="tablenote"><b>Note:</b>
This field does not appear in Merchant Data API's <b>OrderReport</b> or <b>SoldReport</b> responses, because once shipment tracking information is provided to the buyer (or marked as shipped), the order/order line item is considered acknowledged, and acknowledged orders do not show up in <b>OrderReport</b> or <b>SoldReport</b> responses.
</span>
GetOrders
DetailLevel: none, ReturnAll
Conditionally
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ReturnAll
Conditionally
The <b>EstimatedDeliveryTimeMin</b> and <b>EstimatedDeliveryTimeMax</b> timestamps indicate the window during which the buyer can expect delivery. The <b>EstimatedDeliveryTimeMin</b> value indicates the earliest date and time that the buyer can expect to receive the order.
<br><br>
The <b>EstimatedDeliveryTimeMin</b> and <b>EstimatedDeliveryTimeMax</b> dates are only estimates made by eBay, and their accuracy will depend on the seller meeting the handling time deadline. Once the seller ships the order, and marks it as shipped/provides tracking information, the more accurate delivery dates can be found in the the <b>ScheduledDeliveryTimeMin</b> and <b>ScheduledDeliveryTimeMax</b> fields.
GetOrders
ShippingServiceSelected
DetailLevel: none, ReturnAll
Conditionally
OrderReport
ShippingServiceSelected
Conditionally
GetOrderTransactions
ShippingServiceSelected
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetItemTransactions
GetSellerTransactions
ShippingServiceSelected
DetailLevel: none, ReturnAll
Conditionally
The <b>EstimatedDeliveryTimeMin</b> and <b>EstimatedDeliveryTimeMax</b> timestamps indicate the window during which the buyer can expect delivery. The <b>EstimatedDeliveryTimeMax</b> value indicates the latest date and time that the buyer can expect to receive the order.
<br><br>
The <b>EstimatedDeliveryTimeMin</b> and <b>EstimatedDeliveryTimeMax</b> dates are only estimates made by eBay, and their accuracy will depend on the seller meeting the handling time deadline. Once the seller ships the order, and marks it as shipped/provides tracking information, the more accurate delivery dates can be found in the the <b>ScheduledDeliveryTimeMin</b> and <b>ScheduledDeliveryTimeMax</b> fields.
GetOrders
ShippingServiceSelected
DetailLevel: none, ReturnAll
Conditionally
OrderReport
ShippingServiceSelected
Conditionally
GetOrderTransactions
ShippingServiceSelected
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetItemTransactions
GetSellerTransactions
ShippingServiceSelected
DetailLevel: none, ReturnAll
Conditionally
This timestamp indicates the latest date/time that the seller should ship the package to ensure that the package arrives to the buyer within the estimated delivery window. This date/time is calculated by adding the handling time (in days) to the purchase time.
<br><br>
This field is applicable for domestic shipping services, and for Click and Collect orders in the UK and Australia.
GetOrders
DetailLevel: none, ReturnAll
ShippingServiceSelected
Conditionally
OrderReport
ShippingServiceSelected
Conditionally
GetOrderTransactions
ShippingServiceSelected
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetItemTransactions
GetSellerTransactions
ShippingServiceSelected
DetailLevel: none, ReturnAll
Conditionally
The <b>MinNativeEstimatedDeliveryTime</b> and <b>MaxNativeEstimatedDeliveryTime</b> timestamps indicate the window during which the buyer can expect delivery based on the seller's handling time and selected shipping service. The <b>MinNativeEstimatedDeliveryTime</b> value indicates the earliest date and time that the buyer can expect to receive the order.
<br><br>
This field is applicable for domestic shipping services, and for Click and Collect orders in the UK and Australia.
GetOrders
ShippingServiceSelected
DetailLevel: none, ReturnAll
Conditionally
OrderReport
ShippingServiceSelected
Conditionally
GetOrderTransactions
ShippingServiceSelected
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetItemTransactions
GetSellerTransactions
ShippingServiceSelected
DetailLevel: none, ReturnAll
Conditionally
The <b>MinNativeEstimatedDeliveryTime</b> and <b>MaxNativeEstimatedDeliveryTime</b> timestamps indicate the window during which the buyer can expect delivery based on the seller's handling time and selected shipping service. The <b>MaxNativeEstimatedDeliveryTime</b> value indicates the latest date and time that the buyer can expect to receive the order.
<br><br>
This field is applicable for domestic shipping services, and for Click and Collect orders in the UK and Australia.
GetOrders
ShippingServiceSelected
DetailLevel: none, ReturnAll
Conditionally
OrderReport
ShippingServiceSelected
Conditionally
GetOrderTransactions
ShippingServiceSelected
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetItemTransactions
GetSellerTransactions
ShippingServiceSelected
DetailLevel: none, ReturnAll
Conditionally
A shipping rate scale for shipping through UPS that affects the shipping cost calculated for UPS (lower if <strong>ShippingRateType</strong> is <code>DailyPickup</code>). For calculated shipping only.
"On-demand" shipping rate scale.
"Daily pickup" shipping rate scale.
"Standard List" shipping rate scale.
"Counter" shipping rate scale.
"Discounted" shipping rate scale.
"Commercial Plus" shipping rate scale.
"Commercial Plus Discounted Rate1" shipping rate scale.
"Commercial Plus Discounted Rate2" shipping rate scale.
(out) Reserved for internal or future use.
Regions to which the seller is willing to ship the item.
These values are applicable to ShipToLocation.
Africa
Asia
Caribbean
Europe
Latin America
Middle East
North America
Oceania (Pacific region other than Asia)
South America
European Union
Seller will not ship the item.
Seller has specified Worldwide or eBay has
determined that the specified regions add up to Worldwide.
Americas
Reserved for internal or future use
A shipping service used to ship an item. Applications should not depend on the completeness of <strong>ShippingServiceCodeType</strong>. Instead, applications should call GeteBayDetails, with a <strong>DetailName</strong> value of <code>ShippingServiceDetails</code>, to return the complete list of shipping services. To check for the shipping services available for a specific site, specify the site ID in the header.
<br/><br/>
<span class="tablenote">
<strong>Note:</strong> It is possible that some of the returned shipping services can no longer be used in the AddItem family of calls. To distinguish between the valid and invalid shipping services, look for the <strong>ValidForSellingFlow</strong> flag in the <strong>ShippingServiceDetails</strong> node. If this flag is not returned for a specific shipping service, that shipping service can no longer be used in the AddItem family of calls.
</span>
CA_PostExpeditedFlatRateBox, CA_PostExpeditedFlatRateBoxUSA, FreightOtherShipping, SameDayShipping, UK_RoyalMailStandardParcel
UPS Ground
UPS 3rd Day
UPS 2nd Day
UPS Next Day
USPS Priority
USPS Parcel Select Non-Presort
USPS Standard Post
USPS Media
USPS First Class
Standard shipping method
Reserved for internal or future use
USPS Priority Mail Express
UPS Next Day Air
UPS Next Day Air
USPS Priority Mail Express Flat Rate Envelope
To use this service, a seller must specify the package weight so that eBay
can validate the weight against the maximum weight limit for the service.
The seller must also specify a package size of Package/Thick Envelope when
using a calculated shipping service.
USPS Priority Mail Express Padded Flat Rate Envelope
To use this service, a seller must specify the package weight so that eBay
can validate the weight against the maximum weight limit for the service.
The seller must also specify a package size of Package/Thick Envelope when
using a calculated shipping service.
USPS Priority Mail Flat Rate Envelope
To use this service, a seller must specify the package weight so that eBay
can validate the weight against the maximum weight limit for the service.
The seller must also specify a package size of Package/Thick Envelope when
using a calculated shipping service.
USPS Priority Mail Small Flat Rate Box
To use this service, a seller must specify the package weight so that eBay
can validate the weight against the maximum weight limit for the service.
The seller must also specify a package size of Package/Thick Envelope when
using a calculated shipping service.
USPS Priority Mail Flat Rate Box
To use this service, a seller must specify the package weight so that eBay
can validate the weight against the maximum weight limit for the service.
The seller must also specify a package size of Package/Thick Envelope when
using a calculated shipping service.
USPS Priority Mail Large Flat Rate Box
To use this service, a seller must specify the package weight so that eBay
can validate the weight against the maximum weight limit for the service.
USPS Priority Mail Padded Flat Rate Envelope
To use this service, a seller must specify the package weight so that eBay
can validate the weight against the maximum weight limit for the service.
USPS Priority Mail Legal Flat Rate Envelope
To use this service, a seller must specify the package weight so that eBay
can validate the weight against the maximum weight limit for the service.
USPS Priority Mail Express Legal Flat Rate Envelope
To use this service, a seller must specify the package weight so that eBay
can validate the weight against the maximum weight limit for the service.
USPS Priority Mail Regional Box A
To use this service, a seller must specify the package weight so that eBay
can validate the weight against the maximum weight limit for the service.
USPS Priority Mail Regional Box B
To use this service, a seller must specify the package weight so that eBay
can validate the weight against the maximum weight limit for the service.
USPS Priority Mail Regional Box C
To use this service, a seller must specify the package weight so that eBay
can validate the weight against the maximum weight limit for the service.
USPS Priority Mail Express Flat Rate Box
To use this service, a seller must specify the package weight so that eBay
can validate the weight against the maximum weight limit for the service.
Other (see description)
Local Delivery/Pickup
Not Selected
International Not Selected
Standard International Flat Rate Shipping
Expedited International Flat Rate Shipping
USPS Global Express Mail
USPS Global Priority Mail
USPS Economy Parcel Post
USPS Economy Letter Post
USPS Airmail Letter Post
USPS Airmail Parcel Post
UPS Worldwide Express Plus
UPS Worldwide Express
UPS Worldwide Expedited
UPS Worldwide Saver
UPS Standard To Canada
USPS Priority Mail Express International Flat Rate Envelope
To use this service, a seller must specify the package weight so that eBay
can validate the weight against the maximum weight limit for the service.
The seller must also specify a package size of Package/Thick Envelope when
using a calculated shipping service.
USPS Priority Mail Express International Padded Flat Rate Envelope
To use this service, a seller must specify the package weight so that eBay
can validate the weight against the maximum weight limit for the service.
The seller must also specify a package size of Package/Thick Envelope when
using a calculated shipping service.
USPS Priority Mail International Flat Rate Envelope
To use this service, a seller must specify the package weight so that eBay
can validate the weight against the maximum weight limit for the service.
The seller must also specify a package size of Package/Thick Envelope when
using a calculated shipping service.
USPS Priority Mail International Small Flat Rate Box
To use this service, a seller must specify the package weight so that eBay
can validate the weight against the maximum weight limit for the service.
The seller must also specify a package size of Package/Thick Envelope when
using a calculated shipping service.
USPS Priority Mail International Flat Rate Box
To use this service, a seller must specify the package weight so that eBay
can validate the weight against the maximum weight limit for the service.
The seller must also specify a package size of Package/Thick Envelope when
using a calculated shipping service.
USPS Priority Mail International Large Flat Rate Box
To use this service, a seller must specify the package weight so that eBay
can validate the weight against the maximum weight limit for the service.
USPS Priority Mail International Padded Flat Rate Envelope
To use this service, a seller must specify the package weight so that eBay
can validate the weight against the maximum weight limit for the service.
USPS Priority Mail International Legal Flat Rate Envelope
To use this service, a seller must specify the package weight so that eBay
can validate the weight against the maximum weight limit for the service.
USPS Priority Mail Express International Legal Flat Rate Envelope
To use this service, a seller must specify the package weight so that eBay
can validate the weight against the maximum weight limit for the service.
USPS Priority Mail Express International Flat Rate Box
To use this service, a seller must specify the package weight so that eBay
can validate the weight against the maximum weight limit for the service.
Other International Shipping (see description)
Standardversand (unversichert)
Versicherter Versand
Einschreiben (Versand inkl. Einschreibengebuhr)
Nachnahme (Versand inkl. Nachnahmegebuhr)
Express- oder Kurierversand
Versicherter Express- oder Kurierversand
Sonder-/Speditionsversand (z.B. Mobel, KFZ)
Versicherter Sonder-/Speditionsversand (z.B. Mobel, KFZ)
Sonstige (Siehe Artikelbeschreibung)
Unversicherter Versand International
Versicherter Versand International
Sonstiger Versand International
Unversicherter Express Versand International
Versicherter Express Versand International
Sparversand aus dem Ausland
Standardversand aus dem Ausland
Expressversand aus dem Ausland
Versand mit Nachverfolgung aus dem Ausland
Regular
Express
Registered
Courier
Other
EMS International Courier - Parcels
EMS International Courier - Documents
Express Post International - Documents
Air Mail
Economy Air
Sea Mail
Standard International Flat Rate Postage
Expedited international flat rate postage
Other international postage
Australia Post Registered Post International Padded Bag 1 kg
Australia Post Registered Post International Padded Bag 500 g
Australia Post Registered Post International Parcel
Expedited delivery from outside Australia
Economy delivery from outside Australia
Standard Delivery From Outside AU
Australian Air Express Metro 15 kg
Australian Air Express Flat Rate 5 kg
Australian Air Express Flat Rate 3 kg
Australian Air Express Flat Rate 1 kg
Express delivery (1-3 business days) in Australia
Standard delivery (1-6 business days) in Australia
eBay/Australian Post 3 kg Flat Rate Satchel
eBay/Australian Post 500 g Flat Rate Satchel
Freight delivery in Australia. Used for heavy and bulky items.
Livraison standard a partir de l'etranger
Livraison express
Colis
Courrier en recommande
Autre service de livraison
De Post
UPS
FedEx
DHL
TPG Post/TNT (Netherlands)
Frais de livraison internationale fixes
Frais fixes pour livraison internationale express
Autres livraisons internationales (voir description)
La Poste (France)
La Poste - livraison standard (1 a 2 jours ouvrables)
La Poste - envoi recommande (1 jour ouvrable)
La Poste - Taxipost LLS (2 jours ouvrables)
La Poste - Taxipost 24h (1 jour ouvrable)
Autres livraisons
La Poste - livraison standard
La Poste - envoi recommande
TNT
Livraison economique a partir de l'etranger
Livraison standard a partir de l'etranger
Livraison express a partir de l'etranger
Livraison a partir de l'etranger avec suivi de commande
Standard Delivery
Priority Delivery
Parcel Post
Registered Mail
Other Shipping Service
De Post
UPS
FedEx
DHL
TPG Post/TNT (Netherlands)
Standard International
Expedited International
Other International Shipping Services
La Poste (France)
De Post - standaardverzending (1 tot 2 werkdagen)
De Post - aangetekende zending (1 werkdag)
De Post - Taxipost LLS (2 werkdagen)
De Post - Taxipost 24u (1 werkdag)
De Post - Taxipost Secur (1 werkdag)
Andere verzending
De Post - standaardverzending
De Post - aangetekende zending
TNT
Voordelige verzending uit het buitenland
Standaardverzending uit het buitenland
Express verzending uit het buitenland
Verzending uit het buitenland met internationale tracking
Standard Delivery
Expedited delivery
Canada Post Lettermail
Canada Post Regular Parcel
Canada Post Expedited Parcel
Canada Post Xpresspost - International
Canada Post Priority Courier
Canada Post Expedited Flat Rate Box
(This value is no longer used.)
Standard International Flat Rate Shipping
Expedited International Flat Rate Shipping
Other International Shipping (see description)
Canada Post Expedited Parcel - USA
Canada Post Small Packets - USA
Canada Post Xpresspost - USA
Canada Post Xpresspost - International
Canada Post International Parcel - Surface
Canada Post International Parcel - Air
Small Packets - International
Purolator International
Canada Post Small Packets - USA - Ground
Canada Post Small Packets - USA - Air
Small Packets - International - Ground
Small Packets - International - Air
Canada Post USA Letter-post
Canada Post International Letter-post
(This value is no longer used.)
UPS Express Canada
UPS Express Saver Canada
UPS Expedited Canada
UPS Standard Canada
UPS Express United States
UPS Expedited United States
UPS 3 Day Select United States
UPS Standard United States
UPS Worldwide Express
UPS Worldwide Expedited
Canada Post Priority Worldwide
Canada Post Expedited Flat Rate Box USA
Canada Post Tracked Packet - USA
Canada Post Tracked Packet - International
Freight
Standardversand (A-Post/Priority)
Standardversand (B-Post/Economy)
Versicherter Versand (z.B. Assurance/Fragile)
Einschreiben (Versand inkl. Einschreibengebuhr)
Nachnahme (Versand inkl. Nachnahmegebuhr)
Express- oder Kurierversand
Versicherter Express- oder Kurierversand
Sonder-/Speditionsversand (z.B. Mobel, KFZ)
Versicherter Sonder-/Speditionsversand (z.B. Mobel, KFZ)
Sonstige (Siehe Artikelbeschreibung)
Sonstiger Versand (Siehe Artikelbeschreibung)
ECONOMY Sendungen
PRIORITY Sendungen
URGENT Sendungen
Sparversand aus dem Ausland
Standardversand aus dem Ausland
Expressversand aus dem Ausland
Versand mit Nachverfolgung aus dem Ausland
Seller door delivery (limited to the city)
China Post Post Office
Logistics company express
EMS Express
Other (see item description)
China Post Express Mail
City Express
Off-site delivery
International Standard Fixed Freight
International courier fixed freight
Other international shipping charges (see note)
COD (same city only)
Standard Mailing
Regular logistics
EMS
Others (see description)
Unversicherter Versand
Versicherter Versand
Einschreiben (Versand inkl. Einschreibengebuhr)
Nachnahme (Versand inkl. Nachnahmegebuhr)
Express- oder Kurierversand
Versicherter Express- oder Kurierversand
Sonderversand (z.B. Mobel, KFZ)DE_DHLPackchen
Versicherter Sonderversand (z.B. Mobel, KFZ)
Unversicherter Versand
Deutsche Post Brief
eBay DHL Paket 24/7 (Abgabe und Lieferung an Packstation)
DHL Postpaket
DHL Packchen International
Deutsche Post Warensendung
Deutsche Post Buchersendung
Hermes Paket (unversichert)
Hermes Paket (versichert)
iloxx Transport XXL
iloxx Express
iloxx Standard
Sonstige (Siehe Artikelbeschreibung)
Unversicherter Versand
Versicherter Versand
DHL Postpaket International
DHL Packchen International
Sonstiger Versand (Siehe Artikelbeschreibung)
Unversicherter Express - Versand
Versicherter Express - Versand
Deutsche Post Brief (Land)
Deutsche Post Brief (Luft)
iloxx Europa
iloxx World Wide
Paketversand
Expressversand
DHL Paket
Deutsche Post Buecher-/Warensendung
Hermes Paket
iloxx Transport
Sonstige
Einschreiben (inkl. aller Gebuehren)
Nachnahme (inkl. aller Gebuehren)
Sonderversand
UPS
DPD
GLS
Paketversand
DHL Paket International
DHL Paket International Express
Sonstige
Expressversand
Deutsche Post Brief
iloxx Transport International
Hermes Paket International
UPS International
DPD International
GLS International
eBay Hermes Paket Shop2Shop (Kaeufer erhaelt E-Mail von Hermes bei Zustellung)
Hermes Paket Shop2Shop (Kaeufer erhaelt E-Mail von Hermes bei Zustellung)
eBay Hermes Paket Shop2Shop
Hermes Paket Shop2Shop
Hermes Paket Sperrgut
eBay Hermes Paket Sperrgut Shop2Shop (Abgabe und Zustellung im Paketshop)
DHL Paeckchen Packstation
DHL Paket Packstation
eBay DHL Paeckchen
DHL Star-Paeckchen
Versand mit Nachverfolgung aus dem Ausland
Cartas nacionales hasta 20 gr
Correos: cartas ordinarias
Cartas internacionales hasta 20 gr
Cartas internacionales de mas de 20 gr
Paquete Azul (nacional) hasta 2 kg
Correos: Postal Expres
Paquete Internacional Economico
Otro courier 24 horas
Otros (ver descripcion)
Envio internacional estandar
Envio internacional urgente
Envio internacional economico
Cartas y tarjetas postales internacionales
Ems postal expres internacional
Paquete internacional economico
Envio economico desde el extranjero
Envio estandar desde el extranjero
Envio urgente desde el extranjero
Envio desde el extranjero con seguimiento
Entrega a un Kiala point hasta 8 kg
Chronoposte International Classic
Coliposte Colissimo Direct
DHL Express Europack
UPS Standard
Lettre
Lettre avec suivi
Lettre recommandee
Colissimo
Colissimo Recommande
Contre remboursement
Autre mode d'envoi de courrier
Ecopli
Colieco
Autre mode d'envoi de colis
Remise en main propre
Autre livraison internationale standard
Autre livraison internationale express
Autre livraison internationale economique
La Poste - Courrier International Prioritaire
La Poste - Courrier International Economique
La Poste - Colissimo International
La Poste - Colis Economique International
La Poste - Colissimo Emballage International
Chronopost Classic International
Chronopost Premium International
UPS Standard
UPS Express
DHL
La Poste Lettre Max
Livraison en Relais Kiala
Livraison a partir de l'etranger avec suivi de commande
National - Regular
National - Express
National - COD
Local - Courier
Local - COD
International - Standard
International - Expedited
International - other
Flat Rate COD
Buyer picks up and pays
Posta ordinaria
Posta prioritaria
Posta raccomandata
Posta raccomandata con contrassegno
Posta assicurata
Posta celere
Pacco ordinario
Pacco celere 1
Pacco celere 3
Corriere espresso
Paccocelere Maxi
Spedizione internazionale standard a prezzo fisso
Spedizione internazionale celere a prezzo fisso
Altre spedizioni internazionali (vedi descrizione)
Spedizione tracciata dall estero
Standaardverzending
Pakketpost
Verzending met ontvangstbevestiging
Andere verzendservice
TPG Post/TNT
UPS
FedEx
DHL
DPD (Germany)
GLS (Business only)
Vaste kosten standaard internationale verzending
Vaste kosten versnelde internationale verzending
Andere internationale verzending (zie beschrijving)
Voordelige verzending uit het buitenland
Standaardverzending uit het buitenland
Verzending per expresse uit het buitenland
Verzending met internationale tracering uit het buitenland
Post office plus registration
Post office without registration
Post office cash on delivery
Home delivery
Home delivery cash on delivery
Face to face
Freight delivery
Express delivery
Other
Post Office Airbag
Post office air parcel
Post office aviation registered packet
Post office aviation registration package
Post Office International Express EMS
Post office international land and water package
FedEx International Priority
FedEx International Economy
UPS Worldwide Expedited
UPS Worldwide Express
UPS Worldwide Express Plus
Other international shipping charges (see description)
Royal Mail 1st Class
Royal Mail 2nd Class
Royal Mail 1st Class Signed For
Royal Mail 2nd Class Signed For
Royal Mail Special Delivery
(This value is no longer used.)
Parcelforce 24
Parcelforce 48
Other Courier
Hermes Tracked
Collect+ : drop at store-delivery to door
Seller's Standard Rate
Collection in Person
Sellers Standard International Rate
Royal Mail Airmail
Royal Mail Airsure
Royal Mail Surface Mail
Royal Mail International Signed-for
Royal Mail HM Forces Mail
Parcelforce International Datapost
Parcelforce Ireland 24
Parcelforce Euro 48
Parcelforce International Scheduled
Other courier or delivery service
Collect in person
Parcelforce Global Express
Parcelforce Global Value
Parcelforce Global Economy (Not available for destinations in Europe)
Tracked delivery from outside abroad
International tracked postage
Seller's standard rate
First Class Letter Service
SwiftPost National
Registered Post
EMS SDS Courier
Economy SDS Courier
Other courier
Collection in person
Seller's Standard International Rate
International Economy Service
International Priority Service
SwiftPost Express
SwiftPost International
EMS SDS Courier
Economy SDS Courier
Other courier or delivery service
International collection in person
Economy delivery from abroad
Standard delivery from abroad
Express delivery from abroad
Tracked delivery from abroad
Domestic Regular shipping
Domestic Special shipping
Przesylka z zagranicy - ekonomiczna
Przesylka z zagranicy - standardowa
Przesylka z zagranicy - ekspresowa
Przesylka z zagranicy - ze sledzeniem
Service associated with FreightQuote.com
(This value is no longer used.)
Service associated with any freight service other than FreightQuote.com
Freight Shipping International
US Postal Service Ground
Overnight flat rate shipping service (domestic only)
Reserved for internal or future use
USPS Priority Flat Rate Envelope
USPS Priority Flat Rate Box
USPS Global Priority Mail Small Envelope
USPS Global Priority Mail Large Envelope
USPS Priority Mail Express Flat Rate Envelope
UPS Worldwide Express Box 10 Kg
UPS Worldwide Express Box 25 Kg
UPS Worldwide Express Plus Box 10 Kg
UPS Worldwide Express Plus box 25 Kg
Local pick up only
Local courier
Domestic regular shipping
Domestic special shipping
International regular shipping
International special shipping
Local pick up only
Local courier
Domestic standard mail
Domestic non standard mail
Domestic Speedpost Islandwide
International standard mail
International Express Mail Service (EMS)
International courier (DHL, FedEx, UPS)
De Post zending - NON PRIOR (2 werkdagen)
De Post zending - PRIOR (1 werkdag)
De Post zending - aangetekend (1 werkdag)
Kilopost pakje (2 werkdagen)
Taxipost (express)
Kiala afhaalpunt (1 tot 4 werkdagen)
Vaste kosten standaard verzending
Vaste kosten versnelde verzending
Verzekerde verzending
La Poste envoi NON PRIOR (2 jours ouvrables)
La Poste envoi PRIOR (1 jour ouvrable)
La Poste envoi recommande (1 jour ouvrable)
Paquet Kilopost (2 jours ouvrables)
Taxipost (express)
Point retrait Kiala (1 a 4 jours ouvrables)
Livraison standard - prix forfaitaire
Livraison express - prix forfaitaire
Livraison securisee
De Post zending - PRIOR
De Post zending - NON PRIOR
De Post zending - aangetekend
Kilopost pakje Internationaal
Taxipost expressverzending
Verzekerde verzending
La Poste envoie PRIOR
La Poste envoie NON PRIOR
La Poste envoie recommande
Paquet Kilopost Internationale
BEFR_Express Taxipost
Livraison standard internationale - prix forfaitaire
Livraison express internationale - prix forfaitaire
Livraison securisee
Chronopost
Royal Mail Special Delivery; 1:00 pm
Canada Post Light Packet International
Canada Post Light Packet USA
DHL
Przesylka zagraniczna - zwykla
Przesylka zagraniczna - priorytetowa
UPS
Normes de livraison postale
Expedition acceleree
Postes Canada, Poste-lettres
Postes Canada, Colis standard
Postes Canada, Colis acceleres
Postes Canada, Xpresspost
Postes Canada, Messageries prioritaires
Expedition standard - International, tarif fixe
Expedition acceleree - International, tarif fixe
Autres services d'expedition internationale (voir description)
Postes Canada, Colis acceleres - E.U.
Postes Canada, Petits paquets - E.U.
Postes Canada, Xpresspost - E.U.
Postes Canada, Xpresspost - International
Postes Canada, Colis international de surface
Postes Canada, Colis-avion - International
Petits paquets - International
Purolator International
Postes Canada, Petits paquets - E.U. service de surface
Postes Canada, Petits paquets - E.U. par avion
Petits paquets - International, courrier-surface
Petits paquets - International, courrier-avion
Postes Canada, Poste aux lettres - E.U.
Postes Canada, Poste aux lettres - International
UPS Express Saver
UPS Express Saver Canada
UPS Expedited Canada
UPS Standard au Canada
UPS Express Etats-Unis
UPS Expedited Etats-Unis
3Day Select aux Etats-Unis
UPS Standard aux Etats-Unis
UPS Worlwide Express
UPS Worlwide Expedited
Royal Mail Special Delivery 9:00 am
USPS First Class Mail Intl / First Class Package Intl Service
USPS Priority Mail International
USPS Priority Mail Express International
Standardpauschale fur internationalen Versand
Expresspauschale fur internationalen Versand
Sonstiger Versand (Siehe Artikelbeschreibung)
International Standard Fixed Rate for Taiwan
International Express Fixed Rate for Taiwan
USPS Global Express Guaranteed
Regular with Insurance
Express with Insurance
Deutsche Post Warensendung
Deutsche Post Byendung
Hermes Paket (unversichert)
Hermes Paket (versichert)
iloxx Transport XXL
iloxx Ubernacht Express
iloxx Standard
Standardpauschale fur internationalen Versand
Expresspauschale fur internationalen Versand
Deutsche Post Presse & Bucher Economy
Deutsche Post Presse & Bucher Priority
AT_BITTE_TREFFEN_SIE_EINE_AUSWAHL
Einschreiben (Versand inkl. Einschreibengebuhr)
Nachnahme (Versand inkl. Nachnahmegebuhr)
Express- oder Kurierversand
Versicherter Express- oder Kurierversand
Sonderversand (z.B. Sperrgut, KFZ)
Versicherter Sonderversand (z.B. Sperrgut, KFZ)
Standardpauschale fur internationalen Versand
Expresspauschale fur internationalen Versand
Sonstiger Versand (Siehe Artikelbeschreibung)
CH_BITTE_TREFFEN_SIE_EINE_AUSWAHL
Unversicherter Versand
Versicherter Versand
Einschreiben (Versand inkl. Einschreibengebuhr)
Nachnahme (Versand inkl. Nachnahmegebuhr)
Express- oder Kurierversand
Versicherter Express- oder Kurierversand
Sonderversand (z.B. Sperrgut, KFZ)
Versicherter Sonderversand (z.B. Sperrgut, KFZ)
Standardversand (A-Post/Priority)
Standardversand (B-Post/Economy)
DE_BITTE_TREFFEN_SIE_EINE_AUSWAHL
Einschreiben (Versand inkl. Einschreibengebuhr)
Nachnahme (Versand inkl. Nachnahmegebuhr)
Express- oder Kurierversand
Versicherter Express- oder Kurierversand
Sonderversand (z.B. Mobel, KFZ)
Versicherter Sonderversand (z.B. Mobel, KFZ)
Deutsche Post Brief
Standard Int'l Flat Rate Postage
Expedited Int'l Flat Rate Postage
Other Int'l Postage (see description)
Standard Int'l Flat Rate Postage
Expedited Int'l Flat Rate Postage
Other Int'l Postage (see description)
Chronopost - Chrono Relais
Chrono 10
Chrono 13
Chrono 18
Chronopost Express International
PickUp Only Service
Delivery
Pickup Only Service
Abholung
Pickup
Small Parcels
Small Parcel With Tracking
Small Parcel With Tracking And Signature
Regular Parcel With Tracking
Regular Parcel With Tracking And Signature
PrePaid Express Post Satchel 5kg
PrePaid Parcel Post Satchels 500g
PrePaid Parcel Post Satchels 3kg
PrePaid Parcel Post Satchels 5kg
PrePaid Express Post Satchel 500g
PrePaid Express Post Satchel 3kg
PrePaid Express Post Platinum 500g
PrePaid Express Post Platinum 3kg
Express Courier International
Express Post International
PrePaid Express Post International Envelope C5
PrePaid Express Post International Envelope B4
PrePaid Express Post International Satchels 2kg
PrePaid Express Post International Satchels 3kg
PrePaid Express Post International Box 5kg
PrePaid Express Post International Box 10kg
PrePaid Express Post International Box 20kg
Registered Parcel Post
Registered Small Parcel
Registered Parcel Post Prepaid Satchel 500g
Registered Parcel Post Prepaid Satchel 3kg
Registered Parcel Post Prepaid Satchel 5kg
eBay Australia Post Express Post 500g Satchel
eBay Australia Post Express Post 3kg Satchel
Enlevement
Pickup
Afhalen
Pickup
Pickup
Pickup
Pickup
Pickup
Pickup
Pickup
Other 24 Hour Courier
Other 48 Hour Courier
Other Courier 3 days
Other Courier 5 days
Courier Shipping
FedEx Priority Overnight
FedEx Standard Overnight
FedEx 2Day
FedEx Ground
FedEx Home Delivery
FedEx Express Saver
Reserved for internal or future use
Reserved for internal or future use
FedEx International First
FedEx International Priority
FedEx International Economy
FedEx International Ground
Economy shipping from outside US
Expedited shipping from outside US
Standard shipping from outside US
Economy postage from outside UK
Express postage from outside UK
Standard postage from outside UK
Economy postage from outside DE
Standard postage from outside DE
Express postage from outside DE
DHL 2kg Paket (nur fuer kurze Zeit)
Global Shipping Program
<br/>
This shipping service must be selected for the international leg of the shipment.
Reserved for future use.
Royal Mail Tracked 24
Royal Mail Tracked 48
This value indicates that the order will be delivered by an eBay On Demand valet through the eBay On Demand Delivery program.
Type defining the <b>ShippingServiceCostOverrideList</b> 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 <b>SellerProfiles.SellerShippingProfile.ShippingProfileID</b> field of an Add/Revise/Relist call.
<br/><br/>
Shipping service cost overrides are a listing-level concept, and the shipping costs specified through each <b>ShippingServiceCostOverrideList.ShippingServiceCostOverride</b> container will not change the shipping costs defined for the same shipping services in the Business Policies shipping profile.
A <b>ShippingServiceCostOverride</b> container is required for each domestic and/or international shipping service option, defined in the <b>domesticShippingPolicyInfoService</b> and <b>intlShippingPolicyInfoService</b> containers of the Business Policies shipping profile, that the seller wishes to override the shipping costs. Shipping costs include the cost to ship one item, the cost to ship each additional identical item, and any shipping surcharges applicable to domestic shipping services.
<br/><br/>
Shipping service cost overrides are a listing-level concept, and the shipping costs specified through each <b>ShippingServiceCostOverride</b> container will not change the shipping costs defined for the same shipping service options in the Business Policies shipping profile.
<br/><br/>
To override the shipping costs for any domestic shipping service option in the Business Policies shipping profile, the <b>ShippingServiceType</b> field should be set to 'Domestic', and to override the shipping costs for any international shipping service option, the <b>ShippingServiceType</b> field should be set to 'International'. For both domestic and international shipping services, the <b>ShippingServicePriority</b> value should match the <b>sortOrderId</b> value for the matching shipping service in the shipping profile. If any of the domestic and/or international shipping service priorities and shipping service options in the Add/Revise/Relist call and Business Policies shipping profile do not match, an error occurs.
<br/><br/>
If shipping service cost overrides are used in a listing, the <b>ShippingServiceCostOverride</b> container will be returned in the <b>GetItem</b>, <b>GetSellerList</b>, and <b>GetSellingManagerTemplates</b> calls.
AddFixedPriceItem
AddItem
AddItems
VerifyAddItem
VerifyAddFixedPriceItem
VerifyRelistItem
RelistFixedPriceItem
RelistItem
ReviseFixedPriceItem
ReviseItem
AddSellingManagerTemplate
ReviseSellingManagerTemplate
No
GetItem
GetSellerList
GetSellingManagerTemplates
Conditionally
Type defining the <strong>ShippingServiceCostOverride</strong> container, which is used to override the flat shipping costs for a domestic and/or international shipping service option that is defined in the <strong>domesticShippingPolicyInfoService</strong> and <strong>intlShippingPolicyInfoService</strong> containers of the Business Policies shipping profile. Shipping costs include the cost to ship one item, the cost to ship each additional identical item, and any shipping surcharges applicable to domestic shipping services. A <strong>ShippingServiceCostOverride</strong> container is required for each domestic and/or international shipping service option whose costs the seller wishes to override.
This integer value maps the particular instance of the <strong>ShippingServiceCostOverride</strong> container to the <strong>domesticShippingPolicyInfoService</strong> or <strong>intlShippingPolicyInfoService</strong> container of the Business Policies shipping profile. The <strong>ShippingServicePriority</strong> value should match the <strong>sortOrderId</strong> value for the matching shipping service in the Business Policies shipping profile. If overriding the shipping costs for a domestic shipping service, the <strong>ShippingServiceType</strong> field should be set to 'Domestic', and to override the shipping costs for an international shipping service, the <strong>ShippingServiceType</strong> field should be set to 'International'.
<br/><br/>
If any of the domestic and/or international shipping service priorities and shipping service options in the Add/Revise/Relist call and Business Policies shipping profile do not match, an error occurs.
AddFixedPriceItem
AddItem
AddItems
VerifyAddItem
VerifyAddFixedPriceItem
VerifyRelistItem
RelistFixedPriceItem
RelistItem
ReviseFixedPriceItem
ReviseItem
No
GetItem
GetSellerList
GetSellingManagerTemplates
Conditionally
This enumerated value indicates whether the shipping costs of a domestic or an international shipping costs are being overridden. To override the shipping costs for any domestic shipping service in the Business Policies shipping profile, this field should be set to 'Domestic', and to override the shipping costs for any international shipping service, this field should be set to 'International'.
AddFixedPriceItem
AddItem
AddItems
VerifyAddItem
VerifyAddFixedPriceItem
VerifyRelistItem
RelistFixedPriceItem
RelistItem
ReviseFixedPriceItem
ReviseItem
No
GetItem
GetSellerList
GetSellingManagerTemplates
Conditionally
This dollar value indicates the shipping service cost to ship one item to the buyer. If the shipping service costs override operation is successful, this value will override the corresponding <strong>shippingServiceCost</strong> value set in the <strong>domesticShippingPolicyInfoService</strong> (domestic shipping service) or <strong>intlShippingPolicyInfoService</strong> (international shipping service) containers in the Business Policies shipping profile.
AddFixedPriceItem
AddItem
AddItems
VerifyAddItem
VerifyAddFixedPriceItem
VerifyRelistItem
RelistFixedPriceItem
RelistItem
ReviseFixedPriceItem
ReviseItem
No
GetItem
GetSellerList
GetSellingManagerTemplates
Conditionally
This dollar value indicates the cost to ship each additional identical item to the buyer. If the shipping service costs override operation is successful, this value will override the corresponding <strong>shippingServiceAdditionalCost</strong> value set in the <strong>domesticShippingPolicyInfoService</strong> (domestic shipping service) or <strong>intlShippingPolicyInfoService</strong> (international shipping service) containers in the Business Policies shipping profile.
<br/><br/>
This field is only applicable to multi-quantity, fixed-price listings.
AddFixedPriceItem
AddItem
AddItems
VerifyAddItem
VerifyAddFixedPriceItem
VerifyRelistItem
RelistFixedPriceItem
RelistItem
ReviseFixedPriceItem
ReviseItem
No
GetItem
GetSellerList
GetSellingManagerTemplates
Conditionally
This dollar value indicates the shipping surcharge applicable to the domestic shipping service. If the shipping service costs override operation is successful, this value will override the corresponding <strong>shippingSurcharge</strong> value set in the <strong>domesticShippingPolicyInfoService</strong> container in the Business Policies shipping profile.
<br/><br/>
This field can only be used if the shipping surcharges are applicable for the corresponding shipping service.
AddFixedPriceItem
AddItem
AddItems
VerifyAddItem
VerifyAddFixedPriceItem
VerifyRelistItem
RelistFixedPriceItem
RelistItem
ReviseFixedPriceItem
ReviseItem
No
GetItem
GetSellerList
GetSellingManagerTemplates
Conditionally
Type used by the <b>ShippingServiceDetails</b> containers that are returned in the <b>GeteBayDetails</b> response. Each <b>ShippingServiceDetails</b> container consists of detailed information about each shipping service option available for the specified country. These details include the shipping service enumeration value to use when specifying shipping service options in an Add/Revise/Relist call, the shipping carrier, the shipping category (e.g. expedited, economy, etc.), the shipping packages that can be used, and the shipping delivery window.
<br/><br/>
<b>ShippingServiceDetails</b> containers are returned if a <b>DetailName</b> field is included in the call request and set to <code>ShippingServiceDetails</code>, or if no <b>DetailName</b> field is included in the call request.
Display string that applications can use to present a list of shipping service
options in a more user-friendly format (such as in a drop-down list).
GeteBayDetails
Always
Indicates whether a domestic shipping service option is an expedited shipping service. This field is only returned under a <b>ShippingServiceDetails</b> if <code>true</code>. Expedited generally means that the shipment of the order can arrive at the buyer's location within one or two business days.
GeteBayDetails
Conditionally
Indicates whether the shipping service is an international shipping service.
An international shipping service option is required if an item is being
shipped from one country (origin) to another (destination).
Item.ShippingDetails.InternationalShippingServiceOption in AddItem
AddItem.html#Request.Item.ShippingDetails.InternationalShippingDiscountProfileID
GeteBayDetails
Conditionally
The name of shipping service option. The ShippingServiceDetails.<strong>ValidForSellingFlow</strong> flag must also be present and <code>true</code>. Otherwise, that particular shipping service option is no longer valid and cannot be offered to buyers through a listing.
<br/><br/>
This token value is the text that a seller will provide in the ShippingDetails.ShippingServiceOptions.<strong>ShippingService</strong> field when creating a listing.
GeteBayDetails
Conditionally
Numeric identifier. A value greater than 50000 represents an
international shipping service (confirmed by
<strong>InternationalShippingService</strong> being true). Some applications use this ID
to look up shipping services more efficiently.
GeteBayDetails
Conditionally
The integer value returned here indicates the maximum number of business days that the shipping carrier (indicated in the corresponding <b>ShippingCarrier</b> field) will take to ship an item using the corresponding shipping service option (indicated in the <b>ShippingService</b> field).
<br><br>
This maximum shipping time does not include the seller's handling time, and the clock starts on the shipping time only after the seller has delivered the item to the shipping carrier for shipment to the buyer. 'Business days' can vary by shipping carrier and by country, but 'business days' are generally Monday through Friday, excluding holidays. This field is returned if defined for that particular shipping service option.
<br><br>
For sellers opted into and using eBay Guaranteed Delivery, they should be looking at this value, and this value plus their handling time stated in the listing cannot be greater than 4 business days in order for that listing to be eligible for eBay Guaranteed Delivery.
GeteBayDetails
Conditionally
The integer value returned here indicates the minimum number of business days that the shipping carrier (indicated in the corresponding <b>ShippingCarrier</b> field) will take to ship an item using the corresponding shipping service option (indicated in the <b>ShippingService</b> field).
<br><br>
This minimum shipping time does not include the seller's handling time, and the clock starts on the shipping time only after the seller has delivered the item to the shipping carrier for shipment to the buyer. 'Business days' can vary by shipping carrier and by country, but 'business days' are generally Monday through Friday, excluding holidays. This field is returned if defined for that particular shipping service option.
GeteBayDetails
Conditionally
For future use.
The shipping cost types that this shipping service option supports, such as flat-rate or calculated. A <strong>ServiceType</strong> field is returned for each shipping cost type supported by the shipping service option.
GeteBayDetails
Conditionally
Flat, Calculated
The shipping packages that can be used for this shipping service option. A <strong>ShippingPackage</strong> field is returned for each shipping package supported by the shipping service option.
GeteBayDetails
Conditionally
This field is only returned if the shipping service option requires that package dimensions are provided by the seller. This field is only returned if 'true'.
GeteBayDetails
Conditionally
If this field is returned as 'true', the shipping service option can be used in a Add/Revise/Relist API call. If this field is returned as 'false', the shipping service option is not currently supported and cannot be used in a Add/Revise/Relist API call.
GeteBayDetails
Conditionally
This field is only returned if 'true', and indicates that a shipping surcharge is applicable for this shipping service option.
GeteBayDetails
Conditionally
The enumeration value for the shipping carrier associated with the shipping service option.
<br/><br/>
<span class="tablenote">
<strong>Note:</strong> Commonly used shipping carriers can also be found by calling <b>GeteBayDetails</b> with <b>DetailName</b> set to <code>ShippingCarrierDetails</code> and examining the returned <b>ShippingCarrierDetails.ShippingCarrier</b> field.
</span>
GeteBayDetails
Conditionally
This field is only returned if'true', and indicates that the corresponding <b>ShippingServiceDetails.ShippingService</b> value is a COD (Cash-On-Delivery) service.
<br/><br/>
COD shipping services are not supported by all sites.
GeteBayDetails
Conditionally
A mechanism by which details about deprecation of a shipping service is
announced. See also MappedToShippingServiceID.
If this container is empty, it means that there is no mapping for this
shipping service and that the shipping service will be dropped from the
listing without an accompanying warning message from the eBay API.
GeteBayDetails
Conditionally
https://developer.ebay.com/DevZone/guides/features-guide/default.html#Development/Shipping-Services.html#DeprecatedShippingServices
Deprecated Shipping Services
The ID of another shipping service that will be used when a
shipping service is deprecated. See also DeprecationDetails.
GeteBayDetails
Conditionally
https://developer.ebay.com/DevZone/guides/features-guide/default.html#Development/Shipping-Services.html#DeprecatedShippingServices
Deprecated Shipping Services
If returned, this is the shipping service group to which the shipping service belongs. Valid values are found in CostGroupFlatCodeType.
CostGroupFlatCodeType
GeteBayDetails
Conditionally
Shipping Package level details for the enclosing shipping service, this
complex type replaces the existing ShippingPackage type.
GeteBayDetails
Conditionally
If true, a seller who selects this package type for the listing and then offers this shipping service must specify WeightMajor and WeightMinor in the item definition. If not returned, WeightRequired is false.
false
GeteBayDetails
Conditionally
Returns the latest version number for this field. The version can be
used to determine if and when to refresh cached client data.
GeteBayDetails
DetailLevel: none, ReturnSummary, ReturnAll
Always
Gives the time in GMT that the feature flags for the details were last
updated. This timestamp can be used to determine if and when to refresh
cached client data.
GeteBayDetails
DetailLevel: none, ReturnSummary, ReturnAll
Always
Indicates the shipping category. Shipping categories include the following: <code>ECONOMY</code>, <code>STANDARD</code>, <code>EXPEDITED</code>, <code>ONE_DAY</code>, <code>PICKUP</code>, <code>OTHER</code>, and <code>NONE</code>. International shipping services are generally grouped into the <code>NONE</code> category. For more information about these shipping categories, see the <a href="http://pages.ebay.com/sellerinformation/shipping/chooseservice.html">Shipping Basics</a> page on the eBay Shipping Center site.
<br/><br/>
<span class="tablenote">
<strong>Note:</strong> This field is returned only for those sites that support shipping categories: US (0), CA (2), CAFR (210), UK (3), AU (15), FR (71), DE (77), IT (101) and ES (186).
</span>
GeteBayDetails
Conditionally
Container consisting of shipping costs and other details related to a domestic
shipping service. A <b>ShippingServiceOptions</b> container is required for each domestic shipping service option that the seller will make available to buyers in an Add/Revise/Relist call. Up to four domestic shipping service options can be offered per listing.
This field is no longer applicable as it is not longer possible for a seller to offer a buyer shipping insurance.
1035
NoOp
1035
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. This field is required to identify each domestic shipping service option that is specified with a <b>ShippingServiceOptions</b> container.
<br><br>
For a list of valid <b>ShippingService</b> values, call <b>GeteBayDetails</b>
with <b>DetailName</b> set to <code>ShippingServiceDetails</code>. The
<b>ShippingServiceDetails.ValidForSellingFlow</b> flag must also be present. Otherwise,
that particular shipping service option is no longer valid and cannot be offered
to buyers through a listing.
<br><br>
To view the full list of domestic shipping service options in the response, look for the
<b>ShippingServiceDetails.ShippingService</b> fields. Domestic shipping service options will
not have a <b>InternationalService</b> = <code>true</code> field, as this indicates that the <b>ShippingService</b>
value is an International shipping service option.
ShippingServiceCodeType
SendInvoice
No
AddFixedPriceItem
AddItem
AddItems
AddOrder
AddSellingManagerTemplate
RelistFixedPriceItem
RelistItem
ReviseFixedPriceItem
ReviseItem
ReviseSellingManagerTemplate
VerifyAddFixedPriceItem
VerifyAddItem
VerifyRelistItem
Conditionally
GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
Conditionally
GetItemShipping
GetMyeBayBuying
Conditionally
GetOrders
DetailLevel: none, ReturnAll
Conditionally
OrderReport
Conditionally
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetSellingManagerSaleRecord
Conditionally
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ReturnAll
Conditionally
ReviseSellingManagerSaleRecord
No
GeteBayDetails
http://developer.ebay.com/Devzone/XML/docs/Reference/eBay/GeteBayDetails.html
The base cost of shipping one unit of the item using the shipping service specified in the corresponding <b>ShippingService</b> field.
<br>
<br>
In the case of a multiple-quantity, fixed-price listing, the <b>ShippingServiceAdditionalCost</b> field also becomes applicable, and shows the cost to ship each additional unit of the item if the buyer purchases multiple quantity of the same line item.
<br>
<br>
<span class="tablenote"><strong>Note:</strong>
If the corresponding shipping service option is set as a 'free shipping' option (<b>FreeShipping=true</b>), the seller still needs to include this <b>ShippingServiceCost</b> field and set its value to <code>0.0</code>, as eBay will not do this automatically.
</span>
When returned by <b>GetItemShipping</b>, it includes the packaging and
handling cost.
<br>
<br>
Note that if <b>ShippingService</b> is set to <code>LocalPickup</code>, <b>ShippingServiceCost</b> must be set to <code>0.0</code>. Also, if a shipping service has been specified (even <b>LocalPickup</b>), <b>GetItem</b> returns
the shipping service cost, even if the cost is zero.
<br>
<br>
If this is for calculated shipping for a listing that has not
yet ended, note that the cost cannot be determined until the listing
has ended and the buyer has specified a postal code.
SendInvoice
No
AddFixedPriceItem
AddItem
AddItems
AddOrder
AddSellingManagerTemplate
RelistFixedPriceItem
RelistItem
ReviseFixedPriceItem
ReviseItem
ReviseSellingManagerTemplate
VerifyAddFixedPriceItem
VerifyAddItem
VerifyRelistItem
Conditionally
GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
Conditionally
GetBidderList
GetItemShipping
GetMyeBayBuying
GetSellingManagerSaleRecord
Conditionally
GetOrders
DetailLevel: none, ReturnAll
Conditionally
OrderReport
Conditionally
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ReturnAll
Conditionally
GetMyeBayBuying
BidList
WonList
WatchList
DeletedFromWonList
BestOfferList
DetailLevel: none, ReturnAll
Conditionally
GetMyeBaySelling
DetailLevel: none, ReturnAll
Conditionally
ReviseSellingManagerSaleRecord
No
The cost of shipping each additional item if the same buyer purchases multiple quantity of the same line item. This field is required when creating a multiple-quantity, fixed-price listing. Generally, the seller will give the buyer a shipping discount if that buyer purchases multiple quantity of the item, so this value should usually be less than the value set for <b>ShippingServiceCost</b>.
<br/><br/>
The value of this field can even be set to <code>0</code> if the seller wants to encourage buyers to buy multiple quantity of the item, or it could be that the seller can fit multiple quantities of the line item in a single shipping package, so the seller is just passing this shipping savings onto the buyer. This field is not applicable for single-quantity listings.
SendInvoice
No
AddFixedPriceItem
AddItem
AddItems
AddOrder
AddSellingManagerTemplate
RelistFixedPriceItem
RelistItem
ReviseFixedPriceItem
ReviseItem
ReviseSellingManagerTemplate
VerifyAddFixedPriceItem
VerifyAddItem
VerifyRelistItem
Conditionally
GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
Conditionally
GetBidderList
GetItemShipping
GetMyeBayBuying
Conditionally
GetOrders
DetailLevel: none, ReturnAll
Conditionally
OrderReport
Conditionally
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ReturnAll
Conditionally
Controls the order (relative to other shipping services) in
which the corresponding <b>ShippingService</b> will appear in the View Item and
Checkout page.
<br/><br/>
Sellers can specify up to four domestic shipping services (with
four <b>ShippingServiceOptions</b> containers), so valid values are 1, 2, 3, and 4. A
shipping service with a <b>ShippingServicePriority</b> value of 1 appears at the top.
Conversely, a shipping service with a <b>ShippingServicePriority</b> value of 4 appears
at the bottom of a list of four shipping service options.
<br><br>
If this field is omitted from domestic shipping service options, the order of the shipping service options in View Item and Checkout pages will be determined by the order that these shipping services are presented in the request payload of an Add/Revise/Relist call.
SendInvoice
No
AddFixedPriceItem
AddItem
AddItems
AddOrder
AddSellingManagerTemplate
RelistFixedPriceItem
RelistItem
ReviseFixedPriceItem
ReviseItem
ReviseSellingManagerTemplate
VerifyAddFixedPriceItem
VerifyAddItem
VerifyRelistItem
Conditionally
GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
Conditionally
GetBidderList
GetItemShipping
GetMyeBayBuying
Conditionally
GetOrders
DetailLevel: none, ReturnAll
Conditionally
OrderReport
Conditionally
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ReturnAll
Conditionally
This field is returned as <code>true</code> if the domestic shipping service is considered an expedited shipping service. An expedited service is typically a shipping service that can ship an order that will arrive at the buyer's location within one to two business days.
GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
Conditionally
GetItemShipping
GetMyeBayBuying
Conditionally
GetOrders
DetailLevel: none, ReturnAll
Conditionally
OrderReport
Conditionally
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ReturnAll
Conditionally
The integer value returned here indicates the minimum number of business days that the shipping service (indicated in the corresponding <b>ShippingService</b> field) will take to be delivered to the buyer.
<br><br>
This minimum shipping time does not include the seller's handling time, and the clock starts on the shipping time only after the seller has delivered the item to the shipping carrier for shipment to the buyer. 'Business days' can vary by shipping carrier and by country, but 'business days' are generally Monday through Friday, excluding holidays. This field is returned if defined for that particular shipping service option.
GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
Conditionally
GetItemShipping
GetMyeBayBuying
Conditionally
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ReturnAll
Conditionally
The integer value returned here indicates the maximum number of business days that the shipping service (indicated in the corresponding <b>ShippingService</b> field) will take to be delivered to the buyer.
<br><br>
This maximum shipping time does not include the seller's handling time, and the clock starts on the shipping time only after the seller has delivered the item to the shipping carrier for shipment to the buyer. 'Business days' can vary by shipping carrier and by country, but 'business days' are generally Monday through Friday, excluding holidays. This field is returned if defined for that particular shipping service option.
GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
Conditionally
GetItemShipping
GetMyeBayBuying
Conditionally
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ReturnAll
Conditionally
This boolean field indicates whether or not the corresponding domestic shipping service option is free to the buyer. In an Add/Revise/Relist call, free shipping can only be offered for the first specified shipping service (so, the corresponding <b>ShippingServicePriority</b> value should be <code>1</code> or included first in the call request). If 'free shipping' is for any other shipping service, this field is ignored.
<br/><br/>
For 'Get' calls, including <b>GetItem</b>, this field is only returned if <code>1</code>.
<br/><br/>
<span class="tablenote"><strong>Note:</strong>
If a seller is specifying a shipping service option as 'free shipping', in addition to this <b>FreeShipping</b> boolean field, the seller will also need to include the corresponding <b>ShippingServiceCost</b> field and set its value to <code>0.0</code>, as eBay will not do this automatically.
</span>
AddFixedPriceItem
AddItem
AddItems
AddSellingManagerTemplate
RelistFixedPriceItem
RelistItem
ReviseFixedPriceItem
ReviseItem
ReviseSellingManagerTemplate
VerifyAddFixedPriceItem
VerifyAddItem
VerifyRelistItem
No
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally
GetItemShipping
DetailLevel: none, ReturnAll
Conditionally
GetMyeBayBuying
Conditionally
https://developer.ebay.com/DevZone/guides/features-guide/default.html#Development/Shipping-Services.html#SpecifyingFreeShipping
Specifying Free Shipping
The <b>LocalPickup</b> flag is used by the <b>GetMyEbayBuying</b> and <b>GetMyEbaySelling</b> calls to indicate whether the buyer has selected local pickup as the shipping option or the seller has specified local pickup as the first shipping option.
The <b>LocalPickup</b> flag can also be used with other fields to indicate if there is no fee for local pickup.
<br/><br/>
For example, if the <b>LocalPickup</b> flag is used with the <b>ShippingServiceOptions</b> and <b>ShippingServiceCost</b> fields, the seller can indicate that local pickup is an available option and that no is fee charged. This is the equivalent of free shipping.
GetMyeBayBuying
GetMyeBaySelling
Conditionally
The total cost of customs and taxes for the international leg of an order shipped using the Global Shipping Program. This amount is calculated and supplied for each item by the international shipping provider when a buyer views the item properties.
GetItemShipping
Conditionally
GetOrders
DetailLevel: none, ReturnAll
Conditionally
OrderReport
Conditionally
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ReturnAll
Conditionally
GetMyeBayBuying
Conditionally
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.
GetOrders
DetailLevel: none, ReturnAll
Conditionally
OrderReport
Conditionally
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ReturnAll
Conditionally
The last time of day that an order using the specified shipping service will be accepted by the seller for the current listing. The cut off time applies and is returned only when the <strong>ShippingService</strong> field contains the name of a qualifying time-sensitive shipping service, such as <code>eBayNowImmediateDelivery</code>.
<br/><br/>
The cut off time is set by eBay and determined in part by the policies and locations of the seller and the shipping carrier.
GetItemShipping
Conditionally
Reserved for internal or future use.
Packages supported by the enclosing shipping service.
The name of the package type.
GeteBayDetails
Conditionally
This field is only returned if package dimensions are required for the corresponding
package type (<b>ShippingServicePackageDetails.Name</b> value) supported
by the corresponding shipping service option
(<b>ShippingServiceDetails.ShippingService</b> value).
GeteBayDetails
Conditionally
This enumerated type defines the possible values that can be used in the <b>ShippingServiceType</b> field of the <b>ShippingServiceCostOverride</b> container.
This value should be used if the seller is overriding shipping costs for all domestic shipping services defined in the Business Policies shipping profile.
This value should be used if the seller is overriding shipping costs for all international shipping services defined in the Business Policies shipping profile.
If the field is present, the corresponding feature applies to the category. The
field is returned as an empty element (i.e., a boolean value is not returned).
This type is no longer applicable as it only pertained to eBay Now orders, and eBay Now has been discontinued.
This value indicates that the eBay Now order is ready for pickup by the eBay Now valet at the store.
This value indicates that the eBay Now order was picked up by the eBay Now valet.
This value is reserved for internal or future use.
The shipping cost model offered by the seller.
Flat shipping model: the seller establishes the cost of shipping and cost of shipping insurance, regardless of what any buyer-selected shipping service might charge the seller.
<br/><br/>
<span class="tablenote">
<strong>Note:</strong> This shipping type includes an option for a <em>Flat Rate Freight</em> shipping service. For details about freight shipping, see <a href="http://developer.ebay.com/devzone/guides/features-guide/default.html#development/Shipping-TypesCosts.html#SpecifyingFreightShipping">Specifying Freight Shipping</a> in the eBay Features Guide.
</span>
Calculated shipping model: the cost of shipping is
determined in large part by the seller-offered and
buyer-selected shipping service. The seller might assess an
additional fee via PackagingHandlingCosts.
Freight shipping model. Available only for US domestic shipping. The cost of shipping is automatically determined by an affiliated third party, FreightQuote.com, based on the item location (postal code).
<br/><br/>
<span class="tablenote">
<strong>Note:</strong> This shipping type cannot be set via API, but it is automatically set by eBay when a buyer selects the FreightQuote.com option on the US eBay website.
<br/><br/>
For details about types of freight shipping that you can specify via API, see <a href="http://developer.ebay.com/devzone/guides/features-guide/default.html#development/Shipping-TypesCosts.html#SpecifyingFreightShipping">Specifying Freight Shipping</a> in the eBay Features Guide.
</span>
Free shipping.
This field is output-only so if you want to use AddItem to specify a free
Shipping Cost, specify 0 in
Item.ShippingDetails.ShippingServiceOptions.ShippingServiceCost.
The seller did not specify the shipping type.
The seller specified one or more flat domestic shipping services
and one or more calculated international shipping services.
The seller specified one or more calculated domestic shipping services
and one or more flat international shipping services.
Freight shipping model. Available only for the US, UK, AU, CA and CAFR sites, and only for domestic shipping. <code>FreightFlat</code> applies to shipping with carriers that are not affiliated with eBay. It is negotiated freight, not a flat rate. Sellers negotiate the shipping cost with their chosen carrier and the buyer before completing the sale. FreightFlat shipping may be used when calculated shipping cannot be used due to the greater weight of the item.
<br/><br/>
For details about freight shipping, see <a href="http://developer.ebay.com/devzone/guides/features-guide/default.html#development/Shipping-TypesCosts.html#SpecifyingFreightShipping">Specifying Freight Shipping</a> in the eBay Features Guide.
Reserved for future use.
This enumerated type defines the sort values that can be used in the
<b>FavoriteSearch.ItemSort</b> filter in a <b>GetMyeBayBuying</b>
request.
Sorts items by Best Match, and no sort order applies. If specified,
then Best Match sort also applies to CategoryHistogram.
This value is reserved for future or internal use.
Sorts by the end time of the listing, in ascending or descending order according to the
<b>SortOrder</b> value.
Sorts by number of bids on the item, in ascending or descending order according to the
<b>SortOrder</b> value.
Sorts by country; no sort order can be specified.
Sorts by current bid; descending order only.
Sorts by distance; ascending order only.
Sorts by the start time of the listing; recently-listed first.
Sorts by BestMatchCategoryGroup, so results are grouped by Best Match within a category.
Sorts by total cost, which is item cost plus shipping cost. If
<b>SortOrder</b> is included and set to 'Ascending', items are sorted
in the following order: Lowest total cost (for items where shipping was
properly specified); then freight-shipping items (lowest to highest); and finally,
items for which shipping was not specified (lowest to highest).
Type defining the <b>BuyerRequirementDetails</b> container, which is returned in <b>GeteBayDetails</b>, and provides the seller with the buyer requirement features (and applicable values) that are supported by the listing site.
<br/><br/>
<span class="tablenote"><b>Note: </b>
This container is only returned if <b>BuyerRequirementDetails</b> is included as a <b>DetailName</b>
filter in the call request, or if no <b>DetailName</b> filters are used in the request.
</span>
<span class="tablenote"><b>Note: </b>
This field is no longer applicable, as sellers can no longer set the Buyer Requirement that buyers must have a PayPal account linked to their eBay account in order to purchase an item.
</span>
GeteBayDetails
Conditionally
<span class="tablenote"><b>Note: </b>
This field is no longer applicable, as sellers can no longer set the Buyer Requirement that buyers must have only a certain amount of buyer policy violations within a specified amount of time in order to purchase an item.
</span>
GeteBayDetails
Conditionally
This container shows the supported values that can be set as the <b>MaximumItemCount</b> and <b>MinimumFeedbackScore</b> to help control inexperienced or low Feedback bidders/buyers from bidding on or buying an item in a listing.
GeteBayDetails
Conditionally
This container shows the supported values that can be set as the Maximum Unpaid Item count and period (number of days) to block buyers who have recent Unpaid Item Strikes from bidding on or buying an item in a listing.
GeteBayDetails
Conditionally
<span class="tablenote"><b>Note: </b>
This field is no longer applicable, as sellers can no longer set a buyer's Minimum Feedback Score threshold Buyer Requirement at the listing-level in Add/Revise/Relist calls.
</span>
GeteBayDetails
Conditionally
A <code>true</code> value returned in this field indicates that the <b>ShipToRegistrationCountry</b> Buyer Requirement is supported for the specified site.
GeteBayDetails
Conditionally
The Verified User Buyer Requirement has been deprecated, so this field is no longer applicable.
1065
NoOp
1065
Returns the latest version number for this field. The version can be
used to determine if and when to refresh cached client data.
GeteBayDetails
DetailLevel: none, ReturnSummary, ReturnAll
Always
Gives the time in GMT when the feature flags for the details were last
updated. This timestamp can be used to determine if and when to refresh
cached client data.
GeteBayDetails
DetailLevel: none, ReturnSummary, ReturnAll
Always
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.
China, Sweden, Taiwan
USA, site ID 0, abbreviation US, currency USD.
<br/>(<a href="http://www.ebay.com" target="_blank">http://www.ebay.com</a>)
Canada, site ID 2, abbreviation CA, currencies CAD and USD.
<br/>(<a href="http://www.ebay.ca" target="_blank">http://www.ebay.ca</a>)
United Kingdom, site ID 3, abbreviation UK, currency GBP.
<br/>(<a href="http://www.ebay.co.uk" target="_blank">http://www.ebay.co.uk</a>)
Australia, site ID 15, abbreviation AU, currency AUD.
<br/>(<a href="http://www.ebay.com.au" target="_blank">http://www.ebay.com.au</a>)
Austria, site ID 16, abbreviation AT, currency EUR.
<br/>(<a href="http://www.ebay.at" target="_blank">http://www.ebay.at</a>)
Belgium (French), site ID 23, abbreviation BEFR, currency EUR.
<br/>(<a href="http://www.ebay.be" target="_blank">http://www.ebay.be</a>)
France, site ID 71, abbreviation FR, currency EUR.
<br/>(<a href="http://www.ebay.fr" target="_blank">http://www.ebay.fr</a>)
Germany, site ID 77, abbreviation DE, currency EUR.
<br/>(<a href="http://www.ebay.de" target="_blank">http://www.ebay.de</a>)
Italy, site ID 101, abbreviation IT, currency EUR.
<br/>(<a href="http://www.ebay.it" target="_blank">http://www.ebay.it</a>)
Belgium (Dutch), site ID 123, abbreviation BENL, currency EUR.
<br/>(<a href="http://www.ebay.be" target="_blank">http://www.ebay.be</a>)
Netherlands, site ID 146, abbreviation NL, currency EUR.
<br/>(<a href="http://www.ebay.nl" target="_blank">http://www.ebay.nl</a>)
Spain, site ID 186, abbreviation ES, currency EUR.
<br/>(<a href="http://www.ebay.es" target="_blank">http://www.ebay.es</a>)
Switzerland, site ID 193, abbreviation CH, currency CHF.
<br/>(<a href="http://www.ebay.ch" target="_blank">http://www.ebay.ch</a>)
Taiwan, currency TWD. Note that the old eBay Taiwan site is no longer in operation, and the new site does not use this API.
Although Site ID 100 is still valid in APIs, eBay Motors US is no longer its own site, but just a vertical within the eBay US site.
Hong Kong, site ID 201, abbreviation HK, currency HKD.
<br/>(<a href="http://www.ebay.com.hk" target="_blank">http://www.ebay.com.hk</a>)
Singapore, site ID 216, abbreviation SG, currency SGD.
<br/>(<a href="http://www.ebay.com.sg" target="_blank">http://www.ebay.com.sg</a>)
India, site ID 203, abbreviation IN, currency INR.
<br/>(<a href="http://www.ebay.in" target="_blank">http://www.ebay.in</a>)
Ireland, site ID 205, abbreviation IE, currency EUR.
<br/>(<a href="http://www.ebay.ie" target="_blank">http://www.ebay.ie</a>)
Malaysia, site ID 207, abbreviation MY, currency MYR.
<br/>(<a href="http://www.ebay.com.my" target="_blank">http://www.ebay.com.my</a>)
Philippines, site ID 211, abbreviation PH, currency PHP.
<br/>(<a href="http://www.ebay.ph" target="_blank">http://www.ebay.ph</a>)
Poland, site ID 212, abbreviation PL, currency PLN.
<br/>(<a href="http://www.ebay.pl" target="_blank">http://www.ebay.pl</a>)
Reserved for internal or future use.
Canada French, site ID 210, abbreviation CAFR, currencies CAD and USD.
Russia, site ID 215, abbreviation RU, currency RUB. Sellers must use Merchant Integration Platform (MIP) to create and revise listings on the Russia site. Russian listings cannot be created or revised through the Trading API's add and revise calls, so 'Russia' would not be a valid value to pass in through <b>Item.Site</b> field of an Add or Revise Trading API call.
A container for feature definitions that apply to the entire site.
Specifies the ID of a set of default durations for a certain type of listing.
The actual duration values are returned within the FeatureDefinitions node.
The type of listing is named in the type attribute.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
Specifies the default site setting for whether sellers are
required to specify a domestic shipping service and its associated cost
when listing items. True means the shipping terms are required
unless a specific category overrides this setting.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
Specifies the default site setting for whether categories allow Best Offers. A value of <code>true</code> means Best Offers are allowed site-wide, unless a specific category overrides the setting.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
This field is no longer applicable as Dutch auctions are no longer available on eBay sites.
</span>
<br>
Specifies the default site setting for whether a bidder must consent to the
bid by confirming that he or she read and agrees to the terms in eBay's
privacy policy.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
Indicates whether or not it is possible to enhance a listing by putting
it into a rotation for display on a special area of the eBay home page.
Support for this feature varies by site. Item or feedback restrictions may apply.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
Specifies the default site setting for whether categories allow
the ProPack feature (a feature pack). True means ProPack is allowed site-wide,
unless a specific category overrides the setting.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
Specifies the default site setting for whether
categories allow the <b>BasicUpgradePack</b> feature (a feature pack).
No longer allowed on any sites.
Formerly, Australia site (site ID 15, abbreviation AU) only.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
Specifies the default site setting for whether
categories allow the ValuePack feature (a feature pack).
A value of <code>true</code> means it is allowed site-wide, unless a specific category overrides the setting.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
Specifies the default site setting for whether
categories allow the ProPackPlus feature (a feature pack).
A value of <code>true</code> means it is allowed site-wide, unless a specific category overrides the setting.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
Specifies the default site setting for whether categories allow
Classified Ad format listings. A value of <code>true</code> means the feature is allowed site-wide,
unless a specific category overrides the setting.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
Specifies the default site setting for whether categories allow counter offers
for Best Offers. A value of <code>true</code> means counter offers are allowed site-wide, unless a
specific category overrides the setting.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
Specifies the default site setting for whether categories allow
auto decline for Best Offers. A value of <code>true</code> means auto decline is allowed site-wide,
unless a specific category overrides the setting.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
Specifies the default site setting for whether
<b>LocalMarketSpecialitySubscription</b> feature is supported for most categories.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
Specifies the default site setting for whether <b>LocalMarketRegularSubscription</b>
feature is supported for most categories.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
Specifies the default site setting for whether <b>LocalMarketPremiumSubscription</b>
feature is supported for most categories.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
Specifies the default site setting for whether <b>LocalMarketNonSubscription</b>
feature is supported for most categories.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
This field is deprecated.
579
681
NoOp
This field is deprecated.
579
681
NoOp
This field is deprecated.
579
681
NoOp
Specifies the default site setting for whether the Minimum Reserve Price
feature is supported for most categories.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
Specifies the default site setting for whether most categories allow seller-
level contact information for Classified Ad listings.
<br/><br/>
A value of <code>true</code> means
seller-level contact information is available for Classified Ad format
listings site-wide, unless a specific category overrides the setting.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
Specifies the default site setting for whether the Transaction Confirmation
Request feature is supported for most categories.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
This field is is no longer applicable.
This feature is no longer applicable.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
This feature is no longer applicable.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
Specifies the supported local listing distances of regular vehicles
for most categories.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
Specifies the supported local listing distances of specialty vehicles
for most categories.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
Specifies the supported local listing distances for most categories,
for users who have not subscribed to either Regular or Specialty vehicles.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
Indicates if the payment method should be displayed to the user
for most categories. Even if enabled, checkout may or may not
be enabled.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
Indicates if shipping options are available for most categories.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
Indicates if Best Offer is enabled for Classified Ad listings
in most categories.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
Indicates whether counter offers are allowed on Best Offers for
most categories.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
Indicates whether automatic decline for Best Offers is allowed for most
categories.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
Indicates whether most categories support including a phone number in the
seller's contact information.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
Indicates whether most categories support including an email address in the
seller's contact information.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
Specifies whether categories on the site require a seller to offer a safe payment method (i.e. PayPal or one of the credit cards specified in <b>Item.PaymentMethods</b>). If a seller has a 'SafePaymentExempt' status, they are exempt from the category requirement to offer at least one safe payment method, even if the site and category have the safe payment method turned on.
<br/><br/>
If <code>true</code>, items on
the site need to have the safe payment method selected, but specific
categories can override the setting if they don't need this requirement. For
example, Business and Industrial, Motors, Real Estate, and Mature Audiences
categories, and all listings that don't support <b>Item.PaymentMethods</b> are
exempt from this requirement, which means that any seller can list without
any safe payment method selected.
<br><br/>
If <code>false</code>, all sellers in all categories can list without any safe payment
method selected and this setting cannot be overridden at the category level.
If site is not enabled, there is no category where this requirement is
enabled on that site.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
Specifies the default site setting for whether the pay-per-lead feature
is supported for most categories.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
The value returned in this field indicates whether most categories on the specified eBay site support listings with Item Specifics. Item Specifics enable sellers to present descriptive details of an item in a structured manner.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
<span class="tablenote"><b>Note: </b> eBay India is no longer a functioning eBay marketplace, so the <code>PaisaPayEscrow</code> payment method is no longer applicable since this payment method was only supported on the eBay India site.
</span>
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
This field is no longer applicable.
923
NoOp
1045
ISBNEnabled
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
This field is no longer applicable.
923
NoOp
1045
UPCEnabled
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
This field is no longer applicable.
923
NoOp
1045
EANEnabled
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
Indicates whether the category is enabled for the <b>BrandMPN</b> field for a specific item. If
<code>true</code>, sellers can add <b>BrandMPN</b> for that item.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
Specifies the default site setting for whether categories allow
auto-accept for Best Offers for Classified Ads.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
Specifies the default site setting for whether categories allow
auto-accept for Best Offers.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
Specifies the default site setting for whether categories allow
you to specify that listings be displayed in the default search
results of the respective sites.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
Specifies the default site setting for whether categories allow
you to specify that listings be displayed in the default search
results of the respective site.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
Specifies the default site setting for whether categories allow
you to specify that listings be displayed in the default search
results of the respective site.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
For the Australia site, if both <b>PayPalBuyerProtectionEnabled</b> and
<b>BuyerGuaranteeEnabled</b> are returned, then the default site setting
is that categories allow buyer protection.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
For the Australia site, if both <b>PayPalBuyerProtectionEnabled</b> and
<b>BuyerGuaranteeEnabled</b> are returned, then the default site setting
is that categories allow buyer protection.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
<span class="tablenote"><b>Note: </b> eBay India is no longer a functioning eBay marketplace, so this feature is no longer applicable since it was only supported on the eBay India site.
</span>
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
This field is deprecated.
Specifies the default site setting
that enables durations for "Gallery Featured".
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
Specifies the default site setting for whether
categories have PayPal as a required payment method for listings.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
Specifies the default site setting for whether categories allow
Classified Ad listings. A value of <code>true</code> means the feature is allowed site-wide,
unless a specific category overrides the setting. This element is for eBay Motors Pro users.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
Indicates whether most categories support including a phone number in the
seller's contact information. This element is for eBay Motors Pro users.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
Indicates which telephone option is enabled to
contact the seller. This element is for eBay Motors Pro users.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
Indicates whether most categories support including an address in the seller's
contact information. This element is for eBay Motors Pro users.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
Indicates which address option is enabled to
contact the seller. This element is for eBay Motors Pro users.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
Indicates whether most categories support including a company name in the
seller's contact information. This element is for eBay Motors Pro users.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
Indicates whether most categories support including an email address in the
seller's contact information. This element is for eBay Motors Pro users.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
Indicates if Best Offer is enabled for Classified Ad listings
in most categories. This element is for eBay Motors Pro users.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
Specifies the default site setting for whether categories allow
auto-accept for Best Offers for Classified Ads.
This element is for eBay Motors Pro users.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
Specifies the default site setting for whether categories allow
auto-decline for Best Offers for Classified Ads.
This element is for eBay Motors Pro users.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
Indicates if the payment method should be displayed to the user
for most categories. Even if enabled, checkout may or may not
be enabled. This element is for eBay Motors Pro users.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
Indicates if shipping options are available for most categories.
This element is for eBay Motors Pro users.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
Indicates whether counter offers are allowed on Best Offers for
most categories. This element is for eBay Motors Pro users.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
Specifies the default site setting for whether most categories allow seller-
level contact information for Classified Ad format listings. A value of <code>true</code>
means seller-level contact information is available for Classified Ad listings
site-wide, unless a specific category overrides the setting. This element is
for eBay Motors Pro users.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
Specifies the default site setting for whether categories allow Classified Ad
listings. A value of <code>true</code> means the feature is allowed site-wide, unless a specific
category overrides the setting. This element is for Local Market dealers.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
Indicates whether most categories support including a phone number in the
seller's contact information. This element is for Local Market dealers.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
Indicates which telephone option is enabled to
contact the seller. This element is for Local Market dealers.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
Indicates whether most categories support including an address in the seller's
contact information. This element is for Local Market dealers.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
Indicates which address option is enabled to
contact the seller. This element is for Local Market dealers.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
Indicates whether most categories support including a company name in the
seller's contact information. This element is for Local Market dealers.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
Indicates whether most categories support including an email address in the
seller's contact information. This element is for Local Market dealers.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
Indicates if Best Offer is enabled for Classified Ad listings
in most categories. This element is for Local Market dealers.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
Specifies the default site setting for whether categories allow
auto-accept for Best Offers for Classified Ads.
This element is for Local Market dealers.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
Specifies the default site setting for whether categories allow
auto-decline for Best Offers for Classified Ads.
This element is for Local Market dealers.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
Indicates if the payment method should be displayed to the user
for most categories. Even if enabled, checkout may or may not
be enabled. This element is for Local Market dealers.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
Indicates if shipping options are available for most categories.
This element is for Local Market dealers.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
Indicates whether counter offers are allowed on Best Offers for
most categories. This element is for Local Market dealers.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
Specifies the default site setting for whether most categories allow seller-
level contact information for Classified Ad format listings. A value of <code>true</code>
means seller-level contact information is available for Classified Ad format
listings site-wide, unless a specific category overrides the setting. This
element is for Local Market dealers.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
Indicates which telephone option is enabled to
contact the seller. This element is for For Sale By Owner.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
Indicates whether most categories support including an address in the seller's
contact information. This element is for For Sale By Owner.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
Indicates which address option is enabled to
contact the seller. This element is for For Sale By Owner.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
Indicates whether most categories support including a company name in the
seller's contact information. This element is for For Sale By Owner.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
Specifies the default site setting for whether
<b>LocalMarketSpecialitySubscription</b> feature is supported for most categories.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
Specifies the default site setting for whether <b>LocalMarketRegularSubscription</b>
feature is supported for most categories.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
Specifies the default site setting for whether <b>LocalMarketPremiumSubscription</b>
feature is supported for most categories.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
Specifies the supported local listing distances for most categories,
for users who have not subscribed to either Regular or Specialty vehicles.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
This field is deprecated and will no longer be returned.
GetCategoryFeatures
DetailLevel: none, ReturnSummary, ReturnAll
Conditionally
Defines if quantity can be revised while a listing is in semi or fully restricted mode.
Applies to fixed-price listings.
GetCategoryFeatures
DetailLevel: none, ReturnSummary, ReturnAll
Conditionally
Defines if price can be revised while a listing is in semi or fully restricted mode.
Applies to fixed-price listings.
GetCategoryFeatures
DetailLevel: none, ReturnSummary, ReturnAll
Conditionally
Defines if extended business seller listing durations are enabled on a given site.
When the value of this element is <code>true</code>, it means the listing duration values
defined in <b>StoreOwnerExtendedListingDurations</b> are applicable to fixed-price
listings.
GetCategoryFeatures
DetailLevel: none, ReturnSummary, ReturnAll
Conditionally
Provides additional listings durations that are supported by Store Owners.
The extended listing durations provided here in this element should be merged
in with the baseline listing durations provided in the <b>ListingDurations</b> container.
GetCategoryFeatures
DetailLevel: none, ReturnSummary, ReturnAll
Conditionally
Specifies the default site setting for whether a return policy is
required for most categories.<br>
<br>
<b>For most sites:</b> If true, listings in most
categories require a return policy. <br>
<br>
<b>For eBay Australia (AU) and
US eBay Motors Parts and Accessories:</b>
If true, most categories support but do not require a
return policy.<br>
<br>
Individual categories can override the site default.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
Specifies the default site setting for whether a handling time (dispatch time) is
required for most categories.<br>
<br>
The handling time is the maximum number of business days the seller
commits to for preparing an item to be shipped after receiving a
cleared payment. The seller's handling time does not include the
shipping time (the carrier's transit time).<br>
<br>
If <code>false</code>, most listings on the site require a handling time
(see <b>DispatchTimeMax</b> in <b>AddItem</b>) when flat or calculated shipping
is specified. (A handling time is not required for local pickup
or for freight shipping.)<br>
<br>
For a list of the handling time values allowed for each site, use
<b>DispatchTimeMaxDetails</b> in <b>GeteBayDetails</b>.<br>
<br>
<span class="tablenote"><b>Note:</b>
Although the field name ends with "Enabled", a value of <code>true</code> means
that a handling time is NOT required, and value of <code>false</code> means
that a handling time IS required.</span>
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
Specifies the default site setting for whether a maximum flat rate shipping cost
is imposed for listings in most categories on the site.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
Specifying Shipping Types and Costs
http://developer.ebay.com/DevZone/guides/features-guide/default.html#development/Shipping-TypesCosts.html#MaximumFlatRateShippingCost
Specifies the default site setting for whether a maximum flat rate shipping cost
is imposed on sellers who list in categories on this site yet are shipping an
item into the country of this site from another country.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
https://developer.ebay.com/DevZone/guides/features-guide/default.html#Development/Shipping-TypesCosts.html#MaximumFlatRateShippingCost
Maximum Flat Rate Shipping Cost
Returns the applicable max cap per shipping cost for shipping service group1
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
Returns the applicable max cap per shipping cost for shipping service group2
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
Returns the applicable max cap per shipping cost for shipping service group3
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
Indicates the acceptable payment methods that can be used when using the <b>Add</b>/<b>Revise</b>/<b>Relist</b> calls for an item listed on the corresponding site.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
Specifies the default site setting for whether categories support
multi-variation listings. If true, you can pass in Item.Variations
in the AddFixedPriceItem family of calls when you list in
categories that support this feature.<br>
<br>
Multi-variation listings contain items that are logically the same
product, but that vary in their manufacturing details or packaging.
For example, a particular brand and style of shirt could be
available in different sizes and colors, such as "large blue" and
"medium black" variations.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
This field is deprecated.
Specifies the default site setting for whether categories allow
free, automatic upgrades for Gallery Plus, which enhances pictures
in search results.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
Specifies the default site setting for whether categories allow
free, automatic upgrades for Picture Pack, a discount package
that includes super-sizing of pictures.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
Specifies the default site setting for whether listing items with parts
compatibility is supported by application (<code>ByApplication</code>), by specification
(<code>BySpecification</code>), or not at all (<code>Disabled</code>). A given category cannot support
both types of parts compatibility.
<br><br>
Parts compatibility listings contain information to determine the assemblies
with which a part is compatible. For example, an automotive part or accessory
listed with parts compatibility can be matched with vehicles (e.g., specific
years, makes, and models) with which the part or accessory can be used.
<br><br>
Parts Compatibility is supported in limited Parts & Accessories
categories for the US eBay Motors site only.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
Specifying Parts Compatibility in Listings
https://developer.ebay.com/DevZone/guides/features-guide/default.html#Development/CompatibleParts.html
Specifies the default site setting for whether parts compatibility
information is required when listing items, and if so, how many
compatibilities must be specified. If the value is "0," you are not required
to specify compatibility information. A value greater than "0" indicates that
listing with parts compatibity is mandatory and the listing must contain the
specified number of compatibilities at a minimum.
<br><br>
Parts compatibility listings contain information to determine the assemblies
with which a part is compatible. For example, an automotive part or accessory
listed witih parts compatibility can be matched with vehicles (e.g., specific
years, makes, and models) with which the part or accessory can be used.
<br><br>
This field applies only to listings in which compatibility is specified by
application. Entering parts compatibility by application specifies the
assemblies (e.g., a specific year, make, and model of car) to which the item
applies. This can be done automatically by listing with a catalog product
that supports parts compatibility, or manually, using
<b class="con">Item.ItemCompatibilityList</b> when listing or
revising an item.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
Specifies the default site setting for the maximum number of compatible
applications allowed per item when adding or revising items with parts
compatibility.
<br><br>
Parts compatibility listings contain structured information to determine the
assemblies with which a part is compatible. For example, an automotive part
or accessory listed with parts compatibility can be matched with vehicles
(e.g., specific years, makes, and models) with which the part or accessory
can be used.
<br><br>
This field applies only to listings in which compatibility is specified by
application manually when listing or revising an item. Entering parts
compatibility by application manually specifies the assemblies (e.g., a
specific year, make, and model of car) to which the item applies, using <b
class="con">Item.ItemCompatibilityList</b>.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
Specifies the default site setting for whether most categories
support (or require) <b>Item.ConditionID</b> in listings.
Use this to determine whether to use
<b>ConditionID</b> in <b>AddItem</b> and related calls.
See <b>ConditionValues</b> for a list of valid IDs.
<br><br>
In general, this is set to <code>Disabled</code>, and meta-categories
(level 1 categories) define their own default settings.
Disabled
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
The comprehensive list of item conditions on the site. That is,
this lists any value that could be supported by at least one
category on the site.
Individual meta-categories define their own default set of
condition values. (In other words, categories always override
this list with a customized subset of these values.)
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
Specifies the default site setting for whether most categories
follow specific rules associated with "value categories".<br>
<br>
Some eBay sites may select a few categories and designate them as
"value categories". These are typically selected from
categories where buyers can find great deals. (Not all categories
with great deals are designated as value categories.)
This designation can change over time. <br>
<br>
While a category is designated as a value category
(i.e., when <b>ValueCategory</b> = <code>true</code>),
it is subject to the following rule: Items in value categories can only be listed in one category.<br>
<br>
For example, if you attempt to list in two categories and the
<b>PrimaryCategory</b> or <b>SecondaryCategory</b> is a value category,
then eBay drops the <b>SecondaryCategory</b> and lists the
item in the <b>PrimaryCategory</b> only.
Similarly, if you attempt to add a secondary category to an existing
listing, or you change the category for an existing listing,
and if the primary or secondary category is a value category,
then eBay drops the secondary category.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
Specifies the default site setting for whether most categories
support (or require) product creation in listings.
Use this to determine whether it is mandatory to send
product id in AddItem and related calls.
In general, this is set to Disabled, and meta-categories
(level 1 categories) define their own default settings.
Disabled
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
This enumeration value indicates whether or not most categories on the specified eBay site support the use of European Article Numbers (EANs) to help create a listing in an <b>Add</b>/<b>Revise</b>/<b>Relist</b>/<b>Verify</b> API call.
<b></b>
<ul>
<li>A value of <code>Disabled</code> indicates that EANs cannot be used for most categories on the specified eBay site. </li>
<li>A value of <code>Enabled</code> indicates that EANs can be used for most categories on the specified eBay site. </li>
<li>A value of <code>Required</code> indicates that an EAN is required for most categories on the specified eBay site. </li>
</ul>
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
This enumeration value indicates whether or not most categories on the specified eBay site support the use of International Standard Book Numbers (ISBNs) to help create a listing in an <b>Add</b>/<b>Revise</b>/<b>Relist</b>/<b>Verify</b> API call.
<br/><br/>
A value of <code>Disabled</code> indicates that ISBNs cannot be used for most categories on the specified eBay site, a value of <code>Enabled</code> indicates that ISBNs can be used for most categories on the specified eBay site, and a value of <code>Required</code> indicates that an ISBN is required for most categories on the specified eBay site.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
This enumeration value indicates whether or not most categories on
the specified eBay site support the use of Universal Product Codes
(UPCs) to help create a listing in an
Add/Revise/Relist/Verify API call. A value of
<code>Disabled</code> indicates that UPCs cannot be
used for most categories on the specified eBay site, a value of
<code>Enabled</code> indicates that UPCs can be used
for most categories on the specified eBay site, and a value of
<code>Required</code> indicates that a UPC is required
for most categories on the specified eBay site.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
Specifies the maximum fitment count. Sellers can provide up to
1000 fitments at the lowest level of granularity.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
Indicates the type of vehicle; car, truck, boat, or motorcycle.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
This field is deprecated
EbayPaymentProcessEnabled
GetCategoryFeatures
DetailLevel: none, ReturnSummary, ReturnAll
Conditionally
Specifies what categories the Shipping profile is applicable to.
Only returned when this value (or this category's setting)
overrides the value inherited from the category's parent.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
Specifies what categories the Payment profile is applicable to.
Only returned when this value (or this category's setting)
overrides the value inherited from the category's parent.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
Specifies what categories the Return Policy profile is applicable to.
Only returned when this value (or this category's setting)
overrides the value inherited from the category's parent.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
After EOL Attributes, VIN will no longer be supported as primary attributes,
rather consumers should use new tag. This feature helps consumers in identifying
if category supports VIN.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
After EOL Attributes, VRM will no longer be supported as primary attributes,
rather consumers should use new tag. This feature helps consumers in identifying
if category supports VRM.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
After EOL Attributes, Seller Provided Title will no longer be supported as primary attributes,
rather consumers should use new tag. This feature helps consumers in identifying
if category supports Seller Provided Title.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
After EOL Attributes, Deposit will no longer be supported as primary attributes,
rather consumers should use new tags. This feature helps consumers in identifying
if category supports Deposit.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
Indicates whether or not the the specified category is enabled for Global Shipping Program.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
Indicates whether most categories on the specified eBay site support the Boat and Motorcycle Parts Compatibility feature. The Boats Parts Compatibility feature allows sellers to list their boats' parts and accessories items with parts compatibility name-value pairs specific to boats, and allows potential buyers to search for these items using parts compatibility search fields.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
Indicates whether most categories on the specified eBay site
support the "Click and Collect" feature. With the 'Click and Collect' feature, a buyer can purchase certain items on an eBay site and collect them at a local store. Buyers are notified by eBay once their items are available.
<br/><br/>
The "Click and Collect" feature is only available to large merchants on the UK and Australia sites. The 'Click and Collect' feature is only available to large merchants on the eBay UK (site ID - 3), eBay Australia (Site ID - 15), and eBay Germany (Site ID - 77) sites.
<br>
<br>
<span class="tablenote"><b>Note:</b> For Click and Collect eligible sellers, the Click and Collect feature can only be enabled at the account level, and then each of the seller's listings within an Click and Collect enabled category will be automatically evaluated for Click and Collect eligibility.
</span>
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
This field indicates whether or not most categories on the specified eBay site support digital gift cards.
<br/><br/>
Digital gift cards are currently only supported on the US site. There are some restrictions when it comes to selling gift cards, including the following:
<ul>
<li>Each seller can only have one gift card listing at any given time</li>
<li>The maximum dollar value of the gift card may not exceed 500.00</li>
<li>Prepaid credit cards from American Express, Discover, MasterCard, or Visa are not allowed</li>
</ul>
For more information on eBay's Gift Card policy, see the <a href="http://pages.ebay.com/help/policies/gift.html">Gift cards policy</a> Help page.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
This field is returned as <code>true</code> if one or more categories on an eBay site
support the use of an eBay Product ID (e.g. ePID) in an Add/Revise/Relist API
call to identify which motorcycles and/or scooters are compatible with a motor
vehicle part or accessory. ePIDs can only be used to identify motorcycles and
scooters on the Germany and UK sites. <br/><br/> For more
information on using an ePID to identify a compatible motorcycle or scooter
through an Add/Revise/Relist API call on the Germany or UK site, see the
documentation for the <a href="
http://developer.ebay.com/Devzone/XML/docs/Reference/eBay/AddItem.html#Request
.Item.ItemCompatibilityList.Compatibility.NameValueList">Compatibility.Name
ValueList</a> container.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
This field is returned as <code>true</code> if one or more categories on an eBay site
support the use of a K Type vehicle number in an Add/Revise/Relist API call
to identify which cars and/or trucks are compatible with a motor vehicle part
or accessory. K type vehicle numbers can only be used to identify cars and
trucks on the Germany site. <br/><br/> For more information on
using a K Type vehicle number to identify a compatible car or truck through an
Add/Revise/Relist API call on the Germany site, see the documentation for the
<a href="
http://developer.ebay.com/Devzone/XML/docs/Reference/eBay/AddItem.html#Request
.Item.ItemCompatibilityList.Compatibility.NameValueList">Compatibility.Name
ValueList</a> container.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
This field indicates whether or not the specified eBay site supports Product-Based Shopping Experience listings - listings that are associated with an eBay catalog product. The Product-Based Shopping Experience (PBSE) is currently supported by the US, UK, Germany, Australia, and Canada (English) sites.
<br>
<br>
<span class="tablenote"><b>Note:</b>
Due to the rollback of the Product-Based Shopping Experience mandate for all eBay categories, the <b>SiteDefaults.ProductRequiredEnabled</b> field no longer has any practical use, since its value with always be <code>Disabled</code>.
</span>
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
This field returns the options a seller has for accepting or not accepting domestic item returns.
<br><br>
The values returned in this field are pertinent only if <b>ReturnPolicyEnabled</b> in GetCategoryFeatures is set to <code>true</code> for the associated marketplace and category.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
This field returns the options a seller has for accepting or not accepting international item returns.
<br><br>
The values returned in this field are pertinent only if <b>ReturnPolicyEnabled</b> in GetCategoryFeatures is set to <code>true</code> for the associated marketplace and category.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
This field returns the options a seller has for specifying the return period for domestic item returns. The return period is the amount of time the buyer has to initiate a return once they have received the item.
<br><br>
The values returned in this field are pertinent only if <b>ReturnPolicyEnabled</b> in GetCategoryFeatures is set to <code>true</code> for the associated marketplace and category.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
This field returns the options a seller has for specifying the return period for international item returns. The return period is the amount of time the buyer has to initiate a return once they have received the item.
<br><br>
The values returned in this field are pertinent only if <b>ReturnPolicyEnabled</b> in GetCategoryFeatures is set to <code>true</code> for the associated marketplace and category.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
This field returns the options a seller has for specifying who pays the return shipping cost for domestic returns.
<br><br>
The values returned in this field are pertinent only if <b>ReturnPolicyEnabled</b> in GetCategoryFeatures is set to <code>true</code> for the associated marketplace and category.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
This field returns the options a seller has for specifying who pays the return shipping cost for international returns.
<br><br>
The values returned in this field are pertinent only if <b>ReturnPolicyEnabled</b> in GetCategoryFeatures is set to <code>true</code> for the associated marketplace and category.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
In US, sellers can offer an item replacement in addition to offering money-back for domestic returns. This field returns the options a seller has for specifying how they will handle domestic returns.
<br><br>
The values returned in this field are pertinent only if <b>ReturnPolicyEnabled</b> in GetCategoryFeatures is set to <code>true</code> for the associated marketplace and category.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
In US, sellers can offer an item replacement in addition to offering money-back for international returns. This field returns the options a seller has for specifying how they will handle international returns.
<br><br>
The values returned in this field are pertinent only if <b>ReturnPolicyEnabled</b> in GetCategoryFeatures is set to <code>true</code> for the associated marketplace and category.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
In some EU countries, sellers are legally required to describe the return policy they offer. This field returns a flag that indicates whether or not the seller can specify their return-policy details in the associated marketplace.
<br><br>
The values returned in this field are pertinent only if <b>ReturnPolicyEnabled</b> in GetCategoryFeatures is set to <code>true</code> for the associated marketplace and category.
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
Details about a specific site.
Short name that identifies an eBay site. Usually, an eBay site is associated
with a particular country or region (e.g., US or Belgium_French). Specialty
sites (e.g., eBay Stores) use the same site ID as their associated main eBay
site. The US eBay Motors site is an exception to this convention.
Item.Site in AddItem
AddItem.html#Request.Item.Site
User.Site in GetUser
GetUser.html#Response.User.Site
GeteBayDetails
Conditionally
Numeric identifier for an eBay site. If you are using the
SOAP API, you use numeric site IDs in the request URL.
If you are using the XML API, you use numeric site IDs in the
X-EBAY-API-SITEID header.
GeteBayDetails
Conditionally
Returns the latest version number for this field. The version can be
used to determine if and when to refresh cached client data.
GeteBayDetails
DetailLevel: none, ReturnSummary, ReturnAll
Always
Gives the time in GMT that the feature flags for the details were last
updated. This timestamp can be used to determine if and when to refresh
cached client data.
GeteBayDetails
DetailLevel: none, ReturnSummary, ReturnAll
Always
Type defining the <b>SiteHostedPictureDetails</b> container that is returned
in an <b>UploadSiteHostedPictures</b> call.
The seller-defined name for the picture. This field is only returned if a <b>PictureName</b> value was specified in the request. A name for a picture can make it easier to track than an arbitrary, eBay-assigned URL.
UploadSiteHostedPictures
Conditionally
This enumeration value indicates the size of the generated picture. This value may differ from the one specified in the request (e.g. if a Supersize image cannot be generated).
UploadSiteHostedPictures
Always
This enumeration value indicates the image format of the generated image, such as JPG, GIF, or PNG.
UploadSiteHostedPictures
Always
This is the full URL for the uploaded picture on the EPS server. This value should be stored by the seller, as this URL will be needed when create, revise, or relist an item and add this image to the listing. This URL will also be needed for unpublished pictures whose expiration date must be extended through an <b>ExtendSiteHostedPictures</b> call.
UploadSiteHostedPictures
Always
This is the truncated version of the full URL.
UploadSiteHostedPictures
Always
The URL and size information for each generated image.
UploadSiteHostedPictures
Always
The URL of the external Web site hosting the uploaded photo. This field is returned if an <b>ExternalPictureURL</b> is provided in the call request.
<br>
500
1
UploadSiteHostedPictures
Conditionally
This timestamp indicates when the picture must be uploaded with an eBay listing before it is purged from the EPS server.
<br>
<br>
By default, unpublished pictures (not associated with an active eBay listing) are kept on the EPS server for five days, but a seller can use the <b>ExtensionInDays</b> field in the request to make the expiration date further into the future (a maximum of 30 days). The seller can also use the <b>ExtendSiteHostedPictures</b> to extend the expiration date of the picture.
UploadSiteHostedPictures
Always
Site criteria for filtering search results. The site value is determined by the
site specified in the request (the site ID in the SOAP URL or, for Unified
Schema XML requests, the site ID in the X-EBAY-API-SITEID HTTP Header).
(in) Items listed in the currency implied by the site specified in the
request.
(in) Items located in the country implied by the site specified in the
request.
(in) Items available to the country implied by the site specified in the
request. For the US site, this implies listings from ALL English-language
countries that are available to the US.
(in) Items listed on the site specified in the request, regardless of listing
currency.
(in) Items located in Belgium or listed on one of the two Belgian sites.
(out) Reserved for internal or future use.
Contains the data that defines a site-based filter (used when searching for
items and filtering the search result set).
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.
This type is deprecated.
773
Avoid
GetCategoryFeatures
889
This field is deprecated.
This field is deprecated.
This type is no longer applicable as member communication through Skype has been disabled in API calls.
The seller can communicate with the buyer by Skype Chat.
The seller can communicate with the buyer by Skype Voice.
Reserved for internal or future use.
This type is no longer applicable as member communication through Skype has been disabled in API calls.
This type is no longer applicable as member communication through Skype has been disabled in API calls.
This type specifies the sort order of a returned array of elements. The array or list to be sorted, the sort key, and the default sort order depend on the call.
The results will be sorted by the specified key in ascending (low to high) order.
The results will be sorted by the specified key in descending (high to low) order.
(out) Reserved for internal or future use.
Indicates category support for listing of Local Market items by sellers
subscribed to Local Market for Specialty Vehicles.
Each of the subscriptions will have following options, which will define
"National" vs "Local" ad format listing.
"LocalOptional" : This will allow national and local listing.
"LocalOnly" : Seller can have Local listings only.
"NationalOnly" : Seller can not opt into local only exposure. It has to be
national listing.
This type is no longer used and was replaced by <b>ShippingLocationDetails</b>.
This field is deprecated.
This field is deprecated.
This field is deprecated.
Specifies the type of action to carry out with SetStoreCategories.
(in) Add the listed categories to the store.
(in) Delete the listed categories from the store.
(in) Move the listed categories from one place in the store category
structure to another.
(in) Rename the listed store categories to the names provided.
(out) Reserved for internal or future use.
Set of eBay Store color schemes.
A Store color scheme.
GetStoreOptions
Always
Store color scheme.
Store color scheme ID. (use GetStoreOptions to get the list of
valid theme color scheme IDs).
SetStore
Conditionally
GetStore
Conditionally
GetStoreOptions
Always
Store color scheme name. Provides a user-friendly name for the
color scheme.
SetStore
Conditionally
GetStore
Conditionally
GetStoreOptions
Always
Store color set.
SetStore
Conditionally
GetStore
Conditionally
GetStoreOptions
Always
Container consisting of the Store's font properties. This container is not returned if an eBay predefined store theme is
used 'as is'. Use the <b>GetStoreOptions</b>
call to retrieve the complete set of data for the list of predefined eBay Stores options, including the themes and color
schemes.
SetStore
Conditionally
GetStoreOptions
GetStoreOptions.html
GetStore
Conditionally
GetStoreOptions
GetStoreOptions.html
GetStoreOptions
Always
Store color set.
Primary color for the Store. Specified in 6-digit Hex format.
For example: F6F6C9
6
SetStore
Conditionally
GetStore
Conditionally
GetStoreOptions
Always
Secondary color for the Store. Specified in 6-digit Hex format.
For example: F6F6C9
6
SetStore
Conditionally
GetStore
Conditionally
GetStoreOptions
Always
Accent color for the Store. Specified in 6-digit Hex format.
For example: F6F6C9
6
SetStore
Conditionally
GetStore
Conditionally
GetStoreOptions
Always
Set of custom categories for the Store.
A custom category for your eBay Store.
GetStore
Always
SetStoreCategories
Yes
Configuration of a store custom category.
Custom category ID. For SetStoreCategories, required only if
Action is set to Rename, Move or Delete.
GetStore
SetStoreCategories
Always
SetStoreCategories
Conditionally
Name of the custom category.
GetStore
SetStoreCategories
Always
SetStoreCategories
Conditionally
Order in which the custom category appears in the list of store
categories.
GetStore
SetStoreCategories
Always
SetStoreCategories
No
Contains the properties of a custom subcategory for an eBay Store. eBay Stores support
three category levels.
3
GetStore
SetStoreCategories
Always
SetStoreCategories
Conditionally
Specifies whether the Store has a custom header.
Specifies that the Store does not have a custom header.
Specifies that the Store does have a custom header.
(out) Reserved for internal or future use.
Specifies how the custom listing header will be displayed.
No custom listing header is displayed.
The full custom listing header is displayed.
The full custom listing header and the left navigation bar is displayed.
(out) Reserved for internal or future use.
Specifies the type of link in the custom listing header.
No type.
Link is to an About Me page.
Link is to a custom page.
Link is to a custom category.
(out) Reserved for internal or future use.
Custom listing header link.
Link ID for the listing header link. The ID is used when the link
is a custom category or for a custom page, and it is not needed
when the LinkType property is "AboutMe" or "None".
SetStore
Conditionally
GetStore
Conditionally
Order in which to show the custom listing header link.
SetStore
Conditionally
GetStore
Conditionally
Type of link to include in the custom listing header.
SetStore
Conditionally
GetStore
Conditionally
Configuration of a Store custom listing header.
Display type for the custom listing header.
SetStore
Conditionally
GetStore
Conditionally
Specifies whether the custom header has a logo.
SetStore
Conditionally
GetStore
Conditionally
Specifies whether the custom header has a search box.
SetStore
Conditionally
GetStore
Conditionally
Link to include in the custom header.
SetStore
Conditionally
GetStore
Conditionally
Specifies whether the custom header has a link to Add to
Favorite Stores.
SetStore
Conditionally
GetStore
Conditionally
Specifies whether the custom header has a link to Sign up for Store
Newsletter.
SetStore
Conditionally
GetStore
Conditionally
Set of Store custom pages.
A Store custom page.
GetStoreCustomPage
Always
List of possible statuses for Store custom pages.
The page is visible.
The page is to be deleted.
The page is not visible.
Reserved for internal or future use.
Type defining <b>CustomPage</b> container, which is used by a seller in
<b>SetStoreCustomPage</b> to configure and create an eBay Store custom
page. The <b>CustomPage</b> container can also be used to modify an
existing custom page (by including a <b>PageID</b> value). The
<b>CustomPage</b> container is always returned in the
<b>GetStoreCustomPage</b> response.
Name of the eBay Store custom page. This value is required if you are creating a new
page (and omitting a <b>PageID</b> value). Note that you must include a
name for the page even if you are using the <b>PreviewEnabled</b> flag.
However, since using the preview functionality means that the page will not be
persisted, you can enter a dummy value for this field if you have not decided on a
name for the page. The <b>Name</b> value is used in links to the page.
GetStoreCustomPage
Always
SetStoreCustomPage
Conditionally
SetStoreCustomPage
Conditionally
Unique identifier for an eBay Store custom page. If you specify a valid
<b>PageID</b> value in a
<b>SetStoreCustomPage</b> call, the existing custom page
is updated. If you do not specify a <b>PageID</b> value, you are
creating a new custom page.
<br/><br/>
The <b>PageID</b> field is always returned in
<b>GetStoreCustomPage</b>.
GetStoreCustomPage
Always
SetStoreCustomPage
Conditionally
SetStoreCustomPage
Conditionally
The URL path of the eBay Store custom page. This field is only required if you are
using Chinese characters in the <b>Name</b> field. The URL path of the
eBay Store custom page is normally derived from the <b>Name</b> field, but
the URL path cannot be derived from the name of the custom page if it contains Chinese
characters because URLs cannot contain Chinese characters.
<br/><br/>
The <b>URLPath</b> is only returned in the <b>GetStoreCustomPage</b>
response if it is defined for the eBay Store custom page, and if a <b>PageID</b>
value is included in the request.
GetStoreCustomPage
Conditionally
SetStoreCustomPage
Conditionally
SetStoreCustomPage
Conditionally
The full URL of the eBay Store custom page, which is generally derived from the
<b>CustomPage.Name</b> value. The exception to this rule is if the seller
specified a custom URL using the <b>CustomPage.URLPath</b> field in a
<b>SetStoreCustomPage</b> call.
<br/><br/>
The <b>URL</b> is only returned in the
<b>GetStoreCustomPage</b> response if a <b>PageID</b> value
is included in the request.
GetStoreCustomPage
Conditionally
This value indicates the status of the eBay custom page. In a
<b>SetStoreCustomPage</b> call, the seller uses the optional
<b>Status</b> field to make an inactive custom page active, to make an
active custom page inactive, or to delete an active or inactive custom page. To
change the status (including delete) of a custom page, a <b>PageID</b>
value must be included to identify the custom page to modify.
<br/><br/>
The <b>Status</b> value is always returned in the
<b>GetStoreCustomPage</b> response.
GetStoreCustomPage
Active, Inactive
Always
SetStoreCustomPage
Conditionally
SetStoreCustomPage
Conditionally
The HTML content of the eBay Store custom page. This field has a maximum size of 96
kilobytes. If the <b>PreviewEnabled</b> field is set to 'true', then
this field is required in a <b>SetStoreCustomPage</b> call. Otherwise,
it is optional.
<br/><br/>
The <b>Content</b> field is only returned in the
<b>GetStoreCustomPage</b> response if a <b>PageID</b> value
is included in the request.
GetStoreCustomPage
Conditionally
SetStoreCustomPage
Conditionally
SetStoreCustomPage
Conditionally
This flag controls whether or not the left navigation bar is included in the eBay
Store custom page. To include the left navigation bar in a custom page, the seller
will include the <b>LeftNav</b> field in the <b>SetStoreCustomPage</b>
request and set it to 'true'.
<br/><br/>
The <b>LeftNav</b> field is only returned in the
<b>GetStoreCustomPage</b> response if a <b>PageID</b> value
is included in the request.
GetStoreCustomPage
Conditionally
SetStoreCustomPage
Conditionally
SetStoreCustomPage
Conditionally
This flag controls whether or not a custom page preview is enabled. To enable the
a custom page preview, the seller will include the
<b>PreviewEnabled</b> field in the <b>SetStoreCustomPage</b>
request and set it to 'true'.
<br/><br/>
The <b>PreviewEnabled</b> field is only returned in the
<b>GetStoreCustomPage</b> response if a <b>PageID</b> value
is included in the request.
SetStoreCustomPage
No
SetStoreCustomPage
Conditionally
This integer value controls the order in which the corresponding eBay Store custom
page is displayed in the list of custom pages. To make the corresponding custom
page appear first in the list of custom pages, the seller would include the
<b>Order</b> field and set its value to '1'.
<br/><br/>
The <b>Order</b> value is always returned in the
<b>GetStoreCustomPage</b> response.
GetStoreCustomPage
Always
SetStoreCustomPage
Conditionally
SetStoreCustomPage
Conditionally
Font selection for Store configuration.
Arial font.
Courier font.
Times New Roman font.
Verdana font.
Reserved for internal or future use.
Font size selection for Store configuration.
Extra extra small.
Extra small.
Small.
Medium.
Large.
Extra large.
Extra extra large.
Reserved for internal or future use.
Store font set.
Font for the Store name.
SetStore
Conditionally
GetStore
Conditionally
GetStoreOptions
Always
Font size for the Store name.
SetStore
Conditionally
GetStore
Conditionally
GetStoreOptions
Always
Font color for the Store name. Specified in 6-digit Hex format.
For example: F6F6C9
6
SetStore
Conditionally
GetStore
Conditionally
GetStoreOptions
Always
Font for the Store section title.
SetStore
Conditionally
GetStore
Conditionally
GetStoreOptions
Always
Font size for the Store section title.
SetStore
Conditionally
GetStore
Conditionally
GetStoreOptions
Always
Font color for the Store section title. Specified in 6-digit Hex
format. For example: F6F6C9
SetStore
Conditionally
GetStore
Conditionally
GetStoreOptions
Always
Font for the Store description.
SetStore
Conditionally
GetStore
Conditionally
GetStoreOptions
Always
Font size for the Store description.
SetStore
Conditionally
GetStore
Conditionally
GetStoreOptions
Always
Font color for the Store description. Specified in 6-digit Hex
format. For example: F6F6C9
SetStore
Conditionally
GetStore
Conditionally
GetStoreOptions
Always
The full Store header is used.
A minimized Store header is used.
(out) Reserved for internal or future use.
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.
Displays item list as a single column, with smaller item pictures.
Displays item list in two columns, with larger item pictures.
(out) Reserved for internal or future use.
List of available options for how items are sorted in an eBay Store.
Lists items with those ending soon listed first.
Lists items with those newly listed appearing in the list first.
Lists items by price in ascending order. The item with the lowest
starting price is listed first.
Lists items by price in descending order. The item with the highest
starting price is listed first.
Lists items by combined price and shipping cost in ascending order. The item
with the lowest combined starting price plus shipping cost is listed first.
Reserved for future use.
Lists items by combined price and shipping cost in descending order. The item
with the highest combined starting price plus shipping cost is listed first.
(out) Reserved for internal or future use.
Set of Store logos.
A Store logo.
GetStoreOptions
Always
Store logo.
Store logo ID (use GetStoreOptions to get the list of valid logo IDs).
SetStore
Conditionally
GetStore
Conditionally
GetStoreOptions
Always
Store logo name. Provides a user-friendly name for the logo.
SetStore
Conditionally
GetStore
Conditionally
GetStoreOptions
Always
URL of the logo. Must have a .gif or .jpg extention. Specified when
you are using a customized logo.
SetStore
Conditionally
GetStore
Conditionally
If the field is present, the corresponding feature applies to the category. The
field is returned as an empty element (i.e., a boolean value is not returned).
If the field is present, the corresponding feature applies to the category. The
field is returned as an empty element (i.e., a boolean value is not returned).
This type is used to specify the additional listing durations that are available to sellers who have eBay Store subscriptions. The <b>StoreOwnerExtendedListingDurations</b> container is only returned under the <b>SiteDefaults</b> node if the eBay marketplace supports additional listing durations for eBay Store owners, and this container is only returned under a <b>Category</b> node if this eBay category supports additional listing durations for eBay Store owners (other than the durations that are already supported for the category).
Specifies the additional listing duration(s) (in days) supported by the eBay site and/or category. A <b>Duration</b> field is returned for each additional listing duration that the eBay marketplace or category supports.
ListingDurationCodeType
GetCategoryFeatures
DetailLevel: ReturnAll
Conditionally
Store Preferences type.
Store vacation hold preferences.
GetStorePreferences
Conditionally
SetStorePreferences
No
Set of eBay Store subscription levels.
A Store subscription level.
GetStoreOptions
Always
This enumerated type contains the different subscription levels that a seller may subscribe to for their eBay Store. There is also one enumeration value (<code>Close</code>) that allows a seller to cancel their current eBay Store subscription with a <b>SetStore</b> call.
This value is passed into the <b>Store.SubscriptionLevel</b> field of a <b>SetStore</b> call to cancel your current eBay Store subscription. Despite its name, this action does not close your store immediately. Any active listings will remain available through your eBay Store until those listings have ended (either through a sale or when listing end time has been reached).
This enumeration value indicates that the eBay user has a Basic eBay Store subscription.
This enumeration value indicates that the eBay user has a Premium eBay Store subscription.
This enumeration value indicates that the eBay user has an Anchor eBay Store subscription.
This enumeration value indicates that the eBay user has a Starter eBay Store subscription.
This enumeration value indicates that the eBay user has an Enterprise eBay Store subscription.
Reserved for internal or future use.
Type used by the Subscription container that is returned in GetStoreOptions to indicate the subscription level and monthly fee associated with the eBay Store.
Store subscription level.
GetStoreOptions
Anchor, Basic, Featured
Always
Monthly fee for the Store subscription level.
GetStoreOptions
Always
Set of Store themes.
A Store theme.
GetStoreOptions
Always
Set of color schemes. This set is for use with those themes that do
not explicitly list a color scheme in the theme definition (these
themes are also known as advanced themes).
GetStoreOptions
Always
AdvancedThemeArray
Store theme.
Store theme ID (use GetStoreOptions to get the list of valid theme
IDs).
SetStore
Conditionally
GetStore
Conditionally
GetStoreOptions
Always
Store theme name. Provides a user-friendly name for the theme.
SetStore
Conditionally
GetStore
Conditionally
GetStoreOptions
Always
Theme color scheme.
SetStore
Conditionally
GetStore
Conditionally
GetStoreOptions
Always
BasicThemeArray
The configuration of an eBay Store.
Name of the eBay Store. The name is shown
at the top of the Store page.
35
SetStore
Conditionally
GetStore
Always
The URL path of the Store (58 characters maximum). Only if you
are using Chinese characters in the Name property do you need to
use this field, such as if you are opening a Store on the Taiwan
site. The reason for this is that the URL path is normally derived
from the Store name, but it cannot be derived from the name of the
Store if it contains Chinese characters because URLs cannot
contain Chinese characters.
SetStore
Conditionally
GetStore
Conditionally
The complete URL of the user's Store. This field is only ever
returned, and does not need to be explicitly set.
SetStore
Conditionally
GetStore
Conditionally
For the <b>GetStore</b> call, the value returned in this field indicates the user's eBay Store subscription level.
<br>
<br>
For the <b>SetStore</b> call, the user can only cancel the current eBay Store subscription (using the <b>Close</b> enumeration value), and cannot change the subscription level. A seller will have to go to the Subscriptions area of My eBay to change their subscription level. Keep in mind that an early termination fee may apply if a user has a yearly subscription, and then either cancels their subscription, or downgrades their subscription level.
Closed
SetStore
No
GetStore
Closed, CustomCode
Always
eBay Stores Subscription Terms of Service (US site)
https://pages.ebay.com/stores/subscriptionterms.html
Store description (300 characters maximum).
SetStore
Conditionally
GetStore
Always
Store logo.
SetStore
Conditionally
GetStore
Conditionally
Store theme.
SetStore
Conditionally
GetStore
Conditionally
Style for the Store header.
SetStore
Conditionally
GetStore
Conditionally
Page to use as the Store's homepage (default is 0). To change the
homepage, specify the PageID of one of the Store's custom pages.
SetStore
Conditionally
GetStore
Conditionally
The default layout type to use for the Store items.
SetStore
Conditionally
GetStore
Conditionally
The default sort order to use for the items for sale in the Store.
SetStore
Conditionally
GetStore
Conditionally
Layout for the Store's custom header.
SetStore
Conditionally
GetStore
Conditionally
Custom header text for the Store.
SetStore
Conditionally
GetStore
Conditionally
Specifies whether to export the Store listings to comparison
shopping websites.
SetStore
Conditionally
GetStore
Conditionally
Container consisting of an array of one or more <b>CustomCategory</b>
containers. Each <b>CustomCategory</b> container consists of details
related to an eBay Store custom category.
<br>
<br>
To modify an eBay Store's custom categories, an eBay Store owner would use the
<b>StoreCategories</b> container in the request of a
<b>SetStoreCategories</b> call.
GetStore
Always
Custom listing header for the Store.
SetStore
Conditionally
GetStore
Conditionally
This field is deprecated.
Indicates the time the store was last opened or reopened.
SetStore
Conditionally
GetStore
Conditionally
A flag indicating if a Compatibility tab exists for the Store item listing. This
field is only applicable to Parts & Accessories listings in eBay US Motors.
The Compatibility tab will contain vehicles that are compatible with the part
in the listing. The seller specifies this information at listing time.
SetStore
No
GetStore
Conditionally
This type is used by the <b>VacationPreferences</b> container that is set in a <b>SetStorePreferences</b> call and returned in a <b>GetStorePreferences</b> call.
In a <b>SetStorePreferences</b> call, this field should be included in the request and set to <code>true</code> if the eBay store owner is going on vacation and wants to temporarily turn off all active listings. Conversely, if the eBay store owner is back from vacation, this field can be included and set to <code>false</code> to turn off the vacation setting.
<br/><br/>
If the 'On Vacation' setting is turned on for an eBay store owner, all of the store owner's listings will be hidden from search, and shoppers can not buy any items from that store.
<br/><br/>
In a <b>GetStorePreferences</b> call, this field is returned as <code>true</code> if the 'On Vacation' setting is turned on, or returned as <code>false</code> if the 'On Vacation' setting is turned off.
GetStorePreferences
Always
SetStorePreferences
No
In a <b>SetStorePreferences</b> call, this field should be included in the request if the eBay store owner wants to inform shoppers when he/she will return from vacation. The seller should make sure they use the proper date-time format, as specified in the <b>dateTime</b> simple type. If a date is specified in this field, the following behavior can be expected:<br/>
<ul>
<li>The 'On Vacation' setting (if it was turned on) will automatically be turned off when this date is reached</li>
<li>This return date will be displayed in the listing if the <b>VacationPreferences.MessageItem</b> field is set to <code>true</code></li>
<li>This return date will be displayed on the seller's store page if the <b>VacationPreferences.MessageStore</b> field is set to <code>true</code></li>
</ul>
In a <b>GetStorePreferences</b> call, this field is returned if it was set.
GetStorePreferences
Conditionally
SetStorePreferences
No
This field is deprecated, as it was used for Store Inventory listings, which are no longer supported on any eBay site.
In a <b>SetStorePreferences</b> call, this field should be included in the request and set to <code>true</code> if the eBay store owner wants information regarding the vacation to be posted on all of the seller's active listings. The following information will be displayed if this field is set to <code>true</code>:<br/>
<ul>
<li>A note about the seller being on vacation (and items being unavailable for purchase) if the <b>OnVacation</b> field is set to <code>true</code></li>
<li>The date when the seller will return from vacation if the <b>ReturnDate</b> was set</li>
</ul>
If this field is included in the <b>SetStorePreferences</b> request and set to <code>false</code>, no information regarding the seller's vacation will appear on active listings.
<br/><br/>
In a <b>GetStorePreferences</b> call, this field is returned as <code>true</code> if information regarding the vacation is being displayed on active listings, or returned as <code>false</code> if no information regarding the vacation is being displayed on active listings.
GetStorePreferences
Always
SetStorePreferences
No
True
In a <b>SetStorePreferences</b> call, this field should be included in the request and set to <code>true</code> if the eBay store owner wants information regarding the vacation to be posted on store pages. The following information will be displayed if this field is set to <code>true</code>:<br/>
<ul>
<li>A note about the seller being on vacation (and items being unavailable for purchase) if the <b>OnVacation</b> field is set to <code>true</code></li>
<li>The date when the seller will return from vacation if the <b>ReturnDate</b> was set</li>
<li>A customized message from the seller regarding this vacation if the seller included a customized message through the <b>MessageStoreCustomText</b> field and the <b>DisplayMessageStoreCustomText</b> was set to </code>true</code>. If the <b>DisplayMessageStoreCustomText</b> is set to </code>false</code>, the generic 'On Vacation' and return date (if available) will be displayed instead.</li>
</ul>
In a <b>GetStorePreferences</b> call, this field is returned as <code>true</code> if information regarding the vacation is being displayed on the store page, or returned as <code>false</code> if no information regarding the vacation is being displayed on the store page.
GetStorePreferences
Always
SetStorePreferences
No
In a <b>SetStorePreferences</b> call, this field should be included in the request and set to <code>true</code> if the eBay store owner wants a custom message regarding a vacation to display on store pages. For this field to have an affect, the seller will create their custom message regarding the vacation through the <b>MessageStoreCustomText</b> field. If this field is turned off (or <code>false</code>), instead of a custom message, a generic 'On Vacation' message and the return date (if available) will be posted to the Store pages.
<br/><br/>
In a <b>GetStorePreferences</b> call, this field is returned as <code>true</code> if the seller wants a customized vacation message to be displayed on the store page, or returned as <code>false</code> if the seller wants the generic 'On Vacation' message and the return date (if available) to be posted to the Store pages.
GetStorePreferences
Always
SetStorePreferences
No
In a <b>SetStorePreferences</b> call, this field should be included in the request, and the seller will create the customized vacation message in this field. HTML markup can be used in this field. This vacation message will appear on store pages as long as the <b>DisplayMessageStoreCustomText</b> field is set to <code>true</code>. If the <b>DisplayMessageStoreCustomText</b> field is set to <code>false</code>, any text provided through the <b>MessageStoreCustomText</b> will not be displayed on store pages.
<br/><br/>
In a <b>GetStorePreferences</b> call, this field is returned if it is set.
10000
GetStorePreferences
Conditionally
SetStorePreferences
No
This type defines the <b>Storefront</b> 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. A custom category is a category that was created by a seller in their eBay store. This container is used by Add/Revise/Relist calls.
<br/><br/>
The <b>Storefront</b> container is also returned in <b>GetItem</b> and other Trading calls that retrieve Item data.
<br/><br/>
<span class="tablenote"><b>Note: </b>
This type is applicable only for eBay Store sellers.
</span>
Unique identifier of a primary custom category in which to list the item. A custom category is a category that the seller created in their eBay Store. eBay Store sellers can create up to three levels of custom categories for their stores, but the API only supports root-level categories.
<br> <br>
To list an item using the categories in a seller's store, you must set this field to a root-level custom category or a custom category that has no child categories (subcategories). If you attempt to list an item in a category that has subcategories, the call response contains a warning, and the item is listed in the 'Other' store category.
AddFixedPriceItem
AddItem
AddItems
AddSellingManagerTemplate
RelistFixedPriceItem
RelistItem
ReviseFixedPriceItem
ReviseItem
ReviseSellingManagerTemplate
VerifyAddFixedPriceItem
VerifyAddItem
VerifyRelistItem
No
GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
GranularityLevel: Coarse, Medium, Fine
Conditionally
GetBidderList
Conditionally
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally
Unique identifier for the secondary custom category in which to list the item. Set this field to a root-level custom category or a custom category that has no child categories (subcategories).
<br> <br>
The system resets the value to 0 (None) in the following cases:
<br> - The values of <b>StoreCategoryID</b> and <b>StoreCategory2ID</b> field are the same
<br> - You specify <b>StoreCategory2ID</b> but not <b>StoreCategoryID</b>
<br> <br>
<br>In other words, <b>StoreCategoryID</b> must be set to a valid custom category and be different from <b>StoreCategory2ID</b>.
AddFixedPriceItem
AddItem
AddItems
AddSellingManagerTemplate
RelistFixedPriceItem
RelistItem
ReviseFixedPriceItem
ReviseItem
ReviseSellingManagerTemplate
VerifyAddFixedPriceItem
VerifyAddItem
VerifyRelistItem
No
GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
GranularityLevel: Coarse, Medium, Fine
Conditionally
GetBidderList
Conditionally
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally
Category name of a primary custom category in which to list the item. A custom category is a category that the seller created in their eBay Store. eBay Store sellers can create up to three levels of custom categories for their stores, but the API only supports root-level categories.
<br> <br>
To list an item using a category name from a seller's store, you must set this field to a root-level custom category or a custom category that has no child categories (subcategories). If you attempt to list an item in a category that has subcategories, the call response contains a warning, and the item is listed in the store category called 'Other'.
AddFixedPriceItem
AddItem
AddItems
RelistFixedPriceItem
RelistItem
ReviseFixedPriceItem
ReviseItem
VerifyAddFixedPriceItem
VerifyAddItem
VerifyRelistItem
No
Name of the secondary custom category in which to list the item. Set this field to a root-level custom category or a custom category that has no child categories (subcategories).
<br> <br>
The system resets the value to 0 (None) in the following cases:
<br> - The values of <b>StoreCategoryName</b> and <b>StoreCategory2Name</b> field are the same
<br> - You specify <b>StoreCategory2Name</b> but not <b>StoreCategoryName</b>
<br> <br>
<br>In other words <b>StoreCategoryName</b> must be set to a valid custom category name and be different from <b>StoreCategory2Name</b>.
AddFixedPriceItem
AddItem
AddItems
RelistFixedPriceItem
RelistItem
ReviseFixedPriceItem
ReviseItem
VerifyAddFixedPriceItem
VerifyAddItem
VerifyRelistItem
No
The URL of the seller's eBay Stores page.
GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
GranularityLevel: Coarse, Medium, Fine
Conditionally
GetBidderList
Conditionally
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally
The name of the seller's eBay Store.
200
Indicates the type of string matching to use
when a value is submitted in CharityName. If no value is
specified, default behavior is "StartsWith." Does not
apply to Query.
(in) Reserved for internal or future use.
(in) Matches strings that begin with the submitted
value. For example, submitting a CharityName value
of "heart" matches "Heart of Gold," but not "Open
Hearts." Default behavior if no value is
specified.
(in) Matches strings that contain the submitted
value. For example, submitting a CharityName value
of "heart" matches both "Heart of Gold" and "Open
Hearts."
This type is used by the <b>SuggestedBidValues</b> container that is returned if the buyer is attempting to bid on an auction item through the <b>PlaceOffer</b> call.
The <b>SuggestedBidValues</b> container is only returned if the buyer is attempting to bid on an auction item. A <b>BidValue</b> field is returned for each incremental bid value (up to the dollar value specified in the <b>Offer.MaxBid</b> field in the request) that eBay will bid on behalf of the buyer each time that buyer is outbid for the auction item. How many <b>BidValue</b> fields that appear will depend on the current winning bid amount, the required bid increment, and the buyer's specified max bid amount.
PlaceOffer
Conditionally
Contains an array of categories that contain listings with
specified keywords in their titles or descriptions. The array
can contain up to 10 categories.
Describes a category that contains listings that match
specified keywords in the query. Returned if a category matches the query.
GetSuggestedCategories
Conditionally
Defines a suggested category, returned
in response to a search for categories that contain
listings with certain keywords in their titles and descriptions.
Describes a category that contains items that match the query.
GetSuggestedCategories
Conditionally
Percentage of the matching items that were found in this category,
relative to other categories in which matching items were also found.
Indicates the distribution of matching items across the suggested categories.
GetSuggestedCategories
Conditionally
Details about a summary event schedule.
The event type associated with this alert.
SetNotificationPreferences
None
Conditionally
GetNotificationPreferences
Conditionally
The period of time for which to create a summary.
SetNotificationPreferences
Conditionally
GetNotificationPreferences
Conditionally
How often the summary is to be delivered.
SetNotificationPreferences
Conditionally
GetNotificationPreferences
Conditionally
How often the summary is to be delivered.
Deliver every Sunday.
Deliver every Monday.
Deliver every Tuesday.
Deliver every Wednesday.
Deliver every Thursday.
Deliver every Friday.
Deliver every Saturday.
On day 1 of the month.
On day 2 of the month.
On day 3 of the month.
On day 4 of the month.
On day 5 of the month.
On day 6 of the month.
On day 7 of the month.
On day 8 of the month.
On day 9 of the month.
On day 10 of the month.
On day 11 of the month.
On day 12 of the month.
On day 13 of the month.
On day 14 of the month.
On day 15 of the month.
On day 16 of the month.
On day 17 of the month.
On day 18 of the month.
On day 19 of the month.
On day 20 of the month.
On day 21 of the month.
On day 22 of the month.
On day 23 of the month.
On day 24 of the month.
On day 25 of the month.
On day 26 of the month.
On day 27 of the month.
On day 28 of the month.
On day 29 of the month.
On day 30 of the month.
On day 31 of the month.
Every 31 days.
Every 60 days.
The period of time for which to create a summary.
The last 24 hours.
The last 7 days.
The last 31 days.
The current week.
The prior week.
The current month.
The prior month.
The last 60 days.
Type defining the <b>SupportedSellerProfile</b> container, which contains
summary information related to specific Business Policies payment, return policy, and shipping
profiles. The profile type is found in the <b>ProfileType</b> field.
Unique identifier of a Business Policies profile. This identifier is auto-generated by eBay when the seller creates the profile. This field is always
returned with the <b>SupportedSellerProfile</b> container.
GetUserPreferences
Conditionally
SetUserPreferences
No
Indicates the type of the Business Policies profile. Valid values are PAYMENT,
RETURN_POLICY, and SHIPPING. This field is always returned with the
<b>SupportedSellerProfile</b> container.
GetUserPreferences
Conditionally
SetUserPreferences
No
The seller-defined name for a Business Policies profile. This field is always
returned with the <b>SupportedSellerProfile</b> container.
GetUserPreferences
Conditionally
SetUserPreferences
No
Seller-provided description of a Business Policies profile. This field is only
returned if a seller has provided a description for the profile.
GetUserPreferences
Conditionally
SetUserPreferences
No
Identifies the the Business Policies category group associated with the Business
Policies profile. Current values are ALL (referring to all non-motor vehicle
categories) and MOTORS_VEHICLE (for motor vehicle listings).
GetUserPreferences
Conditionally
SetUserPreferences
No
Type defining the <b>SupportedSellerProfiles</b> container for all payment,
return, and shipping policy profiles that a seller has defined for a site.
Container consisting of information related to specific Business Policies payment, return,
and shipping policy profiles. The profile type is found in the
<b>ProfileType</b> field.
GetUserPreferences
Conditionally
SetUserPreferences
No
Defines the Transaction Confirmation Request feature. If the field is present, the corresponding feature applies to the category. The field is returned as an empty element (i.e., a boolean value is not returned).
Status values for the processing progress for the category structure changes
specified by a SetStoreCategories request. If the SetStoreCategories call is
processed asynchronously, then the status is returned by
GetStoreCategoryUpdateStatus, otherwise, the status is returned in the
SetStoreCategories response.
(out) The category changes have not started.
(out) The category changes are in progress.
(out) The category changes completed successfully.
(out) The category changes failed.
(out) Reserved for internal or future use.
Enumerated type that lists the types of taxes that may be charged to the buyer for each order line item purchased.
This enumeration value indicates that standard sales tax was charged to the buyer against the order line item.
This enumeration value indicates that an electronic waste recycling fee was charged to the buyer against the order line item.
This enumeration value indicates that a tire recycling fee was charged to the buyer against the order line item.
This enumeration value indicates that a Goods and Services import tax was charged to the buyer against the order line item.
<br/><br/>
<span class="tablenote"><b>Note: </b> At this time, this tax type is only applicable to the Australia site.
</span>
Reserved for internal or future use.
Type used by the <b>TaxDetails</b> container, which consists of detailed tax information for an order line item, including the tax type and description, tax on the item cost, and tax related to shipping and handling. The information in this container supercedes/overrides the sales tax information in the <b>ShippingDetails.SalesTax</b> container (if returned).
This field indicates the tax type. A separate <b>TaxDetails</b> container is returned for each unique imposition (tax type).
GetItemTransactions
GetOrders
GetOrderTransactions
GetSellerTransactions
DetailLevel: none, ReturnAll
Conditionally
OrderReport
Conditionally
SoldReport
Conditionally
This enumeration indicates the type of tax.
GetItemTransactions
GetOrders
GetOrderTransactions
GetSellerTransactions
DetailLevel: none, ReturnAll
Conditionally
OrderReport
Conditionally
SoldReport
Conditionally
This value is the total amount of sales tax for the order line item for the
corresponding impositiion (tax type).
<br><br>
<b>TaxAmount</b> = <b>TaxOnSubtotalAmount</b> + <b>TaxOnShippingAmount</b> + <b>TaxOnHandlingAmount</b>
<br><br>
<span class="tablenote"><b>Note: </b> If the corresponding tax type is <code>GST</code> or <code>SalesTax</code> (if found under both the <b>eBayCollectAndRemitTaxes.TaxDetails</b> and <b>Taxes.TaxDetails</b> containers), the order is subject to 'eBay Collect and Remit' tax, and a change in logic has been rolled out as of early November 2019. For orders that are subject to 'eBay Collect and Remit' tax, which includes US sales tax for numerous states, and 'Good and Services' tax that is applicable to Australian and New Zealand sellers, the tax amount in this field will be included in the <b>Order.Total</b>, <b>Order.AmountPaid</b>, and <b>Transaction.AmountPaid</b> fields.
<br><br>
Sellers should be aware that the sales tax that the buyer pays for the order will initially be included when the order funds are distributed to their PayPal account, but that PayPal will pull out the sales tax amount shortly after the payment clears, and will distribute the sales tax to the appropriate taxing authority. Previous to this change, PayPal would strip out the 'Collect and Remit' tax before distributing order funds to the seller's account.
<br><br>
This logic change does not apply to sellers who are in eBay managed payments, so the amount in this field will never reflect any 'Collect and Remit' tax, even if the order is subject to 'Collect and Remit' tax.
</span>
GetItemTransactions
GetOrders
GetOrderTransactions
GetSellerTransactions
DetailLevel: none, ReturnAll
Conditionally
OrderReport
Conditionally
SoldReport
Conditionally
This value is the amount of sales tax applied based on the unit cost of the
order line item for the corresponding impositiion (tax type).
GetItemTransactions
GetOrders
GetOrderTransactions
GetSellerTransactions
DetailLevel: none, ReturnAll
Conditionally
OrderReport
Conditionally
SoldReport
Conditionally
This value is the amount of sales tax applied based on shipping costs for the
order line item for the corresponding impositiion (tax type).
GetItemTransactions
GetOrders
GetOrderTransactions
GetSellerTransactions
DetailLevel: none, ReturnAll
Conditionally
OrderReport
Conditionally
SoldReport
Conditionally
This value is the amount of sales tax applied based on handling costs for the
order line item for the corresponding impositiion (tax type).
GetItemTransactions
GetOrders
GetOrderTransactions
GetSellerTransactions
DetailLevel: none, ReturnAll
Conditionally
OrderReport
Conditionally
SoldReport
Conditionally
This value is the actual tax ID for the buyer. This field will generally only be returned if a seller on the Italy or Spain sites required that the buyer supply a tax ID during the checkout process. If the <b>Order.BuyerTaxIdentifier</b> container is returned, the type of tax ID can be found in the <b>BuyerTaxIdentifier.Type</b> field.
GetOrders
DetailLevel: none, ReturnAll
Conditionally
OrderReport
Conditionally
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ReturnAll
Conditionally
This field indicates the collection method used to collect the 'Collect and Remit' or 'Good and Services' tax for the order. This field is always returned for orders subject to 'Collect and Remit' or 'Good and Services' tax, and its value is always <code>NET</code>.
<br>
<br>
<span class="tablenote"><b>Note: </b> Although the <b>CollectionMethod</b> field is returned for all orders subject to 'Collect and Remit' sales tax or 'Good and Services' tax, the <b>CollectionMethod</b> field and <b>CollectionMethodCodeType</b> are not currently of any practical use, although this field may have use in the future. If and when the logic of this field is changed, this note will be updated and a note will also be added to the Release Notes.
</span>
NET
GetItemTransactions
GetOrders
OrderReport
GetOrderTransactions
GetSellerTransactions
DetailLevel: none, ReturnAll
Conditionally
eBayCollectAndRemitTaxes.TaxDetails
NET
OrderReport
Conditionally
eBayCollectAndRemitTaxes.TaxDetails
This enumerated type contains the possible values that can be returned in the <b>name</b> attribute of the <b>BuyerTaxIdentifier.Attribute</b> field. Currently, this type only contains one enumeration value, but in the future, other attributes related to the tax ID may be created for this type.
This value indicates that the value returned in the <b>BuyerTaxIdentifier.Attribute</b> field is the country that issued the buyer tax ID.
Reserved for internal or future use.
This type is used to display the value of the <b>name</b> attribute of the <b>BuyerTaxIdentifier.Attribute</b> field.
The only supported value for this attribute is 'IssuingCountry', but in the future, other attributes related to the tax ID may be supported.
GetOrders
DetailLevel: none, ReturnAll
Conditionally
OrderReport
Conditionally
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
This type is not currently used.
Reserved for internal or future use.
This type defines the <b>BuyerTaxIdentifier</b> container that is returned in order management calls. This container consists of taxpayer identification information for the buyer and it is currently used by sellers selling on the Italy or Spain site to retrieve the taxpayer ID of buyers registered on the Italy or Spain sites.
This enumeration value identifies the type of tax ID that was supplied by the buyer during the checkout process.
Date, Decimal, EAN, ISBN, Text, UPC
GetOrders
DetailLevel: none, ReturnAll
Conditionally
Date, Decimal, EAN, ISBN, Text, UPC
OrderReport
Conditionally
Date, Decimal, EAN, ISBN, Text, UPC
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
Date, Decimal, EAN, ISBN, Text, UPC
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
This value is the actual tax ID for the buyer. The type of tax ID is shown in the <b>Type</b> field.
GetOrders
DetailLevel:none,ReturnAll
Conditionally
OrderReport
Conditionally
GetOrderTransactions
DetailLevel:none,ItemReturnDescription, ReturnAll
Conditionally
GetItemTransactions
GetSellerTransactions
DetailLevel:none,ReturnAll
Conditionally
This field shows an attribute, and its corresponding value for the buyer's tax identification card. Currently, this field is only used to indicate which country issued the buyer's tax ID, but in the future, other attributes related to the tax ID may be returned in this field. This field's value will be an <a href="http://en.wikipedia.org/wiki/ISO_3166-1" target="_blank">ISO 3166-1 two-digit code</a> that represents the issuing country.
GetOrders
DetailLevel: none, ReturnAll
Conditionally
OrderReport
Conditionally
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
This type is used to show sales tax-related details for a tax jurisdiction. The concept of 'sales tax' is only applicable to eBay US and Canada (English and French) sites.
This is the unique, two-digit identifier of the tax jurisdiction (such as 'CA' for California). To retrieve all <b>JurisdictionID</b> values for a site, a seller can either use a <b>GetTaxTable</b> call with <b>DetailLevel</b> set to <code>ReturnAll</code>, or they can use the <b>GeteBayDetails</b> call with <b>DetailLevel</b> name set to <code>TaxJurisdiction</code>.
<br/><br/>
The <b>JurisdictionID</b> field is always required in a <b>SetTaxTable</b> call, and always returned with each <b>TaxJurisdiction</b> container to identify the tax jurisdiction.
SetTaxTable
Yes
GetBidderList
GeteBayDetails
Conditionally
GetTaxTable
GetSellerList
DetailLevel: none, ReturnAll
Conditionally
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnAttributes, ItemReturnDescription, ReturnAll
Conditionally
GetOrderTransactions
DetailLevel: ReturnAll
Conditionally
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetOrders
DetailLevel: none, ReturnAll
Conditionally
OrderReport
Conditionally
This float value is the sales tax percentage rate applicable to the corresponding tax jurisdiction. Sellers are responsible for providing accurate sales tax rates for each jurisdiction. This sales tax rate comes into play when a buyer from that tax jurisdiction makes a purchase from the seller. The value passed in is stored with a precision of 3 digits after the decimal point (##.###).
<br><br>
This field is only returned in <b>GetTaxTable</b> (and other 'Get' calls) if a sales tax percentage rate has been set.
<br><br>
<span class="tablenote"><b>Note: </b> As of January 1, 2019, buyers in some US states will automatically be charged sales tax for eBay purchases. eBay will collect and remit this sales tax to the proper taxing authority on the buyer's behalf. So, if a sales tax rate is established for a state that is subject to 'eBay Collect and Remit', the sales tax rate in this field is ignored by eBay during checkout process. For a list of the US states that will become subject to 'eBay Collect and Remit' (and effective dates), see the <a href="https://www.ebay.com/help/selling/fees-credits-invoices/taxes-import-charges?id=4121#section4">eBay sales tax collection</a> help topic.
</span>
SetTaxTable
Yes
GetBidderList
Conditionally
GetSellerList
GetTaxTable
DetailLevel: none, ReturnAll
Conditionally
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnAttributes, ItemReturnDescription, ReturnAll
Conditionally
GetOrderTransactions
DetailLevel: ReturnAll
Conditionally
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetOrders
DetailLevel: none, ReturnAll
Conditionally
OrderReport
Conditionally
This field is included in a <b>SetTaxTable</b> call and set to <code>true</code> if the seller wants sales tax for the jurisdiction to apply to the cumulative amount of item cost and shipping charges. This value defaults to <code>false</code> if not specified.
<br><br>
This field is always returned with each <b>TaxJurisdiction</b> container (whether <code>true</code> or <code>false</code>).
<br><br>
<span class="tablenote"><b>Note: </b> As of January 1, 2019, buyers in some US states will automatically be charged sales tax for eBay purchases. eBay will collect and remit this sales tax to the proper taxing authority on the buyer's behalf. So, if a <code>true</code> value is set for this field for a state that is subject to 'eBay Collect and Remit', this setting is ignored by eBay during checkout process. For a list of the US states that will become subject to 'eBay Collect and Remit' (and effective dates), see the <a href="https://www.ebay.com/help/selling/fees-credits-invoices/taxes-import-charges?id=4121#section4">eBay sales tax collection</a> help topic.
</span>
GetBidderList
Conditionally
GetSellerList
GetTaxTable
DetailLevel: none, ReturnAll
Conditionally
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnAttributes, ItemReturnDescription, ReturnAll
Conditionally
GetOrderTransactions
DetailLevel: ReturnAll
Conditionally
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetOrders
DetailLevel: none, ReturnAll
Conditionally
OrderReport
Conditionally
False
SetTaxTable
Yes
Full name for the jurisdiction or region for display purposes.
GeteBayDetails
Conditionally
Returns the latest version number for this feature. Use the version to determine
if and when to refresh your cached client data.
GeteBayDetails
Conditionally
The time in GMT when the details for this feature were last updated. Use this
timestamp to determine if and when to refresh your cached client data.
GeteBayDetails
Conditionally
This type is used to express sales tax details for one or more tax jurisdictions. The concept of 'sales tax' is only applicable to eBay US and Canada (English and French) sites.
In a <b>SetTaxTable</b>, a <b>TaxJurisdiction</b> container is required for each tax jurisdiction that the seller wishes to make additions/changes. Sales tax details for zero or more jurisdictions (states,
provinces, etc). This can be just one jurisdiction, up to all jurisdictions defined for the site's country. Any values specified through a <b>TaxJurisdiction</b> container will override any existing values defined in the seller's Sales Tax Table.
<br><br>
If <b>GetTaxTable</b> is called without the <b>DetailLevel</b> field, only tax jurisdictions where sales tax rates have been set up are returned. However, if the <b>DetailLevel</b> field is included in the request and set to <code>ReturnAll</code>, all tax jurisdictions are returned, regardless of whether or not the seller has modified settings for any/all of these jurisdictions.
<br><br>
This container is only returned in order-related 'Get' calls if sales tax is applicable to the order line item.
<br><br>
<span class="tablenote"><b>Note: </b> As of January 1, 2019, buyers in some US states will automatically be charged sales tax for eBay purchases. eBay will collect and remit this sales tax to the proper taxing authority on the buyer's behalf. So, if a sales tax rate is established for a state that is subject to 'eBay Collect and Remit', this sales tax rate will be ignored by eBay during checkout process. For a list of the US states that will become subject to 'eBay Collect and Remit' (and effective dates), see the <a href="https://www.ebay.com/help/selling/fees-credits-invoices/taxes-import-charges?id=4121#section4">eBay sales tax collection</a> help topic.
</span>
SetTaxTable
Yes
GetTaxTable
DetailLevel: none, ReturnAll
Conditionally
GetOrderTransactions
DetailLevel: ReturnAll
Conditionally
GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
Conditionally
GetBidderList
Conditionally
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetOrders
DetailLevel: none, ReturnAll
Conditionally
OrderReport
Conditionally
Enumerated type that lists the types of taxes that may be charged to the buyer for each order line item purchased.
This enumeration value indicates that standard sales tax was charged to the buyer against the order line item.
This enumeration value indicates that an electronic waste recycling fee was charged to the buyer against the order line item.
This enumeration value indicates that a Goods and Services import tax was charged to the buyer against the order line item.
<br/><br/>
This tax type is only applicable for items being sold by Australian or New Zealand sellers.
Reserved for internal or future use.
Type defining the Taxes container, which contains detailed sales tax information for an
order line item. The Taxes container is only returned if the seller is using the Vertex-
based Premium Sales Tax Engine solution. The information in this container
supercedes/overrides the sales tax information in the ShippingDetails.SalesTax container.
This value indicates the total tax amount for the order line item, for all tax types, which may include sales tax (seller-applied or 'eBay Collect and Remit'), 'Goods and Services' tax (for Australian or New Zealand sellers), or other fees like an electronic waste recycling fee.
<br><br>
<span class="tablenote"><b>Note: </b> If the corresponding tax type is <code>GST</code> or <code>SalesTax</code> (if found under both the <b>eBayCollectAndRemitTaxes</b> and <b>Taxes</b> containers), the order is subject to 'eBay Collect and Remit' tax, and a change in logic has rolled out as of early November 2019. For orders that are subject to eBay 'Collect and Remit' tax, which includes US sales tax for numerous states, and 'Good and Services' tax that is applicable to Australian and New Zealand sellers, the tax amount in this field will be included in the <b>Order.Total</b>, <b>Order.AmountPaid</b>, and <b>Transaction.AmountPaid</b> fields.
<br><br>
Sellers should be aware that the sales tax that the buyer pays for the order will initially be included when the order funds are distributed to their PayPal account, but that PayPal will pull out the sales tax amount shortly after the payment clears, and will distribute the sales tax to the appropriate taxing authority. Previous to this change, PayPal would strip out the 'Collect and Remit' tax before distributing order funds to the seller's account.
<br><br>
This logic change does not apply to sellers who are in eBay managed payments, so the amount in this field will never reflect any 'Collect and Remit' tax, even if the order is subject to 'Collect and Remit' tax.
</span>
GetItemTransactions
GetOrders
GetOrderTransactions
GetSellerTransactions
DetailLevel: none, ReturnAll
Conditionally
OrderReport
Conditionally
SoldReport
Conditionally
Container consisting of detailed sales tax information for an order line item,
including the tax type and description, sales tax on the item cost, and sales tax
related to shipping and handling.
GetItemTransactions
GetOrders
GetOrderTransactions
GetSellerTransactions
DetailLevel: none, ReturnAll
Conditionally
OrderReport
Conditionally
SoldReport
Conditionally
Data for one theme group. Returned for <b>GetDescriptionTemplates</b>
if theme groups are requested.
Unique identifier for this theme group.
GetDescriptionTemplates
Conditionally
Name of this theme group (localized to the language associated
with the eBay site).
GetDescriptionTemplates
Conditionally
Unique identifier for each theme in this group. There
is at least one theme in a theme group.
GetDescriptionTemplates
Conditionally
The number of <b>ThemeID</b> elements in this group.
GetDescriptionTemplates
Conditionally
This enumerated type is deprecated.
(in) Any event (applicable to US, UK, and DE)
(in) Comedy & Kabarett (Comedy and Cabaret)
(in) Freizeit & Events (Leisure and Events)
(in) Konzerte & Festivals (Concerts and Festivals)
(in) Kultur & Klassik (Culture and Classical)
(in) Musicals & Shows
(in) Sportveranstaltungen (Sporting Events)
(in) Other events that are not the above Germany event types
(applicable to listings on the DE site)
(in) Amusement Parks (applicable to listings on the UK site)
(in) Comedy (applicable to listings on the UK site)
(in) Concerts/Gigs (applicable to listings on the UK site)
(in) Conferences/Seminars (applicable to listings on the UK site)
(in) Exhibitions/Shows (applicable to listings on the UK site)
(in) Experiences (applicable to listings on the UK site)
(in) Sporting events (applicable to listings on the UK site)
(in) Theatre/Cinema/Circus (applicable to listings on the UK site)
(in) Other. Events that are not the above UK types
(applicable to listings on the UK site)
(in) Concerts (applicable to listings on the US site)
(in) Movies (applicable to listings on the US site)
(in) Sporting events (applicable to listings on the US site)
(in) Theater (applicable to listings on the US site)
(in) Events that are not concerts,
movies, sporting events, or theater events
(applicable to listings on the US site)
Reserved for internal or future use.
Type defining the <b>TicketListingDetails</b> container, which is used in
an <b>Add</b>/<b>Revise</b>/<b>Relist</b> call to provide more details about event tickets.
The name of the event, as shown on the ticket. Typically the
headliner. There is no maximum number of words or characters.
However, the words in the name must be an exact match (or a subset
consisting of complete words) to the words in the product title in
the catalog. The words in the name are matched using OR logic
(the order of the words does not matter). As with all strings, you
need to escape reserved characters such as ampersand.
<br>
1024
Ticket Listings
http://developer.ebay.com/Devzone/guides/features-guide/default.html#development/Specialty-Tickets.html
AddFixedPriceItem
AddItem
AddItems
AddSellingManagerTemplate
RelistFixedPriceItem
RelistItem
ReviseFixedPriceItem
ReviseItem
ReviseSellingManagerTemplate
VerifyAddItem
VerifyRelistItem
Conditionally
GetItem
GetSellingManagerTemplates
Conditionally
The name of the venue, as shown on the ticket.
The validation rules are the same as the rules for the event name.
In addition, eBay supports both US English and UK English spelling
variations for typical words found on tickets (such as "theater" and
"theatre"). As with all strings, you need to escape reserved
characters such as ampersand.
<br>
4000
AddFixedPriceItem
AddItem
AddItems
AddSellingManagerTemplate
RelistFixedPriceItem
RelistItem
ReviseFixedPriceItem
ReviseItem
ReviseSellingManagerTemplate
VerifyAddItem
VerifyRelistItem
Conditionally
GetItem
GetSellingManagerTemplates
Conditionally
The date of the event, as shown on the ticket. Use the date shown on
the ticket, without attempting to adjust it for a different time
zone (such as Pacific time or GMT).<br>
<br>
In most cases, you should be able to specify any numeric date format
in month/day/year order. eBay supports m or mm for the month,
d or dd for the day, and yy or yyyy for the year, in all
combinations. The delimiters must be forward slashes (/).
AddFixedPriceItem
AddItem
AddItems
AddSellingManagerTemplate
RelistFixedPriceItem
RelistItem
ReviseFixedPriceItem
ReviseItem
ReviseSellingManagerTemplate
VerifyAddItem
VerifyRelistItem
Conditionally
GetItem
GetSellingManagerTemplates
Conditionally
The time of the event, as shown on the ticket. Use the time value
shown on the ticket, without attempting to convert it to a different
time zone (such as Pacific time or GMT). Do not round the value up
or down (e.g., do not round 7:01 PM to 7:00 PM).<br>
<br>
In most cases, you should be able to specify the time format exactly
as shown on the ticket.
Ticket Listings
http://developer.ebay.com/Devzone/guides/features-guide/default.html#development/Specialty-Tickets.html
AddFixedPriceItem
AddItem
AddItems
AddSellingManagerTemplate
RelistFixedPriceItem
RelistItem
ReviseFixedPriceItem
ReviseItem
ReviseSellingManagerTemplate
VerifyAddItem
VerifyRelistItem
Conditionally
GetItem
GetSellingManagerTemplates
Conditionally
Specifies the Date range.
Specifies the earliest (oldest) date to be used in a date range.
GetSellingManagerSoldListings
GetSellingManagerEmailLog
No
Specifies the latest (most recent) date to be used in a date range.
GetSellingManagerSoldListings
GetSellingManagerEmailLog
No
Time zone details about a region or location to which the seller is willing to
ship.
A unique identifier for a given time zone. This ID does not change for a
given time zone, even if the time zone supports both standard and daylight
saving time variants. Valid values for TimeZoneID correspond to OLSON IDs.
These IDs provide not only the information as to the offset from GMT (UTC),
but also daylight saving time information. Thus, for example, America/Phoenix
is distinct from America/Denver because they have different daylight saving
time behavior. This value is not localized.
Time Values
https://developer.ebay.com/DevZone/guides/features-guide/default.html#Basics/DataTypes.html#TimeValues
Olson ID Comparison
http://en.wikipedia.org/wiki/Tz_database
GeteBayDetails
Conditionally
Display name of a time zone in its standard (non-daylight saving) time
representation. This value is localized and returned in the language for the
site specified in the request (i.e., the numeric site ID that you specify in
the request URL for the SOAP API or the X-EBAY-API-SITEID header for the XML
API).
GeteBayDetails
Conditionally
The offset in hours from GMT for a time zone when it is not adjusted for
daylight saving time.
GeteBayDetails
Conditionally
Display name of a time zone in its daylight saving time representation.
This element is emitted for time zones that support daylight saving time
only. The value is localized and returned in the language for the site
specified in the request.
GeteBayDetails
Conditionally
The offset in hours from GMT for a time zone when it is on daylight saving
time. This element is emitted for time zones that support daylight
saving time only.
GeteBayDetails
Conditionally
Indicates whether or not the time zone is currently on daylight saving time.
A value of true indicates that the time zone is on daylights savings time.
This element is emitted for time zones that support daylight saving time only.
GeteBayDetails
Conditionally
Returns the latest version number for this field. The version can be
used to determine if and when to refresh cached client data.
GeteBayDetails
DetailLevel: none, ReturnSummary, ReturnAll
Always
Gives the time in GMT that the feature flags for the details were last
updated. This timestamp can be used to determine if and when to refresh
cached client data.
GeteBayDetails
DetailLevel: none, ReturnSummary, ReturnAll
Always
Indicates how the application wants eBay to handle the user's token after
the user signs in.
Return the token in the HTTP redirect to the application-specified
accept URL.
Leave the token at eBay so that the application can get
the token through the FetchToken API call (SecretId required).
Reserved for future use
Contains the status of the token
Token is Active
Token is Expired
Token is revoked by eBay
Token is revoked by user
Token is revoked by Application
Token is Invalid
Reserved for internal or future use
Returns token status.
Current token status.
GetTokenStatus
Always
Identifies the user to whom the token belongs.
GetTokenStatus
Always
Original expiration time for the token.
GetTokenStatus
Always
Token revocation time, if the token has been revoked.
GetTokenStatus
Always
Enumerated type that consists of the Top-Rated Seller programs that exist around the world.
If this enumeration value is returned, it indicates that the eBay user is in the US Top-Rated Seller program.
If this enumeration value is returned, it indicates that the eBay user is in the UK Top-Rated Seller program.
If this enumeration value is returned, it indicates that the eBay user is in the Germany Top-Rated Seller program.
If this enumeration value is returned, it indicates that the eBay user is in the Global Top-Rated Seller program.
Reserved for internal or future use.
Container for Top-Rated Seller program information.
A <b>TopRatedProgram</b> field is returned for each Top-Rated Seller program that the eBay user qualifies for.
q
GetUser
DetailLevel: none, ReturnSummary, ReturnAll
Conditionally
ComingSoon
Enumerated type listing the possible roles an eBay user may have in regards to an
eBay order.
The eBay user is acting as the buyer for the order(s). In <b>GetOrders</b>,
this value should be passed into the <b>OrderRole</b> field in the
request to retrieve orders in which the calling eBay user is the buyer in the order.
The eBay user is acting as the seller for the order(s). In <b>GetOrders</b>,
this value should be passed into the <b>OrderRole</b> field in the
request to retrieve orders in which the calling eBay user is the seller in the order.
This value is reserved for future or internal use.
Type defining the <b>TransactionArray</b> container, which contains an
array of <b>Transaction</b> containers. Each <b>Transaction</b>
container consists of detailed information on one order line item.
A <b>Transaction</b> container is returned for each line item in the order. This container consists of detailed information on one order line item.
<br/><br/>
For the <b>AddOrder</b> call, a <b>Transaction</b> container is used to identified the unpaid order line items that are being combined into one Combined Invoice order.
GetOrders
DetailLevel: none, ReturnAll
Always
OrderReport
Always
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Always
GetItemsAwaitingFeedback
Conditionally
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ReturnAll
Conditionally
GetMyeBayBuying
DeletedFromWonList
WonList
DetailLevel: none, ReturnAll
Conditionally
GetMyeBaySelling
SoldList
DeletedFromSoldList
DetailLevel: none, ReturnAll
Conditionally
AddOrder
Yes
<span class="tablenote"><b>Note: </b> Currently, the only supported value for this enumeration type is <code>eBay</code>. Half.com listings will no longer be supported in APIs.
</span>
Specifies the site on which the purchase was made.
eBay
This value indicates the purchase occurred on an eBay marketplace site.
<span class="tablenote"><b>Note: </b> eBay Express no longer exists.
</span>
The order line item was created on the eBay Express site.
<span class="tablenote"><b>Note: </b> Half.com listings will no longer be supported in APIs.
</span>
The order line item was created on Half.com site.
<span class="tablenote"><b>Note: </b> Shopping.com listings are no longer supported in APIs.
</span>
The order line item was created on the Shopping.com site.
<span class="tablenote"><b>Note: </b> World Of Good is no longer associated with eBay.
</span>
The order line item was created on the WorldOfGood site.
Reserved for future use.
Enumerated type defining the possible values that can returned in the attribute of the <b>Payment.ReferenceID</b> and <b>Payment.PaymentReferenceID</b> field.
MandateReferenceNumber
This value is the unique identifier of an external payment transaction.
No longer applicable as the eBay Now service is no longer available to buyers and sellers.
This value is reserved for future or internal use.
Type defining the <strong>ReferenceID</strong> element, which is used to display the unique identifier of a payment (and payment type through the <strong>type</strong> attribute.
This attribute indicates the type of payment.
GetOrders
DetailLevel: none, ReturnAll
Conditionally
OrderReport
Conditionally
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ReturnAll
Conditionally
Contains the order status, e.g. the buyer's online
payment and whether the checkout process for the order is complete.
Indicates the success or failure of the buyer's online payment for an order.
Applicable for the payment method that the buyer chose for the order. If the
payment failed, the value returned indicates the reason for the failure.
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
Indicates the current status of the checkout flow for the order.
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
Indicates date and time an order's status was last updated (in GMT).
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
The payment method that the buyer selected to pay for the order. If checkout is not yet complete, <b>PaymentMethodUsed</b>, which is returned by the <b>GetItemTransactions</b> call, is set to whatever the buyer selected as his or her preference on the Review Your Purchase page.
<br>
<br>
<span class="tablenote"><b>Note:</b>
For sellers opted in to the eBay Managed Payments program, the enumeration value returned in this field will be <code>CreditCard</code>, regardless of the actual payment method used by the buyer to pay for the order.
</span>
OrderReport
Always
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
Indicates whether checkout is complete, incomplete, or pending for an order.
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
Indicates whether the buyer has selected shipping details
during checkout. False indicates that the shipping service was
selected by eBay for the buyer. For example, if the buyer has
not yet completed the Review Your Purchase page, he has not
picked a shipping service. If it is false, the application
should ignore <strong>ShippingServiceCost</strong> and <strong>ShippingServiceSelected</strong>
(items whose values are defaulted by eBay).
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
This field indicates the type and/or status of a payment hold on the item.
PayPal Holds on Payments
https://developer.ebay.com/DevZone/guides/features-guide/default.html#Development/Sales-Checkouts.html#PayPalHoldsonPayments
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetOrders
DetailLevel: none, ReturnAll
Conditionally
OrderReport
Conditionally
GetMyeBayBuying
WonList
DeletedFromWonList
DetailLevel: none, ReturnAll
Conditionally
GetMyeBaySelling
SoldList
DeletedFromSoldList
DetailLevel: none, ReturnAll
Conditionally
SoldReport
Always
This field being returned with a value of <code>true</code> indicates that the order line item can be paid for with a credit card through the seller's payment gateway account.
<br><br>
<span class="tablenote"><b>Note: </b>
Beginning on May 1, 2019, eBay will no longer support electronic payments through Integrated Merchant Credit Card accounts. To accept online credit card payments from buyers, a seller must use specify PayPal as an accepted payment method, or opt in to eBay Managed Payments program (if the program is available to that seller).
</span>
GetOrders
DetailLevel: none, ReturnAll
Always
OrderReport
Always
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
This container is no longer used.
This field gives the status of a buyer's Item Not Received (INR) Inquiry. This field is only returned if the buyer has created an INR Inquiry through the site or through the Post-Order API.
GetOrders
DetailLevel: none, ReturnAll
Conditionally
OrderReport
Conditionally
GetItemTransactions
DetailLevel: none, ReturnAll
Conditionally
GetOrderTransactions
DetailLevel: none, ReturnAll
Conditionally
GetSellerTransactions
DetailLevel: none, ReturnAll
Conditionally
This field gives the status of a buyer's return request. This field is only returned if the buyer has initiated a return request, or has escalated an existing return request into a return case.
GetOrders
DetailLevel: none, ReturnAll
Conditionally
OrderReport
Conditionally
GetItemTransactions
DetailLevel: none, ReturnAll
Conditionally
GetOrderTransactions
DetailLevel: none, ReturnAll
Conditionally
GetSellerTransactions
DetailLevel: none, ReturnAll
Conditionally
The enumeration value in this field indicates which payment method was used by the German buyer who was offered the 'Pay Upon Invoice' option. This field will only be returned if a German buyer was offered the 'Pay Upon Invoice' option. Otherwise, the buyer's selected payment method is returned in the <b>PaymentMethodUsed</b> field by the <b>GetItemTransactions</b> call.
GetOrders
DetailLevel: none, ReturnAll
Conditionally
OrderReport
Conditionally
GetItemTransactions
DetailLevel: none, ReturnAll
Conditionally
GetOrderTransactions
DetailLevel: none, ReturnAll
Conditionally
GetSellerTransactions
DetailLevel: none, ReturnAll
Conditionally
This enumeration value indicates the current state of a purchased digital gift card. The normal flow is for the buyer (or other recipient of the gift card) to download the gift card from the delivered email after purchase, and then to activate the card for use. This field is only applicable and returned for digital gift card order line items.
GetOrders
DetailLevel: none, ReturnAll
Conditionally
OrderReport
Conditionally
GetItemTransactions
DetailLevel: none, ReturnAll
Conditionally
GetOrderTransactions
DetailLevel: none, ReturnAll
Conditionally
GetSellerTransactions
DetailLevel: none, ReturnAll
Conditionally
The current status for the order cancellation request if it exists. This field is only returned if a cancellation request has been made on an order, or if the order is currently going through the cancellation process, or if the order has already been cancelled.
GetMyeBayBuying
DetailLevel: none, ReturnAll
Conditionally
Contains information about a sales transaction from an eBay listing. This identifier is automatically created by the eBay system once a buyer has committed to make a purchase in an
auction or fixed-price listing. A fixed-priced listing (single or multiple-variation) with multiple quantity can spawn one or more sales transactions.
The total amount the buyer paid for the order line item. This
amount includes all costs such as item cost, shipping/handling charges, and sales tax that is applied to the order by the seller. If the
seller allowed the buyer to change the total for an order, the buyer is
able to change the total up until the time when Checkout status is
Complete. Determine whether the buyer changed the amount by retrieving the
order line item data and comparing the <b>AmountPaid</b> value to
what the seller expected. If multiple order line items
between the same buyer and seller have been combined into a 'Combined
Invoice' order, the <b>AmountPaid</b> value returned for each line item in the order reflects the total amount paid for the entire order,
and not for the individual order line item. In a <b>GetItemTransactions</b> or <b>GetSellerTransactions</b> call, you can determine which
order line items belong to the same 'Combined Invoice' order by checking
to see if the <b>ContainingOrder.OrderID</b> value is the same.
<br><br>
<span class="tablenote"><b>Note: </b> As of November 2019, for orders subject to eBay 'Collect and Remit' taxes, PayPal has begun distributing order funds to the seller's account with the sales tax included. eBay 'Collect and Remit' tax includes US sales tax for numerous states, and 'Good and Services' tax that is applicable to Australian and New Zealand sellers. This 'Collect and Remit' tax amount for the order will be included in the <b>AmountPaid</b> value. To determine if 'Collect and Remit' taxes were added into <b>AmountPaid</b> value, the user can check for the <b>Transaction.eBayCollectAndRemitTaxes.TaxDetails</b> and the <b>Transaction.Taxes.TaxDetails</b> containers in the response. If both of these containers appear in the response with a <b>TaxDetails.TaxDescription</b> value of <code>SalesTax</code> (in US) or <code>GST</code> (in Australia or New Zealand), the tax amount that the buyer paid is in this amount.
<br><br>
Sellers should be aware that the sales tax that the buyer pays for the order will initially be included when the order funds are distributed to their PayPal account, but that PayPal will pull out the sales tax amount shortly after the payment clears, and will distribute the sales tax to the appropriate taxing authority. Previous to this change, PayPal would strip out the 'Collect and Remit' tax before distributing order funds to the seller's account.
<br><br>
This logic change does not apply to sellers who are in eBay managed payments, so the amount in this field will never reflect any 'Collect and Remit' tax, even if the order is subject to 'Collect and Remit' tax.
</span>
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
This value indicates the dollar amount by which the buyer has adjusted the the total cost of the sales transaction. Adjustments to sales transaction costs may include shipping and handling, buyer discounts, or added services. A positive amount indicates the amount is an extra charge being paid to the seller by the buyer. A negative value indicates this amount is a credit given to the buyer by the seller.
<br><br>
This field is always returned, even if there was no cost adjustment to the sales transaction. Its value will just be '0.0' if there was no cost adjustment.
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Always
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Always
This field shows the converted value of <b>AdjustmentAmount</b> in the currency of the site that returned the response. Refresh this value every 24 hours to pick up the current conversion rates.
<br><br>
This field is always returned, even if there was no cost adjustment to the sales transaction. Its value will just be '0.0' if there was no cost adjustment. This value should be the same as the value in <b>AdjustmentAmount</b> if the eBay listing site and the site that returned the response are the same, or use the same currency.
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
Container consisting of user and shipping details for the order's buyer. To be returned by <b>GetItemsAwaitingFeedback</b> the seller
must be the one making the request.
<br><br>
<b>For GetOrders, GetOrderTransactions, and GetItemTransactions only:</b> If using Trading WSDL Version 1019 or above, this container will only be returned to the buyer or seller, and no longer returned at all to third parties. If using a Trading WSDL older than Version 1019, real data is only returned to the buyer or seller, and dummy/masked data will be returned to all third parties.
GetItemsAwaitingFeedback
Conditionally
GetOrders
DetailLevel: none, ReturnAll
Conditionally
OrderReport
Conditionally
GetMyeBaySelling
SoldList
DeletedFromSoldList
DetailLevel: none, ReturnAll
Conditionally
GetOrderTransactions
DetailLevel: none, ReturnAll
Conditionally
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ReturnAll
Conditionally
Container consisting of shipping-related details for a sales transaction. Shipping details may include shipping rates, package dimensions, handling costs, excluded shipping locations (if specified), shipping service options, sales tax information (if applicable), and shipment tracking details (if shipped).
<br><br>
<span class="tablenote"><b>Note: </b> For <b>GetOrders</b> and <b>GetOrderTransactions</b>, a <b>ShippingDetails</b> container is returned at the order at line item level.
</span>
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ReturnAll
Conditionally
GetOrderTransactions
GetOrders
DetailLevel: none, ReturnAll
Conditionally
OrderReport
Conditionally
This field shows the converted value of <b>AmountPaid</b> in the currency of the site that returned the response. Refresh this value every 24 hours to pick up the current conversion rates.
<br><br>
This field is always returned for paid orders. This value should be the same as the value in <b>AmountPaid</b> if the eBay listing site and the site that returned the response are the same, or use the same currency.
<br><br>
<span class="tablenote"><b>Note: </b> As of November 2019, for orders subject to eBay 'Collect and Remit' taxes, PayPal has begun distributing order funds to the seller's account with the sales tax included. eBay 'Collect and Remit' tax includes US sales tax for numerous states, and 'Good and Services' tax that is applicable to Australian and New Zealand sellers. This 'Collect and Remit' tax amount for the order will be included in the <b>ConvertedAmountPaid</b> value. To determine if 'Collect and Remit' taxes were added into <b>ConvertedAmountPaid</b> value, the user can check for the <b>Transaction.eBayCollectAndRemitTaxes.TaxDetails</b> and the <b>Transaction.Taxes.TaxDetails</b> containers in the response. If both of these containers appear in the response with a <b>TaxDetails.TaxDescription</b> value of <code>SalesTax</code> (in US) or <code>GST</code> (in Australia or New Zealand), the tax amount that the buyer paid is in this amount.
<br><br>
Sellers should be aware that the sales tax that the buyer pays for the order will initially be included when the order funds are distributed to their PayPal account, but that PayPal will pull out the sales tax amount shortly after the payment clears, and will distribute the sales tax to the appropriate taxing authority. Previous to this change, PayPal would strip out the 'Collect and Remit' tax before distributing order funds to the seller's account.
<br><br>
This logic change does not apply to sellers who are in eBay managed payments, so the amount in this field will never reflect any 'Collect and Remit' tax, even if the order is subject to 'Collect and Remit' tax.
</span>
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
This field shows the converted value of <b>TransactionPrice</b> in the currency of the site that returned the response. Refresh this value every 24 hours to pick up the current conversion rates.
<br><br>
This field is always returned for sales transactions. This value should be the same as the value in <b>TransactionPrice</b> if the eBay listing site and the site that returned the response are the same, or use the same currency.
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetMyeBaySelling
DetailLevel: none, ReturnAll
Conditionally
This timestamp indicates date/time when the sales transaction occurred. A sales transaction is created when there is a commitment to buy, or when the buyer purchases the item through a 'Buy it Now' option. For auction listings, a sales transaction is created when that listing ends with a high bidder whose bid meets or exceeds the Reserve Price (if set). For a fixed-price listing or a 'Buy It Now' auction listing, a sales transaction is created once the buyer clicks the Buy button.
GetOrders
DetailLevel: none, ReturnAll
Always
OrderReport
Always
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Always
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetMyeBayBuying
WonList
DeletedFromWonList
DetailLevel: none, ReturnAll
Conditionally
GetMyeBaySelling
SoldList
DeletedFromSoldList
DetailLevel: none, ReturnAll
Conditionally
This value indicates whether or not the seller requires a deposit for the purchase of a motor vehicle. This field is only applicable to motor vehicle listings that require an initial deposit. For these listings, its value is returned as 'OtherMethod'. For any other type of listing, its value is returned as 'None'.
Specifying a Vehicle Deposit and Deposit Amount
https://developer.ebay.com/DevZone/guides/features-guide/default.html#Development/Sites-eBayMotors.html#SpecifyingaVehicleDepositandDepositAmoun
GetItemTransactions
GetSellerTransactions
None, OtherMethod
DetailLevel: none, ItemReturnDescription, ReturnAll
Always
GetOrderTransactions
None, OtherMethod
DetailLevel: none, ItemReturnDescription, ReturnAll
Always
This container consists of relevant details about the listing associated with the sales transaction. Which listing fields are returned under this container will depend on the listing, the eBay marketplace, and the API call.
<br><br>
In an <b>AddOrder</b> call, only the unique identifier of the listing (<b>ItemID</b>) is needed to help identify the sales transaction to combine into a 'Combined Invoice' order.
GetOrders
DetailLevel: none, ReturnAll
Always
OrderReport
Always
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Always
GetMyeBayBuying
WonList
DeletedFromWonList
DetailLevel: none, ReturnAll
Conditionally
GetMyeBaySelling
SoldList
DeletedFromSoldList
DetailLevel: none, ReturnAll
Conditionally
GetItemsAwaitingFeedback
GetMyeBaySelling
Conditionally
AddOrder
Yes
GetSellerTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Always
This value indicates the quantity of the line item purchased at the same
time by the same buyer from one listing. For auction listings, this value
is always '1'. For fixed-price, non-variation listings, this value can be
greater than 1.
GetOrders
DetailLevel: none, ReturnAll
Always
OrderReport
Always
GetMyeBayBuying
WonList
DeletedFromWonList
DetailLevel: none, ReturnAll
Conditionally
GetMyeBaySelling
SoldList
DeletedFromSoldList
DetailLevel: none, ReturnAll
Conditionally
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
Container consisting of checkout/payment status details for an order line item. Several of these fields change values during the checkout flow.
<br><br>
For <b>GetOrders</b>, only a limited number of applicable fields are returned at the order line item level. The
fields indicating the status of the order are actually found in the
<b>OrderArray.Order.CheckoutStatus</b> container.
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetOrders
DetailLevel: none, ReturnAll
Conditionally
OrderReport
Conditionally
GetMyeBayBuying
WonList
DeletedFromWonList
DetailLevel: none, ReturnAll
Conditionally
GetMyeBaySelling
SoldList
DeletedFromSoldList
DetailLevel: none, ReturnAll
Conditionally
Unique identifier for an eBay sales transaction. This identifier
is created once there is a commitment from a buyer to
purchase an item, or if/when the buyer actually purchases the line item through a 'Buy it Now' option. An <b>ItemID</b>/<b>TransactionID</b> pair can be used and referenced during an order checkout flow to identify a line item.
<br><br>
<b>For GetOrders, GetOrderTransactions, and GetItemTransactions only:</b> If using Trading WSDL Version 1019 or above, this field will only be returned to the buyer, seller, or PayPal (if payment method is PayPal), and no longer returned at all to third parties (except for PayPal). If using a Trading WSDL older than Version 1019, transaction ID is only returned to the buyer, seller or PayPal, and a dummy value of <code>10000000000000</code> will be returned to all third parties (except for PayPal).
GetOrders
DetailLevel: none, ReturnAll
Always
OrderReport
Always
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Always
GetMyeBayBuying
WonList
DeletedFromWonList
DetailLevel: none, ReturnAll
Conditionally
GetMyeBaySelling
SoldList
DeletedFromSoldList
DetailLevel: none, ReturnAll
Conditionally
GetItemsAwaitingFeedback
Conditionally
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Always
AddOrder
Yes
The sale price for one unit of the line item. This price does not include any other costs like shipping charges or sales tax, and its value will remain the same before and after payment. If multiple units were purchased through a single-variation, fixed-price listing, to get the subtotal of the units purchased, the <b>TransactionPrice</b> value would have to be multiplied by the <b>Transaction.QuantityPurchased</b> value. <br><br>
For a motor vehicle listing that required a deposit/down payment, the amount in the <b>TransactionPrice</b> is actually the deposit amount. <br><br>
<strong>For GetMyeBaySelling</strong>: this field is only returned if the transaction came as a result of a buyer's Best Offer accepted by the seller. Otherwise, the <b>Transaction.TotalPrice</b> field should be viewed instead.
GetOrders
DetailLevel: none, ReturnAll
Always
OrderReport
Always
GetMyeBaySelling
DetailLevel: ReturnAll
SoldList, DeletedFromSoldList
Conditionally
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Always
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Always
Indicates whether or not the sales transaction resulted from the seller accepting a Best Offer (or Counter Offer) from a buyer.
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Always
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Always
VAT rate for the line item. When the <b>VATPercent</b> is specified, the item's VAT information appears on the item's listing page. In addition, the seller can choose to print an invoice that includes the item's net price, VAT percent, VAT amount, and total price. Since VAT rates vary depending on the item and on the user's country of residence, a seller is responsible for entering the correct VAT rate; it is not calculated by eBay. To specify a <b>VATPercent</b>, a seller must have a VAT-ID registered with eBay and must be listing the item on a VAT-enabled site. Max precision 3 decimal places. Max length 5 characters. Note: The View Item page displays the precision to 2 decimal places with no trailing zeros. However, the full value you send in is stored.
Container consisting of payment details for an eBay sales transaction, including an identifier for the monetary transaction and a field to express any fees or credits applied to the monetary transaction. This field is only returned after payment for the order has occurred.
<br><br>
<b>For GetItemTransactions only:</b> If using Trading WSDL Version 1019 or above, this field will only be returned to the buyer or seller, and no longer returned at all to third parties. If using a Trading WSDL older than Version 1019, the real transaction identifier is only returned to the buyer or seller, and a string value of <code>Unavailable</code> will be returned to all third parties.
<br><br>
<span class="tablenote">
<strong>Note:</strong> The <strong>MonetaryDetails</strong> container also shows payment information for the order. In the future, it is possible that the <strong>ExternalTransaction</strong> container will be deprecated, so you are encouraged to start using <strong>MonetaryDetails</strong> as soon as possible.
</span>
GetItemTransactions
GetSellerTransactions
DetailLevel: ReturnAll
Conditionally
GetOrders
DetailLevel: ReturnAll
Conditionally
OrderReport
Conditionally
GetOrderTransactions
DetailLevel: ReturnAll
Conditionally
This container consists of Selling Manager product details and is only
returned if the item was listed through Selling Manager Pro.
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
The shipping service actually selected by the buyer from the shipping services
offered by the seller. The buyer typically selects the shipping service at checkout/payment time.
GetItemTransactions
GetSellerTransactions
GetOrderTransactions
GetOrders
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
OrderReport
Conditionally
Display message from buyer. This field holds transient data that is only
being returned in Checkout-related notifications.
Working with Platform Notifications
https://developer.ebay.com/DevZone/guides/features-guide/default.html#Notifications/Notifications.html
This field is deprecated.
Specifies the paid status of the order.
GetMyeBayBuying
DetailLevel: none, ReturnAll
WonList
DeletedFromWonList
Conditionally
Specifies the paid status of the order.
GetMyeBaySelling
SoldList
DeletedFromSoldList
DetailLevel: none, ReturnAll
Conditionally
Indicates the time when the buyer paid for the order and/or order was marked as 'Paid' by the seller. This field is returned once payment has been made by the buyer.
<br><br>
This value will only be visible to the user on either side of the order. An order can be marked as 'Paid' in the following ways:
<ul>
<li>Automatically when a payment is made through eBay's system</li>
<li>Seller marks the item as paid in My eBay or through Selling Manager Pro </li>
<li>Programmatically by the seller through the <b>ReviseCheckoutStatus</b> or <b>CompleteSale</b> calls.</li>
</ul>
GetItemTransactions
GetSellerTransactions
GetOrders
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
OrderReport
Conditionally
GetMyeBayBuying
DetailLevel: none, ReturnAll
WonList
DeletedFromWonList
Conditionally
GetMyeBaySelling
SoldList
DeletedFromSoldList
DetailLevel: none, ReturnAll
Conditionally
Indicates the time when the line item was marked as 'Shipped'. This value will only be visible to the user on either side of the order. An order can be marked as 'Shipped' by purchasing an eBay shipping label, providing shipment tracking in My eBay or through Selling Manager Pro, or programmatically by the seller through the <b>ReviseCheckoutStatus</b> or <b>CompleteSale</b> call.
<br><br>
<span class="tablenote"><b>Note:</b>
This field does not appear in Merchant Data API's <b>OrderReport</b> or <b>SoldReport</b> responses, because once shipment tracking information is provided to the buyer (or marked as shipped), the order/order line item is considered acknowledged, and acknowledged orders do not show up in <b>OrderReport</b> or <b>SoldReport</b> responses.
</span>
GetOrders
DetailLevel: none, ReturnAll
Always
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetMyeBaySelling
SoldList
DeletedFromSoldList
DetailLevel: none, ReturnAll
Conditionally
GetMyeBayBuying
DetailLevel: none, ReturnAll
WonList
DeletedFromWonList
Conditionally
This field indicates the total price for a sales transaction. Before payment, this dollar value will be the price before a shipping service option is selected. Once a shipping service option is selected, the price in this field will be updated to reflect the shipping and handling costs associated with that shipping service option.
GetMyeBayBuying
DetailLevel: none, ReturnAll
WonList
DeletedFromWonList
Conditionally
GetMyeBaySelling
DetailLevel: none, ReturnAll
SoldList
DeletedFromSoldList
Conditionally
This container consists of Feedback left by the caller for their order
partner. This container is only returned if the order is complete and
feedback on the order line item has been left by the caller.
GetMyeBayBuying
DeletedFromWonList
WonList
DetailLevel: none, ReturnAll
Conditionally
GetMyeBaySelling
DeletedFromSoldList
SoldList
DetailLevel: none, ReturnAll
Conditionally
This container consists of Feedback received by the caller from their
order partner. This container is only returned if the order is complete and
feedback on the order line item has been received by the
caller.
GetItemsAwaitingFeedback
Conditionally
GetMyeBayBuying
DeletedFromWonList
WonList
DetailLevel: none, ReturnAll
Conditionally
GetMyeBaySelling
DeletedFromSoldList
SoldList
DetailLevel: none, ReturnAll
Conditionally
This container is returned in a <b>GetItemTransactions</b> or <b>GetSellerTransactions</b> response if the <b>IncludeContainingOrder</b> field is
included in the call request payload and set to 'true'. This container will be returned whether the order line item is the only line item in the order, or if the order has multiple line items.
<br/><br/>
<span class="tablenote"><b>Note:</b> The new <b>OrderLineItemCount</b> field is automatically returned if the user is using Version 1113 of the Trading WSDL (or newer, as versions roll out). If the user is using Versions 1107 or 1111 of the Trading WSDL, the <b>OrderLineItemCount</b> field will only be returned if the user includes the <b>X-EBAY-API-COMPATIBILITY-LEVEL</b> HTTP header and sets its value to <code>1113<code>. If a user is using a Trading WSDL older than 1107, the <b>OrderLineItemCount</b> field will not be returned.
</span>
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ReturnAll
Conditionally
A Final Value Fee is calculated and charged to a seller's account
immediately upon creation of an order line item. Note that this fee is created
before the buyer makes a payment. As long as the <b>IncludeFinalValueFee</b> field is included in the call request and set to 'true', the Final Value Fee for each order line
item is returned, regardless of the checkout status.
<br><br>
If a seller requests a Final Value Fee credit, the value of
<b>Transaction.FinalValueFee</b> will not change if a credit is
issued. The credit only appears in the seller's account data.
GetOrderTransactions
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetOrders
DetailLevel: none, ReturnAll
Conditionally
OrderReport
Conditionally
This field is no longer applicable
<span class="tablenote"><b>Note: </b> This container is only applicable for Half.com order refunds, and since the Half.com site has been shut down, this field is no longer applicable.
</span>
1027
NoOp
1033
The site upon which the line item was purchased.
GetItemTransactions
GetOrderTransactions
GetSellerTransactions
GetOrders
DetailLevel: none, ReturnAll
Conditionally
GetOrderTransactions
DetailLevel: none, ReturnAll
Conditionally
GetItemTransactions
DetailLevel: none, ReturnAll
Conditionally
This value indicates the site on which the sales transaction originated.
<br><br>
<span class="tablenote"><b>Note: </b> Currently, the only value that should be returned in this field is <code>eBay</code>, as the Half.com marketplace no longer exists.
</span>
GetItemTransactions
GetOrderTransactions
GetSellerTransactions
DetailLevel: none, ReturnAll
Always
CustomCode, eBay
GetMyeBayBuying
WonList
DeletedFromWonList
DetailLevel: none, ReturnAll
Conditionally
CustomCode, eBay
GetMyeBaySelling
SoldList
DeletedFromSoldList
DetailLevel: none, ReturnAll
Conditionally
CustomCode, eBay
This field is no longer applicable as Shopping.com listings are no longer created or managed with eBay APIs.
This field is no longer applicable as Shopping.com listings are no longer created or managed with eBay APIs.
The seller's PayPal email address. This value is only revealed if it is the
seller making the call.
GetItemTransactions
GetOrderTransactions
GetSellerTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
Unique identifier for a <b>PaisaPay</b> transaction. Only applicable if <b>PaisaPay</b> was the payment method used.
GetMyeBayBuying
GetMyeBaySelling
No
Conditionally
For the Australia site, <b>BuyerGuaranteePrice</b> is the PayPal Buyer Protection coverage,
offered for the item at the time of purchase. Details of coverage are in the
following sections of the View Item page: the Buy Safely section and the Payment
Details section.
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
In a fixed-priced listing, a seller can offer variations of the same item.
For example, the seller could create a fixed-priced listing for a t-shirt
design, and offer the shirt in different colors and sizes. In this case, each
color and size combination is a separate variation. Each variation can have
a different quantity and price. Due to the possible price differentiation,
buyers can buy multiple items from this listing at the same time, but all of
the items must be of the same variation. One order line item is created
whether one or multiple quanity of the same variation are purchased.
<br><br>
The <b>Variation</b> node contains information about which variation
was purchased. Therefore, applications that process orders
should always check to see if this node is present.
GetItemTransactions
GetSellerTransactions
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetOrders
DetailLevel: none, ReturnAll
Conditionally
OrderReport
Conditionally
This field is returned if a buyer left a comment for the seller during the
left by buyer during the checkout flow.
<br><br>
<b>For GetItemTransactions only:</b> If using Trading WSDL Version 1019 or above, this field will only be returned to the buyer or seller, and no longer returned at all to third parties. If using a Trading WSDL older than Version 1019, real data is only returned to the buyer or seller, and a string value of <code>Unavailable</code> will be returned to all third parties.
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
The sale price of the order line item. This amount does not take
into account shipping and handling charges, sales tax, or any other costs related to the order line
item. If multiple units were purchased through a non-
variation, fixed-price listing, this value will reflect that. So, if the base cost of the order line item was $15.00, and a quantity of two were purchased (<b>Transaction.QuantityPurchased</b>) the value in this field would show as <code>30.00</code>.
<br><br>
To see the full price of the order line item, including any shipping and handling charges, and any sales tax, the (<b>Transaction.TotalPrice</b>) field value should be viewed instead. However, note that the <b>TotalPrice</b> field value is only updated after a shipping service option is selected and payment is made. And if the seller is offering free shipping, the values in the <b>TotalTransactionPrice</b> and the <b>TotalPrice</b> fields may be the same.
GetMyeBaySelling
DeletedFromSoldList
SoldList
DetailLevel: none, ReturnAll
Conditionally
GetMyeBayBuying
WonList
DeletedFromWonList
DetailLevel: none, ReturnAll
Conditionally
A container consisting of detailed tax information (sales tax, Goods and Services tax, or VAT) for a sales transaction. The <b>Taxes</b> container is always returned, even if the sales transaction is not subject to any taxes on the buyer's purchase. The information in this container supercedes/overrides any sales tax information in the <b>ShippingDetails.SalesTax</b> container.
GetItemTransactions
GetOrders
GetOrderTransactions
GetSellerTransactions
DetailLevel: none, ReturnAll
Always
OrderReport
Always
Boolean value indicating whether or not an order line item is
part of a bundle purchase using Product Configurator.
GetItemTransactions
GetOrderTransactions
GetSellerTransactions
GetOrders
DetailLevel: none, ReturnAll
OrderReport
Conditionally
The shipping cost paid by the buyer for the order line item. This field is only returned after checkout is complete.
GetOrders
DetailLevel: none, ReturnAll
Conditionally
OrderReport
Conditionally
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
The handling cost that the seller has charged for the order line item. This field is only returned after checkout is complete.
<br><br>
The value of this field is returned as zero dollars (0.0) if the seller did not specify a handling cost for the listing.
GetOrders
DetailLevel: none, ReturnAll
Conditionally
OrderReport
Conditionally
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
A unique identifier for an eBay order line item. This identifier is created as
soon as there is a commitment to buy from the seller, or the buyer actually purchases the item using a 'Buy it Now' option.
<br><br>
<b>For GetOrders, GetOrderTransactions, and GetItemTransactions only:</b> If using Trading WSDL Version 1019 or above, this field will only be returned to the buyer or seller, and no longer returned at all to third parties. If using a Trading WSDL older than Version 1019, order line item ID is only returned to the buyer or seller, and a dummy value of <code>10000000000000</code> will be returned to all third parties.
<br>
GetMyeBayBuying
WonList
DeletedFromWonList
DetailLevel: none, ReturnAll
Always
GetMyeBaySelling
SoldList
DeletedFromSoldList
DetailLevel: none, ReturnAll
Always
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Always
GetItemsAwaitingFeedback
Conditionally
GetOrders
DetailLevel: none, ReturnAll
Always
OrderReport
Always
GetOrderTransactions
Always
The generated eBay payment ID used by the buyer when he/she chooses electronic
transfer as payment method for paying the seller. This field is only applicable to the eBay Germany site (Site ID 77).
GetSellerTransactions
DetailLevel: none
Conditionally
GetOrderTransactions
DetailLevel: none
Conditionally
This container consists of information related to the payment hold on the order line item, including the reason why the buyer's payment for the order line item is being held, the expected release date of the funds into the seller's account, and possible action(s) the seller can take to expedite the payout of funds into their account. This container is only returned if a payment hold has been placed on the order line item.
<br><br>
See <b>PaymentHoldReasonCodeType</b> for some details on why/when a seller's funds may be held, or visit the <a href="https://www.ebay.com/help/selling/getting-paid/getting-paid-items-youve-sold/pending-payments?id=4816">Pending payments</a> help topic for more information on eBay's payment hold policies.
GetItemTransactions
GetSellerTransactions
DetailLevel: ReturnAll
Conditionally
GetOrders
DetailLevel: none, ReturnAll
Conditionally
OrderReport
Conditionally
GetOrderTransactions
DetailLevel: ReturnAll
Conditionally
GetMyeBaySelling
SoldList
DetailLevel: none, ReturnAll
Conditionally
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. This container is only returned if the order line item is eligible for seller discounts.
GetItemTransactions
GetOrders
GetOrderTransactions
GetSellerTransactions
DetailLevel: none, ReturnAll
Conditionally
OrderReport
Conditionally
This field is deprecated.
This field is deprecated.
This field is returned if the <b>IncludeCodiceFiscale</b> flag is included in the request and set to <code>true</code>, and if the buyer has provided this value at checkout time.
<br/><br/>
This field is only applicable to buyers on the Italy and Spain sites. The Codice Fiscale number is unique for each Italian and Spanish citizen and is used for tax purposes.
GetSellerTransactions
Conditionally
If <strong>IsMultilegShipping</strong> is <code>true</code>, the order line item will be shipped internationally using the Global Shipping Program (GSP). With GSP, the shipment has a domestic leg and an international leg. In the domestic leg, the seller ships the item to eBay's shipping partner. This shipping address can be found in the <strong>MultiLegShippingDetails.SellerShipmentToLogisticsProvider.ShipToAddress</strong> container. eBay's shipping partner will be responsible for the international leg of the shipment and the order's final destination.
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetItemTransactions
GetSellerTransactions
GetMyeBaySelling
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
This container consists of details about the domestic leg of a Global Shipping Program (GSP) shipment. With GSP, the shipment has a domestic leg and an international leg. In the domestic leg, the seller ships the item to eBay's shipping partner.
<br/><br/>
This container is only returned if the order line item requires shipping through GSP. It is not returned if <strong>IsMultilegShipping</strong> is <code>false</code>.
GetOrders
DetailLevel: none, ReturnAll
Conditionally
OrderReport
Conditionally
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ReturnAll
Conditionally
This field indicates the date/time that an order invoice was sent from the seller to the buyer. This field is only returned if an invoice (containing the order line item) was sent to the buyer.
GetOrderTransactions
GetOrders
GetItemTransactions
GetSellerTransactions
DetailLevel: ReturnAll
Conditionally
OrderReport
Conditionally
Container consisting of details related to the type and status of an Unpaid Item case. This container is only returned if there is an open (or recently closed) Unpaid Item case associated with the order line item.
GetOrderTransactions
GetOrders
GetItemTransactions
GetSellerTransactions
DetailLevel: ReturnAll
Conditionally
OrderReport
Conditionally
This flag indicates whether or not the order line item is an intangible good, such as an MP3 track or a mobile phone ringtone. Intangible items are not eligible for PayPal's Seller Protection program, so the seller will not be able to open an Unpaid Item case against the buyer.
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Always
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Always
Contains information about each monetary transaction that occurs for the order line item, including order payment, any refund, a credit, etc. Both the payer and payee are shown in this container.
<br/><br/>
<span class="tablenote">
<strong>Note:</strong> <strong>MonetaryDetails</strong> can already be used instead of the older <strong>ExternalTransaction</strong> container, and the <strong>ExternalTransaction</strong> container may eventually get deprecated. Due to this possibility, you are encouraged to start using <strong>MonetaryDetails</strong> as soon as it is convenient.
</span>
GetOrders
DetailLevel:ReturnAll
Conditionally
OrderReport
Conditionally
GetOrderTransactions
DetailLevel:ItemReturnDescription, ReturnAll
Conditionally
GetItemTransactions
GetSellerTransactions
DetailLevel:ReturnAll
Conditionally
Container consisting of an array of <strong>PickupOptions</strong> containers. Each <strong>PickupOptions</strong> container consists of the pickup method and its priority. The priority of each pickup method controls the order (relative to other pickup methods) in which the corresponding pickup method will appear in the View Item and Checkout page.
<br/><br/>
This container is always returned prior to order payment if the seller created/revised/relisted the item with the <strong>EligibleForPickupInStore</strong> and/or <strong>EligibleForPickupDropOff</strong> flag in the call request set to 'true'. If and when the In-Store pickup method (US only) or 'Click and Collect' pickup method (UK and Australia only) is selected by the buyer and payment for the order is made, this container will no longer be returned in the response, and will essentially be replaced by the <strong>PickupMethodSelected</strong> container.
<br/><br/>
<span class="tablenote">
<strong>Note:</strong> A seller must be eligible for the In-Store Pickup feature or Click and Collect feature to list an item that is eligible for In-Store Pickup or Click and Collect. At this time, the In-Store Pickup and Click and Collect features are generally only available to large retail merchants, and can only be applied to multiple-quantity, fixed-price listings.
</span>
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetMyeBayBuying
WonList
DeletedFromWonList
DetailLevel: none, ReturnAll
Conditionally
This container consists of details related to the selected In-Store pickup method, including the pickup method, the merchant's store ID, the status of the In-Store pickup, and the pickup reference code (if provided by merchant).
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetMyeBayBuying
WonList
DeletedFromWonList
DetailLevel: none, ReturnAll
Conditionally
GetOrders
DetailLevel: none, ReturnAll
Conditionally
OrderReport
Conditionally
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
<span class="tablenote"><strong>Note:</strong>
This field is no longer applicable/used. It was previously used for eBay Now and 'eBay On Demand Delivery' orders - two features that have been deprecated.
</span>
1095
1095
NoOp
This field will be returned at the order line item level only if the buyer purchased a digital gift card, which is delivered by email, or if the buyer purchased an item that is enabled with the 'Click and Collect' feature.
<br/><br/>
Currently, <strong>LogisticsPlanType</strong> has two applicable values: <code>PickUpDropOff</code>, which indicates that the buyer selected the 'Click and Collect' option. With Click and Collect, buyers are able to purchase from thousands of sellers on the eBay UK and Australia sites, and then pick up their order from the nearest 'eBay Collection Point', including over 750 Argos stores in the UK. The Click and Collect feature is only available on the eBay UK and Australia sites; or, <code>DigitalDelivery</code>, which indicates that the order line item is a digital gift card that will be delivered to the buyer or recipient of the gift card by email.
LogisticsPlanCodeType
GetOrders
DetailLevel:none,ReturnAll
Conditionally
OrderReport
Conditionally
GetOrderTransactions
DetailLevel:none,ItemReturnDescription, ReturnAll
Conditionally
GetItemTransactions
GetSellerTransactions
DetailLevel:none,ReturnAll
Conditionally
This container is returned in <b>GetOrders</b> (and other order management calls) if the 'Pay Upon Invoice' option is being offered to the buyer, and the seller is including payment instructions in the shipping package(s) for the order. The 'Pay Upon Invoice' option is only available on the Germany site.
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetOrders
DetailLevel: none, ReturnAll
Conditionally
OrderReport
Conditionally
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
The unique identifier of the inventory reservation.
GetOrders
DetailLevel:none,ReturnAll
Conditionally
OrderReport
Conditionally
GetOrderTransactions
DetailLevel:none,ItemReturnDescription, ReturnAll
Conditionally
GetItemTransactions
GetSellerTransactions
DetailLevel:none,ReturnAll
Conditionally
A unique identifier for an eBay order in the new eBay REST API model. <b>ExtendedOrderID</b> values will be used to identify orders in REST-based APIs, including the Post-Order API and the Fulfillment API.
<br><br>
<b>For GetOrders, GetOrderTransactions, and GetItemTransactions only:</b> If using Trading WSDL Version 1019 or above, this field will only be returned to the buyer or seller, and no longer returned at all to third parties. If using a Trading WSDL older than Version 1019, the correct Order ID is returned to the buyer or seller, but a dummy Order ID value of <code>1000000000000</code> will be returned to all third parties.
<br><br>
<span class="tablenote"><b>Note: </b> As of June 2019, eBay has changed the format of order identifier values, and this new format is relevant to both legacy and REST API-based order ID fields. The new format is a non-parsable string, globally unique across all eBay marketplaces, and consistent for both single line item and multiple line item orders. Unlike in the past, instead of just being known and exposed to the seller, these unique order identifiers will also be known and used/referenced by the buyer and eBay customer support.
<br><br>
For developers and sellers who are already integrated with the Trading API's order management calls, this change shouldn't impact your integration unless you parse the existing order identifiers (e.g., <b>OrderID</b> or <b>OrderLineItemID</b>), or otherwise infer meaning from the format (e.g., differentiating between a single line item order versus a multiple line item order). Because we realize that some integrations may have logic that is dependent upon the old identifier format, eBay is rolling out this Trading API change with version control to support a transition period of approximately 9 months before applications must switch to the new format completely.
<br><br>
During the transition period, for developers/sellers using a Trading WSDL older than Version 1113, they can use the <b>X-EBAY-API-COMPATIBILITY-LEVEL</b> HTTP header in API calls to control whether the new or old <b>OrderID</b> format is returned in call response payloads. To get the new <b>OrderID</b> format, the value of the <b>X-EBAY-API-COMPATIBILITY-LEVEL</b> HTTP header must be set to <code>1113</code>. During the transition period and even after, the new and old <b>OrderID</b> formats will still be supported/accepted in all Trading API call request payloads. After the transition period (which will be announced), only the new <b>OrderID</b> format will be returned in all Trading API call response payloads, regardless of the Trading WSDL version used or specified compatibility level.
</span>
<br>
<span class="tablenote"><b>Note: </b> For sellers integrated with the new order ID format, please note that the identifier for an order (for <b>OrderID</b> and <b>ExtendedOrderID</b>) will change as it goes from unpaid to paid status. Sellers can check to see if an order has been paid by looking for a value of 'Complete' in the <b>CheckoutStatus.Status</b> field in the response of <b>GetOrders</b> or <b>GetOrderTransactions</b> call, or in the <b>Status.CompleteStatus</b> field in the response of <b>GetItemTransactions</b> or <b>GetSellerTransactions</b> call. Sellers should not fulfill orders until buyer has made payment.
</span>
40
GetOrders
DetailLevel: none, ReturnAll
Conditionally
OrderReport
Conditionally
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
If <code>true</code>, the buyer of the order line item has a eBay Plus program subscription, and is eligible to receive the benefits of this program, such as fast, free shipping and free returns. Top-Rated eBay sellers must opt in to eBay Plus to be able offer the program on qualifying listings. Sellers must commit to next-day delivery of those items.
<br/><br/>
<span class="tablenote"><b>Note:</b> Currently, eBay Plus is available only to buyers in Germany, Austria, and Australia.
</span>
more details
Offering eBay Plus
../../../../guides/features-guide/default.html#development/Feature-eBayPlus.html
GetOrders
GetOrderTransactions
GetItemTransactions
GetSellerTransactions
Conditionally
OrderReport
Conditionally
This container is returned in <b>GetOrders</b> and other order management calls if a buyer has purchased a digital gift card but has sent it to another individual as a gift, and has left a message for the recipient. The <b>GiftSummary</b> container consists of the message that the buyer wrote for the recipient of the digital gift card. A digital gift card line item is indicated if the <b>DigitalDeliverySelected</b> container is returned in the response, and if the digital gift card is sent to another individual as a gift, the <b>Gift</b> boolean field will be returned with a value of <code>true</code>.
GetOrders
DetailLevel: none, ReturnAll
Conditionally
OrderReport
Conditionally
GetOrderTransactions
DetailLevel: none, ReturnAll
Conditionally
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
This container is only returned by <b>GetOrders</b> and other order management calls if the buyer purchased a digital gift card for themselves, or is giving the digital gift card to someone else as a gift (in this case, the <b>Gift</b> boolean field will be returned with a value of <code>true</code>). The <b>DigitalDeliverySelected</b> container consists of information related to the digital gift card order line item, including the delivery method, delivery status, and recipient of the gift card (either the buyer, or another individual that is receiving the gift card as a gift from the buyer.
GetOrders
DetailLevel: none, ReturnAll
Conditionally
OrderReport
Conditionally
GetOrderTransactions
DetailLevel: none, ReturnAll
Conditionally
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
This boolean field is returned as <code>true</code> if the seller is giving a digital gift card to another individual as a gift. This field is only applicable for digital gift card order line items.
GetOrders
GetOrderTransactions
GetItemTransactions
GetSellerTransactions
Conditionally
OrderReport
Conditionally
<span class="tablenote"><b>Note: </b> This field is for future use, as the eBay Guaranteed Shipping feature has been put on hold. eBay Guaranteed Shipping should not be confused with eBay Guaranteed Delivery, which is a completely different feature.
</span>
This field is returned as <code>true</code> if the seller chose to use eBay's Guaranteed Shipping feature at listing time. With eBay's Guaranteed Shipping, the seller will never pay more for shipping than what is charged to the buyer. eBay recommends the shipping service option for the seller to use based on the dimensions and weight of the shipping package.
GetOrders
DetailLevel: none, ReturnAll
Conditionally
OrderReport
Conditionally
GetOrderTransactions
DetailLevel: none, ReturnAll
Conditionally
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
This field is returned as <code>true</code> if the order line item is qualified for eBay Guaranteed Delivery, or <code>false</code> if it is not eligible. At this time, eBay Guaranteed Delivery is only available to a select number of sellers on the US and Australia sites, but this feature will be enabled on more eBay sites in 2019. <br/><br/>Only domestic shipments are available for eBay Guaranteed Delivery. For an order line item to be qualified for eBay Guaranteed Delivery, the following must be true:
<ul>
<li>The eBay Guaranteed Delivery feature must be available to the seller</li>
<li>That seller must be opted in to one of the two eBay Guaranteed Delivery programs</li>
<li>If the seller is opted into the "Door-to-Door" program, a domestic shipping rate table must be applied to the listing, and that shipping rate table must include the buyer's location with a transit time (handling + shipping time) of 3 business days or less; </li>
<li>If the seller is opted into the "Handling Time" program, the handling time plus the max shipping time must equal 3 business days or less, and that shipping rate table must include the buyer's location with a transit time (handling + shipping time) of 3 business days or less</li>
<li>The listing must have a return policy</li>
</ul>
With eBay Guaranteed Delivery, the sellers are committed to getting the order line item to the buyer within 3 business days. The seller's defined "Order Cutoff" time will control what is considered 3 business days. If a buyer wanted to get an order by Friday, that buyer would have to purchase that item on Monday before the seller's "Order Cutoff" time. The seller's "Order Cutoff" time is generally set in their timezone, so the buyer should take this into account before the purchase.
GetOrders
DetailLevel: none, ReturnAll
Always
OrderReport
Always
GetOrderTransactions
DetailLevel: none, ReturnAll
Always
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Always
This boolean field is returned as <code>true</code> if the line item is subject to a tax (US sales tax or Australian Goods and Services tax) that eBay will collect and remit to the proper taxing authority on the buyer's behalf. This field is also returned if <code>false</code> (not subject to eBay Collect and Remit). An <b>eBayCollectAndRemitTaxes</b> container is returned if the order line item is subject to such a tax, and the type and amount of this tax is displayed in the <b>eBayCollectAndRemitTaxes.TaxDetails</b> container.
<br/><br/>
Australian 'Goods and Services' tax (GST) is automatically charged to buyers outside of Australia when they purchase items on the eBay Australia site. Sellers on the Australia site do not have to take any extra steps to enable the collection of GST, as this tax is collected by eBay and remitted to the Australian government. For more information about Australian GST, see the <a href="https://www.ebay.com.au/help/selling/fees-credits-invoices/taxes-import-charges?id=4121">Taxes and import charges</a> help topic.
<br/><br/>
As of July 1, 2019, buyers in 22 US states will automatically be charged sales tax for eBay purchases, and at least six more US states are scheduled to be subject to eBay Collect and Remit Tax by the end of 2019. eBay will collect and remit this sales tax to the proper taxing authority on the buyer's behalf. Sellers do not have to take any extra steps to enable the collection of this sales tax. If the seller is employing a Sales Tax Table for the listing, and a sales tax rate is established for a state that is subject to 'eBay Collect and Remit', this sales tax rate will be ignored by eBay. For a list of the US states that are or will become subject to 'eBay Collect and Remit Tax' (and effective dates), see the <a href="https://www.ebay.com/help/selling/fees-credits-invoices/taxes-import-charges?id=4121#section4">eBay sales tax collection</a> help topic.
GetItemTransactions
GetOrders
OrderReport
GetOrderTransactions
GetSellerTransactions
Conditionally
This container is returned if the order line item is subject to a tax (US sales tax or Australian Goods and Services tax) that eBay will collect and remit to the proper taxing authority on the buyer's behalf. The type of tax will be shown in the <b>TaxDetails.Imposition</b> and <b>TaxDetails.TaxDescription</b> fields, and the amount of this tax will be displayed in the <b>TaxDetails.TaxAmount</b> field.
<br/><br/>
Australian 'Goods and Services' tax (GST) is automatically charged to buyers outside of Australia when they purchase items on the eBay Australia site. Sellers on the Australia site do not have to take any extra steps to enable the collection of GST, as this tax is collected by eBay and remitted to the Australian government. For more information about Australian GST, see the <a href="https://www.ebay.com.au/help/selling/fees-credits-invoices/taxes-import-charges?id=4121">Taxes and import charges</a> help topic.
<br/><br/>
As of January 1, 2019, buyers in some US states will automatically be charged sales tax for eBay purchases. eBay will collect and remit this sales tax to the proper taxing authority on the buyer's behalf. Sellers do not have to take any extra steps to enable the collection of this sales tax. If the seller is employing a Sales Tax Table for the listing, and a sales tax rate is established for a state that is subject to 'eBay Collect and Remit', this sales tax rate will be ignored by eBay. For a list of the US states that will become subject to 'eBay Collect and Remit' (and effective dates), see the <a href="https://www.ebay.com/help/selling/fees-credits-invoices/taxes-import-charges?id=4121#section4">eBay sales tax collection</a> help topic.
GetItemTransactions
GetOrders
OrderReport
GetOrderTransactions
GetSellerTransactions
DetailLevel: none, ReturnAll
Conditionally
Type defining the <b>UPCEnabled</b> field that is returned under the <b>FeatureDefinitions</b> container of the <b>GetCategoryFeatures</b> response (as long as 'UPCEnabled' is included as a <b>FeatureID</b> value in the call request or no <b>FeatureID</b> values are passed into the call request). This field is returned as an empty element (a boolean value is not returned) if one or more eBay API-enabled sites support the UPC product identifying feature.
<br><br>
To verify if a specific eBay site supports the UPC product identifying feature (for most categories), look for a 'true' value in the <b>SiteDefaults.UPCEnabled</b> field.
<br><br>
To verify if a specific category on a specific eBay site supports the UPC product identifying feature, pass in a <b>CategoryID</b> value in the request, and then look for a 'true' value in the <b>UPCEnabled</b> field of the corresponding <b>Category</b> node (match up the <b>CategoryID</b> values if more than one Category IDs were passed in the request).
This type is deprecated and has been replaced by <b>UPCEnabledDefinitionType</b>.
This enumerated type defines the rate types that United Parcel Service (UPS) can offer to sellers for shipping.
This enumeration value indicates that the seller is currently receiving the UPS Daily Rate for shipping items.
This enumeration value indicates that the seller is currently receiving the UPS On-Demand Rate for shipping items.
Reserved for internal or future use
This type is used by the <b>URLDetails</b> containers that are returned in the response of <b>GeteBayDetails</b> if the <code>URLDetails</code> value is used in the <b>DetailName</b> field of the call request. Each <b>URLDetails</b> container conists of the URL of the different eBay pages, such as the View Item URL, the eBay Store URL, and others.
This enumeration value indicates the type of eBay page.
GeteBayDetails
Conditionally
A commonly used eBay URL. Applications use some of these URLs (such as the View Item URL)
to launch eBay Web site pages in a browser.<br><br>
Logo URLs are required to be used in certain types of applications.
See your API license agreement. Also see this page for logo usage rules:<br>
http://developer.ebay.com/join/licenses/apilogousage
GeteBayDetails
Conditionally
Returns the latest version number for this field. The version can be
used to determine if and when to refresh cached client data.
GeteBayDetails
DetailLevel: none, ReturnSummary, ReturnAll
Always
Gives the time in GMT that the feature flags for the details were last
updated. This timestamp can be used to determine if and when to refresh
cached client data.
GeteBayDetails
DetailLevel: none, ReturnSummary, ReturnAll
Always
This enumerated type consists of the different eBay URLs that can be returned under the <b>URLDetails</b> containers of a <b>GeteBayDetails</b> response.
This value indicates that the URL in the corresponding <b>URL</b> field is the base URL for the View Item page. The user will just input the Item ID for a listing at the end of the URL to retrieve the View Item page for that listing.
This value indicates that the URL in the corresponding <b>URL</b> field is the base URL for the eBay User page. The user will just input the user ID for an eBay user at the end of the URL to retrieve the eBay User page.
This value indicates that the URL in the corresponding <b>URL</b> field is the URL for the My eBay home page.
This value indicates that the URL in the corresponding <b>URL</b> field is the URL for the user's My eBay Bids/Offer page.
This value indicates that the URL in the corresponding <b>URL</b> field is the URL to the 'Didn't Win' section on the user's My eBay Bids/Offer page.
This value indicates that the URL in the corresponding <b>URL</b> field is the URL to the 'Bidding' section on the user's My eBay Bids/Offer page.
This value indicates that the URL in the corresponding <b>URL</b> field is the URL to the user's My eBay Watch List page.
This value indicates that the URL in the corresponding <b>URL</b> field is the base URL to the user's eBay Store page. The seller will just add a forward slash (/) and their eBay Store name to get to their eBay Store home page.
This value indicates that the URL in the corresponding <b>URL</b> field is the full URL to the small version of the eBay Marketplace logo.
This value indicates that the URL in the corresponding <b>URL</b> field is the full URL to the medium version of the eBay Marketplace logo.
This value indicates that the URL in the corresponding <b>URL</b> field is the full URL to the large version of the eBay Marketplace logo.
This value indicates that the URL in the corresponding <b>URL</b> field is the base URL that a seller needs to enter the UI flow to make a request that a missing product be added to the eBay Catalog.
<br>
<br>
<span class="tablenote"><b>Note:</b>
Catalog change requests through the UI flow are currently not available, so this URL will not be returned in <b>GeteBayDetails</b>.
</span>
This value indicates that the URL in the corresponding <b>URL</b> field is the base URL that a seller needs to enter the UI flow to make a request that an existing eBay Catalog product be revised. The seller will have to append the ePID value of the catalog product to the end of the URL.
<br>
<br>
<span class="tablenote"><b>Note:</b>
Catalog change requests through the UI flow are currently not available, so this URL will not be returned in <b>GeteBayDetails</b>.
</span>
This value indicates that the URL in the corresponding <b>URL</b> field is the base URL that a seller needs to enter the UI flow to get the status of a catalog change request (request for a new catalog product or request to revise an existing product). The seller will have to append the identifier of the catalog change request to the end of the URL.
<br>
<br>
<span class="tablenote"><b>Note:</b>
Catalog change requests through the UI flow are currently not available, so this URL will not be returned in <b>GeteBayDetails</b>.
</span>
Reserved for future use.
This enumerated type defines the rate types that United States Postal Service (USPS) can offer to sellers for shipping.
This enumeration value indicates that the seller is currently receiving the USPS Discounted Rate for shipping items.
This enumeration value indicates that the seller is currently receiving the USPS Retail Rate for shipping items.
Reserved for internal or future use
Units of measure that you can use to specify properties such as weight and size
dimensions.
Kilograms
Grams
Pounds
Ounces
Centimeters
Milimeters
Inches
Feet
Reserved for internal or future use.
This type provides information about the weight, volume or other quantity measurement of a listed item. The European Union requires listings for certain types of products to include the price per unit so buyers can accurately compare prices. eBay uses the <strong>UnitType</strong> and <strong>UnitQuantity</strong> values and the item's listed price to calculate and display the per-unit price on eBay EU sites.
Designation of size, weight, volume or count to be used to specify the unit quantity of the item. This value can be one of the following:
<br/>
<pre> Kg 100g 10g L 100ml 10ml M M2 M3 Unit </pre>
With <b>GetItem</b>, this field is returned only when you provide <strong>IncludeItemSpecifics</strong> in the request and set it to <code>true</code>.
GetItem
GetItems
Conditionally
Number of units of size, weight, volume or count of the specified unit type for the item. eBay divides the item price by this number to get the price per unit to be displayed in the item listing for comparison purposes.
<br/><br/>
With GetItem, this field is returned only when you provide <strong>IncludeItemSpecifics</strong> in the request and set it to <code>true</code>.
GetItem
GetItems
Conditionally
This type is deprecated.
This field is deprecated.
This field is deprecated.
This field is deprecated.
This type is deprecated.
This field is deprecated.
This field is deprecated.
This type defines the <b>UnpaidItemAssistancePreferences</b> container. This container is
used in <b>SetUserPreferences</b> to set the preferences related to the <b>Unpaid Item
Assistant</b> feature. The <b>UnpaidItemAssistancePreferences</b> container is also returned in
<b>GetUserPreferences</b> (if the <b>ShowUnpaidItemAssistancePreference</b> flag is included and
set to true in the request).
<br/><br/>
See the <a href="http://pages.ebay.com/help/sell/unpaid-item-assistant.html">Using Unpaid Item Assistant</a> Help topic for more information about setting up and using the Unpaid Item Assistant feature.
This value indicates the number of days that should elapse before the Unpaid
Item Assistant mechanism opens an Unpaid Item case on behalf of the seller.
<b>Valid values are</b>: 4, 8, 16, 24, and 32 (days).
<br/><br/>
This field is ignored if the <b>OptInStatus</b> flag is included and set to <code>false</code> in the request, or if the seller is not currently opted into the Unpaid Item Assistant feature in Unpaid Item Assistant Preferences on My eBay.
<br/>
2
32
32
GetUserPreferences
Conditionally
SetUserPreferences
No
Flag to indicate whether or not the Unpaid Item Assistant mechanism is turned on for the seller. Through the Unpaid Item Assistant mechanism, eBay can automatically file Unpaid Item cases on behalf of the seller.
<br/><br/>
The Unpaid Item Assistant feature also has options to automatically relist disputed items, to automatically request a PayPal Giving Fund donation refund (for eBay for Charity listings only), or to create an 'Exclusion list' of buyers who are not subject to the automatic filing of an Unpaid Item case.
GetUserPreferences
Conditionally
SetUserPreferences
No
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. For a multiple-quantity listing,
the quantity is adjusted if <b>AutoRelist</b> is set to <code>true</code>.
<br/><br/>
This field is ignored if the <b>OptInStatus</b> flag is included and set to <code>false</code> in the request, or if the seller is not currently opted into the Unpaid Item Assistant feature in Unpaid Item Assistant Preferences on My eBay.
GetUserPreferences
Conditionally
SetUserPreferences
No
This field should be included and set to <code>true</code> if the seller wants to clear all users from the Unpaid Item Assistant Exclusion list. The Exclusion list can be viewed from the Unpaid Item Assistant Preferences in My eBay. Excluded users are not subject to the automatic filing of Unpaid Item cases. The seller can still open Unpaid Item cases against excluded users, but these cases must be opened manually.
<br/><br/>
Users can be added to Exclusion list through the <b>ExcludedUser</b>
field. The <b>RemoveAllExcludedUsers</b> field is ignored if the
<b>OptInStatus</b> flag is included and set to false in the request,
or if the seller is not currently opted into the Unpaid Item Assistant feature
in Unpaid Item Assistant Preferences on My eBay.
GetUserPreferences
Conditionally
SetUserPreferences
No
An eBay User ID for which the Unpaid Item Assistant mechanism is disabled. This
field is typically used by a seller who would prefer to file an Unpaid Item
dispute manually for the specified user.
<br/><br/>
One or more <b>ExcludedUser</b> fields are used in
<b>SetUserPreferences</b> to add users to Unpaid Item Assistant Exclusion
list. Any and all <b>ExcludedUser</b> fields are ignored if the
<b>OptInStatus</b> flag is included and set to <code>false</code> in the request,
or if the seller is not currently opted into the Unpaid Item Assistant feature
in Unpaid Item Assistant Preferences on My eBay.
<br/><br/>
In <b>GetUserPreferences</b>, one or more <b>ExcludedUser</b> fields
represent the current Excluded user list.
GetUserPreferences
Conditionally
SetUserPreferences
No
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. This setting is
only applicable to eBay for Charity listings.
<br/><br/>
This field is ignored if the
<b>OptInStatus</b> flag is included and set to <code>false</code> in the request, or if
the seller is not currently opted into the Unpaid Item Assistant feature in
Unpaid Item Assistant Preferences on My eBay.
GetUserPreferences
Conditionally
SetUserPreferences
No
Enumeration type that indicates the method used to open an Unpaid Item case.
This value indicates that the Unpaid Item case was opened automatically
through eBay's Unpaid Item Assistant feature.
This value indicates that the seller opened an Unpaid Item case manually
through the Resolution Center or by using the Trading API's
<strong>AddDispute</strong> call.
This value is reserved for future or internal use.
Enumeration type that indicates the current status of an Unpaid Item case.
This value indicates that the Unpaid Item case is open.
This value indicates that the Unpaid Item case is closed with payment
received from the buyer.
This value indicates that the Unpaid Item case is closed with no payment
received from the buyer.
This value is reserved for future or internal use.
This enumerated type consists of each Unpaid Item case state.
This enumeration value indicates that the seller's request for a Final Value Fee credit has been denied.
This enumeration value indicates that the Final Value Fee has been credited back to the seller's account.
This enumeration value indicates that the seller is eligible to received a Final Value Fee credit back to the their account.
This enumeration value indicates that the Unpaid Item case is currently waiting for a response from the seller.
This enumeration value indicates that the Unpaid Item case is currently waiting for a response from the buyer.
This enumeration value indicates that the Unpaid Item case has been opened by the seller against the buyer.
This enumeration value indicates that the seller is eligible to create an Unpaid Item case against the buyer.
Reserved for internal or future use.
Type defining the <strong>UnpaidItem</strong> container, which consists of
details related to the type and status of an Unpaid Item case.
This field indicates the status of the Unpaid Item case. This field is always
returned with the <strong>UnpaidItem</strong> container.
GetOrderTransactions
GetOrders
GetItemTransactions
GetSellerTransactions
SoldReport
DetailLevel: ReturnAll
Conditionally
OrderReport
Conditionally
This field indicates if the Unpaid Item case was opened manually by the customer or
opened automatically by eBay's Unpaid Item Assistant feature. This field is always
returned with the <strong>UnpaidItem</strong> container.
GetOrderTransactions
GetOrders
GetItemTransactions
GetSellerTransactions
SoldReport
DetailLevel: ReturnAll
Conditionally
OrderReport
Conditionally
http://pages.ebay.com/help/sell/unpaid-item-assistant.html
Using Unpaid Item Assistant
more information about managing the Unpaid Item Assistant feature
This enumerated type is used by the <b>NameRecommendation.ValidationRules.UsageConstraint</b> field that is returned in <b>GetCategorySpecifics</b> for each item specific that is returned in the response. The enumeration value returned in the <b>UsageConstraint</b> will indicate whether the item specific is required, recommended, or optional.
This enumeration value indicates that the corresponding item specific is completely optional for a listing in the category, but the seller should still include it if the item specific is relevant to the product and its value is known.
This enumeration value indicates that the corresponding item specific is typical and recommended for a listing in the category, but not fully required. The seller should include this item specific if its value is known because including it may improve search results and sale conversion.
This enumeration value indicates that the corresponding item specific is required for a listing in the category. The seller must include this item specific or the listing may be blocked.
Reserved for internal or future use.
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 type is deprecated.
Contains the items, searches and sellers that the user has saved to this
list using the "Add to list" feature. The name of the list is given by the
"Name" element.
The user's chosen name for this list.
GetMyeBayBuying
Conditionally
The value in this field indicates the total number of items in the
user-defined list. The number of <b>Item</b> nodes in the
<b>ItemArray</b> should match this value.
GetMyeBayBuying
Conditionally
This field is not supported.
The value in this field indicates the total number of favorite sellers in the
user-defined list. The number of <b>FavoriteSeller</b> nodes returned
in the response should match this value.
GetMyeBayBuying
Conditionally
An array of Items that the user has added to the user-defined list.
GetMyeBayBuying
Conditionally
An array of Favorite Searches that the user has added to the user-defined list.
GetMyeBayBuying
Conditionally
An array of Favorite Sellers that the user has added to the user-defined list.
GetMyeBayBuying
Conditionally
Contains an array of eBay UserID entries.
Unique eBay user ID for the user.
Applies to eBay Motors Pro applications only.
GetSellerList
No
This is a string wrapper for the eBay ID that uniquely identifies a user. This is used by
several other types to identify a specific eBay user, such as DisputeType.xsd, FeedbackInfoType.xsd,
GetAllBidders, OrderType, and so on.
<br><br>For GetAllBidders,
some bidder information is anonymous, to protect bidders from fraud. If the seller makes
this API call, the actual IDs of all bidders on the seller's item will be returned.
If a bidder makes this API call, the bidder's actual ID will be returned, but information
for all competing bidders or outside watchers will be returned as anonymized userIDs.
Enumerated type this is used to indicate the type of user that initiated a monetary transaction.
This enumeration value indicates that an eBay user initiated the monetary transaction.
This enumeration value indicates that an eBay partner (such as Pitney Bowes) initiated the monetary transaction.
This value is reserved for future use.
Based on the context of the field, this type defines the user is sending or receiving a payment.
This attribute indicates if the payer or payee is an eBay user or an eBay partner.
GetOrders
DetailLevel: none, ReturnAll
Conditionally
OrderReport
Conditionally
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ReturnAll
Conditionally
These codes indicate the current state or status of an eBay
user account.
UnconfirmedPassport, CreditCardVerifyPassport, UnconfirmedExpress, CreditCardVerifyHalfOptIn, UnconfirmedHalfOptIn
This value indicates that the status of the user's eBay account is unknown. This value should seldom, if ever, be returned and typically represents a problem.
This value indicates that the eBay user's account is suspended. A user with a suspended account cannot participate in buying or selling activity.
This value indicates that the eBay user's account is a confirmed, active account.
This value indicates that the eBay User has completed online registration, but has either not responded to confirmation email or has not yet been sent the confirmation email. Or, if this user began registration as a seller but did not complete it, the user will have this status. A seller with this status can begin to list an item but cannot complete the listing until the seller completes seller registration.
This value indicates that the user originally registered on AuctionWeb (pre-eBay), but that user never re-registered on eBay. Note that there are very few (if any) eBay accounts in the 'Ghost' state.
This value indicates that the eBay user's account is in maintenance mode.
This value indicates that the eBay user's account has been deleted.
This value indicates that the user has completed the registration and confirmation process, but needs to complete verification of credit card information. A user has this status if this user began registration as a seller but did not complete it. A seller with this status can begin to list an item but cannot complete the listing until the seller completes seller registration.
This value indicates that the eBay user's account is currently on hold. A common reason for a user's account to go on hold is a non-payment of the monthly eBay invoice. A user cannot sell or buy items if their account is on hold.
This value indicates that the user record has been merged with another account record for the same user
This value indicates that the eBay User has completed online registration, and eBay has just sent the user a registration code in a confirmation email. The eBay user will have to respond to the confirmation email to get their account confirmed.
This value indicates that the user has scheduled an account closure but eBay has yet to process the closure request.
<span class="tablenote"><b>Note: </b> The Half.com site has been shut down, so this value is no longer applicable.
</span>
User has completed the registration for Half.com and opted
to automatically also be registered with eBay, but the
registration confirmation is still pending
<span class="tablenote"><b>Note: </b> The Half.com site has been shut down, so this value is no longer applicable.
</span>
User has completed the registration for Half.com and opted to automatically also be registered with eBay, but the user needs to complete verification of credit card information. A user has this status on eBay if this user began registration as a seller but did not complete it. A seller with this status can begin to list an item but cannot complete the listing until the seller completes seller registration.
This value is no longer applicable.
This value is no longer applicable.
This value is no longer applicable.
This value indicates that the user is a guest user. The user has not added a password and has not confirmed an email address.
The user has not signed up as a regular user, but has agreed to the User Agreement and Privacy Policy.
The user has been through the buying flow for a guest;
the user has been through checkout using the streamlined Buy-It-Now flow.
Reserved for internal or future use
Type to contain the data for one eBay user. Depending on the context, the user
might be the seller or the buyer on either side of an order, or the bidder or winning bidder
in a listing. An object of this type is returned by a number of calls, including
the <b>GetUser</b> call.
If <code>true</code>, indicates that the user has set up an About Me page.
GetUser
DetailLevel: none, ReturnSummary, ReturnAll
Conditionally
GetItem
GetSellingManagerTemplates
Always
Seller
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
GetSellerList
HighBidder
DetailLevel: ItemReturnDescription, ReturnAll
GranularityLevel: Fine
Conditionally
GetOrderTransactions
DetailLevel: ReturnAll
Conditionally
GetItem
GetSellingManagerTemplates
Conditionally
HighBidder
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
GetSellerList
Seller
DetailLevel: none, ItemReturnDescription, ReturnAll
GranularityLevel: Fine
Always
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ReturnAll
Always
Seller
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ReturnAll
Conditionally
Buyer
GetAllBidders
GetBidderList
Always
Unique identifier for the user that does not change when the eBay user name
is changed. Use when an application needs to associate a new eBay user name
with the corresponding eBay user.
https://developer.ebay.com/DevZone/guides/features-guide/default.html#Development/CRM-UserInformation.html#WorkingwithAnonymousUserInformation
Working with Anonymous User Information
GetSellingManagerTemplates
DetailLevel: ReturnAll
Conditionally
GetUser
DetailLevel: none, ReturnSummary, ReturnAll
Conditionally
GetOrderTransactions
DetailLevel: ReturnAll
Conditionally
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ReturnAll
Always
Seller
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ReturnAll
Conditionally
Buyer
GetSellerList
HighBidder
DetailLevel: ItemReturnDescription, ReturnAll
GranularityLevel: Fine
Conditionally
Email address for the user.
Please see the links below to the topics related to anonymous user information
and static email addresses.
You cannot retrieve an email address for any user
with whom you do not have an order relationship, regardless of site.
<br/><br/>
An email address of another user is only returned
if you and the other user are in an order relationship,
within a certain time of order line item creation
(although this limitation isn't applicable to the <b>GetAllBidders</b> call
in the case of motor vehicles categories.)
Based on Trust and Safety policies, the time is
unspecified and can vary by site.
<br><br>
Since a bidder's user info is anonymous, this tag will be returned only to that
bidder, and to the seller of an item that the user is bidding on.
<br><br>
For the <b>GetOrders</b> call, the buyer's email address will be returned (to the seller only) for orders less than two weeks old, but for orders that occurred more than two weeks in the past, the buyer's email address will no longer be returned. This <b>Email</b> field will still be returned, but 'dummy data', such as <code>Invalid Request</code> will replace the actual email address.
<br>
64 for US. May differ for other countries. Note: The eBay database
allocates up to 128 characters for this field
https://developer.ebay.com/DevZone/guides/features-guide/default.html#Development/CRM-UserInformation.html#WorkingwithAnonymousUserInformation
Working with Anonymous User Information
https://developer.ebay.com/DevZone/guides/features-guide/default.html#Development/CRM-Communications.html#StaticEmailAddressesinTradingAPICalls
Static Email Addresses in Trading API Calls
GetAllBidders
GetBidderList
Conditionally
GetBestOffers
DetailLevel: none, ReturnAll
Conditionally
GetUser
DetailLevel: none, ReturnSummary, ReturnAll
Conditionally
GetOrders
DetailLevel: none, ReturnAll
Conditionally
OrderReport
Conditionally
GetOrderTransactions
DetailLevel: ReturnAll
Conditionally
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally
GetMyeBayBuying
WonList
DeletedFromWonList
DetailLevel: none, ReturnAll
Conditionally
GetMyeBaySelling
SoldList
DeletedFromSoldList
DetailLevel: none, ReturnAll
Conditionally
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ReturnAll
Always
Seller
GetSellerList
Seller
DetailLevel: ReturnAll
Conditionally
GetSellerList
HighBidder
DetailLevel: ItemReturnDescription, ReturnAll
Conditionally
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ReturnAll
Conditionally
Buyer
GetSellerEvents
DetailLevel: ReturnAll
Conditionally
The aggregate feedback score for a user. A user's feedback score is the net
positive feedback minus the net negative feedback left for the user.
Feedback scores are a quantitative expression of the desirability of dealing
with a user as a buyer or a seller in either side of an order.
<br/><br/>
Each order line item can
result in one feedback entry for a given user (the buyer can leave feedback
for the seller, and the seller can leave feedback for the buyer.). That one
feedback can be positive, negative, or neutral. The aggregated feedback
counts for a particular user represent that user's overall feedback score
(referred to as a "feedback rating" on the eBay site).
<br/><br/>
If the user has
chosen to make their feedback private and that user is not the user
identified in the request's authentication token, <b>FeedbackScore</b> is not
returned and <b>FeedbackPrivate</b> is returned with a value of <code>true</code>.
<br/><br/>
In <b>GetMyeBayBuying</b> and <b>GetMyeBaySelling</b>, feedback information (<b>FeedbackScore</b>
and <b>FeedbackRatingStar</b>) is returned in <b>BidList.ItemArray.Item.Seller</b>. For
<b>GetMyeBayBuying</b>, the feedback score of each seller with an item having
received a bid from the buyer is returned. For <b>GetMyeBaySelling</b>, the
feedback score of the seller is returned. <br>
<br>
<b>GetMyeBayBuying</b> and <b>GetMyeBaySelling</b> also return feedback information
(<b>FeedbackScore</b> and <b>FeedbackRatingStar</b>) in
<b>BidList.ItemArray.Item.SellingStatus.HighBidder</b>. <b>GetMyeBayBuying</b> returns
feedback information on the high bidder of each item the buyer is bidding
on. <b>GetMyeBaySelling</b> returns feedback information on the high bidder of each
item the seller is selling.<br>
<br>
Since a bidder's user info is anonymous, the real feedback score will
be returned only to that bidder, and to the seller of an item that the
user is bidding on. For all other users, the value -99 is returned.
<br><br>
<b>For GetOrders, GetOrderTransactions, and GetItemTransactions only:</b> If using Trading WSDL Version 1019 or above, this field will only be returned to the buyer or seller, and no longer returned at all to third parties. If using a Trading WSDL older than Version 1019, the accurate Feedback Score for the user is returned to the buyer or seller, but a dummy value of <code>0</code> will be returned to all third parties.
https://developer.ebay.com/DevZone/guides/features-guide/default.html#Development/CRM-UserInformation.html#WorkingwithAnonymousUserInformation
Working with Anonymous User Information
GetAllBidders
Conditionally
GetUser
DetailLevel: none, ReturnSummary, ReturnAll
Conditionally
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally
GetBidderList
Always
GetBestOffers
DetailLevel: none, ReturnAll
Always
GetOrderTransactions
DetailLevel: ReturnAll
Conditionally
GetSellerList
Seller
DetailLevel: none, ItemReturnDescription, ReturnAll
GranularityLevel: Fine
Always
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ReturnAll
Always
Seller
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ReturnAll
Conditionally
Buyer
GetSellerList
HighBidder
DetailLevel: ItemReturnDescription, ReturnAll
GranularityLevel: Fine
Conditionally
GetSellerEvents
DetailLevel: ReturnAll
Conditionally
GetMyeBayBuying
GetMyeBaySelling
BidList
WatchList
BestOfferList
LostList
DeletedFromLostList
ActiveList
DetailLevel: none, ReturnAll
Conditionally
Total count of negative Feedback entries received by the user, including weekly repeats.
GetUser
DetailLevel: none, ReturnSummary, ReturnAll
Conditionally
Total count of positive Feedback entries received by the user, including
weekly repeats. This contains the aggregate feedback score for a user. A member's
feedback score is the net positive feedback minus the net negative feedback
left for the member.
<br/><br/>
Feedback scores are a quantitative expression of the
desirability of dealing with that person as a Buyer or a Seller on either side of an order. Each order line item can result in one feedback entry for
a given user (the buyer can leave feedback for the seller, and the seller
can leave feedback for the buyer).
<br/><br/>
Feedback can be positive,
negative, or neutral. The aggregated feedback counts for a particular user
represent that user's overall feedback score (referred to as a "feedback
rating" on the eBay site). This rating is commonly expressed as the eBay
Feedback score for the user.
GetUser
DetailLevel: none, ReturnSummary, ReturnAll
Conditionally
Percent of total feedback that is positive. For example, if the member has
50 feedbacks, where 49 are positive and 1 is neutral or negative, the
positive feedback percent could be 98.0. The value uses a max precision of 4
and a scale of 1. If the user has feedback, this value can be returned
regardless of whether the member has chosen to make their feedback private.
Not returned if the user has no feedback.
<br><br>
<b>For GetOrders, GetOrderTransactions, and GetItemTransactions only:</b> If using Trading WSDL Version 1019 or above, this field will only be returned to the buyer or seller, and no longer returned at all to third parties. If using a Trading WSDL older than Version 1019, the accurate Positive Feedback Percentage value for the user is returned to the buyer or seller, but a dummy value of <code>0.0</code> will be returned to all third parties.
GetAllBidders
DetailLevel: ReturnAll
Conditionally
GetItem
GetSellingManagerTemplates
Conditionally
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ReturnAll
Conditionally
GetUser
DetailLevel: none, ReturnSummary, ReturnAll
Conditionally
Indicates whether the user has chosen to make their feedback score and
feedback details private (hidden from other users). The percentage
of positive feedback can still be returned, even if other feedback details
are private.
<br><br>
Since a bidder's user info is anonymous, this tag will be returned only to
that bidder, and to the seller of an item that the user is bidding on.
https://developer.ebay.com/DevZone/guides/features-guide/default.html#Development/CRM-UserInformation.html#WorkingwithAnonymousUserInformation
Working with Anonymous User Information
GetUser
DetailLevel: none, ReturnSummary, ReturnAll
Conditionally
GetAllBidders
GetBidderList
Always
GetItem
GetSellingManagerTemplates
Always
Seller
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
GetItem
GetSellingManagerTemplates
Conditionally
HighBidder
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
GetOrderTransactions
DetailLevel: ReturnAll
Conditionally
GetSellerList
HighBidder
DetailLevel: ItemReturnDescription, ReturnAll
GranularityLevel: Fine
Conditionally
GetSellerList
Seller
DetailLevel: none, ItemReturnDescription, ReturnAll
GranularityLevel: Fine
Always
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ReturnAll
Always
Seller
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ReturnAll
Conditionally
Buyer
Visual indicator of user's feedback score. See <b>FeedbackRatingStarCodeType</b> for
specific values.
<br><br>
<b>For GetOrders, GetOrderTransactions, and GetItemTransactions only:</b> If using Trading WSDL Version 1019 or above, this field will only be returned to the buyer or seller, and no longer returned at all to third parties. If using a Trading WSDL older than Version 1019, the accurate Feedback Rating Star value for the user is returned to the buyer or seller, but a dummy value of <code>None</code> will be returned to all third parties.
GetUser
DetailLevel: none, ReturnSummary, ReturnAll
Conditionally
GetAllBidders
GetBidderList
Always
GetItem
GetSellingManagerTemplates
Always
Seller
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
GetSellerList
HighBidder
DetailLevel: ItemReturnDescription, ReturnAll
GranularityLevel: Fine
Conditionally
GetItem
GetSellingManagerTemplates
Conditionally
HighBidder
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
GetOrderTransactions
DetailLevel: ReturnAll
Conditionally
GetSellerList
Seller
DetailLevel: none, ItemReturnDescription, ReturnAll
GranularityLevel: Fine
Always
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ReturnAll
Always
Seller
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ReturnAll
Conditionally
Buyer
GetMyeBayBuying
GetMyeBaySelling
BidList
WatchList
BestOfferList
LostList
DeletedFromLostList
ActiveList
DetailLevel: none, ReturnAll
Conditionally
Indicates whether the user has been verified. For more information
about the ID Verify program, see:
<a href="http://pages.ebay.com/help/policies/identity-idverify.html">Protecting your account</a>
GetUser
DetailLevel: none, ReturnSummary, ReturnAll
Conditionally
GetAllBidders
GetBidderList
Always
GetItem
GetSellingManagerTemplates
Always
Seller
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
GetSellerList
HighBidder
DetailLevel: ItemReturnDescription, ReturnAll
GranularityLevel: Fine
Conditionally
GetItem
GetSellingManagerTemplates
Conditionally
HighBidder
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ReturnAll
Always
Seller
GetOrderTransactions
DetailLevel: ReturnAll
Conditionally
GetSellerList
Seller
DetailLevel: none, ItemReturnDescription, ReturnAll
GranularityLevel: Fine
Always
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ReturnAll
Conditionally
Buyer
If <code>true</code>, indicates that the user is in good standing with eBay.
GetUser
DetailLevel: none, ReturnSummary, ReturnAll
Conditionally
GetAllBidders
GetBidderList
Always
GetItem
GetSellingManagerTemplates
Always
Seller
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
GetOrderTransactions
DetailLevel: ReturnAll
Conditionally
GetSellerList
HighBidder
DetailLevel: ItemReturnDescription, ReturnAll
GranularityLevel: Fine
Conditionally
GetItem
GetSellingManagerTemplates
Conditionally
HighBidder
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
GetSellerList
Seller
DetailLevel: none, ItemReturnDescription, ReturnAll
GranularityLevel: Fine
Always
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ReturnAll
Always
Seller
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ReturnAll
Conditionally
Buyer
If <code>true</code>, identifies a new user who has been a registered eBay user for 30 days
or less. This is always <code>false</code> after the user has been registered for more than 30
days. Does not indicate an ID change (see <b>UserIdChanged</b>).
GetUser
DetailLevel: none, ReturnSummary, ReturnAll
Conditionally
GetAllBidders
GetBidderList
Always
GetItem
GetSellingManagerTemplates
Always
Seller
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
GetSellerList
HighBidder
DetailLevel: ItemReturnDescription, ReturnAll
GranularityLevel: Fine
Conditionally
GetItem
GetSellingManagerTemplates
Conditionally
HighBidder
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
GetOrderTransactions
DetailLevel: ReturnAll
Conditionally
GetSellerList
Seller
DetailLevel: none, ItemReturnDescription, ReturnAll
GranularityLevel: Fine
Always
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ReturnAll
Always
Seller
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ReturnAll
Conditionally
Buyer
This container consists of the Registration address for the eBay user making the call.<br>
<br>
<b>GetUser:</b> eBay returns complete
<b>RegistrationAddress</b> details (including Phone), as applicable to the
registration site for the eBay user making the call.
<br><br>
<b>GetItem and GetSellerTransactions:</b> <b>RegistrationAddress</b> for another user
(except for Phone) is only returned if you have an order relationship
with that user AND that user is registered on DE/AT/CH, regardless of your
registration site and the site to which you send the request. For example,
the seller can see the buyer's registration address if the buyer is
registered on DE/AT/CH, or the buyer can see the seller's registration
address if the seller is registered on DE/AT/CH. (The buyer and seller won't
see their own registration addresses in <b>GetItem</b>.)
GetUser
DetailLevel: ReturnAll
Conditionally
GetItem
GetSellingManagerTemplates
Conditionally
Seller
HighBidder
DetailLevel: ReturnAll
GetSellerTransactions
DetailLevel: ReturnAll, none
Conditionally
Indicates the date the specified user originally registered with eBay.
<br><br>
Since a bidder's user info is anonymous, this tag will be returned only to that bidder,
and to the seller of an item that the user is bidding on.
https://developer.ebay.com/DevZone/guides/features-guide/default.html#Development/CRM-UserInformation.html#WorkingwithAnonymousUserInformation
Working with Anonymous User Information
GetBestOffers
DetailLevel: none, ReturnAll
Always
GetAllBidders
GetBidderList
Always
GetUser
DetailLevel: none, ReturnSummary, ReturnAll
Conditionally
GetItem
GetSellingManagerTemplates
Always
Seller
HighBidder
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
GetOrderTransactions
DetailLevel: ReturnAll
Conditionally
GetSellerList
HighBidder
DetailLevel: ItemReturnDescription, ReturnAll
GranularityLevel: Fine
Conditionally
GetSellerList
Seller
DetailLevel: none, ItemReturnDescription, ReturnAll
GranularityLevel: Fine
Always
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ReturnAll
Always
Seller
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ReturnAll
Conditionally
Buyer
eBay site the user is registered with.
<br><br>
Since a bidder's user info is anonymous, this tag will be returned only to
that bidder, and to the seller of an item that the user is bidding on.
https://developer.ebay.com/DevZone/guides/features-guide/default.html#Development/CRM-UserInformation.html#WorkingwithAnonymousUserInformation
Working with Anonymous User Information
GetAllBidders
GetBidderList
Always
GetUser
DetailLevel: none, ReturnSummary, ReturnAll
Conditionally
GetItem
GetSellingManagerTemplates
Always
Seller
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
GetOrderTransactions
DetailLevel: ReturnAll
Conditionally
GetSellerList
HighBidder
DetailLevel: ItemReturnDescription, ReturnAll
GranularityLevel: Fine
Conditionally
GetItem
GetSellingManagerTemplates
Conditionally
HighBidder
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
GetSellerList
Seller
DetailLevel: none, ItemReturnDescription, ReturnAll
GranularityLevel: Fine
Always
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ReturnAll
Always
Seller
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ReturnAll
Conditionally
Buyer
Indicates the user's registration/user status.
GetAllBidders
GetBidderList
Always
GetUser
DetailLevel: none, ReturnSummary, ReturnAll
Conditionally
GetItem
GetSellingManagerTemplates
Seller
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Always
GetItem
GetSellingManagerTemplates
HighBidder
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally
GetOrderTransactions
DetailLevel: ReturnAll
Conditionally
GetSellerList
HighBidder
DetailLevel: ItemReturnDescription, ReturnAll
GranularityLevel: Fine
Conditionally
GetSellerList
Seller
DetailLevel: none, ItemReturnDescription,
ReturnAll
GranularityLevel: Fine
Always
GetItemTransactions
GetSellerTransactions
Seller
DetailLevel: none, ReturnAll
Always
GetItemTransactions
GetSellerTransactions
Buyer
DetailLevel: none, ReturnAll
Conditionally
Unique eBay user ID for the user.<br>
<br>
Since a bidder's user info is anonymous, this tag contains the actual
value of an ID only for that bidder, and for the seller of an item that the user is
bidding on. For other users, the actual value is replaced by an
anonymous value, according to these rules:
<br><br>
When bidding on items, <b>UserID</b> is replaced with the
value "a****b" where a and b are random characters from the <b>UserID</b>. For
example, if the <b>UserID</b> = <code>IBidALot</code>, it might be displayed as, "I****A".
<br/><br/>
<span class="tablenote"><b>Important: </b>
In this format, the anonymous bidder ID can change for each
auction.
</span>
For <b>GetMyeBayBuying</b> only, when bidding on items: <b>UserID</b>
is replaced with the value "a****b" where a and b are random characters from
the <b>UserID</b>.
<br><br>
When bidding on items listed on the Philippines site: <b>UserID</b> is replaced
with the value "Bidder X" where X is a number indicating the order of that
user's first bid. For example, if the user was the third bidder,
<b>UserID</b> = <code>Bidder 3</code>.
Note that in this Philippines site format, the anonymous bidder ID stays the same for a given
auction, but is different for different auctions. For example, a bidder who
is the third and then the seventh bidder in an auction will be listed for
both bids as "Bidder 3". However, if that same bidder is the first bidder on
a different auction, the bidder will be listed for that auction as "Bidder
1", not "Bidder 3".
<br><br>
For <b>GetMyeBayBuying</b> only, when bidding on items listed on the UK and AU sites:
<b>UserID</b> is replaced with the string "High Bidder".
<br><br>
For <b>PlaceOffer</b>, see also <b>SellingStatus.HighBidder</b>.
https://developer.ebay.com/DevZone/guides/features-guide/default.html#Development/CRM-UserInformation.html#WorkingwithAnonymousUserInformation
Working with Anonymous User Information
PlaceOffer
Conditionally
GetAllBidders
GetBidderList
Conditionally
GetBestOffers
DetailLevel: none, ReturnAll
Conditionally
GetUser
DetailLevel: none, ReturnSummary, ReturnAll
Conditionally
GetItem
GetSellingManagerTemplates
Always
Seller
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
GetOrderTransactions
DetailLevel: ReturnAll
Conditionally
GetSellerList
HighBidder
DetailLevel: ItemReturnDescription, ReturnAll
GranularityLevel: Fine
Conditionally
GetItem
GetSellingManagerTemplates
Conditionally
HighBidder
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
GetItemsAwaitingFeedback
Conditionally
Buyer
GetMyeBayBuying
DetailLevel: none, ReturnAll
Conditionally
GetMyeBaySelling
ActiveList
SoldList
BidList
DeletedFromSoldList
DetailLevel: none, ReturnAll
Conditionally
GetSellerList
Seller
DetailLevel: none, ItemReturnDescription, ReturnAll
GranularityLevel: Fine
Always
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ReturnAll
Always
Seller
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ReturnAll
Conditionally
Buyer
GetSellerEvents
DetailLevel: ReturnAll
Conditionally
If <code>true</code>, identifies a user whose ID has changed within the last 30 days. Does not
indicate a new user (see <b>NewUser</b>).
<br><br>
Since a bidder's user info is anonymous, this tag will be returned only to that bidder,
and to the seller of an item that the user is bidding on.
https://developer.ebay.com/DevZone/guides/features-guide/default.html#Development/CRM-UserInformation.html#WorkingwithAnonymousUserInformation
Working with Anonymous User Information
GetAllBidders
GetBidderList
Always
GetUser
DetailLevel: none, ReturnSummary, ReturnAll
Conditionally
GetItem
GetSellingManagerTemplates
Always
Seller
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
GetOrderTransactions
DetailLevel: ReturnAll
Conditionally
GetSellerList
HighBidder
DetailLevel: ItemReturnDescription, ReturnAll
GranularityLevel: Fine
Conditionally
GetItem
GetSellingManagerTemplates
Conditionally
HighBidder
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
GetSellerList
Seller
DetailLevel: none, ItemReturnDescription, ReturnAll
GranularityLevel: Fine
Always
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ReturnAll
Always
Seller
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ReturnAll
Conditionally
Buyer
Date and time the user's data was last changed (in GMT).
<br><br>
Since a bidder's user info is anonymous, this tag will be returned only to that bidder,
and to the seller of an item that the user is bidding on.
https://developer.ebay.com/DevZone/guides/features-guide/default.html#Development/CRM-UserInformation.html#WorkingwithAnonymousUserInformation
Working with Anonymous User Information
GetAllBidders
GetBidderList
Always
GetUser
DetailLevel: none, ReturnSummary, ReturnAll
Conditionally
GetItem
GetSellingManagerTemplates
Always
Seller
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
GetOrderTransactions
DetailLevel: ReturnAll
Conditionally
GetSellerList
HighBidder
DetailLevel: ItemReturnDescription, ReturnAll
GranularityLevel: Fine
Conditionally
GetItem
GetSellingManagerTemplates
Conditionally
HighBidder
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
GetSellerList
Seller
DetailLevel: none, ItemReturnDescription, ReturnAll
GranularityLevel: Fine
Always
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ReturnAll
Always
Seller
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ReturnAll
Conditionally
Buyer
Indicates whether or not the user is subject to VAT.
Users who have registered with eBay as VAT-exempt are not
subject to VAT. See documentation on Value-Added Tax (VAT).
VATStatus
https://developer.ebay.com/DevZone/guides/features-guide/default.html#Development/Sites-IntlDiffsVATB2B.html#VATexemptSellers
GetAllBidders
GetBidderList
Always
GetUser
DetailLevel: none, ReturnSummary, ReturnAll
Conditionally
GetItem
GetSellingManagerTemplates
Always
Seller
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
GetOrderTransactions
DetailLevel: ReturnAll
Conditionally
GetSellerList
HighBidder
DetailLevel: ItemReturnDescription, ReturnAll
GranularityLevel: Fine
Conditionally
GetItem
GetSellingManagerTemplates
Conditionally
HighBidder
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
GetSellerList
Seller
DetailLevel: none, ItemReturnDescription, ReturnAll
GranularityLevel: Fine
Always
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ReturnAll
Always
Seller
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ReturnAll
Conditionally
Buyer
Contains information about the user as a buyer, such as
the shipping address. See <b>BuyerType</b> for its child elements.
<br><br>
Since a bidder's user info is anonymous, this tag will be returned only to that bidder,
and to the seller of an item that the user is bidding on.
https://developer.ebay.com/DevZone/guides/features-guide/default.html#Development/CRM-UserInformation.html#WorkingwithAnonymousUserInformation
Working with Anonymous User Information
GetAllBidders
Always
GetSellerList
HighBidder
DetailLevel: ItemReturnDescription, ReturnAll
GranularityLevel: Fine
Conditionally
GetItem
GetSellingManagerTemplates
Conditionally
HighBidder
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ReturnAll
Conditionally
Buyer
GetMyeBaySelling
SoldList
DeletedFromSoldList
DetailLevel: none, ReturnAll
Conditionally
GetOrders
DetailLevel: none, ReturnAll
Conditionally
Buyer
OrderReport
Buyer
Conditionally
Contains information about a seller, including listing settings, listing
preferences, seller rankings, and seller type.
<br><br>
This field is replaced by the <b>SellerBusinessType</b>
field if the user is a business seller with a site
ID of 77 (Germany), ID of 3 (UK), ID of 205 (Ireland) or ID of 0 (US Motors).
<br><br>
See <b>SellerType</b> or <b>SellerBusinessCodeType</b> for the child elements.
GetBidderList
Seller
Always
GetUser
DetailLevel: none, ReturnSummary, ReturnAll
Conditionally
GetItem
GetSellingManagerTemplates
Always
Seller
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
GetSellerList
Seller
DetailLevel: none, ItemReturnDescription, ReturnAll
GranularityLevel: Coarse, Medium, Fine
Always
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ReturnAll
Always
Seller
This field indicates whether the user's account is enabled for buying and selling
(indicated by <b>FullMarketPlaceParticipant</b>) on eBay, or if the account is a Partially
Provisioned Account (indicated by <b>Shopper</b>) without selling and buying privileges on
eBay.
GetUser
Always
This type is deprecated. Use instead <b>User.SellerInfo.CharityAffiliationDetail</b>.
The user's PayPal account level. Only returned for the user identified in
eBayAuthToken. That is, you cannot see someone else's PayPal account level.
Use this information to check whether a seller is eligible to list digital
downloadable items. See the eBay Web site online
help for current PayPal requirements for listing digital items.
GetUser
DetailLevel: none, ReturnSummary, ReturnAll
Conditionally
The user's PayPal account type. Only returned for the user identified in
<b>eBayAuthToken</b>. That is, you cannot see someone else's PayPal account type.
Use this information to check whether a seller is likely to be eligible to
list digital downloadable items. See the eBay Web site online help for
current PayPal requirements for listing digital items.
GetUser
DetailLevel: none, ReturnSummary, ReturnAll
Conditionally
The user's PayPal account status. Only returned for the user identified in
<b>eBayAuthToken</b>. That is, you cannot see someone else's PayPal account status.
Use this information to check whether a seller is eligible to list digital
downloadable items. See the eBay Web site online
help for current PayPal requirements for listing digital items.
GetUser
DetailLevel: none, ReturnSummary, ReturnAll
Conditionally
Specifies the subscription level for a user.
GetUser
DetailLevel: none, ReturnSummary, ReturnAll
Conditionally
This field is deprecated.
This field is deprecated.
Indicates whether a user has read-only access to the eBay Wiki (<code>true</code>)
or whether the user is able contribute or edit articles on the eBay Wiki
(<code>false</code>). By default, all registered eBay users have access to contribute and
edit articles on the eBay Wiki. All content contributed to the eBay Wiki is
subject to the Community Content Policy.
false
GetUser
DetailLevel: none, ReturnSummary, ReturnAll
Always
TUV level is a number allocated to a user based on various characteristics
such as buyer, seller, new buyer, new seller, high risk, or bid limit.
Applies to eBay Motors Pro applications only.
AU, DE, FR, IT, UK
GetUser
DetailLevel: ReturnAll
Conditionally
The value added tax identifier (<b>VATID</b>) is applicable to the VAT-enabled
sites.
Applies to eBay Motors Pro applications only.
AU, DE, FR, IT, UK
GetUser
DetailLevel: none, ReturnSummary, ReturnAll
Conditionally
This field is deprecated.
Contains information about the user as a bidder on a certain
item. Returned by <b>GetAllBidders</b> if <b>IncludeBiddingSummary</b> =
<code>true</code> is included in the request.
GetAllBidders
Conditionally
Indicates whether or not the User container has been made
anonymous. If <code>true</code>, some elements in the User container have
either been removed, or had their values changed to remove
identifying characteristics. If false, all expected elements
are returned, and no values are changed.
<br><br>
Since a bidder's user info is anonymous, this tag is returned as false
only to the bidder, and to the seller of an item that the user is bidding
on. For all other users, this tag is returned as <code>true</code>.
https://developer.ebay.com/DevZone/guides/features-guide/default.html#Development/CRM-UserInformation.html#WorkingwithAnonymousUserInformation
Working with Anonymous User Information
GetAllBidders
GetSellerEvents
Always
GetSellerList
GranularityLevel: Fine
Always
GetItem
GetSellingManagerTemplates
Always
DetailLevel: none, ItemReturnAttributes, ItemReturnDescription, ReturnAll
HighBidder
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
Total count of neutral Feedback entries received by the user, including weekly repeats.
GetUser
DetailLevel: none, ReturnSummary, ReturnAll
Conditionally
Reserved for internal or future use.
GetUser
DetailLevel: none, ReturnAll
Always
When a user has their billing option set to <code>email</code>, they can include
this element in a <b>GetUser</b> request to retrieve their own email bills.
GetUser
DetailLevel: none, ReturnSummary, ReturnAll
Conditionally
This flag indicates whether or not the user is eligible to sell items on eBay. This field is only returned if the <b>IncludeFeatureEligibility</b> flag is included in the call request and set to <code>true</code>.
GetUser
DetailLevel: none, ReturnSummary, ReturnAll
Conditionally
Contains the static email address of an eBay member, used within the "reply to"
email address when the eBay member sends a message.
(Each eBay member is assigned a static alias. The alias is
used within a static email address.)
https://developer.ebay.com/DevZone/guides/features-guide/default.html#Development/CRM-Communications.html#StaticEmailAddressesinTradingAPICalls
Static Email Addresses in Trading API Calls
GetOrderTransactions
GetOrders
DetailLevel: ReturnAll
Conditionally
OrderReport
Conditionally
GetMyeBaySelling
SoldList
DeletedFromSoldList
DetailLevel: none, ReturnAll
Conditionally
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ReturnAll
Conditionally
Buyer
Contains the shipping address of a bidder who has made a Best Offer for an item.
<br/><br/>
You cannot retrieve a shipping address for any user with whom you do not have an order relationship, regardless of site. The shipping address of another user is returned only if you and the other user are in an order relationship, within a certain time of order line item creation.
<br><br>
Because a bidder's user information is anonymous, this container is returned only to that bidder, and to the seller of an item that the user is bidding on.
GetBestOffers
DetailLevel: none, ReturnAll
Conditionally
The <strong>Membership</strong> container will be returned if the seller is enrolled in one or more membership programs on one or more eBay sites. A <b>Program</b> container will be returned for each applicable membership program, and provides details on that program, including the eBay site, the program name (such as '<code>EBAYPLUS</code>'), and the membership expiration date. This container will not be returned at all if the seller is not enrolled in any applicable membership programs.
GetUser
DetailLevel: none, ReturnAll
Conditionally
The first name of the buyer who purchased the order.
GetOrderTransactions
GetOrders
DetailLevel: none,ReturnAll
Conditionally
OrderReport
Conditionally
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ReturnAll
Conditionally
The last name of the buyer who purchased the order.
GetOrderTransactions
GetOrders
DetailLevel: none,ReturnAll
Conditionally
OrderReport
Conditionally
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ReturnAll
Conditionally
This type is used to set/display details related to VAT (Value-Added Tax) and Business Seller features.
<br>
<br>
<span class="tablenote"><b>Note:</b>
VAT is not applicable to all countries, including the US. Sellers must be registered as Business Sellers on the site they are selling on in order to use the Business Seller-related fields.
</span>
This field should be included in an Add/Revise/Relist call and set to <code>true</code> if the seller is registered on the selling site as a Business Seller. This field must be included and set to <code>true</code> if the <b>RestrictedToBusiness</b> field is also included and set to <code>true</code>. The <b>RestrictedToBusiness</b> field is used by German (Site ID 77), Austrian (Site ID 16), and Swiss (Site ID 193) sellers who wish to restrict sales of their item to other users registered as business users.
<br><br>
This field is returned in 'Get' calls only if set on the listing, and the person making the call owns the listing. However, other Business Seller-related information will be returned to all users in 'Get' calls under the <b>SellerInfo</b> and <b>BusinessSellerDetails</b> containers.
AddFixedPriceItem
AddItem
AddItems
AddSellingManagerTemplate
RelistFixedPriceItem
RelistItem
ReviseFixedPriceItem
ReviseItem
ReviseSellingManagerTemplate
VerifyAddFixedPriceItem
VerifyAddItem
VerifyRelistItem
Conditionally
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
BusinessSellerDetails
Conditionally
This field must be included in an Add/Revise/Relist call and set to <code>true</code> if a German (Site ID 77), Austrian (Site ID 16), or Swiss (Site ID 193) seller wishes to restrict sales of their item to other users registered on eBay as business users. If this field is set as <code>true</code>, the <b>BusinessSeller</b> field must also be included and set to <code>true</code>. This feature is not available on any other eBay marketplaces.
<br><br>
This field can be included and set to <code>true</code> only by Business Sellers registered on one of the three sites above, and only if the listing category supports Business-to-Business listings. The <b>GetCategories</b> call can be used by the seller (using one of the Site IDs above) to see which categories support Business-to-Business listings. A <b>B2BVATEnabled</b> boolean field will be returned as <code>true</code> if a listing category supports Business-to-Business listings.
<br><br>
This field is returned in 'Get' calls only if set on the listing, and the person making the call owns the listing. However, other Business Seller-related information will be returned to all users in 'Get' calls under the <b>SellerInfo</b> and <b>BusinessSellerDetails</b> containers.
AddFixedPriceItem
AddItem
AddItems
AddSellingManagerTemplate
RelistFixedPriceItem
RelistItem
ReviseFixedPriceItem
ReviseItem
ReviseSellingManagerTemplate
VerifyAddFixedPriceItem
VerifyAddItem
VerifyRelistItem
No
GetBidderList
BusinessSellerDetails
Conditionally
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
BusinessSellerDetails
Conditionally
This container is used in an Add/Revise/Relist call to set the VAT (Value-added Tax) percentage rate that will be charged to buyers when an item is purchased from the listing.
<br/><br/>
VAT is not applicable to all countries, including the US. Allowed VAT percentage rates can vary by region/country, so sellers should be aware of the rates they are legally required/allowed to charge, and they are responsible for charging the correct VAT rate.
<br/><br/>
If VAT is charged on a listing, the seller can choose to print an invoice for the buyer that shows the item's net price, the VAT percentage rate, the VAT amount, and the total price.
<br/><br/>
This field is returned in 'Get' calls only if the listing is subject to VAT.
<br>
<br>
<span class="tablenote"><b>Note:</b>
The float value input into an Add/Revise/Relist call can have up to three digits beyond the decimal point (e.g. 12.346).
</span>
6
AddFixedPriceItem
AddItem
AddItems
AddSellingManagerTemplate
RelistFixedPriceItem
RelistItem
ReviseFixedPriceItem
ReviseItem
ReviseSellingManagerTemplate
VerifyAddFixedPriceItem
VerifyAddItem
VerifyRelistItem
Conditionally
GetBidderList
Item
Conditionally
GetItem
GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Item
Conditionally
This string value is the Site ID value of the eBay Marketplace where the VAT is applicable and where the seller is registered as a Business Seller.
<br/><br/>
The eBay sites that support VAT (and their corresponding Site IDs) can be found in the <a href="https://developer.ebay.com/DevZone/guides/features-guide/default.html#development/IntlDiffs-B2BFields.html" target="_blank">Business Feature Field Differences</a> topic.
GetItem
GetSellingManagerTemplates
Conditionally
BusinessSellerDetails
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
This is the unique VAT identifier associated with the Business Seller's account. This field will only be returned to Business Sellers who own the specified listing.
<br/><br/>
Non-Business Sellers will not have a VAT identifier associated with their account, so this field will never be returned for those users.
GetItem
GetSellingManagerTemplates
Conditionally
BusinessSellerDetails
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Type defining the <b>VATRateType</b> container, which is used by
<b>ReviseSellingManagerSaleRecord</b> to modify the VAT percentage for an
order line item. This container is also retrieved by
<b>GetSellingManagerSaleRecord</b> if Value-Added Tax has been applied to
the order line item.
Unique identifier for an eBay listing. A listing can have multiple
order line items (transactions), but only one <b>ItemID</b>. An <b>ItemID</b> can be
paired up with a corresponding <b>TransactionID</b> and used as an input filter for
<b>ReviseSellingManagerSaleRecord</b>. However, if <b>OrderID</b> is passed in as an input
filter for <b>ReviseSellingManagerSaleRecord</b>, the <b>ItemID</b>/<b>TransactionID</b> pair is
ignored.
GetSellingManagerSaleRecord
Conditionally
ReviseSellingManagerSaleRecord
No
Unique identifier for an eBay sales transaction. This identifier is
created once there is a commitment from a buyer to purchase an item.
Along with its corresponding <b>ItemID</b>, a <b>TransactionID</b> is used
and referenced during an order checkout flow and after checkout has been
completed. The <b>ItemID</b>/<b>TransactionID</b> pair can be used as an input filter for
<b>ReviseSellingManagerSaleRecord</b>. However, if <b>OrderID</b> is passed in as an input
filter for <b>ReviseSellingManagerSaleRecord</b>, the <b>ItemID</b>/<b>TransactionID</b> pair is
ignored.
GetSellingManagerSaleRecord
Conditionally
ReviseSellingManagerSaleRecord
No
The VAT (Value-Added Tax) rate for the order line item. When the <b>VATPercent</b> is specified, the
item's VAT information appears on the item's listing page. In
addition, the seller can choose to print an invoice that
includes the item's net price, VAT percent, VAT amount, and
total price. Since VAT rates vary
depending on the item and on the user's country of residence, a
seller is responsible for entering the correct VAT rate; it is
not calculated by eBay. To specify a <b>VATPercent</b>, a seller must
have a VAT-ID registered with eBay and must be listing the item on a
VAT-enabled site. Max applicable length is 6 characters,
including the decimal (e.g., 12.345). The scale is 3 decimal places.
(If you pass in 12.3456, eBay may round up the value to 12.346.)
Note: The View Item page may display the precision to 2 decimal places
with no trailing zeros. However, the full value you send in is stored.
6
0
30
GetSellingManagerSaleRecord
Conditionally
ReviseSellingManagerSaleRecord
No
<b>OrderLineItemID</b> is a unique identifier for an eBay order line item If a VAT rate is specified in the
<b>ReviseSellingManagerSaleRecord</b> request, <b>OrderLineItemID</b> can be used instead
of <b>ItemID</b> and <b>TransactionID</b>.
50 (Note: The eBay database specifies 38. ItemIDs and TransactionIDs are usually 9 to 12 digits.)
GetSellingManagerSaleRecord
Conditionally
ReviseSellingManagerSaleRecord
No
Indicates whether or not the user is subject to VAT.
Users who have registered with eBay as VAT-exempt are not
subject to VAT. See documentation on Value-Added Tax (VAT).
(out) VAT is not applicable
(out) Residence in a country with VAT and user is not registered as VAT-exempt
(out) Residence in a country with VAT and user is registered as VAT-exempt
(out) Reserved for internal or future use
If present, the site defines category settings for when the seller
can provide a Vehicle Identification Number (VIN) for
US, CA, and CAFR eBay Motors sites. VIN is required for cars and trucks
from model year 1981 and later. (The US developed national standards for VIN
values as of 1981.)
If present, the site defines category settings for whether the seller
can provide a Vehicle Registration Mark (VRM) for a
UK eBay Motors vehicle listing.
This type is only applicable for Half.com listings, and since the Half.com site has been shut down, this type is no longer applicable.
<span class="tablenote"><b>Note: </b> <b>ValType</b> and all of its fields are no longer applicable since the Half.com site has been shut down.
</span>
For Half.com, use <b>AttributeArray.Attribute.Value.ValueLiteral</b>
in listing requests.
<br/><br/>
<b>AttributeArray.Attribute.Value.ValueLiteral</b> is required when
you use <b>AddItem</b>. For the Half.com Notes attribute, the max
length is 500 characters. You can revise
<b>AttributeArray.Attribute.Value.ValueLiteral</b> for Half.com
listings.
1027
NoOp
1033
<span class="tablenote"><b>Note: </b> <b>ValType</b> and all of its fields are no longer applicable since the Half.com site has been shut down.
</span>
1027
NoOp
1033
<span class="tablenote"><b>Note: </b> <b>ValType</b> and all of its fields are no longer applicable since the Half.com site has been shut down.
1027
NoOp
1033
Defines the value category feature. If a field of this type is present,
the corresponding feature applies to the site. The field is returned as
an empty element (e.g., a boolean value is not returned).
GetCategoryFeatures
DetailLevel: none, ReturnSummary, ReturnAll
Conditionally
Enumerated type that defines the date format that is used for a date-related field that is returned in the <b>GetCategorySpecifics</b> call.
on which are enforceable for validation purposes
This enumeration value indicates that a full date is used, including the month, day, and year in the following format:
'<em>YYYYMMDD</em>'
This enumeration value indicates that a partial date is used, including the month and year in the following format: '<em>YYYYMM</em>'
This enumeration value indicates that only the year is returned in the following format: '<em>YYYY</em>'
Reserved for future or internal use.
Defines the Value Pack feature (a feature pack). If the field is present, the corresponding feature applies to the category. The field is returned as an empty element (i.e., a boolean value is not returned).
Type used by the <b>ValueRecommendation</b> container to provide recommended names for recommended item specifics.
A recommended value for the corresponding, recommended Item Specific. Only returned when a recommended value is available.
GetCategorySpecifics
Conditionally
Constraints that eBay places on this Item Specific value.<br>
<br>
Only returned when you configure your request to include
relationships and/or confidence, and a recommended value
is available.
(Not returned when <b>ExcludeRelationships</b> is <code>true</code> and
<b>IncludeConfidence</b> is <code>false</code>.)
GetCategorySpecifics
Conditionally
This enumeration type is used by multiple Trading API calls, including <b>GetCategorySpecifics</b> call and order management calls (like <b>GetOrders</b>).
<br/><br/>
The values used by <b>GetCategorySpecifics</b> is the data type of the recommended Item Specific called out in the <b>NameRecommendation.Name</b> field.
<br/><br/>
The values used by <b>GetOrders</b> (and other order management calls) is the type of tax ID used in the <strong>BuyerTaxIdentifier</strong> container.
This value indicates that the recommended Item Specific should have numeric values with a decimal point, like 3.14159. Item Specific values cannot be expressed as float or double types.
This value indicates that the recommended Item Specific should have integer values (no decimal point), like 3. Item Specific values cannot be expressed as float or double types.
This value indicates that the value(s) of the recommended Item Specific should be free-form text. This is the default value. The maximum length of a text-based Item Specific is general 65 characters, but instance aspects (like 'Bundle Description' or 'California Prop 65 Warning') are allowed longer lengths.
This value indicates that the recommended Item Specific is an International Standard Book Number (ISBN) value. ISBNs can contain either 10 or 13 characters.
This value indicates that the recommended Item Specific is a Universal Product Code (UPC) value. UPCs contain 12 characters.
This value indicates that the recommended Item Specific is a European Article Number (EAN). EANs contain 13 characters.
This value indicates that the value(s) of the recommended Item Specific is a date value, which will should use the date format specified in the <b>ValueFormat</b> field.
This value indicates that the tax ID in the <b>ID</b> field is a Codice Fiscale ID, which is an identifier used by the Italian government to identify taxpayers in Italy.
This value indicates that the tax ID in the <b>ID</b> field is a Spanish National Identity Number, which is one identifier used by the Spanish government to identify taxpayers in Spain. In Spanish, this ID is known as the 'Documento nacional de identidad'. The other tax identifier for Spanish residents is the NIE number, or 'Numero de Identidad de Extranjero'.
This value indicates that the tax ID in the <b>ID</b> field is a Russian Passport number.
This value indicates that the tax ID in the <b>ID</b> field is a Tax Registration Number, which is an identifier used by the Brazilian government to identify taxpayers in Brazil. In Portuguese, this ID is known as the 'Cadastro de Pessoas Fisicas', or 'CPF'.
This value indicates that the tax ID in the <b>ID</b> field is a Turkish Identification Number, which is an identifier used by the Turkish government to identify taxpayers in Turkey. In Turkish, this ID is known as the 'Turkiye Cumhuriyeti Kimlik Numarasi', often abbreviated as T.C. Kimlik No.
This value indicates that the tax ID in the <b>ID</b> field is a NIE Number, which is one identifier used by the Spanish government to identify taxpayers in Spain. 'NIE' stands for 'Numero de Identidad de Extranjero'. The other tax identifier for Spanish residents is the DNI number, or 'Documento nacional de identidad'. Spanish residents can also be identified by their Spanish VAT (Value-Added Tax) number, which is also called the 'Numero de Identificacion Fiscal' or NIF.
This value indicates that the ID in the <b>ID</b> field is an NIF Number, which is also known as their Spanish VAT (Value-Added Tax) number. 'NIF' stands for 'Numero de Identificacion Fiscal'. Spanish residents can also be identified by their DNI ('Documento nacional de identidad') number or their NIE ('Numero de Identidad de Extranjero') number.
This value indicates that the tax ID in the <b>ID</b> field is a Cedula number, which is an identifier used by the Chilean, Columbian, and Dominican Republic governments to identify taxpayers in those countries. This ID is sometimes referred to as a 'Cedula de Identidad'.
This value indicates that the tax ID in the <b>ID</b> field is a NIT number, which is an identifier used by the Guatemalan government to identify taxpayers in Guatemala. In Spanish, this ID is known as the 'Numero de identificacion tributaria'.
This value indicates that the identifier in the <b>ID</b> field is a driver's license number.
This value indicates that the tax ID in the <b>ID</b> field is a CNPJ number, which is an identifier used by the Brazilian government to identify taxpayers in Brazil. In Portuguese, this ID is known as the 'Cadastro Nacional da Pessoa Juridica'.
Reserved for future use.
Type defining the <b>VariationDetails</b> container that is returned in
<b>GeteBayDetails</b> if <b>VariationDetails</b> is included
in the request as a <b>DetailName</b> filter, or if <b>GeteBayDetails</b>
is called with no <b>DetailName</b> filters.
This value indicates the maximum number of item variations that the site will allow within one multi-variation listing.
GeteBayDetails
Conditionally
This value indicates the maximum number of variation specific sets that the site will allow per listing. Typical variation specific sets for clothing may be 'Color', 'Size', 'Long Sleeve', etc.
GeteBayDetails
Conditionally
This value indicates the maximum number of values that the site will allow within one variation specific set. For example, if the variation specific set was 'Color', the seller could specify as many colors that are available up to this maximum value.
GeteBayDetails
Conditionally
Returns the latest version number for this field. The version can be
used to determine if and when to refresh cached client data.
GeteBayDetails
Always
Gives the time in GMT that the feature flags for the details were last
updated. This timestamp can be used to determine if and when to refresh
cached client data.
GeteBayDetails
Always
Type used by the <b>VariationKey</b> container to identify one or more item variations to either add or remove from an eBay user's Watch List.
The unique identifier of the fixed-price listing whose variation(s) should be added to or removed from the watch list.
AddToWatchList
RemoveFromWatchList
Conditionally
This container is used to identify one or more item variations within the multiple-variation listing. If the specified name-value pairs do not match any item variation, the call behaves as if no variations were specified.
AddToWatchList
RemoveFromWatchList
Conditionally
Enumerated type that indicates if a specific Item Specific can be used to classify pictures in a multiple-variation listing. For example, in a multiple-variation listing that featured t-shirts of numerous colors and sizes, the 'Color' Item Specific would most likely be 'Enabled', and would be a good candidate value for the <b>Variations.Pictures.VariationSpecificName</b> field in a 'FixedPriceItem' call when creating, revising, or relisting an item. Then, the seller would provide URLs to multiple pictures showcasing the available colors of the shirts. These URLs are specified through multiple <b>Variations.Pictures.VariationSpecificPictureSet.PictureURL</b> fields.
This value indicates that the corresponding Item Specific name must be used in the <b>Variations.Pictures.VariationSpecificName</b> field if the seller is providing picture URLs through the <b>Variations.Pictures.VariationSpecificPictureSet</b> container in a 'FixedPriceItem' call when creating, revising, or relisting an item.
This value indicates that the corresponding Item Specific name can be used in the <b>Variations.Pictures.VariationSpecificName</b> field if the seller is providing picture URLs through the <b>Variations.Pictures.VariationSpecificPictureSet</b> container in a 'FixedPriceItem' call when creating, revising, or relisting an item. Unlike the 'Required' value, 'Enabled' indicates that corresponding Item Specific name is just one option, and they may be other options to use as a <b>VariationSpecificName</b> value.
This value indicates that the corresponding Item Specific name cannot be used in the <b>Variations.Pictures.VariationSpecificName</b> field if the seller is providing picture URLs through the <b>Variations.Pictures.VariationSpecificPictureSet</b> container in a 'FixedPriceItem' call when creating, revising, or relisting an item. The seller will have to find an Item Specific that is either 'Enabled' or 'Required' to use as a <b>VariationSpecificName</b> value.
Reserved for future use.
This type defines the <b>VariationProductListingDetails</b> container that is used to specify an EAN, an ISBN, a UPC value, or an ePID to identify a specific product variation in a multiple-variation listing. For multiple-variation listings, the same GTIN type(s) must be used for all product variations within the listing. For instance, if one product variation uses ISBNs, all product variations must use ISBN values.
<br/><br/>
<span class="tablenote"><b>Note: </b>
The <b>ProductReferenceID</b> field can only be used when listing in categories that are enabled with the Product-Based Shopping Experience. If this field is provided when listing in a category that doesn't support PBSE, the listing will be blocked.
</span>
This field is used if the seller wants to, or is required to identify each product variation within a multi-variation listing by an ISBN (International Standard Book Number) value. An ISBN is a unique identifer for books. Both 10 and 13-character ISBNs are supported. When specifying a 13-character ISBN, the value must begin with either '978' or '979'. The seller can use the <b>GetCategoryFeatures</b> or <b>GetCategorySpecifics</b> calls to see if an ISBN is supported/required for a category.
<br/><br/>
This field is only applicable for multiple-variation listings. For a single-variation listing, if the category/product requires an ISBN value, this value should be passed into the <b>Item.ProductListingDetails.ISBN</b> field instead. Unlike single-variation listings, an eBay catalog product cannot be used to prefill product details for a multiple-variation listing.
<br/><br/>
<span class="tablenote"><b>Note: </b>
If the listing is being posted to a category that expects ISBN values, but one doesn't exist for the product, the seller must pass in the text that can be found in the <b>ProductDetails.ProductIdentifierUnavailableText</b> field of the <b>GeteBayDetails</b> response. To get the <b>ProductDetails</b> container to return in the <b>GeteBayDetails</b> response, <code>ProductDetails</code> should be included as a <b>DetailName</b> value in the call request.
</span>
AddFixedPriceItem
AddSellingManagerTemplate
RelistFixedPriceItem
ReviseFixedPriceItem
ReviseSellingManagerTemplate
AddSellingManagerProduct
ReviseSellingManagerProduct
Conditionally
GetItem
GetSellingManagerTemplates
Conditionally
DetailLevel: none, ItemReturnDescription,
ItemReturnAttributes, ReturnAll
GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
Conditionally
GetSellerEvents
Conditionally
DetailLevel: none, ReturnAll
This field is used if the seller wants to, or is required to identify each product variation within a multiple-variation listing by a UPC (Universal Product Code) value. A UPC is a commonly-used identifier for many different products. The seller can use the <b>GetCategoryFeatures</b> or <b>GetCategorySpecifics</b> calls to see if a UPC is supported/required for a category.
<br/><br/>
This field is only applicable for multiple-variation listings. For a single-variation listing, if the category/product requires a UPC value, this value should be passed into the <b>Item.ProductListingDetails.UPC</b> field instead. Unlike single-variation listings, an eBay catalog product cannot be used to prefill product details for a multiple-variation listing.
<br/><br/>
<span class="tablenote"><b>Note: </b>
If the listing is being posted to a category that expects UPC values, but one doesn't exist for the product, the seller must pass in the text that can be found in the <b>ProductDetails.ProductIdentifierUnavailableText</b> field of the <b>GeteBayDetails</b> response. To get the <b>ProductDetails</b> container to return in the <b>GeteBayDetails</b> response, <code>ProductDetails</code> should be included as a <b>DetailName</b> value in the call request.
</span>
AddFixedPriceItem
AddSellingManagerTemplate
RelistFixedPriceItem
ReviseFixedPriceItem
ReviseSellingManagerTemplate
AddSellingManagerProduct
ReviseSellingManagerProduct
Conditionally
GetItem
GetSellingManagerTemplates
Conditionally
DetailLevel: none, ItemReturnDescription,
ItemReturnAttributes, ReturnAll
GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
Conditionally
GetSellerEvents
Conditionally
DetailLevel: none, ReturnAll
This field is used if the seller wants to, or is required to identify each product variation within a multiple-variation listing by an EAN (European Article Number) value. An EAN is a unique 8 or 13-digit identifier that many industries (such as book publishers) use to identify products. The seller can use the <b>GetCategoryFeatures</b> or <b>GetCategorySpecifics</b> calls to see if an EAN is supported/required for a category.
<br/><br/>
This field is only applicable for multiple-variation listings. For a single-variation listing, if the category/product requires an EAN value, this value should be passed into the <b>Item.ProductListingDetails.EAN</b> field instead. Unlike single-variation listings, an eBay catalog product cannot be used to prefill product details for a multiple-variation listing.
<br/><br/>
<span class="tablenote"><b>Note: </b>
If the listing is being posted to a category that expects EAN values, but one doesn't exist for the product, the seller must pass in the text that can be found in the <b>ProductDetails.ProductIdentifierUnavailableText</b> field of the <b>GeteBayDetails</b> response. To get the <b>ProductDetails</b> container to return in the <b>GeteBayDetails</b> response, <code>ProductDetails</code> should be included as a <b>DetailName</b> value in the call request.
</span>
AddFixedPriceItem
AddSellingManagerTemplate
RelistFixedPriceItem
ReviseFixedPriceItem
ReviseSellingManagerTemplate
AddSellingManagerProduct
ReviseSellingManagerProduct
Conditionally
GetItem
GetSellingManagerTemplates
Conditionally
DetailLevel: none, ItemReturnDescription,
ItemReturnAttributes, ReturnAll
GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
Conditionally
GetSellerEvents
Conditionally
DetailLevel: none, ReturnAll
This field is used if the seller wants to, or is required to identify each product variation within a multiple-variation listing by an eBay Product ID (ePID). An ePID is a unique identifier of an eBay Catalog product. The seller can use the <b>GetCategoryFeatures</b> or <b>GetCategorySpecifics</b> calls to see if an ePID is supported/required for a category. Each variation within the listing must use a unique ePID or an error will occur.
<br/><br/>
<span class="tablenote"><b>Note: </b>
The <b>ProductReferenceID</b> field can only be used to specify an ePID for an eBay Catalog product that is part of the Product-Based Shopping Experience mandate. If an ePID is supplied for another eBay Catalog product that is not a part of the Product-Based Shopping Experience mandate, the listing may be blocked. For more information about PBSE, see the <a href="https://developer.ebay.com/pbse/" target="_blank">Product-Based Shopping Experience</a> page.
</span>
This field is also returned in <b>GetItem</b> if the product variations within the listing are associated with eBay Catalog products.
<br>
38 (42 with "EPID")
AddFixedPriceItem
AddSellingManagerProduct
AddSellingManagerTemplate
RelistFixedPriceItem
ReviseFixedPriceItem
ReviseSellingManagerProduct
ReviseSellingManagerTemplate
VerifyAddFixedPriceItem
Conditionally
GetItem
GetSellingManagerTemplates
Conditionally
DetailLevel: none, ItemReturnDescription,
ItemReturnAttributes, ReturnAll
This container is for future use. If it used, it will be ignored.
Type defining the <b>VariationSpecificPictureSet</b> container, which is
used to specify the URL(s) where the picture(s) of the variation specific will be
hosted. If the <b>Variations.Pictures</b> container is used, at least one
<b>VariationSpecificPictureSet</b> container is required.
A value that is associated with <b>VariationSpecificName</b>. For example,
suppose this set of pictures is showing blue shirts, and some of
the variations include Color=Blue in their variation specifics.
If <b>VariationSpecificName</b> is <code>Color </code>, then <b>VariationSpecificValue</b> would be <code>Blue</code>.
AddFixedPriceItem
ReviseFixedPriceItem
RelistFixedPriceItem
VerifyAddFixedPriceItem
Conditionally
AddSellingManagerProduct
ReviseSellingManagerProduct
No
AddSellingManagerTemplate
ReviseSellingManagerTemplate
No
GetSellingManagerInventory
Conditionally
GetItem
Conditionally
DetailLevel: none, ItemReturnDescription,
ItemReturnAttributes, ReturnAll
The URL of a picture that is associated with the
<b>VariationSpecificValue</b>. A variation specific picture set can
consist of up to 12 self-hosted or eBay Picture Services (EPS) hosted pictures. eBay Picture
Services and self-hosted images can never be combined into the same variation
specific picture set. To specify more than one image, use
multiple <b>PictureURL</b> fields, passing in a distinct URL in each
of those fields. This field cannot have an empty/null value. The <b>UploadSiteHostedPictures</b> call can be used to upload pictures to EPS. Note that if pictures are externally-hosted, they must be hosted on a site that is using the 'https' protocol.
<br><br>
The image specified in the first <b>PictureURL</b> field is also used as the thumbnail image for applicable variations. For example, if the picture set contains pictures of red
shirts (i.e., VariationSpecificName=Color and VariationSpecificValue=Red), the
first picture is used as the thumbnail image for all the red shirt variations.
<br/><br/>
<span class="tablenote"><b>Note: </b>
All images, whether they are hosted by EPS or self-hosted, must comply with eBay picture requirements, including the requirement that all images must be at least 500 pixels on its longest side. If the image does not satisfy the 500 pixels requirement, the listing may be blocked. For more information about other requirements and tips for adding pictures to listings, see the <a href="https://www.ebay.com/help/selling/listings/adding-pictures-listings?id=4148">Adding pictures to your listings</a> help page.
</span>
You can use Item.PictureDetails to specify additional pictures.
For example, the item-level pictures could include a model wearing a
black shirt, as a typical example of the shirt style.
<br><br>
<span class="tablenote"><b>Note:</b>
If a URL contains spaces, those spaces can be replaced with <code>%20</code>. For example, <code>https://example.com/my image.jpg</code> must be submitted as <code>https://example.com/my%20image.jpg</code> to replace the space in the image file name. However, a semicolon character (;) cannot be replaced with <code>%20</code>, so a semicolon cannot be a part of the URL, as an error will occur.
</span>
Variation pictures cannot be added or removed from a fixed-price listing when the listing is scheduled to end within 12 hours or if the item variation has already had transactions.
<br/><br/>
<span class="tablenote">
<strong>Note:</strong> For some large merchants, there are no limitations on when variation pictures can be added or removed from a fixed-price listing, even when the item variation has had transactions or is set to end within 12 hours.
</span>
AddFixedPriceItem
ReviseFixedPriceItem
RelistFixedPriceItem
VerifyAddFixedPriceItem
Conditionally
AddSellingManagerProduct
ReviseSellingManagerProduct
No
AddSellingManagerTemplate
ReviseSellingManagerTemplate
No
GetSellingManagerInventory
Conditionally
GetItem
Conditionally
DetailLevel: none, ItemReturnDescription,
ItemReturnAttributes, ReturnAll
No longer used.
Returns the URL of a variation-specific picture that is hosted outside of eBay.<br>
<br>
When you list, revise, or relist a variation, use VariationSpecificPictureSet.PictureURL (not ExternalPictureURL) to specify your self-hosted picture or EPS picture.<br>
<br/>
<span class="tablenote"><b>Note: </b>
All images must comply to the <a href="http://developer.ebay.com/DevZone/guides/features-guide/default.html#development/Pictures-Intro.html">Picture Requirements</a>.
</span>
This is returned only when the seller used a self-hosted picture for the variation.
150
https://developer.ebay.com/DevZone/guides/features-guide/default.html#Development/Pictures-InListing.html#UsingaSelfHostedPicture
Using a Self-Hosted Picture
GetItem
GetItems
Conditionally
outputSelector: Variations
Returns the URLs of the seller's self-hosted (hosted outside of eBay) variation specific pictures and the URL for the corresponding eBay Picture Services (EPS), that was generated when the picture was uploaded.
GetItem
Conditionally
This enumerated type is used to indicate if an Item Specific can be used at the variation level of a listing. This type is only applicable to categories that support multiple-variation listings. If an Item Specific cannot be used at the variation level, it usually indicates that the particular Item Specific should only be specified at the listing-level, as it is a product aspect that should be shared by all variations in the multiple-variation listing.
This value indicates that the corresponding Item Specific can be specified at the variation level. In the <b>AddFixedPriceItem</b> call, variation-specific name-value pairs are specified under the <b>Variation.VariationSpecifics.NameValueList</b> container.
This value indicates that the corresponding Item Specific cannot be specified at the variation level. If an Item Specific cannot be used at the variation level, it usually indicates that the particular Item Specific should only be specified at the listing-level, as it is a product aspect that should be shared by all variations in the multiple-variation listing.
Reserved for future use.
This type is used by the <b>Variation</b> container, which provides full details on each item variation in a multiple-variation listing.
A SKU (stock keeping unit) is a seller-defined identifier. It is only intended for the seller's use (not for buyers). A SKU value is not required, but many large sellers like to add SKU value to their listings. If defined on a listing, a SKU value can be used by sellers to reconcile their eBay inventory with your own inventory system, instead of using the <b>VariationSpecifics</b> identifying values.
<br>
<br>
If specified, all SKU values must be unique within the <b>Variations</b>
node. That is, no two variations within the same listing can have
the same SKU. <br>
<br>
If you include the <b>Item.InventoryTrackingMethod</b> field in an 'FixedPriceItem' call and set its value to <code>SKU</code>,
the <b>Variation.SKU</b> values become required for each variation..<br>
<br>
<b>For GetItem, GetOrders and other 'Get' calls:</b> Only returned if the
seller specified a SKU for the variation.
80
Setting a SKU to Uniquely Identify the Variation
https://developer.ebay.com/DevZone/guides/features-guide/default.html#Development/Variations-Configuring.html#SettingaSKUtoUniquelyIdentifytheVariatio
AddFixedPriceItem
ReviseFixedPriceItem
RelistFixedPriceItem
VerifyAddFixedPriceItem
Conditionally
AddSellingManagerProduct
ReviseSellingManagerProduct
No
AddSellingManagerTemplate
ReviseSellingManagerTemplate
No
GetSellingManagerInventory
Conditionally
GetItem
Conditionally
DetailLevel: none, ItemReturnDescription,
ItemReturnAttributes, ReturnAll
GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
Conditionally
GetItemTransactions
GetSellerTransactions
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetOrders
DetailLevel: none, ReturnAll
Conditionally
OrderReport
Conditionally
GetMyeBaySelling
ActiveList
DeletedFromSoldList
DeletedFromUnsoldList
ScheduledList
SoldList
UnsoldList
DetailLevel: none, ReturnAll
Conditionally
GetSellerEvents
DetailLevel: none, ReturnAll
Conditionally
The fixed price for this item variation.
For example, a "Blue, Large" variation price could be USD 10.00,
and a "Black, Medium" variation price could be USD 5.00.<br>
<br>
Each variation requires this field, and the prices can be the same for all variations, or
be different for each variation. This enables sellers to
provide discounts on certain
variations without affecting the price of others.
Required (and always returned) for listings with variations.<br>
<br>
You can revise a variation's price at any time (even if it
has purchases). When you modify a variation during revise or
relist, you need to include both its <b>StartPrice</b> and <b>Quantity</b>.
Setting the Variation Price
https://developer.ebay.com/DevZone/guides/features-guide/default.html#Development/Variations-Configuring.html#SettingtheVariationPrice
AddFixedPriceItem
ReviseFixedPriceItem
RelistFixedPriceItem
VerifyAddFixedPriceItem
Conditionally
AddSellingManagerProduct
ReviseSellingManagerProduct
No
AddSellingManagerTemplate
ReviseSellingManagerTemplate
No
GetSellingManagerInventory
Conditionally
GetItem
Conditionally
DetailLevel: none, ItemReturnDescription,
ItemReturnAttributes, ReturnAll
GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
Conditionally
GetSellerEvents
DetailLevel: none, ReturnAll
Conditionally
GetItemTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Variations.Variation
Conditionally
GetMyeBaySelling
ActiveList
DeletedFromSoldList
DeletedFromUnsoldList
ScheduledList
SoldList
UnsoldList
DetailLevel: none, ReturnAll
Conditionally
This value indicates the quantity of the specific variation that are
available for purchase. If you set <b>Variation.Quantity</b> to <code>0</code> when
you create, revise, or relist an item listing, the variation is dropped from
the listing. To prevent this, you can set
<a href="http://developer.ebay.com/DevZone/XML/docs/Reference/ebay/SetUserPreferences.html#Request.OutOfStockControlPreference">SetUserPreferences.OutOfStockControlPreference</a> to <code>true</code>.
<br/><br/>
For <b>GetItem</b> (and other related calls that retrieve the Item
object), the <b>Variation.Quantity</b> value indicates the total quantity associated with the variation, including the quantity available and the
quantity sold. To calculate the quantity available for sale, subtract
<b>SellingStatus.QuantitySold</b> from this value.<br>
<br>
<b>For RelistFixedPriceItem:</b>
<ul>
<li>For an item variation that had an available quantity greater than <code>0</code> when the listing ended, the <b>Quantity</b> value of the item variation for the newly relisted item is set to the actual quantity available. For item variations, there is actually no <b>QuantityAvailable</b> field, but this value may be derived if you look at the corresponding item variation in a <b>GetMyeBaySelling</b>) response and subtract the <b>Variation.QuantitySold</b> value from the <b>Variation.Quantity</b> value, which represents the original <b>Variation.Quantity</b> value at creation time of the previous listing. </li>
<li>For item variations with an available quantity of <code>0</code> when the listing ended, the relisted item will retain the <b>Variaton.Quantity</b> value that was passed in at creation time of the previous listing. </li>
</ul>
So, if you are relisting an item that had one or more item variations with an available quantity of <code>0</code> when the listing ended, we strongly recommend that you pass in the correct available quantity through the corresponding <b>Variation.Quantity</b> field of a relist call. Alternatively, you can update the correct quantity available by using a <b>ReviseInventoryStatus</b> call and passing in a <b>Quantity</b> value, while also making sure to pass in the correct <b>SKU</b> value(s) to identify the correct item variation. A <b>ReviseInventoryStatus</b> call can be used to revise the quantity of up to four single item listings and/or item variations (from the same or different listings).
<br> <br>
<b>For ReviseFixedPriceItem:</b>
You can revise a variation's quantity at any time, even if
it has purchases. However, unless you set the <a href="http://developer.ebay.com/DevZone/XML/docs/Reference/ebay/SetUserPreferences.html#Request.OutOfStockControlPreference">OutOfStockControlPreference</a> boolean field of the <b>SetUserPreferences</b> call to <code>true</code>, at least one variation must remain
with a non-zero quantity in order for the listing to remain active. If you set the <b>OutOfStockControlPreference</b> field to <code>true</code>, a multiple-variation listing will remain active but hidden from search even if the quantity of all variations in the listing is set to <code>0</code>.
When you modify a variation during revise or
relist, you need to include both its <b>StartPrice</b> and <b>Quantity</b>.
If you revise the <b>Quantity</b> value for a variation after items have
already sold, specify the quantity available for sale.
(eBay will automatically add the
quantity sold to the value you specify.) If you set the quantity to
<code>0</code> and the variation has no purchases, the variation may be
dropped from the listing.
<br> <br>
<b>For GetSellerTransactions:</b> See <b>Item.Quantity</b> instead.<br>
<br>
See the <a href="http://developer.ebay.com/Devzone/guides/features-guide/default.html#development/Variations-Updating.html">eBay Features Guide</a>
for more details about setting and modifying a variation's quantity.
<br><br>
<span class="tablenote"><b>Note:</b>
The number in the <b>Variation.Quantity</b> field represents the current quantity of the item variation that is available using the "Ship to home" fulfillment method. This number does not take into account any quantity of the item variation that is available through "local" fulfillment methods such as In-Store Pickup or Click and Collect. This is due to the fact that there is no current implementation (or API field) where the seller informs eBay about the quantity of item variations available through each local fulfillment method. In the case where a listing is only offering the item variations through a local fulfillment method, this value should default to <code>0</code>, and the <b>Item.IgnoreQuantity</b> will also be returned as <code>True</code>.
</span>
<br>
Setting and Modifying a Variation's Quantity
https://developer.ebay.com/DevZone/guides/features-guide/default.html#Development/Variations-Configuring.html#SettingandModifyingaVariationsQuantity
Using the Out-of-Stock Feature for more details
../../../../../guides/features-guide/default.html#development/Listings-UseOutOfStock.html
AddFixedPriceItem
ReviseFixedPriceItem
RelistFixedPriceItem
VerifyAddFixedPriceItem
0
Yes
AddSellingManagerProduct
ReviseSellingManagerProduct
No
AddSellingManagerTemplate
ReviseSellingManagerTemplate
No
GetSellingManagerInventory
Conditionally
GetItem
Conditionally
0
DetailLevel: none, ItemReturnDescription,
ItemReturnAttributes, ReturnAll
GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
Conditionally
GetMyeBaySelling
ActiveList
DeletedFromSoldList
DeletedFromUnsoldList
ScheduledList
SoldList
UnsoldList
DetailLevel: none, ReturnAll
Conditionally
GetSellerEvents
DetailLevel: none, ReturnAll
Conditionally
GetItemTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Variations.Variation
Conditionally
A list of name/value pairs that uniquely identify the variation within
the listing. All variations must specify the same set of Item Specific names, but
each variation must provide a unique combination of values for those
Item Specific names. For example, if the items vary by color and size, then every
variation must specify 'Color' and 'Size' as Item Specific names, but no two
variations can specify the same combination of 'Color' and 'Size' values.<br>
<br>
When you revise a listing that includes variations, you can
change names of <b>Variationpecifics</b> by using the <b>Variations.ModifyNameList</b> container. You can also add, delete, or replace individual variations as needed to match your
current inventory. Use the <b>Variation.Delete</b> field to delete a variation that has no sales (order line items). If the variation has
sales, then set the Quantity to 0.<br>
<br>
<b>For GetSellerEvents</b> To keep the <b>GetSellerEvents</b>
response smaller, <b>Variationpecifics</b> are not returned if the
variation has a SKU. If the variation has no SKU, then
<b>Variationpecifics</b> are returned instead. Optionally, you can pass
<b>IncludeVariationSpecifics</b> as <code>true</code> in the request to force
<b>Variationpecifics</b> to be returned, even when the SKU is returned.
2
5
Configuring Variation Specifics
https://developer.ebay.com/DevZone/guides/features-guide/default.html#Development/Variations-Configuring.html#ConfiguringVariationSelectionWidgetsforB
Revising and Relisting with Variations
https://developer.ebay.com/DevZone/guides/features-guide/default.html#Development/Variations-Updating.html
AddFixedPriceItem
ReviseFixedPriceItem
RelistFixedPriceItem
VerifyAddFixedPriceItem
Conditionally
AddSellingManagerProduct
ReviseSellingManagerProduct
No
AddSellingManagerTemplate
ReviseSellingManagerTemplate
No
GetSellingManagerInventory
Conditionally
GetItem
Conditionally
DetailLevel: none, ItemReturnDescription,
ItemReturnAttributes, ReturnAll
GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
Conditionally
GetItemTransactions
GetSellerTransactions
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetOrders
DetailLevel: none, ReturnAll
Conditionally
OrderReport
Conditionally
GetMyeBayBuying
LostList
WatchList
WonList
DeletedFromWonList
DeletedFromLostList
DetailLevel: none, ReturnAll
Conditionally
GetMyeBaySelling
ActiveList
DeletedFromSoldList
DeletedFromUnsoldList
ScheduledList
SoldList
UnsoldList
DetailLevel: none, ReturnAll
Conditionally
GetSellerEvents
DetailLevel: none, ReturnAll
Conditionally
Quantity of items in the seller's inventory for this
Selling Manager product.
This is not the same as the quantity available in a listed item.
Required when a Selling Manager product defines variations.
AddSellingManagerProduct
ReviseSellingManagerProduct
No
Cost of the Selling Manager product that matches this variation.
AddSellingManagerProduct
ReviseSellingManagerProduct
No
Contains the variation's quantity sold.
Always returned when variations are present.
GetItem
Conditionally
GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
Conditionally
GetMyeBaySelling
ActiveList
DeletedFromSoldList
DeletedFromUnsoldList
ScheduledList
SoldList
UnsoldList
DetailLevel: none, ReturnAll
Conditionally
GetSellerEvents
DetailLevel: none, ReturnAll
Conditionally
GetItemTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Variations.Variation
Conditionally
The title of the variation. This is a concatenation of the listing
title plus the values (no names) from <b>Variationpecifics</b>.
For example, if the Title is "Polo Shirt" and the variation is
for a medium pink shirt, the variation title could be
"Polo Shirt[Pink,M].
PayPal may also use this value
to identify item variations (for buyers and sellers).
GetSellerTransactions
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetItemTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Transaction.Variation
Conditionally
GetOrders
DetailLevel: none, ReturnAll
Conditionally
OrderReport
Conditionally
GetMyeBaySelling
ActiveList
DeletedFromSoldList
DeletedFromUnsoldList
ScheduledList
SoldList
UnsoldList
DetailLevel: none, ReturnAll
Conditionally
GetMyeBaySelling
DetailLevel: none, ReturnAll
Conditionally
URL for the variation on eBay. This links to eBay's View Item page,
with the page configured to show details of the specified variation.
The syntax of this URL is similar to Item.ViewItemURL (not optimized
for natural search).
GetSellerTransactions
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetItemTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Transaction.Variation
Conditionally
GetOrders
DetailLevel: none, ReturnAll
Conditionally
OrderReport
Conditionally
If this field is included and set to <b>true</b>, the corresponding variation is deleted from the listing with a successful call. In general,
a listing with variations must have at least one
variation with a non-zero quantity in order to remain active.
Additional deletion rules depend
on whether you are revising or relisting.<br>
<br>
<b>For ReviseFixedPriceItem only</b>:
This boolean field can now be used in a Revise call to delete a variation even if the variation still has quantity and/or has had one or more previous sales during the life of the listing. Previously, if a variation had any purchases, you could not delete the variation, but only set its quantity to zero.
<br>
<br>
To replace a varation, you can delete it and add the new
or corrected one.
However, you can't specify the same SKU twice in the
same request (because the intent would be ambiguous).
So, either use a new SKU for the newer variation,
or use the call twice (once to delete the variation, and
once to add the new variation with the same SKU).<br>
<br>
<b>For RelistFixedPriceItem only</b>:
You can delete any variation, as long as the relisted listing
includes at least 1 variation with a non-zero quantity.
(That is, when you relist, you could delete all but one variation,
or you could delete all existing variations and add a new one.)
ReviseFixedPriceItem
RelistFixedPriceItem
Conditionally
false
Container for statistics about the Selling Manager product
that is associated with this variation.
GetSellingManagerInventory
Conditionally
The number of watches placed on this variation by eBay users.
GetMyeBaySelling
ActiveList
DeletedFromSoldList
DeletedFromUnsoldList
ScheduledList
SoldList
UnsoldList
DetailLevel: none, ReturnAll
Conditionally
A note a user makes on an item with variations in My eBay.
<br>
<br>
For eBay.com, only GetMyeBaySelling (not GetItem) returns this
field, and only if you pass IncludeNotes in the request.
Only visible to the user who created the note.<br>
<br>
Not supported as input in ReviseFixedPriceItem.
Use SetUserNotes instead.<br>
<br>
In SoldList, notes for variations are only returned at the
Item level, not the variation level.
GetMyeBaySelling
ActiveList
DeletedFromUnsoldList
ScheduledList
UnsoldList
DetailLevel: none, ReturnAll
Conditionally
This container provides information for a single variation (within a multiple-variation listing) that has a Strikethrough Price (STP) or a Minimum Advertised Price (MAP) discount pricing treatment. For a multiple-variation listing, the discount pricing information should be set at the variation level and not at the item level (e.g. <b>Item.DiscountPriceInfo</b>). STP and MAP apply only to fixed-price listings. STP is available on the US, eBay Motors, UK, Germany, Canada (English and French), France, Italy, and Spain sites, while MAP is available only on the US site.
<br><br>
Discount pricing is available to qualified sellers (and their associated developers) who participate in the Discount Pricing Program. Once qualified, sellers receive a 'special account flag' (SAF) that allows them to apply Discount Pricing to both single-variation and multi-variation items. STP is intended for eBay partners and their sellers only.
<br><br>
As a seller listing Discount Price items, you are required to maintain records of your discount pricing in the event you are called upon to substantiate your item pricing.
Displaying Discount Pricing Information to Buyers
https://developer.ebay.com/DevZone/guides/features-guide/default.html#Development/Items-Retrieving.html#DisplayingDiscountPricingInformationtoBu
AddFixedPriceItem
AddItem
RelistFixedPriceItem
RelistItem
ReviseFixedPriceItem
ReviseItem
VerifyAddFixedPriceItem
VerifyAddItem
VerifyRelistItem
No
GetItem
Conditionally
DetailLevel: none, ItemReturnDescription,
ItemReturnAttributes, ReturnAll
This container is used to provide one or more product identifiers for a product variation within a multiple-variation, fixed-price listing. The same product identifier type(s) must be used for all product variations within the listing. For instance, if one product variation uses ISBNs, all product variations must use ISBN values.
<br>
<br>
<span class="tablenote"><b>Note:</b>
Currently, the <b>EAN</b>, <b>ISBN</b>, or <b>UPC</b> fields are used to specify a Global Trade Item Number (GTIN), and the <b>GetCategoryFeatures</b> call is used to see if particular product identifier types are supported/required. The <b>ProductReferenceID</b> field can only be used to specify an ePID for an eBay Catalog product that is part of the Product-Based Shopping Experience mandate. For more information about PBSE, see the <a href="https://developer.ebay.com/pbse/" target="_blank">Product-Based Shopping Experience</a> page.
</span>
<br>
When you include the <b>VariationProductListingDetails</b> container in a call, you must specify at least one GTIN or ePID. If an ePID is provided, a matching eBay catalog product must exist for the value that is passed in.
<br>
<br>
<b>For ReviseItem and RelistItem only:</b> When you revise a
listing, if it ends within 12 hours, you cannot change the
product identifier and you cannot remove existing product variation listing details data.
AddFixedPriceItem
ReviseFixedPriceItem
RelistFixedPriceItem
VerifyAddFixedPriceItem
AddSellingManagerTemplate
ReviseSellingManagerTemplate
AddSellingManagerProduct
ReviseSellingManagerProduct
No
GetItem
GetSellingManagerTemplates
Conditionally
DetailLevel: none, ItemReturnDescription,
ItemReturnAttributes, ReturnAll
GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
Conditionally
GetSellerEvents
Conditionally
DetailLevel: none, ReturnAll
Defines the multi-variation listing feature. If the field is present,
the corresponding feature applies to the site. The field is returned as
an empty element (e.g., a boolean value is not returned).<br>
<br>
Multi-variation listings contain items that are logically the same
product, but that vary in their manufacturing details or packaging.
For example, a particular brand and style of shirt could be
available in different sizes and colors, such as "large blue" and
"medium black" variations.
Variations are multiple similar (but not identical) items in a
fixed-price listing.
For example, a single listing could contain multiple items of the
same brand and model that vary by color and size (like "Blue, Large" and "Black, Medium"). Each variation can have its own quantity and
price. For example, a listing could include 10 "Blue, Large"
variations and 20 "Black, Medium" variations.
Contains data that distinguishes one item variation from another.
For example, if an item varies by color and size, each <b>Variation</b>
node specifies a combination of one of those colors and
sizes.<br>
<br>
When listing or relisting an item, you are allowed to create a
listing with only one item variation, and you might have a plan to add more item variations to the listing in the future. However, if you don't plan to add other item variations in the future, we recommend that you avoid listing with only one variation, so that you avoid confusing buyers.
<br> <br>
If you specify multiple <b>Variation</b> containers in an add/revise/relist/verify add call to define multiple item variations, the <b>Variation</b> containers must be contiguous or an error will occur. This means that you would not want to input a <b>Pictures</b> or a <b>VariationSpecificsSet</b> container in between <b>Variation</b> containers in an API call.
<br> <br>
When you modify an item variation with a <b>ReviseFixedPriceItem</b> call, the best practice is to include all applicable fields under the <b>Variation</b> container, even if some of the values/settings are not being modified. The <b>StartPrice</b> and <b>VariationSpecifics</b> must be included when modifying an existing item variation, even if these values are not being changed. If a SKU value is defined for the item variation, it is strongly recommended that you include the <b>SKU</b> field, regardless of whether the SKU value is changing or not. If the <b>SKU</b> field is not included, any existing SKU value will be removed from the item variation. It is also strongly recommended that you include the <b>Quantity</b> field and input an accurate value, because if the <b>Quantity</b> field is omitted in the API call, the quantity for the item variation is set to <code>0</code>.
Using Multi-Variation Listings
https://developer.ebay.com/DevZone/guides/features-guide/default.html#Development/Variations.html
AddFixedPriceItem
ReviseFixedPriceItem
RelistFixedPriceItem
VerifyAddFixedPriceItem
Conditionally
1
120
AddSellingManagerProduct
ReviseSellingManagerProduct
No
AddSellingManagerTemplate
ReviseSellingManagerTemplate
No
GetSellingManagerInventory
Conditionally
GetItem
Conditionally
DetailLevel: none, ItemReturnDescription,
ItemReturnAttributes, ReturnAll
GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
Conditionally
GetMyeBayBuying
LostList
WatchList
WonList
DeletedFromWonList
DeletedFromLostList
DetailLevel: none, ReturnAll
Conditionally
GetMyeBaySelling
ActiveList
DeletedFromSoldList
DeletedFromUnsoldList
ScheduledList
SoldList
UnsoldList
DetailLevel: none, ReturnAll
Conditionally
GetSellerEvents
DetailLevel: none, ReturnAll
Conditionally
GetItemTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
Contains a set of pictures that correspond to one of the
variation specifics, such as Color. For example, if a listing
has blue and black color variations, you could choose Color
for all the pictures, and then include a set of pictures
for the blue variations and another set of pictures for the black
variations.<br>
<br>
We strongly recommend that you also include shared pictures
in Item.PictureDetails, as this results in a better experience
for buyers.<br>
<br>
<b>For ReviseFixedPriceItem only:</b> To replace
or delete individual pictures, pass in the entire Pictures
node with the complete set of variation pictures that you
want in the listing. If the applicable variations have purchases
or the listing ends in less than 12 hours, you can add
pictures, but you can't remove existing pictures.<br>
<br>
Variation, Pictures, or ModifyNameList (or all) need to be
specified when the Variations node is specified in listing requests<br>
<br>
<span class="tablenote"><b>Note:</b>
Only one Pictures node is allowed for a listing.
However, the node has been defined as unbounded (repeatable) in
the schema to allow for different use cases for some calls or sites
in the future.</span>
1
Variation Pictures
https://developer.ebay.com/DevZone/guides/features-guide/default.html#Development/Variations-Configuring.html#DefiningPicturesforVariations
AddFixedPriceItem
ReviseFixedPriceItem
RelistFixedPriceItem
VerifyAddFixedPriceItem
No
AddSellingManagerProduct
ReviseSellingManagerProduct
No
AddSellingManagerTemplate
ReviseSellingManagerTemplate
No
GetSellingManagerInventory
Conditionally
GetItem
Conditionally
DetailLevel: none, ItemReturnDescription,
ItemReturnAttributes, ReturnAll
The set of all variation specific names and values that can be
applicable to the listing (at any time in its life cycle).
This must include all names and values specified in the
VariationSpecifics nodes.<br>
<br>
Required when Variations are specified in a new listing, and when you
modify the name of a variation by using ModifyNameList.
When you modify variation specific names, VariationSpecificsSet must
include the new names plus the names that are not changing (but omit the old names), <br>
<br>
This set configures variation selection widgets
that appear on eBay's View Item page.
For example, if you specify Color and Size names in the set,
eBay's View Item page displays Color and Size drop-down lists
to enable a buyer to choose a variation of interest.<br>
<br>
The order in which you specify the names and values also
controls the order in which the selection widgets appear on
the View Item page.
For example, if you specify "Color", then "Size", and then
"Sleeve Style" as names, the View Item page shows drop-down lists
with those labels in that order. For "Size", if you specify
"S", "M", and "L" as values, the View Item page
shows the values in that order in the Size drop-down list.<br>
<br>
Use GetCategorySpecifics to retrieve recommendations for names,
values, and order.<br>
<br>
Required when Variations are specified in a new listing
(e.g., in AddFixedPriceItem). Also required when you change
variation specific names or values in ReviseFixedPriceItem and
RelistFixedPriceItem.
Configuring Variation Specifics
https://developer.ebay.com/DevZone/guides/features-guide/default.html#Development/Variations-Configuring.html#ConfiguringVariationSelectionWidgetsforB
AddFixedPriceItem
VerifyAddFixedPriceItem
Conditionally
ReviseFixedPriceItem
RelistFixedPriceItem
Conditionally
AddSellingManagerProduct
No
AddSellingManagerTemplate
No
GetSellingManagerInventory
Conditionally
GetItem
Conditionally
DetailLevel: none, ItemReturnDescription,
ItemReturnAttributes, ReturnAll
Modifies variation specific names when you revise or
relist items.<br>
<br>
You can modify a variation specific name regardless of the quantity sold (i.e., no restrictions on whether the item has orders or order line items (transactions)).<br>
<br>
(Use VariationSpecifics to modify variation specific values.)<br>
<br>
You are not required to specify SKU, VariationSpecifics, and other variation details in the request when you are only modifying a variation specific name.
<br>
<br>
Variation, Pictures, VariationSpecificsSet, or ModifyNameList (or all) need to be specified when the Variations node is specified in listing requests.
Revising and Relisting with Variations
https://developer.ebay.com/DevZone/guides/features-guide/default.html#Development/Variations-Updating.html
RelistFixedPriceItem
ReviseFixedPriceItem
Conditionally
The VeRO reporting status for an item.
(out) The VeRO report request for the item has been received by eBay.
(out) The VeRO report request for the item has been submitted to eBay.
(out) The reported item has been ended by eBay.
(out) The VeRO report request for the item failed.
(out) The VeRO report request for the item has been received by eBay, but
additional clarification is needed before eBay can end the item.
(out) Reserved for internal or future use.
Container for reason code details for all sites.
Contains reason code details for a site.
GetVeROReasonCodeDetails
Always
This type is used by the <b>ReportItem</b> container. A <b>ReportItem</b> container is required for each eBay item that the product owner is reporting as violating the product owner's copyright, trademark, or intellectual property rights.
The unique identifier for the listing being reported for the alleged infringement, which is specified in the <b>VeROReasonCodeID</b> field.
VeROReportItems
Yes
The unique identifier for the type of claimed infringement. The
<b>GetVeROReasonCodeDetails</b> call can be used to retrieve a list of reason codes for a given eBay site.
VeROReportItems
Yes
This field is used by the VeRO Program member to provide more details to the seller about why the item is being reported as violating copyright, trademark, or intellectual property rights.
1000
VeROReportItems
No
If the VeRO Program member wants a copy of the Notice of Claimed Infringement (NOCI) document sent to their email address, this field should be included in the request and set to <code>true</code>. This same document is automatically sent to the seller of the reported item.
true
VeROReportItems
No
If the infringement type stated in the <b>VeROReasonCodeID</b> has anything to do about which geographical region the item is shipped to, each region that would trigger this infringement type should be specified in its own <b>Region</b> field. Supported values for <b>Region</b> are found in <b>ShippingRegionCodeType</b>.
VeROReportItems
Conditionally
If the infringement type stated in the <b>VeROReasonCodeID</b> has anything to do about which country the item is shipped to, each country that would trigger this infringement type should be specified in its own <b>Country</b> field. Supported values for <b>Country</b> are found in <b>CountryCodeType</b>.
<br><br>
This field is required when the <b>VeROReasonCodeID</b>
is 9037 (Item(s) is unlawful importation of product bearing trademark).
VeROReportItems
Conditionally
This string field is used to specify the number of a product patent that is being violated.
<br><br>
This field is required when the <b>VeROReasonCodeID</b> is 9048 (Item(s) infringes a valid patent).
15
VeROReportItems
Conditionally
Explanatory text from the VeRO Program member. This field is conditionally required when the
<b>VeROReasonCodeID</b> is <code>Others</code>. Note that there is a 1000-character restriction on this text field when the items are being reported with the <code>Others</code> reason code.
1000
VeROReportItems
Conditionally
Type defining the <b>ReportItems</b> container in the <b>VeROReportItems</b> request. The <b>ReportItems</b> container is an array of one or more eBay items which, according to the product's owner, are infringing upon the product owner's copyright, trademark, or intellectual property rights.
A <b>ReportItem</b> container is required for each eBay item that the product owner is reporting as violating the product owner's copyright, trademark, or intellectual property rights. The <b>ItemID</b> and <b>VeROReasonCodeID</b> fields are required, and the rest of the <b>ReportItem</b> fields can be supplied based on the situation.
VeROReportItems
Yes
Enumerated type that contains the possible states of a VeRO Report packet. A VeRO Report packet is a set of one or more items that have been reported by a Verified Rights Owner as infringing upon the owner's intellectual property rights.
This value indicates that the VeRO Report packet has been received by eBay.
This value indicates that eBay is in the process of reviewing the VeRO Report packet. For a VeRO Report packet consisting of multiple items, the call user can look at the <b>ReportedItemDetails</b> container in the <b>GetVeROReportStatus</b> response to get more details about individual items in the VeRO Report packet.
This value indicates that the VeRO Report packet has been processed by eBay.
This value is reserved for internal or future use.
Container for a list of reported items. Can contain zero, one, or multiple
VeROReportedItemType objects, each of which conveys the data for one item listing.
Contains the data and status of a reported item.
GetVeROReportStatus
Conditionally
Type defining the <b>ReportedItem</b> container which is returned in the
<b>GetVeROReportStatus</b> response. The <b>ReportedItem</b>
container consists of the <b>ItemID</b> of the item that has infringed
upon the seller's copyright, trademark, or intellectual property rights, as well as the
submission status of the VeRO Report.
The unique identifier (<b>ItemID</b>) of the listing reported for
copyright, trademark, or intellectual property right infringment.
<br><br>
This field is always returned with the <b>ReportedItem</b> container.
GetVeROReportStatus
Conditionally
This value indicates the current submission status of the VeRO Report.
<br><br>
This field is always returned with the <b>ReportedItem</b> container.
GetVeROReportStatus
Conditionally
This text explanation is submitted by eBay when the submission of an VeRO Report
has failed or was blocked.
<br><br>
This field is only returned with the <b>ReportedItem</b> container if
the <b>ItemStatus</b> value is <b>SubmissionFailed</b> or
<b>ClarificationRequired</b>.
GetVeROReportStatus
Conditionally
Type used by the <b>VeROSiteDetailType</b> container, which is returned in <b>GetVeROReasonCodeDetails</b>. Each <b>VeROSiteDetailType</b> container will contain one or more reasons how an eBay listing could possibly infringe upon the intellectual property rights of a product owner.
This enumeration value indicates the eBay site for which reason code details are returned.
GetVeROReasonCodeDetails
Always
This container includes brief and detailed text descriptions for the VeRO program intellectual property right infringement reason. There can be multiple <b>ReasonCodeDetail</b> containers returned for each eBay site. This container also consists of a <b>codeID</b> attribute, which is the unique identifier of the reason code.
GetVeROReasonCodeDetails
Always
The Verified User Buyer Requirement has been deprecated, so this type is no longer applicable.
1065
NoOp
1065
1065
NoOp
1065
The Verified User Buyer Requirement has been deprecated, so this type is no longer applicable.
1065
NoOp
1065
1065
NoOp
1065
This type 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 field is deprecated.
This field is deprecated.
This type is deprecated, as product warranties are no longer applicable or supported in eBay APIs.
This value indicates that the duration of the warranty will be one month from time of purchase. If this value is returned in the <b>ReturnPolicyDetails.WarrantyDuration</b> container of the <b>GeteBayDetails</b> response, the seller may offer this warranty duration to the buyer. The warranty duration value is specified through the <b>ReturnPolicy.WarrantyDurationOption</b> field in an add/revise/relist API call.
This value indicates that the duration of the warranty will be three months from time of purchase. If this value is returned in the <b>ReturnPolicyDetails.WarrantyDuration</b> container of the <b>GeteBayDetails</b> response, the seller may offer this warranty duration to the buyer. The warranty duration value is specified through the <b>ReturnPolicy.WarrantyDurationOption</b> field in an add/revise/relist API call.
This value indicates that the duration of the warranty will be six months from time of purchase. If this value is returned in the <b>ReturnPolicyDetails.WarrantyDuration</b> container of the <b>GeteBayDetails</b> response, the seller may offer this warranty duration to the buyer. The warranty duration value is specified through the <b>ReturnPolicy.WarrantyDurationOption</b> field in an add/revise/relist API call.
This value indicates that the duration of the warranty will be one year from time of purchase. If this value is returned in the <b>ReturnPolicyDetails.WarrantyDuration</b> container of the <b>GeteBayDetails</b> response, the seller may offer this warranty duration to the buyer. The warranty duration value is specified through the <b>ReturnPolicy.WarrantyDurationOption</b> field in an add/revise/relist API call.
This value indicates that the duration of the warranty will be two years from time of purchase. If this value is returned in the <b>ReturnPolicyDetails.WarrantyDuration</b> container of the <b>GeteBayDetails</b> response, the seller may offer this warranty duration to the buyer. The warranty duration value is specified through the <b>ReturnPolicy.WarrantyDurationOption</b> field in an add/revise/relist API call.
This value indicates that the duration of the warranty will be three years from time of purchase. If this value is returned in the <b>ReturnPolicyDetails.WarrantyDuration</b> container of the <b>GeteBayDetails</b> response, the seller may offer this warranty duration to the buyer. The warranty duration value is specified through the <b>ReturnPolicy.WarrantyDurationOption</b> field in an add/revise/relist API call.
This value indicates that the duration of the warranty is longer than three years from time of purchase. If this value is returned in the <b>ReturnPolicyDetails.WarrantyDuration</b> container of the <b>GeteBayDetails</b> response, the seller may offer this warranty duration to the buyer. The warranty duration value is specified through the <b>ReturnPolicy.WarrantyDurationOption</b> field in an add/revise/relist API call.
This value is reserved for internal or future use.
This type is deprecated, as product warranties are no longer applicable or supported in eBay APIs.
WarrantyDurationOptionsCodeType
1061
NoOp
1139
1061
NoOp
1139
This type is deprecated, as product warranties are no longer applicable or supported in eBay APIs.
If this value is returned in the <b>ReturnPolicyDetails.WarrantyOffered</b> container of the <b>GeteBayDetails</b> response, the seller may offer a warranty to the buyer. This value that should be passed into the <b>ReturnPolicy.WarrantyOfferedOption</b> field of an add/revise/relist API call if the seller wishes to offer a warranty to the buyer.
This value is reserved for internal or future use.
This type is deprecated, as product warranties are no longer applicable or supported in eBay APIs.
WarrantyOfferedCodeType
1061
NoOp
1139
1061
NoOp
1139
This type is deprecated, as product warranties are no longer applicable or supported in eBay APIs.
If this value is returned in the <b>ReturnPolicyDetails.WarrantyType</b> container of the <b>GeteBayDetails</b> response, the seller may offer a replacement warranty to the buyer. The seller can offer a replacement warranty through the <b>ReturnPolicy.WarrantyTypeOption</b> field in an add/revise/relist API call.
If this value is returned in the <b>ReturnPolicyDetails.WarrantyType</b> container of the <b>GeteBayDetails</b> response, the seller may offer a dealer warranty to the buyer. The seller can offer a dealer warranty through the <b>ReturnPolicy.WarrantyTypeOption</b> field in an add/revise/relist API call.
If this value is returned in the <b>ReturnPolicyDetails.WarrantyType</b> container of the <b>GeteBayDetails</b> response, the seller may offer a manufacturer warranty to the buyer. The seller can offer a manufacturer warranty through the <b>ReturnPolicy.WarrantyTypeOption</b> field in an add/revise/relist API call.
This value is reserved for internal or future use.
This type is deprecated, as product warranties are no longer applicable or supported in eBay APIs.
WarrantyTypeOptionsCodeType
1061
NoOp
1139
1061
NoOp
1139
This enumerated type contains a list of wireless carriers that may be providing SMS messages for a Platform Notifications subscriber.
Cingular, Dobson, Alltel, Leap, Amena
This value is no longer applicable, as Cingular is no longer in existence.
This value indicates that T-Mobile is providing SMS messages for the Platform Notifications subscriber.
This value indicates that Sprint is providing SMS messages for the Platform Notifications subscriber.
This value is no longer applicable, as Nextel was purchased by Sprint.
This value indicates that Verizon is providing SMS messages for the Platform Notifications subscriber.
This value indicates that Cincinnati Bell is providing SMS messages for the Platform Notifications subscriber.
This value is no longer applicable, as Dobson is no longer in existence.
This value is no longer applicable, as Alltel is no longer in existence.
This value is no longer applicable, as Leap is no longer in existence.
This value indicates that US Cellular is providing SMS messages for the Platform Notifications subscriber.
This value indicates that Movistar is providing SMS messages for the Platform Notifications subscriber.
This value is no longer applicable, as Amena is no longer in existence.
This value indicates that Vodafone is providing SMS messages for the Platform Notifications subscriber.
This value indicates that AT&T is providing SMS messages for the Platform Notifications subscriber.
This value is reserved for future use.
This type is deprecated.
773
Avoid
GetCategorySpecifics
889
This field is deprecated.
This field is deprecated.
This field is deprecated.
Type defining the <b>eBayMotorsProAdFormatEnabled</b> field that is returned under the <b>FeatureDefinitions</b> container if <code>eBayMotorsProAdFormatEnabled</code> is used as a <b>FeatureID</b> value in the request, or if no <b>FeatureID</b> values are used in the request. 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 for eBay Motors Pro users.
<br/><br/>
To verify if a specific eBay site supports Classified Ad listings for eBay Motors Pro users (for most categories), look for a <code>true</code> value in the <b>SiteDefaults.eBayMotorsProAdFormatEnabled</b> field.
<br/><br/>
To verify if a specific category on a specific eBay site supports Classified Ad listings for eBay Motors Pro users, pass in a <b>CategoryID</b> value in the request, and then look for a <code>true</code> value in the <b>eBayMotorsProAdFormatEnabled</b> field of the corresponding <b>Category</b> node (match up the <b>CategoryID</b> values if more than one Category IDs were passed in the request).
Type defining the <b>eBayMotorsProAutoAcceptEnabled</b> field that is returned under the <b>FeatureDefinitions</b> container if <code>eBayMotorsProAutoAcceptEnabled</code> is used as a <b>FeatureID</b> value in the request, or if no <b>FeatureID</b> values are used in the request. This field is returned as an empty element (a boolean value is not returned) if one or more eBay API-enabled sites support the Best Offer Auto-Accept feature for eBay Motors Classified Ad listings. Only eBay Motors Pro users are eligible to use eBay Motors Classified Ad listings.
<br/><br/>
To verify if a specific eBay site supports the Best Offer Auto-Accept feature for eBay Motors Classified Ad listings (for most categories), look for a <code>true</code> value in the <b>SiteDefaults.eBayMotorsProAutoAcceptEnabled</b> field.
<br/><br/>
To verify if a specific category on a specific eBay site supports the Best Offer Auto-Accept feature for eBay Motors Classified Ad listings, pass in a <b>CategoryID</b> value in the request, and then look for a <code>true</code> value in the <b>eBayMotorsProAutoAcceptEnabled</b> field of the corresponding <b>Category</b> node (match up the <b>CategoryID</b> values if more than one Category IDs were passed in the request).
Type defining the <b>eBayMotorsProAutoAcceptEnabled</b> field that is returned under the <b>FeatureDefinitions</b> container if <code>eBayMotorsProAutoDeclineEnabled</code> is used as a <b>FeatureID</b> value in the request, or if no <b>FeatureID</b> values are used in the request. This field is returned as an empty element (a boolean value is not returned) if one or more eBay API-enabled sites support the Best Offer Auto-Decline feature for eBay Motors Classified Ad listings. Only eBay Motors Pro users are eligible to use eBay Motors Classified Ad listings.
<br/><br/>
To verify if a specific eBay site supports the Best Offer Auto-Decline feature for eBay Motors Classified Ad listings (for most categories), look for a <code>true</code> value in the <b>SiteDefaults.eBayMotorsProAutoDeclineEnabled</b> field.
<br/><br/>
To verify if a specific category on a specific eBay site supports the Best Offer Auto-Decline feature for eBay Motors Classified Ad listings, pass in a <b>CategoryID</b> value in the request, and then look for a <code>true</code> value in the <b>eBayMotorsProAutoDeclineEnabled</b> field of the corresponding <b>Category</b> node (match up the <b>CategoryID</b> values if more than one Category IDs were passed in the request).
Type defining the <b>eBayMotorsProBestOfferEnabled</b> field that is returned under the <b>FeatureDefinitions</b> container if <code>eBayMotorsProBestOfferEnabled</code> is used as a <b>FeatureID</b> value in the request, or if no <b>FeatureID</b> values are used in the request. This field is returned as an empty element (a boolean value is not returned) if one or more eBay API-enabled sites support the Best Offer feature for eBay Motors Classified Ad listings. Only eBay Motors Pro users are eligible to use eBay Motors Classified Ad listings.
<br/><br/>
To verify if a specific eBay site supports the Best Offer feature for eBay Motors Classified Ad listings (for most categories), look for a <code>true</code> value in the <b>SiteDefaults.eBayMotorsProBestOfferEnabled</b> field.
<br/><br/>
To verify if a specific category on a specific eBay site supports the Best Offer feature for eBay Motors Classified Ad listings, pass in a <b>CategoryID</b> value in the request, and then look for a <code>true</code> value in the <b>eBayMotorsProBestOfferEnabled</b> field of the corresponding <b>Category</b> node (match up the <b>CategoryID</b> values if more than one Category IDs were passed in the request).
Indicates whether the site supports the use of a company name
when contacting the seller about eBay Motors Classified Ad listings.
This feature is only applicable for eBay Motors Pro users.
Indicates whether the site supports the use of a company address when contacting the
seller about eBay Motors Classified Ad listings. This feature is only
applicable for eBay Motors Pro users.
Indicates whether the site supports the use of an email address when contacting the
seller about eBay Motors Classified Ad listings. This feature is only
applicable for eBay Motors Pro users.
Indicates whether the site supports the use of a phone number when contacting the
seller about eBay Motors Classified Ad listings. This feature is only
applicable for eBay Motors Pro users.
Type defining the <b>eBayMotorsProCounterOfferEnabled</b> field that is returned under the <b>FeatureDefinitions</b> container if <code>eBayMotorsProCounterOfferEnabled</code> is used as a <b>FeatureID</b> value in the request, or if no <b>FeatureID</b> values are used in the request. This field is returned as an empty element (a boolean value is not returned) if one or more eBay API-enabled sites support counter offers to Best Offers for eBay Motors Classified Ad listings. Only eBay Motors Pro users are eligible to use eBay Motors Classified Ad listings.
<br/><br/>
To verify if a specific eBay site supports counter offers to Best Offers for eBay Motors Classified Ad listings (for most categories), look for a <code>true</code> value in the <b>SiteDefaults.eBayMotorsProCounterOfferEnabled</b> field.
<br/><br/>
To verify if a specific category on a specific eBay site supports counter offers to Best Offers for eBay Motors Classified Ad listings, pass in a <b>CategoryID</b> value in the request, and then look for a <code>true</code> value in the <b>eBayMotorsProCounterOfferEnabled</b> field of the corresponding <b>Category</b> node (match up the <b>CategoryID</b> values if more than one Category IDs were passed in the request).
Type defining the <b>eBayMotorsProPaymentMethodCheckOutEnabled</b> field that is returned under the <b>FeatureDefinitions</b> container if <code>eBayMotorsProPaymentMethodCheckOutEnabled</code> is used as a <b>FeatureID</b> value in the request, or if no <b>FeatureID</b> values are used in the request. This field is returned as an empty element (a boolean value is not returned) if one or more eBay API-enabled sites support the display of accepted payment methods for eBay Motors Classified Ad listings. Only eBay Motors Pro users are eligible to use eBay Motors Classified Ad listings.
Indicates which phone option the site supports
for contacting the seller about Classified Ad format listings.
Added for EbayMotors Pro users.
This field is returned (as an empty element) if the site supports contacting
the seller for a Classified Ad listings.
This is for EbayMotors Pro users only.
Indicates if the site supports shipping options for
Classified Ad format listings.
Added for EbayMotors Pro users.
Indicates which address option the site supports for
Classified Ad format listings.
Added for EbayMotors Pro users.
Contains information about a country where a specified seller is eligible to offer eBay Plus on listings, as well as the seller's opt-in status and listing preference for that country.
<br/><br/>
eBay Plus is a premium account option for buyers, which provides benefits such as fast free domestic shipping and free returns on selected items. Top Rated eBay sellers must opt in to eBay Plus to be able offer the program on qualifying listings. Sellers must commit to next-day delivery of those items.
<br/><br/>
<span class="tablenote">
<strong>Note:</strong> Currently, eBay Plus is available only to buyers in Germany, Austria, and Australia.
</span>
For more details about eBay Plus, see <a href="../../../../guides/features-guide/default.html#development/Feature-eBayPlus.html">Offering eBay Plus</a>.
An ISO 3166 standard two-letter code that identifies a country where the seller is eligible to offer eBay Plus on fixed price listings.
<br/><br/>
<span class="tablenote">
<strong>Note:</strong> Currently, eBay Plus is available only to buyers in Germany, Austria, and Australia..
</span>
GetUserPreferences
Conditionally
A value of <code>true</code> indicates that the seller has opted in to eBay Plus for listings in the specified country.
GetUserPreferences
Conditionally
A value of <code>true</code> indicates that if <strong>OptInStatus</strong> is also <code>true</code>, the seller will offer eBay Plus by default for new listings in the specified country. If this field's value is <code>false</code> (and <strong>OptInStatus</strong> is <code>true</code>), the seller will offer eBay Plus on a listing by listing basis in the specified country.
GetUserPreferences
Conditionally
This type is deprecated.
This field is deprecated.
This field is deprecated.
This field is deprecated.
1131