API сервісу Е-Специфікація + Комерційна пропозиція

Перелік методів API сервісу Е-Специфікація+Комерційна пропозиція

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

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

Налаштування рівнів погодження (тільки для Мережі)

Отримати інформацію про всіх користувачів компанії (на рівні акаунта)

 GET /api/oas/account/users

Отримати всі пов’язані GLN користувача в сервісі «Е-Специфікація»

 GET /api/es/user/spec_all_glns

Отримати всі статуси документів, в яких документи доступні користувачу до перегляду

 GET /api/es/user/spec_view_statuses

Отримати всі активні GLN користувача (за якими відображаються категорії товарів)

 GET /api/es/user/spec_view_glns

Отримати налаштування дій узгодження для вказаного користувача в розрізі кожного підтипу документа AGREEM

 GET /api/es/user/spec_status

Вказати нові статуси документів, в яких документи будуть доступні користувачу до перегляду

 POST /api/es/user/spec_view_statuses

Вказати нові активні GLN користувача (за якими відображаються категорії товарів)

 POST /api/es/user/spec_view_glns

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

 POST /api/es/user/spec_status
Робота з контрактами / специфікаціями

Створити нову специфікацію (Мережа)

 POST /api/es/contract

Оновити раніше створену специфікацію (Мережа)

 PUT /api/es/contract

Переглянути усі контракти/специфікації

 GET /api/es/contracts

Переглянути контракт з конкретним контрагентом

 GET /api/es/contract

Видалити контракт/товарні позиції в контракті

 DELETE /api/es/contract/data

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

 POST /api/es/contracts/search
Робота з пропозиціями

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

 GET /api/es/agreements

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

 GET /api/oas/retailer/settings

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

 GET /api/es/agreement

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

 POST /api/es/agreement

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

 PUT /api/es/agreement

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

 POST /api/es/agreement/body

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

 GET /api/es/agreement/body

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

 PUT /api/es/agreement/body

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

 DELETE /api/es/agreement

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

 DELETE /api/es/agreement/attachment

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

 GET /api/es/attachment

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

 GET /api/es/attachment/body

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

 POST /api/es/attachment

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

 PATCH /api/es/agreement

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

 PATCH /api/es/agreement/comdoc

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

 GET /api/es/agreement/signers

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

 PUT /api/es/agreement/copy

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

 POST /api/es/agreements/search

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

 GET /api/es/agreement/excel

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

 PATCH /api/v2/es/agreement/positions

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

 PATCH /api/v2/es/agreement/reject

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

 POST /api/v2/es/agreement/comdoc

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

 PATCH /api/v2/es/agreement/comdoc

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

 GET /api/v2/es/agreement/comdoc

Отримати Комерційну пропозицію в xlsx форматі (Excel)

 GET /api/es/agreement/offer/excel
Робота з коментарями

Створити коментар до пропозиції товарного переузгодження

 POST /api/es/agreement/comment

Переглянути коментарі

 GET /api/es/agreement/comments
Робота зі статусами

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

 PUT /api/es/agreement/status

Оновити внутрішній статус пропозиції

 PUT /api/es/agreement/sub_status
Робота з товарними позиціями Комерційних пропозицій

Додати товарну позицію до чернетки Комерційної пропозиції (Постачальник)

 POST /api/es/position

Отримати дані товарних позицій Комерційної пропозиції

 GET /api/es/position

Отримати дані товарних позицій всіх Комерційних пропозицій за фільтром

 POST /api/es/position/search

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

 PUT /api/es/position

Видалити товарну позицію чернетки Комерційної пропозиції (Постачальник)

 DELETE /api/es/position

Додати зображення до товарної позиції (чернетка Комерційної пропозиції)

 POST /api/es/position/image

Отримати зображення до товарної позиції Комерційної пропозиції

 GET /api/es/position/image

Видалити зображення до товарної позиції (чернетка Комерційної пропозиції)

 DELETE /api/es/position/image
Робота з категоріями / групами

Отримати доступні групи / категорії

 GET /api/products/group

Відредагувати групу / категорію (Мережа)

 PUT /api/products/group

Створити нову групу / категорію (Мережа)

 POST /api/products/group

Видалити групу / категорію (Мережа)

 DELETE /api/products/group
Робота з графіком акцій

Створити нову акцію

 POST /api/es/promotion

Редагувати акцію

 PUT /api/es/promotion

Видалити акцію

 DELETE /api/es/promotion

Отримати список акцій

 GET /api/es/promotion

Створити новий тип акції

 POST /api/es/promotion/type

Редагувати тип акції

 PUT /api/es/promotion/type

Отримати список типів акцій

 GET /api/es/promotion/type

Алгоритми обміну документами (API)

Basic_espec_002.png


Алгоритм «Електронна специфікація» (PRODUCTLIST)

№ кроку

МЕРЕЖА

1.1

Авторизація

1.2

Створення нової специфікації (Мережа)


ПОСТАЧАЛЬНИК

2.1

Авторизація

2.2

Перегляд усіх Cпецифікацій / Переглянути Специфікацію з конкретним контрагентом

Додаткові методи API

Алгоритм «Товарне узгодження» (AGREEM)

AGREEM_API_work_001.png

 

№ кроку

ПОСТАЧАЛЬНИК

1.1

Авторизація

1.2

Перегляд усіх Cпецифікацій / Переглянути Специфікацію з конкретним контрагентом

1.3

Створення пропозиції (переузгодження) на підставі отриманої Специфікації


МЕРЕЖА

2.1

Авторизація

2.2

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

2.3

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

2.4

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

2.4*

