# Handling

Handling

## List handlings

> List all order handlings

```json
{"openapi":"3.0.2","info":{"title":"Flow Retail API version 2","version":"2.0.0"},"tags":[{"name":"Handling","description":"Handling"}],"servers":[{"description":"Flow Retail Production","url":"https://api.flowretail.com/v2"},{"description":"Flow Retail Stage","url":"https://api.stage.flowretail.com/v2"}],"security":[{"accessToken":[]},{"authToken":[]},{"integrationToken":[]}],"components":{"securitySchemes":{"accessToken":{"description":"Access token recevied after user login with a deviceToken","scheme":"bearer","type":"http"},"authToken":{"description":"Token received from the auth service","scheme":"bearer","type":"http"},"integrationToken":{"scheme":"bearer","type":"http"}},"parameters":{"pageNumberQuery":{"description":"Reference to a specific page in a result set.","in":"query","name":"pageNumber","required":false,"schema":{"type":"integer"}},"pageSizeQuery":{"description":"The number of items per page in a result set.","in":"query","name":"pageSize","required":false,"schema":{"type":"integer"}},"sortByQuery":{"description":"Defines which field the resource list is sorted by.","in":"query","name":"sortBy","required":false,"schema":{"type":"string"}},"sortDirectionQuery":{"description":"Reference to a sort direction","explode":false,"in":"query","name":"sortDirection","schema":{"$ref":"#/components/schemas/SortDirectionENUM"},"style":"form"}},"schemas":{"SortDirectionENUM":{"description":"|ENUM      | Description |\n| ---------------- | ------------ |\n| ASC | Sort in ascending order|\n| DESC | Sort in descending order|\n","enum":["ASC","DESC"],"title":"SortDirectionENUM","type":"string"},"HandlingResponseSchema":{"title":"HandlingResponseSchema","type":"object","required":["active","createdAt","createdBy","description","handlingUid","lastModifiedAt","lastModifiedBy","name","requireSerialnumberForComplete","templateUidForComplete"],"properties":{"active":{"type":"boolean"},"createdAt":{"format":"date-time","type":"string"},"createdBy":{"type":"string"},"description":{"type":"string"},"handlingUid":{"$ref":"#/components/schemas/UID"},"lastModifiedAt":{"format":"date-time","type":"string"},"lastModifiedBy":{"type":"string"},"name":{"maxLength":20,"type":"string"},"triggers":{"type":"array","items":{"$ref":"#/components/schemas/HandlingTriggerResponseSchema"}},"requireSerialnumberForComplete":{"type":"boolean","description":"All products that require serialnumber must have a serial number set before this handling can be set to `COMPLETE`"},"templateUidForComplete":{"$ref":"#/components/schemas/OptionalUID"}}},"UID":{"title":"UID","type":"string","pattern":"^[A-Za-z0-9-_]+"},"HandlingTriggerResponseSchema":{"title":"HandlingTriggerResponseSchema","type":"object","required":["active","trigger","state","value","handlingTriggerUid"],"properties":{"active":{"type":"boolean"},"trigger":{"$ref":"#/components/schemas/HandlingTriggerENUM"},"state":{"$ref":"#/components/schemas/HandlingStateENUM"},"value":{"type":"string"},"handlingTriggerUid":{"$ref":"#/components/schemas/UID"}}},"HandlingTriggerENUM":{"description":"|ENUM      | Description |\n| ---------------- | ------------ |\n| AUTO_PRINT_PICKUP_LABELS| Auto-print pickup labels when order is parked or confirmed|\n| SET_EXPIRY_DATE| Set expiry date on order|","enum":["AUTO_PRINT_PICKUP_LABELS","SET_EXPIRY_DATE"],"title":"HandlingTriggerENUM","type":"string"},"HandlingStateENUM":{"enum":["NOT_STARTED","IN_PROGRESS","COMPLETE"],"title":"HandlingStateENUM","type":"string"},"OptionalUID":{"title":"OptionalUID","type":"string","pattern":"^[A-Za-z0-9-_]*"},"Paging":{"description":"totalCount The total number of items in the result set.\n\npageSize The number of items per page.\n\npageNumber The current page in the result set.","properties":{"pageNumber":{"type":"integer"},"pageSize":{"type":"integer"},"totalCount":{"type":"integer"}},"required":["totalCount","pageSize","pageNumber"],"title":"Paging","type":"object"}},"responses":{"HandlingListResponse":{"content":{"application/json":{"schema":{"properties":{"items":{"items":{"$ref":"#/components/schemas/HandlingResponseSchema"},"type":"array"},"paging":{"$ref":"#/components/schemas/Paging"}},"required":["items","paging"],"type":"object"}}},"description":"Example response"}}},"paths":{"/tenants/{tenantUid}/handlings":{"get":{"description":"List all order handlings","operationId":"get-tenants-handlings","parameters":[{"$ref":"#/components/parameters/pageNumberQuery"},{"$ref":"#/components/parameters/pageSizeQuery"},{"$ref":"#/components/parameters/sortByQuery"},{"$ref":"#/components/parameters/sortDirectionQuery"}],"responses":{"200":{"$ref":"#/components/responses/HandlingListResponse"}},"summary":"List handlings","tags":["Handling"]}}}}
```

## Create a new handling

> Create a new handling.\
> \
> Required permissions: HANDLING

