Add an item to the shipment table part sale.shipmentitem.add
If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the MCP server so that the assistant can utilize the official REST documentation.
Scope:
saleWho 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 |
Description |
|
fields* |
Field values for creating an item in the shipment table part |
Parameter fields
Required parameters are marked with *
|
Name |
Description |
|
orderDeliveryId* |
Shipment identifier |
|
basketId* |
Basket identifier |
|
quantity* |
Quantity of the product |
|
xmlId |
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
-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
// 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 ShipmentItemAddResult = {
shipmentItem: {
basketId: number
dateInsert: ISODate | null
id: number
orderDeliveryId: number
quantity: number
reservedQuantity: number
xmlId: string
}
}
try {
const response = await $b24.actions.v2.call.make<ShipmentItemAddResult>({
method: 'sale.shipmentitem.add',
params: {
fields: {
orderDeliveryId: 33,
basketId: 18,
quantity: 1,
},
},
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.shipmentItem.id, result.shipmentItem.basketId, result.shipmentItem.quantity)
}
} 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 addShipmentItem() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'sale.shipmentitem.add',
params: {
fields: {
orderDeliveryId: 33,
basketId: 18,
quantity: 1,
},
},
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.shipmentItem.id, result.shipmentItem.basketId, result.shipmentItem.quantity)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', addShipmentItem)
</script>
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 |
Description |
|
result |
Root element of the response |
|
shipmentItem |
Object with information about the added item in the shipment table part |
|
time |
Information about the request execution time |
Error Handling
HTTP status: 400
{
"error": 201250000001,
"error_description": "Duplicate entry for key [basketId, orderDeliveryId]"
}
|
Name |
Description |
|
error |
String error code. It may consist of digits, Latin letters, and underscores |
|
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 |
|
|
An item with the specified field values To change the quantity of the product, use the method |
|
|
Shipment not found. Invalid value for the passed parameter |
|
|
Basket not found. Invalid value for the passed parameter |
|
|
Insufficient permissions to add an item to the shipment table part |
|
|
The |
|
|
Required fields are not provided |
|
|
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 |
Description |
|
|
|
An internal server error has occurred. Please contact the server administrator or Bitrix24 technical support |
|
|
|
An internal server error has occurred. Please contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
The current method is not permitted for calls using batch |
|
|
|
The maximum length of parameters passed to the batch method has been exceeded |
|
|
|
Invalid access token or webhook code |
|
|
|
The HTTPS protocol is required for method calls |
|
|
|
The REST API is blocked due to overload. This is a manual individual block; please contact Bitrix24 technical support to lift it |
|
|
|
The REST API is only available on commercial plans |
|
|
|
The user associated with the access token or webhook used to call the method lacks the necessary permissions |
|
|
|
The manifest is not available |
|
|
|
The request requires higher privileges than those provided by the webhook token |
|
|
|
The provided access token has expired |
|
|
|
The user does not have access to the application. This means that the application is installed, but the portal administrator has restricted access to this application to specific users only |
|
|
|
The public part of the site is closed. To open the public part of the site on an on-premise installation, disable the "Temporary closure of the public part of the site" option. Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site |
Continue Learning
- Update an item in the shipment table part sale.shipmentitem.update
- Accessing Fields of the sale.shipmentitem.get Element
- Get a list of shipment item table elements sale.shipmentitem.list
- Delete Shipment Item from Collection sale.shipmentitem.delete
- Get Fields of Shipment Item from sale.shipmentitem.getfields