Update Shipment sale.shipment.update

Scope: sale

Who can execute the method: administrator

This method updates a shipment.

Method Parameters

Required parameters are marked with *

Name `type`	Description
id* `sale_order_shipment.id`	Shipment identifier
fields* `object`	Field values for updating the shipment

Parameter fields

General parameters relevant for shipment properties of any type:

Required parameters are marked with *

Name `type`	Description
allowDelivery* `string`	Indicator of delivery permission. Possible values: `Y` – yes (delivery allowed) `N` – no (delivery not allowed)
deducted* `string`	Indicator of whether the shipment has been shipped. Possible values: `Y` – yes (shipped) `N` – no (not shipped)
deliveryId* `sale_delivery_service`	Delivery service identifier
statusId `sale_status`	Delivery status identifier. If not provided, the status DN is used (see the default status table in the documentation for `sale.status.*`)
deliveryDocDate `datetime`	Shipment document date
deliveryDocNum `string`	Shipment document number
trackingNumber `string`	Shipment identifier
basePriceDelivery `double`	Base delivery cost (without discounts / surcharges). If provided, it is also used for setting the `priceDelivery` value. The provided `priceDelivery` value is ignored in this case. If neither basePriceDelivery nor priceDelivery is provided, both prices are set to 0
priceDelivery `double`	Delivery cost. If provided and basePriceDelivery is not set, it is also used for setting the basePriceDelivery value. If neither basePriceDelivery nor priceDelivery is provided, both prices are set to 0
comments `string`	Manager's comment
companyId `integer`	Company identifier from the "Online Store" module. Currently not used
responsibleId `user`	Identifier of the user responsible for the shipment
xmlId `string`	External shipment identifier. Can be used for synchronizing the shipment with an external system

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 '{"id":2452,"fields":{"allowDelivery":"N","deducted":"N","deliveryId":3,"statusId":"DD","deliveryDocDate":"2024-02-13T15:05:49","deliveryDocNum":"MyDocumentNumber","trackingNumber":"MyTrackingNumber","basePriceDelivery":1999.99,"comments":"My new comment for manager","responsibleId":1,"xmlId":"myNewXmlId"}}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/sale.shipment.update

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"id":2452,"fields":{"allowDelivery":"N","deducted":"N","deliveryId":3,"statusId":"DD","deliveryDocDate":"2024-02-13T15:05:49","deliveryDocNum":"MyDocumentNumber","trackingNumber":"MyTrackingNumber","basePriceDelivery":1999.99,"comments":"My new comment for manager","responsibleId":1,"xmlId":"myNewXmlId"},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/sale.shipment.update

