GetExpressWishList - Call Reference - eBay Trading Web Services

GetExpressWishList

Enables users to retrieve and view eBay Express wish lists. Wish list is a feature currently available on the eBay Express web site. This call does not enable creation, modification, or removal of wish lists. Wish lists may be public or private. Private wish lists are available for viewing only by their owners. User ID is not returned in the response. Only one of the search input fields, (FirstName, LastName, UserID, and WishListID) is recognized in a request. When all search input fields are included in a request, WishListID takes precedence, followed by UserID, which is followed by FirstName and/or LastName. If none of the search input fields are used, the call returns the wish list of the requesting user.

GetExpressWishList Input

The box below lists all fields that could be included in the call request. To learn more about an individual field or its type, click its name in the box (or scroll down to find it in the table below the box).

See also Samples.

See also the Deprecated Objects link above. Fields presented in this color are deprecated, and fields presented in this color are (or soon will be) non-operational.

The XML prototype may be missing some XML fields and attributes. This is a documentation limitation only (see Limitations of This Document).

<?xml version="1.0" encoding="utf-8"?>
<GetExpressWishListRequest xmlns="urn:ebay:apis:eBLBaseComponents">
  <!-- Standard Input Fields -->
  <ErrorLanguage> string </ErrorLanguage>
  <MessageID> string </MessageID>
  <OutputSelector> string </OutputSelector>
  <!-- ... more OutputSelector nodes here ... -->
  <Version> string </Version>
  <WarningLevel> WarningLevelCodeType </WarningLevel>
  <!-- Call-specific Input Fields -->
  <FirstName> string </FirstName>
  <LastName> string </LastName>
  <Pagination> PaginationType 
    <EntriesPerPage> int </EntriesPerPage>
    <PageNumber> int </PageNumber>
  </Pagination>
  <SortOrder> WishListSortCodeType </SortOrder>
  <UserID> string </UserID>
  <WishListID> string </WishListID>
</GetExpressWishListRequest>

Argument	Type	Reqd?	Meaning
Standard Input Fields [Jump to call-specific fields]
ErrorLanguage	string	Optional	Use ErrorLanguage 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. Specify the standard RFC 3066 language identification tag (e.g., en_US). ID--- country ----- ----- de_AT Austria de_CH Switzerland de_DE Germany en_AU Australia en_CA Canada en_GB United Kingdom en_SG Singapore en_US United States es_ES Spain fr_BE Belgium (French) fr_CA Canada (French) fr_FR France it_IT Italy nl_BE Belgium (Dutch) nl_NL Netherlands zh_CN China en_IN India en_IE Ireland zh_HK Hong Kong See Tags for the Identification of Languages.
MessageID	string	Optional	In most cases, all calls support a MessageID element in the request and a CorrelationID element in the response. If you pass a message ID in a request, we will return the same value in CorrelationID in the response. You can use this for tracking that a response is returned for every request and to match particular responses to particular requests. If you do not pass MessageID in the request, CorrelationID is not returned. Note: GetCategories, GetAttributesCS, GetCategory2CS, GetAttributesXSL, GetProductFinder, GetProductFinderXSL, and GetProductSearchPage 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, the MessageID and CorrelationID 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, MessageID and CorrelationID are applicable.
OutputSelector	string (repeatable)	Optional	You can use the OutputSelector field to restrict the data returned by this call. When you make a call such as GetItem that retrieves data from eBay, the OutputSelector field is useful for restricting the data returned. This field makes the call response easier to use, especially when a large payload would be returned. If you use the OutputSelector field, the output data will include only the fields you specified in the request. For example, if you are using GetItem and you want the item data in the response to be restricted to the ViewItemURL (the URL where a user can view the listing) and BuyItNowPrice, then within the GetItem request, specify those output fields. To use this field, see the information at the following link. See Selecting Fields to Retrieve.
Version	string	Conditional	The version number of the API code that you are programming against (e.g., 549). The version you specify for a call has these basic effects: - It indicates the version of the code lists and other data that eBay should use to process your request. - It indicates the schema version you are using. You need to use a version that is greater than or equal to the lowest supported version. For the SOAP API: If you are using the SOAP API, this field is required. Specify the version of the WSDL your application is using. For the XML API: If you are using the XML API, this field has no effect. Instead, specify the version in the X-EBAY-API-COMPATIBILITY-LEVEL HTTP header. (If you specify Version 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.) See: HTTP Headers (XML API Only) eBay Schema Versioning Strategy Lowest Supported Version
WarningLevel	WarningLevelCodeType	Optional	Controls whether or not to return warnings when the application passes unrecognized or deprecated elements in a request. An unrecognized element is one that is not defined in any supported version of the schema. Schema element names are case-sensitive, so using WarningLevel 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. WarningLevel 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. We recommend that you only use this during development and debugging. Do not use this in requests in your production code. Applicable values: • High (in) Return warnings when the application passes unrecognized or deprecated elements in a request. • Low (in) Do not return warnings when the application passes unrecognized or deprecated elements in a request. This is the default value if WarningLevel is not specified. See Warning Level.
Call-specific Input Fields
FirstName	string	Optional	User first name. Can be used in combination with LastName. Will be ignored if either UserID or WishListID is included in the request.
LastName	string	Optional	User last name. Can be used in combination with FirstName. Will be ignored if either UserID or WishListID is included in the request.
Pagination	PaginationType	Optional	Contains the data that control the pagination of items or products in any returned wish list.
Pagination.EntriesPerPage	int	Optional	Specifies the maximum number of entries to return in a single call. If the number of entries that can be returned is less than the value in EntriesPerPage, then the lower number is returned. For most calls, the max is 200 and the default is 25. For GetUserDisputes, the value is hard-coded at 200, and any input is ignored. For GetProducts, the maximum is 20 (and higher values are ignored). See the annotations for other individual calls to determine the correct max and default values. For GetOrders, not applicable to eBay.com (but applicable to Half.com for GetOrders).
Pagination.PageNumber	int	Optional	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 other individual calls to determine the correct default value. For GetOrders, not applicable to eBay.com (for GetOrders, applicable to Half.com). Min: 0. Max: 2147483647. Default: 0.
SortOrder	WishListSortCodeType	Optional	Sort order for returned results. Default is CreationDateDescending, which returns the most recently added wish list items first. Applicable values: • CreationDateAscending (in) Return older wish list items first. • CreationDateDescending (in) Return recently added wish list items first. This is the default sorting order. • CustomCode (in) Reserved for internal or future use. • PriceAscending (in) Return lowest priced items and products first. Note that price rankings will not take shipping costs into account. • PriceDescending (in) Return highest priced items and products first. Note that price rankings will not take shipping costs into account.
UserID	string	Optional	eBay user ID. Can be used as an alternative to WishListID or to the combination FirstName and LastName. If WishListID is used, UserID will be ignored. This value is not returned in the response.
WishListID	string	Optional	Identifies an eBay Express wish list. When used in a request, UserID and FirstName and LastName are ignored.

