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

GET /v3/orders/f1d36d01-ce9d-4bec-a307-52aa405d20ae HTTP/1.1
Host: api.didww.com
Content-Type: application/vnd.api+json
Accept: application/vnd.api+json
Api-Key: [API token]

curl

curl -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

HTTP/1.1 200 OK
Content-Type: application/vnd.api+json

{
    "data": {
        "id": "ebf12efb-3cd5-4c1a-a044-284749259a94",
        "type": "orders",
        "attributes": {
            "amount": "0.35",
            "status": "Completed",
            "created_at": "2021-03-15T05:45:02.141Z",
            "description": "DID",
            "reference": "CZF-274626",
            "items": [
                {
                    "type": "did_order_items",
                    "attributes": {
                        "qty": 1,
                        "nrc": "0.0",
                        "mrc": "0.35",
                        "prorated_mrc": false,
                        "billed_from": "2021-03-15",
                        "billed_to": "2021-04-15",
                        "setup_price": "0.0",
                        "monthly_price": "0.35",
                        "did_group_id": "0a265a8c-50fc-4ab3-ae16-9811bc17c241"
                    }
                }
            ],
            "callback_method": null,
            "callback_url": null
        }
    },
    "meta": {
        "api_version": "2021-04-19"
    }
}

Other Responses

Code

Success

Description

404

No

Not Found

401

No

Unauthorized