Skip to main content
POST
/
v1
/
orders
/
filter
Filter
curl --request POST \
  --url https://{defaultHost}/v1/orders/filter \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "filter": {
    "type": "condition",
    "attribute_name": "order_type",
    "operator_label": "is",
    "comparison_value": "checkout"
  }
}
'
{
  "object": "list",
  "pagination": {
    "count": 1,
    "limit": 20,
    "page": 1,
    "url": "/v1/orders/filter"
  },
  "data": [
    {
      "id": "b3f046bb-88e6-45e9-9183-d5f630c5a9b8",
      "object": "order",
      "fulfillment_status": "unfulfilled",
      "live_mode": true,
      "number": "0000",
      "order_type": "checkout",
      "return_status": "not_returned",
      "shipment_status": "unshippable",
      "portal_url": "http://app.example.com/portal_redirect/orders/b3f046bb-88e6-45e9-9183-d5f630c5a9b8",
      "statement_url": "http://app.example.com/statements/orders/b3f046bb-88e6-45e9-9183-d5f630c5a9b8",
      "status": "paid",
      "checkout": "72f7c525-c177-4843-b105-c6d55cd1bfd1",
      "created_at": 1782485856,
      "updated_at": 1782485856
    }
  ]
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
filter
object

A rule tree describing how to filter records. May be a single rule_condition or a rule_group combining multiple conditions and nested groups with and / or. The valid attribute_name and operator_label values for each resource come from the corresponding GET /v1/<resource>/filter_schema endpoint.

Example:
{ "type": "group" }

Response

200 - application/json

Success

object
string

A string describing the object type returned.

pagination
object
data
array

An array of objects.