```json
{"openapi":"3.0.2","info":{"title":"Flow Retail API version 2","version":"2.0.0"},"tags":[{"name":"Handling","description":"Handling"}],"servers":[{"description":"Flow Retail Production","url":"https://api.flowretail.com/v2"},{"description":"Flow Retail Stage","url":"https://api.stage.flowretail.com/v2"}],"security":[{"accessToken":[]},{"authToken":[]},{"integrationToken":[]}],"components":{"securitySchemes":{"accessToken":{"description":"Access token recevied after user login with a deviceToken","scheme":"bearer","type":"http"},"authToken":{"description":"Token received from the auth service","scheme":"bearer","type":"http"},"integrationToken":{"scheme":"bearer","type":"http"}},"requestBodies":{"HandlingCreateRequest":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HandlingCreateRequestSchema"}}},"description":"Request for creating  an orderhandling"}},"schemas":{"HandlingCreateRequestSchema":{"allOf":[{"properties":{"handlingUid":{"$ref":"#/components/schemas/UID"}},"type":"object"},{"$ref":"#/components/schemas/HandlingUpdateRequestSchema"}],"title":"HandlingCreateRequestSchema"},"UID":{"title":"UID","type":"string","pattern":"^[A-Za-z0-9-_]+"},"HandlingUpdateRequestSchema":{"description":"Request for creating or updating an orderhandling","title":"HandlingUpdateRequestSchema","type":"object","required":["active","description","name"],"properties":{"active":{"type":"boolean"},"description":{"type":"string"},"name":{"maxLength":20,"type":"string"},"requireSerialnumberForComplete":{"type":"boolean"},"templateUidForComplete":{"$ref":"#/components/schemas/OptionalUID"}}},"OptionalUID":{"title":"OptionalUID","type":"string","pattern":"^[A-Za-z0-9-_]*"},"HandlingResponseSchema":{"title":"HandlingResponseSchema","type":"object","required":["active","createdAt","createdBy","description","handlingUid","lastModifiedAt","lastModifiedBy","name","requireSerialnumberForComplete","templateUidForComplete"],"properties":{"active":{"type":"boolean"},"createdAt":{"format":"date-time","type":"string"},"createdBy":{"type":"string"},"description":{"type":"string"},"handlingUid":{"$ref":"#/components/schemas/UID"},"lastModifiedAt":{"format":"date-time","type":"string"},"lastModifiedBy":{"type":"string"},"name":{"maxLength":20,"type":"string"},"triggers":{"type":"array","items":{"$ref":"#/components/schemas/HandlingTriggerResponseSchema"}},"requireSerialnumberForComplete":{"type":"boolean","description":"All products that require serialnumber must have a serial number set before this handling can be set to `COMPLETE`"},"templateUidForComplete":{"$ref":"#/components/schemas/OptionalUID"}}},"HandlingTriggerResponseSchema":{"title":"HandlingTriggerResponseSchema","type":"object","required":["active","trigger","state","value","handlingTriggerUid"],"properties":{"active":{"type":"boolean"},"trigger":{"$ref":"#/components/schemas/HandlingTriggerENUM"},"state":{"$ref":"#/components/schemas/HandlingStateENUM"},"value":{"type":"string"},"handlingTriggerUid":{"$ref":"#/components/schemas/UID"}}},"HandlingTriggerENUM":{"description":"|ENUM      | Description |\n| ---------------- | ------------ |\n| AUTO_PRINT_PICKUP_LABELS| Auto-print pickup labels when order is parked or confirmed|\n| SET_EXPIRY_DATE| Set expiry date on order|","enum":["AUTO_PRINT_PICKUP_LABELS","SET_EXPIRY_DATE"],"title":"HandlingTriggerENUM","type":"string"},"HandlingStateENUM":{"enum":["NOT_STARTED","IN_PROGRESS","COMPLETE"],"title":"HandlingStateENUM","type":"string"}},"responses":{"HandlingResponse":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HandlingResponseSchema"}}},"description":"Example response"}}},"paths":{"/tenants/{tenantUid}/handlings":{"post":{"description":"Create a new handling.\n\nRequired permissions: HANDLING","operationId":"post-tenants-handlings","requestBody":{"$ref":"#/components/requestBodies/HandlingCreateRequest"},"responses":{"201":{"$ref":"#/components/responses/HandlingResponse"}},"summary":"Create a new handling","tags":["Handling"]}}}}
```

## Get handling details

> Get handling details

```json
{"openapi":"3.0.2","info":{"title":"Flow Retail API version 2","version":"2.0.0"},"tags":[{"name":"Handling","description":"Handling"}],"servers":[{"description":"Flow Retail Production","url":"https://api.flowretail.com/v2"},{"description":"Flow Retail Stage","url":"https://api.stage.flowretail.com/v2"}],"security":[{"accessToken":[]},{"authToken":[]},{"integrationToken":[]}],"components":{"securitySchemes":{"accessToken":{"description":"Access token recevied after user login with a deviceToken","scheme":"bearer","type":"http"},"authToken":{"description":"Token received from the auth service","scheme":"bearer","type":"http"},"integrationToken":{"scheme":"bearer","type":"http"}},"responses":{"HandlingResponse":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HandlingResponseSchema"}}},"description":"Example response"}},"schemas":{"HandlingResponseSchema":{"title":"HandlingResponseSchema","type":"object","required":["active","createdAt","createdBy","description","handlingUid","lastModifiedAt","lastModifiedBy","name","requireSerialnumberForComplete","templateUidForComplete"],"properties":{"active":{"type":"boolean"},"createdAt":{"format":"date-time","type":"string"},"createdBy":{"type":"string"},"description":{"type":"string"},"handlingUid":{"$ref":"#/components/schemas/UID"},"lastModifiedAt":{"format":"date-time","type":"string"},"lastModifiedBy":{"type":"string"},"name":{"maxLength":20,"type":"string"},"triggers":{"type":"array","items":{"$ref":"#/components/schemas/HandlingTriggerResponseSchema"}},"requireSerialnumberForComplete":{"type":"boolean","description":"All products that require serialnumber must have a serial number set before this handling can be set to `COMPLETE`"},"templateUidForComplete":{"$ref":"#/components/schemas/OptionalUID"}}},"UID":{"title":"UID","type":"string","pattern":"^[A-Za-z0-9-_]+"},"HandlingTriggerResponseSchema":{"title":"HandlingTriggerResponseSchema","type":"object","required":["active","trigger","state","value","handlingTriggerUid"],"properties":{"active":{"type":"boolean"},"trigger":{"$ref":"#/components/schemas/HandlingTriggerENUM"},"state":{"$ref":"#/components/schemas/HandlingStateENUM"},"value":{"type":"string"},"handlingTriggerUid":{"$ref":"#/components/schemas/UID"}}},"HandlingTriggerENUM":{"description":"|ENUM      | Description |\n| ---------------- | ------------ |\n| AUTO_PRINT_PICKUP_LABELS| Auto-print pickup labels when order is parked or confirmed|\n| SET_EXPIRY_DATE| Set expiry date on order|","enum":["AUTO_PRINT_PICKUP_LABELS","SET_EXPIRY_DATE"],"title":"HandlingTriggerENUM","type":"string"},"HandlingStateENUM":{"enum":["NOT_STARTED","IN_PROGRESS","COMPLETE"],"title":"HandlingStateENUM","type":"string"},"OptionalUID":{"title":"OptionalUID","type":"string","pattern":"^[A-Za-z0-9-_]*"}}},"paths":{"/tenants/{tenantUid}/handlings/{handlingUid}":{"get":{"description":"Get handling details","operationId":"get-tenants-handlings-details","responses":{"200":{"$ref":"#/components/responses/HandlingResponse"}},"summary":"Get handling details","tags":["Handling"]}}}}
```

