MCP Server for Shopify

Build 25.0.9440

SellingPlanGroupSellingPlans

Lists selling plans associated with a selling plan group.

View-Specific Information

Select

The server uses the Shopify API to process WHERE clause conditions built with the following column and operators. The server processes other filters client-side within the server.

  • SellingPlanGroupId supports the '=, IN' comparison operators.

For example, the following query is processed server-side:

  SELECT * FROM SellingPlanGroupSellingPlans WHERE SellingPlanGroupId = 'Val1'

Columns

Name Type References Description
Id [KEY] String A globally unique Id for the selling plan.
SellingPlanGroupId String

SellingPlanGroups.Id

A globally unique Id for the associated selling plan group.
Name String A customer-facing description of the selling plan. If the store supports multiple currencies, avoid including country-specific pricing (for example, 'Buy monthly, get 10$ CAD off') since this text is not converted for other currencies.
Category String The category used to classify the selling plan for reporting purposes.

The allowed values are OTHER, PRE_ORDER, SUBSCRIPTION, TRY_BEFORE_YOU_BUY.

Description String The buyer-facing description of the selling plan commitment.
Options String The option values available in the selling plan. Selling plans are grouped together in Liquid when created by the same app and share the same 'selling_plan_group.name' and 'selling_plan_group.options' values.
Position Int The relative display order of the selling plan. Lower values are shown before higher values.
CreatedAt Datetime The date and time when the selling plan was created.
InventoryPolicyReserve String Specifies when to reserve inventory for the order.

The allowed values are ON_FULFILLMENT, ON_SALE.

FixedBillingPolicyCheckoutChargeType String The type of checkout charge applied by the fixed billing policy.

The allowed values are PERCENTAGE, PRICE.

FixedBillingPolicyCheckoutChargeValueAmount Decimal The fixed checkout charge amount, expressed as a decimal value.
FixedBillingPolicyCheckoutChargeValueCurrencyCode String The currency code for the fixed checkout charge amount.
FixedBillingPolicyCheckoutChargeValuePercentage Double The checkout charge as a percentage of the product price.
FixedBillingPolicyRemainingBalanceChargeExactTime Datetime The exact date and time when to capture the remaining balance.
FixedBillingPolicyRemainingBalanceChargeTimeAfterCheckout String The duration between the checkout event and capturing the remaining balance. Expressed as an ISO8601 duration.
FixedBillingPolicyRemainingBalanceChargeTrigger String Specifies when to capture payment for the remaining balance.

The allowed values are EXACT_TIME, NO_REMAINING_BALANCE, TIME_AFTER_CHECKOUT.

RecurringBillingPolicyAnchors String The anchor dates used for calculating billing intervals.
RecurringBillingPolicyCreatedAt Datetime The date and time when the recurring billing policy was created.
RecurringBillingPolicyInterval String The billing interval unit.

The allowed values are DAY, MONTH, WEEK, YEAR.

RecurringBillingPolicyIntervalCount Int The number of interval units between billings.
RecurringBillingPolicyMaxCycles Int The maximum number of billing cycles allowed.
RecurringBillingPolicyMinCycles Int The minimum number of billing cycles required.
FixedDeliveryPolicyAnchors String The anchor dates used for calculating delivery intervals.
FixedDeliveryPolicyCutoff Int The cutoff period (in days) for including orders in the next fulfillment cycle.
FixedDeliveryPolicyFulfillmentExactTime Datetime The exact date and time when fulfillment should occur.
FixedDeliveryPolicyFulfillmentTrigger String Specifies what triggers fulfillment.

The allowed values are ANCHOR, ASAP, EXACT_TIME, UNKNOWN.

FixedDeliveryPolicyIntent String Indicates whether the delivery policy is merchant-centric or buyer-centric. Currently, only merchant-centric delivery policies are supported.
FixedDeliveryPolicyPreAnchorBehavior String Specifies fulfillment behavior if an order is placed before the anchor date.

The allowed values are ASAP, NEXT.

RecurringDeliveryPolicyAnchors String The anchor dates used for calculating recurring delivery intervals.
RecurringDeliveryPolicyCreatedAt Datetime The date and time when the recurring delivery policy was created.
RecurringDeliveryPolicyCutoff Int The cutoff period (in days) for including orders in the current delivery cycle.
RecurringDeliveryPolicyIntent String Indicates whether the delivery policy is merchant-centric or buyer-centric. Currently, only merchant-centric delivery policies are supported.

The allowed values are FULFILLMENT_BEGIN.

RecurringDeliveryPolicyInterval String The delivery interval unit. The unit for the delivery interval (day, week, month, or year).
RecurringDeliveryPolicyIntervalCount Int The number of interval units between deliveries.
RecurringDeliveryPolicyPreAnchorBehavior String Specifies fulfillment behavior if an order is placed before the anchor date.

The allowed values are ASAP, NEXT.

FixedPricingPolicies String Represents fixed pricing policies associated with the selling plan.
RecurringPricingPolicies String Represents recurring pricing policies associated with the selling plan.

Pseudo-Columns

Pseudo-columns are fields that can only be used in the types of statements under which they are explicitly listed. They are not standard columns but instead provide additional functionality for specific operations.

Name Type Description
Metafields String Additional metadata attached to the selling plan resource.

Copyright (c) 2025 CData Software, Inc. - All rights reserved.
Build 25.0.9440