Sign in
StockTakes

Create a Stocktake

This endpoint creates a stocktake for the given site.

post/inventory/stock-takes

Request body

site_idstring uuid required

Identifier of the site the stocktake is being performed at. All items counted in this stocktake must belong to this site; the caller's API key must have access to it.

location_idstring uuid required

Identifier of the stock location being counted. Counts are recorded against this location, and any variance found creates adjustments at this location only.

descriptionstring required

Free-text label shown in the admin UI and on stocktake reports, used to distinguish this stocktake from others (e.g. "Quarterly retail count Q1 2024"). 1-255 characters.

Example request

{
  "description": "Stocktake started on 01/06/2024"
}

Response

The stocktake was successfully retrieved

Example response

{
  "data": {
    "description": "Stocktake started on 01/06/2024",
    "currency": "gbp",
    "created_by": {
      "first_name": "Dan",
      "last_name": "Johnson",
      "full_name": "Dan Johnson"
    },
    "posted_by": {
      "first_name": "Dan",
      "last_name": "Johnson",
      "full_name": "Dan Johnson"
    },
    "created_at": "2024-06-01T12:00:00Z"
  }
}

Changes