Get cart

Get details of an abandoned cart using its unique cart ID.


AuthorizationstringoAuth token with mandatory Bearer before it. Example: Bearer e***s0, where e***s0 should be replaced with your oAuth token.


A JSON object of type 'OrderEntry' with the following fields:


cartIdstringID of the abandoned cart, e.g. 0B299518-FB54-491A-A6E0-5B6BA6E20868
subtotalnumberOrder subtotal. Includes the sum of all products' cost in the order
totalnumberOrder total cost. Includes shipping, taxes, discounts, etc.
emailstringCustomer email address
paymentMethodstringPayment method name
paymentModulestringPayment processor name
taxnumberTax total
customerTaxExemptbooleantrue if customer is tax exempt, false otherwise. Learn more
customerTaxIdstringCustomer tax ID
customerTaxIdValidbooleantrue if customer tax ID is valid, false otherwise
reversedTaxAppliedbooleantrue if order tax was set to 0 because customer specified their valid tax ID in checkout process. false otherwise
b2b_b2cstringOrder type: business-to-business (b2b) or business-to-consumer (b2c)
customerRequestedInvoicebooleantrue if customer requested an invoice, false otherwise
customerFiscalCodestringFiscale code of a customer
electronicInvoicePecEmailstringPEC email for invoices
electronicInvoiceSdiCodestringSDI code for invoices
ipAddressstringCustomer IP
refererUrlstringURL of the page when order was placed (without hash (#) part)
orderCommentsstringOrder comments
couponDiscountnumberDiscount applied to order using a coupon
volumeDiscountnumberSum of discounts based on subtotal. Is included into the discount field
discountnumberThe 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
membershipBasedDiscountnumberSum of discounts based on customer group. Is included into the discount field
totalAndMembershipBasedDiscountnumberThe sum of discount based on subtotal AND customer group. Is included into the discount field
discountCoupon<DiscountCouponInfo>Information about applied coupon
discountInfoArray<DiscountInfo>Information about applied discounts (coupons are not included)
customerIdnumberUnique customer internal ID (if the order is placed by a registered user)
hiddenbooleanDetermines if the order is hidden (removed from the list). Applies to unsfinished orders only.
usdTotalnumberOrder total in USD
globalRefererstringURL that the customer came to the store from
createDatedateThe date/time of order placement, e.g 2014-06-06 18:57:19 +0000
updateDatedateThe date/time of the last order change, e.g 2014-06-06 18:57:19 +0000
createTimestampnumberThe date of order placement in UNIX Timestamp format, e.g 1427268654
updateTimestampnumberThe date of the last order change in UNIX Timestamp format, e.g 1427268654
customerGroupIdnumberCustomer group ID
customerGroupstringThe name of group (membership) the customer belongs to
itemsArray<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
additionalInfoMap<string,string>Additional order information if any (reserved for future use)
paymentParamsMap<string,string>Additional payment parameters entered by customer on checkout, e.g. PO number in "Purchase order" payments
trackingNumberstringShipping tracking code
paymentMessagestringMessage from the payment processor if any
externalTransactionIdstringTransaction ID / invoice number of the order in the payment system (e.g. PayPal transaction ID)
affiliateIdstringAffiliate ID
creditCardStatus<CreditCardStatus>The status of credit card payment
recoveredOrderIdnumberOrder number. Is present if the abandoned cart was successfully recovered
recoveryEmailSentTimestampstringThe date/time of the last order change, e.g 2014-06-06 18:57:19 +0000
acceptMarketingbooleantrue if customer agreed to accept marketing emails. false otherwise.
taxesOnShippingArray<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)


idnumberOrder item ID. Can be used to address the item in the order, e.g. to manage ordered items.
productIdnumberStore product ID
categoryIdnumberID 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
pricenumberPrice of ordered item in the cart
productPricenumberBasic product price without options markups, wholesale discounts etc.
weightnumberProduct weight
skustringProduct SKU. If the chosen options match a combination, this will be a combination SKU.
quantitynumberAmount purchased
shortDescriptionstringProduct description truncated to 120 characters
taxnumberTax amount applied to the item
shippingnumberOrder item shipping cost
quantityInStocknumberThe number of products in stock in the store
namestringProduct name
isShippingRequiredbooleantrue/false: shows whether the item requires shipping
trackQuantitybooleantrue/false: shows whether the store admin set to track the quantity of this product and get low stock notifications
fixedShippingRateOnlybooleantrue/false: shows whether the fixed shipping rate is set for the product
imageUrlstringProduct image URL
fixedShippingRatenumberFixed shipping rate for the product
digitalbooleantrue/false: shows whether the item has downloadable files attached
couponAppliedbooleantrue/false: shows whether a discount coupon is applied for this item
selectedOptionsArray<OrderItemOption>Product options values selected by the customer
taxesArray<OrderItemTax>Taxes applied to this order item
filesArray<OrderItemProductFile>Files attached to the order item
dimensions<ProductDimensions>Product dimensions info
customSurchargesArray<customSurchargesInfo>Information about applied surcharges
couponAmountnumberCoupon discount amount applied to item. Provided if discount applied to order. Is not recalculated if order is updated later manually
discountsArray<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
recurringChargeSettingsArray <RecurringChargeSettings>Subscription product information about subscription charge intervals
isCustomerSetPricebooleantrue if price for the ordered product was set up by a customer ("Pay What You Want" feature is enabled). false otherwise.
isPreorderbooleantrue if the product is pre-ordered because it was out of stock. Learn more about Accepting pre-orders. Otherwise the field is not returned.


namestringTax name
valuenumberTax value in percent
totalnumberTax amount for the item
taxOnDiscountedSubtotalnumberTax on item subtotal (after applying discounts)
taxOnShippingnumberTax on item shipping
includeInPricebooleantrue if the tax rate is included in product prices. More details: Taxes in Ecwid


productFileIdnumberInternal unique file ID
maxDownloadsnumberMax allowed number of file downloads. See E-goods article in Ecwid Help center for the details
remainingDownloadsnumberRemaining number of download attempts
expirestringDate/time of the customer download link expiration
namestringFile name
descriptionstringFile description defined by the store administrator
sizenumberFile size, bytes (64-bit integer)
adminUrlstringLink 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.
customerUrlstringFile download link that is sent to the customer when the order is paid


namestringOption name
typestringOption type. One of:
  • CHOICE (dropdown or radio button)
  • CHOICES (checkboxes)
  • TEXT (text input and text area)
  • DATE (date/time)
  • FILES (upload file option)
valuestringSelected/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.
valuesArrayArraySelected 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.
filesArray<OrderItemOptionFile>Attached files (if the option type is FILES)
selectionsArray<SelectionInfo>Details of selected product options. If sent in update order request, other fields will be regenerated based on information in this field


idnumberFile ID
namestringFile name
sizenumberFile size in bytes
urlstringFile URL


selectionTitlestringSelection title, as set by merchant
selectionModifiernumberSelection price modifier amount. Value is negative for negative modifiers
selectionModifierTypestringPrice modifier type: "PERCENT" or "ABSOLUTE"


lengthnumberLength of a product
widthnumberWidth of a product
heightnumberHeight of a product


namestringFull name
companyNamestringCompany name
streetstringAddress line 1 and address line 2, separated by '\n'
countryCodestringTwo-letter country code
countryNamestringCountry name
postalCodestringPostal/ZIP code
stateOrProvinceCodestringState code, e.g. NY
stateOrProvinceNamestringState/province name
phonestringPhone number


idstringSurcharge id. If not specified default value: Custom Surcharge
valuenumberSurcharge value
typestringSurcharges type: ABSOLUTE or PERCENT
totalnumberTotal value of surcharges
totalWithoutTaxnumberTotal value of surcharges without taxes
descriptionstringSurcharge description
descriptionTranslatedstringSurcharge description in the translation
taxablebooleanControls tax application for the surcharge
taxesArray<Taxes>The list of applied taxes


discountInfo<OrderItemDiscountInfo>Info about discounts applied to item
totalnumberTotal order item discount value for this discount


valuenumberDiscount value
typestringDiscount type: ABS or PERCENT
orderTotalnumberMinimum order subtotal the discount applies to


namestringCoupon title in store control panel
codestringCoupon code
statusstringDiscount coupon state: ACTIVE, PAUSED, EXPIRED or USEDUP
discountnumberDiscount amount
launchDatestringThe date of coupon launch, e.g. 2014-06-06 08:00:00 +0000
expirationDatestringCoupon expiration date, e.g. 2014-06-06 08:00:00 +0000
totalLimitnumberThe minimum order subtotal the coupon applies to
usesLimitstringNumber of uses limitation: UNLIMITED, ONCEPERCUSTOMER, SINGLE
applicationLimitstringApplication limit for discount coupons. Possible values: "UNLIMITED", "NEW_CUSTOMER_ONLY", "REPEAT_CUSTOMER_ONLY"
creationDatestringCoupon creation date
orderCountnumberNumber of uses
catalogLimit<DiscountCouponCatalogLimit>Products and categories the coupon can be applied to


productsArray<number>The list of product IDs the coupon can be applied to
categoriesArray<number>The list of category IDs the coupon can be applied to


recurringIntervalstringSubscription charge interval. Supported values: DAY, WEEK, MONTH, YEAR
recurringIntervalCountnumberCharge interval count (e.g. 3 - once per 3 months)
subscriptionPriceWithSignUpFeenumberThe cost of the product for the first subscription order.
signUpFeenumberThe size of the markup that is imposed on the first order.


shippingCarrierNamestringOptional. Is present for orders made with carriers, e.g. USPS or shipping applications.
shippingMethodNamestringShipping option name
estimatedTransitTimestringDelivery time estimation. Possible formats: number "5", several days estimate "4-9"
pickupInstructionstringInstruction for customer on how to receive their products


namestringHandling fee name set by store admin. E.g. Wrapping
valuenumberHandling fee value
descriptionstringHandling fee description for customer


valuenumberDiscount value
typestringDiscount type: ABS or PERCENT
order_totalnumberMinimum order subtotal the discount applies to
descriptionstringDescription of a discount (for discounts with base == CUSTOM)


avsMessagestringAddress verification status returned by the payment system
cvvMessagestringCredit card verification status returned by the payment system


namestringTax name
valuenumberTax value in store settings, applied to destination zone
totalnumberTax total applied to shipping


In case of error, Ecwid responds with an error HTTP status code and, optionally, JSON-formatted body containing error description

HTTP codes

HTTP StatusMeaning
400Request parameters are malformed
415Unsupported content-type: expected application/json or text/json
500Cannot retrieve the order info because of an error on the server

Error response body (optional)

errorMessagestringError message