---
title: "Get stocktaking information"
method: GET
path: "/shops/{SHOP_ID}/stocktakings/{STOCKTAKING_ID}"
tags: ["Stocktaking"]
---

# Get stocktaking information

`GET /shops/{SHOP_ID}/stocktakings/{STOCKTAKING_ID}`

## Request

- Base URL: `https://pos.pages.fm/api/v1`
- URL: `https://pos.pages.fm/api/v1/shops/{SHOP_ID}/stocktakings/{STOCKTAKING_ID}`
- Auth: API key in query parameter `api_key`

Get stocktaking information

## Path parameters

- `SHOP_ID` integer, required
- `STOCKTAKING_ID` string, required

## Response `200`

Success

- object
  - `data` Stocktaking: Stocktaking information
    - `id` string: Stocktaking ID
    - `display_id` integer: Stocktaking ID
    - `status` -2 | -1 | 0 | 1 | 2: Status
    - `warehouse_id` string: Warehouse ID
    - `stocktaking_by` string: Stocktaking by
    - `stocktaking_by_value` string[]: Category ID / Supplier products ID / Brand ID
    - `stocktaking_at` string, date-time: Stocktaking at
    - `progress` integer: Processing percentage
    - `note` string: Note
    - `items` object[]: List of products
      - `id` string: Stocktaking item ID
      - `variation_id` string: Variation ID
      - `changed_quantity` integer: Changed quantity
      - `current_quantity` integer: Current quantity
      - `note` string: Note
      - `variation` object: Variation information
        - `id` string
        - `display_id` string
        - `barcode` string
        - `product_id` string
        - `retail_price` integer
        - `last_imported_price` integer
        - `weight` integer
        - `fields` object[]
        - `images` string[]
        - `product` object
          - `display_id` string
          - `name` string
          - `image` string, uri
          - `note_product` string
          - `note` string: Internal note
      - `inserted_at` string, date-time: Inserted at
      - `updated_at` string, date-time: Updated at
    - `shop_id` integer: Shop ID
    - `creator_id` string: Creator ID
    - `inserted_at` string, date-time: Inserted at
    - `updated_at` string, date-time: Updated at
    - `updated_status_at` string, date-time: Updated status at
  - `success` boolean: Success status

---

[API](https://skmtc.dev/pancake/apis/pancake-pos-open-api.md) - [All operations](https://skmtc.dev/pancake/apis/pancake-pos-open-api/llms.txt) - [OpenAPI document](https://skmtc.dev/pancake/apis/pancake-pos-open-api/revisions/3df28d1fb5dc?raw)