> ## Documentation Index
> Fetch the complete documentation index at: https://docs.qwoty.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Product

> Retrieve a specific product by ID

## Authorization

<ParamField header="Authorization" type="string" required>
  Bearer token for authentication. Format: `Bearer qwoty_your_token`
</ParamField>

## Path Parameters

<ParamField path="id" type="string" required>
  UUID of the product
</ParamField>

## Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl https://qwoty.app/api/products/550e8400-e29b-41d4-a716-446655440000 \
    -H "Authorization: Bearer qwoty_your_token"
  ```

  ```javascript JavaScript theme={null}
  const productId = '550e8400-e29b-41d4-a716-446655440000'

  const response = await fetch(`https://qwoty.app/api/products/${productId}`, {
    headers: {
      Authorization: 'Bearer qwoty_your_token',
    },
  })

  const data = await response.json()
  ```

  ```python Python theme={null}
  import requests

  product_id = '550e8400-e29b-41d4-a716-446655440000'

  response = requests.get(
      f'https://qwoty.app/api/products/{product_id}',
      headers={
          'Authorization': 'Bearer qwoty_your_token'
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

<ResponseField name="success" type="boolean">
  Indicates if the request was successful
</ResponseField>

<ResponseField name="data" type="object">
  The product object

  <Expandable title="Product Object">
    <ResponseField name="id" type="string">
      Unique identifier (UUID)
    </ResponseField>

    <ResponseField name="product_parent_id" type="string">
      ID of parent product (UUID)
    </ResponseField>

    <ResponseField name="workspace_id" type="string">
      Workspace ID (UUID)
    </ResponseField>

    <ResponseField name="name" type="string">
      Product name (display name combining parent + variant options)
    </ResponseField>

    <ResponseField name="api_name" type="string">
      API identifier (creation-only)
    </ResponseField>

    <ResponseField name="reference" type="string">
      Internal reference
    </ResponseField>

    <ResponseField name="description" type="string">
      Product description
    </ResponseField>

    <ResponseField name="description_inherit_from_product" type="boolean">
      Whether to inherit description from parent product
    </ResponseField>

    <ResponseField name="primary_image_inherit_from_product" type="boolean">
      Whether to inherit primary image from parent product
    </ResponseField>

    <ResponseField name="is_active" type="boolean">
      Active status
    </ResponseField>

    <ResponseField name="is_default" type="boolean">
      Whether this is the default product
    </ResponseField>

    <ResponseField name="catalogs" type="array">
      Catalogs linked to the parent product

      <Expandable title="Catalog Entry">
        <ResponseField name="id" type="string">Catalog ID (UUID)</ResponseField>
        <ResponseField name="api_name" type="string">Catalog API name</ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="categories" type="array">
      Categories linked to the parent product

      <Expandable title="Category Entry">
        <ResponseField name="id" type="string">Category ID (UUID)</ResponseField>
        <ResponseField name="api_name" type="string">Category API name</ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="settings" type="object">
      Product settings and configuration

      <Expandable title="Settings Object">
        <ResponseField name="unit_per_pack" type="number">
          Number of units per pack
        </ResponseField>

        <ResponseField name="product_type" type="string">
          Parent product type
        </ResponseField>

        <ResponseField name="language_code" type="string">
          Parent language code (e.g. `en`, `fr`)
        </ResponseField>

        <ResponseField name="unit_of_measure" type="string">
          Parent unit of measure
        </ResponseField>

        <ResponseField name="recurrence_type" type="string">
          Parent recurrence type (`one_off` or `recurring`)
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="shipping" type="object">
      Shipping information

      <Expandable title="Shipping Object">
        <ResponseField name="weight" type="number">
          Shipping weight
        </ResponseField>

        <ResponseField name="weight_unit" type="string">
          Shipping weight unit (kg, lbs)
        </ResponseField>

        <ResponseField name="height" type="number">
          Shipping height
        </ResponseField>

        <ResponseField name="length" type="number">
          Shipping length
        </ResponseField>

        <ResponseField name="width" type="number">
          Shipping width
        </ResponseField>

        <ResponseField name="length_unit" type="string">
          Shipping length unit (cm, in, etc.)
        </ResponseField>

        <ResponseField name="country_of_origin" type="string">
          Country of origin for shipping
        </ResponseField>

        <ResponseField name="harmonized_system_code" type="string">
          HS code for customs
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="inventory" type="object">
      Inventory information

      <Expandable title="Inventory Object">
        <ResponseField name="sku" type="string">
          Stock Keeping Unit
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="identifiers" type="object">
      External system identifiers

      <Expandable title="Identifiers Object">
        <ResponseField name="crm" type="string">
          External CRM ID
        </ResponseField>

        <ResponseField name="accounting" type="string">
          External accounting ID
        </ResponseField>

        <ResponseField name="erp" type="string">
          External ERP ID
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="accounting" type="object">
      Accounting information

      <Expandable title="Accounting Object">
        <ResponseField name="ledger_account" type="string">
          Ledger account code
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="primary_image_id" type="string">
      UUID of the primary media for this product. Null if none is set.
      When `primary_image_inherit_from_product` is `true` and this field is null,
      use `parent_primary_image_id` as the effective image.
    </ResponseField>

    <ResponseField name="parent_primary_image_id" type="string">
      UUID of the primary media of the parent product. Read-only.
      Useful when `primary_image_inherit_from_product` is `true`.
    </ResponseField>

    <ResponseField name="options" type="array">
      Variant option values (e.g., color, size)

      <Expandable title="Option Object">
        <ResponseField name="option_id" type="string">
          Option definition ID
        </ResponseField>

        <ResponseField name="option_name" type="string">
          Option name (e.g., "Color")
        </ResponseField>

        <ResponseField name="option_api_name" type="string">
          Option API name
        </ResponseField>

        <ResponseField name="value_id" type="string">
          Option value ID
        </ResponseField>

        <ResponseField name="value_name" type="string">
          Option value (e.g., "Blue")
        </ResponseField>

        <ResponseField name="value_api_name" type="string">
          Value API name
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="prices" type="array">
      Prices associated with this product across all pricebooks

      <Expandable title="Price Entry">
        <ResponseField name="id" type="string">Price ID (UUID)</ResponseField>
        <ResponseField name="pricebook_id" type="string">Pricebook ID (UUID)</ResponseField>
        <ResponseField name="pricebook_api_name" type="string">API name of the pricebook</ResponseField>

        <ResponseField name="pricing_model" type="string">
          Pricing model (`flat`, `volume`, `graduated`, `percent`, `cost_based`, `none`)
        </ResponseField>

        <ResponseField name="amount" type="number | null">
          Unit price. Only populated when `pricing_model` is `flat`, otherwise `null`.
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="created_at" type="string">
      ISO 8601 timestamp
    </ResponseField>

    <ResponseField name="updated_at" type="string">
      ISO 8601 timestamp
    </ResponseField>

    <ResponseField name="created_by" type="string">
      User ID who created the product
    </ResponseField>

    <ResponseField name="updated_by" type="string">
      User ID who last updated the product
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseExample>
  ```json Success Response theme={null}
  {
    "success": true,
    "data": {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "product_parent_id": "660e8400-e29b-41d4-a716-446655440001",
      "workspace_id": "880e8400-e29b-41d4-a716-446655440003",
      "name": "Consulting Services - Senior",
      "api_name": "consulting_services_senior",
      "reference": "SERV-001",
      "description": "Senior consultant hourly rate",
      "description_inherit_from_product": true,
      "primary_image_inherit_from_product": true,
      "is_active": true,
      "is_default": true,
      "catalogs": [
        {
          "id": "770e8400-e29b-41d4-a716-446655440002",
          "api_name": "catalog_main"
        }
      ],
      "categories": [],
      "settings": {
        "unit_per_pack": 1,
        "product_type": "service",
        "language_code": "en",
        "unit_of_measure": "hour",
        "recurrence_type": "recurring"
      },
      "shipping": {
        "weight": null,
        "weight_unit": null,
        "height": null,
        "length": null,
        "width": null,
        "length_unit": null,
        "country_of_origin": null,
        "harmonized_system_code": null
      },
      "inventory": {
        "sku": "CONS-SEN-001"
      },
      "identifiers": {
        "crm": "crm_123",
        "accounting": "acc_789",
        "erp": "erp_456"
      },
      "accounting": {
        "ledger_account": "4010"
      },
      "primary_image_id": "cc0e8400-e29b-41d4-a716-446655440020",
      "parent_primary_image_id": "dd0e8400-e29b-41d4-a716-446655440021",
      "options": [
        {
          "option_id": "aa0e8400-e29b-41d4-a716-446655440010",
          "option_name": "Seniority",
          "option_api_name": "seniority",
          "value_id": "bb0e8400-e29b-41d4-a716-446655440011",
          "value_name": "Senior",
          "value_api_name": "senior"
        }
      ],
      "prices": [
        {
          "id": "ee0e8400-e29b-41d4-a716-446655440030",
          "pricebook_id": "ff0e8400-e29b-41d4-a716-446655440031",
          "pricebook_api_name": "standard",
          "pricing_model": "flat",
          "amount": 1990
        }
      ],
      "created_at": "2024-12-21T10:30:00Z",
      "updated_at": "2024-12-21T10:30:00Z",
      "created_by": "aa1e8400-e29b-41d4-a716-446655440099",
      "updated_by": "aa1e8400-e29b-41d4-a716-446655440099"
    }
  }
  ```
</ResponseExample>

## Error Responses

<ResponseExample>
  ```json Not Found theme={null}
  {
    "success": false,
    "error": "Product not found"
  }
  ```

  ```json Unauthorized theme={null}
  {
    "success": false,
    "error": "Invalid API token"
  }
  ```

  ```json Invalid ID Format theme={null}
  {
    "success": false,
    "error": "Invalid product ID format"
  }
  ```
</ResponseExample>

## Notes

This endpoint provides direct access to a product using only the product ID.

For accessing products through their parent product, you can also use:

* `GET /api/product-parents/{id}/products/{product_id}`