complexType "ns:GetAllBiddersResponseType"

Overview

Namespace

WSDL

Schema

Component

Index

PREV C-TYPE NEXT C-TYPE

FRAMES NO FRAMES NS-Bindings

SUMMARY: XML REP | DERIVED | USE

DETAIL: DESC | XML SRC | TYPE | ATTR | CHILD

eBay Trading API

complexType "ns:GetAllBiddersResponseType"

Namespace:	urn:ebay:apis:eBLBaseComponents
Content:	complex, 19 elements, elem. wildcard
Defined:	globally in Schema in ebaySvc.wsdl; see XML source
Includes:	definitions of 4 elements
Used:	at 1 location

Component Diagram

XML Representation Summary

<...>

Content:

</...>

All Direct / Indirect Based Elements (1):

ns:GetAllBiddersResponse

Known Usage Locations

As direct type of elements (1):

ns:GetAllBiddersResponse

Annotation

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.

Type Definition Detail

Type Derivation Tree

ns:AbstractResponseType (extension)

ns:GetAllBiddersResponseType

XML Source (w/o annotations (5); see within schema source)

<xs:complexType name="GetAllBiddersResponseType">

<xs:complexContent>

<xs:extension base="ns:AbstractResponseType">

<xs:sequence>

<xs:element minOccurs="0" name="BidArray" type="ns:OfferArrayType"/>

<xs:element minOccurs="0" name="HighBidder" type="ns:UserIDType"/>

<xs:element minOccurs="0" name="HighestBid" type="ns:AmountType"/>

<xs:element minOccurs="0" name="ListingStatus" type="ns:ListingStatusCodeType"/>

</xs:sequence>

</xs:extension>

</xs:complexContent>

</xs:complexType>

Content Element Detail (all declarations defined in this component; 4/20)

ns:BidArray

Type:

ns:OfferArrayType, complex content

This container consists of an array of bids made on the specified auction listing. Each OfferType object represents the data for one bid.

Component Diagram

XML Representation Summary

<ns:BidArray>

Content:

ns:Offer*

</ns:BidArray>

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="BidArray" type="ns:OfferArrayType"/>

ns:HighBidder

Type:

ns:UserIDType, simple content

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.

XML Representation Summary

<ns:HighBidder>

Content:

{ xs:string }

</ns:HighBidder>

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="HighBidder" type="ns:UserIDType"/>

ns:HighestBid

Type:

ns:AmountType, simple content

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).

Component Diagram

XML Representation Summary

<ns:HighestBid

currencyID

("AFA" | "ALL" | "DZD" | "ADP" | "AOA" | "ARS" | "AMD" | "AWG" | "AZM" | "BSD" | "BHD" | "BDT" | "BBD" | "BYR" | "BZD" | "BMD" | "BTN" | "INR" | "BOV" | "BOB" | "BAM" | "BWP" | "BRL" | "BND" | "BGL" | "BGN" | "BIF" | "KHR" | "CAD" | "CVE" | "KYD" | "XAF" | "CLF" | "CLP" | "CNY" | "COP" | "KMF" | "CDF" | "CRC" | "HRK" | "CUP" | "CYP" | "CZK" | "DKK" | "DJF" | "DOP" | "TPE" | "ECV" | "ECS" | "EGP" | "SVC" | "ERN" | "EEK" | "ETB" | "FKP" | "FJD" | "GMD" | "GEL" | "GHC" | "GIP" | "GTQ" | "GNF" | "GWP" | "GYD" | "HTG" | "HNL" | "HKD" | "HUF" | "ISK" | "IDR" | "IRR" | "IQD" | "ILS" | "JMD" | "JPY" | "JOD" | "KZT" | "KES" | "AUD" | "KPW" | "KRW" | "KWD" | "KGS" | "LAK" | "LVL" | "LBP" | "LSL" | "LRD" | "LYD" | "CHF" | "LTL" | "MOP" | "MKD" | "MGF" | "MWK" | "MYR" | "MVR" | "MTL" | "EUR" | "MRO" | "MUR" | "MXN" | "MXV" | "MDL" | "MNT" | "XCD" | "MZM" | "MMK" | "ZAR" | "NAD" | "NPR" | "ANG" | "XPF" | "NZD" | "NIO" | "NGN" | "NOK" | "OMR" | "PKR" | "PAB" | "PGK" | "PYG" | "PEN" | "PHP" | "PLN" | "USD" | "QAR" | "ROL" | "RUB" | "RUR" | "RWF" | "SHP" | "WST" | "STD" | "SAR" | "SCR" | "SLL" | "SGD" | "SKK" | "SIT" | "SBD" | "SOS" | "LKR" | "SDD" | "SRG" | "SZL" | "SEK" | "SYP" | "TWD" | "TJS" | "TZS" | "THB" | "XOF" | "TOP" | "TTD" | "TND" | "TRL" | "TMM" | "UGX" | "UAH" | "AED" | "GBP" | "USS" | "USN" | "UYU" | "UZS" | "VUV" | "VEB" | "VND" | "MAD" | "YER" | "YUM" | "ZMK" | "ZWD" | "ATS" | "CustomCode")

Content:

{ xs:double }

</ns:HighestBid>

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="HighestBid" type="ns:AmountType"/>

ns:ListingStatus

Type:

ns:ListingStatusCodeType, simple content

This enumeration value indicates the listing status of the specified listing.

XML Representation Summary

<ns:ListingStatus>

Content:

{ enumeration of xs:token }

</ns:ListingStatus>

Simple Content

Enumeration:

"Active"	-	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.
"Ended"	-	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.
"Completed"	-	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.
"CustomCode"	-	Reserved for internal or future use.
"Custom"	-	Reserved for internal or future use.

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="ListingStatus" type="ns:ListingStatusCodeType"/>

Overview

Namespace

WSDL

Schema

Component

Index

PREV C-TYPE NEXT C-TYPE

FRAMES NO FRAMES NS-Bindings

SUMMARY: XML REP | DERIVED | USE

DETAIL: DESC | XML SRC | TYPE | ATTR | CHILD

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.