Handling
Handling
List all order handlings
Access token recevied after user login with a deviceToken
Reference to a tenant.
^[A-Za-z0-9-_]+Reference to a specific page in a result set.
The number of items per page in a result set.
Defines which field the resource list is sorted by.
| ENUM | Description |
|---|---|
| ASC | Sort in ascending order |
| DESC | Sort in descending order |
Example response
GET /v2/tenants/{tenantUid}/handlings HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
Example response
{
"items": [
{
"active": true,
"createdAt": "2026-01-01T00:00:00.000Z",
"createdBy": "text",
"description": "text",
"handlingUid": "text",
"lastModifiedAt": "2026-01-01T00:00:00.000Z",
"lastModifiedBy": "text",
"name": "text",
"triggers": [
{
"active": true,
"trigger": "AUTO_PRINT_PICKUP_LABELS",
"state": "NOT_STARTED",
"value": "text",
"handlingTriggerUid": "text"
}
],
"requireSerialnumberForComplete": true,
"templateUidForComplete": "text"
}
],
"paging": {
"pageNumber": 1,
"pageSize": 1,
"totalCount": 1
}
}Create a new handling.
Required permissions: HANDLING
Access token recevied after user login with a deviceToken
Reference to a tenant.
^[A-Za-z0-9-_]+Request for creating or updating an orderhandling
^[A-Za-z0-9-_]+^[A-Za-z0-9-_]*Example response
^[A-Za-z0-9-_]+All products that require serialnumber must have a serial number set before this handling can be set to COMPLETE
^[A-Za-z0-9-_]*POST /v2/tenants/{tenantUid}/handlings HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 141
{
"handlingUid": "text",
"active": true,
"description": "text",
"name": "text",
"requireSerialnumberForComplete": true,
"templateUidForComplete": "text"
}Example response
{
"active": true,
"createdAt": "2026-01-01T00:00:00.000Z",
"createdBy": "text",
"description": "text",
"handlingUid": "text",
"lastModifiedAt": "2026-01-01T00:00:00.000Z",
"lastModifiedBy": "text",
"name": "text",
"triggers": [
{
"active": true,
"trigger": "AUTO_PRINT_PICKUP_LABELS",
"state": "NOT_STARTED",
"value": "text",
"handlingTriggerUid": "text"
}
],
"requireSerialnumberForComplete": true,
"templateUidForComplete": "text"
}Get handling details
Access token recevied after user login with a deviceToken
Reference to a tenant.
^[A-Za-z0-9-_]+Reference to an handling id.
^[A-Za-z0-9-_]+Example response
^[A-Za-z0-9-_]+All products that require serialnumber must have a serial number set before this handling can be set to COMPLETE
^[A-Za-z0-9-_]*GET /v2/tenants/{tenantUid}/handlings/{handlingUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
Example response
{
"active": true,
"createdAt": "2026-01-01T00:00:00.000Z",
"createdBy": "text",
"description": "text",
"handlingUid": "text",
"lastModifiedAt": "2026-01-01T00:00:00.000Z",
"lastModifiedBy": "text",
"name": "text",
"triggers": [
{
"active": true,
"trigger": "AUTO_PRINT_PICKUP_LABELS",
"state": "NOT_STARTED",
"value": "text",
"handlingTriggerUid": "text"
}
],
"requireSerialnumberForComplete": true,
"templateUidForComplete": "text"
}Update handling details
Required permissions: HANDLING
Access token recevied after user login with a deviceToken
Reference to a tenant.
^[A-Za-z0-9-_]+Reference to an handling id.
^[A-Za-z0-9-_]+Request for creating or updating an orderhandling
^[A-Za-z0-9-_]*Example response
^[A-Za-z0-9-_]+All products that require serialnumber must have a serial number set before this handling can be set to COMPLETE
^[A-Za-z0-9-_]*PUT /v2/tenants/{tenantUid}/handlings/{handlingUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 120
{
"active": true,
"description": "text",
"name": "text",
"requireSerialnumberForComplete": true,
"templateUidForComplete": "text"
}Example response
{
"active": true,
"createdAt": "2026-01-01T00:00:00.000Z",
"createdBy": "text",
"description": "text",
"handlingUid": "text",
"lastModifiedAt": "2026-01-01T00:00:00.000Z",
"lastModifiedBy": "text",
"name": "text",
"triggers": [
{
"active": true,
"trigger": "AUTO_PRINT_PICKUP_LABELS",
"state": "NOT_STARTED",
"value": "text",
"handlingTriggerUid": "text"
}
],
"requireSerialnumberForComplete": true,
"templateUidForComplete": "text"
}Delete a handling
Required permissions: HANDLING
Access token recevied after user login with a deviceToken
Reference to a tenant.
^[A-Za-z0-9-_]+Reference to an handling id.
^[A-Za-z0-9-_]+No Content
No content
DELETE /v2/tenants/{tenantUid}/handlings/{handlingUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
No Content
No content
List handling triggers
Access token recevied after user login with a deviceToken
Reference to a tenant.
^[A-Za-z0-9-_]+Reference to an handling id.
^[A-Za-z0-9-_]+Reference to a specific page in a result set.
The number of items per page in a result set.
Defines which field the resource list is sorted by.
| ENUM | Description |
|---|---|
| ASC | Sort in ascending order |
| DESC | Sort in descending order |
Example response
GET /v2/tenants/{tenantUid}/handlings/{handlingUid}/triggers HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
Example response
{
"items": [
{
"active": true,
"trigger": "AUTO_PRINT_PICKUP_LABELS",
"state": "NOT_STARTED",
"value": "text",
"handlingTriggerUid": "text"
}
],
"paging": {
"pageNumber": 1,
"pageSize": 1,
"totalCount": 1
}
}Add a trigger to a handling
Required permissions: HANDLING
Access token recevied after user login with a deviceToken
Reference to a tenant.
^[A-Za-z0-9-_]+Reference to an handling id.
^[A-Za-z0-9-_]+| ENUM | Description |
|---|---|
| AUTO_PRINT_PICKUP_LABELS | Auto-print pickup labels when order is parked or confirmed |
| SET_EXPIRY_DATE | Set expiry date on order |
| ENUM | Description |
|---|---|
| NOT_STARTED | Handling has not been started. |
| IN_PROGRESS | Handling is in progress. |
| ON_HOLD | Handling is paused (on hold). |
| COMPLETE | Handling is complete. |
^[A-Za-z0-9-_]+Example response
| ENUM | Description |
|---|---|
| AUTO_PRINT_PICKUP_LABELS | Auto-print pickup labels when order is parked or confirmed |
| SET_EXPIRY_DATE | Set expiry date on order |
| ENUM | Description |
|---|---|
| NOT_STARTED | Handling has not been started. |
| IN_PROGRESS | Handling is in progress. |
| ON_HOLD | Handling is paused (on hold). |
| COMPLETE | Handling is complete. |
^[A-Za-z0-9-_]+POST /v2/tenants/{tenantUid}/handlings/{handlingUid}/triggers HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 117
{
"active": true,
"trigger": "AUTO_PRINT_PICKUP_LABELS",
"state": "NOT_STARTED",
"value": "text",
"handlingTriggerUid": "text"
}Example response
{
"active": true,
"trigger": "AUTO_PRINT_PICKUP_LABELS",
"state": "NOT_STARTED",
"value": "text",
"handlingTriggerUid": "text"
}Get handling trigger details
Get handling trigger details
Access token recevied after user login with a deviceToken
Reference to a tenant.
^[A-Za-z0-9-_]+Reference to an handling id.
^[A-Za-z0-9-_]+Reference to a handlingTriggerUid
^[A-Za-z0-9-_]+Example response
| ENUM | Description |
|---|---|
| AUTO_PRINT_PICKUP_LABELS | Auto-print pickup labels when order is parked or confirmed |
| SET_EXPIRY_DATE | Set expiry date on order |
| ENUM | Description |
|---|---|
| NOT_STARTED | Handling has not been started. |
| IN_PROGRESS | Handling is in progress. |
| ON_HOLD | Handling is paused (on hold). |
| COMPLETE | Handling is complete. |
^[A-Za-z0-9-_]+GET /v2/tenants/{tenantUid}/handlings/{handlingUid}/triggers/{handlingTriggerUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
Example response
{
"active": true,
"trigger": "AUTO_PRINT_PICKUP_LABELS",
"state": "NOT_STARTED",
"value": "text",
"handlingTriggerUid": "text"
}Update handling trigger details
Update handling trigger details
Required permissions: HANDLING
Access token recevied after user login with a deviceToken
Reference to a tenant.
^[A-Za-z0-9-_]+Reference to an handling id.
^[A-Za-z0-9-_]+Reference to a handlingTriggerUid
^[A-Za-z0-9-_]+| ENUM | Description |
|---|---|
| AUTO_PRINT_PICKUP_LABELS | Auto-print pickup labels when order is parked or confirmed |
| SET_EXPIRY_DATE | Set expiry date on order |
| ENUM | Description |
|---|---|
| NOT_STARTED | Handling has not been started. |
| IN_PROGRESS | Handling is in progress. |
| ON_HOLD | Handling is paused (on hold). |
| COMPLETE | Handling is complete. |
^[A-Za-z0-9-_]+Example response
| ENUM | Description |
|---|---|
| AUTO_PRINT_PICKUP_LABELS | Auto-print pickup labels when order is parked or confirmed |
| SET_EXPIRY_DATE | Set expiry date on order |
| ENUM | Description |
|---|---|
| NOT_STARTED | Handling has not been started. |
| IN_PROGRESS | Handling is in progress. |
| ON_HOLD | Handling is paused (on hold). |
| COMPLETE | Handling is complete. |
^[A-Za-z0-9-_]+PUT /v2/tenants/{tenantUid}/handlings/{handlingUid}/triggers/{handlingTriggerUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 117
{
"active": true,
"trigger": "AUTO_PRINT_PICKUP_LABELS",
"state": "NOT_STARTED",
"value": "text",
"handlingTriggerUid": "text"
}Example response
{
"active": true,
"trigger": "AUTO_PRINT_PICKUP_LABELS",
"state": "NOT_STARTED",
"value": "text",
"handlingTriggerUid": "text"
}Delete a handling trigger
Delete a handling trigger
Required permissions: HANDLING
Access token recevied after user login with a deviceToken
Reference to a tenant.
^[A-Za-z0-9-_]+Reference to an handling id.
^[A-Za-z0-9-_]+Reference to a handlingTriggerUid
^[A-Za-z0-9-_]+No Content
No content
DELETE /v2/tenants/{tenantUid}/handlings/{handlingUid}/triggers/{handlingTriggerUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
No Content
No content
List Handling actions
Access token recevied after user login with a deviceToken
Reference to a tenant.
^[A-Za-z0-9-_]+Reference to an handling id.
^[A-Za-z0-9-_]+Reference to a specific page in a result set.
The number of items per page in a result set.
Defines which field the resource list is sorted by.
| ENUM | Description |
|---|---|
| ASC | Sort in ascending order |
| DESC | Sort in descending order |
Reference to a store uid.
^[A-Za-z0-9-_]+Example response
GET /v2/tenants/{tenantUid}/handlings/{handlingUid}/actions HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
Example response
{
"items": [
{
"active": true,
"allowComment": true,
"name": "text",
"storeUid": "text",
"createdAt": "2026-01-01T00:00:00.000Z",
"createdBy": "text",
"handlingActionUid": "text",
"lastModifiedAt": "2026-01-01T00:00:00.000Z",
"lastModifiedBy": "text"
}
],
"paging": {
"pageNumber": 1,
"pageSize": 1,
"totalCount": 1
}
}Create new handling action
Required permissions: HANDLING
Access token recevied after user login with a deviceToken
Reference to a tenant.
^[A-Za-z0-9-_]+Reference to an handling id.
^[A-Za-z0-9-_]+^[A-Za-z0-9-_]+^[A-Za-z0-9-_]+Example response
^[A-Za-z0-9-_]*^[A-Za-z0-9-_]+POST /v2/tenants/{tenantUid}/handlings/{handlingUid}/actions HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 94
{
"handlingActionUid": "text",
"active": true,
"allowComment": true,
"name": "text",
"storeUid": "text"
}Example response
{
"active": true,
"allowComment": true,
"name": "text",
"storeUid": "text",
"createdAt": "2026-01-01T00:00:00.000Z",
"createdBy": "text",
"handlingActionUid": "text",
"lastModifiedAt": "2026-01-01T00:00:00.000Z",
"lastModifiedBy": "text"
}Get handling action details
Get handling action details
Access token recevied after user login with a deviceToken
Reference to a tenant.
^[A-Za-z0-9-_]+Reference to an handling id.
^[A-Za-z0-9-_]+Reference to an handling action id.
^[A-Za-z0-9-_]+Example response
^[A-Za-z0-9-_]*^[A-Za-z0-9-_]+GET /v2/tenants/{tenantUid}/handlings/{handlingUid}/actions/{handlingActionUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
Example response
{
"active": true,
"allowComment": true,
"name": "text",
"storeUid": "text",
"createdAt": "2026-01-01T00:00:00.000Z",
"createdBy": "text",
"handlingActionUid": "text",
"lastModifiedAt": "2026-01-01T00:00:00.000Z",
"lastModifiedBy": "text"
}Update a handling action
Required permissions: HANDLING
Access token recevied after user login with a deviceToken
Reference to a tenant.
^[A-Za-z0-9-_]+Reference to an handling id.
^[A-Za-z0-9-_]+Reference to an handling action id.
^[A-Za-z0-9-_]+^[A-Za-z0-9-_]*Example response
^[A-Za-z0-9-_]*^[A-Za-z0-9-_]+PUT /v2/tenants/{tenantUid}/handlings/{handlingUid}/actions/{handlingActionUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 67
{
"active": true,
"allowComment": true,
"name": "text",
"storeUid": "text"
}Example response
{
"active": true,
"allowComment": true,
"name": "text",
"storeUid": "text",
"createdAt": "2026-01-01T00:00:00.000Z",
"createdBy": "text",
"handlingActionUid": "text",
"lastModifiedAt": "2026-01-01T00:00:00.000Z",
"lastModifiedBy": "text"
}Delete a handling action
Delete a handling action
Required permissions: HANDLING
Access token recevied after user login with a deviceToken
Reference to a tenant.
^[A-Za-z0-9-_]+Reference to an handling id.
^[A-Za-z0-9-_]+Reference to an handling action id.
^[A-Za-z0-9-_]+No Content
No content
DELETE /v2/tenants/{tenantUid}/handlings/{handlingUid}/actions/{handlingActionUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
No Content
No content
Last updated