Anchor to section titled 'undefined'selling
selling
query
Unstable
Returns a Selling Plan Group resource by ID.
Anchor to section titled 'Arguments'
Arguments
The ID of the SellingPlanGroup to return.
Was this section helpful?
Anchor to section titled 'SellingPlanGroup possible returns'
SellingPlanGroup possible returns
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?
Code examples for QUERY: sellingPlanGroup
Query Reference for QUERY: sellingPlanGroup
"{\n sellingPlanGroup(id) {\n # SellingPlanGroup fields\n }\n}"Input Reference for QUERY: sellingPlanGroup
Schema Reference for QUERY: sellingPlanGroup
Display Examples for QUERY: sellingPlanGroup
[
{
"example": {
"type_name": "sellingplangroup",
"title": "Retrieve information about a selling plan group",
"query_string": "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",
"query_arguments": {
"id": "gid://shopify/sellingPlanGroup/1"
},
"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"
}
}
}
},
"api_name": "admin",
"location": "/components/merchandising/test/unit/graph_api/admin/selling_plan_group_test.rb",
"minimum_api_version": null,
"maximum_api_version": null,
"curl_example": "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/unstable/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",
"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",
"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",
"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",
"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"
},
"titleStringKey": "arguments",
"inputVariableEntries": [
{
"arg": {
"name": "id",
"description": "The ID of the SellingPlanGroup to return.",
"type": {
"kind": "SCALAR",
"name": "ID",
"list": false,
"non_null": true
},
"defaultValue": null,
"typeSignature": "ID!",
"isDeprecated": false,
"deprecationReason": null
},
"key": "id",
"argValue": " \"gid://shopify/sellingPlanGroup/1\"",
"typeKind": "QUERY"
}
]
}
]