createInventoryPosition
This mutation creates an InventoryPosition, an orchestratable entity inside the Fluent ecosystem. If the InventoryPosition is successfully created, a CREATE event will be generate associated with the mutation.
A sample of the event generated:
{
"name": "CREATE",
"type": "NORMAL",
"entityRef": "INVENTORYPOSITION-001",
"entityType": "INVENTORYPOSITION",
"retailerId": "1",
"accountId": "ACCOUNT_ID"
}
Input fields
CreateInventoryPositionInput)
Return fields
ID!)
ID of the object. For internal use, should not be used externally or by any business logic
DateTime)
Time of creation
DateTime)
Time of last update
String!)
The unique reference identifier for the Inventory Position
String!)
Type of the InventoryPosition, 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 InventoryPosition.
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.
[Attribute])
A list of attributes associated with this Inventory Position. This can be used to extend the existing data structure with additional data for use in orchestration rules, etc.
String!)
A reference identifying a Product. The referenced product may or may not exist within one or more Product Catalogues. This is a loosely coupled association, since Product and Inventory are separate domains.
Product)
The Product (Standard, Variant or Group) the current inventory position refers to.
- Only products in the same product catalogue are considered in this association
- The caller must have permission to access the underlying product - PRODUCT_VIEW for all products, plus STANDARDPRODUCT_VIEW for StandardProduct, VARIANTPRODUCT_VIEW for VariantProduct, GROUPPRODUCT_VIEW for GroupProduct. If any required permission is absent, the result will be empty. E.G if the product ref is for a GroupProduct but GROUPPRODUCT_VIEW is not granted, then no product will be returned
- If there are several products with the same ref in the corresponding product catalogue, the product returned will be selected by priority: GroupProduct -> VariantProduct -> StandardProduct
| Argument | Type | Description |
|---|---|---|
catalogue |
ProductCatalogueKey
|
Int)
The calculated on hand quantity based on the associated quantities, and rules in the orchestration workflow
String)
A reference identifying the Location where this inventory exists. This is a loosely coupled association.
StoreAddress)
No longer supported
DEPRECATED, please use the field locationLink instead - The Location where this inventory exists.
Location)
The Agent Location where this inventory exists.
InventoryCatalogue)
The Inventory Catalogue in which this Position is managed
InventoryQuantityAggregateOutput)