Метод для получения данных отримання даних по сделке. Возвращает ключевую информацию по сделке, для понимания в каком состоянии она находиться, а так же информацию по обработчику и угоді. Повертає основну інформацію по угоді для розуміння, в якому стані вона знаходиться, а також дані по обробнику та по платежам за товар и за доставку товара обработчиком. На разных этапах сделки она имеет разную заполненность полей.
...
і доставку товару обробником. На різних етапах угоди вона має різну заповненість полів.
Запит
Method | GET |
URL | /deals/{{dealId}} |
...
Параметри запиту
ПолеОбязательное | Обов'язковість | Тип | ОписаниеОпис | ПримерПриклад |
---|---|---|---|---|
{{dealId}} | ДаТак | String | ID сделкиугоди | "L8M95ER" |
ПримерПриклад:
Code Block | ||
---|---|---|
| ||
GET /deals/L8M95ER |
Параметри відповіді
Поле | Описание |
---|---|
data |
Об'єкт з відповіддю | |
data.id | ID |
угоди |
data.externalId |
Зовнішній ID |
угоди | |
data.cartId | ID |
кошика |
data.productTitle |
Назва товару |
data.productPrice |
Ціна товару, в |
копійках |
data.productWeight |
Вага товару, в |
грамах |
data.handlerPrice |
Розрахована ціна доставки |
обробником, |
в копійках | |
data.status | Статус |
угоди, є завжди і відображає в якому стані в даний момент знаходиться угода. Може бути:
|
|
|
|
|
|
|
|
|
| |
data.reasonStep | Поле |
, яке вказує на якому етапі угода перейшла в статус "REJECTED" |
або"EXPIRED". |
Може бути:
|
|
|
|
data.sellerFirstName |
Ім'я продавця |
data.sellerLastName |
Прізвище продавця |
data.sellerPatronymic |
По батькові продавця | |
data.sellerPhone | Номер |
телефону продавця в |
форматі "380XXXXXXXXX" |
data.sellerEmail |
Електронна пошта продавця |
data.buyerFirstName |
Ім'я покупця |
data.buyerLastName |
Прізвище покупця |
data.buyerPatronymic |
По батькові покупця | |
data.buyerPhone | Номер |
телефону покупця в |
форматі "380XXXXXXXXX" |
data.buyerEmail |
Електронна пошта покупця |
data.lg |
Мова локалізації | |
data.createdAt | Дата |
створення угоди | |
data.adId | ID |
оголошення |
data.handler |
Об'єкт з даними обробника | |
data.handler.type | Тип |
обробника, з допомогою якого буде виконуватися доставка товару | |
data.handler.status | Статус |
обробника, є завжди і відображає стан обробника на даний момент. Може бути:
|
|
|
|
|
|
|
|
|
|
|
| |
data.handler.statusCode | Статус код |
обробника в системі обраного обробника |
data.handler.statusText |
Текстовий статус обробника в системі обраного обробника | |
data.handler.waybillNumber | Номер ТТН ( |
або щось подібне) в |
системі обраного обробника | |
data.handler.senderCityId | ID |
міста в системі обраного обробника, з якого буде/була виконана відправка |
data.handler.senderCityName |
Текстова назва міста в системі обраного обробника, з якого буде/була виконана відправка | |
data.handler.senderOfficeId | ID |
відділення/офісу в системі обраного обробника, з якого буде/була виконана відправка |
data.handler.senderOfficeName |
Текстова назва відділення/офісу в системі обраного обробника, з якого буде/була виконана відправка | |
data.handler.recipientCityId | ID |
міста в системі обраного обробника, в яке буде/була виконана відправка |
data.handler.recipientCityName |
Текстова назва міста в системі обраного обробника, в яке буде/була виконана відправка | |
data.handler.recipientOfficeId | ID |
відділення/офісу в системі обраного обробника, в яке буде/була виконана відправка |
data.handler.recipientOfficeName |
Текстова назва відділення/офісу в системі обраного обробника, в яке буде/була виконана відправка |
data.productPayment |
Об'єкт з даними платежу за товар | |
data.productPayment.type | Тип |
платіжної системи платежу | |
data.productPayment.id | ID |
платежу |
data.productPayment.amount |
Сума |
data.productPayment.commissionAmount |
Сума комісії платежу | |
data.productPayment.status | Статус |
платежу, є завжди і відображає стан платежу в даний момент. Може бути:
|
|
|
|
|
|
|
|
| |
data.productPayment.statusCode | Статус код |
платежу обраної платіжної системи |
data.productPayment.statusText |
Текстовий статус платежу обраної платіжної системи | |
data.productPayment.waitingFor | Статус |
означає, що платіж очікує певної дії. Може бути:
|
|
|
|
|
data.productPayment.details |
Об'єкт, який зберігає додаткову інформацію для платежу. Наприклад: об'єкт для проведення підтвердження платежу користувачем (details.confirmation) |
data.productPayment.payReceipt |
Посилання на квитанцію оплати платежу |
data.productPayment.reverseReceipt |
Посилання на квитанцію повернення платежу |
data.productPayment.finishReceipt |
Посилання на квитанцію завершення платежу |
data.handlerPayment |
Об'єкт з даними платежу за доставку | |
data.handlerPayment.type | Тип |
платіжної системи платежу | |
data.handlerPayment.id | ID |
платежу |
data.handlerPayment.amount |
Сума платежу |
data.handlerPayment.commissionAmount |
Сума комісії платежу | |
data.handlerPayment.status | Статус |
платежу, є завжди і відображає стан платежу в даний момент. Може бути:
|
|
|
|
|
|
|
|
| |
data.handlerPayment.statusCode | Статус код |
платежу обраної платіжної системи |
data.handlerPayment.statusText |
Текстовий статус платежу обраної платіжної системи | |
data.handlerPayment.waitingFor | Статус |
означає, що платіж очікує певної дії. Може бути:
|
|
|
|
|
data.handlerPayment.details |
Об'єкт, який зберігає додаткову інформацію для платежу. Наприклад: об'єкт для проведення підтвердження платежу користувачем(details.confirmation) |
data.handlerPayment.payReceipt |
Посилання на квитанцію оплати платежу |
data.handlerPayment.reverseReceipt |
Посилання на квитанцію повернення платежу |
data.handlerPayment.finishReceipt |
Посилання на квитанцію завершення платежу |
Приклад:
Code Block | ||
---|---|---|
| ||
{ "data": { "id": "L8M95ER", "externalId": "myExternalId537916", "cartId": 338, "productTitle": "СтолСтіл", "productPrice": 100000, "productWeight": 15000, "handlerPrice": null, "status": "NEW", "reasonStep": null, "buyerFirstName": "Петро", "buyerLastName": "Петров", "buyerPatronymic": "Петрович", "buyerPhone": "380987654321", "buyerEmail": "petrov@mail.test", "sellerFirstName": "ИванІван", "sellerLastName": "ИвановІванов", "sellerPatronymic": "ИвановичІванович", "sellerPhone": "380123456789", "sellerEmail": "ivanov@mail.test", "lg": "uk", "createdAt": "2018-10-08T09:18:45.000Z", "adId": null, "handler": { "status": "NEW", "statusCode": null, "statusText": null, "waybillNumber": null, "senderCityId": "8d5a980d-391c-11dd-90d9-001a92567626", "senderCityName": null, "senderOfficeId": "7b2cc7fd-84ff-11e4-acce-0050568002cf", "senderOfficeName": null, "recipientCityId": "8d5a980d-391c-11dd-90d9-001a92567626", "recipientCityName": null, "recipientOfficeId": "1ec09d88-e1c2-11e3-8c4a-0050568002cf", "recipientOfficeName": null, "type": "NovaPoshta" }, "productPayment": { "id": 594, "amount": null, "commissionAmount": null, "status": "NEW", "statusCode": null, "statusText": null, "type": "P2P", "waitingFor": null, "details": null, "payReceipt": null, "reverseReceipt": null, "finishReceipt": null }, "handlerPayment": { "id": 593, "amount": null, "commissionAmount": null, "status": "NEW", "statusCode": null, "statusText": null, "type": "ECOM", "waitingFor": null, "details": null, "payReceipt": null, "reverseReceipt": null, "finishReceipt": null } } } |