List Orders

GET

List all orders created for a given site.

Path parameters

site_idstringRequired

Unique identifier for a Site

Headers

Accept-VersionstringOptional

The API version

Query parameters

statusenumOptional

Filter the orders by status

offsetdoubleOptional

Offset used for pagination if the results have more than limit records

limitdoubleOptional

Maximum number of records to be returned (max limit: 100)

Response

Request was successful

list of objects or null

Errors

GET

1 curl https://api.webflow.com/sites/580e63e98c9a982ac9b8b741/orders \
2      -H "Accept-Version: 1.0.0" \
3      -H "Authorization: Bearer <token>"

200Retrieved

1 [
2   {
3     "orderId": "dfa-3f1",
4     "status": "unfulfilled",
5     "comment": "",
6     "orderComment": "",
7     "acceptedOn": "2018-12-03T22:06:15Z",
8     "customerPaid": {
9       "unit": "USD",
10       "value": "6099",
11       "string": "60.99"
12     },
13     "netAmount": {
14       "unit": "USD",
15       "value": "6099",
16       "string": "58.92"
17     },
18     "requiresShipping": true,
19     "customerInfo": {
20       "fullName": "Customerio Namen",
21       "email": "renning+customer@webflow.com"
22     },
23     "allAddresses": [
24       {
25         "type": "billing",
26         "addressee": "Customerio Namen",
27         "line1": "123 Example Rd",
28         "line2": "",
29         "city": "Examplesville",
30         "state": "CA",
31         "country": "US",
32         "postalCode": "90012"
33       },
34       {
35         "type": "shipping",
36         "addressee": "Customerio Namen",
37         "line1": "123 Example Rd",
38         "line2": "",
39         "city": "Examplesville",
40         "state": "CA",
41         "country": "US",
42         "postalCode": "90012"
43       }
44     ],
45     "shippingAddress": {
46       "type": "shipping",
47       "addressee": "Customerio Namen",
48       "line1": "123 Example Rd",
49       "line2": "",
50       "city": "Examplesville",
51       "state": "CA",
52       "country": "US",
53       "postalCode": "90012"
54     },
55     "billingAddress": {
56       "type": "billing",
57       "addressee": "Customerio Namen",
58       "line1": "123 Example Rd",
59       "line2": "",
60       "city": "Examplesville",
61       "state": "CA",
62       "country": "US",
63       "postalCode": "90012"
64     },
65     "purchasedItems": [
66       {
67         "count": 1,
68         "rowTotal": {
69           "unit": "USD",
70           "value": "6099",
71           "string": "55.00"
72         },
73         "productId": "5eb9fd05caef491eb9757183",
74         "productName": "White Cup",
75         "productSlug": "white-cup",
76         "variantId": "5eb9fcace279761d8199790c",
77         "variantName": "white-cup_default_sku",
78         "variantSlug": "white-cup-default-sku",
79         "variantImage": {
80           "fileId": "5bfedb42bab0ad90fa7dad2e",
81           "url": "https://d1otoma47x30pg.cloudfront.net/5bfedb42bab0ad90fa7dac03/5bfedb42bab0ad90fa7dad2e_5bb3d019b3465c6e8a324dd7_458036-unsplas.png"
82         },
83         "variantPrice": {
84           "unit": "USD",
85           "value": "6099",
86           "string": "55.00"
87         },
88         "height": 7,
89         "length": 2,
90         "width": 4,
91         "weight": 5,
92         "purchasedItemsCount": 1
93       }
94     ],
95     "stripeDetails": {
96       "chargeId": "ch_1DdPYQKMjGA7k9mI2AKiBY6u",
97       "customerId": "cus_E5ajeiWNHEtcAW"
98     },
99     "stripeCard": {
100       "last4": "4242",
101       "brand": "Visa",
102       "ownerName": "Customerio Namen",
103       "expires": {
104         "year": 2023,
105         "month": 12
106       }
107     },
108     "totals": {
109       "subtotal": {
110         "unit": "USD",
111         "value": "6099",
112         "string": "55.00"
113       },
114       "extras": [
115         {
116           "type": "tax",
117           "name": "State Taxes",
118           "description": "CA Taxes (6.25%)",
119           "price": {
120             "unit": "USD",
121             "value": "6099",
122             "string": "3.44"
123           }
124         },
125         {
126           "type": "tax",
127           "name": "County Taxes",
128           "description": "LOS ANGELES Taxes (1.00%)",
129           "price": {
130             "unit": "USD",
131             "value": "6099",
132             "string": "0.55"
133           }
134         },
135         {
136           "type": "tax",
137           "name": "Special District Taxes",
138           "description": "Special District Taxes (2.25%)",
139           "price": {
140             "unit": "USD",
141             "value": "6099",
142             "string": "1.24"
143           }
144         },
145         {
146           "type": "shipping",
147           "name": "Flat Rate",
148           "description": "",
149           "price": {
150             "unit": "USD",
151             "value": "6099",
152             "string": "5.99"
153           }
154         },
155         {
156           "type": "discount-shipping",
157           "name": "Free Shipping (SHIP4FREE)",
158           "description": "",
159           "price": {
160             "unit": "USD",
161             "value": "6099",
162             "string": "-$ 5.99 USD"
163           }
164         }
165       ],
166       "total": {
167         "unit": "USD",
168         "value": "6099",
169         "string": "60.23"
170       }
171     },
172     "customData": [
173       {
174         "textInput": "(415) 123-4567",
175         "name": "Telephone"
176       },
177       {
178         "textArea": "Happy birthday Mom!",
179         "name": "Gift note"
180       },
181       {
182         "checkbox": true,
183         "name": "Send as gift"
184       }
185     ],
186     "downloadFiles": [
187       {
188         "id": "5e9a5eba75e0ac242e1b6f64",
189         "name": "The modern web design process - Webflow Ebook.pdf",
190         "url": "https://webflow.com/dashboard/download-digital-product?payload=5d93ba5e38c6b0160ab711d3;e7634a;5eb1aac72912ec06f561278c;5e9a5eba75e0ac242e1b6f63:ka2nehxy:4a1ee0a632feaab94294350087215ed89533f2f530903e3b933b638940e921aa"
191       },
192       {
193         "id": "5e9a5eba75e0ac242e1b6f63",
194         "name": "The freelance web designers guide - Webflow Ebook.pdf",
195         "url": "https://webflow.com/dashboard/download-digital-product?payload=5d93ba5e38c6b0160ab711d3;e7634a;5dd44c493543b37d5449b3cd;5e9a5eba75e0ac242e1b6f63:ka2nehxy:6af5adf7c6fff7a3b0f54404fac1be492ac6f1ed5340416f1fe27c5fd4dd8079"
196       }
197     ]
198   }
199 ]

