| File Prefix | SPECIAL-ORDER-EVENTS |
| Current Version | V2 |
| Attribute | Format | Length | Required | Description | Example |
| order_ref | Alphanumeric | 3-255 | Yes | Order reference descriptor | 103495 |
| line_item_ref | Alphanumeric | 3-255 | Yes | Order line item descriptor | 103495-1 |
| sequence | Numeric | 1-3 | Yes | Position 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_ref | 3 |
| description | Alphanumeric | 1-255 | Yes | Short description of event | Sent to fabrication |
| created_at | Datetime ISO 8601 | 10 | Yes | Date and time the event occurred | 2022-01-17T19:23:22Z |
| reference | Alphanumeric | 1-65535 | No | General 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_required | Boolean [TRUE|FALSE] | Yes | Determine if this event requires human intervention. The sales associate for this order will be alerted. | TRUE |
Notes
Theaction_required field will only trigger a visible action if this is set to TRUE for the last event in the sequence.
For example:
| Sequence | Description | action_required | Application Behavior |
|---|---|---|---|
| 3 | Sent to boutique | FALSE | Nothing |
| 4 | Received at boutique | TRUE | This event and the special order will be surfaced to the sales associate to take next steps |
| 5 | Delivered to client | FALSE | This 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 samesequence and order_ref will be ignored.