Retrieve inventory physical count

GET

/v2/inventory/physical-counts/{physical_count_id}

Returns the InventoryPhysicalCount object with the provided physical_count_id.

Permissions:INVENTORY_READ

Try in API Explorer

Link to section

Path parameters

Example code

Link to section

physical_count_id

string

Required

ID of the InventoryPhysicalCount to retrieve.

Link to section

Response fields

Link to section

errors

Any errors that occurred during the request.

Link to section

count

The requested InventoryPhysicalCount.

Link to section

Examples

GET /v2/inventory/physical-counts/{physical_count_id}

curl https://connect.squareup.com/v2/inventory/physical-counts/physical_count_id0 \
  -H 'Square-Version: 2024-11-20' \
  -H 'Authorization: Bearer ACCESS_TOKEN' \
  -H 'Content-Type: application/json'

Response JSON

{
  "errors": [],
  "count": {
    "id": "ANZADNPLKADOJKJIUANKLMLQ",
    "reference_id": "f857ec37-f9a0-4458-8e23-5b5e0bea4e53",
    "catalog_object_id": "W62UWFY35CWMYGVWK6TWJDNI",
    "catalog_object_type": "ITEM_VARIATION",
    "state": "IN_STOCK",
    "location_id": "C6W5YS5QM06F5",
    "quantity": "15",
    "source": {
      "product": "SQUARE_POS",
      "application_id": "416ff29c-86c4-4feb-b58c-9705f21f3ea0",
      "name": "Square Point of Sale 4.37"
    },
    "team_member_id": "LRK57NSQ5X7PUD05",
    "occurred_at": "2016-11-16T22:25:24.878Z",
    "created_at": "2016-11-16T22:25:24.878Z"
  }
}