Stores Cart to eCommerce Checkout Conversion Table

Some fields in the the Stores Cart API cart object are now held in the eCommerce Checkout API checkout object. To learn more, refer to the table below for changes in name and/or location.

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 that remain with the same name, in the same location, and with no changes in behavior are marked with an asterisk (*).

Stores Cart ObjecteCommerce Checkout Object
id-
status-
weightUnit *weightUnit
buyerNote *buyerNote
currency.codecurrency
currency.symbolNo longer returned. Instead, for every price returned, we also provide the formatted price in checkout.priceSummary and/or order.priceSummary.
billingAddress.addressbillingInfo.address - See address object conversion table for more details.
billingAddress.contactDetails.firstNamebillingInfo.contactDetails.firstName
billingAddress.contactDetails.lastNamebillingInfo.contactDetails.lastName
billingAddress.contactDetails.phonebillingInfo.contactDetails.phone
billingAddress.contactDetails.companybillingInfo.contactDetails.company
billingAddress.contactDetails.vatIdbillingInfo.contactDetails.vatId
billingAddress.contactDetails.emailbillingInfo.buyerInfo.email
appliedCoupon.couponIdappliedDiscounts[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.codeappliedDiscounts[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.nameappliedDiscounts[i].coupon.name - The coupon is now an item in the appliedDiscounts array. To get it, search the appliedDiscounts array for the coupon field.
appliedCoupon.discountValueappliedDiscounts[i].coupon.amount.amount - The coupon is now an item in the appliedDiscounts array. To get it, search the appliedDiscounts array for the coupon field.
appliedCoupon.couponTypeNo longer returned.
totals.subtotalpriceSummary.subtotal.amount
totals.shippingpriceSummary.shipping.amount
totals.taxpriceSummary.tax.amount
totals.discountpriceSummary.discount.amount
totals.totalpriceSummary.total.amount
totals.weightlineItems[i].physicalProperties.weight X lineItems[i].quantity
totals.quantitylineItems[0].quantity + lineItems[1].quantity + lineItems[2].quantity
convertedTotals.subtotalpriceSummary.subtotal.convertedAmount
convertedTotals.shippingpriceSummary.shipping.convertedAmount
convertedTotals.taxpriceSummary.tax.convertedAmount
convertedTotals.discountpriceSummary.discount.convertedAmount
convertedTotals.totalpriceSummary.total.convertedAmount
convertedTotals.weightNo weight conversion in checkout. Same value as Stores cart.totals.weight.
convertedTotals.quantitySame value as Stores cart.totals.quantity.
shippingInfo.shippingRuleDetails.ruleIdֿֿֿֿֿֿֿֿshippingInfo.region._id
shippingInfo.shippingRuleDetails.optionIdֿֿֿֿֿֿֿֿshippingInfo.selectedCarrierServiceOption.title
shippingInfo.shippingRuleDetails.deliveryOptionֿֿֿֿֿֿֿֿshippingInfo.selectedCarrierServiceOption.title
shippingInfo.shippingRuleDetails.estimatedDeliveryTimeֿֿֿֿֿֿֿֿshippingInfo.logistics.deliveryTime
shippingInfo.pickupDetails.pickupAddressshippingInfo.selectedCarrierServiceOption.logistics.pickupDetails.address - See address object conversion table for more details.
shippingInfo.pickupDetails.buyerDetails.firstNameshippingInfo.shippingDestination.contactDetails.firstName
shippingInfo.pickupDetails.buyerDetails.lastNameshippingInfo.shippingDestination.contactDetails.lastName
shippingInfo.pickupDetails.buyerDetails.emailbuyerInfo.email
shippingInfo.pickupDetails.buyerDetails.phoneshippingInfo.shippingDestination.contactDetails.phone
shippingInfo.pickupDetails.pickupInstructionsshippingInfo.logistics.instructions
shippingInfo.shippingAddress.addressshippingInfo.shippingDestination.address - See address object conversion table for more details.
shippingInfo.shippingAddress.contactDetailsshippingInfo.shippingDestination.contactDetails
buyerInfo.id and buyerInfo.identityType: CONTACTbuyerInfo.contactId only.
buyerInfo.id and buyerInfo.identityType: VISITORbuyerInfo.visitorId only.
buyerInfo.id and buyerInfo.identityType: MEMBERbuyerInfo.memberId only.
buyerInfo.email *buyerInfo.email
buyerInfo.phonebillingInfo.contactDetails.phone
buyerInfo.firstNamebillingInfo.contactDetails.firstName
buyerInfo.lastNamebillingInfo.contactDetails.lastName
lineItems[i].idlineItems[i]._id - Note: this _id is of type GUID. In the Stores Cart API, the id is of type Int32.
lineItems[i].productIdlineItems[i].catalogReference.catalogItemId
lineItems[i].namelineItems[i].productName.original
lineItems[i].quantity*lineItems[i].quantity
lineItems[i].weightlineItems[i].physicalProperties.weight
lineItems[i].skulineItems[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_ITEMlineItems[i].itemType.custom and lineItems[i].catalogReference is empty.
lineItems[i].noteslineItems[i].descriptionLines[i].plainText.original
lineItems[i].customTextFieldslineItems[i].descriptionLines
lineItems[i].mediaItem.mediaTypeAll line item media in the eCommerce Cart, Checkout, and Order APIs are images.
lineItems[i].mediaItem.urllineItems[i].media.url
lineItems[i].mediaItem.widthlineItems[i].media.width
lineItems[i].mediaItem.heightlineItems[i].media.height
lineItems[i].optionslineItems[i].catalogReference.options
lineItems[i].priceData.pricelineItems[i].price.amount
lineItems[i].priceData.totalPricelineItems[i].price.amount X lineItems[i].quantity
lineItems[i].convertedPriceData.pricelineItems[i].price.convertedAmount
lineItems[i].convertedPriceData.totalPricelineItems[i].price.convertedAmount X lineItems[i].quantity
Was this helpful?
Yes
No