Search API library /

Generate a test token to explore our APIs

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

Carts

About Carts

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

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

Abandoned Carts

AbandonedCart Object

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

Get Abandoned Cart

Permissions

The API requires WIX_STORES.READ_ABANDONED_CARTS permission

GET

https://ecom.wix.com/v1/abandonedCarts/{id}

Request Headers

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

Path Params

NAME

TYPE

DESCRIPTION

id

Required

string

Cart ID

Status/Error Codes

The response will include an HTTP status code.

Response Object

NAME

TYPE

DESCRIPTION

abandonedCart

object

Cart details

Query Abandoned Carts

Returns abandoned carts based on the requested query parameters

Permissions

The API requires WIX_STORES.READ_ABANDONED_CARTS permission

POST

https://ecom.wix.com/v1/abandonedCarts/query

Request Headers

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

Body Params

NAME

TYPE

DESCRIPTION

query

object

Query details

Status/Error Codes

The response will include an HTTP status code.

Response Object

NAME

TYPE

DESCRIPTION

abandonedCarts

array<object>

Abandoned carts list

totalResults

integer

Total number of carts

Cart Abandoned Event Webhook

Permissions

The API requires Wix Stores > Read Abandoned Carts permission

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

Cart Recovered Event Webhook

Permissions

The API requires Wix Stores > Read Abandoned Carts permission

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

Carts

Cart Object

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

Get Cart

Get a cart by ID

GET

https://ecom.wix.com/_api/cart-server/v1/carts/{id}

Request Headers

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

Path Params

NAME

TYPE

DESCRIPTION

id

Required

string

Cart ID

Status/Error Codes

The response will include an HTTP status code.

Response Object

NAME

TYPE

DESCRIPTION

cart

object

Cart details

Get Cart Checkout Url

Get a cart's checkout URL by ID

GET

https://ecom.wix.com/_api/cart-server/v1/carts/{id}/checkoutUrl

Request Headers

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

Path Params

NAME

TYPE

DESCRIPTION

id

Required

string

The requested cart ID to checkout

Status/Error Codes

The response will include an HTTP status code.

Response Object

NAME

TYPE

DESCRIPTION

url

string

Cart Created Webhook

Permissions

The API requires Wix Stores > Read Carts permission

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

Cart Completed Webhook

Permissions

The API requires Wix Stores > Read Carts permission

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

Catalog

Catalog Service

About This API

Wix Stores creates a catalog of store owners’ items for purchase and allows store owners to create smaller collections of products by type or theme. The catalog (known to Wix store owners as the "All Products Collection") organizes the store’s products and collections and facilitates inventory management. With the Wix Stores Catalog API you can query individual products, collections or the entire catalog.

Querying the products and collections in the catalog enables you to coordinate a store’s inventory across other sales platforms (e.g., Facebook marketplace), or inventory management tools (e.g., NetSuite, TradeGecko), among other uses.

Note:
Write operations are not supported at this time.

Query language

For endpoints that allow querying, the format follows the following guidelines.

Collection

Collection Object

Attributes

NAME

TYPE

DESCRIPTION

id

string

Collection ID (generated automatically by the catalog)

name

string

Collection name

media

object

Media items (images, videos etc) associated with this collection

Get Collection

Returns a collection with the provided ID

Permissions

The API requires permission

GET

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

Request Headers

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

Path Params

NAME

TYPE

DESCRIPTION

id

Required

string

Requested collection ID

Status/Error Codes

The response will include an HTTP status code.

Response Object

NAME

TYPE

DESCRIPTION

collection

object

Examples

Example of Get Collection request

curl -X GET \
   'https://www.wixapis.com/stores/v1/collections/{id}'
   -H 'Authorization: <AUTH>'

Query Collections

Returns a list of up to 100 collections, given the provided paging, sorting and filtering

Permissions

The API requires permission

POST

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

Request Headers

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

Body Params

NAME

TYPE

DESCRIPTION

query

object

Status/Error Codes

The response will include an HTTP status code.

Response Object

NAME

TYPE

DESCRIPTION

collections

array<object>

metadata

object

totalResults

integer

Examples

Example of Query Collections request

curl -X POST \
   'https://www.wixapis.com/stores/v1/collections/query'
    --data-binary '{}'
   -H 'Content-Type: application/json'
   -H 'Authorization: <AUTH>'

Collection Created Webhook

Permissions

The API requires Wix Stores > Read Products permission

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

collectionId

string

Collection ID (generated automatically by the catalog)

name

string

Collection name

media

object

Media items (images, videos etc) associated with this collection