GetExpressWishList Output

The box below lists all fields that might be returned in the call response. To learn more about an individual field or its type, click its name in the box (or scroll down to find it in the table below the box).

See also Samples.

See also the Deprecated Objects link above. Fields presented in this color are deprecated, and fields presented in this color are not returned (or soon will not be returned) or are not operational (or soon will be non-operational).

The XML prototype may be missing some XML fields and attributes. This is a documentation limitation only (see Limitations of This Document).

<?xml version="1.0" encoding="utf-8"?>
<GetExpressWishListResponse xmlns="urn:ebay:apis:eBLBaseComponents">
  <!-- Standard Output Fields -->
  <Ack> AckCodeType </Ack>
  <Build> string </Build>
  <CorrelationID> string </CorrelationID>
  <Errors> ErrorType 
    <ErrorClassification> ErrorClassificationCodeType </ErrorClassification>
    <ErrorCode> token </ErrorCode>
    <ErrorParameters ParamID="string"> ErrorParameterType 
      <Value> string </Value>
    </ErrorParameters>
    <!-- ... more ErrorParameters nodes here ... -->
    <LongMessage> string </LongMessage>
    <SeverityCode> SeverityCodeType </SeverityCode>
    <ShortMessage> string </ShortMessage>
  </Errors>
  <!-- ... more Errors nodes here ... -->
  <HardExpirationWarning> string </HardExpirationWarning>
  <Timestamp> dateTime </Timestamp>
  <Version> string </Version>
  <!-- Call-specific Output Fields -->
  <Pagination> PaginationResultType 
    <TotalNumberOfEntries> int </TotalNumberOfEntries>
    <TotalNumberOfPages> int </TotalNumberOfPages>
  </Pagination>
  <WishList> WishListType 
    <Description> string </Description>
    <FirstName> string </FirstName>
    <LastName> string </LastName>
    <Name> string </Name>
    <UserLocation> string </UserLocation>
    <WishListEntry> WishListEntryType 
      <CreationDate> dateTime </CreationDate>
      <Item> ItemType 
        <ExpressDetails> ExpressDetailsType 
          <ExpressSmallImage> anyURI </ExpressSmallImage>
        </ExpressDetails>
      </Item>
      <Notes> string </Notes>
      <Product> ExpressProductType 
        <DetailsURL> anyURI </DetailsURL>
        <ItemCount> int </ItemCount>
        <MaxPrice> AmountType (double) </MaxPrice>
        <MinPrice> AmountType (double) </MinPrice>
        <ProductReferenceID> long </ProductReferenceID>
        <StockPhotoURL> anyURI </StockPhotoURL>
        <Title> string </Title>
      </Product>
      <QuantityReceived> int </QuantityReceived>
      <QuantityWanted> int </QuantityWanted>
    </WishListEntry>
    <!-- ... more WishListEntry nodes here ... -->
    <WishListID> string </WishListID>
    <WishListURL> anyURI </WishListURL>
  </WishList>
  <!-- ... more WishList nodes here ... -->
