Stock Level Recommendation Object

Stock Level Recommendation Object Formats

JSON Format

{
	"Description": "",
	"DueDate": "",
	"Extensions": {
		"Ref #": ""
	},
	"Items": [{
		"FlexView": [{
			"Title": "GroupName",
			"Items": [{
				"Label": "labeltext",
				"Value": "valuetext"
			}]
		}],
		"ProdAttrs": {
			"Desc": "",
			"IsBatch": false,
			"IsInvCtrl": false,
			"IsSerialized": false,
			"ProdType": ""
		},
		"ProdNum": "",
		"Qty": 1.0,
		"RecQty": 1.0
	}],
	"ID": "",
	"Status": "",
	"StorageLocationID": "",
	"TechCreated": false
}

Stock Level Recommendation Object Properties

Required properties are in bold.

Property Type Description

Description string Detailed description of the stock level recommendation for a storage location.

DueDate

datetime

The date and time, in UTC format, of when the stock level recommendation is expected to be completed.

3.34.0

Extensions

object

This object contains an optional collection of key/value pairs.

These key/value are defined and controlled by the customer and are typically used to assist in integration by pass additional data around the system.

ID string The unique ID that identifies this stock level recommendation.

Items

collection

Identifies the product items and quantities that are in the recommendation and to be reviewed to maintain the stock level in specified storage location's inventory.

Property Type Description

FlexView

collection

The optional FlexViews object is used to provided additional read-only details and information specific to the object they are included in. The FlexViews are fully customizable by the customer.

See: Flex Views Object

3.37.0

ProdAttrs

object

This object contains the item's product attributes from the Product table. If this object is not specified, then the Broker ESB will automatically populate it from the details in the Product table.

If the Product table is not being managed through the Product REST APIs, then this object is required.

Property	Type	Description
Desc	string	Provides the description of the product item. This description will be in the preferred language of the technician.
IsBatch	boolean	Identifies if this product item is batch controlled. If `true`, then the `BatchNum` property is required. Valid values are: `true` - Item is batch controlled. `false` - Item is not batch controlled. This is the default value if this property is missing.
IsInvCtrl	boolean	Identifies if this product is under inventory control. If `true`, then the application will automatically adjust the proper storage location's inventory based on the item usage. Valid values are: `true` - Item is under inventory control. `false` - Item is not under inventory control. This is the default value if this property is missing.
IsSerialized	boolean	Identifies if this product item is serialized or not. If `true`, then the `SerialNum` property is required. Valid values are: `true` - Item is serialized and requires a serial number. `false` - Item is not serialized. This is the default value if this property is missing.
ProdType	string	Identifies the product item type or category. See: Product Types System Category

See: Product Object

ProdNum string Identifies the product number associated with the item.

Qty number Identifies the adjusted recommended quantity for the item. This quantity reflects changes made to the recommended quantity by mobile worker during stock level recommendation review.

RecQty number Identifies the recommended stock level quantity for the item.

Status

string

The current status of the stock level recommendation.

Valid values are:

1001 - The stock level recommendation is under review
1002 - The stock level recommendation review has been completed

StorageLocationID string Identifies the storage location where the stock level recommendation is to be applied to.

TechCreated

boolean

Specifies if the mobile worker created the stock level recommendation.

Valid values are:

false = Indicates that the stock level recommendation was created in the back office. This is the default value if this property is not specified.
true = The mobile worker created the stock level recommendation from the mobile application.

4.6.0