Revert an order one step

Steps an order one step BACK along the forward lifecycle — the safe undo for a mis-click: fulfilled → accepted, accepted → captured (clearing the fulfilling store), or rejected → captured (routing found no store able to serve; re-open it so it can be routed again once stock lands). Takes no body; the order id comes from the PATH. Failure conditions: 404 for an unknown order; 422 for a status that cannot be stepped back (a captured order at the start, or a terminal cancelled one).

POST /v1/orders/{id}/revert

Error

A valid request URL is required to generate request examples

200

{
  "id": "WEB-24810",
  "channel": "web",
  "deliveryMode": "click-and-collect",
  "customer": {
    "customerId": "cust-24810",
    "displayName": "Camille Laurent"
  },
  "lines": [
    {
      "skuId": "f139995b359e2702f33b391acb3d42a419197a7b2c09d04c1fe6d97ecefe4feb",
      "quantity": 1,
      "unitPriceCents": 11900
    }
  ],
  "status": "accepted",
  "fulfillingStoreId": "store-lyon",
  "routingExplanation": {
    "basis": "criterion",
    "criterionIndex": 0,
    "criterionKind": "stock-depth",
    "runnerUpStoreId": "store-rivoli"
  },
  "actorId": "user-camille",
  "capturedAt": "2026-07-28T10:00:00.000Z"
}

Authorizations

Authorization · string · header · required

Authorization: Bearer <token>. Accepts EITHER a Keycloak access token (scopes-in-token) OR an opaque POS session token; both resolve to the same pos.* scope vocabulary the route guards enforce.

Path Parameters

id · string · required

Id of the order (commande) to read or transition.

Minimum string length: 1

Response

200

application/json

The order after the single step back.

The order after the single step back.

id · string · required

channel · enum<string> · required

Available options: web, marketplace, mobile-app, in-store

deliveryMode · enum<string> · required

Available options: click-and-collect, ship-from-store, endless-aisle

customer · object · required

Show child attributes

lines · object[] · required

Show child attributes

status · enum<string> · required

Available options: captured, accepted, fulfilled, cancelled, rejected

fulfillingStoreId · string | null · required

routingExplanation · object | null · required

Show child attributes

actorId · string · required

capturedAt · string · required