Skip to main content

Interface: Order

Defined in: type/Order.ts:15

Object class for Order

Properties​

accountManagerId?​

optional accountManagerId?: number

Defined in: type/Order.ts:23

The id of the Owner/Account Manager that will handle this order

addresses?​

optional addresses?: Address[]

Defined in: type/Order.ts:73

The addresses for the order

cartId?​

optional cartId?: string

Defined in: type/Order.ts:25

The cartId of the cart that this order is created from.

channelId​

channelId: number

Defined in: type/Order.ts:27

The channel identifier of the webshop this order originated from

companyId?​

optional companyId?: number

Defined in: type/Order.ts:79

The companyId of the company that placed this order

createdAt​

createdAt: string

Defined in: type/Order.ts:59

The date and time the order was placed

currency​

currency: string

Defined in: type/Order.ts:53

Currency used to place this order

currencyRatio​

currencyRatio: number

Defined in: type/Order.ts:55

The currency's exchange rate at the time the order was placed

debtorId?​

optional debtorId?: string

Defined in: type/Order.ts:31

The debtorId of the Customer or Company that placed this Order

email​

email: string

Defined in: type/Order.ts:39

The email address for transactional emails

emailDate?​

optional emailDate?: string

Defined in: type/Order.ts:41

The date the last transactional email was sent for this order

exportedAt?​

optional exportedAt?: string

Defined in: type/Order.ts:85

The date and time the order was exported

exportMessage?​

optional exportMessage?: string

Defined in: type/Order.ts:89

Order export message

exportStatus?​

optional exportStatus?: OrderExportStatus

Defined in: type/Order.ts:87

Order export status of this order

extra3?​

optional extra3?: string

Defined in: type/Order.ts:48

extra3: Open text field to add meta data on an Order. The field will not be visible to Propeller admins, but can be used to be displayed on front-ends or be used in integrations.

extra4?​

optional extra4?: string

Defined in: type/Order.ts:51

extra4: Open text field to add meta data on an Order. The field will not be visible to Propeller admins, but can be used to be displayed on front-ends or be used in integrations.

id​

id: number

Defined in: type/Order.ts:17

The auto-incremental id for this order

invoiceUserId?​

optional invoiceUserId?: number

Defined in: type/Order.ts:75

The id of the User, contact or Customer that should receive the invoice for this Order

items​

items: OrderItem[]

Defined in: type/Order.ts:69

The items included in the order

language​

language: string

Defined in: type/Order.ts:57

The selected language on the webshop at the time the order was placed

lastModifiedAt​

lastModifiedAt: string

Defined in: type/Order.ts:81

The date and time the order was last modified

media?​

optional media?: OrderMedia

Defined in: type/Order.ts:19

media field

orderAddresses​

orderAddresses: OrderAddress[]

Defined in: type/Order.ts:91

orderAddresses field

originalOrderId?​

optional originalOrderId?: number

Defined in: type/Order.ts:83

Original order id

paymentData​

paymentData: OrderPaymentData

Defined in: type/Order.ts:65

The payment data of the order

postageData​

postageData: OrderPostageData

Defined in: type/Order.ts:63

The postage data of the order

reference?​

optional reference?: string

Defined in: type/Order.ts:45

Reference added by the customer about this order

remarks?​

optional remarks?: string

Defined in: type/Order.ts:43

Remarks added by the customer about this order

shipments?​

optional shipments?: Shipment[]

Defined in: type/Order.ts:71

The shipments for the order

source?​

optional source?: string

Defined in: type/Order.ts:37

The source this order originates from

sources?​

optional sources?: Source[]

Defined in: type/Order.ts:93

Order sources

status​

status: string

Defined in: type/Order.ts:33

The processing status for this order

statusDate?​

optional statusDate?: string

Defined in: type/Order.ts:61

The date and time the status of the order was last changed

total​

total: OrderTotals

Defined in: type/Order.ts:67

The totals of the order

type​

type: OrderType

Defined in: type/Order.ts:35

The type of this order

userId?​

optional userId?: number

Defined in: type/Order.ts:21

The userId of the user that placed this order

uuid​

uuid: string

Defined in: type/Order.ts:29

Unique identifier for this order

validUntil?​

optional validUntil?: string

Defined in: type/Order.ts:77

The date and time until the order is valid