Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 2 Next »

3.0.0

The Inventory Load REST API is used for creating and deleting inventory load objects. An inventory load, also referred to as an inventory shipment, is used to restock an inventory location such as a vehicle. The inventory load contains a list of items, their expected quantities and, if required, serial and batch control numbers. 

  • The actual inventory object will not be adjusted until the load is received and accepted by the mobile user.
  • Each inventory load object can only target a single inventory storage location.

An inventory load object, once created, can not be modified by the back-office. If a change is required the load must be delete and a new load created.

On this page:

Related pages:

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

ParameterDescription

${LoadNum}

Identifies the Inventory Load Object.

Supported HTTP Methods

MethodDescription
PUTCreates 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.

Unable to render {include} The included page could not be found.

 

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

Unable to render {include} The included page could not be found.

Create a new Inventory Load

This REST API will insert a new Inventory Load, returning the ID for the created object.

(warning) 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 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 Inventory Load Object, which can be used in a GET API call; and
  • The response body will contain a plain text representation of the ${LoadNum} for the created 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.

(warning) 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 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 Inventory Load Object.

  • No labels