Handling

PreviousGiftcard NextImport

Was this helpful?

Get handling details

get

Get handling details

Authorizations

Path parameters

tenantUidstringrequired

Reference to a tenant.

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

handlingUidstringrequired

Reference to an handling id.

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

Responses

application/json

objectoptional

get

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-04-18T01:17:02.163Z",
  "createdBy": "text",
  "description": "text",
  "handlingUid": "text",
  "lastModifiedAt": "2025-04-18T01:17:02.163Z",
  "lastModifiedBy": "text",
  "name": "text",
  "triggers": [
    {
      "active": true,
      "trigger": "PUSHMESSAGE_ON_CREATE"
    }
  ]
}

Delete an handling

delete

Delete an handling

Authorizations

Path parameters

tenantUidstringrequired

Reference to a tenant.

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

handlingUidstringrequired

Reference to an handling id.

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

Responses

delete

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

204

No Content

List Handling actions

get

List Handling actions

Authorizations

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

Available options:

handlingActionStoreUidstringoptional

Reference to a store uid.

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

Responses

application/json

objectoptional

get

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-04-18T01:17:02.163Z",
      "createdBy": "text",
      "handlingActionUid": "text",
      "lastModifiedAt": "2025-04-18T01:17:02.163Z",
      "lastModifiedBy": "text"
    }
  ],
  "paging": {
    "pageNumber": 1,
    "pageSize": 1,
    "totalCount": 1
  }
}

Get handling action details

get

Get handling action details

Authorizations

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

application/json

all ofoptional

get

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-04-18T01:17:02.163Z",
  "createdBy": "text",
  "handlingActionUid": "text",
  "lastModifiedAt": "2025-04-18T01:17:02.163Z",
  "lastModifiedBy": "text"
}

Delete a handling action

delete

Delete a handling action

Authorizations

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

delete

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

204

No Content

List handlings

get

List all order handlings

Authorizations

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

Available options:

Responses

application/json

objectoptional

get

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-04-18T01:17:02.163Z",
      "createdBy": "text",
      "description": "text",
      "handlingUid": "text",
      "lastModifiedAt": "2025-04-18T01:17:02.163Z",
      "lastModifiedBy": "text",
      "name": "text",
      "triggers": [
        {
          "active": true,
          "trigger": "PUSHMESSAGE_ON_CREATE"
        }
      ]
    }
  ],
  "paging": {
    "pageNumber": 1,
    "pageSize": 1,
    "totalCount": 1
  }
}

Create a new handling

post

Create a new order handling.

Required permission: TENANT.ACCESS

Authorizations

Path parameters

tenantUidstringrequired

Reference to a tenant.

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

Body

all ofoptional

Request for creating or updating an orderhandling

Responses

application/json

objectoptional

post

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

{
  "handlingUid": "text",
  "active": true,
  "description": "text",
  "name": "text",
  "triggers": [
    {
      "active": true,
      "trigger": "PUSHMESSAGE_ON_CREATE"
    }
  ]
}

201

Example response

{
  "active": true,
  "createdAt": "2025-04-18T01:17:02.163Z",
  "createdBy": "text",
  "description": "text",
  "handlingUid": "text",
  "lastModifiedAt": "2025-04-18T01:17:02.163Z",
  "lastModifiedBy": "text",
  "name": "text",
  "triggers": [
    {
      "active": true,
      "trigger": "PUSHMESSAGE_ON_CREATE"
    }
  ]
}

Update handling details

put

Update handling details

Authorizations

Path parameters

tenantUidstringrequired

Reference to a tenant.

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

handlingUidstringrequired

Reference to an handling id.

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

Body

Request for creating or updating an orderhandling

activebooleanrequired

descriptionstringrequired

namestring · max: 20required

triggersobject[]required

Responses

application/json

objectoptional

put

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

{
  "active": true,
  "description": "text",
  "name": "text",
  "triggers": [
    {
      "active": true,
      "trigger": "PUSHMESSAGE_ON_CREATE"
    }
  ]
}

200

Example response

{
  "active": true,
  "createdAt": "2025-04-18T01:17:02.163Z",
  "createdBy": "text",
  "description": "text",
  "handlingUid": "text",
  "lastModifiedAt": "2025-04-18T01:17:02.163Z",
  "lastModifiedBy": "text",
  "name": "text",
  "triggers": [
    {
      "active": true,
      "trigger": "PUSHMESSAGE_ON_CREATE"
    }
  ]
}

Create new handling action

post

Create new handling action

Authorizations

Path parameters

tenantUidstringrequired

Reference to a tenant.

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

handlingUidstringrequired

Reference to an handling id.

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

Body

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

activebooleanrequired

allowCommentbooleanrequired

namestring · max: 20required

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

Responses

application/json

all ofoptional

post

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-04-18T01:17:02.163Z",
  "createdBy": "text",
  "handlingActionUid": "text",
  "lastModifiedAt": "2025-04-18T01:17:02.163Z",
  "lastModifiedBy": "text"
}

Update a handling action

put

Update a handling action

Required permission: TENANT.ADMIN

Authorizations

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

activebooleanrequired

allowCommentbooleanrequired

namestring · max: 20required

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

Responses

application/json

all ofoptional

put

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-04-18T01:17:02.163Z",
  "createdBy": "text",
  "handlingActionUid": "text",
  "lastModifiedAt": "2025-04-18T01:17:02.163Z",
  "lastModifiedBy": "text"
}