NAME
eBay::API::XML::DataType::CartType
DESCRIPTION
Details about an eBay Express shopping cart.
SYNOPSIS
INHERITANCE
eBay::API::XML::DataType::CartType inherits from the eBay::API::XML::BaseDataType class
Subroutines:
setCartID()
The ID of the shopping cart.
Default: # Argument: 'xs:long'
getCartID()
Calls: GetCart
SetCart
Returned: Always
# Returns: 'xs:long'
setCartItemArray()
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.
# Argument: 'ns:CartItemArrayType'
getCartItemArray()
Calls: GetCart
SetCart
Returned: Conditionally
# Returns: 'ns:CartItemArrayType'
setCartStatus()
Status of the eBay Express cart.
# Argument: 'ns:OrderStatusCodeType'
getCartStatus()
Calls: GetCart
SetCart
Returned: Always
OnlyTheseValues:
Active, Authenticated, Cancelled, Completed, InProcess, Inactive
# Returns: 'ns:OrderStatusCodeType'
setCheckoutCompleteRedirect()
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.
# Argument: 'ns:CheckoutCompleteRedirectType'
getCheckoutCompleteRedirect()
Calls: GetCart
SetCart
Returned: Conditionally
# Returns: 'ns:CheckoutCompleteRedirectType'
setCheckoutURL()
The eBay-specified URL to which the third party site should direct the user for checking out.
# Argument: 'xs:anyURI'
getCheckoutURL()
Calls: GetCart
SetCart
Returned: Always
# Returns: 'xs:anyURI'
setCreationTime()
Cart creation date time.
# Argument: 'xs:dateTime'
getCreationTime()
Calls: GetCart
SetCart
Returned: Always
# Returns: 'xs:dateTime'
setExpirationTime()
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.
# Argument: 'xs:dateTime'
getExpirationTime()
Calls: GetCart
SetCart
Returned: Always
# Returns: 'xs:dateTime'
setOrderDetail()
Details of the order for the checked out cart. This container and its children are only returned if checkout was completed on eBay Express.
# Argument: 'ns:CheckoutOrderDetailType'
getOrderDetail()
Calls: GetCart
SetCart
Returned: Conditionally
# Returns: 'ns:CheckoutOrderDetailType'
setShippingAddress()
The address to which the items in the cart are to be shipped. This is echoed from the ShippingAddress provided on input, if provided.
# Argument: 'ns:AddressType'
getShippingAddress()
Calls: GetCart
SetCart
Returned: Conditionally
# Returns: 'ns:AddressType'