Resource URL Summary
Retrieve the details of a specific Inventory Load
GET /seiapi/v3/trans/Load/${LoadNum}
Create a new Inventory Load
POST /seiapi/v3/trans/Load
Insert the details of a specific Inventory Load for a specific Load Number
PUT /seiapi/v3/trans/Load/${LoadNum}
Delete a specific Inventory Load
DELETE /seiapi/v3/trans/Load/${LoadNum}
API Specific Parameters
Parameter | Description |
---|---|
| Identifies the REST Object Definitions Inventory Related Objects Inventory Load Object. |
Supported HTTP Methods
Method | Description |
---|---|
PUT | Creates a new Inventory Load object identified by the ${LoadNum} URL parameter. |
POST 3.17.0 | Creates a new Inventory Load object. Server will auto generate ${LoadNum} and will return it in HTTP response. |
HTTP Headers
This API uses the default ServiceMobility HTTP Headers.
API Specifics
Retrieve the details of a specific Inventory Load
This REST API will return an Inventory Load with the specified ID. The Inventory Load with the specified ID must already exist in the system.
URL
GET /seiapi/v3/trans/Load/${LoadNum}
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 Inventory Load Object. Otherwise, on error, the response body will contain a descriptive reason for the error.
Create a new Inventory Load
This REST API will insert a new Inventory Load, returning the ID for the created object.
Once created, the Inventory Load object can no longer be updated by the backend system.
URL
POST /seiapi/v3/trans/Load
HTTP Request Body
The HTTP request body must contain a valid REST Object Definitions Inventory Related Objects Inventory Load Object.
HTTP Response
On success, an HTTP response code of 201 will be returned, and:
- The response
Location
header will contain a URL defining the location of the created REST Object Definitions Inventory Related Objects Inventory Load Object, which can be used in aGET
API call; and - The response body will contain a plain text representation of the
${LoadNum}
for the created REST Object Definitions Inventory Related Objects Inventory Load Object.
Insert the details of a specific Inventory Load for a specific Load Number
This REST API will insert a new Inventory Load with the specified ID into the system, if a Inventory Load with the specified ID does not already exist in the system.
Once created, the Inventory Load object can no longer be updated by the backend system.
URL
PUT /seiapi/v3/trans/Load/${LoadNum}
HTTP Request Body
The HTTP request body must contain a valid REST Object Definitions Inventory Related Objects Inventory Load Object.
HTTP Response
On success the API will return a response code of 200.
Delete a specific Inventory Load
This REST API will delete an Inventory Load with the specified ID from the system. The Inventory Load with the specified ID must already exist in the system.
URL
DELETE /seiapi/v3/trans/Load/${LoadNum}
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 Inventory Load Object.