Interface StagedOrder

interface StagedOrder {
    anonymousId?: string;
    billingAddress?: Address;
    businessUnit?: BusinessUnitKeyReference;
    cart?: CartReference;
    completedAt?: string;
    country?: string;
    createdAt: string;
    createdBy?: CreatedBy;
    custom?: CustomFields;
    customLineItems: CustomLineItem[];
    customerEmail?: string;
    customerGroup?: CustomerGroupReference;
    customerId?: string;
    discountCodes?: DiscountCodeInfo[];
    id: string;
    inventoryMode?: string;
    itemShippingAddresses?: Address[];
    lastMessageSequenceNumber?: number;
    lastModifiedAt: string;
    lastModifiedBy?: LastModifiedBy;
    lineItems: LineItem[];
    locale?: string;
    orderNumber?: string;
    orderState: string;
    origin: string;
    paymentInfo?: PaymentInfo;
    paymentState?: string;
    purchaseOrderNumber?: string;
    quote?: QuoteReference;
    refusedGifts: CartDiscountReference[];
    returnInfo?: ReturnInfo[];
    shipmentState?: string;
    shipping: Shipping[];
    shippingAddress?: Address;
    shippingCustomFields?: CustomFields;
    shippingInfo?: ShippingInfo;
    shippingKey?: string;
    shippingMode: string;
    shippingRateInput?: ShippingRateInput;
    state?: StateReference;
    store?: StoreKeyReference;
    syncInfo: SyncInfo[];
    taxCalculationMode?: string;
    taxMode?: string;
    taxRoundingMode?: string;
    taxedPrice?: TaxedPrice;
    taxedShippingPrice?: TaxedPrice;
    totalPrice: TypedMoney;
    version: number;
}

Hierarchy

Properties

anonymousId? billingAddress? businessUnit? cart? completedAt? country? createdAt createdBy? custom? customLineItems customerEmail? customerGroup? customerId? discountCodes? id inventoryMode? itemShippingAddresses? lastMessageSequenceNumber? lastModifiedAt lastModifiedBy? lineItems locale? orderNumber? orderState origin paymentInfo? paymentState? purchaseOrderNumber? quote? refusedGifts returnInfo? shipmentState? shipping shippingAddress? shippingCustomFields? shippingInfo? shippingKey? shippingMode shippingRateInput? state? store? syncInfo taxCalculationMode? taxMode? taxRoundingMode? taxedPrice? taxedShippingPrice? totalPrice version

Properties

Optional Readonly anonymousId

anonymousId?: string

Identifies carts and orders belonging to an anonymous session (the customer has not signed up/in yet).

Optional Readonly billingAddress

billingAddress?: Address

Optional Readonly businessUnit

businessUnit?: BusinessUnitKeyReference

The Business Unit the Order belongs to.

Optional Readonly cart

cart?: CartReference

Set when this order was created from a cart. The cart will have the state Ordered.

Optional Readonly completedAt

completedAt?: string

This field will only be present if it was set for Order Import

Optional Readonly country

country?: string

A two-digit country code as per ISO 3166-1 alpha-2. Used for product variant price selection.

Readonly createdAt

createdAt: string

Optional Readonly createdBy

createdBy?: CreatedBy

Present on resources created after 1 February 2019 except for events not tracked.

Optional Readonly custom

custom?: CustomFields

Readonly customLineItems

customLineItems: CustomLineItem[]

Optional Readonly customerEmail

customerEmail?: string

Optional Readonly customerGroup

customerGroup?: CustomerGroupReference

Set when the customer is set and the customer is a member of a customer group. Used for product variant price selection.

Optional Readonly customerId

customerId?: string

Optional Readonly discountCodes

discountCodes?: DiscountCodeInfo[]

Readonly id

id: string

Unique identifier of the Order.

Optional Readonly inventoryMode

inventoryMode?: string

Optional Readonly itemShippingAddresses

itemShippingAddresses?: Address[]

Contains addresses for orders with multiple shipping addresses.

