com.shopify.buy3

Class Storefront.SellingPlanAllocationQuery

java.lang.Object

com.shopify.graphql.support.Query<Storefront.SellingPlanAllocationQuery>

com.shopify.buy3.Storefront.SellingPlanAllocationQuery

Enclosing class:

Storefront

public static class Storefront.SellingPlanAllocationQuery
extends Query<Storefront.SellingPlanAllocationQuery>

Represents an association between a variant and a selling plan. Selling plan allocations describe the options offered for each variant, and the price of the variant when purchased with a selling plan.

Field Summary

Fields inherited from class com.shopify.graphql.support.Query

_queryBuilder, ALIAS_SUFFIX_SEPARATOR

Method Summary

Modifier and Type	Method and Description
Storefront.SellingPlanAllocationQuery	checkoutChargeAmount(Storefront.MoneyV2QueryDefinition queryDef) The checkout charge amount due for the purchase.
Storefront.SellingPlanAllocationQuery	priceAdjustments(Storefront.SellingPlanAllocationPriceAdjustmentQueryDefinition queryDef) A list of price adjustments, with a maximum of two.
Storefront.SellingPlanAllocationQuery	remainingBalanceChargeAmount(Storefront.MoneyV2QueryDefinition queryDef) The remaining balance charge amount due for the purchase.
Storefront.SellingPlanAllocationQuery	sellingPlan(Storefront.SellingPlanQueryDefinition queryDef) A representation of how products and variants can be sold and purchased.

Methods inherited from class com.shopify.graphql.support.Query

appendQuotedString, startField, startInlineFragment, withAlias

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

checkoutChargeAmount

public Storefront.SellingPlanAllocationQuery checkoutChargeAmount(Storefront.MoneyV2QueryDefinition queryDef)

The checkout charge amount due for the purchase.

priceAdjustments

public Storefront.SellingPlanAllocationQuery priceAdjustments(Storefront.SellingPlanAllocationPriceAdjustmentQueryDefinition queryDef)

A list of price adjustments, with a maximum of two. When there are two, the first price adjustment goes into effect at the time of purchase, while the second one starts after a certain number of orders. A price adjustment represents how a selling plan affects pricing when a variant is purchased with a selling plan. Prices display in the customer's currency if the shop is configured for it.

remainingBalanceChargeAmount

public Storefront.SellingPlanAllocationQuery remainingBalanceChargeAmount(Storefront.MoneyV2QueryDefinition queryDef)

The remaining balance charge amount due for the purchase.

sellingPlan

public Storefront.SellingPlanAllocationQuery sellingPlan(Storefront.SellingPlanQueryDefinition queryDef)

A representation of how products and variants can be sold and purchased. For example, an individual selling plan could be '6 weeks of prepaid granola, delivered weekly'.