Interface OrderImport

The data representation for an Order to be imported that is persisted as an Order in the Project.

In commercetools, you can import an Order using the [Create Order by Import](/projects/orders-import#create-order-by-import) endpoint method instead of creating it from a Cart.

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?: string;
    itemShippingAddresses?: Address[];
    lineItems?: LineItemImportDraft[];
    orderNumber: string;
    orderState?: string;
    origin?: string;
    paymentState?: string;
    shipmentState?: string;
    shippingAddress?: Address;
    shippingInfo?: ShippingInfoImportDraft;
    state?: StateKeyReference;
    store?: StoreKeyReference;
    taxCalculationMode?: string;
    taxedPrice?: TaxedPrice;
    taxRoundingMode?: string;
    totalPrice: TypedMoney;
}

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

Optional ReadonlybillingAddress

billingAddress?: Address

Maps to Order.billingAddress.

Optional ReadonlycompletedAt

completedAt?: string

Maps to Order.completedAt.

Optional Readonlycountry

country?: string

Maps to Order.country.

Optional Readonlycustom

custom?: Custom

Maps to Order.custom.

Optional Readonlycustomer

customer?: CustomerKeyReference

Optional ReadonlycustomerEmail

customerEmail?: string

Maps to Order.customerEmail.

Optional ReadonlycustomerGroup

customerGroup?: CustomerGroupKeyReference

Maps to Order.customerGroup.

Optional ReadonlycustomLineItems

customLineItems?: CustomLineItemDraft[]

Maps to Order.customLineItems

Optional ReadonlyinventoryMode

inventoryMode?: string

Maps to Order.inventoryMode.

Optional ReadonlyitemShippingAddresses

itemShippingAddresses?: Address[]

Maps to Order.itemShippingAddresses.

Optional ReadonlylineItems

lineItems?: LineItemImportDraft[]

Maps to Order.lineItems.

ReadonlyorderNumber

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.

Optional ReadonlyorderState

orderState?: string

Maps to Order.orderState.

Optional Readonlyorigin

origin?: string

Maps to Order.origin.

Optional ReadonlypaymentState

paymentState?: string

Maps to Order.paymentState.

Optional ReadonlyshipmentState

shipmentState?: string

Maps to Order.shipmentState.

Optional ReadonlyshippingAddress

shippingAddress?: Address

Maps to Order.shippingAddress.

Optional ReadonlyshippingInfo

shippingInfo?: ShippingInfoImportDraft

Maps to Order.shippingInfo.

Optional Readonlystate

state?: StateKeyReference

Reference to a State in a custom workflow.

Optional Readonlystore

store?: StoreKeyReference

Reference to the Store in which the Order is associated. If referenced Store does not exist, the state of the ImportOperation will be set to unresolved until the necessary Store exists.

Optional ReadonlytaxCalculationMode

taxCalculationMode?: string

Maps to Order.taxCalculationMode.

Optional ReadonlytaxedPrice

taxedPrice?: TaxedPrice

Maps to Order.taxedPrice.

Optional ReadonlytaxRoundingMode

taxRoundingMode?: string

Maps to Order.taxRoundingMode.

ReadonlytotalPrice

totalPrice: TypedMoney

Maps to Order.totalPrice.

Settings

Member Visibility

On This Page

Properties