Collection Changed Webhook

Permissions

The API requires Wix Stores > Read Products permission

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

collectionId

string

Collection ID (generated automatically by the catalog)

changedFields

array<string>

Collection Deleted Webhook

Permissions

The API requires Wix Stores > Read Products permission

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

collectionId

string

Collection ID (generated automatically by the catalog)

Product

Product Object

Attributes

NAME

TYPE

DESCRIPTION

stock

object

Product inventory status

weight

number

Product weight

name

string

Product name

sku

string

Product SKU (stock keeping unit). If variants are being managed, this will be empty

visible

boolean

Whether the product is visible to customers

productOptions

array<object>

Options (color, size etc) for this product

description

string

Product description

price

object

Product price

slug

string

A permanent, friendly URL name (generated automatically by the catalog)

productType

string

One of unspecified_product_type, physical, digital.

Product type: physical/digital

ribbons

array<object>

Optional text marker that store owners can add to specific products (e.g., sale, new arrival)

id

string

Product ID (generated automatically by the catalog)

customTextFields

array<object>

Text box for the customer to add a message to their order (e.g., customization request)

media

object

Media items (images, videos etc) associated with this product

productPageUrl

object

Product page URL for this product (generated automatically by the server)

numericId

integer

Product’s unique numeric ID (assigned in ascending order) Promarily for sorting and filtering when crawling all products

manageVariants

boolean

Whether variants are being managed for this product

inventoryItemId

string

Inventory item ID - ID referencing the inventory system

additionalInfoSections

array<object>

Additional text that the store owner can assign to the product (e.g. shipping details, refund policy, etc.)

Get Product

Returns a product with the provided ID

Permissions

The API requires permission

GET

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

Request Headers

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

Path Params

NAME

TYPE

DESCRIPTION

id

Required

string

Requested product ID

Status/Error Codes

The response will include an HTTP status code.

Response Object

NAME

TYPE

DESCRIPTION

product

object

Examples

Example of Get Product request

curl -X GET \
   'https://www.wixapis.com/stores/v1/products/{id}'
   -H 'Authorization: <AUTH>'

Product Options Availability

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

Permissions

The API requires permission

POST

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

Request Headers

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

Path Params

NAME

TYPE

DESCRIPTION

id

Required

string

Requested product ID

Body Params

NAME

TYPE

DESCRIPTION

options

object

Array containing the selected options (e.g, color: Blue, size: Large)

Status/Error Codes

The response will include an HTTP status code.

Response Object

NAME

TYPE

DESCRIPTION

selectedVariant

object

The variant, given that the all the choices were provided

media

object

Media items (images, videos etc) associated with this choice

productOptions

array<object>

Options (color, size, etc.) for this product, given the choices provided, with the inventory and visibility fields updated per the provided choices

availableForPurchase

boolean

Whether all the selected choices result in a visible, in-stock variant

Examples

Example of Product Options Availability request

General product availability query for a product with multiple selections/variants.
availableForPurchase will always be false, because some relevant selections are not passed in the request.

Request

curl -X POST \
'https://www.wixapis.com/stores/v1/products/{id}/productOptionsAvailability'
--data-binary '{"options": {"Size": "S","Color": "Green"}}'
-H 'Content-Type: application/json'
-H 'Authorization: <AUTH>'

Response returns data only for the specific selection passed in the request.
Data referring to variants (e.g., availableForPurchase) will return as false because the required information was not passed in the request.

Response

{
  "productOptions": [
    {
      "optionType": "drop_down",
      "name": "Size",
      "choices": [
        {
          "value": "S",
          "description": "S",
          "inStock": true,
          "visible": true
        },
        {
          "value": "M",
          "description": "M",
          "inStock": true,
          "visible": true
        },
        {
          "value": "L",
          "description": "L",
          "inStock": true,
          "visible": true
        }
      ]
    },
    {
      "optionType": "color",
      "name": "Color",
      "choices": [
        {
          "value": "#FF0000",
          "description": "Red",
          "inStock": false,
          "visible": true
        },
        {
          "value": "#00FF00",
          "description": "Green",
          "inStock": true,
          "visible": true
        },
        {
          "value": "#00000FF",
          "description": "Blue",
          "inStock": true,
          "visible": true
        }
      ]
    }
  ],
  "availableForPurchase": false
}

Product availability query for a specific product variant.

Request

curl -X POST \
'https://www.wixapis.com/stores/v1/products/{id}/productOptionsAvailability'
--data-binary '{"options": {"Size": "S","Color": "Green"}}'
'Content-Type: application/json'
-H 'Authorization: XXX'

