Робота з пропозиціями

Всі запити нижче перерахованих API методів платформи EDIN 2.0 направляються на адресу: https://edo-v2.edin.ua

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

Отримати список документів в журналі

GET /api/es/agreements

REQUEST

URL
Метод запиту	GET
URL запиту	/api/es/agreements?gln=986xxxxx11415
URL параметри	gln (обов’язково) String - GLN власної Компанії АБО guid (обов’язково) String - унікальний ідентифікатор власної організації на платформі; limit (опціонально) int - ліміт вибірки (за замовчуванням=20); offset (опціонально) int - зміщення відносно верхньої межі вибірки (за замовчуванням=0)
Headers
Authorization	SID - токен, отриманий при авторизації
Content-Type	application/json

RESPONSE

В тілі відповіді в json-форматі передається масив з інформацією про пропозиції .

Переглянути налаштування мережі

GET /api/oas/retailer/settings

REQUEST

URL
Метод запиту	GET
URL запиту	/api/oas/retailer/settings?gln=9864119011415&retailer_id=7
URL параметри	gln (обов’язково) String - GLN власної Компанії; retailer_id (обов’язково) long - id мережі
Headers
Authorization	SID - токен, отриманий при авторизації
Content-Type	application/json

RESPONSE

В тілі відповіді в json-форматі передається об’єкт з налаштуваннями мережі.

Отримати дані товарного узгодження

GET /api/es/agreement

REQUEST

URL
Метод запиту	GET
URL запиту	/api/es/agreement?gln=9864xxxxx415&agreement_uuid=11xxxxx6-6473-4c82-9fbe-4d2ba210fafa
URL параметри	gln (обов’язково) String - GLN власної Компанії; agreement_uuid (обов’язково) String - GUID документа (комерційної пропозиції / товарного узгодження)
Headers
Authorization	SID - токен, отриманий при авторизації
Content-Type	application/json

RESPONSE

В тілі відповіді в json-форматі передається об’єкт з інформацією про документ

Створити пропозицію (переузгодження) (для Постачальника)

POST /api/es/agreement

При переузгодженні потрібно створити пропозицію (документ «Товарне узгодження» AGREEM). Один AGREEM може бути пов’язаний лише з одним COMDOC_008, тобто при повторному створенні AGREEM на підставі того ж COMDOC_008 (параметр parent_doc_uuid) буде виникати помилка.

Даний метод може бути використано лише користувачем з роллю «Постачальник».

URL
Метод запиту	POST
URL запиту	/api/es/agreement?gln=9864067620417&sender_id=13200665&recipient_id=41249&retailer_id=7&contract_uuid=ebe77c79-85fc-4c58-a07b-833caac25d65&type=1&doc_date=1588881407&doc_number=1200.996633_128&status_id=1&signperiod=undefined
URL параметри	gln (обов’язково) String - GLN власної Компанії; sender_id (обов’язково) long - id відправника; recipient_id (обов’язково) long - id одержувача; retailer_id (обов’язково) long - id мережі; contract_uuid (обов’язково) UUID - GUID контракту / договору; type (обов’язково) int - тип документа (1-AGREEM, 2-COMDOC_008, 3-NOVELTY); doc_date (обов’язково) long - дата ствоення документа; doc_number (обов’язково) String - номер документа; status_id (обов’язково) int - статус документа (1-чернетка); parent_doc_uuid UUID - GUID документа-підстави (початкового документа); signperiod String - встановлений період підписання
Headers
Authorization	SID - токен, отриманий при авторизації
Content-Type	application/json
REQUEST
JSON Body	В тілі запиту методу передається документ: для type=1 - це Товарне узгодження AGREEM для type=3 - це Комерційна пропозиція NOVELTY

RESPONSE

В тілі відповіді в json-форматі передається GUID створеної пропозиції (вказується в подальших методах):

JSON:

{7a2eee64-f4f0-4388-8023-122d03899a3c}

Редагувати пропозицію (переузгодження) (для Постачальника)

PUT /api/es/agreement

Даний метод виконується лише на стороні Постачальника (роль користувача) для комерційних пропозицій / товарних узгоджень в статусі «Чернетка» (status=1)!

REQUEST

