Add Item (Position) to the Cart of an Existing Order sale.basketitem.add

Scope: sale

Who can execute the method: administrator

This method adds an item to the cart of an existing order.

Field values marked with ** will be taken from the product data on the site if a valid product identifier is passed in the productid field. If the product does not exist on the site, the field must be filled in manually.

Name `type`	Description
orderId* `sale_order.id`	Order identifier
sort `integer`	Position in the list of order items
productid* `catalog_product.id`	Product/variation identifier. For products that are not on the site/account, it may be zero
price `double`	Price including markups and discounts (see the `customPrice` field below). The field will be filled automatically if `customPrice !== ‘Y’`
basePrice `double`	Original price excluding markups and discounts (see the `customPrice` field below). The field will be filled automatically if `customPrice !== ‘Y’`
discountPrice `double`	Amount of the final discount or markup (see the `customPrice` field below). The field will be filled automatically if `customPrice !== ‘Y’`
currency* `crm_currency.CURRENCY`	Currency of the price. Must match the currency of the order
customPrice `string`	Is the price specified manually. Possible values: `Y` — yes `N` — no If `Y` is specified, catalog data will be ignored. The parameters `price`, `basePrice`, and `discountPrice` must be explicitly set so that the condition `basePrice = price + discountPrice` is met
quantity* `double`	Quantity of the product
xmlId `string`	External code of the cart item
name,* `string`	Product name
weight** `integer`	Weight of the product
dimensions** `string`	Dimensions of the product (serialized array)
measureCode** `catalog_measure.code`	Unit code of the product
measureName** `catalog_measure.symbol`	Name of the unit of measure
canBuy** `string`	Availability flag of the product. Possible values: `Y` — yes `N` — no
vatRate** `double`	Tax rate in percentage. To specify the rate "No VAT", an empty string must be passed
vatIncluded** `string`	Flag indicating whether VAT or tax is included in the product price. Possible values: `Y` — yes `N` — no
catalogXmlId** `string`	External code of the product catalog
productXmlId** `string`	External code of the product

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":5147,"quantity":2,"productId":6544,"currency":"USD"}}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/sale.basketitem.add

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"fields":{"orderId":5147,"quantity":2,"productId":6544,"currency":"USD"},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/sale.basketitem.add

try
        {
        	const response = await $b24.callMethod(
        		"sale.basketitem.add",
        		{
        			fields: { // minimum set of required fields
        				orderId: 5147,
        				quantity: 2,
        				productId: 6544,
        				currency: 'USD',
        			}
        		}
        	);
        	
        	const result = response.getData().result;
        	console.log(result);
        }
        catch( error )
        {
        	console.error(error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'sale.basketitem.add',
                    [
                        'fields' => [
                            'orderId'   => 5147,
                            'quantity'  => 2,
                            'productId' => 6544,
                            'currency'  => 'USD',
                        ],
                    ]
                );
        
            $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: { // minimum set of required fields
                    orderId: 5147,
                    quantity: 2,
                    productId: 6544,
                    currency: 'USD',
                }
            },
        )
            .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' => 5147,
                    'quantity' => 2,
                    'productId' => 6544,
                    'currency' => 'USD',
                ]
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Typical use-cases and scenarios

Response Handling

HTTP status: 200

{
            "result": {
                "basketItem": {
                    "basePrice": 1000,
                    "canBuy": "Y",
                    "catalogXmlId": "FUTURE-QUICKBOOKS-CATALOG",
                    "currency": "USD",
                    "customPrice": "N",
                    "dateInsert": "2024-04-23T15:59:37+02:00",
                    "dateUpdate": "2024-04-23T15:59:37+02:00",
                    "dimensions": "a:3:{s:5:\"WIDTH\";N;s:6:\"HEIGHT\";N;s:6:\"LENGTH\";N;}",
                    "discountPrice": 100,
                    "id": 6790,
                    "measureCode": "163",
                    "measureName": "g",
                    "name": "Product",
                    "orderId": 5147,
                    "price": 900,
                    "productId": 1245,
                    "productXmlId": "1245",
                    "properties": [],
                    "quantity": 1,
                    "reservations": [],
                    "sort": 100,
                    "vatIncluded": "N",
                    "vatRate": null,
                    "weight": 0,
                    "xmlId": "bx_6627bec8c4fdc"
                }
            },
            "total": 1,
            "time": {
                "start": 1713880776.108755,
                "finish": 1713880777.704221,
                "duration": 1.595465898513794,
                "processing": 0.973701000213623,
                "date_start": "2024-04-23T15:59:36+02:00",
                "date_finish": "2024-04-23T15:59:37+02:00",
                "operating": 0
            }
        }

Returned Data

Name `type`	Description
result `object`	Root element of the response
basketItem `sale_basket_item`	Object with data of the created item (position) in the cart
total `integer`	Number of processed records
time `time`	Information about the execution time of the request

Error Handling

HTTP status: 400

{
            "error":0,
            "error_description":"error"
        }

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
`200140400007`	`basket item is not saved - bad data` The item was not created. The error occurs if an invalid product identifier is passed or if the product is inactive
`200140400008`	`Required fields: fields[ORDER_ID]` Order identifier is not specified
`200140400009`	`Order not found` Order not found
`200140400011`	`Currency must be the currency of the order` The currency of the item does not match the currency of the order
`200040300010`	Insufficient permissions to add
`100`	Required parameters are not specified
`0`	Other errors (e.g., fatal errors)

Statuses and System Error Codes

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 Item in Cart of Existing Order

Add Item (Position) to the Cart of an Existing Order sale.basketitem.add

Method Parameters

Parameter fields

Code Examples

Response Handling

Returned Data

Error Handling

Possible Error Codes

Statuses and System Error Codes

Continue Learning

Add Item (Position) to the Cart of an Existing Order sale.basketitem.add

Method ParametersMethod Parameters

Parameter fieldsParameter fields

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning

Method Parameters

Parameter fields

Code Examples

Response Handling

Returned Data

Error Handling

Possible Error Codes

Statuses and System Error Codes

Continue Learning