## Update handling details

> Update handling details\
> \
> Required permissions: HANDLING

```json
{"openapi":"3.0.2","info":{"title":"Flow Retail API version 2","version":"2.0.0"},"tags":[{"name":"Handling","description":"Handling"}],"servers":[{"description":"Flow Retail Production","url":"https://api.flowretail.com/v2"},{"description":"Flow Retail Stage","url":"https://api.stage.flowretail.com/v2"}],"security":[{"accessToken":[]},{"authToken":[]},{"integrationToken":[]}],"components":{"securitySchemes":{"accessToken":{"description":"Access token recevied after user login with a deviceToken","scheme":"bearer","type":"http"},"authToken":{"description":"Token received from the auth service","scheme":"bearer","type":"http"},"integrationToken":{"scheme":"bearer","type":"http"}},"requestBodies":{"HandlingUpdateRequest":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HandlingUpdateRequestSchema"}}},"description":"Request for updating an orderhandling"}},"schemas":{"HandlingUpdateRequestSchema":{"description":"Request for creating or updating an orderhandling","title":"HandlingUpdateRequestSchema","type":"object","required":["active","description","name"],"properties":{"active":{"type":"boolean"},"description":{"type":"string"},"name":{"maxLength":20,"type":"string"},"requireSerialnumberForComplete":{"type":"boolean"},"templateUidForComplete":{"$ref":"#/components/schemas/OptionalUID"}}},"OptionalUID":{"title":"OptionalUID","type":"string","pattern":"^[A-Za-z0-9-_]*"},"HandlingResponseSchema":{"title":"HandlingResponseSchema","type":"object","required":["active","createdAt","createdBy","description","handlingUid","lastModifiedAt","lastModifiedBy","name","requireSerialnumberForComplete","templateUidForComplete"],"properties":{"active":{"type":"boolean"},"createdAt":{"format":"date-time","type":"string"},"createdBy":{"type":"string"},"description":{"type":"string"},"handlingUid":{"$ref":"#/components/schemas/UID"},"lastModifiedAt":{"format":"date-time","type":"string"},"lastModifiedBy":{"type":"string"},"name":{"maxLength":20,"type":"string"},"triggers":{"type":"array","items":{"$ref":"#/components/schemas/HandlingTriggerResponseSchema"}},"requireSerialnumberForComplete":{"type":"boolean","description":"All products that require serialnumber must have a serial number set before this handling can be set to `COMPLETE`"},"templateUidForComplete":{"$ref":"#/components/schemas/OptionalUID"}}},"UID":{"title":"UID","type":"string","pattern":"^[A-Za-z0-9-_]+"},"HandlingTriggerResponseSchema":{"title":"HandlingTriggerResponseSchema","type":"object","required":["active","trigger","state","value","handlingTriggerUid"],"properties":{"active":{"type":"boolean"},"trigger":{"$ref":"#/components/schemas/HandlingTriggerENUM"},"state":{"$ref":"#/components/schemas/HandlingStateENUM"},"value":{"type":"string"},"handlingTriggerUid":{"$ref":"#/components/schemas/UID"}}},"HandlingTriggerENUM":{"description":"|ENUM      | Description |\n| ---------------- | ------------ |\n| AUTO_PRINT_PICKUP_LABELS| Auto-print pickup labels when order is parked or confirmed|\n| SET_EXPIRY_DATE| Set expiry date on order|","enum":["AUTO_PRINT_PICKUP_LABELS","SET_EXPIRY_DATE"],"title":"HandlingTriggerENUM","type":"string"},"HandlingStateENUM":{"enum":["NOT_STARTED","IN_PROGRESS","COMPLETE"],"title":"HandlingStateENUM","type":"string"}},"responses":{"HandlingResponse":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HandlingResponseSchema"}}},"description":"Example response"}}},"paths":{"/tenants/{tenantUid}/handlings/{handlingUid}":{"put":{"operationId":"put-tenants-handlings-details","description":"Update handling details\n\nRequired permissions: HANDLING","requestBody":{"$ref":"#/components/requestBodies/HandlingUpdateRequest"},"responses":{"200":{"$ref":"#/components/responses/HandlingResponse"}},"summary":"Update handling details","tags":["Handling"]}}}}
```

## Delete a handling

> Delete a handling\
> \
> Required permissions: HANDLING

