Перейти к содержимому

DeleteGMH: Удаление ГМХ

SOAP Endpoint: DeleteGMH Обновлено: 2026-05-16
  • Endpoint: DeleteGMH
  • SOAP-метод: DeleteGMH
  • Группа: DeleteGMH
  • Создано: 16.04.2026 · Обновлено: 16.05.2026

Описание

Функция позволяет удалить грузовые места, при условии что документ, в который добавляются места, не обработан (не проведен)

Параметры запроса

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

Описание параметра parameters

Описание: Параметры документа, из которого удаляются грузовые места. Каждый параметр представлен отдельным блоком List, содержащим:

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

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

Параметр
Тип
Обязательно
Описание
DocumentType
string
да
Тип документа, из которого удаляются ГМХ
Number
string
нет
Номер документа
numbertype
string
да
Номер документа, в который будут добавляться грузовые места.

Описание параметра data

одержит список грузовых мест для создания. Содержит Key = "GMH" и список элементов List

List содержит данные о каждом грузовом месте с Key отражающем идентификатор грузоместа и структурой Fields отражающую параметры грузового места (габариты, вес, код клиента). Каждый параметр представлен отдельным блоком Fields, содержащим:

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

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

Параметр
Тип
Обязательно
Описание
GMH_Number
string
нет
Номер грузового места хранения, которое вернула система Карго
GMH_GUID
string
нет
GUID грузового места хранения, которое вернула система Карго

Описание возвращаемого параметра return

Содержит пару параметров Key и List содержащие ответ по одному грузовому месту

Структура List пару параметров Key и Properties содержащие информацию по одному из параметров грузового места. Каждый параметр представлен отдельным блоком Properties, содержащим:

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

---

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

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

Параметр
Тип
Обязательно
Описание
GMH
string
нет
Номер удалённого грузового места
Delete
boolean
нет
Результат удаления: true — успешно, false — ошибка

Пример запроса (XML Request)

xml
<soapenv:Envelope
  xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
  xmlns:car="http://www.cargo3.ru">
  <soapenv:Header/>
  <soapenv:Body>
    <car:DeleteGMH>
      <car:Login>test</car:Login>
      <car:Password>2016</car:Password>
      <car:data>
        <car:Key>GMH</car:Key>
        <car:List>
          <car:Key>#PC#888-385 -00000000021</car:Key>
          <car:Fields>
            <car:Key>GMH_Number</car:Key>
            <car:Value>#PC#888-385 -00000000021</car:Value>
            <car:ValueType>string</car:ValueType>
          </car:Fields>
        </car:List>
      </car:data>
      <car:parameters>
        <car:Key>parameters</car:Key>
        <car:List>
          <car:Key>DocumentType</car:Key>
          <car:Value>waybill</car:Value>
          <car:ValueType>string</car:ValueType>
        </car:List>
        <car:List>
          <car:Key>Number</car:Key>
          <car:Value>888-0006983-00004806</car:Value>
          <car:ValueType>string</car:ValueType>
        </car:List>
        <car:List>
          <car:Key>numbertype</car:Key>
          <car:Value>innernumber</car:Value>
          <car:ValueType>string</car:ValueType>
        </car:List>
      </car:parameters>
    </car:DeleteGMH>
  </soapenv:Body>
</soapenv:Envelope>

Пример ответа (XML Response)

xml
<soap:Envelope
  xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <m:DeleteGMHResponse
      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>DeleteGMH</m:Key>
        <m:List>
          <m:Key>GMH</m:Key>
          <m:Properties>
            <m:Key>GMH</m:Key>
            <m:Value xsi:type="xs:string">#PC#888-385 -00000000021</m:Value>
            <m:ValueType>string</m:ValueType>
          </m:Properties>
          <m:Properties>
            <m:Key>Delete</m:Key>
            <m:Value xsi:type="xs:boolean">true</m:Value>
            <m:ValueType>boolean</m:ValueType>
          </m:Properties>
        </m:List>
      </m:return>
    </m:DeleteGMHResponse>
  </soap:Body>
</soap:Envelope>