Document toolboxDocument toolbox

Standard Inventory Count REST API

Owned by Andrew Hill (Deactivated)
Last updated: Oct 02, 2024 by Jason Andrew
3 min read

3.0.0

The Inventory Count REST API is used to create a request to have the inventory for a specific storage location physically counted. The request can either be for a full or partial count. If a partial count is requested, then the request will include the specific inventory items to be counted. The count request can be assigned to any UserID (technician) to preform the count even a technician who is not currently assigned to the storage location.

Once an inventory count request has been created it becomes immutable and can no longer be modified by the backend system. If a change is required then the existing object must be deleted and a new request object created with a new PhysicalInventoryNum identifier. This restriction is to ensure data integrity as the count may already be in progress or completed with a technician that is out of network coverage when the backend system decides to modify the request.

On this page:

Related pages:

Resource URL Summary

Retrieve the details of a specific Physical Inventory Count Request

GET /seiapi/v3/trans/PhysicalInventoryRequest/${PhysicalInventoryNum}

Insert the details of a specific Physical Inventory Count Request

PUT /seiapi/v3/trans/PhysicalInventoryRequest/${PhysicalInventoryNum}

Delete a specific Physical Inventory Count Request

DELETE /seiapi/v3/trans/PhysicalInventoryRequest/${PhysicalInventoryNum}

API Specific Parameters

ParameterDescription

${PhysicalInventoryNum}

Identifies the unique Physical Inventory Count Request object.

HTTP Headers

This API uses the default ServiceMobility HTTP Headers.


API Specifics

Retrieve the details of a specific Physical Inventory Count Request

This REST API will return a Physical Inventory Count Request with the specified ID. The Physical Inventory Count Request with the specified ID must already exist in the system.

URL

GET /seiapi/v3/trans/PhysicalInventoryRequest/${PhysicalInventoryNum}

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 Physical Inventory Count Object. Otherwise, on error, the response body will contain a descriptive reason for the error. 

JSON Format 
{
	"Description" : "",
    "Extensions" : {
       "key" : "value"
    },
    "InventoryRequestType": "", 
    "ModifiedUTC" : "2013-01-01T12:00:00.000Z",
    "PhysicalInventoryNum": "", 
    "RequestUTC": "", 
    "Status": "", 
    "StorageLocationID": "", 
    "UserID": "",
    "Items": [
        {
            "BatchNum": "", 
            "ExpectedQty": 0.0,
 			"FlexView": [
        		{
            		"Title": "GroupName",
            		"Items": [
                		{
                    		"Label": "labeltext",
                    		"Value": "valuetext"
                		}
            		]
        		}
    		], 
            "ProdAttrs": {
                "IsBatch": false, 
                "IsInvCtrl" : false,
                "IsSerialized": false, 
                "Desc": ""
            }, 
            "ProdNum": "", 
            "Qty": 0.0, 
            "SerialNum": ""
        }
    ]
}

Insert the details of a specific Service Contract

This REST API will insert a new Physical Inventory Count Request with the specified ID into the system, if a Physical Inventory Count Request with the specified ID does not already exist in the system.

(warning) Once created, the Physical Inventory Count Request object can no longer be updated by the backend system, only the counting technician.

URL

PUT /seiapi/v3/trans/PhysicalInventoryRequest/${PhysicalInventoryNum}

HTTP Request Body

The HTTP request body must contain a valid Physical Inventory Count Object.

HTTP Response

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

Delete a specific Service Contract

This REST API will delete a Physical Inventory Count Request with the specified ID from the system. The Physical Inventory Count Request with the specified ID must already exist in the system.

URL

DELETE /seiapi/v3/trans/PhysicalInventoryRequest/${PhysicalInventoryNum}

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 Physical Inventory Count Object.