POST public-api/transactions/item/remove

This api is used to remove quantity of an item. If an item has trackbys they must be entered. Quantity removed in this way is always removed using the stocking units. Requires the Allow Remove permission and enforces Role Site permission Accepts a maximum of 500 records at a time. If error, Returns a list of error message with a zero based index of items that contain errors.

Request Information

URI Parameters

None.

Body Parameters

Collection of ItemRemoveTransactionModel

Name	Description	Type	Additional information
ItemNumber	the unique identifier for this item	string	None.
DateRemoved	the date the inventory was removed	date	None.
CustomerNumber	the customer associated with the transaction	string	None.
SiteName	the site the inventory was removed from	string	None.
LocationCode	the location in the site the inventory was removed from	string	None.
ParentContainerId	Instead of removing inventory quantity using LocationCode and SiteName, the Inventory Quantity can be remvoe from a container (such as a carton, box, tote, tub, pallet, cage, etc). The License Plate Number must already exist in the system prior to use.	string	None.
ContainerId		string	None.
Quantity	the amount of inventory to remove	decimal number	None.
DateCode	the date code of the inventory	date	None.
Lot	the lot of the inventory	string	None.
SerialNumber	the unique serial number of the inventory	string	None.

Request Formats

application/json

Sample:

[
  {
    "ItemNumber": "DateCodeItem8dd529a2f4ae32c",
    "DateRemoved": "0001-01-01T00:00:00",
    "SiteName": "Site8dd529a2f4ae32c",
    "LocationCode": "Location8dd529a2f4ae32c",
    "Quantity": 50.0,
    "DateCode": "2025-02-21T00:00:00Z"
  }
]

Response Information

Resource Description

WaspResultOfResults

Name	Description	Type	Additional information
Data	Type specific result that always depends on the function called.	Results	None.
Messages	List of Messages. All APIs should return messages. If an API function returns an error you can find more information about the error or errors in this collection of messages.	Collection of WtResult	None.
BatchNumber	This is a global batch number generated by a mass group of transaction records to be returned to the consumer on each call to rolling transaction rules. This requests that each group of Move/Add/Remove transaction batches is tied together. In prior products (such as Mobile Asset Cloud), all are set to null and the only time when the batch number is generated is for multiple check-out transactions but the old is to generate for each responsible party.	integer	None.
HasError	True if an API function result has an error message in the results. If this is false, the function succeeded but other informative messages may be available.	boolean	None.
HasHttpError	True if an API function call could not be fully posted to the server or the results could not be fully returned.	boolean	None.
HasMessage	True if any message is available.	boolean	None.
HasSuccessWithMoreDataRemaining	True if the server sent part of the data and there is more data available. Use with paging APIs to fetch data one page at a time.	boolean	None.
TotalRecordsLongCount	This is the total number of records available in the database based on the query and filer conditions provided. It is possible that the value can change from call to call as users add and delete records so this should not be used to page through multiple recordsets of data. This is used, for example, to set relative scroll bar sizes. When paging through data using functions like the assetadvancedinfosearch, calculating TotalRecordsLongCount for every page full of data is an time-consuming operation. To avoid that extra calculation, and help prevent throttling, assign TotalRecordsLongCount to TotalCountFromPriorFetch in the AdvancedSearchParameters to skip recalculating this total page count and to page thru the records faster.	integer	None.

Response Formats

application/json

Sample:

{
  "Data": {
    "ResultList": [
      {
        "ResultCode": 0,
        "Message": "Success",
        "HttpStatusCode": 200,
        "FieldName": "DateCodeItem8dd529a2f4ae32c"
      }
    ],
    "SuccessfullResults": 1,
    "TotalResults": 1,
    "ErrorCount": 0
  },
  "Messages": [
    {
      "ResultCode": 0,
      "Message": "Success",
      "HttpStatusCode": 200,
      "FieldName": ""
    }
  ],
  "TotalRecordsLongCount": 1,
  "HasSuccessWithMoreDataRemaining": false,
  "HasError": false,
  "HasMessage": true,
  "HasHttpError": false
}