For the complete documentation index, see llms.txt. This page is also available as Markdown.

Create new saved service order list

Save a named service order list for the caller. Supply savedListUid to make the call idempotent: a repeat with the same savedListUid returns the list already created and writes nothing, when that list is the caller's own. A savedListUid held by another person's list is refused with a 400, as any uid already in use is, and a malformed uid stays refused. The list belongs to the caller who creates it and is never visible to anyone else. A list follows its owner onto every device they sign in on or unlock. What is saved is a set of filters, in the same shape as a service order search request, not a fixed set of service orders and not a raw query. The list is evaluated fresh every time it is opened.

Required permissions: SERVICE_ORDER

post
/tenants/{tenantUid}/serviceorders/savedlists
Authorizations
AuthorizationstringRequired

Access token recevied after user login with a deviceToken

Path parameters
tenantUidstringRequired

Reference to a tenant.

Pattern: ^[A-Za-z0-9-_]+
Body

The editable parts of a saved service order list. Lists are personal — the caller only ever reads and writes their own, and a list can never be handed to another user. filters replaces what the list stands for: send the whole filter set, in the same shape as a service order search request, and send an empty object for a list that filters on nothing. Because a list holds semantic filters rather than a raw query, it keeps working when the configuration changes underneath it — a list filtering on a status that is later deactivated still returns whatever is on that status.

namestringRequired

What to call the list. Shown in the list picker and on the dashboard card.

sortBystringOptional

The field to sort the list by, passed on to the search endpoint when the list is opened. Send an empty string to fall back to the default sorting. Left out, the list keeps the sort field it has; left out on the create, a list uses the default sorting.

sortDirectionstring · enumOptional
ENUMDescription
ASCSort in ascending order
DESCSort in descending order
Possible values:
positionintegerOptional

Where the list is to sit among the user's own lists, ascending. Reorder the lists by writing new positions on them. Left out, the list keeps the position it has. Left out on the create, a list is placed after the user's existing lists, and the first list is placed at 0.

showAsCardbooleanOptional

Whether the list also gets a card with a count on the service workspace dashboard, on top of being in the list picker. Left out, the list keeps what it has. Left out on the create, a list gets no card.

savedListUidstringOptionalPattern: ^[A-Za-z0-9-_]+
Responses
201

Example response

application/json

A named service order list one user saved for themselves, such as "My overdue repairs". A saved list is personal: it belongs to the caller who created it — the person the request is authenticated as, which on a shared screen is the person whose PIN unlocked it. Only that user ever sees it, and it follows them onto every device they sign in on or unlock. A list holds filters, in the same shape as a service order search request — never a fixed set of service orders and never a raw query. It is therefore evaluated fresh every time and keeps working when the configuration changes underneath it: a list filtering on a status that has since been deactivated still returns whatever is on that status. Lists are shown in the order given by position. A list with showAsCard also gets a card on the service workspace dashboard, whose number is read by sending the list's filters to the service order counts endpoint. A list is opened on the tenant-level service order search, which reaches every service order of the tenant for a caller holding SERVICE_ORDER at any level — the same reach the counts endpoint counts over, and the same filters run on both, so a card's number and the list behind it always agree. A list that is to cover only some stores says so with storeUids in its own filters, or with createdFromStoreUids when it is to hold what a store took in rather than what it owns.

savedListUidstringRequiredPattern: ^[A-Za-z0-9-_]+
tenantUidstringRequiredPattern: ^[A-Za-z0-9-_]+
tenantUserUidstringRequired

The user the list belongs to. Always the caller the request was made by — a list is only ever returned to the user who owns it.

Pattern: ^[A-Za-z0-9-_]+
namestringRequired

What the user called the list. Shown in the list picker and on the dashboard card.

sortBystringRequired

The field the list is sorted by, as it is passed on to the search endpoint. An empty string when the list uses the default sorting.

sortDirectionstring · enumRequired
ENUMDescription
ASCSort in ascending order
DESCSort in descending order
Possible values:
positionintegerRequired