Get Order

Up Next

Built with

1	curl https://api.webflow.com/sites/580e63e98c9a982ac9b8b741/orders \
2	-H "Accept-Version: 1.0.0" \
3	-H "Authorization: Bearer <token>"

1	[
2	{
3	"orderId": "dfa-3f1",
4	"status": "unfulfilled",
5	"comment": "",
6	"orderComment": "",
7	"acceptedOn": "2018-12-03T22:06:15Z",
8	"customerPaid": {
9	"unit": "USD",
10	"value": "6099",
11	"string": "60.99"
12	},
13	"netAmount": {
14	"unit": "USD",
15	"value": "6099",
16	"string": "58.92"
17	},
18	"requiresShipping": true,
19	"customerInfo": {
20	"fullName": "Customerio Namen",
21	"email": "renning+customer@webflow.com"
22	},
23	"allAddresses": [
24	{
25	"type": "billing",
26	"addressee": "Customerio Namen",
27	"line1": "123 Example Rd",
28	"line2": "",
29	"city": "Examplesville",
30	"state": "CA",
31	"country": "US",
32	"postalCode": "90012"
33	},
34	{
35	"type": "shipping",
36	"addressee": "Customerio Namen",
37	"line1": "123 Example Rd",
38	"line2": "",
39	"city": "Examplesville",
40	"state": "CA",
41	"country": "US",
42	"postalCode": "90012"
43	}
44	],
45	"shippingAddress": {
46	"type": "shipping",
47	"addressee": "Customerio Namen",
48	"line1": "123 Example Rd",
49	"line2": "",
50	"city": "Examplesville",
51	"state": "CA",
52	"country": "US",
53	"postalCode": "90012"
54	},
55	"billingAddress": {
56	"type": "billing",
57	"addressee": "Customerio Namen",
58	"line1": "123 Example Rd",
59	"line2": "",
60	"city": "Examplesville",
61	"state": "CA",
62	"country": "US",
63	"postalCode": "90012"
64	},
65	"purchasedItems": [
66	{
67	"count": 1,
68	"rowTotal": {
69	"unit": "USD",
70	"value": "6099",
71	"string": "55.00"
72	},
73	"productId": "5eb9fd05caef491eb9757183",
74	"productName": "White Cup",
75	"productSlug": "white-cup",
76	"variantId": "5eb9fcace279761d8199790c",
77	"variantName": "white-cup_default_sku",
78	"variantSlug": "white-cup-default-sku",
79	"variantImage": {
80	"fileId": "5bfedb42bab0ad90fa7dad2e",
81	"url": "https://d1otoma47x30pg.cloudfront.net/5bfedb42bab0ad90fa7dac03/5bfedb42bab0ad90fa7dad2e_5bb3d019b3465c6e8a324dd7_458036-unsplas.png"
82	},
83	"variantPrice": {
84	"unit": "USD",
85	"value": "6099",
86	"string": "55.00"
87	},
88	"height": 7,
89	"length": 2,
90	"width": 4,
91	"weight": 5,
92	"purchasedItemsCount": 1
93	}
94	],
95	"stripeDetails": {
96	"chargeId": "ch_1DdPYQKMjGA7k9mI2AKiBY6u",
97	"customerId": "cus_E5ajeiWNHEtcAW"
98	},
99	"stripeCard": {
100	"last4": "4242",
101	"brand": "Visa",
102	"ownerName": "Customerio Namen",
103	"expires": {
104	"year": 2023,
105	"month": 12
106	}
107	},
108	"totals": {
109	"subtotal": {
110	"unit": "USD",
111	"value": "6099",
112	"string": "55.00"
113	},
114	"extras": [
115	{
116	"type": "tax",
117	"name": "State Taxes",
118	"description": "CA Taxes (6.25%)",
119	"price": {
120	"unit": "USD",
121	"value": "6099",
122	"string": "3.44"
123	}
124	},
125	{
126	"type": "tax",
127	"name": "County Taxes",
128	"description": "LOS ANGELES Taxes (1.00%)",
129	"price": {
130	"unit": "USD",
131	"value": "6099",
132	"string": "0.55"
133	}
134	},
135	{
136	"type": "tax",
137	"name": "Special District Taxes",
138	"description": "Special District Taxes (2.25%)",
139	"price": {
140	"unit": "USD",
141	"value": "6099",
142	"string": "1.24"
143	}
144	},
145	{
146	"type": "shipping",
147	"name": "Flat Rate",
148	"description": "",
149	"price": {
150	"unit": "USD",
151	"value": "6099",
152	"string": "5.99"
153	}
154	},
155	{
156	"type": "discount-shipping",
157	"name": "Free Shipping (SHIP4FREE)",
158	"description": "",
159	"price": {
160	"unit": "USD",
161	"value": "6099",
162	"string": "-$ 5.99 USD"
163	}
164	}
165	],
166	"total": {
167	"unit": "USD",
168	"value": "6099",
169	"string": "60.23"
170	}
171	},
172	"customData": [
173	{
174	"textInput": "(415) 123-4567",
175	"name": "Telephone"
176	},
177	{
178	"textArea": "Happy birthday Mom!",
179	"name": "Gift note"
180	},
181	{
182	"checkbox": true,
183	"name": "Send as gift"
184	}
185	],
186	"downloadFiles": [
187	{
188	"id": "5e9a5eba75e0ac242e1b6f64",
189	"name": "The modern web design process - Webflow Ebook.pdf",
190	"url": "https://webflow.com/dashboard/download-digital-product?payload=5d93ba5e38c6b0160ab711d3;e7634a;5eb1aac72912ec06f561278c;5e9a5eba75e0ac242e1b6f63:ka2nehxy:4a1ee0a632feaab94294350087215ed89533f2f530903e3b933b638940e921aa"
191	},
192	{
193	"id": "5e9a5eba75e0ac242e1b6f63",
194	"name": "The freelance web designers guide - Webflow Ebook.pdf",
195	"url": "https://webflow.com/dashboard/download-digital-product?payload=5d93ba5e38c6b0160ab711d3;e7634a;5dd44c493543b37d5449b3cd;5e9a5eba75e0ac242e1b6f63:ka2nehxy:6af5adf7c6fff7a3b0f54404fac1be492ac6f1ed5340416f1fe27c5fd4dd8079"
196	}
197	]
198	}
199	]