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": "f1d36d01-ce9d-4bec-a307-52aa405d20ae",
    "type": "orders",
    "attributes": {
      "reference": "BEX-438024",
      "amount": "15.0",
      "status": "Completed",
      "created_at": "2017-06-25T08:21:41.795Z",
      "description": "DID",
      "items": [{
        "type": "did_order_items",
        "attributes": {
          "qty": 1,
          "nrc": "0.0",
          "mrc": "15.0",
          "prorated_mrc": true,
          "billed_from": "2018-08-15",
          "billed_to": "2018-09-15",
          "did_group_id": "111f3e78-4c18-4394-88e7-7eb90c4b4e8d"
        }
      }]
    }
  },
  "meta": {
    "api_version": "2017-09-18"
  }
}

Other Responses

Code

Success

Description

404

No

Not Found

401

No

Unauthorized