List all variants by product

Returns a list of variants for a given product ID, scoped to the API key company.

get/v1/workflows/product/by-product/{productId}

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

Path parameters

productIdstring required

Product ID

Response

The variants were successfully retrieved.

Example response

{
  "variants": [
    {
      "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"
    }
  ]
}

Changes

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