Inventory Count

The inventory count resource.

Basehttps://rest.carbon.ms/inventoryCount

GET/inventoryCount

List inventory counts

Retrieve a paginated list of inventory counts. Filter, order, and select columns with PostgREST query parameters.

Query parameters

selectstring

Comma-separated columns to return. Defaults to all.

orderstring

Column to sort by, e.g. `createdAt.desc`.

limitinteger

Maximum rows to return.

offsetinteger

Rows to skip, for pagination.

GEThttps://rest.carbon.ms/inventoryCount

curl --request GET \
  --url 'https://rest.carbon.ms/inventoryCount?select=*&limit=10' \
  --header 'Authorization: Bearer <api-key>'

Response

[
  {
    "id": "abc123def456",
    "companyId": "xyz789",
    "inventoryCountId": "xyz789",
    "locationId": "xyz789",
    "status": "string",
    "isBlind": true,
    "createdBy": "string",
    "createdAt": "2026-01-01T00:00:00Z"
  }
]

GET/inventoryCount

Retrieve a inventory count

Fetch a single inventory count by filtering on `id`.

Query parameters

idstring

Match on the inventory count's `id`, e.g. `eq.{id}`.

GEThttps://rest.carbon.ms/inventoryCount

curl --request GET \
  --url 'https://rest.carbon.ms/inventoryCount?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'

Response

{
  "id": "abc123def456",
  "companyId": "xyz789",
  "inventoryCountId": "xyz789",
  "locationId": "xyz789",
  "status": "string",
  "isBlind": true,
  "createdBy": "string",
  "createdAt": "2026-01-01T00:00:00Z"
}

POST/inventoryCount

Create a inventory count

Create a new inventory count.

Body parameters

inventoryCountIdstringrequired

locationIdstringrequired

References location.id

statusinventoryCountStatusrequired

isBlindbooleanrequired

scopeobject

snapshotAttimestamp

notesstring

postedBystring

References user.id

postedAttimestamp

customFieldsobject

POSThttps://rest.carbon.ms/inventoryCount

curl --request POST \
  --url https://rest.carbon.ms/inventoryCount \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"inventoryCountId":"xyz789","locationId":"xyz789","status":"string","isBlind":true}'

Response

{
  "id": "abc123def456",
  "companyId": "xyz789",
  "inventoryCountId": "xyz789",
  "locationId": "xyz789",
  "status": "string",
  "isBlind": true,
  "createdBy": "string",
  "createdAt": "2026-01-01T00:00:00Z"
}

PATCH/inventoryCount

Update a inventory count

Update an existing inventory count, matched on `id`.

Body parameters

inventoryCountIdstringrequired

locationIdstringrequired

References location.id

statusinventoryCountStatusrequired

isBlindbooleanrequired

scopeobject

snapshotAttimestamp

notesstring

postedBystring

References user.id

postedAttimestamp

customFieldsobject

PATCHhttps://rest.carbon.ms/inventoryCount

curl --request PATCH \
  --url 'https://rest.carbon.ms/inventoryCount?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"inventoryCountId":"xyz789"}'

Response

{
  "id": "abc123def456",
  "companyId": "xyz789",
  "inventoryCountId": "xyz789",
  "locationId": "xyz789",
  "status": "string",
  "isBlind": true,
  "createdBy": "string",
  "createdAt": "2026-01-01T00:00:00Z"
}

DELETE/inventoryCount

Delete a inventory count

Delete a inventory count, matched on `id`. Returns 204 No Content.

Query parameters

idstring

The `id` of the inventory count to delete, e.g. `eq.{id}`.

DELETEhttps://rest.carbon.ms/inventoryCount

curl --request DELETE \
  --url 'https://rest.carbon.ms/inventoryCount?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'

204 No Content