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?

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 Learn more.

Guides

Additional information about this section

Main Entity

The API's main object

Endpoints

The endpoints exposed by this API

  • POST
    Create Order

    Creates a new order. The following body params are required: totals.subtotal, totals.total, lineItems.quantity, lineItems.priceData, lineItems.name, ...

  • GET
    Get Order

    Returns an order with the provided ID

  • POST
    Query Orders

    Returns a list of up to 100 orders, given the provided paging, sorting and filters. See Stores Pagination for more information. Hidden orders are not returned

  • POST
    Create Fulfillment

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

  • PUT
    Update Fulfillment

    Updates an existing fulfillment

  • DELETE
    Delete Fulfillment

    Deletes an existing fulfillment

Webhooks

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

Was this helpful?

Order

Attributes

NAME
TYPE
DESCRIPTION
read

boolean

Deprecated

number

integer

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

cartId

string

ID of the cart this order was created from

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

lastUpdated

string

Latest update timestamp

archived

boolean

Order archive status

enteredBy

object

Identity of the order creator (in cases where the order was created on behalf of a buyer)

shippingInfo

object

Order shipping information

activities

Array<object>

Log of 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

buyerLanguage

string

Language to be used when communicating with the customer For a site that supports multiple languages, this is the language the customer selected (otherwise this defaults to the site language)

channelInfo

object

Sales channel that submitted this order

totals

object

Totals for order's line items

fulfillmentStatus

string

One of NOT_FULFILLED, FULFILLED, CANCELED, PARTIALLY_FULFILLED.

Order fulfillment status

fulfillments

Array<object>

Order fulfillments

Was this helpful?

Create Order

Creates a new order.
The following body params are required: totals.subtotal, totals.total, lineItems.quantity, lineItems.priceData, lineItems.name, channelInfo.type.
Only orders with the paymentStatus parameter set as PAID or NOT_PAID will show up in the site owner's Stores Orders tab in their dashboard.
The billingInfo.paymentProviderTransactionId and billingInfo.paymentMethod parameters can only be passed when paymentStatus is PAID.
The billingAddress parameter is required unless channelInfo.type = POS.
The shippingInfo.shipmentDetails.address parameter is required unless one of the following is true:

  1. the shippingInfo.pickupDetails is passed instead,
  2. channelInfo.type = POS,
  3. All order items are lineItems.lineItemType = digital.

When passing lineItems.variantId, lineItems.options is required. When passing lineItems.productId, lineItem.lineItemType is limited to PHYSICAL.
When not passing lineItems.productId, lineItem.lineItemType is limited to CUSTOM_AMOUNT_ITEM.

Authorization

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

Permissions

The API requires WIX_STORES.CREATE_ORDERS

POST

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

Body Params

NAME
TYPE
DESCRIPTION
order
Required

object

Response Object

Create Order Response

NAME
TYPE
DESCRIPTION
order

object

Status/Error Codes

The response will include an HTTP status code.

Was this helpful?

Example 1

Request

curl

Copy Code
1curl 'https://www.wixapis.com/stores/v2/orders' \
2--data-binary '{
3                   "order": {
4                       "totals": {
5                           "subtotal": "10",
6                           "shipping": "3",
7                           "tax": "3",
8                           "discount": "1",
9                           "total": "15"
10                       },
11                       "billingInfo": {
12                           "paymentMethod": "PayPal",
13                           "paymentProviderTransactionId": "tx_1806",
14                           "address": {
15                               "fullName": {
16                                   "firstName": "John",
17                                   "lastName": "Smith"
18                               },
19                               "country": "US",
20                               "city": "New York",
21                               "zipCode": "92544",
22                               "phone": "+972 555234555",
23                               "email": "Ivanushka@example.com"
24                           }
25                       },
26                       "shippingInfo": {
27                           "deliveryOption": "Express",
28                           "estimatedDeliveryTime": "Today",
29                           "shipmentDetails": {
30                               "address": {
31                                   "fullName": {
32                                       "firstName": "John",
33                                       "lastName": "Smith"
34                                   },
35                                   "country": "US",
36                                   "city": "New York",
37                                   "zipCode": "92544",
38                                   "phone": "+972 555234555",
39                                   "email": "Ivanushka@example.com"
40                               },
41                               "tax": "1",
42                               "priceData": {
43                                  "taxIncludedInPrice": false,
44                                  "price": "3"
45                               }
46                           }
47                       },
48                       "paymentStatus": "PAID",
49                       "lineItems": [
50                           {
51                               "quantity": 2,
52                               "discount": "1",
53                               "tax": "1",
54                               "name": "my product",
55                               "productId": "a1f9d337-f831-4529-31e6-67db8fd4e1aa",
56                               "lineItemType": "PHYSICAL",
57                               "weight": "15",
58                               "sku": "12345678",
59                               "priceData": {
60                                  "taxIncludedInPrice": false,
61                                  "price": "5"
62                               }
63                           }
64                       ],
65                       "channelInfo": {
66                           "type": "WEB"
67                       }
68                   }
69               }' \
70-H 'Content-Type: application/json' \
71-H 'Authorization: <AUTH>'

