priceProducts

Calculate batch pricing for products for a specific channel, currency, and customer group.

Arguments

storeHashStringOptional
Store hash.
channelIdIntegerOptional
The channel ID that pricing evaluates within.
currencyCodeStringRequired
The currency code of prices this request returns. This field is required.
customerGroupIdIntegerOptional
The customer group ID that's relevant for any customer group pricing, tax values, etc.
itemslist of optional PricingProductItemInputTypeRequired
The items for which to fetch prices. This field is required.

Returns

an optional list of optional PricingProductType
productIdInteger
The product ID of the item.
variantIdInteger
The variant ID of the item.
optionslist of optional PricingProductItemOptionsType
The optional product option configuration for this generated price.
referenceRequestReferenceRequestType
You can use the original details of the request to identify the exact product variant and fetch prices.
retailPricePriceType

The (optional) RRP/retail price configured for this product and used for price comparison and storefront display purposes.

salePricePriceType

The merchant-entered sale price for a product overwrites the default price. The sale_price is optional.

minimumAdvertisedPricePriceType

The minimum advertised price (MAP) you can display on a storefront. A value supplied by the merchant and used for display purposes.

savedPriceType

The amount that merchants save, determined by the difference between retail_price and calculated_price

pricePriceType

The merchant-entered price for a product, which could include or exclude tax. When creating a product, you must define the price, which serves as the default price.

calculatedPricePriceType

The shopper price for a product, which includes modifier, option, and option set rules. The calculated_price may include or exclude estimates for tax.

priceRangePriceRangeType

The minimum and maximum price that will typically apply to this product. Only used for complex products (products with variants).

retailPriceRangePriceRangeType

The productʼs variants that will typically apply to this product.

bulkPricinglist of optional BulkPricingType
The bulk pricing rules that apply to this product.