Робота з пропозиціями
Всі запити нижче перерахованих 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 |
В тілі запиту методу передається документ: |
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 |
В тілі запиту методу передаються дані для редагування вказаного документа (поле **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 - тип тіла
при body_type=3 вказується attacheName String - назва файла-вкладення разом з роширенням; при body_type=3 вказується attacheMime String - тип файлу-вкладення - application/pdf (може бути переданий файл лише в pdf форматі згідно MIME типізації ) |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
|
REQUEST |
|
|
JSON Body |
В тілі запиту методу передаються:
|
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).
Надіслати пропозицію (переузгодження) (для Постачальника)
PATCH /api/es/agreement
При відправці товарного узгодження створюється документ з вкладеннями, що були прикріплені до чернетки.
REQUEST
|
URL |
|
|
Метод запиту |
PATCH |
|
URL запиту |
/api/es/agreement?gln=9864067620417&agreement_uuid=3b5xxx22-effa-449a-af9a-251e8f23b43d&recipient_id=41249 |
|
URL параметри |
gln (обов’язково) String - GLN власної Компанії; agreement_uuid (обов’язково) UUID - GUID документа (комерційної пропозиції / товарного узгодження); recipient_id (обов’язково) int - id отримувача |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
RESPONSE
Код сервера 200 (ok).
Надіслати підписану пропозицію
PATCH /api/es/agreement/comdoc
Даний метод може бути використано лише користувачем з роллю «Мережа». За допомогою цього методу мережа може надіслати підтвердженний та вже підписаний документ. Підписання відбувається лише на web платформі!
REQUEST
|
URL |
|
|
Метод запиту |
PATCH |
|
URL запиту |
/api/es/agreement/comdoc?gln=9864067620417&agreement_uuid=3b5xxx22-effa-449a-af9a-251e8f23b43d&recipient_id=41249 |
|
URL параметри |
gln (обов’язково) String - GLN власної Компанії; agreement_uuid (обов’язково) UUID - GUID пропозиції; recipient_id (обов’язково) int - id отримувача |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
RESPONSE
Код сервера 200 (ok).
Отримання інформації про сертифікати підписантів
GET /api/es/agreement/signers
REQUEST
|
URL |
|
|
Метод запиту |
GET |
|
URL запиту |
/api/es/agreement/signers?gln=9864065160861&agreement_uuid=1e55d353-89ac-4a3b-8419-ed540a534761 |
|
URL параметри |
gln - рядок (13); номер GLN організації, яка пов’язана з авторизованим користувачем платформи EDIN 2.0 на рівні акаунта; АБО guid - рядок; унікальний ідентифікатор організації в системі agreement_uuid - рядок; GUID пропозиції |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
RESPONSE
В тілі відповіді передається інформація про підписантів (масив об’єктів ExEndUserSignInfo).
Клонування товарного узгодження (створення пропозиції)
PUT /api/es/agreement/copy
Даний метод може бути використано лише користувачем з роллю «Постачальник».
REQUEST
|
URL |
|
|
Метод запиту |
PUT |
|
URL запиту |
/api/es/agreement/copy?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 власної Компанії; agreement_uuid (обов’язково) UUID - GUID узгодження для клонування |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
RESPONSE
В тілі відповіді в json-форматі передається GUID створеної пропозиції (вказується в подальших методах):
JSON:
{"uuid":"c1efa050-2633-49f4-9a98-bd9059e20215"}
Пошук «Товарних узгоджень» (AGREEM) з фільтрацією
POST /api/es/agreements/search
REQUEST
|
URL |
|
|
Метод запиту |
POST |
|
URL запиту |
/api/es/agreements/search?gln=9864067620417 |
|
URL параметри |
gln (обов’язково) String - GLN власної Компанії; АБО guid - рядок; унікальний ідентифікатор організації в системі |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
|
REQUEST |
|
|
JSON Body |
В тілі запиту методу передаються критерії пошуку/фільтрації документів. |
RESPONSE
В тілі відповіді в json-форматі передається масив об’єктів з даними по знайденим узгодженням.
Формування та отримання Excel-звіту по акціях
GET /api/es/agreement/excel
REQUEST
|
URL |
|
|
Метод запиту |
GET |
|
URL запиту |
/api/es/agreement/excel?gln=9864067620417&promotion_id=28 |
|
URL параметри |
gln (обов’язково) String - GLN власної Компанії; АБО guid (обов’язково) String - унікальний ідентифікатор власної Компанії; promotion_id (обов’язково) String - ідентифікатор акції |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
RESPONSE
В тілі відповіді передається звіт у вигляді xlsx-файлу.
Приймання/Відхилення позицій «Товарного узгодження» (Мережа)
PATCH /api/v2/es/agreement/positions
Даний метод виконується на стороні Мережі. Метод дозволяє змінити «Дати дії нової ціни» (опціонально).
REQUEST
|
URL |
|
|
Метод запиту |
PATCH |
|
URL запиту |
/api/v2/es/agreement/positions?gln=6549873219876&agreement_uuid=f5efc3ff-eec5-48a1-b1de-877f0f3ad1b5&action=accept |
|
URL параметри |
gln (обов’язково) String - GLN власної Компанії; agreement_uuid (обов’язково) UUID - GUID «Товарного узгодження»; action (обов’язково) String - дія по позиціям (передаються в тілі запиту):
price_start_date (опціонально) Дата (РРРР-ММ-ДД) - дата початку дії нової ціни «Товарного узгодження»; price_end_date (опціонально) Дата (РРРР-ММ-ДД) - дата завершення дії нової ціни «Товарного узгодження» |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
|
REQUEST |
|
|
JSON Body |
В тілі запиту методу в json передається масив об’єктів з ідентифікаторами позиції «Товарного узгодження» (штрихкод+артикул товарної позиції), наприклад:
[
{
"PRODUCT": "PRODUCT_1",
"PRODUCTIDBUYER": "PRODUCTIDBUYER_1"
},
{
"PRODUCT": "PRODUCT_3",
"PRODUCTIDBUYER": "PRODUCTIDBUYER_3"
}
]
|
Якщо тіло запиту буде порожнім, то дія (action) застосовується до всіх позицій «Товарного узгодження»!
RESPONSE
Код сервера 200 (ok).
Відхилення «Товарного узгодження» (Мережа)
PATCH /api/v2/es/agreement/reject
Даний метод виконується на стороні Мережі. При відхиленні документа всі позиції «Товарного узгодження» стають відхиленими автоматично.
REQUEST
|
URL |
|
|
Метод запиту |
PATCH |
|
URL запиту |
/api/v2/es/agreement/reject?gln=6549873219876&agreement_uuid=7f27023e-b954-4d3b-ad9e-f87cac3f35a6 |
|
URL параметри |
gln (обов’язково) String - GLN власної Компанії; agreement_uuid (обов’язково) UUID - GUID «Товарного узгодження» |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
|
REQUEST |
|
|
JSON Body |
В тілі запиту методу (в json форматі) передається причина відхилення «Товарного узгодження» в текстовому вигляді. |
RESPONSE
Код сервера 200 (ok).
Прийняти «Товарне узгодження» (Мережа)
POST /api/v2/es/agreement/comdoc
Даний метод виконується на стороні Мережі для підготовки «Товарного узгодження» до підписання (документ отримує статус «Готовий до підписання»). В результаті роботи методу відбувається формування «Товарної специфікації».
REQUEST
|
URL |
|
|
Метод запиту |
POST |
|
URL запиту |
/api/v2/es/agreement/comdoc?gln=6549873219876&agreement_uuid=8d19fedd-f85f-4e56-9551-5ff7f10d4ad3 |
|
URL параметри |
gln (обов’язково) String - GLN власної Компанії; agreement_uuid (обов’язково) UUID - GUID «Товарного узгодження»; response_type (опціонально) String - формат очікуваної відповіді (формат «Товарної специфікації»); можливі варіанти:
|
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
RESPONSE
В тілі відповіді передається XML контента документа Товарна специфікація (COMDOC_008) в заданому вигляді.
Відправити підписаний документ «Товарна специфікація» (Мережа)
PATCH /api/v2/es/agreement/comdoc
Даний метод виконується на стороні Мережі.
REQUEST
|
URL |
|
|
Метод запиту |
PATCH |
|
URL запиту |
/api/v2/es/agreement/comdoc?gln=6549873219876&agreement_uuid=8d19fedd-f85f-4e56-9551-5ff7f10d4ad3 |
|
URL параметри |
gln (обов’язково) String - GLN власної Компанії; agreement_uuid (обов’язково) UUID - GUID «Товарного узгодження» |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
|
REQUEST |
|
|
JSON Body |
В тілі запиту методу передається підписаний контент (p7s) Товарної специфікації (COMDOC_008) в бінарному вигляді чи в base64. Під час відпрацювання цього методу здійснюється перевіка (порівняння) змісту тіла «Товарної специфікації», що відправляється цим методом з контентом цього документа, що записується в систему під час Приймання «Товарного узгодження» (документ отримує статус «Готовий до підписання»). Якщо документи по структурі не співпадають, то у відповідь Ви отримаєте помилку: «Signed content from p7s does not match generated comdoc» |
RESPONSE
Код сервера 200 (ok).
Отримати XML контента документа «Товарна специфікація» (Мережа)
GET /api/v2/es/agreement/comdoc
Даний метод виконується на стороні Мережі.
REQUEST
|
URL |
|
|
Метод запиту |
GET |
|
URL запиту |
/api/v2/es/agreement/comdoc?gln=6549873219876&agreement_uuid=8d19fedd-f85f-4e56-9551-5ff7f10d4ad3 |
|
URL параметри |
gln (обов’язково) String - GLN власної Компанії; agreement_uuid (обов’язково) UUID - GUID «Товарного узгодження»; response_type (опціонально) String - формат очікуваної відповіді (формат «Товарної специфікації»); можливі варіанти:
|
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
RESPONSE
В тілі відповіді передається XML контента документа Товарна специфікація (COMDOC_008) в заданому вигляді.
Отримати Комерційну пропозицію в xlsx форматі (Excel)
GET /api/es/agreement/offer/excel
REQUEST
|
URL |
|
|
Метод запиту |
GET |
|
URL запиту |
/api/es/agreement/offer/excel?gln=9864066822430&agreement_uuid=2d7d91c6-b769-419d-953d-44ed2966213a |
|
URL параметри |
gln (обов’язково) String - GLN власної Компанії; АБО guid (обов’язково) String - унікальний ідентифікатор власної організації на платформі; agreement_uuid (обов’язково) String - унікальний ідентифікатор Комерційної пропозиції. |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
RESPONSE
В тілі відповіді передається Комерційна пропозиція в xlsx форматі (Excel).
No comments to display
No comments to display