# API сервісу Маркет
# Перелік методів АРІ сервіс Маркет
Для роботи з методами користувач повинен бути [авторизованим](https://wiki-v2.edin.ua/books/robota-z-api/page/metod-avtorizaciyi-na-platformi)
Готову колекцію основних методів API сервісу Маркет для Postman можна завантажити за посиланням: [Сервіс -EDIN-Market-.postman\_collection.json](https://wiki-v2.edin.ua/attachments/96)
##### **Запрошення**
| Відправити запрошення Покупцю
(ініціатор Продавець (Виробник))
| [POST /api/distribex/invitation](https://wiki-v2.edin.ua/books/robota-z-api/page/vidpraviti-zaprosennia-pokupciu-iniciator-prodavec-virobnik-post-apidistribexinvitation) |
| Отримати запрошення Продавця в сервіс «Маркет»/Отримати вкладення до вказаного запрошення
| [GET /api/distribex/invitation](https://wiki-v2.edin.ua/books/robota-z-api/page/otrimati-zaprosennia-prodavcia-v-servis-marketotrimati-vkladennia-do-vkazanogo-zaprosennia-get-apidistribexinvitation) |
| Прийняти / Відхилити запрошення Продавця
(ініціатор Покупець (Дистриб’ютор))
| [POST /api/distribex/invitation](https://wiki-v2.edin.ua/books/robota-z-api/page/priiniati-vidxiliti-zaprosennia-prodavcia-iniciator-pokupec-distribiutor-post-apidistribexinvitation) |
| Повторно відправити запрошення Покупцю
(ініціатор Продавець (Виробник))
| [PATCH /api/distribex/invitation](https://wiki-v2.edin.ua/books/robota-z-api/page/povtorno-vidpraviti-zaprosennia-pokupciu-iniciator-prodavec-virobnik-patch-apidistribexinvitation) |
| Видалити відправлені запрошення Покупцю
(ініціатор Продавець (Виробник))
| [DELETE /api/distribex/invitation](https://wiki-v2.edin.ua/books/robota-z-api/page/vidaliti-vidpravleni-zaprosennia-pokupciu-iniciator-prodavec-virobnik-delete-apidistribexinvitation)
|
##### **Робота з обмеженнями**
| Додати/змінити обмеження
(ініціатор Продавець (Виробник))
| [POST /api/distribex/limits](https://wiki-v2.edin.ua/books/robota-z-api/page/dodatizminiti-obmezennia-iniciator-prodavec-virobnik-iniciator-prodavec-virobnik-post-apidistribexlimits) |
| Отримати обмеження контрагента за GLN
| [GET /api/distribex/limits](https://wiki-v2.edin.ua/books/robota-z-api/page/otrimati-obmezennia-kontragenta-za-gln-get-apidistribexlimits) |
| Видалити обмеження для контрагента
(ініціатор Продавець (Виробник))
| [DELETE /api/distribex/limits](https://wiki-v2.edin.ua/books/robota-z-api/page/vidaliti-obmezennia-dlia-kontragenta-iniciator-prodavec-virobnik-delete-apidistribexlimits) |
##### **Робота з квотами**
| Встановити нові квоти для Покупців
(Дистриб'юторів)
| [PUT /api/distribex/quotas](https://wiki-v2.edin.ua/books/robota-z-api/page/vstanoviti-novi-kvoti-dlia-pokupciv-distribiutoriv-put-apidistribexquotas) |
| Отримати квоти по товару для вказаного Покупця
(Дистриб'ютора)
| [GET /api/distribex/quotas](https://wiki-v2.edin.ua/books/robota-z-api/page/otrimati-kvoti-po-tovaru-dlia-vkazanogo-pokupcia-distribiutora-get-apidistribexquotas) |
| Масово видалити квоти в прайс-листі для Покупця
(Дистриб'ютора)
| [DELETE /api/distribex/quotas](https://wiki-v2.edin.ua/books/robota-z-api/page/masovo-vidaliti-kvoti-v-prais-listi-dlia-pokupcia-distribiutora-delete-apidistribexquotas) |
##### **Робота з надбавками**
| Встановити відмітку «Надбавка» для Покупців
(Дистриб'юторів)
| [PUT /api/distribex/surcharge](https://wiki-v2.edin.ua/books/robota-z-api/page/vstanoviti-vidmitku-nadbavka-dlia-pokupciv-distribiutoriv-put-apidistribexsurcharge) |
| Отримати дані надбавки по товару для вказаного Покупця
(Дистриб'ютора)
| [GET /api/distribex/surcharge](https://wiki-v2.edin.ua/books/robota-z-api/page/otrimati-dani-nadbavki-po-tovaru-dlia-vkazanogo-pokupcia-distribiutora-get-apidistribexsurcharge) |
| Масово видалити відмітку надбавки в прайс-листі для Покупця
(Дистриб'ютора)
| [DELETE /api/distribex/surcharge](https://wiki-v2.edin.ua/books/robota-z-api/page/masovo-vidaliti-vidmitku-nadbavki-v-prais-listi-dlia-pokupcia-distribiutora) |
##### **Робота з «Прайс-листами»**
| Додати або оновити дані товарів у Прайс-листі для вказаних Покупців
(Дистриб’юторів)
| [POST /api/distribex/pricelist](https://wiki-v2.edin.ua/books/robota-z-api/page/dodati-abo-onoviti-dani-tovariv-u-prais-listi-dlia-vkazanix-pokupciv-distribiutoriv-post-apidistribexpricelist) |
| Редагувати дані товарів «Прайс-листа» вказаного Покупця
(Дистрибʼютора)
| [PUT /api/distribex/pricelist](https://wiki-v2.edin.ua/books/robota-z-api/page/redaguvati-dani-tovariv-prais-lista-vkazanogo-pokupcia-distribiutora-put-apidistribexpricelist) |
| Отримати дані «Прайс-листа» для вказаного Покупця
(Дистрибʼютора)
| [GET /api/distribex/pricelist](https://wiki-v2.edin.ua/books/robota-z-api/page/otrimati-dani-prais-lista-dlia-vkazanogo-pokupcia-distribiutora-get-apidistribexpricelist) |
| Видалити позицію або «Прайс-лист» для вказаного Покупця
(Дистрибʼютора)
| [DELETE /api/distribex/pricelist](https://wiki-v2.edin.ua/books/robota-z-api/page/vidaliti-poziciiu-abo-prais-list-dlia-vkazanogo-pokupcia-distribiutora-delete-apidistribexpricelist) |
##### **Робота з Замовленнями** (Покупець (Дистрибʼютор))
| Зберегти (відредагувати) Замовлення за «Прайс-листом»
| [PUT /api/distribex/preorder](https://wiki-v2.edin.ua/books/robota-z-api/page/zberegti-vidredaguvati-zamovlennia-za-prais-listom-put-apidistribexpreorder) |
| Отримати дані для формування Замовлення по «Прайс-листу»
| [GET /api/distribex/preorder](https://wiki-v2.edin.ua/books/robota-z-api/page/otrimati-dani-dlia-formuvannia-zamovlennia-po-prais-listu-get-apidistribexpreorder) |
| Зберегти Замовлення по «Прайс-листу»
| [POST /api/distribex/preorder](https://wiki-v2.edin.ua/books/robota-z-api/page/zberegti-zamovlennia-po-prais-listu-post-apidistribexpreorder) |
| Видалити Замовлення
| [DELETE /api/distribex/preorder](https://wiki-v2.edin.ua/books/robota-z-api/page/vidaliti-zamovlennia-delete-apidistribexpreorder) |
| Надсилання документа (без створення чернетки)
| [POST /api/eds/doc/create\_and\_send](https://wiki-v2.edin.ua/books/robota-z-api/page/nadsilannia-dokumenta-bez-stvorennia-cernetki-post-apiedsdoccreate-and-send) |
##### **Робота з рекомендаціями до замовлення**
(Продавець (Виробник))
| Відправити рекомендації до замовлення за «Прайс-листом»
| [POST /api/eds/doc/create\_and\_send](https://wiki-v2.edin.ua/books/robota-z-api/page/vidpraviti-rekomendaciyi-do-zamovlennia-za-prais-listom-post-apiedsdoccreate-and-send) |
##### **Робота з документами**
| Створити (розрахувати) номер «Замовлення» (ORDER)
| [GET /api/oas/doc\_counter](https://wiki-v2.edin.ua/books/robota-z-api/page/stvoriti-rozraxuvati-nomer-zamovlennia-order-get-apioasdoc-counter) |
| Створити документ «Замовлення» (ORDER) за «Прайс-листом»
| [POST /api/distribex/doc/order](https://wiki-v2.edin.ua/books/robota-z-api/page/stvoriti-dokument-zamovlennia-order-za-prais-listom-post-apidistribexdocorder) |
| Створити копію документа «Замовлення» (ORDER) відповідно до актуального «Прайс-листа»
| [POST /api/distribex/order/copy](https://wiki-v2.edin.ua/books/robota-z-api/page/stvoriti-kopiiu-dokumenta-zamovlennia-order-vidpovidno-do-aktualnogo-prais-lista-post-apidistribexordercopy) |
| Отримання контенту документа
| [GET /api/eds/doc/body](https://wiki-v2.edin.ua/books/robota-z-api/page/otrimannia-kontentu-dokumenta-get-apiedsdocbody) |
| Пошук документів (з фільтрацією), вибір списку документів
| [POST /api/eds/docs/search](https://wiki-v2.edin.ua/books/robota-z-api/page/posuk-dokumentiv-z-filtracijeiu-vibir-spisku-dokumentiv-post-apiedsdocssearch-MbE) |
| Визначення переліку товарних позицій, доступних для повернення, та формування документа “Надсилання Повернення”
(ініціатор - Покупець / Дистриб’ютор)
| [POST /api/distribex/doc/retann](https://wiki-v2.edin.ua/books/robota-z-api/page/viznacennia-pereliku-tovarnix-pozicii-dostupnix-dlia-povernennia-ta-formuvannia-dokumenta-nadsilannia-povernennia-iniciator-pokupecdistribiutor-post-apidistribexdocretann) |
##### **Робота з дозволами**
| Отримати список контрагентів-Покупців
(Дистриб'юторів)
| [GET /api/distribex/distributor/list](https://wiki-v2.edin.ua/books/robota-z-api/page/otrimati-spisok-kontragentiv-pokupciv-distribiutoriv-get-apidistribexdistributorlist) |
| Отримати список контрагентів-Продавців
(Виробників)
| [GET /api/distribex/producers/list](https://wiki-v2.edin.ua/books/robota-z-api/page/otrimati-spisok-kontragentiv-prodavciv-virobnikiv-get-apidistribexproducerslist) |
##### **Робота з товарами/товарним довідником**
| Відредагувати товарну позицію «Прайс-листа»
| [PUT /api/distribex/product](https://wiki-v2.edin.ua/books/robota-z-api/page/vidredaguvati-tovarnu-poziciiu-prais-lista-put-apidistribexproduct) |
| Отримати список категорій товарів Прайс-листа
| [GET /api/distribex/categories](https://wiki-v2.edin.ua/books/robota-z-api/page/otrimati-spisok-kategorii-tovariv-prais-lista-get-apidistribexcategories) |
| Видалити товарну позицію з «Прайс-листа»
| [DELETE /api/distribex/product](https://wiki-v2.edin.ua/books/robota-z-api/page/vidaliti-tovarnu-poziciiu-z-prais-lista-delete-apidistribexproduct) |
##### **Робота з групами Покупців**
(Дистрибʼюторів)
| Отримати дані про створені групи Покупців (Дистрибʼюторів)
(на стороні Продавця (Виробника))
| [GET /api/distribex/accessgroup](https://wiki-v2.edin.ua/books/robota-z-api/page/otrimati-dani-pro-stvoreni-grupi-pokupciv-distribiutoriv-na-storoni-prodavcia-virobnika-get-apidistribexaccessgroup) |
| Створити групу Покупців (Дистрибʼюторів)
(на стороні Продавця (Виробника))
| [POST /api/distribex/accessgroup](https://wiki-v2.edin.ua/books/robota-z-api/page/stvoriti-grupu-pokupciv-distribiutoriv-na-storoni-prodavcia-virobnika-post-apidistribexaccessgroup) |
| Перейменувати поточну групу Покупців (Дистрибʼюторів)
(на стороні Продавця (Виробника))
| [PUT /api/distribex/accessgroup](https://wiki-v2.edin.ua/books/robota-z-api/page/pereimenuvati-potocnu-grupu-pokupciv-distribiutoriv-na-storoni-prodavcia-virobnika-put-apidistribexaccessgroup) |
| Видалити групу Покупців (Дистрибʼюторів)
(на стороні Продавця (Виробника))
| [DELETE /api/distribex/accessgroup](https://wiki-v2.edin.ua/books/robota-z-api/page/vidaliti-grupu-pokupciv-distribiutoriv-na-storoni-prodavcia-virobnika-delete-apidistribexaccessgroup) |
| Додати Покупця (Дистрибʼютора) до групи Покупців (Дистрибʼюторів)
(на стороні Продавця (Виробника))
| [POST /api/distribex/useraccessgroup](https://wiki-v2.edin.ua/books/robota-z-api/page/dodati-pokupcia-distribiutora-do-grupi-pokupciv-distribiutoriv-na-storoni-prodavcia-virobnika-post-apidistribexuseraccessgroup) |
| Видалити Покупця (Дистрибʼютора) з групи Покупців (Дистрибʼюторів)
| [DELETE /api/distribex/useraccessgroup](https://wiki-v2.edin.ua/books/robota-z-api/page/vidaliti-pokupcia-distribiutora-z-grupi-pokupciv-distribiutoriv-delete-apidistribexuseraccessgroup) |
##### **Робота з Графіком замовлень**
| Отримати список графіків замовлень
(Продавець (Виробник)
| [GET /api/distribex/producer/schedules](https://wiki-v2.edin.ua/books/robota-z-api/page/otrimati-spisok-grafikiv-zamovlen-prodavec-virobnik-get-apidistribexproducerschedules) |
| Створити графік замовлень
(Продавець (Виробник)
| [POST /api/distribex/producer/schedules](https://wiki-v2.edin.ua/books/robota-z-api/page/stvoriti-grafik-zamovlen-prodavec-virobnik-post-apidistribexproducerschedules) |
| Оновити графік замовлення
(Продавець (Виробник)
| [PATCH /api/distribex/producer/schedules](https://wiki-v2.edin.ua/books/robota-z-api/page/onoviti-grafik-zamovlennia-prodavec-virobnik-patch-apidistribexproducerschedules) |
| Видалити графік замовлення
(Продавець (Виробник)
| [DELETE /api/distribex/producer/schedules](https://wiki-v2.edin.ua/books/robota-z-api/page/vidaliti-grafik-zamovlennia-prodavec-virobnik-delete-apidistribexproducerschedules) |
| Отримати найактуальніші графіки замовлень для зазначеного списку Продавців (Виробників)
(Покупець (Дистриб'ютор))
| [POST /api/distribex/distributor/schedules](https://wiki-v2.edin.ua/books/robota-z-api/page/otrimati-naiaktualnisi-grafiki-zamovlen-dlia-zaznacenogo-spisku-prodavciv-virobnikiv-pokupec-distribiutor-post-apidistribexdistributorschedules) |
| Отримати перелік дат доступних для відправлення замовлень у вибраному місяці згідно з графіком Продавця (Виробника)
(Покупець (Дистриб'ютор))
| [POST /api/distribex/schedule/dates](https://wiki-v2.edin.ua/books/robota-z-api/page/otrimati-perelik-dat-dostupnix-dlia-vidpravlennia-zamovlen-u-vibranomu-misiaci-zgidno-z-grafikom-prodavcia-virobnika-pokupec-distribiutor-post-apidistribexscheduledates) |
##### **Картка продавця**
| Створення картки продавця
| [POST api/oas/supplier](https://wiki-v2.edin.ua/books/robota-z-api/page/stvorennia-kartki-prodavcia-post-apioassupplier) |
| Оновлення картки продавця
| [PUT api/oas/supplier](https://wiki-v2.edin.ua/books/robota-z-api/page/onovlennia-kartki-prodavcia-put-apioassupplier) |
| Отримання картки продавця
| [GET api/oas/supplier](https://wiki-v2.edin.ua/books/robota-z-api/page/otrimannia-kartki-prodavcia-get-apioassupplier) |
| Завантаження логотипа
| [POST api/oas/logo/create](https://wiki-v2.edin.ua/books/robota-z-api/page/zavantazennia-logotipa-post-apioaslogocreate) |
| Отримання логотипа за посиланням на динамічний роут
| [GET api/oas/logo/supplier](https://wiki-v2.edin.ua/books/robota-z-api/page/otrimannia-logotipa-za-posilanniam-na-dinamicnii-rout-get-apioaslogosupplier) |
##### **Звернення**
| Створити звернення
| [POST api/distribex/buyer/request](https://wiki-v2.edin.ua/books/robota-z-api/page/stvoriti-zvernennia-post-apidistribexbuyerrequest) |
| Редагування звернення
| [PUT api/distribex/buyer/request](https://wiki-v2.edin.ua/books/robota-z-api/page/redaguvannia-zvernennia-put-apidistribexbuyerrequest) |
| Оновлення статусу звернення
| [PATCH api/distribex/buyer/request](https://wiki-v2.edin.ua/books/robota-z-api/page/onovlennia-statusu-zvernennia-patch-apidistribexbuyerrequest) |
| Отримання переліку звернень
| [GET api/distribex/buyer/request](https://wiki-v2.edin.ua/books/robota-z-api/page/otrimannia-pereliku-zvernen-get-apidistribexbuyerrequest) |
# Опис помилок сервісу Маркет
| **Код відповіді**
| **Індекс помилки**
| **Текст помилки**
| **Опис**
|
| 400
| ERR\_MRKT-1
| Validation document errors: \[%s\]
Документ містить помилки: \[%s\]
| Помилка виникає, якщо не передати обов'язковий url-параметр
|
| 400
| ERR\_MRKT-2
| No connection between producer and distributor
Відсутній зв’язок між Продавцем (Виробником) і Покупцем (Дистрибʼютором)
| |
| 400
| ERR\_MRKT-3
| The currency doesn’t match the one already set
Валюта не відповідає вже встановленій
| |
| 400
| ERR\_MRKT-4
| Save pricelist error: \[%s\]
Помилка при збереженні прайсу: \[%s\]
| |
| 400
| ERR\_MRKT-5
| Position with barcode \[%s\] not found in original order
Позиції зі штрихкодом \[%s\] не знайдено в оригінальному замовленні
| |
| 400
| ERR\_MRKT-6
| The „VAT included“ doesn’t match the one already set
Ознака „З/Без ПДВ“ у прайсі що існує відрізняється
| |
| 400
| ERR\_MRKT-7
| Some positions don’t have a price %s vat
По деяких позиціях відсутня ціна %s ПДВ
|
|
# Отримання переліку звернень GET api/distribex/buyer/request
##### **REQUEST**
| **URL**
| https://edo-v2.edin.ua |
| Метод запиту
| GET
|
| URL запиту
| /api/distribex/buyer/request
|
| URL параметри
| **producer\_id** (опціонально) - звернення до конкретного продавця
**gln** (обов’язково) String - GLN власної Компанії
**gln\_id** (опціонально) - звернення до конкретного покупця
|
| **Headers**
| |
| Authorization
| **SID** - токен, отриманий при [авторизації](https://wiki-v2.edin.ua/books/robota-z-api/page/metod-avtorizaciyi-na-platformi)
|
| Content-Type
| [multipart/form-data](https://tools.ietf.org/html/rfc7578)
|
##### **RESPONSE**
Код сервера 200 (ok).
**Приклад відповіді**
```json
[
{
"id": 3,
"producerId": 13206429,
"glnId": 13208197,
"text": "Я просто тестую звернення, тому і створив оце одне, щоб подивитися чи те, що я зробив, взагалі працює.. тепер от змінив текст трохи..",
"status": 0,
"contactPerson": {
"firstName": "Alex",
"lastName": "Marchenko",
"phoneNumber": "+380992323992"
}
}
]
```
# Оновлення статусу звернення PATCH api/distribex/buyer/request
##### **REQUEST**
| **URL**
| https://edo-v2.edin.ua |
| Метод запиту
| PATCH
|
| URL запиту
| /api/distribex/buyer/request
|
| URL параметри
| **gln** (обов’язково) String - GLN власної Компанії;
**status=1** (обов’язково)
|
| **Headers**
| |
| Authorization
| **SID** - токен, отриманий при [авторизації](https://wiki-v2.edin.ua/books/robota-z-api/page/metod-avtorizaciyi-na-platformi)
|
| Content-Type
| [multipart/form-data](https://tools.ietf.org/html/rfc7578)
|
| **REQUEST**
| |
| JSON Body
| У тілі запиту необхідно передати перелік ID звернень для оновлення статусу.
|
##### **RESPONSE**
Код сервера 200 (ok).
# Редагування звернення PUT api/distribex/buyer/request
##### **REQUEST**
| **URL**
| https://edo-v2.edin.ua |
| Метод запиту
| PUT
|
| URL запиту
| /api/distribex/buyer/request
|
| URL параметри
| **gln** (обов’язково) String - GLN власної Компанії;
|
| **Headers**
| |
| Authorization
| **SID** - токен, отриманий при [авторизації](https://wiki-v2.edin.ua/books/robota-z-api/page/metod-avtorizaciyi-na-platformi)
|
| Content-Type
| [multipart/form-data](https://tools.ietf.org/html/rfc7578)
|
##### **RESPONSE**
Код сервера 200 (ok).
# Створити звернення POST api/distribex/buyer/request
##### **REQUEST**
| **URL**
| https://edo-v2.edin.ua |
| Метод запиту
| POST
|
| URL запиту
| /api/distribex/buyer/request
|
| URL параметри
| **gln** (обов’язково) String - GLN власної Компанії;
|
| **Headers**
| |
| Authorization
| **SID** - токен, отриманий при [авторизації](https://wiki-v2.edin.ua/books/robota-z-api/page/metod-avtorizaciyi-na-platformi)
|
| Content-Type
| [multipart/form-data](https://tools.ietf.org/html/rfc7578), де:
- одним файлом передається JSON-об’єкт з даними звернення;
- до трьох додаткових файлів — вкладення (зображення розміром до 500 КБ).
|
**Приклад запиту**
```json
{
"producerId": 13206429,
"glnId": 13208197,
"text": "Я просто тестую звернення, тому і створив оце одне, щоб подивитися чи те, що я зробив, взагалі працює..",
"contactPerson": {
"firstName": "Alex",
"lastName": "Marchenko",
"phoneNumber": "+380992323992"
}
}
```
##### **RESPONSE**
Код сервера 200 (ok).
# Отримання логотипа за посиланням на динамічний роут GET api/oas/logo/supplier
##### **REQUEST**
| **URL**
| https://edo-v2.edin.ua |
| Метод запиту
| GET
|
| URL запиту
| api/oas/logo/supplier/1.jpg
|
| URL параметри
| **logo** (обов’язково)
|
| **Headers**
| |
| Authorization
| **SID** - токен, отриманий при [авторизації](https://wiki-v2.edin.ua/books/robota-z-api/page/metod-avtorizaciyi-na-platformi)
|
##### **RESPONSE**
Код сервера 200 (ok).
# Завантаження логотипа POST api/oas/logo/create
##### **REQUEST**
| **URL**
| https://edo-v2.edin.ua |
| Метод запиту
| POST
|
| URL запиту
| api/oas/logo/create
|
| URL параметри
| **gln** (обов’язково) String - GLN Продавця (Виробника)
**folder\_name=supplier** (обов’язково)
|
| **Headers**
| |
| Authorization
| **SID** - токен, отриманий при [авторизації](https://wiki-v2.edin.ua/books/robota-z-api/page/metod-avtorizaciyi-na-platformi)
|
| Content-Type
| application/json
|
##### **RESPONSE**
Код сервера 200 (ok).
# Отримання картки продавця GET api/oas/supplier
##### **REQUEST**
| **URL**
| https://edo-v2.edin.ua |
| Метод запиту
| GET
|
| URL запиту
| api/oas/supplier
|
| URL параметри
| **gln** (обов’язково) String - GLN Продавця (Виробника)
|
| **Headers**
| |
| Authorization
| **SID** - токен, отриманий при [авторизації](https://wiki-v2.edin.ua/books/robota-z-api/page/metod-avtorizaciyi-na-platformi)
|
| Content-Type
| application/json
|
##### **RESPONSE**
Код сервера 200 (ok).
**Приклад відповіді**
```json
{
"id": 1,
"name": "Хлібна майстерня",
"description": "Хлібна майстерня» — це більше ніж пекарня...",
"phone": "+380954603452",
"logo": "1.jpg",
"glnId": 13208197,
"accountId": 40895
}
```
# Оновлення картки продавця PUT api/oas/supplier
##### **REQUEST**
| **URL**
| https://edo-v2.edin.ua |
| Метод запиту
| PUT
|
| URL запиту
| api/oas/supplier
|
| URL параметри
| **gln** (обов’язково) String - GLN Продавця (Виробника)
|
| **Headers**
| |
| Authorization
| **SID** - токен, отриманий при [авторизації](https://wiki-v2.edin.ua/books/robota-z-api/page/metod-avtorizaciyi-na-platformi)
|
| Content-Type
| application/json
|
**Приклад запиту**
```json
{
"id": 1
"name": "Хлібна майстерня",
"description": "Хлібна майстерня» — це більше ніж пекарня. Це місце, де давні традиції випікання поєднуються із сучасними підходами до якості й смаку. Ми віримо, що справжній хліб має народжуватися з любові до ремесла та натуральних інгредієнтів, тому кожен наш буханець — це результат кропіткої роботи, уваги до деталей і поваги до класичних рецептів.",
"phone": "+380954603452",
"glnId": 13208197,
"accountId": 40895
}
```
##### **RESPONSE**
Код сервера 200 (ok).
# Створення картки продавця POST api/oas/supplier
##### **REQUEST**
| **URL**
| https://edo-v2.edin.ua |
| Метод запиту
| POST
|
| URL запиту
| api/oas/supplier
|
| URL параметри
| **gln** (обов’язково) String - GLN Продавця (Виробника)
|
| **Headers**
| |
| Authorization
| **SID** - токен, отриманий при [авторизації](https://wiki-v2.edin.ua/books/robota-z-api/page/metod-avtorizaciyi-na-platformi)
|
| Content-Type
| application/json
|
**Приклад запиту**
```json
{
"name": "Хлібна майстерня",
"description": "Хлібна майстерня» — це більше ніж пекарня. Це місце, де давні традиції випікання поєднуються із сучасними підходами до якості й смаку. Ми віримо, що справжній хліб має народжуватися з любові до ремесла та натуральних інгредієнтів, тому кожен наш буханець — це результат кропіткої роботи, уваги до деталей і поваги до класичних рецептів.",
"phone": "+380954603452",
"glnId": 13208197,
"accountId": 40895
}
```
##### **RESPONSE**
Код сервера 200 (ok).
# Отримати перелік дат доступних для відправлення замовлень у вибраному місяці згідно з графіком Продавця (Виробника) (Покупець (Дистриб'ютор)) POST /api/distribex/schedule/dates
##### **REQUEST**
| **URL**
| |
| Метод запиту
| POST
|
| URL запиту
| /api/distribex/schedule/dates
|
| URL параметри
| **year** (обов’язково) int - рік;
**month** (обов’язково) int - порядковий номер місяця
|
| **Headers**
| |
| Authorization
| SID - токен, отриманий при [авторизації](https://wiki-v2.edin.ua/books/robota-z-api/page/metod-avtorizaciyi-na-platformi)
|
| Content-Type
| application/json
|
| **REQUEST**
| |
| JSON Body
| В тілі запиту методу передається повний об’єкт графіка замовлень (об’єкт [Schedule](https://wiki-v2.edin.ua/books/robota-z-api/page/objekt-schedule)), що може бути отриманий методом [POST /api/distribex/distributor/schedules](https://wiki-v2.edin.ua/books/robota-z-api/page/otrimati-naiaktualnisi-grafiki-zamovlen-dlia-zaznacenogo-spisku-prodavciv-virobnikiv-pokupec-distribiutor-post-apidistribexdistributorschedules)
|
##### **RESPONSE**
В тілі відповіді передається список дат, наприклад: \[1,2,3,4,5,6,7,8,9,10\]
# Отримати найактуальніші графіки замовлень для зазначеного списку Продавців (Виробників) (Покупець (Дистриб'ютор)) POST /api/distribex/distributor/schedules
Метод враховує ієрархію типів графіків: якщо у Продавця (Виробника) вже діє загальний графік, але для конкретного Покупця (Дистрибʼютора) існує індивідуальний графік, який починає діяти пізніше (після поточної дати), у відповіді буде повернено саме індивідуальний графік.
##### **REQUEST**
| **URL**
| https://edo-v2.edin.ua |
| Метод запиту
| POST
|
| URL запиту
| /api/distribex/distributor/schedules
|
| URL параметри
| **gln** (обов’язково) String - GLN Покупця (Дистрибʼютора)
|
| **Headers**
| |
| Authorization
| SID - токен, отриманий при [авторизації](https://wiki-v2.edin.ua/books/robota-z-api/page/metod-avtorizaciyi-na-platformi)
|
| Content-Type
| application/json
|
| **REQUEST**
| |
| JSON Body
| В тілі запиту методу передається список ідентифікаторів GLN Продавців (Виробників) (масив значень gln\_id), наприклад: \[13200757\]
|
##### **RESPONSE**
В тілі відповіді передаються дані графіка замовлень за кожним вказаним Продавцем (Виробником) (об’єкт [Schedule](https://wiki-v2.edin.ua/books/robota-z-api/page/objekt-schedule)).
# Видалити графік замовлення (Продавець (Виробник) DELETE /api/distribex/producer/schedules
##### **REQUEST**
| **URL**
| https://edo-v2.edin.ua |
| Метод запиту
| DELETE
|
| URL запиту
| /api/distribex/producer/schedules
|
| URL параметри
| **gln** (обов’язково) String - GLN Продавця (Виробника)
**schedule\_id** (обов’язково) long - ідентифікатор графіка замовлень
|
| **Headers**
| |
| Authorization
| SID - токен, отриманий при [авторизації](https://wiki-v2.edin.ua/books/robota-z-api/page/metod-avtorizaciyi-na-platformi)
|
| Content-Type
| application/json
|
##### **RESPONSE**
Код сервера 200 (ok).
# Оновити графік замовлення (Продавець (Виробник) PATCH /api/distribex/producer/schedules
****Правило оновлення графіка замовлень****
- При оновленні графіка необхідно передавати всі параметри, так само як і при створенні.
Параметри, що не передаються в «оновленому графіку», автоматично затираються.
- Не допускається графік замовлень, який має перетин дат з іншим графіком для одного й того ж Покупця (Дистриб’ютора) та типу графіка.
- При створенні графіка для конкретного Покупця (Дистриб’ютора) з type = 1 система виконує перевірку усіх існуючих графіків цього Продавця (Виробника) для вказаного Покупця (Дистриб’ютора) (також з типом = 1).
- Якщо буде знайдено перетин дат, система поверне помилку:
`Dates can’t overlap with already existing schedule, name - [Test2]. Please edit your schedule.`
##### **REQUEST**
| **URL**
| https://edo-v2.edin.ua |
| Метод запиту
| PATCH
|
| URL запиту
| /api/distribex/producer/schedules
|
| URL параметри
| **gln** (обов’язково) String - GLN Продавця (Виробника)
|
| **Headers**
| |
| Authorization
| SID - токен, отриманий при [авторизації](https://wiki-v2.edin.ua/books/robota-z-api/page/metod-avtorizaciyi-na-platformi)
|
| Content-Type
| application/json
|
| **REQUEST**
| |
| JSON Body
| В тілі запиту методу передаються нові дані для зазначеного графіка замовлень (об’єкт [Schedule](https://wiki-v2.edin.ua/books/robota-z-api/page/objekt-schedule))
|
##### **RESPONSE**
Код сервера 200 (ok).
# Створити графік замовлень (Продавець (Виробник) POST /api/distribex/producer/schedules
**Правило створення графіка замовлень**
Не допускається створення графіка замовлень, який має перетин дат з іншим графіком для одного й того ж Покупця (Дистриб’ютора) та типу графіка.
- При створенні графіка для конкретного Покупця (Дистриб’ютора) з type = 1 система виконує перевірку усіх існуючих графіків цього Продавця (Виробника) для вказаного Покупця (Дистриб’ютора) (також з типом = 1).
- Якщо буде знайдено перетин дат, система поверне помилку:
`Dates can’t overlap with already existing schedule, name - [Test2]. Please edit your schedule.`
##### **REQUEST**
| **URL**
| https://edo-v2.edin.ua |
| Метод запиту
| POST
|
| URL запиту
| /api/distribex/producer/schedules
|
| URL параметри
| **gln** (обов’язково) String - GLN Продавця (Виробника)
|
| **Headers**
| |
| Authorization
| SID - токен, отриманий при [авторизації](https://wiki-v2.edin.ua/books/robota-z-api/page/metod-avtorizaciyi-na-platformi)
|
| Content-Type
| application/json
|
| **REQUEST**
| |
| JSON Body
| В тілі запиту методу передаються дані графіка замовлень (об’єкт [Schedule](https://wiki-v2.edin.ua/books/robota-z-api/page/objekt-schedule))
|
##### **RESPONSE**
В тілі відповіді передаються дані графіка замовлень (об’єкт [Schedule](https://wiki-v2.edin.ua/books/robota-z-api/page/objekt-schedule)).
# Отримати список графіків замовлень (Продавець (Виробник) GET /api/distribex/producer/schedules
##### **REQUEST**
| **URL**
| https://edo-v2.edin.ua |
| Метод запиту
| GET
|
| URL запиту
| /api/distribex/producer/schedules
|
| URL параметри
| **gln** (обов’язково) String - GLN Продавця (Виробника)
**limit** (опціонально) int - ліміт вибірки (за замовчуванням=20);
**offset** (опціонально) int - зміщення відносно верхньої межі вибірки (за замовчуванням=0)
|
| **Headers**
| |
| Authorization
| SID - токен, отриманий при [авторизації](https://wiki-v2.edin.ua/books/robota-z-api/page/metod-avtorizaciyi-na-platformi)
|
| Content-Type
| application/json |
##### **RESPONSE**
В тілі відповіді передається список графіків замовлень (масив об’єктів [Schedule](https://wiki-v2.edin.ua/books/robota-z-api/page/objekt-schedule)) відсортованих за датою створення/оновлення.
# Видалити Покупця (Дистрибʼютора) з групи Покупців (Дистрибʼюторів) DELETE /api/distribex/useraccessgroup
##### **REQUEST**
| **URL**
| https://edo-v2.edin.ua |
| Метод запиту
| DELETE
|
| URL запиту
| /api/distribex/useraccessgroup
|
| URL параметри
| **gln** (обов’язково) String - GLN Продавця (Виробника)
**access\_groups\_id** (обов’язково) long - ідентифікатор групи
**gln\_id** (обов’язково) String - GLN Покупця (Дистрибʼютора)
|
| **Headers**
| |
| Authorization
| **SID** - токен, отриманий при [авторизації](https://wiki-v2.edin.ua/books/robota-z-api/page/metod-avtorizaciyi-na-platformi)
|
| Content-Type
| application/json
|
##### **RESPONSE**
Код сервера 200 (ok).
# Додати Покупця (Дистрибʼютора) до групи Покупців (Дистрибʼюторів) (на стороні Продавця (Виробника)) POST /api/distribex/useraccessgroup
##### **REQUEST**
| **URL**
| https://edo-v2.edin.ua |
| Метод запиту
| POST
|
| URL запиту
| /api/distribex/useraccessgroup
|
| URL параметри
| **gln** (обов’язково) String - GLN Продавця (Виробника)
**access\_groups\_id** (обов’язково) long - ідентифікатор групи
**gln\_id** (обов’язково) String - GLN Покупця (Дистрибʼютора)
|
| **Headers**
| |
| Authorization
| **SID** - токен, отриманий при [авторизації](https://wiki-v2.edin.ua/books/robota-z-api/page/metod-avtorizaciyi-na-platformi)
|
| Content-Type
| application/json
|
##### **RESPONSE**
Код сервера 200 (ok).
# Видалити групу Покупців (Дистрибʼюторів) (на стороні Продавця (Виробника)) DELETE /api/distribex/accessgroup
##### **REQUEST**
| **URL**
| https://edo-v2.edin.ua |
| Метод запиту
| DELETE
|
| URL запиту
| /api/distribex/accessgroup
|
| URL параметри
| **gln** (обов’язково) String - GLN Продавця (Виробника)
**group\_id** (обов’язково) long - ідентифікатор групи
|
| **Headers**
| |
| Authorization
| **SID** - токен, отриманий при [авторизації](https://wiki-v2.edin.ua/books/robota-z-api/page/metod-avtorizaciyi-na-platformi)
|
| Content-Type
| application/json
|
##### **RESPONSE**
Код сервера 200 (ok).
# Перейменувати поточну групу Покупців (Дистрибʼюторів) (на стороні Продавця (Виробника)) PUT /api/distribex/accessgroup
##### **REQUEST**
| **URL**
| https://edo-v2.edin.ua |
| Метод запиту
| PUT
|
| URL запиту
| /api/distribex/accessgroup
|
| URL параметри
| **gln** (обов’язково) String - GLN Продавця (Виробника)
|
| **Headers**
| |
| Authorization
| **SID** - токен, отриманий при [авторизації](https://wiki-v2.edin.ua/books/robota-z-api/page/metod-avtorizaciyi-na-platformi)
|
| Content-Type
| application/json
|
| **REQUEST**
| |
| JSON Body
| В тілі запиту методу передаються дані групи дистиб’юторів (об’єкт [XDistribexAccessGroup](https://wiki-v2.edin.ua/books/robota-z-api/page/objekt-xdistribexaccessgroup))
|
##### **RESPONSE**
Код сервера 200 (ok).
# Створити групу Покупців (Дистрибʼюторів) (на стороні Продавця (Виробника)) POST /api/distribex/accessgroup
##### **REQUEST**
| **URL**
| https://edo-v2.edin.ua |
| Метод запиту
| POST
|
| URL запиту
| /api/distribex/accessgroup
|
| URL параметри
| **gln** (обов’язково) String - GLN Продавця (Виробника)
|
| **Headers**
| |
| Authorization
| **SID** - токен, отриманий при [авторизації](https://wiki-v2.edin.ua/books/robota-z-api/page/metod-avtorizaciyi-na-platformi)
|
| Content-Type
| application/json
|
| **REQUEST**
| |
| JSON Body
| При створенні нової групи в тілі запиту методу передаються лише назва (name) та ідентифікатор Продавця (Виробника) (producerId).
|
**Приклад запиту**
```json
{"name":"Красавчики","producerId":13200791}
```
##### **RESPONSE**
В тілі відповіді передаються дані створеної групи Покупців (Дистрибʼюторів) (об’єкт [XDistribexAccessGroup](https://wiki-v2.edin.ua/books/robota-z-api/page/objekt-xdistribexaccessgroup)).
# Отримати дані про створені групи Покупців (Дистрибʼюторів) (на стороні Продавця (Виробника)) GET /api/distribex/accessgroup
##### **REQUEST**
| **URL**
| https://edo-v2.edin.ua |
| Метод запиту
| GET
|
| URL запиту
| /api/distribex/accessgroup
|
| URL параметри
| **gln** (обов’язково) String - GLN Продавця (Виробника)
|
| **Headers**
| |
| Authorization
| **SID** - токен, отриманий при [авторизації](https://wiki-v2.edin.ua/books/robota-z-api/page/metod-avtorizaciyi-na-platformi)
|
| Content-Type
| application/json
|
##### **RESPONSE**
В тілі відповіді передаються дані всіх створених груп дистриб'юторів (масив об’єктів [XDistribexAccessGroup](https://wiki-v2.edin.ua/books/robota-z-api/page/objekt-xdistribexaccessgroup))
# Видалити товарну позицію з «Прайс-листа» DELETE /api/distribex/product
Метод доступний лише для користувача з роллю Продавець (Виробник)
##### **REQUEST**
| **URL**
| https://edo-v2.edin.ua |
| Метод запиту
| DELETE
|
| URL запиту
| /api/distribex/product
|
| URL параметри
| **gln** (обов’язково) String - GLN Продавця (Виробника)
**producer\_id** (обов’язково) String - ідентифікатор Продавця (Виробника)
**list\_id** (обов’язково) String - ідентифікатор товарної позиції
|
| **Headers**
| |
| Authorization
| **SID** - токен, отриманий при [авторизації](https://wiki-v2.edin.ua/books/robota-z-api/page/metod-avtorizaciyi-na-platformi)
|
| Content-Type
| application/json
|
##### **RESPONSE**
Код сервера 200 (ok).
# Отримати список категорій товарів Прайс-листа GET /api/distribex/categories
##### **REQUEST**
| **URL**
| https://edo-v2.edin.ua |
| Метод запиту
| GET
|
| URL запиту
| /api/distribex/categories
|
| URL параметри
| **gln** (обов’язково) String - GLN ініціатора запиту (Продавця (Виробника) чи Покупця (Дистрибʼютора));
**gln\_id** (обов’язково) String - ідентифікатор GLN контрагента (Покупця (Дистрибʼютора) чи Продавця (Виробника) відповідно);
**e\_product** (опціонально) boolean - значення **true** є індикатором того, що запит виконується в сервісі **Є-Товар**
|
| **Headers**
| |
| Authorization
| **SID** - токен, отриманий при [авторизації](https://wiki-v2.edin.ua/books/robota-z-api/page/metod-avtorizaciyi-na-platformi)
|
| Content-Type
| application/json
|
##### **RESPONSE**
В тілі відповіді у вигляді масиву об’єкта [XProductGroup](https://wiki-v2.edin.ua/books/robota-z-api/page/objekt-xproductgroup) передаються категорії товарів Прайс-листа для вказаної пари «Покупець (Дистрибʼютор)»-«Продавець (Виробник)».
# Відредагувати товарну позицію «Прайс-листа» PUT /api/distribex/product
Метод доступний лише для користувача з роллю Продавець (Виробник)
##### **REQUEST**
| **URL**
| https://edo-v2.edin.ua |
| Метод запиту
| PUT
|
| URL запиту
| /api/distribex/product
|
| URL параметри
| **gln** (обов’язково) String - GLN Продавця (Виробника)
|
| **Headers**
| |
| Authorization
| **SID** - токен, отриманий при [авторизації](https://wiki-v2.edin.ua/books/robota-z-api/page/metod-avtorizaciyi-na-platformi)
|
| Content-Type
| application/json
|
| **REQUEST**
| |
| JSON Body
| В тілі запиту методу передається об’єкт [XDistribexProduct](https://wiki-v2.edin.ua/books/robota-z-api/page/objekt-xdistribexproduct) з даними по товарній позиції
|
##### **RESPONSE**
Код сервера 200 (ok).
# Отримати список контрагентів-Продавців (Виробників) GET /api/distribex/producers/list
##### **REQUEST**
| **URL**
| https://edo-v2.edin.ua |
| Метод запиту
| GET
|
| URL запиту
| /api/distribex/producers/list
|
| URL параметри
| **gln** (обов’язково) String - GLN Покупця (Дистрибʼютора)
**query** (опціонально) String - текст пошуку (пошук здійснюється за назвою/GLN)
**limit** (опціонально) int - ліміт вибірки (за замовчуванням=20);
**offset** (опціонально) int - зміщення відносно верхньої межі вибірки (за замовчуванням=0)
|
| **Headers**
| |
| Authorization
| **SID** - токен, отриманий при [авторизації](https://wiki-v2.edin.ua/books/robota-z-api/page/metod-avtorizaciyi-na-platformi)
|
| Content-Type
| application/json
|
##### **RESPONSE**
В тілі відповіді передається масив об'єкта [Identificator](https://wiki-v2.edin.ua/books/robota-z-api/page/objekt-identificator) з даними контрагентів.
# Отримати список контрагентів-Покупців (Дистриб'юторів) GET /api/distribex/distributor/list
##### **REQUEST**
| **URL**
| https://edo-v2.edin.ua |
| Метод запиту
| GET
|
| URL запиту
| /api/distribex/distributor/list
|
| URL параметри
| **gln** (обов’язково) String - GLN Продавця (Виробника)
**query** (опціонально) String - текст пошуку (пошук здійснюється за назвою/GLN)
**limit** (опціонально) int - ліміт вибірки (за замовчуванням=20);
**offset** (опціонально) int - зміщення відносно верхньої межі вибірки (за замовчуванням=0)
**accessgroup** (опціонально) String - назва групи (пошук за повним збігом)
|
| **Headers**
| |
| Authorization
| **SID** - токен, отриманий при [авторизації](https://wiki-v2.edin.ua/books/robota-z-api/page/metod-avtorizaciyi-na-platformi)
|
| Content-Type
| application/json
|
##### **RESPONSE**
В тілі відповіді передається масив об'єкта [Identificator](https://wiki-v2.edin.ua/books/robota-z-api/page/objekt-identificator) з даними контрагентів.
# Визначення переліку товарних позицій, доступних для повернення, та формування документа “Надсилання Повернення” (ініціатор - Покупець/Дистриб’ютор) POST /api/distribex/doc/retann
##### **REQUEST**
| **URL**
| https://edo-v2.edin.ua
|
| Метод запиту
| POST
|
| URL запиту
| /api/distribex/doc/retann
|
| URL параметри
| **gln** (обов’язково) String - GLN Покупця (Дистрибʼютора)
**producer** (обов’язково) String - GLN Продавця (Виробника);
**period** (обов’язково) int - кількість днів, за які з документів робиться вибірка позицій, доступних до повернення (починаючи від поточного дня) - period=1 - за сьогодні, period=2 - за сьогодні та вчора і т.д.; максимум 90 днів, однак обмеження може змінюватись відповідно до наявності Лімітів зазначених Продавцем;
**search\_positions** (опціонально) boolean:
- якщо **true**, то у відповідь метода повертається список доступних до повернення позицій для зазначеного Покупця в межах періоду;
- якщо **false** або параметр **search\_positions** відсутній, то очікується тіло документа [«Повідомлення про повернення» (RETANN)](https://wiki-v2.edin.ua/books/xml-specifikaciyi-dokumentiv/page/povidomlennia-pro-povernennia-retann) в json форматі уже разом із позиціями; при цьому документ одразу відправляється контрагенту (без створення чернетки).
|
| **Headers**
| |
| Authorization
| SID - токен, отриманий при [авторизації](https://wiki-v2.edin.ua/books/robota-z-api/page/metod-avtorizaciyi-na-platformi)
|
| Content-Type
| application/json
|
| **REQUEST**
| |
| JSON Body
| Тіло запиту передається лише при search\_positions=false або відсутності даного параметра: [«Повідомлення про повернення» (RETANN)](https://wiki-v2.edin.ua/books/xml-specifikaciyi-dokumentiv/page/povidomlennia-pro-povernennia-retann) в json форматі уже разом із позиціями; при цьому документ одразу відправляється контрагенту (без створення чернетки).
|
##### **RESPONSE**
В тілі відповіді залежно від параметра `search_positions`:
- якщо **true**, то у відповідь метода повертається список доступних до Повернення позицій (масив об’єктів POSITION [«Повідомлення про повернення» (RETANN)](https://wiki-v2.edin.ua/books/xml-specifikaciyi-dokumentiv/page/povidomlennia-pro-povernennia-retann)) для зазначеного Покупця в межах періоду;
- якщо **false** або параметр **search\_positions** відсутній, то повертається doc\_uuid - унікальний ідентифікатор успішно відправленого «Повідомлення про повернення» (RETANN).
**Приклад відповіді (успішний запит)**
- **search\_positions=true**
```json
[
{
"POSITIONNUMBER": 1,
"PRODUCT": "4820022867421",
"PRICE": 96.06,
"PRODUCTIDSUPPLIER": "7127",
"RETURNQUANTITYUNIT": "PCE",
"DELIVEREDQUANTITYUNIT": "PCE",
"DESCRIPTION": "\"Традиционный\" 400х12 зерновой кофе Жокей Укр",
"AMOUNT": "3169.98",
"RETURNQUANTITY": "33"
}
]
```
- **search\_positions=false**
```json
{
doc_uuid:"e3dbf6e8-029e-4c3b-804b-9b2741d9f37d"
}
```
# Пошук документів (з фільтрацією), вибір списку документів POST /api/eds/docs/search
Метод виконує пошук за заданими критеріями, наприклад отримати список документів із певним статусом або за визначений період часу.
##### **REQUEST**
| **URL**
| https://edo-v2.edin.ua |
| Метод запиту
| POST
|
| URL запиту
| /api/eds/docs/search
|
| URL параметри
| **gln** (обов’язково) String - GLN власної Компанії АБО **guid** (обов’язково) String - унікальний ідентифікатор власної організації на платформі
**status\_id** (опціонально) int - id папки документів:
- 0 - Всі
- 1 - Вхідні;
- 2 - Надіслані;
- 3 - Архівні;
- 4 - Чернетки;
- 5 - Важливі.
**family** (опціонально) String - назва сімейства документів:
- edi
- uzd
- certificats
- ats
- ettn
- distribex (Маркет)
- simple-doc (Вільний)
- tender
- agreement
- openprice (Є-Товар)
|
| **Headers**
| |
| Authorization
| **SID** - токен, отриманий при [авторизації](https://wiki-v2.edin.ua/books/robota-z-api/page/metod-avtorizaciyi-na-platformi)
|
| Content-Type
| application/json
|
| **REQUEST**
| |
| JSON Body
| В тілі запиту методу передаються обов’язкові та додаткові критерії пошуку/фільтрації [об’єкт StorageQuery](https://wiki-v2.edin.ua/books/robota-z-api/page/objekt-storagequery-dani-dlia-filtraciyi)
|
##### **RESPONSE**
В тілі відповіді передається масив документів [об'єкт XDoc](https://wiki-v2.edin.ua/books/robota-z-api/page/objekt-xdoc).
# Отримання контенту документа GET /api/eds/doc/body
Метод повертає контент документа без підписів і печаток, а також тіла підпису та печатки. У запиті передаються GLN користувача, doc\_uuid та тип тіла документа.
##### **REQUEST**
| **URL**
| https://edo-v2.edin.ua |
| Метод запиту
| GET
|
| URL запиту
| /api/eds/doc/body
|
| URL параметри
| **gln** (обов’язково) String (13) - номер GLN організації, яка пов’язана з авторизованим користувачем платформи EDIN 2.0 на рівні акаунта
АБО
**guid** (обов’язково) String - унікальний ідентифікатор організації на платформі EDIN 2.0
**doc\_uuid** (обов’язково) UUID - ідентифікатор документа;
**body\_type** (обов’язково) String - тип тіла документа; можливі значення:
- content - base64 контент без підписів/печаток;
- json - json документа;
- sign - base64 тіло підпису;
- xml - тіло документа в xml форматі;
**response\_type** (опціонально) String - формат очікуваної відповіді; можливі варіанти:
- **bytes** (за замовчуванням)
- **file**
- **base64**
|
| **Headers**
| |
| Authorization
| **SID** - токен, отриманий при [авторизації](https://wiki-v2.edin.ua/books/robota-z-api/page/metod-avtorizaciyi-na-platformi)
|
| Content-Type
| application/json
|
##### **RESPONSE**
В тілі відповіді передається тіло документа в форматі, що визначається значенням параметра body\_type.
# Створити копію документа «Замовлення» (ORDER) відповідно до актуального «Прайс-листа» POST /api/distribex/order/copy
При формуванні «Замовлення» необхідно враховувати [обмеження](https://wiki.edin.ua/uk/latest/Distribution/EDIN_2_0/Instructions_2_0/Instruktsiia_dlia_dystrybiutora.html#id6), визначені в «Прайс-листі».
Методи API для [роботи з обмеженнями](https://wiki-v2.edin.ua/books/robota-z-api/page/robota-z-obmezenniami).
##### **REQUEST**
| **URL**
| https://edo-v2.edin.ua |
| Метод запиту
| POST
|
| URL запиту
| /api/distribex/order/copy?
|
| URL параметри
| **gln** (обов’язково) String - GLN Покупця (Дистрибʼютора) АБО **guid** (обов’язково) String - унікальний ідентифікатор організації Покупця (Дистрибʼютора) на платформі;
**doc\_uuid** (обов’язково) UUID - ідентифікатор документа (Замовлення), який потрібно повторити/скопіювати;
**actualize** (обов’язково) boolean = true - актуалізація нового повтореного/скопійованого Замовлення відносно Замовлення-основи на підставі актуального Прайс-листа Продавця (Виробника).
Актуалізація означає врахування всіх змін згідно з актуальним Прайс-листом: оновлених цін, наявності товарів та інших відмінностей у документі.
|
| **Headers**
| |
| Authorization
| **SID** - токен, отриманий при [авторизації](https://wiki-v2.edin.ua/books/robota-z-api/page/metod-avtorizaciyi-na-platformi)
|
| Content-Type
| application/json
|
##### **RESPONSE**
В тілі відповіді передається [об’єкт DistribexOrderResult](https://wiki-v2.edin.ua/books/robota-z-api/page/objekt-distribexorderresult) з деталями результату операції створення документа «Замовлення» (ORDER).
# Створити документ «Замовлення» (ORDER) за «Прайс-листом» POST /api/distribex/doc/order
При формуванні «Замовлення» необхідно враховувати [обмеження](https://wiki.edin.ua/uk/latest/Distribution/EDIN_2_0/Instructions_2_0/Instruktsiia_dlia_dystrybiutora.html#id6), визначені в «Прайс-листі».
Методи API для [роботи з обмеженнями](https://wiki-v2.edin.ua/books/robota-z-api/page/robota-z-obmezenniami).
##### **REQUEST**
| **URL**
| https://edo-v2.edin.ua |
| Метод запиту
| POST
|
| URL запиту
| /api/distribex/doc/order
|
| URL параметри
| **gln** (обов’язково) String - GLN Покупця (Дистрибʼютора) АБО **guid** (обов’язково) String - унікальний ідентифікатор організації Покупця (Дистрибʼютора) на платформі
**preorder\_id** (обов'язково) - id попереднього замовлення
**producer\_gln** (обов’язково) String - GLN Продавця (Виробника)
**number** (обов’язково) String - номер документа ORDER
**doc\_date** (опціонально) String - дата документа («YYYY-MM-DD»). При відсутності параметра автоматично проставляється поточна дата на момент формування запиту.
**delivery\_date** (опціонально) String - дата доставки («YYYY-MM-DD»). При відсутності параметра автоматично проставляється поточна дата на момент формування запиту.
**delivery\_gln** (обов’язково) String - GLN точки доставки
**delivery\_terms** (обов’язково) String - код умови відвантаження:
- 1 - Самовивіз;
- 2 - Доставка транспортом Продавця (Виробника).
**payment\_method** (опціонально) String - код способу оплати:
- 1 - Готівковий розрахунок
- 2 - Безготівковий розрахунок
**doc\_type** (опціонально) String - підтип документа «Замовлення» (ORDER.DOCTYPE); можливі варіанти:
- `O` - Оригінал замовлення (за замовчуванням)
- `PO` - Попереднє замовлення
- `R` - Заміна
- `D` - Видалення
|
| **Headers**
| |
| Authorization
| **SID** - токен, отриманий при [авторизації](https://wiki-v2.edin.ua/books/robota-z-api/page/metod-avtorizaciyi-na-platformi)
|
| Content-Type
| application/json
|
| **REQUEST**
| |
| JSON Body
| В тілі запиту методу передається [об'єкт DistribexOrderParams](https://wiki-v2.edin.ua/books/robota-z-api/page/objekt-distribexorderparams) (якщо необхідно)
|
##### **RESPONSE**
В тілі відповіді передається [об’єкт DistribexOrderResult](https://wiki-v2.edin.ua/books/robota-z-api/page/objekt-distribexorderresult) з деталями результату операції створення документа «Замовлення» (ORDER).
# Створити (розрахувати) номер «Замовлення» (ORDER) GET /api/oas/doc_counter
##### **REQUEST**
| **URL**
| https://edo-v2.edin.ua |
| Метод запиту
| GET
|
| URL запиту
| /api/oas/doc\_counter
|
| URL параметри
| **gln** (обов’язково) String - GLN Покупця (Дистрибʼютора)
|
| **Headers**
| |
| Authorization
| **SID** - токен, отриманий при [авторизації](https://wiki-v2.edin.ua/books/robota-z-api/page/metod-avtorizaciyi-na-platformi)
|
| Content-Type
| application/json
|
##### **RESPONSE**
В тілі відповіді передається розрахований номер «Замовлення» (ORDER), наприклад: `1000253`.
# Відправити рекомендації до замовлення за «Прайс-листом» POST /api/eds/doc/create_and_send
Метод дозволяє надіслати рекомендації до замовлення за Прайс-листом для покупця/-ців.
##### **REQUEST**
| **URL**
| https://edo-v2.edin.ua |
| Метод запиту
| POST
|
| URL запиту
| /api/eds/doc/create\_and\_send
|
| URL параметри
| **gln** - рядок (13); номер GLN організації, яка пов’язана з авторизованим користувачем платформи EDIN 2.0 на рівні акаунта
**doc\_type** - рядок; тип документа: допустиме значення: `orders`
|
| **Headers**
| |
| Authorization
| **SID** - токен, отриманий при [авторизації](https://wiki-v2.edin.ua/books/robota-z-api/page/metod-avtorizaciyi-na-platformi)
|
| Content-Type
| [multipart/form-data](https://tools.ietf.org/html/rfc7578)
|
| **REQUEST**
| |
| JSON Body
| В тілі запиту методу передається тільки один файл-вкладення в форматі `application/json` / `application/xml` / `application/pkcs7-signature` (приклади запитів + [специфікація Замовлення](https://wiki-v2.edin.ua/books/xml-specifikaciyi-dokumentiv/page/zamovlennia-order-i8g), в якому очікується DOCTYPE = «PO»)
При вказуванні `application/pkcs7-signature` доступна можливість обробки BASE64 формату.
|
**Приклад запиту в json форматі:**
```json
POST /api/eds/doc/create_and_send?doc_type=orders&gln=9864065702429 HTTP/1.1
Content-Type: multipart/form-data; boundary=-------------573cf973d5228
...else headers...
---------------573cf973d5228
Content-Disposition: form-data; name="file"; filename="file.json"
Content-Type: application/json
{Content of JSON file}
```
**Приклад запиту в xml форматі:**
```json
POST /api/eds/doc/create_and_send?doc_type=orders&gln=9864065702429 HTTP/1.1
Content-Type: multipart/form-data; boundary=-------------573cf973d5228
...else headers...
---------------573cf973d5228
Content-Disposition: form-data; name="file"; filename="file.xml"
Content-Type: application/xml
{Content of XML file}
```
**Приклад запиту в p7s форматі:**
```json
POST /api/eds/doc/create_and_send?doc_type=orders&gln=9864065702429 HTTP/1.1
Content-Type: multipart/form-data; boundary=-------------573cf973d5228
...else headers...
---------------573cf973d5228
Content-Disposition: form-data; name="file"; filename="file.p7s"
Content-Type: application/pkcs7-signature
{Content of P7S file}
```
##### **RESPONSE**
Код сервера 200 (ok).
# Надсилання документа (без створення чернетки) POST /api/eds/doc/create_and_send
Метод є універсальним для різних типів документів і дозволяє одночасно створити та відправити документ без створення чернетки.
##### **REQUEST**
| **URL**
| https://edo-v2.edin.ua |
| Метод запиту
| POST
|
| URL запиту
| /api/eds/doc/create\_and\_send
|
| URL параметри
| **gln** - рядок (13); номер GLN організації, яка пов’язана з авторизованим користувачем платформи EDIN 2.0 на рівні акаунта
**doc\_type** - рядок; [тип документа](https://wiki-v2.edin.ua/books/robota-z-api/page/objekt-xdoctype#bkmrk-%D0%A2%D0%B0%D0%B1%D0%BB%D0%B8%D1%86%D1%8F-2.-%D0%9E%D0%BF%D0%B8%D1%81-%D1%82%D0%B8%D0%BF%D1%96)
|
| **Headers**
| |
| Authorization
| **SID** - токен, отриманий при [авторизації](https://wiki-v2.edin.ua/books/robota-z-api/page/metod-avtorizaciyi-na-platformi)
|
| Content-Type
| [multipart/form-data](https://tools.ietf.org/html/rfc7578)
|
| **REQUEST**
| |
| JSON Body
| В тілі запиту методу передається тільки один файл-вкладення в форматі `application/json` / `application/xml` / `application/pkcs7-signature`
При вказуванні `application/pkcs7-signature` доступна можливість обробки BASE64 формату.
|
**Приклад запиту в json форматі:**
```json
POST /api/eds/doc/create_and_send?doc_type=orders&gln=9864065702429 HTTP/1.1
Content-Type: multipart/form-data; boundary=-------------573cf973d5228
...else headers...
---------------573cf973d5228
Content-Disposition: form-data; name="file"; filename="file.json"
Content-Type: application/json
{Content of JSON file}
```
**Приклад запиту в xml форматі:**
```json
POST /api/eds/doc/create_and_send?doc_type=orders&gln=9864065702429 HTTP/1.1
Content-Type: multipart/form-data; boundary=-------------573cf973d5228
...else headers...
---------------573cf973d5228
Content-Disposition: form-data; name="file"; filename="file.xml"
Content-Type: application/xml
{Content of XML file}
```
**Приклад запиту в p7s форматі:**
```json
POST /api/eds/doc/create_and_send?doc_type=orders&gln=9864065702429 HTTP/1.1
Content-Type: multipart/form-data; boundary=-------------573cf973d5228
...else headers...
---------------573cf973d5228
Content-Disposition: form-data; name="file"; filename="file.p7s"
Content-Type: application/pkcs7-signature
{Content of P7S file}
```
##### **RESPONSE**
- **chain\_uuid** - ідентифікатор ланцюжка, в якому знаходиться документ;
- **doc\_uuid** - ідентифікатор документа на платформі EDIN 2.0;
- **ticket\_uuid** - ідентифікатор квитанції
Параметр `ticket_uuid` повертається системою лише у випадках створення додаткового тікета до вже існуючого документа (наприклад: підписання у відповідь, відмова від підпису, запит на анулювання).
Якщо документ є новим, у відповіді система повертає лише `chain_uuid` та `doc_uuid`.
**Приклад відповіді:**
```json
{
"chain_uuid": "7ccff78e-ea42-47ea-81e4-5508ed4fbd51",
"doc_uuid": "3698b501-e1ef-464d-a71a-58066f556114",
"ticket_uuid": "1003706c-3656-497b-9438-c6f33e27c36d"
}
```
# Видалити Замовлення DELETE /api/distribex/preorder
##### **REQUEST**
| **URL**
| https://edo-v2.edin.ua |
| Метод запиту
| DELETE
|
| URL запиту
| /api/distribex/preorder
|
| URL параметри
| **gln** (обов’язково) String - GLN Покупця (Дистрибʼютора)
**preorder\_id** (обов’язково) String - ідентифікатор Попереднього замовлення
|
| **Headers**
| |
| Authorization
| **SID** - токен, отриманий при [авторизації](https://wiki-v2.edin.ua/books/robota-z-api/page/metod-avtorizaciyi-na-platformi)
|
| Content-Type
| application/json
|
##### **RESPONSE**
Код сервера 200 (ok).
# Зберегти Замовлення по «Прайс-листу» POST /api/distribex/preorder
##### **REQUEST**
| **URL**
| https://edo-v2.edin.ua |
| Метод запиту
| POST
|
| URL запиту
| /api/distribex/preorder
|
| URL параметри
| **gln** (обов’язково) String - GLN Покупця (Дистрибʼютора)
**producerId** (обов’язково) String - ідентифікатор Продавця (Виробника)
**positions** (обов’язково /-) String - позиції Попереднього замовлення. Параметр відсутній при наявності load\_excel параметра
**load\_excel** (обов’язково /-) boolean - load\_excel=true при передачі значень через xls-файл. Параметр відсутній при наявності positions параметра
**doc\_uuid** (опціонально) UUID - ідентифікатор документа-підстави
**type\_id** (опціонально) int - ідентифікатор підтипу документа:
- 1 - оригінальне замовлення (за замовчуванням);
- 2 - попереднє замовлення;
- 3 - відредаговане замовлення
|
| **Headers**
| |
| Authorization
| **SID** - токен, отриманий при [авторизації](https://wiki-v2.edin.ua/books/robota-z-api/page/metod-avtorizaciyi-na-platformi)
|
| Content-Type
| application/json
|
| **REQUEST**
| |
| JSON Body
| При передачі значень вручну (через positions параметр): в тілі запиту методу передається масив об’єктів [XDistribexPreorderPosition](https://wiki-v2.edin.ua/books/robota-z-api/page/objekt-xdistribexpreorderposition) з вказаною кількістю відповідних товарних позицій для Попереднього замовлення.
При передачі значень через xls-файл (вказується параметр load\_excel=true): в тілі запиту передається заповнений шаблон order\_upload\_ua.xls *(вкладення ліворуч)*
|
##### **RESPONSE**
В тілі відповіді передаються дані для збереження Замовлення по «Прайс-листу» (об’єкт [XDistribexPreorder](https://wiki-v2.edin.ua/books/robota-z-api/page/objekt-xdistribexpreorder))
# Отримати дані для формування Замовлення по «Прайс-листу» GET /api/distribex/preorder
##### **REQUEST**
| **URL**
| https://edo-v2.edin.ua |
| Метод запиту
| GET
|
| URL запиту
| /api/distribex/preorder
|
| URL параметри
| **gln** (обов’язково) String - GLN Покупця (Дистрибʼютора)
**producerId** (обов’язково) String - ідентифікатор Продавця (Виробника)
**type\_id** (опціонально) int - ідентифікатор підтипу документа:
- 1 - оригінальне замовлення (за замовчуванням);
- 2 - попереднє замовлення;
- 3 - відредаговане замовлення
|
| **Headers**
| |
| Authorization
| **SID** - токен, отриманий при [авторизації](https://wiki-v2.edin.ua/books/robota-z-api/page/metod-avtorizaciyi-na-platformi)
|
| Content-Type
| application/json
|
##### **RESPONSE**
В тілі відповіді передаються дані для формування Замовлення по «Прайс-листу» (об’єкт [XDistribexPreorder](https://wiki-v2.edin.ua/books/robota-z-api/page/objekt-xdistribexpreorder))
# Зберегти (відредагувати) Замовлення за «Прайс-листом» PUT /api/distribex/preorder
##### **REQUEST**
| **URL**
| https://edo-v2.edin.ua |
| Метод запиту
| PUT
|
| URL запиту
| /api/distribex/preorder
|
| URL параметри
| **gln** (обов’язково) String - GLN Покупця (Дистрибʼютора)
**producerId** (обов’язково) String - ідентифікатор Продавця (Виробника)
**id** (обов’язково) String - ідентифікатор Попереднього замовлення
**positions** (обов’язково) String - позиції Попереднього замовлення
**doc\_uuid** (опціонально) UUID - ідентифікатор документа-підстави
**type\_id** (опціонально) int - ідентифікатор підтипу документа:
- 1 - оригінальне замовлення (за замовчуванням);
- 2 - попереднє замовлення;
- 3 - відредаговане замовлення
|
| **Headers**
| |
| Authorization
| **SID** - токен, отриманий при [авторизації](https://wiki-v2.edin.ua/books/robota-z-api/page/metod-avtorizaciyi-na-platformi)
|
| Content-Type
| application/json
|
| **REQUEST**
| |
| JSON Body
| В тілі запиту методу передається масив об'єкта [XDistribexPreorderPosition](https://wiki-v2.edin.ua/books/robota-z-api/page/objekt-xdistribexpreorderposition)
|
##### **RESPONSE**
В тілі відповіді передаються дані для збереження Замовлення по «Прайс-листу» (об’єкт [XDistribexPreorder](https://wiki-v2.edin.ua/books/robota-z-api/page/objekt-xdistribexpreorder))
# Видалити позицію або «Прайс-лист» для вказаного Покупця (Дистрибʼютора) DELETE /api/distribex/pricelist
Даний метод може бути використано лише користувачем з роллю Продавець (Виробник).
Метод призначений для видалення товарної позиції з «Прайс-листа» для зазначеного «Покупця (Дистрибʼютора)».
Якщо параметр `list_id` (ID товарної позиції) не передано, тоді «Прайс-лист» для вказаного «Покупця (Дистрибʼютора)» повністю очищується.
##### **REQUEST**
| **URL**
| https://edo-v2.edin.ua |
| Метод запиту
| DELETE
|
| URL запиту
| /api/distribex/pricelist
|
| URL параметри
| **gln** (обов’язково) String - GLN Продавця (Виробника)
**gln\_id** (обов’язково) String - ідентифікатор Покупця (Дистрибʼютора)
**list\_id** (опціонально) String - ідентифікатор товарної позиції, яку потрібно видалити в Прайс-листі. Якщо **list\_id** параметр не передається, то Прайс-лист для вказаного Покупця (Дистрибʼютора) видаляється (очищається) повністю.
|
| **Headers**
| |
| Authorization
| **SID** - токен, отриманий при [авторизації](https://wiki-v2.edin.ua/books/robota-z-api/page/metod-avtorizaciyi-na-platformi)
|
| Content-Type
| application/json
|
##### **RESPONSE**
Код сервера 200 (ok).
# Отримати дані «Прайс-листа» для вказаного Покупця (Дистрибʼютора) GET /api/distribex/pricelist
Значення параметрів у запиті відрізняються залежно від ролі користувача «Продавець (Виробник)» / «Покупець (Дистрибʼютор)».
##### **REQUEST**
**Для ролі Покупця (Дистрибʼютора)**
| **URL**
| https://edo-v2.edin.ua |
| Метод запиту
| GET
|
| URL запиту
| /api/distribex/pricelist
|
| URL параметри
| **gln** (обов’язково) Число (13) - GLN Покупця (Дистрибʼютора)
**gln\_id** (обов’язково) String - ідентифікатор Продавця (Виробника) (producer\_id)
|
| **Headers**
| |
| Authorization
| **SID** - токен, отриманий при [авторизації](https://wiki-v2.edin.ua/books/robota-z-api/page/metod-avtorizaciyi-na-platformi)
|
| Content-Type
| application/json
|
**Для ролі Продавця (Виробника)**
| **URL**
| https://edo-v2.edin.ua |
| Метод запиту
| GET
|
| URL запиту
| /api/distribex/pricelist
|
| URL параметри
| **gln** (обов’язково) Число (13) - GLN Продавця (Виробника)
**gln\_id** (обов’язково/-) String - ідентифікатор Покупця (Дистрибʼютора) (distributor\_id). Обов’язково передається або **gln\_id** або **access\_groups\_id** (один з параметрів);
**access\_groups\_id** (обов’язково/-) long - ідентифікатор групи Покупців (Дистрибʼюторів). Обов’язково передається або **gln\_id** або **access\_groups\_id** (один з параметрів);
**date** (опціонально) YYYY-MM-DD - *Прайс-лист Покупця (Дистрибʼютора) на* дату (фільтр)
|
| **Headers**
| |
| Authorization
| **SID** - токен, отриманий при [авторизації](https://wiki-v2.edin.ua/books/robota-z-api/page/metod-avtorizaciyi-na-platformi)
|
| Content-Type
| application/json
|
##### **RESPONSE**
В тілі відповіді передаються дані по товарах «Прайс-листа»:
- у вигляді масиву об’єктів [XPriceListElement](https://wiki-v2.edin.ua/books/robota-z-api/page/objekt-xpricelistelement) для вказаного Покупця (Дистрибʼютора);
- у вигляді об’єкта зі списком ідентифікаторів Покупців (Дистрибʼюторів), що входять до вказаної групи (access\_groups\_id), та «Прайс-листом» для кожного знайденого Покупця (Дистрибʼютора) (масиву об’єктів [XPriceListElement](https://wiki-v2.edin.ua/books/robota-z-api/page/objekt-xpricelistelement)).
# Редагувати дані товарів «Прайс-листа» вказаного Покупця (Дистрибʼютора) PUT /api/distribex/pricelist
Даний метод може бути використано лише користувачем з роллю Продавець (Виробник).
##### **REQUEST**
| **URL**
| https://edo-v2.edin.ua |
| Метод запиту
| PUT
|
| URL запиту
| /api/distribex/pricelist
|
| URL параметри
| **gln** (обов’язково) String - GLN Продавця (Виробника)
**gln\_id** (обов’язково) String - ідентифікатор Покупця (Дистрибʼютора)
|
| **Headers**
| |
| Authorization
| **SID** - токен, отриманий при [авторизації](https://wiki-v2.edin.ua/books/robota-z-api/page/metod-avtorizaciyi-na-platformi)
|
| Content-Type
| application/json
|
| **REQUEST**
| |
| JSON Body
| В тілі запиту методу передаються нові/оновлені дані товарів Прайс-листа для вказаного Покупця (Дистрибʼютора) (масив об’єктів [XPriceListElement](https://wiki-v2.edin.ua/books/robota-z-api/page/objekt-xpricelistelement))
|
##### **RESPONSE**
Код сервера 200 (ok).
# Додати або оновити дані товарів у Прайс-листі для вказаних Покупців (Дистриб’юторів) POST /api/distribex/pricelist
Даний метод може бути використано лише користувачем з роллю Продавець (Виробник).
##### **REQUEST**
| **URL**
| https://edo-v2.edin.ua |
| Метод запиту
| POST
|
| URL запиту
| /api/distribex/pricelist
|
| URL параметри
| **gln** (обов’язково) String - GLN Продавця (Виробника)
|
| **Headers**
| |
| Authorization
| **SID** - токен, отриманий при [авторизації](https://wiki-v2.edin.ua/books/robota-z-api/page/metod-avtorizaciyi-na-platformi)
|
| Content-Type
| application/json
|
| **REQUEST**
| |
| JSON Body
| В тілі запиту методу передаються нові/оновлені дані товарів, що долучаються в Прайс-лист до вказаних Покупців (Дистрибʼюторів) (об’єкт [XPriceListElement](https://wiki-v2.edin.ua/books/robota-z-api/page/objekt-xpricelistelement))
|
##### **RESPONSE**
Код сервера 200 (ok).
# Масово видалити відмітку надбавки в прайс-листі для Покупця (Дистриб'ютора) DELETE /api/distribex/surcharge
Даний метод може бути використано лише користувачем з роллю Продавець (Виробник).
##### **REQUEST**
| **URL**
| https://edo-v2.edin.ua |
| Метод запиту
| DELETE
|
| URL запиту
| /api/distribex/surcharge
|
| URL параметри
| **gln** (обов’язково) String - GLN Продавця (Виробника)
**distributor\_gln** (обов’язково) String - GLN Покупця (Дистрибʼютора)
|
| **Headers**
| |
| Authorization
| **SID** - токен, отриманий при [авторизації](https://wiki-v2.edin.ua/books/robota-z-api/page/metod-avtorizaciyi-na-platformi)
|
| Content-Type
| application/json
|
##### **RESPONSE**
Код сервера 200 (ok).
# Отримати дані надбавки по товару для вказаного Покупця (Дистриб'ютора) GET /api/distribex/surcharge
##### **REQUEST**
| **URL**
| https://edo-v2.edin.ua |
| Метод запиту
| GET
|
| URL запиту
| /api/distribex/surcharge
|
| URL параметри
| **gln** (обов’язково) String - GLN Продавця (Виробника)
**distributor\_gln** (обов’язково) String - GLN Покупця (Дистрибʼютора)
**barcode** (обов’язково) String - штрихкод товару
**article** (опціонально) String - артикул товару
|
| **Headers**
| |
| Authorization
| **SID** - токен, отриманий при [авторизації](https://wiki-v2.edin.ua/books/robota-z-api/page/metod-avtorizaciyi-na-platformi)
|
| Content-Type
| application/json
|
##### **RESPONSE**
В тілі відповіді передаються дані по встановленим [надбавкам](https://wiki-v2.edin.ua/books/robota-z-api/page/objekt-xdistribexsurcharge) для вказаного Покупця (Дистрибʼютора).
# Встановити відмітку «Надбавка» для Покупців (Дистриб'юторів) PUT /api/distribex/surcharge
Даний метод може бути використано лише користувачем з роллю Продавець (Виробник).
##### **REQUEST**
| **URL**
| https://edo-v2.edin.ua |
| Метод запиту
| PUT
|
| URL запиту
| /api/distribex/surcharge
|
| URL параметри
| **gln** (обов’язково) String - GLN Продавця (Виробника)
|
| **Headers**
| |
| Authorization
| **SID** - токен, отриманий при [авторизації](https://wiki-v2.edin.ua/books/robota-z-api/page/metod-avtorizaciyi-na-platformi)
|
| Content-Type
| application/json
|
| **REQUEST**
| |
| JSON Body
| В тілі запиту методу передається масив об’єктів [XDistribexSurcharge](https://wiki-v2.edin.ua/books/robota-z-api/page/objekt-xdistribexsurcharge)
з надбавками для зазначених товарних позицій вказаного користувача-Покупця (Дистрибʼютора)
|
##### **RESPONSE**
Код сервера 200 (ok).
# Масово видалити квоти в прайс-листі для Покупця (Дистриб'ютора) DELETE /api/distribex/quotas
Даний метод може бути використано лише користувачем з роллю Продавець (Виробник).
##### **REQUEST**
| **URL**
| https://edo-v2.edin.ua |
| Метод запиту
| DELETE
|
| URL запиту
| /api/distribex/quotas
|
| URL параметри
| **gln** (обов’язково) String - GLN Продавця (Виробника)
**d\_gln** (обов’язково) String - GLN Покупця (Дистрибʼютора)
|
| **Headers**
| |
| Authorization
| **SID** - токен, отриманий при [авторизації](https://wiki-v2.edin.ua/books/robota-z-api/page/metod-avtorizaciyi-na-platformi)
|
| Content-Type
| application/json
|
##### **RESPONSE**
Код сервера 200 (ok).
# Отримати квоти по товару для вказаного Покупця (Дистриб'ютора) GET /api/distribex/quotas
##### **REQUEST**
| **URL**
| https://edo-v2.edin.ua |
| Метод запиту
| GET
|
| URL запиту
| /api/distribex/quotas
|
| URL параметри
| **gln** (обов’язково) String - GLN Продавця (Виробника)
**d\_gln** (обов’язково) String - GLN Покупця (Дистрибʼютора)
**barcode** (обов’язково) String - штрихкод товару
**article** (обов’язково) String - артикул товару
|
| **Headers**
| |
| Authorization
| **SID** - токен, отриманий при [авторизації](https://wiki-v2.edin.ua/books/robota-z-api/page/metod-avtorizaciyi-na-platformi)
|
| Content-Type
| application/json
|
##### **RESPONSE**
В тілі відповіді передаються дані по встановленим [квотам](https://wiki-v2.edin.ua/books/robota-z-api/page/objekt-quotas) для вказаного Покупця (Дистрибʼютора).
# Встановити нові квоти для Покупців (Дистриб'юторів) PUT /api/distribex/quotas
##### **REQUEST**
| **URL**
| https://edo-v2.edin.ua |
| Метод запиту
| PUT
|
| URL запиту
| /api/distribex/quotas
|
| URL параметри
| **gln** (обов’язково) String - GLN Продавця (Виробника)
|
| **Headers**
| |
| Authorization
| **SID** - токен, отриманий при [авторизації](https://wiki-v2.edin.ua/books/robota-z-api/page/metod-avtorizaciyi-na-platformi)
|
| Content-Type
| application/json
|
| **REQUEST**
| |
| JSON Body
| В тілі запиту методу передається масив об’єктів [Quotas ](https://wiki-v2.edin.ua/books/robota-z-api/page/objekt-quotas)з квотами для кожного вказаного користувача-Покупця (Дистрибʼютора)
|
##### **RESPONSE**
Код сервера 200 (ok).
# Видалити обмеження для контрагента (ініціатор Продавець (Виробник)) DELETE /api/distribex/limits
##### **REQUEST**
| **URL**
| https://edo-v2.edin.ua |
| Метод запиту
| DELETE
|
| URL запиту
| /api/distribex/limits
|
| URL параметри
| **gln** (обов’язково) String - GLN Продавця (Виробника)
**d\_gln** (обов’язково) String - GLN Покупця (Дистрибʼютора)
**limit\_key** (опціонально) String - [перелік доступних значень обмежень](https://wiki-v2.edin.ua/books/robota-z-api/page/objekt-limits). Використовується, якщо потрібно видалити одне обмеження зі списку, а не очистити всі обмеження повністю.
|
| **Headers**
| |
| Authorization
| **SID** - токен, отриманий при [авторизації](https://wiki-v2.edin.ua/books/robota-z-api/page/metod-avtorizaciyi-na-platformi)
|
| Content-Type
| application/json
|
##### **RESPONSE**
Код сервера 200 (ok).
# Отримати обмеження контрагента за GLN GET /api/distribex/limits
Метод може використовуватись як Продавцем (Виробником), так і Покупцем (Дистрибʼютором):
- для отримання налаштованих обмежень з боку Продавця (Виробника) передаються параметри **gln** та **d\_gln**;
- для отримання налаштованих обмежень з боку Покупця (Дистрибʼютора) передаються параметри **gln** та **producerId**.
##### **REQUEST**
| **URL**
| https://edo-v2.edin.ua |
| Метод запиту
| GET
|
| URL запиту
| /api/distribex/limits
|
| URL параметри
| **gln** (обов’язково) String - GLN власної Компанії
**d\_gln** / **producerId** (обов’язково) String
- з боку Продавця (Виробника): **d\_gln** - GLN Покупця (Дистрибʼютора)
- з боку Покупця (Дистрибʼютора): **producerId** - ідентифікатор компанії-Продавця (Виробника)
|
| **Headers**
| |
| Authorization
| **SID** - токен, отриманий при [авторизації](https://wiki-v2.edin.ua/books/robota-z-api/page/metod-avtorizaciyi-na-platformi)
|
| Content-Type
| application/json
|
##### **RESPONSE**
В тілі відповіді передається об’єкт [Limits ](https://wiki-v2.edin.ua/books/robota-z-api/page/objekt-limits)з обмеженнями для вказаного Покупця (Дистрибʼютора).
# Додати/змінити обмеження (ініціатор Продавець (Виробник)) (ініціатор Продавець (Виробник)) POST /api/distribex/limits
##### **REQUEST**
| **URL**
| https://edo-v2.edin.ua |
| Метод запиту
| POST
|
| URL запиту
| /api/distribex/limits
|
| URL параметри
| **gln** (обов’язково) String - GLN Продавця (Виробника)
|
| **Headers**
| |
| Authorization
| **SID** - токен, отриманий при [авторизації](https://wiki-v2.edin.ua/books/robota-z-api/page/metod-avtorizaciyi-na-platformi)
|
| Content-Type
| application/json
|
| **REQUEST**
| |
| JSON Body
| В тілі запиту методу передається об’єкт [Limits ](https://wiki-v2.edin.ua/books/robota-z-api/page/objekt-limits)(назва=GLN Покупця (Дистрибʼютора)) з обмеженнями для конкретного користувача-Покупця (Дистрибʼютора)
|
##### **RESPONSE**
Код сервера 200 (ok)
# Видалити відправлені запрошення Покупцю (ініціатор Продавець (Виробник)) DELETE /api/distribex/invitation
##### **REQUEST**
| **URL**
| https://edo-v2.edin.ua |
| Метод запиту
| DELETE
|
| URL запиту
| /api/distribex/invitation
|
| URL параметри
| **gln** (обов’язково) String - GLN власної Компанії;
**invitation\_id** (обов’язково) String - ідентифікатор раніше відправленого запрошення (XDistribexInvitation.id); можна передавати декілька, для масового надсилання
|
| **Headers**
| |
| Authorization
| **SID** - токен, отриманий при [авторизації](https://wiki-v2.edin.ua/books/robota-z-api/page/metod-avtorizaciyi-na-platformi)
|
| Content-Type
| application/json
|
##### **RESPONSE**
Код сервера 200 (ok).
# Повторно відправити запрошення Покупцю (ініціатор Продавець (Виробник)) PATCH /api/distribex/invitation
Повторне надсилання запрошення одному й тому ж Покупцю доступно один раз на 24 години
##### **REQUEST**
| **URL**
| https://edo-v2.edin.ua |
| Метод запиту
| PATCH
|
| URL запиту
| /api/distribex/invitation
|
| URL параметри
| **gln** (обов’язково) String - GLN власної Компанії;
**invitation\_id** (обов’язково) String - ідентифікатор раніше відправленого запрошення (XDistribexInvitation.id); можна передавати декілька, для масового надсилання
|
| **Headers**
| |
| Authorization
| **SID** - токен, отриманий при [авторизації](https://wiki-v2.edin.ua/books/robota-z-api/page/metod-avtorizaciyi-na-platformi)
|
| Content-Type
| application/json
|
##### **RESPONSE**
В тілі відповіді передається об’єкт з контактами, яким не були відправлені запрошення:
- **done** - масив; список контактів, з якими вже утворений зв’язок;
- **errors** - масив; список контактів, яким Ви вже відправляли запрошення протягом останніх 24 годин.
**Приклад відповіді:**
```json
{"done":[save@mail.com],"errors":["savep38075@adosnan.com"]}
```
# Прийняти / Відхилити запрошення Продавця (ініціатор Покупець (Дистриб’ютор)) POST /api/distribex/invitation
##### **REQUEST**
| **URL**
| https://edo-v2.edin.ua |
| Метод запиту
| POST
|
| URL запиту
| /api/distribex/invitation
|
| URL параметри
| **gln** (обов’язково) String - GLN власної Компанії;
**invitation\_id** (обов’язково) String - ідентифікатор раніше відправленого запрошення (XDistribexInvitation.id);
**status** (обов’язково) int - статус, який потрібно надати запрошенню:
- 1 - Прийнято;
- 2 - Відхилено
|
| **Headers**
| |
| Authorization
| **SID** - токен, отриманий при [авторизації](https://wiki-v2.edin.ua/books/robota-z-api/page/metod-avtorizaciyi-na-platformi)
|
| Content-Type
| application/json
|
| **REQUEST**
| |
| JSON Body
| В запиті при **status=2** може передаватись текстова причина відхилення запрошення, що буде відображатись Продавцю.
|
##### **RESPONSE**
Код сервера 200 (ok).
# Отримати запрошення Продавця в сервіс «Маркет»/Отримати вкладення до вказаного запрошення GET /api/distribex/invitation
##### **REQUEST**
- **Формування запиту Продавцем**
| **URL**
| https://edo-v2.edin.ua |
| Метод запиту
| GET
|
| URL запиту
| /api/distribex/invitation
|
| URL параметри
| **gln** (обов’язково) String - GLN власної Компанії;
**invitation\_id** (опціонально) int - ідентифікатор запрошення (передається для того, щоб отримати конкретне запрошення у json форматі). Якщо додатково передати параметр **load\_body=true**, то повертається контент вкладення (pdf-файл) до запрошення;
Для фільтрації списку доступних запрошень можливо використовувати дод. параметри:
- **limit** (опціонально) int - ліміт вибірки (за замовчуванням=20);
- **offset** (опціонально) int - зміщення відносно верхньої межі вибірки (за замовчуванням=0)
- **status** (опціонально) int - статус запрошення (можливо передавати кілька значень):
- 0 - Запрошено;
- 1 - Прийнято;
- 2 - Відхилено
|
| **Headers**
| |
| Authorization
| **SID** - токен, отриманий при [авторизації](https://wiki-v2.edin.ua/books/robota-z-api/page/metod-avtorizaciyi-na-platformi)
|
| Content-Type
| application/json
|
- **Формування запиту Покупцем**
| **URL**
| https://edo-v2.edin.ua |
| Метод запиту
| GET
|
| URL запиту
| /api/distribex/invitation?gln=9864065732303&limit=21&offset=0
|
| URL параметри
| **gln** (обов’язково) String - GLN власної Компанії;
**invitation\_id** (опціонально) int - ідентифікатор запрошення (передається для того, щоб отримати конкретне запрошення у json форматі). Якщо додатково передати параметр **load\_body=true**, то повертається контент вкладення (pdf-файл) до запрошення;
**buyer\_ipn** (опціонально) int - ЄДРПОУ / ІПН Покупця, що були зазначені в запрошенні;
**buyer** (опціонально) String - контакти (email або мобільний номер телефону) Покупця, що були зазначені в запрошенні;
Для фільтрації списку доступних запрошень можливо використовувати дод. параметри:
- **limit** (опціонально) int - ліміт вибірки (за замовчуванням=20);
- **offset** (опціонально) int - зміщення відносно верхньої межі вибірки (за замовчуванням=0)
|
| **Headers**
| |
| Authorization
| **SID** - токен, отриманий при [авторизації](https://wiki-v2.edin.ua/books/robota-z-api/page/metod-avtorizaciyi-na-platformi)
|
| Content-Type
| application/json
|
##### **RESPONSE**
В тілі відповіді залежно від параметрів, що передаються може повертатись список усіх наявних запрошень ([масив об’єктів XDistribexInvitation](https://wiki-v2.edin.ua/books/robota-z-api/page/objekt-xdistribexinvitation)) чи конкретне запрошення (1 об’єкт XDistribexInvitation). Якщо в методі передавались параметри invitation\_id + load\_body=true, то у відповідь повертається pdf-вкладення до запрошення в base64 форматі.
# Відправити запрошення Покупцю (ініціатор Продавець (Виробник)) POST /api/distribex/invitation
Повторне надсилання запрошення одному й тому ж Покупцю доступно один раз на 24 години
##### **REQUEST**
- **Надіслати запрошення Покупцю**
| **URL**
| https://edo-v2.edin.ua |
| Метод запиту
| POST
|
| URL запиту
| /api/distribex/invitation
|
| URL параметри
| **gln** (обов’язково) String - GLN власної Компанії;
**buyer** (обов’язково) String - контакт Покупця (email або мобільний номер телефону);
**buyer\_ipn** (опціонально) String - ЄДРПОУ / ІПН Покупця
|
| **Headers**
| |
| Authorization
| **SID** - токен, отриманий при [авторизації](https://wiki-v2.edin.ua/books/robota-z-api/page/metod-avtorizaciyi-na-platformi)
|
| Content-Type
| [multipart/form-data](https://tools.ietf.org/html/rfc7578)
|
| **REQUEST**
| |
| Form-data
| В запиті може передаватись (опціонально) тіло в форматі `application/pdf` - інформаційний лист, як вкладення до запрошення Покупця
|
**Приклад запиту:**
```json
-----------------------------339686098424586820212953841379
Content-Disposition: form-data; name="attachment"; filename="_pdf_meme.pdf"
Content-Type: application/pdf
(data)
-----------------------------339686098424586820212953841379--
```
- **Масове надсилання запрошень Покупцям**
| **URL**
| https://edo-v2.edin.ua |
| Метод запиту
| POST
|
| URL запиту
| /api/distribex/invitation
|
| URL параметри
| **gln** (обов’язково) String - GLN власної Компанії;
**buyer** (опціонально) String - контакт Покупця (email або мобільний номер телефону);
**buyer\_ipn** (опціонально) String - ЄДРПОУ / ІПН Покупця
|
| **Headers**
| |
| Authorization
| **SID** - токен, отриманий при [авторизації](https://wiki-v2.edin.ua/books/robota-z-api/page/metod-avtorizaciyi-na-platformi)
|
| Content-Type
| [multipart/form-data](https://tools.ietf.org/html/rfc7578)
|
| **REQUEST**
| |
| Form-data
| В запиті може передаватись кілька тіл:
- одне з тіл у форматі `application/pdf` (опціонально) - інформаційний лист, як вкладення до запрошення Покупця;
- для масового завантаження запрошень обов’язково одне з тіл в запиті має бути в форматі application/json, де передається список запрошених Покупців
|
**Приклад запиту:**
```json
-----------------------------42215802802152663972618512251
Content-Disposition: form-data; name="json"; filename="json"
Content-Type: application/json
[{"buyerContact":"test@gmail.com","buyerIPN":"14360570"},{"buyerContact":"test2@gmail.com","buyerIPN":"14360570"}]
-----------------------------42215802802152663972618512251
Content-Disposition: form-data; name="file"; filename="_pdf_meme.pdf"
Content-Type: application/pdf
(data)
-----------------------------42215802802152663972618512251--
```
##### **RESPONSE**
В тілі відповіді передається об’єкт з контактами, яким не були відправлені запрошення:
- **done** - масив; список контактів, з якими вже утворений зв’язок;
- **duplicates** - масив; список контактів, яким Ви вже відправляли запрошення протягом останніх 24 годин
**Приклад відповіді:**
```json
{"done":[save@mail.com],"duplicates":["savep38075@adosnan.com"]}
```