Response

json

1
2{"order": {
3  "id": "fedb19f5-bd4c-4bfc-b2d1-212538319611",
4  "number": 10096,
5  "dateCreated": "2020-03-18T16:47:59.222Z",
6  "currency": "USD",
7  "weightUnit": "LB",
8  "totals":   {
9    "subtotal": "10",
10    "shipping": "3",
11    "tax": "3",
12    "discount": "1",
13    "total": "15",
14    "weight": "30",
15    "quantity": 2
16  },
17  "billingInfo":   {
18    "paymentMethod": "PayPal",
19    "externalTransactionId": "tx_1806",
20    "paymentProviderTransactionId": "tx_1806",
21    "address":     {
22      "fullName":       {
23        "firstName": "John",
24        "lastName": "Smith"
25      },
26      "country": "US",
27      "city": "New York",
28      "zipCode": "92544",
29      "phone": "+972 555234555",
30      "email": "Ivanushka@example.com"
31    },
32    "paidDate": "2020-03-18T16:47:59.244Z"
33  },
34  "shippingInfo":   {
35    "deliveryOption": "Express",
36    "estimatedDeliveryTime": "Today",
37    "shipmentDetails":     {
38      "address":       {
39        "fullName":         {
40          "firstName": "John",
41          "lastName": "Smith"
42        },
43        "country": "US",
44        "city": "New York",
45        "zipCode": "92544",
46        "phone": "+972 555234555",
47        "email": "Ivanushka@example.com"
48      },
49      "discount": "0",
50      "tax": "1",
51      "priceData":       {
52        "taxIncludedInPrice": false,
53        "price": "3"
54      }
55    }
56  },
57  "read": false,
58  "archived": false,
59  "paymentStatus": "PAID",
60  "fulfillmentStatus": "NOT_FULFILLED",
61  "lineItems": [  {
62    "index": 1,
63    "quantity": 2,
64    "price": "5",
65    "name": "my product",
66    "productId": "a1f9d337-f831-4529-31e6-67db8fd4e1aa",
67    "totalPrice": "10",
68    "lineItemType": "PHYSICAL",
69    "options": [],
70    "customTextFields": [],
71    "weight": "15",
72    "sku": "12345678",
73    "discount": "1",
74    "tax": "1",
75    "taxIncludedInPrice": false,
76    "priceData":     {
77      "taxIncludedInPrice": false,
78      "price": "5",
79      "totalPrice": "10"
80    }
81  }],
82  "activities":   [
83        {
84      "type": "ORDER_PLACED",
85      "timestamp": "2020-03-18T16:47:59.222Z"
86    },
87        {
88      "type": "ORDER_PAID",
89      "timestamp": "2020-03-18T16:47:59.244Z"
90    }
91  ],
92  "fulfillments": [],
93  "discount": {"value": "1"},
94  "buyerLanguage": "en",
95  "channelInfo": {"type": "WEB"},
96  "enteredBy":   {
97    "id": "e85274cf-047a-4989-baff-dac5e0c3971d",
98    "identityType": "USER"
99  },
100  "lastUpdated": "2020-03-18T16:47:59.244Z"
101}}
Example 2

Get Order

Returns an order with the provided ID

Authorization

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

Permissions

The API requires Wix Stores > Read Orders

GET

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

Path Params

NAME
TYPE
DESCRIPTION
id
Required

string

Requested order ID

Response Object

Get Order Response V2

NAME
TYPE
DESCRIPTION
order

object

Order data

Status/Error Codes

The response will include an HTTP status code.

Was this helpful?

Request

curl

Copy Code
1curl 'https://www.wixapis.com/stores/v2/orders/fedb19f5-bd4c-4bfc-b2d1-212538319611' \
2-H 'Content-Type: application/json' \
3-H 'Authorization: <AUTH>'

Response

json

