Sign in
StockTakes

List Stocktakes

This endpoint retrieves a list of all the stocktakes for the given site.

get/inventory/stock-takes

Query parameters

site_idstring uuid required

Filter stocktakes by site.

pageinteger

The page to retrieve results from

per_pageinteger

The number of results to return per page

Response

The stocktakes were 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"
    }
  ],
  "meta": {
    "from": 1,
    "to": 2,
    "total": 2,
    "current_page": 1,
    "last_page": 2,
    "per_page": 15,
    "path": "http://example.com/api"
  },
  "links": {
    "first": "http://example.com?page=1",
    "next": "https://example.com?page=3",
    "prev": "https://example.com?page=1",
    "last": "https://example.com?page=4"
  }
}

Changes