Fulfilment

A Fulfilment represents one or more items in an order that need to be picked & packed for the customer.
A fulfilment is assigned to a location based on the retailer's fulfilment rules and available inventory. A fulfilment will have an origin (from) and destination (to) associated with it.

Implements

Node
Orchestrateable

Connections

waves (WaveConnection)

Connection representing a list of Waves

Argument	Type	Description
`ref`	`[String!]`	External reference of the `Wave`. Must be unique.
`name`	`[String]`	Name of the `Wave`
`status`	`[String]`
`type`	`[String!]`
`workflowRef`	`[String!]`
`workflowVersion`	`[Int!]`
`createdOn`	`DateRange`
`updatedOn`	`DateRange`
`processingLocation`	`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

articles (ArticleConnection)

Connection representing a list of Articles

Argument	Type	Description
`ref`	`[String]`	The unique article reference provided by the retailer
`type`	`[String!]`
`status`	`[String]`
`workflowRef`	`[String!]`
`workflowVersion`	`[Int!]`
`createdOn`	`DateRange`
`updatedOn`	`DateRange`
`description`	`[String]`	Description
`height`	`[Float!]`	Height
`length`	`[Float!]`	Length
`name`	`[String]`	Name
`weight`	`[Float!]`	Weight
`width`	`[Float!]`	Width
`quantity`	`[Int]`	Quantity
`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 (FulfilmentItemConnection)

Connection representing a list of FulfilmentItems

Argument	Type	Description
`ref`	`[String]`	External reference of the object. Recommended to be unique.
`status`	`[String!]`	Status
`requestedQuantity`	`[Int]`	Number of `OrderItem`s assigned to the fulfilment
`filledQuantity`	`[Int!]`	Number of `OrderItem`s confirmed
`rejectedQuantity`	`[Int!]`	Number of `OrderItem`s rejected
`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

rejections (FulfilmentItemRejectionConnection)

Connection representing a list of Rejected FulfilmentItems

Argument	Type	Description
`quantity`	`[Int!]`	Number of `FulfilmentItem`s rejected
`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

payments (PaymentConnection)

The Payments associated with the Fulfilment

Argument	Type	Description
`ref`	`[String!]`	External reference of the object. Must be unique.
`type`	`[String!]`	Type of the `Payment`, typically used by the Orchestration Engine to determine the workflow that should be applied. For Payment a sample value for this is `DEFAULT`.
`status`	`[String!]`	Status of the `Payment`
`retailer`	`RetailerLinkInput`
`workflow`	`WorkflowLinkInput`
`workflowRef`	`[String!]`	DEPRECATED, please use the field `workflow` instead - The reference of the workflow.
`workflowVersion`	`[Int!]`	DEPRECATED, please use the field `workflow` instead - The version of the workflow.
`createdOn`	`DateRange`
`updatedOn`	`DateRange`
`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

consignments (ConsignmentConnection)

Connection representing a list of Consignments

Argument	Type	Description
`ref`	`[String]`	External reference of the object. Recommended to be unique.
`status`	`[String]`	The status of the consignment
`consignmentReference`	`[String!]`	The external consignment reference assigned by the carrier
`trackingLabel`	`[String]`	Tracking label of the consignment
`labelUrl`	`[String]`	The URL used to retrieve the shipping label
`orderSummaryUrl`	`[String]`	A url to represent the order summary. Usually the manifest url from the service provider.
`workflowRef`	`[String!]`	The reference used for workflow identification
`workflowVersion`	`[Int!]`	The version of the workflow
`createdOn`	`DateRange`
`updatedOn`	`DateRange`
`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 object

createdOn (DateTime)

Time of creation

updatedOn (DateTime)

Time of last update

type (String!)

Type of the Fulfilment, 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 Fulfilment. Supports all values.

status (String)

The current status of the Fulfilment.
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 object. Recommended to be unique.

fulfilmentChoiceRef (String)

Represents the FulfilmentChoice corresponding to this object

attributes ([Attribute])

Attributes of fulfilment

deliveryType (String)

Type of delivery. Supported values are STANDARD, OVERNIGHT and EXPRESS.

eta (String)

The estimated time of completing the fulfilment.

expiryTime (DateTime)

Expiry time for the fulfilment

order (Order)

The associated Order

fromAddress (Address)

Address of the fulfilment location

toAddress (Address)

Address of the delivery location

user (Customer)

The associated Customer

fromLocation (LocationLink)

The Location responsible for processing outbound Fulfilments