v1

latestOpenAPI 3.0.0Apache License Version 2.02026-07-24163274903.6 KB
Inventory Service

getInventoryAdjustmentsByPage

Retrieve a page of inventory adjustments (waste transactions) by date and location.

get/inventory/inventoryadjustment/v1/getInventoryAdjustmentsByPage

Query parameters

componentRecipeAdjustmentFlagboolean

Recipe Adjustment. When true indicates a recipe adjustment, when false indicates an inventory adjustment.

daypartCodestring

The code for the Daypart associated with the adjustment.

entryDatestring required

Date of transaction adjustment in format DD-MMM-YY.

includeDetailsboolean

Retrieve all the details of the inventory adjustment.

locationCodestring required

The Code that identifies the Location in Crunchtime.

minutesSinceUpdateinteger

The number of minutes since a inventory adjustment record was last updated. Use to set how far back to search.

pageNumberinteger

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

transactionNumberstring

Transaction number associated to the entry in Crunchtime.

pageSizeinteger

Number of items to display per page.

includeNullboolean

Specify 'true' to output null data elements.

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
totalPagesinteger

Example response

{
  "inventoryAdjustmentDetails": [
    {
      "inventoryAdjustmentDetailDetails": [
        {
          "lotNumber": "165R-13593",
          "packageType": "GAL",
          "productName": "OIL BLENDED",
          "qualitativeJudgment": "BREAKAGE",
          "quantity": 0.2475,
          "recipeName": "MUSHROOMS ROASTED",
          "recipeQuantity": 9.9,
          "storageCode": "0004",
          "transactionDate": "12/14/2025",
          "value": 0.32,
          "unitCost": 19.2632,
          "recipeValue": 43.86
        }
      ],
      "inventoryAdjustmentHeaderDetails": {
        "componentRecipeAdjustmentFlag": "Y",
        "daypartCode": 6,
        "entryUser": "JSCOTT",
        "locationCode": "BS002",
        "memo": "Items left out on counter",
        "transactionNumber": "BS002",
        "transactionDate": "12/14/2025",
        "transactionValue": 132.48
      }
    }
  ]
}