Add Shipment sale.shipment.add

Scope: sale

Who can execute the method: administrator

This method adds a shipment.

Method Parameters

Required parameters are marked with *

Name `type`	Description
fields* `object`	Field values for creating a shipment

Parameter fields

Required parameters are marked with *

Name `type`	Description
orderId* `sale_order.id`	Order identifier
allowDelivery* `string`	Delivery permission indicator 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.id`	Delivery service identifier
statusId `sale_status`	Delivery status identifier If not provided, the status DN will be 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, the value will also be used as the delivery cost (shipment field `priceDelivery`). If not provided, both the base delivery cost and the delivery cost will be calculated automatically based on the selected delivery service
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 '{"fields":{"orderId":2068,"allowDelivery":"Y","deducted":"Y","deliveryId":2,"statusId":"DN","deliveryDocDate":"2024-02-13T14:05:48","deliveryDocNum":"DocumentNumber123456","trackingNumber":"trackingNumber","basePriceDelivery":999.99,"comments":"My comment for manager","responsibleId":25,"xmlId":"myXmlId"}}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/sale.shipment.add

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"fields":{"orderId":2068,"allowDelivery":"Y","deducted":"Y","deliveryId":2,"statusId":"DN","deliveryDocDate":"2024-02-13T14:05:48","deliveryDocNum":"DocumentNumber123456","trackingNumber":"trackingNumber","basePriceDelivery":999.99,"comments":"My comment for manager","responsibleId":25,"xmlId":"myXmlId"},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/sale.shipment.add

try
        {
        	const response = await $b24.callMethod(
        		'sale.shipment.add', {
        			fields: {
        				orderId: 2068,
        				allowDelivery: 'Y',
        				deducted: 'Y',
        				deliveryId: 2,
        				statusId: 'DN',
        				deliveryDocDate: '2024-02-13T14:05:48',
        				deliveryDocNum: 'DocumentNumber123456',
        				trackingNumber: 'trackingNumber',
        				basePriceDelivery: 999.99,
        				comments: 'My comment for manager',
        				responsibleId: 25,
        				xmlId: 'myXmlId',
        			}
        		}
        	);
        	
        	const result = response.getData().result;
        	console.info(result);
        }
        catch( error )
        {
        	console.error(error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'sale.shipment.add',
                    [
                        'fields' => [
                            'orderId'           => 2068,
                            'allowDelivery'     => 'Y',
                            'deducted'          => 'Y',
                            'deliveryId'        => 2,
                            'statusId'          => 'DN',
                            'deliveryDocDate'   => '2024-02-13T14:05:48',
                            'deliveryDocNum'    => 'DocumentNumber123456',
                            'trackingNumber'    => 'trackingNumber',
                            'basePriceDelivery' => 999.99,
                            'comments'          => 'My comment for manager',
                            'responsibleId'     => 25,
                            'xmlId'             => 'myXmlId',
                        ],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
            
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error adding shipment: ' . $e->getMessage();
        }

BX24.callMethod(
            'sale.shipment.add', {
                fields: {
                    orderId: 2068,
                    allowDelivery: 'Y',
                    deducted: 'Y',
                    deliveryId: 2,
                    statusId: 'DN',
                    deliveryDocDate: '2024-02-13T14:05:48',
                    deliveryDocNum: 'DocumentNumber123456',
                    trackingNumber: 'trackingNumber',
                    basePriceDelivery: 999.99,
                    comments: 'My comment for manager',
                    responsibleId: 25,
                    xmlId: 'myXmlId',
                }
            },
            function(result) {
                if (result.error()) {
                    console.error(result.error());
                } else {
                    console.info(result.data());
                }
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'sale.shipment.add',
            [
                'fields' => [
                    'orderId' => 2068,
                    'allowDelivery' => 'Y',
                    'deducted' => 'Y',
                    'deliveryId' => 2,
                    'statusId' => 'DN',
                    'deliveryDocDate' => '2024-02-13T14:05:48',
                    'deliveryDocNum' => 'DocumentNumber123456',
                    'trackingNumber' => 'trackingNumber',
                    'basePriceDelivery' => 999.99,
                    'comments' => 'My comment for manager',
                    'responsibleId' => 25,
                    'xmlId' => 'myXmlId',
                ]
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Successful Response

HTTP status: 200

{
           "result":{
              "shipment":{
                 "accountNumber":"2068\/19",
                 "allowDelivery":"Y",
                 "basePriceDelivery":999.99,
                 "canceled":"N",
                 "comments":"My comment for manager",
                 "currency":"USD",
                 "customPriceDelivery":"N",
                 "dateAllowDelivery":"2024-04-11T14:17:52+02:00",
                 "dateDeducted":"2024-04-11T14:17:52+02:00",
                 "dateInsert":"2024-04-11T14:17:52+02:00",
                 "dateResponsibleId":"2024-04-11T14:17:52+02:00",
                 "deducted":"Y",
                 "deliveryDocDate":"2024-02-13T13:05:48+02:00",
                 "deliveryDocNum":"DocumentNumber123456",
                 "deliveryId":2,
                 "deliveryName":"Courier Delivery",
                 "deliveryXmlId":"",
                 "empAllowDeliveryId":1,
                 "empDeductedId":1,
                 "empResponsibleId":1,
                 "id":2452,
                 "marked":"N",
                 "orderId":2068,
                 "priceDelivery":999.99,
                 "responsibleId":25,
                 "shipmentItems":[
                    
                 ],
                 "statusId":"DN",
                 "statusXmlId":"FFdddd",
                 "system":"N",
                 "trackingNumber":"trackingNumber",
                 "xmlId":"myXmlId"
              }
           },
           "time":{
              "start":1712837872.459187,
              "finish":1712837873.462857,
              "duration":1.0036699771881104,
              "processing":0.8182649612426758,
              "date_start":"2024-04-11T15:17:52+02:00",
              "date_finish":"2024-04-11T15:17:53+02:00"
           }
        }

Returned Data

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

Error Handling

HTTP status: 400

{
           "error":0,
           "error_description":"Unable to load order"
        }

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
`200040300020`	Insufficient permissions to add shipment
`100`	Parameter `fields` is not specified or is empty
`0`	Order not found
`SALE_SHIPMENT_WRONG_DELIVERY_SERVICE`	Delivery service not found
`BX_INVALID_VALUE`	Value of one of the fields did not pass validation before saving
`0`	Required fields 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

Overview of Methods

Update Shipment

Add Shipment sale.shipment.add

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