The cart is the first phase of a purchase, followed by checkout, then order.

A cart holds information about purchased items, prices, discounts, site details, buyer IDs (contact and member/visitor) and more.

With the eCommerce Cart API you can:

• Get a cart.
• Add catalog items to a cart.
• Create a checkout from a cart.
• Estimate a cart's price totals.
• Update a cart's properties and line items quantity.
• Remove a coupon.
• Remove line items and delete a cart.

You can also listen for events when a cart is created, updated, and deleted.

To assist in migration from the Stores to eCommerce APIs, please refer to the Stores to eCommerce Cart Conversion Table.

This article shares some possible use cases your app could support, as well as an example flow that could support each use case. You're certainly not limited to these use cases, but they can be a helpful jumping off point as you plan your app's implementation.

1. A site visitor adds an item to the cart.
2. Using the Cart Created Webhook, listen for an event when a cart is created.

Copy Code
{
  "entityId" : "33d99986-63b0-4f0e-a549-33bda4bef756",
  "entityEventSequence" : "1",
  "slug" : "created",
  "id" : "09f3dfbf-f0c2-4276-9527-cc4af371125a",
  "createdEvent" : {
    "entity" : {
      "lineItems" : [ {
        "physicalProperties" : {
          "sku" : "364215376135191",
          "shippable" : true
        },
        "quantity" : 3,
        "paymentOption" : "FULL_PAYMENT_ONLINE",
        "couponScopes" : [ {
          "namespace" : "stores",
          "group" : {
            "name" : "collection",
            "entityId" : "00000000-000000-000000-000000000001"
          }
        }, {
          "namespace" : "stores",
          "group" : {
            "name" : "product",
            "entityId" : "df19c1f7-07d8-a265-42f8-e8dfa824cc6e"
          }
        } ],
        "url" : {
          "relativePath" : "/product-page/shoe",
          "url" : "https://example.wixsite.com/ep-tester"
        },
        "image" : {
          "id" : "3c76e2_bf235c38610f4d2a905db71095b351cf~mv2.jpg",
          "url" : "https://static.wixstatic.com/media/3c76e2_bf235c38610f4d2a905db71095b351cf~mv2.jpg",
          "height" : 1000,
          "width" : 1000
        },
        "price" : {
          "amount" : "85",
          "convertedAmount" : "85",
          "formattedAmount" : "$85.00",
          "formattedConvertedAmount" : "$85.00"
        },
        "availability" : {
          "status" : "AVAILABLE",
          "quantityAvailable" : 30
        },
        "priceBeforeDiscounts" : {
          "amount" : "85",
          "convertedAmount" : "85",
          "formattedAmount" : "$85.00",
          "formattedConvertedAmount" : "$85.00"
        },
        "id" : "00000000-0000-0000-0000-000000000001",
        "fullPrice" : {
          "amount" : "85",
          "convertedAmount" : "85",
          "formattedAmount" : "$85.00",
          "formattedConvertedAmount" : "$85.00"
        },
        "itemType" : {
          "preset" : "PHYSICAL"
        },
        "productName" : {
          "original" : "Shoe",
          "translated" : "Shoe"
        },
        "descriptionLines" : [ {
          "name" : {
            "original" : "Color",
            "translated" : "Color"
          },
          "colorInfo" : {
            "original" : "Black",
            "translated" : "Black",
            "code" : "#000"
          },
          "lineType" : "UNRECOGNISED"
        } ],
        "catalogReference" : {
          "catalogItemId" : "df19c1f7-07d8-a265-42f8-e8dfa824cc6e",
          "appId" : "1380b703-ce81-ff05-f115-39571d94dfcd",
          "options" : {
            "variantId" : "e62fee23-7878-437a-bf0e-292f17d11cb5"
          }
        }
      } ],
      "siteLanguage" : "en",
      "appliedDiscounts": [{
        "coupon":   {
          "id": "e463550b-220a-428f-82d9-8d11c3c1acd7",
          "code": "SUMMERSALE10"
        }
      }],
      "taxIncludedInPrices" : false,
      "weightUnit" : "KG",
      "id" : "33d99986-63b0-4f0e-a549-33bda4bef756",
      "buyerInfo" : {
        "visitorId" : "4c7ce95c-9fb3-417d-9f02-b41e82b841f7"
      },
      "currency" : "USD",
      "subtotal" : {
        "amount" : "255",
        "convertedAmount" : "255",
        "formattedAmount" : "$255.00",
        "formattedConvertedAmount" : "$255.00"
      },
      "updatedDate" : "2022-12-12T13:29:22.950Z",
      "conversionCurrency" : "USD",
      "buyerLanguage" : "en",
      "createdDate" : "2022-12-12T13:29:22.950Z"
    }
  },
  "entityFqdn" : "wix.ecom.v1.cart",
  "eventTime" : "2022-12-12T13:29:22.953616Z",
  "triggeredByAnonymizeRequest" : false
}

