Fork me on GitHub

Table Of Contents

You are currently viewing the version 4.1. View another version :

Orders Index¶

About¶

Returns orders of the authenticated user.

/api/v2/orders/

Information
HTTP Method	GET
Requires Authentication	Yes

Parameters¶

Parameters	Type	Information
page	integer	page number of listing
per_page	integer	number of orders to list per page
includes	string	inclusion of sub-data. Currently only ‘elements’ supported

Response Fields¶

Field	Description
data	The list of orders

Response sample¶

{
  "meta": {
    "api_version": "2.0.0",
    "request": "GET /api/v2/orders/",
    "response_time": "2016-03-23T19:43:43+01:00",
    "http_code": 200,
    "error_type": null,
    "error_message": null,
    "error_details": null,
    "charset": "UTF-8"
  },
  "response": {
    "data": [
      {
        "id": 1,
        "owner_id": 1,
        "created": "2016-02-09T14:26:20+01:00",
        "usage": "",
        "deadline": "2016-02-11T00:00:00+01:00"
      },
      {
        "id": 9,
        "owner_id": 1,
        "created": "2016-03-02T17:57:40+01:00",
        "usage": "I can do what I wish with these records",
        "deadline": "2016-03-02T16:57:29+01:00"
      }
    ],
    "meta": {
      "pagination": {
        "total": 16,
        "count": 2,
        "per_page": 2,
        "current_page": 1,
        "total_pages": 8,
        "links": {
          "next": "/api.php/api/v2/orders/?page=2&per_page=2"
        }
      }
    }
  }
}