Product-Documentation

Enumerations

Item Status

Only the Shipped, Packed and Printed status should be set by the API, to avoid conflicts with internal workflows.

Value Name Description
(0) Shipped The item has been sent to its destination.
(1) Unreviewed The item has been ordered but is pending review.
(2) PendingData The item is pending the arrival of data.
(3) PendingPrepReady The item is pending manual actions from an administrator.
(4) Ready The item is ready for production.
(5) Sent The item sent for output generation, but not generated yet.
(6) Rendered The item has been generated but not yet produced.
(7) Failed An error has occured during output generation.
(8) Packed The item has been packed.
(9) Printed The item produced and is ready to be sent.
(10) Rejected The item has been rejected.

Currency

Value Name Description
(0) eUnknown Any currency other than GBP, EUR or USD.
(1) ePound United Kingdom Pound Sterling (GBP)
(2) eDollar United States of America Dollar (USD)
(3) eEuro European Union Euro (EUR)This event is called after an individual Order Item in an Order is rendered.

Event

Value Name Description
(0) OrderCreated This event is called after an order is placed. If any approvals are required in the Order, this event will instead be triggered after all items in the Order have been approved or declined.
(1) OrderReadyForProduction This event is called after an Order is ready for production after approvals and payments.
(2) OrderItemRendered This event is called after an individual Order Item in an Order is rendered.