Inventory REST API
Resource URL Summary
Retrieve the details of a specific Storage Location
GET /seiapi/v3/trans/Inventory/${StorageLocationID}
Insert or update the details of a specific Storage Location
PUT /seiapi/v3/trans/Inventory/${StorageLocationID}
Update only supplied details of a specific Storage Location
POST /seiapi/v3/trans/Inventory/${StorageLocationID}
Delete the a specific Storage Location
DELETE /seiapi/v3/trans/Inventory/${StorageLocationID}
Retrieve the usage data for a specific Storage Location
GET /seiapi/v3/trans/Inventory/${StorageLocationID}/UsageStatistics
Insert or update the usage data for a specific Storage Location
PUT /seiapi/v3/trans/Inventory/${StorageLocationID}/UsageStatistics
Update only supplied usage data for a specific Storage Location
POST /seiapi/v3/trans/Inventory/${StorageLocationID}/UsageStatistics
Delete the usage data for a specific Storage Location
DELETE /seiapi/v3/trans/Inventory/${StorageLocationID}/UsageStatistics
API Specific Parameters
Parameter | Description |
---|---|
| Identifies the Storage Location Object. |
HTTP Headers
This API uses the default ServiceMobility HTTP Headers.
API Specifics
Retrieve the details of a specific Storage Location
This REST API will return a Storage Location with the specified ID. The Storage Location with the specified ID must already exist in the system.
URL
GET /seiapi/v3/trans/Inventory/${StorageLocationID}
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 a Storage Location Object. Otherwise, on error, the response body will contain a descriptive reason for the error.
Insert or update the details of a specific Storage Location
This REST API will insert a new Storage Location with the specified ID into the system, if a Storage Location with the specified ID does not already exist in the system.
If, however, the Storage Location with the specified ID does already exist in the system, then this REST API will update (i.e. replace) the already existing Storage Location with the specified ID with the details of the Storage Location supplied in the HTTP Request Body.
URL
PUT /seiapi/v3/trans/Inventory/${StorageLocationID}
HTTP Request Body
The HTTP request body must contain a valid Storage Location Object.
HTTP Response Body
On success the API will return a status code of 200.
Update only supplied details of a specific Storage Location
This REST API will update an existing Storage Location with the specified ID with the information provided.
Any existing information not specified in the new request will remain unchanged.
The Storage Location with the specified ID must already exist in the system.
This API provides an easy and safe way to make updates to a Storage Location without having to provide the entire object, as any Storage Location data that already exist, but are not specified in the POST call, are left unmodified, unlike the PUT method which would remove them.
URL
POST /seiapi/v3/trans/Inventory/${StorageLocationID}
HTTP Request Body
The HTTP request body must contain a valid Storage Location Object.
HTTP Response Body
On success the API will return a status code of 200.
Delete a specific Storage Location
This REST API will delete the Storage Location with the specified ID from the system. The Storage Location with the specified ID must already exist in the system.
URL
DELETE /seiapi/v3/trans/Inventory/${StorageLocationID}
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. The system will return HTTP response code 410 in case of non-existent Storage Location Object.
Retrieve the usage data for a specific Storage Location
This REST API will return a the inventory Usage Statistics for the Storage Location with the specified ID. The Storage Location with the specified ID must already exist in the system.
URL
GET /seiapi/v3/trans/Inventory/${StorageLocationID}/UsageStatistics
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 a Usage Data Object. Otherwise, on error, the response body will contain a descriptive reason for the error.
Insert or update the usage data for a specific Storage Location
This REST API will insert new inventory Usage Statistics for the Storage Location with the specified ID into the system, if inventory Usage Statistics for the Storage Location with the specified ID do not already exist in the system.
If, however, there are already inventory Usage Statistics for the Storage Location with the specified ID in the system, then this REST API will update (i.e. replace) the already existing inventory Usage Statistics for the Storage Location with the specified ID with the details of the inventory Usage Statistics supplied in the HTTP Request Body.
URL
PUT /seiapi/v3/trans/Inventory/${StorageLocationID}/UsageStatistics
HTTP Request Body
The HTTP request body must contain a valid Usage Data Object.
HTTP Response Body
On success the API will return a status code of 200.
Update only supplied usage data for a specific Storage Location
This REST API will update the existing inventory Usage Statistics for the Storage Location with the specified ID with the information provided.
Any existing information not specified in the new request will remain unchanged.
The Storage Location with the specified ID must already exist in the system.
This API provides an easy and safe way to make updates to the inventory Usage Statistics for a Storage Location without having to provide the entire object, as any inventory Usage Statistics data for the Storage Location that already exist, but are not specified in the POST call, are left unmodified, unlike the PUT method which would remove them.
URL
POST /seiapi/v3/trans/Inventory/${StorageLocationID}/UsageStatistics
HTTP Request Body
The HTTP request body must contain a valid Usage Data Object.
HTTP Response Body
On success the API will return a status code of 200.
Delete the usage data for a specific Storage Location
This REST API will delete the inventory Usage Statistics for the Storage Location with the specified ID from the system. The Storage Location with the specified ID must already exist in the system.
URL
DELETE /seiapi/v3/trans/Inventory/${StorageLocationID}/UsageStatistics
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. The system will return HTTP response code 410 in case of non-existent Storage Location Object.