Get Order#
Description
Returns a single Order.
Request#
HTTP Method: GET
URI Path: /v3/orders/
URI Query Parameters:
Name |
Type |
Is Required? |
Description |
id |
|
Yes |
Unique ID identifier of the Order. |
Example#
http
1GET /v3/orders/f1d36d01-ce9d-4bec-a307-52aa405d20ae HTTP/1.1
2Host: api.didww.com
3Content-Type: application/vnd.api+json
4Accept: application/vnd.api+json
5Api-Key: [API token]
curl
1curl -i -X GET https://api.didww.com/v3/orders/f1d36d01-ce9d-4bec-a307-52aa405d20ae -H "Accept: application/vnd.api+json" -H "Api-Key: [API token]" -H "Content-Type: application/vnd.api+json"
response
1HTTP/1.1 200 OK
2Content-Type: application/vnd.api+json
3
4{
5 "data": {
6 "id": "f1d36d01-ce9d-4bec-a307-52aa405d20ae",
7 "type": "orders",
8 "attributes": {
9 "reference": "BEX-438024",
10 "amount": "15.0",
11 "status": "Completed",
12 "created_at": "2017-06-25T08:21:41.795Z",
13 "description": "DID",
14 "items": [{
15 "type": "did_order_items",
16 "attributes": {
17 "qty": 1,
18 "nrc": "0.0",
19 "mrc": "15.0",
20 "prorated_mrc": true,
21 "billed_from": "2018-08-15",
22 "billed_to": "2018-09-15",
23 "did_group_id": "111f3e78-4c18-4394-88e7-7eb90c4b4e8d"
24 }
25 }]
26 }
27 },
28 "meta": {
29 "api_version": "2017-09-18"
30 }
31}
Other Responses#
Code |
Success |
Description |
|---|---|---|
404 |
No |
|
401 |
No |