v1

latestOpenAPI 3.0.0Apache License Version 2.02026-07-24163274903.6 KB

Vendor Product Pricing Service

getVendorProductPricingByPage

Retrieve a page of vendor product pricing.

get/vendorproductpricing/v1/getVendorProductPricingByPage

Query parameters

activeProductFlagstring

Retrieve active products (optional). Default to Y, if not provided.

bidSheetstring

Name of bid sheet to retrieve (optional) (case sensitive full name search).

contractStatusstring

Retrieve products under contract (Y/N) - optional.

effectiveDatestring

Retrieve products relevant for this date (optional). API retrieves products with a beginDate less than or equal to the EffectiveDate and an endDate greater than the EffectiveDate. EffectiveDate is current date by default. Hint: If you want to see bids that end 'today', enter the date for the day before.

marketstring

Name of market to retrieve (optional) (case sensitive full name search).

minutesSinceUpdateinteger

The number of minutes since a vendor product pricing or contract 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.

substitutestring

Fetch substitute products (optional).

productNamestring

Name of product to retrieve (optional) (case sensitive full name search).

productNumberstring

Product number to retrieve. (case sensitive).

secondaryMarketstring

Retrieve products from secondary markets, if market param is provided. If market param is filled and secondaryMarket equals to "Y", API returns products not only from the market provided, but from secondary markets linked to the market, if there are any.

vendorstring

Name of vendor to retrieve (optional) (case sensitive full name search).

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

{
  "vendorProductPricingRows": [
    {
      "beginDate": "11/10/2023",
      "bidSheet": "QGF000",
      "contractStatus": "Y",
      "endDate": "11/10/2012",
      "inventoryUnit": "12/12 OZ",
      "lastChangeDate": "11/10/2020",
      "market": "My Market",
      "preferredUnit": "12/12 OZ",
      "price": 100,
      "productBrand": "Nestle",
      "productName": "My Company",
      "productNumber": "000222",
      "secondaryMarket": "Y",
      "secondaryVendorProducts": [
        {
          "beginDate": "11/10/2023",
          "endDate": "11/10/2012",
          "lastChangeDate": "11/10/2020",
          "price": 100,
          "primaryAltPrimary": "Y",
          "productBrand": "Nestle",
          "splitFlag": "N",
          "vendorPackSize": "12/12 OZ",
          "vendorProductName": "My Milk",
          "vendorProductNumber": "p-0222",
          "substitute": "Y",
          "substituteNotApproved": "N",
          "substituteRestricted": "Y",
          "taxCode": "T08"
        }
      ],
      "splitFlag": "N",
      "vendor": "My Vendor Company",
      "vendorCode": "000222",
      "vendorPackSize": "12/12 OZ",
      "vendorProductNumber": "p-0222",
      "contractLastChangeDate": "11/10/2020 09:23:35",
      "taxCode": "T08",
      "contractInfo": {
        "referenceNumber": "AB123321",
        "lineNumber": "12",
        "expirationDate": "11/10/2020"
      }
    }
  ]
}