@medusajs/order/dist/types/utils/index.d.ts

Medusa Order module

import { BigNumberInput, CreateOrderCreditLineDTO, OrderCreditLineDTO } from "@medusajs/framework/types";
export type VirtualOrder = {
    id: string;
    items: {
        id: string;
        order_id: string;
        return_id?: string;
        claim_id?: string;
        exchange_id?: string;
        unit_price: BigNumberInput;
        compare_at_unit_price: BigNumberInput | null;
        quantity: BigNumberInput;
        detail: {
            id?: string;
            order_id: string;
            return_id?: string;
            claim_id?: string;
            exchange_id?: string;
            item_id?: string;
            unit_price?: BigNumberInput;
            compare_at_unit_price?: BigNumberInput | null;
            quantity: BigNumberInput;
            shipped_quantity: BigNumberInput;
            fulfilled_quantity: BigNumberInput;
            delivered_quantity: BigNumberInput;
            return_requested_quantity: BigNumberInput;
            return_received_quantity: BigNumberInput;
            return_dismissed_quantity: BigNumberInput;
            written_off_quantity: BigNumberInput;
            metadata?: Record<string, unknown>;
        };
    }[];
    shipping_methods: {
        id: string;
        order_id: string;
        return_id?: string;
        claim_id?: string;
        exchange_id?: string;
        detail?: {
            id?: string;
            order_id: string;
            return_id?: string;
            claim_id?: string;
            exchange_id?: string;
        };
        amount: BigNumberInput;
    }[];
    credit_lines: (OrderCreditLineDTO | CreateOrderCreditLineDTO)[];
    summary?: {
        pending_difference: BigNumberInput;
        current_order_total: BigNumberInput;
        original_order_total: BigNumberInput;
        transaction_total: BigNumberInput;
        paid_total: BigNumberInput;
        refunded_total: BigNumberInput;
        credit_line_total: BigNumberInput;
        accounting_total: BigNumberInput;
    };
    total: BigNumberInput;
    customer_id?: string;
    transactions?: OrderTransaction[];
    metadata?: Record<string, unknown>;
};
export declare enum EVENT_STATUS {
    PENDING = "pending",
    DONE = "done"
}
export interface OrderSummaryCalculated {
    current_order_total: BigNumberInput;
    original_order_total: BigNumberInput;
    transaction_total: BigNumberInput;
    pending_difference: BigNumberInput;
    paid_total: BigNumberInput;
    refunded_total: BigNumberInput;
    credit_line_total: BigNumberInput;
    accounting_total: BigNumberInput;
}
export interface OrderTransaction {
    amount: BigNumberInput;
}
export interface OrderChangeEvent {
    action: string;
    amount?: BigNumberInput;
    reference?: string;
    reference_id?: string;
    return_id?: string;
    claim_id?: string;
    exchange_id?: string;
    change_id?: string;
    details?: any;
}
export type InternalOrderChangeEvent = OrderChangeEvent & {
    status?: EVENT_STATUS;
    original_?: InternalOrderChangeEvent;
};
export type OrderReferences = {
    action: InternalOrderChangeEvent;
    previousEvents?: InternalOrderChangeEvent[];
    currentOrder: VirtualOrder;
    summary: OrderSummaryCalculated;
    transactions: OrderTransaction[];
    type: ActionTypeDefinition;
    actions: InternalOrderChangeEvent[];
    options?: {
        addActionReferenceToObject?: boolean;
        [key: string]: unknown;
    };
};
export interface ActionTypeDefinition {
    isDeduction?: boolean;
    operation?: (obj: OrderReferences) => BigNumberInput | void;
    validate?: (obj: OrderReferences) => void;
    [key: string]: unknown;
}
//# sourceMappingURL=index.d.ts.map