Try it — GetFormsForDocuments
SOAP Request

Отредактируйте параметры запроса и нажмите Выполнить для отправки запроса на сервер

GetFormsForDocuments: Получение скана накладной или печатной формы

  • Создано 16.04.2026
  • Обновлено 15.05.2026
  • Endpoint: GetFormsForDocuments
  • Soap-method: GetFormsForDocuments
Описание

Получение печатных форм или скан-копий документов (накладная, заказ, грузовое место)

Параметры запроса
Параметр Тип Обязательно Описание
login string Логин пользователя
password string Пароль
parameters Element Список параметров
documents Element Список документов
Описание параметра parameters

Параметры формирования документа (тип документа, формат, вид выдачи и т.д.). Каждый параметр представлен отдельным блоком List, содержащим:

  • Key — название параметра (варианты в таблице ниже)
  • Value — значение этого параметра
  • ValueType — тип значения этого параметра

Таблица параметров (возможные значения Key внутри List):

Параметр Тип Обязательно Описание
DocumentType string Тип отслеживаемых документов, может быть «Order»/«Orders» (для заказов), или «Waybill»/«Waybills» (для накладных)
Type string В данном параметре указываем «scan» для получения скана документа. «print» для получения печатной формы документа
Format string Формат возвращаемого документа. (по-умолчанию PDF). Возможные варианты: pdf, xlsx, xls, mxl.
Name string ТОЛЬКО ДЛЯ «PRINT». Название печатной формы.
Для заказа - Универсальная печатная форма документа ЗАКАЗ.
Для накладной - Универсальная печатная форма документа НАКЛАДНАЯ.
Для грузовой марки - Марка ГМХ. Название печатной формы можно уточнить у менеджера.
NumberType string Позволяет указать, какой тип номера использовать для поиска документа. Если тип номера не указан, то используется внутренний номер. Допустимые значения:
«ClientNumber» (номер клиента),
«AgentNumber» (номер агента),
«OrderNumber»(номер заказа, используется только для накладных)
«PackageID» (номер упаковки (ГМХ), указанной в составном грузе документа)
OnlySelectedType boolean Признак того, что поиск будет выполняться строго по номеру, указанному в NumberType. Если этот признак не установлен, то в случае неудачи поиска по номеру, указанному в NumberType документ ищется по внутреннему номеру системы «Карго».
Описание параметра documents

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

Содержит Key передающий фиксированное имя контейнера Documents , а так же List с перечнем документов указанных через параметр Key 

Параметр Тип Обязательно Описание
Key string Фиксированное имя контейнера
List Element Группирует один идентификатор документа. Каждый List содержит Key с номером документа
Key (внутри List) string Номер накладной, заказа или идентификатор грузового места (ГМХ)
Описание возвращаемых параметров return

Если во время запроса произошла ошибка, информация о ней будет отражена в свойстве Properties (см. метод GetReferenceData: ErrorCodes — Коды ошибок). 

При успешном выполнении метода вернутся данные в виде:

Параметр Тип Обязательно Описание
Key string Название выполненного метода GetPrintForms
List Element Группирует данные одного документа
Описание возвращаемых параметров List

Содержит информацию об одном полученном документе

Параметр Тип Обязательно Описание
Key string Идентификатор документа (номер накладной, заказа или ГМХ)
Properties Element Содержит свойства документа (повторяется для каждого параметра)
BData base64Binary Двоичные данные файла в кодировке Base64
Описание возвращаемых параметров Properties

Отображает свойства документа. Каждый параметр представлен отдельным блоком Properties, содержащим:

  • Key — название параметра (варианты в таблице ниже)
  • Value — значение этого параметра
  • ValueType — тип значения этого параметра

Таблица параметров (возможные значения Key):

