POST public-api/transactions/item/check-out
This api is used to check out quantity of an item. If an item has trackbys they must be entered. Quantity checked out in this way is always checked out using the stocking units. A Customer or Vendor must be specified and not both. Requires the Allow Check Out permission, enforces Role Site security Accepts a maximum of 500 records at a time
Request Information
URI Parameters
None.
Body Parameters
Collection of ItemCheckOutTransactionModel| Name | Description | Type | Additional information |
|---|---|---|---|
| ItemNumber | string |
None. |
|
| FromSiteName | string |
None. |
|
| FromLocationCode | string |
None. |
|
| FromParentContainerId | string |
None. |
|
| ToSiteName | string |
None. |
|
| ToLocationCode | string |
None. |
|
| ToParentContainerId | string |
None. |
|
| DueDate | date |
None. |
|
| CustomerNumber | string |
None. |
|
| VendorNumber | string |
None. |
|
| Quantity | decimal number |
None. |
|
| DateCode | date |
None. |
|
| Lot | string |
None. |
|
| SerialNumber | string |
None. |
|
| ContainerId | string |
None. |
|
| Notes | string |
None. |
|
| GeoLocation | GeoLocation |
None. |
Request Formats
application/json
Sample:
[
{
"ItemNumber": "sample string 1",
"FromSiteName": "sample string 2",
"FromLocationCode": "sample string 3",
"FromParentContainerId": "sample string 4",
"ToSiteName": "sample string 5",
"ToLocationCode": "sample string 6",
"ToParentContainerId": "sample string 7",
"DueDate": "2026-09-15T18:17:30.4086687+00:00",
"CustomerNumber": "sample string 8",
"VendorNumber": "sample string 9",
"Quantity": 10.0,
"DateCode": "2026-09-15T18:17:30.4086687+00:00",
"Lot": "sample string 11",
"SerialNumber": "sample string 12",
"ContainerId": "sample string 13",
"Notes": "sample string 14",
"GeoLocation": {
"ImportRowNumber": 1,
"GeoLocationId": 2,
"Latitude": 1.0,
"Longitude": 1.0,
"Altitude": 1.0,
"TimeUTC": "2026-09-15T18:17:30.4086687+00:00",
"Accuracy": 1.0,
"DeviceReason": 64,
"DeviceStatus": 1,
"Address": {
"AddressImportRowNumber": 1,
"AddressId": 2,
"AddressTypeId": 3,
"AddressAssociationId": 4,
"Address1": "sample string 5",
"Address2": "sample string 6",
"Address3": "sample string 7",
"Address4": "sample string 8",
"AddressCity": "sample string 9",
"AddressState": "sample string 10",
"AddressPostalCode": "sample string 11",
"AddressCountry": "sample string 12",
"AddressMailStop": "sample string 13",
"AddressTypeName": "sample string 14",
"AddressTypeLangLabel": "sample string 15",
"AddressTypeFormId": 16,
"AddressChangeType": 1,
"HdnAddressTypeId": 17,
"AddressRecordStatus": 18,
"AddressIsPrimary": true
},
"History": [
{
"Latitude": 1.0,
"Longitude": 1.0,
"Altitude": 1.0,
"TimeUTC": "2026-09-15T18:17:30.4086687+00:00",
"Accuracy": 1.0,
"Date": "2026-09-15T18:17:30.4086687+00:00",
"UserId": "d62ace91-aba1-4512-9992-6b3975ca5b68",
"Reason": 64,
"Status": 1,
"ReasonDescription": "sample string 3",
"GeofenceNames": [
"sample string 1",
"sample string 2"
],
"TransactionTypeDescription": "sample string 4"
},
{
"Latitude": 1.0,
"Longitude": 1.0,
"Altitude": 1.0,
"TimeUTC": "2026-09-15T18:17:30.4086687+00:00",
"Accuracy": 1.0,
"Date": "2026-09-15T18:17:30.4086687+00:00",
"UserId": "d62ace91-aba1-4512-9992-6b3975ca5b68",
"Reason": 64,
"Status": 1,
"ReasonDescription": "sample string 3",
"GeofenceNames": [
"sample string 1",
"sample string 2"
],
"TransactionTypeDescription": "sample string 4"
}
]
}
},
{
"ItemNumber": "sample string 1",
"FromSiteName": "sample string 2",
"FromLocationCode": "sample string 3",
"FromParentContainerId": "sample string 4",
"ToSiteName": "sample string 5",
"ToLocationCode": "sample string 6",
"ToParentContainerId": "sample string 7",
"DueDate": "2026-09-15T18:17:30.4086687+00:00",
"CustomerNumber": "sample string 8",
"VendorNumber": "sample string 9",
"Quantity": 10.0,
"DateCode": "2026-09-15T18:17:30.4086687+00:00",
"Lot": "sample string 11",
"SerialNumber": "sample string 12",
"ContainerId": "sample string 13",
"Notes": "sample string 14",
"GeoLocation": {
"ImportRowNumber": 1,
"GeoLocationId": 2,
"Latitude": 1.0,
"Longitude": 1.0,
"Altitude": 1.0,
"TimeUTC": "2026-09-15T18:17:30.4086687+00:00",
"Accuracy": 1.0,
"DeviceReason": 64,
"DeviceStatus": 1,
"Address": {
"AddressImportRowNumber": 1,
"AddressId": 2,
"AddressTypeId": 3,
"AddressAssociationId": 4,
"Address1": "sample string 5",
"Address2": "sample string 6",
"Address3": "sample string 7",
"Address4": "sample string 8",
"AddressCity": "sample string 9",
"AddressState": "sample string 10",
"AddressPostalCode": "sample string 11",
"AddressCountry": "sample string 12",
"AddressMailStop": "sample string 13",
"AddressTypeName": "sample string 14",
"AddressTypeLangLabel": "sample string 15",
"AddressTypeFormId": 16,
"AddressChangeType": 1,
"HdnAddressTypeId": 17,
"AddressRecordStatus": 18,
"AddressIsPrimary": true
},
"History": [
{
"Latitude": 1.0,
"Longitude": 1.0,
"Altitude": 1.0,
"TimeUTC": "2026-09-15T18:17:30.4086687+00:00",
"Accuracy": 1.0,
"Date": "2026-09-15T18:17:30.4086687+00:00",
"UserId": "d62ace91-aba1-4512-9992-6b3975ca5b68",
"Reason": 64,
"Status": 1,
"ReasonDescription": "sample string 3",
"GeofenceNames": [
"sample string 1",
"sample string 2"
],
"TransactionTypeDescription": "sample string 4"
},
{
"Latitude": 1.0,
"Longitude": 1.0,
"Altitude": 1.0,
"TimeUTC": "2026-09-15T18:17:30.4086687+00:00",
"Accuracy": 1.0,
"Date": "2026-09-15T18:17:30.4086687+00:00",
"UserId": "d62ace91-aba1-4512-9992-6b3975ca5b68",
"Reason": 64,
"Status": 1,
"ReasonDescription": "sample string 3",
"GeofenceNames": [
"sample string 1",
"sample string 2"
],
"TransactionTypeDescription": "sample string 4"
}
]
}
}
]
Response Information
Resource Description
WaspResultOfResults| Name | Description | Type | Additional information |
|---|---|---|---|
| Data | Results |
None. |
|
| Messages | Collection of WtResult |
None. |
|
| BatchNumber | integer |
None. |
|
| HasError | boolean |
None. |
|
| HasHttpError | boolean |
None. |
|
| HasMessage | boolean |
None. |
|
| HasSuccessWithMoreDataRemaining | boolean |
None. |
|
| TotalRecordsLongCount | integer |
None. |
Response Formats
application/json
Sample:
{
"Data": {
"ResultList": [
{
"ResultCode": 0,
"Message": "sample string 1",
"HttpStatusCode": 200,
"FieldName": "sample string 2"
},
{
"ResultCode": 0,
"Message": "sample string 1",
"HttpStatusCode": 200,
"FieldName": "sample string 2"
}
],
"SuccessfullResults": 1,
"TotalResults": 2,
"ErrorCount": 0
},
"Messages": [
{
"ResultCode": 0,
"Message": "sample string 1",
"HttpStatusCode": 200,
"FieldName": "sample string 2"
},
{
"ResultCode": 0,
"Message": "sample string 1",
"HttpStatusCode": 200,
"FieldName": "sample string 2"
}
],
"BatchNumber": 1,
"HasError": false,
"HasHttpError": false,
"HasMessage": true,
"HasSuccessWithMoreDataRemaining": false,
"TotalRecordsLongCount": 1
}