EDI
×

ListMb

Метод для получения списка входящих документов.
 
Примечание: документы типа ORDER_PLN возвращаются в списке вместе с документами типа ORDERS.
 
Параметры вызова:
Наименование
Формат
Обязательность
Описание
 
Name
Строка
+
Имя пользователя в сервисе «EDI Электронный обмен данными»
 
Password
Строка
+
Пароль пользователя
 
RelationId
Строка
+
Идентификатор входящей (direction = IN) взаимосвязи Relationships
 
DocumentStatus
Строка
-
Статус документа:
  • N - новый,
  • R - прочитанный,
  • A - все типы
По умолчанию - A
DeliveryPointGln
Строка
-
GLN точки доставки по документу
Можно ввести максимально до 50 точек доставки в одном поле через разделитель «;»
DocDateFrom
Дата в формате YYYY-MM-DDTHH:MM:SS+03:00
-
Фильтр по дате документа - начало периода
Ограничения по дате обработки и дате документа: 
  • если указан период обработки, захватывающий даты раньше, чем от текущей даты до 6 мес. назад, то будут выгружены документы только за последние полгода («Документы не старше 6 месяцев»);
  • если не указана ни одна из дат (DocDateFrom, DocDateTo, DateFrom, DateTo), то учитывается период 2 недели от текущей даты по дате обработки (DateFrom-DateTo);
  • если хотя бы один период указан полностью (From-To), то учитывается именно этот период без вмешательств;
  • если хотя бы один период указан с одной граничной датой, то вторая дата ограничивается сроком 2 недели.  
    Те. если DocDateFrom = 01.02.2019, то DocDateTo будет установлена в 14.02.2019. Если DateTo = 25.01.2019, то DateFrom будет установлена в 12.01.2019. 
    Таким образом, в условия фильтрации могут попасть не пересекающиеся периоды даты обработки и даты документа, что в итоге может дать пустую выборку. 
Даты и время необходимо указывать в часовом поясе сервера - MSK (UTC+3).
DocDateTo
Дата в формате YYYY-MM-DDTHH:MM:SS+03:00
-
Фильтр по дате документа - окончание периода
DateFrom
Дата в формате YYYY-MM-DDTHH:MM:SS+03:00
-
Фильтр по дате получения (обработки) документа - начало периода
DateTo
Дата в формате YYYY-MM-DDTHH:MM:SS+03:00
-
Фильтр по дате получения (обработки) документа - окончание периода
ItemFrom
Целое число
-
Индекс первого элемента списка начиная с 0
По умолчанию - 0
PageSize
Целое число
-
Размер списка документов
Ограничение по количеству выгружаемых документов: 
  • кол-во выгружаемых документов по умолчанию - 100;
  • максимально возможное кол-во документов - 1000. Если выборка превышает 1000 документов или любое другое заданное значение, то в выборку не попадут более новые документы по дате обработки
 
Пример запроса:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:edi="http://edi-express.esphere.ru/">
  <soapenv:Header/>
  <soapenv:Body>
    <edi:ListMBInput>
      <edi:Name>royal</edi:Name>
      <edi:Password>test</edi:Password>
      <edi:RelationId>7490321514111</edi:RelationId>
      <!--Optional:-->
      <edi:DocumentStatus>A</edi:DocumentStatus>
      <!--Optional:-->
      <edi:DeliveryPointGln>9999999999992;4604093834873</edi:DeliveryPointGln>
      <!--Optional:-->
      <edi:DocDateFrom></edi:DocDateFrom>
      <!--Optional:-->
      <edi:DocDateTo></edi:DocDateTo>
      <!--Optional:-->
      <edi:DateFrom>2022-01-01</edi:DateFrom>
      <!--Optional:-->
      <edi:DateTo>2022-03-12</edi:DateTo>
      <!--Optional:-->
      <edi:ItemFrom>0</edi:ItemFrom>
      <!--Optional:-->
      <edi:PageSize>100</edi:PageSize>
    </edi:ListMBInput>
  </soapenv:Body>
</soapenv:Envelope>
 
Параметры ответа:
Наименование
Обязательность
Описание
Res
+
Результат операции. В случае успешного выполнения равен 1, в случае неуспешного выполнения передается код ошибки - см. Коды ошибок
tracking-id
+
Идентификатор документа в сервисе «EDI Электронный обмен данными»
partner-iln
+
Идентификатор Вашего партнера по обмену
document-type
+
Тип документа в сервисе «EDI Электронный обмен данными» (ORDERS, ORDRSP, INVOIC...)
document-number
+
Номер документа
document-date
+
Дата документа
receive_date
+
Дата получения (обработки) документа в часовом поясе сервера MSK (UTC+3)
receive_datetime
+
Дата и время получения (обработки) документа в часовом поясе сервера MSK (UTC+3). В ответе документы отсортированы по возрастанию receive_datetime (от старых к новым)
document-status
+
Статус документа
 
Пример ответа:
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
  <SOAP-ENV:Header/>
  <SOAP-ENV:Body>
    <ns2:ListMBResponse xmlns:ns2="http://edi-express.esphere.ru/">
      <ns2:Res>1</ns2:Res>
      <ns2:Cnt>
        <ns2:mailbox-response>
          <ns2:document-info>
            <ns2:tracking-id>84222445</ns2:tracking-id>
            <ns2:partner-iln>9999999999992</ns2:partner-iln>
            <ns2:document-type>ORDERS</ns2:document-type>
            <ns2:document-number>orders_test_2</ns2:document-number>
            <ns2:document-date>2022-01-31T17:14:00+03:00</ns2:document-date>
            <ns2:recieve_date>2022-02-03</ns2:recieve_date>
            <ns2:receive_datetime>2022-02-03T13:27:49+03:00</ns2:receive_datetime>
            <ns2:document-status>N</ns2:document-status>
            </ns2:document-info>
            <ns2:document-info>
            <ns2:tracking-id>84222446</ns2:tracking-id>
            <ns2:partner-iln>9999999999992</ns2:partner-iln>
            <ns2:document-type>ORDERS</ns2:document-type>
            <ns2:document-number>orders_test_33</ns2:document-number>
            <ns2:document-date>2022-01-31T17:14:00+03:00</ns2:document-date>
            <ns2:recieve_date>2022-02-03</ns2:recieve_date>
            <ns2:receive_datetime>2022-02-03T13:30:28+03:00</ns2:receive_datetime>
            <ns2:document-status>N</ns2:document-status>
          </ns2:document-info>
        </ns2:mailbox-response>
      </ns2:Cnt>
    </ns2:ListMBResponse>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>
 
Обратите внимание! При выполнении методов ListMb, ListPb важную роль играет режим T/P на взаимосвязи со стороны клиента, вызывающего метод.
Если режим, который был указан на взаимосвязи в момент прохождения документа, отличается от того, который указан в момент вызова метода, то документ будет отсутствовать в ответе метода.
Пример:
24.07.2022 на взаимосвязи id6789 протокол отправителя был soap-test. В этот же день был отправлен документ id1234. В системе зафиксировано, что документ id1234 прошел с режимом test.
27.07.2022 на взаимосвязи id6789 протокол отправителя был изменен на soap-prod. После чего был отправлен документ id3456. В системе зафиксировано, что документ id3456 прошел с режимом prod.
29.07.2022 отправитель документа вызывает метод ListPb и в ответе видит документ id3456, но не видит документ id1234.