API version: unstable
API version: 2021-01 Release candidate
API version: 2020-10 Latest
API version: 2020-07
API version: 2020-04
API version: 2020-01
API version: 2019-10 Unsupported
API version: 2019-07 Unsupported

sellingPlanGroupCreate mutation

Version unstable

Creates a Selling Plan Group.

Required access

write_products access scope.

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.


Arguments

input ( SellingPlanGroupInput! ) required

The properties of the new Selling Plan Group.

resources ( SellingPlanGroupResourceInput )

The resources this Selling Plan Group should be applied to.

SellingPlanGroupInput fields

appId (String)

Identifier for app, exposed in Liquid and product JSON.

description (String)

Merchant facing description of the selling plan group.

merchantCode (String)

Merchant facing label of the selling plan group.

name (String)

Buyer facing label of the selling plan group.

options ([String!])

Options available to describe the selling plan group.

position (Int)

Relative value for display purposes of the selling plan group. A lower position will be displayed before a higher one.

sellingPlansToCreate ([SellingPlanInput!])

List of selling plans to create.

sellingPlansToDelete ([ID!])

List of selling plans ids to delete.

sellingPlansToUpdate ([SellingPlanInput!])

List of selling plans to update.

Return fields

sellingPlanGroup (SellingPlanGroup)

The created selling plan group object.

userErrors ([SellingPlanGroupUserError!]!)

List of errors that occurred executing the mutation.

Version 2021-01 (Release candidate)

Creates a Selling Plan Group.

Required access

write_products access scope.

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.


Arguments

input ( SellingPlanGroupInput! ) required

The properties of the new Selling Plan Group.

resources ( SellingPlanGroupResourceInput )

The resources this Selling Plan Group should be applied to.

SellingPlanGroupInput fields

appId (String)

Identifier for app, exposed in Liquid and product JSON.

description (String)

Merchant facing description of the selling plan group.

merchantCode (String)

Merchant facing label of the selling plan group.

name (String)

Buyer facing label of the selling plan group.

options ([String!])

Options available to describe the selling plan group.

position (Int)

Relative value for display purposes of the selling plan group. A lower position will be displayed before a higher one.

sellingPlansToCreate ([SellingPlanInput!])

List of selling plans to create.

sellingPlansToDelete ([ID!])

List of selling plans ids to delete.

sellingPlansToUpdate ([SellingPlanInput!])

List of selling plans to update.

Return fields

sellingPlanGroup (SellingPlanGroup)

The created selling plan group object.

userErrors ([SellingPlanGroupUserError!]!)

List of errors that occurred executing the mutation.