Get Shipment Property sale.shipmentproperty.get
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.
Scope:
saleWho can execute the method: administrator
This method retrieves the shipment property.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
Identifier of the shipment property |
Code Examples
How to Use Examples in Documentation
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":22}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/sale.shipmentproperty.get
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":22,"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/sale.shipmentproperty.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 } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
// Shape of the payload returned in result (match the "response handling" section of the page)
type ShipmentPropertyGetResult = {
property: {
active: string
code: string
defaultValue: string
description: string
id: number
inputFieldLocation: string
isAddress: string
isAddressFrom: string
isAddressTo: string
isEmail: string
isFiltered: string
isLocation: string
isLocation4tax: string
isPayer: string
isPhone: string
isProfileName: string
isZip: string
multiple: string
name: string
personTypeId: number
propsGroupId: number
required: string
settings: unknown[]
sort: number
type: string
userProps: string
util: string
xmlId: string
}
}
try {
const response = await $b24.actions.v2.call.make<ShipmentPropertyGetResult>({
method: 'sale.shipmentproperty.get',
params: {
id: 22,
},
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.property.id, result.property.name, result.property.type)
}
} 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 getShipmentProperty() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'sale.shipmentproperty.get',
params: {
id: 22,
},
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.property.id, result.property.name, result.property.type)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', getShipmentProperty)
</script>
try {
$response = $b24Service
->core
->call(
'sale.shipmentproperty.get',
[
'id' => 22,
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result, true);
// Your required data processing logic
processData($result);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error getting shipment property: ' . $e->getMessage();
}
BX24.callMethod(
"sale.shipmentproperty.get", {
"id": 22
},
function(result) {
if (result.error()) {
console.error(result.error());
} else {
console.info(result.data());
}
}
);
require_once('crest.php');
$result = CRest::call(
'sale.shipmentproperty.get',
[
'id' => 22
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
Successful Response
HTTP status: 200
{
"result": {
"property": {
"active": "Y",
"code": "PHONE",
"defaultValue": "",
"description": "",
"id": 22,
"inputFieldLocation": "0",
"isAddress": "N",
"isAddressFrom": "N",
"isAddressTo": "N",
"isEmail": "N",
"isFiltered": "N",
"isLocation": "N",
"isLocation4tax": "N",
"isPayer": "N",
"isPhone": "Y",
"isProfileName": "N",
"isZip": "N",
"multiple": "N",
"name": "Phone",
"personTypeId": 3,
"propsGroupId": 5,
"required": "Y",
"settings": [],
"sort": 120,
"type": "STRING",
"userProps": "Y",
"util": "N",
"xmlId": ""
}
},
"time": {
"start": 1712818820.026505,
"finish": 1712818820.232912,
"duration": 0.2064070701599121,
"processing": 0.018364906311035156,
"date_start": "2024-04-11T10:00:20+02:00",
"date_finish": "2024-04-11T10:00:20+02:00"
}
}
Returned Data
|
Name |
Description |
|
result |
Root element of the response |
|
property |
Information about the shipment property |
|
time |
Information about the request execution time |
Error Handling
HTTP status: 400
{
"error":200840400001,
"error_description":"property does not exist"
}
|
Name |
Description |
|
error |
String error code. It may consist of digits, Latin letters, and underscores |
|
error_description |
Textual description of the error. The description is not intended to be shown to the end user in its raw form |
Possible Error Codes
|
Code |
Description |
|
|
Shipment property not found |
|
|
Insufficient permissions to read the shipment property |
|
|
Parameter |
|
|
Other errors (e.g., fatal errors) |
HTTP Status: 20x, 40x, 50x
The errors described below may occur when calling any method.
|
Status |
Code |
Description |
|
|
|
An internal server error has occurred. Please contact the server administrator or Bitrix24 technical support |
|
|
|
An internal server error has occurred. Please contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
The current method is not permitted for calls using batch |
|
|
|
The maximum length of parameters passed to the batch method has been exceeded |
|
|
|
Invalid access token or webhook code |
|
|
|
The HTTPS protocol is required for method calls |
|
|
|
The REST API is blocked due to overload. This is a manual individual block; please contact Bitrix24 technical support to lift it |
|
|
|
The REST API is only available on commercial plans |
|
|
|
The user associated with the access token or webhook used to call the method lacks the necessary permissions |
|
|
|
The manifest is not available |
|
|
|
The request requires higher privileges than those provided by the webhook token |
|
|
|
The provided access token has expired |
|
|
|
The user does not have access to the application. This means that the application is installed, but the portal administrator has restricted access to this application to specific users only |
|
|
|
The public part of the site is closed. To open the public part of the site 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
- Shipping Properties in the Online Store: Overview of Methods
- Add Shipment Property sale.shipmentproperty.add
- Update Shipment Property sale.shipmentproperty.update
- Get a list of shipment properties sale.shipmentproperty.list
- Delete Shipment Property sale.shipmentproperty.delete
- Get Fields and Settings of Shipment Property for a Specific Property Type sale.shipmentproperty.getfieldsbytype