Variants

Bulk read variants

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

get/v1/variants

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/variants
  • 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' | 'barcode' | 'price' | 'salePrice' | 'costPrice'

Field name to sort results by

sortOrder'asc' | 'desc'

Sort direction (default: asc)

searchByBarcodestring

Field name to search by (case-insensitive partial match)

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

isOnSaleboolean

Filter by isOnSale

notSoldInPosboolean

Filter by notSoldInPos

notSoldOnlineboolean

Filter by notSoldOnline

unitIdstring

Filter by unitId

stockVariantIdstring

Filter by stockVariantId

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",
      "sku": "1234567890",
      "isOnSale": true,
      "barcode": "1234567890",
      "price": 10000,
      "salePrice": 9000,
      "externalId": "1234567890",
      "allowBackorder": true,
      "costPrice": 8000,
      "images": [
        "https://example.com/image1.jpg",
        "https://example.com/image2.jpg"
      ],
      "currency": "USD",
      "minorUnits": 2,
      "metadata": [
        {
          "key": "key1",
          "value": "value1"
        },
        {
          "key": "key2",
          "value": "value2"
        }
      ],
      "attributes": [
        {
          "name": "color",
          "value": "red"
        }
      ],
      "unitId": "KGM",
      "stockVariantId": "68d4a2c7b1e35f9a4c67a101"
    }
  ],
  "meta": {
    "count": 1450,
    "limit": 100
  }
}

Changes

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