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

Get the expected turnaround for a service type at a store

Get the expected turnaround that applies when this store takes in a service order of this service type, together with the level it was found at. A figure set for the store wins over the figure the service type carries for the whole tenant, the same precedence intake forms follow. This endpoint therefore answers with the one number intake uses, rather than leaving the client to choose between two. The effective figure is null when neither level carries one, and readyAtEstimate is then null: nothing is prefilled. readyAtEstimate is also null, and nothing is prefilled, when no day of the week can be one of the store's working days (its openDays hold only Saturday and Sunday and serviceCountWeekendsAsWorkingDays is false). The resolution is TENANT whenever the store has no override of its own, including when the service type's own figure is null. The response also carries readyAtEstimate, the date core computes from the figure for a service order registered now — the day of the request in the tenant's timezone plus that many of the store's working days (serviceCountWeekendsAsWorkingDays), at 23:59:59 on that day in the tenant's timezone, which reads as the end of the day — so the client shows it on the intake form and sends the date the staff kept, adjusted or cleared on the service order create, never counting days itself. It is a starting point rather than a promise — staff adjust the date case by case, and the adjusted date is what the service order carries. Reading it asks for any service permission — SERVICE_ORDER or SERVICE_STORE_CONFIG held at this store, at its organization or at the tenant, or SERVICE_CONFIG, which is held at the tenant only — because whoever sets the store's turnaround reads it, and intake reads it to prefill readyAtEstimate. A tenant-wide ADMIN grant counts as every permission. A caller holding none of them at this store, a user with no role assignments included, is refused with a 403, and a storeUid naming no store of the tenant with a 400.

Required permissions: SERVICE_ORDER, SERVICE_STORE_CONFIG, SERVICE_CONFIG

get
/tenants/{tenantUid}/stores/{storeUid}/serviceorders/types/{serviceTypeUid}/turnaround
Authorizations
AuthorizationstringRequired

Access token recevied after user login with a deviceToken

Path parameters
tenantUidstringRequired

Reference to a tenant.

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

Reference to a Store.

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

Reference to a service type

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

Example response

application/json

The expected turnaround that applies to one service type at one store, together with the level it was found at. A figure set for the store wins over the tenant's figure on the service type, so this is what intake reads rather than either one on its own. estimatedBusinessDays is the effective figure: the store's own where the store has one, and the service type's otherwise. readyAtEstimate is the date core computes from it for a service order registered now, so the client never does the business-day arithmetic itself. Both are null when neither level carries a figure, and nothing is prefilled. readyAtEstimate is also null, and nothing is prefilled, when no day of the week can be one of the store's working days (its openDays hold only Saturday and Sunday and serviceCountWeekendsAsWorkingDays is false).

tenantUidstringRequiredPattern: ^[A-Za-z0-9-_]+
storeUidstringRequiredPattern: ^[A-Za-z0-9-_]+
serviceTypeUidstringRequiredPattern: ^[A-Za-z0-9-_]+
estimatedBusinessDaysinteger · nullableRequired

The expected turnaround that applies here, in business days. null when neither the store nor the service type carries a figure. The date it yields is readyAtEstimate on this response: the client reads the prefilled date off the response rather than computing it, and staff adjust that date case by case.

readyAtEstimatestring · date-time · nullableRequired

The date intake prefills the service order's readyAtEstimate with: the day of this request in the tenant's timezone plus estimatedBusinessDays of the store's working days (serviceCountWeekendsAsWorkingDays), at 23:59:59 on that day in the tenant's timezone, which reads as the end of the day with no time picked, as readyAtEstimate on the service order response states. Counting starts on the day of the request, or on the next working day when the request falls on a non-working day, so 0 business days answers that starting day. Core does the arithmetic; the client never counts days itself. null when estimatedBusinessDays is null, or when no day of the week can be one of the store's working days (its openDays hold only Saturday and Sunday and serviceCountWeekendsAsWorkingDays is false), and nothing is prefilled. The client shows the day and time on the intake form and sends the day and time the staff kept, adjusted or cleared as readyAtEstimate on the service order create; the create never prefills a date on its own.

resolutionstring · enumRequired

The level the expected turnaround was found at. STORE: the store has an override of its own for this service type — a store figure always wins. TENANT: the store has no override, so the service type's own figure applies, which may itself be none.

Possible values:
get/tenants/{tenantUid}/stores/{storeUid}/serviceorders/types/{serviceTypeUid}/turnaround
GET /v2/tenants/{tenantUid}/stores/{storeUid}/serviceorders/types/{serviceTypeUid}/turnaround HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

Example response

{
  "tenantUid": "text",
  "storeUid": "text",
  "serviceTypeUid": "text",
  "estimatedBusinessDays": 1,
  "readyAtEstimate": "2026-01-01T00:00:00.000Z",
  "resolution": "STORE"
}

Last updated

Was this helpful?