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

collectionReorderProducts mutation

Version unstable

Asynchronously reorders a set of products from a given collection.

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

id ( ID! ) required

The ID of the collection on which to reorder products.
moves ( [MoveInput!]! ) required

A list of moves to perform which will be evaulated in order.

MoveInput fields

id (ID!) Required

The ID of the object to be moved.
newPosition (UnsignedInt64!) Required

The new position of the object in the set, using a 0 based index.

Return fields

job (Job)

The asynchronous job reordering the products.
userErrors ([UserError!]!)

List of errors that occurred executing the mutation.
Version 2021-01 (Release candidate)

Asynchronously reorders a set of products from a given collection.

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

id ( ID! ) required

The ID of the collection on which to reorder products.
moves ( [MoveInput!]! ) required

A list of moves to perform which will be evaulated in order.

MoveInput fields

id (ID!) Required

The ID of the object to be moved.
newPosition (UnsignedInt64!) Required

The new position of the object in the set, using a 0 based index.

Return fields

job (Job)

The asynchronous job reordering the products.
userErrors ([UserError!]!)

List of errors that occurred executing the mutation.
Version 2020-10 (Latest)

Asynchronously reorders a set of products from a given collection.

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

id ( ID! ) required

The ID of the collection on which to reorder products.
moves ( [MoveInput!]! ) required

A list of moves to perform which will be evaulated in order.

MoveInput fields

id (ID!) Required

The ID of the object to be moved.
newPosition (UnsignedInt64!) Required

The new position of the object in the set, using a 0 based index.

Return fields

job (Job)

The asynchronous job reordering the products.
userErrors ([UserError!]!)

List of errors that occurred executing the mutation.
Version 2020-07

Asynchronously reorders a set of products from a given collection.

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

id ( ID! ) required

The ID of the collection on which to reorder products.
moves ( [MoveInput!]! ) required

A list of moves to perform which will be evaulated in order.

MoveInput fields

id (ID!) Required

The ID of the object to be moved.
newPosition (UnsignedInt64!) Required

The new position of the object in the set, using a 0 based index.

Return fields

job (Job)

The asynchronous job reordering the products.
userErrors ([UserError!]!)

List of errors that occurred executing the mutation.
Version 2020-04

Asynchronously reorders a set of products from a given collection.

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

id ( ID! ) required

The ID of the collection on which to reorder products.
moves ( [MoveInput!]! ) required

A list of moves to perform which will be evaulated in order.

MoveInput fields

id (ID!) Required

The ID of the object to be moved.
newPosition (UnsignedInt64!) Required

The new position of the object in the set, using a 0 based index.

Return fields

job (Job)

The asynchronous job reordering the products.
userErrors ([UserError!]!)

List of errors that occurred executing the mutation.
Version 2020-01

Asynchronously reorders a set of products from a given collection.

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

id ( ID! ) required

The ID of the collection on which to reorder products.
moves ( [MoveInput!]! ) required

A list of moves to perform which will be evaulated in order.

MoveInput fields

id (ID!) Required

The ID of the object to be moved.
newPosition (UnsignedInt64!) Required

The new position of the object in the set, using a 0 based index.

Return fields

job (Job)

The asynchronous job reordering the products.
userErrors ([UserError!]!)

List of errors that occurred executing the mutation.
Version 2019-10 (Unsupported)

Asynchronously reorders a set of products from a given collection.

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

id ( ID! ) required

The ID of the collection on which to reorder products.
moves ( [MoveInput!]! ) required

A list of moves to perform which will be evaulated in order.

MoveInput fields

id (ID!) Required

The ID of the object to be moved.
newPosition (UnsignedInt64!) Required

The new position of the object in the set, using a 0 based index.

Return fields

job (Job)

The asynchronous job reordering the products.
userErrors ([UserError!]!)

List of errors that occurred executing the mutation.
Version 2019-07 (Unsupported)

Asynchronously reorders a set of products from a given collection.

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

id ( ID! ) required

The ID of the collection on which to reorder products.
moves ( [MoveInput!]! ) required

A list of moves to perform which will be evaulated in order.

MoveInput fields

id (ID!) Required

The ID of the object to be moved.
newPosition (UnsignedInt64!) Required

The new position of the object in the set, using a 0 based index.

Return fields

job (Job)

The asynchronous job reordering the products.
userErrors ([UserError!]!)

List of errors that occurred executing the mutation.
Version 2019-04 (Unsupported)

Asynchronously reorders a set of products from a given collection.

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

id ( ID! ) required

The ID of the collection on which to reorder products.
moves ( [MoveInput!]! ) required

A list of moves to perform which will be evaulated in order.

MoveInput fields

id (ID!) Required

The ID of the object to be moved.
newPosition (UnsignedInt64!) Required

The new position of the object in the set, using a 0 based index.

Return fields

job (Job)

The asynchronous job reordering the products.
userErrors ([UserError!]!)

List of errors that occurred executing the mutation.