REST API DropCat: получение списка документов

GET /getListDocuments

Метод предназначен для формирования списка EDI-документов.

Формат запроса

Запрос на получение списка документов следует отправлять с помощью метода GET.

/getListDocuments
? [id_type= <тип идентификатора>]
& [org_id= <идентификатор>]
& [document_type= <тип документа>]
& [sort= <тип сортировки>]
& [partner_org_id= <идентификатор>]
& [document_subtype= <подтип документа>]
& [limit= <количество документов>]
& [states= <статус документа>]
& [date_from= <дата>]
& [date_to= <дата>]
& [doc_read= <прочтение>]
& [read_date_from= <дата>]
& [read_date_to= <дата>]

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

Параметр	Пример значения	Описание	Тип параметра	Тип данных
id_type*	gln	Тип идентификатора организации. Принимает значения: gln или fns.	query	string
org_id*	2000000009994	Идентификатор организации-инициатора запроса.	query	string
document_type	WAYBILL_T1_ ON_PTLSSOBTS	Тип документа. Может принимать значения: - FORWARDING_ORDER - Поручение экспедитору - TRANSPORT_IFTMBP - Предварительный запрос на автотранспорт - TRANSPORT_IFTMBC - Ответ на предварительный запрос на автотранспорт - ETRN_FNS_GO - ЭТРН. Титул 1. Титул грузоотправителя - ETRN_FNS_TK_LOAD - ЭТРН. Титул 2. Титул транспортной компании (погрузка) - ETRN_FNS_GP - ЭТРН. Титул 3. Титул грузополучателя - ETRN_FNS_TK_UNLOAD - ЭТРН. Титул 4. Титул транспортной компании(разгрузка) - ETRN_FNS_TK_CHANGE_FINANCE - ЭТРН. Титул 5. Титул Перевозчика об изменении ФС - ETRN_FNS_GO_CHANGE_FINANCE - ЭТРН. Титул 6. Титул Грузоотправителя о подтверждении факта изменения ФС - ETRN_FNS_TK_READDRESS - ЭТРН. Титул 7. Титул переадресовки - ETRN_FNS_TK_CORRECT - ЭТРН. Титул 8. Титул замены водителя(водителей) и (или) транспортного средства - ETRN_FNS_DP_UVUTOCH -ЭТРН. Уведомление об уточнении - ETRN_FNS_UVPERADR - ЭТРН. Уведомление о переадресовке - WAYBILL_T1_ON_PTLSSOBTS - Обстоятельства и особенности рейса (титул 1) - WAYBILL_T2_ON_PTLSPRMO - Результат предсменного, предрейсового медицинского осмотра (титул 2) - WAYBILL_T3_ON_PTLSVIPTS - Выпуск транспортного средства на линию (титул 3) - WAYBILL_T4_ON_PTLSODVZD - Показания одометра (выезд/прием транспортного средства) (титул 4) - WAYBILL_T5_ON_PTLSODPARK - Показания одометра (заезд/сдача транспортного средства) (титул 5) - WAYBILL_T6_ON_PTLSPOSMO - Результат послесменного, послерейсового медицинского осмотра (титул 6) - ORDER_FNS_GO - ЭЗЗ. Титул 1. Титул грузоотправителя - ORDER_FNS_TK - ЭЗЗ. Титул 2. Титул перевозчика - EDI_CONTRL - Нотификация	query	string
date_from*	2023-10-01	Дата документа с: 'yyyy-MM-dd'.	query	date-time
date_to*	2023-14-03	Дата документа пр: 'yyyy-MM-dd'.	query	date-time
sort	Ascending	Задает порядок сортировки документов в выдаче, принимает одно из значений: - Ascending - Descending	query	string
partner_org_id	2000000007705	Идентификатор организации партнера.	query	string
document_subtype	Incoming	Подтип выводимых сообщений. Может принимать значения: - All – все документы. - Incoming - входящие. Определяются на основании: если org_id == org_id_receiver & partner_org_id == org_id_sender. Сверка по org_id обязательна, чтобы в ответе возвращались только документы для данной организации. Сверка по partner_org_id производится при наличии параметра в запросе. - Outgoing - исходящие. Определяются на основании: если org_id == org_id_sender & partner_org_id == org_id_receiver. Сверка по org_id обязательна, чтобы в ответе возвращались только документы для данной организации. Сверка по partner_org_id производится при наличии параметра в запросе. - Statuses – статусные извещения.	query	string
limit	10	Ограничение на количество выводимых документов. По умолчанию 100.	query	long
states		Статус документа. Параметр может принимать несколько значений, в таком случае статусы указываются через запятую, без пробелов. Например, DRAFT,READ,SENT. Может принимать значения: - DRAFT - Черновик - SENT - Отправлен/Получен - READ (прочитан) - COMPLETED (завершен) - DELETED (удален)	query	string
read_date_from	2023-14-01	Дата прочтения документа с: 'yyyy-MM-dd'.	query	date-time
read_date_to	2023-14-03	Дата прочтения документа по: 'yyyy-MM-dd'.	query	date-time

*Обязательный параметр.

Формат ответа

Если запрос был обработан без ошибок, API отвечает кодом 200. Если запрос вызвал ошибку, возвращается подходящий код ответа, а тело ответа содержит описание ошибки.

Curl

curl -X GET --header "Accept: application/json" "https://dapi-preprod.ediweb.ru/edi/api/v1.1/getListDocuments?id_type=gln&org_id=2000000009994&document_type=WAYBILL_T1_ON_PTLSSOBTS &sort=Ascending&partner_org_id=2000000007705&document_subtype=Incoming&limit=10&date_from=2021-14-01&date_to=2023-14-03&doc_read=false"

URL запроса

https://dapi-preprod.ediweb.ru/edi/api/v1.1/getListDocuments?id_type=gln&org_id=2000000009994&document_type=WAYBILL_T1_ON_PTLSSOBTS &sort=Ascending&partner_org_id=2000000007705&document_subtype=Incoming&limit=10&date_from=2023-14-01&date_to=2023-14-03&doc_read=false

Тело ответа

[[
 "WAYBILL_T1_ON_PTLSSOBTS",
 104021581
]]

HTTP код ответа

Заголовки ответа

{
  "connection": "keep-alive",
  "content-length": "33",
  "content-type": "text/plain; charset=UTF-8",
  "date": "Fri, 14 Oct 2023 15:14:07 GMT",
  "request_uuid": "8e677a13-efd9-4f68-af4c-35d5ecc82362",
  "server": "nginx"
}

23 июня 2026 г.