1
2{"order": {
3  "id": "fedb19f5-bd4c-4bfc-b2d1-212538319611",
4  "number": 10096,
5  "dateCreated": "2020-03-18T16:47:59.222Z",
6  "currency": "USD",
7  "weightUnit": "LB",
8  "totals":   {
9    "subtotal": "10",
10    "shipping": "3",
11    "tax": "3",
12    "discount": "1",
13    "total": "15",
14    "weight": "30",
15    "quantity": 2
16  },
17  "billingInfo":   {
18    "paymentMethod": "PayPal",
19    "externalTransactionId": "tx_1806",
20    "paymentProviderTransactionId": "tx_1806",
21    "address":     {
22      "fullName":       {
23        "firstName": "John",
24        "lastName": "Smith"
25      },
26      "country": "US",
27      "city": "New York",
28      "zipCode": "92544",
29      "phone": "+972 555234555",
30      "email": "Ivanushka@example.com"
31    },
32    "paidDate": "2020-03-18T16:47:59.244Z"
33  },
34  "shippingInfo":   {
35    "deliveryOption": "Express",
36    "estimatedDeliveryTime": "Today",
37    "shipmentDetails":     {
38      "address":       {
39        "fullName":         {
40          "firstName": "John",
41          "lastName": "Smith"
42        },
43        "country": "US",
44        "city": "New York",
45        "zipCode": "92544",
46        "phone": "+972 555234555",
47        "email": "Ivanushka@example.com"
48      },
49      "discount": "0",
50      "tax": "1",
51      "priceData":       {
52        "taxIncludedInPrice": false,
53        "price": "3"
54      }
55    }
56  },
57  "read": false,
58  "archived": false,
59  "paymentStatus": "PAID",
60  "fulfillmentStatus": "NOT_FULFILLED",
61  "lineItems": [  {
62    "index": 1,
63    "quantity": 2,
64    "price": "5",
65    "name": "my product",
66    "productId": "a1f9d337-f831-4529-31e6-67db8fd4e1aa",
67    "totalPrice": "10",
68    "lineItemType": "PHYSICAL",
69    "options": [],
70    "customTextFields": [],
71    "weight": "15",
72    "sku": "12345678",
73    "discount": "1",
74    "tax": "1",
75    "taxIncludedInPrice": false,
76    "priceData":     {
77      "taxIncludedInPrice": false,
78      "price": "5",
79      "totalPrice": "10"
80    }
81  }],
82  "activities":   [
83        {
84      "type": "ORDER_PLACED",
85      "timestamp": "2020-03-18T16:47:59.222Z"
86    },
87        {
88      "type": "ORDER_PAID",
89      "timestamp": "2020-03-18T16:47:59.244Z"
90    }
91  ],
92  "fulfillments": [],
93  "discount": {"value": "1"},
94  "buyerLanguage": "en",
95  "channelInfo": {"type": "WEB"},
96  "enteredBy":   {
97    "id": "e85274cf-047a-4989-baff-dac5e0c3971d",
98    "identityType": "USER"
99  },
100  "lastUpdated": "2020-03-18T16:47:59.244Z"
101}}

Query Orders

Returns a list of up to 100 orders, given the provided paging, sorting and filters.
See Stores Pagination for more information.
Hidden orders are not returned

Description

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
lastUpdated$eq,$ne,$hasSome,$lt,$lte,$gt,$gteAllowed

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

Authorization

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

Permissions

The API requires Wix Stores > Read Orders

POST

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

Body Params

NAME
TYPE
DESCRIPTION
QueryOrdersRequestV2

object

Response Object

Query Orders Response V2

NAME
TYPE
DESCRIPTION
orders

Array<object>

Order data

metadata

object

Paging metadata

totalResults

integer

Total results

Status/Error Codes

The response will include an HTTP status code.

Was this helpful?

Request

curl

Copy Code
1curl 'https://www.wixapis.com/stores/v2/orders/query' \
2--data-binary '{
3                 "query": {
4                   "filter": "{\"paymentStatus\": \"PAID\"}",
5                   "paging": {
6                     "limit": 1
7                   },
8                   "sort": "[{\"number\": \"desc\"}]"
9                 }
10               }' \
11-H 'Content-Type: application/json' \
12-H 'Authorization: <AUTH>'

Response

json

