Skip to content

CreateTemplate

Field Type Required Description
code TemplateCode yes max length 255 · min length 1
name TemplateName yes max length 255 · min length 1
triggerType TemplateTriggerType yes one of: event, other
eventType EventType only needed if type is event. With the option “custom” you can listen to custom events from external systems. If custom is set the property “customEventType” must be set
one of: fulfillmentOrderUpdated, fulfillmentOrderStatusUpdated, orderNotPickedUp, salesOrderAdded, salesOrderFulfillmentAdded, schedulePickupReminderTimeReached, cartReminderTimeReached, inactiveDeviceTimeReached, returnOrderAdded, returnOrderStatusUpdated, productInventoryRestocked, custom
description Description
messages TemplateLocalizedMessage yes
status TemplateStatus one of: active, inactive · default: "active"
{
"code": "TEMPLATE1",
"name": "Our great template",
"triggerType": "event",
"eventType": "fulfillmentOrderUpdated",
"description": "description of the entity",
"status": "active"
}