Template
| Field | Type | Required | Description |
|---|---|---|---|
code |
TemplateCode | max length 255 · min length 1 | |
name |
TemplateName | max length 255 · min length 1 | |
triggerType |
TemplateTriggerType | 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 | ||
campaignsUsing |
number |
||
status |
TemplateStatus | one of: active, inactive · default: "active" |
|
createDate |
string |
format: date-time |
|
createBy |
string |
Example
Section titled “Example”{ "code": "TEMPLATE1", "name": "Our great template", "triggerType": "event", "eventType": "fulfillmentOrderUpdated", "description": "description of the entity", "campaignsUsing": 2, "status": "active", "createDate": "2016-07-27T07:45:00Z", "createBy": "john@doe.com"}