Відхилення «Товарного узгодження» (Мережа)
Додаткові методи API
Алгоритм «Товарна специфікація» (COMDOC_008)

№ кроку

МЕРЕЖА

1.1

Авторизація

1.2

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

1.3

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

№ кроку

ПОСТАЧАЛЬНИК

2.1

Авторизація

2.2

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

2.3

Підписання вхідного документа

[*] - Після погодження (обоюдного підписання) «Товарної специфікації» (COMDOC_008) реалізована автоматична відправка документа «Електронна специфікація» (PRODUCTLIST) з урахуванням усіх погоджених змін. Мережа при цьому отримує документ через FTP сервіс EDIN. Перегляд усіх Cпецифікацій / Переглянути Специфікацію з конкретним контрагентом.


Помилки при роботі з API

Загальні помилки при роботі з API (для всіх сервісів EDIN) можна подивитись за посиланням.

Отримати список типів акцій GET /api/es/promotion/type

REQUEST

URL

  

Метод запиту

GET

URL запиту

/api/es/promotion/type

URL параметри

gln (обов’язково) String - GLN власної Компанії;

retailer_id - id Мережі на платформі EDIN. Якщо користувач має роль Постачальник, цей параметр є обов'язковим.

Headers

  

Authorization

SID - токен, отриманий при авторизації

Content-Type

application/json

RESPONSE

У відповідь приходить масив об'єктів XPromotionType.

Редагувати тип акції PUT /api/es/promotion/type

REQUEST

URL

  

Метод запиту

PUT

URL запиту

/api/es/promotion/type

URL параметри

gln (обов’язково) String - GLN власної Компанії;

retailer_id - id Мережі на платформі EDIN. Якщо користувач має роль Постачальник, цей параметр є обов'язковим.

Headers

  

Authorization

SID - токен, отриманий при авторизації

Content-Type

application/json

REQUEST

  

JSON Body