1
2{
3  "orders": [  {
4    "id": "fedb19f5-bd4c-4bfc-b2d1-212538319611",
5    "number": 10096,
6    "dateCreated": "2020-03-18T16:47:59.222Z",
7    "buyerInfo":     {
8      "id": "e9a69747-6816-42fb-87bf-4cd60a408b4e",
9      "type": "CONTACT",
10      "identityType": "CONTACT",
11      "firstName": "John",
12      "lastName": "Smith",
13      "phone": "+972 555234555",
14      "email": "Ivanushka@example.com"
15    },
16    "currency": "USD",
17    "weightUnit": "LB",
18    "totals":     {
19      "subtotal": "10",
20      "shipping": "3",
21      "tax": "3",
22      "discount": "1",
23      "total": "15",
24      "weight": "30",
25      "quantity": 2
26    },
27    "billingInfo":     {
28      "paymentMethod": "PayPal",
29      "externalTransactionId": "tx_1806",
30      "paymentProviderTransactionId": "tx_1806",
31      "address":       {
32        "fullName":         {
33          "firstName": "John",
34          "lastName": "Smith"
35        },
36        "country": "US",
37        "city": "New York",
38        "zipCode": "92544",
39        "phone": "+972 555234555",
40        "email": "Ivanushka@example.com"
41      },
42      "paidDate": "2020-03-18T16:47:59.244Z"
43    },
44    "shippingInfo":     {
45      "deliveryOption": "Express",
46      "estimatedDeliveryTime": "Today",
47      "shipmentDetails":       {
48        "address":         {
49          "fullName":           {
50            "firstName": "John",
51            "lastName": "Smith"
52          },
53          "country": "US",
54          "city": "New York",
55          "zipCode": "92544",
56          "phone": "+972 555234555",
57          "email": "Ivanushka@example.com"
58        },
59        "trackingInfo":         {
60          "trackingNumber": "123",
61          "shippingProvider": "FEDEX",
62          "trackingLink": "https://www.fedex.com/apps/fedextrack/?action=track&trackingnumber=123"
63        },
64        "discount": "0",
65        "tax": "1",
66        "priceData":         {
67          "taxIncludedInPrice": false,
68          "price": "3"
69        }
70      }
71    },
72    "read": false,
73    "archived": false,
74    "paymentStatus": "PAID",
75    "fulfillmentStatus": "PARTIALLY_FULFILLED",
76    "lineItems": [    {
77      "index": 1,
78      "quantity": 2,
79      "price": "5",
80      "name": "my product",
81      "productId": "a1f9d337-f831-4529-31e6-67db8fd4e1aa",
82      "totalPrice": "10",
83      "lineItemType": "PHYSICAL",
84      "options": [],
85      "customTextFields": [],
86      "weight": "15",
87      "sku": "12345678",
88      "discount": "1",
89      "tax": "1",
90      "taxIncludedInPrice": false,
91      "priceData":       {
92        "taxIncludedInPrice": false,
93        "price": "5",
94        "totalPrice": "10"
95      }
96    }],
97    "activities":     [
98            {
99        "type": "ORDER_PLACED",
100        "timestamp": "2020-03-18T16:47:59.222Z"
101      },
102            {
103        "type": "ORDER_PAID",
104        "timestamp": "2020-03-18T16:47:59.244Z"
105      },
106            {
107        "type": "TRACKING_NUMBER_ADDED",
108        "timestamp": "2020-03-18T16:55:59.178Z"
109      },
110            {
111        "type": "TRACKING_NUMBER_ADDED",
112        "timestamp": "2020-03-18T17:04:01.397Z"
113      },
114            {
115        "type": "TRACKING_NUMBER_EDITED",
116        "timestamp": "2020-03-18T17:05:55.724Z"
117      }
118    ],
119    "fulfillments": [    {
120      "id": "5945017a-bf19-414e-ae67-af3d2dbc66ff",
121      "dateCreated": "2020-03-18T17:04:01.397Z",
122      "lineItems": [      {
123        "index": 1,
124        "quantity": 1
125      }],
126      "trackingInfo":       {
127        "trackingNumber": "123",
128        "shippingProvider": "fedex",
129        "trackingLink": "https://www.fedex.com/apps/fedextrack/?action=track&trackingnumber=123"
130      }
131    }],
132    "discount": {"value": "1"},
133    "buyerLanguage": "en",
134    "channelInfo": {"type": "WEB"},
135    "enteredBy":     {
136      "id": "e85274cf-047a-4989-baff-dac5e0c3971d",
137      "identityType": "USER"
138    },
139    "lastUpdated": "2020-03-18T17:05:55.724Z"
140  }],
141  "metadata":   {
142    "items": 1,
143    "offset": 0
144  },
145  "totalResults": 80
146}

Create Fulfillment

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)

Authorization

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

Permissions

The API requires Wix Stores > Modify Orders

POST

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

Path Params

NAME
TYPE
DESCRIPTION
orderId
Required

string

Order ID (to which the fulfillment will be related)

Body Params

NAME
TYPE
DESCRIPTION
CreateFulfillmentRequest

object

Response Object

Create Fulfillment Response

NAME
TYPE
DESCRIPTION
id

string

Fulfillment ID

order

object

Updated order data

Status/Error Codes

The response will include an HTTP status code.

Was this helpful?

Request

curl

Copy Code
1curl 'https://www.wixapis.com/stores/v2/orders/fedb19f5-bd4c-4bfc-b2d1-212538319611/fulfillments' \
2--data-binary '{
3                "fulfillment": {
4                  "lineItems": [
5                    {
6                      "index": 1,
7                      "quantity": 1
8                    }
9                  ],
10                  "trackingInfo": {
11                    "shippingProvider": "fedex",
12                    "trackingNumber": "1234",
13                    "trackingLink": "https://www.fedex.com/apps/fedextrack/?action=track&trackingnumber=1234"
14                  }
15                }
16              }' \
17-H 'Content-Type: application/json' \
18-H 'Authorization: <AUTH>'

Response

json

