Documentation Summary
Data Types
The API uses a number of its own enumerable data types for certain constructs.
CurrencyUnit
The API recognises Pounds, Euros and Dollars by default.
| Name | Value | Description |
|---|---|---|
| eUnknown | 0 | Unknown |
| ePound | 1 | UK Pound |
| eDollar | 2 | US Dollar |
| eEuro | 3 | EU Euro |
Event
The events listed below correspond to the available callbacks.
| Member name | Value | Description |
|---|---|---|
| OrderCreated | 0 | 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. |
| OrderReadyForProduction | 1 | This event is called after an Order is ready for production after approvals and payments. |
| OrderItemRendered | 2 | This event is called after an individual Order Item in an Order is rendered. |
OrderItemStatus
Order Items can have a wide variety of states, however some should only be set manually rather than with the API.
| Name | Value | Description |
|---|---|---|
| Shipped | 0 | The OrderItem has been sent to its destination. The user will see the item marked as completed. |
| Unreviewed | 1 | The OrderItem has been ordered but is pending reveiw. |
| PendingData | 2 | The OrderItem is pending the arrival of data, possibly an external source. |
| PendingPrep | 3 | Pending manual actions from a site administrator. |
| Ready | 4 | The OrderItem is ready for production. |
| Sent | 5 | The OrderItem has been submitted for output generation, but has yet to be generated. |
| Rendered | 6 | The OrderItem has been generated but not yet produced. |
| Failed | 7 | An error has occured during output generation. |
| Packed | 8 | The OrderItem has been packed. |
| Printed | 9 | The Order Item has been produced and is ready to be sent.(MANUAL) |
| Rejected | 10 | The Order Item has been rejected. (MANUAL) |