VOvoucherifyio
Orders

List Orders

Returns a list of orders.

get/v1/orders

Request

  • Base URL
    https://api.voucherify.io
  • URL
    https://api.voucherify.io/v1/orders
  • Auth
    • API key in header X-App-Id and API key in header X-App-Token
    • or OAuth 2
      Implicit: https://api.voucherify.io/v1/oauth/token
      Scopes: api, orders

Query parameters

limitinteger

Limits the number of objects to be returned. The limit can range between 1 and 100 items. If no limit is set, it returns 10 items.

pageinteger

Which page of results to return. The lowest value is 1.

order'created_at' | '-created_at' | 'updated_at' | '-updated_at'

This is a property that controls the sorting direction of the results. Sort the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order.

Response

Returns a dictionary with order objects. The orders are returned sorted by creation date by default, with the most recent orders appearing last, unless you specify another sequence using the order query parameter.

object'list' required

The type of the object represented by JSON. This object stores information about orders in a dictionary.

data_ref'orders' required

Identifies the name of the attribute that contains the array of order objects.

totalinteger required

Total number of orders.

Example response

{
  "orders": [
    {
      "created_at": "2021-12-22T10:13:06.487Z",
      "updated_at": "2021-12-22T10:14:45.316Z",
      "customer_id": "cust_7iUa6ICKyU6gH40dBU25kQU1",
      "referrer_id": "cust_nM4jqPiaXUvQdVSA6vTRUnix"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.