Update Delivery Service sale.delivery.extra.service.update
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:
sale, deliveryWho can execute the method: administrator
This method updates the delivery service.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
Identifier of the service. You can obtain the identifiers of delivery services using the sale.delivery.extra.service.get method. |
|
|
NAME |
Name of the service |
|
ACTIVE |
Indicator of the service's activity. Possible values:
|
|
CODE |
Symbolic code of the service |
|
SORT |
Sorting |
|
DESCRIPTION |
Description of the service |
|
PRICE |
Cost of the service in the delivery service's currency. This field is relevant only for services of type |
|
ITEMS |
List of available options for selection (detailed description provided below). This field is relevant only for services of type |
ITEMS Parameter
Required parameters are marked with *
|
Name |
Description |
|
TITLE* |
Name of the list option |
|
CODE* |
Symbolic code of the list option |
|
PRICE |
Cost of the service when selecting this option in the delivery service's currency |
Code Examples
How to Use Examples in Documentation
Updating a service of type Quantitative service:
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"ID":128,"ACTIVE":"N","CODE":"door_delivery","NAME":"Door Delivery New Name","DESCRIPTION":"Door Delivery New Description","SORT":200,"PRICE":399.99}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/sale.delivery.extra.service.update
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"ID":128,"ACTIVE":"N","CODE":"door_delivery","NAME":"Door Delivery New Name","DESCRIPTION":"Door Delivery New Description","SORT":200,"PRICE":399.99,"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/sale.delivery.extra.service.update
try
{
const response = await $b24.callMethod(
'sale.delivery.extra.service.update', {
ID: 128,
ACTIVE: "N",
CODE: "door_delivery",
NAME: "Door Delivery New Name",
DESCRIPTION: "Door Delivery New Description",
SORT: 200,
PRICE: 399.99,
}
);
const result = response.getData().result;
console.info(result);
}
catch( error )
{
console.error(error);
}
try {
$response = $b24Service
->core
->call(
'sale.delivery.extra.service.update',
[
'ID' => 128,
'ACTIVE' => "N",
'CODE' => "door_delivery",
'NAME' => "Door Delivery New Name",
'DESCRIPTION' => "Door Delivery New Description",
'SORT' => 200,
'PRICE' => 399.99,
]
);
$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 updating delivery service: ' . $e->getMessage();
}
BX24.callMethod(
'sale.delivery.extra.service.update', {
ID: 128,
ACTIVE: "N",
CODE: "door_delivery",
NAME: "Door Delivery New Name",
DESCRIPTION: "Door Delivery New Description",
SORT: 200,
PRICE: 399.99,
},
function(result) {
if (result.error()) {
console.error(result.error());
} else {
console.info(result.data());
}
}
);
require_once('crest.php');
$result = CRest::call(
'sale.delivery.extra.service.update',
[
'ID' => 128,
'ACTIVE' => "N",
'CODE' => "door_delivery",
'NAME' => "Door Delivery New Name",
'DESCRIPTION' => "Door Delivery New Description",
'SORT' => 200,
'PRICE' => 399.99,
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
Updating a service of type List:
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"ID":129,"ACTIVE":"N","CODE":"cargo_type","NAME":"Cargo Type New Name","DESCRIPTION":"Cargo Type New Description","TYPE":"enum","SORT":500,"ITEMS":[{"TITLE":"Small Package(s)","CODE":"small_package","PRICE":129.99},{"TITLE":"Documents","CODE":"documents","PRICE":69.99},{"TITLE":"Large Package(s)","CODE":"large_package","PRICE":1290.99}]}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/sale.delivery.extra.service.update
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"ID":129,"ACTIVE":"N","CODE":"cargo_type","NAME":"Cargo Type New Name","DESCRIPTION":"Cargo Type New Description","TYPE":"enum","SORT":500,"ITEMS":[{"TITLE":"Small Package(s)","CODE":"small_package","PRICE":129.99},{"TITLE":"Documents","CODE":"documents","PRICE":69.99},{"TITLE":"Large Package(s)","CODE":"large_package","PRICE":1290.99}],"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/sale.delivery.extra.service.update
try
{
const response = await $b24.callMethod(
'sale.delivery.extra.service.update', {
ID: 129,
ACTIVE: "N",
CODE: "cargo_type",
NAME: "Cargo Type New Name",
DESCRIPTION: "Cargo Type New Description",
TYPE: "enum",
SORT: 500,
ITEMS: [{
TITLE: "Small Package(s)",
CODE: "small_package",
PRICE: 129.99,
},
{
TITLE: "Documents",
CODE: "documents",
PRICE: 69.99,
},
{
TITLE: "Large Package(s)",
CODE: "large_package",
PRICE: 1290.99,
},
],
}
);
const result = response.getData().result;
console.info(result);
}
catch( error )
{
console.error(error);
}
try {
$response = $b24Service
->core
->call(
'sale.delivery.extra.service.update',
[
'ID' => 129,
'ACTIVE' => "N",
'CODE' => "cargo_type",
'NAME' => "Cargo Type New Name",
'DESCRIPTION' => "Cargo Type New Description",
'TYPE' => "enum",
'SORT' => 500,
'ITEMS' => [
[
'TITLE' => "Small Package(s)",
'CODE' => "small_package",
'PRICE' => 129.99,
],
[
'TITLE' => "Documents",
'CODE' => "documents",
'PRICE' => 69.99,
],
[
'TITLE' => "Large Package(s)",
'CODE' => "large_package",
'PRICE' => 1290.99,
],
],
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result, true);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error updating delivery extra service: ' . $e->getMessage();
}
BX24.callMethod(
'sale.delivery.extra.service.update', {
ID: 129,
ACTIVE: "N",
CODE: "cargo_type",
NAME: "Cargo Type New Name",
DESCRIPTION: "Cargo Type New Description",
TYPE: "enum",
SORT: 500,
ITEMS: [{
TITLE: "Small Package(s)",
CODE: "small_package",
PRICE: 129.99,
},
{
TITLE: "Documents",
CODE: "documents",
PRICE: 69.99,
},
{
TITLE: "Large Package(s)",
CODE: "large_package",
PRICE: 1290.99,
},
],
},
function(result) {
if (result.error()) {
console.error(result.error());
} else {
console.info(result.data());
}
}
);
require_once('crest.php');
$result = CRest::call(
'sale.delivery.extra.service.update',
[
'ID' => 129,
'ACTIVE' => "N",
'CODE' => "cargo_type",
'NAME' => "Cargo Type New Name",
'DESCRIPTION' => "Cargo Type New Description",
'TYPE' => "enum",
'SORT' => 500,
'ITEMS' => [
[
'TITLE' => "Small Package(s)",
'CODE' => "small_package",
'PRICE' => 129.99,
],
[
'TITLE' => "Documents",
'CODE' => "documents",
'PRICE' => 69.99,
],
[
'TITLE' => "Large Package(s)",
'CODE' => "large_package",
'PRICE' => 1290.99,
],
]
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
Response Handling
HTTP status: 200
{
"result":true,
"time":{
"start":1714549724.272976,
"finish":1714549724.479944,
"duration":0.20696806907653809,
"processing":0.02615499496459961,
"date_start":"2024-05-01T10:48:44+02:00",
"date_finish":"2024-05-01T10:48:44+02:00"
}
}
Returned Data
|
Name |
Description |
|
result |
Result of the service update |
|
time |
Information about the request execution time |
Error Handling
HTTP status: 400, 403
{
"error":"ERROR_EXTRA_SERVICE_NOT_FOUND",
"error_description":"Extra service not found"
}
|
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 |
Status |
|
|
Validation error of incoming parameters (details in the error description) |
|
|
|
Error while attempting to update the service |
|
|
|
Service with the specified identifier (ID) not found |
|
|
|
Insufficient rights to add the service |
|
Statuses and System Error Codes
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
- Add Delivery Service sale.delivery.extra.service.add
- Get Information About All Services of a Specific Delivery Service sale.delivery.extra.service.get
- Delete the delivery service sale.delivery.extra.service.delete