Sign in

v1

latestOpenAPI 3.0.02026-07-266521,3121.2 MB
WarehouseTransfer

GetArchivedTransfersFiltered

Use this call to search for archived transfers which match a specific search term. <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

get/api/WarehouseTransfer/GetArchivedTransfersFiltered

Query parameters

searchType'SKU' | 'ITEMTITLE' | 'ITEMBARCODE' | 'TRANSFERREFERENCE' | 'BINREFERENCE'

The type of search.

filterstring

The search term.

pageNumberinteger

The page number (starting at 1).

entriesPerPageinteger

The number of entries to be returned per page.

Response

OK

PageNumberinteger

Result page number

EntriesPerPageinteger

Result page size, quantity of records per page

TotalEntriesinteger

Total records

TotalPagesinteger

Total pages

Example response

{
  "Data": [
    {
      "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"
        }
      ]
    }
  ]
}