GetCart - Call Reference - eBay Trading Web Services

GetCart

Retrieves information about an eBay Express shopping cart.

See Shopping Carts and eBay Express Items.

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

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
AffiliateTrackingDetails	AffiliateTrackingDetailsType	Optional	Container for affiliate tags. If you use affiliate tags, it is possible to get affiliate commissions based on calls made by your application. (See the eBay Partner Network for information about commissions.) Affiliate tags enable the tracking of user activity. You can use child tags of AffiliateTrackingDetails if you want call output to include a string, in Item.ListingDetails.ViewItemURL, that includes affiliate tracking information. Affiliate details that you provide appear in the CheckoutURL that is returned by GetCart. Child elements of this element that are marked as conditionally required are required only if this container is present. See Affiliate Tracking Concepts.
AffiliateTrackingDetails .AffiliateUserID	string	Conditional	Need not be specified. You can define an AffiliateUserID (up to 256 characters) if you want to leverage it to better monitor your marketing efforts. If you are using the eBay Partner Network, and you provide an AffiliateUserID, the tracking URL returned by eBay Partner Network will contain the AffiliateUserID, but it will be referred to as a "customid".
AffiliateTrackingDetails .ApplicationDeviceType	ApplicationDeviceTypeCodeType	Conditional	Type of device from which the call originated. For PlaceOffer, if you are using affiliate tracking, this field is required as part of the set of tags you use in the AffiliateTrackingDetails container. Applicable values: • Browser (in) Browser device. • CustomCode (in) Reserved for future use. • Desktop (in) Desktop device. • SetTopTVBox (in) SetTopTVBox device. • Wireless (in) Wireless device.
AffiliateTrackingDetails .TrackingID	string	Conditional	The value you specify is obtained from your tracking partner. For eBay Partner Network, the TrackingID is the Campaign ID ("campid") provided by eBay Partner Network. A Campaign ID is a 9-digit, unique number to be used for associating traffic. A Campaign ID is valid across all programs to which you have been accepted. Another example is the Affiliate ID given to you by TradeDoubler.
AffiliateTrackingDetails .TrackingPartnerCode	string	Conditional	Specifies your tracking partner for affiliate commissions. Affiliates earn money from eBay for driving traffic to eBay. Required if you specify a TrackingID. Depending on your tracking partner, specify one of the following values. Not all partners are valid for all sites. For PlaceOffer, only eBay Partner Network and Mediaplex are valid: 2 = Be Free 3 = Affilinet 4 = TradeDoubler 5 = Mediaplex 6 = DoubleClick 7 = Allyes 8 = BJMT 9 = eBay Partner Network For information about the eBay Partner Network, see eBay Partner Network. See Affiliate Tracking Concepts.
CartID	long	Required	The ID of the shopping cart to inspect, obtained from a prior run of SetCart.
ShippingAddress	AddressType	Optional	The country and postal code to which the items in the cart are to be shipped. Required only if you want shipping costs calculated for those items for which calculated shipping applies. Of no value if there are no items in the cart with calculated shipping.
ShippingAddress.Country	CountryCodeType	Optional	The country code of the user. If not provided as input for GetCart or SetCart, eBay uses the country associated with the SiteID in effect when the call is made. Also applicable to Half.com (for GetOrders). Applicable values: See Country.
ShippingAddress.PostalCode	string	Optional	User's postal code. If not provided as input for GetCart or SetCart, eBay uses the country associated with the SiteID in effect when the call is made. Also applicable to Half.com (for GetOrders). Max length: 12.

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"?>
<GetCartResponse 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 -->
  <Cart> CartType 
    <CartID> long </CartID>
    <CartItemArray> CartItemArrayType 
      <CartItem> CartItemType 
        <Item> ItemType 
          <ItemID> ItemIDType (string) </ItemID>
          <Quantity> int </Quantity>
          <QuantityAvailable> int </QuantityAvailable>
          <Seller> UserType 
            <FeedbackScore> int </FeedbackScore>
            <UserID> UserIDType (string) </UserID>
          </Seller>
          <SellingStatus> SellingStatusType 
            <ConvertedCurrentPrice currencyID="CurrencyCodeType"> AmountType (double) </ConvertedCurrentPrice>
            <CurrentPrice currencyID="CurrencyCodeType"> AmountType (double) </CurrentPrice>
          </SellingStatus>
          <ShippingDetails> ShippingDetailsType 
            <InsuranceDetails> InsuranceDetailsType 
              <InsuranceFee currencyID="CurrencyCodeType"> AmountType (double) </InsuranceFee>
              <InsuranceOption> InsuranceOptionCodeType </InsuranceOption>
            </InsuranceDetails>
            <ShippingServiceOptions> ShippingServiceOptionsType 
              <ShippingInsuranceCost currencyID="CurrencyCodeType"> AmountType (double) </ShippingInsuranceCost>
              <ShippingService> token </ShippingService>
              <ShippingServiceAdditionalCost currencyID="CurrencyCodeType"> AmountType (double) </ShippingServiceAdditionalCost>
              <ShippingServiceCost currencyID="CurrencyCodeType"> AmountType (double) </ShippingServiceCost>
              <ShippingTimeMax> int </ShippingTimeMax>
              <ShippingTimeMin> int </ShippingTimeMin>
            </ShippingServiceOptions>
            <!-- ... more ShippingServiceOptions nodes here ... -->
            <ShippingType> ShippingTypeCodeType </ShippingType>
          </ShippingDetails>
          <Title> string </Title>
        </Item>
        <ReferenceID> long </ReferenceID>
      </CartItem>
      <!-- ... more CartItem nodes here ... -->
    </CartItemArray>
    <CartStatus> OrderStatusCodeType </CartStatus>
    <CheckoutCompleteRedirect> CheckoutCompleteRedirectType 
      <Name> string </Name>
      <URL> anyURI </URL>
    </CheckoutCompleteRedirect>
    <CheckoutURL> anyURI </CheckoutURL>
    <CreationTime> dateTime </CreationTime>
    <ExpirationTime> dateTime </ExpirationTime>
    <OrderDetail> CheckoutOrderDetailType 
      <TotalAmount currencyID="CurrencyCodeType"> AmountType (double) </TotalAmount>
      <TotalCartShippingCost currencyID="CurrencyCodeType"> AmountType (double) </TotalCartShippingCost>
    </OrderDetail>
    <ShippingAddress> AddressType 
      <Country> CountryCodeType </Country>
      <PostalCode> string </PostalCode>
    </ShippingAddress>
  </Cart>
