Order

Type

Definition

let Order: {
  channelKey: nothing|text
  createdAt: instant
  currencyCode: text
  deliveries: [{
    createdAt: instant
    deliveryAddress: {
      addressLine1?: nothing|text
      addressLine2?: nothing|text
      attention?: nothing|text
      careOf?: nothing|text
      city?: nothing|text
      countryCode?: nothing|text
      email?: nothing|text
      name?: nothing|text
      phone?: nothing|text
      postalCode?: nothing|text
      state?: nothing|text
    }
    deliveryId: uuid
    deliveryNumber: text
    deliveryState: 'open'|'processing'|'completed'|'cancelled'|'cancelledByOrder'
    dynamic: {text->value}
    finalizedAt: nothing|instant
    orderLines: [{
      description: text|nothing
      dynamic: {text->value}
      image: text|nothing
      orderLineId: uuid
      orderLineNumber: text
      orderLineTotal: number
      productNumber: text
      quantity: number
      releasedToInvoice: boolean
      returnedQuantity: number
      skus: [{
        orderLineSkuId: uuid
        reservedQuantity: number
        skuNumber: text
        totalQuantity: number
        totalReturnedQuantity: number
        unitQuantity: number
      }]
      taxFactor: nothing|number
      taxTotal: number
      unitPrice: number
    }]
    releasedToInvoice: boolean
    shippingDescription: nothing|text
    shippingPrice: number
    shippingProductNumber: nothing|text
    shippingTax: number
    shippingTaxFactor: nothing|number
    shippingTotal: number
    tags: [text]
  }]
  dynamic: {text->value}
  invoiceRecipient: {
    addressLine1: text
    addressLine2: text
    attention: text
    careOf: text
    city: text
    countryCode: text
    email: text
    name: text
    phone: text
    postalCode: text
    state: text
    taxCountryCode: nothing|text
    taxId: nothing|text
    taxIdType: nothing|text
  }
  invoices: [{
    capturedTotal: number
    createdAt: instant
    invoiceId: uuid
    invoiceLines: [{
      description: nothing|text
      discounts: [{
        amount: number
        description: nothing|text
        invoiceLineDiscountId: uuid
        referenceId: uuid
        referenceType: 'staticDiscount'|'promotion'
      }]
      invoiceLineId: uuid
      invoiceLineNumber: number
      net: number
      originalInvoiceLineId: nothing|uuid
      productNumber: nothing|text
      quantity: nothing|number
      referenceId: uuid
      referenceType: 'none'|'orderLine'|'return'|'delivery'
      tax: number
      total: number
    }]
    invoiceNetTotal: number
    invoiceNumber: text
    invoiceRecipient: {
      addressLine1: text
      addressLine2: text
      attention: text
      careOf: text
      city: text
      countryCode: text
      email: text
      name: text
      phone: text
      postalCode: text
      state: text
      taxCountryCode: nothing|text
      taxId: nothing|text
      taxIdType: nothing|text
    }
    invoiceTaxTotal: number
    invoiceTotal: number
    isCancelled: boolean
  }]
  journalEntries: [{
    amount: number
    invoiceId: uuid|nothing
    orderJournalEntryId: uuid
    orderJournalEntryType: 'receivable'|'capture'|'clearing'|'fee'
    paymentId: uuid|nothing
    timestamp: instant
  }]
  locale: nothing|text
  orderId: uuid
  orderNumber: text
  orderState: 'pending'|'confirmed'|'cancelled'
  orderTaxTotal: number
  orderTotal: number
  promotions: [{
    componentId: nothing|text
    description: nothing|text
    dynamic: {text->value}
    parameters: {text->value}
    promotionGroup: text
    promotionId: uuid
  }]
  tags: [text]
  taxIncluded: boolean
}

Availability

Promotion	Rule	Reactor
	✓	✓