```json
{"openapi":"3.0.2","info":{"title":"Flow Retail API version 2","version":"2.0.0"},"tags":[{"name":"Handling","description":"Handling"}],"servers":[{"description":"Flow Retail Production","url":"https://api.flowretail.com/v2"},{"description":"Flow Retail Stage","url":"https://api.stage.flowretail.com/v2"}],"security":[{"accessToken":[]},{"authToken":[]},{"integrationToken":[]}],"components":{"securitySchemes":{"accessToken":{"description":"Access token recevied after user login with a deviceToken","scheme":"bearer","type":"http"},"authToken":{"description":"Token received from the auth service","scheme":"bearer","type":"http"},"integrationToken":{"scheme":"bearer","type":"http"}}},"paths":{"/tenants/{tenantUid}/handlings/{handlingUid}":{"delete":{"description":"Delete a handling\n\nRequired permissions: HANDLING","operationId":"delete-tenants-handlings-details","responses":{"204":{"description":"No Content"}},"summary":"Delete a handling","tags":["Handling"]}}}}
```

## List handling triggers

> List handling triggers

```json
{"openapi":"3.0.2","info":{"title":"Flow Retail API version 2","version":"2.0.0"},"tags":[{"name":"Handling","description":"Handling"}],"servers":[{"description":"Flow Retail Production","url":"https://api.flowretail.com/v2"},{"description":"Flow Retail Stage","url":"https://api.stage.flowretail.com/v2"}],"security":[{"accessToken":[]},{"authToken":[]},{"integrationToken":[]}],"components":{"securitySchemes":{"accessToken":{"description":"Access token recevied after user login with a deviceToken","scheme":"bearer","type":"http"},"authToken":{"description":"Token received from the auth service","scheme":"bearer","type":"http"},"integrationToken":{"scheme":"bearer","type":"http"}},"responses":{"HandlingTriggerListResponse":{"description":"Example response","content":{"application/json":{"schema":{"type":"object","required":["items","paging"],"properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/HandlingTriggerResponseSchema"}},"paging":{"$ref":"#/components/schemas/Paging"}}}}}}},"schemas":{"HandlingTriggerResponseSchema":{"title":"HandlingTriggerResponseSchema","type":"object","required":["active","trigger","state","value","handlingTriggerUid"],"properties":{"active":{"type":"boolean"},"trigger":{"$ref":"#/components/schemas/HandlingTriggerENUM"},"state":{"$ref":"#/components/schemas/HandlingStateENUM"},"value":{"type":"string"},"handlingTriggerUid":{"$ref":"#/components/schemas/UID"}}},"HandlingTriggerENUM":{"description":"|ENUM      | Description |\n| ---------------- | ------------ |\n| AUTO_PRINT_PICKUP_LABELS| Auto-print pickup labels when order is parked or confirmed|\n| SET_EXPIRY_DATE| Set expiry date on order|","enum":["AUTO_PRINT_PICKUP_LABELS","SET_EXPIRY_DATE"],"title":"HandlingTriggerENUM","type":"string"},"HandlingStateENUM":{"enum":["NOT_STARTED","IN_PROGRESS","COMPLETE"],"title":"HandlingStateENUM","type":"string"},"UID":{"title":"UID","type":"string","pattern":"^[A-Za-z0-9-_]+"},"Paging":{"description":"totalCount The total number of items in the result set.\n\npageSize The number of items per page.\n\npageNumber The current page in the result set.","properties":{"pageNumber":{"type":"integer"},"pageSize":{"type":"integer"},"totalCount":{"type":"integer"}},"required":["totalCount","pageSize","pageNumber"],"title":"Paging","type":"object"},"SortDirectionENUM":{"description":"|ENUM      | Description |\n| ---------------- | ------------ |\n| ASC | Sort in ascending order|\n| DESC | Sort in descending order|\n","enum":["ASC","DESC"],"title":"SortDirectionENUM","type":"string"}},"parameters":{"pageNumberQuery":{"description":"Reference to a specific page in a result set.","in":"query","name":"pageNumber","required":false,"schema":{"type":"integer"}},"pageSizeQuery":{"description":"The number of items per page in a result set.","in":"query","name":"pageSize","required":false,"schema":{"type":"integer"}},"sortByQuery":{"description":"Defines which field the resource list is sorted by.","in":"query","name":"sortBy","required":false,"schema":{"type":"string"}},"sortDirectionQuery":{"description":"Reference to a sort direction","explode":false,"in":"query","name":"sortDirection","schema":{"$ref":"#/components/schemas/SortDirectionENUM"},"style":"form"}}},"paths":{"/tenants/{tenantUid}/handlings/{handlingUid}/triggers":{"get":{"description":"List handling triggers","operationId":"list-handling-triggers","responses":{"200":{"$ref":"#/components/responses/HandlingTriggerListResponse"}},"summary":"List handling triggers","tags":["Handling"],"parameters":[{"$ref":"#/components/parameters/pageNumberQuery"},{"$ref":"#/components/parameters/pageSizeQuery"},{"$ref":"#/components/parameters/sortByQuery"},{"$ref":"#/components/parameters/sortDirectionQuery"}]}}}}
```

## Add a trigger to a handling

> Add a trigger to a handling\
> \
> Required permissions: HANDLING

