Skip to content

catalog-product-property-get.md

Latest commit

 

History

History
362 lines (302 loc) · 9.76 KB

catalog-product-property-get.md

File metadata and controls

362 lines (302 loc) · 9.76 KB
Raw

Get Values of Product or Variation Property Fields catalog.productProperty.get

{% note tip "" %}

If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the MCP server so that the assistant can utilize the official REST documentation.

{% endnote %}

Scope: catalog

Who can execute the method: user with permission to view the catalog

The method catalog.productProperty.get returns the values of the product or variation property fields.

Method Parameters

{% include Note on required parameters %}

#| || Name type | Description || || id* catalog_product_property.id | Identifier of the property.

Property identifiers can be obtained using the catalog.productProperty.list method || |#

Code Examples

{% include Note on examples %}

{% list tabs %}

  • cURL (Webhook)

    curl -X POST \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{"id":659}' \
  https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/catalog.productProperty.get

  • cURL (OAuth)

    curl -X POST \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{"id":659,"auth":"**put_access_token_here**"}' \
  https://**put_your_bitrix24_address**/rest/catalog.productProperty.get

  • JS (TS)

    // This snippet is an ES module: top-level await requires type="module" or a bundler.
// $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame, ISODate } from '@bitrix24/b24jssdk'

declare const $b24: B24Frame

// Shape of the payload returned in result (match the "response handling" section of the page)
type GetProductPropertyResult = {
  productProperty: {
    active: string
    code: string
    colCount: number
    defaultValue: string | null
    fileType: string | null
    filtrable: string
    hint: string | null
    iblockId: number
    id: number
    isRequired: string
    linkIblockId: number | null
    listType: string
    multiple: string
    multipleCnt: number | null
    name: string
    propertyType: string
    rowCount: number
    searchable: string
    sort: number | null
    timestampX: ISODate | null
    userType: string
    userTypeSettings: {
      group: string
      multiple: string
      size: number
      tableName: string
      width: number
    }
    withDescription: string | null
    xmlId: string | null
  }
}

try {
  const response = await $b24.actions.v2.call.make<GetProductPropertyResult>({
    method: 'catalog.productProperty.get',
    params: {
      id: 659,
    },
    requestId: Text.getUuidRfc4122()
  })

  // The payload is available only on a successful response
  if (!response.isSuccess) {
    console.error(response.getErrorMessages().join('; '))
  } else {
    const result = response.getData()!.result
    console.info(result.productProperty.id, result.productProperty.name, result.productProperty.propertyType)
  }
} catch (error) {
  // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
  console.error(error)
}

  • JS (UMD)

    <!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
  async function getProductProperty() {
    try {
      // Initialize the SDK inside a Bitrix24 frame
      const $b24 = await B24Js.initializeB24Frame()

      const response = await $b24.actions.v2.call.make({
        method: 'catalog.productProperty.get',
        params: {
          id: 659,
        },
        requestId: B24Js.Text.getUuidRfc4122()
      })

      // The payload is available only on a successful response
      if (!response.isSuccess) {
        console.error(response.getErrorMessages().join('; '))
        return
      }

      const result = response.getData().result
      console.info(result.productProperty.id, result.productProperty.name, result.productProperty.propertyType)
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

  document.addEventListener('DOMContentLoaded', getProductProperty)
</script>

  • Python

    from b24pysdk.errors import BitrixAPIError, BitrixSDKException

try:
    bitrix_response = client.catalog.product_property.get(
        bitrix_id=659,
    ).response
    result = bitrix_response.result
    print(result)
except BitrixAPIError as error:
    print(
        "Bitrix API error",
        f"error: {error.error}",
        f"error_description: {error.error_description}",
        sep="\n",
    )
except BitrixSDKException as error:
    print(f"Bitrix SDK error: {error.message}")
except Exception as error:
    print(f"Unexpected error: {error}")

  • PHP

    try {
    $response = $b24Service
        ->core
        ->call(
            'catalog.productProperty.get',
            [
                'id' => 659,
            ]
        );

    print_r($response->getResponseData()->getResult());
} catch (\Throwable $exception) {
    echo $exception->getMessage();
}

  • BX24.js

    BX24.callMethod(
    'catalog.productProperty.get',
    {
        id: 659
    },
    function(result) {
        if (result.error()) {
            console.error(result.error());
        } else {
            console.log(result.data());
        }
    }
);

  • PHP CRest

    require_once('crest.php');

$result = CRest::call(
    'catalog.productProperty.get',
    ['id' => 659]
);

print_r($result);

  • Go

    // client and ctx are already created — see the Go SDK section
res, err := client.Core().Call(ctx, "catalog.productProperty.get", b24.Params{
	"id": 659,
}, b24.WithIdempotent())
if err != nil {
	return fmt.Errorf("catalog.productProperty.get: %w", err)
}

// The method wraps the response in an object with the "productProperty" key.
raw, ok := b24.Unwrap(res.Result, "productProperty")
if !ok {
	return fmt.Errorf("no productProperty key in the response")
}

var item struct {
	Active    string `json:"active"`
	Code      string `json:"code"`
	ColCount  int    `json:"colCount"`
	Filtrable string `json:"filtrable"`
	IblockID  b24.ID `json:"iblockId"`
	ID        b24.ID `json:"id"`
}
if err := json.Unmarshal(raw, &item); err != nil {
	return fmt.Errorf("parse response: %w", err)
}
fmt.Println(item.Active, item.Code)

{% endlist %}

Response Handling

HTTP Status: 200

{
    "result": {
        "productProperty": {
            "active": "Y",
            "code": "s12",
            "colCount": 30,
            "defaultValue": null,
            "fileType": null,
            "filtrable": "N",
            "hint": null,
            "iblockId": 19,
            "id": 659,
            "isRequired": "N",
            "linkIblockId": null,
            "listType": "L",
            "multiple": "N",
            "multipleCnt": null,
            "name": "Category",
            "propertyType": "S",
            "rowCount": 1,
            "searchable": "N",
            "sort": null,
            "timestampX": "2026-03-19T21:23:02+02:00",
            "userType": "directory",
            "userTypeSettings": {
                "group": "N",
                "multiple": "N",
                "size": 1,
                "tableName": "b_hlbd_categories",
                "width": 0
            },
            "withDescription": null,
            "xmlId": null
        }
    },
    "time": {
        "start": 1773950078,
        "finish": 1773950078.362409,
        "duration": 0.3624091148376465,
        "processing": 0,
        "date_start": "2026-03-19T22:54:38+02:00",
        "date_finish": "2026-03-19T22:54:38+02:00",
        "operating_reset_at": 1773950678,
        "operating": 0
    }
}

Returned Data

#| || Name type | Description || || result object | Root object of the response || || productProperty catalog_product_property | Object containing information about the product or variation property || || time time | Information about the request execution time || |#

Error Handling

HTTP Status: 400

{
    "error": "",
    "error_description": "productProperty does not exist."
}

{% include notitle error handling %}

Possible Error Codes

#| || Status | Code | Description | Value || || 400 | 0 | Access Denied | Insufficient rights to view the catalog || || 400 | Empty value | productProperty does not exist | Property with the specified id not found ||

|#

{% include system errors %}

Continue Learning