createFulfilmentOption
This mutation creates a FulfilmentOption, an orchestratable entity inside the Fluent ecosystem. If the FulfilmentOption is successfully created, a CREATE event will be generate associated with the mutation.
A sample of the event generated:
{
"name": "CREATE",
"type": "NORMAL",
"entityRef": "FULFILMENTOPTION-001",
"entityType": "FULFILMENTOPTION",
"retailerId": "1",
"accountId": "ACCOUNT_ID"
}
Input fields
CreateFulfilmentOptionInput)
ExecutionMode)
Return fields
ID!)
ID of the object
DateTime)
Time of creation
DateTime)
Time of last update
String!)
Type of the FulfilmentOption, 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 FulfilmentOption.
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!)
ID of the Retailer, typically used by the Orchestration Engine to determine the workflow that should be applied.
String)
Type of order. For example click & collect (CC) or home delivery (HD)
String)
The reference identifier for a location. May be used in orchestration rules to drive custom business logic. For example, you can have a rule to return plans only from this location or a rule to return plans from all locations but excluding this one.
String)
A unique identifier for the clients to group related Fulfilment Plans.
FulfilmentOptionAddress)
A type for passing address. Can be used as an input in creating Fulfilment Plans.
[FulfilmentOptionProduct])
Products being queried for availability
[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.