Products

Bulk read products

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

get/v1/products

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/products
  • 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' | 'name' | 'sku' | 'status' | 'barcode'

Field name to sort results by

sortOrder'asc' | 'desc'

Sort direction (default: asc)

searchByNamestring

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

searchByDescriptionstring

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

searchByShortDescriptionstring

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

productTypestring

Filter by productType

sourcestring

Filter by source

tagsstring

Filter by tags. Supports comma-separated values for matching any item in the array

status'active' | 'inactive' | 'draft'

Filter by status. Allowed values: active, inactive, draft

notSoldInPosboolean

Filter by notSoldInPos

notSoldOnlineboolean

Filter by notSoldOnline

gtenumber
ltenumber
gtnumber
ltnumber

Filter by minPrice using range operators

gtenumber
ltenumber
gtnumber
ltnumber

Filter by maxPrice using range operators

supplierstring

Filter by supplier

taxTablestring

Filter by taxTable

bookingRulesIdstring

Filter by bookingRulesId

defaultVariantIdstring

Filter by defaultVariantId

categoriesstring

Filter by categories. Supports comma-separated values for matching any item in the array

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",
      "name": "Sweet Tea",
      "productType": "simple",
      "source": "woo-commerce",
      "externalId": "1234567890",
      "description": "Sweet Tea is a refreshing drink made with tea and sugar.",
      "shortDescription": "Sweet Tea is a drink with sugar.",
      "sku": "1234567890",
      "images": [
        "https://example.com/image1.jpg",
        "https://example.com/image2.jpg"
      ],
      "tags": [
        "sweet",
        "tea",
        "refreshing"
      ],
      "status": "active",
      "minPrice": 100,
      "maxPrice": 200,
      "supplier": "Supplier 1",
      "taxTable": "o1p2q3r4s5t6u7v8w9x0y1z2",
      "bookingRulesId": "o1p2q3r4s5t6u7v8w9x0y1z2",
      "defaultVariantId": "o1p2q3r4s5t6u7v8w9x0y1z2",
      "categories": [
        "o1p2q3r4s5t6u7v8w9x0y1z2",
        "o1p2q3r4s5t6u7v8w9x0y1z3"
      ],
      "currency": "USD",
      "minorUnits": 2,
      "metadata": [
        {
          "key": "key1",
          "value": "value1"
        },
        {
          "key": "key2",
          "value": "value2"
        }
      ],
      "attributes": [
        {
          "name": "color",
          "values": [
            "red",
            "blue"
          ]
        }
      ],
      "barcode": "1234567890"
    }
  ],
  "meta": {
    "count": 1450,
    "limit": 100
  }
}

Changes

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