Order list parameters
Discover how to effectively manage and customize order list parameters for improved organization and efficiency in your workflow.
- Release Notes
- Newly Released Features
- Getting Started
- Roles & Permissions
- Manifests
- Order Management
- Automations
- Employee Management
- Customer Management
- Customer Portal
- Stock Management
- Part Requests
- Price Lists
- Invoicing
- Reporting
- Custom Fields
- Integrations
- GSX
- Shipments
- Service Contracts
- Configuring Your Environment
- Incoming Part Allocation
- Appointment Booking
Table of Contents
Parameters are combined with & in the list parameters field. Some take a value (status=in_queue), others are flags (open, closed). Max length is 1024 characters.
Order details
Parameter |
Description |
Values / how to find |
|---|---|---|
queue |
Filter by Queue(s). Includes sub-queues. |
Queue ID or queue name. System Settings → Queues. Supports list (1,2,3) and exclusion (!1). |
status |
Filter by Order Status(es). |
Status ID or status type (in_queue, in_diagnosis, waiting_for_parts, parts_arrived, waiting_for_pickup, picked_up, ready_for_shipping, shipped, waiting_for_processing, waiting_for_customer, waiting_for_third_party). Supports list and exclusion. |
status_yellow |
Orders that have / have not exceeded the yellow status time limit. |
0 or 1 |
status_red |
Orders that have / have not exceeded the red status time limit. |
0 or 1 |
location |
Filter by service Location(s). |
Location ID. System Settings → Locations and Stores. Supports list and exclusion. |
locationGroup |
Filter by Location Group. |
Group name (matches all locations in the group). |
internal |
Filter by Internal Location. |
with_customer, in_service, in_store, in_transit (comma-separated allowed). |
transit_origin |
Where the order is in transit from (only applies to in-transit orders). |
service or store |
handler |
Filter by assigned Employee(s). |
User ID. Use * for "has any handler", empty for "no handler". Supports list and exclusion. |
store |
Filter by Store(s). |
Store ID. System Settings → Locations and Stores. Supports list and exclusion. |
device |
Filter by Device. |
Device ID. |
reference |
Filter by Customer Reference (substring match, * wildcards supported). |
Text from the Customer Reference field. |
identifier |
Filter by external provider identifier. |
Exact text from order provider. |
provider |
Filter by order provider. |
Provider name (e.g. GSPN-ACK, GSX, DST). |
account |
Filter by Account. |
Text from the Account field. |
insurance_company |
Filter by Insurance Company. |
Insurance company ID. |
tags |
Filter by Order or Customer tags. |
Tag name (* wildcard supported). Supports list and exclusion. |
unreadNotifications |
Orders with unread notifications. |
Flag (no value). |
user |
Filter by Customer / End User. |
User ID. Matches both customer and owner. Supports list and exclusion. |
task |
Filter by a specific task value. |
Format task=name:value — e.g. task=serial number:1234567890. |
customField_{id} |
Filter by Custom Field value. |
Field ID in the parameter name. If no value is given, returns orders where the field is filled. If a value is given, matches with wildcards prefixed/suffixed. |
createdBy |
Filter by who created the order. |
User ID. |
order_ids |
Filter by specific order IDs. |
Comma-separated list of order IDs. |
product_id |
Orders containing a specific product/part on a line. |
Product ID. |
serial |
Orders with a specific serial number on a line. |
Serial string. |
imei |
Orders with a specific IMEI on a line. |
IMEI string. |
price_list_status |
Filter by price list status. |
none, pending_quote_approval, pending_ber_confirmation, quote_approved, ber_confirmed. Supports list. |
Shipment details
Parameter |
Description |
Values / how to find |
|---|---|---|
delivery |
Filter by Delivery Method. |
Delivery ID or short name. System Settings → Delivery Methods. |
delivery_type |
Filter by Delivery Type. |
dropoff, shipping, pickup (also accepts numeric: 0=dropoff, 1=shipping, 2=pickup). |
delivery_carrier |
Filter by Delivery Carrier. |
Carrier name (manual or shipping integration). |
Customer details
Parameter |
Description |
Values / how to find |
|---|---|---|
contactName |
Filter by End User's Name (exact match). |
Customer name. |
contactPhone |
Filter by End User's Phone (exact match). |
Customer phone. |
contactEmail |
Filter by End User's Email (exact match). |
Customer email. |
Repair & appointment
Parameter |
Description |
Values / how to find |
|---|---|---|
repair |
Orders that have a repair. |
|
open_repair |
Orders that have an open repair. |
|
strategy |
Orders with a repair using a given strategy (e.g. CIN for GSX carry-in). Combine with open_repair to limit to open repairs. |
Strategy code. |
saw |
Orders that have SAW (Service Action Web) available. |
|
scheduled |
Orders with scheduled appointments. Requires schedule_provider. |
|
schedule_provider |
Appointment scheduler used by scheduled. |
INTERNAL_APPOINTMENT_SCHEDULER, GSX_APPOINTMENT_SCHEDULER. |
Other options
Parameter |
Description |
|---|---|
open |
Currently open orders. |
closed |
Currently closed orders. |
draft |
Orders still in draft state. |
notdraft |
Orders that are no longer in draft state. |
in |
Internal Location = in-service, in-store, or in-transit. |
out |
Internal Location = with-customer. |
asc |
Reverses sort order to ascending. |
ignorepriority |
Removes priority from the sort order. |
Sorting
| Parameter | Description | Values |
|---|---|---|
| sort | Column to sort by. | order_id, contact, device, handler, status, queued, in_service, user, location, issue, repair, last_status_change, next_appointment, diagnosis_started, repair_started |
| sort_order | Sort direction. | ASC or DESC (default DESC) |
| sort_by_priority | Whether to keep priority at the top of the sort. | 0 or 1 (default 1) |
| asc | Shortcut that reverses the default sort to ascending (no sort column needed). | Flag (no value) |
| ignorepriority | Removes priority from the sort order (sorts by queued/in-service time only). | Flag (no value) |
Sort column meanings:
| Value | Sorts by |
|---|---|
| order_id | Order ID |
| contact | Contact name |
| device | Device description |
| handler | Handler first + last name |
| status | Status name |
| queued | Time the order entered the queue |
| in_service | Time the order entered service |
| user | Customer (company, then last name) |
| location | Service location name |
| issue | Issue text |
| repair | Repair created date |
| last_status_change | When the status was last changed |
| next_appointment | Next appointment date (orders with future appointments only) |
| diagnosis_started | Diagnosis started date |
| repair_started | Repair started date |
Placeholders
These are substituted automatically when the list is opened:
Placeholder |
Replaced with |
|---|---|
{location} |
User's default service Location ID (from User Settings) |
{store} |
User's default Store ID (from User Settings) |
{handler} |
The current (logged-in) user's ID |
Exclusion (negation)
Parameters that support exclusion accept a ! prefix on the value: status=!1,!2 excludes status IDs 1 and 2. Supported on: status, queue, handler, location, store, user, tags.
Lists
Parameters that accept multiple comma-separated values: queue, status, handler, location, store, user, tags, internal, price_list_status, order_ids.