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 name Description Possible value Required
priceListID Integer yes
pageNo API 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
recordsOnPage Number of records API should return. By default 20, at most 1000. Integer

Response

Field name Type Description
priceListProductID Integer ID of a price list row.
productID Integer
price Decimal Discounted net sales price for a product.
amount Integer Available only if Quantity discounts module is enabled on your account. The quantity threshold from which the specified price will apply.
subsidy Decimal Available only if Price list row subsidy and other fields module is enabled on your account.
subsidyTypeID Integer Available only if Price list row subsidy and other fields module is enabled on your account.
page Integer Available only if Price list row subsidy and other fields module is enabled on your account.
positionOnPage Integer Available only if Price list row subsidy and other fields module is enabled on your account.
forecastUnits Integer Available only if Price list row subsidy and other fields module is enabled on your account.