To help with migration from the Stores Cart API to the eCommerce Cart and Current Cart APIs, refer to the table below for changes in name and/or location.
Certain information that used to be held in the Cart is now kept in the Checkout. These properties are indicated in the table below, with more information available in the Stores Cart to eCommerce Checkout Conversion Table.
The address object used in the eCommerce APIs is slightly different to the one used in the Stores APIs. For more details, refer to the address object conversion table.
Fields marked with an asterisk (*) signify little to no change in semantics or service location.
| Stores Cart | eCommerce Cart |
|---|---|
_id* | _id |
status | All carts in the eCommerce Cart API have a status value of INCOMPLETE. After a purchase is completed (order.paymentStatus property value is PAID), the cart is deleted and the onCartDeleted() event is triggered. Any attempt to retrieve it via the getCart() function will fail. In the Stores Cart API, the cart's status would change to COMPLETE after a purchase. |
weightUnit* | weightUnit |
buyerNote* | buyerNote |
currency.code | currency |
currency.symbol | No longer returned. Instead, for every price returned, we also provide the formatted price in checkout.priceSummary and/or order.priceSummary. |
billingAddress | Billing address is now kept in the Checkout and Order. |
appliedCoupon.couponId | appliedDiscounts[i].coupon._id - The coupon is now an item in the appliedDiscounts array. To get it, search the appliedDiscounts array for the coupon field. |
appliedCoupon.code | appliedDiscounts[i].coupon.code - The coupon is now an item in the appliedDiscounts array. To get it, search the appliedDiscounts array for the coupon field. |
appliedCoupon.name | This field is held only in the Checkout object under appliedDiscounts[i].coupon.name. |
appliedCoupon.discountValue | This field is held only in the Checkout object under appliedDiscounts[i].coupon.amount.amount. |
appliedCoupon.couponType | No longer returned. |
totals | All totals properties are available by using the estimateCurrentCartTotals() function, or by passing the cart ID to the Cart API's estimateTotals() function, under priceSummary in the response. |
shippingInfo | All shippingInfo properties are available by using the estimateCurrentCartTotals() function, or by passing the cart ID to the Cart API's estimateTotals() function. |
buyerInfo.id and buyerInfo.identityType: CONTACT | buyerInfo.contactId only. |
buyerInfo.id and buyerInfo.identityType: VISITOR | buyerInfo.visitorId only. |
buyerInfo.id and buyerInfo.identityType: MEMBER | buyerInfo.memberId only. |
buyerInfo.id and buyerInfo.identityType: ADMIN | This identity is no longer supported. |
buyerInfo.email | Buyer email is now kept in Checkout. |
buyerInfo.phone | Buyer phone is now kept in Checkout. |
buyerInfo.firstName | Buyer first name is now kept in Checkout. |
buyerInfo.lastName | Buyer last name is now kept in Checkout. |
lineItems[i].id | lineItems[i]._id. Note: This _id is of type GUID. In the Stores Cart API, the lineItem.id is of type Int32. |
lineItems[i].productId | lineItems[i].catalogReference.catalogItemId |
lineItems[i].name | lineItems[i].productName.translated |
lineItems[i].quantity* | lineItems[i].quantity* |
lineItems[i].weight | lineItems[i].physicalProperties.weight |
lineItems[i].sku | lineItems[i].physicalProperties.sku |
lineItems[i].lineItemType: "PHYSICAL" | lineItems[i].itemType.preset: "PHYSICAL" |
lineItems[i].lineItemType: "DIGITAL" | lineItems[i].itemType.preset: "DIGITAL" |
lineItems[i].lineItemType: "CUSTOM_AMOUNT_ITEM" | lineItems[i].itemType.custom and lineItems[i].catalogReference is empty. |
lineItems[i].notes | lineItems[i].descriptionLines[i].plainText.original |
lineItems[i].customTextFields | lineItems[i].descriptionLines |
lineItems[i].mediaItem.mediaType | All line item media in the Cart API are images. |
lineItems[i].mediaItem.url | lineItems[i].media.url |
lineItems[i].mediaItem.width | lineItems[i].media.width |
lineItems[i].mediaItem.height | lineItems[i].media.height |
lineItems[i].options | lineItems[i].descriptionLines |
lineItems[i].priceData.price | lineItems[i].price.amount |
lineItems[i].priceData.totalPrice | lineItems[i].price.amount X lineItems[i].quantity |
lineItems[i].convertedPriceData.price | lineItems[i].price.convertedAmount |
lineItems[i].convertedPriceData.totalPrice | lineItems[i].price.convertedAmount X lineItems[i].quantity |