About The Stores Carts API

The Wix Stores Cart API allows for retrieving a cart and listening to events when a cart is created or completed.

Deprecation Notice:

Stores Carts API has been replaced with eCommerce Cart API and will be removed on June 30, 2024.

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

Was this helpful?
Yes
No

Cart Object

Read and Write carts from Wix Stores, produce cart lifecycle events

Attributes
idstringformat GUID
Cart ID, generated from customer identity

statusstring
2 supported values:
INCOMPLETECOMPLETE
Cart status can be INCOMPLETE, COMPLETE

weightUnitstring
3 supported values:
UNSPECIFIED_WEIGHT_UNITKGLB
Weight unit used in this store

buyerNotestringmaxLength 1000
Message from the customer

currencyobject
Currency used for pricing in this store

convertedCurrencyobject
Conversion currency used for pricing in this store

billingAddressobject
Customer's billing address

appliedCouponobject
Coupon applied to the cart

totalsobject
Order totals

convertedTotalsobject
Converted Order totals

shippingInfoobject
Cart shipping information

buyerInfoobject
Customer's Wix ID

lineItemsArray <LineItem>minItems 1
Line items ordered
Was this helpful?
Yes
No

GetGet Cart

Deprecated

This method has been replaced with GetCart, and will be removed on June 30, 2024.

Get a cart by ID.

Deprecation Notice:

This endpoint has been replaced with Get Cart and will be removed on June 30, 2024.

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

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Stores - all permissions
Read Orders
Read Stores - all read permissions
Manage Orders
Learn more about permission scopes.
Was this helpful?
Yes
No

GetGet Cart Checkout Url

Deprecated

This method has been replaced with GetCheckoutURL, and will be removed on June 30, 2024.

Get a cart's checkout URL by ID.

Deprecation Notice:

This endpoint has been replaced with Get Checkout URL and will be removed on June 30, 2024.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Stores - all permissions
Read Orders
Read Stores - all read permissions
Manage Orders
Learn more about permission scopes.
Was this helpful?
Yes
No

Cart Created 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 Cart Created Webhook and will be removed on June 30, 2024.

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

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Stores - all permissions
Read Orders
Read Stores - all read permissions
Manage Orders
Learn more about permission scopes.
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

creationTimestringRead-onlyformat date-time
Time the cart was created

buyerInfoobject
Customer's wix ID

weightUnitstring
3 supported values:
UNSPECIFIED_WEIGHT_UNITKGLB
Weight unit used in this store

currencyobject
Currency used for pricing in this store

totalsobject
Totals for order's line items
Was this helpful?
Yes
No

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 June 30, 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.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Stores - all permissions
Read Orders
Read Stores - all read permissions
Manage Orders
Learn more about permission scopes.
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

buyerInfoobject
Customer's Wix ID

weightUnitstring
3 supported values:
UNSPECIFIED_WEIGHT_UNITKGLB
Weight unit used in this store

buyerNotestringmaxLength 1000
Message from the customer

billingAddressobject
Customer's billing address

currencyobject
Currency used for pricing in this store

appliedCouponobject
Coupon applied to this cart

totalsobject
Totals for order's line items

shippingInfoobject
Cart shipping information
Was this helpful?
Yes
No