Get variant with parent product

Returns the variant and its parent product in a single response, scoped to the API key company. Equivalent to composing GET /variant/:id and GET /product/:productId.

get/v1/workflows/product/{variantId}

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

Path parameters

variantIdstring required

Variant ID

Response

The variant and its parent product were successfully retrieved.

Example response

{
  "variant": {
    "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"
  },
  "product": {
    "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.