createFulfilmentPlan
This mutation creates a FulfilmentPlan, an orchestratable entity inside the Fluent ecosystem. If the FulfilmentPlan is successfully created, a CREATE event will be generate associated with the mutation.
A sample of the event generated:
{
"name": "CREATE",
"type": "NORMAL",
"entityRef": "FULFILMENTPLAN-001",
"entityType": "FULFILMENTPLAN",
"retailerId": "1",
"accountId": "ACCOUNT_ID"
}
Input fields
CreateFulfilmentPlanInput)
Return fields
ID!)
ID of the object
DateTime)
Time of creation
DateTime)
Time of last update
String!)
Type of the FulfilmentPlan, typically used by the Orchestration Engine to determine the workflow that should be applied. Unless stated otherwise, no values are enforced by the platform.
String)
The current status of the FulfilmentPlan.
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
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".
Int!)
The version of the workflow assigned to the entity and used for workflow identification. It comprises a major version and minor version number.
String)
External reference. Recommended to be unique.
Int)
Order split limits
String)
ETA of the FulfilmentPlan. Although this can be set explicitly, we recommend that this be determined and set in the workflow.
Int)
ID of the retailer
[Attribute])
A list of attributes associated with this object. This can be used to extend the existing data structure with additional data for use in orchestration rules, etc.
FulfilmentOption)
Represents the associated FulfilmentOption object
[FulfilmentPlanFulfilment])
Represents fulfilments under this Fulfilment Plan
[FulfilmentPlanException])
Exceptions can be used to augment the existing object with any useful information in case of exceptions.