Get handling trigger details

Get handling trigger details

get

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

Authorizations

AuthorizationstringRequired

Access token recevied after user login with a deviceToken

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

activebooleanRequired

triggerstring · enumRequired

ENUM	Description
AUTO_PRINT_PICKUP_LABELS	Auto-print pickup labels when order is parked or confirmed
SET_EXPIRY_DATE	Deprecated: set expiry date on order. Not in use, and will be removed

Possible values:

statestring · enumRequired

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.

Possible values:

valuestringRequired

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

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

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_LABELS",
  "state": "NOT_STARTED",
  "value": "text",
  "handlingTriggerUid": "text"
}