Skip to main content
Anchor to SellingPlanGroupConnection

SellingPlanGroupConnection

connection

An auto-generated type for paginating through multiple SellingPlanGroups.

Anchor to Fields with this connectionFields with this connection

Anchor to DeliveryProfile.sellingPlanGroupsDeliveryProfile.sellingPlanGroups
•OBJECT

A shipping profile that defines shipping rates for specific Product objects and ProductVariant objects. Delivery profiles determine which products can ship from which Location objects to which zones, and at what rates.

Profiles can associate with SellingPlanGroup objects to provide custom shipping rules for subscriptions, such as free shipping or restricted delivery zones. The default profile applies to all products that aren't assigned to other profiles.

Learn more about building delivery profiles.

Anchor to Product.sellingPlanGroupsProduct.sellingPlanGroups
•OBJECT

The Product object lets you manage products in a merchant’s store.

Products are the goods and services that merchants offer to customers. They can include various details such as title, description, price, images, and options such as size or color. You can use product variants to create or update different versions of the same product. You can also add or update product media. Products can be organized by grouping them into a collection.

Learn more about working with Shopify's product model, including limitations and considerations.

Anchor to ProductVariant.sellingPlanGroupsProductVariant.sellingPlanGroups
•OBJECT

The ProductVariant object represents a version of a product that comes in more than one option, such as size or color. For example, if a merchant sells t-shirts with options for size and color, then a small, blue t-shirt would be one product variant and a large, blue t-shirt would be another.

Use the ProductVariant object to manage the full lifecycle and configuration of a product's variants. Common use cases for using the ProductVariant object include:

  • Tracking inventory for each variant
  • Setting unique prices for each variant
  • Assigning barcodes and SKUs to connect variants to fulfillment services
  • Attaching variant-specific images and media
  • Setting delivery and tax requirements
  • Supporting product bundles, subscriptions, and selling plans

A ProductVariant is associated with a parent Product object. ProductVariant serves as the central link between a product's merchandising configuration, inventory, pricing, fulfillment, and sales channels within the GraphQL Admin API schema. Each variant can reference other GraphQL types such as:

Learn more about Shopify's product model.

Was this section helpful?

Anchor to Queries with this connectionQueries with this connection

Anchor to sellingPlanGroupssellingPlanGroups
•query

Retrieves a paginated list of SellingPlanGroup objects that belong to the app making the API call. Selling plan groups are selling methods like subscriptions, preorders, or other purchase options that merchants offer to customers.

Each group has one or more SellingPlan objects that define specific billing and delivery schedules, pricing adjustments, and policies. Use the query argument to search by name or filter results by other criteria.

Learn more about building selling plans.

Arguments

Anchor to firstfirst
•Int

The first n elements from the paginated list.

Anchor to afterafter
•String

The elements that come after the specified cursor.

Anchor to lastlast
•Int

The last n elements from the paginated list.

Anchor to beforebefore
•String

The elements that come before the specified cursor.

Anchor to reversereverse
•Boolean
Default:false

Reverse the order of the underlying list.

Anchor to sortKeysortKey
•SellingPlanGroupSortKeys
Default:ID

Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.

Anchor to queryquery
•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to default
•string

Filter by a case-insensitive search of multiple fields in a document.

Example:

  • query=Bob Norman
  • query=title:green hoodie
Anchor to app_id
•id

Valid values:

  • CURRENT Default
  • ALL
  • * (numeric app ID)
Anchor to category
•string

A comma-separated list of categories.

Valid values:

  • SUBSCRIPTION
  • PRE_ORDER
  • TRY_BEFORE_YOU_BUY
  • OTHER
Anchor to created_at
•time
Anchor to delivery_frequency
•string
Anchor to id
•id

Filter by id range.

Example:

  • id:1234
  • id:>=1234
  • id:<=1234
Anchor to name
•string
Anchor to percentage_off
•float
Was this section helpful?

Anchor to Possible returnsPossible returns

Anchor to edgesedges
•[SellingPlanGroupEdge!]!
non-null

The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node.

Anchor to nodesnodes
•[SellingPlanGroup!]!
non-null

A list of nodes that are contained in SellingPlanGroupEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve.

Anchor to pageInfopageInfo
•PageInfo!
non-null

An object that’s used to retrieve cursor information about the current page.

Was this section helpful?