</GetCartResponse>

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
Cart	CartType	Always	Overall cart details.
Cart.CartID	long	Always	The ID of the shopping cart.
Cart.CartItemArray	CartItemArrayType	Conditionally	Array of CartItem (details about items and what is to be done with each, such as add, delete, update). This is only returned if there are items in the cart.
Cart.CartItemArray.CartItem	CartItemType (repeatable)	Conditionally	Details about a cart item and what to do with it (for example, add it to the cart, remove it from the cart, or change the quantity for an item). As a return type, this and its children are only returned if there are items in the cart after the last SetCart operation. This is only required if the parent container is submitted.
Cart.CartItemArray.CartItem .Item	ItemType	Conditionally	When used as input, this is the item to be added, removed or updated in the cart. Only ItemID and Quantity apply. This is only required as input if the parent container is submitted. When returned, this is one of the items remaining in the cart.
Cart.CartItemArray.CartItem .Item.ItemID	ItemIDType (string)	Conditionally	The ID that uniquely identifies the item listing. The ID is generated by eBay after an item is listed. You cannot choose or revise this value. Also applicable to Half.com. For Half.com, you can specify either ItemID or SellerInventoryID in a ReviseItem request to uniquely identify the listing. In GetItemRecommendations, the item ID is required when the value of ListingFlow is ReviseItem or RelistItem, but it is not applicable when the value of ListingFlow is AddItem. In GetSearchResultsExpress, always returned when ItemArray.Item is returned. For GetCart/SetCart input, this is only required if the parent container is submitted. Max length: 19. (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits.).
Cart.CartItemArray.CartItem .Item.Quantity	int	Conditionally	For AddItem and related calls, this is the number of items in the listing. For new listings being defined, this is the initial number of items the seller offers for sale. Even during a Dutch auction, where one of several items can be purchased during the auction, this number does not change. Sellers need to meet certain feedback requirements to specify a quantity greater than 1. 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. For auction items, a change in the auction's quantity could result in a change in the auction type. For example, if the quantity is changed from 1 (a Chinese auction) to 2, the auction is now a Dutch auction. This may impose new requirements and fees on the seller. For GetSellerEvents calls, Quantity is returned only for listings where item quantity is greater than 1. For SetCart input, this is only required if the parent container is submitted. Also applicable to Half.com (valid range 1 to 1000). You can revise this field for Half.com listings.
Cart.CartItemArray.CartItem .Item.QuantityAvailable	int	Conditionally	Specifies how many of a certain item are available. Not applicable to Half.com. For GetSearchResultsExpress, only returned when ItemDetails is set to Fine.
Cart.CartItemArray.CartItem .Item.Seller	UserType	Conditionally	Container for information about this listing's seller. Not applicable to Half.com. In GetSearchResultsExpress, only returned when ItemDetails is set to Fine. Returned by GetCart/SetCart only if there are items in the cart. See (GetSearchResultsExpress) ItemDetails.
Cart.CartItemArray.CartItem .Item.Seller.FeedbackScore	int	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 transactions. Each transaction 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). If the user has chosen to make their feedback private and that user is not the user identified in the request's authentication token, FeedbackScore is not returned and FeedbackPrivate is returned with a value of true. To be eligible to list on Express, a seller's feedback score needs to be 100 or higher. See "eBay Express" in the eBay Web Services guide. In GetSearchResultsExpress, only returned when ItemDetails is set to Fine. In GetSearchResults and GetCategoryListings, feedback information is only returned if IncludeFeedback = true in the request. In GetMyeBayBuying and GetMyeBaySelling, feedback information (FeedbackScore and FeedbackRatingStar) is returned in BidList.ItemArray.Item.Seller. For GetMyeBayBuying, the feedback score of each seller with an item having received a bid from the buyer is returned. For GetMyeBaySelling, the feedback score of the seller is returned. GetMyeBayBuying and GetMyeBaySelling also return feedback information (FeedbackScore and FeedbackRatingStar) in BidList.ItemArray.Item.SellingStatus.HighBidder. GetMyeBayBuying returns feedback information on the high bidder of each item the buyer is bidding on. GetMyeBaySelling returns feedback information on the high bidder of each item the seller is selling. 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. See Working with Anonymous User Information.
Cart.CartItemArray.CartItem .Item.Seller.UserID	UserIDType (string)	Conditionally	Unique eBay user ID for the user. In GetSearchResultsExpress, only returned when ItemDetails is set to Fine. Since a bidder's user info 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: 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, "IA". Note that in this format, the anonymous bidder ID stays the same for every auction. (GetMyeBayBuying 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. When bidding on items listed on the 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. 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". (GetMyeBayBuying only) when bidding on items listed on the UK and AU sites: UserID is replaced with the string "High Bidder". See Working with Anonymous User Information.
Cart.CartItemArray.CartItem .Item.SellingStatus	SellingStatusType	Conditionally	Various details about the current status of the listing, such as the current number of bids and the current high bidder. Not applicable to Half.com. For GetSearchResultsExpress, this is always returned when ItemArray.Item is returned. Returned by GetCart/SetCart only if there are items in the cart.
Cart.CartItemArray.CartItem .Item.SellingStatus .ConvertedCurrentPrice	AmountType (double)	Conditionally	Converted value of the CurrentPrice 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.
Cart.CartItemArray.CartItem .Item.SellingStatus .ConvertedCurrentPrice [ attribute currencyID ]	CurrencyCodeType	Conditionally	Currency in which the monetary amount is specified. In the AddItem family of calls, the currency can be specified in the Item.Currency field instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. For a list of possible enumeration values, see CurrencyCodeType.
Cart.CartItemArray.CartItem .Item.SellingStatus .CurrentPrice	AmountType (double)	Conditionally	For competitive-bidding listings (Chinese and Dutch auctions), current minimum asking price (start price) or the current highest bid for the item if bids have been placed. Shows minimum bid if no bids have been placed on the item. For Basic Fixed-Price (FixedPriceItem), Store Inventory (StoresFixedPrice), or Ad type (AdType) listings this returns the original price specified when the item was listed/re-listed or the revised price if the item was revised using the ReviseItem call. For GetSearchResultsExpress, this is the current fixed price of the listing, and it is always returned when ItemArray.Item is returned.
Cart.CartItemArray.CartItem .Item.SellingStatus .CurrentPrice [ attribute currencyID ]	CurrencyCodeType	Conditionally	Currency in which the monetary amount is specified. In the AddItem family of calls, the currency can be specified in the Item.Currency field instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. For a list of possible enumeration values, see CurrencyCodeType.
Cart.CartItemArray.CartItem .Item.ShippingDetails	ShippingDetailsType	Conditionally	The shipping-related details for an item or transaction, including flat and calculated shipping costs and shipping insurance costs. 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 GetCategoryFeatures returns true for Category.ShippingTermsRequired. For multi-quantity Store Inventory Format listings and 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. For a listing to be eligible for eBay Express, shipping details are required (to support the eBay Express shopping cart). For flat shipping, this means the shipping service and cost are required. For calculated shipping, it means all of the usual parameters (weight, originating postal code, etc.) are required. See the the eBay Web Services Guide links below for more information. In GetSearchResultsExpress, always returned when ItemArray.Item is returned. This container is returned by GetCart or SetCart only when a valid postal code is provided for the country (see SetCart.ShippingAddress) and there is at least one item in the shopping cart for which calculated shipping is offered. Shipping details are not applicable to Real Estate listings and Half.com. See: Determining Shipping Costs for a Listing Specify Domestic Shipping Costs for Express and eBay Revising Items for restrictions on changing item properties with ReviseItem
Cart.CartItemArray.CartItem .Item.ShippingDetails .InsuranceDetails	InsuranceDetailsType	Conditionally	Container for domestic insurance information. (Note that there are fields named InsuranceFee and InsuranceOption at the same level as this container. These were once used for representing both domestic and international insurance details.) If this (newer) container is provided on input and if ShippingDetails.InsuranceFee or ShippingDetails.InsuranceOption are also provided, those two (older fields) are ignored. If this container is omitted on input, its InsuranceFee and InsuranceOption subfields are set to match whatever (the older fields) ShippingDetails.InsuranceFee and ShippingDetails.InsuranceOption are set to. For flat and calculated shipping, depending on which subfields are used.
Cart.CartItemArray.CartItem .Item.ShippingDetails .InsuranceDetails.InsuranceFee	AmountType (double)	Conditionally	Cost of shipping insurance set by the seller. If the buyer bought more than one of this item, this is the insurance for just a single item. Exception: for GetItemShipping, this is proportional to QuantitySold. Default is 0.00. Value should be greater than 0.00 if InsuranceOption is Optional or Required. For flat shipping only. Optional as input and only allowed if ChangePaymentInstructions is true. Also applicable to Half.com (for GetOrders). This field is ignored when Item.ListingType=Express.
Cart.CartItemArray.CartItem .Item.ShippingDetails .InsuranceDetails.InsuranceFee [ attribute currencyID ]	CurrencyCodeType	Conditionally	Currency in which the monetary amount is specified. In the AddItem family of calls, the currency can be specified in the Item.Currency field instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. For a list of possible enumeration values, see CurrencyCodeType.
Cart.CartItemArray.CartItem .Item.ShippingDetails .InsuranceDetails .InsuranceOption	InsuranceOptionCodeType	Conditionally	Whether the seller offers shipping insurance and, if so, whether the insurance is optional or required. Flat and calculated shipping. Optional as input and only allowed if ChangePaymentInstructions is true. Also applicable to Half.com (for GetOrders). This field is ignored when Item.ListingType=Express. Applicable values: • CustomCode (in/out) Reserved for internal or future use • IncludedInShippingHandling (in/out) The seller is not charging separately for shipping insurance costs; any insurance is already included in the base shipping cost. • NotOffered (in/out) The seller does not offer shipping insurance to the buyer. • NotOfferedOnSite (out) 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. • Optional (in/out) The seller offers the buyer the choice of paying for shipping insurance or not. • Required (in/out) The seller requires that the buyer pay for shipping insurance.
Cart.CartItemArray.CartItem .Item.ShippingDetails .ShippingServiceOptions	ShippingServiceOptionsType (repeatable)	Conditionally	Shipping costs and options related to domestic shipping services offered by the seller. Flat and calculated shipping. Required if InternationalShippingServiceOption is specified. If you specify multiple ShippingServiceOptions nodes, the repeating nodes must be contiguous. For example, you can insert InternationalShippingServiceOption nodes after a list of repeating ShippingServiceOptions nodes, but not between them: <ShippingServiceOptions>...</ShippingServiceOptions> <ShippingServiceOptions>...</ShippingServiceOptions> <ShippingServiceOptions>...</ShippingServiceOptions> <InternationalShippingServiceOption>...</InternationalShippingServiceOption> <InternationalShippingServiceOption>...</InternationalShippingServiceOption> If you specify ShippingDetails when you revise or relist an item but you omit ShippingServiceOptions, 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. To retain the shipping services and dependent fields when you modify other shipping details, it may be simplest to specify all ShippingDetails that you still want to include in the listing. Not applicable to Half.com or eBay Motors vehicle listings. See Overview of the API Schema for rules regarding repeating instances of a nodes (nodes for which maxOccurs is "unbounded" or is greater than 1).
Cart.CartItemArray.CartItem .Item.ShippingDetails .ShippingServiceOptions .ShippingInsuranceCost	AmountType (double)	Conditionally	The insurance cost associated with shipping a single item with this shipping service. Exception: for GetItemShipping, this is proportional to QuantitySold. If the item has not yet been sold, insurance information cannot be calculated and the value is 0.00. For calculated shipping only. Also applicable to Half.com (for GetOrders). See Determining Shipping Costs for a Listing.
Cart.CartItemArray.CartItem .Item.ShippingDetails .ShippingServiceOptions .ShippingInsuranceCost [ attribute currencyID ]	CurrencyCodeType	Conditionally	Currency in which the monetary amount is specified. In the AddItem family of calls, the currency can be specified in the Item.Currency field instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. For a list of possible enumeration values, see CurrencyCodeType.
Cart.CartItemArray.CartItem .Item.ShippingDetails .ShippingServiceOptions .ShippingService	token	Conditionally	A domestic shipping service offered for shipping the item (for example, UPS Ground). For a list of valid values that you can cache for future use, call GeteBayDetails with DetailName set to ShippingServiceDetails. For flat and calculated shipping. Also applicable to Half.com (for GetOrders). See GeteBayDetails.
Cart.CartItemArray.CartItem .Item.ShippingDetails .ShippingServiceOptions .ShippingServiceAdditionalCost	AmountType (double)	Conditionally	The cost of shipping each additional item beyond the first item. For input, this is required if the listing is for multiple items and should be zero for single-item listings. Default value is 0.00. For flat shipping only. Not applicable to Half.com. See Determining Shipping Costs for a Listing.
Cart.CartItemArray.CartItem .Item.ShippingDetails .ShippingServiceOptions .ShippingServiceAdditionalCost [ attribute currencyID ]	CurrencyCodeType	Conditionally	Currency in which the monetary amount is specified. In the AddItem family of calls, the currency can be specified in the Item.Currency field instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. For a list of possible enumeration values, see CurrencyCodeType.
Cart.CartItemArray.CartItem .Item.ShippingDetails .ShippingServiceOptions .ShippingServiceCost	AmountType (double)	Conditionally	The meaning of this element depends on the call and on whether flat or calculated shipping has been selected. (For example, it could be the cost to ship a single item, the cost to ship all items, or the cost to ship just the first of many items, with ShippingServiceAdditionalCost accounting for the rest.) When returned by GetItemShipping, it includes the packaging and handling cost. For flat and calculated shipping. Also applicable to Half.com (for GetOrders). For applications processing an Express transaction when the transaction is part of an Express Order, ShippingServiceCost will have a value of 0. This is generally because the ShippingServiceCost of an Order is not returned by each transaction included in that Order when making the GetItemTransactions or GetSellerTransactions call. This is regardless of whether the Order is an Express Order or a regular eBay site Order. This is a known issue and a current product limitation for Orders and Transactions in general. See Determining Shipping Costs for a Listing.
Cart.CartItemArray.CartItem .Item.ShippingDetails .ShippingServiceOptions .ShippingServiceCost [ attribute currencyID ]	CurrencyCodeType	Conditionally	Currency in which the monetary amount is specified. In the AddItem family of calls, the currency can be specified in the Item.Currency field instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. For a list of possible enumeration values, see CurrencyCodeType.
Cart.CartItemArray.CartItem .Item.ShippingDetails .ShippingServiceOptions .ShippingTimeMax	int	Conditionally	The maximum guaranteed number of days the shipping carrier will take to ship an item (not including the time it takes the seller to deliver the item to the shipping carrier). See Enabling Get It Fast. Not applicable to Half.com.
Cart.CartItemArray.CartItem .Item.ShippingDetails .ShippingServiceOptions .ShippingTimeMin	int	Conditionally	The minimum guaranteed number of days in which the shipping carrier can ship an item (not including the time it takes the seller to deliver the item to the shipping carrier). See Enabling Get It Fast. Not applicable to Half.com.
Cart.CartItemArray.CartItem .Item.ShippingDetails .ShippingType	ShippingTypeCodeType	Conditionally	The shipping cost model offered by the seller. This is not returned for various calls since shipping type can be deduced: if a CalculatedShippingRate structure is returned by the call, the shipping type is Calculated. Otherwise, it is one of the other non-Calculated shipping types. Not applicable to Half.com. Applicable values: • Calculated (in/out) 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. • CalculatedDomesticFlatInternational (in/out) The seller specified one or more calculated domestic shipping services and one or more flat international shipping services. • CustomCode (in/out) Reserved for future use. • Flat (in/out) 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. • FlatDomesticCalculatedInternational (in/out) The seller specified one or more flat domestic shipping services and one or more calculated international shipping services. • Freight (out) Freight shipping model: the cost of shipping is determined by a third party, FreightQuote.com, based on the item location (zip code). Currently, Freight can only be specified on input via eBay Web site, not API. • FreightFlat (in/out) Freight shipping model: freight shipping may be used when flat or calculated shipping cannot be used due to the greater weight of the item. See "Specifying Freight Shipping" in the Shipping chapter for details on freight shipping. • NotSpecified (in/out) The seller did not specify the shipping type. (Not all values in ShippingTypeCodeType apply to this field.)
Cart.CartItemArray.CartItem .Item.Title	string	Conditionally	Name of the item as it appears in the listing or search results. Required for most items. Optional if you list in Books, Music, Movies, or Video Games categories and you use Pre-filled Item Information (as the title can be pre-filled based on the catalog product title). That is, optional if you specify Item.ExternalProductID or Item.ProductListingDetails. You cannot use HTML or JavaScript in the Title. (HTML characters will be interpreted literally as plain text.) For AddItem, not applicable to Half.com. For GetOrders, not returned from eBay.com, but a title from the Half.com catalog is returned from Half.com instead. You can add or change the value of this tag only if an item has no bids (or no items have sold) and the listing does not end for 12 hours. In GetSearchResultsExpress, always returned when ItemArray.Item is returned. In GetItemRecommendations, more keywords in the title usually results in more relevant recommendations. Max length: 55.
Cart.CartItemArray.CartItem .ReferenceID	long	Conditionally	An ID created by eBay and returned along with an item, if items are returned. This ID must be provided on input to SetCart along with the corresponding item when doing a Delete or Update related to that item.
Cart.CartStatus	OrderStatusCodeType	Always	Status of the eBay Express cart. Applicable values: • Active (in/out) The cart is active. Items can only be added, deleted, or updated in the cart when status is Active. • Authenticated (out) The cart was authenticated. • Cancelled (out) The cart was cancelled. • Completed (in/out) The order is completed. • Inactive (out) The cart is invalid; it does not exist. An example is a cart that has expired. • InProcess (out) After placing the order and before completion of checkout, the card is "in process." (Not all values in OrderStatusCodeType apply to this field.)
Cart.CheckoutCompleteRedirect	CheckoutCompleteRedirectType	Conditionally	When the user has completed eBay Express checkout with the shopping cart, the user is shown a link to your website. The values of this element were established via SetCart input.
Cart.CheckoutCompleteRedirect .Name	string	Conditionally	The name of the third party site (the visible text to display for the link defined in the URL element). This is only returned if it was set via SetCart input.
Cart.CheckoutCompleteRedirect .URL	anyURI	Conditionally	The URL of the third party site. This is only returned if it was set via SetCart input.
Cart.CheckoutURL	anyURI	Always	The eBay-specified URL to which the third party site should direct the user for checking out.
Cart.CreationTime	dateTime	Always	Cart creation date time.
Cart.ExpirationTime	dateTime	Always	The time at which the cart will no longer exist in the eBay Express domain. This is currently 7 days after the CreationTime but may be changed by eBay in the future.
Cart.OrderDetail	CheckoutOrderDetailType	Conditionally	Details of the order for the checked out cart. This container and its children are only returned if checkout was completed on eBay Express.
Cart.OrderDetail.TotalAmount	AmountType (double)	Conditionally	The overall total cost (including item cost, shipping cost and taxes).
Cart.OrderDetail.TotalAmount [ attribute currencyID ]	CurrencyCodeType	Conditionally	Currency in which the monetary amount is specified. In the AddItem family of calls, the currency can be specified in the Item.Currency field instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. For a list of possible enumeration values, see CurrencyCodeType.
Cart.OrderDetail .TotalCartShippingCost	AmountType (double)	Conditionally	The total shipping cost of all items in the cart.
Cart.OrderDetail .TotalCartShippingCost [ attribute currencyID ]	CurrencyCodeType	Conditionally	Currency in which the monetary amount is specified. In the AddItem family of calls, the currency can be specified in the Item.Currency field instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. For a list of possible enumeration values, see CurrencyCodeType.
Cart.ShippingAddress	AddressType	Conditionally	The address to which the items in the cart are to be shipped. This is echoed from the ShippingAddress provided on input, if provided.
Cart.ShippingAddress.Country	CountryCodeType	Conditionally	The country code of the user. If not provided as input for GetCart or SetCart, eBay uses the country associated with the SiteID in effect when the call is made. Also applicable to Half.com (for GetOrders). Applicable values: See Country.
Cart.ShippingAddress .PostalCode	string	Conditionally	User's postal code. If not provided as input for GetCart or SetCart, eBay uses the country associated with the SiteID in effect when the call is made. Also applicable to Half.com (for GetOrders). Max length: 12.

GetCart Detail Controls

Detail Control: DetailLevel

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

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

GetCart Change History

Version	Description
507 2007-04-04	(modified) eBay Express supports Half.com listings. These listings are treated like any other listings in the Express shopping cart.
495 2007-01-10	(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