Search API library /

Generate a test token to explore our APIs

Wix Stores

This is Wix Stores summary

Description

This is Wix Stores description

Guides

guides that relates to this api

API's

API's related to this category

  • Carts

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

  • Catalog

    Read the products from Wix Stores catalog

  • Inventory

    Read & Write inventory from Wix Stores Inventory

  • Orders

    Read orders from Wix Stores

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.

Was this helpful?

Carts

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

Guides

guides that relates to this api

Carts

Endpoints that relates to this API

  • Cart
    OBJECT
  • Get Cart
    GET

    Get a cart by ID

  • Get Cart Checkout Url
    GET

    Get a cart's checkout URL by ID

  • Cart Completed
    WEBHOOK

    This webhook is triggered when a customer has completed their checkout. In most cases, an order will be created immediately and an Order Event webhook will also be triggered. In some cases, the payment provider may list the order as "pending" - and the order will not be created until the payment is listed as "approved."

  • Cart Created
    WEBHOOK

Abandoned Carts

Endpoints that relates to this API

Catalog

Read the products from Wix Stores catalog

Guides

guides that relates to this api

Collection

Endpoints that relates to this API

Product

Endpoints that relates to this API

  • Product
    OBJECT
  • Create Product
    POST

    Creates new product

  • Get Product
    GET

    Returns a product with the provided ID

  • Query Products
    POST

    Returns a list of up to 100 products, given the provided paging, sorting and filtering.
    Hidden products are not returned.

  • Update Product
    PATCH

    Updates specified fields in product

  • Delete Product
    DELETE

    Deletes a product by ID

  • Delete Product Options
    DELETE

    Delete all options from a specific product (only available when variant management is disabled)

  • Product Options Availability
    POST

    Gets the availability of relevant product variants based on the product ID and selections provided. See Use Cases for an example.

  • Add Product Media
    POST

    Adds media items to a specified product, either via URL or existing media ID

  • Remove Product Media
    POST

    Removes specified media items from a specific product

  • Add Product Media To Choices
    PATCH

    Links media items that are already associated with a specific product to a choice within the same product.

    Media items can only be set for choices within one option at a time - e.g., if you set media items for some or all of the choices within the Colors option (blue, green, and red), you won't be able to also assign media items to choices within the Size option (S, M, and L).

    You can clear existing media from choices via the Remove Product Media From Choices endpoint

  • Remove Product Media From Choices
    POST

    Removes media items from all or some of a product's choices. (Media items can only be set for choices within one option at a time - e.g., if you set media items for some or all of the choices within the Colors option (blue, green, and red), you won't be able to also assign media items to choices within the Size option (S, M, and L).)

  • Product Changed
    WEBHOOK
  • Product Created
    WEBHOOK
  • Product Deleted
    WEBHOOK

Variant

Endpoints that relates to this API

  • Query Variants
    POST

    Returns product variants, based on either choices (option-choice key-value pairs) or variant IDs

  • Update Variants
    PATCH

    Updates data for the specified product variant

  • Reset All Variant Data
    POST

    Resets all variant data to default values (price = current product price; weight = current product weight; SKU = current product SKU; visibility = true)

  • Variants Changed
    WEBHOOK

Orders

Read orders from Wix Stores

Guides

guides that relates to this api

Methods

The endpoints this api exposes

  • Get Order
    GET

    Returns an order with the provided ID

  • Query Orders
    POST

    Returns a list of up to 100 orders, given the provided paging, sorting and filters. Hidden orders are not returned.

  • Create Fulfillment
    POST

    Creates a fulfillment (a subset of an order, with line items that are being shipped together) based on the body parameters passed with the request. If the site owner has requested it, calling this request will trigger an email to the customer (based on the Wix store settings)

  • Update Fulfillment
    PUT

    Updates an existing fulfillment

  • Delete Fulfillment
    DELETE

    Deletes an existing fulfillment