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

// 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 ShipmentUpdateResult = {
          shipment: {
            id: number
            orderId: number
            accountNumber: string
            deliveryId: number
            deliveryName: string
            statusId: string
            allowDelivery: string
            deducted: string
            canceled: string
            marked: string
            priceDelivery: number
            basePriceDelivery: number
            discountPrice: number
            currency: string
            comments: string
            trackingNumber: string
            deliveryDocNum: string
            deliveryDocDate: ISODate | null
            xmlId: string
            companyId: number | null
            responsibleId: number | null
            dateInsert: ISODate | null
            dateAllowDelivery: ISODate | null
            dateDeducted: ISODate | null
            shipmentItems: unknown[]
          }
        }
        
        try {
          const response = await $b24.actions.v2.call.make<ShipmentUpdateResult>({
            method: 'sale.shipment.update',
            params: {
              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',
              },
            },
            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('Updated shipment id:', result.shipment.id, 'status:', result.shipment.statusId)
          }
        } 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 updateShipment() {
            try {
              // Initialize the SDK inside a Bitrix24 frame
              const $b24 = await B24Js.initializeB24Frame()
        
              const response = await $b24.actions.v2.call.make({
                method: 'sale.shipment.update',
                params: {
                  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',
                  },
                },
                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('Updated shipment id:', result.shipment.id, 'status:', result.shipment.statusId)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', updateShipment)
        </script>
        

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

// client and ctx are already created — see the Go SDK section
        res, err := client.Core().Call(ctx, "sale.shipment.update", b24.Params{
        	"id": 2452,
        	"fields": b24.Params{
        		"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",
        	},
        })
        if err != nil {
        	return fmt.Errorf("sale.shipment.update: %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)