Optional Readonly lastMessageSequenceNumber

lastMessageSequenceNumber?: number

Internal-only field.

Deprecated

Readonly lastModifiedAt

lastModifiedAt: string

Optional Readonly lastModifiedBy

lastModifiedBy?: LastModifiedBy

Present on resources created after 1 February 2019 except for events not tracked.

Readonly lineItems

lineItems: LineItem[]

Optional Readonly locale

locale?: string

Optional Readonly orderNumber

orderNumber?: string

String that uniquely identifies an order. It can be used to create more human-readable (in contrast to ID) identifier for the order. It should be unique across a project. Once it's set it cannot be changed.

Readonly orderState

orderState: string

One of the four predefined OrderStates.

Readonly origin

origin: string

Optional Readonly paymentInfo

paymentInfo?: PaymentInfo

Optional Readonly paymentState

paymentState?: string

Optional Readonly purchaseOrderNumber

purchaseOrderNumber?: string

The Purchase Order Number is typically set by the Buyer on a QuoteRequest to track the purchase order during the quote and order flow.

Optional Readonly quote

quote?: QuoteReference

Set when this order was created from a quote.

Readonly refusedGifts

refusedGifts: CartDiscountReference[]

Automatically filled when a line item with LineItemMode GiftLineItem is removed from this order.

Optional Readonly returnInfo

returnInfo?: ReturnInfo[]

Optional Readonly shipmentState

shipmentState?: string

Readonly shipping

shipping: Shipping[]

Holds all shipping-related information per Shipping Method for Multi ShippingMode.

It is updated automatically after the [Shipping Method is added](ctp:api:type:CartAddShippingMethodAction).

Optional Readonly shippingAddress

shippingAddress?: Address

Holds all shipping-related information per Shipping Method.

For `Multi` [ShippingMode](ctp:api:typeShippingMode), it is updated automatically after the Shipping Methods are added.

Optional Readonly shippingCustomFields

shippingCustomFields?: CustomFields

Custom Fields of the Shipping Method for Single ShippingMode.

Optional Readonly shippingInfo

shippingInfo?: ShippingInfo

Set if the ShippingMethod is set.

Optional Readonly shippingKey

shippingKey?: string

User-defined unique identifier of the Shipping Method with Single ShippingMode.

Readonly shippingMode

shippingMode: string

Indicates whether one or multiple Shipping Methods are added to the Cart.

Optional Readonly shippingRateInput

shippingRateInput?: ShippingRateInput

Input used to select a ShippingRatePriceTier. The data type of this field depends on the shippingRateInputType.type configured in the Project:

- If `CartClassification`, it is [ClassificationShippingRateInput](ctp:api:type:ClassificationShippingRateInput).
- If `CartScore`, it is [ScoreShippingRateInput](ctp:api:type:ScoreShippingRateInput).
- If `CartValue`, it cannot be used.

Optional Readonly state

state?: StateReference

This reference can point to a state in a custom workflow.

Optional Readonly store

store?: StoreKeyReference

Readonly syncInfo

syncInfo: SyncInfo[]

Optional Readonly taxCalculationMode

taxCalculationMode?: string

When calculating taxes for taxedPrice, the selected mode is used for calculating the price with LineItemLevel (horizontally) or UnitPriceLevel (vertically) calculation mode.

Optional Readonly taxMode

taxMode?: string

Optional Readonly taxRoundingMode

taxRoundingMode?: string

When calculating taxes for taxedPrice, the selected mode is used for rouding.

Optional Readonly taxedPrice

taxedPrice?: TaxedPrice

The taxes are calculated based on the shipping address.

Optional Readonly taxedShippingPrice

taxedShippingPrice?: TaxedPrice

Sum of taxedPrice of ShippingInfo across all Shipping Methods. For Platform TaxMode, it is set automatically only if shipping address is set or Shipping Method is added to the Cart.

Readonly totalPrice

totalPrice: TypedMoney

Readonly version

version: number

The current version of the order.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc