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](ctp:import:endpoint:/{projectKey}/orders/import:POST)
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;
    customLineItems?: CustomLineItemDraft[];
    customer?: CustomerKeyReference;
    customerEmail?: string;
    customerGroup?: CustomerGroupKeyReference;
    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;
    taxRoundingMode?: string;
    taxedPrice?: TaxedPrice;
    totalPrice: TypedMoney;
}

Properties

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

Properties

Optional Readonly billingAddress

billingAddress?: Address

Maps to Order.billingAddress.

Optional Readonly completedAt

completedAt?: string

Maps to Order.completedAt.

Optional Readonly country

country?: string

Maps to Order.country.

Optional Readonly custom

custom?: Custom

Maps to Order.custom.

Optional Readonly customLineItems

customLineItems?: CustomLineItemDraft[]

Maps to Order.customLineItems

Optional Readonly customer

customer?: CustomerKeyReference

Optional Readonly customerEmail

customerEmail?: string

Maps to Order.customerEmail.

Optional Readonly customerGroup

customerGroup?: CustomerGroupKeyReference

Maps to Order.customerGroup.

Optional Readonly inventoryMode

inventoryMode?: string

Maps to Order.inventoryMode.

Optional Readonly itemShippingAddresses

itemShippingAddresses?: Address[]

Maps to Order.itemShippingAddresses.

Optional Readonly lineItems

lineItems?: LineItemImportDraft[]

Maps to Order.lineItems.

Readonly orderNumber

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 Readonly orderState

orderState?: string

Maps to Order.orderState.

Optional Readonly origin

origin?: string

Maps to Order.origin.

Optional Readonly paymentState

paymentState?: string

Maps to Order.paymentState.

Optional Readonly shipmentState

shipmentState?: string

Maps to Order.shipmentState.

Optional Readonly shippingAddress

shippingAddress?: Address

Maps to Order.shippingAddress.

Optional Readonly shippingInfo

shippingInfo?: ShippingInfoImportDraft

Maps to Order.shippingInfo.

Optional Readonly state

state?: StateKeyReference

Reference to a State in a custom workflow.

Optional Readonly store

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 Readonly taxCalculationMode

taxCalculationMode?: string

Maps to Order.taxCalculationMode.

Optional Readonly taxRoundingMode

taxRoundingMode?: string

Maps to Order.taxRoundingMode.

Optional Readonly taxedPrice

taxedPrice?: TaxedPrice

Maps to Order.taxedPrice.

Readonly totalPrice

totalPrice: TypedMoney

Maps to Order.totalPrice.

Settings

Member Visibility

Theme

On This Page

billingAddresscompletedAtcountrycustomcustomLineItemscustomercustomerEmailcustomerGroupinventoryModeitemShippingAddresseslineItemsorderNumberorderStateoriginpaymentStateshipmentStateshippingAddressshippingInfostatestoretaxCalculationModetaxRoundingModetaxedPricetotalPrice