Update Delivery Request sale.delivery.request.update

Scope: sale, delivery

Who can execute the method: administrator

This method updates the delivery request.

Method Parameters

Required parameters are marked with *

Name `type`	Description
DELIVERY_ID* `sale_delivery_service.ID`	Identifier of the delivery service to which the delivery request belongs. You can obtain the identifiers of `sale_delivery_service.ID` delivery services using the sale.delivery.getlist method.
REQUEST_ID* `string`	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 `string`	Indicator of the need to complete (finalize) the delivery request. It is implied that the indicator value should be set to `Y` when the delivery request is fulfilled. By default, if no value is provided, the request is not finalized. Possible values: `Y` — yes `N` — no
STATUS `object`	Status of the delivery request (detailed description provided below)
PROPERTIES `object[]`	Properties of the delivery request (detailed description provided below)
OVERWRITE_PROPERTIES `string`	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 `N`). If the calling party needs to pass the full set of properties and overwrite existing properties, the value of this indicator must be set to `Y`. Possible values: `Y` — yes `N` — no

Parameter STATUS

Required parameters are marked with *

Name
type

Description

TEXT*
string

Text name of the delivery request status

SEMANTIC*
string

Value of the status semantics.

Possible values:

process — request in progress
success — request successfully completed

Parameter PROPERTIES

Required parameters are marked with *

Name `type`	Description
NAME* `string`	Name of the property
VALUE* `string`	Value of the property
TAGS `string[]`	List of tags. Possible values: `phone` — the provided value will be displayed as a phone number

Code Examples

How to Use Examples in Documentation

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

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

try
        {
        	const response = await $b24.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",
        				},
        			],
        		}
        	);
        	
        	const result = response.getData().result;
        	console.info(result);
        }
        catch( error )
        {
        	console.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>';

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 `type`	Description
result `boolean`	Result of updating the delivery request
time `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 `type`	Description
error `string`	String error code. It may consist of digits, Latin letters, and underscores
error_description `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
`DELIVERY_ID_NOT_SPECIFIED`	Delivery service identifier not specified	`400`
`DELIVERY_NOT_FOUND`	Delivery service not found	`400`
`REQUEST_ID_NOT_SPECIFIED`	Delivery request identifier not specified	`400`
`REQUEST_NOT_FOUND`	Delivery request not found	`400`
`STATUS_UNEXPECTED_FORMAT`	Incorrect format of the `STATUS` parameter value	`400`
`STATUS_TEXT_NOT_SPECIFIED`	Status name value not specified	`400`
`STATUS_SEMANTIC_NOT_SPECIFIED`	Status semantics value not specified	`400`
`PROPERTIES_UNEXPECTED_FORMAT`	Incorrect format of the `PROPERTIES` parameter value	`400`
`PROPERTY_VALUE_UNEXPECTED_FORMAT`	Incorrect format of one of the provided properties	`400`
`PROPERTY_VALUE_TAGS_UNEXPECTED_FORMAT`	Incorrect format of the property tags value	`400`
`PROPERTY_VALUE_TAG_UNEXPECTED_FORMAT`	Incorrect format of the property tag value	`400`
`UNEXPECTED_REQUEST_FINALIZE_INDICATOR_VALUE`	Incorrect value of the `FINALIZE` parameter. Allowed values: `Y`, `N`	`400`
`UNEXPECTED_OVERWRITE_PROPERTIES_VALUE`	Incorrect value of the `OVERWRITE_PROPERTIES` parameter. Allowed values: `Y`, `N`	`400`
`UPDATE_REQUEST_INTERNAL_ERROR`	Error while attempting to update the delivery request	`400`
`EMPTY_UPDATE_PAYLOAD`	Empty set of fields for updating the delivery request	`400`
`ACCESS_DENIED`	Insufficient rights to add the delivery service	`403`

Statuses and System Error Codes

HTTP Status: 20x, 40x, 50x

The errors described below may occur when calling any method.

Status	Code Error Message	Description
`500`	`INTERNAL_SERVER_ERROR` Internal server error	An internal server error has occurred, please contact the server administrator or Bitrix24 technical support
`500`	`ERROR_UNEXPECTED_ANSWER` Server returned an unexpected response	An internal server error has occurred, please contact the server administrator or Bitrix24 technical support
`503`	`QUERY_LIMIT_EXCEEDED` Too many requests	The request intensity limit has been exceeded
`405`	`ERROR_BATCH_METHOD_NOT_ALLOWED` Method is not allowed for batch usage	The current method is not allowed to be called using batch
`400`	`ERROR_BATCH_LENGTH_EXCEEDED` Max batch length exceeded	The maximum length of parameters passed to the batch method has been exceeded
`401`	`NO_AUTH_FOUND` Wrong authorization data	Invalid access token or webhook code
`400`	`INVALID_REQUEST` Https required	The methods must be called using the HTTPS protocol
`503`	`OVERLOAD_LIMIT` REST API is blocked due to overload	The REST API is blocked due to overload. This is a manual individual block, to remove it you need to contact Bitrix24 technical support
`403`	`ACCESS_DENIED` REST API is available only on commercial plans	The REST API is available only on commercial plans
`403`	`INVALID_CREDENTIALS` Invalid request credentials	The user whose access token or webhook was used to call the method lacks permissions
`404`	`ERROR_MANIFEST_IS_NOT_AVAILABLE` Manifest is not available	The manifest is not available
`403`	`insufficient_scope` The request requires higher privileges than provided by the webhook token	The request requires higher privileges than those provided by the webhook token
`401`	`expired_token` The access token provided has expired	The provided access token has expired
`403`	`user_access_error` The user does not have access to the application	The user does not have access to the application. This means that the application is installed, but the account administrator has allowed access to this application only for specific users
`500`	`PORTAL_DELETED` Portal was deleted	The public part of the site is closed. To open the public part of the site on an on-premise installation, disable the option "Temporary closure of the public part of the site". Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site

Continue Learning

Overview of Methods

Create Notifications for Transportation Request

Update Delivery Request sale.delivery.request.update

Method ParametersMethod Parameters

Parameter STATUSParameter STATUS

Parameter PROPERTIESParameter PROPERTIES

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning

Method Parameters

Parameter STATUS

Parameter PROPERTIES

Code Examples

Response Handling

Returned Data

Error Handling

Possible Error Codes

Statuses and System Error Codes

Continue Learning