Get Shipment Fields sale.shipment.get
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
This method retrieves the values of all shipment fields.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
Shipment identifier |
Code Examples
How to Use Examples in Documentation
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":2465}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/sale.shipment.get
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":2465,"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/sale.shipment.get
// 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 ShipmentGetResult = {
shipment: {
accountNumber: string
allowDelivery: string
basePriceDelivery: number
canceled: string
comments: string
companyId: number
currency: string
customPriceDelivery: string
dateAllowDelivery: ISODate | null
dateCanceled: ISODate | null
dateDeducted: ISODate | null
dateInsert: ISODate
dateMarked: ISODate | null
dateResponsibleId: ISODate
deducted: string
deliveryDocDate: ISODate | null
deliveryDocNum: string
deliveryId: number
deliveryName: string
deliveryXmlId: string
discountPrice: number
empAllowDeliveryId: number | null
empCanceledId: number | null
empDeductedId: number | null
empMarkedId: number | null
empResponsibleId: number | null
externalDelivery: string
id: number
id1c: string
marked: string
orderId: number
priceDelivery: number
reasonMarked: string
reasonUndoDeducted: string
responsibleId: number
shipmentItems: Array<{
basketId: number
dateInsert: ISODate
id: number
orderDeliveryId: number
quantity: number
reservedQuantity: number
xmlId: string
}>
statusId: string
statusXmlId: string
system: string
trackingDescription: string
trackingLastCheck: string
trackingNumber: string
trackingStatus: string
updated1c: string
version1c: string
xmlId: string
}
}
try {
const response = await $b24.actions.v2.call.make<ShipmentGetResult>({
method: 'sale.shipment.get',
params: {
id: 2465,
},
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.shipment.id, result.shipment.accountNumber, result.shipment.statusId)
}
} 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 getShipment() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'sale.shipment.get',
params: {
id: 2465,
},
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.shipment.id, result.shipment.accountNumber, result.shipment.statusId)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', getShipment)
</script>
try {
$response = $b24Service
->core
->call(
'sale.shipment.get',
[
'id' => 2465,
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result, true);
// Your logic for processing data
processData($result);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error getting shipment: ' . $e->getMessage();
}
BX24.callMethod(
"sale.shipment.get", {
"id": 2465
},
function(result) {
if (result.error()) {
console.error(result.error());
} else {
console.info(result.data());
}
}
);
require_once('crest.php');
$result = CRest::call(
'sale.shipment.get',
[
'id' => 2465
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
Successful Response
HTTP status: 200
{
"result": {
"shipment": {
"accountNumber": "2069/2",
"allowDelivery": "N",
"basePriceDelivery": 600,
"canceled": "N",
"comments": "",
"companyId": 0,
"currency": "USD",
"customPriceDelivery": "N",
"dateAllowDelivery": null,
"dateCanceled": null,
"dateDeducted": null,
"dateInsert": "2024-04-11T15:05:48+02:00",
"dateMarked": null,
"dateResponsibleId": "2024-04-11T15:05:48+02:00",
"deducted": "N",
"deliveryDocDate": null,
"deliveryDocNum": "",
"deliveryId": 2,
"deliveryName": "Courier Delivery",
"deliveryXmlId": "",
"discountPrice": 0,
"empAllowDeliveryId": null,
"empCanceledId": null,
"empDeductedId": null,
"empMarkedId": null,
"empResponsibleId": null,
"externalDelivery": "N",
"id": 2465,
"id1c": "",
"marked": "N",
"orderId": 2069,
"priceDelivery": 600,
"reasonMarked": "",
"reasonUndoDeducted": "",
"responsibleId": 0,
"shipmentItems": [
{
"basketId": 2721,
"dateInsert": "2024-04-11T15:05:51+02:00",
"id": 10,
"orderDeliveryId": 2465,
"quantity": 1,
"reservedQuantity": 1,
"xmlId": "bx_6617e02cb74f9"
}
],
"statusId": "DN",
"statusXmlId": "FFdddd",
"system": "N",
"trackingDescription": "",
"trackingLastCheck": "",
"trackingNumber": "",
"trackingStatus": "",
"updated1c": "N",
"version1c": "",
"xmlId": "bx_6617e02cae2a1"
}
},
"time": {
"start": 1712840827.02634,
"finish": 1712840827.41618,
"duration": 0.38983988761901855,
"processing": 0.21664810180664062,
"date_start": "2024-04-11T16:07:07+02:00",
"date_finish": "2024-04-11T16:07:07+02:00"
}
}
Returned Data
|
Name |
Description |
|
result |
Root element of the response |
|
property |
Shipment information |
|
time |
Information about the request execution time |
Error Handling
HTTP status: 400
{
"error": 201140400001,
"error_description": "shipment does not exist"
}
|
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 |
|
|
Shipment not found |
|
|
Insufficient permissions to read the shipment |
|
|
Parameter |
|
|
Other errors (e.g., fatal errors) |
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 |