Skip to main content

Interface: OrderCreateInput

Defined in: type/OrderCreateInput.ts:12

Input object for OrderCreateInput

Properties​

accountManagerId?​

optional accountManagerId?: number

Defined in: type/OrderCreateInput.ts:16

User ID of the Account Manager of the order

actionCode?​

optional actionCode?: string

Defined in: type/OrderCreateInput.ts:60

Active actioncode that was applied to this Order

addresses?​

optional addresses?: OrderCreateAddressInput[]

Defined in: type/OrderCreateInput.ts:90

Order Addresses. Expected exactly 1 invoice and 1 delivery type of address. Default empty addresses will be created if not provided

cartId?​

optional cartId?: string

Defined in: type/OrderCreateInput.ts:80

The ID of the Cart the Order belongs to

channelId?​

optional channelId?: number

Defined in: type/OrderCreateInput.ts:18

Channel ID the Order belongs to

companyId?​

optional companyId?: number

Defined in: type/OrderCreateInput.ts:66

ID of the Company of the Order

companySource?​

optional companySource?: SourceInput

Defined in: type/OrderCreateInput.ts:68

A company source

currency​

currency: string

Defined in: type/OrderCreateInput.ts:54

Order currency - ISO 4217 currency code => https://www.xe.com/iso4217.php

currencyRatio?​

optional currencyRatio?: number

Defined in: type/OrderCreateInput.ts:56

Currency conversion ratio compared the the Order's Shop's base currency

debtorCompany?​

optional debtorCompany?: string

Defined in: type/OrderCreateInput.ts:26

Company name of the Debtor [USED FOR ORDER SEARCH ONLY]

debtorFirstName?​

optional debtorFirstName?: string

Defined in: type/OrderCreateInput.ts:22

First name of the Debtor [USED FOR ORDER SEARCH ONLY]

debtorId?​

optional debtorId?: string

Defined in: type/OrderCreateInput.ts:20

Debtor ID of the User, Contact or Customer

debtorLastName?​

optional debtorLastName?: string

Defined in: type/OrderCreateInput.ts:24

Last name of the Debtor [USED FOR ORDER SEARCH ONLY]

email​

email: string

Defined in: type/OrderCreateInput.ts:42

Email address used for communication about this Order

exportedAt?​

optional exportedAt?: string

Defined in: type/OrderCreateInput.ts:72

The date and time the order was exported

exportMessage?​

optional exportMessage?: string

Defined in: type/OrderCreateInput.ts:76

Order export message

exportStatus?​

optional exportStatus?: OrderExportStatus

Defined in: type/OrderCreateInput.ts:74

Order export status of this order

externalId?​

optional externalId?: string

Defined in: type/OrderCreateInput.ts:34

ID of the Order in an external system

extra3?​

optional extra3?: string

Defined in: type/OrderCreateInput.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/OrderCreateInput.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.

invoiceUserId?​

optional invoiceUserId?: number

Defined in: type/OrderCreateInput.ts:62

ID of the User, Contact or Customer that should receive the invoice for this Order

items​

items: OrderItemCreateInput[]

Defined in: type/OrderCreateInput.ts:82

The OrderItem to create with the Order as a single bulk request

language​

language: string

Defined in: type/OrderCreateInput.ts:58

Order language - ISO 639-1 language code => https://localizely.com/iso-639-1-list/

originalOrderId?​

optional originalOrderId?: number

Defined in: type/OrderCreateInput.ts:70

Original order id

paymentData​

paymentData: OrderPaymentInput

Defined in: type/OrderCreateInput.ts:84

Order's payment data

postageData​

postageData: OrderPostageInput

Defined in: type/OrderCreateInput.ts:86

Order's postage data

recipientCompany?​

optional recipientCompany?: string

Defined in: type/OrderCreateInput.ts:32

Company name of the Recipient [USED FOR ORDER SEARCH ONLY]

recipientFirstName?​

optional recipientFirstName?: string

Defined in: type/OrderCreateInput.ts:28

First name of the Recipient [USED FOR ORDER SEARCH ONLY]

recipientLastName?​

optional recipientLastName?: string

Defined in: type/OrderCreateInput.ts:30

Last name of the Recipient [USED FOR ORDER SEARCH ONLY]

reference?​

optional reference?: string

Defined in: type/OrderCreateInput.ts:46

Reference by the customer

remarks?​

optional remarks?: string

Defined in: type/OrderCreateInput.ts:44

Remarks by the customer

shopId​

shopId: number

Defined in: type/OrderCreateInput.ts:78

The ID of the shop the Order belongs to

source?​

optional source?: string

Defined in: type/OrderCreateInput.ts:40

Source of the Order i.e. webshop, internal, external or api

status​

status: string

Defined in: type/OrderCreateInput.ts:36

Status of the Order

total​

total: OrderTotalInput

Defined in: type/OrderCreateInput.ts:88

Order's totals, tax and global discount

type​

type: OrderType

Defined in: type/OrderCreateInput.ts:38

Type of the Order

userId​

userId: number

Defined in: type/OrderCreateInput.ts:14

ID of the User, Contact or Customer of the Order

validUntil?​

optional validUntil?: string

Defined in: type/OrderCreateInput.ts:64

Date and time until the order is valid