Search.../
  1. Home
  2. Getting Started
  3. Overview
Generate a test token to explore our APIs

About Wix Stores

Wix enables site owners to quickly and easily create and manage an online store for physical and/or digital products on their site. Read more about the Wix Stores features.

Terminology

  • The catalog is a complete list of all the store‚Äôs products - compiled automatically.
  • Collections are themed groupings of items for purchase that a store owner can create to organize their products (e.g., Spring 2019, Running shoes, etc.). Products can belong to multiple collections.
  • Options are property types that customers can select within the specific product - e.g., color and size.
  • Selections are the types available within each option - e.g., red and green selections under the Color option.
  • Choices are the specific choices the customer has made within a selection - e.g., choosing the red Selection triggers the red Choice.
  • Variants are combinations of different product choices - e.g., a red shirt in size large. A variant can override the following values from the parent product:
    • Price
    • SKU
    • Weight
    • Inventory

Was this helpful?

Pagination

The standard Wix API pagination includes:

limit: amount of items per response (defaults will be defined per use case)
offset: number of items to skip

The following example:

"query": {
"paging": {
"limit": 100,
"offset": 20
}
}
Copy Code

Should return items 21-120 in the collection.

Wix Stores query endpoints are designed to handle a max of 10k data items. Therefore, if a user's store includes ~10k relevant items (e.g., products, inventory items), limit and offset may fail.

Instead, filter by numericId (query products, query inventory) or number (query orders) and sort in ascending order:

"query": {
"sort": [{"numericId": "asc"}],
}
Copy Code

Then copy the last numericId/number sent in this call and call the endpoint again:

"query":{
"sort": [{"numericId": "asc"}],
"filter": {
"numericId": {
"$gt": <last numeric id>
}
}
}
Copy Code

Continue until you receive an empty JSON as a response.

Important:
Escape the JSON strings in your query parameters.

Was this helpful?

Rich Text

Select parameters currently accept values with rich text. The following rich text formatting is accepted:

<p><strong>This is bolded text</strong></p>
<p><u>This is underlined text</u></p>
<p><span style=\"color:#cb2026\">This is red text</span></p>
<p><span style=\"color:#000000;\"><span style=\"background-color:#ce5028;\">This is black text with a red background</span></span></p>
<p><a href=\"http://www.google.com\" target=\"_blank\">This is a link</a></p>

<ul>
<li>This is a bullet</li>
<li>This is a second bullet</li>
</ul>
Copy Code
<ol>
<li>This is a numbered list item</li>
<li>This is a second numbered list item</li>
</ol>
Copy Code

Was this helpful?

About Carts

The Wix Stores Carts APIs provide your app with access to the site's customers' cart data.

Important:
This Carts API will be deprecated in the second half of 2020, when a completely new version will be deployed.

A cart is created the first time a visitor adds something to their cart.

A cart is considered abandoned once it has been idle for 1 hour.

The Abandoned Cart Webhook is triggered only for carts of site members who are logged in to the site, or for visitors who entered their email address in the checkout process before abandoning their cart.

Use Case - Abandoned Cart Email Reminder

  1. Listen to the Cart Abandoned and the Cart Recovered webhooks.

    Note:
    To ensure up-to-date information, you can also call the Get Abandoned Carts endpoint at regular intervals.

  2. When a cart status is changed to Abandoned (an hour after the last cart activity), call the Get Cart Checkout URL and/or Get Cart endpoints, as necessary.
  3. Enter the relevant cart information into the email to send to the customer reminding them to complete their order.

    Note:
    If you receive a Cart Recovered webhook before the email is sent, cancel the email - the customer has already completed their order.

Testing

Wix site owners can view all abandoned carts in their Wix Dashboard under Stores Orders > Abandoned Carts.

Was this helpful?

Cart

Attributes

NAME
TYPE
DESCRIPTION
lineItems

Array<object>

Ordered line items

billingAddress

object

Customer's billing address

shippingInfo

object

Cart shipping information

weightUnit

string

One of UNSPECIFIED_WEIGHT_UNIT, KG, LB.

Weight unit used in this store

id

string

Cart ID, generated from customer identity

buyerNote

string

Message from the customer

status

string

One of INCOMPLETE, COMPLETE.

Cart status can be INCOMPLETE, COMPLETE

buyerInfo

object

Customer's wix ID

currency

object

Currency used for pricing in this store

appliedCoupon

object

Coupon applied to the cart

totals

object

Totals for order's line items

Was this helpful?

Get Cart

Get a cart by ID

Authorization

This API requires an authorization header - pass the access token from the OAuth installation flow.

Permissions

The API requires Wix Stores > Read Carts

GET

https://www.wixapis.com/stores/v1/carts/{id}

Path Params

NAME
TYPE
DESCRIPTION
id
Required

string

Cart ID

Response Object

Get Response

NAME
TYPE
DESCRIPTION
cart

object

Cart details

Status/Error Codes

The response will include an HTTP status code.

Was this helpful?

Get Cart Checkout Url

Get a cart's checkout URL by ID

