Orders List

GET/api/v1/ordersAccessExpress

Returns a list of orders for a particular customer with filtering, sorting, and pagination options.

Auth Scope

urn:grt:accessexpress

Content-Type

application/json

Rate Limit

60 req/min

Headers

Header	Value
`Authorization`	`Bearer access-token`

Parameter	Type	Required	Description
`page`	integer	No	Page number for pagination (starting at 1). Default: `1`
`page_size`	integer	No	Number of orders per page. Must be between 1 and 100. Default: `20`
`status`	array of strings	No	Comma-separated list of order statuses to filter by. Valid values: `"draft"`, `"submitted"`, `"pending"`, `"canceled"`, `"completed"`
`requester`	array of strings	No	List of requesters to filter the results
`start_date`	datetime	No	Filter orders created on or after this date
`search`	string	No	Search term applied to `order_name`, `order_number`, `requester`, `customer_name`, or billing address
`sort_field`	string	No	Field to sort the results by. Valid values: `"order_number"`, `"updated_at"`, `"order_name"`, `"requester"`, `"customer_name"`. Default: `"created_at"`
`sort_order`	string	No	Sort direction: `"asc"` or `"desc"`. Default: `"desc"`
`granted_tenant_macnum`	string	No	The company macnum on whose behalf the action is performed

If the request is successful, a 200 OK status code is returned.

Field	Type	Description
`id`	UUID	Unique identifier for the order
`order_number`	integer	Order number for reference
`status`	string	Current status of the order. Values: `"draft"`, `"submitted"`, `"pending"`, `"canceled"`, `"completed"`
`total_amount`	number	Total amount for the order
`locations`	array	Array of location objects with address and order items

HTTP Status	Error Description	Resolution
`401`	Authentication Failed	Verify your access token is valid and included in the Authorization header with the "Bearer " prefix.
`403`	Permission Denied	You do not have permissions to view orders. Check your API scope (`urn:grt:accessexpress`).
`429`	Rate Limit Exceeded	You have exceeded the rate limit of 60 requests per minute. Check the `Retry-After` header in the response.