Returned data includes price, weight, SKU, inventory and availability for purchase of the specific variant passed in the request.

Response

{
  "selectedVariant": {
    "price": {
      "currency": "USD",
      "price": 81,
      "discountedPrice": 81,
      "formatted": {
        "price": "$81.00",
        "discountedPrice": "$81.00"
      }
    },
    "weight": 0,
    "sku": "364215376135191",
    "inStock": true,
    "visible": true
  },
  "productOptions": [
    {
      "optionType": "drop_down",
      "name": "Size",
      "choices": [
        {
          "value": "S",
          "description": "S",
          "inStock": true,
          "visible": true
        },
        {
          "value": "M",
          "description": "M",
          "inStock": true,
          "visible": true
        },
        {
          "value": "L",
          "description": "L",
          "inStock": true,
          "visible": true
        }
      ]
    },
    {
      "optionType": "color",
      "name": "Color",
      "choices": [
        {
          "value": "#FF0000",
          "description": "Red",
          "inStock": false,
          "visible": true
        },
        {
          "value": "#00FF00",
          "description": "Green",
          "inStock": true,
          "visible": true
        },
        {
          "value": "#00000FF",
          "description": "Blue",
          "inStock": true,
          "visible": true
        }
      ]
    }
  ],
  "availableForPurchase": true
}

Query Products

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

Permissions

The API requires permission

POST

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

Request Headers

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

Body Params

NAME

TYPE

DESCRIPTION

query

object

Status/Error Codes

The response will include an HTTP status code.

Response Object

NAME

TYPE

DESCRIPTION

products

array<object>

metadata

object

totalResults

integer

Examples

Example of Query Products request

curl -X POST \
   'https://www.wixapis.com/stores/v1/products/query'
    --data-binary '{}'
   -H 'Content-Type: application/json'
   -H 'Authorization: <AUTH>'

Product Created Webhook

Permissions

The API requires Wix Stores > Read Products permission

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

name

string

Product name

sku

string

Product SKU (stock keeping unit). If variants are being managed, this will be empty

visible

boolean

Whether the product is visible to customers

price

object

Product price

media

object

Media items (images, videos etc) associated with this product

productPageUrl

object

Product page URL for this product (generated automatically by the server)

productId

string

Product ID (generated automatically by the catalog)

Product Changed Webhook

Permissions

The API requires Wix Stores > Read Products permission

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

productId

string

Product ID

changedFields

array<string>

Product Deleted Webhook

Permissions

The API requires Wix Stores > Read Products permission

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

productId

string

ID of deleted product

Variant

Query Variants

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

Permissions

The API requires permission

POST

https://www.wixapis.com/stores/v1/products/{id}/variants/query

Request Headers

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

Path Params

NAME

TYPE

DESCRIPTION

id

Required

string

Requested product ID

Body Params

NAME

TYPE

DESCRIPTION

choices

object

The specific choices available or chosen from within a selection (e.g., choosing the red Selection triggers the red Choice). You may specify all the relevant choices for a specific variant, or only some of the options, which will return all corresponding variants (Not relevant when passing variant IDs)

variantIds

array<string>

List of variant IDs (Not relevant when passing choices)

paging

object

Status/Error Codes

The response will include an HTTP status code.

Response Object

NAME

TYPE

DESCRIPTION

variants

array<object>

All variants

metadata

object

totalResults

integer

Variants Changed Webhook

Permissions

The API requires Wix Stores > Read Products permission

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

productId

string

Product ID

variants

array<object>

Inventory

About Inventory

The Wix Stores Inventory service allows you to:

  • Enable and disable inventory tracking (per product/item).
  • Query and modify the inventory for product variants.

Note:
See the Wix Stores Terminology defined above.

A product's inventory item ID is included in the response returned by the Query Products endpoint.

Note:
When inventory tracking is disabled, Wix store owners may still update the variant quantity manually.

Use Case

  1. Get the inventory item ID for the product you want to read/update.
    a. Call the Query Products endpoint.
    b. Collect the inventory item ID from the response.

    Note:
    You can change or check the inventory status for this product using the Get Item Inventory Status or the Update Item Inventory Status endpoints.

  2. Call the Get Variant Inventory Status endpoint, filtering for the relevant choices/variants.

InventoryItem Object

Attributes

NAME

TYPE

DESCRIPTION

id

string

Inventory item ID

externalId

string

Product ID

trackInventory

boolean

Whether inventory is being tracked

Get Item Inventory Status

Permissions

The API requires Wix Stores > Read Inventory permission

