Handling

Handling

List handlings

get

https://api.flowretail.com/v2https://api.stage.flowretail.com/v2

/tenants/{tenantUid}/handlings

List all order handlings

Authorizations

accessTokenauthTokenintegrationToken

Path parameters

tenantUidstringRequired

Reference to a tenant.

Pattern: ^[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

ENUM	Description
ASC	Sort in ascending order
DESC	Sort in descending order

Possible values:

Responses

200

Example response

application/json

get

/tenants/{tenantUid}/handlings

HTTPcURLJavaScriptPython

GET /v2/tenants/{tenantUid}/handlings HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Example response

{
  "items": [
    {
      "active": true,
      "createdAt": "2025-10-30T21:07:16.103Z",
      "createdBy": "text",
      "description": "text",
      "handlingUid": "text",
      "lastModifiedAt": "2025-10-30T21:07:16.103Z",
      "lastModifiedBy": "text",
      "name": "text",
      "triggers": [
        {
          "active": true,
          "trigger": "AUTO_PRINT_PICKUP_LABEL",
          "state": "NOT_STARTED",
          "value": "text",
          "handlingTriggerUid": "text"
        }
      ]
    }
  ],
  "paging": {
    "pageNumber": 1,
    "pageSize": 1,
    "totalCount": 1
  }
}

Create a new handling

post

https://api.flowretail.com/v2https://api.stage.flowretail.com/v2

/tenants/{tenantUid}/handlings

Create a new order handling.

Required permission: TENANT.ACCESS

Authorizations

accessTokenauthTokenintegrationToken

Path parameters

tenantUidstringRequired

Reference to a tenant.

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

Body

application/json

all ofOptional

Responses

201

Example response

application/json

post

/tenants/{tenantUid}/handlings

HTTPcURLJavaScriptPython

POST /v2/tenants/{tenantUid}/handlings HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 71

{
  "handlingUid": "text",
  "active": true,
  "description": "text",
  "name": "text"
}

201

Example response

{
  "active": true,
  "createdAt": "2025-10-30T21:07:16.103Z",
  "createdBy": "text",
  "description": "text",
  "handlingUid": "text",
  "lastModifiedAt": "2025-10-30T21:07:16.103Z",
  "lastModifiedBy": "text",
  "name": "text",
  "triggers": [
    {
      "active": true,
      "trigger": "AUTO_PRINT_PICKUP_LABEL",
      "state": "NOT_STARTED",
      "value": "text",
      "handlingTriggerUid": "text"
    }
  ]
}

Get handling details

get

https://api.flowretail.com/v2https://api.stage.flowretail.com/v2

/tenants/{tenantUid}/handlings/{handlingUid}

Get handling details

Authorizations

accessTokenauthTokenintegrationToken

Path parameters

tenantUidstringRequired

Reference to a tenant.

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

handlingUidstringRequired

Reference to an handling id.

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

Responses

200

Example response

application/json

get

/tenants/{tenantUid}/handlings/{handlingUid}

HTTPcURLJavaScriptPython

GET /v2/tenants/{tenantUid}/handlings/{handlingUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Example response

{
  "active": true,
  "createdAt": "2025-10-30T21:07:16.103Z",
  "createdBy": "text",
  "description": "text",
  "handlingUid": "text",
  "lastModifiedAt": "2025-10-30T21:07:16.103Z",
  "lastModifiedBy": "text",
  "name": "text",
  "triggers": [
    {
      "active": true,
      "trigger": "AUTO_PRINT_PICKUP_LABEL",
      "state": "NOT_STARTED",
      "value": "text",
      "handlingTriggerUid": "text"
    }
  ]
}

Update handling details

put

https://api.flowretail.com/v2https://api.stage.flowretail.com/v2

/tenants/{tenantUid}/handlings/{handlingUid}

Update handling details

Authorizations

accessTokenauthTokenintegrationToken

Path parameters

tenantUidstringRequired

Reference to a tenant.

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

handlingUidstringRequired

Reference to an handling id.

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

Body

application/json

Request for creating or updating an orderhandling

activebooleanRequired

descriptionstringRequired

namestring · max: 20Required

Responses

200

Example response

application/json

put

/tenants/{tenantUid}/handlings/{handlingUid}

HTTPcURLJavaScriptPython

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: 50

{
  "active": true,
  "description": "text",
  "name": "text"
}

200

Example response

{
  "active": true,
  "createdAt": "2025-10-30T21:07:16.103Z",
  "createdBy": "text",
  "description": "text",
  "handlingUid": "text",
  "lastModifiedAt": "2025-10-30T21:07:16.103Z",
  "lastModifiedBy": "text",
  "name": "text",
  "triggers": [
    {
      "active": true,
      "trigger": "AUTO_PRINT_PICKUP_LABEL",
      "state": "NOT_STARTED",
      "value": "text",
      "handlingTriggerUid": "text"
    }
  ]
}

Delete an handling

delete

https://api.flowretail.com/v2https://api.stage.flowretail.com/v2

/tenants/{tenantUid}/handlings/{handlingUid}

Delete an handling

Authorizations

accessTokenauthTokenintegrationToken

Path parameters

tenantUidstringRequired

Reference to a tenant.

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

handlingUidstringRequired

Reference to an handling id.

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

Responses

204

No Content

No content

delete

/tenants/{tenantUid}/handlings/{handlingUid}

HTTPcURLJavaScriptPython

DELETE /v2/tenants/{tenantUid}/handlings/{handlingUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

204

No Content

No content

List handling triggers

get

https://api.flowretail.com/v2https://api.stage.flowretail.com/v2

/tenants/{tenantUid}/handlings/{handlingUid}/triggers

List handling triggers

Authorizations

accessTokenauthTokenintegrationToken

Path parameters

tenantUidstringRequired

Reference to a tenant.

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

handlingUidstringRequired

Reference to an handling id.

Pattern: ^[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

ENUM	Description
ASC	Sort in ascending order
DESC	Sort in descending order

Possible values:

Responses

200

Example response

application/json

get

/tenants/{tenantUid}/handlings/{handlingUid}/triggers

HTTPcURLJavaScriptPython

GET /v2/tenants/{tenantUid}/handlings/{handlingUid}/triggers HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Example response

{
  "items": [
    {
      "active": true,
      "trigger": "AUTO_PRINT_PICKUP_LABEL",
      "state": "NOT_STARTED",
      "value": "text",
      "handlingTriggerUid": "text"
    }
  ],
  "paging": {
    "pageNumber": 1,
    "pageSize": 1,
    "totalCount": 1
  }
}

Add a trigger to a handling

post

https://api.flowretail.com/v2https://api.stage.flowretail.com/v2

/tenants/{tenantUid}/handlings/{handlingUid}/triggers

Add a trigger to a handling

Authorizations

accessTokenauthTokenintegrationToken

Path parameters

tenantUidstringRequired

Reference to a tenant.

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

handlingUidstringRequired

Reference to an handling id.

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

Body

application/json

activebooleanRequired

triggerstring · enumRequired

ENUM	Description
AUTO_PRINT_PICKUP_LABEL	Auto-print pickup labels when order is parked or confirmed
SET_EXPIRY_DATE	Set expiry date on order

Possible values:

statestring · enumRequiredPossible values:

valuestringOptional

handlingTriggerUidstringOptionalPattern: ^[A-Za-z0-9-_]+

Responses

204

Example response

application/json

post

/tenants/{tenantUid}/handlings/{handlingUid}/triggers

HTTPcURLJavaScriptPython

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: 116

{
  "active": true,
  "trigger": "AUTO_PRINT_PICKUP_LABEL",
  "state": "NOT_STARTED",
  "value": "text",
  "handlingTriggerUid": "text"
}

204

Example response

{
  "active": true,
  "trigger": "AUTO_PRINT_PICKUP_LABEL",
  "state": "NOT_STARTED",
  "value": "text",
  "handlingTriggerUid": "text"
}

Get handling trigger details

get

https://api.flowretail.com/v2https://api.stage.flowretail.com/v2

/tenants/{tenantUid}/handlings/{handlingUid}/triggers/{handlingTriggerUid}

Get handling trigger details

Authorizations

accessTokenauthTokenintegrationToken

Path parameters

tenantUidstringRequired

Reference to a tenant.

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

handlingUidstringRequired

Reference to an handling id.

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

handlingTriggerUidstringRequired

Reference to a handlingTriggerUid

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

Responses

200

Example response

application/json

get

/tenants/{tenantUid}/handlings/{handlingUid}/triggers/{handlingTriggerUid}

HTTPcURLJavaScriptPython

GET /v2/tenants/{tenantUid}/handlings/{handlingUid}/triggers/{handlingTriggerUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Example response

{
  "active": true,
  "trigger": "AUTO_PRINT_PICKUP_LABEL",
  "state": "NOT_STARTED",
  "value": "text",
  "handlingTriggerUid": "text"
}

Update handling trigger details

put

https://api.flowretail.com/v2https://api.stage.flowretail.com/v2

/tenants/{tenantUid}/handlings/{handlingUid}/triggers/{handlingTriggerUid}

Update handling trigger details

Authorizations

accessTokenauthTokenintegrationToken

Path parameters

tenantUidstringRequired

Reference to a tenant.

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

handlingUidstringRequired

Reference to an handling id.

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

handlingTriggerUidstringRequired

Reference to a handlingTriggerUid

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

Body

application/json

activebooleanRequired

triggerstring · enumRequired

ENUM	Description
AUTO_PRINT_PICKUP_LABEL	Auto-print pickup labels when order is parked or confirmed
SET_EXPIRY_DATE	Set expiry date on order

Possible values:

statestring · enumRequiredPossible values:

valuestringOptional

handlingTriggerUidstringOptionalPattern: ^[A-Za-z0-9-_]+

Responses

204

Example response

application/json

put

/tenants/{tenantUid}/handlings/{handlingUid}/triggers/{handlingTriggerUid}

HTTPcURLJavaScriptPython

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: 116

{
  "active": true,
  "trigger": "AUTO_PRINT_PICKUP_LABEL",
  "state": "NOT_STARTED",
  "value": "text",
  "handlingTriggerUid": "text"
}

204

Example response

{
  "active": true,
  "trigger": "AUTO_PRINT_PICKUP_LABEL",
  "state": "NOT_STARTED",
  "value": "text",
  "handlingTriggerUid": "text"
}

Delete a handling trigger

delete

https://api.flowretail.com/v2https://api.stage.flowretail.com/v2

/tenants/{tenantUid}/handlings/{handlingUid}/triggers/{handlingTriggerUid}

Delete a handling trigger

Authorizations

accessTokenauthTokenintegrationToken

Path parameters

tenantUidstringRequired

Reference to a tenant.

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

handlingUidstringRequired

Reference to an handling id.

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

handlingTriggerUidstringRequired

Reference to a handlingTriggerUid

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

Responses

204

No Content

No content

delete

/tenants/{tenantUid}/handlings/{handlingUid}/triggers/{handlingTriggerUid}

HTTPcURLJavaScriptPython

DELETE /v2/tenants/{tenantUid}/handlings/{handlingUid}/triggers/{handlingTriggerUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

204

No Content

No content

List Handling actions

get

https://api.flowretail.com/v2https://api.stage.flowretail.com/v2

/tenants/{tenantUid}/handlings/{handlingUid}/actions

List Handling actions

Authorizations

accessTokenauthTokenintegrationToken

Path parameters

tenantUidstringRequired

Reference to a tenant.

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

handlingUidstringRequired

Reference to an handling id.

Pattern: ^[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

ENUM	Description
ASC	Sort in ascending order
DESC	Sort in descending order

Possible values:

handlingActionStoreUidstringOptional

Reference to a store uid.

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

Responses

200

Example response

application/json

get

/tenants/{tenantUid}/handlings/{handlingUid}/actions

HTTPcURLJavaScriptPython

GET /v2/tenants/{tenantUid}/handlings/{handlingUid}/actions HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Example response

{
  "items": [
    {
      "active": true,
      "allowComment": true,
      "name": "text",
      "storeUid": "text",
      "createdAt": "2025-10-30T21:07:16.103Z",
      "createdBy": "text",
      "handlingActionUid": "text",
      "lastModifiedAt": "2025-10-30T21:07:16.103Z",
      "lastModifiedBy": "text"
    }
  ],
  "paging": {
    "pageNumber": 1,
    "pageSize": 1,
    "totalCount": 1
  }
}

Create new handling action

post

https://api.flowretail.com/v2https://api.stage.flowretail.com/v2

/tenants/{tenantUid}/handlings/{handlingUid}/actions

Create new handling action

Authorizations

accessTokenauthTokenintegrationToken

Path parameters

tenantUidstringRequired

Reference to a tenant.

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

handlingUidstringRequired

Reference to an handling id.

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

Body

application/json

handlingActionUidstringOptionalPattern: ^[A-Za-z0-9-_]+

activebooleanRequired

allowCommentbooleanRequired

namestring · max: 20Required

storeUidstringOptionalPattern: ^[A-Za-z0-9-_]+

Responses

200

Example response

application/json

Responseall of

post

/tenants/{tenantUid}/handlings/{handlingUid}/actions

HTTPcURLJavaScriptPython

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"
}

200

Example response

{
  "active": true,
  "allowComment": true,
  "name": "text",
  "storeUid": "text",
  "createdAt": "2025-10-30T21:07:16.103Z",
  "createdBy": "text",
  "handlingActionUid": "text",
  "lastModifiedAt": "2025-10-30T21:07:16.103Z",
  "lastModifiedBy": "text"
}

Get handling action details

get

https://api.flowretail.com/v2https://api.stage.flowretail.com/v2

/tenants/{tenantUid}/handlings/{handlingUid}/actions/{handlingActionUid}

Get handling action details

Authorizations

accessTokenauthTokenintegrationToken

Path parameters

tenantUidstringRequired

Reference to a tenant.

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

handlingUidstringRequired

Reference to an handling id.

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

handlingActionUidstringRequired

Reference to an handling action id.

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

Responses

200

Example response

application/json

Responseall of

get

/tenants/{tenantUid}/handlings/{handlingUid}/actions/{handlingActionUid}

HTTPcURLJavaScriptPython

GET /v2/tenants/{tenantUid}/handlings/{handlingUid}/actions/{handlingActionUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Example response

{
  "active": true,
  "allowComment": true,
  "name": "text",
  "storeUid": "text",
  "createdAt": "2025-10-30T21:07:16.103Z",
  "createdBy": "text",
  "handlingActionUid": "text",
  "lastModifiedAt": "2025-10-30T21:07:16.103Z",
  "lastModifiedBy": "text"
}

Update a handling action

put

https://api.flowretail.com/v2https://api.stage.flowretail.com/v2

/tenants/{tenantUid}/handlings/{handlingUid}/actions/{handlingActionUid}

Update a handling action

Required permission: TENANT.ADMIN

Authorizations

accessTokenauthTokenintegrationToken

Path parameters

tenantUidstringRequired

Reference to a tenant.

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

handlingUidstringRequired

Reference to an handling id.

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

handlingActionUidstringRequired

Reference to an handling action id.

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

Body

application/json

activebooleanRequired

allowCommentbooleanRequired

namestring · max: 20Required

storeUidstringOptionalPattern: ^[A-Za-z0-9-_]*

Responses

200

Example response

application/json

Responseall of

put

/tenants/{tenantUid}/handlings/{handlingUid}/actions/{handlingActionUid}

HTTPcURLJavaScriptPython

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"
}

200

Example response

{
  "active": true,
  "allowComment": true,
  "name": "text",
  "storeUid": "text",
  "createdAt": "2025-10-30T21:07:16.103Z",
  "createdBy": "text",
  "handlingActionUid": "text",
  "lastModifiedAt": "2025-10-30T21:07:16.103Z",
  "lastModifiedBy": "text"
}

Delete a handling action

delete

https://api.flowretail.com/v2https://api.stage.flowretail.com/v2

/tenants/{tenantUid}/handlings/{handlingUid}/actions/{handlingActionUid}

Delete a handling action

Authorizations

accessTokenauthTokenintegrationToken

Path parameters

tenantUidstringRequired

Reference to a tenant.

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

handlingUidstringRequired

Reference to an handling id.

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

handlingActionUidstringRequired

Reference to an handling action id.

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

Responses

204

No Content

No content

delete

/tenants/{tenantUid}/handlings/{handlingUid}/actions/{handlingActionUid}

HTTPcURLJavaScriptPython

DELETE /v2/tenants/{tenantUid}/handlings/{handlingUid}/actions/{handlingActionUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

204

No Content

No content