productVariantJoinSellingPlanGroups

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.

Adds multiple selling plan groups to a product variant.

Arguments

Anchor to idid • ID!required: The ID of the product variant.
Anchor to sellingPlanGroupIdssellingPlanGroupIds • [ID!]!required: The IDs of the selling plan groups to add.

Was this section helpful?

Anchor to ProductVariantJoinSellingPlanGroupsPayload returnsProductVariantJoinSellingPlanGroupsPayload returns

Anchor to productVariantproductVariant • ProductVariant: The product variant object.
Anchor to userErrorsuserErrors • [SellingPlanGroupUserError!]!non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Mutation Reference

1mutation productVariantJoinSellingPlanGroups($id: ID!, $sellingPlanGroupIds: [ID!]!) {
2  productVariantJoinSellingPlanGroups(id: $id, sellingPlanGroupIds: $sellingPlanGroupIds) {
3    productVariant {
4      # ProductVariant fields
5    }
6    userErrors {
7      field
8      message
9    }
10  }
11}

Input

1{
2  "id": "gid://shopify/<objectName>/10079785100",
3  "sellingPlanGroupIds": [
4    "gid://shopify/<objectName>/10079785100"
5  ]
6}

{
  "id": "gid://shopify/<objectName>/10079785100",
  "sellingPlanGroupIds": [
    "gid://shopify/<objectName>/10079785100"
  ]
}