Get Orders

GET https://{{host}}/v3/orders

Returns a collection of Orders.

Request Params

• Allow blank - No.

• Allow array - Yes. | | filter[status] | null | | string - Filters by order status field.

• Allow blank - Yes.

• Allow array - Yes. | | filter[created_at_gteq] | null | | DateTime - Filters by the created_at_gteq field.

• Allow blank - No.

• Allow array - No. | | filter[created_at_lteq] | null | | DateTime - Filters by the created_at_lteq field.

• Allow blank - No.

• Allow array - No. | | filter[reference] | null | | string - Filters by order reference field.

• Allow blank - No.

• Allow array - Yes. | | sort | null | | Used for sorting the fields returned by the request, with a comma , separating the included fields. Details in Sorting Article.

status - The status field.

---

amount - The amount field.

---

created_at - The created_at field.

---

description - The description field. *** |

HEADERS

RESPONSES

status: OK

{"data":[{"id":"af76f42d-2a5c-424e-b908-3b14215b5b15","type":"orders","attributes":{"amount":"16.0","status":"Canceled","created_at":"2018-10-17T13:32:28.424Z","description":"DID","reference":"NGH-098920","items":[{"type":"did_order_items","attributes":{"qty":2,"nrc":"4.0","mrc":"4.0","prorated_mrc":false,"billed_from":null,"billed_to":null,"setup_price":"4.0","monthly_price":"4.0","did_group_id":"3bdc6002-4859-46b0-9cf7-ae95d1af66e2"}}]}},{"id":"1c2d1229-acb4-4b41-b64b-3c3b2d68d985","type":"orders","attributes":{"amount":"8.0","status":"Completed","created_at":"2018-10-17T13:37:55.980Z","description":"DID","reference":"XIH-422617","items":[{"type":"did_order_items","attributes":{"qty":1,"nrc":"4.0","mrc":"4.0","prorated_mrc":false,"billed_from":"2018-10-17","billed_to":"2018-11-16","setup_price":"4.0","monthly_price":"4.0","did_group_id":"939b0c3a-7a07-4699-9e73-9ef77d816c38"}}]}}],"meta":{"total_records":2,"api_version":"2022-05-10"}}