Sign in
StockTakes

List Stocktake Items

This endpoint retrieves a list of all the items for the given stocktake.

get/inventory/stock-takes/{stockTakeId}/items

Path parameters

stockTakeIdstring uuid required

Identifier of the stocktake. Returned from createStockTake; use it to read the stocktake, list or update its items, post the final counts, or poll the async queue for export status.

Query parameters

brand_idsstring[]

A comma-separated list of brand IDs to retrieve stocktake items for.

category_idsstring[]

A comma-separated list of category IDs to retrieve stocktake items for.

supplier_idsstring[]

A comma-separated list of supplier IDs to retrieve stocktake items for.

querystring uuid

A search query to filter stocktake items by. This will search the item name.

status'all' | 'uncounted' | 'counted'

The status to filter the stocktake items by.

pageinteger

The page to retrieve results from

per_pageinteger

The number of results to return per page

Response

The stock take items were successfully retrieved

Example response

{
  "data": [
    {
      "name": "Blissful Body Butter",
      "sku": "BB-001",
      "unit_cost": 2000,
      "counted_quantity": 50.5,
      "expected_quantity": 70.5,
      "adjusted_quantity": 20.5,
      "adjusted_value": 70,
      "created_at": "2024-06-01T00:00:00Z",
      "updated_at": "2024-06-01T00:00:00Z"
    }
  ],
  "meta": {
    "totals": {
      "items": 100,
      "counted": 50,
      "uncounted": 50,
      "adjustment_value": 1000
    },
    "currency": "gbp",
    "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

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