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

Get Order

Returns an order with the provided ID

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.

GET

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

Path Params

NAME
TYPE
DESCRIPTION
id
Required

string

Requested order ID

Response Object

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