Anchor to sellingPlanGroupselling
sellingPlanGroup
query
Returns a Selling Plan Group resource by ID.
Anchor to Possible returnsPossible returns
- Anchor to SellingPlanGroupSelling•
Plan Group Represents a selling method (for example, "Subscribe and save" or "Pre-paid"). Selling plan groups and associated records (selling plans and policies) are deleted 48 hours after a merchant uninstalls their subscriptions app. We recommend backing up these records if you need to restore them later.
Was this section helpful?
Retrieve information about a selling plan group
const { admin } = await authenticate.admin(request);
const response = await admin.graphql(
`#graphql
query sellingPlanGroups {
sellingPlanGroup(id: "gid://shopify/SellingPlanGroup/1") {
id,
name,
merchantCode,
appId,
description,
options,
position,
createdAt,
sellingPlans(first: 1) {
edges {
node {
id
}
}
}
productVariants(first: 1) {
edges {
node {
id
}
}
}
productVariantCount,
summary,
products(first: 1) {
query sellingPlanGroups {
sellingPlanGroup(id: "gid://shopify/SellingPlanGroup/1") {
id,
name,
merchantCode,
appId,
description,
options,
position,
createdAt,
sellingPlans(first: 1) {
edges {
node {
id
}
}
}
productVariants(first: 1) {
edges {
node {
id
}
}
}
productVariantCount,
summary,
products(first: 1) {
edges {
node {
id
}
}
}
productCount,
appliesToProduct(productId: "gid://shopify/Product/1"),
appliesToProductVariant(productVariantId: "gid://shopify/ProductVariant/1")
app {
id
}
}
}
curl -X POST \
https://your-development-store.myshopify.com/admin/api/2025-01/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "query sellingPlanGroups { sellingPlanGroup(id: \"gid://shopify/SellingPlanGroup/1\") { id, name, merchantCode, appId, description, options, position, createdAt, sellingPlans(first: 1) { edges { node { id } } } productVariants(first: 1) { edges { node { id } } } productVariantCount, summary, products(first: 1) { edges { node { id } } } productCount, appliesToProduct(productId: \"gid://shopify/Product/1\"), appliesToProductVariant(productVariantId: \"gid://shopify/ProductVariant/1\") app { id } } }"
}'
const { admin } = await authenticate.admin(request);
const response = await admin.graphql(
`#graphql
query sellingPlanGroups {
sellingPlanGroup(id: "gid://shopify/SellingPlanGroup/1") {
id,
name,
merchantCode,
appId,
description,
options,
position,
createdAt,
sellingPlans(first: 1) {
edges {
node {
id
}
}
}
productVariants(first: 1) {
edges {
node {
id
}
}
}
productVariantCount,
summary,
products(first: 1) {
edges {
node {
id
}
}
}
productCount,
appliesToProduct(productId: "gid://shopify/Product/1"),
appliesToProductVariant(productVariantId: "gid://shopify/ProductVariant/1")
app {
id
}
}
}`,
);
const data = await response.json();
const client = new shopify.clients.Graphql({session});
const data = await client.query({
data: `query sellingPlanGroups {
sellingPlanGroup(id: "gid://shopify/SellingPlanGroup/1") {
id,
name,
merchantCode,
appId,
description,
options,
position,
createdAt,
sellingPlans(first: 1) {
edges {
node {
id
}
}
}
productVariants(first: 1) {
edges {
node {
id
}
}
}
productVariantCount,
summary,
products(first: 1) {
edges {
node {
id
}
}
}
productCount,
appliesToProduct(productId: "gid://shopify/Product/1"),
appliesToProductVariant(productVariantId: "gid://shopify/ProductVariant/1")
app {
id
}
}
}`,
});
session = ShopifyAPI::Auth::Session.new(
shop: "your-development-store.myshopify.com",
access_token: access_token
)
client = ShopifyAPI::Clients::Graphql::Admin.new(
session: session
)
query = <<~QUERY
query sellingPlanGroups {
sellingPlanGroup(id: "gid://shopify/SellingPlanGroup/1") {
id,
name,
merchantCode,
appId,
description,
options,
position,
createdAt,
sellingPlans(first: 1) {
edges {
node {
id
}
}
}
productVariants(first: 1) {
edges {
node {
id
}
}
}
productVariantCount,
summary,
products(first: 1) {
edges {
node {
id
}
}
}
productCount,
appliesToProduct(productId: "gid://shopify/Product/1"),
appliesToProductVariant(productVariantId: "gid://shopify/ProductVariant/1")
app {
id
}
}
}
QUERY
response = client.query(query: query)
Response
JSON{
"sellingPlanGroup": {
"id": "gid://shopify/SellingPlanGroup/1",
"name": "Subscribe & Save",
"merchantCode": "sub-n-save",
"appId": "gid://shopify/App/1",
"description": null,
"options": [
"Delivery every"
],
"position": null,
"createdAt": "2023-07-16T19:21:25Z",
"sellingPlans": {
"edges": [
{
"node": {
"id": "gid://shopify/SellingPlan/1"
}
}
]
},
"productVariants": {
"edges": [
{
"node": {
"id": "gid://shopify/ProductVariant/1"
}
}
]
},