HomeAPI Reference
API Reference

Get Orders

get
https://api.recvue.com/api/v2.0/orders

Retrieves a paginated list of orders with comprehensive filtering options.

Filter Capabilities:

  • Customer and billing details
  • Date ranges (creation, effective, booking dates)
  • Business unit and status
  • Vendor and payment information

Performance: Optimized for large datasets with indexed search

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

Filter by specific order number

string
^[0-9]*$

Filter by order ID (numeric only)

string

Filter by bill-to account number

string

Filter by bill-to account name

string

Filter by business unit name

string
^[0-9]*$

Filter by business unit ID

string

Filter by order status

date

Filter by effective start date

date

Filter by effective end date

integer
≥ 0
Defaults to 0

Page number (0-indexed)

integer
1 to 100
Defaults to 10

Number of records per page

sort
array of strings

Sort criteria in format 'field:direction' (e.g., 'orderId:DESC')

sort
string

Global search across order fields

string

Comma-separated list of fields to return (reduces response size)

string
enum
Defaults to AND

Logical operator for multiple filters

Allowed:
Responses

400
401
500

Updated 3 months ago

Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 3 months ago