Order

fulfilmentChoices (FulfilmentChoiceConnection)

The FulfilmentChoices specified when booking the order

Argument	Type	Description
`ref`	`[String]`	External reference of the object. Recommended to be unique.
`type`	`[String!]`	Type of the Fulfilment choice. Supports all values.
`status`	`[String]`	The current status of the Fulfilment choice. By default, the initial value will be CREATED, however no other status values are enforced by the platform. The status field is also used within ruleset selection during orchestration. For more info, see Orchestration.
`workflowRef`	`[String!]`	The workflow's reference
`workflowVersion`	`[Int!]`	The version of the workflow
`createdOn`	`DateRange`
`updatedOn`	`DateRange`
`currency`	`[String]`	The type of currency, 3 letter ISO currency code.
`deliveryFirstName`	`[String]`	First Name of delivery recipient.
`deliveryLastName`	`[String]`	Last Name of delivery recipient.
`deliveryContact`	`[String]`	Mobile number of delivery recipient.
`deliveryEmail`	`[String]`	Email address to which e-delivery is made.
`deliverAfter`	`DateRange`
`deliverBefore`	`DateRange`
`dispatchOn`	`DateRange`
`deliveryInstruction`	`[String]`	Instruction provided by the customer (250 character limit).
`deliveryType`	`[String!]`	The type of delivery determined by retailers' shipping options. Example values are STANDARD, EXPRESS, OVERNIGHT, 3HOURS
`fulfilmentPrice`	`[Float]`	FulfilmentPrice refers to shipping and C&C fees.
`fulfilmentTaxPrice`	`[Float]`	This refers to the tax cost associated with the fulfilment price.
`fulfilmentType`	`[String]`	Indicates the type of fulfilment.
`pickupLocationRef`	`[String]`	Pickup location. Required if it is a click & collect.
`first`	`Int`	Returns the first n elements from the list
`last`	`Int`	Returns the last n elements from the list
`before`	`String`	Returns the elements in the list that come before the specified global ID
`after`	`String`	Returns the elements in the list that come after the specified global ID

items (OrderItemConnection)

Connection representing a list of OrderItems

Argument	Type	Description
`ref`	`[String]`	External reference of the object. Recommended to be unique.
`status`	`[String!]`	Status of the OrderItem.
`createdOn`	`DateRange`
`updatedOn`	`DateRange`
`quantity`	`[Int!]`	Quantity ordered
`paidPrice`	`[Float]`	Price paid. Excludes tax.
`currency`	`[String]`	Currency. Should ideally be a 3 letter ISO currency code. For instance AUD.
`price`	`[Float]`	Price
`taxPrice`	`[Float]`	Tax price
`taxType`	`[String]`	Tax type. Supported values are GST, VAT, EXCLTAX
`totalPrice`	`[Float]`	Total price
`totalTaxPrice`	`[Float]`	Total tax price
`first`	`Int`	Returns the first n elements from the list
`last`	`Int`	Returns the last n elements from the list
`before`	`String`	Returns the elements in the list that come before the specified global ID
`after`	`String`	Returns the elements in the list that come after the specified global ID

fulfilments (FulfilmentConnection)

Connection representing a list of Fulfilments

Argument	Type	Description
`ref`	`[String]`	External reference of the object. Recommended to be unique.
`status`	`[String]`
`fulfilmentChoiceRef`	`[String]`	Represents the `FulfilmentChoice` corresponding to this object
`workflowRef`	`[String!]`
`workflowVersion`	`[Int!]`
`createdOn`	`DateRange`
`updatedOn`	`DateRange`
`deliveryType`	`[String]`	Type of delivery. Supported values are STANDARD, OVERNIGHT and EXPRESS.
`type`	`[String!]`	Type of the Fulfilment. Supports all values.
`eta`	`[String]`	The estimated time of completing the fulfilment.
`expiryTime`	`DateRange`
`fromLocation`	`LocationLinkInput`
`first`	`Int`	Returns the first n elements from the list
`last`	`Int`	Returns the last n elements from the list
`before`	`String`	Returns the elements in the list that come before the specified global ID
`after`	`String`	Returns the elements in the list that come after the specified global ID
`retailerId`	`[Int!]`	ID of the retailer

financialTransactions (FinancialTransactionConnection)

Connection representing a list of FinancialTransactions

Argument	Type	Description
`ref`	`[String]`	The unique transaction reference provided by the Retailer to the payment gateway
`type`	`[String!]`
`status`	`[String]`
`workflowRef`	`[String!]`
`workflowVersion`	`[Int!]`
`createdOn`	`DateRange`
`updatedOn`	`DateRange`
`total`	`[Float!]`	The total transaction amount
`scale`	`[Int]`	The number of digits to scale down to
`unscaledValue`	`[Int]`	The unscaled value
`currency`	`[String!]`	Currency used for the transaction.
`externalTransactionCode`	`[String]`	The unique transaction code or request code provided by the payment gateway
`externalTransactionId`	`[String]`	The unique transaction ID or request ID provided by the payment gateway
`cardType`	`[String]`	The card type used for the payment
`paymentMethod`	`[String]`	The way in which payment was made. Platform provides support for the following payment methods - 'CREDITCARD', 'PAYPAL', 'GIFTVOUCHER', 'CASH', 'AFTERPAY'. However, these can be overridden/configured per client as settings
`paymentProviderName`	`[String]`	The name of the payment gateway. Platform provided values are 'CYBERSOURCE', 'GIVEX', 'PAYPAL', 'BRAINTREE', 'AFTERPAY'. However, these can be overridden/configured per client as settings using 'PAYMENT.PROVIDER'
`first`	`Int`	Returns the first n elements from the list
`last`	`Int`	Returns the last n elements from the list
`before`	`String`	Returns the elements in the list that come before the specified global ID
`after`	`String`	Returns the elements in the list that come after the specified global ID

id (ID!)

ID of the object

createdOn (DateTime)

Time of creation

updatedOn (DateTime)

Time of last update

type (String!)

Type of the Order, typically used by the Orchestration Engine to determine the workflow that should be applied. Unless stated otherwise, no values are enforced by the platform.
Type of the Order, typically used by the Orchestration Engine to determine the workflow that should be applied. Unless stated otherwise, no values are enforced by the platform. Currently supports all values.

status (String)

The current status of the Order.
By default, the initial value will be CREATED, however no other status values are enforced by the platform.
The status field is also used within ruleset selection during orchestration. For more info, see Orchestration
The current status of the Order.

workflowRef (String!)

The reference used for workflow identification. This is defined by a combination of the entity name and the type, in the format [EntityName]::[Type]. For example, an Order of type CC will have the workflowRef "ORDER::CC".
The workflow's reference

workflowVersion (Int!)

The version of the workflow assigned to the entity and used for workflow identification. It comprises a major version and minor version number.
The version of the workflow

ref (String)

External reference of the object. Must be unique.

attributes ([Attribute])

List of order attributes

retailer (Retailer)

Retailer of the order

totalPrice (Float)

Total price

totalTaxPrice (Float)

Total tax price

fulfilmentChoice (FulfilmentChoice)

The FulfilmentChoice specified when booking the order

customer (Customer)

Customer of the order

customerLink (CustomerLink)

Contains the reference of the customer. It can be used to fetch the Customer object.

payment (PaymentLink)

Payment for the order

billingAddress (OrderBillingAddress)

Order billing address

Order

Implements

Connections

Fields