Get Order#

Description

Returns a single Order.

Request#

HTTP Method: GET

URI Path: /v3/orders/

URI Query Parameters:

Name

Type

Is Required?

Description

id

string

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": "ebf12efb-3cd5-4c1a-a044-284749259a94",
 7        "type": "orders",
 8        "attributes": {
 9            "amount": "0.35",
10            "status": "Completed",
11            "created_at": "2021-03-15T05:45:02.141Z",
12            "description": "DID",
13            "reference": "CZF-274626",
14            "items": [
15                {
16                    "type": "did_order_items",
17                    "attributes": {
18                        "qty": 1,
19                        "nrc": "0.0",
20                        "mrc": "0.35",
21                        "prorated_mrc": false,
22                        "billed_from": "2021-03-15",
23                        "billed_to": "2021-04-15",
24                        "setup_price": "0.0",
25                        "monthly_price": "0.35",
26                        "did_group_id": "0a265a8c-50fc-4ab3-ae16-9811bc17c241"
27                    }
28                }
29            ],
30            "callback_method": null,
31            "callback_url": null
32        }
33    },
34    "meta": {
35        "api_version": "2021-12-15"
36    }
37}

Other Responses#

Code

Success

Description

404

No

Not Found

401

No

Unauthorized