Order list parameters
Discover how to effectively manage and customize order list parameters for improved organization and efficiency in your workflow.
Table of Contents
These are the parameters you can use when you edit an order list as raw text (Switch to advanced (raw text) in the list's panel). Most of them are also available as filters in the visual builder, described in the Order Lists User Guide.
Parameters are combined with &, for example open&location={location}&status=parts_arrived. Some take a value (status=in_queue), others are flags (open, closed). The whole string can be up to 1024 characters long.
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 lists (1,2,3) and exclusion (!1). |
status |
Filter by order status(es) or status type(s). | 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 lists and exclusion. |
status_yellow |
1: open, in-service orders that have been in their status longer than its yellow time limit. 0: orders that have not. |
0 or 1
|
status_red |
1: open, in-service orders that have been in their status longer than its red time limit. 0: orders that have not. |
0 or 1
|
priority |
Filter by order priority. |
normal, high or highest
|
location |
Filter by service location(s). | Location ID. System Settings → Locations and Stores. Supports lists and exclusion. |
locationGroup |
Filter by location group.* | Group name (matches every location in the group). |
internal |
Filter by internal location. |
with_customer, in_service, in_store, in_transit (comma-separated allowed). |
transit_origin |
Where an in-transit order is coming from. |
service or store
|
handler |
Filter by assigned employee(s). | User ID. Use * for "has any handler", or leave the value empty (handler) for "no handler". Supports lists and exclusion. |
store |
Filter by store(s). | Store ID. System Settings → Locations and Stores. Supports lists and exclusion. |
device |
Filter by device. | Device ID. |
reference |
Orders whose customer reference contains this text. | Text from the Customer Reference field. * is not a wildcard here; the value is always matched anywhere in the reference. |
identifier |
Filter by external provider identifier. | Exact text from the order provider. |
provider |
Filter by where the order came from. | Provider name, for example PORTAL, Import, APPTSCHEDULER, DST or GSPN-ACK. Supports lists and exclusion (provider=!PORTAL). An empty value (provider=) shows orders with no provider. |
account |
Filter by account. | Exact text from the Account field. |
insurance_company |
Filter by insurance company. | Insurance company (customer) ID. Supports lists and exclusion. |
tags |
Filter by order or customer tags. | Tag name. Not case-sensitive, * works as a wildcard (warranty*). Supports lists and exclusion. Exclude one tag per list: !A,!B only removes orders that carry both tags. |
unreadNotifications |
Orders with unread notifications. | Flag (no value). |
user |
Filter by customer. | Customer ID. Matches both the customer and the owner of the order. Supports lists and exclusion. |
task |
Filter by the answer to a task. | Format task=name:value, for example task=serial number:1234567890. For Yes/No tasks use 1 or 0. |
customField_{id} |
Filter by a custom field value. | Field ID in the parameter name, for example customField_8=blue. Text fields match values that contain the text. With no value, the filter returns orders where the field has a value. |
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 with a specific product or part on a line. | Product ID. |
serial |
Orders with a specific serial number on a line. | Serial number (exact). |
imei |
Orders with a specific IMEI on a line. | IMEI (exact). |
price_list_status |
Filter by price list status. |
none, pending_quote_approval, pending_ber_confirmation, quote_approved, ber_confirmed. Supports lists. |
Shipment details
| Parameter | Description | Values / how to find |
|---|---|---|
delivery |
Filter by delivery method. | Delivery method ID or short name. System Settings → Delivery Methods. |
delivery_type |
Filter by delivery type. |
dropoff, shipping or pickup. |
delivery_carrier |
Filter by delivery carrier. | Carrier name (manual or from a shipping integration). |
dispatched |
Orders that have (1) or have not (0) had lines dispatched with Dispatch or Bill and dispatch.* |
0 or 1
|
Customer details
| Parameter | Description | Values / how to find |
|---|---|---|
contactName |
Filter by the end user's name (exact match). | Contact name. |
contactPhone |
Filter by the end user's phone (exact match). | Contact phone number. |
contactEmail |
Filter by the end user's email (exact match). | Contact email address. |
Repair & appointment
| Parameter | Description | Values / how to find |
|---|---|---|
repair |
Orders that have a repair. | Flag (no value). |
open_repair |
Orders that have a repair that is not finished. | Flag (no value). |
repeat_repair |
Orders marked as a repeat repair. | Flag (no value). |
rework |
Orders whose repair has a diagnostic code marked as rework.* | 1 |
strategy |
Orders with a repair using a given strategy (for example CIN for GSX carry-in). Combine with open_repair to limit it to open repairs.* |
Strategy code. |
saw |
Orders that have SAW (Service Action Web) requests.* | Flag (no value). |
scheduled |
Orders with scheduled appointments. Has no effect without schedule_provider. |
Flag (no value). |
schedule_provider |
The appointment scheduler that scheduled looks at. |
INTERNAL_APPOINTMENT_SCHEDULER, GSX_APPOINTMENT_SCHEDULER or service_booking (Service Booking appointments). |
appointment_from / appointment_to
|
Limit a scheduled list to appointments in a date range.* | Dates as YYYY-MM-DD. Use together with scheduled and schedule_provider, or with provider=APPTSCHEDULER. |
Other options
| Parameter | Description |
|---|---|
open |
Orders that are not closed or cancelled. |
closed |
Completed orders. Cancelled orders are not included. |
draft |
Orders still in draft state. |
notdraft |
Orders that are no longer drafts. |
in |
The device is in service, in store or in transit. |
out |
The device is with the customer. |
noqueue |
Orders that are not in any queue. |
* Marked parameters filter the list itself, but the count badge in the menu and the list's CSV/XLSX export ignore them. A list that uses one can show a higher count in the menu than the number of orders it opens.
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 for the sort column. |
asc or desc (default desc) |
sort_by_priority |
Whether to keep priority orders at the top when sorting by a column. |
0 or 1 (default 1) |
asc |
Reverses the default sort to ascending (no sort column needed). | Flag (no value) |
ignorepriority |
Removes priority from the default sort order. | Flag (no value) |
Sort column meanings
| Value | Sorts by |
|---|---|
order_id |
Order ID |
contact |
Contact name |
device |
Device description |
handler |
Handler first and 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 replaced automatically when someone opens the list, so one list adapts to each viewer:
| Placeholder | Replaced with |
|---|---|
{location} |
The viewer's default service location ID (User Settings → General). Only the default location, not every location the user can access. |
{store} |
The viewer's default store ID (User Settings → General). |
{handler} |
The viewer's own user ID. |
If the viewer has no default location or store set, a list that uses {location} or {store} shows no orders.
Exclusion (negation)
Parameters that support exclusion accept a ! in front of a value: status=!1,!2 leaves out status IDs 1 and 2. Supported on: status, queue, handler, location, store, user, insurance_company, provider, tags.
Excluding a status or a location also leaves out orders that have no status or no location at all. Excluding a store or a handler does not work reliably at the moment; use a filter that includes the stores or handlers you want instead.
Lists
Parameters that accept several comma-separated values: queue, status, handler, location, store, user, insurance_company, provider, tags, internal, price_list_status, order_ids. A list of values matches orders with any of them.