```json
{"openapi":"3.0.2","info":{"title":"Flow Retail API version 2","version":"2.0.0"},"tags":[{"name":"Handling","description":"Handling"}],"servers":[{"description":"Flow Retail Production","url":"https://api.flowretail.com/v2"},{"description":"Flow Retail Stage","url":"https://api.stage.flowretail.com/v2"}],"security":[{"accessToken":[]},{"authToken":[]},{"integrationToken":[]}],"components":{"securitySchemes":{"accessToken":{"description":"Access token recevied after user login with a deviceToken","scheme":"bearer","type":"http"},"authToken":{"description":"Token received from the auth service","scheme":"bearer","type":"http"},"integrationToken":{"scheme":"bearer","type":"http"}},"responses":{"HandlingTriggerResponse":{"description":"Example response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HandlingTriggerResponseSchema"}}}}},"schemas":{"HandlingTriggerResponseSchema":{"title":"HandlingTriggerResponseSchema","type":"object","required":["active","trigger","state","value","handlingTriggerUid"],"properties":{"active":{"type":"boolean"},"trigger":{"$ref":"#/components/schemas/HandlingTriggerENUM"},"state":{"$ref":"#/components/schemas/HandlingStateENUM"},"value":{"type":"string"},"handlingTriggerUid":{"$ref":"#/components/schemas/UID"}}},"HandlingTriggerENUM":{"description":"|ENUM      | Description |\n| ---------------- | ------------ |\n| AUTO_PRINT_PICKUP_LABELS| Auto-print pickup labels when order is parked or confirmed|\n| SET_EXPIRY_DATE| Set expiry date on order|","enum":["AUTO_PRINT_PICKUP_LABELS","SET_EXPIRY_DATE"],"title":"HandlingTriggerENUM","type":"string"},"HandlingStateENUM":{"enum":["NOT_STARTED","IN_PROGRESS","COMPLETE"],"title":"HandlingStateENUM","type":"string"},"UID":{"title":"UID","type":"string","pattern":"^[A-Za-z0-9-_]+"},"HandlingTriggerCreateRequestSchema":{"title":"HandlingTriggerCreateRequestSchema","type":"object","required":["active","trigger","state"],"properties":{"active":{"type":"boolean"},"trigger":{"$ref":"#/components/schemas/HandlingTriggerENUM"},"state":{"$ref":"#/components/schemas/HandlingStateENUM"},"value":{"type":"string"},"handlingTriggerUid":{"$ref":"#/components/schemas/UID"}}}},"requestBodies":{"HandlingTriggerCreateRequest":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HandlingTriggerCreateRequestSchema"}}}}}},"paths":{"/tenants/{tenantUid}/handlings/{handlingUid}/triggers":{"post":{"operationId":"post-handling-trigger-details","description":"Add a trigger to a handling\n\nRequired permissions: HANDLING","responses":{"204":{"$ref":"#/components/responses/HandlingTriggerResponse"}},"summary":"Add a trigger to a handling","tags":["Handling"],"requestBody":{"$ref":"#/components/requestBodies/HandlingTriggerCreateRequest"}}}}}
```

## Get handling trigger details

> Get handling trigger details

```json
{"openapi":"3.0.2","info":{"title":"Flow Retail API version 2","version":"2.0.0"},"tags":[{"name":"Handling","description":"Handling"}],"servers":[{"description":"Flow Retail Production","url":"https://api.flowretail.com/v2"},{"description":"Flow Retail Stage","url":"https://api.stage.flowretail.com/v2"}],"security":[{"accessToken":[]},{"authToken":[]},{"integrationToken":[]}],"components":{"securitySchemes":{"accessToken":{"description":"Access token recevied after user login with a deviceToken","scheme":"bearer","type":"http"},"authToken":{"description":"Token received from the auth service","scheme":"bearer","type":"http"},"integrationToken":{"scheme":"bearer","type":"http"}},"responses":{"HandlingTriggerResponse":{"description":"Example response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HandlingTriggerResponseSchema"}}}}},"schemas":{"HandlingTriggerResponseSchema":{"title":"HandlingTriggerResponseSchema","type":"object","required":["active","trigger","state","value","handlingTriggerUid"],"properties":{"active":{"type":"boolean"},"trigger":{"$ref":"#/components/schemas/HandlingTriggerENUM"},"state":{"$ref":"#/components/schemas/HandlingStateENUM"},"value":{"type":"string"},"handlingTriggerUid":{"$ref":"#/components/schemas/UID"}}},"HandlingTriggerENUM":{"description":"|ENUM      | Description |\n| ---------------- | ------------ |\n| AUTO_PRINT_PICKUP_LABELS| Auto-print pickup labels when order is parked or confirmed|\n| SET_EXPIRY_DATE| Set expiry date on order|","enum":["AUTO_PRINT_PICKUP_LABELS","SET_EXPIRY_DATE"],"title":"HandlingTriggerENUM","type":"string"},"HandlingStateENUM":{"enum":["NOT_STARTED","IN_PROGRESS","COMPLETE"],"title":"HandlingStateENUM","type":"string"},"UID":{"title":"UID","type":"string","pattern":"^[A-Za-z0-9-_]+"}}},"paths":{"/tenants/{tenantUid}/handlings/{handlingUid}/triggers/{handlingTriggerUid}":{"get":{"description":"Get handling trigger details","operationId":"get-handling-trigger-details","responses":{"200":{"$ref":"#/components/responses/HandlingTriggerResponse"}},"summary":"Get handling trigger details","tags":["Handling"]}}}}
```

## Update handling trigger details

> Update handling trigger details\
> \
> Required permissions: HANDLING