1
2{
3  "id": "0175f0e8-f877-40a9-b980-0d336c64c726",
4  "order":   {
5    "id": "fedb19f5-bd4c-4bfc-b2d1-212538319611",
6    "number": 10096,
7    "dateCreated": "2020-03-18T16:47:59.222Z",
8    "buyerInfo":     {
9      "id": "e9a69747-6816-42fb-87bf-4cd60a408b4e",
10      "type": "CONTACT",
11      "identityType": "CONTACT",
12      "firstName": "John",
13      "lastName": "Smith",
14      "phone": "+972 555234555",
15      "email": "Ivanushka@example.com"
16    },
17    "currency": "USD",
18    "weightUnit": "LB",
19    "totals":     {
20      "subtotal": "10",
21      "shipping": "3",
22      "tax": "3",
23      "discount": "1",
24      "total": "15",
25      "weight": "30",
26      "quantity": 2
27    },
28    "billingInfo":     {
29      "paymentMethod": "PayPal",
30      "externalTransactionId": "tx_1806",
31      "paymentProviderTransactionId": "tx_1806",
32      "address":       {
33        "fullName":         {
34          "firstName": "John",
35          "lastName": "Smith"
36        },
37        "country": "US",
38        "city": "New York",
39        "zipCode": "92544",
40        "phone": "+972 555234555",
41        "email": "Ivanushka@example.com"
42      },
43      "paidDate": "2020-03-18T16:47:59.244Z"
44    },
45    "shippingInfo":     {
46      "deliveryOption": "Express",
47      "estimatedDeliveryTime": "Today",
48      "shipmentDetails":       {
49        "address":         {
50          "fullName":           {
51            "firstName": "John",
52            "lastName": "Smith"
53          },
54          "country": "US",
55          "city": "New York",
56          "zipCode": "92544",
57          "phone": "+972 555234555",
58          "email": "Ivanushka@example.com"
59        },
60        "trackingInfo":         {
61          "trackingNumber": "1234",
62          "shippingProvider": "FEDEX",
63          "trackingLink": "https://www.fedex.com/apps/fedextrack/?action=track&trackingnumber=1234"
64        },
65        "discount": "0",
66        "tax": "1",
67        "priceData":         {
68          "taxIncludedInPrice": false,
69          "price": "3"
70        }
71      }
72    },
73    "read": false,
74    "archived": false,
75    "paymentStatus": "PAID",
76    "fulfillmentStatus": "PARTIALLY_FULFILLED",
77    "lineItems": [    {
78      "index": 1,
79      "quantity": 2,
80      "price": "5",
81      "name": "my product",
82      "productId": "a1f9d337-f831-4529-31e6-67db8fd4e1aa",
83      "totalPrice": "10",
84      "lineItemType": "PHYSICAL",
85      "options": [],
86      "customTextFields": [],
87      "weight": "15",
88      "sku": "12345678",
89      "discount": "1",
90      "tax": "1",
91      "taxIncludedInPrice": false,
92      "priceData":       {
93        "taxIncludedInPrice": false,
94        "price": "5",
95        "totalPrice": "10"
96      }
97    }],
98    "activities":     [
99            {
100        "type": "ORDER_PLACED",
101        "timestamp": "2020-03-18T16:47:59.222Z"
102      },
103            {
104        "type": "ORDER_PAID",
105        "timestamp": "2020-03-18T16:47:59.244Z"
106      },
107            {
108        "type": "TRACKING_NUMBER_ADDED",
109        "timestamp": "2020-03-18T16:55:59.178Z"
110      }
111    ],
112    "fulfillments": [    {
113      "id": "0175f0e8-f877-40a9-b980-0d336c64c726",
114      "dateCreated": "2020-03-18T16:55:59.178Z",
115      "lineItems": [      {
116        "index": 1,
117        "quantity": 1
118      }],
119      "trackingInfo":       {
120        "trackingNumber": "1234",
121        "shippingProvider": "fedex",
122        "trackingLink": "https://www.fedex.com/apps/fedextrack/?action=track&trackingnumber=1234"
123      }
124    }],
125    "discount": {"value": "1"},
126    "buyerLanguage": "en",
127    "channelInfo": {"type": "WEB"},
128    "enteredBy":     {
129      "id": "e85274cf-047a-4989-baff-dac5e0c3971d",
130      "identityType": "USER"
131    },
132    "lastUpdated": "2020-03-18T16:55:59.178Z"
133  }
134}

Update Fulfillment

Updates an existing fulfillment

Authorization

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

Permissions

The API requires Wix Stores > Modify Orders

PUT

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

Path Params

NAME
TYPE
DESCRIPTION
orderId
Required

string

Order ID

fulfillmentId
Required

string

Fulfillment ID

Body Params

NAME
TYPE
DESCRIPTION
UpdateFulfillmentRequest

object

Response Object

Update Fulfillment Response

NAME
TYPE
DESCRIPTION
order

object

Updated order data

Status/Error Codes

The response will include an HTTP status code.

Was this helpful?

Request

curl

