Order

The Order object

Parameters

• id string readonly

• status string

• date date

• orderId string

  Store order id

• number string

  Store order number

• currencyId string

• paymentType string

• paymentTag string

• paid boolean

• paidAt date

• fulfilled boolean

• fulfilledAt date

• cancelled boolean

• cancelledAt date

• complete boolean

• completedAt date

• refunded boolean

• refundedAt date

• locale string

  Order specific locale

• expectedTotalWithTax number

• payloads array[object]

  Order original payloads

• taxClause string

  Custom tax clause passed from order

• _billingAddress object

  show nested properties hide nested properties

  • id string readonly

  • isEndCustomer boolean

  • throwEslogErrors boolean

  • ipAddress string

  • fatturaPaChannelId string

  • name string

  • address string

  • address2 string

  • city string

  • zip string

  • state string

  • country string

  • countryAlpha2Code string

  • taxNumber string

  • taxSubject boolean

  • companyNumber string

  • IBAN string

  • bank string

  • SWIFT string

  • website string

  • email string

  • phone string

  • businessType string

  Additional propertiesExpand allHide all

  • createdAt date readonly

  • updatedAt date readonly

  • custom object

    Custom field for freeform data input

  • _data array[object]

    show nested properties hide nested properties

    • id string readonly

    • name string

      Name identifier of data

    • value object

    • options object

      Different data options. Ie. should the value be persistem to the document `onPDF: boolean`. This includes displaying on PDF. Note that only two values will be displayed per PDF on Client. Add Document data to export using `export: boolean`

• _shippingAddress object

  show nested properties hide nested properties

  • id string readonly

  • isEndCustomer boolean

  • throwEslogErrors boolean

  • ipAddress string

  • fatturaPaChannelId string

  • name string

  • address string

  • address2 string

  • city string

  • zip string

  • state string

  • country string

  • countryAlpha2Code string

  • taxNumber string

  • taxSubject boolean

  • companyNumber string

  • IBAN string

  • bank string

  • SWIFT string

  • website string

  • email string

  • phone string

  • businessType string

  Additional propertiesExpand allHide all

  • createdAt date readonly

  • updatedAt date readonly

  • custom object

    Custom field for freeform data input

  • _data array[object]

    show nested properties hide nested properties

    • id string readonly

    • name string

      Name identifier of data

    • value object

    • options object

      Different data options. Ie. should the value be persistem to the document `onPDF: boolean`. This includes displaying on PDF. Note that only two values will be displayed per PDF on Client. Add Document data to export using `export: boolean`

• invoiceId string

• estimateId string

• organizationId string

• shopifyId string

• magento1Id string

• woocommerceId string

• customIntegrationId string

• customId string

• thrivecartId string

• _items array[object]

  show nested properties hide nested properties

  • id string readonly

  • name string

  • description string

  • price number

  • priceGross number

  • unit string

  • SKU string

  • onBehalf string

    tax number of company selling this item/service on behalf of

  • _taxes array[object]

    show nested properties hide nested properties

    • id string readonly

    • rate number

    • name string

    • abbreviation string

    • recoverable boolean

    • compound boolean

    • taxNumber string

      Tax number associated with this tax.

  Additional propertiesExpand allHide all

  • custom object

    Custom field for freeform data input

• _transactions array[object]

  show nested properties hide nested properties

  • id string readonly

  • amount number

  • gateway string

  • type string

  • status string

  • tag string

    Payment tag for sub categorization

  • date date

  • note string

  Additional propertiesExpand allHide all

  • custom object

    Custom field for freeform data input

• bokunId string

• shopamineId string

Additional propertiesExpand allHide all

• deletedAt date readonly

• _isDeleted boolean readonly

• deletedId string readonly

• createdAt date readonly

• updatedAt date readonly