Inttegro TypeScript SDK - v8.2.0
    Preparing search index...

    Interface Order

    Order response object

    interface Order {
        billingDetails?: BillingDetails;
        cancelledAt?: string;
        checkoutSettings?: CheckoutSettings;
        completedAt?: string;
        createdAt?: string;
        currency?: Currency;
        customData?: CustomData | null;
        customer?: {
            createdAt?: string;
            emailAddress: string;
            id: string;
            name: string;
            phoneNumber: string;
        };
        customerId?: string;
        expiresAt?: string;
        id: string;
        initiatedAt?: string;
        invoice?: Invoice;
        invoiceSettings?: InvoiceSettings;
        lineItemGroup?: LineItemGroup;
        lineItems?: LineItem[];
        number?: string;
        paidAt?: string;
        payment?: Payment;
        paymentMethodId?: string;
        paymentStatus?: PaymentStatus;
        receiptNumber?: string;
        redirectUrl?: string;
        refunds?: Refund[];
        sealedAt?: string;
        shipping?: Shipping;
        statementDescriptor?: string;
        status: OrderStatus;
        subtotal?: Amount;
        tax?: Amount;
        total?: Amount;
        updatedAt?: string;
    }
    Index
    billingDetails? cancelledAt? checkoutSettings? completedAt? createdAt? currency? customData? customer? customerId? expiresAt? id initiatedAt? invoice? invoiceSettings? lineItemGroup? lineItems? number? paidAt? payment? paymentMethodId? paymentStatus? receiptNumber? redirectUrl? refunds? sealedAt? shipping? statementDescriptor? status subtotal? tax? total? updatedAt?
    billingDetails?: BillingDetails

    Billing details

    cancelledAt?: string
    checkoutSettings?: CheckoutSettings

    Checkout settings

    completedAt?: string
    createdAt?: string
    currency?: Currency
    customData?: CustomData | null

    Order-level custom metadata

    customer?: {
        createdAt?: string;
        emailAddress: string;
        id: string;
        name: string;
        phoneNumber: string;
    }

    Customer summary

    customerId?: string

    Customer ID

    expiresAt?: string
    id: string

    Order ID

    initiatedAt?: string

    Lifecycle timestamps

    invoice?: Invoice

    Invoice info

    invoiceSettings?: InvoiceSettings

    Invoice rendering metadata

    lineItemGroup?: LineItemGroup

    Grouped items (current spec)

    lineItems?: LineItem[]

    Items (legacy)

    number?: string

    Order number

    paidAt?: string
    payment?: Payment

    Payment details

    paymentMethodId?: string

    Payment method ID if saved

    paymentStatus?: PaymentStatus

    Legacy payment status

    receiptNumber?: string

    Receipt number

    redirectUrl?: string

    Redirect URL

    refunds?: Refund[]

    Refunds issued for this order, newest first. Omitted when none exist.

    sealedAt?: string
    shipping?: Shipping

    Shipping information

    statementDescriptor?: string

    Statement descriptor

    status: OrderStatus

    Order status

    subtotal?: Amount
    tax?: Amount
    total?: Amount

    Totals

    updatedAt?: string

    Settings
    Member Visibility

    On This Page
    Properties