Skip to content

Latest commit

 

History

History
43 lines (34 loc) · 2.2 KB

File metadata and controls

43 lines (34 loc) · 2.2 KB

FulfillmentStatusConfigurationItem

Properties

Name Type Description Notes
statusId String Status Id (no whitespaces) [optional]
statusName String Status name [optional]
enabled Boolean Is status enabled [optional]
displayName String The short status string that is displayed to users in apps, portal. If empty then Order Status Name is displayed instead [optional]
icon String Icon/Image that represents that status visual [optional]
publicDescription String A string which could be used in notification templates with a placeholder (SMS, email, push, web page with status) [optional]
internal Boolean Is internal state (internal states not shown to customers) [optional]
nextStatuses List<String> list of statuses that this status can move to (can be back or forth) [optional]
defaultNextStatus List<NextStatusWithOrderType> The default next status (on a dropdown or quick button on terminal or portal) [optional]
changeType ChangeTypeEnum How will state change (manually or automated, including timed) [optional]
includeInReports Boolean Include in reports [optional]
isCustom Boolean Is custom state. If not, then it's a system state [optional]
orderTypes List<OrderTypesEnum> If empty then applies to all ordertypes, otherwise a list of order types this state applies to [optional]
communication Boolean Whether state should fire off a notification to the customer [optional]
image String Image (image filename, relative, not absolute URL) [optional]

Enum: ChangeTypeEnum

Name Value
MANUAL "Manual"
AUTOMATED "Automated"
INTEGRATED "Integrated"

Enum: List<OrderTypesEnum>

Name Value
ALL "All"
DELIVERY "Delivery"
COLLECTION "Collection"
DINEIN "DineIn"