Get Delivery Information by ID crm.item.delivery.get
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:
crmWho can execute the method: a user with read access to the order the delivery belongs to
The method crm.item.delivery.get returns brief information about a delivery.
A delivery is a shipment of an order linked to a CRM object. The method returns a fixed set of fields — you cannot select other shipment fields. The full set is returned by the sale.shipment.get method, but it is available to administrators only.
How deliveries are linked to CRM objects is described in the overview of the section methods.
The method does not check which CRM object the delivery belongs to and returns any delivery the user has access to. The crm.item.delivery.list method excludes system shipments and shipments without a delivery service from the list, while crm.item.delivery.get returns them.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
Delivery identifier. You can retrieve the delivery identifiers of a CRM object using the crm.item.delivery.list method |
Code Examples
How to Use Examples in Documentation
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":4077}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.item.delivery.get
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":4077,"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/crm.item.delivery.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 DeliveryGetResult = {
id: number
accountNumber: string
deducted: string
dateDeducted: ISODate | null
deliveryId: number
priceDelivery: number
currency: string
deliveryName: string
}
try {
const response = await $b24.actions.v2.call.make<DeliveryGetResult>({
method: 'crm.item.delivery.get',
params: {
id: 4077,
},
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.id, result.deliveryName, result.priceDelivery, result.currency)
}
} 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 getDelivery() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'crm.item.delivery.get',
params: {
id: 4077,
},
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.id, result.deliveryName, result.priceDelivery, result.currency)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', getDelivery)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.crm.item.delivery.get(
bitrix_id=4077,
).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(
'crm.item.delivery.get',
[
'id' => 4077,
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result, true);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error getting delivery item: ' . $e->getMessage();
}
BX24.callMethod(
'crm.item.delivery.get', {
id: 4077,
},
function(result) {
if (result.error()) {
console.error(result.error());
} else {
console.log(result.data());
}
}
);
require_once('crest.php');
$result = CRest::call(
'crm.item.delivery.get',
[
'id' => 4077
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
// client and ctx are already created — see the Go SDK section
res, err := client.Core().Call(ctx, "crm.item.delivery.get", b24.Params{
"id": 4077,
}, b24.WithIdempotent())
if err != nil {
return fmt.Errorf("crm.item.delivery.get: %w", err)
}
var item struct {
ID b24.ID `json:"id"`
AccountNumber string `json:"accountNumber"`
Deducted string `json:"deducted"`
DateDeducted *string `json:"dateDeducted"`
DeliveryID b24.ID `json:"deliveryId"`
PriceDelivery float64 `json:"priceDelivery"`
Currency string `json:"currency"`
DeliveryName string `json:"deliveryName"`
}
if err := json.Unmarshal(res.Result, &item); err != nil {
return fmt.Errorf("parse response: %w", err)
}
fmt.Println(item.ID, item.AccountNumber, item.DeliveryName)
Response Handling
HTTP status: 200
{
"result":{
"id":4077,
"accountNumber":"3657\/2",
"deducted":"N",
"dateDeducted":null,
"deliveryId":228,
"priceDelivery":79.99,
"currency":"USD",
"deliveryName":"Uber Taxi (Cargo)"
},
"time":{
"start":1716369295.614557,
"finish":1716369296.143089,
"duration":0.5285320281982422,
"processing":0.2371680736541748,
"date_start":"2024-05-22T12:14:55+03:00",
"date_finish":"2024-05-22T12:14:56+03:00"
}
}
Returned Data
|
Name |
Description |
|
result |
Object with brief information about the delivery (detailed description) |
|
time |
Information about the request execution time |
Object result
|
Name |
Description |
|
Delivery identifier |
|
|
accountNumber |
System delivery number. For example, |
|
deducted |
Indicates whether the delivery has been shipped. Possible values:
|
|
dateDeducted |
Date and time when the |
|
deliveryId |
Delivery service identifier. You can retrieve the list of delivery services using the sale.delivery.getlist method |
|
priceDelivery |
Delivery cost |
|
currency |
Character code of the delivery currency. For example, |
|
deliveryName |
Delivery service name. For example, |
Error Handling
HTTP status: 400
{
"error":"0",
"error_description":"Delivery has not been found"
}
|
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
|
Status |
Code |
Description |
Value |
|
|
|
Delivery has not been found |
There is no delivery with such |
|
|
|
Could not find value for parameter |
The required parameter |
|
|
|
Invalid value {value} to match with parameter {id}. Should be value of type int |
The value of |
|
|
|
Access denied |
The user has no read access to the order the delivery belongs to. Read access to the CRM object where this delivery is visible does not clear the error |
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 |