getVendorProductPricingByPage

get

https://webservices-test.net-chef.com/vendorproductpricing/v1/getVendorProductPricingByPage

Retrieve a page of vendor product pricing.

Query Params

activeProductFlag

string

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

bidSheet

string

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

contractStatus

string

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

effectiveDate

string

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.

market

string

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

minutesSinceUpdate

int32

The number of minutes since a vendor product pricing or contract record was last updated. Use to set how far back to search.

pageNumber

int32

Defaults to 1

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

substitute

string

Fetch substitute products (optional).

productName

string

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

productNumber

string

Product number to retrieve. (case sensitive).

secondaryMarket

string

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.

vendor

string

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

pageSize

int32

Number of items to display per page.

includeNull

boolean

Specify 'true' to output null data elements.

Headers

authenticationtoken

string

required

Secure token for API authentication.

password

string

required

Password for the Crunchtime Application User.

sitename

string

required

Crunchtime site identifier. (test or production)

userid

string

required

User ID for the Crunchtime Application User.

X-B3-TraceId

string

Optional trace identifier for troubleshooting.

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

200Success

400Validation Error

401Authorization

404vendor product pricing not found

429Too Many Requests

500Unexpected Error

503System under maintenance

504Timeout