v1

latestOpenAPI 3.0.0Apache License Version 2.02026-07-24163274903.6 KB

Commissary Order Service

getCommissaryOrdersByPage

Retrieves all commissary orders with the accompanying information by page number.

get/commissaryorder/v1/getCommissaryOrdersByPage

Query parameters

customerLocationCodestring

Code number for the Customer Location receiving the order (incoming commissary order).

expectedDeliveryDateStartstring

Retrieve orders with expected delivery date equal to this date or later (optional). Must be entered together with the end date.

expectedDeliveryDateEndstring

Retrieve orders with expected delivery date equal to this date or earlier (optional). Must be entered together with the start date.

includeDetailsboolean

Use true to retrieve detailed information for each Commissary Order (optional).

locationCodestring

Code number for the Commissary Location supplying the order (outgoing commissary order).

orderDateStartstring

Retrieve orders with entry date equal to this date or later. Must be entered together with the end date.

orderDateEndstring

Retrieve orders with entry date equal to this date or earlier. Must be entered together with the start date.

orderNumberstring

Order Number for order to retrieve.

orderStatus'NEWORDER' | '1' | 'SUBMITTED' | '18' | 'PICKLISTED' | '19' | 'INVOICED' | '2' | 'CANCELED' | '4' | 'PHYSICALRECONCILED' | '7' | 'FINALRECONCILED' | '3'

Order Status (NEW ORDER [1], SUBMITTED [18], PICKLISTED [19], INVOICED [2], CANCELED [4], PHYSICAL RECONCILED [7], FINAL RECONCILED [3]) for orders to retrieve (optional).

pageNumberinteger

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

postDatestring

Retrieve orders with post date equal this date (optional).

referenceNumberstring

Reference Number for order to retrieve (optional).

sortBy'orderPk' | 'orderNumber' | 'orderDate' | 'invoiceDate'

Specifies the field used to sort the Commissary Orders. Default is 'orderNumber' if not provided (Optional).

sortOrder'ASC' | 'DESC'

Specifies the sort direction for Commissary Orders: ascending (ASC) or descending (DESC). Default is ASC if not specified (Optional).

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

has Next

totalPagesinteger

Total Pages

Example response

{
  "commissaryOrderDetails": [
    {
      "commissaryOrderDetailDetails": [
        {
          "completeTaxRate": 1,
          "conversionInventoryIssueUnit": 1,
          "conversionInventoryOrderUnit": 1,
          "conversionInventoryPicklistUnit": 1,
          "conversionInventoryInvoiceUnit": 2.13,
          "conversionInventoryPhysReconUnit": 2.13,
          "conversionInventoryFinReconUnit": 2.13,
          "customerStorageLocation": "0002",
          "customerStorageLocationCode": "WALK IN COOLER",
          "finalReconcilePrice": 2.02,
          "finalReconcileQuantity": 5.16,
          "finalReconcileQuantityForInv": 5.16,
          "finalReconcileQuantityForOrder": 11,
          "unitPrice": 0.9484,
          "invoicePrice": 2.02,
          "invoiceQuantity": 5.16,
          "invoiceQuantityForInv": 5.16,
          "invoiceQuantityForOrder": 11,
          "orderQuantity": 11,
          "orderQuantityForInv": 11,
          "orderQuantityForOrder": 11,
          "physicalReconcilePrice": 2.02,
          "physicalReconcileQuantity": 5.16,
          "physicalReconcileQuantityForInv": 5.16,
          "physicalReconcileQuantityForOrder": 11,
          "picklistQuantity": 11,
          "picklistQuantityForInv": 11,
          "picklistQuantityForOrder": 11,
          "productName": "P-ADOBO SAUCE",
          "productNumber": "1000011",
          "qualitativeJudgment": "ACCEPTABLE",
          "storageLocation": "01",
          "storageLocationCode": "STORE1",
          "taxCode": "TX-FOOD-LOCAL",
          "taxDescription": "Local Food Tax",
          "taxValue": 0.25,
          "orderUnit": "QT",
          "picklistUnit": "QT",
          "invoiceUnit": "LB",
          "physicalReconcileUnit": "LB",
          "finalReconcileUnit": "LB",
          "inventoryUnit": "QT",
          "issueUnit": "QT"
        }
      ],
      "commissaryOrderHeaderDetails": {
        "arBatchNumber": 175,
        "consumptionDays": 3,
        "customerCode": "7654",
        "customerName": "Boston Store",
        "entryDate": "04/09/2018 07:26:52",
        "entryDateUTC": "04/09/2018 04:26:52",
        "entryUser": "JAROD",
        "expectedDeliveryDate": "04/10/2018",
        "expectedDeliveryDateUTC": "04/09/2018",
        "finalReconcileDate": "08/20/2025 10:15:00",
        "finalReconcileDateUTC": "08/20/2025 04:45:00",
        "finalReconcileUser": "JAROD",
        "finalReconcileValue": 10.42,
        "invoiceDate": "08/14/2025 09:17:58",
        "invoiceDateUTC": "08/14/2025 06:17:58",
        "invoiceUser": "JAROD",
        "invoiceValue": 10.42,
        "locationCode": "JD",
        "locationName": "Boston Commissary",
        "orderNumber": "CO-10182",
        "orderStatus": "INVOICED",
        "physicalReconcileDate": "08/18/2025 08:30:00",
        "physicalReconcileDateUTC": "08/18/2025 03:00:00",
        "physicalReconcileUser": "JAROD",
        "postDate": "08/18/2025",
        "postDateUTC": "08/17/2025",
        "referenceNumber": "REF-2025-001",
        "grandTotal": 10.42,
        "taxTotal": 2.1
      }
    }
  ],
  "hasNext": true,
  "totalPages": 10
}