Sign in

v1

latestOpenAPI 3.0.02026-07-266521,3121.2 MB
WarehouseTransfer

AddItemToTransfer

Use this call to add an item to the transfer (only works for transfers in draft/request states) <b>Permissions Required: </b> GlobalPermissions.Inventory.WarehouseTransferNode <b>Rate limit: </b><span style="background-color:#0272d9;color:white;padding:4px 8px;text-align:center;border-radius:5px; font-size: small;"><b>150</b></span> / minute

post/api/WarehouseTransfer/AddItemToTransfer

Request body

fkTransferIdstring uuid

fkTransferId

pkStockItemIdstring uuid

pkStockItemId

Example request

{
  "fkTransferId": "00000000-0000-0000-0000-000000000000",
  "pkStockItemId": "00000000-0000-0000-0000-000000000000"
}

Response

OK

PkTransferItemIdstring uuid

Transfer ID

FkStockItemIdstring uuid

Stock item ID (unique identifier)

SKUstring

Product SKU

Barcodestring

Product barcode

ItemTitlestring

Product title

RequestedQuantityinteger

Quantity requested for transfer

SentQuantityinteger

Quantity transferred

ReceivedQuantityinteger

Quantity received

InFromLocationQuantityinteger

Quantity from location

DueFromLocationQuantityinteger

Due from location quantity

InToLocationQuantityinteger

Currently in location quantity

ItemNoteCountinteger

Items notes count

BinRackNumberstring

Stock item binrack

PkBinIdstring uuid

Transfer bin ID

Example response

{
  "PkTransferItemId": "00000000-0000-0000-0000-000000000000",
  "FkStockItemId": "00000000-0000-0000-0000-000000000000",
  "PkBinId": "00000000-0000-0000-0000-000000000000",
  "ItemNotes": [
    {
      "PkTransferItemNoteId": "00000000-0000-0000-0000-000000000000",
      "FkBinId": "00000000-0000-0000-0000-000000000000",
      "PkTransferItemId": "00000000-0000-0000-0000-000000000000"
    }
  ]
}