Service
Service
List all service-orders for a tenant store. Default sorting order is by serviceOrderUid ascending.
Authorizations
Path parameters
tenantUidstringRequiredPattern:
Reference to a tenant.
^[A-Za-z0-9-_]+storeUidstringRequiredPattern:
Reference to a Store.
^[A-Za-z0-9-_]+Query parameters
pageNumberintegerOptional
Reference to a specific page in a result set.
pageSizeintegerOptional
The number of items per page in a result set.
sortBystringOptional
Defines which field the resource list is sorted by.
sortDirectionstring · enumOptional
Possible values:
| ENUM | Description |
|---|---|
| ASC | Sort in ascending order |
| DESC | Sort in descending order |
serviceTypeUidsstring[]Optional
Filter by service types
assignedUserUidsstring[]Optional
Filter by assigned users
createdFromStoreUidsstring[]Optional
Filter by created-from-stores
Responses
200
Example response
application/json
get
GET /v2/tenants/{tenantUid}/stores/{storeUid}/serviceorders HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200
Example response
{
"items": [
{
"serviceOrderUid": "text",
"tenantUid": "text",
"storeUid": "text",
"orderProductLineUid": "text",
"orderUid": "text",
"customerUid": "text",
"createdFromStoreUid": "text",
"assignedUserUid": "text",
"assignedUserDisplayName": "text",
"serviceTypeUid": "text",
"serviceTypeName": "text",
"serviceStatusUid": "text",
"serviceStatusName": "text",
"serviceState": "NOT_STARTED",
"title": "text",
"serviceNumber": "text",
"externalServiceNumber": "text",
"description": "text",
"locationLabel": "text",
"priority": "NONE",
"requiresPriceEstimate": true,
"estimatedPrice": 1,
"maxPrice": 1,
"readyAtEstimate": "2025-07-30T18:10:28.008Z",
"readyAtNeeded": "2025-07-30T18:10:28.008Z",
"publicPageHash": "text",
"warranty": true,
"createdAt": "2025-07-30T18:10:28.008Z",
"createdBy": "text",
"lastModifiedAt": "2025-07-30T18:10:28.008Z",
"lastModifiedBy": "text",
"totals": {
"grandTotal": 1,
"partsTotal": 1,
"workTotal": 1
},
"items": [
{
"serviceOrderItemUid": "text",
"serviceOrderUid": "text",
"warehouseUid": "text",
"tenantUserUid": "text",
"productUid": "text",
"salesOrderUid": "text",
"quantity": 1,
"name": "text",
"sku": "text",
"price": 1,
"costPrice": 1,
"originalPrice": 1,
"totalPrice": 1,
"totalCostPrice": 1,
"serialNumber": "text",
"note": "text",
"tenantUserDisplayName": "text",
"createdAt": "2025-07-30T18:10:28.008Z",
"createdBy": "text",
"lastModifiedAt": "2025-07-30T18:10:28.008Z",
"lastModifiedBy": "text"
}
],
"assets": [
{
"assetUid": "text",
"name": "text",
"description": "text",
"isPublic": true,
"publicUrl": "text",
"mimeType": "text"
}
]
}
],
"paging": {
"pageNumber": 1,
"pageSize": 1,
"totalCount": 1
}
}Create a new service-order.
Authorizations
Path parameters
tenantUidstringRequiredPattern:
Reference to a tenant.
^[A-Za-z0-9-_]+storeUidstringRequiredPattern:
Reference to a Store.
^[A-Za-z0-9-_]+Body
all ofOptional
and
Responses
201
Example response
application/json
post
POST /v2/tenants/{tenantUid}/stores/{storeUid}/serviceorders HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 367
{
"customerUid": "text",
"serviceTypeUid": "text",
"orderProductLineUid": "text",
"title": "text",
"description": "text",
"locationLabel": "text",
"priority": "NONE",
"requiresPriceEstimate": true,
"estimatedPrice": 1,
"maxPrice": 1,
"readyAtEstimate": "2025-07-30T18:10:28.008Z",
"readyAtNeeded": "2025-07-30T18:10:28.008Z",
"assignedUserUid": "text",
"warranty": true,
"serviceOrderUid": "text"
}201
Example response
{
"serviceOrderUid": "text",
"tenantUid": "text",
"storeUid": "text",
"orderProductLineUid": "text",
"orderUid": "text",
"customerUid": "text",
"createdFromStoreUid": "text",
"assignedUserUid": "text",
"assignedUserDisplayName": "text",
"serviceTypeUid": "text",
"serviceTypeName": "text",
"serviceStatusUid": "text",
"serviceStatusName": "text",
"serviceState": "NOT_STARTED",
"title": "text",
"serviceNumber": "text",
"externalServiceNumber": "text",
"description": "text",
"locationLabel": "text",
"priority": "NONE",
"requiresPriceEstimate": true,
"estimatedPrice": 1,
"maxPrice": 1,
"readyAtEstimate": "2025-07-30T18:10:28.008Z",
"readyAtNeeded": "2025-07-30T18:10:28.008Z",
"publicPageHash": "text",
"warranty": true,
"createdAt": "2025-07-30T18:10:28.008Z",
"createdBy": "text",
"lastModifiedAt": "2025-07-30T18:10:28.008Z",
"lastModifiedBy": "text",
"totals": {
"grandTotal": 1,
"partsTotal": 1,
"workTotal": 1
},
"items": [
{
"serviceOrderItemUid": "text",
"serviceOrderUid": "text",
"warehouseUid": "text",
"tenantUserUid": "text",
"productUid": "text",
"salesOrderUid": "text",
"quantity": 1,
"name": "text",
"sku": "text",
"price": 1,
"costPrice": 1,
"originalPrice": 1,
"totalPrice": 1,
"totalCostPrice": 1,
"serialNumber": "text",
"note": "text",
"tenantUserDisplayName": "text",
"createdAt": "2025-07-30T18:10:28.008Z",
"createdBy": "text",
"lastModifiedAt": "2025-07-30T18:10:28.008Z",
"lastModifiedBy": "text"
}
],
"assets": [
{
"assetUid": "text",
"name": "text",
"description": "text",
"isPublic": true,
"publicUrl": "text",
"mimeType": "text"
}
]
}Get the data for a given service-order.
Authorizations
Path parameters
tenantUidstringRequiredPattern:
Reference to a tenant.
^[A-Za-z0-9-_]+storeUidstringRequiredPattern:
Reference to a Store.
^[A-Za-z0-9-_]+serviceOrderUidstringRequiredPattern:
Reference to a service order
^[A-Za-z0-9-_]+Responses
200
Example response
application/json
get
GET /v2/tenants/{tenantUid}/stores/{storeUid}/serviceorders/{serviceOrderUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200
Example response
{
"serviceOrderUid": "text",
"tenantUid": "text",
"storeUid": "text",
"orderProductLineUid": "text",
"orderUid": "text",
"customerUid": "text",
"createdFromStoreUid": "text",
"assignedUserUid": "text",
"assignedUserDisplayName": "text",
"serviceTypeUid": "text",
"serviceTypeName": "text",
"serviceStatusUid": "text",
"serviceStatusName": "text",
"serviceState": "NOT_STARTED",
"title": "text",
"serviceNumber": "text",
"externalServiceNumber": "text",
"description": "text",
"locationLabel": "text",
"priority": "NONE",
"requiresPriceEstimate": true,
"estimatedPrice": 1,
"maxPrice": 1,
"readyAtEstimate": "2025-07-30T18:10:28.008Z",
"readyAtNeeded": "2025-07-30T18:10:28.008Z",
"publicPageHash": "text",
"warranty": true,
"createdAt": "2025-07-30T18:10:28.008Z",
"createdBy": "text",
"lastModifiedAt": "2025-07-30T18:10:28.008Z",
"lastModifiedBy": "text",
"totals": {
"grandTotal": 1,
"partsTotal": 1,
"workTotal": 1
},
"items": [
{
"serviceOrderItemUid": "text",
"serviceOrderUid": "text",
"warehouseUid": "text",
"tenantUserUid": "text",
"productUid": "text",
"salesOrderUid": "text",
"quantity": 1,
"name": "text",
"sku": "text",
"price": 1,
"costPrice": 1,
"originalPrice": 1,
"totalPrice": 1,
"totalCostPrice": 1,
"serialNumber": "text",
"note": "text",
"tenantUserDisplayName": "text",
"createdAt": "2025-07-30T18:10:28.008Z",
"createdBy": "text",
"lastModifiedAt": "2025-07-30T18:10:28.008Z",
"lastModifiedBy": "text"
}
],
"assets": [
{
"assetUid": "text",
"name": "text",
"description": "text",
"isPublic": true,
"publicUrl": "text",
"mimeType": "text"
}
]
}Update data on a given service-order.
Authorizations
Path parameters
tenantUidstringRequiredPattern:
Reference to a tenant.
^[A-Za-z0-9-_]+storeUidstringRequiredPattern:
Reference to a Store.
^[A-Za-z0-9-_]+serviceOrderUidstringRequiredPattern:
Reference to a service order
^[A-Za-z0-9-_]+Body
customerUidstringRequiredPattern:
^[A-Za-z0-9-_]*serviceTypeUidstringRequiredPattern:
^[A-Za-z0-9-_]+orderProductLineUidstringOptionalPattern:
^[A-Za-z0-9-_]*titlestringRequired
descriptionstringRequired
locationLabelstringOptional
prioritystring · enumRequiredDefault:
NONEPossible values: requiresPriceEstimatebooleanOptional
estimatedPriceintegerOptional
maxPriceintegerOptional
readyAtEstimatestring · date-timeOptional
readyAtNeededstring · date-timeOptional
assignedUserUidstringOptionalPattern:
^[A-Za-z0-9-_]*warrantybooleanOptional
Responses
200
Example response
application/json
put
PUT /v2/tenants/{tenantUid}/stores/{storeUid}/serviceorders/{serviceOrderUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 342
{
"customerUid": "text",
"serviceTypeUid": "text",
"orderProductLineUid": "text",
"title": "text",
"description": "text",
"locationLabel": "text",
"priority": "NONE",
"requiresPriceEstimate": true,
"estimatedPrice": 1,
"maxPrice": 1,
"readyAtEstimate": "2025-07-30T18:10:28.008Z",
"readyAtNeeded": "2025-07-30T18:10:28.008Z",
"assignedUserUid": "text",
"warranty": true
}200
Example response
{
"serviceOrderUid": "text",
"tenantUid": "text",
"storeUid": "text",
"orderProductLineUid": "text",
"orderUid": "text",
"customerUid": "text",
"createdFromStoreUid": "text",
"assignedUserUid": "text",
"assignedUserDisplayName": "text",
"serviceTypeUid": "text",
"serviceTypeName": "text",
"serviceStatusUid": "text",
"serviceStatusName": "text",
"serviceState": "NOT_STARTED",
"title": "text",
"serviceNumber": "text",
"externalServiceNumber": "text",
"description": "text",
"locationLabel": "text",
"priority": "NONE",
"requiresPriceEstimate": true,
"estimatedPrice": 1,
"maxPrice": 1,
"readyAtEstimate": "2025-07-30T18:10:28.008Z",
"readyAtNeeded": "2025-07-30T18:10:28.008Z",
"publicPageHash": "text",
"warranty": true,
"createdAt": "2025-07-30T18:10:28.008Z",
"createdBy": "text",
"lastModifiedAt": "2025-07-30T18:10:28.008Z",
"lastModifiedBy": "text",
"totals": {
"grandTotal": 1,
"partsTotal": 1,
"workTotal": 1
},
"items": [
{
"serviceOrderItemUid": "text",
"serviceOrderUid": "text",
"warehouseUid": "text",
"tenantUserUid": "text",
"productUid": "text",
"salesOrderUid": "text",
"quantity": 1,
"name": "text",
"sku": "text",
"price": 1,
"costPrice": 1,
"originalPrice": 1,
"totalPrice": 1,
"totalCostPrice": 1,
"serialNumber": "text",
"note": "text",
"tenantUserDisplayName": "text",
"createdAt": "2025-07-30T18:10:28.008Z",
"createdBy": "text",
"lastModifiedAt": "2025-07-30T18:10:28.008Z",
"lastModifiedBy": "text"
}
],
"assets": [
{
"assetUid": "text",
"name": "text",
"description": "text",
"isPublic": true,
"publicUrl": "text",
"mimeType": "text"
}
]
}Delete a given service-order.
Authorizations
Path parameters
tenantUidstringRequiredPattern:
Reference to a tenant.
^[A-Za-z0-9-_]+storeUidstringRequiredPattern:
Reference to a Store.
^[A-Za-z0-9-_]+serviceOrderUidstringRequiredPattern:
Reference to a service order
^[A-Za-z0-9-_]+Responses
204
No Content
delete
DELETE /v2/tenants/{tenantUid}/stores/{storeUid}/serviceorders/{serviceOrderUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
204
No Content
No content
Add a new service-order item.
Authorizations
Path parameters
tenantUidstringRequiredPattern:
Reference to a tenant.
^[A-Za-z0-9-_]+storeUidstringRequiredPattern:
Reference to a Store.
^[A-Za-z0-9-_]+serviceOrderUidstringRequiredPattern:
Reference to a service order
^[A-Za-z0-9-_]+Body
all ofOptional
and
Responses
201
Example response
application/json
post
POST /v2/tenants/{tenantUid}/stores/{storeUid}/serviceorders/{serviceOrderUid}/items HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 131
{
"price": 1,
"quantity": 1,
"serialNumber": "text",
"note": "text",
"productUid": "text",
"serviceOrderItemUid": "text",
"warehouseUid": "text"
}201
Example response
{
"serviceOrderUid": "text",
"tenantUid": "text",
"storeUid": "text",
"orderProductLineUid": "text",
"orderUid": "text",
"customerUid": "text",
"createdFromStoreUid": "text",
"assignedUserUid": "text",
"assignedUserDisplayName": "text",
"serviceTypeUid": "text",
"serviceTypeName": "text",
"serviceStatusUid": "text",
"serviceStatusName": "text",
"serviceState": "NOT_STARTED",
"title": "text",
"serviceNumber": "text",
"externalServiceNumber": "text",
"description": "text",
"locationLabel": "text",
"priority": "NONE",
"requiresPriceEstimate": true,
"estimatedPrice": 1,
"maxPrice": 1,
"readyAtEstimate": "2025-07-30T18:10:28.008Z",
"readyAtNeeded": "2025-07-30T18:10:28.008Z",
"publicPageHash": "text",
"warranty": true,
"createdAt": "2025-07-30T18:10:28.008Z",
"createdBy": "text",
"lastModifiedAt": "2025-07-30T18:10:28.008Z",
"lastModifiedBy": "text",
"totals": {
"grandTotal": 1,
"partsTotal": 1,
"workTotal": 1
},
"items": [
{
"serviceOrderItemUid": "text",
"serviceOrderUid": "text",
"warehouseUid": "text",
"tenantUserUid": "text",
"productUid": "text",
"salesOrderUid": "text",
"quantity": 1,
"name": "text",
"sku": "text",
"price": 1,
"costPrice": 1,
"originalPrice": 1,
"totalPrice": 1,
"totalCostPrice": 1,
"serialNumber": "text",
"note": "text",
"tenantUserDisplayName": "text",
"createdAt": "2025-07-30T18:10:28.008Z",
"createdBy": "text",
"lastModifiedAt": "2025-07-30T18:10:28.008Z",
"lastModifiedBy": "text"
}
],
"assets": [
{
"assetUid": "text",
"name": "text",
"description": "text",
"isPublic": true,
"publicUrl": "text",
"mimeType": "text"
}
]
}Update a service-order item.
Authorizations
Path parameters
tenantUidstringRequiredPattern:
Reference to a tenant.
^[A-Za-z0-9-_]+storeUidstringRequiredPattern:
Reference to a Store.
^[A-Za-z0-9-_]+serviceOrderUidstringRequiredPattern:
Reference to a service order
^[A-Za-z0-9-_]+serviceOrderItemUidstringRequiredPattern:
Reference to a service order item
^[A-Za-z0-9-_]+Body
priceintegerOptional
quantityintegerRequired
serialNumberstringOptional
notestringOptional
Responses
200
Example response
application/json
put
PUT /v2/tenants/{tenantUid}/stores/{storeUid}/serviceorders/{serviceOrderUid}/items/{serviceOrderItemUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 60
{
"price": 1,
"quantity": 1,
"serialNumber": "text",
"note": "text"
}200
Example response
{
"serviceOrderUid": "text",
"tenantUid": "text",
"storeUid": "text",
"orderProductLineUid": "text",
"orderUid": "text",
"customerUid": "text",
"createdFromStoreUid": "text",
"assignedUserUid": "text",
"assignedUserDisplayName": "text",
"serviceTypeUid": "text",
"serviceTypeName": "text",
"serviceStatusUid": "text",
"serviceStatusName": "text",
"serviceState": "NOT_STARTED",
"title": "text",
"serviceNumber": "text",
"externalServiceNumber": "text",
"description": "text",
"locationLabel": "text",
"priority": "NONE",
"requiresPriceEstimate": true,
"estimatedPrice": 1,
"maxPrice": 1,
"readyAtEstimate": "2025-07-30T18:10:28.008Z",
"readyAtNeeded": "2025-07-30T18:10:28.008Z",
"publicPageHash": "text",
"warranty": true,
"createdAt": "2025-07-30T18:10:28.008Z",
"createdBy": "text",
"lastModifiedAt": "2025-07-30T18:10:28.008Z",
"lastModifiedBy": "text",
"totals": {
"grandTotal": 1,
"partsTotal": 1,
"workTotal": 1
},
"items": [
{
"serviceOrderItemUid": "text",
"serviceOrderUid": "text",
"warehouseUid": "text",
"tenantUserUid": "text",
"productUid": "text",
"salesOrderUid": "text",
"quantity": 1,
"name": "text",
"sku": "text",
"price": 1,
"costPrice": 1,
"originalPrice": 1,
"totalPrice": 1,
"totalCostPrice": 1,
"serialNumber": "text",
"note": "text",
"tenantUserDisplayName": "text",
"createdAt": "2025-07-30T18:10:28.008Z",
"createdBy": "text",
"lastModifiedAt": "2025-07-30T18:10:28.008Z",
"lastModifiedBy": "text"
}
],
"assets": [
{
"assetUid": "text",
"name": "text",
"description": "text",
"isPublic": true,
"publicUrl": "text",
"mimeType": "text"
}
]
}Delete a service-order item.
Authorizations
Path parameters
tenantUidstringRequiredPattern:
Reference to a tenant.
^[A-Za-z0-9-_]+storeUidstringRequiredPattern:
Reference to a Store.
^[A-Za-z0-9-_]+serviceOrderUidstringRequiredPattern:
Reference to a service order
^[A-Za-z0-9-_]+serviceOrderItemUidstringRequiredPattern:
Reference to a service order item
^[A-Za-z0-9-_]+Responses
204
No Content
delete
DELETE /v2/tenants/{tenantUid}/stores/{storeUid}/serviceorders/{serviceOrderUid}/items/{serviceOrderItemUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
204
No Content
No content
List all events for a service order.
Authorizations
Path parameters
tenantUidstringRequiredPattern:
Reference to a tenant.
^[A-Za-z0-9-_]+storeUidstringRequiredPattern:
Reference to a Store.
^[A-Za-z0-9-_]+serviceOrderUidstringRequiredPattern:
Reference to a service order
^[A-Za-z0-9-_]+Query parameters
pageNumberintegerOptional
Reference to a specific page in a result set.
pageSizeintegerOptional
The number of items per page in a result set.
sortBystringOptional
Defines which field the resource list is sorted by.
sortDirectionstring · enumOptional
Possible values:
| ENUM | Description |
|---|---|
| ASC | Sort in ascending order |
| DESC | Sort in descending order |
Responses
200
Example response
application/json
get
GET /v2/tenants/{tenantUid}/stores/{storeUid}/serviceorders/{serviceOrderUid}/events HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200
Example response
{
"items": [
{
"serviceEventUid": "text",
"serviceOrderUid": "text",
"serviceStatusUid": "text",
"tenantUserUid": "text",
"tenantUserDisplayName": "text",
"note": "text",
"visibility": "INTERNAL",
"createdAt": "2025-07-30T18:10:28.008Z",
"createdBy": "text",
"lastModifiedAt": "2025-07-30T18:10:28.008Z",
"lastModifiedBy": "text",
"notifications": [
{
"notificationUid": "text",
"type": "EMAIL",
"state": "NOT_STARTED",
"recipient": "text"
}
]
}
],
"paging": {
"pageNumber": 1,
"pageSize": 1,
"totalCount": 1
}
}Create a new service-order event.
Authorizations
Path parameters
tenantUidstringRequiredPattern:
Reference to a tenant.
^[A-Za-z0-9-_]+storeUidstringRequiredPattern:
Reference to a Store.
^[A-Za-z0-9-_]+serviceOrderUidstringRequiredPattern:
Reference to a service order
^[A-Za-z0-9-_]+Body
all ofOptional
and
Responses
201
Example response
application/json
post
POST /v2/tenants/{tenantUid}/stores/{storeUid}/serviceorders/{serviceOrderUid}/events HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 116
{
"note": "text",
"serviceStatusUid": "text",
"visibility": "INTERNAL",
"notifications": [
"EMAIL"
],
"serviceEventUid": "text"
}201
Example response
{
"serviceEventUid": "text",
"serviceOrderUid": "text",
"serviceStatusUid": "text",
"tenantUserUid": "text",
"tenantUserDisplayName": "text",
"note": "text",
"visibility": "INTERNAL",
"createdAt": "2025-07-30T18:10:28.008Z",
"createdBy": "text",
"lastModifiedAt": "2025-07-30T18:10:28.008Z",
"lastModifiedBy": "text",
"notifications": [
{
"notificationUid": "text",
"type": "EMAIL",
"state": "NOT_STARTED",
"recipient": "text"
}
]
}Get a service-order event.
Authorizations
Path parameters
tenantUidstringRequiredPattern:
Reference to a tenant.
^[A-Za-z0-9-_]+storeUidstringRequiredPattern:
Reference to a Store.
^[A-Za-z0-9-_]+serviceOrderUidstringRequiredPattern:
Reference to a service order
^[A-Za-z0-9-_]+serviceEventUidstringRequiredPattern:
Reference to a service event
^[A-Za-z0-9-_]+Responses
200
Example response
application/json
get
GET /v2/tenants/{tenantUid}/stores/{storeUid}/serviceorders/{serviceOrderUid}/events/{serviceEventUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200
Example response
{
"serviceEventUid": "text",
"serviceOrderUid": "text",
"serviceStatusUid": "text",
"tenantUserUid": "text",
"tenantUserDisplayName": "text",
"note": "text",
"visibility": "INTERNAL",
"createdAt": "2025-07-30T18:10:28.008Z",
"createdBy": "text",
"lastModifiedAt": "2025-07-30T18:10:28.008Z",
"lastModifiedBy": "text",
"notifications": [
{
"notificationUid": "text",
"type": "EMAIL",
"state": "NOT_STARTED",
"recipient": "text"
}
]
}Update a service-order event.
Authorizations
Path parameters
tenantUidstringRequiredPattern:
Reference to a tenant.
^[A-Za-z0-9-_]+storeUidstringRequiredPattern:
Reference to a Store.
^[A-Za-z0-9-_]+serviceOrderUidstringRequiredPattern:
Reference to a service order
^[A-Za-z0-9-_]+serviceEventUidstringRequiredPattern:
Reference to a service event
^[A-Za-z0-9-_]+Body
notestringOptional
serviceStatusUidstringRequiredPattern:
^[A-Za-z0-9-_]+visibilitystring · enumRequiredPossible values:
Responses
200
Example response
application/json
put
PUT /v2/tenants/{tenantUid}/stores/{storeUid}/serviceorders/{serviceOrderUid}/events/{serviceEventUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 91
{
"note": "text",
"serviceStatusUid": "text",
"visibility": "INTERNAL",
"notifications": [
"EMAIL"
]
}200
Example response
{
"serviceEventUid": "text",
"serviceOrderUid": "text",
"serviceStatusUid": "text",
"tenantUserUid": "text",
"tenantUserDisplayName": "text",
"note": "text",
"visibility": "INTERNAL",
"createdAt": "2025-07-30T18:10:28.008Z",
"createdBy": "text",
"lastModifiedAt": "2025-07-30T18:10:28.008Z",
"lastModifiedBy": "text",
"notifications": [
{
"notificationUid": "text",
"type": "EMAIL",
"state": "NOT_STARTED",
"recipient": "text"
}
]
}Delete a service-order event.
Authorizations
Path parameters
tenantUidstringRequiredPattern:
Reference to a tenant.
^[A-Za-z0-9-_]+storeUidstringRequiredPattern:
Reference to a Store.
^[A-Za-z0-9-_]+serviceOrderUidstringRequiredPattern:
Reference to a service order
^[A-Za-z0-9-_]+serviceEventUidstringRequiredPattern:
Reference to a service event
^[A-Za-z0-9-_]+Responses
204
No Content
delete
DELETE /v2/tenants/{tenantUid}/stores/{storeUid}/serviceorders/{serviceOrderUid}/events/{serviceEventUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
204
No Content
No content
List hours for a service-order.
Authorizations
Path parameters
tenantUidstringRequiredPattern:
Reference to a tenant.
^[A-Za-z0-9-_]+storeUidstringRequiredPattern:
Reference to a Store.
^[A-Za-z0-9-_]+serviceOrderUidstringRequiredPattern:
Reference to a service order
^[A-Za-z0-9-_]+Query parameters
pageNumberintegerOptional
Reference to a specific page in a result set.
pageSizeintegerOptional
The number of items per page in a result set.
sortBystringOptional
Defines which field the resource list is sorted by.
sortDirectionstring · enumOptional
Possible values:
| ENUM | Description |
|---|---|
| ASC | Sort in ascending order |
| DESC | Sort in descending order |
Responses
200
Example response
application/json
get
GET /v2/tenants/{tenantUid}/stores/{storeUid}/serviceorders/{serviceOrderUid}/hours HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200
Example response
{
"items": [
{
"serviceHoursUid": "text",
"serviceOrderUid": "text",
"tenantUserUid": "text",
"note": "text",
"serviceDate": "2025-07-30T18:10:28.008Z",
"usedMinutes": 1,
"billedMinutes": 1,
"hourPrice": 1,
"totalPrice": 1,
"tenantUserDisplayName": "text",
"createdAt": "2025-07-30T18:10:28.008Z",
"createdBy": "text",
"lastModifiedAt": "2025-07-30T18:10:28.008Z",
"lastModifiedBy": "text",
"hourlyRateUid": "text",
"salesOrderUid": "text"
}
],
"paging": {
"pageNumber": 1,
"pageSize": 1,
"totalCount": 1
}
}Create new hours entry for a service-order.
Authorizations
Path parameters
tenantUidstringRequiredPattern:
Reference to a tenant.
^[A-Za-z0-9-_]+storeUidstringRequiredPattern:
Reference to a Store.
^[A-Za-z0-9-_]+serviceOrderUidstringRequiredPattern:
Reference to a service order
^[A-Za-z0-9-_]+Body
all ofOptional
and
Responses
201
Example response
application/json
post
POST /v2/tenants/{tenantUid}/stores/{storeUid}/serviceorders/{serviceOrderUid}/hours HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 138
{
"serviceDate": "2025-07-30T18:10:28.008Z",
"usedMinutes": 1,
"note": "text",
"billedMinutes": 1,
"hourlyRateUid": "text",
"serviceHoursUid": "text"
}201
Example response
{
"serviceHoursUid": "text",
"serviceOrderUid": "text",
"tenantUserUid": "text",
"note": "text",
"serviceDate": "2025-07-30T18:10:28.008Z",
"usedMinutes": 1,
"billedMinutes": 1,
"hourPrice": 1,
"totalPrice": 1,
"tenantUserDisplayName": "text",
"createdAt": "2025-07-30T18:10:28.008Z",
"createdBy": "text",
"lastModifiedAt": "2025-07-30T18:10:28.008Z",
"lastModifiedBy": "text",
"hourlyRateUid": "text",
"salesOrderUid": "text"
}Get a service hours entry
Authorizations
Path parameters
tenantUidstringRequiredPattern:
Reference to a tenant.
^[A-Za-z0-9-_]+storeUidstringRequiredPattern:
Reference to a Store.
^[A-Za-z0-9-_]+serviceOrderUidstringRequiredPattern:
Reference to a service order
^[A-Za-z0-9-_]+serviceHoursUidstringRequiredPattern:
Reference to a service hours entry
^[A-Za-z0-9-_]+Responses
200
Example response
application/json
get
GET /v2/tenants/{tenantUid}/stores/{storeUid}/serviceorders/{serviceOrderUid}/hours/{serviceHoursUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200
Example response
{
"serviceHoursUid": "text",
"serviceOrderUid": "text",
"tenantUserUid": "text",
"note": "text",
"serviceDate": "2025-07-30T18:10:28.008Z",
"usedMinutes": 1,
"billedMinutes": 1,
"hourPrice": 1,
"totalPrice": 1,
"tenantUserDisplayName": "text",
"createdAt": "2025-07-30T18:10:28.008Z",
"createdBy": "text",
"lastModifiedAt": "2025-07-30T18:10:28.008Z",
"lastModifiedBy": "text",
"hourlyRateUid": "text",
"salesOrderUid": "text"
}Update a service hours entry.
Authorizations
Path parameters
tenantUidstringRequiredPattern:
Reference to a tenant.
^[A-Za-z0-9-_]+storeUidstringRequiredPattern:
Reference to a Store.
^[A-Za-z0-9-_]+serviceOrderUidstringRequiredPattern:
Reference to a service order
^[A-Za-z0-9-_]+serviceHoursUidstringRequiredPattern:
Reference to a service hours entry
^[A-Za-z0-9-_]+Body
serviceDatestring · date-timeOptional
usedMinutesintegerOptional
notestringOptional
billedMinutesintegerOptional
hourlyRateUidstringOptionalPattern:
^[A-Za-z0-9-_]*Responses
200
Example response
application/json
put
PUT /v2/tenants/{tenantUid}/stores/{storeUid}/serviceorders/{serviceOrderUid}/hours/{serviceHoursUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 113
{
"serviceDate": "2025-07-30T18:10:28.008Z",
"usedMinutes": 1,
"note": "text",
"billedMinutes": 1,
"hourlyRateUid": "text"
}200
Example response
{
"serviceHoursUid": "text",
"serviceOrderUid": "text",
"tenantUserUid": "text",
"note": "text",
"serviceDate": "2025-07-30T18:10:28.008Z",
"usedMinutes": 1,
"billedMinutes": 1,
"hourPrice": 1,
"totalPrice": 1,
"tenantUserDisplayName": "text",
"createdAt": "2025-07-30T18:10:28.008Z",
"createdBy": "text",
"lastModifiedAt": "2025-07-30T18:10:28.008Z",
"lastModifiedBy": "text",
"hourlyRateUid": "text",
"salesOrderUid": "text"
}Delete a service hours entry.
Authorizations
Path parameters
tenantUidstringRequiredPattern:
Reference to a tenant.
^[A-Za-z0-9-_]+storeUidstringRequiredPattern:
Reference to a Store.
^[A-Za-z0-9-_]+serviceOrderUidstringRequiredPattern:
Reference to a service order
^[A-Za-z0-9-_]+serviceHoursUidstringRequiredPattern:
Reference to a service hours entry
^[A-Za-z0-9-_]+Responses
204
No Content
delete
DELETE /v2/tenants/{tenantUid}/stores/{storeUid}/serviceorders/{serviceOrderUid}/hours/{serviceHoursUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
204
No Content
No content
List notifications for a service-order
Authorizations
Path parameters
tenantUidstringRequiredPattern:
Reference to a tenant.
^[A-Za-z0-9-_]+storeUidstringRequiredPattern:
Reference to a Store.
^[A-Za-z0-9-_]+serviceOrderUidstringRequiredPattern:
Reference to a service order
^[A-Za-z0-9-_]+Query parameters
pageNumberintegerOptional
Reference to a specific page in a result set.
pageSizeintegerOptional
The number of items per page in a result set.
sortBystringOptional
Defines which field the resource list is sorted by.
sortDirectionstring · enumOptional
Possible values:
| ENUM | Description |
|---|---|
| ASC | Sort in ascending order |
| DESC | Sort in descending order |
Responses
200
Example response
application/json
get
GET /v2/tenants/{tenantUid}/stores/{storeUid}/serviceorders/{serviceOrderUid}/notifications HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200
Example response
{
"items": [
{
"messageType": "EMAIL",
"recipient": "text",
"message": "text",
"subject": "text",
"state": "NOT_STARTED",
"errorText": "text",
"notificationUid": "text",
"customerUid": "text",
"orderUid": "text",
"serviceOrderUid": "text",
"serviceEventUid": "text",
"tenantUserUid": "text",
"supplierUid": "text",
"receivementUid": "text",
"purchaseOrderUid": "text",
"createdBy": "text",
"createdAt": "2025-07-30T18:10:28.008Z",
"lastModifiedBy": "text",
"lastModifiedAt": "2025-07-30T18:10:28.008Z"
}
],
"paging": {
"pageNumber": 1,
"pageSize": 1,
"totalCount": 1
}
}List service types.
Authorizations
Path parameters
tenantUidstringRequiredPattern:
Reference to a tenant.
^[A-Za-z0-9-_]+Query parameters
pageNumberintegerOptional
Reference to a specific page in a result set.
pageSizeintegerOptional
The number of items per page in a result set.
sortBystringOptional
Defines which field the resource list is sorted by.
sortDirectionstring · enumOptional
Possible values:
| ENUM | Description |
|---|---|
| ASC | Sort in ascending order |
| DESC | Sort in descending order |
Responses
200
Example response
application/json
get
GET /v2/tenants/{tenantUid}/serviceorders/types HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200
Example response
{
"items": [
{
"serviceTypeUid": "text",
"tenantUid": "text",
"serviceStatuses": [
{
"serviceStatusUid": "text",
"serviceStatusName": "text",
"position": 1,
"state": "NOT_STARTED"
}
],
"name": "text",
"deprecated": true
}
],
"paging": {
"pageNumber": 1,
"pageSize": 1,
"totalCount": 1
}
}Create a new service type.
Authorizations
Path parameters
tenantUidstringRequiredPattern:
Reference to a tenant.
^[A-Za-z0-9-_]+Body
all ofOptional
and
Responses
201
Example response
application/json
post
POST /v2/tenants/{tenantUid}/serviceorders/types HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 118
{
"name": "text",
"serviceStatuses": [
{
"serviceStatusUid": "text",
"position": 1
}
],
"deprecated": true,
"serviceTypeUid": "text"
}201
Example response
{
"serviceTypeUid": "text",
"tenantUid": "text",
"serviceStatuses": [
{
"serviceStatusUid": "text",
"serviceStatusName": "text",
"position": 1,
"state": "NOT_STARTED"
}
],
"name": "text",
"deprecated": true
}Get a service type by ID.
Authorizations
Path parameters
tenantUidstringRequiredPattern:
Reference to a tenant.
^[A-Za-z0-9-_]+serviceTypeUidstringRequiredPattern:
Reference to a service type
^[A-Za-z0-9-_]+Responses
200
Example response
application/json
get
GET /v2/tenants/{tenantUid}/serviceorders/types/{serviceTypeUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200
Example response
{
"serviceTypeUid": "text",
"tenantUid": "text",
"serviceStatuses": [
{
"serviceStatusUid": "text",
"serviceStatusName": "text",
"position": 1,
"state": "NOT_STARTED"
}
],
"name": "text",
"deprecated": true
}Update a service type.
Authorizations
Path parameters
tenantUidstringRequiredPattern:
Reference to a tenant.
^[A-Za-z0-9-_]+serviceTypeUidstringRequiredPattern:
Reference to a service type
^[A-Za-z0-9-_]+Body
namestringRequired
deprecatedbooleanOptional
Responses
200
Example response
application/json
put
PUT /v2/tenants/{tenantUid}/serviceorders/types/{serviceTypeUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 94
{
"name": "text",
"serviceStatuses": [
{
"serviceStatusUid": "text",
"position": 1
}
],
"deprecated": true
}200
Example response
{
"serviceTypeUid": "text",
"tenantUid": "text",
"serviceStatuses": [
{
"serviceStatusUid": "text",
"serviceStatusName": "text",
"position": 1,
"state": "NOT_STARTED"
}
],
"name": "text",
"deprecated": true
}Delete a service type.
Authorizations
Path parameters
tenantUidstringRequiredPattern:
Reference to a tenant.
^[A-Za-z0-9-_]+serviceTypeUidstringRequiredPattern:
Reference to a service type
^[A-Za-z0-9-_]+Responses
204
No Content
delete
DELETE /v2/tenants/{tenantUid}/serviceorders/types/{serviceTypeUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
204
No Content
No content
Get a list of statuses for a service order.
Authorizations
Path parameters
tenantUidstringRequiredPattern:
Reference to a tenant.
^[A-Za-z0-9-_]+Query parameters
pageNumberintegerOptional
Reference to a specific page in a result set.
pageSizeintegerOptional
The number of items per page in a result set.
sortBystringOptional
Defines which field the resource list is sorted by.
sortDirectionstring · enumOptional
Possible values:
| ENUM | Description |
|---|---|
| ASC | Sort in ascending order |
| DESC | Sort in descending order |
Responses
200
Example response
application/json
get
GET /v2/tenants/{tenantUid}/serviceorders/statuses HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200
Example response
{
"items": [
{
"serviceStatusUid": "text",
"tenantUid": "text",
"name": "text",
"state": "NOT_STARTED",
"deprecated": false
}
],
"paging": {
"pageNumber": 1,
"pageSize": 1,
"totalCount": 1
}
}Create a new service status. Set position to reflect which step in the workflow this status will be.
Authorizations
Path parameters
tenantUidstringRequiredPattern:
Reference to a tenant.
^[A-Za-z0-9-_]+Body
all ofOptional
and
Responses
201
Example response
application/json
post
POST /v2/tenants/{tenantUid}/serviceorders/statuses HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 81
{
"name": "text",
"state": "NOT_STARTED",
"deprecated": true,
"serviceStatusUid": "text"
}201
Example response
{
"serviceStatusUid": "text",
"tenantUid": "text",
"name": "text",
"state": "NOT_STARTED",
"deprecated": false
}Get a service status by ID.
Authorizations
Path parameters
tenantUidstringRequiredPattern:
Reference to a tenant.
^[A-Za-z0-9-_]+serviceStatusUidstringRequiredPattern:
Reference to a service status
^[A-Za-z0-9-_]+Responses
200
Example response
application/json
get
GET /v2/tenants/{tenantUid}/serviceorders/statuses/{serviceStatusUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200
Example response
{
"serviceStatusUid": "text",
"tenantUid": "text",
"name": "text",
"state": "NOT_STARTED",
"deprecated": false
}Update a given service status. Set position to reflect which step in the workflow this status is.
Authorizations
Path parameters
tenantUidstringRequiredPattern:
Reference to a tenant.
^[A-Za-z0-9-_]+serviceStatusUidstringRequiredPattern:
Reference to a service status
^[A-Za-z0-9-_]+Body
namestringRequired
statestring · enumRequiredPossible values:
deprecatedbooleanOptional
Responses
200
Example response
application/json
put
PUT /v2/tenants/{tenantUid}/serviceorders/statuses/{serviceStatusUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 55
{
"name": "text",
"state": "NOT_STARTED",
"deprecated": true
}200
Example response
{
"serviceStatusUid": "text",
"tenantUid": "text",
"name": "text",
"state": "NOT_STARTED",
"deprecated": false
}Delete a given service status.
Authorizations
Path parameters
tenantUidstringRequiredPattern:
Reference to a tenant.
^[A-Za-z0-9-_]+serviceStatusUidstringRequiredPattern:
Reference to a service status
^[A-Za-z0-9-_]+Responses
204
No Content
delete
DELETE /v2/tenants/{tenantUid}/serviceorders/statuses/{serviceStatusUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
204
No Content
No content
Get a service order by the public page hash.
Authorizations
Path parameters
tenantUidstringRequiredPattern:
Reference to a tenant.
^[A-Za-z0-9-_]+storeUidstringRequiredPattern:
Reference to a Store.
^[A-Za-z0-9-_]+serviceOrderHashstringRequired
Encrypted reference to a service order
Responses
200
Example response
application/json
get
GET /v2/tenants/{tenantUid}/stores/{storeUid}/serviceorders/pages/{serviceOrderHash} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200
Example response
{
"serviceOrderUid": "text",
"tenantUid": "text",
"storeUid": "text",
"orderProductLineUid": "text",
"orderUid": "text",
"customerUid": "text",
"createdFromStoreUid": "text",
"assignedUserUid": "text",
"assignedUserDisplayName": "text",
"serviceTypeUid": "text",
"serviceTypeName": "text",
"serviceStatusUid": "text",
"serviceStatusName": "text",
"serviceState": "NOT_STARTED",
"title": "text",
"serviceNumber": "text",
"externalServiceNumber": "text",
"description": "text",
"locationLabel": "text",
"priority": "NONE",
"requiresPriceEstimate": true,
"estimatedPrice": 1,
"maxPrice": 1,
"readyAtEstimate": "2025-07-30T18:10:28.008Z",
"readyAtNeeded": "2025-07-30T18:10:28.008Z",
"publicPageHash": "text",
"warranty": true,
"createdAt": "2025-07-30T18:10:28.008Z",
"createdBy": "text",
"lastModifiedAt": "2025-07-30T18:10:28.008Z",
"lastModifiedBy": "text",
"totals": {
"grandTotal": 1,
"partsTotal": 1,
"workTotal": 1
},
"items": [
{
"serviceOrderItemUid": "text",
"serviceOrderUid": "text",
"warehouseUid": "text",
"tenantUserUid": "text",
"productUid": "text",
"salesOrderUid": "text",
"quantity": 1,
"name": "text",
"sku": "text",
"price": 1,
"costPrice": 1,
"originalPrice": 1,
"totalPrice": 1,
"totalCostPrice": 1,
"serialNumber": "text",
"note": "text",
"tenantUserDisplayName": "text",
"createdAt": "2025-07-30T18:10:28.008Z",
"createdBy": "text",
"lastModifiedAt": "2025-07-30T18:10:28.008Z",
"lastModifiedBy": "text"
}
],
"assets": [
{
"assetUid": "text",
"name": "text",
"description": "text",
"isPublic": true,
"publicUrl": "text",
"mimeType": "text"
}
]
}List sales orders for a service-order.
Authorizations
Path parameters
tenantUidstringRequiredPattern:
Reference to a tenant.
^[A-Za-z0-9-_]+storeUidstringRequiredPattern:
Reference to a Store.
^[A-Za-z0-9-_]+serviceOrderUidstringRequiredPattern:
Reference to a service order
^[A-Za-z0-9-_]+Query parameters
pageNumberintegerOptional
Reference to a specific page in a result set.
pageSizeintegerOptional
The number of items per page in a result set.
Responses
200
Example response
application/json
get
GET /v2/tenants/{tenantUid}/stores/{storeUid}/serviceorders/{serviceOrderUid}/orders HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200
Example response
{
"items": [
{
"shippingAddress": {
"address": "text",
"city": "text",
"companyName": "text",
"countryCode": "text",
"email": "text",
"firstname": "text",
"lastname": "text",
"mobile": "text",
"postalCode": "text",
"vatNumber": "text",
"displayName": "text"
},
"createdAt": "2025-07-30T18:10:28.008Z",
"customerAddress": {
"address": "text",
"city": "text",
"companyName": "text",
"countryCode": "text",
"email": "text",
"firstname": "text",
"lastname": "text",
"mobile": "text",
"postalCode": "text",
"vatNumber": "text",
"displayName": "text"
},
"customerUid": "text",
"customerContact": {
"customerContactUid": "text",
"firstname": "text",
"lastname": "text",
"email": "text",
"mobile": "text",
"displayName": "text"
},
"deliveryState": "NOT_STARTED",
"externalOrderNumber": "text",
"externalVoucherNumber": "text",
"invoiceAddress": {
"address": "text",
"city": "text",
"companyName": "text",
"countryCode": "text",
"email": "text",
"mobile": "text",
"firstname": "text",
"lastname": "text",
"postalCode": "text",
"displayName": "text",
"customerAddressUid": "text"
},
"items": [
{
"actions": [
{
"comment": "text",
"createdAt": "2025-07-30T18:10:28.008Z",
"createdBy": "text",
"handlingActionUid": "text",
"handlingActionName": "text",
"handlingDescription": "text",
"handlingUid": "text",
"handlingName": "text",
"lastModifiedAt": "2025-07-30T18:10:28.008Z",
"lastModifiedBy": "text",
"orderHandlingActionUid": "text"
}
],
"allowedActions": [
"QUANTITY_SOLD"
],
"createdAt": "2025-07-30T18:10:28.008Z",
"discountReasonCode": "text",
"externalId": "text",
"itemCost": 1,
"itemDiscountAmount": 1,
"itemDiscountPercentage": 1,
"itemGrossProfitAmount": 1,
"itemGrossProfitPercentage": 1,
"itemPrice": 1,
"itemVatAmount": 1,
"lastModifiedAt": "2025-07-30T18:10:28.008Z",
"ledgerNumber": "text",
"name": "text",
"note": "text",
"orderItemUid": "text",
"orderLinks": [
{
"orderUid": "text",
"orderItemUid": "text",
"orderNumber": "text",
"storeUid": "text",
"type": "CREDIT"
}
],
"originalItemPrice": 1,
"productUid": "text",
"productType": "STOCK",
"properties": [
{
"uid": "text",
"key": "text",
"value": "text"
}
],
"quantityCredited": 1,
"quantityDelivered": 1,
"quantityOrdered": 1,
"quantityReserved": 1,
"returnReasonCode": "text",
"serialnumber": "text",
"sku": "text",
"sortOrder": 1,
"tenantUserDisplayName": "text",
"tenantUserUid": "text",
"totalCost": 1,
"totalDiscountAmount": 1,
"totalGrossProfitAmount": 1,
"totalPrice": 1,
"totalVatAmount": 1,
"vatCodeUid": "text",
"warehouseUid": "text",
"warehouseName": "text",
"internalInfo": "text",
"productProperties": [
{
"productPropertyUid": "text",
"propertyName": "text",
"propertyOptionName": "text",
"propertyType": "TEXT",
"propertyText": "text",
"propertyUid": "text",
"propertyOptionUid": "text",
"required": true
}
],
"coverImage": {
"productMediaUid": "text",
"mainUrl": "text",
"thumbnailUrl": "text"
},
"deliveryUid": "text",
"compensationReasonCode": "text",
"orderReceiptUid": "text",
"allowDeliveryFromDate": "2025-07-30T18:10:28.008Z",
"reservationType": "NONE",
"reservationDetails": {
"warehouse": {
"warehouseName": "text"
},
"purchaseOrder": {
"purchaseOrderUid": "text",
"purchaseOrderItemUid": "text",
"expectedDeliveryDate": "2025-07-30T18:10:28.008Z",
"purchaseOrderNumber": "text",
"quantityOrdered": 1
}
}
}
],
"lastModifiedAt": "2025-07-30T18:10:28.008Z",
"note": "text",
"orderUid": "text",
"orderNumber": "text",
"orderState": "OPEN",
"orderTotals": {
"costTotal": 1,
"grandTotal": 1,
"grossProfitAmount": 1,
"grossProfitPercentage": 1,
"specifiedVat": [
{
"vatAmount": 1,
"vatDescription": "text",
"vatRate": 1
}
],
"subtotal": 1,
"totalDiscount": 1,
"totalVat": 1
},
"orderhandlingState": "NOT_STARTED",
"orderhandlings": [
{
"active": true,
"createdAt": "2025-07-30T18:10:28.008Z",
"createdBy": "text",
"description": "text",
"handlingUid": "text",
"lastModifiedAt": "2025-07-30T18:10:28.008Z",
"lastModifiedBy": "text",
"name": "text",
"orderHandlingUid": "text",
"state": "NOT_STARTED"
}
],
"settleState": "NOT_STARTED",
"settledAt": "2025-07-30T18:10:28.008Z",
"settlementTotals": {
"change": 1,
"remaining": 1,
"remainingRounded": 1,
"totals": 1,
"remainingPrePayment": 1
},
"settlements": [
{
"amount": 1,
"createdAt": "2025-07-30T18:10:28.008Z",
"displayMessages": [
{
"key": "text",
"message": "text",
"timestamp": "2025-07-30T18:10:28.008Z"
}
],
"externalId": "text",
"externalPaymentReference": "text",
"idMethod": "NO_CVM_RULE_PERFORMED",
"lastModifiedAt": "2025-07-30T18:10:28.008Z",
"ledgerNumber": "text",
"ledgerType": "LEDGER",
"parameters": [
{
"key": "text",
"value": "text"
}
],
"settledAt": "2025-07-30T18:10:28.008Z",
"settlementCode": "text",
"settlementUid": "text",
"settlementName": "text",
"state": "NOT_STARTED",
"status": "NEW",
"storeSettlementIssuerUid": "text",
"tenantUserDisplayName": "text",
"tenantUserUid": "text",
"storePaymentMethodUid": "text",
"currency": {
"amount": 1,
"code": "text",
"exchangeRate": 1
},
"additionalDetails": [
{
"key": "text",
"value": "text"
}
],
"paymentCount": 1,
"paymentAmount": 1,
"orderReceiptUid": "text"
}
],
"storeUid": "text",
"storeName": "text",
"systemOrigin": "text",
"tenantUserDisplayName": "text",
"tenantUserUid": "text",
"tillUid": "text",
"type": "OFFER",
"validUntil": "2025-07-30T18:10:28.008Z",
"vatFree": true,
"vatPrint": "SUM",
"voucherNumber": "text",
"deliveryDate": "2025-07-30",
"discounts": [
{
"orderDiscountUid": "text",
"discountCode": "text",
"type": "PERCENTAGE",
"amount": 1,
"name": "text",
"origin": "LOYALTY",
"validTo": "2025-07-30T18:10:28.008Z",
"maxUsage": 1,
"productSkus": [
"text"
],
"orderItemUids": [
"text"
],
"externalTransactionId": "text",
"scope": "WHOLE_ORDER",
"discountReasonCode": "text",
"createdAt": "2025-07-30T18:10:28.008Z",
"createdBy": "text",
"lastModifiedAt": "2025-07-30T18:10:28.008Z",
"lastModifiedBy": "text",
"campaignUid": "text"
}
],
"compensationReasonUid": "text",
"lastModifiedBy": "text"
}
],
"paging": {
"pageNumber": 1,
"pageSize": 1,
"totalCount": 1
}
}Create sales order for a service-order.
Authorizations
Path parameters
tenantUidstringRequiredPattern:
Reference to a tenant.
^[A-Za-z0-9-_]+storeUidstringRequiredPattern:
Reference to a Store.
^[A-Za-z0-9-_]+serviceOrderUidstringRequiredPattern:
Reference to a service order
^[A-Za-z0-9-_]+Body
sellerStoreUidstringRequiredPattern:
^[A-Za-z0-9-_]+salesOrderUidstringOptionalPattern:
^[A-Za-z0-9-_]*Responses
201
Example response
application/json
post
POST /v2/tenants/{tenantUid}/stores/{storeUid}/serviceorders/{serviceOrderUid}/orders HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 48
{
"sellerStoreUid": "text",
"salesOrderUid": "text"
}201
Example response
{
"shippingAddress": {
"address": "text",
"city": "text",
"companyName": "text",
"countryCode": "text",
"email": "text",
"firstname": "text",
"lastname": "text",
"mobile": "text",
"postalCode": "text",
"vatNumber": "text",
"displayName": "text"
},
"createdAt": "2025-07-30T18:10:28.008Z",
"customerAddress": {
"address": "text",
"city": "text",
"companyName": "text",
"countryCode": "text",
"email": "text",
"firstname": "text",
"lastname": "text",
"mobile": "text",
"postalCode": "text",
"vatNumber": "text",
"displayName": "text"
},
"customerUid": "text",
"customerContact": {
"customerContactUid": "text",
"firstname": "text",
"lastname": "text",
"email": "text",
"mobile": "text",
"displayName": "text"
},
"deliveryState": "NOT_STARTED",
"externalOrderNumber": "text",
"externalVoucherNumber": "text",
"invoiceAddress": {
"address": "text",
"city": "text",
"companyName": "text",
"countryCode": "text",
"email": "text",
"mobile": "text",
"firstname": "text",
"lastname": "text",
"postalCode": "text",
"displayName": "text",
"customerAddressUid": "text"
},
"items": [
{
"actions": [
{
"comment": "text",
"createdAt": "2025-07-30T18:10:28.008Z",
"createdBy": "text",
"handlingActionUid": "text",
"handlingActionName": "text",
"handlingDescription": "text",
"handlingUid": "text",
"handlingName": "text",
"lastModifiedAt": "2025-07-30T18:10:28.008Z",
"lastModifiedBy": "text",
"orderHandlingActionUid": "text"
}
],
"allowedActions": [
"QUANTITY_SOLD"
],
"createdAt": "2025-07-30T18:10:28.008Z",
"discountReasonCode": "text",
"externalId": "text",
"itemCost": 1,
"itemDiscountAmount": 1,
"itemDiscountPercentage": 1,
"itemGrossProfitAmount": 1,
"itemGrossProfitPercentage": 1,
"itemPrice": 1,
"itemVatAmount": 1,
"lastModifiedAt": "2025-07-30T18:10:28.008Z",
"ledgerNumber": "text",
"name": "text",
"note": "text",
"orderItemUid": "text",
"orderLinks": [
{
"orderUid": "text",
"orderItemUid": "text",
"orderNumber": "text",
"storeUid": "text",
"type": "CREDIT"
}
],
"originalItemPrice": 1,
"productUid": "text",
"productType": "STOCK",
"properties": [
{
"uid": "text",
"key": "text",
"value": "text"
}
],
"quantityCredited": 1,
"quantityDelivered": 1,
"quantityOrdered": 1,
"quantityReserved": 1,
"returnReasonCode": "text",
"serialnumber": "text",
"sku": "text",
"sortOrder": 1,
"tenantUserDisplayName": "text",
"tenantUserUid": "text",
"totalCost": 1,
"totalDiscountAmount": 1,
"totalGrossProfitAmount": 1,
"totalPrice": 1,
"totalVatAmount": 1,
"vatCodeUid": "text",
"warehouseUid": "text",
"warehouseName": "text",
"internalInfo": "text",
"productProperties": [
{
"productPropertyUid": "text",
"propertyName": "text",
"propertyOptionName": "text",
"propertyType": "TEXT",
"propertyText": "text",
"propertyUid": "text",
"propertyOptionUid": "text",
"required": true
}
],
"coverImage": {
"productMediaUid": "text",
"mainUrl": "text",
"thumbnailUrl": "text"
},
"deliveryUid": "text",
"compensationReasonCode": "text",
"orderReceiptUid": "text",
"allowDeliveryFromDate": "2025-07-30T18:10:28.008Z",
"reservationType": "NONE",
"reservationDetails": {
"warehouse": {
"warehouseName": "text"
},
"purchaseOrder": {
"purchaseOrderUid": "text",
"purchaseOrderItemUid": "text",
"expectedDeliveryDate": "2025-07-30T18:10:28.008Z",
"purchaseOrderNumber": "text",
"quantityOrdered": 1
}
}
}
],
"lastModifiedAt": "2025-07-30T18:10:28.008Z",
"note": "text",
"orderUid": "text",
"orderNumber": "text",
"orderState": "OPEN",
"orderTotals": {
"costTotal": 1,
"grandTotal": 1,
"grossProfitAmount": 1,
"grossProfitPercentage": 1,
"specifiedVat": [
{
"vatAmount": 1,
"vatDescription": "text",
"vatRate": 1
}
],
"subtotal": 1,
"totalDiscount": 1,
"totalVat": 1
},
"orderhandlingState": "NOT_STARTED",
"orderhandlings": [
{
"active": true,
"createdAt": "2025-07-30T18:10:28.008Z",
"createdBy": "text",
"description": "text",
"handlingUid": "text",
"lastModifiedAt": "2025-07-30T18:10:28.008Z",
"lastModifiedBy": "text",
"name": "text",
"orderHandlingUid": "text",
"state": "NOT_STARTED"
}
],
"settleState": "NOT_STARTED",
"settledAt": "2025-07-30T18:10:28.008Z",
"settlementTotals": {
"change": 1,
"remaining": 1,
"remainingRounded": 1,
"totals": 1,
"remainingPrePayment": 1
},
"settlements": [
{
"amount": 1,
"createdAt": "2025-07-30T18:10:28.008Z",
"displayMessages": [
{
"key": "text",
"message": "text",
"timestamp": "2025-07-30T18:10:28.008Z"
}
],
"externalId": "text",
"externalPaymentReference": "text",
"idMethod": "NO_CVM_RULE_PERFORMED",
"lastModifiedAt": "2025-07-30T18:10:28.008Z",
"ledgerNumber": "text",
"ledgerType": "LEDGER",
"parameters": [
{
"key": "text",
"value": "text"
}
],
"settledAt": "2025-07-30T18:10:28.008Z",
"settlementCode": "text",
"settlementUid": "text",
"settlementName": "text",
"state": "NOT_STARTED",
"status": "NEW",
"storeSettlementIssuerUid": "text",
"tenantUserDisplayName": "text",
"tenantUserUid": "text",
"storePaymentMethodUid": "text",
"currency": {
"amount": 1,
"code": "text",
"exchangeRate": 1
},
"additionalDetails": [
{
"key": "text",
"value": "text"
}
],
"paymentCount": 1,
"paymentAmount": 1,
"orderReceiptUid": "text"
}
],
"storeUid": "text",
"storeName": "text",
"systemOrigin": "text",
"tenantUserDisplayName": "text",
"tenantUserUid": "text",
"tillUid": "text",
"type": "OFFER",
"validUntil": "2025-07-30T18:10:28.008Z",
"vatFree": true,
"vatPrint": "SUM",
"voucherNumber": "text",
"deliveryDate": "2025-07-30",
"discounts": [
{
"orderDiscountUid": "text",
"discountCode": "text",
"type": "PERCENTAGE",
"amount": 1,
"name": "text",
"origin": "LOYALTY",
"validTo": "2025-07-30T18:10:28.008Z",
"maxUsage": 1,
"productSkus": [
"text"
],
"orderItemUids": [
"text"
],
"externalTransactionId": "text",
"scope": "WHOLE_ORDER",
"discountReasonCode": "text",
"createdAt": "2025-07-30T18:10:28.008Z",
"createdBy": "text",
"lastModifiedAt": "2025-07-30T18:10:28.008Z",
"lastModifiedBy": "text",
"campaignUid": "text"
}
],
"compensationReasonUid": "text",
"lastModifiedBy": "text"
}Get reports for service-orders.
Authorizations
Path parameters
tenantUidstringRequiredPattern:
Reference to a tenant.
^[A-Za-z0-9-_]+storeUidstringRequiredPattern:
Reference to a Store.
^[A-Za-z0-9-_]+serviceOrderUidstringRequiredPattern:
Reference to a service order
^[A-Za-z0-9-_]+Responses
200
Based on the Accept header the response will be base64 json encoded or a raw file.
application/octet-stream will return a binary file
application/json will return a json with the file content base64 encoded.
get
GET /v2/tenants/{tenantUid}/stores/{storeUid}/serviceorders/{serviceOrderUid}/reports HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200
Based on the Accept header the response will be base64 json encoded or a raw file. application/octet-stream will return a binary file application/json will return a json with the file content base64 encoded.
{
"content": "text",
"contentType": "text",
"filename": "text"
}Search for service orders is case insensitive and you can use partial values, e.g. name 'Anna' will return both 'Anna' and 'Johanna'. Use the query to search for customer, service number or title from only one field. When this is used, the customer and service search fields are ignored. The array fields work like filters.
Authorizations
Path parameters
tenantUidstringRequiredPattern:
Reference to a tenant.
^[A-Za-z0-9-_]+storeUidstringRequiredPattern:
Reference to a Store.
^[A-Za-z0-9-_]+Query parameters
pageNumberintegerOptional
Reference to a specific page in a result set.
pageSizeintegerOptional
The number of items per page in a result set.
sortBystringOptional
Defines which field the resource list is sorted by.
sortDirectionstring · enumOptional
Possible values:
| ENUM | Description |
|---|---|
| ASC | Sort in ascending order |
| DESC | Sort in descending order |
Body
customerNamestringOptional
customerMobilestringOptional
customerEmailstringOptional
titlestringOptional
serviceNumberstringOptional
querystringOptional
Search on customer, service number and title in one.
fromCreatedDatestring · dateOptional
GTE date, e.g. 2006-05-04
toCreatedDatestring · dateOptional
LTE date, e.g. 2006-05-04
assignedUserUidsstring[]Optional
createdFromStoreUidsstring[]Optional
serviceTypeUidsstring[]Optional
Responses
200
Example response
application/json
post
POST /v2/tenants/{tenantUid}/stores/{storeUid}/serviceorders/search HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 324
{
"customerName": "text",
"customerMobile": "text",
"customerEmail": "text",
"title": "text",
"serviceNumber": "text",
"query": "text",
"fromCreatedDate": "2025-07-30",
"toCreatedDate": "2025-07-30",
"assignedUserUids": [
"text"
],
"createdFromStoreUids": [
"text"
],
"priorities": [
"NONE"
],
"serviceStates": [
"NOT_STARTED"
],
"serviceTypeUids": [
"text"
]
}200
Example response
{
"items": [
{
"serviceOrderUid": "text",
"tenantUid": "text",
"storeUid": "text",
"orderProductLineUid": "text",
"orderUid": "text",
"customerUid": "text",
"createdFromStoreUid": "text",
"assignedUserUid": "text",
"assignedUserDisplayName": "text",
"serviceTypeUid": "text",
"serviceTypeName": "text",
"serviceStatusUid": "text",
"serviceStatusName": "text",
"serviceState": "NOT_STARTED",
"title": "text",
"serviceNumber": "text",
"externalServiceNumber": "text",
"description": "text",
"locationLabel": "text",
"priority": "NONE",
"requiresPriceEstimate": true,
"estimatedPrice": 1,
"maxPrice": 1,
"readyAtEstimate": "2025-07-30T18:10:28.008Z",
"readyAtNeeded": "2025-07-30T18:10:28.008Z",
"publicPageHash": "text",
"warranty": true,
"createdAt": "2025-07-30T18:10:28.008Z",
"createdBy": "text",
"lastModifiedAt": "2025-07-30T18:10:28.008Z",
"lastModifiedBy": "text",
"totals": {
"grandTotal": 1,
"partsTotal": 1,
"workTotal": 1
},
"items": [
{
"serviceOrderItemUid": "text",
"serviceOrderUid": "text",
"warehouseUid": "text",
"tenantUserUid": "text",
"productUid": "text",
"salesOrderUid": "text",
"quantity": 1,
"name": "text",
"sku": "text",
"price": 1,
"costPrice": 1,
"originalPrice": 1,
"totalPrice": 1,
"totalCostPrice": 1,
"serialNumber": "text",
"note": "text",
"tenantUserDisplayName": "text",
"createdAt": "2025-07-30T18:10:28.008Z",
"createdBy": "text",
"lastModifiedAt": "2025-07-30T18:10:28.008Z",
"lastModifiedBy": "text"
}
],
"assets": [
{
"assetUid": "text",
"name": "text",
"description": "text",
"isPublic": true,
"publicUrl": "text",
"mimeType": "text"
}
]
}
],
"paging": {
"pageNumber": 1,
"pageSize": 1,
"totalCount": 1
}
}List hourly rates.
Authorizations
Path parameters
tenantUidstringRequiredPattern:
Reference to a tenant.
^[A-Za-z0-9-_]+Query parameters
pageNumberintegerOptional
Reference to a specific page in a result set.
pageSizeintegerOptional
The number of items per page in a result set.
Responses
200
Example response
application/json
get
GET /v2/tenants/{tenantUid}/hourlyrates HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200
Example response
{
"items": [
{
"hourlyRateUid": "text",
"name": "text",
"price": 1,
"createdAt": "2025-07-30T18:10:28.008Z",
"createdBy": "text",
"lastModifiedAt": "2025-07-30T18:10:28.008Z",
"lastModifiedBy": "text"
}
],
"paging": {
"pageNumber": 1,
"pageSize": 1,
"totalCount": 1
}
}Create a new hourly rate.
Authorizations
Path parameters
tenantUidstringRequiredPattern:
Reference to a tenant.
^[A-Za-z0-9-_]+Body
hourlyRateUidstringOptionalPattern:
^[A-Za-z0-9-_]*namestringRequired
priceintegerRequired
Responses
201
Example response
application/json
post
POST /v2/tenants/{tenantUid}/hourlyrates HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 48
{
"hourlyRateUid": "text",
"name": "text",
"price": 1
}201
Example response
{
"hourlyRateUid": "text",
"name": "text",
"price": 1,
"createdAt": "2025-07-30T18:10:28.008Z",
"createdBy": "text",
"lastModifiedAt": "2025-07-30T18:10:28.008Z",
"lastModifiedBy": "text"
}Get hourly rate.
Authorizations
Path parameters
tenantUidstringRequiredPattern:
Reference to a tenant.
^[A-Za-z0-9-_]+hourlyRateUidstringRequiredPattern:
Reference to a hourly rate.
^[A-Za-z0-9-_]+Responses
200
Example response
application/json
get
GET /v2/tenants/{tenantUid}/hourlyrates/{hourlyRateUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200
Example response
{
"hourlyRateUid": "text",
"name": "text",
"price": 1,
"createdAt": "2025-07-30T18:10:28.008Z",
"createdBy": "text",
"lastModifiedAt": "2025-07-30T18:10:28.008Z",
"lastModifiedBy": "text"
}Update hourly rate.
Authorizations
Path parameters
tenantUidstringRequiredPattern:
Reference to a tenant.
^[A-Za-z0-9-_]+hourlyRateUidstringRequiredPattern:
Reference to a hourly rate.
^[A-Za-z0-9-_]+Body
namestringOptional
priceintegerOptional
Responses
200
Example response
application/json
put
PUT /v2/tenants/{tenantUid}/hourlyrates/{hourlyRateUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 25
{
"name": "text",
"price": 1
}200
Example response
{
"hourlyRateUid": "text",
"name": "text",
"price": 1,
"createdAt": "2025-07-30T18:10:28.008Z",
"createdBy": "text",
"lastModifiedAt": "2025-07-30T18:10:28.008Z",
"lastModifiedBy": "text"
}Delete hourly rate.
Authorizations
Path parameters
tenantUidstringRequiredPattern:
Reference to a tenant.
^[A-Za-z0-9-_]+hourlyRateUidstringRequiredPattern:
Reference to a hourly rate.
^[A-Za-z0-9-_]+Responses
204
No Content
delete
DELETE /v2/tenants/{tenantUid}/hourlyrates/{hourlyRateUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
204
No Content
No content
Was this helpful?