Copy Code
1curl -X PUT 'https://www.wixapis.com/stores/v2/orders/fedb19f5-bd4c-4bfc-b2d1-212538319611/fulfillments/5945017a-bf19-414e-ae67-af3d2dbc66ff' \
2--data-binary '{
3                 "fulfillmentTrackingInfo": {
4                   "shippingProvider": "fedex",
5                   "trackingNumber": "123"
6                 }
7               }' \
8-H 'Content-Type: application/json' \
9-H 'Authorization: <AUTH>'

Response

json

1
2{"order": {
3  "id": "fedb19f5-bd4c-4bfc-b2d1-212538319611",
4  "number": 10096,
5  "dateCreated": "2020-03-18T16:47:59.222Z",
6  "buyerInfo":   {
7    "id": "e9a69747-6816-42fb-87bf-4cd60a408b4e",
8    "type": "CONTACT",
9    "identityType": "CONTACT",
10    "firstName": "John",
11    "lastName": "Smith",
12    "phone": "+972 555234555",
13    "email": "Ivanushka@example.com"
14  },
15  "currency": "USD",
16  "weightUnit": "LB",
17  "totals":   {
18    "subtotal": "10",
19    "shipping": "3",
20    "tax": "3",
21    "discount": "1",
22    "total": "15",
23    "weight": "30",
24    "quantity": 2
25  },
26  "billingInfo":   {
27    "paymentMethod": "PayPal",
28    "externalTransactionId": "tx_1806",
29    "paymentProviderTransactionId": "tx_1806",
30    "address":     {
31      "fullName":       {
32        "firstName": "John",
33        "lastName": "Smith"
34      },
35      "country": "US",
36      "city": "New York",
37      "zipCode": "92544",
38      "phone": "+972 555234555",
39      "email": "Ivanushka@example.com"
40    },
41    "paidDate": "2020-03-18T16:47:59.244Z"
42  },
43  "shippingInfo":   {
44    "deliveryOption": "Express",
45    "estimatedDeliveryTime": "Today",
46    "shipmentDetails":     {
47      "address":       {
48        "fullName":         {
49          "firstName": "John",
50          "lastName": "Smith"
51        },
52        "country": "US",
53        "city": "New York",
54        "zipCode": "92544",
55        "phone": "+972 555234555",
56        "email": "Ivanushka@example.com"
57      },
58      "trackingInfo":       {
59        "trackingNumber": "123",
60        "shippingProvider": "FEDEX",
61        "trackingLink": "https://www.fedex.com/apps/fedextrack/?action=track&trackingnumber=123"
62      },
63      "discount": "0",
64      "tax": "1",
65      "priceData":       {
66        "taxIncludedInPrice": false,
67        "price": "3"
68      }
69    }
70  },
71  "read": false,
72  "archived": false,
73  "paymentStatus": "PAID",
74  "fulfillmentStatus": "PARTIALLY_FULFILLED",
75  "lineItems": [  {
76    "index": 1,
77    "quantity": 2,
78    "price": "5",
79    "name": "my product",
80    "productId": "a1f9d337-f831-4529-31e6-67db8fd4e1aa",
81    "totalPrice": "10",
82    "lineItemType": "PHYSICAL",
83    "options": [],
84    "customTextFields": [],
85    "weight": "15",
86    "sku": "12345678",
87    "discount": "1",
88    "tax": "1",
89    "taxIncludedInPrice": false,
90    "priceData":     {
91      "taxIncludedInPrice": false,
92      "price": "5",
93      "totalPrice": "10"
94    }
95  }],
96  "activities":   [
97        {
98      "type": "ORDER_PLACED",
99      "timestamp": "2020-03-18T16:47:59.222Z"
100    },
101        {
102      "type": "ORDER_PAID",
103      "timestamp": "2020-03-18T16:47:59.244Z"
104    },
105        {
106      "type": "TRACKING_NUMBER_ADDED",
107      "timestamp": "2020-03-18T16:55:59.178Z"
108    },
109        {
110      "type": "TRACKING_NUMBER_ADDED",
111      "timestamp": "2020-03-18T17:04:01.397Z"
112    },
113        {
114      "type": "TRACKING_NUMBER_EDITED",
115      "timestamp": "2020-03-18T17:05:55.724Z"
116    }
117  ],
118  "fulfillments": [  {
119    "id": "5945017a-bf19-414e-ae67-af3d2dbc66ff",
120    "dateCreated": "2020-03-18T17:04:01.397Z",
121    "lineItems": [    {
122      "index": 1,
123      "quantity": 1
124    }],
125    "trackingInfo":     {
126      "trackingNumber": "123",
127      "shippingProvider": "fedex",
128      "trackingLink": "https://www.fedex.com/apps/fedextrack/?action=track&trackingnumber=123"
129    }
130  }],
131  "discount": {"value": "1"},
132  "buyerLanguage": "en",
133  "channelInfo": {"type": "WEB"},
134  "enteredBy":   {
135    "id": "e85274cf-047a-4989-baff-dac5e0c3971d",
136    "identityType": "USER"
137  },
138  "lastUpdated": "2020-03-18T17:05:55.724Z"
139}}

