Skip to content
/Orders

Orders

An order represents an authorization of credit for a customer transaction. Once authorized, an order can be partially or fully captured as goods or services are fulfilled, or canceled if the transaction does not proceed.

Operations

List orders

Request

Return a paginated list of orders.

Security
bearerAuth or basicAuth
Query
limitinteger, [ 1 .. 100 ]

Limit the number of orders returned.

Default:100
pagestring

Specify the page of orders returned.

Default:"1"
filterobject

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

curl -i -X GET \
  'https://docs.resolvepay.com/_mock/merchant-api/openapi/orders?limit=100&page=1&filter=%7B%22status%22%3A%7B%22eq%22%3A%22string%22%7D%2C%22order_number%22%3A%7B%22eq%22%3A%22string%22%7D%2C%22po_number%22%3A%7B%22eq%22%3A%22string%22%7D%2C%22customer_id%22%3A%7B%22eq%22%3A%22string%22%7D%2C%22authorized_at%22%3A%7B%22eq%22%3A%222019-08-24T14%3A15%3A22Z%22%2C%22gt%22%3A%222019-08-24T14%3A15%3A22Z%22%2C%22lt%22%3A%222019-08-24T14%3A15%3A22Z%22%2C%22gte%22%3A%222019-08-24T14%3A15%3A22Z%22%2C%22lte%22%3A%222019-08-24T14%3A15%3A22Z%22%7D%2C%22amount_authorized%22%3A%7B%22eq%22%3A0%2C%22gt%22%3A0%2C%22lt%22%3A0%2C%22gte%22%3A0%2C%22lte%22%3A0%7D%2C%22amount_captured%22%3A%7B%22eq%22%3A0%2C%22gt%22%3A0%2C%22lt%22%3A0%2C%22gte%22%3A0%2C%22lte%22%3A0%7D%2C%22amount_canceled%22%3A%7B%22eq%22%3A0%2C%22gt%22%3A0%2C%22lt%22%3A0%2C%22gte%22%3A0%2C%22lte%22%3A0%7D%2C%22amount_remaining%22%3A%7B%22eq%22%3A0%2C%22gt%22%3A0%2C%22lt%22%3A0%2C%22gte%22%3A0%2C%22lte%22%3A0%7D%7D' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

A paginated list of orders.

Bodyapplication/json
countinteger
Example:1
limitinteger
Example:100
pageinteger
Example:1
resultsArray of objects(OrderListItem)
Response
{
  "count": 1,
  "limit": 100,
  "page": 1,
  "results": [
    { … }
  ]
}