GET

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

Request Headers

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

Path Params

NAME

TYPE

DESCRIPTION

id

Required

string

Inventory item ID

Status/Error Codes

The response will include an HTTP status code.

Response Object

NAME

TYPE

DESCRIPTION

item

object

Get Variant Inventory Status

Permissions

The API requires Wix Stores > Read Inventory permission

GET

https://www.wixapis.com/stores/v1/inventoryItems/{item_id}/variants/{variant_id}

Request Headers

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

Path Params

NAME

TYPE

DESCRIPTION

itemId

Required

string

Inventory item ID

variantId

Required

string

Variant ID

Status/Error Codes

The response will include an HTTP status code.

Response Object

NAME

TYPE

DESCRIPTION

variant

object

Update Item Inventory Status

Permissions

The API requires Wix Stores > Modify Inventory permission

PATCH

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

Request Headers

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

Path Params

NAME

TYPE

DESCRIPTION

item.id

Required

string

Inventory item ID

Body Params

NAME

TYPE

DESCRIPTION

item

object

Inventory item ID

Status/Error Codes

The response will include an HTTP status code.

Response Object

Returns an empty object.

Update Variant Inventory Status

Permissions

The API requires Wix Stores > Modify Inventory permission

PATCH

https://www.wixapis.com/stores/v1/inventoryItems/{variant.item_id}/variants/{variant.variant_id}

Request Headers

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

Path Params

NAME

TYPE

DESCRIPTION

variant.item_id

Required

string

Inventory item ID

variant.variant_id

Required

string

Variant ID

Body Params

NAME

TYPE

DESCRIPTION

variant

object

Status/Error Codes

The response will include an HTTP status code.

Response Object

Returns an empty object.

Inventory Item Changed Webhook

Permissions

The API requires Wix Stores > Read Inventory permission

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

inventoryItemId

string

Inventory item ID

externalId

string

Item ID from external source

trackInventory

boolean

Whether inventory is being tracked

Inventory Variants Changed Webhook

Permissions

The API requires Wix Stores > Read Inventory permission

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

inventoryItemId

string

Inventory item ID

externalId

string

Item ID from external source

variants

array<object>

Orders

Orders Service

About This API

Stores Orders allows third party apps to read orders for Wix store owners.

Note:
Write operations are not supported at this time.

Order Types

Shipping orders: Order and shipment of any selection of products from the store's catalog.
Pickup orders: Order of any selection of products from the store's catalog for user pickup.
Point of Sale (POS) orders: Sale consisting only of price and partial billing information, of products not included in the store's catalog.

Query Language

For endpoints that allow querying, the format follows the following guidelines.

Fields That Allow Filtering

FieldOperatorsSorting Allowed
dateCreated$eq,$ne,$hasSome,$lt,$lte,$gt,$gteAllowed
paymentStatus$eq,$ne,$hasSome,$contains,$startsWithAllowed
archived$eq,$ne
read$eq,$ne
number$eq,$ne,$hasSome,$lt,$lte,$gt,$gteAllowed
id$eq,$ne,$hasSome,$contains,$startsWithAllowed
lineItems.productId$eq,$ne,$hasSome,$hasAll
lineItems.name$eq,$ne,$hasSome,$hasAll
billingInfo.address.fullName$eq,$ne,$hasSome,$lt,$lte,$gt,$gte
buyerInfo.id$eq,$ne,$hasSome,$lt,$lte,$gt,$gte

** Note that "HasSome" is same as the operator "IN" in SQL

Below are some usage examples:

Get all paid orders

curl 'https://www.wix.com/_api/orders-server/v2/orders/query' --data-binary '{"query":{"filter":"{\"paymentStatus\": \"PAID\"}"}}' -H 'Content-Type: application/json' -H 'Authorization: XXX'

Get all orders, sorted by creation date

curl 'https://www.wix.com/_api/orders-server/v2/orders/query' --data-binary '{"query":{"sort":"[{\"dateCreated\": \"asc\"}]"}}' -H 'Content-Type: application/json' -H 'Authorization: XXX'

Get orders by IDs

curl 'https://www.wix.com/_api/orders-server/v2/orders/query' --data-binary '{"query":{"filter":"{\"id\": {\"$hasSome\": [\"ORDER_ID_1\",\"ORDER_ID_2\"]}}"}}' -H 'Content-Type: application/json' -H 'Authorization: xxx'

Order Object

Attributes

NAME

TYPE

DESCRIPTION

read

boolean

Whether the order was read by the store owner

number

integer

ID displayed in the owner's store (auto-generated)

