Change a sales order's rank

Moves one or more sales orders to an exact place in the sales order list.

The sales orders in order_ids are placed as one consecutive block, in the order given, at the place set in place. The first id ends up highest in the list. All other sales orders keep their order relative to each other.

before_id places them directly above that sales order, and after_id directly below it. Sending the same request again changes nothing, so a request can be retried safely.

Only open sales orders can be reranked. A sales order moves together with its linked manufacturing orders.

To rerank more than 250 sales orders, send them in batches: the first batch with place.position set to top, each next batch with place.after_id set to the last id in the previous response's order_ids.

Sales order lists show the new order shortly after the request returns.

The request returns 422 when any of the sales orders, including the one in before_id or after_id, doesn't exist or is not open, or when before_id or after_id is one of order_ids.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

The sales orders to move and where to put them

order_ids
array of integers, unique
required
length between 1 and 250

IDs of the sales orders to move, in the order they should appear, highest first. 1 to 250 unique IDs.

order_ids*
place
object
required

Where to put the sales orders. Set exactly one of position, before_id or after_id.

Responses

Language
Credentials
Bearer
LoadingLoading…
Response
Choose an example:
application/json