Stock movements

List stock movements

Every change of a stock balance at the location, oldest first, including sales at the point of sale. The list can be followed: keep the id of the last movement you have read and pass it as after to get what has happened since. A movement appears in the list about ten seconds after it is made.

get/v1/locations/{locationId}/stock-movements

Request

  • Base URL: https://api.cliento.com
  • URL: https://api.cliento.com/v1/locations/{locationId}/stock-movements
  • Auth: HTTP bearer

Path parameters

locationIdstring required

Query parameters

limitinteger

Page size, 1 to 200. Default 50.

afterstring

Only movements made after this one: a nextCursor or the id of any movement.

productIdstring

Only this product's movements.

colourBarItemIdstring

Only this colour bar item's movements.

typestring

Only movements of this type.

externalReferencestring

Only movements with this external reference.

Response

OK

nextCursorstring

Pass as after to fetch the next page. Absent when there is nothing more yet; to follow new movements, call again later with the id of the last movement you have read.

Example response

{
  "data": [
    {
      "balanceAfter": 505,
      "colourBarItemId": "cbi_3Vn8Kq5TzL1xWc7PdM2RbJ",
      "colourBarMixId": "cbm_8Wq3Nd6HtY1mKx4LcP9RvB",
      "comment": "Colour for Anna, 14:00",
      "correctedByMovementId": "mov_6Wr3tYu8Io1Pa4Sd7FgHjK",
      "correctsMovementId": "mov_9Bd2fHk4Mn7Pq1Sv6XzCtA",
      "createdAt": "2026-10-11T09:24:31.512Z",
      "externalReference": "visit-88213",
      "id": "mov_3Lp6vRt9Yx2Kc5Ng8QwEzH",
      "listValue": "304.00",
      "productId": "prd_5Tg8mPq1Xc7Jd2Ls9WbNrK",
      "quantity": -2,
      "reason": "consumption",
      "residue": 3,
      "staffId": "stf_7Qm2xLd9Kc4Vb1Ts8HpWzE",
      "type": "withdrawal"
    }
  ],
  "nextCursor": "mov_3Lp6vRt9Yx2Kc5Ng8QwEzH"
}

Changes

No recorded changes to this operation across all 1 revision of this API.