Get Orders

Description

Returns a collection of Orders.

Request

HTTP Method: GET

URI Path: /v3/orders

URI Query Parameters:

Name	Type	Is Required?	Description
filter[<filter_name>]	string, DateTime	Optional	Filtering
sort	string	Optional	Sorting

Filters:

Filter Name	Type	Allow Blank	Allow Array	Filters by:
id	string	No	Yes	Order id field.
status	Array[String]	Yes	Yes	Order status field. Possible values: Pending Canceled Completed
created_at_gteq	DateTime	No	No	The created_at_gteq field.
created_at_lteq	DateTime	No	No	The created_at_lteq field.
reference	Array[String]	No	Yes	Order reference field.

Sorting:

Value	Sorts by:
status	The status field. Possible values: Pending Canceled Completed
amount	The amount field.
created_at	The created_at field.
description	The description field.

Fielding:

Value	Returns:
status	The status attribute. Possible values: Pending Canceled Completed
amount	The amount attribute.
created_at	The created_at attribute.
description	The description attribute.
reference	The reference attribute.

Example

http

GET /v3/orders 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 -H "Accept: application/vnd.api+json" -H "Api-Key: [API token]" -H "Content-Type: application/vnd.api+json"

response

GET /v3/orders HTTP/1.1
Host: api.didww.com
Content-Type: application/vnd.api+json
Accept: application/vnd.api+json
Api-Key: [API token]

Other Responses

Code	Success	Description
404	No	Not Found
401	No	Unauthorized