Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Order

Hierarchy

  • Order

Implements

Index

Properties

channel

channel: Channel

customer

customer: Customer

The customer that is purchasing the order

Optional customerOrderReference

customerOrderReference: string | undefined

The order reference that will be shown to the customer in communications (order confirmation page, emails, SMS...)

deals

deals: Deal[]

The basket of goods and related pricing that the customer is purchasing

devicePlatform

devicePlatform: string

The family derived from the customer's User Agent, and identified by UserAgent If it cannot be determined then should have value "UNKNOWN"

Optional discount

discount: Discount | undefined

dispatched

dispatched: boolean

An internal PHDV flag, to identify whether the order has been dispatched. This can default to false.

disposition

disposition: Disposition

Details of how the order will get to the customer

envFlag

envFlag: ENVIRONMENTS

The environment this order should be related to, this should generally be 'production'

Optional eta

eta: number | undefined

The number of minutes the order should take for delivery.

Optional etaRange

etaRange: EtaRange

Min/Max expected delivery time in minutes, expressed as {from: num, to: num}

expired

expired: boolean

An internal PHDV flag, to identify whether an order has already expired. This can default to false.

expiry

expiry: number

A future date in seconds since the unix epoch, at which point if the order has not been processed by a POS system it should be considered to have failed. This is typically 10 minutes from the time the order was placed.

Optional featureRole

featureRole: undefined | string

This gets set if an order is place with e.g. development or canary feature role

hut

hut: Hut

The store from which the order will be fulfilled

ipaddress

ipaddress: string

The IP Address of the customer placing the order

Optional isDealbotEnabled

isDealbotEnabled: boolean | undefined

An internal PHDV flag, can be set to false for orders from outside PHDV

Optional isMobileApp

isMobileApp: boolean | undefined

An internal PHDV flag, can be set to false for orders from outside PHDV

Optional isTest

isTest: undefined | false | true

This gets set if an order is a test order

Optional loyalty

loyalty: Loyalty | undefined

origin

origin: Origin

payment

payment: Payment

Details of the payment that will be taken from the customer

Optional priorityDeliveryReservation

priorityDeliveryReservation: PriorityDeliveryReservation | undefined

promisedDeliveryTime

promisedDeliveryTime: string

The date time (ISO8601) that we have promised the customer the order will be delivered. Either their choice of future time or the order.time plus the eta/promise_time, etc.

Optional surcharges

surcharges: Surcharges | undefined

time

time: number

The time the order was placed, in milliseconds since the unix epoch

traceId

traceId: string

A unique ID for the customer placing the order, ideally represented in a UUID form

transactionId

transactionId: string

A globally unique ID for this order, ideally represented in a UUID form

version

version: "1.0"

Optional voucher

voucher: Voucher | undefined

Generated using TypeDoc