Get Orders#

Returns a collection of Orders.

Request#

HTTP Method: GET

URI Path: /v3/orders

Note

For all returned data attributes, see Order Object.

URI Query Parameters#

Name

Type

Is Required?

Description

filter[<filter_name>]

string, DateTime

No

Filtering

fields[orders]

string

No

Sparse fieldsets

sort

string

No

Sorting

page[number]

integer

No

Page number.

page[size]

integer

No

Page size. Pagination defaults to 50 records per page. The maximum is 100.

Filters#

Filter Name

Type

Allow Blank

Allow Array

Filters by:

id

string

No

Yes

Order id field.

status

string

Yes

Yes

Order status field. Possible values: pending, completed, canceled.

created_at_gteq

DateTime

No

No

The created_at_gteq field.

created_at_lteq

DateTime

No

No

The created_at_lteq field.

reference

string

No

Yes

Order reference field.

external_reference_id

string

No

No

The external_reference_id field.

Sorting#

Value

Sorts by:

status

The status field. Possible values: pending, completed, canceled.

amount

The amount field.

created_at

The created_at field.

reference

The reference field.

external_reference_id

The external_reference_id field.

Examples#

http

1GET /v3/orders HTTP/1.1
2Host: api.didww.com
3Content-Type: application/vnd.api+json
4Accept: application/vnd.api+json
5Authorization: Bearer [access token]

curl

1curl -i -X GET https://api.didww.com/v3/orders -H "Accept: application/vnd.api+json" -H "Content-Type: application/vnd.api+json" -H "Authorization: Bearer [access token]"

response

 1HTTP/1.1 200 OK
 2Content-Type: application/vnd.api+json
 3
 4{
 5    "data": [
 6        {
 7            "id": "d9fb4666-cf4b-4409-8144-cb7535924db8",
 8            "type": "orders",
 9            "attributes": {
10                "amount": "6.0",
11                "status": "completed",
12                "created_at": "2023-10-26T11:06:28.989Z",
13                "description": "DID",
14                "reference": "EBX-118849",
15                "external_reference_id": null,
16                "items": [
17                    {
18                        "type": "did_order_items",
19                        "attributes": {
20                            "qty": 1,
21                            "nrc": "0.0",
22                            "mrc": "5.0",
23                            "prorated_mrc": false,
24                            "billed_from": "2023-10-26",
25                            "billed_to": "2023-11-26",
26                            "setup_price": "0.0",
27                            "monthly_price": "5.0",
28                            "did_group_id": "2ef40a84-dfd4-45bb-8519-b4a7ebb74453"
29                        }
30                    }
31                ],
32                "callback_method": null,
33                "callback_url": null
34            }
35        }
36    ],
37    "meta": {
38        "total_records": 1,
39        "api_version": "2026-11-19"
40    },
41    "links": {
42        "first": "https://api.didww.com/v3/orders?page%5Bnumber%5D=1&page%5Bsize%5D=50",
43        "last": "https://api.didww.com/v3/orders?page%5Bnumber%5D=1&page%5Bsize%5D=50"
44    }
45}

Other Responses#

Code

Success

Description

400

No

Bad Request

401

No

Unauthorized

429

No

The request budget of the account for the current window is spent (too_many_requests). Retry-After gives the number of seconds to wait.