createInventoryQuantity

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

Input fields

input (CreateInventoryQuantityInput)

Return fields

id (ID!)

ID of the object. For internal use, should not be used externally or by any business logic

createdOn (DateTime)

Time of creation

updatedOn (DateTime)

Time of last update

ref (String!)

The unique reference identifier for the Inventory Quantity

type (String!)

Type of the InventoryQuantity, typically used by the Orchestration Engine to determine the workflow that should be applied. Unless stated otherwise, no values are enforced by the platform.
The type field can be used to differentiate between Inventory Quantity workflows. Example types include LAST_ON_HAND, RESERVED, EXPECTED, and ADJUSTMENT.

status (String)

The current status of the InventoryQuantity.
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.

attributes ([Attribute])

A list of attributes associated with this Inventory Quantity. This can be used to extend the existing data structure with additional data for use in orchestration rules, etc.

quantity (Int)

The actual amount of this specific Quantity record

condition (String)

The condition of the Inventory Quantity value. The platform does not enforce any values here. Examples could include NEW, USED, or DAMAGED

expectedOn (DateTime)

The date and time the quantity is expected to arrive

storageAreaRef (String)

A reference to the Storage Area where this inventory is kept

catalogue (InventoryCatalogue)

The Inventory Catalogue in which this Quantity is managed

position (InventoryPosition)

The associated parent Inventory Position of which this Quantity applies

parent (InventoryQuantity)

A reference to the parent InventoryQuantity (used for hierarchical relationships)

expiresOn (DateTime)

An expiration date and time of the inventory quantity

associationType (String)

A type of association with an external entity (e.g. purchase order, in-transit shipment, fulfilment)

associationRef (String)

A reference of the associated external entity

countryOfOrigin (String)

A country where the product was manufactured

channel (String)

A sales channel associated with this inventory quantity

manufacturer (String)

A name or identifier of the product manufacturer

manufacturerBatchNumber (String)

A batch number assigned by the manufacturer

supplier (String)

A product supplier

segment1 (String)

An additional segment 1

segment2 (String)

An additional segment 2

segment3 (String)

An additional segment 3

quantitiesAggregate (InventoryQuantityAggregateOutput)

Retrieve the aggregate quantity of the direct Inventory Quantity children associated with this Inventory Quantity and filtered by parameters (types, statuses, expectedOn, expiresOn, associationTypes, associationRefs and segments)

Argument Type Description
type [String!]

Inventory Quantity type

status [String!]

Inventory Quantity status

expectedOn DateRange

Inventory Quantity expected on date

expiresOn DateRange

An expiration date and time of the inventory quantity

associationType [String]

A type of association with an external entity (e.g. purchase order, in-transit shipment, fulfilment)

associationRef [String]

A reference of the associated external entity

countryOfOrigin [String]

A country where the product was manufactured

channel [String]

A sales channel associated with this inventory quantity

manufacturer [String]

A name or identifier of the product manufacturer

manufacturerBatchNumber [String]

A batch number assigned by the manufacturer

supplier [String]

A product supplier

segment1 [String]

An additional segment 1

segment2 [String]

An additional segment 2

segment3 [String]

An additional segment 3