API сервісу Маркет

Перелік методів АРІ сервіс Маркет

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

Готову колекцію основних методів API сервісу Маркет для Postman можна завантажити за посиланням: Сервіс -EDIN-Market-.postman_collection.json

Запрошення

Відправити запрошення Покупцю
(ініціатор Продавець (Виробник))

 POST /api/distribex/invitation

Отримати запрошення Продавця в сервіс «Маркет»/Отримати вкладення до вказаного запрошення

 GET /api/distribex/invitation

Прийняти / Відхилити запрошення Продавця 
(ініціатор Покупець (Дистриб’ютор))

 POST /api/distribex/invitation

Повторно відправити запрошення Покупцю
(ініціатор Продавець (Виробник))

 PATCH /api/distribex/invitation

Видалити відправлені запрошення Покупцю
(ініціатор Продавець (Виробник))

DELETE /api/distribex/invitation

 
Робота з обмеженнями

Додати/змінити обмеження 

(ініціатор Продавець (Виробник))

 POST /api/distribex/limits

Отримати обмеження контрагента за GLN

 GET /api/distribex/limits

Видалити обмеження для контрагента 

(ініціатор Продавець (Виробник))

 DELETE /api/distribex/limits
Робота з квотами

Встановити нові квоти для Покупців

(Дистриб'юторів)

 PUT /api/distribex/quotas

Отримати квоти по товару для вказаного Покупця 

(Дистриб'ютора)

 GET /api/distribex/quotas

Масово видалити квоти в прайс-листі для Покупця

(Дистриб'ютора)

 DELETE /api/distribex/quotas
Робота з надбавками

Встановити відмітку «Надбавка» для Покупців

(Дистриб'юторів)

 PUT /api/distribex/surcharge

Отримати дані надбавки по товару для вказаного Покупця 

(Дистриб'ютора)

 GET /api/distribex/surcharge

Масово видалити відмітку надбавки в прайс-листі для Покупця 

(Дистриб'ютора)

 DELETE /api/distribex/surcharge
Робота з «Прайс-листами»

Додати або оновити дані товарів у Прайс-листі для вказаних Покупців

(Дистриб’юторів)

 POST /api/distribex/pricelist

Редагувати дані товарів «Прайс-листа» вказаного Покупця

(Дистрибʼютора)

 PUT /api/distribex/pricelist

Отримати дані «Прайс-листа» для вказаного Покупця

(Дистрибʼютора)

 GET /api/distribex/pricelist

Видалити позицію або «Прайс-лист» для вказаного Покупця

(Дистрибʼютора)

 DELETE /api/distribex/pricelist
Робота з Замовленнями
(Покупець (Дистрибʼютор))

Зберегти (відредагувати) Замовлення за «Прайс-листом»

 PUT /api/distribex/preorder

Отримати дані для формування Замовлення по «Прайс-листу»

 GET /api/distribex/preorder

Зберегти Замовлення по «Прайс-листу»

 POST /api/distribex/preorder

Видалити Замовлення

 DELETE /api/distribex/preorder

Надсилання документа (без створення чернетки)

 POST /api/eds/doc/create_and_send
Робота з рекомендаціями до замовлення
(Продавець (Виробник))

Відправити рекомендації до замовлення за «Прайс-листом»

 POST /api/eds/doc/create_and_send
Робота з документами

Створити (розрахувати) номер «Замовлення» (ORDER)

 GET /api/oas/doc_counter

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

 POST /api/distribex/doc/order

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

 POST /api/distribex/order/copy

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

 GET /api/eds/doc/body

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

 POST /api/eds/docs/search

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

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

 POST /api/distribex/doc/retann
Робота з дозволами

Отримати список контрагентів-Покупців 

(Дистриб'юторів)

 GET /api/distribex/distributor/list

Отримати список контрагентів-Продавців

(Виробників)

 GET /api/distribex/producers/list
Робота з товарами/товарним довідником

Відредагувати товарну позицію «Прайс-листа»

 PUT /api/distribex/product

Отримати список категорій товарів Прайс-листа

 GET /api/distribex/categories

Видалити товарну позицію з «Прайс-листа»

 DELETE /api/distribex/product
Робота з групами Покупців
(Дистрибʼюторів)

Отримати дані про створені групи Покупців (Дистрибʼюторів)

(на стороні Продавця (Виробника))

 GET /api/distribex/accessgroup

Створити групу Покупців (Дистрибʼюторів)

(на стороні Продавця (Виробника))

 POST /api/distribex/accessgroup

Перейменувати поточну групу Покупців (Дистрибʼюторів)

(на стороні Продавця (Виробника))

 PUT /api/distribex/accessgroup

Видалити групу Покупців (Дистрибʼюторів)

(на стороні Продавця (Виробника))

 DELETE /api/distribex/accessgroup

Додати Покупця (Дистрибʼютора) до групи Покупців (Дистрибʼюторів)

(на стороні Продавця (Виробника))

 POST /api/distribex/useraccessgroup

Видалити Покупця (Дистрибʼютора) з групи Покупців (Дистрибʼюторів)

 DELETE /api/distribex/useraccessgroup
Робота з Графіком замовлень

Отримати список графіків замовлень

(Продавець (Виробник)

 GET /api/distribex/producer/schedules

Створити графік замовлень

(Продавець (Виробник)

 POST /api/distribex/producer/schedules

Оновити графік замовлення

(Продавець (Виробник)

 PATCH /api/distribex/producer/schedules

Видалити графік замовлення

(Продавець (Виробник)

 DELETE /api/distribex/producer/schedules

Отримати найактуальніші графіки замовлень для зазначеного списку Продавців (Виробників)

(Покупець (Дистриб'ютор))

 POST /api/distribex/distributor/schedules

Отримати перелік дат доступних для відправлення замовлень у вибраному місяці згідно з графіком Продавця (Виробника) 

(Покупець (Дистриб'ютор))

 POST /api/distribex/schedule/dates
Картка продавця

Створення картки продавця

 POST api/oas/supplier

Оновлення картки продавця

 PUT api/oas/supplier

Отримання картки продавця

 GET api/oas/supplier

Завантаження логотипа 

 POST api/oas/logo/create

Отримання логотипа за посиланням на динамічний роут

 GET api/oas/logo/supplier
Звернення

Створити звернення

 POST api/distribex/buyer/request

Редагування звернення

 PUT api/distribex/buyer/request

Оновлення статусу звернення

 PATCH api/distribex/buyer/request

Отримання переліку звернень

 GET api/distribex/buyer/request

Опис помилок сервісу Маркет

Код відповіді

Індекс помилки

Текст помилки

Опис

400

ERR_MRKT-1

Validation document errors: [%s]

Документ містить помилки: [%s]

Помилка виникає, якщо не передати обов'язковий url-параметр

400

ERR_MRKT-2

No connection between producer and distributor

Відсутній зв’язок між Продавцем (Виробником) і Покупцем (Дистрибʼютором)

  

400

ERR_MRKT-3

The currency doesn’t match the one already set

Валюта не відповідає вже встановленій

  

400

ERR_MRKT-4

Save pricelist error: [%s]

Помилка при збереженні прайсу: [%s]

  

400

ERR_MRKT-5

Position with barcode [%s] not found in original order

Позиції зі штрихкодом [%s] не знайдено в оригінальному замовленні

  

400

ERR_MRKT-6

The „VAT included“ doesn’t match the one already set

Ознака „З/Без ПДВ“ у прайсі що існує відрізняється

  

400

ERR_MRKT-7

Some positions don’t have a price %s vat

По деяких позиціях відсутня ціна %s ПДВ

Отримання переліку звернень GET api/distribex/buyer/request

REQUEST

URL

 https://edo-v2.edin.ua

Метод запиту

GET

URL запиту

/api/distribex/buyer/request

URL параметри

producer_id (опціонально) - звернення до конкретного продавця

gln (обов’язково) String - GLN власної Компанії
gln_id (опціонально) - звернення до конкретного покупця

Headers

  

Authorization

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

Content-Type

multipart/form-data
RESPONSE

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

Приклад відповіді

[
    {
        "id": 3,
        "producerId": 13206429,
        "glnId": 13208197,
        "text": "Я просто тестую звернення, тому і створив оце одне, щоб подивитися чи те, що я зробив, взагалі працює.. тепер от змінив текст трохи..",
        "status": 0,
        "contactPerson": {
            "firstName": "Alex",
            "lastName": "Marchenko",
            "phoneNumber": "+380992323992"
          }
      }
  ]

 

Оновлення статусу звернення PATCH api/distribex/buyer/request

REQUEST

URL

 https://edo-v2.edin.ua

Метод запиту

PATCH

URL запиту

/api/distribex/buyer/request

URL параметри

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

Headers

  

Authorization

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

Content-Type

multipart/form-data

REQUEST


JSON Body

У тілі запиту необхідно передати перелік ID звернень для оновлення статусу.
RESPONSE

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

Редагування звернення PUT api/distribex/buyer/request

REQUEST

URL

 https://edo-v2.edin.ua

Метод запиту

PUT

URL запиту

/api/distribex/buyer/request

URL параметри

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

Headers

  

Authorization

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

Content-Type

multipart/form-data
RESPONSE

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

Створити звернення POST api/distribex/buyer/request

REQUEST

URL

 https://edo-v2.edin.ua

Метод запиту

POST

URL запиту

/api/distribex/buyer/request

URL параметри

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

Headers

  

Authorization

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

Content-Type

multipart/form-data, де:

  • одним файлом передається JSON-об’єкт з даними звернення;

  • до трьох додаткових файлів — вкладення (зображення розміром до 500 КБ).

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

{
	"producerId": 13206429,
	"glnId": 13208197,
	"text": "Я просто тестую звернення, тому і створив оце одне, щоб подивитися чи те, що я зробив, взагалі працює..",
	"contactPerson": {
		"firstName": "Alex",
		"lastName": "Marchenko",
		"phoneNumber": "+380992323992"
	}
}
RESPONSE

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

 

Отримання логотипа за посиланням на динамічний роут GET api/oas/logo/supplier

REQUEST

URL

 https://edo-v2.edin.ua

Метод запиту

GET

URL запиту

api/oas/logo/supplier/1.jpg

URL параметри

logo (обов’язково)

Headers

  

Authorization

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

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

Завантаження логотипа POST api/oas/logo/create

REQUEST

URL

 https://edo-v2.edin.ua

Метод запиту

POST

URL запиту

api/oas/logo/create

URL параметри

gln (обов’язково) String - GLN Продавця (Виробника)
folder_name=supplier (обов’язково)

Headers

  

Authorization

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

Content-Type

application/json
RESPONSE

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

Отримання картки продавця GET api/oas/supplier

REQUEST

URL

 https://edo-v2.edin.ua

Метод запиту

GET

URL запиту

api/oas/supplier

URL параметри

gln (обов’язково) String - GLN Продавця (Виробника)

Headers

  

Authorization

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

Content-Type

application/json
RESPONSE

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

Приклад відповіді 

{
    "id": 1,
    "name": "Хлібна майстерня",
    "description": "Хлібна майстерня» — це більше ніж пекарня...",
    "phone": "+380954603452",
    "logo": "1.jpg",
    "glnId": 13208197,
    "accountId": 40895
}

 

Оновлення картки продавця PUT api/oas/supplier

REQUEST

URL

 https://edo-v2.edin.ua

Метод запиту

PUT

URL запиту

api/oas/supplier

URL параметри

gln (обов’язково) String - GLN Продавця (Виробника)

Headers

  

Authorization

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

Content-Type

application/json

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

{   
	  "id": 1
    "name": "Хлібна майстерня",
    "description": "Хлібна майстерня» — це більше ніж пекарня. Це місце, де давні традиції випікання поєднуються із сучасними підходами до якості й смаку. Ми віримо, що справжній хліб має народжуватися з любові до ремесла та натуральних інгредієнтів, тому кожен наш буханець — це результат кропіткої роботи, уваги до деталей і поваги до класичних рецептів.",
    "phone": "+380954603452",
    "glnId": 13208197,
    "accountId": 40895
}
RESPONSE

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

 

Створення картки продавця POST api/oas/supplier

REQUEST

URL

 https://edo-v2.edin.ua

Метод запиту

POST

URL запиту

api/oas/supplier

URL параметри

gln (обов’язково) String - GLN Продавця (Виробника)

Headers

  

Authorization

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

Content-Type

application/json

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

{
    "name": "Хлібна майстерня",
    "description": "Хлібна майстерня» — це більше ніж пекарня. Це місце, де давні традиції випікання поєднуються із сучасними підходами до якості й смаку. Ми віримо, що справжній хліб має народжуватися з любові до ремесла та натуральних інгредієнтів, тому кожен наш буханець — це результат кропіткої роботи, уваги до деталей і поваги до класичних рецептів.",
    "phone": "+380954603452",
    "glnId": 13208197,
    "accountId": 40895
}
RESPONSE

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

 

Отримати перелік дат доступних для відправлення замовлень у вибраному місяці згідно з графіком Продавця (Виробника) (Покупець (Дистриб'ютор)) POST /api/distribex/schedule/dates

REQUEST

URL

  

Метод запиту

POST

URL запиту

/api/distribex/schedule/dates

URL параметри

year (обов’язково) int - рік;

month (обов’язково) int - порядковий номер місяця

Headers

  

Authorization

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

Content-Type

application/json

REQUEST

  

JSON Body

В тілі запиту методу передається повний об’єкт графіка замовлень (об’єкт Schedule), що може бути отриманий методом POST /api/distribex/distributor/schedules
RESPONSE

В тілі відповіді передається список дат, наприклад: [1,2,3,4,5,6,7,8,9,10]

Отримати найактуальніші графіки замовлень для зазначеного списку Продавців (Виробників) (Покупець (Дистриб'ютор)) POST /api/distribex/distributor/schedules

Метод враховує ієрархію типів графіків: якщо у Продавця (Виробника) вже діє загальний графік, але для конкретного Покупця (Дистрибʼютора) існує індивідуальний графік, який починає діяти пізніше (після поточної дати), у відповіді буде повернено саме індивідуальний графік.

REQUEST

URL

 https://edo-v2.edin.ua

Метод запиту

POST

URL запиту

/api/distribex/distributor/schedules

URL параметри

gln (обов’язково) String - GLN Покупця (Дистрибʼютора)

Headers

  

Authorization

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

Content-Type

application/json

REQUEST

  

JSON Body

В тілі запиту методу передається список ідентифікаторів GLN Продавців (Виробників) (масив значень gln_id), наприклад: [13200757]
RESPONSE

В тілі відповіді передаються дані графіка замовлень за кожним вказаним Продавцем (Виробником) (об’єкт Schedule).

Видалити графік замовлення (Продавець (Виробник) DELETE /api/distribex/producer/schedules

REQUEST

URL

 https://edo-v2.edin.ua

Метод запиту

DELETE

URL запиту

/api/distribex/producer/schedules

URL параметри

gln (обов’язково) String - GLN Продавця (Виробника)

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

Headers

  

Authorization

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

Content-Type

application/json
RESPONSE

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

Оновити графік замовлення (Продавець (Виробник) PATCH /api/distribex/producer/schedules

Правило оновлення графіка замовлень

REQUEST

URL

 https://edo-v2.edin.ua

Метод запиту

PATCH

URL запиту

/api/distribex/producer/schedules

URL параметри

gln (обов’язково) String - GLN Продавця (Виробника)

Headers

  

Authorization

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

Content-Type

application/json

REQUEST

  

JSON Body

В тілі запиту методу передаються нові дані для зазначеного графіка замовлень (об’єкт Schedule)
RESPONSE

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

Створити графік замовлень (Продавець (Виробник) POST /api/distribex/producer/schedules

Правило створення графіка замовлень

Не допускається створення графіка замовлень, який має перетин дат з іншим графіком для одного й того ж Покупця (Дистриб’ютора) та типу графіка.

REQUEST

URL

 https://edo-v2.edin.ua

Метод запиту

POST

URL запиту

/api/distribex/producer/schedules

URL параметри

gln (обов’язково) String - GLN Продавця (Виробника)

Headers

  

Authorization

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

Content-Type

application/json

REQUEST

  

JSON Body

В тілі запиту методу передаються дані графіка замовлень (об’єкт Schedule)
RESPONSE

В тілі відповіді передаються дані графіка замовлень (об’єкт Schedule).

Отримати список графіків замовлень (Продавець (Виробник) GET /api/distribex/producer/schedules

REQUEST

URL

 https://edo-v2.edin.ua

Метод запиту

GET

URL запиту

/api/distribex/producer/schedules

URL параметри

gln (обов’язково) String - GLN Продавця (Виробника)

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

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

Headers

  

Authorization

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

Content-Type

 application/json
RESPONSE

В тілі відповіді передається список графіків замовлень (масив об’єктів Schedule) відсортованих за датою створення/оновлення.

Видалити Покупця (Дистрибʼютора) з групи Покупців (Дистрибʼюторів) DELETE /api/distribex/useraccessgroup

REQUEST

URL

 https://edo-v2.edin.ua

Метод запиту

DELETE

URL запиту

/api/distribex/useraccessgroup

URL параметри

gln (обов’язково) String - GLN Продавця (Виробника)

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

gln_id (обов’язково) String - GLN Покупця (Дистрибʼютора)

Headers

  

Authorization

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

Content-Type

application/json
RESPONSE

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

Додати Покупця (Дистрибʼютора) до групи Покупців (Дистрибʼюторів) (на стороні Продавця (Виробника)) POST /api/distribex/useraccessgroup

REQUEST

URL

 https://edo-v2.edin.ua

Метод запиту

POST

URL запиту

/api/distribex/useraccessgroup

URL параметри

gln (обов’язково) String - GLN Продавця (Виробника)

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

gln_id (обов’язково) String - GLN Покупця (Дистрибʼютора)

Headers

  

Authorization

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

Content-Type

application/json
RESPONSE

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

Видалити групу Покупців (Дистрибʼюторів) (на стороні Продавця (Виробника)) DELETE /api/distribex/accessgroup

REQUEST

URL

 https://edo-v2.edin.ua

Метод запиту

DELETE

URL запиту

/api/distribex/accessgroup

URL параметри

gln (обов’язково) String - GLN Продавця (Виробника)

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

Headers

  

Authorization

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

Content-Type

application/json
RESPONSE

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

Перейменувати поточну групу Покупців (Дистрибʼюторів) (на стороні Продавця (Виробника)) PUT /api/distribex/accessgroup

REQUEST

URL

 https://edo-v2.edin.ua

Метод запиту

PUT

URL запиту

/api/distribex/accessgroup

URL параметри

gln (обов’язково) String - GLN Продавця (Виробника)

Headers

  

Authorization

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

Content-Type

application/json

REQUEST

  

JSON Body

В тілі запиту методу передаються дані групи дистиб’юторів (об’єкт XDistribexAccessGroup)
RESPONSE

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

Створити групу Покупців (Дистрибʼюторів) (на стороні Продавця (Виробника)) POST /api/distribex/accessgroup

REQUEST

URL

 https://edo-v2.edin.ua

Метод запиту

POST

URL запиту

/api/distribex/accessgroup

URL параметри

gln (обов’язково) String - GLN Продавця (Виробника)

Headers

  

Authorization

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

Content-Type

application/json

REQUEST

  

JSON Body

При створенні нової групи в тілі запиту методу передаються лише назва (name) та ідентифікатор Продавця (Виробника) (producerId).

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

{"name":"Красавчики","producerId":13200791}
RESPONSE

 В тілі відповіді передаються дані створеної групи Покупців (Дистрибʼюторів) (об’єкт XDistribexAccessGroup).

Отримати дані про створені групи Покупців (Дистрибʼюторів) (на стороні Продавця (Виробника)) GET /api/distribex/accessgroup

REQUEST

URL

 https://edo-v2.edin.ua

Метод запиту

GET

URL запиту

/api/distribex/accessgroup

URL параметри

gln (обов’язково) String - GLN Продавця (Виробника)

Headers

  

Authorization

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

Content-Type

application/json
RESPONSE

В тілі відповіді передаються дані всіх створених груп дистриб'юторів (масив об’єктів XDistribexAccessGroup)

Видалити товарну позицію з «Прайс-листа» DELETE /api/distribex/product

Метод доступний лише для користувача з роллю Продавець (Виробник)

REQUEST

URL

 https://edo-v2.edin.ua

Метод запиту

DELETE

URL запиту

/api/distribex/product

URL параметри

gln (обов’язково) String - GLN Продавця (Виробника)

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

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

Headers

  

Authorization

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

Content-Type

application/json
RESPONSE

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

Отримати список категорій товарів Прайс-листа GET /api/distribex/categories

REQUEST

URL

 https://edo-v2.edin.ua

Метод запиту

GET

URL запиту

/api/distribex/categories

URL параметри

gln (обов’язково) String - GLN ініціатора запиту (Продавця (Виробника) чи Покупця (Дистрибʼютора));

gln_id (обов’язково) String - ідентифікатор GLN контрагента (Покупця (Дистрибʼютора) чи Продавця (Виробника) відповідно);

e_product (опціонально) boolean - значення true є індикатором того, що запит виконується в сервісі Є-Товар

Headers

  

Authorization

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

Content-Type

application/json
RESPONSE

В тілі відповіді у вигляді масиву об’єкта XProductGroup передаються категорії товарів Прайс-листа для вказаної пари «Покупець (Дистрибʼютор)»-«Продавець (Виробник)».

Відредагувати товарну позицію «Прайс-листа» PUT /api/distribex/product

Метод доступний лише для користувача з роллю Продавець (Виробник)

REQUEST

URL

 https://edo-v2.edin.ua

Метод запиту

PUT

URL запиту

/api/distribex/product

URL параметри

gln (обов’язково) String - GLN Продавця (Виробника)

Headers

  

Authorization

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

Content-Type

application/json

REQUEST

  

JSON Body

В тілі запиту методу передається об’єкт XDistribexProduct з даними по товарній позиції
RESPONSE

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

Отримати список контрагентів-Продавців (Виробників) GET /api/distribex/producers/list

REQUEST

URL

 https://edo-v2.edin.ua

Метод запиту

GET

URL запиту

/api/distribex/producers/list

URL параметри

gln (обов’язково) String - GLN Покупця (Дистрибʼютора)

query (опціонально) String - текст пошуку (пошук здійснюється за назвою/GLN)

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

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

Headers

  

Authorization

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

Content-Type

application/json
RESPONSE

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

Отримати список контрагентів-Покупців (Дистриб'юторів) GET /api/distribex/distributor/list

REQUEST

URL

 https://edo-v2.edin.ua

Метод запиту

GET

URL запиту

/api/distribex/distributor/list

URL параметри

gln (обов’язково) String - GLN Продавця (Виробника)

query (опціонально) String - текст пошуку (пошук здійснюється за назвою/GLN)

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

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

accessgroup (опціонально) String - назва групи (пошук за повним збігом)

Headers

  

Authorization

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

Content-Type

application/json
RESPONSE

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

Визначення переліку товарних позицій, доступних для повернення, та формування документа “Надсилання Повернення” (ініціатор - Покупець/Дистриб’ютор) POST /api/distribex/doc/retann

REQUEST

URL

https://edo-v2.edin.ua

Метод запиту

POST

URL запиту

/api/distribex/doc/retann

URL параметри

gln (обов’язково) String - GLN Покупця (Дистрибʼютора)

producer (обов’язково) String - GLN Продавця (Виробника);

period (обов’язково) int - кількість днів, за які з документів робиться вибірка позицій, доступних до повернення (починаючи від поточного дня) - period=1 - за сьогодні, period=2 - за сьогодні та вчора і т.д.; максимум 90 днів, однак обмеження може змінюватись відповідно до наявності Лімітів зазначених Продавцем;

search_positions (опціонально) boolean:

  • якщо true, то у відповідь метода повертається список доступних до повернення позицій для зазначеного Покупця в межах періоду;

  • якщо false або параметр search_positions відсутній, то очікується тіло документа «Повідомлення про повернення» (RETANN) в json форматі уже разом із позиціями; при цьому документ одразу відправляється контрагенту (без створення чернетки).

Headers

  

Authorization

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

Content-Type

application/json

REQUEST

  

JSON Body

Тіло запиту передається лише при search_positions=false або відсутності даного параметра: «Повідомлення про повернення» (RETANN) в json форматі уже разом із позиціями; при цьому документ одразу відправляється контрагенту (без створення чернетки).
RESPONSE

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

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

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

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

Метод виконує пошук за заданими критеріями, наприклад отримати список документів із певним статусом або за визначений період часу.

REQUEST

URL

 https://edo-v2.edin.ua

Метод запиту

POST

URL запиту

/api/eds/docs/search

URL параметри

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

status_id (опціонально) int - id папки документів:

  • 0 - Всі

  • 1 - Вхідні;

  • 2 - Надіслані;

  • 3 - Архівні;

  • 4 - Чернетки;

  • 5 - Важливі.

family (опціонально) String - назва сімейства документів:

  • edi

  • uzd

  • certificats

  • ats

  • ettn

  • distribex (Маркет)

  • simple-doc (Вільний)

  • tender

  • agreement

  • openprice (Є-Товар)

Headers

  

Authorization

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

Content-Type

application/json

REQUEST

  

JSON Body

В тілі запиту методу передаються обов’язкові та додаткові критерії пошуку/фільтрації об’єкт StorageQuery
RESPONSE

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

Отримання контенту документа GET /api/eds/doc/body

Метод повертає контент документа без підписів і печаток, а також тіла підпису та печатки. У запиті передаються GLN користувача, doc_uuid та тип тіла документа.

REQUEST

URL

 https://edo-v2.edin.ua

Метод запиту

GET

URL запиту

/api/eds/doc/body

URL параметри

gln (обов’язково) String (13) - номер GLN організації, яка пов’язана з авторизованим користувачем платформи EDIN 2.0 на рівні акаунта

АБО

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

doc_uuid (обов’язково) UUID - ідентифікатор документа;

body_type (обов’язково) String - тип тіла документа; можливі значення:

  • content - base64 контент без підписів/печаток;

  • json - json документа;

  • sign - base64 тіло підпису;

  • xml - тіло документа в xml форматі;

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

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

  • file

  • base64

Headers

  

Authorization

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

Content-Type

application/json
RESPONSE

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

Створити копію документа «Замовлення» (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

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

Створити документ «Замовлення» (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) 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.

Відправити рекомендації до замовлення за «Прайс-листом» POST /api/eds/doc/create_and_send

Метод дозволяє надіслати рекомендації до замовлення за Прайс-листом для покупця/-ців.

REQUEST

URL

 https://edo-v2.edin.ua

Метод запиту

POST

URL запиту

/api/eds/doc/create_and_send

URL параметри

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

doc_type - рядок; тип документа: допустиме значення: orders

Headers

  

Authorization

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

Content-Type

multipart/form-data

REQUEST

  

JSON Body

В тілі запиту методу передається тільки один файл-вкладення в форматі application/json / application/xml / application/pkcs7-signature (приклади запитів + специфікація Замовлення, в якому очікується DOCTYPE = «PO»)

 

При вказуванні application/pkcs7-signature доступна можливість обробки BASE64 формату.

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

POST /api/eds/doc/create_and_send?doc_type=orders&gln=9864065702429 HTTP/1.1
Content-Type: multipart/form-data; boundary=-------------573cf973d5228
...else headers...
---------------573cf973d5228
Content-Disposition: form-data; name="file"; filename="file.json"
Content-Type: application/json
{Content of JSON file}

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

POST /api/eds/doc/create_and_send?doc_type=orders&gln=9864065702429 HTTP/1.1
Content-Type: multipart/form-data; boundary=-------------573cf973d5228
...else headers...
---------------573cf973d5228
Content-Disposition: form-data; name="file"; filename="file.xml"
Content-Type: application/xml
{Content of XML file}

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

POST /api/eds/doc/create_and_send?doc_type=orders&gln=9864065702429 HTTP/1.1
Content-Type: multipart/form-data; boundary=-------------573cf973d5228
...else headers...
---------------573cf973d5228
Content-Disposition: form-data; name="file"; filename="file.p7s"
Content-Type: application/pkcs7-signature
{Content of P7S file}
RESPONSE

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

 

 

 

Надсилання документа (без створення чернетки) POST /api/eds/doc/create_and_send

Метод є універсальним для різних типів документів і дозволяє одночасно створити та відправити документ без створення чернетки.

REQUEST

URL

  https://edo-v2.edin.ua

Метод запиту

POST

URL запиту

/api/eds/doc/create_and_send

URL параметри

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

doc_type - рядок; тип документа

Headers

  

Authorization

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

Content-Type

multipart/form-data

REQUEST

  

JSON Body

В тілі запиту методу передається тільки один файл-вкладення в форматі application/json / application/xml / application/pkcs7-signature

 

При вказуванні application/pkcs7-signature доступна можливість обробки BASE64 формату.

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

POST /api/eds/doc/create_and_send?doc_type=orders&gln=9864065702429 HTTP/1.1
Content-Type: multipart/form-data; boundary=-------------573cf973d5228
...else headers...
---------------573cf973d5228
Content-Disposition: form-data; name="file"; filename="file.json"
Content-Type: application/json
{Content of JSON file}

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

POST /api/eds/doc/create_and_send?doc_type=orders&gln=9864065702429 HTTP/1.1
Content-Type: multipart/form-data; boundary=-------------573cf973d5228
...else headers...
---------------573cf973d5228
Content-Disposition: form-data; name="file"; filename="file.xml"
Content-Type: application/xml
{Content of XML file}

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

POST /api/eds/doc/create_and_send?doc_type=orders&gln=9864065702429 HTTP/1.1
Content-Type: multipart/form-data; boundary=-------------573cf973d5228
...else headers...
---------------573cf973d5228
Content-Disposition: form-data; name="file"; filename="file.p7s"
Content-Type: application/pkcs7-signature
{Content of P7S file}
RESPONSE

Параметр ticket_uuid повертається системою лише у випадках створення додаткового тікета до вже існуючого документа (наприклад: підписання у відповідь, відмова від підпису, запит на анулювання).
Якщо документ є новим, у відповіді система повертає лише chain_uuid та doc_uuid.

Приклад відповіді:

{
  "chain_uuid": "7ccff78e-ea42-47ea-81e4-5508ed4fbd51",
  "doc_uuid": "3698b501-e1ef-464d-a71a-58066f556114",
  "ticket_uuid": "1003706c-3656-497b-9438-c6f33e27c36d"
}

 

 

 

 

Видалити Замовлення DELETE /api/distribex/preorder

REQUEST

URL

 https://edo-v2.edin.ua

Метод запиту

DELETE

URL запиту

/api/distribex/preorder

URL параметри

gln (обов’язково) String - GLN Покупця (Дистрибʼютора)

preorder_id (обов’язково) String - ідентифікатор Попереднього замовлення

Headers

  

Authorization

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

Content-Type

application/json
RESPONSE

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

Зберегти Замовлення по «Прайс-листу» POST /api/distribex/preorder

REQUEST

URL

 https://edo-v2.edin.ua

Метод запиту

POST

URL запиту

/api/distribex/preorder

URL параметри

gln (обов’язково) String - GLN Покупця (Дистрибʼютора)

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

positions (обов’язково /-) String - позиції Попереднього замовлення. Параметр відсутній при наявності load_excel параметра

load_excel (обов’язково /-) boolean - load_excel=true при передачі значень через xls-файл. Параметр відсутній при наявності positions параметра

doc_uuid (опціонально) UUID - ідентифікатор документа-підстави

type_id (опціонально) int - ідентифікатор підтипу документа:

  • 1 - оригінальне замовлення (за замовчуванням);

  • 2 - попереднє замовлення;

  • 3 - відредаговане замовлення

Headers

  

Authorization

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

Content-Type

application/json

REQUEST

  

JSON Body

При передачі значень вручну (через positions параметр): в тілі запиту методу передається масив об’єктів XDistribexPreorderPosition з вказаною кількістю відповідних товарних позицій для Попереднього замовлення.

При передачі значень через xls-файл (вказується параметр load_excel=true): в тілі запиту передається заповнений шаблон order_upload_ua.xls (вкладення ліворуч) 
RESPONSE

В тілі відповіді передаються дані для збереження Замовлення по «Прайс-листу» (об’єкт XDistribexPreorder)

Отримати дані для формування Замовлення по «Прайс-листу» GET /api/distribex/preorder

REQUEST

URL

 https://edo-v2.edin.ua

Метод запиту

GET

URL запиту

/api/distribex/preorder

URL параметри

gln (обов’язково) String - GLN Покупця (Дистрибʼютора)

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

type_id (опціонально) int - ідентифікатор підтипу документа:

  • 1 - оригінальне замовлення (за замовчуванням);

  • 2 - попереднє замовлення;

  • 3 - відредаговане замовлення

Headers

  

Authorization

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

Content-Type

application/json
RESPONSE

В тілі відповіді передаються дані для формування Замовлення по «Прайс-листу» (об’єкт XDistribexPreorder)

Зберегти (відредагувати) Замовлення за «Прайс-листом» PUT /api/distribex/preorder

REQUEST

URL

 https://edo-v2.edin.ua

Метод запиту

PUT

URL запиту

/api/distribex/preorder

URL параметри

gln (обов’язково) String - GLN Покупця (Дистрибʼютора)

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

id (обов’язково) String - ідентифікатор Попереднього замовлення

positions (обов’язково) String - позиції Попереднього замовлення

doc_uuid (опціонально) UUID - ідентифікатор документа-підстави

type_id (опціонально) int - ідентифікатор підтипу документа:

  • 1 - оригінальне замовлення (за замовчуванням);

  • 2 - попереднє замовлення;

  • 3 - відредаговане замовлення

Headers

  

Authorization

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

Content-Type

application/json

REQUEST

  

JSON Body

В тілі запиту методу передається масив об'єкта XDistribexPreorderPosition
RESPONSE

В тілі відповіді передаються дані для збереження Замовлення по «Прайс-листу» (об’єкт XDistribexPreorder)

Видалити позицію або «Прайс-лист» для вказаного Покупця (Дистрибʼютора) DELETE /api/distribex/pricelist

Даний метод може бути використано лише користувачем з роллю Продавець (Виробник).
Метод призначений для видалення товарної позиції з «Прайс-листа» для зазначеного «Покупця (Дистрибʼютора)».
Якщо параметр list_id (ID товарної позиції) не передано, тоді «Прайс-лист» для вказаного «Покупця (Дистрибʼютора)» повністю очищується.

REQUEST

URL

 https://edo-v2.edin.ua

Метод запиту

DELETE

URL запиту

/api/distribex/pricelist

URL параметри

gln (обов’язково) String - GLN Продавця (Виробника)

gln_id (обов’язково) String - ідентифікатор Покупця (Дистрибʼютора)

list_id (опціонально) String - ідентифікатор товарної позиції, яку потрібно видалити в Прайс-листі. Якщо list_id параметр не передається, то Прайс-лист для вказаного Покупця (Дистрибʼютора) видаляється (очищається) повністю.

Headers

  

Authorization

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

Content-Type

application/json
 RESPONSE

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

Отримати дані «Прайс-листа» для вказаного Покупця (Дистрибʼютора) GET /api/distribex/pricelist

Значення параметрів у запиті відрізняються залежно від ролі користувача «Продавець (Виробник)» / «Покупець (Дистрибʼютор)».

REQUEST

Для ролі Покупця (Дистрибʼютора)

URL

 https://edo-v2.edin.ua

Метод запиту

GET

URL запиту

/api/distribex/pricelist

URL параметри

gln (обов’язково) Число (13) - GLN Покупця (Дистрибʼютора)

gln_id (обов’язково) String - ідентифікатор Продавця (Виробника) (producer_id)

Headers

  

Authorization

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

Content-Type

application/json

 Для ролі Продавця (Виробника)

URL

 https://edo-v2.edin.ua

Метод запиту

GET

URL запиту

/api/distribex/pricelist

URL параметри

gln (обов’язково) Число (13) - GLN Продавця (Виробника)

gln_id (обов’язково/-) String - ідентифікатор Покупця (Дистрибʼютора) (distributor_id). Обов’язково передається або gln_id або access_groups_id (один з параметрів);

access_groups_id (обов’язково/-) long - ідентифікатор групи Покупців (Дистрибʼюторів). Обов’язково передається або gln_id або access_groups_id (один з параметрів);

date (опціонально) YYYY-MM-DD - Прайс-лист Покупця (Дистрибʼютора) на дату (фільтр)

Headers

  

Authorization

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

Content-Type

application/json
RESPONSE

В тілі відповіді передаються дані по товарах «Прайс-листа»:

Редагувати дані товарів «Прайс-листа» вказаного Покупця (Дистрибʼютора) PUT /api/distribex/pricelist

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

REQUEST

URL

 https://edo-v2.edin.ua

Метод запиту

PUT

URL запиту

/api/distribex/pricelist

URL параметри

gln (обов’язково) String - GLN Продавця (Виробника)

gln_id (обов’язково) String - ідентифікатор Покупця (Дистрибʼютора)

Headers

  

Authorization

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

Content-Type

application/json

REQUEST

  

JSON Body

В тілі запиту методу передаються нові/оновлені дані товарів Прайс-листа для вказаного Покупця (Дистрибʼютора) (масив об’єктів XPriceListElement)
RESPONSE

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

Додати або оновити дані товарів у Прайс-листі для вказаних Покупців (Дистриб’юторів) POST /api/distribex/pricelist

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

REQUEST

URL

 https://edo-v2.edin.ua

Метод запиту

POST

URL запиту

/api/distribex/pricelist

URL параметри

gln (обов’язково) String - GLN Продавця (Виробника)

Headers

  

Authorization

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

Content-Type

application/json

REQUEST

  

JSON Body

В тілі запиту методу передаються нові/оновлені дані товарів, що долучаються в Прайс-лист до вказаних Покупців (Дистрибʼюторів) (об’єкт XPriceListElement)
RESPONSE

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

Масово видалити відмітку надбавки в прайс-листі для Покупця (Дистриб'ютора) DELETE /api/distribex/surcharge

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

REQUEST

URL

 https://edo-v2.edin.ua

Метод запиту

DELETE

URL запиту

/api/distribex/surcharge

URL параметри

gln (обов’язково) String - GLN Продавця (Виробника)

distributor_gln (обов’язково) String - GLN Покупця (Дистрибʼютора)

Headers

  

Authorization

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

Content-Type

application/json
RESPONSE

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

Отримати дані надбавки по товару для вказаного Покупця (Дистриб'ютора) GET /api/distribex/surcharge

REQUEST

URL

 https://edo-v2.edin.ua

Метод запиту

GET

URL запиту

/api/distribex/surcharge

URL параметри

gln (обов’язково) String - GLN Продавця (Виробника)

distributor_gln (обов’язково) String - GLN Покупця (Дистрибʼютора)

barcode (обов’язково) String - штрихкод товару

article (опціонально) String - артикул товару

Headers

  

Authorization

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

Content-Type

application/json
RESPONSE

В тілі відповіді передаються дані по встановленим надбавкам для вказаного Покупця (Дистрибʼютора).

Встановити відмітку «Надбавка» для Покупців (Дистриб'юторів) PUT /api/distribex/surcharge

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

REQUEST

URL

 https://edo-v2.edin.ua

Метод запиту

PUT

URL запиту

/api/distribex/surcharge

URL параметри

gln (обов’язково) String - GLN Продавця (Виробника)

Headers

  

Authorization

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

Content-Type

application/json

REQUEST

  

JSON Body

В тілі запиту методу передається масив об’єктів XDistribexSurcharge

з надбавками для зазначених товарних позицій вказаного користувача-Покупця (Дистрибʼютора)
RESPONSE

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

Масово видалити квоти в прайс-листі для Покупця (Дистриб'ютора) DELETE /api/distribex/quotas

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

REQUEST

URL

 https://edo-v2.edin.ua

Метод запиту

DELETE

URL запиту

/api/distribex/quotas

URL параметри

gln (обов’язково) String - GLN Продавця (Виробника)

d_gln (обов’язково) String - GLN Покупця (Дистрибʼютора)

Headers

  

Authorization

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

Content-Type

application/json
RESPONSE

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

Отримати квоти по товару для вказаного Покупця (Дистриб'ютора) GET /api/distribex/quotas

REQUEST

URL

 https://edo-v2.edin.ua

Метод запиту

GET

URL запиту

/api/distribex/quotas

URL параметри

gln (обов’язково) String - GLN Продавця (Виробника)

d_gln (обов’язково) String - GLN Покупця (Дистрибʼютора)

barcode (обов’язково) String - штрихкод товару

article (обов’язково) String - артикул товару

Headers

  

Authorization

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

Content-Type

application/json
RESPONSE

В тілі відповіді передаються дані по встановленим квотам для вказаного Покупця (Дистрибʼютора).

Встановити нові квоти для Покупців (Дистриб'юторів) PUT /api/distribex/quotas

REQUEST

URL

 https://edo-v2.edin.ua

Метод запиту

PUT

URL запиту

/api/distribex/quotas

URL параметри

gln (обов’язково) String - GLN Продавця (Виробника)

Headers

  

Authorization

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

Content-Type

application/json

REQUEST

  

JSON Body

В тілі запиту методу передається масив об’єктів Quotas з квотами для кожного вказаного користувача-Покупця (Дистрибʼютора)
RESPONSE

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

Видалити обмеження для контрагента (ініціатор Продавець (Виробник)) DELETE /api/distribex/limits

REQUEST

URL

 https://edo-v2.edin.ua

Метод запиту

DELETE

URL запиту

/api/distribex/limits

URL параметри

gln (обов’язково) String - GLN Продавця (Виробника)

d_gln (обов’язково) String - GLN Покупця (Дистрибʼютора)

limit_key (опціонально) String - перелік доступних значень обмежень. Використовується, якщо потрібно видалити одне обмеження зі списку, а не очистити всі обмеження повністю.

Headers

  

Authorization

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

Content-Type

application/json
RESPONSE

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

Отримати обмеження контрагента за GLN GET /api/distribex/limits

Метод може використовуватись як Продавцем (Виробником), так і Покупцем (Дистрибʼютором):
 - для отримання налаштованих обмежень з боку Продавця (Виробника) передаються параметри gln та d_gln;
 - для отримання налаштованих обмежень з боку Покупця (Дистрибʼютора) передаються параметри gln та producerId.

REQUEST

URL

 https://edo-v2.edin.ua

Метод запиту

GET

URL запиту

/api/distribex/limits

URL параметри

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

d_gln / producerId (обов’язково) String

  • з боку Продавця (Виробника): d_gln - GLN Покупця (Дистрибʼютора)

  • з боку Покупця (Дистрибʼютора): producerId - ідентифікатор компанії-Продавця (Виробника)

Headers

  

Authorization

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

Content-Type

application/json
RESPONSE

В тілі відповіді передається об’єкт Limits з обмеженнями для вказаного Покупця (Дистрибʼютора).

Додати/змінити обмеження  (ініціатор Продавець (Виробник)) (ініціатор Продавець (Виробник)) POST /api/distribex/limits

REQUEST

URL

 https://edo-v2.edin.ua

Метод запиту

POST

URL запиту

/api/distribex/limits

URL параметри

gln (обов’язково) String - GLN Продавця (Виробника)

Headers

  

Authorization

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

Content-Type

application/json

REQUEST

  

JSON Body

В тілі запиту методу передається об’єкт Limits (назва=GLN Покупця (Дистрибʼютора)) з обмеженнями для конкретного користувача-Покупця (Дистрибʼютора)
RESPONSE

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

Видалити відправлені запрошення Покупцю (ініціатор Продавець (Виробник)) DELETE /api/distribex/invitation

REQUEST

URL

 https://edo-v2.edin.ua

Метод запиту

DELETE

URL запиту

/api/distribex/invitation

URL параметри

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

invitation_id (обов’язково) String - ідентифікатор раніше відправленого запрошення (XDistribexInvitation.id); можна передавати декілька, для масового надсилання

Headers

  

Authorization

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

Content-Type

application/json
RESPONSE

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

Повторно відправити запрошення Покупцю (ініціатор Продавець (Виробник)) PATCH /api/distribex/invitation

Повторне надсилання запрошення одному й тому ж Покупцю доступно один раз на 24 години

REQUEST

URL

 https://edo-v2.edin.ua

Метод запиту

PATCH

URL запиту

/api/distribex/invitation

URL параметри

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

invitation_id (обов’язково) String - ідентифікатор раніше відправленого запрошення (XDistribexInvitation.id); можна передавати декілька, для масового надсилання

Headers

  

Authorization

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

Content-Type

application/json
RESPONSE

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

Приклад відповіді:

{"done":[save@mail.com],"errors":["savep38075@adosnan.com"]}

Прийняти / Відхилити запрошення Продавця (ініціатор Покупець (Дистриб’ютор)) POST /api/distribex/invitation

REQUEST

URL

 https://edo-v2.edin.ua

Метод запиту

POST

URL запиту

/api/distribex/invitation

URL параметри

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

invitation_id (обов’язково) String - ідентифікатор раніше відправленого запрошення (XDistribexInvitation.id);

status (обов’язково) int - статус, який потрібно надати запрошенню:

  • 1 - Прийнято;

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

Headers

  

Authorization

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

Content-Type

application/json

REQUEST

  

JSON Body

В запиті при status=2 може передаватись текстова причина відхилення запрошення, що буде відображатись Продавцю.
RESPONSE

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

Отримати запрошення Продавця в сервіс «Маркет»/Отримати вкладення до вказаного запрошення GET /api/distribex/invitation

REQUEST

URL

 https://edo-v2.edin.ua

Метод запиту

GET

URL запиту

/api/distribex/invitation

URL параметри

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

invitation_id (опціонально) int - ідентифікатор запрошення (передається для того, щоб отримати конкретне запрошення у json форматі). Якщо додатково передати параметр load_body=true, то повертається контент вкладення (pdf-файл) до запрошення;

Для фільтрації списку доступних запрошень можливо використовувати дод. параметри:

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

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

  • status (опціонально) int - статус запрошення (можливо передавати кілька значень):

    • 0 - Запрошено;

    • 1 - Прийнято;

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

Headers

  

Authorization

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

Content-Type

application/json

URL

 https://edo-v2.edin.ua

Метод запиту

GET

URL запиту

/api/distribex/invitation?gln=9864065732303&limit=21&offset=0

URL параметри

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

invitation_id (опціонально) int - ідентифікатор запрошення (передається для того, щоб отримати конкретне запрошення у json форматі). Якщо додатково передати параметр load_body=true, то повертається контент вкладення (pdf-файл) до запрошення;

buyer_ipn (опціонально) int - ЄДРПОУ / ІПН Покупця, що були зазначені в запрошенні;

buyer (опціонально) String - контакти (email або мобільний номер телефону) Покупця, що були зазначені в запрошенні;

Для фільтрації списку доступних запрошень можливо використовувати дод. параметри:

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

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

Headers

  

Authorization

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

Content-Type

application/json
RESPONSE

В тілі відповіді залежно від параметрів, що передаються може повертатись список усіх наявних запрошень (масив об’єктів XDistribexInvitation) чи конкретне запрошення (1 об’єкт XDistribexInvitation). Якщо в методі передавались параметри invitation_id + load_body=true, то у відповідь повертається pdf-вкладення до запрошення в base64 форматі.

Відправити запрошення Покупцю (ініціатор Продавець (Виробник)) POST /api/distribex/invitation

Повторне надсилання запрошення одному й тому ж Покупцю доступно один раз на 24 години

REQUEST

URL

 https://edo-v2.edin.ua

Метод запиту

POST

URL запиту

/api/distribex/invitation

URL параметри

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

buyer (обов’язково) String - контакт Покупця (email або мобільний номер телефону);

buyer_ipn (опціонально) String - ЄДРПОУ / ІПН Покупця

Headers

  

Authorization

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

Content-Type

multipart/form-data

REQUEST

  

Form-data

В запиті може передаватись (опціонально) тіло в форматі application/pdf - інформаційний лист, як вкладення до запрошення Покупця

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

-----------------------------339686098424586820212953841379
Content-Disposition: form-data; name="attachment"; filename="_pdf_meme.pdf"
Content-Type: application/pdf

(data)

-----------------------------339686098424586820212953841379--

URL

 https://edo-v2.edin.ua

Метод запиту

POST

URL запиту

/api/distribex/invitation

URL параметри

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

buyer (опціонально) String - контакт Покупця (email або мобільний номер телефону);

buyer_ipn (опціонально) String - ЄДРПОУ / ІПН Покупця

Headers

  

Authorization

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

Content-Type

multipart/form-data

REQUEST

  

Form-data

В запиті може передаватись кілька тіл:

  • одне з тіл у форматі application/pdf (опціонально) - інформаційний лист, як вкладення до запрошення Покупця;

  • для масового завантаження запрошень обов’язково одне з тіл в запиті має бути в форматі application/json, де передається список запрошених Покупців 

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

-----------------------------42215802802152663972618512251
Content-Disposition: form-data; name="json"; filename="json"
Content-Type: application/json

[{"buyerContact":"test@gmail.com","buyerIPN":"14360570"},{"buyerContact":"test2@gmail.com","buyerIPN":"14360570"}]
-----------------------------42215802802152663972618512251
Content-Disposition: form-data; name="file"; filename="_pdf_meme.pdf"
Content-Type: application/pdf

(data)

-----------------------------42215802802152663972618512251--
RESPONSE

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

Приклад відповіді:

{"done":[save@mail.com],"duplicates":["savep38075@adosnan.com"]}