--- title: "getCommissaryOrdersByPage" method: GET path: "/commissaryorder/v1/getCommissaryOrdersByPage" tags: ["Commissary Order Service"] --- # getCommissaryOrdersByPage `GET /commissaryorder/v1/getCommissaryOrdersByPage` Retrieves all commissary orders with the accompanying information by page number. ## Query parameters - `customerLocationCode` string - `expectedDeliveryDateStart` string - `expectedDeliveryDateEnd` string - `includeDetails` boolean - `locationCode` string - `orderDateStart` string - `orderDateEnd` string - `orderNumber` string - `orderStatus` 'NEWORDER' | '1' | 'SUBMITTED' | '18' | 'PICKLISTED' | '19' | 'INVOICED' | '2' | 'CANCELED' | '4' | 'PHYSICALRECONCILED' | '7' | 'FINALRECONCILED' | '3' - `pageNumber` integer - `postDate` string - `referenceNumber` string - `sortBy` 'orderPk' | 'orderNumber' | 'orderDate' | 'invoiceDate' - `sortOrder` 'ASC' | 'DESC' - `pageSize` integer - `includeNull` boolean ## Headers - `authenticationtoken` string, required - `password` string, required - `sitename` string, required - `userid` string, required - `X-B3-TraceId` string ## Response `200` Success - CommissaryOrderBatchResponseDto — CommissaryOrderBatchResponseDto description - `commissaryOrderDetails` CommissaryOrderDetails[] - `commissaryOrderDetailDetails` CommissaryOrderDetailsDto[] - `completeTaxRate` number — Complete Tax Rate - `conversionInventoryIssueUnit` number — Conversion from Inventory Unit to Issue Unit. Note that this is the configured Issue Unit from the Company Products screen, not necessarily the unit the order was placed in. - `conversionInventoryOrderUnit` number — Conversion from Inventory Unit to the Ordered Unit - `conversionInventoryPicklistUnit` number — Conversion from Inventory Unit to the Picklisted Unit - `conversionInventoryInvoiceUnit` number — Conversion from Inventory Unit to the Invoiced Unit - `conversionInventoryPhysReconUnit` number — Conversion from Inventory Unit to the Physically Reconciled Unit - `conversionInventoryFinReconUnit` number — Conversion from Inventory Unit to the Final Reconciled Unit - `customerStorageLocation` string — Storage code for the storage location at the receiving location (incoming commissary order) - `customerStorageLocationCode` string — Storage name for the storage location at the receiving location (incoming commissary order) - `finalReconcilePrice` number — Price to customer at Final Reconcile. (This is stored per Inventory Unit) - `finalReconcileQuantity` number — Final Reconciled Quantity, in issue units - `finalReconcileQuantityForInv` number — Final Reconciled Quantity, in inventory units - `finalReconcileQuantityForOrder` number — Final Reconciled Quantity for the ordered units - `unitPrice` number — Unit Price (This is stored per Inventory Unit) - `invoicePrice` number — Price to customer at Invoice. (This is stored per Inventory Unit) - `invoiceQuantity` number — Invoiced Quantity, in issue units - `invoiceQuantityForInv` number — Invoiced Quantity, in inventory units - `invoiceQuantityForOrder` number — Invoiced Quantity, in ordered units - `orderQuantity` number — Ordered Quantity, in issue units - `orderQuantityForInv` number — Ordered Quantity, in inventory units - `orderQuantityForOrder` number — Ordered Quantity, in ordered units - `physicalReconcilePrice` number — Price to customer at Physical Reconcile. (This is stored per Inventory Unit) - `physicalReconcileQuantity` number — Physical Reconciled Quantity, in issue units - `physicalReconcileQuantityForInv` number — Physical Reconciled Quantity, in inventory units - `physicalReconcileQuantityForOrder` number — Physical Reconciled Quantity for the ordered units - `picklistQuantity` number — Picklisted Quantity, in issue units - `picklistQuantityForInv` number — Picklisted Quantity, in inventory units - `picklistQuantityForOrder` number — Picklisted Quantity for the ordered units - `productName` string — Product Name - `productNumber` string — Product Number - `qualitativeJudgment` string — Qualitative judgment supplied (if any) for the line item at the receiving location. (Incoming commissary order) - `storageLocation` string — Storage name for the storage location at the commissary location sending the product (outgoing commissary order) - `storageLocationCode` string — Storage code for the storage location at the commissary location sending the product (outgoing commissary order) - `suggestedQuantity` number — Suggested Quantity - `taxCode` string — Tax code related to the product (if any) - `taxDescription` string — Tax description related to the product (if any) - `taxValue` number — Value of the tax for the product - `orderUnit` string — The unit of measure (package type) this product was ordered in - `picklistUnit` string — The unit of measure (package type) this product was picklisted in - `invoiceUnit` string — The unit of measure (package type) this product was invoiced in - `physicalReconcileUnit` string — The unit of measure (package type) this product was physical reconciled in - `finalReconcileUnit` string — The unit of measure (package type) this product was final reconciled in - `inventoryUnit` string — The Inventory Unit of the product - `issueUnit` string — The Issue Unit of the product - `commissaryOrderHeaderDetails` CommissaryOrderHeaderDto — CommissaryOrderHeaderDto description - `arBatchNumber` integer — Accounts Receivable Batch Number - `consumptionDays` number — Number of days of consumption used when this order was created - `customerCode` string — Location Code for the Customer Location receiving the order (incoming commissary order) - `customerName` string — Location Name for the Customer Location receiving the order (incoming commissary order) - `entryDate` string — Date order originally created, or an order in New Order status was last edited - `entryDateUTC` string — Entry Date in UTC - `entryUser` string — User ID for the user who originally created order or last edited New Order Status - `expectedDeliveryDate` string — Expected Delivery Date - `expectedDeliveryDateUTC` string — Expected Delivery Date in UTC - `finalReconcileDate` string — Date order was final reconciled - `finalReconcileDateUTC` string — Final Reconcile Date in UTC - `finalReconcileUser` string — User ID for the user who final Reconciled order, or last Edited final Reconciled order - `finalReconcileValue` number — Total Value at Reconcile - `invoiceDate` string — Date the order was invoiced - `invoiceDateUTC` string — Invoice Date in UTC - `invoiceUser` string — User ID for the user ID for the user who Invoiced order, or last Edited Invoiced order - `invoiceValue` number — Before invoicing, this is the total value of the ordered products. After invoice, this is the invoiced value for all products. Note that this gets set to zero if an order is canceled. - `locationCode` string — Code number for the Commissary Location supplying the order (outgoing commissary order) - `locationName` string — Code name for the Commissary Location supplying the order (outgoing commissary order) - `orderNumber` string — Order Number - `orderStatus` string — Order Status (NEW ORDER [1], SUBMITTED [18], PICKLISTED [19], INVOICED [2], CANCELED [4], PHYSICAL RECONCILED [7], FINAL RECONCILED [3]) - `physicalReconcileDate` string — Date order was physically reconciled, or the last time a physically reconciled order was edited - `physicalReconcileDateUTC` string — Physical Reconcile Date in UTC - `physicalReconcileUser` string — User ID for the user who Physical Reconciled order, or last Edited Physical Reconciled order - `postDate` string — Post date that this order falls in - `postDateUTC` string — Post Date in UTC - `referenceNumber` string — Reference Number - `grandTotal` number — Total value of the products ordered plus any tax values - `taxTotal` number — Total value of calculated tax from the products on the order - `hasNext` boolean — has Next - `totalPages` integer — Total Pages ## Other responses - `400` — Validation Error - `401` — Authorization - `404` — commissary order not found - `429` — Too Many Requests - `500` — Unexpected Error - `503` — System under maintenance - `504` — Timeout --- [API](https://skmtc.net/crunchtime/apis/inventory-labor.md) · [All operations](https://skmtc.net/crunchtime/apis/inventory-labor/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/crunchtime/inventory-labor/revisions/0af8e380ff2c/schema)