Получение заказов с готовыми фото
Метод используется для получения перечня заказов с ссылками на готовые к скачиванию архивы.
Запрос на получение списка заказов с готовыми фото
Для использования необходимо отправить POST-запрос на URL:
Среда | URL |
---|---|
тестовая | https://api.edu.cdek.ru/v2/photoDocument |
боевая | https://api.cdek.ru/v2/photoDocument |
Тело запроса
Необходимо передавать в формате JSON (Content-Type: application/json).
Поддерживаются следующие поля:
№ | Название поля | Описание | Тип поля | Обяз. для заполн. |
---|---|---|---|---|
1 | periodBegin | Начало периода поиска | dateTime | да , если не передано orders |
2 | periodEnd | Конец периода поиска | dateTime | да , если не передано orders |
3 | orders | Список заказов | [ ] | да, если не передано periodBegin и periodEnd |
3.1 | order_uuid | Идентификатор заказа в ИС СДЭК | UUID | да, если не передано orders и не передано cdek_number |
3.2 | cdek_number | Номер заказа СДЭК | string | да, если не передано orders и не передано order_uuid |
* Если указаны и период и перечень заказов, то период игнорируется.
Ответ на получение списка заказов с готовыми фото
Ответ возвращается в формате JSON:
№ | Название поля | Описание | Тип поля | Обяз. для заполн. |
---|---|---|---|---|
1 | orders | Перечень готовых к скачиванию заказов | [ ] | да |
1.1 | order_uuid | Идентификатор заказа СДЭК | UUID | да |
1.2 | cdek_number | Номер заказа СДЭК | string | да |
1.3 | link | Ссылка на скачивание архива с фотографиями | string (1024) | да |
2 | errors | Ошибки, возникшие в ходе выполнения запроса | error[] | нет |
2.1 | code | Код ошибки | string() | да |
2.2 | message | Описание ошибки | string() | да |
3 | warnings | Предупреждения, возникшие в ходе выполнения запроса | warning[] | нет |
3.1 | code | Код предупреждения | string() | да |
3.2 | message | Описание предупреждения | string() | да |
{ "periodBegin": "2021-02-10T11:10:34+0700", "periodEnd": "2022-04-10T11:10:34+0700" } |
{ "orders": [ { "cdek_number": "1107546886", "link": "https://photo-docs.production.cdek.ru/archives/PpB5LdIuphBM3SMy", "order_uuid": "72753031-c3b5-447d-8ae7-98ac3e36b102" }, { "cdek_number": "1107547001", "link": "https://photo-docs.production.cdek.ru/archives/StmFQSqvd0wk", "order_uuid": "72753031-6485-4c55-a082-7c21714d3703" } ] } |
© 2000—2024, Курьерская компания СДЭК