Cart Completed Event

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Deprecation Notice:

This webhook has been replaced with the Checkout Marked As Completed Webhook and will be removed on September 4, 2024.

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

Permissions

Learn more about app permissions.

Event BodyEvent Body Event data is received as a JSON Web Token (JWT). It may be delayed. Be sure to verify the data was sent by Wix.

Event Data

cartIdstringformat GUID

completedTimestringRead-onlyformat date-time

Time the cart was created

buyerInfoBuyerInfo

Customer's Wix ID

weightUnitstring

Weight unit used in this store

buyerNotestringmaxLength 1000

Message from the customer

billingAddressBillingAddress

Customer's billing address

currencyCurrency

Currency used for pricing in this store

appliedCouponAppliedCoupon

Coupon applied to this cart

totalsTotals

Totals for order's line items

shippingInfoShippingInfo

Cart shipping information

Event Body

The data payload will include the following as an encoded JWT:

JSON


{
  "data": {
    "eventType": "com.wix.ecommerce.cart.api.v1.CartCompletedEvent",
    "instanceId": "<app-instance-id>",
    "data": "<stringified-JSON>",
    // The identity field is sent as a stringified JSON
    "identity": {
      "identityType": "<identityType>", // ANONYMOUS_VISITOR, MEMBER, WIX_USER, APP
      "anonymousVisitorId": "<anonymousVisitorId>", // in case of ANONYMOUS_VISITOR
      "memberId": "<memberId>", // in case of MEMBER
      "wixUserId": "<wixUserId>", // in case of WIX_USER
      "appId": "<appId>" // in case of APP
    }
  }
}

Sample Data Shown:Cart Completed Event

JSON


{
  "cartId": "2bd3c22c-4776-419f-ad4f-ad207465a0a8",
  "completedTime": "2020-08-11T13:04:51.009Z",
  "buyerInfo": {
    "id": "d11e902a-38f7-4bea-9f75-4d7678a47015",
    "identityType": "MEMBER",
    "email": "johndoe@anydomain.com",
    "phone": "515-522-4422",
    "firstName": "John",
    "lastName": "Doe"
  },
  "weightUnit": "LB",
  "billingAddress": {
    "address": {
      "country": "US",
      "subdivision": "US-IA",
      "city": "New York",
      "postalCode": "10011",
      "addressLine": "235 W 23rd St"
    },
    "contactDetails": {
      "firstName": "John",
      "lastName": "Doe",
      "phone": "515-522-4422",
      "email": "johndoe@anydomain.com"
    }
  },
  "currency": {
    "code": "USD",
    "symbol": "$"
  },
  "totals": {
    "subtotal": 25,
    "discount": 0,
    "total": 25,
    "quantity": 1
  },
  "shippingInfo": {
    "shippingRuleDetails": {
      "ruleId": "00000000-0000-0000-0000-000000000001",
      "optionId": "1",
      "deliveryOption": "Standard Shipping"
    },
    "shippingAddress": {
      "address": {
        "country": "US",
        "subdivision": "US-IA",
        "city": "New York",
        "postalCode": "10011",
        "addressLine": "235 W 23rd St"
      },
      "contactDetails": {
        "firstName": "John",
        "lastName": "Doe",
        "phone": "515-522-4422",
        "email": "johndoe@anydomain.com"
      }
    }
  }
}

Did this help?