Skip to main content

Interface: Order

Defined in: type/Order.ts:16

Object class for Order

Properties​

accountManagerId?​

optional accountManagerId?: number

Defined in: type/Order.ts:24

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

addresses?​

optional addresses?: Address[]

Defined in: type/Order.ts:74

The addresses for the order

cartId?​

optional cartId?: string

Defined in: type/Order.ts:26

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

channelId​

channelId: number

Defined in: type/Order.ts:28

The channel identifier of the webshop this order originated from

company?​

optional company?: Company

Defined in: type/Order.ts:97

company field

companyId?​

optional companyId?: number

Defined in: type/Order.ts:80

The companyId of the company that placed this order

createdAt​

createdAt: string

Defined in: type/Order.ts:60

The date and time the order was placed

currency​

currency: string

Defined in: type/Order.ts:54

Currency used to place this order

currencyRatio​

currencyRatio: number

Defined in: type/Order.ts:56

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

debtorId?​

optional debtorId?: string

Defined in: type/Order.ts:32

The debtorId of the Customer or Company that placed this Order

email​

email: string

Defined in: type/Order.ts:40

The email address for transactional emails

emailDate?​

optional emailDate?: string

Defined in: type/Order.ts:42

The date the last transactional email was sent for this order

exportedAt?​

optional exportedAt?: string

Defined in: type/Order.ts:86

The date and time the order was exported

exportMessage?​

optional exportMessage?: string

Defined in: type/Order.ts:90

Order export message

exportStatus?​

optional exportStatus?: OrderExportStatus

Defined in: type/Order.ts:88

Order export status of this order

extra3?​

optional extra3?: string

Defined in: type/Order.ts:49

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:52

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:18

The auto-incremental id for this order

invoiceUserId?​

optional invoiceUserId?: number

Defined in: type/Order.ts:76

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

items​

items: OrderItem[]

Defined in: type/Order.ts:70

The items included in the order

language​

language: string

Defined in: type/Order.ts:58

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

lastModifiedAt​

lastModifiedAt: string

Defined in: type/Order.ts:82

The date and time the order was last modified

media?​

optional media?: OrderMedia

Defined in: type/Order.ts:20

media field

orderAddresses​

orderAddresses: OrderAddress[]

Defined in: type/Order.ts:92

orderAddresses field

originalOrderId?​

optional originalOrderId?: number

Defined in: type/Order.ts:84

Original order id

paymentData​

paymentData: OrderPaymentData

Defined in: type/Order.ts:66

The payment data of the order

postageData​

postageData: OrderPostageData

Defined in: type/Order.ts:64

The postage data of the order

reference?​

optional reference?: string

Defined in: type/Order.ts:46

Reference added by the customer about this order

remarks?​

optional remarks?: string

Defined in: type/Order.ts:44

Remarks added by the customer about this order

shipments?​

optional shipments?: Shipment[]

Defined in: type/Order.ts:72

The shipments for the order

source?​

optional source?: string

Defined in: type/Order.ts:38

The source this order originates from

sources?​

optional sources?: Source[]

Defined in: type/Order.ts:94

Order sources

status​

status: string

Defined in: type/Order.ts:34

The processing status for this order

statusDate?​

optional statusDate?: string

Defined in: type/Order.ts:62

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

total​

total: OrderTotals

Defined in: type/Order.ts:68

The totals of the order

type​

type: OrderType

Defined in: type/Order.ts:36

The type of this order

userId?​

optional userId?: number

Defined in: type/Order.ts:22

The userId of the user that placed this order

uuid​

uuid: string

Defined in: type/Order.ts:30

Unique identifier for this order

validUntil?​

optional validUntil?: string

Defined in: type/Order.ts:78

The date and time until the order is valid