Skip to main content

Запрошення

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

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

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

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 - масив; список контактів, з якими вже утворений зв’язок;

  • duplicates - масив; список контактів, яким Ви вже відправляли запрошення протягом останніх 24 годин

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

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

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

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

Повторно відправити запрошення Покупцю

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

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 - масив; список контактів, з якими вже утворений зв’язок;

  • errors - масив; список контактів, яким Ви вже відправляли запрошення протягом останніх 24 годин.

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

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

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

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

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

 

No comments to display

Back to top
Entity Select