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

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

Authorization

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

Permissions

This endpoint requires the Manage Orders or the Read Orders permission scope.

POST

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

Body Params

NAME
TYPE
DESCRIPTION
query

object

Query

Response Object

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}