The Stock Level Recommendation REST API is used for creating and deleting stock level recommendation objects. Stock Level Recommendation is used as a guidance for maintaining stock levels for items in an inventory location such as a vehicle. A mobile worker can provide feedback on back-office generated recommended stock level for each part during review process.

Each stock level recommendation object can only target a single inventory storage location.

On this page:

Related pages:

Resource URL Summary

Retrieve the details of a specific Stock Level Recommendation

GET /seiapi/v3/StockLevelRecommendation/${ID}

Insert or Update the details of a specific Stock Level Recommendation

PUT /seiapi/v3/StockLevelRecommendation/${ID}

Delete a specific Stock Level Recommendation

DELETE /seiapi/v3/StockLevelRecommendation/${ID}

API Specific Parameters

Parameter	Description
`${ID}`	Identifies the REST Object Definitions Inventory Related Objects Stock Level Recommendation Object.

HTTP Headers

This API uses the default ServiceMobility HTTP Headers.

API Specifics

Retrieve the details of a specific Stock Level Recommendation

This REST API will return a Stock Level Recommendation with the specified ID. The Stock Level Recommendation with the specified ID must already exist in the system.

URL

GET /seiapi/v3/StockLevelRecommendation/${ID}

HTTP Request Body

This request does not require a request body.

HTTP Response Body

On success, an HTTP response code of 200 will be returned, and the response body will contain an REST Object Definitions Inventory Related Objects Stock Level Recommendation Object. Otherwise, on error, the response body will contain a descriptive reason for the error.

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
}

Insert or Update the details of a specific Stock Level Recommendation

This REST API will insert a new Stock Level Recommendation with the specified ID into the system, if a Stock Level Recommendation with the specified ID does not already exist in the system.

If, however, the Stock Level Recommendation with the specified ID does already exist in the system, then this REST API will update (i.e. replace) the already existing Stock Level Recommendation with the specified ID with the details of the Stock Level Recommendation supplied in the HTTP Request Body.

The API will return an error if an attempt to update an existing Stock Level Recommendation is made where the Status field of the existing object is already set in the system to indicate that the stock level recommendation review has been completed.

URL

PUT /seiapi/v3/StockLevelRecommendation/${ID}

HTTP Request Body

The HTTP request body must contain a valid REST Object Definitions Inventory Related Objects Stock Level Recommendation Object.

HTTP Response

On success the API will return a response code of 200.

Delete a specific Stock Level Recommendation

This REST API will delete an Stock Level Recommendation with the specified ID from the system. The Stock Level Recommendation with the specified ID must already exist in the system.

The API will return an error if an attempt to delete an existing Stock Level Recommendation is made where the Status field of the existing object is set in the system to indicate that the stock level recommendation review has been completed.

URL

DELETE /seiapi/v3/StockLevelRecommendation/${ID}

HTTP Request Body

This request does not require a request body.

HTTP Response

On success an HTTP response code of 200 will be returned. The system will return HTTP response code 410 in case of non-existent REST Object Definitions Inventory Related Objects Stock Level Recommendation Object.