# List orders

Retrieve a list of orders matching the given criteria.

Endpoint: GET /orders
Version: 3.0.0
Security: SessionKey

## Query parameters:

  - `records` (integer)
    The number of records per page that should be returned

  - `page` (integer)
    The number of the results page to return

  - `number` (string)
    If set, only returns orders whose number matches the specified regular expression

  - `customer` (string)
    If set, only returns orders placed by the customer identified by the specified account number

  - `status` (string)
    If set, only returns orders with the specified status
    Enum: "Placed", "Cancelled", "Timed Out", "Fulfilled", "Voided", "Returned"

  - `sort` (string)
    If set, determines how the returned orders are sorted
    Enum: "date"

  - `order` (string)
    If set along with the 'sort' parameter, determines whether the results will be sorted in ascending or descending order.
    Enum: "asc", "desc"

## Response 200 fields (application/json):

  - `total` (integer)
    The total number of results available

  - `page` (integer)
    The number of the results page returned

  - `records` (integer)
    The maximum number of results returned per page

  - `entries` (array)
    List of orders matching the given criteria

  - `entries.self` (string)
    URI of the order resource

  - `entries.number` (string)
    Unique identifier of the order

  - `entries.status` (string)
    Current status of the order

  - `entries.placed` (string)
    The date and time at which the order was placed

  - `entries.subtotal` (number)
    Total cost of the ordered items, before convenience fees are applied

  - `entries.fees` (number)
    Total applicable convenience fees for this order

  - `entries.total` (number)
    Total to be paid for this order inclusive of item costs (subtotal) and fees

  - `entries.items` (array)
    List of items that were ordered

  - `entries.items.number` (string)
    Unique identifier of the ordered item

  - `entries.items.name` (string)
    Short name of the ordered item

  - `entries.items.description` (string)
    Detailed description of the ordered item

  - `entries.items.price` (number)
    Unit price of the ordered item

  - `entries.items.quantity` (number)
    Number of instances of this item that were ordered

  - `entries.customer` (object)
    Details of the user account that placed the order

  - `entries.customer.self` (string)
    URI of the account resource

  - `entries.customer.number` (string)
    Immutable identifier attached to the account

  - `entries.customer.username` (string)
    Unique username attached to the account

  - `entries.customer.email` (string)
    Unique email address attached to the account

  - `entries.customer.role` (string)
    User role assigned to the account
    Enum: "customer", "support", "host", "administrator"

  - `entries.customer.verified` (boolean)
    True if the account email address has been verified, false otherwise

  - `entries.customer.activated` (boolean)
    True if the account is active, false if it has been deactivated

  - `entries.customer.firstName` (string)
    The account holder's forename

  - `entries.customer.lastName` (string)
    The account holder's surname

  - `entries.customer.title` (string)
    The account holder's formal title
    Enum: "Mr", "Mrs", "Ms", "Mx"

  - `entries.customer.dateOfBirth` (string)
    The account holder's date of birth

  - `entries.customer.phone` (string)
    The account holder's primary contact number

  - `entries.customer.country` (string)
    The country associated with the account (used for regionalisation)

  - `entries.customer.firstAddressLine` (string)
    The first line of the account holder's address

  - `entries.customer.secondAddressLine` (string)
    The second line of the account holder's address

  - `entries.customer.city` (string)
    The city portion of the account holder's address

  - `entries.customer.state` (string)
    The state, parish or district portion of the account holder's address

  - `entries.customer.preferences` (string)
    URI of the account's user preferences resource

  - `entries.payments` (string)
    URI of the collection of payments that settle this order

## Response 404 fields (application/json):

  - `message` (string)
    Reason for the given response.