sellingPlanGroup

query

Returns a Selling Plan Group resource by ID.

Arguments

Anchor to idid • ID!required: The ID of the SellingPlanGroup to return.

Was this section helpful?

Anchor to Possible returnsPossible returns

Anchor to SellingPlanGroupSellingPlanGroup • SellingPlanGroup: 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

1const { admin } = await authenticate.admin(request);
2
3const response = await admin.graphql(
4  `#graphql
5  query sellingPlanGroups {
6    sellingPlanGroup(id: "gid://shopify/SellingPlanGroup/1") {
7      id,
8      name,
9      merchantCode,
10      appId,
11      description,
12      options,
13      position,
14      createdAt,
15      sellingPlans(first: 1) {
16        edges {
17          node {
18            id
19          }
20        }
21      }
22      productVariants(first: 1) {
23        edges {
24          node {
25            id
26          }
27        }
28      }
29      productVariantCount,
30      summary,
31      products(first: 1) {
32        edges {
33          node {
34            id
35          }
36        }
37      }
38      productCount,
39      appliesToProduct(productId: "gid://shopify/Product/1"),
40      appliesToProductVariant(productVariantId: "gid://shopify/ProductVariant/1")
41      app {
42        id
43      }
44    }
45  }`,
46);
47
48const data = await response.json();
49

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/unstable/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

1{
2  "sellingPlanGroup": {
3    "id": "gid://shopify/SellingPlanGroup/1",
4    "name": "Subscribe & Save",
5    "merchantCode": "sub-n-save",
6    "appId": "gid://shopify/App/1",
7    "description": null,
8    "options": [
9      "Delivery every"
10    ],
11    "position": null,
12    "createdAt": "2023-07-16T19:21:25Z",
13    "sellingPlans": {
14      "edges": [
15        {
16          "node": {
17            "id": "gid://shopify/SellingPlan/1"
18          }
19        }
20      ]
21    },
22    "productVariants": {
23      "edges": [
24        {
25          "node": {
26            "id": "gid://shopify/ProductVariant/1"
27          }
28        }
29      ]
30    },
31    "productVariantCount": 1,
32    "summary": "1 delivery frequency, 25-26% discount",
33    "products": {
34      "edges": [
35        {
36          "node": {
37            "id": "gid://shopify/Product/1"
38          }
39        }
40      ]
41    },
42    "productCount": 1,
43    "appliesToProduct": true,
44    "appliesToProductVariant": true,
45    "app": {
46      "id": "gid://shopify/App/1"
47    }
48  }
49}