EDI
×

ListPb

Метод для получения списка исходящих документов.
 
Параметры вызова:
Наименование
Формат
Обязательность
Описание
Примечание
Name
Строка
+
Имя пользователя в сервисе «EDI Электронный обмен данными»
 
Password
Строка
+
Пароль пользователя
 
RelationId
Строка
+
Идентификатор исходящей (direction = OUT) взаимосвязи Relationships
 
DocumentStatus
Строка
+
Статус документа:
  • N - новый,
  • R - прочитанный,
  • E - ошибка,
  • P - в процессе,
  • A - все типы
 
TrackingId
Строка
-
Идентификатор документа в сервисе «EDI Электронный обмен данными»
Если указан TrackingId, то период дат не учитывается
DateFrom
Дата в формате 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)
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:ListPBInput>
      <edi:Name>991</edi:Name>
      <edi:Password>test</edi:Password>
      <edi:RelationId>74893887115151</edi:RelationId>
      <edi:DocumentStatus>A</edi:DocumentStatus>
      <!--Optional:-->
      <edi:TrackingId></edi:TrackingId>
      <!--Optional:-->
      <edi:DateFrom>2023-01-01</edi:DateFrom>
      <!--Optional:-->
      <edi:DateTo>2023-05-01</edi:DateTo>
      <!--Optional:-->
      <edi:ItemFrom>0</edi:ItemFrom>
      <!--Optional:-->
      <edi:PageSize>100</edi:PageSize>
    </edi:ListPBInput>
  </soapenv:Body>
</soapenv:Envelope>
 
Параметры ответа:
Наименование
Обязательность
Описание
Res
+
Результат операции. В случае успешного выполнения равен 1, в случае неуспешного выполнения передается код ошибки - см. Коды ошибок
tracking-id
+
Идентификатор документа в сервисе «EDI Электронный обмен данными»
partner-iln
+
Идентификатор Вашего партнера по обмену
document-type
+
Тип документа в сервисе «EDI Электронный обмен данными» (ORDERS, ORDRSP, INVOIC...)
document-number
+
Номер документа
document-date
+
Дата документа
submission-date
+
Дата отправки (обработки) документа в часовом поясе сервера MSK (UTC+3). В ответе документы отсортированы по возрастанию submission-date (от старых к новым)
document-status-description
+
Описание статуса документа
document-status
+
Статус документа
submission-handle
+
Идентификатор документа в сервисе «EDI Электронный обмен данными». То же, что tracking-id
 
Примечание: документы в списке возвращаются в порядке от старых к новым. Таким образом, если не указать дату в параметрах запроса, в ответе будут в первую очередь самые старые доступные документы (полгода). 
 
Пример ответа:
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
  <SOAP-ENV:Header/>
  <SOAP-ENV:Body>
    <ns2:ListPBResponse xmlns:ns2="http://edi-express.esphere.ru/">
      <ns2:Res>1</ns2:Res>
      <ns2:Cnt>
        <ns2:document-status-response>
          <ns2:document-status-item>
            <ns2:tracking-id>84648975</ns2:tracking-id>
            <ns2:partner-iln>4607075269996</ns2:partner-iln>
            <ns2:document-type>DESADV</ns2:document-type>
            <ns2:document-number>pallet_weight PRWL-7562</ns2:document-number>
            <ns2:document-date>2023-01-09T00:00:00+03:00</ns2:document-date>
            <ns2:submission-date>2023-01-09 09:35:11</ns2:submission-date>
            <ns2:document-status-description>Не прочитан получателем</ns2:document-status-description>
            <ns2:document-status>N</ns2:document-status>
            <ns2:submission-handle>84648975</ns2:submission-handle>
          </ns2:document-status-item>
        <ns2:document-status-item>
            <ns2:tracking-id>84648975</ns2:tracking-id>
            <ns2:partner-iln>4607075269996</ns2:partner-iln>
            <ns2:document-type>DESADV</ns2:document-type>
            <ns2:document-number>000000012555</ns2:document-number>
            <ns2:document-date>2023-01-09T00:00:00+03:00</ns2:document-date>
            <ns2:submission-date>2023-01-10 15:03:49</ns2:submission-date>
            <ns2:document-status-description>Прочитан получателем</ns2:document-status-description>
            <ns2:document-status>R</ns2:document-status>
            <ns2:submission-handle>84652755</ns2:submission-handle>
          </ns2:document-status-item>
        <ns2:document-status-item>
            <ns2:tracking-id>84648975</ns2:tracking-id>
            <ns2:partner-iln>4607075269996</ns2:partner-iln>
            <ns2:document-type>DESADV</ns2:document-type>
            <ns2:document-number>34607402</ns2:document-number>
            <ns2:submission-date>2023-01-10 15:06:48</ns2:submission-date>
            <ns2:document-status-description>Ошибка обработки</ns2:document-status-description>
            <ns2:document-status>Е</ns2:document-status>
            <ns2:submission-handle>84652757</ns2:submission-handle>
          </ns2:document-status-item>
        </ns2:document-status-response>
      </ns2:Cnt>
    </ns2:ListPBResponse>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>