priceProducts | BigCommerce Developer Center

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
    }
  }
}

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

{
  "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 ObjectsRequired

The items for which to fetch prices. This field is required.

Returns

an optional list of optional Objects

productIdInteger

The product ID of the item.

variantIdInteger

The variant ID of the item.

optionslist of optional Objects

The optional product option configuration for this generated price.

referenceRequestObject

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

retailPriceObject

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

salePriceObject

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

minimumAdvertisedPriceObject

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

savedObject

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

priceObject

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.

calculatedPriceObject

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

priceRangeObject

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

retailPriceRangeObject

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

bulkPricinglist of optional Objects

The bulk pricing rules that apply to this product.

1	query ExampleQuery($storeHash: String, $channelId: Int, $currencyCode: String, $customerGroupId: Int, $items: [PricingProductItemInputType]) {
2	priceProducts(storeHash: $storeHash, channelId: $channelId, currencyCode: $currencyCode, customerGroupId: $customerGroupId, items: $items) {
3	productId
4	variantId
5	options {
6	optionId
7	valueId
8	}
9	referenceRequest {
10	productId
11	variantId
12	options
13	}
14	retailPrice {
15	asEntered
16	enteredInclusive
17	taxExclusive
18	taxInclusive
19	}
20	salePrice {
21	asEntered
22	enteredInclusive
23	taxExclusive
24	taxInclusive
25	}
26	minimumAdvertisedPrice {
27	asEntered
28	enteredInclusive
29	taxExclusive
30	taxInclusive
31	}
32	saved {
33	asEntered
34	enteredInclusive
35	taxExclusive
36	taxInclusive
37	}
38	price {
39	asEntered
40	enteredInclusive
41	taxExclusive
42	taxInclusive
43	}
44	calculatedPrice {
45	asEntered
46	enteredInclusive
47	taxExclusive
48	taxInclusive
49	}
50	}
51	}

1	{
2	"data": {
3	"priceProducts": [
4	{
5	"productId": 0,
6	"variantId": 0,
7	"options": [
8	{
9	"optionId": 0,
10	"valueId": 0
11	}
12	],
13	"referenceRequest": {
14	"productId": 0,
15	"variantId": 0,
16	"options": [
17	{
18	"optionId": null,
19	"valueId": null
20	}
21	]
22	},
23	"retailPrice": {
24	"asEntered": 0,
25	"enteredInclusive": true,
26	"taxExclusive": 0,
27	"taxInclusive": 0
28	},
29	"salePrice": {
30	"asEntered": 0,
31	"enteredInclusive": true,
32	"taxExclusive": 0,
33	"taxInclusive": 0
34	},
35	"minimumAdvertisedPrice": {
36	"asEntered": 0,
37	"enteredInclusive": true,
38	"taxExclusive": 0,
39	"taxInclusive": 0
40	},
41	"saved": {
42	"asEntered": 0,
43	"enteredInclusive": true,
44	"taxExclusive": 0,
45	"taxInclusive": 0
46	},
47	"price": {
48	"asEntered": 0,
49	"enteredInclusive": true,
50	"taxExclusive": 0,
51	"taxInclusive": 0
52	},
53	"calculatedPrice": {
54	"asEntered": 0,
55	"enteredInclusive": true,
56	"taxExclusive": 0,
57	"taxInclusive": 0
58	}
59	}
60	]
61	}
62	}