Fetch Order

GET

/v1/orders/:order_id

GET

/v1/orders/:order_id

1 from yoco_demo import Yoco
2 
3 client = Yoco()
4 client.orders.fetch(
5     order_id="order_id",
6 )

Try it

1 {
2   "amounts": {
3     "discount_amount": {
4       "amount": 2780,
5       "currency": "ZAR"
6     },
7     "gross_amount": {
8       "amount": 16680,
9       "currency": "ZAR"
10     },
11     "net_amount": {
12       "amount": 13900,
13       "currency": "ZAR"
14     },
15     "tax_amount": {
16       "amount": 32263,
17       "currency": "ZAR"
18     },
19     "tip_amount": {
20       "amount": 0,
21       "currency": "ZAR"
22     }
23   },
24   "closed_at": "2024-11-19T16:27:23+00:00",
25   "created_at": "2024-11-19T15:27:02+00:00",
26   "currency": "ZAR",
27   "display_name": "Order #10542623",
28   "id": "1585232943682-9f7e2dbe-a09e-4fa8-aa4a-72290c513f1d",
29   "name": "Table 42",
30   "note": "This is a very important table.",
31   "order_number": "10542623",
32   "status": "completed",
33   "updated_at": "2024-11-19T16:27:23+00:00",
34   "applied_discounts": [
35     {
36       "discount_amount": {
37         "amount": 3000,
38         "currency": "ZAR"
39       },
40       "name": "Item Discount",
41       "percentage": "10.00",
42       "scope": "order",
43       "type": "fixed_percentage"
44     }
45   ],
46   "line_items": [
47     {
48       "applied_discounts": [
49         {
50           "discount_amount": {
51             "amount": 3000,
52             "currency": "ZAR"
53           },
54           "name": "Item Discount",
55           "percentage": "10.00",
56           "scope": "order",
57           "type": "fixed_percentage"
58         }
59       ],
60       "applied_taxes": [
61         {
62           "name": "VAT",
63           "percentage": "15.00",
64           "scope": "line_item",
65           "tax_amount": {
66             "amount": 3000,
67             "currency": "ZAR"
68           },
69           "type": "inclusive"
70         }
71       ],
72       "discount_amount": {
73         "amount": 2780,
74         "currency": "ZAR"
75       },
76       "id": "1585232943683-bc402745-df17-486e-b583-3dfedcbc8b53",
77       "item_type": "product",
78       "name": "Men's Funky Blue T-Shirt - Medium",
79       "net_amount": {
80         "amount": 25020,
81         "currency": "ZAR"
82       },
83       "note": "This is an optional note related to this item in the order.",
84       "quantity": "1.00",
85       "quantity_unit": "string",
86       "total_price": {
87         "amount": 13900,
88         "currency": "ZAR"
89       },
90       "unit_price": {
91         "amount": 13900,
92         "currency": "ZAR"
93       },
94       "variant_id": "1600421176247-798d940c-fce6-44b2-9872-8bb28005ec2a:1718365491897-f6a94fdc-46e4-477f-9b53-be85e35fc7a6"
95     }
96   ],
97   "payments": [
98     {
99       "amount_excl_tip": {
100         "amount": 25000,
101         "currency": "ZAR"
102       },
103       "created_at": "2024-11-19T15:27:02+00:00",
104       "currency": "ZAR",
105       "display_name": "Payment receipt #491352",
106       "id": "1732194482873-c777dc85-035e-40de-9820-765fde5ded7b",
107       "note": "This is a note on this payment.",
108       "order_id": "1585232943682-9f7e2dbe-a09e-4fa8-aa4a-72290c513f1d",
109       "payment_method": "card",
110       "payment_source": "payment_link",
111       "processing_fees": [
112         {
113           "amount": {
114             "amount": 1,
115             "currency": "string"
116           },
117           "type": "initial"
118         }
119       ],
120       "receipt_number": "491352",
121       "refunded_amount": {
122         "amount": 0,
123         "currency": "ZAR"
124       },
125       "refunds": [
126         {
127           "created_at": "2024-11-19T15:27:02+00:00",
128           "currency": "ZAR",
129           "display_name": "Refund receipt #491352",
130           "id": "1732188199292-2a8752ab-db45-4507-9d85-fcc6049beef3",
131           "note": "This is a note on this refund.",
132           "order_id": "1585232943682-9f7e2dbe-a09e-4fa8-aa4a-72290c513f1d",
133           "order_number": "10542623",
134           "payment_id": "1732194482873-c777dc85-035e-40de-9820-765fde5ded7b",
135           "payment_method": "card",
136           "processed_at": "2024-11-20T16:27:23+00:00",
137           "processing_fees": [
138             {
139               "amount": {
140                 "amount": 27800,
141                 "currency": "ZAR"
142               },
143               "type": "initial"
144             }
145           ],
146           "receipt_number": "491352",
147           "refund_type": "auth_reversal",
148           "refunded_processing_fees": [
149             {
150               "amount": {
151                 "amount": 27800,
152                 "currency": "ZAR"
153               },
154               "type": "initial"
155             }
156           ],
157           "status": "approved",
158           "total_amount": {
159             "amount": 4500,
160             "currency": "ZAR"
161           },
162           "updated_at": "2024-11-19T16:27:23+00:00"
163         }
164       ],
165       "status": "approved",
166       "tip_amount": {
167         "amount": 2500,
168         "currency": "ZAR"
169       },
170       "total_amount": {
171         "amount": 27500,
172         "currency": "ZAR"
173       },
174       "updated_at": "2024-11-19T16:27:23+00:00"
175     }
176   ],
177   "refunds": [
178     {
179       "created_at": "2024-11-19T15:27:02+00:00",
180       "currency": "ZAR",
181       "display_name": "Refund receipt #491352",
182       "id": "1732188199292-2a8752ab-db45-4507-9d85-fcc6049beef3",
183       "note": "This is a note on this refund.",
184       "order_id": "1585232943682-9f7e2dbe-a09e-4fa8-aa4a-72290c513f1d",
185       "order_number": "10542623",
186       "payment_id": "1732194482873-c777dc85-035e-40de-9820-765fde5ded7b",
187       "payment_method": "card",
188       "processed_at": "2024-11-20T16:27:23+00:00",
189       "processing_fees": [
190         {
191           "amount": {
192             "amount": 27800,
193             "currency": "ZAR"
194           },
195           "type": "initial"
196         }
197       ],
198       "receipt_number": "491352",
199       "refund_type": "auth_reversal",
200       "refunded_processing_fees": [
201         {
202           "amount": {
203             "amount": 27800,
204             "currency": "ZAR"
205           },
206           "type": "initial"
207         }
208       ],
209       "status": "approved",
210       "total_amount": {
211         "amount": 4500,
212         "currency": "ZAR"
213       },
214       "updated_at": "2024-11-19T16:27:23+00:00"
215     }
216   ],
217   "returns": [
218     {
219       "amounts": {
220         "discount_amount": {
221           "amount": 2780,
222           "currency": "ZAR"
223         },
224         "gross_amount": {
225           "amount": 16680,
226           "currency": "ZAR"
227         },
228         "net_amount": {
229           "amount": 13900,
230           "currency": "ZAR"
231         },
232         "tax_amount": {
233           "amount": 32263,
234           "currency": "ZAR"
235         },
236         "tip_amount": {
237           "amount": 0,
238           "currency": "ZAR"
239         }
240       },
241       "returned_applied_discounts": [
242         {
243           "discount_amount": {
244             "amount": 3000,
245             "currency": "ZAR"
246           },
247           "name": "Item Discount",
248           "percentage": "10.00",
249           "scope": "order",
250           "type": "fixed_percentage"
251         }
252       ],
253       "returned_line_items": [
254         {
255           "applied_discounts": [
256             {
257               "discount_amount": {
258                 "amount": 3000,
259                 "currency": "ZAR"
260               },
261               "name": "Item Discount",
262               "percentage": "10.00",
263               "scope": "order",
264               "type": "fixed_percentage"
265             }
266           ],
267           "applied_taxes": [
268             {
269               "name": "VAT",
270               "percentage": "15.00",
271               "scope": "line_item",
272               "tax_amount": {
273                 "amount": 3000,
274                 "currency": "ZAR"
275               },
276               "type": "inclusive"
277             }
278           ],
279           "discount_amount": {
280             "amount": 2780,
281             "currency": "ZAR"
282           },
283           "id": "1585232943683-bc402745-df17-486e-b583-3dfedcbc8b53",
284           "item_type": "product",
285           "name": "Men's Funky Blue T-Shirt - Medium",
286           "net_amount": {
287             "amount": 25020,
288             "currency": "ZAR"
289           },
290           "note": "This is an optional note related to this item in the order.",
291           "quantity": "1.00",
292           "quantity_unit": "string",
293           "total_price": {
294             "amount": 13900,
295             "currency": "ZAR"
296           },
297           "unit_price": {
298             "amount": 13900,
299             "currency": "ZAR"
300           },
301           "variant_id": "1600421176247-798d940c-fce6-44b2-9872-8bb28005ec2a:1718365491897-f6a94fdc-46e4-477f-9b53-be85e35fc7a6"
302         }
303       ],
304       "returned_total_taxes": [
305         {
306           "name": "VAT",
307           "percentage": "15.00",
308           "scope": "line_item",
309           "tax_amount": {
310             "amount": 3000,
311             "currency": "ZAR"
312           },
313           "type": "inclusive"
314         }
315       ],
316       "source_order_id": "1585232943682-9f7e2dbe-a09e-4fa8-aa4a-72290c513f1d"
317     }
318   ],
319   "total_taxes": [
320     {
321       "name": "VAT",
322       "percentage": "15.00",
323       "scope": "line_item",
324       "tax_amount": {
325         "amount": 3000,
326         "currency": "ZAR"
327       },
328       "type": "inclusive"
329     }
330   ]
331 }

