Stores Cart to eCommerce Checkout Conversion Table

To help with migration to the eCommerce API, refer to the table below for differences between the Stores Cart and eCommerce Checkout objects.

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.

Stores Cart ObjecteCommerce Checkout Object
id-
status-
weightUnitweightUnit
buyerNotebuyerNote
currency.codecurrency
currency.symbolFor every price returned, we also provide the formatted price under checkout.priceSummary.
convertedCurrency.codeconversionCurrency
convertedCurrency.symbolFor every converted price returned, we also provide the formatted converted price under checkout.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
appliedCoupon.nameappliedDiscounts[i].coupon.name
appliedCoupon.codeappliedDiscounts[i].coupon.code
appliedCoupon.discountValueappliedDiscounts[i].coupon.amount.amount
appliedCoupon.convertedDiscountValueappliedDiscounts[i].coupon.convertedAmount
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 and so on.
totals.quantitylineItems[0].quantity + lineItems[1].quantity + lineItems[2].quantity and so on.
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 cart.totals.weight.
convertedTotals.quantitySame value as 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.emailbuyerInfo.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, this id was of type Int32.
lineItems[i].productIdlineItems[i].catalogReference.catalogItemId - See Stores Catalog eCommerce Integration for more information.
lineItems[i].namelineItems[i].productName.original
lineItems[i].quantitylineItems[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 image types.
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 - See Stores Catalog eCommerce Integration for more information.
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