URL
Метод запиту	PUT
URL запиту	/api/es/agreement?gln=9864067620417
URL параметри	gln (обов’язково) String - GLN власної Компанії;
Headers
Authorization	SID - токен, отриманий при авторизації
Content-Type	application/json
REQUEST
JSON Body	В тілі запиту методу передаються `дані ~~<https://wiki.edin.ua/uk/latest/Commercial_offers/API/Methods/EveryBody/PutNoveltyRequest.html>`__,~~ для редагування вказаного документа (поле uuid передається обов'язково).

RESPONSE

Код сервера 200 (ok).

Створити тіло документа (комерційної пропозиції / товарного узгодження) / Додати обгрунтування до пропозиції

POST /api/es/agreement/body

Даний метод може бути використано лише користувачем з роллю «Постачальник». За допомогою цього методу можливо додати обгрунтування, але лише поки пропозиція у статусі «Чернетка».

REQUEST

URL
Метод запиту	POST
URL запиту	/api/es/agreement/body?gln=9864067620417&agreement_uuid=e9xxxxa0-aed2-4cd8-b8ba-c6070ecab278&body_type=2
URL параметри	gln (обов’язково) String - GLN власної Компанії; agreement_uuid UUID - GUID документа (комерційної пропозиції / товарного узгодження) (метод створення документа); body_type (обов’язково) long - тип тіла 1 - тіло Комерційної пропозиції (NOVELTY) 2 - налаштування специфікації мережі (сервіс Е-Специфікація); 3 - вкладення (обгунтування) (сервіс Е-Специфікація); при body_type=3 вказується attacheName String - назва файла-вкладення разом з роширенням; при body_type=3 вказується attacheMime String - тип файлу-вкладення - application/pdf (може бути переданий файл лише в pdf форматі згідно MIME типізації )
Headers
Authorization	SID - токен, отриманий при авторизації
Content-Type	application/json
REQUEST
JSON Body	В тілі запиту методу передаються: при body_type=1 Комерційна пропозиція (NOVELTY) при body_type=2 налаштування специфікації мережі при body_type=3 передається файл в бінарному вигляді

RESPONSE

Код сервера 200 (ok).

Отримати тіло документа (комерційної пропозиції / товарного узгодження)

GET /api/es/agreement/body

REQUEST

URL
Метод запиту	GET
URL запиту	/api/es/agreement/body?gln=9864067620417&agreement_uuid=e9xxxxa0-aed2-4cd8-b8ba-c6070ecab278&body_type=1
URL параметри	gln (обов’язково) String - GLN власної Компанії; agreement_uuid (обов’язково) UUID - GUID пропозиції; body_type (обов’язково) int - тип даних; число (1-AGREEM; 2-налаштування; 3-вкладення);

Headers
Authorization	SID - токен, отриманий при авторизації
Content-Type	application/json

RESPONSE

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

Оновити тіло документа (комерційної пропозиції / товарного узгодження)

PUT /api/es/agreement/body

Користувач з роллю «Постачальник» за допомогою цього методу може замінити файл обгрунтування, але лише поки пропозиція у статусі «Чернетка». Користувач з роллю «Мережа» за допомогою цього методу може оновити тіло пропозиції (наприклад змінити ціни).

REQUEST

URL
Метод запиту	PUT
URL запиту	/api/es/agreement/body?gln=9864067620417&agreement_uuid=e9xxxxa0-aed2-4cd8-b8ba-c6070ecab278&body_type=1
URL параметри	gln (обов’язково) String - GLN власної Компанії; agreement_uuid (обов’язково) UUID - GUID пропозиції; body_type (обов’язково) int - тип даних; число (1-AGREEM; 3-вкладення обгунтування);

Headers
Authorization	SID - токен, отриманий при авторизації
Content-Type	application/json
REQUEST
JSON Body	В тілі запиту методу передаються тіло документа Товарне узгодження (AGREEM) / Комерційна пропозиція (NOVELTY) (json) у вигляді байтмассива

RESPONSE

Код сервера 200 (ok).

Видалити пропозицію

DELETE /api/es/agreement

Даний метод може бути використано лише користувачем з роллю «Постачальник». Видалити документ можливо лише в статусі «Чернетка»(status=1)!

REQUEST

URL
Метод запиту	DELETE
URL запиту	api/es/agreement?gln=9864067620417&agreement_uuid=e9xxxxa0-aed2-4cd8-b8ba-c6070ecab278
URL параметри	gln (обов’язково) String - GLN власної Компанії; agreement_uuid UUID - GUID документа (комерційної пропозиції / товарного узгодження)
Headers
Authorization	SID - токен, отриманий при авторизації
Content-Type	application/json

RESPONSE

Код сервера 200 (ok).

Видалити вкладення (обгрунтування) пропозиції товарного переузгодження

DELETE /api/es/agreement/attachment

Даний метод може бути використано лише користувачем з роллю «Постачальник». Видалити вкладення можливо лише в Пропозиції в статусі «Чернетка».

REQUEST

URL
Метод запиту	DELETE
URL запиту	/api/es/agreement/attachment?gln=9864067620417&agreement_uuid=3aa29cf2-b05f-49b7-b447-e5f4354f1132&attachment_id=612
URL параметри	gln (обов’язково) String - GLN власної Компанії; agreement_uuid (обов’язково) UUID - унікальний ідентифікатор товарного узгодження; attachment_id (опціонально) long - ідентифікатор вкладення; якщо не передається, то видаляються всі вкладення
Headers
Authorization	SID - токен, отриманий при авторизації
Content-Type	application/json

RESPONSE

Код сервера 200 (ok).

Отримати список вкладень до пропозиції товарного переузгодження чи конкретного коментаря документа

GET /api/es/attachment

REQUEST

URL
Метод запиту	GET
URL запиту	/api/es/attachment?gln=9864067620417&agreement_uuid=3aa29cf2-b05f-49b7-b447-e5f4354f1132
URL параметри	gln (обов’язково) String - GLN власної Компанії; agreement_uuid (обов’язково) UUID - унікальний ідентифікатор товарного узгодження; comment_id (опціонально) long - ідентифікатор коментаря з вкладеннями; якщо параметр не передається або передається comment_id=0, то у відповідь повертаються дані вкладень до документа, а не коментаря
Headers
Authorization	SID - токен, отриманий при авторизації
Content-Type	application/json

RESPONSE

В тілі відповіді в json-форматі передається масив об’єктів з інформацією про вкладення.

Отримати контент файлу-вкладення товарного узгодження чи коментаря

GET /api/es/attachment/body

REQUEST

URL
Метод запиту	GET
URL запиту	/api/es/attachment/body?gln=9864067620417&agreement_uuid=3aa29cf2-b05f-49b7-b447-e5f4354f1132&attachment_id=622
URL параметри	gln (обов’язково) String - GLN власної Компанії; agreement_uuid (обов’язково) UUID - унікальний ідентифікатор товарного узгодження; attachment_id (обов’язково) long - ідентифікатор вкладення
Headers
Authorization	SID - токен, отриманий при авторизації
Content-Type	application/octet-stream

RESPONSE

В тілі відповіді передається контент файлу-вкладення в бінарному вигляді.

Додати обгрунтування до пропозиції товарного переузгодження (Постачальник)

POST /api/es/attachment

Даний метод виконується на стороні Постачальника для прискорення погодження. В якості обгрунтування до документу можливо додати максимум 5 файлів розміром кожного не більше 5 МБ в наступних форматах: PDF/JPG/JPEG/PNG/BMP/DOC/DOCX/XLS/XLSX/PPT/PPTX/TXT.

REQUEST

URL
Метод запиту	POST
URL запиту	/api/es/attachment?gln=9864067620417&agreement_uuid=3aa29cf2-b05f-49b7-b447-e5f4354f1132&file_name=1624010092199.png&file_type=image/png
URL параметри	gln (обов’язково) String - GLN власної Компанії; agreement_uuid (обов’язково) UUID - унікальний ідентифікатор товарного узгодження; file_name (обов’язково) String - назва файлу-вкладення; file_type (обов’язково) String - тип файлу згідно MIME типізації
Headers
Authorization	SID - токен, отриманий при авторизації
Content-Type	application/json

RESPONSE

Код сервера 200 (ok).

Робота з пропозиціями

Отримати список документів в журналі

Переглянути налаштування мережі

Отримати дані товарного узгодження

Створити пропозицію (переузгодження) (для Постачальника)

Створити тіло документа (комерційної пропозиції / товарного узгодження) / Додати обгрунтування до пропозиції

Отримати тіло документа (комерційної пропозиції / товарного узгодження)

Оновити тіло документа (комерційної пропозиції / товарного узгодження)

Видалити пропозицію

Видалити вкладення (обгрунтування) пропозиції товарного переузгодження

Отримати список вкладень до пропозиції товарного переузгодження чи конкретного коментаря документа

Отримати контент файлу-вкладення товарного узгодження чи коментаря

Додати обгрунтування до пропозиції товарного переузгодження (Постачальник)

Надіслати пропозицію (переузгодження) (для Постачальника)

Надіслати підписану пропозицію

Отримання інформації про сертифікати підписантів

Клонування товарного узгодження (створення пропозиції)

Пошук «Товарних узгоджень» (AGREEM) з фільтрацією

Формування та отримання Excel-звіту по акціях

Приймання/Відхилення позицій «Товарного узгодження» (Мережа)

Відхилення «Товарного узгодження» (Мережа)

Прийняти «Товарне узгодження» (Мережа)

Відправити підписаний документ «Товарна специфікація» (Мережа)

Отримати XML контента документа «Товарна специфікація» (Мережа)