Wave

Wave represents the pick and pack process that gets carried out in a store or a warehouse.

Implements

Connections

fulfilments (FulfilmentConnection)

Fulfilments associated with this Wave

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

items (WaveItemConnection!)

Items associated with this Wave

Argument Type Description
quantity [Int!]

Aggregated quantity of a product in the Wave

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

Fields

id (ID!)

ID of the Wave

createdOn (DateTime)

Time of creation

updatedOn (DateTime)

Time of last update

type (String!)

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

status (String)

The current status of the Wave.
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 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".

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.

ref (String!)

External reference of the Wave. Must be unique.

attributes ([Attribute])

A list of attributes associated with this Wave. Attributes can be used to extend the existing data structure with additional data for use in orchestration rules, etc.

name (String)

Name of the Wave

retailer (Retailer!)

The associated retailer

location (Location!)

Location of the Wave operation

allocatedTo (User)

User who the wave is assigned to

processingLocation (LocationLink)

The Location where the Wave is processed