Получить поля отгрузки sale.shipment.get

Scope: sale

Кто может выполнять метод: администратор

Метод получает значения всех полей отгрузки.

Параметры метода

Обязательные параметры отмечены *

Название
тип

Описание

id*
sale_order_shipment.id

Идентификатор отгрузки

Примеры кода

Как использовать примеры в документации

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
        
try
        {
        	const response = await $b24.callMethod(
        		"sale.shipment.get", {
        			"id": 2465
        		}
        	);
        	
        	const result = response.getData().result;
        	console.info(result);
        }
        catch( error )
        {
        	console.error(error);
        }
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'sale.shipment.get',
                    [
                        'id' => 2465,
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
            // Нужная вам логика обработки данных
            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>';

Ответ в случае успеха

HTTP-статус: 200

{
           "result":{
              "shipment":{
                 "accountNumber":"2069\/2",
                 "allowDelivery":"N",
                 "basePriceDelivery":600,
                 "canceled":"N",
                 "comments":"",
                 "companyId":0,
                 "currency":"RUB",
                 "customPriceDelivery":"N",
                 "dateAllowDelivery":null,
                 "dateCanceled":null,
                 "dateDeducted":null,
                 "dateInsert":"2024-04-11T15:05:48+03:00",
                 "dateMarked":null,
                 "dateResponsibleId":"2024-04-11T15:05:48+03:00",
                 "deducted":"N",
                 "deliveryDocDate":null,
                 "deliveryDocNum":"",
                 "deliveryId":2,
                 "deliveryName":"Доставка курьером",
                 "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+03: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+03:00",
              "date_finish":"2024-04-11T16:07:07+03:00"
           }
        }

Возвращаемые данные

Название
тип

Описание

result
object

Корневой элемент ответа

property
sale_order_shipment

Информация об отгрузке

time
time

Информация о времени выполнения запроса

Обработка ошибок

HTTP-статус: 400

{
           "error":201140400001,
           "error_description":"shipment is not exists"
        }

Название
тип

Описание

error
string

Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания

error_description
error_description

Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде

Возможные коды ошибок

Код

Описание

201140400001

Отгрузка не найдена

200040300010

Недостаточно прав для чтения отгрузки

100

Не указан параметр id

0

Другие ошибки (например, фатальные ошибки)

HTTP-статус: 20x, 40x, 50x

Описанные ниже ошибки могут возникнуть при вызове любого метода

Статус

Код
Текст ошибки

Описание

500

INTERNAL_SERVER_ERROR
Internal server error

Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24

503

QUERY_LIMIT_EXCEEDED
Too many requests

Превышен лимит на интенсивность запросов

405

ERROR_BATCH_METHOD_NOT_ALLOWED
Method is not allowed for batch usage

Текущий метод не разрешен для вызова с помощью batch

400

ERROR_BATCH_LENGTH_EXCEEDED
Max batch length exceeded

Превышена максимальная длина параметров, переданных в метод batch

401

NO_AUTH_FOUND
Wrong authorization data

Неверный access-токен или код вебхука

400

INVALID_REQUEST
Https required

Для вызовов методов требуется использовать протокол HTTPS

503

OVERLOAD_LIMIT
REST API is blocked due to overload

REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24

403

ACCESS_DENIED
REST API is available only on commercial plans

REST API доступен только на коммерческих планах

403

INVALID_CREDENTIALS
Invalid request credentials

У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав

404

ERROR_MANIFEST_IS_NOT_AVAILABLE
Manifest is not available

Манифест недоступен

403

insufficient_scope
The request requires higher privileges than provided by the webhook token

Запрос требует более высоких привилегий, чем предоставляет токен вебхука

401

expired_token
The access token provided has expired

Предоставленный access-токен доступа истек

403

user_access_error
The user does not have access to the application

Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям

500

PORTAL_DELETED
Portal was deleted

Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

Продолжите изучение

Предыдущая
Обновить отгрузку
Следующая
Получить список отгрузок