Delete Fulfillment

Deletes an existing fulfillment

Authorization

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

Permissions

The API requires Wix Stores > Modify Orders

DELETE

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

Path Params

NAME
TYPE
DESCRIPTION
orderId
Required

string

Order ID

fulfillmentId
Required

string

Fulfillment ID

Response Object

Delete Fulfillment Response

NAME
TYPE
DESCRIPTION
order

object

Updated order data

Status/Error Codes

The response will include an HTTP status code.

Was this helpful?

Request

curl

Copy Code
1curl -X DELETE 'https://www.wixapis.com/stores/v2/orders/fedb19f5-bd4c-4bfc-b2d1-212538319611/fulfillments/0175f0e8-f877-40a9-b980-0d336c64c726' \
2-H 'Content-Type: application/json' \
3-H 'Authorization: <AUTH>'

Response

json

1
2{"order": {
3  "id": "fedb19f5-bd4c-4bfc-b2d1-212538319611",
4  "number": 10096,
5  "dateCreated": "2020-03-18T16:47:59.222Z",
6  "buyerInfo":   {
7    "id": "e9a69747-6816-42fb-87bf-4cd60a408b4e",
8    "type": "CONTACT",
9    "identityType": "CONTACT",
10    "firstName": "John",
11    "lastName": "Smith",
12    "phone": "+972 555234555",
13    "email": "Ivanushka@example.com"
14  },
15  "currency": "USD",
16  "weightUnit": "LB",
17  "totals":   {
18    "subtotal": "10",
19    "shipping": "3",
20    "tax": "3",
21    "discount": "1",
22    "total": "15",
23    "weight": "30",
24    "quantity": 2
25  },
26  "billingInfo":   {
27    "paymentMethod": "PayPal",
28    "externalTransactionId": "tx_1806",
29    "paymentProviderTransactionId": "tx_1806",
30    "address":     {
31      "fullName":       {
32        "firstName": "John",
33        "lastName": "Smith"
34      },
35      "country": "US",
36      "city": "New York",
37      "zipCode": "92544",
38      "phone": "+972 555234555",
39      "email": "Ivanushka@example.com"
40    },
41    "paidDate": "2020-03-18T16:47:59.244Z"
42  },
43  "shippingInfo":   {
44    "deliveryOption": "Express",
45    "estimatedDeliveryTime": "Today",
46    "shipmentDetails":     {
47      "address":       {
48        "fullName":         {
49          "firstName": "John",
50          "lastName": "Smith"
51        },
52        "country": "US",
53        "city": "New York",
54        "zipCode": "92544",
55        "phone": "+972 555234555",
56        "email": "Ivanushka@example.com"
57      },
58      "discount": "0",
59      "tax": "1",
60      "priceData":       {
61        "taxIncludedInPrice": false,
62        "price": "3"
63      }
64    }
65  },
66  "read": false,
67  "archived": false,
68  "paymentStatus": "PAID",
69  "fulfillmentStatus": "NOT_FULFILLED",
70  "lineItems": [  {
71    "index": 1,
72    "quantity": 2,
73    "price": "5",
74    "name": "my product",
75    "productId": "a1f9d337-f831-4529-31e6-67db8fd4e1aa",
76    "totalPrice": "10",
77    "lineItemType": "PHYSICAL",
78    "options": [],
79    "customTextFields": [],
80    "weight": "15",
81    "sku": "12345678",
82    "discount": "1",
83    "tax": "1",
84    "taxIncludedInPrice": false,
85    "priceData":     {
86      "taxIncludedInPrice": false,
87      "price": "5",
88      "totalPrice": "10"
89    }
90  }],
91  "activities":   [
92        {
93      "type": "ORDER_PLACED",
94      "timestamp": "2020-03-18T16:47:59.222Z"
95    },
96        {
97      "type": "ORDER_PAID",
98      "timestamp": "2020-03-18T16:47:59.244Z"
99    },
100        {
101      "type": "TRACKING_NUMBER_ADDED",
102      "timestamp": "2020-03-18T16:55:59.178Z"
103    }
104  ],
105  "fulfillments": [],
106  "discount": {"value": "1"},
107  "buyerLanguage": "en",
108  "channelInfo": {"type": "WEB"},
109  "enteredBy":   {
110    "id": "e85274cf-047a-4989-baff-dac5e0c3971d",
111    "identityType": "USER"
112  },
113  "lastUpdated": "2020-03-18T16:59:49.740Z"
114}}

Fulfillment Created

Authorization

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

Permissions

The API requires Wix Stores > Read Orders

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
orderId

string

Order ID (auto generated upon order creation)

trackingInfo

object

Fulfillment tracking information

dateCreated

string