Параметр Тип Обязательно Описание
DocumentType string Тип документа
DocumentName string Внутренне название документа в системе «Карго»
GUID string (GUID) Уникальный идентификатор документа в системе «Карго»
Date dateTime Дата и время формирования документа в системе «Карго»
Number string Номер документа в системе «Карго»
FormName string Название печатной формы (если запрашивалась)
FormFormat string Формат полученного файла
Примеры запроса/ответа 
<soap:Envelope
  xmlns:soap="http://www.w3.org/2003/05/soap-envelope">
  <soap:Header />
  <soap:Body>
    <m:GetFormsForDocuments
      xmlns:m="http://www.cargo3.ru">
      <m:login>Login</m:login>
      <m:password>password</m:password>
      <m:documents>
        <m:Key>Documents</m:Key>
        <m:List>
          <m:Key>№ документа</m:Key>
        </m:List>
      </m:documents>
      <m:parameters>
        <m:Key>Parameters</m:Key>
        <m:List>
          <m:Key>DocumentType</m:Key>
          <m:Value>waybill</m:Value>
          <m:ValueType>string</m:ValueType>
        </m:List>
        <m:List>
          <m:Key>Type</m:Key>
          <m:Value>scan</m:Value>
          <m:ValueType>string</m:ValueType>
        </m:List>
        <m:List>
          <m:Key>OnlyPath</m:Key>
          <m:Value>false</m:Value>
          <m:ValueType>boolean</m:ValueType>
        </m:List>
        <m:List>
          <m:Key>Format</m:Key>
          <m:Value>PDF</m:Value>
          <m:ValueType>string</m:ValueType>
        </m:List>
      </m:parameters>
    </m:GetFormsForDocuments>
  </soap:Body>
</soap:Envelope>
<soap:Envelope
  xmlns:soap="http://www.w3.org/2003/05/soap-envelope">
  <soap:Body>
    <m:GetFormsForDocumentsResponse
      xmlns:m="http://www.cargo3.ru">
      <m:return
        xmlns:xs="http://www.w3.org/2001/XMLSchema"
        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
        <m:Key>GetPrintForms</m:Key>
        <m:List>
          <m:Key>496-AA-1676378</m:Key>
          <m:Properties>
            <m:Key>DocumentType</m:Key>
            <m:Value xsi:type="xs:string">Waybill</m:Value>
            <m:ValueType>string</m:ValueType>
          </m:Properties>
          <m:Properties>
            <m:Key>DocumentName</m:Key>
            <m:Value xsi:type="xs:string">Накладная</m:Value>
            <m:ValueType>string</m:ValueType>
          </m:Properties>
          <m:Properties>
            <m:Key>GUID</m:Key>
            <m:Value xsi:type="xs:string">0dc919e6-6d46-11f0-869d-005056a355e0</m:Value>
            <m:ValueType>string</m:ValueType>
          </m:Properties>
          <m:Properties>
            <m:Key>Date</m:Key>
            <m:Value xsi:type="xs:dateTime">2025-07-30T16:05:46</m:Value>
            <m:ValueType>dateTime</m:ValueType>
          </m:Properties>
          <m:Properties>
            <m:Key>Number</m:Key>
            <m:Value xsi:type="xs:string">496-AA-1676378</m:Value>
            <m:ValueType>string</m:ValueType>
            undefined
          
          </m:Properties>undefined
          
          <m:Properties>
            <m:Key>FormName</m:Key>undefined
          
          </m:Properties>undefined
          
          <m:Properties>
            <m:Key>FormFormat</m:Key>
            <m:Value xsi:type="xs:string">PDF</m:Value>
            <m:ValueType>string</m:ValueType>undefined
          
          </m:Properties>undefined
          
          <m:BData>iVBORw0KGgoAAAANSUhEUgAA..................</m:BData>undefined
        
        </m:List>undefined
      
      </m:return>undefined
    
    </m:GetFormsForDocumentsResponse>undefined
  
  </soap:Body>undefined

</soap:Envelope>