Update Delivery Request sale.delivery.request.update
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:
deliveryWho can execute the method: administrator
The method sale.delivery.request.update updates the delivery request.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
DELIVERY_ID* |
Identifier of the delivery service to which the delivery request belongs. You can obtain the identifiers of |
|
REQUEST_ID* |
Identifier of the delivery request. The identifier is assigned by the external system in response to the webhook for creating a delivery order (more details in the webhook description Creating a Delivery Order). |
|
FINALIZE |
Indicator of the need to finalize the delivery request. It is implied that the indicator value should be set to By default, if no value is provided, the request is not finalized. Possible values:
|
|
STATUS |
Status of the delivery request (detailed description provided below) |
|
PROPERTIES |
Properties of the delivery request (detailed description provided below) |
|
OVERWRITE_PROPERTIES |
Indicator of the need to completely overwrite the property values of the request during the update. By default, properties are only added during the update (equivalent to passing the value Possible values:
|
Parameter STATUS
Required parameters are marked with *
|
Name |
Description |
|
TEXT* |
Text name of the delivery request status |
|
SEMANTIC* |
Semantic value of the status. Possible values:
|
Parameter PROPERTIES
Required parameters are marked with *
|
Name |
Description |
|
NAME* |
Name of the property |
|
VALUE* |
Value of the property |
|
TAGS |
List of tags. Possible values:
|
Code Examples
How to Use Examples in Documentation
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"DELIVERY_ID":225,"REQUEST_ID":"4757aca4931a4f029f49c0db4374d13d","STATUS":{"TEXT":"Performer found","SEMANTIC":"process"},"PROPERTIES":[{"NAME":"Car","VALUE":"Gray Skoda Octavia, a777zn"},{"NAME":"Driver","VALUE":"John Smith"},{"NAME":"Phone Number","VALUE":"+11111111111","TAGS":["phone"]},{"NAME":"Something else","VALUE":"Some value"}]}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/sale.delivery.request.update
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"DELIVERY_ID":225,"REQUEST_ID":"4757aca4931a4f029f49c0db4374d13d","STATUS":{"TEXT":"Performer found","SEMANTIC":"process"},"PROPERTIES":[{"NAME":"Car","VALUE":"Gray Skoda Octavia, a777zn"},{"NAME":"Driver","VALUE":"John Smith"},{"NAME":"Phone Number","VALUE":"+11111111111","TAGS":["phone"]},{"NAME":"Something else","VALUE":"Some value"}],"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/sale.delivery.request.update
// 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
try {
const response = await $b24.actions.v2.call.make<boolean>({
method: 'sale.delivery.request.update',
params: {
DELIVERY_ID: 225,
REQUEST_ID: '4757aca4931a4f029f49c0db4374d13d',
STATUS: {
TEXT: 'Performer found',
SEMANTIC: 'process',
},
PROPERTIES: [
{
NAME: 'Car',
VALUE: 'Gray Skoda Octavia, a777zn',
},
{
NAME: 'Driver',
VALUE: 'John Smith',
},
{
NAME: 'Phone Number',
VALUE: '+11111111111',
TAGS: ['phone'],
},
{
NAME: 'Something else',
VALUE: 'Some value',
},
],
},
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('Delivery request updated:', result)
}
} 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 updateDeliveryRequest() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'sale.delivery.request.update',
params: {
DELIVERY_ID: 225,
REQUEST_ID: '4757aca4931a4f029f49c0db4374d13d',
STATUS: {
TEXT: 'Performer found',
SEMANTIC: 'process',
},
PROPERTIES: [
{
NAME: 'Car',
VALUE: 'Gray Skoda Octavia, a777zn',
},
{
NAME: 'Driver',
VALUE: 'John Smith',
},
{
NAME: 'Phone Number',
VALUE: '+11111111111',
TAGS: ['phone'],
},
{
NAME: 'Something else',
VALUE: 'Some value',
},
],
},
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('Delivery request updated:', result)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', updateDeliveryRequest)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
status = {
"TEXT": "Performer found",
"SEMANTIC": "process",
}
properties = [
{
"NAME": "Car",
"VALUE": "Gray Skoda Octavia, a777zn",
},
{
"NAME": "Driver",
"VALUE": "John Smith",
},
{
"NAME": "Phone Number",
"VALUE": "+11111111111",
"TAGS": [
"phone",
],
},
{
"NAME": "Something else",
"VALUE": "Some value",
},
]
try:
bitrix_response = client.sale.delivery.request.update(
delivery_id=225,
request_id='4757aca4931a4f029f49c0db4374d13d',
status=status,
properties=properties,
).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.delivery.request.update',
[
'DELIVERY_ID' => 225,
'REQUEST_ID' => "4757aca4931a4f029f49c0db4374d13d",
'STATUS' => [
'TEXT' => "Performer found",
'SEMANTIC' => "process",
],
'PROPERTIES' => [
[
'NAME' => "Car",
'VALUE' => "Gray Skoda Octavia, a777zn",
],
[
'NAME' => "Driver",
'VALUE' => "John Smith",
],
[
'NAME' => "Phone Number",
'VALUE' => "+11111111111",
'TAGS' => [
"phone"
],
],
[
'NAME' => "Something else",
'VALUE' => "Some value",
],
],
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result, true);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error updating delivery request: ' . $e->getMessage();
}
BX24.callMethod(
'sale.delivery.request.update', {
DELIVERY_ID: 225,
REQUEST_ID: "4757aca4931a4f029f49c0db4374d13d",
STATUS: {
TEXT: "Performer found",
SEMANTIC: "process",
},
PROPERTIES: [{
NAME: "Car",
VALUE: "Gray Skoda Octavia, a777zn",
},
{
NAME: "Driver",
VALUE: "John Smith",
},
{
NAME: "Phone Number",
VALUE: "+11111111111",
TAGS: [
"phone"
],
},
{
NAME: "Something else",
VALUE: "Some value",
},
],
},
function(result) {
if (result.error()) {
console.error(result.error());
} else {
console.info(result.data());
}
}
);
require_once('crest.php');
$result = CRest::call(
'sale.delivery.request.update',
[
'DELIVERY_ID' => 225,
'REQUEST_ID' => "4757aca4931a4f029f49c0db4374d13d",
'STATUS' => [
'TEXT' => "Performer found",
'SEMANTIC' => "process",
],
'PROPERTIES' => [
[
'NAME' => "Car",
'VALUE' => "Gray Skoda Octavia, a777zn",
],
[
'NAME' => "Driver",
'VALUE' => "John Smith",
],
[
'NAME' => "Phone Number",
'VALUE' => "+11111111111",
'TAGS' => [
"phone"
],
],
[
'NAME' => "Something else",
'VALUE' => "Some value",
],
]
]
);
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.delivery.request.update", b24.Params{
"DELIVERY_ID": 225,
"REQUEST_ID": "4757aca4931a4f029f49c0db4374d13d",
"STATUS": b24.Params{
"TEXT": "Performer found",
"SEMANTIC": "process",
},
"PROPERTIES": []b24.Params{
{
"NAME": "Car",
"VALUE": "Gray Skoda Octavia, a777zn",
},
{
"NAME": "Driver",
"VALUE": "John Smith",
},
{
"NAME": "Phone Number",
"VALUE": "+11111111111",
"TAGS": []string{"phone"},
},
{
"NAME": "Something else",
"VALUE": "Some value",
},
},
})
if err != nil {
return fmt.Errorf("sale.delivery.request.update: %w", err)
}
var ok bool
if err := json.Unmarshal(res.Result, &ok); err != nil {
return fmt.Errorf("parse response: %w", err)
}
fmt.Println("done:", ok)
Response Handling
HTTP Status: 200
{
"result":true,
"time":{
"start":1714557963.841951,
"finish":1714557964.052347,
"duration":0.21039605140686035,
"processing":0.04059791564941406,
"date_start":"2024-05-01T13:06:03+02:00",
"date_finish":"2024-05-01T13:06:04+02:00"
}
}
Returned Data
|
Name |
Description |
|
result |
Result of the delivery request update |
|
time |
Information about the request execution time |
Error Handling
HTTP Status: 400, 403
{
"error":"DELIVERY_NOT_FOUND",
"error_description":"Delivery service has not been found"
}
|
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 |
Status |
|
|
Delivery service identifier not specified |
|
|
|
Delivery service not found |
|
|
|
Delivery request identifier not specified |
|
|
|
Delivery request not found |
|
|
|
Incorrect format of the |
|
|
|
Status name value not specified |
|
|
|
Semantic value of the status not specified |
|
|
|
Incorrect format of the |
|
|
|
Incorrect format of one of the provided properties |
|
|
|
Incorrect format of the property tag values |
|
|
|
Incorrect format of the property tag value |
|
|
|
Incorrect value of the Allowed values: |
|
|
|
Incorrect value of the Allowed values: |
|
|
|
Error while attempting to update the delivery request |
|
|
|
Empty set of fields for updating the delivery request |
|
|
|
Insufficient permissions to update the delivery request |
|
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 |