Search

getProductsInPriceList

Returns products that are on the price list.

API user must have the view rights for all price lists.

To add a new price list, use the savePriceList API call.
If you need to add products to a price list, use the addProductToPriceList API call.
To edit products on the price list, use the editProductInPriceList API call.
To delete products from the price list, use the deleteProductInPriceList API call.

Input parameters

Parameter nameDescriptionPossible valueRequired
priceListIDInteger
pageNoAPI returns at most recordsOnPage items at a time. To retrive the next recordsOnPage items, send a new request with pageNo incremented by one. By default, API returns "page 1".Integer
recordsOnPageNumber of records API should return. By default 20, at most 1000.Integer

Response

Field nameTypeDescription
priceListProductIDIntegerID of a price list row.
productIDInteger
priceDecimalDiscounted net sales price for a product.
amountIntegerAvailable only if Quantity discounts module is enabled on your account. The quantity threshold from which the specified price will apply.
subsidyDecimalAvailable only if Price list row subsidy and other fields module is enabled on your account.
subsidyTypeIDIntegerAvailable only if Price list row subsidy and other fields module is enabled on your account.
pageIntegerAvailable only if Price list row subsidy and other fields module is enabled on your account.
positionOnPageIntegerAvailable only if Price list row subsidy and other fields module is enabled on your account.
forecastUnitsIntegerAvailable only if Price list row subsidy and other fields module is enabled on your account.