Anchor to section titled 'undefined'selling
selling
mutation
Unstable
Requires write access scope as well as any of write, write access scopes. Also: The user must have manage permissions.
Creates a Selling Plan Group.
Anchor to section titled 'Arguments'
Arguments
The properties of the new Selling Plan Group.
The resources this Selling Plan Group should be applied to.
Was this section helpful?
Anchor to section titled 'SellingPlanGroupCreatePayload returns'
SellingPlanGroupCreatePayload returns
The created selling plan group object.
The list of errors that occurred from executing the mutation.
Was this section helpful?
Code examples for MUTATION: sellingPlanGroupCreate
Query Reference for MUTATION: sellingPlanGroupCreate
"mutation sellingPlanGroupCreate($input: SellingPlanGroupInput!) {\n sellingPlanGroupCreate(input: $input) {\n sellingPlanGroup {\n # SellingPlanGroup fields\n }\n userErrors {\n field\n message\n }\n }\n}"Input Reference for MUTATION: sellingPlanGroupCreate
"{\n \"input\": {\n \"appId\": \"<your-appId>\",\n \"description\": \"<your-description>\",\n \"merchantCode\": \"<your-merchantCode>\",\n \"name\": \"<your-name>\",\n \"options\": [\n \"<your-options>\"\n ],\n \"position\": 1,\n \"sellingPlansToCreate\": [\n {\n \"billingPolicy\": {\n \"fixed\": {\n \"checkoutCharge\": {\n \"type\": \"PERCENTAGE\",\n \"value\": {\n \"fixedValue\": \"29.99\",\n \"percentage\": 1.1\n }\n },\n \"remainingBalanceChargeExactTime\": \"2019-09-07T15:50:00Z\",\n \"remainingBalanceChargeTimeAfterCheckout\": \"<your-remainingBalanceChargeTimeAfterCheckout>\",\n \"remainingBalanceChargeTrigger\": \"EXACT_TIME\"\n },\n \"recurring\": {\n \"anchors\": [\n {\n \"cutoffDay\": 1,\n \"day\": 1,\n \"month\": 1,\n \"type\": \"MONTHDAY\"\n }\n ],\n \"interval\": \"DAY\",\n \"intervalCount\": 1,\n \"maxCycles\": 1,\n \"minCycles\": 1\n }\n },\n \"category\": \"OTHER\",\n \"deliveryPolicy\": {\n \"fixed\": {\n \"anchors\": [\n {\n \"cutoffDay\": 1,\n \"day\": 1,\n \"month\": 1,\n \"type\": \"MONTHDAY\"\n }\n ],\n \"cutoff\": 1,\n \"fulfillmentExactTime\": \"2019-09-07T15:50:00Z\",\n \"fulfillmentTrigger\": \"ANCHOR\",\n \"intent\": \"FULFILLMENT_BEGIN\",\n \"preAnchorBehavior\": \"ASAP\"\n },\n \"recurring\": {\n \"anchors\": [\n {\n \"cutoffDay\": 1,\n \"day\": 1,\n \"month\": 1,\n \"type\": \"MONTHDAY\"\n }\n ],\n \"cutoff\": 1,\n \"intent\": \"FULFILLMENT_BEGIN\",\n \"interval\": \"DAY\",\n \"intervalCount\": 1,\n \"preAnchorBehavior\": \"ASAP\"\n }\n },\n \"description\": \"<your-description>\",\n \"id\": \"gid://shopify/<objectName>/10079785100\",\n \"inventoryPolicy\": {\n \"reserve\": \"ON_FULFILLMENT\"\n },\n \"metafields\": [\n {\n \"id\": \"gid://shopify/<objectName>/10079785100\",\n \"key\": \"<your-key>\",\n \"namespace\": \"<your-namespace>\",\n \"type\": \"<your-type>\",\n \"value\": \"<your-value>\"\n }\n ],\n \"name\": \"<your-name>\",\n \"options\": [\n \"<your-options>\"\n ],\n \"position\": 1,\n \"pricingPolicies\": [\n {\n \"fixed\": {\n \"adjustmentType\": \"FIXED_AMOUNT\",\n \"adjustmentValue\": {\n \"fixedValue\": \"29.99\",\n \"percentage\": 1.1\n },\n \"id\": \"gid://shopify/<objectName>/10079785100\"\n },\n \"recurring\": {\n \"adjustmentType\": \"FIXED_AMOUNT\",\n \"adjustmentValue\": {\n \"fixedValue\": \"29.99\",\n \"percentage\": 1.1\n },\n \"afterCycle\": 1,\n \"id\": \"gid://shopify/<objectName>/10079785100\"\n }\n }\n ]\n }\n ],\n \"sellingPlansToDelete\": [\n \"gid://shopify/<objectName>/10079785100\"\n ],\n \"sellingPlansToUpdate\": [\n {\n \"billingPolicy\": {\n \"fixed\": {\n \"checkoutCharge\": {\n \"type\": \"PERCENTAGE\",\n \"value\": {\n \"fixedValue\": \"29.99\",\n \"percentage\": 1.1\n }\n },\n \"remainingBalanceChargeExactTime\": \"2019-09-07T15:50:00Z\",\n \"remainingBalanceChargeTimeAfterCheckout\": \"<your-remainingBalanceChargeTimeAfterCheckout>\",\n \"remainingBalanceChargeTrigger\": \"EXACT_TIME\"\n },\n \"recurring\": {\n \"anchors\": [\n {\n \"cutoffDay\": 1,\n \"day\": 1,\n \"month\": 1,\n \"type\": \"MONTHDAY\"\n }\n ],\n \"interval\": \"DAY\",\n \"intervalCount\": 1,\n \"maxCycles\": 1,\n \"minCycles\": 1\n }\n },\n \"category\": \"OTHER\",\n \"deliveryPolicy\": {\n \"fixed\": {\n \"anchors\": [\n {\n \"cutoffDay\": 1,\n \"day\": 1,\n \"month\": 1,\n \"type\": \"MONTHDAY\"\n }\n ],\n \"cutoff\": 1,\n \"fulfillmentExactTime\": \"2019-09-07T15:50:00Z\",\n \"fulfillmentTrigger\": \"ANCHOR\",\n \"intent\": \"FULFILLMENT_BEGIN\",\n \"preAnchorBehavior\": \"ASAP\"\n },\n \"recurring\": {\n \"anchors\": [\n {\n \"cutoffDay\": 1,\n \"day\": 1,\n \"month\": 1,\n \"type\": \"MONTHDAY\"\n }\n ],\n \"cutoff\": 1,\n \"intent\": \"FULFILLMENT_BEGIN\",\n \"interval\": \"DAY\",\n \"intervalCount\": 1,\n \"preAnchorBehavior\": \"ASAP\"\n }\n },\n \"description\": \"<your-description>\",\n \"id\": \"gid://shopify/<objectName>/10079785100\",\n \"inventoryPolicy\": {\n \"reserve\": \"ON_FULFILLMENT\"\n },\n \"metafields\": [\n {\n \"id\": \"gid://shopify/<objectName>/10079785100\",\n \"key\": \"<your-key>\",\n \"namespace\": \"<your-namespace>\",\n \"type\": \"<your-type>\",\n \"value\": \"<your-value>\"\n }\n ],\n \"name\": \"<your-name>\",\n \"options\": [\n \"<your-options>\"\n ],\n \"position\": 1,\n \"pricingPolicies\": [\n {\n \"fixed\": {\n \"adjustmentType\": \"FIXED_AMOUNT\",\n \"adjustmentValue\": {\n \"fixedValue\": \"29.99\",\n \"percentage\": 1.1\n },\n \"id\": \"gid://shopify/<objectName>/10079785100\"\n },\n \"recurring\": {\n \"adjustmentType\": \"FIXED_AMOUNT\",\n \"adjustmentValue\": {\n \"fixedValue\": \"29.99\",\n \"percentage\": 1.1\n },\n \"afterCycle\": 1,\n \"id\": \"gid://shopify/<objectName>/10079785100\"\n }\n }\n ]\n }\n ]\n },\n \"resources\": {\n \"productIds\": [\n \"gid://shopify/<objectName>/10079785100\"\n ],\n \"productVariantIds\": [\n \"gid://shopify/<objectName>/10079785100\"\n ]\n }\n}"Schema Reference for MUTATION: sellingPlanGroupCreate
"input SellingPlanGroupInput {\n appId: String\n description: String\n merchantCode: String\n name: String\n options: [String!]\n position: Int\n sellingPlansToCreate: [SellingPlanInput!]\n sellingPlansToDelete: [ID!]\n sellingPlansToUpdate: [SellingPlanInput!]\n}\n\ninput SellingPlanInput {\n billingPolicy: SellingPlanBillingPolicyInput\n category: SellingPlanCategory\n deliveryPolicy: SellingPlanDeliveryPolicyInput\n description: String\n id: ID\n inventoryPolicy: SellingPlanInventoryPolicyInput\n metafields: [MetafieldInput!]\n name: String\n options: [String!]\n position: Int\n pricingPolicies: [SellingPlanPricingPolicyInput!]\n}\n\ninput SellingPlanGroupResourceInput {\n productIds: [ID!]\n productVariantIds: [ID!]\n}\n"Display Examples for MUTATION: sellingPlanGroupCreate
[
{
"example": {
"type_name": "sellingplangroupcreate",
"title": "Create a prepaid selling plan group with anchor dates",
"query_string": "mutation createSellingPlanGroup($input: SellingPlanGroupInput!, $resources: SellingPlanGroupResourceInput) {\n sellingPlanGroupCreate(input: $input, resources: $resources) {\n sellingPlanGroup {\n id\n sellingPlans(first: 1) {\n edges {\n node {\n id\n }\n }\n }\n }\n userErrors {\n field\n message\n }\n }\n}",
"query_arguments": {
"input": "$input",
"resources": "$resources"
},
"variables": {
"input": {
"name": "Delivered every week and billed every three weeks",
"merchantCode": "prepaid-weekly",
"options": [
"1 week"
],
"sellingPlansToCreate": [
{
"name": "Delivered every week",
"options": "1 Week(s)",
"category": "SUBSCRIPTION",
"billingPolicy": {
"recurring": {
"interval": "WEEK",
"intervalCount": 3,
"anchors": [
{
"cutoffDay": 2,
"day": 4,
"type": "WEEKDAY"
}
]
}
},
"pricingPolicies": [
{
"fixed": {
"adjustmentType": "PERCENTAGE",
"adjustmentValue": {
"percentage": 25
}
}
}
],
"deliveryPolicy": {
"recurring": {
"interval": "WEEK",
"intervalCount": 1,
"anchors": [
{
"cutoffDay": 2,
"day": 4,
"type": "WEEKDAY"
}
]
}
}
}
]
},
"resources": {
"productIds": [
"gid://shopify/Product/121709582"
],
"productVariantIds": []
}
},
"response": {
"data": {
"sellingPlanGroupCreate": {
"sellingPlanGroup": {
"id": "gid://shopify/SellingPlanGroup/1039518901",
"sellingPlans": {
"edges": [
{
"node": {
"id": "gid://shopify/SellingPlan/1070277392"
}
}
]
}
},
"userErrors": []
}
}
},
"api_name": "admin",
"minimum_api_version": "2023-10",
"maximum_api_version": "unstable",
"location": "/components/merchandising/test/unit/graph_api/admin/mutations/selling_plan_group_create_test.rb",
"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\": \"mutation createSellingPlanGroup($input: SellingPlanGroupInput!, $resources: SellingPlanGroupResourceInput) { sellingPlanGroupCreate(input: $input, resources: $resources) { sellingPlanGroup { id sellingPlans(first: 1) { edges { node { id } } } } userErrors { field message } } }\",\n \"variables\": {\n \"input\": {\n \"name\": \"Delivered every week and billed every three weeks\",\n \"merchantCode\": \"prepaid-weekly\",\n \"options\": [\n \"1 week\"\n ],\n \"sellingPlansToCreate\": [\n {\n \"name\": \"Delivered every week\",\n \"options\": \"1 Week(s)\",\n \"category\": \"SUBSCRIPTION\",\n \"billingPolicy\": {\n \"recurring\": {\n \"interval\": \"WEEK\",\n \"intervalCount\": 3,\n \"anchors\": [\n {\n \"cutoffDay\": 2,\n \"day\": 4,\n \"type\": \"WEEKDAY\"\n }\n ]\n }\n },\n \"pricingPolicies\": [\n {\n \"fixed\": {\n \"adjustmentType\": \"PERCENTAGE\",\n \"adjustmentValue\": {\n \"percentage\": 25.0\n }\n }\n }\n ],\n \"deliveryPolicy\": {\n \"recurring\": {\n \"interval\": \"WEEK\",\n \"intervalCount\": 1,\n \"anchors\": [\n {\n \"cutoffDay\": 2,\n \"day\": 4,\n \"type\": \"WEEKDAY\"\n }\n ]\n }\n }\n }\n ]\n },\n \"resources\": {\n \"productIds\": [\n \"gid://shopify/Product/121709582\"\n ],\n \"productVariantIds\": [\n \n ]\n }\n }\n}'\n",
"remix_example": "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n `#graphql\n mutation createSellingPlanGroup($input: SellingPlanGroupInput!, $resources: SellingPlanGroupResourceInput) {\n sellingPlanGroupCreate(input: $input, resources: $resources) {\n sellingPlanGroup {\n id\n sellingPlans(first: 1) {\n edges {\n node {\n id\n }\n }\n }\n }\n userErrors {\n field\n message\n }\n }\n }`,\n {\n variables: {\n \"input\": {\n \"name\": \"Delivered every week and billed every three weeks\",\n \"merchantCode\": \"prepaid-weekly\",\n \"options\": [\n \"1 week\"\n ],\n \"sellingPlansToCreate\": [\n {\n \"name\": \"Delivered every week\",\n \"options\": \"1 Week(s)\",\n \"category\": \"SUBSCRIPTION\",\n \"billingPolicy\": {\n \"recurring\": {\n \"interval\": \"WEEK\",\n \"intervalCount\": 3,\n \"anchors\": [\n {\n \"cutoffDay\": 2,\n \"day\": 4,\n \"type\": \"WEEKDAY\"\n }\n ]\n }\n },\n \"pricingPolicies\": [\n {\n \"fixed\": {\n \"adjustmentType\": \"PERCENTAGE\",\n \"adjustmentValue\": {\n \"percentage\": 25.0\n }\n }\n }\n ],\n \"deliveryPolicy\": {\n \"recurring\": {\n \"interval\": \"WEEK\",\n \"intervalCount\": 1,\n \"anchors\": [\n {\n \"cutoffDay\": 2,\n \"day\": 4,\n \"type\": \"WEEKDAY\"\n }\n ]\n }\n }\n }\n ]\n },\n \"resources\": {\n \"productIds\": [\n \"gid://shopify/Product/121709582\"\n ],\n \"productVariantIds\": [\n \n ]\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 mutation createSellingPlanGroup($input: SellingPlanGroupInput!, $resources: SellingPlanGroupResourceInput) {\n sellingPlanGroupCreate(input: $input, resources: $resources) {\n sellingPlanGroup {\n id\n sellingPlans(first: 1) {\n edges {\n node {\n id\n }\n }\n }\n }\n userErrors {\n field\n message\n }\n }\n }\nQUERY\n\nvariables = {\n \"input\": {\n \"name\": \"Delivered every week and billed every three weeks\",\n \"merchantCode\": \"prepaid-weekly\",\n \"options\": [\"1 week\"],\n \"sellingPlansToCreate\": [{\"name\"=>\"Delivered every week\", \"options\"=>\"1 Week(s)\", \"category\"=>\"SUBSCRIPTION\", \"billingPolicy\"=>{\"recurring\"=>{\"interval\"=>\"WEEK\", \"intervalCount\"=>3, \"anchors\"=>[{\"cutoffDay\"=>2, \"day\"=>4, \"type\"=>\"WEEKDAY\"}]}}, \"pricingPolicies\"=>[{\"fixed\"=>{\"adjustmentType\"=>\"PERCENTAGE\", \"adjustmentValue\"=>{\"percentage\"=>25.0}}}], \"deliveryPolicy\"=>{\"recurring\"=>{\"interval\"=>\"WEEK\", \"intervalCount\"=>1, \"anchors\"=>[{\"cutoffDay\"=>2, \"day\"=>4, \"type\"=>\"WEEKDAY\"}]}}}]\n },\n \"resources\": {\n \"productIds\": [\"gid://shopify/Product/121709582\"],\n \"productVariantIds\": []\n }\n}\n\nresponse = client.query(query: query, variables: variables)\n",
"node_example": "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n data: {\n \"query\": `mutation createSellingPlanGroup($input: SellingPlanGroupInput!, $resources: SellingPlanGroupResourceInput) {\n sellingPlanGroupCreate(input: $input, resources: $resources) {\n sellingPlanGroup {\n id\n sellingPlans(first: 1) {\n edges {\n node {\n id\n }\n }\n }\n }\n userErrors {\n field\n message\n }\n }\n }`,\n \"variables\": {\n \"input\": {\n \"name\": \"Delivered every week and billed every three weeks\",\n \"merchantCode\": \"prepaid-weekly\",\n \"options\": [\n \"1 week\"\n ],\n \"sellingPlansToCreate\": [\n {\n \"name\": \"Delivered every week\",\n \"options\": \"1 Week(s)\",\n \"category\": \"SUBSCRIPTION\",\n \"billingPolicy\": {\n \"recurring\": {\n \"interval\": \"WEEK\",\n \"intervalCount\": 3,\n \"anchors\": [\n {\n \"cutoffDay\": 2,\n \"day\": 4,\n \"type\": \"WEEKDAY\"\n }\n ]\n }\n },\n \"pricingPolicies\": [\n {\n \"fixed\": {\n \"adjustmentType\": \"PERCENTAGE\",\n \"adjustmentValue\": {\n \"percentage\": 25.0\n }\n }\n }\n ],\n \"deliveryPolicy\": {\n \"recurring\": {\n \"interval\": \"WEEK\",\n \"intervalCount\": 1,\n \"anchors\": [\n {\n \"cutoffDay\": 2,\n \"day\": 4,\n \"type\": \"WEEKDAY\"\n }\n ]\n }\n }\n }\n ]\n },\n \"resources\": {\n \"productIds\": [\n \"gid://shopify/Product/121709582\"\n ],\n \"productVariantIds\": [\n \n ]\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 mutation createSellingPlanGroup($input: SellingPlanGroupInput!, $resources: SellingPlanGroupResourceInput) {\n sellingPlanGroupCreate(input: $input, resources: $resources) {\n sellingPlanGroup {\n id\n sellingPlans(first: 1) {\n edges {\n node {\n id\n }\n }\n }\n }\n userErrors {\n field\n message\n }\n }\n }\nQUERY;\n\n$variables = [\n \"input\" => [\n \"name\" => \"Delivered every week and billed every three weeks\",\n \"merchantCode\" => \"prepaid-weekly\",\n \"options\" => [\"1 week\"],\n \"sellingPlansToCreate\" => [{\"name\"=>\"Delivered every week\", \"options\"=>\"1 Week(s)\", \"category\"=>\"SUBSCRIPTION\", \"billingPolicy\"=>{\"recurring\"=>{\"interval\"=>\"WEEK\", \"intervalCount\"=>3, \"anchors\"=>[{\"cutoffDay\"=>2, \"day\"=>4, \"type\"=>\"WEEKDAY\"}]}}, \"pricingPolicies\"=>[{\"fixed\"=>{\"adjustmentType\"=>\"PERCENTAGE\", \"adjustmentValue\"=>{\"percentage\"=>25.0}}}], \"deliveryPolicy\"=>{\"recurring\"=>{\"interval\"=>\"WEEK\", \"intervalCount\"=>1, \"anchors\"=>[{\"cutoffDay\"=>2, \"day\"=>4, \"type\"=>\"WEEKDAY\"}]}}}],\n ],\n \"resources\" => [\n \"productIds\" => [\"gid://shopify/Product/121709582\"],\n \"productVariantIds\" => [],\n ],\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
},
"titleStringKey": "variables",
"inputVariableEntries": [
{
"arg": {
"name": "input",
"description": "The properties of the new Selling Plan Group.",
"type": {
"kind": "INPUT_OBJECT",
"name": "SellingPlanGroupInput",
"list": false,
"non_null": true
},
"defaultValue": null,
"typeSignature": "SellingPlanGroupInput!",
"isDeprecated": false,
"deprecationReason": null,
"kind": "ARGUMENT"
},
"key": "input",
"argValue": " {\"name\":\"Delivered every week and billed every three weeks\",\"merchantCode\":\"prepaid-weekly\",\"options\":[\"1 week\"],\"sellingPlansToCreate\":[{\"name\":\"Delivered every week\",\"options\":\"1 Week(s)\",\"category\":\"SUBSCRIPTION\",\"billingPolicy\":{\"recurring\":{\"interval\":\"WEEK\",\"intervalCount\":3,\"anchors\":[{\"cutoffDay\":2,\"day\":4,\"type\":\"WEEKDAY\"}]}},\"pricingPolicies\":[{\"fixed\":{\"adjustmentType\":\"PERCENTAGE\",\"adjustmentValue\":{\"percentage\":25}}}],\"deliveryPolicy\":{\"recurring\":{\"interval\":\"WEEK\",\"intervalCount\":1,\"anchors\":[{\"cutoffDay\":2,\"day\":4,\"type\":\"WEEKDAY\"}]}}}]}",
"typeKind": "MUTATION"
},
{
"arg": {
"name": "resources",
"description": "The resources this Selling Plan Group should be applied to.",
"type": {
"kind": "INPUT_OBJECT",
"name": "SellingPlanGroupResourceInput",
"list": false,
"non_null": false
},
"defaultValue": null,
"typeSignature": "SellingPlanGroupResourceInput",
"isDeprecated": false,
"deprecationReason": null,
"kind": "ARGUMENT"
},
"key": "resources",
"argValue": " {\"productIds\":[\"gid://shopify/Product/121709582\"],\"productVariantIds\":[]}",
"typeKind": "MUTATION"
}
]
},
{
"example": {
"type_name": "sellingplangroupcreate",
"title": "Create a selling plan group with metafields",
"query_string": "mutation createSellingPlanGroup($input: SellingPlanGroupInput!, $resources: SellingPlanGroupResourceInput) {\n sellingPlanGroupCreate(input: $input, resources: $resources) {\n sellingPlanGroup {\n id\n sellingPlans(first: 1) {\n edges {\n node {\n id\n metafields(first: 1) {\n edges {\n node {\n id\n namespace\n key\n value\n }\n }\n }\n }\n }\n }\n }\n userErrors {\n field\n message\n }\n }\n}",
"query_arguments": {
"input": "$input",
"resources": "$resources"
},
"variables": {
"input": {
"name": "Subscribe and save",
"merchantCode": "subscribe-and-save",
"appId": "groovy",
"options": [
"Delivery every",
"Delivery interval",
"Fun every"
],
"position": 1,
"description": "Subscribe and save group",
"sellingPlansToCreate": [
{
"name": "Pay every month deliver every month",
"options": [
"1",
"month",
"day"
],
"metafields": [
{
"namespace": "for_testing",
"key": "my_key",
"value": "selling plan metafield",
"type": "single_line_text_field"
}
],
"position": 1,
"category": "SUBSCRIPTION",
"billingPolicy": {
"recurring": {
"interval": "MONTH",
"intervalCount": 1,
"anchors": [
{
"type": "MONTHDAY",
"day": 26
}
]
}
},
"deliveryPolicy": {
"recurring": {
"interval": "MONTH",
"intervalCount": 1,
"anchors": [
{
"type": "MONTHDAY",
"day": 26
}
],
"cutoff": 5,
"intent": "FULFILLMENT_BEGIN",
"preAnchorBehavior": "ASAP"
}
},
"inventoryPolicy": {
"reserve": "ON_SALE"
},
"pricingPolicies": [
{
"fixed": {
"adjustmentType": "PERCENTAGE",
"adjustmentValue": {
"percentage": 25
}
}
},
{
"recurring": {
"afterCycle": 3,
"adjustmentType": "PERCENTAGE",
"adjustmentValue": {
"percentage": 26
}
}
}
]
}
]
},
"resources": {}
},
"response": {
"data": {
"sellingPlanGroupCreate": {
"sellingPlanGroup": {
"id": "gid://shopify/SellingPlanGroup/1039518902",
"sellingPlans": {
"edges": [
{
"node": {
"id": "gid://shopify/SellingPlan/1070277393",
"metafields": {
"edges": [
{
"node": {
"id": "gid://shopify/Metafield/1069228978",
"namespace": "for_testing",
"key": "my_key",
"value": "selling plan metafield"
}
}
]
}
}
}
]
}
},
"userErrors": []
}
}
},
"api_name": "admin",
"minimum_api_version": "2024-07",
"maximum_api_version": "unstable",
"location": "/components/merchandising/test/unit/graph_api/admin/mutations/selling_plan_group_create_test.rb",
"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\": \"mutation createSellingPlanGroup($input: SellingPlanGroupInput!, $resources: SellingPlanGroupResourceInput) { sellingPlanGroupCreate(input: $input, resources: $resources) { sellingPlanGroup { id sellingPlans(first: 1) { edges { node { id metafields(first: 1) { edges { node { id namespace key value } } } } } } } userErrors { field message } } }\",\n \"variables\": {\n \"input\": {\n \"name\": \"Subscribe and save\",\n \"merchantCode\": \"subscribe-and-save\",\n \"appId\": \"groovy\",\n \"options\": [\n \"Delivery every\",\n \"Delivery interval\",\n \"Fun every\"\n ],\n \"position\": 1,\n \"description\": \"Subscribe and save group\",\n \"sellingPlansToCreate\": [\n {\n \"name\": \"Pay every month deliver every month\",\n \"options\": [\n \"1\",\n \"month\",\n \"day\"\n ],\n \"metafields\": [\n {\n \"namespace\": \"for_testing\",\n \"key\": \"my_key\",\n \"value\": \"selling plan metafield\",\n \"type\": \"single_line_text_field\"\n }\n ],\n \"position\": 1,\n \"category\": \"SUBSCRIPTION\",\n \"billingPolicy\": {\n \"recurring\": {\n \"interval\": \"MONTH\",\n \"intervalCount\": 1,\n \"anchors\": [\n {\n \"type\": \"MONTHDAY\",\n \"day\": 26\n }\n ]\n }\n },\n \"deliveryPolicy\": {\n \"recurring\": {\n \"interval\": \"MONTH\",\n \"intervalCount\": 1,\n \"anchors\": [\n {\n \"type\": \"MONTHDAY\",\n \"day\": 26\n }\n ],\n \"cutoff\": 5,\n \"intent\": \"FULFILLMENT_BEGIN\",\n \"preAnchorBehavior\": \"ASAP\"\n }\n },\n \"inventoryPolicy\": {\n \"reserve\": \"ON_SALE\"\n },\n \"pricingPolicies\": [\n {\n \"fixed\": {\n \"adjustmentType\": \"PERCENTAGE\",\n \"adjustmentValue\": {\n \"percentage\": 25.0\n }\n }\n },\n {\n \"recurring\": {\n \"afterCycle\": 3,\n \"adjustmentType\": \"PERCENTAGE\",\n \"adjustmentValue\": {\n \"percentage\": 26.0\n }\n }\n }\n ]\n }\n ]\n },\n \"resources\": {\n }\n }\n}'\n",
"remix_example": "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n `#graphql\n mutation createSellingPlanGroup($input: SellingPlanGroupInput!, $resources: SellingPlanGroupResourceInput) {\n sellingPlanGroupCreate(input: $input, resources: $resources) {\n sellingPlanGroup {\n id\n sellingPlans(first: 1) {\n edges {\n node {\n id\n metafields(first: 1) {\n edges {\n node {\n id\n namespace\n key\n value\n }\n }\n }\n }\n }\n }\n }\n userErrors {\n field\n message\n }\n }\n }`,\n {\n variables: {\n \"input\": {\n \"name\": \"Subscribe and save\",\n \"merchantCode\": \"subscribe-and-save\",\n \"appId\": \"groovy\",\n \"options\": [\n \"Delivery every\",\n \"Delivery interval\",\n \"Fun every\"\n ],\n \"position\": 1,\n \"description\": \"Subscribe and save group\",\n \"sellingPlansToCreate\": [\n {\n \"name\": \"Pay every month deliver every month\",\n \"options\": [\n \"1\",\n \"month\",\n \"day\"\n ],\n \"metafields\": [\n {\n \"namespace\": \"for_testing\",\n \"key\": \"my_key\",\n \"value\": \"selling plan metafield\",\n \"type\": \"single_line_text_field\"\n }\n ],\n \"position\": 1,\n \"category\": \"SUBSCRIPTION\",\n \"billingPolicy\": {\n \"recurring\": {\n \"interval\": \"MONTH\",\n \"intervalCount\": 1,\n \"anchors\": [\n {\n \"type\": \"MONTHDAY\",\n \"day\": 26\n }\n ]\n }\n },\n \"deliveryPolicy\": {\n \"recurring\": {\n \"interval\": \"MONTH\",\n \"intervalCount\": 1,\n \"anchors\": [\n {\n \"type\": \"MONTHDAY\",\n \"day\": 26\n }\n ],\n \"cutoff\": 5,\n \"intent\": \"FULFILLMENT_BEGIN\",\n \"preAnchorBehavior\": \"ASAP\"\n }\n },\n \"inventoryPolicy\": {\n \"reserve\": \"ON_SALE\"\n },\n \"pricingPolicies\": [\n {\n \"fixed\": {\n \"adjustmentType\": \"PERCENTAGE\",\n \"adjustmentValue\": {\n \"percentage\": 25.0\n }\n }\n },\n {\n \"recurring\": {\n \"afterCycle\": 3,\n \"adjustmentType\": \"PERCENTAGE\",\n \"adjustmentValue\": {\n \"percentage\": 26.0\n }\n }\n }\n ]\n }\n ]\n },\n \"resources\": {\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 mutation createSellingPlanGroup($input: SellingPlanGroupInput!, $resources: SellingPlanGroupResourceInput) {\n sellingPlanGroupCreate(input: $input, resources: $resources) {\n sellingPlanGroup {\n id\n sellingPlans(first: 1) {\n edges {\n node {\n id\n metafields(first: 1) {\n edges {\n node {\n id\n namespace\n key\n value\n }\n }\n }\n }\n }\n }\n }\n userErrors {\n field\n message\n }\n }\n }\nQUERY\n\nvariables = {\n \"input\": {\n \"name\": \"Subscribe and save\",\n \"merchantCode\": \"subscribe-and-save\",\n \"appId\": \"groovy\",\n \"options\": [\"Delivery every\", \"Delivery interval\", \"Fun every\"],\n \"position\": 1,\n \"description\": \"Subscribe and save group\",\n \"sellingPlansToCreate\": [{\"name\"=>\"Pay every month deliver every month\", \"options\"=>[\"1\", \"month\", \"day\"], \"metafields\"=>[{\"namespace\"=>\"for_testing\", \"key\"=>\"my_key\", \"value\"=>\"selling plan metafield\", \"type\"=>\"single_line_text_field\"}], \"position\"=>1, \"category\"=>\"SUBSCRIPTION\", \"billingPolicy\"=>{\"recurring\"=>{\"interval\"=>\"MONTH\", \"intervalCount\"=>1, \"anchors\"=>[{\"type\"=>\"MONTHDAY\", \"day\"=>26}]}}, \"deliveryPolicy\"=>{\"recurring\"=>{\"interval\"=>\"MONTH\", \"intervalCount\"=>1, \"anchors\"=>[{\"type\"=>\"MONTHDAY\", \"day\"=>26}], \"cutoff\"=>5, \"intent\"=>\"FULFILLMENT_BEGIN\", \"preAnchorBehavior\"=>\"ASAP\"}}, \"inventoryPolicy\"=>{\"reserve\"=>\"ON_SALE\"}, \"pricingPolicies\"=>[{\"fixed\"=>{\"adjustmentType\"=>\"PERCENTAGE\", \"adjustmentValue\"=>{\"percentage\"=>25.0}}}, {\"recurring\"=>{\"afterCycle\"=>3, \"adjustmentType\"=>\"PERCENTAGE\", \"adjustmentValue\"=>{\"percentage\"=>26.0}}}]}]\n },\n \"resources\": {\n\n }\n}\n\nresponse = client.query(query: query, variables: variables)\n",
"node_example": "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n data: {\n \"query\": `mutation createSellingPlanGroup($input: SellingPlanGroupInput!, $resources: SellingPlanGroupResourceInput) {\n sellingPlanGroupCreate(input: $input, resources: $resources) {\n sellingPlanGroup {\n id\n sellingPlans(first: 1) {\n edges {\n node {\n id\n metafields(first: 1) {\n edges {\n node {\n id\n namespace\n key\n value\n }\n }\n }\n }\n }\n }\n }\n userErrors {\n field\n message\n }\n }\n }`,\n \"variables\": {\n \"input\": {\n \"name\": \"Subscribe and save\",\n \"merchantCode\": \"subscribe-and-save\",\n \"appId\": \"groovy\",\n \"options\": [\n \"Delivery every\",\n \"Delivery interval\",\n \"Fun every\"\n ],\n \"position\": 1,\n \"description\": \"Subscribe and save group\",\n \"sellingPlansToCreate\": [\n {\n \"name\": \"Pay every month deliver every month\",\n \"options\": [\n \"1\",\n \"month\",\n \"day\"\n ],\n \"metafields\": [\n {\n \"namespace\": \"for_testing\",\n \"key\": \"my_key\",\n \"value\": \"selling plan metafield\",\n \"type\": \"single_line_text_field\"\n }\n ],\n \"position\": 1,\n \"category\": \"SUBSCRIPTION\",\n \"billingPolicy\": {\n \"recurring\": {\n \"interval\": \"MONTH\",\n \"intervalCount\": 1,\n \"anchors\": [\n {\n \"type\": \"MONTHDAY\",\n \"day\": 26\n }\n ]\n }\n },\n \"deliveryPolicy\": {\n \"recurring\": {\n \"interval\": \"MONTH\",\n \"intervalCount\": 1,\n \"anchors\": [\n {\n \"type\": \"MONTHDAY\",\n \"day\": 26\n }\n ],\n \"cutoff\": 5,\n \"intent\": \"FULFILLMENT_BEGIN\",\n \"preAnchorBehavior\": \"ASAP\"\n }\n },\n \"inventoryPolicy\": {\n \"reserve\": \"ON_SALE\"\n },\n \"pricingPolicies\": [\n {\n \"fixed\": {\n \"adjustmentType\": \"PERCENTAGE\",\n \"adjustmentValue\": {\n \"percentage\": 25.0\n }\n }\n },\n {\n \"recurring\": {\n \"afterCycle\": 3,\n \"adjustmentType\": \"PERCENTAGE\",\n \"adjustmentValue\": {\n \"percentage\": 26.0\n }\n }\n }\n ]\n }\n ]\n },\n \"resources\": {\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 mutation createSellingPlanGroup($input: SellingPlanGroupInput!, $resources: SellingPlanGroupResourceInput) {\n sellingPlanGroupCreate(input: $input, resources: $resources) {\n sellingPlanGroup {\n id\n sellingPlans(first: 1) {\n edges {\n node {\n id\n metafields(first: 1) {\n edges {\n node {\n id\n namespace\n key\n value\n }\n }\n }\n }\n }\n }\n }\n userErrors {\n field\n message\n }\n }\n }\nQUERY;\n\n$variables = [\n \"input\" => [\n \"name\" => \"Subscribe and save\",\n \"merchantCode\" => \"subscribe-and-save\",\n \"appId\" => \"groovy\",\n \"options\" => [\"Delivery every\", \"Delivery interval\", \"Fun every\"],\n \"position\" => 1,\n \"description\" => \"Subscribe and save group\",\n \"sellingPlansToCreate\" => [{\"name\"=>\"Pay every month deliver every month\", \"options\"=>[\"1\", \"month\", \"day\"], \"metafields\"=>[{\"namespace\"=>\"for_testing\", \"key\"=>\"my_key\", \"value\"=>\"selling plan metafield\", \"type\"=>\"single_line_text_field\"}], \"position\"=>1, \"category\"=>\"SUBSCRIPTION\", \"billingPolicy\"=>{\"recurring\"=>{\"interval\"=>\"MONTH\", \"intervalCount\"=>1, \"anchors\"=>[{\"type\"=>\"MONTHDAY\", \"day\"=>26}]}}, \"deliveryPolicy\"=>{\"recurring\"=>{\"interval\"=>\"MONTH\", \"intervalCount\"=>1, \"anchors\"=>[{\"type\"=>\"MONTHDAY\", \"day\"=>26}], \"cutoff\"=>5, \"intent\"=>\"FULFILLMENT_BEGIN\", \"preAnchorBehavior\"=>\"ASAP\"}}, \"inventoryPolicy\"=>{\"reserve\"=>\"ON_SALE\"}, \"pricingPolicies\"=>[{\"fixed\"=>{\"adjustmentType\"=>\"PERCENTAGE\", \"adjustmentValue\"=>{\"percentage\"=>25.0}}}, {\"recurring\"=>{\"afterCycle\"=>3, \"adjustmentType\"=>\"PERCENTAGE\", \"adjustmentValue\"=>{\"percentage\"=>26.0}}}]}],\n ],\n \"resources\" => [\n ],\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
},
"titleStringKey": "variables",
"inputVariableEntries": [
{
"arg": {
"name": "input",
"description": "The properties of the new Selling Plan Group.",
"type": {
"kind": "INPUT_OBJECT",
"name": "SellingPlanGroupInput",
"list": false,
"non_null": true
},
"defaultValue": null,
"typeSignature": "SellingPlanGroupInput!",
"isDeprecated": false,
"deprecationReason": null,
"kind": "ARGUMENT"
},
"key": "input",
"argValue": " {\"name\":\"Subscribe and save\",\"merchantCode\":\"subscribe-and-save\",\"appId\":\"groovy\",\"options\":[\"Delivery every\",\"Delivery interval\",\"Fun every\"],\"position\":1,\"description\":\"Subscribe and save group\",\"sellingPlansToCreate\":[{\"name\":\"Pay every month deliver every month\",\"options\":[\"1\",\"month\",\"day\"],\"metafields\":[{\"namespace\":\"for_testing\",\"key\":\"my_key\",\"value\":\"selling plan metafield\",\"type\":\"single_line_text_field\"}],\"position\":1,\"category\":\"SUBSCRIPTION\",\"billingPolicy\":{\"recurring\":{\"interval\":\"MONTH\",\"intervalCount\":1,\"anchors\":[{\"type\":\"MONTHDAY\",\"day\":26}]}},\"deliveryPolicy\":{\"recurring\":{\"interval\":\"MONTH\",\"intervalCount\":1,\"anchors\":[{\"type\":\"MONTHDAY\",\"day\":26}],\"cutoff\":5,\"intent\":\"FULFILLMENT_BEGIN\",\"preAnchorBehavior\":\"ASAP\"}},\"inventoryPolicy\":{\"reserve\":\"ON_SALE\"},\"pricingPolicies\":[{\"fixed\":{\"adjustmentType\":\"PERCENTAGE\",\"adjustmentValue\":{\"percentage\":25}}},{\"recurring\":{\"afterCycle\":3,\"adjustmentType\":\"PERCENTAGE\",\"adjustmentValue\":{\"percentage\":26}}}]}]}",
"typeKind": "MUTATION"
},
{
"arg": {
"name": "resources",
"description": "The resources this Selling Plan Group should be applied to.",
"type": {
"kind": "INPUT_OBJECT",
"name": "SellingPlanGroupResourceInput",
"list": false,
"non_null": false
},
"defaultValue": null,
"typeSignature": "SellingPlanGroupResourceInput",
"isDeprecated": false,
"deprecationReason": null,
"kind": "ARGUMENT"
},
"key": "resources",
"argValue": " {}",
"typeKind": "MUTATION"
}
]
}
]