Create Inventory Count | Ply | API Documentation

curl -X POST https://api.getply.com/api/v1/inventory-counts \
     -H "API_KEY: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "locationId": "c3d4e5f6-a7b8-9012-cdef-123456789012",
  "startDate": "2026-03-15",
  "dueDate": "2026-03-22",
  "assignedUserIds": [
    "e1f2a3b4-c5d6-7890-efab-901234567890"
  ]
}'

{
  "id": "a3b4c5d6-e7f8-9012-abcd-ef3456789012",
  "status": "NOT_STARTED",
  "period": 1,
  "active": true,
  "canceled": false,
  "assignedUserIds": [
    "e1f2a3b4-c5d6-7890-efab-901234567890"
  ],
  "createdAt": "2026-03-20T14:30:00Z",
  "updatedAt": "2026-03-20T14:30:00Z",
  "location": {
    "id": "c3d4e5f6-a7b8-9012-cdef-123456789012",
    "name": "Main Warehouse"
  },
  "startDate": "2026-03-15",
  "dueDate": "2026-03-22"
}

Creates a new inventory count session for a location.

Requires scope: inventory_counts:write

Authentication

API_KEYstring

API Key authentication via header

Request

This endpoint expects an object.

locationIdUUIDRequired

ID of the location to count. Required.

startDatedateRequired

Scheduled start date (ISO 8601, e.g. 2026-03-15). Required.

dueDatedateRequired

Due date for completing the count (ISO 8601, e.g. 2026-03-22). Required.

assignedUserIdslist of UUIDsOptional

IDs of users to assign to this count session.

Response

This endpoint returns an object.

idUUID

Unique identifier for the inventory count.

statusenum

Current status of the count session.

periodinteger

Count period number (e.g. cycle or iteration index).

activeboolean

Whether the count session is currently active.

canceledboolean

Whether the count session has been cancelled.

assignedUserIdslist of UUIDs

IDs of users assigned to this count session.

createdAtdatetime

ISO 8601 timestamp when the session was created.

updatedAtdatetime

ISO 8601 timestamp when the session was last updated.

locationobject

Reference to the location being counted.

startDatedate

Scheduled start date for the count (ISO 8601 date, e.g. 2026-03-15).

dueDatedate

Due date for completing the count (ISO 8601 date, e.g. 2026-03-22).

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error