Skip to content

Type

Order

Back to Index

Definition

let Order: {
createdAt: instant
currencyCode: text
deliveries: [{
createdAt: instant
deliveryAddress: {
addressLine1: text
addressLine2: text
attention: text
careOf: text
city: text
countryCode: text
email: text
name: text
phone: text
postalCode: text
state: text
}
deliveryId: uuid
deliveryNumber: text
deliveryState: 'open'|'processing'|'completed'|'cancelled'|'cancelledByOrder'
dynamic: {text->*}
inventoryDate: nothing|instant
inventoryKey: nothing|text
orderLines: [{
description: text|nothing
dynamic: {text->*}
image: text|nothing
orderLineId: uuid
orderLineNumber: text
orderLineTotal: number
productNumber: text
quantity: number
releasedToInvoice: boolean
salesQuantity: number
taxFactor: number
taxTotal: number
unitPrice: number
}]
releasedToInvoice: boolean
shippingDescription: nothing|text
shippingPrice: number
shippingProductNumber: nothing|text
shippingTaxFactor: number
shippingTaxTotal: number
shippingTotal: number
tags: {number->text}
}]
dynamic: {text->*}
invoiceAddress: {
addressLine1: text
addressLine2: text
attention: text
careOf: text
city: text
countryCode: text
email: text
name: text
phone: text
postalCode: text
state: text
}
invoices: [{
createdAt: instant
invoiceAddress: {
addressLine1: text
addressLine2: text
attention: text
careOf: text
city: text
countryCode: text
email: text
name: text
phone: text
postalCode: text
state: text
}
invoiceId: uuid
invoiceLines: [{
amount: number
description: nothing|text
discounts: [{
amount: number
discountId: uuid
invoiceLineDiscountId: uuid
invoiceLineNumber: number
taxFactor: number
}]
invoiceLineId: uuid
invoiceLineNumber: number
invoiceLineTotal: number
productNumber: nothing|text
referenceId: uuid
referenceType: 'orderLine'|'return'|'shipping'
taxFactor: number
unit: {
label: text
quantity: number
value: number
}
}]
invoiceNetTotal: number
invoiceNumber: text
invoiceTotal: number
isCancelled: boolean
}]
journalEntries: [{
amount: number
invoiceId: uuid|nothing
orderJournalEntryId: uuid
orderJournalEntryType: 'receivable'|'capture'|'clearing'|'fee'
paymentId: uuid|nothing
timestamp: instant
}]
orderId: uuid
orderNumber: text
orderState: 'pending'|'confirmed'|'cancelled'
orderTaxTotal: number
orderTotal: number
tags: {number->text}
taxIncluded: boolean
}

Availability

Discount Rule Reactor
Back to Index