com.shopify.buy3

Class Storefront.SellingPlanQuery

java.lang.Object

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

com.shopify.buy3.Storefront.SellingPlanQuery

Enclosing class:

Storefront

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

Represents how products and variants can be sold and purchased.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	Storefront.SellingPlanQuery.MetafieldArguments
static interface	Storefront.SellingPlanQuery.MetafieldArgumentsDefinition

Field Summary

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

_queryBuilder, ALIAS_SUFFIX_SEPARATOR

Method Summary

Modifier and Type	Method and Description
Storefront.SellingPlanQuery	billingPolicy(Storefront.SellingPlanBillingPolicyQueryDefinition queryDef) The billing policy for the selling plan.
Storefront.SellingPlanQuery	checkoutCharge(Storefront.SellingPlanCheckoutChargeQueryDefinition queryDef) The initial payment due for the purchase.
Storefront.SellingPlanQuery	deliveryPolicy(Storefront.SellingPlanDeliveryPolicyQueryDefinition queryDef) The delivery policy for the selling plan.
Storefront.SellingPlanQuery	description() The description of the selling plan.
Storefront.SellingPlanQuery	id() A globally-unique ID.
Storefront.SellingPlanQuery	metafield(java.lang.String key, Storefront.MetafieldQueryDefinition queryDef) Returns a metafield found by namespace and key.
Storefront.SellingPlanQuery	metafield(java.lang.String key, Storefront.SellingPlanQuery.MetafieldArgumentsDefinition argsDef, Storefront.MetafieldQueryDefinition queryDef) Returns a metafield found by namespace and key.
Storefront.SellingPlanQuery	metafields(java.util.List<Storefront.HasMetafieldsIdentifier> identifiers, Storefront.MetafieldQueryDefinition queryDef) The metafields associated with the resource matching the supplied list of namespaces and keys.
Storefront.SellingPlanQuery	name() The name of the selling plan.
Storefront.SellingPlanQuery	options(Storefront.SellingPlanOptionQueryDefinition queryDef) The selling plan options available in the drop-down list in the storefront.
Storefront.SellingPlanQuery	priceAdjustments(Storefront.SellingPlanPriceAdjustmentQueryDefinition queryDef) The price adjustments that a selling plan makes when a variant is purchased with a selling plan.
Storefront.SellingPlanQuery	recurringDeliveries() Whether purchasing the selling plan will result in multiple deliveries.

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

billingPolicy

public Storefront.SellingPlanQuery billingPolicy(Storefront.SellingPlanBillingPolicyQueryDefinition queryDef)

The billing policy for the selling plan.

checkoutCharge

public Storefront.SellingPlanQuery checkoutCharge(Storefront.SellingPlanCheckoutChargeQueryDefinition queryDef)

The initial payment due for the purchase.

deliveryPolicy

public Storefront.SellingPlanQuery deliveryPolicy(Storefront.SellingPlanDeliveryPolicyQueryDefinition queryDef)

The delivery policy for the selling plan.

description

public Storefront.SellingPlanQuery description()

The description of the selling plan.

id

public Storefront.SellingPlanQuery id()

A globally-unique ID.

metafield

public Storefront.SellingPlanQuery metafield(java.lang.String key,
                                             Storefront.MetafieldQueryDefinition queryDef)

Returns a metafield found by namespace and key.

metafield

public Storefront.SellingPlanQuery metafield(java.lang.String key,
                                             Storefront.SellingPlanQuery.MetafieldArgumentsDefinition argsDef,
                                             Storefront.MetafieldQueryDefinition queryDef)

Returns a metafield found by namespace and key.

metafields

public Storefront.SellingPlanQuery metafields(java.util.List<Storefront.HasMetafieldsIdentifier> identifiers,
                                              Storefront.MetafieldQueryDefinition queryDef)

The metafields associated with the resource matching the supplied list of namespaces and keys.

name

public Storefront.SellingPlanQuery name()

The name of the selling plan. For example, '6 weeks of prepaid granola, delivered weekly'.

options

public Storefront.SellingPlanQuery options(Storefront.SellingPlanOptionQueryDefinition queryDef)

The selling plan options available in the drop-down list in the storefront. For example, 'Delivery every week' or 'Delivery every 2 weeks' specifies the delivery frequency options for the product. Individual selling plans contribute their options to the associated selling plan group. For example, a selling plan group might have an option called `option1: Delivery every`. One selling plan in that group could contribute `option1: 2 weeks` with the pricing for that option, and another selling plan could contribute `option1: 4 weeks`, with different pricing.

priceAdjustments

public Storefront.SellingPlanQuery priceAdjustments(Storefront.SellingPlanPriceAdjustmentQueryDefinition queryDef)

The price adjustments that a selling plan makes when a variant is purchased with a selling plan.

recurringDeliveries

public Storefront.SellingPlanQuery recurringDeliveries()

Whether purchasing the selling plan will result in multiple deliveries.