Application Load
IOrder
The physical TypeScript declaration from the Nuxt starter, with linked types and field comments.
IOrderA customer order with payment, contact details and shipments.
app/interfaces/orionplace/orders/IOrderHistory.tsexport interface IOrder {
// Order ID.
id: number;
// Payment method from the latest invoice, or null.
payment: IPaymentMethod | null;
// Amounts by currency: order total, paid amount, remaining amount, discounts
// and refunds. `delivery_price_is_estimate` identifies an unfinished delivery
// quote.
prices: IOrderPrices;
// Currency the order is counted and charged in: `id` of the currency and
// `rate`, its units per US dollar at checkout. Both are `null` for orders
// placed before currencies were saved.
currency: {
// Order ID.
id: number | null;
// Units of the order currency per US dollar at checkout; `null` for older
// orders.
rate: number | null;
};
// Order lifecycle state: `EOrderStatus`. Payment state is a separate field.
status: {
// Value of int.
int: EOrderStatus;
// Value of text.
text: string;
};
// Payment state: `EOrderPaymentStatus`.
payment_status: {
// Value of int.
int: EOrderPaymentStatus;
// Value of text.
text: string;
};
// Counts waiting for return, received back and awaiting refund payment.
refund_stats: IOrderRefundStats;
// Whether the latest invoice uses payment on delivery.
pay_on_delivery: boolean;
// Saved order address; `country` and `state` are single objects or null.
main_address: Omit<ICartAddress, 'location'>;
// Customer contact details and optional recipient details in `reciever_name`
// and `reciever_phone`.
contact: {
// Value of full_name.
full_name: string;
// Value of phone.
phone: string;
// Value of email.
email: string;
// Order ID.
id: number;
// Optional value of reciever_name; it may be omitted.
reciever_name?: string;
// Optional value of reciever_phone; it may be omitted.
reciever_phone?: string;
};
// Shipments with delivery method, destination, dates, tracking, prices and
// `shipment_items`. `null` when shipment data is absent.
delivery_froms: IOrderShipment[] | null;
// The customer requested cancellation.
order_self_canceled: boolean;
// Attached promotion details, when included; can be `null`.
attached_promo?: IPromoDefinition | null;
// Applied issued code, when present.
promocode?: string;
// Number of sent shipments.
c_delivery_from_sent: number;
// Number of delivered shipments.
c_delivery_from_delivered: number;
// Total shipments.
c_delivery_from: number;
// Minutes until the current unpaid invoice expires, only while that invoice
// is created and has an expiry. May be negative; null otherwise.
cancel_in_minutes: number | null;
// Order submission time.
time_submited: IApiDateTime | null;
// Customer comment saved with the order.
user_comment: string;
}