Отримання даних по угоді

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

Запит

MethodGET
URL/deals/{{dealId}}

Параметри запиту

ПолеОбов'язковістьТипОписПриклад
{{dealId}}ТакStringID угоди"L8M95ER"

Приклад:

Параметри відповіді

ПолеОписание
dataОб'єкт з відповіддю
data.idID угоди
data.externalIdЗовнішній ID угоди
data.cartIdID кошика
data.productTitleНазва товару
data.productPriceЦіна товару, в копійках
data.productWeightВага товару, в грамах
data.handlerPriceРозрахована ціна доставки обробником, в копійках
data.status

Статус угоди, є завжди і відображає в якому стані в даний момент знаходиться угода. Може бути:

  • "NEW" - нова угода, початковий статус;
  • "PAID" - угода оплачена;
  • "CONFIRMED" - угода підтверджена продавцем;
  • "SENT" - обробник повідомив про відправку товару;
  • "DELIVERED" - обробник повідомив про прибуття товару;
  • "FINISHED" - угода успішно завершена;
  • "REJECTED" - угода відхилена з  якої-небудь причини;
  • "EXPIRED" - угода прострочена на будь-якому етапі
data.reasonStep

Поле, яке вказує на якому етапі угода перейшла в статус "REJECTED" або"EXPIRED". Може бути:

  • "PAID" - етап, на якому операція була оплачена, але продавець не встиг підтвердити свій термін (2 дні) або була відмова від угоди;
  • "CONFIRMED" - етап, на якому угода була підтверджена, але продавець не встиг відправити товар за відведений термін (7 днів) або була відмова від угоди;
  • "DELIVERED" - етап, на якому товар прийшов, але покупець його не встиг забрати за відведений термін (у кожного обробника може бути свій термін) або відмовився від товару
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.adIdID оголошення
data.handlerОб'єкт з даними обробника
data.handler.typeТип обробника, з допомогою якого буде виконуватися доставка товару
data.handler.status

Статус обробника, є завжди і відображає стан обробника на даний момент. Може бути:

  • "NEW" - новий обробник, початковий статус;
  • "CREATED" - створена ТТН(або щось подібне), по якій буде відправлено товар;
  • "SENT" - товар відправлено;
  • "DELIVERED" - товар прибув;
  • "FINISHED" - покупець забрав товар;
  • "CANCELED" - ТТН (або щось подібне) відмінена чи видалена;
  • "REJECTED" - товар відхилено покупцем;
  • "EXPIRED" - перевищено термін очікування, для того щоб забрати товар
data.handler.statusCodeСтатус код обробника в системі  обраного обробника
data.handler.statusTextТекстовий статус обробника в системі обраного обробника
data.handler.waybillNumberНомер ТТН (або щось подібне) в системі обраного обробника
data.handler.senderCityIdID міста в системі обраного обробника, з якого буде/була виконана відправка
data.handler.senderCityNameТекстова назва міста в системі обраного обробника,  з якого буде/була виконана відправка
data.handler.senderOfficeIdID відділення/офісу в системі обраного обробника,  з якого буде/була виконана відправка
data.handler.senderOfficeNameТекстова назва відділення/офісу в системі обраного обробника,  з якого буде/була виконана відправка
data.handler.recipientCityIdID міста в системі обраного обробника,  в яке буде/була виконана відправка
data.handler.recipientCityNameТекстова назва міста  в системі обраного обробника,  в яке буде/була виконана відправка
data.handler.recipientOfficeIdID відділення/офісу  в системі обраного обробника,  в яке буде/була виконана відправка
data.handler.recipientOfficeNameТекстова назва відділення/офісу в системі обраного обробника,  в яке буде/була виконана відправка
data.productPaymentОб'єкт з даними платежу за товар
data.productPayment.typeТип платіжної системи платежу
data.productPayment.idID платежу
data.productPayment.amountСума
data.productPayment.commissionAmountСума комісії платежу
data.productPayment.status

Статус платежу, є завжди і відображає стан платежу в даний момент. Може бути:

  • "NEW" - новий платіж, початковий статус;
  • "PAID" - платіж оплачено покупцем, гроші знаходяться у платіжної системи;
  • "FINISHED" - платіж завершено, гроші зараховані продавцю;
  • "REVERSED" - платіж повернуто, гроші повернуті покупцю; 
  • "REJECTED" - платіж не проведено, помилка оплати
data.productPayment.statusCodeСтатус код платежу обраної платіжної системи
data.productPayment.statusTextТекстовий статус платежу обраної платіжної системи
data.productPayment.waitingFor

Статус означає, що платіж очікує певної дії. Може бути:

  • "PAY_PROCESSING" - платіж очікує поки платіжна система зробить оплату (переказ грошей платіжній системі);
  • "REVERSE_PROCESSING" -платіж очікує поки платіжна система зробить повернення (повернення грошей покупцеві);
  • "FINISH_PROCESSING" - платіж очікує поки платіжна система зробить завершення (переказ грошей продавцеві);
  • "CONFIRMATION" - платіж очікує підтвердження платежу покупцем, крок перед оплатою
data.productPayment.details

Об'єкт, який зберігає додаткову інформацію для платежу. Наприклад: об'єкт для проведення підтвердження платежу користувачем (details.confirmation)

data.productPayment.payReceiptПосилання на квитанцію оплати платежу
data.productPayment.reverseReceiptПосилання на квитанцію повернення платежу
data.productPayment.finishReceiptПосилання на квитанцію завершення платежу
data.handlerPaymentОб'єкт з даними платежу за доставку
data.handlerPayment.typeТип платіжної системи платежу
data.handlerPayment.idID платежу
data.handlerPayment.amountСума платежу
data.handlerPayment.commissionAmountСума комісії платежу
data.handlerPayment.status

Статус платежу, є завжди і відображає стан платежу в даний момент. Може бути:

  • "NEW" - новий платіж, початковий статус;
  • "PAID" - платіж оплачено покупцем, гроші знаходяться у платіжної системи;
  • "FINISHED" - платіж завершено, гроші зараховані обробнику;
  • "REVERSED" - платіж повернуто, гроші повернуті покупцеві; 
  • "REJECTED" - платіж не проведено, помилка оплати
data.handlerPayment.statusCodeСтатус код платежу обраної платіжної системи
data.handlerPayment.statusTextТекстовий статус платежу обраної платіжної системи
data.handlerPayment.waitingFor

Статус означає, що платіж очікує певної дії. Може бути:

  • "PAY_PROCESSING" - платіж очікує поки платіжна система виконає оплату (переказ грошей платіжній системі);
  • "REVERSE_PROCESSING" - платіж очікує поки платіжна система зробить повернення (повернення грошей покупцеві);
  • "FINISH_PROCESSING" - платіж очікує поки платіжна система зробить завершення (переказ грошей обробнику);
  • "CONFIRMATION" - платіж очікує підтвердження платежу покупцем, крок перед оплатою
data.handlerPayment.detailsОб'єкт, який зберігає додаткову інформацію для платежу. Наприклад: об'єкт для проведення підтвердження платежу користувачем(details.confirmation)
data.handlerPayment.payReceiptПосилання на квитанцію оплати платежу
data.handlerPayment.reverseReceiptПосилання на квитанцію повернення платежу
data.handlerPayment.finishReceiptПосилання на квитанцію завершення платежу

Приклад: