productVariantLeaveSellingPlanGroups mutation

Remove multiple groups from a product variant.

Required access

write_products access scope.

On this page

Interactive example

This is an example mutation query. Use the embedded interactive tool below to edit the query.

Hint: use Ctrl + Space for autocompleting fields.

mutation productVariantLeaveSellingPlanGroups($id: ID!, $sellingPlanGroupIds: [ID!]!) { productVariantLeaveSellingPlanGroups(id: $id, sellingPlanGroupIds: $sellingPlanGroupIds) { 
  1. <font style="color:#1F61A0;">productVariant</font> <font style="color:#555555;">{</font>
  3.   <font style="color:#1F61A0;">id</font>
  5. <font style="color:#555555;">}</font>
  7. <font style="color:#1F61A0;">userErrors</font> <font style="color:#555555;">{</font>
  9.   <font style="color:#1F61A0;">code</font>
  11.   <font style="color:#1F61A0;">field</font>
  13.   <font style="color:#1F61A0;">message</font>
  15. <font style="color:#555555;">}</font>
} } { “id”: “Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE=”, “sellingPlanGroupIds”: [ 
  1. <font style="color:#D64292;">"Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE="</font>
] }

Arguments

Argument Description
id
(
[ID!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#id-2021-01)

) REQUIRED		 The ID of the product variant.
sellingPlanGroupIds
(
[[ID!]!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#id-2021-01)

) REQUIRED		 The IDs of the selling plan groups to leave.

Return fields

  • productVariant ([ProductVariant](https://shopify.dev/docs/admin-api/graphql/reference/products-and-collections/productvariant))
    The product variant object.
  • userErrors ([[SellingPlanGroupUserError!]!](https://shopify.dev/docs/admin-api/graphql/reference/products-and-collections/sellingplangroupusererror))
    List of errors that occurred executing the mutation.