--- title: "getPurchaseOrdersByPage" method: GET path: "/purchaseorder/v1/getPurchaseOrdersByPage" tags: ["Purchase Order Service"] --- # getPurchaseOrdersByPage `GET /purchaseorder/v1/getPurchaseOrdersByPage` ## Request - Base URL: `//webservices-test.net-chef.com` (relative, and the document’s source URL is not known) - URL: `//webservices-test.net-chef.com/purchaseorder/v1/getPurchaseOrdersByPage` - Auth: none declared. Required headers: `authenticationtoken`, `password`, `sitename`, `userid` Retrieves all vendor orders with the accompanying information by page number. The minutesSinceUpdate or at least two of the following parameters must be populated: locationCode, vendorCode, purchaseOrderNumber, vendorInvoiceNumber, or orderType. ## Query parameters - `actualDeliveryDateEnd` string - `actualDeliveryDateStart` string - `expectedDeliveryDateEnd` string - `expectedDeliveryDateStart` string - `includeDetails` boolean - `invoiceDateEnd` string - `invoiceDateStart` string - `locationCode` string - `orderDateEnd` string - `orderDateStart` string - `orderType` string - `pageNumber` integer - `postDate` string - `productNumber` string - `purchaseOrderNumber` string - `reconcileDateEnd` string - `reconcileDateStart` string - `status` '1' | '7' | '3' | '4' - `submitDateEnd` string - `submitDateStart` string - `traceabilityCode` string - `vendorCode` string - `vendorInvoiceNumber` string - `vendorProductName` string - `vendorProductNumber` string - `pageSize` integer - `minutesSinceUpdate` integer - `sortBy` 'orderPk' | 'orderNumber' | 'lastUpdated' | 'submitDate' | 'createDate' | 'invoiceDate' - `sortOrder` 'ASC' | 'DESC' - `includeNull` boolean ## Headers - `authenticationtoken` string, required - `password` string, required - `sitename` string, required - `userid` string, required - `X-B3-TraceId` string ## Response `200` Success - PurchaseOrderBatchResponseDto: PurchaseOrderBatchResponseDto description - `hasNext` boolean - `purchaseOrderDetails` PurchaseOrderHeaderDto[] - `accountNumber` string: Receiving location's specific account number with the vendor - `actualDeliveryDate` string: Actual Delivery Date - `adjustInvoicePrices` boolean: Indicates if invoice prices will be adjusted based on vendor setting at the time of invoice - `apBatchNumber` string: AP Batch Number - `approvalDate` string: Date an order was approved - `approvalDateUTC` string: Date an order was approved UTC - `approvalRequiredFlag` boolean: Indicates whether the vendor order requires approval because of a price/quantity discrepancy - `approvalUser` string: User that approved an order - `autoOrderFlag` boolean: Indicates whether the order was created by Auto-Order - `autoOrderTransmitFlag` boolean: Indicates whether the autoorder has been successfully transmitted - `checkNumber` string: Check Number (COD) - `confirmAnticipatedShipDate` string: Confirm Anticipated Ship Date - `confirmAnticipatedShipDateUTC` string: Confirm Anticipated Ship Date UTC - `confirmDate` string: Date Confirmed Terms for order - `confirmReceiptDate` string: Date Confirmed Receipt for order - `confirmReceiptFlag` boolean: Indicates that a Vendor Order Confirm Receipt has been received for the Vendor Order - `confirmReceiptTrackingNum` string: Vendor’s tracking number for the Vendor Order - `confirmReceiptUser` string: User who confirmed receipt - `confirmTermsAlert` boolean: Indicates whether an alert (price or quantity) was identified during the confirm terms process - `confirmTermsFlag` boolean: Indicates when a confirm terms file is successfully processed - `confirmUser` string: User who confirmed Terms for order - `consumptionDays` number, double: Number of days of consumption - `corporateCurrency` string: Corporate Currency - `createDate` string: Create Date - `createDateUTC` string: Create Date UTC - `createdByOcr` boolean: Indicates whether the order was created by OCR - `createdByReconciler` boolean: Indicates whether the order was created by Reconciler Mobile application - `ctxConfirmReceiptUser` string: CTX user email that acknowledged the order - `ctxConfirmUser` string: CTX user email that confirmed the order - `ctxInvoiceUser` string: CTX user email that invoiced the order - `deliverToLocationCode` string: Deliver to Location Code - `details` PurchaseOrderDetailsDto[]: Product Details for the order - `actualBidContractConv` number, double: Actual Conversion from Bid or Contract Price from Vendor Bid - `actualBidContractPrice` number, double: Actual Bid or Contract Price from Vendor Bid - `addVendorCode` string: Vendor for which the vendor product was received from. Only populated if the vendor product was received from a different vendor than the order was with - `altVpFlag` boolean: Indicates the vendor product line item of a vendor order in which is considered the primary vendor product on order and was not split into secondary vendor products - `approvePriceAlertFlag` boolean: Flags whether the line item had a Price Alert which requires approval - `approveQuantityAlertFlag` boolean: Flags whether the line item had a Quantity Alert which requires approval - `catchWeighted` boolean: Catch Weighted - `cnvConfirmToInventory` number, double: Conversion from Vendor Unit to Inventory Unit at Confirm Terms - `cnvEntryToInventory` number, double: Conversion from Vendor Unit to Inventory Unit from create - `cnvReconcileToInventory` number, double: Conversion from Vendor Unit to Inventory Unit at Reconcile - `completeTaxRate` number, double: Complete Tax Rate - `confirmTermsPriceAlert` boolean: Whether a price alert was identified during the confirm terms - `confirmTermsQuantityAlert` boolean: Whether a quantity alert was identified during the confirm terms - `creditValue` number, double: Credit used to adjust the receiving Invoice value of the transaction by adjusting the Invoice Price - `expirationDate` string: Expiration Date - `expirationDateUTC` string: Expiration Date UTC - `lotNumber` string: Lot Number - `manufacturerNumber` string: Manufacturer Number - `marketName` string: Market Name - `minDaysOnHand` number, double: Min Days On Hand - `notApproved` boolean: Not Approved - `poLineNumber` integer: PO Line Number - `priceCaptureDate` string: Price Capture Date - `priceCaptureDateUTC` string: Price Capture Date UTC - `priceConfirmation` number, double: Confirm Terms Item price per Vendor Unit - `priceEntry` number, double: Item price per Vendor Unit - `priceInvoice` number, double: Invoice Price per Vendor Unit - `priceInvoiceOriginal` number, double: Original Invoice Price of line item, prior to credit adjustment - `priceReconcile` number, double: Vendor Product Price - `priceRemediationFlag` boolean: Price discrepancies between invoice and reconcile - `priceUsed` number, double: Inventory Price - `productBrand` string: Product Brand from Vendor Bid/Contract - `productNumber` string: Product Number - `projectedConsumption` number: Projected Consumption calculated for this product - `qualitativeJudgement` string: Qualitative Judgement - `quantityConfirm` number, double: Confirm Terms Quantity, in Vendor Units - `quantityConfirmForInv` number, double: Confirm Terms Quantity, in Inventory Units - `quantityEntry` number, double: Quantity ordered, in Vendor units - `quantityEntryForInv` number, double: Quantity ordered, in Inventory units - `quantityInvoice` number, double: Invoice Quantity, in Vendor Units - `quantityInvoiceForInv` number, double: Invoice Quantity, in Inventory Units - `quantityMoForInv` number, double: Order Quantity originally requested in Master Order - `quantityReconcile` number, double: Physical Quantity received, in Vendor Units - `quantityReconcileForInv` number, double: Physical Quantity received, in Inventory Units - `quantityRemediationFlag` boolean: Quantity discrepancies between invoice and reconcile - `quantitySuggestedForInv` number, double: Quantity for the line item as suggested to the user - `referenceLineNumber` integer: Reference Line Number - `referenceNumber` string: Reference Number - `restricted` boolean: Restricted - `splitFlag` boolean: Status of Vendor Bid "Split" flag at create of order based on bid/contract - `storageCode` string: Storage Code - `subConversionFactor` number, double: Sub Conversion Factor - `subPackage` string: Sub Package Type - `subProductFlag` boolean: Indicates if the vendor product was substituted when received on an electronic invoice - `subProductName` string: Sub Product Name - `subProductNumber` string: Sub Product Number - `taxCode` string: Tax Code - `temperature` number, double: Temperature entered during NC Reconcile - `traceabilityCode` string: Traceability Lot Code - `traceabilityCodeSource` string: Traceability Lot Code Source - `vendorPackage` string: Vendor Package Type - `vendorPackageOrder` string: Vendor Package Order Type - `vendorPortalDetailExists` boolean: Vendor Portal Detail Exists - `vendorPortalSubExists` boolean: Vendor Portal Sub Exists - `vendorProductName` string: Vendor Product Name - `vendorProductNumber` string: Vendor Product Number - `vpOriginalReconcilePrice` number, double: The Original Reconcile Price - `vpOriginalReconcileQuantity` number, double: The Original Reconcile Quantity - `disputeDate` string: The date that the Vendor Order is rejected by the vendor - `disputeDateTime` string: Dispute DateTime - `disputeDateTimeUTC` string: Dispute DateTime UTC - `disputeDateUTC` string: The date that the Vendor Order is rejected by the vendor UTC - `doNotTransmitFlag` boolean: The user submitted the order without transmitting it - `electronicInvoiceDate` string: Electronic Invoice Date - `electronicInvoiceDateUTC` string: Electronic Invoice Date UTC - `electronicInvoiceFlag` boolean: Was Electronic Invoice received - `entryDate` string: Date order originally created - `entryDateUTC` string: Date order originally created UTC - `entryUser` string: User who originally created order - `expectedDeliveryDate` string: Expected Delivery Date - `finalReconcileDate` string: Date/time of final reconciliation of warehoused order - `finalReconcileDateUTC` string: Date/time of final reconciliation of warehoused order UTC - `finalReconcileUser` string: User performing final reconciliation of warehoused order - `invoiceDate` string: Invoice Date - `invoiceNumber` string: Invoice Number - `invoiceTotal` number, double: Invoice Total - `locCorpCurrencyRatio` number, double: Conversion from Vendor Base Currency to Location Base Currency - `locationCode` string: Location Code - `locationCurrency` string: Location Currency - `marketName` string: Market Name - `message` string: Vendor Order Message - `misc1Amount` number, double: Amount entered for "Misc. 1" at Vendor Order Reconcile - `misc1GlNumber` string: General Ledger number selected for "Misc. 1" at Vendor Order Reconcile - `misc2Amount` number, double: Amount entered for "Misc. 2" at Vendor Order Reconcile - `misc2GlNumber` string: General Ledger number selected for "Misc. 2" at Vendor Order Reconcile - `orderType` string: Vendor Order Type - `orderUnitSelected` string: I/V. 'I' = Order in Inventory Units, 'V' = Order in Vendor Units - `postDate` string: Post Date - `receivedWithoutInvoiceFlag` boolean: Indicate whether the vendor order has been Physically Received - `reconcileDate` string: Date order Reconciled - `reconcileDateUTC` string: Date order Reconciled UTC - `reconcileUser` string: User who reconciled order - `referenceNumber` string: Reference Number - `remediateDate` string: Remediate Date - `remediateDateUTC` string: Remediate Date UTC - `remediateUser` string: Remediate User - `remediationDate` string: The date the corporate user changes the vendor order - `remediationDateUTC` string: The date the corporate user changes the vendor order UTC - `remediationFlag` boolean: Indicates when the Vendor Order requires remediation from the corporate office - `remediationUser` string: User that updated vendor order. - `shippingAmount` number, double: Amount entered for "Freight/Shipping" at Vendor Order Reconcile - `shippingGlNumber` string: Tax General Ledger Number selected for "Freight/Shipping" - `status` integer: Inventory Type Status - `submitDate` string: Date order submitted - `submitDateUTC` string: Date order submitted UTC - `submitUser` string: User who submitted order - `taxAmount` number, double: Amount entered for "Tax" at Vendor Order Reconcile - `taxGlNumber` string: Tax General Ledger Number - `transactionNumber` string: Transaction Number - `userMatchAlertFlag` boolean: Indicates whether the same user submitted and reconciled a non e-invoice order - `venLocCurrencyRatio` number, double: Vendor to Location Currency Ratio - `vendorCode` string: Vendor Code - `vendorCurrency` string: Vendor Currency - `vendorPortalOrderExists` boolean: Vendor Portal Order Exists - `vpInvoiceFlag` boolean: Indicates that the vendor order was invoiced via the vendor portal - `totalPages` integer ## Other responses - `400`: Validation Error - `401`: Authorization - `404`: purchase orders not found - `429`: Too Many Requests - `500`: Unexpected Error - `503`: System under maintenance - `504`: Timeout ## Changes - **2026-11-03** `fff247a87cc9`: 3 breaking - removed the enum value `2` from the `query` request parameter `status` - removed the enum value `6` from the `query` request parameter `status` - removed the enum value `8` from the `query` request parameter `status` [Operation history](https://skmtc.dev/crunchtime/apis/inventory-labor/changes/purchaseorder/v1/getPurchaseOrdersByPage/get.md) --- [API](https://skmtc.dev/crunchtime/apis/inventory-labor.md) - [All operations](https://skmtc.dev/crunchtime/apis/inventory-labor/llms.txt) - [OpenAPI document](https://skmtc.dev/crunchtime/apis/inventory-labor/revisions/fff247a87cc9?raw)