```json
{"openapi":"3.0.2","info":{"title":"Flow Retail API version 2","version":"2.0.0"},"tags":[{"name":"Handling","description":"Handling"}],"servers":[{"description":"Flow Retail Production","url":"https://api.flowretail.com/v2"},{"description":"Flow Retail Stage","url":"https://api.stage.flowretail.com/v2"}],"security":[{"accessToken":[]},{"authToken":[]},{"integrationToken":[]}],"components":{"securitySchemes":{"accessToken":{"description":"Access token recevied after user login with a deviceToken","scheme":"bearer","type":"http"},"authToken":{"description":"Token received from the auth service","scheme":"bearer","type":"http"},"integrationToken":{"scheme":"bearer","type":"http"}},"responses":{"HandlingTriggerResponse":{"description":"Example response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HandlingTriggerResponseSchema"}}}}},"schemas":{"HandlingTriggerResponseSchema":{"title":"HandlingTriggerResponseSchema","type":"object","required":["active","trigger","state","value","handlingTriggerUid"],"properties":{"active":{"type":"boolean"},"trigger":{"$ref":"#/components/schemas/HandlingTriggerENUM"},"state":{"$ref":"#/components/schemas/HandlingStateENUM"},"value":{"type":"string"},"handlingTriggerUid":{"$ref":"#/components/schemas/UID"}}},"HandlingTriggerENUM":{"description":"|ENUM      | Description |\n| ---------------- | ------------ |\n| AUTO_PRINT_PICKUP_LABELS| Auto-print pickup labels when order is parked or confirmed|\n| SET_EXPIRY_DATE| Set expiry date on order|","enum":["AUTO_PRINT_PICKUP_LABELS","SET_EXPIRY_DATE"],"title":"HandlingTriggerENUM","type":"string"},"HandlingStateENUM":{"enum":["NOT_STARTED","IN_PROGRESS","COMPLETE"],"title":"HandlingStateENUM","type":"string"},"UID":{"title":"UID","type":"string","pattern":"^[A-Za-z0-9-_]+"},"HandlingTriggerUpdateRequestSchema":{"title":"HandlingTriggerUpdateRequestSchema","type":"object","required":["active","trigger","state"],"properties":{"active":{"type":"boolean"},"trigger":{"$ref":"#/components/schemas/HandlingTriggerENUM"},"state":{"$ref":"#/components/schemas/HandlingStateENUM"},"value":{"type":"string"},"handlingTriggerUid":{"$ref":"#/components/schemas/UID"}}}},"requestBodies":{"HandlingTriggerUpdateRequest":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HandlingTriggerUpdateRequestSchema"}}}}}},"paths":{"/tenants/{tenantUid}/handlings/{handlingUid}/triggers/{handlingTriggerUid}":{"put":{"operationId":"put-handling-trigger-details","description":"Update handling trigger details\n\nRequired permissions: HANDLING","responses":{"204":{"$ref":"#/components/responses/HandlingTriggerResponse"}},"summary":"Update handling trigger details","tags":["Handling"],"requestBody":{"$ref":"#/components/requestBodies/HandlingTriggerUpdateRequest"}}}}}
```

## Delete a handling trigger

> Delete a handling trigger\
> \
> Required permissions: HANDLING

```json
{"openapi":"3.0.2","info":{"title":"Flow Retail API version 2","version":"2.0.0"},"tags":[{"name":"Handling","description":"Handling"}],"servers":[{"description":"Flow Retail Production","url":"https://api.flowretail.com/v2"},{"description":"Flow Retail Stage","url":"https://api.stage.flowretail.com/v2"}],"security":[{"accessToken":[]},{"authToken":[]},{"integrationToken":[]}],"components":{"securitySchemes":{"accessToken":{"description":"Access token recevied after user login with a deviceToken","scheme":"bearer","type":"http"},"authToken":{"description":"Token received from the auth service","scheme":"bearer","type":"http"},"integrationToken":{"scheme":"bearer","type":"http"}}},"paths":{"/tenants/{tenantUid}/handlings/{handlingUid}/triggers/{handlingTriggerUid}":{"delete":{"summary":"Delete a handling trigger","tags":["Handling"],"responses":{"204":{"description":"No Content"}},"operationId":"delete-handling-trigger","description":"Delete a handling trigger\n\nRequired permissions: HANDLING"}}}}
```

## List Handling actions

> List Handling actions

```json
{"openapi":"3.0.2","info":{"title":"Flow Retail API version 2","version":"2.0.0"},"tags":[{"name":"Handling","description":"Handling"}],"servers":[{"description":"Flow Retail Production","url":"https://api.flowretail.com/v2"},{"description":"Flow Retail Stage","url":"https://api.stage.flowretail.com/v2"}],"security":[{"accessToken":[]},{"authToken":[]},{"integrationToken":[]}],"components":{"securitySchemes":{"accessToken":{"description":"Access token recevied after user login with a deviceToken","scheme":"bearer","type":"http"},"authToken":{"description":"Token received from the auth service","scheme":"bearer","type":"http"},"integrationToken":{"scheme":"bearer","type":"http"}},"parameters":{"pageNumberQuery":{"description":"Reference to a specific page in a result set.","in":"query","name":"pageNumber","required":false,"schema":{"type":"integer"}},"pageSizeQuery":{"description":"The number of items per page in a result set.","in":"query","name":"pageSize","required":false,"schema":{"type":"integer"}},"sortByQuery":{"description":"Defines which field the resource list is sorted by.","in":"query","name":"sortBy","required":false,"schema":{"type":"string"}},"sortDirectionQuery":{"description":"Reference to a sort direction","explode":false,"in":"query","name":"sortDirection","schema":{"$ref":"#/components/schemas/SortDirectionENUM"},"style":"form"},"handlingActionStoreUidQuery":{"description":"Reference to a store uid.","in":"query","name":"handlingActionStoreUid","required":false,"schema":{"$ref":"#/components/schemas/UID"}}},"schemas":{"SortDirectionENUM":{"description":"|ENUM      | Description |\n| ---------------- | ------------ |\n| ASC | Sort in ascending order|\n| DESC | Sort in descending order|\n","enum":["ASC","DESC"],"title":"SortDirectionENUM","type":"string"},"UID":{"title":"UID","type":"string","pattern":"^[A-Za-z0-9-_]+"},"HandlingActionResponseSchema":{"allOf":[{"$ref":"#/components/schemas/HandlingActionUpdateRequestSchema"},{"type":"object","properties":{"createdAt":{"format":"date-time","type":"string"},"createdBy":{"type":"string"},"handlingActionUid":{"$ref":"#/components/schemas/UID"},"lastModifiedAt":{"format":"date-time","type":"string"},"lastModifiedBy":{"type":"string"},"storeUid":{"$ref":"#/components/schemas/OptionalUID"}},"required":["createdAt","createdBy","handlingActionUid","lastModifiedAt","lastModifiedBy","storeUid"]}],"title":"HandlingActionResponseSchema"},"HandlingActionUpdateRequestSchema":{"title":"HandlingActionUpdateRequestSchema","type":"object","properties":{"active":{"type":"boolean"},"allowComment":{"type":"boolean"},"name":{"type":"string","maxLength":20},"storeUid":{"$ref":"#/components/schemas/OptionalUID"}},"required":["active","allowComment","name"]},"OptionalUID":{"title":"OptionalUID","type":"string","pattern":"^[A-Za-z0-9-_]*"},"Paging":{"description":"totalCount The total number of items in the result set.\n\npageSize The number of items per page.\n\npageNumber The current page in the result set.","properties":{"pageNumber":{"type":"integer"},"pageSize":{"type":"integer"},"totalCount":{"type":"integer"}},"required":["totalCount","pageSize","pageNumber"],"title":"Paging","type":"object"}},"responses":{"HandlingActionListResponse":{"content":{"application/json":{"schema":{"properties":{"items":{"items":{"$ref":"#/components/schemas/HandlingActionResponseSchema"},"type":"array"},"paging":{"$ref":"#/components/schemas/Paging"}},"required":["items","paging"],"type":"object"}}},"description":"Example response"}}},"paths":{"/tenants/{tenantUid}/handlings/{handlingUid}/actions":{"get":{"description":"List Handling actions","operationId":"get-tenants-handlings-actions","parameters":[{"$ref":"#/components/parameters/pageNumberQuery"},{"$ref":"#/components/parameters/pageSizeQuery"},{"$ref":"#/components/parameters/sortByQuery"},{"$ref":"#/components/parameters/sortDirectionQuery"},{"$ref":"#/components/parameters/handlingActionStoreUidQuery"}],"responses":{"200":{"$ref":"#/components/responses/HandlingActionListResponse"}},"summary":"List Handling actions","tags":["Handling"]}}}}
```