Save the newly created cart's ID (entityId field in the above webhook's payload) for use in the flow below.

If a store owner wants to update a specific cart with a buyer note and remove a coupon, they can follow this basic flow.

1. Pass the cart's ID (entityId field in the above webhook's payload) to the Update Cart endpoint to add a buyer note to the cart:

   Copy Code
   curl -X PATCH \
     'https://www.wixapis.com/ecom/v1/carts/33d99986-63b0-4f0e-a549-33bda4bef756' \
     -H 'Authorization: <AUTH>' \
     -H 'Content-Type: application/json' \
     -d '{
       "cartInfo": {
        "id": "33d99986-63b0-4f0e-a549-33bda4bef756",
        "buyerNote": "Please ship ASAP."
       }
     }'

   The response is the cart object containing the newly added buyer note.

2. Use Remove Coupon to remove a coupon from a cart.

   Copy Code
   curl -X POST \
     'https://www.wixapis.com/ecom/v1/carts/33d99986-63b0-4f0e-a549-33bda4bef756/remove-coupon' \
     -H 'Authorization: <AUTH>'
     -H 'Content-Type: application/json' \

To help with migration from the Stores Cart API to the eCommerce Cart and Checkout APIs, refer to the table below for field changes in name and/or location.

Certain information that used to be held in the Cart, is now kept in the Checkout object. These fields are marked 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, the cart is deleted and the Cart Deleted Webhook is triggered. Any attempt to retrieve it via the Get Cart endpoint will yield a 404 error code. 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.
convertedCurrency.code	conversionCurrency
convertedCurrency.symbol	No longer returned. Instead, for every converted price returned, we also provide the formatted converted price.
billingAddress	Billing address is no longer kept in the Cart. This information is only kept in Checkout.
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 only populated 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 only populated 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.convertedDiscountValue	This field is held only in the Checkout object under appliedDiscounts[i].coupon.amount.convertedAmount.
appliedCoupon.couponType	No longer returned.
totals	Future functionality will see this information made available in the eCommerce Cart API.
convertedTotals	Future functionality will see this information made available in the eCommerce Cart API.
shippingInfo	Shipping information is now only kept in Checkout.
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	Buyer email is now only kept in Checkout.
buyerInfo.phone	Buyer phone is now only kept in Checkout.
buyerInfo.firstName	Buyer first name is now only kept in Checkout.
buyerInfo.lastName	Buyer last name is now only 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 - See Stores Catalog eCommerce Integration for more information.
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 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 - See Stores Catalog eCommerce Integration for more information.
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

The eCommerce APIs use a different address object. Notably, fields related to contact information have been moved to an adjacent contactDetails object (for example, in order.shippingInfo).

To help with conversion and migration, refer to the table below to check which fields have changed and how.

Note: in the eCommerce API, the buyer's email is only held in the buyerInfo field in the eCommerce Order object.

Previous Address Object	eCommerce Address Field Location	Change
address.city	address.city
address.email	buyerInfo.email
address.zipCode	address.postalCode	Field name
address.country	address.country
address.addressLine1	address.addressLine	Field name
address.addressLine2	address.addressLine2
address.street	address.streetAddress	Field name
address.subdivision	address.subdivision
address.fullName.firstName	contactDetails.firstName	Moved to contactDetails object
address.fullName.lastName	contactDetails.lastName	Moved to contactDetails object
address.phone	contactDetails.phone	Moved to contactDetails object
address.company	contactDetails.company	Moved to contactDetails object
address.vatId	contactDetails.vatId	Moved to contactDetails object