@avvyr/storefront-sdk - v0.19.0
    Preparing search index...

    Interface Order

    interface Order {
        appliedDiscountCodes?: OrderAppliedDiscountCode[];
        billingAddress?: Address;
        currencyCode: string;
        customer?: CartCustomer;
        invoices?: OrderInvoice[];
        lineItems: OrderLineItem[];
        orderDate: string;
        orderNumber: string;
        paymentStatus: string;
        publicToken?: string;
        remainingAmount?: number;
        shipmentOrders?: OrderShipmentOrder[];
        shipments?: OrderShipment[];
        shipmentStatus: string;
        shippingAddress?: Address;
        shippingDetails?: OrderShippingDetails;
        shippingLines?: {
            carrier?: string | null;
            name?: string | null;
            shipmentOrderId?: string | null;
            totalAmountExVat: number;
            totalAmountIncVat: number;
            vatAmount: number;
            vatRate: number;
        }[];
        totalAmountExVat: number;
        totalAmountIncVat: number;
        totalDiscountAmountExVat?: number;
        totalDiscountAmountIncVat?: number;
        vatAmount: number;
        [key: string]: unknown;
    }

    Indexable

    • [key: string]: unknown
    Index
    appliedDiscountCodes? billingAddress? currencyCode customer? invoices? lineItems orderDate orderNumber paymentStatus publicToken? remainingAmount? shipmentOrders? shipments? shipmentStatus shippingAddress? shippingDetails? shippingLines? totalAmountExVat totalAmountIncVat totalDiscountAmountExVat? totalDiscountAmountIncVat? vatAmount
    appliedDiscountCodes?: OrderAppliedDiscountCode[]
    billingAddress?: Address
    currencyCode: string
    customer?: CartCustomer
    invoices?: OrderInvoice[]

    Invoices issued by the merchant's accounting system for this order. An order can carry several: a partially delivered order is normally invoiced once per delivery. Only finalised invoices appear here — a draft still being edited in the ERP does not.

    lineItems: OrderLineItem[]
    orderDate: string
    orderNumber: string
    paymentStatus: string
    publicToken?: string
    remainingAmount?: number
    shipmentOrders?: OrderShipmentOrder[]

    Fulfillment units — how the order is split for delivery/pickup

    shipments?: OrderShipment[]

    Actual shipments with tracking info

    shipmentStatus: string
    shippingAddress?: Address
    shippingDetails?: OrderShippingDetails
    shippingLines?: {
        carrier?: string | null;
        name?: string | null;
        shipmentOrderId?: string | null;
        totalAmountExVat: number;
        totalAmountIncVat: number;
        vatAmount: number;
        vatRate: number;
    }[]

    Every shipping charge on the order, one per shipment.

    totalAmountExVat: number
    totalAmountIncVat: number
    totalDiscountAmountExVat?: number
    totalDiscountAmountIncVat?: number
    vatAmount: number

    Settings
    Member Visibility

    On This Page
    Properties