SaveWaybillOffice: Накладные/накладные с товарами
Функция сохраняет новые накладные в систему «Карго», а также позволяет создавать накладные содержащие список товаров ...
SOAP
Endpoint: SaveWaybillOffice
Обновлено: 2026-05-20
- Endpoint:
SaveWaybillOffice - SOAP-метод:
SaveWaybillOffice - Группа: SaveWaybillOffice
- Создано: 16.04.2026 · Обновлено: 20.05.2026
Описание
Функция сохраняет новые накладные в систему «Карго», а также позволяет создавать накладные содержащие список товаров в отправлении
Параметры запроса
Метод «Сохранить накладную». Содержит авторизацию и основные данные заказа.
Параметр | Тип | Обязательно | Описание |
|---|---|---|---|
login | string | да | Логин пользователя |
password | string | да | Пароль |
Company | string | да | Не используется |
Number | string | нет | Номер накладной для редактирования |
ClientNumber | string | нет | Клиентский номер документа, максимальное количество символов – 20 |
OrderData | OrderData | нет | Структура данных для заполнения документа |
Office | string | нет | Не используется |
Описание параметра OrderData
Основной контейнер с данными накладной. Вся информация о перевозке.
Параметр | Тип | Обязательно | Описание |
|---|---|---|---|
ClientContact | string | нет | Контактное лицо клиента |
TakeDate | dateTime | да | Дата и время забора накладной. Обязательно передавать время (yyyy-mm-ddThh:MM:ss) |
Comment | string | нет | Комментарий к накладной |
Repository | string | нет | Склад (GUID), если подключено более одного склада, параметр становится обязателен к заполнению. Используется для накладных с товарами |
ReplySMSPhone | string | нет | Телефон для смс информирования |
ReplyEMail | string | нет | Адрес электронной почты для уведомлений. Формат: <имя пользователя >@<почтовый сервер>. Пример:test@test.com |
Sender | DestinationInformation | да | Данные об отправителе |
Recipient | DestinationInformation | да | Данные о получателе |
TypeOfPayer | int | да | Плательщик, по умолчанию - заказчик. Если вы клиент с категорией не ИМ и в качестве плательщика(TypeOfPayer) указываете заказчика, то ограничения по оплате будут действовать согласно договору. Получить актуальный список способов оплаты можно функцией GetReferenceData:способы оплаты . Если плательщик не заказчик, то способ оплаты должен быть наличный расчет. При указании неверного способа оплаты возникнет ошибка. |
WayOfPayment | int | да | Способо оплаты, по умолчанию - безнал |
TypeOfCargo | string | нет | Вид груза (GUID), по умолчанию - груз |
WithReturn | boolean | нет | Признак того, что отправление требует температурного режима, возврата термоконтейнера и термодатчика |
Department | string | нет | GUID (Globally Unique Identifier) подразделения (получение списка подразделений см. GetReferenceData: подразделения), или подразделение в виде наименования |
DescriptionForTheVPDreturn | string | нет | Описание возврата для ВПД (Возврат при доставке) |
Project | string | нет | Проект клиента (GUID) . При необходимости указания в накладных, будет предоставлен менеджером |
DeliveryOfCargo | int | нет | Тип значения NameOfdeliverytype вида доставки(получение списка видов доставки см. GetReferenceData: DeliveryType - Виды доставок) |
DeliveryDate | dateTime | нет | Согласованная дата доставки начало интервала. Передавать в формате дата время (yyyy-mmddThh:MM:ss). Если параметр передается, то дата доставки должна быть больше даты забора и времени создания документа. Рекомендуется передача даты и интервала, полученных из ответа функции GerReferenceData:AvailableDeliveryDates (Возможные даты доставки). |
DeliveryDateOf | dateTime | нет | Согласованная дата доставки конец интервала. Передавать в формате дата время (yyyy-mmddThh:MM:ss). Параметр становится обязательным, если передан DeliveryDate (Согласованная дата доставки начало интервала) |
ParentOrderForWaybill | string | нет | Номер заказа или накладной (КСЕ) |
TypeOfParentForWaybill | string | нет | Тип документа основания (order/waybill) (КСЕ) |
ArrayOfDocumentsPhoto | DocumentsPhoto | нет | Список документов для фотосъемки при работе клиента в данном режиме (только для накладных) (если список документов отличается от типового) |
ClientCodes | ListOfCorrespondences | нет | Список дополнительных номеров |
AdditionalServices | AdditionalServices | нет | Список дополнительных услуг |
Описание параметра Sender и Recipient (тип DestinationInformation)
Параметры которые могут содержаться в массиве отправителя и получателя
Параметр | Тип | Обязательно | Описание |
|---|---|---|---|
Client | String | да | Отправитель/Получатель |
Official | string | нет | Контактное лицо отправителя/получателя |
Address | DestinationAddress | да | Адрес отправителя/получателя |
Info | string | нет | Комментарий отправителя/получателя |
Phone | string | да | Телефон отправителя/получателя |
Cargo | Cargo | нет | Данные о грузе, только для получателей (для них обязательный) |
EMail | string | нет | Адрес электронной почты отправителя/получателя Формат: <имя пользователя >@<почтовый сервер>. Пример:test@test.com |
Urgency | string | да | GUID Срочности в соответствии с договором, параметр необходимо передавать в блоке получателя, (получение списка срочностей см. GetReferenceData: URGENCIES) |
Products | Products | нет | Данные о товарах (Могут передавать только ИМ) |
DeliveryOptions | DeliveryOptions | нет | Данные об опциях доставки |
PVZ | string | нет | GIUD пункта выдачи заказов (данные берутся из метода, описанного выше) или Код карточки ПВЗ (передается в формате PVZID-000075020) |
Описание параметра Address (тип destinationAddress)
Содержит данные адреса.
Параметр | Тип | Обязательно | Описание |
|---|---|---|---|
Geography | string | да | -Населенный пукнт (GUID). -Либо код ФИАС, для этого необходимо передать строку «fias-» и необходисмый код ФИАС. -Для поиска по индексу: «postcode-», затем код страны (цифровой, либо Альфа-2, либо Альфа-3) и индекс для поиска – пример «postcode-KZA00A0A0». Если код страны не вводится, по умолчанию поиск осуществляется по России. Пример для России: «postcode-RU-990500» или «postcode-990500» (данный вариант поиска может возвращать не точную информацию). |
Index | string | нет | Индекс Отправителя/Получателя. Обязательно только для международных отправлений; |
FreeForm | string | да | Всегда истина (true) |
Info | string | да | Адрес целиком. Info:Можно указать в параметре Info в DESTINATIONINFORMATION. 1. Название страны – обязательно только для международных отправлений; 2. Название республики, края, области, автономного округа (области) – обязательно к передаче; 3. Название района – при отсутствии заполнять необязательно; 4. Название населенного пункта – обязательно к передаче; 5. Название улицы, номер дома, номер квартиры – при отсутствии заполнять необязательно. Разделитель - запятая «,». Пример: 115432, г Москва, проезд Проектируемый 4062-й, дом 6, стр 2 Комментарии к адресу, такие как: ∙ Этаж; ∙ Домофон; ∙ Наименование ТЦ/БЦ; ∙ Ориентиры и другая информация, помогающая выполнить сбор/доставку. |
Описание параметра Cargo (тип Cargo)
Список параметров для описания груза
Параметр | Тип | Обязательно | Описание |
|---|---|---|---|
CargoDescription | string | нет | Описание груза |
CargoPackageQty | string | да | Количество груза |
Weight | float | да | Вес груза |
VolumeWeight | float | нет | Объемный вес |
Volume | float | нет | Объем, м3 |
Length | float | нет | Длина |
Width | float | нет | Ширина |
Height | float | нет | Высота |
InsuranceRate | float | нет | Сумма страховой стоимости |
InsuranceRateCurrency | string | нет | Валюта страховой стоимости (по – умолчанию руб.) |
DeclaredValueRate | float | нет | Сумма объявленной стоимости |
DeclaredValueRateCurrency | string | нет | Валюта объявленной стоимости (по – умолчанию руб.) |
ValueForCustomsPurposes | float | нет | Таможенная стоимость груза |
ValueForCustomsPurposesCurrency | string | нет | GUID (Globally Unique Identifier) валюты таможенной стоимости груза (получение списка валют см. GetReferenceData: валюты); если не указано, то валюта – доллар |
PackageID | string | нет | Номер упаковки |
COD | float | нет | Сумма наложенного платежа. Плательщик всегда получатель. Только для ИМ. Заполняется из общей суммы за товары. Если передавали CustomerPrepayment, то COD заполняется, общая сумма за товары минус предоплата. |
CODCurrency | string | нет | GUID (Globally Unique Identifier) валюты наложенного платежа (получение списка валют см. GetReferenceData: валюты); если не указано, то валюта – рубли. |
CustomerPrepayment | float | нет | Сумма предоплаты за товар. Сумма предоплаты не может быть больше суммы за товары. Только для ИМ |
CargoPackages | CargoPackages | нет | Информация по грузовым местам |
Описание параметра CargoPackages(тип CargoPackages)
Содержит описание грузового места
Параметр | Тип | Обязательно | Описание |
|---|---|---|---|
Length | float | нет | Длина |
Width | float | нет | Ширина |
Height | float | нет | Высота |
Package | string | нет | GUID упаковки (packages) |
Weight | float | да | Вес груза |
VolumeWeight | float | нет | Объемный вес |
PackageQty | string | да | Количество груза |
PackageID | string | нет | Номер упаковки |
Описание параметра Products (тип Products )
Описание товарных позиций отправления.
Обратите внимание, перед созданием накладной необходимо передать все используемые в ней товары (функция). Для передачи параметров Party и SerialNumber у товара должен быть установлен соответствующий признак учета.
Параметр | Тип | Обязательно | Описание |
|---|---|---|---|
Article | string | да | Артикул товара |
Name | string | нет | Наименование товара или его GUID в справочнике |
Price | float | нет | Цена за единицу товара. По-умолчанию 0. |
PackageQty | int | нет | Количество упаковок товара |
Qty | int | нет | Количество единиц товара (Пересчитывается из количества упаковок) |
VATRate | int | нет | Код ставки НДС (получение списка ставок см. GetReferenceData: ставки НДС: ставки НДС). -Если переданная ставка НДС отличается от ставки НДС в карточке товара, в документе запишутся данные из запроса. - Если передана ставка НДС «0%» или «Без НДС» – в документе записывается «Без НДС». - Если ставка НДС не передана, в создаваемом документе, ставка НДС для товара будет записана из карточки товара |
AssessedValue | float | нет | Оценочная стоимость товара |
Comment | string | нет | Комментарий к товару |
SerialNumber | string | нет | GUID серийного номера товара |
UIN | string | нет | GUID (Globally Unique Identifier) – УИН ювелирного изделия |
Party | string | нет | GUID партии товара |
Описание параметра DeliveryOptions (тип DeliveryOptions)
Описание опций доставки
Параметр | Тип | Обязательно | Описание |
|---|---|---|---|
CashOnDelivery | boolean | нет | Признак наложенного платежа (true/false) |
Описание параметра ClientCodes (тип ClientCodes)
Пользовательские коды
Параметр | Тип | Обязательно | Описание |
|---|---|---|---|
Items | string | нет | GUID или код |
Info | string | нет | Значение кода |
Описание параметра ArrayOfDocumentsPhoto (тип ArrayOfDocumentsPhoto)
Параметр | Тип | Обязательно | Описание |
|---|---|---|---|
Document | string | нет | GUID типа документа |
Required | boolean | нет | Обязателен ли документ (true/false) |
Описание параметра AdditionalServices (тип AdditionalServices)
Параметр | Тип | Обязательно | Описание |
|---|---|---|---|
Items | string | да | GUID дополнительной услуги |
Qty | float | нет | Количество, используется для передачи номера этажа |
Описание параметра возвращаемого параметра return
Параметр | Тип | Обязательно | Описание |
|---|---|---|---|
Error | boolean | да | Флаг ошибки на уровне всего ответа. true — есть ошибка, false — успех |
ErrorInfo | string | нет | Общее сообщение об ошибке (если есть) или пустая строка |
Items | Items | нет | Параметр для описания одного результата операции. Может повторяться при создании нескольких накладных за один запрос (например, при нескольких отправлениях) |
Описание параметра возвращаемого параметра Items
Структура Items
Параметр | Тип | Обязательно | Описание |
|---|---|---|---|
Value | string | нет | Номер созданной накладной (успешный случай) или код ошибки / идентификатор |
Error | boolean | да | Флаг ошибки для конкретной накладной. true — ошибка, false — успешно создана |
ErrorInfo | string | нет | Текст ошибки (если Error = true) или вспомогательная информация (например, ClientNumber из запроса). |
Пример запроса (XML Request)
<?xml version="1.0" encoding="UTF-8"?>
<soap:Envelope
xmlns:soap="http://www.w3.org/2003/05/soap-envelope"
xmlns:ns1="http://www.cargo3.ru"
xmlns:xs="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<soap:Header />
<soap:Body>
<ns1:SaveWaybillOffice>
<ns1:Language />
<ns1:Login>test</ns1:Login>
<ns1:Password>2016</ns1:Password>
<ns1:Company />
<ns1:Number />
<ns1:ClientNumber>148704450</ns1:ClientNumber>
<ns1:OrderData>
<ns1:ClientContact />
<ns1:DeliveryDate>2025-09-30T09:00:00</ns1:DeliveryDate>
<ns1:Recipient>
<ns1:Client>ТЕСТ</ns1:Client>
<ns1:Official />
<ns1:Address>
<ns1:Geography>postcode-127018</ns1:Geography>
<ns1:Info>АДРЕС ПОЛУЧАТЕЛЯ</ns1:Info>
<ns1:FreeForm>true</ns1:FreeForm>
</ns1:Address>
<ns1:Phone>100</ns1:Phone>
<ns1:Urgency>18c4f209-458b-11dc-9497-0015170f8c09</ns1:Urgency>
<ns1:Cargo>
<ns1:CargoPackageQty>1</ns1:CargoPackageQty>
<ns1:Weight>1</ns1:Weight>
<ns1:COD>6047.0</ns1:COD>
<ns1:CustomerPrepayment>1.0</ns1:CustomerPrepayment>
</ns1:Cargo>
<ns1:Products>
<ns1:Article>УТ-00727861</ns1:Article>
<ns1:Name>5d93f941-bf99-11ea-aa80-005056bb6b60</ns1:Name>
<ns1:Price>50.0</ns1:Price>
<ns1:PackageQty>1</ns1:PackageQty>
</ns1:Products>
<ns1:Products>
<ns1:Article>УТ-12915747</ns1:Article>
<ns1:Name>74dbb15c-c039-11ea-ae8c-005056bb6b60</ns1:Name>
<ns1:Price>1999.0</ns1:Price>
<ns1:PackageQty>3</ns1:PackageQty>
</ns1:Products>
</ns1:Recipient>
<ns1:Sender>
<ns1:Client>ТЕСТ</ns1:Client>
<ns1:Address>
<ns1:Geography>cf862f56-442d-11dc-9497-0015170f8c09</ns1:Geography>
<ns1:Info>АДРЕС ОТПРАВИТЕЛЯ</ns1:Info>
<ns1:FreeForm>true</ns1:FreeForm>
</ns1:Address>
<ns1:Phone>1110</ns1:Phone>
</ns1:Sender>
<ns1:TakeDate>2025-09-01T09:00:00</ns1:TakeDate>
<ns1:TypeOfCargo>4aab1fc6-fc2b-473a-8728-58bcd4ff79ba</ns1:TypeOfCargo>
<ns1:TypeOfPayer>0</ns1:TypeOfPayer>
<ns1:WayOfPayment>1</ns1:WayOfPayment>
<ns1:DeliveryOfCargo>ДоставкаДоДверей</ns1:DeliveryOfCargo>
<ns1:DeliveryDateOf>2025-09-30T18:00:00</ns1:DeliveryDateOf>
</ns1:OrderData>
<ns1:Office />
</ns1:SaveWaybillOffice>
</soap:Body>
</soap:Envelope>Пример ответа (XML Response)
<soap:Envelope
xmlns:soap="http://www.w3.org/2003/05/soap-envelope">
<soap:Body>
<m:SaveWaybillOfficeResponse
xmlns:m="http://www.cargo3.ru">
<m:return
xmlns:xs="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchemainstance">
<m:Items>
<m:Value>496-0106983-00001247</m:Value>
<m:Error>false</m:Error>
<m:ErrorInfo>148704450</m:ErrorInfo>
</m:Items>
<m:Error>false</m:Error>
<m:ErrorInfo/>
</m:return>
</m:SaveWaybillOfficeResponse>
</soap:Body>
</soap:Envelope>