Shopify uses cookies to provide necessary site functionality and improve your experience. By using our website, you agree to our privacy policy and our cookie policy.

sellingPlanGroupUpdate

mutation

Requires write_products access scope as well as any of write_own_subscription_contracts, write_purchase_options access scopes. Also: The user must have manage_orders_information permissions.

Update a Selling Plan Group.

Arguments

Anchor to idid • ID!required: The Selling Plan Group to update.
Anchor to inputinput • SellingPlanGroupInput!required: The properties of the Selling Plan Group to update.

Was this section helpful?

Anchor to SellingPlanGroupUpdatePayload returnsSellingPlanGroupUpdatePayload returns

Anchor to deletedSellingPlanIdsdeletedSellingPlanIds • [ID!]: The IDs of the deleted Subscription Plans.
Anchor to sellingPlanGroupsellingPlanGroup • SellingPlanGroup: The updated Selling Plan Group.
Anchor to userErrorsuserErrors • [SellingPlanGroupUserError!]!non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Mutation Reference

mutation sellingPlanGroupUpdate($id: ID!, $input: SellingPlanGroupInput!) {

sellingPlanGroupUpdate(id: $id, input: $input) {

deletedSellingPlanIds

sellingPlanGroup {

# SellingPlanGroup fields

}

userErrors {

field

message

}

}

}

Input

{

"id": "gid://shopify/<objectName>/10079785100",

"input": {

"appId": "<your-appId>",

"description": "<your-description>",

"merchantCode": "<your-merchantCode>",

"name": "<your-name>",

"options": [

"<your-options>"

],

"position": 1,

"sellingPlansToCreate": [

{

"billingPolicy": "",

"category": "",

"deliveryPolicy": "",

"description": "<your-description>",

"id": "gid://shopify/<objectName>/10079785100",

"inventoryPolicy": "",

"name": "<your-name>",

"options": [

"<your-options>"

],

"position": 1,

"pricingPolicies": [

{
  "id": "gid://shopify/<objectName>/10079785100",
  "input": {
    "appId": "<your-appId>",
    "description": "<your-description>",
    "merchantCode": "<your-merchantCode>",
    "name": "<your-name>",
    "options": [
      "<your-options>"
    ],
    "position": 1,
    "sellingPlansToCreate": [
      {
        "billingPolicy": "",
        "category": "",
        "deliveryPolicy": "",
        "description": "<your-description>",
        "id": "gid://shopify/<objectName>/10079785100",
        "inventoryPolicy": "",
        "name": "<your-name>",
        "options": [
          "<your-options>"
        ],
        "position": 1,
        "pricingPolicies": [
          ""
        ]
      }
    ],
    "sellingPlansToDelete": [
      "gid://shopify/<objectName>/10079785100"
    ],
    "sellingPlansToUpdate": [
      {
        "billingPolicy": "",
        "category": "",
        "deliveryPolicy": "",
        "description": "<your-description>",
        "id": "gid://shopify/<objectName>/10079785100",
        "inventoryPolicy": "",
        "name": "<your-name>",
        "options": [
          "<your-options>"
        ],
        "position": 1,
        "pricingPolicies": [
          ""
        ]
      }
    ]
  }
}

input SellingPlanGroupInput {
  appId: String
  description: String
  merchantCode: String
  name: String
  options: [String!]
  position: Int
  sellingPlansToCreate: [SellingPlanInput!]
  sellingPlansToDelete: [ID!]
  sellingPlansToUpdate: [SellingPlanInput!]
}

input SellingPlanInput {
  billingPolicy: SellingPlanBillingPolicyInput
  category: SellingPlanCategory
  deliveryPolicy: SellingPlanDeliveryPolicyInput
  description: String
  id: ID
  inventoryPolicy: SellingPlanInventoryPolicyInput
  name: String
  options: [String!]
  position: Int
  pricingPolicies: [SellingPlanPricingPolicyInput!]
}