Creating & executing stow jobs
Last updated
Last updated
Stow jobs represent the intention or instruction to change the storage location and/or the amount of stock in a facility. While the stow job itself holds general information such as the facility or priority of the job, the stow line item contains information on the items to be moved, their quantity, location, and more. Stow line items cannot exist without a stow job.
An admin wants items from a goods receipt to be stowed or items to be relocated.
Create stow job using
set status to OPEN
use takeFrom.type
LOCATION
and stowTo.Type
LOCATION
Job is started by worker. Set status to IN_PROGRESS
using .
Items are taken from start location. Set TAKEN
information in operative data via . A takenStockRef
must be set to in order to define which stock should be reduced.
Items are stowed to target location. Set STOWED
information in operative data via .
A stowedStockRef
and stowedStorageLocationRef
must be sent but can also be null.
If a stowedStockRef
is provided, the moved stock is added to the specified stock. If null, a new stock is created.
If a stowedStorageLocationRef
is provided, the stock will be created on that location. If null, a stock is created without a reference to any location.
Repeat step "3." & "4." until everything is stowed.
Set status to CLOSED
via .
An admin wants new stock to be booked to location.
set status to OPEN
use takeFrom.type
UNREGISTERED
and stowTo.Type
LOCATION
If new stock should have properties or traits, it can be defined in the stockInformation
of the takeFrom
object.
Admin wants stock to be discarded.
set status to OPEN
use takeFrom.type
LOCATION
and stowTo.Type
DISCARD
Admin wants stock to be discarded and worker specifies a reason for discarding, e.g., "BROKEN".
set status to OPEN
use takeFrom.type
LOCATION
and stowTo.Type
DISCARD
AstowedStockRef
must be sent but can be null since the stock is deleted after stowing was completed.
The reasons array of the corresponding stow line item can have one or multiple reasons. Each reason must be one of the following:
An object containing tenantReasonId: <tenantReasonId>
of an (active) preconfigured external stock change reason.
Follow the steps above.
Admin wants a specific stock to be relocated. This could, for example, be the case if there are multiple expiry dates for the same item on one location.
set status to OPEN
use takeFrom.type
STOCK
and stowTo.Type
STOCK
If no stowedStockRef
is defined, a new stock will be created.
Repeat step "3." & "4." until everything is stowed.
Admin wants items to be moved from one location to multiple other locations. This could, for example, be the case if items should be stored after a goods receipt was completed.
set status to OPEN
use takeFrom.type
LOCATION
and stowTo.Type
LOCATION
define all target locations along with the respective quantities in the stowTo
array
Define the ID of the stowTo
object that should be updated.
It is necessary to send the complete stowTo
array, even if only one object should be updated.
A stowedStockRef
and stowedStorageLocationRef
must be sent but can also be null.
If a stowedStockRef
is provided, the moved stock is added to the specified stock. If null, a new stock is created.
If a stowedStorageLocationRef
is provided, the stock will be created on that location. If null, a stock is created without a reference to any location.
Repeat step "3." & "4." until everything is stowed.
Create stow job using
Job is started by worker. Set status to IN_PROGRESS
using .
Items are taken up by the worker. Set TAKEN
information in operative data via . A takenStockRef
must be sent but can be null since a new stock will be created based on data in taken.takenQuantity
and takeFrom.stockInformation
.
Follow steps "4." to "6." from .
Create stow job using
Job is started by worker. Set status to IN_PROGRESS
using .
Items are taken from start location. Set TAKEN
information in operative data via . A takenStockRef
must be set to in order to define which stock should be reduced.
Items are discarded. Set STOWED
information in operative data via . AstowedStockRef
must be sent but can be null since the stock is deleted after stowing was completed.
Set status to CLOSED
via .
Create stow job using
Job is started by worker. Set status to IN_PROGRESS
using .
Items are taken from start location. Set TAKEN
information in operative data via . A takenStockRef
must be set to in order to define which stock should be reduced.
Items are discarded and worker defined reason for discarding stock. Set STOWED
information in operative data via .
An object containing id: <id>
of a preconfigured (active) .
An object containing reasonLocalized: <LocalizedString>
. See for the format of LocalizedString
. For this option, the reason does not need to be preconfigured. The object can optionally contain a tenantReasonId
, if there is no preconfigured with that Id.
Set status to CLOSED
via .
Create stow job using
Job is started by worker. Set status to IN_PROGRESS
using .
Items are taken. Set TAKEN
information in operative data via . A takenStockRef
must be set to in order to define which stock should be reduced.
Items are stowed. Set STOWED
information in operative data via . AstowedStockRef
must be sent but can also be null.
Set status to CLOSED
via .
The priority
can be defined on stowJob
level. Any value can be set meaning users can define their own logic. Priority can be set using .
Create stow job using
Job is started by worker. Set status to IN_PROGRESS
using .
Items are taken from start location. Set TAKEN
information in operative data via . A takenStockRef
must be set to in order to define which stock should be reduced.
Items are stowed to target location. Set STOWED
information in operative data via .
Set status to CLOSED
via .