Fetch an order

Required OAuth 2.0 scope: business/orders:read

Path parameters

order_idstringRequired>=1 character<=100 characters

The unique identifier of the order.

Response

Successful Response

amountsobject

A collection of summarized amounts on the order.

closed_atstring or nullformat: "date-time"

The date and time the order was closed in ISO 8601 format.

created_atstringformat: "date-time"

The order creation date and time in ISO 8601 format.

currencystring

The currency code in ISO 4217 format.

display_namestring

A human-friendly label for the order.

idstring

The unique identifier of the order.

namestring or null

A human-friendly identifier (customer name, table number, order number, etc) representing the order.

notestring or null

An optional note attached to the order.

order_numberstring or null

A human-friendly identifier for the order.

statusenum

The current state of the order.

Allowed values:

updated_atstring or nullformat: "date-time"

The date and time the order was last modified in ISO 8601 format.

applied_discountslist of objects or null

The discounts applicable to the order.

line_itemslist of objects or null

A list of line items making up the order.

paymentslist of objects or null

The payments that have been receipted against the order.

refundslist of objects or null

The refunds that have been issued against the order.

returnslist of objects or null

A list of returns associated with this order.

total_taxeslist of objects or null

A list of taxes across all line items aggregated by tax type.

Fetch Order

Path parameters

Headers

Response

Errors