Options
All
  • Public
  • Public/Protected
  • All
Menu

This event is sent on a change in order status and or relevant fields, meaning it will be sent even if there is no status change but a field related to the current status has changed.

Hierarchy

Index

Constructors

Properties

_eid: string

Event unique id

_type: EventType

Event type

_v: string

Event format version / API version

appointmentEnd: Date

Installation appointment time end

appointmentStart: Date

Installation appointment time start

customer: Customer
customerBilling: CustomerBilling

The order billing address

documents: OrderDocumentation[]

Documentation for order completion and/or other order related events.

Not that, one documentation type can be have several files present.

externalId: string

The order external id, if set by the API integrator

finishTimestamp: Date

The time installer finished working on a order.

remarks

Keep in mind that this timestamp might differ from the actual appointment as it represents the time when the installer has submitted all the documentation regarding the order, not the exact time the actual work has been finished.

invoicingExternalId: string

The order invoicing external id, if set by the API integrator

orderId: string

The order ID

orderNumber: string

The order number used for communication (email, protocols, etc.)

orderType: OrderType
products: default[]

Products included in the order.

projectId: string

The ID of the project this order belongs to

remark

Since v1.1.0

projectName: string

The name of the project this order belongs to

remark

Since v1.1.0

shippingAddress: Address

The order installation address

startTimestamp: Date

The time installer started working on an order.

status: OrderStatus

Generated using TypeDoc