Authorization

This API requires an authorization header - pass the access token from the OAuth installation flow.

Permissions

The API requires Wix Stores > Read Carts

GET

https://www.wixapis.com/stores/v1/carts/{id}/checkoutUrl

Path Params

NAME
TYPE
DESCRIPTION
id
Required

string

The requested cart ID to checkout

Response Object

Get Cart Checkout Url Response

NAME
TYPE
DESCRIPTION
url

string

Status/Error Codes

The response will include an HTTP status code.

Was this helpful?

Cart Completed

Authorization

This API requires an authorization header - pass the access token from the OAuth installation flow.

Permissions

The API requires Wix Stores > Read Carts

Event Body

The event's data is received as a JSON Web Token (JWT). Make sure to verify that the data was received by Wix - read more about it in the Webhooks article.

Payload

NAME
TYPE
DESCRIPTION
cartId

string

billingAddress

object

Customer's billing address

shippingInfo

object

Cart shipping information

weightUnit

string

One of UNSPECIFIED_WEIGHT_UNIT, KG, LB.

Weight unit used in this store

buyerNote

string

Message from the customer

buyerInfo

object

Customer's Wix ID

currency

object

Currency used for pricing in this store

completedTime

string

Time the cart was created

appliedCoupon

object

Coupon applied to this cart

totals

object

Totals for order's line items

Was this helpful?

Cart Created

Authorization

This API requires an authorization header - pass the access token from the OAuth installation flow.

Permissions

The API requires Wix Stores > Read Carts

Event Body

The event's data is received as a JSON Web Token (JWT). Make sure to verify that the data was received by Wix - read more about it in the Webhooks article.

Payload

NAME
TYPE
DESCRIPTION
cartId

string

weightUnit

string

One of UNSPECIFIED_WEIGHT_UNIT, KG, LB.

Weight unit used in this store

buyerInfo

object

Customer's wix ID

currency

object

Currency used for pricing in this store

totals

object

Totals for order's line items

creationTime

string

Time the cart was created

Was this helpful?

AbandonedCart

Attributes

NAME
TYPE
DESCRIPTION
abandonTime

string

Time the cart was abandoned

activities

Array<object>

History activities

total

string

Cart total including currency symbol

id

string

Original cart ID

status

string

One of ABANDONED, RECOVERED.

Cart status

buyerInfo

object

Buyer information

Was this helpful?

Get Abandoned Cart

Authorization

This API requires an authorization header - pass the access token from the OAuth installation flow.

Permissions

The API requires Wix Stores > Read Abandoned Carts

GET

https://www.wixapis.com/stores/v1/abandonedCarts/{id}

Path Params

NAME
TYPE
DESCRIPTION
id
Required

string

Cart ID

Response Object

Get Abandoned Cart Response

NAME
TYPE
DESCRIPTION
abandonedCart

object

Cart details

Status/Error Codes

The response will include an HTTP status code.

Was this helpful?

Query Abandoned Carts

Returns abandoned carts based on the requested query parameters

Authorization

This API requires an authorization header - pass the access token from the OAuth installation flow.

Permissions

The API requires Wix Stores > Read Abandoned Carts

POST

https://www.wixapis.com/stores/v1/abandonedCarts/query

Body Params

NAME
TYPE
DESCRIPTION
QueryAbandonedCartsRequest

object

Response Object

Query Abandoned Carts Response

NAME
TYPE
DESCRIPTION
abandonedCarts

Array<object>

Abandoned carts list

totalResults

integer

Total number of carts

Status/Error Codes

The response will include an HTTP status code.

Was this helpful?

Cart Abandoned Event

Authorization

This API requires an authorization header - pass the access token from the OAuth installation flow.

Permissions

The API requires Wix Stores > Read Abandoned Carts

Event Body

The event's data is received as a JSON Web Token (JWT). Make sure to verify that the data was received by Wix - read more about it in the Webhooks article.

Payload

NAME
TYPE
DESCRIPTION
abandonTime

string

Time the cart was abandoned

cartId

string

itemsCount

integer

Amount of items in cart

buyerInfo

object

Buyer information

couponId

string

Coupon ID (if relevant)

checkoutUrl

string

Checkout URL - checkout with the abandoned cart details

totals

object

Subtotal of all line items in cart, not before shipping and taxes

creationTime

string

Time the cart was created

Was this helpful?

Cart Recovered Event

Authorization

This API requires an authorization header - pass the access token from the OAuth installation flow.

Permissions

The API requires Wix Stores > Read Abandoned Carts

Event Body

The event's data is received as a JSON Web Token (JWT). Make sure to verify that the data was received by Wix - read more about it in the Webhooks article.

Payload

NAME
TYPE
DESCRIPTION
cartId

string

recoveredTime

string

Time the cart was recovered

creationTime

string

Time the cart was created

abandonedTime

string

Time the cart was abandoned

Was this helpful?

Catalog

Read the products from Wix Stores catalog

Inventory

Read & Write inventory from Wix Stores Inventory

Orders

Read orders from Wix Stores

)}