|
eBay Trading API |
Namespace: |
|
Content: |
|
Defined: |
|
Includes: |
|
Used: |
at 23 locations |
<xs:sequence>
<xs:element minOccurs="0" name="ApplicationData" type="xs:string"/>
</xs:sequence>
<xs:element maxOccurs="unbounded" minOccurs="0" name="ListingEnhancement" type="ns:ListingEnhancementsCodeType"/>
<xs:element maxOccurs="unbounded" minOccurs="0" name="PaymentMethods" type="ns:BuyerPaymentMethodCodeType"/>
<xs:element minOccurs="0" name="ExtendedSellerContactDetails" type="ns:ExtendedContactDetailsType"/>
<xs:element minOccurs="0" name="InventoryTrackingMethod" type="ns:InventoryTrackingMethodCodeType"/>
<xs:element minOccurs="0" name="ShippingServiceCostOverrideList" type="ns:ShippingServiceCostOverrideListType"/>
<xs:element minOccurs="0" name="QuantityRestrictionPerBuyer" type="ns:QuantityRestrictionPerBuyerInfoType"/>
<xs:any maxOccurs="unbounded" minOccurs="0" processContents="lax"/>
</xs:complexType>
|
Type: |
xs:string, predefined, simple content
|
|
Type: |
ns:BuyerProtectionDetailsType, complex content
|
|
Type: |
ns:AttributeArrayType, complex content
|
|
Type: |
ns:AttributeSetArrayType, complex content
|
|
Type: |
xs:boolean, predefined, simple content
|
true
, the seller requests immediate payment for a fixed-price item or an auction item that is purchased with the 'Buy it Now' feature. If false
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.)
true
in the GetCategories response). To enable the listing with the immediated payment requirement, AutoPay must be true
, the
PayPalEmailAddress field must be included and must have a valid PayPal email address for the seller, and the only specified
PaymentMethods value must be PayPal
.
true
to create an Immediate Payment listing.
false
.
|
Type: |
xs:boolean, predefined, simple content
|
true
, 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'.
true
value in the PickupDropOffEnabled field of the corresponding Category node (match up the CategoryID values if more than one Category IDs were passed in the request).
|
Type: |
ns:BestOfferDetailsType, complex content
|
|
Type: |
xs:boolean, predefined, simple content
|
|
Type: |
ns:BiddingDetailsType, complex content
|
|
Type: |
xs:boolean, predefined, simple content
|
|
Type: |
ns:BusinessSellerDetailsType, complex content
|
Commercial
.
This is only applicable for sites where Business Seller options
are supported.
|
Type: |
ns:AmountType, simple content
|
|
Type: |
ns:BuyerProtectionCodeType, simple content
|
true
. 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
PayPal Buyer Protection help page.
|
Enumeration: |
|
Type: |
ns:BuyerRequirementDetailsType, complex content
|
|
Type: |
xs:boolean, predefined, simple content
|
true
,
the buyer is responsible for vehicle pickup or shipping. false
, specify
vehicle shipping arrangements in the item description. (The
description can also include vehicle shipping arrangements when this value is
true
.) true
and the listing is on the US eBay Motors site, and you want the
listing to be visible on the eBay Canada site, set Item.ShipToLocations to CA.
true
and the listing is on the eBay Canada site, and you want your listing
to be visible on the US eBay Motors site, set Item.ShipToLocations to US.
|
Type: |
ns:AmountType, simple content
|
|
Type: |
xs:boolean, predefined, simple content
|
true
if this field is omitted. Previously, the default value was false
, so a user had to include this field and set it to true
in order for eBay to map an outdated Primary or Secondary Category ID to the updated Category ID.
This boolean field controls whether or not eBay automatically maps outdated Category ID(s) specified in a
PrimaryCategory and/or SecondaryCategory container(s) to the updatd Category ID(s) no longer exists in the
current category structure: If you pass a value of true
in
CategoryMappingAllowed 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 false
, 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 CategoryID and Category2ID fields (if secondary category is used) of the Add/Revise/Relist call response.
|
Default: |
"false" |
Type: |
ns:AmountType, simple content
|
|
Type: |
ns:CharityType, complex content
|
|
Type: |
ns:AmountType, simple content
|
|
Type: |
xs:string, predefined, simple content
|
|
Type: |
xs:string, predefined, simple content
|
|
Type: |
xs:string, predefined, simple content
|
|
Type: |
xs:int, predefined, simple content
|
1000
maps to New
condition.
ConditionEnabled
, and the other field set to ConditionValues
.
|
Type: |
ns:CountryCodeType, simple content
|
|
Enumeration: |
see details at ns:CountryCodeType
|
Type: |
xs:string, predefined, simple content
|
|
Type: |
ns:CrossPromotionsType, complex content
|
|
Type: |
ns:CurrencyCodeType, simple content
|
|
Enumeration: |
see details at ns:CurrencyCodeType
|
Type: |
xs:string, predefined, simple content
|
true
).
|
Type: |
ns:DescriptionReviseModeCodeType, simple content
|
|
Enumeration: |
|
Type: |
ns:DigitalGoodInfoType, complex content
|
|
Type: |
xs:boolean, predefined, simple content
|
true
, all buyer requirements (from Item.BuyerRequirementDetails
or Buyer requirements preferences in My eBay) are ignored.
false
(or omitted): Item.BuyerRequirementDetails or Buyer
requirements preferences are used, with Item.BuyerRequirementDetails
having the higher precedence.
|
Type: |
ns:DiscountPriceInfoType, complex content
|
|
Type: |
xs:int, predefined, simple content
|
0
or 1
(days) and the cumulative value of DispatchTimeMax plus the transit time of the shipping service (returned in ShippingServiceDetails.ShippingTimeMax field of GeteBayDetails) must be 4 business days or less to be eligible for this feature. See the eBay Guaranteed Delivery page in Seller Center for more information on this program. The eBay Guaranteed Delivery feature is only available on the US and Australia marketplaces.
|
Type: |
ns:DistanceType, complex content
|
|
Type: |
xs:string, predefined, simple content
|
|
Type: |
xs:boolean, predefined, simple content
|
21919431: This listing isn't eligible for eBay Plus.
warning message in an add/revise/relist call, even though eBay may ultimately set the eBay Plus feature on the listing if the item is eligible.
true
. If the seller is not eligible for/opted in to eBay Plus and/or the listing category or item does not qualify for eBay Plus, a warning message will be returned to the seller in the response indicating this. In addition to the seller, listing category, and item being eligible for eBay Plus, the seller must also set/commit to the following for the listing:
0
or 1
). true
in a 'Get' call, it indicates that the item is eligible for eBay Plus treatment, but eBay Plus will only come into play if the buyer is subscribed to eBay Plus.
|
Type: |
xs:boolean, predefined, simple content
|
true
, 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 and free domestic shipping and free returns on selected items. eBay sellers must opt in to eBay Plus to be able offer the program on qualifying listings. Among other requirements, sellers must commit to next-day delivery of those items.
|
Type: |
xs:boolean, predefined, simple content
|
|
Type: |
xs:boolean, predefined, simple content
|
|
Type: |
ns:ExtendedContactDetailsType, complex content
|
|
<xs:element minOccurs="0" name="ExtendedSellerContactDetails" type="ns:ExtendedContactDetailsType"/>
|
Type: |
ns:AmountType, simple content
|
|
Type: |
ns:CategoryType, complex content
|
|
Type: |
xs:boolean, predefined, simple content
|
|
Type: |
xs:string, predefined, simple content
|
|
Type: |
xs:boolean, predefined, simple content
|
true
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 ReasonHideFromSearch field.
|
Type: |
xs:long, predefined, simple content
|
BasicStyle
,
RetroStyle
, or HiddenStyle
.
|
Type: |
ns:HitCounterCodeType, simple content
|
|
Enumeration: |
|
Type: |
xs:boolean, predefined, simple content
|
true
if the actual quantity of a multiple-quantity, fixed-price listing (indicated in the Item.Quantity field) can not be accurately determined by eBay.
|
Type: |
xs:boolean, predefined, simple content
|
true
, then
integrated merchant credit card (IMCC) is enabled for credit cards because
the seller has a payment gateway account. Therefore, if
IntegratedMerchantCreditCardEnabled is true
, 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).
|
Type: |
ns:InventoryTrackingMethodCodeType, simple content
|
ItemID
(default value), but the item must also have a SKU value (Item.SKU or Variation.SKU) associated with it.
For GetItem and related calls:
Only returned when the value is SKU
; not returned when the value is ItemID
.
|
Enumeration: |
|
<xs:element minOccurs="0" name="InventoryTrackingMethod" type="ns:InventoryTrackingMethodCodeType"/>
|
Type: |
xs:boolean, predefined, simple content
|
true
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.
|
Type: |
xs:boolean, predefined, simple content
|
Item.IsSecureDescription
is not one of the values passed in to one of these fields.
true
, 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 false
, 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.
|
Type: |
xs:int, predefined, simple content
|
true
in the request.
|
Type: |
ns:ItemCompatibilityListType, complex content
|
true
in the
GetItem request.
|
Type: |
ns:ItemIDType, simple content
|
|
Type: |
ns:ItemPolicyViolationType, complex content
|
|
Type: |
ns:NameValueListArrayType, complex content
|
Brand
, MPN
, or a Global Trade Item Number (GTIN). GTINs are a set of globally recognized identifiers, including EAN
, ISBN
, and UPC
. However, the Values provided for these Names must comply with eBay's constraints or they will not be recognized as product identifiers. The Value for Brand must be an actual brand name (except that if the item is not branded, Value can be Unbranded
.) The Value for Brand or MPN cannot contain only special characters (e.g. %$*#@
). All GTINs must comply with international formatting standards. For more details, see Listing with Item Specifics.
Instance
in one or more NameRecommendation.ValidationRules.aspectUsage fields. Many categories support the following instance aspects: Custom Bundle, Bundle Description, Modified Item, Modification Description, and California Prop 65 Warning. 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.
Note: To specify an item's condition, use the ConditionID field instead of a condition Item Specific. Use GetCategoryFeatures to see which categories support ConditionID and to get a list of valid condition IDs. (If you specify ConditionID and you also specify Condition as a Item Specific, eBay drops the condition Item Specific.)
For GetItem: This list is returned only when you specify IncludeItemSpecifics in the request (and the seller included Item Specifics in their listing).
|
Type: |
xs:int, predefined, simple content
|
|
Type: |
xs:boolean, predefined, simple content
|
|
Type: |
ns:ListingDetailsType, complex content
|
|
Type: |
xs:token, predefined, simple content
|
GTC
is specified in this field, it will be ignored, and GTC
will be used instead.
|
Type: |
ns:ListingEnhancementsCodeType, simple content
|
|
Enumeration: |
<xs:element maxOccurs="unbounded" minOccurs="0" name="ListingEnhancement" type="ns:ListingEnhancementsCodeType"/>
|
Type: |
ns:ListingSubtypeCodeType, simple content
|
|
Enumeration: |
|
Type: |
ns:ListingTypeCodeType, simple content
|
Chinese
value), fixed-price (indicated with FixedPriceItem
value), or classified ad (indicated with AdType
value).
FixedPriceItem
, since these calls only work with fixed-price listings.
|
Enumeration: |
see details at ns:ListingTypeCodeType
|
Type: |
xs:boolean, predefined, simple content
|
|
Type: |
xs:boolean, predefined, simple content
|
|
Type: |
xs:string, predefined, simple content
|
|
Type: |
xs:boolean, predefined, simple content
|
true
, eBay provided a central location as a result of the user
not specifying a location. This typically occurs when the seller
specifies PostalCode without Location.
|
Type: |
ns:LookupAttributeArrayType, complex content
|
|
Type: |
xs:int, predefined, simple content
|
true
, the category does not support lots.
|
Type: |
xs:boolean, predefined, simple content
|
|
Type: |
xs:int, predefined, simple content
|
|
Type: |
xs:string, predefined, simple content
|
|
Type: |
xs:string, predefined, simple content
|
|
Type: |
ns:SiteCodeType, simple content
|
|
Enumeration: |
see details at ns:SiteCodeType
|
Type: |
ns:PaymentDetailsType, complex content
|
|
Type: |
ns:BuyerPaymentMethodCodeType, simple content
|
true
.
IMCC
is passed in as a value, this value will be ignored and dropped (and listing will possibly get blocked if IMCC
is the only specified payment method).
<PaymentMethods>VisaMC</PaymentMethods>
<PaymentMethods>PayPal</PaymentMethods>
<PayPalEmailAddress>mypaypalemail@ebay.com</PayPalEmailAddress>
maxOccurs="unbounded"
or greater than 1) in the schema. See Overview of the API Schema in the eBay Features Guide.
|
Enumeration: |
<xs:element maxOccurs="unbounded" minOccurs="0" name="PaymentMethods" type="ns:BuyerPaymentMethodCodeType"/>
|
Type: |
xs:string, predefined, simple content
|
|
Type: |
ns:PickupInStoreDetailsType, complex content
|
|
Type: |
ns:PictureDetailsType, complex content
|
|
Type: |
xs:string, predefined, simple content
|
951**
.
|
Type: |
ns:CategoryType, complex content
|
|
Type: |
xs:boolean, predefined, simple content
|
true
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.
|
Type: |
xs:string, predefined, simple content
|
|
Type: |
ns:ProductListingDetailsType, complex content
|
|
Type: |
xs:boolean, predefined, simple content
|
|
Type: |
xs:int, predefined, simple content
|
1
. For a fixed-price listing, the Quantity value indicates the number of identical items the seller has available for sale in the listing. If this field is not included when creating a new fixed-price listing, quantity defaults to '1'. If variations are specified in AddFixedPriceItem or VerifyAddFixedPriceItem, the Item.Quantity is not required since the quantity of variations is specified in Variation.Quantity instead. See the Creating a listing with variations eBay Help page for more information on variations.
1
.
10
, and three items have been sold,
eBay sets the relisted item's Quantity to 10
by default, and not 7
.
So, we strongly recommend that you always
set Quantity to the correct value (your actual quantity available)
in your relist requests.
|
Type: |
xs:int, predefined, simple content
|
|
Type: |
ns:QuantityAvailableHintCodeType, simple content
|
|
Enumeration: |
|
Type: |
ns:QuantityInfoType, complex content
|
|
Type: |
ns:QuantityRestrictionPerBuyerInfoType, complex content
|
|
<xs:element minOccurs="0" name="QuantityRestrictionPerBuyer" type="ns:QuantityRestrictionPerBuyerInfoType"/>
|
Type: |
xs:int, predefined, simple content
|
|
Type: |
xs:long, predefined, simple content
|
|
Type: |
ns:ReasonHideFromSearchCodeType, simple content
|
|
Enumeration: |
|
Type: |
xs:string, predefined, simple content
|
|
Type: |
xs:boolean, predefined, simple content
|
true
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 false
value should never get returned.
|
Type: |
xs:boolean, predefined, simple content
|
|
Type: |
xs:long, predefined, simple content
|
|
Type: |
ns:AmountType, simple content
|
|
Type: |
ns:ReturnPolicyType, complex content
|
|
Type: |
ns:ReviseStatusType, complex content
|
|
Type: |
xs:dateTime, predefined, simple content
|
AT, BEFR, BENL, CH, DE, ES, FR, IE, IT, NL, PL, UK
|
Type: |
ns:SearchDetailsType, complex content
|
|
Type: |
ns:CategoryType, complex content
|
0
in the SecondaryCategory.CategoryID field.
|
Type: |
ns:UserType, complex content
|
|
Type: |
ns:AddressType, complex content
|
|
Type: |
ns:SellerProfilesType, complex content
|
|
Type: |
xs:string, predefined, simple content
|
|
Type: |
xs:string, predefined, simple content
|
|
Type: |
ns:SellingStatusType, complex content
|
|
Type: |
ns:ShippingDetailsType, complex content
|
true
for
Category.ShippingTermsRequired.
None
- <ShipToLocations>None</ShipToLocations>
|
Type: |
ns:ShippingOverrideType, complex content
|
|
Type: |
ns:ShipPackageDetailsType, complex content
|
|
Type: |
ns:ShippingServiceCostOverrideListType, complex content
|
|
<xs:element minOccurs="0" name="ShippingServiceCostOverrideList" type="ns:ShippingServiceCostOverrideListType"/>
|
Type: |
xs:string, predefined, simple content
|
None
.
ReviseItem can add a ShipToLocations. On output, ShipToLocations is the
collection of all input item-level ShipToLocations plus international shipping
service-level ShipToLocation values.
None
- <ShipToLocations>None</ShipToLocations>
|
Type: |
ns:SiteCodeType, simple content
|
|
Enumeration: |
see details at ns:SiteCodeType
|
Type: |
xs:int, predefined, simple content
|
|
Type: |
ns:SKUType, simple content
|
SKU
. Setting the InventoryTrackingMethod field to SKU
allows the seller to use a SKU value instead of an ItemID value as a unique identifier
in calls such as GetItem and ReviseInventoryStatus
|
Type: |
ns:AmountType, simple content
|
|
Type: |
ns:StorefrontType, complex content
|
|
Type: |
xs:string, predefined, simple content
|
|
Type: |
xs:string, predefined, simple content
|
|
Type: |
xs:duration, predefined, simple content
|
|
Type: |
xs:string, predefined, simple content
|
|
Type: |
xs:boolean, predefined, simple content
|
true
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
Top-Rated Seller requirements help topic for more information on qualifying as a Top-Rated Seller and the Top-Rated Plus listing requirements 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 Top-Rated Seller home page in the Seller Center.
|
Type: |
xs:long, predefined, simple content
|
|
Type: |
ns:UnitInfoType, complex content
|
true
.
|
Type: |
xs:boolean, predefined, simple content
|
|
Type: |
xs:boolean, predefined, simple content
|
|
Type: |
xs:boolean, predefined, simple content
|
true
,
the values contained in the seller's sales tax table will supersede the values contained in the Item.ShippingDetails.SalesTax container (if included in the request).
|
Type: |
ns:UUIDType, simple content
|
|
Type: |
ns:VariationsType, complex content
|
true
in the request,
the DetailLevel was set to ReturnAll, and an applicable pagination
value and time range were specified.true
in the request. (Also see Variation returned in Transaction for
information about which variation was actually purchased.)
false
or not specified in the request.
|
Type: |
ns:VATDetailsType, complex content
|
|
Type: |
ns:VideoDetailsType, complex content
|
|
Type: |
xs:string, predefined, simple content
|
|
Type: |
xs:string, predefined, simple content
|
|
Type: |
xs:string, predefined, simple content
|
|
Type: |
xs:string, predefined, simple content
|
|
Type: |
xs:long, predefined, simple content
|
true
in the request.
Returned by GetMyeBaySelling only if greater than 0.
|
<xs:any maxOccurs="unbounded" minOccurs="0" processContents="lax"/>
|
|
eBay Trading API |
WSDL documentation generated with FlexDoc/XML 1.13 using FlexDoc/XML WSDLDoc 1.2.5 template set. All XSD diagrams generated by FlexDoc/XML DiagramKit. |