sellingPlanGroupCreate mutation

Creates a Selling Plan Group.

Required access

write_products access scope.

On this page

• Interactive example
• Arguments
• SellingPlanGroupInput fields
• Return fields

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.

<font style="color:#1F61A0;">sellingPlanGroup</font> <font style="color:#555555;">{</font>
  <font style="color:#1F61A0;">id</font>
<font style="color:#555555;">}</font>
<font style="color:#1F61A0;">userErrors</font> <font style="color:#555555;">{</font>
  <font style="color:#1F61A0;">code</font>
  <font style="color:#1F61A0;">field</font>
  <font style="color:#1F61A0;">message</font>
<font style="color:#555555;">}</font>

Arguments

SellingPlanGroupInput fields

• appId ([String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01))
  Identifier for app, exposed in Liquid and product JSON.
• description ([String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01))
  Merchant facing description of the selling plan group.
• merchantCode ([String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01))
  Merchant facing label of the selling plan group.
• name ([String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01))
  Buyer facing label of the selling plan group.
• options ([[String!]](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01))
  The values of all options available on the selling plan group. Selling plans are grouped together in Liquid when they are created by the same app, and have the same selling_plan_group.name and selling_plan_group.options values.
• position ([Int](https://shopify.dev/docs/admin-api/graphql/reference/scalar#int-2021-01))
  Relative value for display purposes of the selling plan group. A lower position will be displayed before a higher one.
• sellingPlansToCreate ([[SellingPlanInput!]](https://shopify.dev/docs/admin-api/graphql/reference/products-and-collections/sellingplaninput))
  List of selling plans to create.
• sellingPlansToDelete ([[ID!]](https://shopify.dev/docs/admin-api/graphql/reference/scalar#id-2021-01))
  List of selling plans ids to delete.
• sellingPlansToUpdate ([[SellingPlanInput!]](https://shopify.dev/docs/admin-api/graphql/reference/products-and-collections/sellingplaninput))
  List of selling plans to update.

Return fields

• sellingPlanGroup ([SellingPlanGroup](https://shopify.dev/docs/admin-api/graphql/reference/products-and-collections/sellingplangroup))
  The created selling plan group object.
• userErrors ([[SellingPlanGroupUserError!]!](https://shopify.dev/docs/admin-api/graphql/reference/products-and-collections/sellingplangroupusererror))
  List of errors that occurred executing the mutation.