Sign in

v1

latestOpenAPI 3.0.02026-07-266521,3121.2 MB
WarehouseTransfer

CreateTransferRequestWithReturn

Use this call to create a new transfer request with default reference number <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/CreateTransferRequestWithReturn

Request body

fromLocationIdstring uuid

pkLocationId for from Location

toLocationIdstring uuid

pkLocationId for to Location

Example request

{
  "fromLocationId": "00000000-0000-0000-0000-000000000000",
  "toLocationId": "00000000-0000-0000-0000-000000000000"
}

Response

OK

PkTransferIdstring uuid

Transfer ID

FromLocationIdstring uuid

Location from which transfer is made (unique identifier)

ToLocationIdstring uuid

Location to which transfer is made (unique identifier)

FromLocationstring

Name of location from which transfer is made

ToLocationstring

Name of location to which transfer is made

Status'Draft' | 'Request' | 'Accepted' | 'Packing' | 'InTransit' | 'CheckingIn' | 'Delivered'

Current transfer status

nStatusinteger

Status ID

ReferenceNumberstring

Transfer reference number

OrderDatestring date-time

When transer was ordered

NumberOfItemsinteger

Number of items transfered

NumberOfNotesinteger

Number of transfer notes

fkOriginalTransferIdstring uuid

Original transfer ID

OriginalTransferReferencestring

Original transfer reference number

IsDiscrepancyTransferboolean

If its a discrepency transfer

BLogicalDeleteboolean

If transfer is deleted

Example response

{
  "PkTransferId": "00000000-0000-0000-0000-000000000000",
  "FromLocationId": "00000000-0000-0000-0000-000000000000",
  "ToLocationId": "00000000-0000-0000-0000-000000000000",
  "fkOriginalTransferId": "00000000-0000-0000-0000-000000000000",
  "Bins": [
    {
      "PkBinId": "00000000-0000-0000-0000-000000000000",
      "BinNotes": [
        {
          "PkTransferBinNoteId": "00000000-0000-0000-0000-000000000000",
          "PkBinId": "00000000-0000-0000-0000-000000000000"
        }
      ],
      "BinItems": [
        {
          "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"
            }
          ]
        }
      ]
    }
  ],
  "Notes": [
    {
      "PkTransferNoteId": "00000000-0000-0000-0000-000000000000"
    }
  ],
  "AuditTrail": [
    {
      "PkTransferAuditId": "00000000-0000-0000-0000-000000000000"
    }
  ],
  "TransferProperties": [
    {
      "PkTransferPropertyId": "00000000-0000-0000-0000-000000000000"
    }
  ]
}