Typescript SDK Type Docs
    Preparing search index...

    Interface OrderImport

    Represents the data used to import an Order. Once imported, this data is persisted as an Order in the Project.

    An OrderImport is a snapshot of an order at the time it was imported.
    interface OrderImport {
        billingAddress?: Address;
        completedAt?: string;
        country?: string;
        custom?: Custom;
        customer?: CustomerKeyReference;
        customerEmail?: string;
        customerGroup?: CustomerGroupKeyReference;
        customLineItems?: CustomLineItemDraft[];
        inventoryMode?: InventoryMode;
        itemShippingAddresses?: Address[];
        lineItems?: LineItemImportDraft[];
        orderNumber: string;
        orderState?: OrderState;
        origin?: CartOrigin;
        paymentState?: PaymentState;
        shipmentState?: ShipmentState;
        shippingAddress?: Address;
        shippingInfo?: ShippingInfoImportDraft;
        state?: StateKeyReference;
        store?: StoreKeyReference;
        taxCalculationMode?: TaxCalculationMode;
        taxedPrice?: TaxedPrice;
        taxRoundingMode?: RoundingMode;
        totalPrice: TypedMoney;
    }
    Index

    Properties

    billingAddress? completedAt? country? custom? customer? customerEmail? customerGroup? customLineItems? inventoryMode? itemShippingAddresses? lineItems? orderNumber orderState? origin? paymentState? shipmentState? shippingAddress? shippingInfo? state? store? taxCalculationMode? taxedPrice? taxRoundingMode? totalPrice

    Properties

    billingAddress?: Address

    Maps to Order.billingAddress.

    completedAt?: string

    Maps to Order.completedAt.

    country?: string

    Maps to Order.country.

    custom?: Custom

    Maps to Order.custom.

    customer?: CustomerKeyReference

    key of the Customer that the Order belongs to. If the referenced Customer does not exist, the state of the ImportOperation will be set to unresolved until the referenced Customer is created.

    customerEmail?: string

    Maps to Order.customerEmail.

    customerGroup?: CustomerGroupKeyReference

    Maps to Order.customerGroup. If the referenced CustomerGroup does not exist, the state of the ImportOperation will be set to unresolved until the referenced CustomerGroup is created.

    customLineItems?: CustomLineItemDraft[]

    Maps to Order.customLineItems

    inventoryMode?: InventoryMode

    Maps to Order.inventoryMode.

    itemShippingAddresses?: Address[]

    Maps to Order.itemShippingAddresses.

    lineItems?: LineItemImportDraft[]

    Maps to Order.lineItems.

    orderNumber: string

    Maps to Order.orderNumber, String that uniquely identifies an order. It should be unique across a project. Once it's set it cannot be changed.

    orderState?: OrderState

    Maps to Order.orderState.

    origin?: CartOrigin

    Maps to Order.origin.

    paymentState?: PaymentState

    Maps to Order.paymentState.

    shipmentState?: ShipmentState

    Maps to Order.shipmentState.

    shippingAddress?: Address

    Maps to Order.shippingAddress.

    shippingInfo?: ShippingInfoImportDraft

    Maps to Order.shippingInfo.

    state?: StateKeyReference

    Maps to Order.state. If the referenced State does not exist, the state of the ImportOperation will be set to unresolved until the referenced State is created.

    store?: StoreKeyReference

    Maps to Order.store. If the referenced Store does not exist, the state of the ImportOperation will be set to unresolved until the referenced Store is created.

    taxCalculationMode?: TaxCalculationMode

    Maps to Order.taxCalculationMode.

    taxedPrice?: TaxedPrice

    Maps to Order.taxedPrice.

    taxRoundingMode?: RoundingMode

    Maps to Order.taxRoundingMode.

    totalPrice: TypedMoney

    Maps to Order.totalPrice.

    Settings

    Member Visibility

    On This Page

    Properties