Orders

Field reference for objects returned by GET orders and GET orders/{reference}. Create an order with POST orders.

Order object

Field	Type	Description
id	Number	The internal unique identifier of the order.
external_id	String	The external order ID from your system.
reference	String	The unique Dropday reference for the order.
source	String	The source/origin of the order (e.g., webshop name).
test	Boolean	Indicates if this is a test order.
blocked	Boolean	Indicates if the order is blocked from processing.
total	Number	The total amount of the order.
shipping_address	Object	The shipping address details.
email	String	Email address of the recipient.
first_name	String	First name of the recipient.
last_name	String	Last name of the recipient.
company_name	String	Company name (if applicable).
phone	String	Phone number of the recipient.
address1	String	Primary address line (street and house number).
address2	String	Secondary address line (apartment, suite, etc.).
city	String	City name.
postcode	String	Postal/ZIP code.
state	String	State or province.
country	String	Country name of the shipping address.
country_iso	String	ISO 3166-1 alpha-2 country code for the shipping address.
shipping	Object	Shipping method details.
cost	Number	The shipping cost.
name	String	Name of the shipping carrier/method.
description	String	Description of the shipping method.
note	String	Additional delivery instructions.
delivery_date	String	Expected delivery date.
custom	Object	Custom fields as key-value pairs.
order_lines	Object[]	Array of order line items.
suppliers	Object[]	Array of unique suppliers for this order.
created_at	String	ISO 8601 timestamp when the order was created.
updated_at	String	ISO 8601 timestamp when the order was last updated.
completed_at	String|null	ISO 8601 timestamp when the order reached its final state. null if the order hasn't completed yet.

Order line object

Field	Type	Description
id	Number	The internal unique identifier of the order line.
external_id	String	The external product ID from your system.
name	String	The name/description of the product.
ean13	String	The EAN-13 barcode of the product.
reference	String	The SKU or reference code of the product.
quantity	Number	The quantity ordered.
stock_quantity	Number	The available stock quantity at time of order.
price	Number	The selling price of the product.
purchase_price	Number	The purchase/cost price from the supplier.
height	Number	The height of the product.
width	Number	The width of the product.
length	Number	The length of the product.
weight	Number	The weight of the product.
brand	String	The brand of the product.
category	String	The category of the product.
image_url	String	URL to the product image.
custom	Object	Custom fields as key-value pairs.
labels	String[]	Array of labels attached to this order line. Empty array if none set.
current_status	String	Current status: pending, ruled, completed, partially_completed, failed, declined, skipped.
supplier optional	String	Free-text supplier name supplied by the merchant/integration at order-creation time.
matched_supplier	Object	The Dropday supplier assigned to this order line by the rule engine. Only present once rules have run.
id	Number	The supplier's unique identifier.
name	String	The supplier's name.
logs	Object[]	Array of status change logs (included when fetching a single order).

supplier and matched_supplier are independent fields. supplier is an informational string passed in by the caller when the order is created. matched_supplier is the actual Dropday supplier object ({id, name}) assigned by Dropday's rule engine; it is only present once rules have run.

Supplier object

Field	Type	Description
id	Number	The supplier's unique identifier.
name	String	The supplier's name.