POST public-api/transactions/item/add

This api is used to add quantity to an item. If an item has trackbys they must be entered. Quantity added in this way is always added using the stocking units. Requires the Allow Add permission and enforces Role Site permission Accepts a maximum of 500 records at a time



Request Information

URI Parameters

None.

Body Parameters

Collection of ItemAddTransactionModel
NameDescriptionTypeAdditional information
ItemNumber

Required: the unique identifier for this item

string

None.

Cost

Required: the cost of an individual unit cost of the inventory being added

decimal number

None.

DateAcquired

the date the inventory was acquired

date

None.

CustomerNumber

the customer associated with the transaction

string

None.

SiteName

Required: the site the inventory is being placed at. If ParentContainerId is specified, then this field should be null or empty.

string

None.

LocationCode

Required: the location the inventory is being placed at within the site If ParentContainerId is specified, then this field should be null or empty.

string

None.

ParentContainerId

Instead of adding inventory quantity using LocationCode and SiteName, the Inventory Quantity can be added (or nested) in 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.

VendorNumber

the vendor associated with the transaction

string

None.

Quantity

Required: the amount of inventory to add

decimal number

None.

DateCode

the date code of the inventory

date

None.

NewContainerId

This value should be specified ONLY if a new container is being added to the system. When a new container is added, the Quantity specified must be exactly 1. If NewContainerId already exists, then an error will be returned. If a new License Plate Number is being added and nested to an existing parent container instead of a site/location, then the value ParentContainerId must be specified, and ParentContainerId must already exist. THIS VALUE MUST BE GLOBALLY UNIQUE

string

None.

Lot

the lot of the inventory

string

None.

SerialNumber

the unique serial number of the inventory. This value must be unique for the specified ItemNumber. When SerialNumber is specified, the Quantity must be exactly 1.

string

None.

ReferenceNumber

The reference number associated with the transaction. This value is used to tag a transaction with a searchable/filterable value.

string

None.

OrderNumber

Sometimes during add or receive (when inventory quantity is being added), we will need to specify an (optional) Purchase Order Number. If the purchase Order Number does NOT exist, then the error 'Order Not Found' will be returned.

string

None.

TransactionRecordSource

The name or ip address of the mobile device or computer/workstation that is making the Inventory Add request

string

None.

UserNotes

string

None.

Request Formats

application/json

Sample:
[
  {
    "ItemNumber": "DateCodeItem8dd529a2f4ae32c",
    "Cost": 20.0,
    "DateAcquired": "0001-01-01T00:00:00",
    "SiteName": "Site8dd529a2f4ae32c",
    "LocationCode": "Location8dd529a2f4ae32c",
    "Quantity": 100.0,
    "DateCode": "2025-02-21T00:00:00Z"
  }
]

application/json

Sample:
- MandatoryField
[
  {
    "Cost": 20.0,
    "DateAcquired": "0001-01-01T00:00:00",
    "SiteName": "Warehouse 1",
    "LocationCode": "R1.S1.R1",
    "Quantity": 100.0,
    "DateCode": "2025-02-21T00:00:00Z"
  }
]

application/json

Sample:
- AlreadyExists
[
  {
    "ItemNumber": "DateCodeItem8dd529a2f4ae32c",
    "Cost": 20.0,
    "DateAcquired": "0001-01-01T00:00:00",
    "SiteName": "Site8dd529a2f4ae32c",
    "LocationCode": "Location8dd529a2f4ae32c",
    "Quantity": 100.0,
    "DateCode": "2025-02-21T00:00:00Z"
  }
]



Response Information

Resource Description

WaspResultOfResults
NameDescriptionTypeAdditional 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": "record 0 is success ,site name is Site8dd529a2f4ae32c,quantity is 100.0,cost is 20.0,location code is Location8dd529a2f4ae32c",
        "HttpStatusCode": 200,
        "FieldName": "record: 0"
      }
    ],
    "SuccessfullResults": 1,
    "TotalResults": 1,
    "ErrorCount": 0
  },
  "Messages": [
    {
      "ResultCode": 0,
      "Message": "Success",
      "HttpStatusCode": 200,
      "FieldName": ""
    }
  ],
  "TotalRecordsLongCount": 1,
  "HasSuccessWithMoreDataRemaining": false,
  "HasError": false,
  "HasMessage": true,
  "HasHttpError": false
}