Add a Custom Item to an Order Cart sale.basketitem.add

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"fields":{"orderId":923,"productId":0,"name":"Oversized freight delivery","price":1500,"currency":"USD","quantity":1,"measureCode":"796","measureName":"pcs"},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/sale.basketitem.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 BasketItemAddResult = {
          basketItem: {
            id: number
            orderId: number
            productId: number
            name: string
            sort: number
            quantity: number
            price?: number
            basePrice: number
            discountPrice?: number
            currency: string
            customPrice: string
            vatRate: number | null
            vatIncluded?: string
            weight?: number
            dimensions?: string
            measureCode?: string
            measureName?: string
            canBuy: string
            xmlId: string
            catalogXmlId?: string
            productXmlId?: string
            dateInsert: ISODate | null
            dateUpdate: ISODate | null
            properties: unknown[]
            reservations: unknown[]
          }
        }
        
        try {
          const response = await $b24.actions.v2.call.make<BasketItemAddResult>({
            method: 'sale.basketitem.add',
            params: {
              fields: {
                orderId: 923,
                productId: 0,
                name: 'Oversized freight delivery',
                price: 1500,
                currency: 'USD',
                quantity: 1,
                measureCode: '796',
                measureName: 'pcs',
              },
            },
            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(result.basketItem.id, result.basketItem.name, result.basketItem.price)
          }
        } 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 addBasketItem() {
            try {
              // Initialize the SDK inside a Bitrix24 frame
              const $b24 = await B24Js.initializeB24Frame()
        
              const response = await $b24.actions.v2.call.make({
                method: 'sale.basketitem.add',
                params: {
                  fields: {
                    orderId: 923,
                    productId: 0,
                    name: 'Oversized freight delivery',
                    price: 1500,
                    currency: 'USD',
                    quantity: 1,
                    measureCode: '796',
                    measureName: 'pcs',
                  },
                },
                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(result.basketItem.id, result.basketItem.name, result.basketItem.price)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', addBasketItem)
        </script>
        

from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        fields = {
            "orderId": 923,
            "productId": 0,
            "name": "Oversized freight delivery",
            "price": 1500,
            "currency": "USD",
            "quantity": 1,
            "measureCode": "796",
            "measureName": "pcs",
        }
        
        try:
            bitrix_response = client.sale.basketitem.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.basketitem.add',
                    [
                        'fields' => [
                            'orderId'     => 923,
                            'productId'   => 0,
                            'name'        => 'Oversized freight delivery',
                            'price'       => 1500,
                            'currency'    => 'USD',
                            'quantity'    => 1,
                            'measureCode' => '796',
                            'measureName' => 'pcs',
                        ],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error adding basket item: ' . $e->getMessage();
        }
        

BX24.callMethod(
            "sale.basketitem.add",
            {
                fields: {
                    orderId: 923,
                    productId: 0,
                    name: 'Oversized freight delivery',
                    price: 1500,
                    currency: 'USD',
                    quantity: 1,
                    measureCode: '796',
                    measureName: 'pcs',
                }
            },
        )
            .then(
                function(result)
                {
                    if (result.error())
                    {
                        console.error(result.error());
                    }
                    else
                    {
                        console.log(result.data());
                    }
                },
                function(error)
                {
                    console.info(error);
                }
            );
        

require_once('crest.php');
        
        $result = CRest::call(
            'sale.basketitem.add',
            [
                'fields' =>
                [
                    'orderId' => 923,
                    'productId' => 0,
                    'name' => 'Oversized freight delivery',
                    'price' => 1500,
                    'currency' => 'USD',
                    'quantity' => 1,
                    'measureCode' => '796',
                    'measureName' => 'pcs',
                ]
            ]
        );
        
        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.basketitem.add", b24.Params{
        	"fields": b24.Params{
        		"orderId":     923,
        		"productId":   0,
        		"name":        "Oversized freight delivery",
        		"price":       1500,
        		"currency":    "EUR",
        		"quantity":    1,
        		"measureCode": "796",
        		"measureName": "pcs",
        	},
        })
        if err != nil {
        	return fmt.Errorf("sale.basketitem.add: %w", err)
        }
        
        // The method wraps the response in an object with the "basketItem" key.
        raw, ok := b24.Unwrap(res.Result, "basketItem")
        if !ok {
        	return fmt.Errorf("no basketItem key in the response")
        }
        
        var item struct {
        	ID          int     `json:"id"`
        	OrderID     int     `json:"orderId"`
        	ProductID   int     `json:"productId"`
        	Name        string  `json:"name"`
        	Price       float64 `json:"price"`
        	Currency    string  `json:"currency"`
        	Quantity    float64 `json:"quantity"`
        	MeasureCode string  `json:"measureCode"`
        	MeasureName string  `json:"measureName"`
        	CustomPrice string  `json:"customPrice"`
        }
        if err := json.Unmarshal(raw, &item); err != nil {
        	return fmt.Errorf("parse response: %w", err)
        }
        fmt.Println(item.ID, item.Name, item.Price)