Management API
Order
Retrieve Order
1min
mmRetrieve a single order, if requesting manager has access permissions to it.
URL: /api/v1/orders/{id}/
Method: GET
Code: 200 OK
Content Examples:
JSON
1{
2 "id": 1593781720493279,
3 "order_items": [
4 {
5 "id": 1593781720493299,
6 "product_id": 1584723961091234,
7 "licenses": [
8 {
9 "id": 1593781720493289,
10 "customer": {
11 "id": 620,
12 "total_orders": 14,
13 "total_licenses": 45,
14 "labels": [
15 {
16 "id": 3,
17 "label_id": 8,
18 "label": "Customer",
19 "color": "#ff9f43"
20 },
21 {
22 "id": 53,
23 "label_id": 34,
24 "label": "Loyal",
25 "color": "#3a0cd4"
26 }
27 ],
28 "email": "[email protected]",
29 "first_name": "",
30 "last_name": "",
31 "company_name": "",
32 "phone": "",
33 "reference": "",
34 "address": "",
35 "postcode": "",
36 "city": "",
37 "country": "",
38 "state": "",
39 "clabels_all": "customerloyal",
40 "cognito_user_pool_id": "",
41 "metadata": {},
42 "company": 277,
43 "license_user": null,
44 "clabels": [
45 8,
46 34
47 ]
48 },
49 "product_features": [
50 {
51 "id": 1605023917125630,
52 "product_feature": {
53 "id": 189,
54 "created_at": "2020-11-13T07:40:53Z",
55 "updated_at": "2020-11-13T07:40:53Z",
56 "name": "Feature 5",
57 "code": "f5",
58 "is_deleted": false,
59 "feature_type": "activation",
60 "max_consumption": 0,
61 "allow_overages": false,
62 "max_overages": 0,
63 "reset_consumption": false,
64 "consumption_period": null,
65 "metadata": {}
66 },
67 "max_consumption": 0,
68 "total_consumptions": 0,
69 "expiry_date": null,
70 "allow_overages": false,
71 "max_overages": 99,
72 "reset_consumption": false,
73 "consumption_period": null,
74 "metadata": {}
75 },
76 {
77 "id": 1605023917125631,
78 "product_feature": {
79 "id": 172,
80 "created_at": "2020-08-26T05:37:14Z",
81 "updated_at": "2020-08-26T05:37:14Z",
82 "name": "Feature 2",
83 "code": "f2",
84 "is_deleted": false,
85 "feature_type": "consumption",
86 "max_consumption": 20,
87 "allow_overages": false,
88 "max_overages": 0,
89 "reset_consumption": false,
90 "consumption_period": null,
91 "metadata": {}
92 },
93 "max_consumption": 5,
94 "total_consumptions": 0,
95 "expiry_date": null,
96 "allow_overages": false,
97 "max_overages": 99,
98 "reset_consumption": false,
99 "consumption_period": null,
100 "metadata": {}
101 }
102 ],
103 "product_custom_fields": [],
104 "license_user": {
105 "id": 1240,
106 "last_login": null,
107 "email": "[email protected]|uss1",
108 "true_email": "[email protected]",
109 "created_at": "2020-08-12T08:52:32Z",
110 "updated_at": "2020-08-12T09:01:24Z",
111 "is_admin": {},
112 "is_active": true,
113 "is_staff": false,
114 "first_name": "John",
115 "last_name": "Doe",
116 "phone_number": "00385913109161",
117 "subscribed_to_email": false,
118 "acquired_consent": null,
119 "is_manager": false,
120 "initial_password": "4q3dg7!_",
121 "is_initial_password": true
122 },
123 "license_users": [
124 {
125 "id": 1240,
126 "last_login": null,
127 "email": "[email protected]|uss1",
128 "true_email": "[email protected]",
129 "created_at": "2020-08-12T08:52:32Z",
130 "updated_at": "2020-08-12T09:01:24Z",
131 "is_admin": {},
132 "is_active": true,
133 "is_staff": false,
134 "first_name": "John",
135 "last_name": "Doe",
136 "phone_number": "00385913109161",
137 "subscribed_to_email": false,
138 "acquired_consent": null,
139 "is_manager": false,
140 "initial_password": "4q3dg7!_",
141 "is_initial_password": true
142 }
143 ],
144 "order_store_id": "d2d2dce02c844d4492c9d48758aa143a",
145 "active_up_to_date_devices": 0,
146 "product": {
147 "id": 1584723961091234,
148 "product_name": "mch"
149 },
150 "created_at": "2020-07-03T13:08:40Z",
151 "updated_at": "2020-11-13T07:42:58Z",
152 "license_key": null,
153 "active": false,
154 "enabled": true,
155 "time_activated": "2020-10-10T14:42:16Z",
156 "time_disabled": "2020-08-14T07:26:27Z",
157 "max_activations": 5,
158 "times_activated": 0,
159 "valid_duration": null,
160 "validity_period": "2020-09-30",
161 "license_type": "perpetual",
162 "enable_maintenance_period": true,
163 "maintenance_duration": "3m",
164 "maintenance_period": "2021-01-10",
165 "is_trial": true,
166 "max_consumptions": 0,
167 "total_consumptions": 0,
168 "subscription_id": null,
169 "last_check": null,
170 "prevent_vm": true,
171 "allow_overages": false,
172 "max_overages": 0,
173 "reset_consumption": false,
174 "consumption_period": null,
175 "trial_days": 0,
176 "is_floating": false,
177 "is_floating_cloud": true,
178 "floating_users": 1,
179 "note": null,
180 "max_license_users": 0,
181 "transfer_count": 0,
182 "floating_timeout": null,
183 "max_transfers": 0,
184 "is_air_gapped": false,
185 "can_borrow": false,
186 "max_borrow_time": 0,
187 "is_bundle": false,
188 "metadata": {},
189 "order": 1593781720493279,
190 "order_item": 1593781720493299,
191 "disabled_user": null,
192 "last_activation_device": null,
193 "status": "Inactive"
194 }
195 ],
196 "created_at": null,
197 "updated_at": null,
198 "order": 1593781720493279,
199 "product": 1584723961091234
200 }
201 ],
202 "customer": {
203 "id": 620,
204 "total_orders": 14,
205 "total_licenses": 45,
206 "labels": [
207 {
208 "id": 3,
209 "label_id": 8,
210 "label": "Customer",
211 "color": "#ff9f43"
212 },
213 {
214 "id": 53,
215 "label_id": 34,
216 "label": "Loyal",
217 "color": "#3a0cd4"
218 }
219 ],
220 "customer_account": null,
221 "email": "[email protected]",
222 "first_name": "",
223 "last_name": "",
224 "company_name": "",
225 "phone": "",
226 "reference": "",
227 "address": "",
228 "postcode": "",
229 "city": "",
230 "country": "",
231 "state": "",
232 "clabels_all": "customerloyal",
233 "cognito_user_pool_id": "",
234 "metadata": {},
235 "company": 277,
236 "license_user": null,
237 "clabels": [
238 8,
239 34
240 ]
241 },
242 "has_active_licenses": false,
243 "created_at": "2020-07-03T13:08:40Z",
244 "updated_at": "2020-07-03T13:08:40Z",
245 "store_id": "d2d2dce02c844d4492c9d48758aa143a",
246 "type": "normal",
247 "customer_email": null,
248 "is_test": false,
249 "customer_reference": null,
250 "is_trial": false,
251 "download_id": null,
252 "language": null,
253 "campaign_params": null,
254 "customer_first_name": null,
255 "customer_last_name": null,
256 "customer_company": null,
257 "customer_phone": null,
258 "metadata": {},
259 "company": 277
260}
Updated 25 Mar 2025
Did this page help you?