---
title: "getVendorProductPricingByPage"
method: GET
path: "/vendorproductpricing/v1/getVendorProductPricingByPage"
tags: ["Vendor Product Pricing Service"]
---

# getVendorProductPricingByPage

`GET /vendorproductpricing/v1/getVendorProductPricingByPage`

## Request

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

Retrieve a page of vendor product pricing.

## Query parameters

- `activeProductFlag` string
- `bidSheet` string
- `contractStatus` string
- `effectiveDate` string
- `market` string
- `minutesSinceUpdate` integer
- `pageNumber` integer
- `substitute` string
- `productName` string
- `productNumber` string
- `secondaryMarket` string
- `vendor` string
- `pageSize` integer
- `includeNull` boolean

## Headers

- `authenticationtoken` string, required
- `password` string, required
- `sitename` string, required
- `userid` string, required
- `X-B3-TraceId` string

## Response `200`

Success

- VendorProductPricingBatchResponseDto: VendorProductPricingBatchResponseDto description
  - `hasNext` boolean
  - `totalPages` integer
  - `vendorProductPricingRows` VendorProductPricingDto[]
    - `beginDate` string: "Begin Date" of vendor product
    - `bidSheet` string: "Bid Sheet" from Vendor Bids screen
    - `contractStatus` string: "Contract Status" indicates (Y/N) whether the product has a contract
    - `conversionToInventoryUnit` number: "Conversion Factor" from Vendor to Inventory unit.
    - `endDate` string: "End Date" of vendor product
    - `inventoryUnit` string: "Inventory Unit" from Vendor Bids screen
    - `lastChangeDate` string: "Last Change Date" from Vendor Bids screen
    - `market` string: "Market Name" from Market screen
    - `preferredUnit` string: "Preferred Unit" from Vendor Bids screen
    - `price` number: "Price" from Vendor Bids screen
    - `productBrand` string: "Product Brand" from Vendor Bids screen
    - `productName` string: "Company Product Name" from Company Products screen
    - `productNumber` string: "Company Product Number" from Company Products screen
    - `secondaryMarket` string: "Secondary Market Flag" shows relationship between markets.
    - `secondaryVendorProducts` SecVendorProductPricingDto[]: "Secondary Vendor Products" from Vendor Bids screen
      - `beginDate` string: "Begin Date" of vendor product
      - `conversionToInventoryUnit` number: "Conversion Factor" from Vendor to Inventory unit.
      - `endDate` string: "End Date" of vendor product
      - `lastChangeDate` string: "Last Change Date" from Vendor Bids screen
      - `price` number: "Price" from Vendor Bids screen
      - `primaryAltPrimary` string: "Alternative Primary" flag from Vendor Bid Split and Secondary Vendor Products pop-up
      - `productBrand` string: "Product Brand" from Vendor Bid Split and Secondary Vendor Products pop-up
      - `splitFlag` string: "Split" flag from Vendor Bid Split and Secondary Vendor Products pop-up
      - `vendorPackSize` string: "Vendor Pack Size" - Vendor Unit from Vendor Bid Split and Secondary Vendor Products pop-up
      - `vendorProductName` string: "Vendor Product Name" from Vendor Bid Split and Secondary Vendor Products pop-up
      - `vendorProductNumber` string: "Vendor Product Number" from Vendor Bid Split and Secondary Vendor Products pop-up
      - `substitute` string: "Substitute" flag from Vendor Bid Split and Secondary Vendor Products pop-up
      - `substituteNotApproved` string: "Not Approved" flag from Vendor Bid Split and Secondary Vendor Products pop-up
      - `substituteRestricted` string: "Restricted" flag from Vendor Bid Split and Secondary Vendor Products pop-up
      - `taxCode` string: "Tax Code" from Vendor Bid Split and Secondary Vendor Products popup
    - `splitFlag` string: "Split" flag from Vendor Bids screen
    - `usage` string: "Usage"
    - `vendor` string: "Vendor Name" from Vendor setup screen
    - `vendorCode` string: "Vendor Code" from Vendor setup screen
    - `vendorPackSize` string: "Vendor Pack Size" - Vendor Unit from Vendor Bids screen
    - `vendorProductNumber` string: "Vendor Product Number" from Vendor Bids screen
    - `contractLastChangeDate` string: "Last Change Date" for Contract
    - `taxCode` string: "Tax Code" from Vendor Bids screen
    - `contractInfo` ContractInfoDto: ContractInfoDto description
      - `referenceNumber` string: "Reference #" from Contract Info on Vendor Bids screenr
      - `lineNumber` string: "Line #" from Contract Info on Vendor Bids screen
      - `expirationDate` string: "Expiration Date" from Contract Info on Vendor Bids screen

## Other responses

- `400`: Validation Error
- `401`: Authorization
- `404`: vendor product pricing not found
- `429`: Too Many Requests
- `500`: Unexpected Error
- `503`: System under maintenance
- `504`: Timeout

---

[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)