Product

Get a product by ID

Retrieves a single product by its unique identifier.

get/v1/product/{id}

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/product/{id}
  • Auth: API key in header x-api-key

Path parameters

idstring required

Product ID

Response

The product has been successfully retrieved.

idstring

Unique identifier for the Product.

createdAtstring date-time

Timestamp when the Product was created.

updatedAtstring date-time

Timestamp when the Product was last updated.

companyIdstring

Company ID associated with the Product.

namestring

Name of the product.

productTypestring

Type of the product. (simple or variable)

sourcestring

Source of the product.

externalIdstring

External ID of the product.

descriptionstring

Description of the product.

shortDescriptionstring

Short description of the product.

skustring

SKU of the product.

imagesstring[]

Images of the product.

tagsstring[]

Tags of the product.

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

Status of the product.

notSoldInPosboolean

Not sold on its own at the POS (till, flows). Missing = sold. Both flags set = Unlisted.

notSoldOnlineboolean

Not sold online (web shop, public API orders). Missing = sold. Both flags set = Unlisted.

minPricenumber

Min price of the product in the lowest currency unit.

maxPricenumber

Max price of the product in the lowest currency unit.

supplierstring

Supplier of the product.

taxTablestring

Tax table of the product.

bookingRulesIdstring

Booking rule set of the product (productType "booking" only). Reusable, referenced the way taxTable is.

defaultVariantIdstring

Default variant of the product. Must be one of its own variants.

categoriesstring[]

Categories of the product.

currency'USD' | 'EUR' | 'GBP' | 'CAD' | 'AUD' | 'NZD' | 'CHF' | 'CNY' | 'INR' | 'MXN' | 'BRL' | 'ZAR' | 'SGD' | 'HKD' | 'SEK' | 'NOK' | 'DKK' | 'PLN' | 'THB' | 'MYR' | 'PHP' | 'IDR' | 'AED' | 'SAR' | 'ILS' | 'TRY' | 'RUB' | 'HTG' | 'BND' | 'CRC' | 'BDT' | 'UAH' | 'NGN' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BGN' | 'BMD' | 'BOB' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'COP' | 'CZK' | 'DOP' | 'DZD' | 'EGP' | 'ETB' | 'FJD' | 'GEL' | 'GHS' | 'GTQ' | 'GYD' | 'HNL' | 'IRR' | 'JMD' | 'KES' | 'KGS' | 'KHR' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'MAD' | 'MDL' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MUR' | 'MVR' | 'MZN' | 'NAD' | 'NIO' | 'NPR' | 'PAB' | 'PEN' | 'PGK' | 'PKR' | 'QAR' | 'RON' | 'RSD' | 'SBD' | 'SRD' | 'SYP' | 'TJS' | 'TMT' | 'TOP' | 'TTD' | 'TZS' | 'UYU' | 'UZS' | 'VES' | 'WST' | 'XCD' | 'YER' | 'ZMW' | 'CDF' | 'CUP' | 'ERN' | 'FKP' | 'GIP' | 'GMD' | 'KPW' | 'LRD' | 'LSL' | 'MGA' | 'MWK' | 'SCR' | 'SDG' | 'SHP' | 'SLE' | 'SOS' | 'SSP' | 'STN' | 'SZL' | 'VED' | 'XCG' | 'JPY' | 'KRW' | 'VND' | 'CLP' | 'ISK' | 'HUF' | 'TWD' | 'GNF' | 'BIF' | 'DJF' | 'KMF' | 'PYG' | 'RWF' | 'UGX' | 'VUV' | 'XAF' | 'XOF' | 'XPF' | 'KWD' | 'BHD' | 'OMR' | 'JOD' | 'TND' | 'LYD' | 'IQD'

Currency of the Product. ISO 4217 currency code.

minorUnitsnumber

The Minor Units of the Product to convert the amount from minor units to major units.

barcodestring

Barcode of the product.

Example response

{
  "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"
}

Changes

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