Skip to main content
File PrefixSPECIAL-ORDER-EVENTS
Current VersionV2
Special order events represent the various states the order goes through before it’s finalized. They are mostly provided as historical view, but in some cases can trigger an alert for user intervention.
AttributeFormatLengthRequiredDescriptionExample
order_refAlphanumeric3-255YesOrder reference descriptor103495
line_item_refAlphanumeric3-255YesOrder line item descriptor103495-1
sequenceNumeric1-3YesPosition of event for this order. It is unique within a given order, e.g. there can’t be two events with the same sequence and order_ref3
descriptionAlphanumeric1-255YesShort description of eventSent to fabrication
created_atDatetime ISO 860110YesDate and time the event occurred2022-01-17T19:23:22Z
referenceAlphanumeric1-65535NoGeneral purpose reference. For example could be a shipping tracking number. If a URL is provided, it will be displayed as a link that can be opened on tap.IB01T/38259
action_requiredBoolean [TRUE|FALSE]YesDetermine if this event requires human intervention. The sales associate for this order will be alerted.TRUE

​
Notes

The action_required field will only trigger a visible action if this is set to TRUE for the last event in the sequence. For example:
SequenceDescriptionaction_requiredApplication Behavior
3Sent to boutiqueFALSENothing
4Received at boutiqueTRUEThis event and the special order will be surfaced to the sales associate to take next steps
5Delivered to clientFALSEThis event will cause any notification or alerts to be removed for the sales associate

​
Event Processing Rules

Special order events are append-only data. Previously sent events can’t be updated or deleted. If an event for an order has already been imported, future events with the same sequence and order_ref will be ignored.