CollectionReorderProductsPayload

The asynchronous job reordering the products.

The list of errors that occurred from executing the mutation.

Asynchronously reorders products within a specified collection. Instead of returning an updated collection, this mutation returns a job, which should be polled. The Collection.sortOrder must be MANUAL.

How to use this mutation:

• Provide only the products that actually moved in the moves list; do not send the entire product list. For example: to move the product at index 1 to index N, send a single move for that product with newPosition: N.
• Each move is applied sequentially in the order provided.
• newPosition is a zero-based index within the collection at the moment the move is applied (after any prior moves in the list).
• Products not included in moves keep their relative order, aside from any displacement caused by the moves.
• If newPosition is greater than or equal to the number of products, the product is placed at the end.

Example:

• Initial order: [A, B, C, D, E] (indices 0..4)
• Moves (applied in order):
• E -> newPosition: 1
• C -> newPosition: 4
• Result: [A, E, B, D, C]

Displaced products will have their position altered in a consistent manner with no gaps.