Where the list sits among the user's own lists, ascending. Reordering the lists is writing new positions on them.

showAsCardbooleanRequired

Whether the list also gets a card with a count on the service workspace dashboard, on top of being in the list picker.

createdAtstring · date-timeRequired
createdBystringRequired
lastModifiedAtstring · date-timeRequired
lastModifiedBystringRequired
post/tenants/{tenantUid}/serviceorders/savedlists
POST /v2/tenants/{tenantUid}/serviceorders/savedlists HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 967

{
  "name": "text",
  "filters": {
    "customerName": "text",
    "customerMobile": "text",
    "customerEmail": "text",
    "title": "text",
    "serviceNumber": "text",
    "query": "text",
    "fromCreatedDate": "2026-01-01",
    "toCreatedDate": "2026-01-01",
    "assignedUserUids": [
      "text"
    ],
    "createdFromStoreUids": [
      "text"
    ],
    "priorities": [
      "HIGHEST"
    ],
    "serviceStates": [
      "AWAITING_PRODUCT"
    ],
    "open": true,
    "serviceTypeUids": [
      "text"
    ],
    "storeUids": [
      "text"
    ],
    "serviceStatusUids": [
      "text"
    ],
    "fromReadyAtEstimate": "2026-01-01T00:00:00.000Z",
    "toReadyAtEstimate": "2026-01-01T00:00:00.000Z",
    "overdue": true,
    "serial": "text",
    "serviceJobTypeUids": [
      "text"
    ],
    "externalServiceNumber": "text",
    "claimNumber": "text",
    "externalSalesOrderNumber": "text",
    "customerNumber": "text",
    "customerUids": [
      "text"
    ],
    "productUids": [
      "text"
    ],
    "coverages": [
      "PAYABLE"
    ],
    "fromFinishedDate": "2026-01-01",
    "toFinishedDate": "2026-01-01",
    "formValueFilters": [
      {
        "fieldKey": "text",
        "value": "text"
      }
    ]
  },
  "sortBy": "text",
  "sortDirection": "ASC",
  "position": 1,
  "showAsCard": true,
  "savedListUid": "text"
}
201

Example response

{
  "savedListUid": "text",
  "tenantUid": "text",
  "tenantUserUid": "text",
  "name": "text",
  "filters": {
    "customerName": "text",
    "customerMobile": "text",
    "customerEmail": "text",
    "title": "text",
    "serviceNumber": "text",
    "query": "text",
    "fromCreatedDate": "2026-01-01",
    "toCreatedDate": "2026-01-01",
    "assignedUserUids": [
      "text"
    ],
    "createdFromStoreUids": [
      "text"
    ],
    "priorities": [
      "HIGHEST"
    ],
    "serviceStates": [
      "AWAITING_PRODUCT"
    ],
    "open": true,
    "serviceTypeUids": [
      "text"
    ],
    "storeUids": [
      "text"
    ],
    "serviceStatusUids": [
      "text"
    ],
    "fromReadyAtEstimate": "2026-01-01T00:00:00.000Z",
    "toReadyAtEstimate": "2026-01-01T00:00:00.000Z",
    "overdue": true,
    "serial": "text",
    "serviceJobTypeUids": [
      "text"
    ],
    "externalServiceNumber": "text",
    "claimNumber": "text",
    "externalSalesOrderNumber": "text",
    "customerNumber": "text",
    "customerUids": [
      "text"
    ],
    "productUids": [
      "text"
    ],
    "coverages": [
      "PAYABLE"
    ],
    "fromFinishedDate": "2026-01-01",
    "toFinishedDate": "2026-01-01",
    "formValueFilters": [
      {
        "fieldKey": "text",
        "value": "text"
      }
    ]
  },
  "sortBy": "text",
  "sortDirection": "ASC",
  "position": 1,
  "showAsCard": true,
  "createdAt": "2026-01-01T00:00:00.000Z",
  "createdBy": "text",
  "lastModifiedAt": "2026-01-01T00:00:00.000Z",
  "lastModifiedBy": "text"
}

Last updated

Was this helpful?