collectionReorderProducts mutation

Asynchronously reorders a set of products from a given collection.

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 collectionReorderProducts($id: ID!, $moves: [MoveInput!]!) { collectionReorderProducts(id: $id, moves: $moves) { 
  1. <font style="color:#1F61A0;">job</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;">field</font>
  11.   <font style="color:#1F61A0;">message</font>
  13. <font style="color:#555555;">}</font>
} } { “id”: “Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE=”, “moves”: [ 
  1. <font style="color:#555555;">{</font>
  3.   <font style="color:#8B2BB9;">"id"</font><font style="color:#555555;">:</font> <font style="color:#D64292;">"Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE="</font><font style="color:#555555;">,</font>
  5.   <font style="color:#8B2BB9;">"newPosition"</font><font style="color:#555555;">:</font> <font style="color:#D64292;">"placeholder"</font>
  7. <font style="color:#555555;">}</font>
] }

Arguments

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

) REQUIRED		 The ID of the collection on which to reorder products.
moves
(
[[MoveInput!]!](https://shopify.dev/docs/admin-api/graphql/reference/products-and-collections/moveinput)

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

MoveInput fields

  • id ([ID!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#id-2021-01)) REQUIRED
    The ID of the object to be moved.
  • newPosition ([UnsignedInt64!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#unsignedint64-2021-01)) REQUIRED
    The new position of the object in the set, using a 0 based index.

Return fields

  • job ([Job](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/job))
    The asynchronous job reordering the products.
  • userErrors ([[UserError!]!](https://shopify.dev/docs/admin-api/graphql/reference/usererror))
    List of errors that occurred executing the mutation.