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

sellingPlanGroupUpdate mutation

Version unstable

Update 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

Argument Description
id ( ID! ) required

The Selling Plan Group to update.

input ( SellingPlanGroupInput )

The properties of the Selling Plan Group to update.

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!])

    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)

    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

Version 2021-07 (Release candidate)

Update 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

Argument Description
id ( ID! ) required

The Selling Plan Group to update.

input ( SellingPlanGroupInput )

The properties of the Selling Plan Group to update.

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!])

    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)

    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

Version 2021-04 (Latest)

Update 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

Argument Description
id ( ID! ) required

The Selling Plan Group to update.

input ( SellingPlanGroupInput )

The properties of the Selling Plan Group to update.

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!])

    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)

    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

Version 2021-01

Update 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

Argument Description
id ( ID! ) required

The Selling Plan Group to update.

input ( SellingPlanGroupInput )

The properties of the Selling Plan Group to update.

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!])

    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)

    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