Get Product Variation Field Values catalog.product.offer.get
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:
catalogWho can execute the method: a user with permission to read the variation in the information block and one of the permissions: "View product catalog", "View catalog products", or "Edit selling price"
The method catalog.product.offer.get returns the values of all fields and properties of a product variation by its identifier.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
Identifier of the variation. You can retrieve variation identifiers using the catalog.product.offer.list method |
If you pass the identifier of a product rather than a variation in id, the method returns an empty array {"offer": []} without an error.
The method does not return variation prices. To retrieve prices, use the catalog.price.* methods.
Code Examples
How to Use Examples in Documentation
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":7695}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/catalog.product.offer.get
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":7695,"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/catalog.product.offer.get
// 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
type OfferProperty = {
value: string
valueId: string
valueEnum?: string
}
type OfferFile = {
id: string
url: string
urlMachine: string
}
// Shape of the offer returned in result (match the "response handling" section of the page)
type Offer = {
id: number
iblockId: number
name: string
active: string
code: string | null
xmlId: string
sort: number | null
type: number
available: string
parentId: OfferProperty | null
quantity: number | null
purchasingPrice?: string | null
purchasingCurrency?: string | null
previewPicture: OfferFile | null
detailPicture: OfferFile | null
dateCreate: ISODate
timestampX: ISODate
[key: `property${number}`]: OfferProperty | OfferProperty[] | null
}
try {
const response = await $b24.actions.v2.call.make<{ offer: Offer }>({
method: 'catalog.product.offer.get',
params: {
id: 7695,
},
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('Offer:', result.offer.id, result.offer.name, result.offer.parentId?.value)
}
} 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 getOffer() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'catalog.product.offer.get',
params: {
id: 7695,
},
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('Offer:', result.offer.id, result.offer.name, result.offer.parentId?.value)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', getOffer)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.catalog.product.offer.get(
bitrix_id=7695,
).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(
'catalog.product.offer.get',
[
'id' => 7695,
]
);
$result = $response
->getResponseData()
->getResult();
print_r($result);
} catch (Throwable $e) {
echo $e->getMessage();
}
BX24.callMethod(
'catalog.product.offer.get',
{
id: 7695,
},
function(result)
{
if (result.error())
console.error(result.error());
else
console.log(result.data());
}
);
require_once('crest.php');
$result = CRest::call(
'catalog.product.offer.get',
[
'id' => 7695,
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
// client and ctx are already created — see the Go SDK section
res, err := client.Core().Call(ctx, "catalog.product.offer.get", b24.Params{
"id": 7695,
}, b24.WithIdempotent())
if err != nil {
return fmt.Errorf("catalog.product.offer.get: %w", err)
}
// The method wraps the response in an object with the "offer" key.
raw, ok := b24.Unwrap(res.Result, "offer")
if !ok {
return fmt.Errorf("the response has no offer key")
}
// Optional fields can be null, so pointers are used for them.
var item struct {
ID b24.ID `json:"id"`
IblockID int `json:"iblockId"`
Name string `json:"name"`
Active string `json:"active"`
Code *string `json:"code"`
Sort *int `json:"sort"`
Type int `json:"type"`
Quantity *float64 `json:"quantity"`
PurchasingPrice *string `json:"purchasingPrice"`
ParentID *struct {
Value string `json:"value"`
ValueID string `json:"valueId"`
} `json:"parentId"`
PreviewPicture *struct {
ID string `json:"id"`
URL string `json:"url"`
} `json:"previewPicture"`
}
if err := json.Unmarshal(raw, &item); err != nil {
return fmt.Errorf("parse response: %w", err)
}
fmt.Println(item.ID, item.Name)
Response Handling
HTTP status: 200
{
"result": {
"offer": {
"active": "Y",
"available": "Y",
"barcodeMulti": "N",
"bundle": "N",
"canBuyZero": "Y",
"code": "tshirt-red-m",
"createdBy": 1269,
"dateActiveFrom": null,
"dateActiveTo": null,
"dateCreate": "2026-11-05T19:19:32+01:00",
"detailPicture": null,
"detailText": null,
"detailTextType": "text",
"height": 20,
"iblockId": 27,
"iblockSection": null,
"iblockSectionId": null,
"id": 7695,
"length": 700,
"measure": 9,
"modifiedBy": 1269,
"name": "Red T-shirt, M",
"parentId": {
"value": "7603",
"valueId": "4149"
},
"previewPicture": {
"id": "40057",
"url": "/rest/catalog.product.download?fields%5BfieldName%5D=previewPicture&fields%5BfileId%5D=40057&fields%5BproductId%5D=7695",
"urlMachine": "/rest/catalog.product.download?fields%5BfieldName%5D=previewPicture&fields%5BfileId%5D=40057&fields%5BproductId%5D=7695"
},
"previewText": "100% cotton, density 180 g/m²",
"previewTextType": "text",
"property429": null,
"property891": {
"value": "Dark red",
"valueId": "4155"
},
"property895": null,
"property905": null,
"property907": {
"value": "1603",
"valueEnum": "M",
"valueId": "4157"
},
"property909": null,
"property911": null,
"property925": null,
"property937": null,
"purchasingCurrency": "EUR",
"purchasingPrice": "850.00000000",
"quantity": 30,
"quantityReserved": null,
"quantityTrace": "Y",
"recurSchemeLength": null,
"recurSchemeType": "D",
"sort": 100,
"subscribe": "Y",
"timestampX": "2026-11-05T19:19:32+01:00",
"trialPriceId": null,
"type": 4,
"vatId": 3,
"vatIncluded": "Y",
"weight": 200,
"width": 500,
"withoutOrder": "N",
"xmlId": "tshirt-red-m"
}
},
"time": {
"start": 1793895573,
"finish": 1793895573.636081,
"duration": 0.6360809803009033,
"processing": 0,
"date_start": "2026-11-05T19:19:33+01:00",
"date_finish": "2026-11-05T19:19:33+01:00",
"operating_reset_at": 1793896140,
"operating": 0
}
}
Returned Data
|
Name |
Description |
|
result |
Root element of the response |
|
result.offer |
Object with all fields and properties of the variation. Empty fields are returned as The parent product is returned in the A picture is returned as an object with the file identifier The |
|
time |
Information about the request execution time |
Error Handling
HTTP status: 400
{
"error": "",
"error_description": "offer does not exist."
}
|
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
|
Status |
Code |
Description |
Value |
|
|
|
Access Denied |
The user has none of the "View product catalog", "View catalog products", or "Edit selling price" permissions |
|
|
|
Access Denied |
The user does not have permission to read this variation in the information block |
|
|
Empty value |
offer does not exist. |
No variation exists with the specified |
|
|
|
Could not find value for parameter |
The |
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
- Add Product Variation catalog.product.offer.add
- Update Product Variation Fields catalog.product.offer.update
- Get List of Product Variations catalog.product.offer.list
- Download Product Variation Files catalog.product.offer.download
- Delete Product Variation catalog.product.offer.delete
- Get Product Variation Fields by Filter catalog.product.offer.getFieldsByFilter