Create a property for a basket item sale.basketproperties.add

Scope: sale

Who can execute the method: administrator

This method adds a property for an item (position) in the basket of an order.

Method Parameters

Required parameters are marked with *

Name `type`	Description
fields* `object`	Field values (detailed description provided below) for creating a property of a basket item (position): `fields: { basketId: "value", name: "value", value: "value", code: "value", sort: "value", xmlId: "value", }`

Parameter fields

Required parameters are marked with *

Name `type`	Description
basketId* `sale_basket_item.id`	Identifier of the basket item (position) in the order. Can be obtained using the methods `sale.basketitem.get` or `sale.basketitem.list`
name* `string`	Property name
value* `string`	Property value
code* `string`	Symbolic code of the property
sort `integer`	Position in the list of properties. If not specified, a default value of 100 will be assigned
xmlId `string`	External code of the property. If not specified, it will be generated automatically

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":{"basketId":6806,"name":"Article","value":"4653-4877","code":"ARTICUL"}}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/sale.basketproperties.add

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"fields":{"basketId":6806,"name":"Article","value":"4653-4877","code":"ARTICUL"},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/sale.basketproperties.add

try
        {
        	const response = await $b24.callMethod(
        		"sale.basketproperties.add",
        		{
        			fields: {
        				basketId: 6806,
        				name: 'Article',
        				value: '4653-4877',
        				code: 'ARTICUL',
        			}
        		}
        	);
        	
        	const result = response.getData().result;
        	console.log(result);
        }
        catch( error )
        {
        	console.error(error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'sale.basketproperties.add',
                    [
                        'fields' => [
                            'basketId' => 6806,
                            'name'     => 'Article',
                            'value'    => '4653-4877',
                            'code'     => 'ARTICUL',
                        ],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error adding basket property: ' . $e->getMessage();
        }

BX24.callMethod(
            "sale.basketproperties.add",
            {
                fields: {
                    basketId: 6806,
                    name: 'Article',
                    value: '4653-4877',
                    code: 'ARTICUL',
                }
            },
        )
            .then(
                function(result)
                {
                    if (result.error())
                    {
                        console.error(result.error());
                    }
                    else
                    {
                        console.log(result);
                    }
                },
                function(error)
                {
                    console.info(error);
                }
            );

require_once('crest.php');
        
        $result = CRest::call(
            'sale.basketproperties.add',
            [
                'fields' =>
                [
                    'basketId' => 6806,
                    'name' => 'Article',
                    'value' => '4653-4877',
                    'code' => 'ARTICUL',
                ]
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Response Handling

HTTP status: 200

{
            "result": {
                "basketProperty": {
                    "basketId": 6806,
                    "code": "ARTICUL",
                    "id": 17,
                    "name": "Article",
                    "value": "4653-4877",
                    "xmlId": "bx_662a44cff2b81"
                }
            },
            "time": {
                "start": 1714046159.109796,
                "finish": 1714046163.282623,
                "duration": 4.1728270053863525,
                "processing": 3.4128189086914062,
                "date_start": "2024-04-25T13:55:59+02:00",
                "date_finish": "2024-04-25T13:56:03+02:00",
                "operating": 0
            }
        }

Returned Data

Name `type`	Description
result `object`	Root element of the response
basketProperty `sale_basket_item_property`	Object with data of the created property of the basket item (position)
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
`200040300010`	Insufficient permissions to add
`200240400004`	Basket item id is absent Basket item (position) identifier is not specified
`200240400005`	Basket item id is bad Invalid basket item (position) identifier — for example, the string ‘seventy’
`200240400001`, `200240400002`	Basket item (position) not found
`100`	Parameter `fields` is not specified or empty
`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 Basket Property

Create a property for a basket item sale.basketproperties.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