Add an item to the shipment table part sale.shipmentitem.add
Choose a tool for developing with an AI agent:
- use Alaio Vibecode to build an app for Bitrix24 from a task description without knowing any programming language. The agent writes the code and deploys the app to a server, with no manual hosting setup
- use the MCP server to develop a REST API integration in your own project. The agent refers to the official REST documentation
Scope:
saleWho can execute the method: administrator
The method sale.shipmentitem.add adds a product from a basket item to a shipment. The basket item and the shipment must belong to the same order. For the rules on distributing quantity across shipments, see the section overview.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
fields* |
Field values for creating an item in the shipment table part (detailed description) |
Parameter fields
Required parameters are marked with *
|
Name |
Description |
|
orderDeliveryId* |
Shipment identifier. Can be retrieved using the sale.shipment.list method |
|
basketId* |
Basket item identifier. Can be retrieved using the sale.basketitem.list method |
|
quantity* |
Quantity of the product in the shipment. Must be greater than The total quantity across all shipments of the order cannot exceed the quantity in the basket item |
|
xmlId |
External identifier. If omitted, Bitrix24 generates a value like Can be used to synchronize the shipment table part item with a similar position in an external system |
Code Examples
How to Use Examples in Documentation
curl -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
curl -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>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
fields = {
"orderDeliveryId": 33,
"basketId": 18,
"quantity": 1,
}
try:
bitrix_response = client.sale.shipmentitem.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.shipmentitem.add',
[
'fields' => [
'orderDeliveryId' => 33,
'basketId' => 18,
'quantity' => 1,
],
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result, 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>';
// client and ctx are already created — see the Go SDK section
res, err := client.Core().Call(ctx, "sale.shipmentitem.add", b24.Params{
"fields": b24.Params{
"orderDeliveryId": 33,
"basketId": 18,
"quantity": 1,
},
})
if err != nil {
return fmt.Errorf("sale.shipmentitem.add: %w", err)
}
// The method wraps the response in an object with the "shipmentItem" key.
raw, ok := b24.Unwrap(res.Result, "shipmentItem")
if !ok {
return fmt.Errorf("no shipmentItem key in the response")
}
var item struct {
BasketID b24.ID `json:"basketId"`
DateInsert string `json:"dateInsert"`
ID b24.ID `json:"id"`
OrderDeliveryID b24.ID `json:"orderDeliveryId"`
Quantity float64 `json:"quantity"`
ReservedQuantity float64 `json:"reservedQuantity"`
}
if err := json.Unmarshal(raw, &item); err != nil {
return fmt.Errorf("parse response: %w", err)
}
fmt.Println(item.BasketID, item.DateInsert)
Response Handling
HTTP status: 200
{
"result": {
"shipmentItem": {
"basketId": 18,
"dateInsert": "2024-04-11T10:10:35+02:00",
"id": 7,
"orderDeliveryId": 33,
"quantity": 1,
"reservedQuantity": 0,
"xmlId": "bx_6617a2e1b3c5d"
}
},
"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 (detailed description) |
|
time |
Information about the request execution time |
Object result
|
Name |
Description |
|
shipmentItem |
The added item in the shipment table part |
Error Handling
HTTP status: 400
{
"error": "201250000001",
"error_description": "Duplicate entry for key [basketId, orderDeliveryId]"
}
|
Name |
Description |
|
error |
String error code. It consists of digits, Latin letters, and underscores. It may arrive empty — in that case only |
|
error_description |
Error message for the developer. Do not show it to the end user without processing |
Possible Error Codes
|
Code |
Description |
|
|
An item with the specified field values To change the quantity of the product, use the sale.shipmentitem.update method |
|
|
The shipment is not found or belongs to a different order than the basket item. Check |
|
|
The basket item is not found. Invalid value of |
|
|
The basket does not have enough unallocated product: the quantity exceeds the remainder not distributed to other shipments |
|
|
|
|
|
A negative |
|
|
Insufficient permissions to add an item to the shipment table part |
|
|
The |
|
|
Required fields are not provided in |
|
|
The shipment is already shipped ( |
|
|
Other errors (e.g., fatal errors) |
Statuses and System Error Codes
HTTP Status: 4xx, 5xx
The errors described below are returned by the REST API itself, not by the logic of a specific method. They can arrive in response to any method.
|
Status |
Code |
Description |
|
|
|
An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
The method is blocked because the request resource intensity limit has been exceeded. The block is lifted automatically once the accumulated execution time of the method no longer exceeds the limit |
|
|
|
The request contains no authorization data: neither an access token nor a webhook code was passed |
|
|
|
Methods are called over the HTTPS protocol only |
|
|
|
The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support |
|
|
|
REST API access is not active for this account. In Bitrix24 Cloud, check the current plan or trial status: Vibe+ plans include REST API access, while Essentials plans do not. A webhook receives a different error message — |
|
|
|
No active webhook with the specified user identifier and secret code was found |
|
|
|
No method with this name was found. The name is misspelled, the method does not exist in the REST API, or it is unavailable without the required scope |
|
|
|
The request requires broader permissions than the token has: for a webhook these are the permissions granted to it, for an application it is the scope. For an application, the error message ends with |
|
|
|
The access token has expired |
|
|
|
The application is installed, but the Bitrix24 administrator has granted access to it only to specific users |
|
|
|
The public part of the site is closed. To open it 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
- Shipment Table Section in the Online Store: Overview of Methods
- Update an item in the shipment table part sale.shipmentitem.update
- Get a Shipment Table Part Item sale.shipmentitem.get
- Get a list of shipment item table elements sale.shipmentitem.list
- Delete a Shipment Table Part Item sale.shipmentitem.delete
- Get Fields of a Shipment Table Part Item sale.shipmentitem.getFields