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 Object | eCommerce Checkout Object |
|---|---|
id | - |
status | - |
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.address | billingInfo.address - See address object conversion table for more details. |
billingAddress.contactDetails.firstName | billingInfo.contactDetails.firstName |
billingAddress.contactDetails.lastName | billingInfo.contactDetails.lastName |
billingAddress.contactDetails.phone | billingInfo.contactDetails.phone |
billingAddress.contactDetails.company | billingInfo.contactDetails.company |
billingAddress.contactDetails.vatId | billingInfo.contactDetails.vatId |
billingAddress.contactDetails.email | billingInfo.buyerInfo.email |
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 | appliedDiscounts[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.discountValue | appliedDiscounts[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.couponType | No longer returned. |
totals.subtotal | priceSummary.subtotal.amount |
totals.shipping | priceSummary.shipping.amount |
totals.tax | priceSummary.tax.amount |
totals.discount | priceSummary.discount.amount |
totals.total | priceSummary.total.amount |
totals.weight | lineItems[i].physicalProperties.weight X lineItems[i].quantity |
totals.quantity | lineItems[0].quantity + lineItems[1].quantity + lineItems[2].quantity |
convertedTotals.subtotal | priceSummary.subtotal.convertedAmount |
convertedTotals.shipping | priceSummary.shipping.convertedAmount |
convertedTotals.tax | priceSummary.tax.convertedAmount |
convertedTotals.discount | priceSummary.discount.convertedAmount |
convertedTotals.total | priceSummary.total.convertedAmount |
convertedTotals.weight | No weight conversion in checkout. Same value as Stores cart.totals.weight. |
convertedTotals.quantity | Same 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.pickupAddress | shippingInfo.selectedCarrierServiceOption.logistics.pickupDetails.address - See address object conversion table for more details. |
shippingInfo.pickupDetails.buyerDetails.firstName | shippingInfo.shippingDestination.contactDetails.firstName |
shippingInfo.pickupDetails.buyerDetails.lastName | shippingInfo.shippingDestination.contactDetails.lastName |
shippingInfo.pickupDetails.buyerDetails.email | buyerInfo.email |
shippingInfo.pickupDetails.buyerDetails.phone | shippingInfo.shippingDestination.contactDetails.phone |
shippingInfo.pickupDetails.pickupInstructions | shippingInfo.logistics.instructions |
shippingInfo.shippingAddress.address | shippingInfo.shippingDestination.address - See address object conversion table for more details. |
shippingInfo.shippingAddress.contactDetails | shippingInfo.shippingDestination.contactDetails |
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.email * | buyerInfo.email |
buyerInfo.phone | billingInfo.contactDetails.phone |
buyerInfo.firstName | billingInfo.contactDetails.firstName |
buyerInfo.lastName | billingInfo.contactDetails.lastName |
lineItems[i].id | lineItems[i]._id - Note: this _id is of type GUID. In the Stores Cart API, the id is of type Int32. |
lineItems[i].productId | lineItems[i].catalogReference.catalogItemId |
lineItems[i].name | lineItems[i].productName.original |
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 eCommerce Cart, Checkout, and Order APIs 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].catalogReference.options |
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 |
Adds catalog line items and/or custom line items to a checkout.
The addToCheckout() function returns a Promise that resolves to the updated checkout when the specified items have been added.
Note: When adding catalog items, options.lineItems.catalogReference is required.
Checkout ID.
Items to be added to checkout.
This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.
Creates a checkout.
The createCheckout() function returns a Promise that resolves to the new checkout when it's created.
Notes:
options.lineItems array.options.channelType is required._id for options.lineItems is added, make sure that each _id is unique.options.checkoutInfo.customFields are added, then options.checkoutInfo.customFields.value is required.Checkout creation options.
This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.
Creates an order from a specified checkout.
The createOrder() function returns a Promise that resolves to the new order's ID and paymentGatewayOrderID when the order is created.
Pass the paymentGatewayOrderId as the paymentId param to the startPayment() function to allow a customer to pay for their order.
Note: The following requirements must be met for an order to be created from a checkout.
checkout._id to Get Checkout and take a look at the calculationErrors field.availability.status of "AVAILABLE" or "PARTIALLY_AVAILABLE".priceSummary.total is greater than 0, the billingInfo.address field must be provided.shippingInfo.shippingDestination.address and shippingInfo.selectedCarrierServiceOption fields must be provided.shippingInfo.selectedCarrierServiceOption.logistics.pickupDetails field must be provided.Checkout ID.
Further order creation options.
This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.
Retrieves a checkout.
The getCheckout() function returns a Promise that resolves when the specified checkout is retrieved.
Checkout ID.
This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.
This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.
Retrieves the checkout page URL of a specified checkout.
By default, a checkoutUrl generates for a checkout and directs to a standard Wix checkout page.
However, if overrideCheckoutUrl has a value, it will replace and set the value of checkoutUrl.
Checkout ID.
This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.
Marks a checkout as completed - checkout.complete boolean is set to true.
The markCheckoutAsCompleted() function returns a Promise that resolves when the specified checkout is marked as completed.
Checkout ID.
This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.
Removes the coupon from a specified checkout.
The removeCoupon() function returns a Promise that resolves to the updated checkout when the coupon is removed from the specified checkout.
Note: A checkout can only hold 1 coupon.
ID of the checkout to remove the coupon from.
This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.
Removes the gift card from a specified checkout.
The removeGiftCard() function returns a Promise that resolves to the updated checkout when the gift card is removed from the specified checkout.
Note: A checkout can only hold 1 gift card.
ID of the checkout to remove the gift card from.
This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.
Removes line items from the specified checkout.
The removeLineItems() function returns a Promise that resolves to the updated checkout when the line items are removed from the specified checkout.
ID of the checkout to remove line items from.
IDs of the line items to be removed.
To find the IDs of the checkout line items you'd like to remove, pass the checkout._id to getCheckout() and look for the IDs under lineItems and/or customLineItems.
This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.
This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.
Removes the overrideCheckoutUrl from a specified checkout.
When overrideCheckoutUrl is removed, the checkoutUrl will be set to the default, standard
Wix checkout page URL.
ID of the checkout to remove the override checkout url from.
This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.
Updates a checkout.
The updateCheckout() function returns a Promise that resolves to the updated checkout when the specified properties are updated.
Notes:
checkout.buyerInfo.email may not be removed once it is set.Checkout ID.
Checkout update options.
This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.
Updates the quantity of one or more line items in a checkout.
This endpoint is only for updating the quantity of line items. To entirely remove a line item from
the checkout, use removeLineItems().
To add a new line item to the checkout, use addToCheckout().
This endpoint checks the amount of stock remaining for this line item. If the specified quantity
is greater than the remaining stock, then the quantity returned in the response is the total amount
of remaining stock.
Checkout ID.
Line item info to update.
This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.