Fulfillment creation date

fulfillmentId

string

Fulfillment ID

buyerInfo

object

Customer information

fulfillmentStatus

string

One of NOT_FULFILLED, FULFILLED, CANCELED, PARTIALLY_FULFILLED.

Order fulfillment status

Was this helpful?

Example of FulfillmentCreated

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

Event Body

json

1{
2  "data": {
3    "eventType": "<event-type>",
4    "instanceId": "<app-instance-id>",
5    "data": "<stringified-JSON>"
6  }
7}

The parsed data will include:

Sample Data

json

1
2{
3  "orderId": "8234d6e7-d92f-4c0d-b973-8fadec29fa47",
4  "fulfillmentId": "ca4abdc6-ac46-430a-8db9-9c866fa11a50",
5  "dateCreated": "2019-12-10T15:03:30.800Z",
6  "buyerInfo":   {
7    "id": "aa3159c6-5d5c-4b1c-bcf1-6b0d9e5a3897",
8    "type": "CONTACT",
9    "identityType": "CONTACT",
10    "firstName": "John",
11    "lastName": "Israeli",
12    "phone": "0123456789",
13    "email": "John.Israeli123@hotmail.com"
14  },
15  "fulfillmentStatus": "FULFILLED",
16  "trackingInfo":   {
17    "trackingNumber": "1234-5678-9101-1121-3141-51",
18    "shippingProvider": "usps",
19    "trackingLink": "https://tools.usps.com/go/TrackConfirmAction.action?tLabels=1234-5678-9101-1121-3141-51"
20  }
21}

Fulfillment Deleted

Authorization

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

Permissions

The API requires Wix Stores > Read Orders

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
orderId

string

Order ID (auto generated upon order creation)

fulfillmentId

string

Fulfillment ID

fulfillmentStatus

string

One of NOT_FULFILLED, FULFILLED, CANCELED, PARTIALLY_FULFILLED.

Order fulfillment status

Was this helpful?

Example of FulfillmentDeleted

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

Event Body

json

1{
2  "data": {
3    "eventType": "<event-type>",
4    "instanceId": "<app-instance-id>",
5    "data": "<stringified-JSON>"
6  }
7}

The parsed data will include:

Sample Data

json

1
2{
3  "orderId": "8234d6e7-d92f-4c0d-b973-8fadec29fa47",
4  "fulfillmentId": "ca4abdc6-ac46-430a-8db9-9c866fa11a50",
5  "fulfillmentStatus": "NOT_FULFILLED"
6}

Fulfillment Updated

Authorization

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

Permissions

The API requires Wix Stores > Read Orders

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
orderId

string

Order ID (auto generated upon order creation)

fulfillmentId

string

Fulfillment ID

trackingInfo

object

Fulfillment tracking information

Was this helpful?

Example of FulfillmentUpdated

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

Event Body

json

1{
2  "data": {
3    "eventType": "<event-type>",
4    "instanceId": "<app-instance-id>",
5    "data": "<stringified-JSON>"
6  }
7}

The parsed data will include:

Sample Data

json

1
2{
3  "orderId": "8234d6e7-d92f-4c0d-b973-8fadec29fa47",
4  "fulfillmentId": "ca4abdc6-ac46-430a-8db9-9c866fa11a50",
5  "trackingInfo":   {
6    "trackingNumber": "1234-5678-9101-1121-3141-51",
7    "shippingProvider": "usps",
8    "trackingLink": "https://tools.usps.com/go/TrackConfirmAction.action?tLabels=1234-5678-9101-1121-3141-51"
9  }
10}

Order Created

Authorization

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

Permissions

The API requires Wix Stores > Read Orders

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

Order fulfillment status

Was this helpful?

Example of Order Created

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

Event Body

json

1{
2  "data": {
3    "eventType": "<event-type>",
4    "instanceId": "<app-instance-id>",
5    "data": "<stringified-JSON>"
6  }
7}

The parsed data will include:

Sample Data

json

1
2{
3  "orderId": "afc47c2d-4fbf-450d-9f20-478e54b46b89",
4  "number": "10001",
5  "dateCreated": "2019-08-28T08:30:42.074Z",
6  "buyerInfo":   {
7    "id": "d52512dc-131f-4062-abf3-a653552bbbd2",
8    "type": "CONTACT",
9    "identityType": "CONTACT",
10    "firstName": "Eric",
11    "lastName": "Ben",
12    "phone": "055223399",
13    "email": "test123@wix.com"
14  },
15  "currency": "USD",
16  "weightUnit": "KG",
17  "totals":   {
18    "subtotal": "1",
19    "shipping": "2",
20    "tax": "3",
21    "discount": "0",
22    "total": "5",
23    "weight": "0",
24    "quantity": 2
25  },
26  "read": true,
27  "paymentStatus": "PAID",
28  "fulfillmentStatus": "FULFILLED"
29}
)}