В тілі запиту методу передаються параметри типу акції у JSON форматі (об'єкт XPromotionType).

 

Приклад запиту:

 

{
  "type_id": 123
  "retailer_id": 13,
  "type": "Новіший тип акції"
}

RESPONSE

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

Створити новий тип акції POST /api/es/promotion/type

REQUEST

URL

  

Метод запиту

POST

URL запиту

/api/es/promotion/type

URL параметри

gln (обов’язково) String - GLN власної Компанії;

retailer_id - id Мережі на платформі EDIN. Якщо користувач має роль Постачальник, цей параметр є обов'язковим.

Headers

  

Authorization

SID - токен, отриманий при авторизації

Content-Type

application/json

REQUEST

  

JSON Body

В тілі запиту методу передаються параметри типу акції у JSON форматі (об'єкт XPromotionType).

 

Приклад запиту:

 

{
  "retailer_id": 12,
  "type": "Новий тип акції"
}

RESPONSE

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

Отримати список акцій GET /api/es/promotion

REQUEST

URL

  

Метод запиту

GET

URL запиту

/api/es/promotion

URL параметри

gln (обов’язково) String - GLN власної Компанії;

retailer_id - id Мережі на платформі EDIN. Якщо користувач має роль Постачальник, цей параметр є обов'язковим.

Headers

  

Authorization

SID - токен, отриманий при авторизації

Content-Type

application/json

RESPONSE

У відповідь приходить масив об'єктів XPromotion.

Видалити акцію DELETE /api/es/promotion

REQUEST

URL

  

Метод запиту

DELETE

URL запиту

/api/es/promotion

URL параметри

gln (обов’язково) String - GLN власної Компанії;

promotion_id (обов'язково) - id акції.

Headers

  

Authorization

SID - токен, отриманий при авторизації

Content-Type

application/json

RESPONSE

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

Редагувати акцію PUT /api/es/promotion

REQUEST

URL

  

Метод запиту

PUT

URL запиту

/api/es/promotion

URL параметри

gln (обов’язково) String - GLN власної Компанії;

Headers

  

Authorization

SID - токен, отриманий при авторизації

Content-Type

application/json

REQUEST

  

JSON Body

В тілі запиту методу передаються параметри акції у JSON форматі (об'єкт XPromotion). При цьому передача ключа id є обов'язковою.

 

Приклад запиту:

 

    {
        "id": 2,
        "code": "02",
        "name": "тижнева",
        "type_id": 2,
        "date_from": 1726386323,
        "date_to": 1764598960,
        "date_end": 1764598960,
        "date_changed": 0,
        "date_notification": 1751379760,
        "state": 1,
        "type": {
            "type_id": 2,
            "retailer_id": 7,
            "gln_id": 0
        },
        "access": []
    }

RESPONSE

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

Створити нову акцію POST /api/es/promotion

REQUEST

URL

  

Метод запиту

POST

URL запиту

/api/es/promotion

URL параметри

gln (обов’язково) String - GLN власної Компанії;

Headers

  

Authorization

SID - токен, отриманий при авторизації

Content-Type

application/json

REQUEST

  

JSON Body

В тілі запиту методу передаються параметри акції у JSON форматі (об'єкт XPromotion).

 

Приклад запиту:

 

{
      "code": "07",
      "name": "Акція року_2025",
      "type_id": 1,
      "date_from": 1726386323,
      "date_to": 1733903123,
      "date_end": 1733903123,
      "date_notification": 1751354560
    }

RESPONSE

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

Видалити групу / категорію (Мережа) DELETE /api/products/group

Даний метод може бути використано лише користувачем на стороні Мережі.

REQUEST

URL

  

Метод запиту

DELETE

URL запиту

/api/products/group

URL параметри

gln (обов’язково) String - GLN власної Компанії;

group_id (обов’язково) long - ідентифікатор групи/категорії для видалення

Headers

  

Authorization

SID - токен, отриманий при авторизації

Content-Type

application/json

RESPONSE

Response is empty

Створити нову групу / категорію (Мережа) POST /api/products/group

Даний метод може бути використано лише користувачем на стороні Мережі.

REQUEST

URL

  

Метод запиту

POST

URL запиту

/api/products/group

URL параметри

gln (обов’язково) String - GLN власної Компанії;

group_name (обов’язково) String - назва нової групи / категорії;

parrent_group_id (опціонально) long - ідентифікатор вищого рівня в структурі (групи/категорії); За відсутності=0

Headers

  

Authorization

SID - токен, отриманий при авторизації

Content-Type

application/json

RESPONSE

В тілі відповіді передається ідентифікатор створеної групи/категорії (groupd_id):

{"id":230}

 

Відредагувати групу / категорію (Мережа) PUT /api/products/group

Даний метод може бути використано лише користувачем на стороні Мережі.

REQUEST

URL

  

Метод запиту

PUT

URL запиту

/api/products/group

URL параметри

gln (обов’язково) String - GLN власної Компанії;

group_name (обов’язково) String - назва нової групи / категорії;

group_id (обов’язково) long - ідентифікатор групи/категорії, що буде відредагована;

parrent_group_id (опціонально) long - ідентифікатор вищого рівня в структурі (групи/категорії); За відсутності=0

Headers

  

Authorization

SID - токен, отриманий при авторизації

Content-Type

application/json

RESPONSE

Response is empty

Отримати доступні групи / категорії GET /api/products/group

REQUEST

URL

  

Метод запиту

GET

URL запиту

/api/products/group

URL параметри

gln (обов’язково) String - GLN власної Компанії (для мережі обидва параметра мають однакове значення);

shard_gln (обов’язково) String - GLN мережі;

group_id (опціонально) long - ідентифікатор групи/категорії

Headers

  

Authorization

SID - токен, отриманий при авторизації

Content-Type

application/json

RESPONSE

В тілі відповіді у вигляді масиву об’єктів передаються групи/категорії товарів.

Видалити зображення до товарної позиції (чернетка Комерційної пропозиції) DELETE /api/es/position/image

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

REQUEST

URL

  

Метод запиту

DELETE

URL запиту

/api/es/position/image

URL параметри

gln (обов’язково) String - GLN власної Компанії;

position_id (обов’язково) String - ідентифікатор товарної позиції;

image_type (обов’язково) String - тип зображення:

  • icon - маленький логотип

  • logo - великий логотип (оригінальний розмір)

Headers

  

Authorization

SID - токен, отриманий при авторизації

Content-Type

application/json

RESPONSE

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

Отримати зображення до товарної позиції Комерційної пропозиції GET /api/es/position/image

REQUEST

URL

  

Метод запиту

GET

URL запиту

/api/es/position/image

URL параметри

gln (обов’язково) String - GLN власної Компанії;

position_id (обов’язково) String - ідентифікатор товарної позиції;

image_type (обов’язково) String - тип зображення:

  • icon - маленький логотип

  • logo - великий логотип (оригінальний розмір)

Headers

  

Authorization

SID - токен, отриманий при авторизації

Content-Type

application/json

RESPONSE

В тілі відповіді в текстовому вигляді передається посилання на зображення:

https://static.edin.ua/agreement/positions/eds_ua_158182/logo/24523c0a-ea3e-4239-b15b-0a027cb991e2.jpg

 

Додати зображення до товарної позиції (чернетка Комерційної пропозиції) POST /api/es/position/image

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

REQUEST

URL

  

Метод запиту

POST

URL запиту

/api/es/position/image

URL параметри

gln (обов’язково) String - GLN власної Компанії;

position_id (обов’язково) String - ідентифікатор товарної позиції;

image_type (обов’язково) String - тип зображення:

  • icon - маленький логотип

  • logo - великий логотип (оригінальний розмір)

mime_type (обов’язково) String - згідно MIME типізації може бути переданий image/png або image/jpeg для відповідного формату зображення

Headers

  

Authorization

SID - токен, отриманий при авторизації

Content-Type

application/json

REQUEST

  

JSON Body

В тілі запиту методу передається файл (зображення) в вигляді набору байтів

RESPONSE

В тілі відповіді в текстовому вигляді передається посилання на збережене зображення:

https://static.edin.ua/agreement/positions/eds_ua_158182/logo/24523c0a-ea3e-4239-b15b-0a027cb991e2.jpg

 

Видалити товарну позицію чернетки Комерційної пропозиції (Постачальник) DELETE /api/es/position

REQUEST

URL

  

Метод запиту

DELETE

URL запиту

/api/es/position

URL параметри

gln (обов’язково) String - GLN власної Компанії;

agreement_uuid (обов’язково) String - унікальний ідентифікатор Комерційної пропозиції;

position_id (обов’язково) String - ідентифікатор товарної позиції

Headers

  

Authorization

SID - токен, отриманий при авторизації

Content-Type

application/json

RESPONSE

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

Редагувати товарну позицію чернетки Комерційної пропозиції (Постачальник) PUT /api/es/position

REQUEST

URL

  

Метод запиту

PUT

URL запиту

/api/es/position

URL параметри

gln (обов’язково) String - GLN власної Компанії;

agreement_uuid (обов’язково) String - унікальний ідентифікатор Комерційної пропозиції

Headers

  

Authorization

SID - токен, отриманий при авторизації

Content-Type

application/json

REQUEST

  

JSON Body

В тілі запиту методу передаються дані позиції Комерційної пропозиції (об’єкт XAgreemDocPosition).

RESPONSE

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

Отримати дані товарних позицій всіх Комерційних пропозицій за фільтром POST /api/es/position/search

REQUEST

URL

  

Метод запиту

POST

URL запиту

/api/es/position/search

URL параметри

gln (обов’язково) String - GLN власної Компанії; АБО guid (обов’язково) String - унікальний ідентифікатор власної організації на платформі

Headers

  

Authorization

SID - токен, отриманий при авторизації

Content-Type

application/json

REQUEST

  

JSON Body

В тілі запиту методу передається набір фільтрів для відбору позицій Комерційних пропозицій (об’єкт XSearchPositionsQuery).

RESPONSE

В тілі відповіді передаються дані відібраних товарних позицій всіх Комерційних пропозиції: масив об’єктів XAgreemDocPosition.

Отримати дані товарних позицій Комерційної пропозиції GET /api/es/position

REQUEST

URL

  

Метод запиту

GET

URL запиту

/api/es/position

URL параметри

gln (обов’язково) String - GLN власної Компанії;

agreement_uuid (обов’язково) String - унікальний ідентифікатор Комерційної пропозиції;

position_id (опціонально) String - ідентифікатор товарної позиції

Headers

  

Authorization

SID - токен, отриманий при авторизації

Content-Type

application/json

RESPONSE

В тілі відповіді передаються дані всіх товарних позицій Комерційної пропозиції або конкретної товарної позиції (якщо передавати position_id) - масив об’єктів XAgreemDocPosition.

Додати товарну позицію до чернетки Комерційної пропозиції (Постачальник) POST /api/es/position

REQUEST

URL

  

Метод запиту

POST

URL запиту

/api/es/position

URL параметри

gln (обов’язково) String - GLN власної Компанії;

agreement_uuid (обов’язково) String - унікальний ідентифікатор Комерційної пропозиції

Headers

  

Authorization

SID - токен, отриманий при авторизації

Content-Type

application/json

REQUEST

  

JSON Body

В тілі запиту методу передаються дані позицій Комерційної пропозиції (масив об’єктів XAgreemDocPosition).

RESPONSE

В тілі відповіді передаються дані доданих запитом товарних позицій Комерційної пропозиції: масив об’єктів XAgreemDocPosition.

Оновити внутрішній статус пропозиції PUT /api/es/agreement/sub_status

За допомогою цього методу оновлюється статус пропозиції лише у мережі.

REQUEST

URL

  

Метод запиту

PUT

URL запиту

/api/es/agreement/sub_status

URL параметри

doc_uuid (обов’язково) UUID - GUID пропозиції;

status_id (обов’язково) int - id статусу

Headers

  

Authorization

SID - токен, отриманий при авторизації

Content-Type

application/json

RESPONSE

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

Оновити статус документа (комерційної пропозиції / товарного узгодження) PUT /api/es/agreement/status

За допомогою цього методу оновлюється статус пропозиції у обох контрагентів.

REQUEST

URL

  

Метод запиту

PUT

URL запиту

/api/es/agreement/status

URL параметри

gln (обов’язково) String - GLN власної Компанії;

doc_uuid (обов’язково) UUID - GUID документа (комерційної пропозиції / товарного узгодження)

sender_id (обов’язково) int - id отримувача

recipient_id (обов’язково) int - id отримувача

status_id (обов’язково) int - id статусу документа (комерційної пропозиції / товарного узгодження):

Для Товарного узгодження (AGREEM):

  • 1 - Чернетка (на стороні постачальника)

  • 2 - Відправлено (на стороні постачальника)

  • 3 - На узгодженні (на стороні постачальника)

  • 4 - Відхилено (на стороні постачальника)

  • 5 - Підписання постачальником (на стороні постачальника)

  • 6 - 2 підписання постачальником (на стороні постачальника)

  • 7 - Завершено (на стороні постачальника)

  • 11 - Відхилено (на стороні мережі)

  • 12 - На узгодженні (на стороні мережі)

  • 13 - Підготовлено (на стороні мережі)

  • 14 - Готовий до підписання (на стороні мережі)

  • 15 - Погоджено (на стороні мережі)

  • 16 - Підписано (на стороні мережі)

  • 17 - Перевірено (на стороні мережі)

  • 18 - Підтверджено (на стороні мережі)

  • 19 - Підписання постачальником (на стороні мережі)

  • 20 - Підписання мережею (на стороні мережі)

Для Комерційної пропозиції (NOVELTY):

  • 1 - Чернетка (на стороні постачальника)

  • 3 - На узгодженні (на стороні постачальника)

  • 4 - Відхилено

  • 8 - Прийнято

  • 21 - На узгодженні перший етап (на стороні мережі)

  • 22 - На узгодженні другий етап (на стороні мережі)

  • 23 - На узгодженні третій етап (на стороні мережі)

  • 24 - На узгодженні четвертий етап (на стороні мережі)

  • 25 - На узгодженні п’ятий етап етап (на стороні мережі)

  • 26 - На узгодженні фінальний етап (на стороні мережі)

Headers

  

Authorization

SID - токен, отриманий при авторизації

Content-Type

application/json

REQUEST

  

JSON Body

В тілі запиту методу при відхиленні (AGREEM / NOVELTY: status_id=4) чи прийманні (NOVELTY: status_id=8) передається тіло відповідного документа, що містить коментар:

RESPONSE

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

Переглянути коментарі GET /api/es/agreement/comments

REQUEST

URL

  

Метод запиту

GET

URL запиту

/api/es/agreement/comments

URL параметри

gln (обов’язково) String - GLN власної Компанії;

agreement_uuid UUID - GUID пропозиції;

Headers

  

Authorization

SID - токен, отриманий при авторизації

Content-Type

application/json

RESPONSE

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

Створити коментар до пропозиції товарного переузгодження POST /api/es/agreement/comment

REQUEST

URL

  

Метод запиту

POST

URL запиту

/api/es/agreement/comment

URL параметри

gln (обов’язково) String - GLN власної Компанії;

uuid (обов’язково) UUID - унікальний ідентифікатор товарного узгодження;

comment (обов’язково) String - текст коментаря; forAll (опціонально і лише для Мережі) Boolean:

  • true - зробити коментар та вкладення приватними (буде відображатись лише на стороні Мережі);

  • false (за замовчуванням) - коментар та вкладення будуть відображатись на стороні обох контрагентів.

Headers

  

Authorization

SID - токен, отриманий при авторизації

Content-Type

multipart/form-data

REQUEST

  

Form-data

В тілі запиту можуть передаватись файли-вкладення в інтерфейсі form-data (приклад запиту)

RESPONSE

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

Отримати Комерційну пропозицію в xlsx форматі (Excel) GET /api/es/agreement/offer/excel

REQUEST

URL

  

Метод запиту

GET

URL запиту

/api/es/agreement/offer/excel

URL параметри

gln (обов’язково) String - GLN власної Компанії; АБО guid (обов’язково) String - унікальний ідентифікатор власної організації на платформі;

agreement_uuid (обов’язково) String - унікальний ідентифікатор Комерційної пропозиції.

Headers

  

Authorization

SID - токен, отриманий при авторизації

Content-Type

application/json

RESPONSE

В тілі відповіді передається Комерційна пропозиція в xlsx форматі (Excel).

Отримати XML контента документа «Товарна специфікація» (Мережа) GET /api/v2/es/agreement/comdoc

Даний метод виконується на стороні Мережі.

REQUEST

URL

  

Метод запиту

GET

URL запиту

/api/v2/es/agreement/comdoc

URL параметри

gln (обов’язково) String - GLN власної Компанії;

agreement_uuid (обов’язково) UUID - GUID «Товарного узгодження»;

response_type (опціонально) String - формат очікуваної відповіді (формат «Товарної специфікації»); можливі варіанти:

  • bytes (за замовчуванням) - набір байт XML

  • base64 - XML в base64

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

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).

Прийняти «Товарне узгодження» (Мережа) POST /api/v2/es/agreement/comdoc

Даний метод виконується на стороні Мережі для підготовки «Товарного узгодження» до підписання (документ отримує статус «Готовий до підписання»). В результаті роботи методу відбувається формування «Товарної специфікації».

REQUEST

URL

  

Метод запиту

POST

URL запиту

/api/v2/es/agreement/comdoc

URL параметри

gln (обов’язково) String - GLN власної Компанії;

agreement_uuid (обов’язково) UUID - GUID «Товарного узгодження»;

response_type (опціонально) String - формат очікуваної відповіді (формат «Товарної специфікації»); можливі варіанти:

  • bytes (за замовчуванням) - набір байт XML

  • base64 - XML в base64

Headers

  

Authorization

SID - токен, отриманий при авторизації

Content-Type

application/json

RESPONSE

В тілі відповіді передається XML контента документа Товарна специфікація (COMDOC_008) в заданому вигляді.

Відхилити «Товарне узгодження» (Мережа) PATCH /api/v2/es/agreement/reject

Даний метод виконується на стороні Мережі. При відхиленні документа всі позиції «Товарного узгодження» стають відхиленими автоматично.

REQUEST

URL

  

Метод запиту

PATCH

URL запиту

/api/v2/es/agreement/reject

URL параметри

gln (обов’язково) String - GLN власної Компанії;

agreement_uuid (обов’язково) UUID - GUID «Товарного узгодження»

Headers

  

Authorization

SID - токен, отриманий при авторизації

Content-Type

application/json

REQUEST

  

JSON Body

В тілі запиту методу (в json форматі) передається причина відхилення «Товарного узгодження» в текстовому вигляді.

RESPONSE

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

Прийняти/Відхилити позиції «Товарного узгодження» (Мережа) PATCH /api/v2/es/agreement/positions

Даний метод виконується на стороні Мережі. Метод дозволяє змінити «Дати дії нової ціни» (опціонально).

REQUEST

URL

  

Метод запиту

PATCH

URL запиту

/api/v2/es/agreement/positions

URL параметри

gln (обов’язково) String - GLN власної Компанії;

agreement_uuid (обов’язково) UUID - GUID «Товарного узгодження»;

action (обов’язково) String - дія по позиціям (передаються в тілі запиту):

  • accept - відповідні позиції встановлюються, як «Прийняті»

  • reject - відповідні позиції встановлюються, як «Відхилені»;

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).

Формування та отримання Excel-звіту по акціях GET /api/es/agreement/excel

REQUEST

URL

  

Метод запиту

GET

URL запиту

/api/es/agreement/excel

URL параметри

gln (обов’язково) String - GLN власної Компанії; АБО guid (обов’язково) String - унікальний ідентифікатор власної Компанії;

promotion_id (обов’язково) String - ідентифікатор акції

Headers

  

Authorization

SID - токен, отриманий при авторизації

Content-Type

application/json

RESPONSE

В тілі відповіді передається звіт у вигляді xlsx-файлу.

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

REQUEST

URL

  

Метод запиту

POST

URL запиту

/api/es/agreements/search

URL параметри

gln (обов’язково) String - GLN власної Компанії; АБО guid - рядок; унікальний ідентифікатор організації в системі

Headers

  

Authorization

SID - токен, отриманий при авторизації

Content-Type

application/json

REQUEST

  

JSON Body

В тілі запиту методу передаються критерії пошуку/фільтрації документів.

RESPONSE

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

Клонувати товарне узгодження (створення пропозиції) PUT /api/es/agreement/copy

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

REQUEST

URL

  

Метод запиту

PUT

URL запиту

/api/es/agreement/copy

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"}

 

Отримання інформації про сертифікати підписантів GET /api/es/agreement/signers

REQUEST

URL

  

Метод запиту

GET

URL запиту

/api/es/agreement/signers

URL параметри

gln - рядок (13); номер GLN організації, яка пов’язана з авторизованим користувачем платформи EDIN 2.0 на рівні акаунта; АБО guid - рядок; унікальний ідентифікатор організації в системі

agreement_uuid - рядок; GUID пропозиції

Headers

  

Authorization

SID - токен, отриманий при авторизації

Content-Type

application/json

RESPONSE

В тілі відповіді передається інформація про підписантів (масив об’єктів ExEndUserSignInfo).

Надіслати підписану пропозицію PATCH /api/es/agreement/comdoc

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

REQUEST

URL

  

Метод запиту

PATCH

URL запиту

/api/es/agreement/comdoc

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

При відправці товарного узгодження створюється документ з вкладеннями, що були прикріплені до чернетки.

REQUEST

URL

  

Метод запиту

PATCH

URL запиту

/api/es/agreement

URL параметри

gln (обов’язково) String - GLN власної Компанії;

agreement_uuid (обов’язково) UUID - GUID документа (комерційної пропозиції / товарного узгодження);

recipient_id (обов’язково) int - id отримувача

Headers

  

Authorization

SID - токен, отриманий при авторизації

Content-Type

application/json

RESPONSE

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

Додати обгрунтування до пропозиції товарного переузгодження (Постачальник) 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

URL параметри

gln (обов’язково) String - GLN власної Компанії;

agreement_uuid (обов’язково) UUID - унікальний ідентифікатор товарного узгодження;

file_name (обов’язково) String - назва файлу-вкладення;

file_type (обов’язково) String - тип файлу згідно MIME типізації

Headers

  

Authorization

SID - токен, отриманий при авторизації

Content-Type

application/json

RESPONSE

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

Отримати контент файлу-вкладення товарного узгодження чи коментаря GET /api/es/attachment/body

REQUEST

URL

  

Метод запиту

GET

URL запиту

/api/es/attachment/body

URL параметри

gln (обов’язково) String - GLN власної Компанії;

agreement_uuid (обов’язково) UUID - унікальний ідентифікатор товарного узгодження;

attachment_id (обов’язково) long - ідентифікатор вкладення

Headers

  

Authorization

SID - токен, отриманий при авторизації

Content-Type

application/octet-stream

RESPONSE

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

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

REQUEST

URL

  

Метод запиту

GET

URL запиту

/api/es/attachment

URL параметри

gln (обов’язково) String - GLN власної Компанії;

agreement_uuid (обов’язково) UUID - унікальний ідентифікатор товарного узгодження;

comment_id (опціонально) long - ідентифікатор коментаря з вкладеннями; якщо параметр не передається або передається comment_id=0, то у відповідь повертаються дані вкладень до документа, а не коментаря

Headers

  

Authorization

SID - токен, отриманий при авторизації

Content-Type

application/json

RESPONSE

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

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

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

REQUEST

URL

  

Метод запиту

DELETE

URL запиту

/api/es/agreement/attachment

URL параметри

gln (обов’язково) String - GLN власної Компанії;

agreement_uuid (обов’язково) UUID - унікальний ідентифікатор товарного узгодження;

attachment_id (опціонально) long - ідентифікатор вкладення; якщо не передається, то видаляються всі вкладення

Headers

  

Authorization

SID - токен, отриманий при авторизації

Content-Type

application/json

RESPONSE

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

Видалити пропозицію DELETE /api/es/agreement

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

REQUEST

URL

  

Метод запиту

DELETE

URL запиту

api/es/agreement

URL параметри

gln (обов’язково) String - GLN власної Компанії;

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

Headers

  

Authorization

SID - токен, отриманий при авторизації

Content-Type

application/json

RESPONSE

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

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

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

REQUEST

URL

  

Метод запиту

PUT

URL запиту

/api/es/agreement/body

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).

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

REQUEST

URL

  

Метод запиту

GET

URL запиту

/api/es/agreement/body

URL параметри

gln (обов’язково) String - GLN власної Компанії;

agreement_uuid (обов’язково) UUID - GUID пропозиції;

body_type (обов’язково) int - тип даних; число (1-AGREEM; 2-налаштування; 3-вкладення);
   

Headers

  

Authorization

SID - токен, отриманий при авторизації

Content-Type

application/json

RESPONSE

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

Створити тіло документа (комерційної пропозиції / товарного узгодження) / Додати обгрунтування до пропозиції 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

В тілі запиту методу передаються:

RESPONSE

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

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

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

REQUEST

URL

  

Метод запиту

PUT

URL запиту

/api/es/agreement

URL параметри

gln (обов’язково) String - GLN власної Компанії;

Headers

  

Authorization

SID - токен, отриманий при авторизації

Content-Type

application/json

REQUEST

  

JSON Body

В тілі запиту методу передаються дані  для редагування вказаного документа (поле **uuid** передається обов'язково).

RESPONSE

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

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

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

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

URL

  

Метод запиту

POST

URL запиту

/api/es/agreement

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}

 

Отримати дані пропозиції (товарного узгодження) GET /api/es/agreement

REQUEST

URL

  

Метод запиту

GET

URL запиту

/api/es/agreement

URL параметри

gln (обов’язково) String - GLN власної Компанії;

agreement_uuid (обов’язково) String - GUID документа (комерційної пропозиції / товарного узгодження)

Headers

  

Authorization

SID - токен, отриманий при авторизації

Content-Type

application/json

RESPONSE

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

Переглянути налаштування мережі GET /api/oas/retailer/settings

REQUEST

URL

  

Метод запиту

GET

URL запиту

/api/oas/retailer/settings

URL параметри

gln (обов’язково) String - GLN власної Компанії;

retailer_id (обов’язково) long - id мережі

Headers

  

Authorization

SID - токен, отриманий при авторизації

Content-Type

application/json

RESPONSE

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

Отримати список документів в журналі GET /api/es/agreements

REQUEST

URL

  

Метод запиту

GET

URL запиту

/api/es/agreements

URL параметри

gln (обов’язково) String - GLN власної Компанії АБО guid (обов’язково) String - унікальний ідентифікатор власної організації на платформі;

limit (опціонально) int - ліміт вибірки (за замовчуванням=20);

offset (опціонально) int - зміщення відносно верхньої межі вибірки (за замовчуванням=0)

Headers

  

Authorization

SID - токен, отриманий при авторизації

Content-Type

application/json

RESPONSE

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

Пошук контрактів/специфікацій (з фільтрацією) POST /api/es/contracts/search

REQUEST

URL

  

Метод запиту

POST

URL запиту

/api/es/contracts/search

URL параметри

gln (обов’язково) String - GLN власної Компанії; АБО guid - рядок; унікальний ідентифікатор організації в системі

Headers

  

Authorization

SID - токен, отриманий при авторизації

Content-Type

application/json

REQUEST

  

JSON Body

В тілі запиту методу передаються критерії пошуку/фільтрації.

RESPONSE

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

Видалити контракт/товарні позиції в контракті DELETE /api/es/contract/data

Для видалення всього контракту разом з усіма його позиціями тіло запиту передавати не потрібно. Для видалення конкретних позицій з контракту в тілі запиту потрібно передавати об’єкт зі списком id позицій з конкретного контракту.

Наприклад:

{
    "productID": [
        0,
        21212121,
        113
    ]
}

Щоб отримати інформацію по контракту з товарними позиціями, можна скористатись методом за посиланням.

REQUEST

URL

  

Метод запиту

DELETE

URL запиту

/api/es/contract/data

URL параметри

gln (обов’язково) String - GLN власної Компанії;

contract_uuid (обов’язково) UUID - GUID контракту

Headers

  

Authorization

SID - токен, отриманий при авторизації

Content-Type

application/json

REQUEST

  

JSON Body

В тілі запиту методу може передаватись об’єкт з масивом productID, що містить список id позицій вказаного контракту (видалення позицій). Для видалення контракту тіло запиту не передається.

RESPONSE

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

Переглянути контракт з конкретним контрагентом GET /api/es/contract

REQUEST

URL

  

Метод запиту

GET

URL запиту

/api/es/contract

URL параметри

gln (обов’язково) String - GLN власної Компанії;

contract_uuid (обов’язково) String - GUID контракту / договору

Headers

  

Authorization

SID - токен, отриманий при авторизації

Content-Type

application/json

RESPONSE

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

Переглянути усі контракти/специфікації GET /api/es/contracts

REQUEST

URL

  

Метод запиту

GET

URL запиту

/api/es/contracts

URL параметри

gln (обов’язково) String - GLN власної Компанії;

expireFrom (опціонально) unix timestamp - завершення терміну дії контракту/специфікації «Від»;

expireTo (опціонально) unix timestamp - завершення терміну дії контракту/специфікації «До»

Headers

  

Authorization

SID - токен, отриманий при авторизації

Content-Type

application/json

Приклади формування запиту:

RESPONSE

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

Оновити раніше створенуї специфікацію (Мережа) PUT /api/es/contract

Даний метод виконується на стороні Мережі.

REQUEST

URL

  

Метод запиту

PUT

URL запиту

/api/es/contract

URL параметри

gln (обов’язково) String - GLN власної Компанії (Мережі);

contract_uuid (обов’язково) UUID - GUID контракту / договору

Headers

  

Authorization

SID - токен, отриманий при авторизації

Content-Type

application/json or application/xml

REQUEST

  

JSON Body

В тілі запиту методу передається тіло документа Електронна специфікація (PRODUCTLIST) в json чи xml форматі відповідно до значення Content-Type

RESPONSE

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

Створити нову специфікацію (Мережа) POST /api/es/contract

REQUEST

URL

  

Метод запиту

POST

URL запиту

/api/es/contract

URL параметри

gln (обов’язково) String - GLN власної Компанії (Мережі)

Headers

  

Authorization

SID - токен, отриманий при авторизації

Content-Type

application/json or application/xml

REQUEST

  

JSON Body

В тілі запиту методу передається тіло документа Електронна специфікація (PRODUCTLIST) в json чи xml форматі відповідно до значення Content-Type

RESPONSE

В тілі відповіді передається ідентифікатор контракту нової специфікації:

{"contract_uuid": "1a06eda0-2b5f-4fbc-a6d4-3a96d4353da6"}

 

Вказати нові дії узгодження для вказаного користувача в розрізі кожного підтипу документа AGREEM POST /api/es/user/spec_status

REQUEST

URL

  

Метод запиту

POST

URL запиту

/api/es/user/spec_status

URL параметри

gln (обов’язково) String - GLN власної Компанії АБО guid (обов’язково) String - унікальний ідентифікатор власної організації на платформі

user_id (обов’язково) long - ідентифікатор користувача

Headers

  

Authorization

SID - токен, отриманий при авторизації

Content-Type

application/json

REQUEST

  

JSON Body

В тілі запиту методу передаються нові налаштування дій узгодження для вказаного користувача в розрізі кожного підтипу документа AGREEM (об’єкт SpecStatus).

RESPONSE

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

Вказати нові активні GLN користувача (за якими відображаються категорії товарів) POST /api/es/user/spec_view_glns

REQUEST

URL

  

Метод запиту

POST

URL запиту

/api/es/user/spec_view_glns

URL параметри

gln (обов’язково) String - GLN власної Компанії АБО guid (обов’язково) String - унікальний ідентифікатор власної організації на платформі

user_id (обов’язково) long - ідентифікатор користувача

Headers

  

Authorization

SID - токен, отриманий при авторизації

Content-Type

application/json

REQUEST

  

JSON Body

В тілі запиту методу передаються пов’язані з користувачем номера GLN, що мають бути активні (за якими будуть відображатись категорії товарів в сервісі Е-Специфікація), наприклад: ['9864232377986','9864232377993','9864232378006']

RESPONSE

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

Вказати нові статуси документів, в яких документи будуть доступні користувачу до перегляду POST /api/es/user/spec_view_statuses

REQUEST

URL

  

Метод запиту

POST

URL запиту

/api/es/user/spec_view_statuses

URL параметри

gln (обов’язково) String - GLN власної Компанії АБО guid (обов’язково) String - унікальний ідентифікатор власної організації на платформі

user_id (обов’язково) long - ідентифікатор користувача

Headers

  

Authorization

SID - токен, отриманий при авторизації

Content-Type

application/json

REQUEST

  

JSON Body

В тілі запиту методу передаються ідентифікатори статусів, в яких документи будуть доступні користувачу до перегляду в сервісі Е-Специфікація, наприклад: [12,14,15,17,18]. Доступні значення:

  • 12 - На узгодженні (на стороні мережі)

  • 13 - Підготовлено (на стороні мережі)

  • 14 - Готовий до підписання (на стороні мережі)

  • 15 - Погоджено (на стороні мережі)

  • 17 - Перевірено (на стороні мережі)

  • 18 - Підтверджено (на стороні мережі)

  • 19 - Підписання постачальником (на стороні мережі)

  • 20 - Підписання мережею (на стороні мережі)

RESPONSE

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

Отримати налаштування дій узгодження для вказаного користувача в розрізі кожного підтипу документа AGREEM GET /api/es/user/spec_status

REQUEST

URL

  

Метод запиту

GET

URL запиту

/api/es/user/spec_status

URL параметри

gln (обов’язково) String - GLN власної Компанії АБО guid (обов’язково) String - унікальний ідентифікатор власної організації на платформі

user_id (обов’язково) long - ідентифікатор користувача

Headers

  

Authorization

SID - токен, отриманий при авторизації

Content-Type

application/json

RESPONSE

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

Отримати всі активні GLN користувача (за якими відображаються категорії товарів) GET /api/es/user/spec_view_glns

REQUEST

URL

  

Метод запиту

GET

URL запиту

/api/es/user/spec_view_glns

URL параметри

gln (обов’язково) String - GLN власної Компанії АБО guid (обов’язково) String - унікальний ідентифікатор власної організації на платформі

user_id (обов’язково) long - ідентифікатор користувача

Headers

  

Authorization

SID - токен, отриманий при авторизації

Content-Type

application/json

RESPONSE

В тілі відповіді в json-форматі передаються ідентифікатори активних (включених) GLN користувача (за якими відображаються категорії товарів в сервісі «Е-Специфікація»), наприклад: [174988,174990].

Отримати всі статуси документів, в яких документи доступні користувачу до перегляду GET /api/es/user/spec_view_statuses

REQUEST

URL

  

Метод запиту

GET

URL запиту

/api/es/user/spec_view_statuses

URL параметри

gln (обов’язково) String - GLN власної Компанії АБО guid (обов’язково) String - унікальний ідентифікатор власної організації на платформі

user_id (обов’язково) long - ідентифікатор користувача

Headers

  

Authorization

SID - токен, отриманий при авторизації

Content-Type

application/json

RESPONSE

В тілі відповіді в json-форматі передаються ідентифікатори статусів, в яких документи доступні користувачу для перегляду в сервісі «Е-Специфікація», наприклад: [12,14,15,17,18] (детальніше).

Отримати всі пов’язані GLN користувача в сервісі «Е-Специфікація» GET /api/es/user/spec_all_glns

REQUEST

URL

  

Метод запиту

GET

URL запиту

/api/es/user/spec_all_glns

URL параметри

gln (обов’язково) String - GLN власної Компанії АБО guid (обов’язково) String - унікальний ідентифікатор власної організації на платформі

Headers

  

Authorization

SID - токен, отриманий при авторизації

Content-Type

application/json

RESPONSE

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

Отримати інформацію про всіх користувачів компанії (на рівні акаунта) GET /api/oas/account/users

REQUEST

URL

  

Метод запиту

GET

URL запиту

/api/oas/account/users

URL параметри

type (опціонально) String - тип очікуваної відповіді; можливі варіанти:

  • full (за замовчуванням)

  • short

Headers

  

Authorization

SID - токен, отриманий при авторизації

Content-Type

application/json

RESPONSE

В тілі відповіді передається інформація про користувачів (масив об’єктів User).