lineItems

array<object>

Line items ordered

invoiceInfo

object

Invoice information

paymentStatus

string

One of UNSPECIFIED_PAYMENT_STATUS, NOT_PAID, PAID, PARTIALLY_REFUNDED, FULLY_REFUNDED.

Order payment status

archived

boolean

Order archive status

shippingInfo

object

Order shipping information

activities

array<object>

Order history log containing changes that were made to the order

customField

object

Custom field

weightUnit

string

One of UNSPECIFIED_WEIGHT_UNIT, KG, LB.

Weight unit used in this store

id

string

Order ID (auto-generated upon order creation)

dateCreated

string

Order creation date

buyerNote

string

Message from the customer (e.g., customization request)

billingInfo

object

Order billing information

buyerInfo

object

Customer information

currency

string

Currency used for pricing in this store

discount

object

Applied discount

totals

object

Totals for order's line items

fulfillmentStatus

string

One of NOT_FULFILLED, FULFILLED, CANCELED.

Order fulfillment status

fulfillments

array<object>

Order fulfillments

Create Fulfillment

Creates a fulfillment (a subset of an order, with line items that are being shipped together) based on the body paramaters 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)

Permissions

The API requires Wix Stores > Modify Orders permission

POST

https://www.wixapis.com/stores/v2/orders/{orderId}/fulfillments

Request Headers

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

Path Params

NAME

TYPE

DESCRIPTION

orderId

Required

string

Order ID to which the fulfillment will be related

Body Params

NAME

TYPE

DESCRIPTION

fulfillment

object

Fulfillment to be created in the service

Status/Error Codes

The response will include an HTTP status code.

Response Object

NAME

TYPE

DESCRIPTION

id

string

ID of the created fulfillment

Get Order

Returns an order with the provided ID

Permissions

The API requires Wix Stores > Read Orders permission

GET

https://www.wixapis.com/stores/v2/orders/{id}

Request Headers

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

Path Params

NAME

TYPE

DESCRIPTION

id

Required

string

Requested order ID

Status/Error Codes

The response will include an HTTP status code.

Response Object

NAME

TYPE

DESCRIPTION

order

object

Requested order

Examples

Example of Get Order request

curl -X GET \
   'https://www.wixapis.com/stores/v2/orders/<ID>'
   -H 'Authorization: <AUTH>'

Query Orders

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

Permissions

The API requires Wix Stores > Read Orders permission

POST

https://www.wixapis.com/stores/v2/orders/query

Request Headers

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

Body Params

NAME

TYPE

DESCRIPTION

query

object

Query

Status/Error Codes

The response will include an HTTP status code.

Response Object

NAME

TYPE

DESCRIPTION

orders

array<object>

Orders answered the query

metadata

object

Paging metadata

totalResults

integer

Total results

Examples

Example of Query Order request

curl 'https://www.wixapis.com/stores/v2/orders/query'
   --data-binary '{"query":{"filter":"{\"paymentStatus\": \"PAID\"}"}}'
   -H 'Content-Type: application/json'
   -H 'Authorization: <AUTH>'

Update Fulfillment

Updates an existing fulfillment

Permissions

The API requires Wix Stores > Modify Orders permission

PUT

https://www.wixapis.com/stores/v2/orders/{orderId}/fulfillments/{fulfillmentId}

Request Headers

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

Path Params

NAME

TYPE

DESCRIPTION

orderId

Required

string

Order ID

fulfillmentId

Required

string

Fulfillment ID

Body Params

NAME

TYPE

DESCRIPTION

fulfillmentTrackingInfo

object

Updated tracking info

Status/Error Codes

The response will include an HTTP status code.

Response Object

Returns an empty object.

Order Event Webhook

Permissions

The API requires Wix Stores > Read Orders permission

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

read

boolean

Whether the order was read by the store owner

number

integer

ID displayed in the owner's store (auto generated)

paymentStatus

string

One of UNSPECIFIED_PAYMENT_STATUS, NOT_PAID, PAID, PARTIALLY_REFUNDED, FULLY_REFUNDED.

Order payment status

orderId

string

Order ID (auto generated upon order creation)

archived

boolean

Order archive status

weightUnit

string

One of UNSPECIFIED_WEIGHT_UNIT, KG, LB.

Weight unit used in this store

dateCreated

string

Order creation date

buyerInfo

object

Customer information

currency

string

Currency used for pricing in this store

totals

object

Totals for order's line items

fulfillmentStatus

string

One of NOT_FULFILLED, FULFILLED, CANCELED.

Order fulfillment status