## Create new handling action

> Create new handling action\
> \
> Required permissions: HANDLING

```json
{"openapi":"3.0.2","info":{"title":"Flow Retail API version 2","version":"2.0.0"},"tags":[{"name":"Handling","description":"Handling"}],"servers":[{"description":"Flow Retail Production","url":"https://api.flowretail.com/v2"},{"description":"Flow Retail Stage","url":"https://api.stage.flowretail.com/v2"}],"security":[{"accessToken":[]},{"authToken":[]},{"integrationToken":[]}],"components":{"securitySchemes":{"accessToken":{"description":"Access token recevied after user login with a deviceToken","scheme":"bearer","type":"http"},"authToken":{"description":"Token received from the auth service","scheme":"bearer","type":"http"},"integrationToken":{"scheme":"bearer","type":"http"}},"requestBodies":{"HandlingActionCreateRequest":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HandlingActionCreateRequestSchema"}}}}},"schemas":{"HandlingActionCreateRequestSchema":{"properties":{"handlingActionUid":{"$ref":"#/components/schemas/UID"},"active":{"type":"boolean"},"allowComment":{"type":"boolean"},"name":{"type":"string","maxLength":20},"storeUid":{"$ref":"#/components/schemas/UID"}},"required":["active","allowComment","name"],"title":"HandlingActionCreateRequestSchema","type":"object"},"UID":{"title":"UID","type":"string","pattern":"^[A-Za-z0-9-_]+"},"HandlingActionResponseSchema":{"allOf":[{"$ref":"#/components/schemas/HandlingActionUpdateRequestSchema"},{"type":"object","properties":{"createdAt":{"format":"date-time","type":"string"},"createdBy":{"type":"string"},"handlingActionUid":{"$ref":"#/components/schemas/UID"},"lastModifiedAt":{"format":"date-time","type":"string"},"lastModifiedBy":{"type":"string"},"storeUid":{"$ref":"#/components/schemas/OptionalUID"}},"required":["createdAt","createdBy","handlingActionUid","lastModifiedAt","lastModifiedBy","storeUid"]}],"title":"HandlingActionResponseSchema"},"HandlingActionUpdateRequestSchema":{"title":"HandlingActionUpdateRequestSchema","type":"object","properties":{"active":{"type":"boolean"},"allowComment":{"type":"boolean"},"name":{"type":"string","maxLength":20},"storeUid":{"$ref":"#/components/schemas/OptionalUID"}},"required":["active","allowComment","name"]},"OptionalUID":{"title":"OptionalUID","type":"string","pattern":"^[A-Za-z0-9-_]*"}},"responses":{"HandlingActionResponse":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HandlingActionResponseSchema"}}},"description":"Example response"}}},"paths":{"/tenants/{tenantUid}/handlings/{handlingUid}/actions":{"post":{"operationId":"post-tenants-handlings-actions","description":"Create new handling action\n\nRequired permissions: HANDLING","requestBody":{"$ref":"#/components/requestBodies/HandlingActionCreateRequest"},"responses":{"200":{"$ref":"#/components/responses/HandlingActionResponse"}},"summary":"Create new handling action","tags":["Handling"]}}}}
```

## Get handling action details

> Get handling action details

