Робота з документами

Для роботи з методами користувач повинен ~~бути~~ бути авторизованим.

Створити (розрахувати) номер «Замовлення» (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 - токен, отриманий ~~при~~ при авторизації
Content-Type	application/json

RESPONSE

В ~~тілі відповіді~~ тілі відповіді передається розрахований номер «Замовлення» (ORDER), наприклад: 1000253.

Створити документ «Замовлення» (ORDER) за «Прайс-листом»

POST /api/distribex/doc/order

При формуванні «Замовлення» необхідно враховувати обмеження, визначені в «Прайс-листі».
Методи API для роботи з обмеженнями.

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 - токен, отриманий ~~при~~ при авторизації
Content-Type	application/json
REQUEST
JSON Body	В тілі запиту методу передається об'єкт DistribexOrderParams (якщо необхідно)

RESPONSE

В тілі відповіді передається об’єкт DistribexOrderResult з деталями результату операції створення документа «Замовлення» (ORDER).

Створити копію документа «Замовлення» (ORDER) відповідно до актуального «Прайс-листа»

POST /api/distribex/order/copy

При формуванні «Замовлення» необхідно ~~враховувати~~ враховувати обмеження, визначені в «Прайс-листі».
Методи API для роботи з обмеженнями.

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 - токен, отриманий ~~при~~ при авторизації
Content-Type	application/json

RESPONSE

Отримання контенту документа

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 - токен, отриманий ~~при~~ при авторизації
Content-Type	application/json

RESPONSE

В ~~тілі відповіді~~ тілі відповіді передається тіло документа в форматі, що визначається значенням ~~параметра~~ параметра body_type.

Пошук документів (з фільтрацією), вибір списку документів

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 - токен, отриманий ~~при~~ при авторизації
Content-Type	application/json
REQUEST
JSON Body	В тілі запиту методу передаються обов’язкові та додаткові критерії пошуку/фільтрації об’єкт StorageQuery

RESPONSE

В тілі відповіді передається масив документів об'~~єкт~~ єкт XDoc.

Визначення переліку товарних позицій, доступних для повернення, та формування документа “Надсилання Повернення”

(ініціатор — Покупець / Дистриб’ютор)

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) в json форматі уже разом із позиціями; при цьому документ одразу відправляється контрагенту (без створення чернетки).
Headers
Authorization	~~SID~~ SID - токен, отриманий ~~при~~ при авторизації
Content-Type	application/json
REQUEST
JSON Body	Тіло запиту передається лише при search_positions=false або відсутності даного параметра: «Повідомлення про повернення» (RETANN) в json форматі уже разом із позиціями; при цьому документ одразу відправляється контрагенту (без створення чернетки).

RESPONSE

В тілі відповіді залежно від ~~параметра~~ параметра search_positions:

~~якщо~~ якщо true, то у відповідь метода повертається список доступних до Повернення позицій (масив об’єктів ~~POSITION~~ POSITION «Повідомлення про повернення» (RETANN)) для зазначеного Покупця в межах періоду;
~~якщо~~ якщо ~~false~~ false або параметр search_positions відсутній, то ~~повертається~~ повертається doc_uuid - унікальний ідентифікатор успішно відправленого «Повідомлення про повернення» (RETANN).

Приклад відповіді (успішний запит)

search_positions=true

[
    {
        "POSITIONNUMBER": 1,
        "PRODUCT": "4820022867421",
        "PRICE": 96.06,
        "PRODUCTIDSUPPLIER": "7127",
        "RETURNQUANTITYUNIT": "PCE",
        "DELIVEREDQUANTITYUNIT": "PCE",
        "DESCRIPTION": "\"Традиционный\"  400х12 зерновой кофе Жокей Укр",
        "AMOUNT": "3169.98",
        "RETURNQUANTITY": "33"
    }
]

search_positions=false

{
  doc_uuid:"e3dbf6e8-029e-4c3b-804b-9b2741d9f37d"
  }