</GetExpressWishListResponse>

Return Value	Type	Returned?	Meaning
Standard Output Fields [Jump to call-specific fields]
Ack	AckCodeType	Always	A token representing the application-level acknowledgement code that indicates the response status (e.g., success). The AckCodeType list specifies the possible values for Ack. Applicable values: • CustomCode (out) Reserved for internal or future use. • Failure (out) Request processing failed • Success (out) Request processing succeeded • Warning (out) Request processing completed with warning information being included in the response message (Not all values in AckCodeType apply to this field.)
Build	string	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.
CorrelationID	string	Conditionally	In most cases, all calls support a MessageID element in the request and a CorrelationID element in the response. If you pass a message ID in a request, we will return the same value in CorrelationID in the response. You can use this for tracking that a response is returned for every request and to match particular responses to particular requests. If you do not pass MessageID in the request, CorrelationID is not returned. Note: GetCategories, GetAttributesCS, GetCategory2CS, GetAttributesXSL, GetProductFinder, GetProductFinderXSL, and GetProductSearchPage 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, the MessageID and CorrelationID 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, MessageID and CorrelationID are applicable.
Errors	ErrorType (repeatable)	Conditionally	A list of application-level errors (if any) that occurred when eBay processed the request. See Error Handling.
Errors.ErrorClassification	ErrorClassificationCodeType	Conditionally	API errors are divided between two classes: system errors and request errors. Applicable values: • CustomCode (out) Reserved for internal or future use. • RequestError (out) 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. • SystemError (out) 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.
Errors.ErrorCode	token	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.
Errors.ErrorParameters	ErrorParameterType (repeatable)	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 ErrorType are returned.
Errors.ErrorParameters [ attribute ParamID ]	string	Conditionally	The index of the parameter in the list of parameter types returned within the error type.
Errors.ErrorParameters.Value	string	Conditionally	The value of the variable (e.g., the attribute set ID)
Errors.LongMessage	string	Conditionally	A more detailed description of the condition that raised the error.
Errors.SeverityCode	SeverityCodeType	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. Applicable values: • CustomCode (out) Reserved for internal or future use • Error (out) Application-level error • Warning (out) Warning or informational error
Errors.ShortMessage	string	Conditionally	A brief description of the condition that raised the error.
HardExpirationWarning	string	Conditionally	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.
Timestamp	dateTime	Always	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 Time Values in the eBay Web Services guide for information about this time format and converting to and from the GMT time zone. Note: GetCategories, GetAttributesCS, GetCategory2CS, GetAttributesXSL, GetProductFinder, GetProductFinderXSL, and GetProductSearchPage 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.
Version	string	Always	The version of the response payload schema. Indicates the version of the schema that eBay used to process the request. See "Standard Data for All Calls" in the eBay Web Services Guide for information on using the response version when troubleshooting "CustomCode" values that appear in the response.
Call-specific Output Fields
Pagination	PaginationResultType	Always	Child elements control the display pagination of the items and products in retrieved wish lists.
Pagination .TotalNumberOfEntries	int	Always	Indicates the total number of entries that could be returned by repeated requests. For GetOrders, not applicable to eBay.com (for GetOrders, applicable to Half.com). Returned with a value of 0 if no entries are available.
Pagination.TotalNumberOfPages	int	Always	Indicates the total number of pages of data that could be returned by repeated requests. For GetOrders, not applicable to eBay.com (for GetOrders, applicable to Half.com). Returned with a value of 0 if no pages are available.
WishList	WishListType (repeatable)	Always	Contains the contents and description of the requested wish list.
WishList.Description	string	Conditionally	User-entered description of the wish list.
WishList.FirstName	string	Always	eBay user first name.
WishList.LastName	string	Always	eBay user last name.
WishList.Name	string	Always	The user-assigned name of the wish list.
WishList.UserLocation	string	Always	Location of the creator of the wish list (Example: CA, United States).
WishList.WishListEntry	WishListEntryType (repeatable)	Conditionally	Product or item the user has added to the wish list. Returned only if request specifies WishListID.
WishList.WishListEntry .CreationDate	dateTime	Always	Date the item or product was added to the wish list.
WishList.WishListEntry.Item	ItemType	Conditionally	Item details, returned if the wish list entry is an item, as opposed to a product.
WishList.WishListEntry.Item .ExpressDetails	ExpressDetailsType	Always	Additional item details that only appear in eBay Express search results. In GetSearchResultsExpress, only returned when ItemDetails is set to Fine.
WishList.WishListEntry.Item .ExpressDetails .ExpressSmallImage	anyURI	Always	Small gallery image that appears in the "List View" in search results on the Express site. The longest dimension is 96 pixels. Only returned when ItemDetails is set to Fine. Express generates the image based on pictures that the seller includes in the listing. For details about Express listing criteria, see the eBay Web Services Guide link below. If the item was listed in an eBay category that does not require pictures for Express (like Tickets), a generic image may be returned instead. See Listing Criteria for eBay Express.
WishList.WishListEntry.Notes	string	Conditionally	Notes the user has entered about the product or item, only returned if notes exist.
WishList.WishListEntry.Product	ExpressProductType	Conditionally	Product details, returned if the wish list entry is a product, as opposed to an item.
WishList.WishListEntry.Product .DetailsURL	anyURI	Conditionally	Fully qualified URL for optional information about the product, such as a movie's description or film credits. This information is hosted through the eBay.com Web site and it cannot be edited. Portions of the content are protected by copyright. Applications can include this URL as a link in product search results so that end users can view additional descriptive details about the product. This is usually always returned when Product is returned, but it may be safest to check for the existence of this field.
WishList.WishListEntry.Product .ItemCount	int	Always	Total number of active listings (on the specified Express site) that were pre-filled based on this eBay catalog product. Only returned when ProductDetails is set to Fine. This does not necessarily match the number of items returned in ItemArray (if any), because the call returns deduped items in ItemArray.
WishList.WishListEntry.Product .MaxPrice	AmountType (double)	Always	Highest current price of active and ended listings on the specified eBay site that were pre-filled based on this product. The value is in the Express site's currency (i.e., not converted). Round numbers might only show one zero after the decimal (e.g., 15.0). Always returned when Product is returned. Excludes shipping costs.
WishList.WishListEntry.Product .MinPrice	AmountType (double)	Always	Lowest current price of active and ended listings on the specified eBay site that were pre-filled based on the eBay catalog product. The value is in the Express site's currency (i.e., not converted). Round numbers might only show one zero after the decimal (e.g., 15.0). Always returned when Product is returned. Excludes shipping costs.
WishList.WishListEntry.Product .ProductReferenceID	long	Always	The global reference ID for the eBay catalog product. For GetSearchResultsExpress, only returned when ProductDetails is set to Fine. Note: This value is not the same as the ProductID used in AddItem and related calls. A ProductID represents a particular version of a catalog product, which is associated with a particular set of Item Specifics and other details. A ProductReferenceID is a more generic or global reference to a catalog product, which is useful for buy-side searching. One ProductReferenceID can be associated with multiple ProductIDs.
WishList.WishListEntry.Product .StockPhotoURL	anyURI	Always	Fully qualified URL for a stock image (if any) that is associated with the eBay catalog product. For GetSearchResultsExpress, only returned when ProductDetails is set to Fine.
WishList.WishListEntry.Product .Title	string	Always	The title of the eBay catalog product. Always returned when Product is returned.
WishList.WishListEntry .QuantityReceived	int	Always	Quantity of the item or product already received by the user.
WishList.WishListEntry .QuantityWanted	int	Always	User-specified desired quantity of the item or product.
WishList.WishListID	string	Always	ID that uniquely identifies an eBay Express wish list.
WishList.WishListURL	anyURI	Always	The URL of the wish list.

GetExpressWishList Detail Controls

Detail Control: DetailLevel

This call does not support varying Detail Levels. You do not need to pass DetailLevel in the request.

GetExpressWishList Samples

An inline sample will be added in a future release. Please refer to the Samples section of the eBay Web Services Guide chapter for GetExpressWishList.

GetExpressWishList Change History

Version	Description
535 2007-10-17	(added) New call.

User-Contributed Notes

This document was generated with a customized version of the apireferencedocs tool [0.5M zip].

eBay Trading API Call Reference Version 573

eBay Trading API
Call Reference Version 573