```json
{"openapi":"3.0.2","info":{"title":"Flow Retail API version 2","version":"2.0.0"},"tags":[{"name":"Handling","description":"Handling"}],"servers":[{"description":"Flow Retail Production","url":"https://api.flowretail.com/v2"},{"description":"Flow Retail Stage","url":"https://api.stage.flowretail.com/v2"}],"security":[{"accessToken":[]},{"authToken":[]},{"integrationToken":[]}],"components":{"securitySchemes":{"accessToken":{"description":"Access token recevied after user login with a deviceToken","scheme":"bearer","type":"http"},"authToken":{"description":"Token received from the auth service","scheme":"bearer","type":"http"},"integrationToken":{"scheme":"bearer","type":"http"}},"responses":{"HandlingActionResponse":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HandlingActionResponseSchema"}}},"description":"Example response"}},"schemas":{"HandlingActionResponseSchema":{"allOf":[{"$ref":"#/components/schemas/HandlingActionUpdateRequestSchema"},{"type":"object","properties":{"createdAt":{"format":"date-time","type":"string"},"createdBy":{"type":"string"},"handlingActionUid":{"$ref":"#/components/schemas/UID"},"lastModifiedAt":{"format":"date-time","type":"string"},"lastModifiedBy":{"type":"string"},"storeUid":{"$ref":"#/components/schemas/OptionalUID"}},"required":["createdAt","createdBy","handlingActionUid","lastModifiedAt","lastModifiedBy","storeUid"]}],"title":"HandlingActionResponseSchema"},"HandlingActionUpdateRequestSchema":{"title":"HandlingActionUpdateRequestSchema","type":"object","properties":{"active":{"type":"boolean"},"allowComment":{"type":"boolean"},"name":{"type":"string","maxLength":20},"storeUid":{"$ref":"#/components/schemas/OptionalUID"}},"required":["active","allowComment","name"]},"OptionalUID":{"title":"OptionalUID","type":"string","pattern":"^[A-Za-z0-9-_]*"},"UID":{"title":"UID","type":"string","pattern":"^[A-Za-z0-9-_]+"}}},"paths":{"/tenants/{tenantUid}/handlings/{handlingUid}/actions/{handlingActionUid}":{"get":{"description":"Get handling action details","operationId":"get-tenants-handlings-actions-details","responses":{"200":{"$ref":"#/components/responses/HandlingActionResponse"}},"summary":"Get handling action details","tags":["Handling"]}}}}
```

## Update a handling action

> Update a handling action\
> \
> Required permissions: HANDLING

```json
{"openapi":"3.0.2","info":{"title":"Flow Retail API version 2","version":"2.0.0"},"tags":[{"name":"Handling","description":"Handling"}],"servers":[{"description":"Flow Retail Production","url":"https://api.flowretail.com/v2"},{"description":"Flow Retail Stage","url":"https://api.stage.flowretail.com/v2"}],"security":[{"accessToken":[]},{"authToken":[]},{"integrationToken":[]}],"components":{"securitySchemes":{"accessToken":{"description":"Access token recevied after user login with a deviceToken","scheme":"bearer","type":"http"},"authToken":{"description":"Token received from the auth service","scheme":"bearer","type":"http"},"integrationToken":{"scheme":"bearer","type":"http"}},"requestBodies":{"HandlingActionUpdateRequest":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HandlingActionUpdateRequestSchema"}}}}},"schemas":{"HandlingActionUpdateRequestSchema":{"title":"HandlingActionUpdateRequestSchema","type":"object","properties":{"active":{"type":"boolean"},"allowComment":{"type":"boolean"},"name":{"type":"string","maxLength":20},"storeUid":{"$ref":"#/components/schemas/OptionalUID"}},"required":["active","allowComment","name"]},"OptionalUID":{"title":"OptionalUID","type":"string","pattern":"^[A-Za-z0-9-_]*"},"HandlingActionResponseSchema":{"allOf":[{"$ref":"#/components/schemas/HandlingActionUpdateRequestSchema"},{"type":"object","properties":{"createdAt":{"format":"date-time","type":"string"},"createdBy":{"type":"string"},"handlingActionUid":{"$ref":"#/components/schemas/UID"},"lastModifiedAt":{"format":"date-time","type":"string"},"lastModifiedBy":{"type":"string"},"storeUid":{"$ref":"#/components/schemas/OptionalUID"}},"required":["createdAt","createdBy","handlingActionUid","lastModifiedAt","lastModifiedBy","storeUid"]}],"title":"HandlingActionResponseSchema"},"UID":{"title":"UID","type":"string","pattern":"^[A-Za-z0-9-_]+"}},"responses":{"HandlingActionResponse":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HandlingActionResponseSchema"}}},"description":"Example response"}}},"paths":{"/tenants/{tenantUid}/handlings/{handlingUid}/actions/{handlingActionUid}":{"put":{"description":"Update a handling action\n\nRequired permissions: HANDLING","operationId":"put-tenants-handlings-actions-details","requestBody":{"$ref":"#/components/requestBodies/HandlingActionUpdateRequest"},"responses":{"200":{"$ref":"#/components/responses/HandlingActionResponse"}},"summary":"Update a handling action","tags":["Handling"]}}}}
```

## Delete a handling action

> Delete a handling action\
> \
> Required permissions: HANDLING

```json
{"openapi":"3.0.2","info":{"title":"Flow Retail API version 2","version":"2.0.0"},"tags":[{"name":"Handling","description":"Handling"}],"servers":[{"description":"Flow Retail Production","url":"https://api.flowretail.com/v2"},{"description":"Flow Retail Stage","url":"https://api.stage.flowretail.com/v2"}],"security":[{"accessToken":[]},{"authToken":[]},{"integrationToken":[]}],"components":{"securitySchemes":{"accessToken":{"description":"Access token recevied after user login with a deviceToken","scheme":"bearer","type":"http"},"authToken":{"description":"Token received from the auth service","scheme":"bearer","type":"http"},"integrationToken":{"scheme":"bearer","type":"http"}}},"paths":{"/tenants/{tenantUid}/handlings/{handlingUid}/actions/{handlingActionUid}":{"delete":{"operationId":"delete-tenants-handlings-actions-details","description":"Delete a handling action\n\nRequired permissions: HANDLING","responses":{"204":{"description":"No Content"}},"summary":"Delete a handling action","tags":["Handling"]}}}}
```