CRcrunchtime
Inventory Service

getInventoryLocationTransfersByPage

Changed on

Retrieve a page of inventory location and storage transfers for a location.

get/inventory/inventorylocationtransfers/v1/getInventoryLocationTransfersByPage

Request

  • Base URL
    //webservices-test.net-chef.com (relative, and the document’s source URL is not known)
  • URL
    //webservices-test.net-chef.com/inventory/inventorylocationtransfers/v1/getInventoryLocationTransfersByPage
  • Auth
    none declared. Required headers: authenticationtoken, password, sitename, userid

Query parameters

locationCodestring required

The Code that identifies the Location in Crunchtime. Matches either the source or the destination location of the transfer.

transactionNumberstring

Transaction number of the transfer. Exact match, case-insensitive.

transferType'L' | 'S'

Type of transfer to retrieve: L (Location) or S (Storage), case-insensitive. If left blank, both Location and Storage transfers are returned.

minutesSinceUpdateinteger

The number of minutes since a transfer record was last updated. Use to set how far back to search. Must be 0 or greater.

includeDetailsboolean

Retrieve the line items of each transfer. If false, the response contains header information only. If left blank, the default is true.

pageNumberinteger

Retrieve one or more records by pageNumber. Use to retrieve data in smaller chunks. If left blank, the default is 1.

pageSizeinteger

Number of items to display per page. Must be between 1 and 100.

Headers

authenticationtokenstring required

Secure token for API authentication.

passwordstring required

Password for the Crunchtime Application User.

sitenamestring required

Crunchtime site identifier. (test or production)

useridstring required

User ID for the Crunchtime Application User.

X-B3-TraceIdstring

Optional trace identifier for troubleshooting.

Response

Success

hasNextboolean

Indicates whether more pages are available.

totalPagesinteger

Total number of pages.

Example response

{
  "hasNext": true,
  "inventoryLocationTransfersDetails": [
    {
      "inventoryLocationTransfersDetailDetails": [
        {
          "productNumber": "100377",
          "productName": "TOMATO CRUSHED",
          "inventoryUnit": "CAN #10",
          "unitPrice": 3.2583,
          "issueQuantity": 2,
          "issueUnit": "CAN #10",
          "issueAmount": 6.5166,
          "requestQuantity": 2,
          "requestUnit": "CAN #10",
          "reconcileQuantity": 2,
          "reconcileAmount": 6.5166,
          "sourceLotNumber": "LOT-0001",
          "destinationLotNumber": "LOT-0001",
          "sourceStorageCode": "0004",
          "sourceStorageName": "DRY STORAGE",
          "destinationStorageCode": "0004",
          "destinationStorageName": "DRY STORAGE"
        }
      ],
      "inventoryLocationTransfersHeaderDetails": {
        "transferType": "Location",
        "initiatedBy": "S",
        "transactionNumber": "TFR-10002",
        "referenceNumber": "000242052712",
        "status": "Reconciled_Final",
        "transferDate": "05/26/2012",
        "entryUser": "USER0066",
        "sourceLocationCode": "000001",
        "sourceLocationName": "AUTOMATION TWO",
        "destinationLocationCode": "000005",
        "destinationLocationName": "Rules THREE (GT3)",
        "sourceStorageCode": "0004",
        "sourceStorageName": "DRY STORAGE",
        "destinationStorageCode": "0004",
        "destinationStorageName": "DRY STORAGE",
        "transferMemo": "Weekly stock transfer",
        "transferTotal": 37.38,
        "reconcileDate": "05/28/2012",
        "reconcileUser": "USER0071",
        "rejectUser": "USER0072",
        "rejectMemo": "Wrong quantities",
        "requestDate": "05/24/2012",
        "requestUser": "USER0070",
        "requestMemo": "Need more for weekend",
        "requestTotal": 40
      }
    }
  ],
  "totalPages": 10
}

Changes