OrderHandling | Flow Retail Docs

Flow Retail Docs

Visit our website API Documentation

Get handling details for an order

get

Get handling details for an order

Authorizations

Path parameters

tenantUidstringrequired

Reference to a tenant.

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

storeUidstringrequired

Reference to a Store.

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

orderUidstringrequired

Reference to an Order.

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

orderHandlingUidstringrequired

Reference to an orderhandling id.

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

Responses

application/json

all ofoptional

get

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

200

Example response

{
  "orderUid": "text",
  "active": true,
  "createdAt": "2025-04-18T01:16:59.627Z",
  "createdBy": "text",
  "description": "text",
  "handlingUid": "text",
  "lastModifiedAt": "2025-04-18T01:16:59.627Z",
  "lastModifiedBy": "text",
  "name": "text",
  "orderHandlingUid": "text",
  "state": "NOT_STARTED"
}

Delete handling for an order

delete

Delete handling for an order

Authorizations

Path parameters

tenantUidstringrequired

Reference to a tenant.

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

storeUidstringrequired

Reference to a Store.

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

orderUidstringrequired

Reference to an Order.

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

orderHandlingUidstringrequired

Reference to an orderhandling id.

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

Responses

delete

DELETE /v2/tenants/{tenantUid}/stores/{storeUid}/orders/{orderUid}/handlings/{orderHandlingUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

204

No Content

List handling actions for an order item id

get

List handling actions for an order item id

Authorizations

Path parameters

tenantUidstringrequired

Reference to a tenant.

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

storeUidstringrequired

Reference to a Store.

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

orderUidstringrequired

Reference to an Order.

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

orderItemUidstringrequired

Reference to an order item on an order.

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

Responses

application/json

objectoptional

get

GET /v2/tenants/{tenantUid}/stores/{storeUid}/orders/{orderUid}/items/{orderItemUid}/handlingactions HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Example response

{
  "items": [
    {
      "comment": "text",
      "createdAt": "2025-04-18T01:16:59.627Z",
      "createdBy": "text",
      "handlingActionUid": "text",
      "handlingActionName": "text",
      "handlingDescription": "text",
      "handlingUid": "text",
      "handlingName": "text",
      "lastModifiedAt": "2025-04-18T01:16:59.627Z",
      "lastModifiedBy": "text",
      "orderHandlingActionUid": "text"
    }
  ]
}

Delete a handling action for an order item.

delete

Delete a handling action for an order item.

Authorizations

Path parameters

tenantUidstringrequired

Reference to a tenant.

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

storeUidstringrequired

Reference to a Store.

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

orderUidstringrequired

Reference to an Order.

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

orderItemUidstringrequired

Reference to an order item on an order.

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

orderHandlingActionUidstringrequired

Reference to an orderhandling action id.

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

Responses

delete

DELETE /v2/tenants/{tenantUid}/stores/{storeUid}/orders/{orderUid}/items/{orderItemUid}/handlingactions/{orderHandlingActionUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

204

No Content

List handlings for an order

get

List all handlings for a specific order

Authorizations

Path parameters

tenantUidstringrequired

Reference to a tenant.

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

storeUidstringrequired

Reference to a Store.

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

orderUidstringrequired

Reference to an Order.

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}/stores/{storeUid}/orders/{orderUid}/handlings HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Example response

{
  "items": [
    {
      "active": true,
      "createdAt": "2025-04-18T01:16:59.627Z",
      "createdBy": "text",
      "description": "text",
      "handlingUid": "text",
      "lastModifiedAt": "2025-04-18T01:16:59.627Z",
      "lastModifiedBy": "text",
      "name": "text",
      "orderHandlingUid": "text",
      "state": "NOT_STARTED"
    }
  ],
  "paging": {
    "pageNumber": 1,
    "pageSize": 1,
    "totalCount": 1
  }
}

Add a handling on an order

post

Add a handling on an order

Authorizations

Path parameters

tenantUidstringrequired

Reference to a tenant.

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

storeUidstringrequired

Reference to a Store.

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

orderUidstringrequired

Reference to an Order.

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

Body

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

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

Responses

application/json

all ofoptional

post

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

{
  "handlingUid": "text",
  "orderHandlingUid": "text"
}

201

Example response

{
  "orderUid": "text",
  "active": true,
  "createdAt": "2025-04-18T01:16:59.627Z",
  "createdBy": "text",
  "description": "text",
  "handlingUid": "text",
  "lastModifiedAt": "2025-04-18T01:16:59.627Z",
  "lastModifiedBy": "text",
  "name": "text",
  "orderHandlingUid": "text",
  "state": "NOT_STARTED"
}

Update handling details for an order

put

Update handling details for an order

Authorizations

Path parameters

tenantUidstringrequired

Reference to a tenant.

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

storeUidstringrequired

Reference to a Store.

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

orderUidstringrequired

Reference to an Order.

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

orderHandlingUidstringrequired

Reference to an orderhandling id.

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

Body

statestring · enumrequiredAvailable options:

commentstringoptional

Responses

application/json

all ofoptional

put

PUT /v2/tenants/{tenantUid}/stores/{storeUid}/orders/{orderUid}/handlings/{orderHandlingUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 40

{
  "state": "NOT_STARTED",
  "comment": "text"
}

200

Example response

{
  "orderUid": "text",
  "active": true,
  "createdAt": "2025-04-18T01:16:59.627Z",
  "createdBy": "text",
  "description": "text",
  "handlingUid": "text",
  "lastModifiedAt": "2025-04-18T01:16:59.627Z",
  "lastModifiedBy": "text",
  "name": "text",
  "orderHandlingUid": "text",
  "state": "NOT_STARTED"
}

Add handling action to order item

post

Add handling action to order item

Authorizations

Path parameters

tenantUidstringrequired

Reference to a tenant.

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

storeUidstringrequired

Reference to a Store.

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

orderUidstringrequired

Reference to an Order.

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

orderItemUidstringrequired

Reference to an order item on an order.

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

Body

commentstringoptional

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

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

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

Responses

application/json

objectoptional

post

POST /v2/tenants/{tenantUid}/stores/{storeUid}/orders/{orderUid}/items/{orderItemUid}/handlingactions HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 98

{
  "comment": "text",
  "handlingActionUid": "text",
  "handlingUid": "text",
  "orderHandlingActionUid": "text"
}

200

Example response

{
  "comment": "text",
  "createdAt": "2025-04-18T01:16:59.627Z",
  "createdBy": "text",
  "handlingActionUid": "text",
  "handlingActionName": "text",
  "handlingDescription": "text",
  "handlingUid": "text",
  "handlingName": "text",
  "lastModifiedAt": "2025-04-18T01:16:59.627Z",
  "lastModifiedBy": "text",
  "orderHandlingActionUid": "text"
}

Update order item handling action

put

Update order item handling action

Authorizations

Path parameters

tenantUidstringrequired

Reference to a tenant.

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

storeUidstringrequired

Reference to a Store.

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

orderUidstringrequired

Reference to an Order.

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

orderItemUidstringrequired

Reference to an order item on an order.

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

orderHandlingActionUidstringrequired

Reference to an orderhandling action id.

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

Body

commentstringrequired

Responses

application/json

objectoptional

put

PUT /v2/tenants/{tenantUid}/stores/{storeUid}/orders/{orderUid}/items/{orderItemUid}/handlingactions/{orderHandlingActionUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 18

{
  "comment": "text"
}

200

Example response

{
  "comment": "text",
  "createdAt": "2025-04-18T01:16:59.627Z",
  "createdBy": "text",
  "handlingActionUid": "text",
  "handlingActionName": "text",
  "handlingDescription": "text",
  "handlingUid": "text",
  "handlingName": "text",
  "lastModifiedAt": "2025-04-18T01:16:59.627Z",
  "lastModifiedBy": "text",
  "orderHandlingActionUid": "text"
}