Add an item to the shipment table part sale.shipmentitem.add

Scope: sale

Who can execute the method: administrator

The method sale.shipmentitem.add adds an item to the shipment table part.

Method Parameters

Required parameters are marked with *

Name `type`	Description
fields* `object`	Field values for creating an item in the shipment table part

Parameter fields

Required parameters are marked with *

Name `type`	Description
orderDeliveryId* `sale_order_shipment.id`	Shipment identifier
basketId* `sale_basket_item.id`	Basket identifier
quantity* `double`	Quantity of the product
xmlId `string`	External identifier. Can be used to synchronize the current product position in the shipment with a similar position in an external system

Code Examples

How to Use Examples in Documentation

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

-X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"fields":{"orderDeliveryId":33,"basketId":18,"quantity":1}}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/sale.shipmentitem.add

-X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"fields":{"orderDeliveryId":33,"basketId":18,"quantity":1},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/sale.shipmentitem.add

try
        {
        	const response = await $b24.callMethod(
        		'sale.shipmentitem.add',
        		{
        			fields: {
        				orderDeliveryId: 33,
        				basketId: 18,
        				quantity: 1
        			}
        		}
        	);
        	
        	const result = response.getData().result;
        	console.log(result);
        }
        catch( error )
        {
        	console.error(error.ex);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'sale.shipmentitem.add',
                    [
                        'fields' => [
                            'orderDeliveryId' => 33,
                            'basketId'        => 18,
                            'quantity'        => 1,
                        ],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            if ($result->error()) {
                error_log($result->error()->ex);
            } else {
                echo 'Success: ' . print_r($result->data(), true);
            }
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error adding shipment item: ' . $e->getMessage();
        }

BX24.callMethod(
            'sale.shipmentitem.add',
            {
                fields: {
                    orderDeliveryId: 33,
                    basketId: 18,
                    quantity: 1
                }
            },
            function(result)
            {
                if(result.error())
                    console.error(result.error().ex);
                else
                    console.log(result.data());
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'sale.shipmentitem.add',
            [
                'fields' => [
                    'orderDeliveryId' => 33,
                    'basketId' => 18,
                    'quantity' => 1
                ]
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Response Handling

HTTP status: 200

{
            "result": {
                "shipmentItem": {
                    "basketId": 2716,
                    "dateInsert": "2024-04-11T09:10:34+02:00",
                    "id": 7,
                    "orderDeliveryId": 2431,
                    "quantity": 3,
                    "reservedQuantity": 0,
                    "xmlId": "myXmlId"
                }
            },
            "time": {
                "start": 1712819431.708122,
                "finish": 1712819435.985352,
                "duration": 4.2772300243377686,
                "processing": 4.085968971252441,
                "date_start": "2024-04-11T10:10:31+02:00",
                "date_finish": "2024-04-11T10:10:35+02:00"
            }
        }

Returned Data

Name `type`	Description
result `object`	Root element of the response
shipmentItem `sale_order_shipment_item`	Object with information about the added item in the shipment table part
time `time`	Information about the request execution time

Error Handling

HTTP status: 400

{
            "error": 201250000001,
            "error_description": "Duplicate entry for key [basketId, orderDeliveryId]"
        }

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
`201250000001`	An item with the specified field values `basketId` and `orderDeliveryId` already exists. To change the quantity of the product, use the method `sale.shipmentitem.update`
`201240400002`	Shipment not found. Invalid value for the passed parameter `orderDeliveryId`
`201240400003`	Basket not found. Invalid value for the passed parameter `basketId`
`200040300020`	Insufficient permissions to add an item to the shipment table part
`100`	The `fields` parameter is missing or empty
`0`	Required fields are not provided
`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 Shipment Table Section

Add an item to the shipment table part sale.shipmentitem.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