priceProducts

Example Query

query ExampleQuery($storeHash: String, $channelId: Int, $currencyCode: String!, $customerGroupId: Int, $items: [PricingProductItemInputType]!) {
  priceProducts(storeHash: $storeHash, channelId: $channelId, currencyCode: $currencyCode, customerGroupId: $customerGroupId, items: $items) {
    productId
    variantId
    options {
      optionId
      valueId
    }
    referenceRequest {
      productId
      variantId
      options
    }
    retailPrice {
      asEntered
      enteredInclusive
      taxExclusive
      taxInclusive
    }
    salePrice {
      asEntered
      enteredInclusive
      taxExclusive
      taxInclusive
    }
    minimumAdvertisedPrice {
      asEntered
      enteredInclusive
      taxExclusive
      taxInclusive
    }
    saved {
      asEntered
      enteredInclusive
      taxExclusive
      taxInclusive
    }
    price {
      asEntered
      enteredInclusive
      taxExclusive
      taxInclusive
    }
    calculatedPrice {
      asEntered
      enteredInclusive
      taxExclusive
      taxInclusive
    }
  }
}

Variables

{
  "storeHash": "example",
  "channelId": 0,
  "currencyCode": "example",
  "customerGroupId": 0,
  "items": [
    {
      "productId": 0,
      "variantId": 0,
      "options": [
        {
          "optionId": 0,
          "valueId": 0
        }
      ]
    }
  ]
}

Example response

{
  "data": {
    "priceProducts": [
      {
        "productId": 0,
        "variantId": 0,
        "options": [
          {
            "optionId": 0,
            "valueId": 0
          }
        ],
        "referenceRequest": {
          "productId": 0,
          "variantId": 0,
          "options": [
            {
              "optionId": null,
              "valueId": null
            }
          ]
        },
        "retailPrice": {
          "asEntered": 0,
          "enteredInclusive": true,
          "taxExclusive": 0,
          "taxInclusive": 0
        },
        "salePrice": {
          "asEntered": 0,
          "enteredInclusive": true,
          "taxExclusive": 0,
          "taxInclusive": 0
        },
        "minimumAdvertisedPrice": {
          "asEntered": 0,
          "enteredInclusive": true,
          "taxExclusive": 0,
          "taxInclusive": 0
        },
        "saved": {
          "asEntered": 0,
          "enteredInclusive": true,
          "taxExclusive": 0,
          "taxInclusive": 0
        },
        "price": {
          "asEntered": 0,
          "enteredInclusive": true,
          "taxExclusive": 0,
          "taxInclusive": 0
        },
        "calculatedPrice": {
          "asEntered": 0,
          "enteredInclusive": true,
          "taxExclusive": 0,
          "taxInclusive": 0
        }
      }
    ]
  }
}

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

productIdIntegerOptional

The product ID of the item.

variantIdIntegerOptional

The variant ID of the item.

optionslist of optional PricingProductItemOptionsTypeOptional

The optional product option configuration for this generated price.

referenceRequestReferenceRequestTypeOptional

You can use the original details of the request to identify the exact product variant and fetch prices.

retailPricePriceTypeOptional

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

salePricePriceTypeOptional

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

minimumAdvertisedPricePriceTypeOptional

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

savedPriceTypeOptional

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

pricePriceTypeOptional

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.

calculatedPricePriceTypeOptional

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

priceRangePriceRangeTypeOptional

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

retailPriceRangePriceRangeTypeOptional

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

bulkPricinglist of optional BulkPricingTypeOptional

The bulk pricing rules that apply to this product.