try
        {
        	const response = await $b24.callMethod(
        		'sale.shipment.update', {
        			id: 2452,
        			fields: {
        				allowDelivery: 'N',
        				deducted: 'N',
        				deliveryId: 3,
        				statusId: 'DD',
        				deliveryDocDate: '2024-02-13T15:05:49',
        				deliveryDocNum: 'MyDocumentNumber',
        				trackingNumber: 'MyTrackingNumber',
        				basePriceDelivery: 1999.99,
        				comments: 'My new comment for manager',
        				responsibleId: 1,
        				xmlId: 'myNewXmlId',
        			}
        		}
        	);
        	
        	const result = response.getData().result;
        	console.log(result);
        }
        catch( error )
        {
        	console.error(error.ex);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'sale.shipment.update',
                    [
                        'id' => 2452,
                        'fields' => [
                            'allowDelivery'      => 'N',
                            'deducted'           => 'N',
                            'deliveryId'         => 3,
                            'statusId'           => 'DD',
                            'deliveryDocDate'    => '2024-02-13T15:05:49',
                            'deliveryDocNum'     => 'MyDocumentNumber',
                            'trackingNumber'     => 'MyTrackingNumber',
                            'basePriceDelivery'  => 1999.99,
                            'comments'           => 'My new comment for manager',
                            'responsibleId'      => 1,
                            'xmlId'              => 'myNewXmlId',
                        ],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error updating shipment: ' . $e->getMessage();
        }

BX24.callMethod(
            'sale.shipment.update', {
                id: 2452,
                fields: {
                    allowDelivery: 'N',
                    deducted: 'N',
                    deliveryId: 3,
                    statusId: 'DD',
                    deliveryDocDate: '2024-02-13T15:05:49',
                    deliveryDocNum: 'MyDocumentNumber',
                    trackingNumber: 'MyTrackingNumber',
                    basePriceDelivery: 1999.99,
                    comments: 'My new comment for manager',
                    responsibleId: 1,
                    xmlId: 'myNewXmlId',
                }
            },
            function(result) {
                if (result.error())
                    console.error(result.error().ex);
                else
                    console.log(result.data());
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'sale.shipment.update',
            [
                'id' => 2452,
                'fields' => [
                    'allowDelivery' => 'N',
                    'deducted' => 'N',
                    'deliveryId' => 3,
                    'statusId' => 'DD',
                    'deliveryDocDate' => '2024-02-13T15:05:49',
                    'deliveryDocNum' => 'MyDocumentNumber',
                    'trackingNumber' => 'MyTrackingNumber',
                    'basePriceDelivery' => 1999.99,
                    'comments' => 'My new comment for manager',
                    'responsibleId' => 1,
                    'xmlId' => 'myNewXmlId',
                ]
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Successful Response

HTTP status: 200

{
           "result":{
              "shipment":{
                 "accountNumber":"2068\/19",
                 "allowDelivery":"N",
                 "basePriceDelivery":1999.99,
                 "canceled":"N",
                 "comments":"My new comment for manager",
                 "companyId":null,
                 "currency":"USD",
                 "customPriceDelivery":"N",
                 "dateAllowDelivery":"2024-04-12T10:01:23+02:00",
                 "dateCanceled":null,
                 "dateDeducted":"2024-04-12T10:01:23+02:00",
                 "dateInsert":"2024-04-11T14:17:52+02:00",
                 "dateMarked":null,
                 "dateResponsibleId":"2024-04-12T10:01:23+02:00",
                 "deducted":"N",
                 "deliveryDocDate":"2024-02-13T14:05:49+02:00",
                 "deliveryDocNum":"MyDocumentNumber",
                 "deliveryId":3,
                 "deliveryName":"Pickup",
                 "deliveryXmlId":"",
                 "discountPrice":0,
                 "empAllowDeliveryId":1,
                 "empCanceledId":null,
                 "empDeductedId":1,
                 "empMarkedId":null,
                 "empResponsibleId":1,
                 "externalDelivery":"N",
                 "id":2452,
                 "id1c":"",
                 "marked":"N",
                 "orderId":2068,
                 "priceDelivery":1999.99,
                 "reasonMarked":"",
                 "reasonUndoDeducted":"",
                 "responsibleId":1,
                 "shipmentItems":[
                    
                 ],
                 "statusId":"DD",
                 "statusXmlId":"",
                 "system":"N",
                 "trackingDescription":"",
                 "trackingLastCheck":"",
                 "trackingNumber":"MyTrackingNumber",
                 "trackingStatus":"",
                 "updated1c":"N",
                 "version1c":"",
                 "xmlId":"myNewXmlId"
              }
           },
           "time":{
              "start":1712928678.417617,
              "finish":1712928679.68092,
              "duration":1.2633028030395508,
              "processing":1.0808379650115967,
              "date_start":"2024-04-12T16:31:18+02:00",
              "date_finish":"2024-04-12T16:31:19+02:00"
           }
        }

Returned Data

Name `type`	Description
result `object`	Root element of the response
shipment `sale_order_shipment`	Object with information about the updated shipment
time `time`	Information about the request execution time

Error Handling

HTTP status: 400

{
           "error":0,
           "error_description":"Required fields: name"
        }

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
`201140400001`	Shipment not found
`200040300020`	Insufficient permissions to update the shipment
`BX_INVALID_VALUE`	Value of one of the fields did not pass validation before saving
`100`	Parameter `id` not specified
`100`	Parameter `fields` not specified or empty
`0`	Required fields of the `fields` structure not provided
`0`	Other errors (e.g., fatal errors)

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

Add Shipment

Get Shipment Field Values

Update Shipment sale.shipment.update

Method ParametersMethod Parameters

Parameter fieldsParameter fields

Code ExamplesCode Examples

Successful ResponseSuccessful Response

Returned DataReturned Data

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Continue LearningContinue Learning