Get details of an abandoned cart using its unique cart ID.
Access scopes
Requires the following access scope: read_orders
Response
A JSON object with the following fields:
Field
Type
Description
cartId
string
ID of the abandoned cart, e.g. 0B299518-FB54-491A-A6E0-5B6BA6E20868
subtotal
number
Order subtotal. Includes the sum of all products' cost in the order
total
number
Order total cost. Includes shipping, taxes, discounts, etc.
email
string
Customer email address
paymentMethod
string
Payment method name
paymentModule
string
Payment processor name
tax
number
Tax total
customerTaxExempt
boolean
true if customer is tax exempt, false otherwise. Learn more
customerTaxId
string
Customer tax ID
customerTaxIdValid
boolean
true if customer tax ID is valid, false otherwise
reversedTaxApplied
boolean
true if order tax was set to 0 because customer specified their valid tax ID in checkout process. false otherwise
b2b_b2c
string
Order type: business-to-business (b2b) or business-to-consumer (b2c)
customerRequestedInvoice
boolean
true if customer requested an invoice, false otherwise
customerFiscalCode
string
Fiscale code of a customer
electronicInvoicePecEmail
string
PEC email for invoices
electronicInvoiceSdiCode
string
SDI code for invoices
ipAddress
string
Customer IP
refererUrl
string
URL of the page when order was placed (without hash (#) part)
orderComments
string
Order comments
couponDiscount
number
Discount applied to order using a coupon
volumeDiscount
number
Sum of discounts based on subtotal. Is included into the discount field
discount
number
The sum of all applied discounts except for the coupon discount. To get the total order discount, take the sum of couponDiscount and discount field values
membershipBasedDiscount
number
Sum of discounts based on customer group. Is included into the discount field
totalAndMembershipBasedDiscount
number
The sum of discount based on subtotal AND customer group. Is included into the discount field
discountCoupon
<DiscountCouponInfo>
Information about applied coupon
discountInfo
Array<DiscountInfo>
Information about applied discounts (coupons are not included)
customerId
number
Unique customer internal ID (if the order is placed by a registered user)
hidden
boolean
Determines if the order is hidden (removed from the list). Applies to unsfinished orders only.
usdTotal
number
Order total in USD
globalReferer
string
URL that the customer came to the store from
createDate
date
The date/time of order placement, e.g 2014-06-06 18:57:19 +0000
updateDate
date
The date/time of the last order change, e.g 2014-06-06 18:57:19 +0000
createTimestamp
number
The date of order placement in UNIX Timestamp format, e.g 1427268654
updateTimestamp
number
The date of the last order change in UNIX Timestamp format, e.g 1427268654
customerGroupId
number
Customer group ID
customerGroup
string
The name of group (membership) the customer belongs to
items
Array<OrderItem>
Order items
billingPerson
<PersonInfo>
Name and billing address of the customer
shippingPerson
<PersonInfo>
Name and address of the person entered in shipping information
shippingOption
<ShippingOptionInfo>
Information about selected shipping option
handlingFee
<HandlingFeeInfo>
Handling fee details
additionalInfo
Map<string,string>
Additional order information if any (reserved for future use)
paymentParams
Map<string,string>
Additional payment parameters entered by customer on checkout, e.g. PO number in "Purchase order" payments
trackingNumber
string
Shipping tracking code
paymentMessage
string
Message from the payment processor if any
externalTransactionId
string
Transaction ID / invoice number of the order in the payment system (e.g. PayPal transaction ID)
affiliateId
string
Affiliate ID
creditCardStatus
<CreditCardStatus>
The status of credit card payment
recoveredOrderId
number
Order number. Is present if the abandoned cart was successfully recovered
recoveryEmailSentTimestamp
string
The date/time of the last order change, e.g 2014-06-06 18:57:19 +0000
acceptMarketing
boolean
true if customer agreed to accept marketing emails. false otherwise.
taxesOnShipping
Array<TaxOnShipping>
Taxes applied to shipping. null for old carts, [] for carts with taxes applied to subtotal only. Are not recalculated if cart is updated later manually. Is calculated like: (shippingRate + handlingFee)*(taxValue/100)
OrderItem
Field
Type
Description
id
number
Order item ID. Can be used to address the item in the order, e.g. to manage ordered items.
productId
number
Store product ID
categoryId
number
ID of the category this product belongs to. If the product belongs to many categories, categoryID will return the ID of the default product category. If the product doesn't belong to any category, 0 is returned
price
number
Price of ordered item in the cart
productPrice
number
Basic product price without options markups, wholesale discounts etc.
weight
number
Product weight
sku
string
Product SKU. If the chosen options match a combination, this will be a combination SKU.
quantity
number
Amount purchased
shortDescription
string
Product description truncated to 120 characters
tax
number
Tax amount applied to the item
shipping
number
Order item shipping cost
quantityInStock
number
The number of products in stock in the store
name
string
Product name
isShippingRequired
boolean
true/false: shows whether the item requires shipping
trackQuantity
boolean
true/false: shows whether the store admin set to track the quantity of this product and get low stock notifications
fixedShippingRateOnly
boolean
true/false: shows whether the fixed shipping rate is set for the product
imageUrl
string
Product image URL
fixedShippingRate
number
Fixed shipping rate for the product
digital
boolean
true/false: shows whether the item has downloadable files attached
couponApplied
boolean
true/false: shows whether a discount coupon is applied for this item
selectedOptions
Array<OrderItemOption>
Product options values selected by the customer
taxes
Array<OrderItemTax>
Taxes applied to this order item
files
Array<OrderItemProductFile>
Files attached to the order item
dimensions
<ProductDimensions>
Product dimensions info
customSurcharges
Array<customSurchargesInfo>
Information about applied surcharges
couponAmount
number
Coupon discount amount applied to item. Provided if discount applied to order. Is not recalculated if order is updated later manually
discounts
Array<OrderItemDiscounts>
Discounts applied to order item 'as is'. Provided if discounts are applied to order (not including discount coupons) and are not recalculated if order is updated later manually
recurringChargeSettings
Array <RecurringChargeSettings>
Subscription product information about subscription charge intervals
isCustomerSetPrice
boolean
true if price for the ordered product was set up by a customer ("Pay What You Want" feature is enabled). false otherwise.
isPreorder
boolean
true if the product is pre-ordered because it was out of stock. Learn more about Accepting pre-orders. Otherwise the field is not returned.
OrderItemTax
Field
Type
Description
name
string
Tax name
value
number
Tax value in percent
total
number
Tax amount for the item
taxOnDiscountedSubtotal
number
Tax on item subtotal (after applying discounts)
taxOnShipping
number
Tax on item shipping
includeInPrice
boolean
true if the tax rate is included in product prices. More details: Taxes in Ecwid
OrderItemProductFile
Field
Type
Description
productFileId
number
Internal unique file ID
maxDownloads
number
Max allowed number of file downloads. See E-goods article in Ecwid Help center for the details
remainingDownloads
number
Remaining number of download attempts
expire
string
Date/time of the customer download link expiration
name
string
File name
description
string
File description defined by the store administrator
size
number
File size, bytes (64-bit integer)
adminUrl
string
Link to the file. Be careful: the link contains the API access token. Make sure you do not display the link as is in your application and not give it to a customer.
customerUrl
string
File download link that is sent to the customer when the order is paid
OrderItemOption
Field
Type
Description
name
string
Option name
type
string
Option type. One of:
CHOICE (dropdown or radio button)
CHOICES (checkboxes)
TEXT (text input and text area)
DATE (date/time)
FILES (upload file option)
value
string
Selected/entered option value(s) as a string. For the CHOICES type, provides a string with all chosen values (comma-separated). You can use this to simply print out all selected values.
valuesArray
Array
Selected option values as an array. For the CHOICES type, provides an array with the chosen values so you can iterate through them in your app.
files
Array<OrderItemOptionFile>
Attached files (if the option type is FILES)
selections
Array<SelectionInfo>
Details of selected product options. If sent in update order request, other fields will be regenerated based on information in this field
OrderItemOptionFile
Field
Type
Description
id
number
File ID
name
string
File name
size
number
File size in bytes
url
string
File URL
SelectionInfo
Field
Type
Description
selectionTitle
string
Selection title, as set by merchant
selectionModifier
number
Selection price modifier amount. Value is negative for negative modifiers
selectionModifierType
string
Price modifier type: "PERCENT" or "ABSOLUTE"
ProductDimensions
Field
Type
Description
length
number
Length of a product
width
number
Width of a product
height
number
Height of a product
PersonInfo
Field
Type
Description
name
string
Full name
companyName
string
Company name
street
string
Address line 1 and address line 2, separated by '\n'
city
string
City
countryCode
string
Two-letter country code
countryName
string
Country name
postalCode
string
Postal/ZIP code
stateOrProvinceCode
string
State code, e.g. NY
stateOrProvinceName
string
State/province name
phone
string
Phone number
customSurchargesInfo
Field
Type
Description
id
string
Surcharge id. If not specified default value: Custom Surcharge
value
number
Surcharge value
type
string
Surcharges type: ABSOLUTE or PERCENT
total
number
Total value of surcharges
totalWithoutTax
number
Total value of surcharges without taxes
description
string
Surcharge description
descriptionTranslated
string
Surcharge description in the translation
taxable
boolean
Controls tax application for the surcharge
taxes
Array<Taxes>
The list of applied taxes
OrderItemDiscounts
Field
Type
Description
discountInfo
<OrderItemDiscountInfo>
Info about discounts applied to item
total
number
Total order item discount value for this discount
OrderItemDiscountInfo
Field
Type
Description
value
number
Discount value
type
string
Discount type: ABS or PERCENT
base
string
Discount base, one of ON_TOTAL, ON_MEMBERSHIP, ON_TOTAL_AND_MEMBERSHIP, CUSTOM
