Inventories

Bulk read inventories

Retrieves a list of inventories. Supports filtering by fields, sorting, and pagination.

get/v1/inventories

Request

  • Base URL: https://api.finalpos.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.finalpos.com/v1/inventories
  • Auth: API key in header x-api-key

Query parameters

skipnumber

Number of records to skip (default: 0)

limitnumber

Maximum number of records to return (default: 100, max: 1000)

sortBy'createdAt' | 'updatedAt'

Field name to sort results by

sortOrder'asc' | 'desc'

Sort direction (default: asc)

gtestring date-time
ltestring date-time
gtstring date-time
ltstring date-time

Filter by createdAt using range operators

gtestring date-time
ltestring date-time
gtstring date-time
ltstring date-time

Filter by updatedAt using range operators

productIdstring

Filter by productId

variantIdstring

Filter by variantId

outletIdstring

Filter by outletId

manageStockboolean

Filter by manageStock

Response

Successfully retrieved list of items

Example response

{
  "data": [
    {
      "id": "o1p2q3r4s5t6u7v8w9x0y1z2",
      "createdAt": "2025-12-07T19:31:48.436+00:00",
      "updatedAt": "2025-12-07T19:35:48.436+00:00",
      "companyId": "o1p2q3r4s5t6u7v8w9x0y1z2",
      "productId": "o1p2q3r4s5t6u7v8w9x0y1z2",
      "variantId": "o1p2q3r4s5t6u7v8w9x0y1z2",
      "outletId": "o1p2q3r4s5t6u7v8w9x0y1z2",
      "manageStock": true,
      "quantity": 10
    }
  ],
  "meta": {
    "count": 1450,
    "limit": 100
  }
}

Changes

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