# Get Orders

Get all orders.

Endpoint: GET /v1/orders
Security: OAuth2

## Query parameters:

  - `cursor` (string)
    Pagination cursor for fetching the next page of results.
Omit or pass an empty string to start from the beginning of the list.

  - `limit` (integer)
    Maximum number of items to return per page.
Defaults to 100, maximum 100.

  - `from` (string)
    Filter orders after the provided timestamp.

  - `to` (string)
    Filter orders before the provided timestamp.

  - `sort` (string)
    Field to define the sort order. To indicate sorting direction, fields may be prefixed with + (ascending) or - (descending).

Ensure to URL escape the value as + can otherwise be interpreted as a space.

Only fields created_at and updated_at are supported.

## Response 200 fields (application/json):

  - `next` (string)
    Cursor for the next page of results.
An empty string or absent value indicates the end of the list.

  - `items` (array)

  - `items.id` (string, required)
    The unique identifier of the order.

  - `items.number` (string, required)
    A sequential, human-readable order number.

  - `items.status` (string, required)
    The status of the order.
    Enum: "PENDING", "COMPLETED", "CANCELLED"

  - `items.payment_status` (string, required)
    The payment status of the order.
    Enum: "UNPAID", "PAID", "PARTIALLY_PAID", "REFUNDED", "PARTIALLY_REFUNDED"

  - `items.created_at` (string, required)
    Timestamp of when the order was created.

  - `items.updated_at` (string, required)
    Timestamp of when the order was last updated.

  - `items.customer` (any, required)
    The customer that placed the order.

  - `items.origin` (any, required)
    The origin of the order.

  - `items.totals` (object, required)
    Financial summary of the order.

  - `items.totals.discount` (object, required)
    The total discount applied to the order.

  - `items.totals.discount.currency` (string, required)
    The ISO 4217 currency code.
    Example: "USD"

  - `items.totals.discount.value` (integer, required)
    The price in the smallest currency unit (e.g. cents for USD).
    Example: 2500

  - `items.totals.discount.exponent` (integer, required)
    The number of decimal places for the currency.
    Example: 2

  - `items.totals.vat_amount` (object, required)
    The total VAT amount for the order.

  - `items.totals.amount` (object, required)
    The total amount for the order.

  - `items.metadata` (object)
    A set of key-value pairs that are attached to the order for storing additional information.

## Response 400 fields (application/json):

  - `message` (string, required)

  - `code` (string, required)

## Response default fields (application/json):

  - `message` (string, required)

  - `code` (string, required)