REresolvepay
Orders

List orders

Return a paginated list of orders.

get/orders

Request

Query parameters

limitinteger

Limit the number of orders returned.

pagestring

Specify the page of orders returned.

Filter orders by the specified fields.

Filter semantics: filter[field][operator]=value.

Available filter operators:

  • eq - equal (=)
  • gt - greater than (>)
  • gte - greater than or equal (>=)
  • lt - less than (<)
  • lte - less than or equal (<=)

Filtering is allowed by the following fields:

  • status (eq)
  • order_number (eq)
  • po_number (eq)
  • customer_id (eq)
  • authorized_at (eq, gt, lt, gte, lte)
  • amount_authorized (eq, gt, lt, gte, lte)
  • amount_captured (eq, gt, lt, gte, lte)
  • amount_canceled (eq, gt, lt, gte, lte)
  • amount_remaining (eq, gt, lt, gte, lte)

Example: filter[status][eq]=authorized

Note: filter with the eq operator is equivalent to filter[field]=value

Response

A paginated list of orders.

countinteger
limitinteger
pageinteger

Example response

{
  "count": 1,
  "limit": 100,
  "page": 1,
  "results": [
    {
      "id": "ORDlaE5wbg0",
      "checkout_id": "CHKabc123",
      "number": "ord_100001",
      "po_number": "PO-555",
      "source": "checkout",
      "status": "authorized",
      "amount_authorized": 1000,
      "amount_captured": 500,
      "amount_remaining": 500,
      "first_captured_at": "2024-01-15T10:00:00.000Z",
      "line_items": [
        {
          "name": "Widget A",
          "quantity": 2,
          "unit_price": 50,
          "sku": "ABC-123",
          "total_price": 100,
          "type": "product",
          "tax_amount": 8.5
        }
      ],
      "authorization_expires_at": "2024-02-15T10:00:00.000Z",
      "authorization_expiry_source": "system",
      "authorized_at": "2024-01-01T00:00:00.000Z",
      "updated_at": "2024-01-15T10:00:00.000Z",
      "customer": {
        "id": "X50sgfRd",
        "name": "Acme Corp",
        "remaining_credit": 5000
      }
    }
  ]
}

Changes

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