Interface Order

interface Order {
    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;
    directDiscounts?: DirectDiscount[];
    discountCodes?: DiscountCodeInfo[];
    discountOnTotalPrice?: DiscountOnTotalPrice;
    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 (view full)

Properties

anonymousId? billingAddress? businessUnit? cart? completedAt? country? createdAt createdBy? custom? customLineItems customerEmail? customerGroup? customerId? directDiscounts? discountCodes? discountOnTotalPrice? 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

Anonymous session associated with the Order.

Optional Readonly billingAddress

billingAddress?: Address

Billing address associated with the Order.

Optional Readonly businessUnit

businessUnit?: BusinessUnitKeyReference

Reference to a Business Unit the Order belongs to.

Optional Readonly cart

cart?: CartReference

Reference to the Cart for an Order created from Cart. The referenced Cart will have the Ordered CartState.

Optional Readonly completedAt

completedAt?: string

User-defined date and time (UTC) of the Order. Present only on an Order created using Order Import.

Optional Readonly country

country?: string

Used for Line Item price selection.

Readonly createdAt

createdAt: string

Date and time (UTC) the Order was initially created.

Optional Readonly createdBy

createdBy?: CreatedBy

IDs and references that created the Order.

Optional Readonly custom

custom?: CustomFields

Custom Fields of the Order.

Readonly customLineItems

customLineItems: CustomLineItem[]

Custom Line Items that are part of the Order.

Optional Readonly customerEmail

customerEmail?: string

Email address of the Customer that the Order belongs to.

Optional Readonly customerGroup

customerGroup?: CustomerGroupReference

Reference to the Customer Group of the Customer that the Order belongs to. Used for Line Item price selection.

Optional Readonly customerId

customerId?: string

id of the Customer that the Order belongs to.

Optional Readonly directDiscounts

directDiscounts?: DirectDiscount[]

Direct Discounts added to the Order. An Order that has discountCodes cannot have directDiscounts.

Optional Readonly discountCodes

discountCodes?: DiscountCodeInfo[]

Discount Codes added to the Order. An Order that has directDiscounts cannot have discountCodes.

Optional Readonly discountOnTotalPrice

discountOnTotalPrice?: DiscountOnTotalPrice

Discounts that apply on the total price of the Order.

Readonly id

id: string

Unique identifier of the Order.

Optional Readonly inventoryMode

inventoryMode?: string

Indicates how stock quantities are tracked for Line Items in the Order.

Optional Readonly itemShippingAddresses

itemShippingAddresses?: Address[]

Additional shipping addresses of the Order as specified by LineItems using the shippingDetails field. Eligible Shipping Methods or applicable Tax Rates are determined by the address in shippingAddress, and not itemShippingAddresses.

Optional Readonly lastMessageSequenceNumber

lastMessageSequenceNumber?: number

Internal-only field.

Deprecated

Readonly lastModifiedAt

lastModifiedAt: string

Date and time (UTC) the Order was last updated.

Optional Readonly lastModifiedBy

lastModifiedBy?: LastModifiedBy

IDs and references that last modified the Order.

Readonly lineItems

lineItems: LineItem[]

Line Items that are part of the Order.

Optional Readonly locale

locale?: string

Languages of the Order. Can only contain languages supported by the Project.

Optional Readonly orderNumber

orderNumber?: string

User-defined identifier of the Order that is unique across a Project.

Readonly orderState

orderState: string

Current status of the Order.

Readonly origin

origin: string

Indicates the origin of the Cart from which the Order was created.

Optional Readonly paymentInfo

paymentInfo?: PaymentInfo

Payment information related to the Order.

Optional Readonly paymentState

paymentState?: string

Payment status of the Order.

Optional Readonly purchaseOrderNumber

purchaseOrderNumber?: string

User-defined identifier of a purchase Order.

It is typically set by the [Buyer](ctp:api:type:Buyer) and can be used with [Quotes](/quotes-overview) to track the purchase Order during the [quote and order flow](/../api/quotes-overview#intended-workflow).

Optional Readonly quote

quote?: QuoteReference

Reference to the Quote for an Order created from Quote.

Readonly refusedGifts

refusedGifts: CartDiscountReference[]

Automatically set when a Line Item with GiftLineItem LineItemMode is removed from the Order.

Optional Readonly returnInfo

returnInfo?: ReturnInfo[]

Contains information regarding the returns associated with the Order.

Optional Readonly shipmentState

shipmentState?: string

Shipment status of the Order.

Readonly shipping

shipping: Shipping[]

Shipping-related information for Multiple ShippingMode. Updated automatically each time a new Shipping Method is added.

Optional Readonly shippingAddress

shippingAddress?: Address

Shipping address associated with the Order. Determines eligible ShippingMethod rates and Tax Rates of Line Items.

Optional Readonly shippingCustomFields

shippingCustomFields?: CustomFields

Custom Fields of the Shipping Method for Single ShippingMode.

Optional Readonly shippingInfo

shippingInfo?: ShippingInfo

Shipping-related information for Single ShippingMode. Automatically set when a Shipping Method is set.

Optional Readonly shippingKey

shippingKey?: string

key of the ShippingMethod for Single ShippingMode.

Readonly shippingMode

shippingMode: string

Indicates whether there can be one or multiple Shipping Methods.

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

State of the Order. This reference can point to a State in a custom workflow.

Optional Readonly store

store?: StoreKeyReference

Reference to a Store the Order belongs to.

Readonly syncInfo

syncInfo: SyncInfo[]

Contains synchronization activity information of the Order (like export or import). Can only be set with Update SyncInfo update action.

Optional Readonly taxCalculationMode

taxCalculationMode?: string

Indicates how taxes are calculated when calculating taxes for taxedPrice.

Optional Readonly taxMode

taxMode?: string

Indicates how Tax Rates are set.

Optional Readonly taxRoundingMode

taxRoundingMode?: string

Indicates how monetary values are rounded when calculating taxes for taxedPrice.

Optional Readonly taxedPrice

taxedPrice?: TaxedPrice

  • For Platform TaxMode, it is automatically set when a shipping address is set.

    • For External TaxMode, it is automatically set when shippingAddress and external Tax Rates for all Line Items, Custom Line Items, and Shipping Methods in the Cart are set.

    If a discount applies on totalPrice, this field holds the discounted values.

Optional Readonly taxedShippingPrice

taxedShippingPrice?: TaxedPrice

Sum of the taxedPrice field of ShippingInfo across all Shipping Methods.

Readonly totalPrice

totalPrice: TypedMoney

Sum of the totalPrice field of all LineItems and CustomLineItems, and if available, the price field of ShippingInfo. If a discount applies on totalPrice, this field holds the discounted value.

Taxes are included if [TaxRate](ctp:api:type:TaxRate) `includedInPrice` is `true` for each price.

Readonly version

version: number

Current version of the Order.

Settings

Member Visibility

Theme

On This Page

anonymousIdbillingAddressbusinessUnitcartcompletedAtcountrycreatedAtcreatedBycustomcustomLineItemscustomerEmailcustomerGroupcustomerIddirectDiscountsdiscountCodesdiscountOnTotalPriceidinventoryModeitemShippingAddresseslastMessageSequenceNumberlastModifiedAtlastModifiedBylineItemslocaleorderNumberorderStateoriginpaymentInfopaymentStatepurchaseOrderNumberquoterefusedGiftsreturnInfoshipmentStateshippingshippingAddressshippingCustomFieldsshippingInfoshippingKeyshippingModeshippingRateInputstatestoresyncInfotaxCalculationModetaxModetaxRoundingModetaxedPricetaxedShippingPricetotalPriceversion