createFulfilment

This mutation creates a Fulfilment, an orchestratable entity inside the Fluent ecosystem. If the Fulfilment is successfully created, a CREATE event will be generate associated with the mutation.
A sample of the event generated:
{
    "name": "CREATE",
    "type": "NORMAL",
    "entityRef": "FULFILMENT-001",
    "entityType": "FULFILMENT",
    "retailerId": "1",
    "accountId": "ACCOUNT_ID"
}

Input fields

input (CreateFulfilmentInput)

Return 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