SellingPlanGroup - admin-graphql - OBJECT

Version: 2024-10

Description:

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.

Access Scopes

`read_products` access scope.

Fields

• appId: String - The ID for app, exposed in Liquid and product JSON.
• appliesToProduct: Boolean! - Whether the given product is directly associated to the selling plan group.
• appliesToProductVariant: Boolean! - Whether the given product variant is directly associated to the selling plan group.
• appliesToProductVariants: Boolean! - Whether any of the product variants of the given product are associated to the selling plan group.
• createdAt: DateTime! - The date and time when the selling plan group was created.
• description: String - The merchant-facing description of the selling plan group.
• id: ID! - A globally-unique ID.
• merchantCode: String! - The merchant-facing label of the selling plan group.
• name: String! - The buyer-facing label of the selling plan group.
• options: String! - The values of all options available on the selling plan group. Selling plans are grouped together in Liquid when they're created by the same app, and have the same `selling_plan_group.name` and `selling_plan_group.options` values.
• position: Int - The relative position of the selling plan group for display.
• productVariantsCount: Count - A count of product variants associated to the selling plan group.
• productsCount: Count - A count of products associated to the selling plan group.
• summary: String - A summary of the policies associated to the selling plan group.
• translations: Translation! - The published translations associated with the resource.

Connections

• productVariants: ProductVariantConnection!
• products: ProductConnection!
• sellingPlans: SellingPlanConnection!

Related queries

• sellingPlanGroup Returns a Selling Plan Group resource by ID.
• sellingPlanGroups List Selling Plan Groups.

Related mutations

• sellingPlanGroupAddProductVariants Adds multiple product variants to a selling plan group.
• sellingPlanGroupAddProducts Adds multiple products to a selling plan group.
• sellingPlanGroupCreate Creates a Selling Plan Group.
• sellingPlanGroupUpdate Update a Selling Plan Group.

Related Unions

Examples

• Retrieve information about a selling plan group

          Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-10/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"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 } } }\"\n}'\n"
          Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: `query sellingPlanGroups {\n    sellingPlanGroup(id: \"gid://shopify/SellingPlanGroup/1\") {\n      id,\n      name,\n      merchantCode,\n      appId,\n      description,\n      options,\n      position,\n      createdAt,\n      sellingPlans(first: 1) {\n        edges {\n          node {\n            id\n          }\n        }\n      }\n      productVariants(first: 1) {\n        edges {\n          node {\n            id\n          }\n        }\n      }\n      productVariantCount,\n      summary,\n      products(first: 1) {\n        edges {\n          node {\n            id\n          }\n        }\n      }\n      productCount,\n      appliesToProduct(productId: \"gid://shopify/Product/1\"),\n      appliesToProductVariant(productVariantId: \"gid://shopify/ProductVariant/1\")\n      app {\n        id\n      }\n    }\n  }`,\n});\n"
          Ruby example: "session = ShopifyAPI::Auth::Session.new(\n  shop: \"your-development-store.myshopify.com\",\n  access_token: access_token\n)\nclient = ShopifyAPI::Clients::Graphql::Admin.new(\n  session: session\n)\n\nquery = <<~QUERY\n  query sellingPlanGroups {\n    sellingPlanGroup(id: \"gid://shopify/SellingPlanGroup/1\") {\n      id,\n      name,\n      merchantCode,\n      appId,\n      description,\n      options,\n      position,\n      createdAt,\n      sellingPlans(first: 1) {\n        edges {\n          node {\n            id\n          }\n        }\n      }\n      productVariants(first: 1) {\n        edges {\n          node {\n            id\n          }\n        }\n      }\n      productVariantCount,\n      summary,\n      products(first: 1) {\n        edges {\n          node {\n            id\n          }\n        }\n      }\n      productCount,\n      appliesToProduct(productId: \"gid://shopify/Product/1\"),\n      appliesToProductVariant(productVariantId: \"gid://shopify/ProductVariant/1\")\n      app {\n        id\n      }\n    }\n  }\nQUERY\n\nresponse = client.query(query: query)\n"
          PHP example: "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = <<<QUERY\n  query sellingPlanGroups {\n    sellingPlanGroup(id: \"gid://shopify/SellingPlanGroup/1\") {\n      id,\n      name,\n      merchantCode,\n      appId,\n      description,\n      options,\n      position,\n      createdAt,\n      sellingPlans(first: 1) {\n        edges {\n          node {\n            id\n          }\n        }\n      }\n      productVariants(first: 1) {\n        edges {\n          node {\n            id\n          }\n        }\n      }\n      productVariantCount,\n      summary,\n      products(first: 1) {\n        edges {\n          node {\n            id\n          }\n        }\n      }\n      productCount,\n      appliesToProduct(productId: \"gid://shopify/Product/1\"),\n      appliesToProductVariant(productVariantId: \"gid://shopify/ProductVariant/1\")\n      app {\n        id\n      }\n    }\n  }\nQUERY;\n\n$response = $client->query([\"query\" => $query]);\n"
          Remix example: "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n  `#graphql\n  query sellingPlanGroups {\n    sellingPlanGroup(id: \"gid://shopify/SellingPlanGroup/1\") {\n      id,\n      name,\n      merchantCode,\n      appId,\n      description,\n      options,\n      position,\n      createdAt,\n      sellingPlans(first: 1) {\n        edges {\n          node {\n            id\n          }\n        }\n      }\n      productVariants(first: 1) {\n        edges {\n          node {\n            id\n          }\n        }\n      }\n      productVariantCount,\n      summary,\n      products(first: 1) {\n        edges {\n          node {\n            id\n          }\n        }\n      }\n      productCount,\n      appliesToProduct(productId: \"gid://shopify/Product/1\"),\n      appliesToProductVariant(productVariantId: \"gid://shopify/ProductVariant/1\")\n      app {\n        id\n      }\n    }\n  }`,\n);\n\nconst data = await response.json();\n"
          Graphql query: "query sellingPlanGroups {\n  sellingPlanGroup(id: \"gid://shopify/SellingPlanGroup/1\") {\n    id,\n    name,\n    merchantCode,\n    appId,\n    description,\n    options,\n    position,\n    createdAt,\n    sellingPlans(first: 1) {\n      edges {\n        node {\n          id\n        }\n      }\n    }\n    productVariants(first: 1) {\n      edges {\n        node {\n          id\n        }\n      }\n    }\n    productVariantCount,\n    summary,\n    products(first: 1) {\n      edges {\n        node {\n          id\n        }\n      }\n    }\n    productCount,\n    appliesToProduct(productId: \"gid://shopify/Product/1\"),\n    appliesToProductVariant(productVariantId: \"gid://shopify/ProductVariant/1\")\n    app {\n      id\n    }\n  }\n}\n"
        

  input: null

  response: {
    "data": {
      "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"
              }
            }
          ]
        },
        "productVariantCount": 1,
        "summary": "1 delivery frequency, 25-26% discount",
        "products": {
          "edges": [
            {
              "node": {
                "id": "gid://shopify/Product/1"
              }
            }
          ]
        },
        "productCount": 1,
        "appliesToProduct": true,
        "appliesToProductVariant": true,
        "app": {
          "id": "gid://shopify/App/1"
        }
      }
    }
  }