Add Shipment 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
        

// 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, ISODate } from '@bitrix24/b24jssdk'
        
        declare const $b24: B24Frame
        
        // Shape of the payload returned in result (match the "response handling" section of the page)
        type ShipmentAddResult = {
          shipment: {
            accountNumber: string
            allowDelivery: string
            basePriceDelivery: number
            canceled: string
            comments: string
            currency: string
            customPriceDelivery: string
            dateAllowDelivery: ISODate | null
            dateDeducted: ISODate | null
            dateInsert: ISODate | null
            dateResponsibleId: ISODate | null
            deducted: string
            deliveryDocDate: ISODate | null
            deliveryDocNum: string
            deliveryId: number
            deliveryName: string
            deliveryXmlId: string
            empAllowDeliveryId: number
            empDeductedId: number
            empResponsibleId: number
            id: number
            marked: string
            orderId: number
            priceDelivery: number
            responsibleId: number
            shipmentItems: unknown[]
            statusId: string
            statusXmlId: string
            system: string
            trackingNumber: string
            xmlId: string
          }
        }
        
        try {
          const response = await $b24.actions.v2.call.make<ShipmentAddResult>({
            method: 'sale.shipment.add',
            params: {
              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',
              },
            },
            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('Added shipment id:', result.shipment.id, result.shipment)
          }
        } 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 addShipment() {
            try {
              // Initialize the SDK inside a Bitrix24 frame
              const $b24 = await B24Js.initializeB24Frame()
        
              const response = await $b24.actions.v2.call.make({
                method: 'sale.shipment.add',
                params: {
                  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',
                  },
                },
                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('Added shipment id:', result.shipment.id, result.shipment)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', addShipment)
        </script>
        

from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        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",
        }
        
        try:
            bitrix_response = client.sale.shipment.add(
                fields=fields,
            ).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.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>';
        

// client and ctx are already created — see the Go SDK section
        res, err := client.Core().Call(ctx, "sale.shipment.add", b24.Params{
        	"fields": b24.Params{
        		"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",
        	},
        })
        if err != nil {
        	return fmt.Errorf("sale.shipment.add: %w", err)
        }
        
        // The method wraps the response in an object with the "shipment" key.
        raw, ok := b24.Unwrap(res.Result, "shipment")
        if !ok {
        	return fmt.Errorf("no shipment key in the response")
        }
        
        var item struct {
        	AccountNumber     string  `json:"accountNumber"`
        	AllowDelivery     string  `json:"allowDelivery"`
        	BasePriceDelivery float64 `json:"basePriceDelivery"`
        	Canceled          string  `json:"canceled"`
        	Comments          string  `json:"comments"`
        	Currency          string  `json:"currency"`
        }
        if err := json.Unmarshal(raw, &item); err != nil {
        	return fmt.Errorf("parse response: %w", err)
        }
        fmt.Println(item.AccountNumber, item.AllowDelivery)