API Reference
Log In
API Reference

Orders

Response

ParamTypeDescription
@entitystringThe entity type, indicating this is a paginated list.
itemsarrayA list of order objects. Each object contains details of an order.

Order

ParamTypeDescription
idstringA unique identifier for the order.
created_atlongTimestamp indicating when the order was created (in milliseconds since epoch).
updated_atlongTimestamp indicating when the order was last updated (in milliseconds since epoch).
@entitystringThe entity type, indicating this is an order.
statusstring (Enum)The current status of the order.

Values:
CREATED, CONFIRMED, FAILED, COMPLETED, CANCELLED.
order_timelongTimestamp indicating the time of the order (in milliseconds since epoch).
resolved_timelongTimestamp indicating when the order was resolved (in milliseconds since epoch).
resolved_datelongDate when the order was resolved (in milliseconds since epoch).
total_pricefloatThe total price of the order including GST.
sub_totalfloatThe price of the order excluding GST.
discountfloatThe discount applied to the order.
gst_amountfloatThe amount of GST applied to the order.
price_including_gstbooleanA boolean flag indicating whether the price includes GST.
Language
Credentials
Header
Click Try It! to start a request and see the response here!