Get Catalog Product Item Fields sale.basketitem.getFieldsCatalogProduct
Choose a tool for developing with an AI agent:
- use Alaio Vibecode to build an app for Bitrix24 from a task description without knowing any programming language. The agent writes the code and deploys the app to a server, with no manual hosting setup
- use the MCP server to develop a REST API integration in your own project. The agent refers to the official REST documentation
Scope:
saleWho can execute the method: store manager
The method sale.basketitem.getFieldsCatalogProduct retrieves a list of cart item fields for the methods sale.basketitem.addCatalogProduct and sale.basketitem.updateCatalogProduct — these methods only work with products from the catalog module.
The field set is the same as in sale.basketitem.getFields, but most of the fields are marked as read-only. When adding a cart item with sale.basketitem.addCatalogProduct, pass orderId, productId, currency, quantity, price, sort, and xmlId. Once the item is added, sale.basketitem.updateCatalogProduct can change only quantity, price, sort, and xmlId.
No parameters required.
Code Examples
How to Use Examples in Documentation
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/sale.basketitem.getFieldsCatalogProduct
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/sale.basketitem.getFieldsCatalogProduct
// 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 } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
type FieldDescription = {
isImmutable: boolean
isReadOnly: boolean
isRequired: boolean
type: string
}
// Shape of the payload returned in result (match the "response handling" section of the page)
type GetCatalogProductFieldsResult = {
basketItem: Record<string, FieldDescription>
}
try {
const response = await $b24.actions.v2.call.make<GetCatalogProductFieldsResult>({
method: 'sale.basketitem.getFieldsCatalogProduct',
params: {},
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('basketItem fields:', Object.keys(result.basketItem))
}
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
<!-- 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 getCatalogProductFields() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'sale.basketitem.getFieldsCatalogProduct',
params: {},
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('basketItem fields:', Object.keys(result.basketItem))
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', getCatalogProductFields)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.sale.basketitem.get_fields_catalog_product().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}")
try {
$response = $b24Service
->core
->call(
'sale.basketitem.getFieldsCatalogProduct',
[]
);
$result = $response
->getResponseData()
->getResult();
if ($result->error()) {
echo 'Error: ' . $result->error();
} else {
echo 'Success: ' . print_r($result->data(), true);
}
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error getting catalog product fields: ' . $e->getMessage();
}
BX24.callMethod(
"sale.basketitem.getFieldsCatalogProduct",
{},
)
.then(
function(result)
{
if (result.error())
{
console.error(result.error());
}
else
{
console.log(result.data());
}
},
function(error)
{
console.info(error);
}
);
require_once('crest.php');
$result = CRest::call(
'sale.basketitem.getFieldsCatalogProduct',
[]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
// client and ctx are already created — see the Go SDK section
res, err := client.Core().Call(ctx, "sale.basketitem.getFieldsCatalogProduct", nil)
if err != nil {
return fmt.Errorf("sale.basketitem.getFieldsCatalogProduct: %w", err)
}
// The response arrives as json.RawMessage — unmarshal it
// into a struct matching the response shape shown below on this page.
fmt.Printf("%s\n", res.Result)
Response Handling
HTTP Status: 200
The example shows three of the 25 fields.
{
"result": {
"basketItem": {
"basePrice": {
"isImmutable": false,
"isReadOnly": true,
"isRequired": false,
"type": "double"
},
"canBuy": {
"isImmutable": false,
"isReadOnly": true,
"isRequired": false,
"type": "char"
},
"catalogXmlId": {
"isImmutable": false,
"isReadOnly": true,
"isRequired": false,
"type": "string"
}
}
},
"time": {
"start": 1790578169,
"finish": 1790578169.100949,
"duration": 0.10094904899597168,
"processing": 0,
"date_start": "2026-09-28T08:49:29+02:00",
"date_finish": "2026-09-28T08:49:29+02:00",
"operating_reset_at": 1790578769,
"operating": 0
}
}
Returned Data
|
Name |
Description |
|
result |
Root element of the response |
|
basketItem |
Object in the format |
|
time |
Information about the request execution time |
Error Handling
|
Name |
Description |
|
error |
String error code. It consists of digits, Latin letters, and underscores. It may arrive empty — in that case only |
|
error_description |
Error message for the developer. Do not show it to the end user without processing |
Possible Error Codes
|
Code |
Description |
|
|
Insufficient permissions to read |
|
|
Other errors, such as fatal errors |
Statuses and System Error Codes
HTTP Status: 4xx, 5xx
The errors described below are returned by the REST API itself, not by the logic of a specific method. They can arrive in response to any method.
|
Status |
Code |
Description |
|
|
|
An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
The method is blocked because the request resource intensity limit has been exceeded. The block is lifted automatically once the accumulated execution time of the method no longer exceeds the limit |
|
|
|
The request contains no authorization data: neither an access token nor a webhook code was passed |
|
|
|
Methods are called over the HTTPS protocol only |
|
|
|
The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support |
|
|
|
REST API access is not active for this account. In Bitrix24 Cloud, check the current plan or trial status: Vibe+ plans include REST API access, while Essentials plans do not. A webhook receives a different error message — |
|
|
|
No active webhook with the specified user identifier and secret code was found |
|
|
|
No method with this name was found. The name is misspelled, the method does not exist in the REST API, or it is unavailable without the required scope |
|
|
|
The request requires broader permissions than the token has: for a webhook these are the permissions granted to it, for an application it is the scope. For an application, the error message ends with |
|
|
|
The access token has expired |
|
|
|
The application is installed, but the Bitrix24 administrator has granted access to it only to specific users |
|
|
|
The public part of the site is closed. To open it on an on-premise installation, disable the "Temporary closure of the public part of the site" option. Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site |
Continue Learning
- Shopping Cart in Online Store: Overview of Methods
- Add a Custom Item to an Order Cart sale.basketitem.add
- Update an Order Cart Item sale.basketitem.update
- Get a Cart Item sale.basketitem.get
- Get a List of Cart Items sale.basketitem.list
- Remove an Item from an Order Cart sale.basketitem.delete
- Add a Catalog Product Item to an Order Cart sale.basketitem.addCatalogProduct
- Update a Catalog Product Item sale.basketitem.updateCatalogProduct
- Get Cart Item Fields sale.basketitem.getFields