Order model

Orders are the building blocks of the Bolt restaurant orders API.
Each instance of an Order model represents an actual order recorded in the eshop that can be delivered to (or returned from) the contact.

An Order model has the following fields:

Field	Description
order_id	Market specific order ID you receive back when placing an order
order_ref	Order ID with the prefix attached
created_at	The exact date time of the order’s placement
first_name	First name of the customer contact
last_name	Last name of the customer contact
consignee	Name of the partner company (formerly known as “Restaurant Name”)
email	Email address of the customer contact
phone	Phone number of the customer contact
country	Country code of the customer contact
zip	ZIP (postal) code of the customer delivery address
city	City of the customer delivery address
street	Street name of the customer delivery address
house_number	House number of the customer delivery address
floor	Floor number/label of the customer delivery address
door	Door number/label of the customer delivery address
opening_hours	The opening hours of the customer
product	The name (with variation) of the product in the order
product_id	The ID of the product in the order
login	Login credential for the restaurant device
password	Password credential for the restaurant device
final_completion_date	The final delivery date for the order when it reached its end of life
order_type	Type of the order, either REGULAR, RETURN or EXCHANGE
original_order_id	ID of the original order in case the current order is a return or exchange
trackings	Array of Tracking models, representing each delivery cycle for the order
detailed_status	The latest DetailedStatus model related to the Order
serial_number	Serial number related to the product of the order
delivery_errors	Array of freetext delivery errors with their creation date and internal comment
note	This is a general free-text field that can contain any notes related to an order.
boolanga_comments	Additional comments made by administrators
bolt_comments	Additional comments made by bolt

Caution

Retrieving an Order model returns every field, the ones empty have a value of null. For example, you shouldn’t rely simply on the presence of the “final_completion_date” field if you want to check if an order is delivered, you also have to check if it has a null value.

Order IDs and Order References

The Order ID is a market specific identifier, for example 1234. Market specific means that an ecommerce system can have multiple markets running at the same time, and for each, an order with the ID 1234 can be present.

In the context of the API, the order ID is unique and only returns the correct order. For out of context purposes, there are also Order References, which consist of an order prefix or discriminator and the Order ID itself, for example BOLTRESTPT1234.

Use the Order IDs when in the context of the API, but when you have to refer to an order, for the sake of easier communication, please use the Order Reference.