Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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

...

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

Запит

MethodGET
URL/deals/{{dealId}}

...

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

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

ПримерПриклад:

Code Block
languagejs
GET /deals/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 дня) или был отказ от сделки
  •  етап, на якому операція була оплачена, але продавець не встиг підтвердити свій термін (2 дні) або була відмова від угоди;
  • "CONFIRMED" -
 этап когда сделка была подтверждена, но продавец не успел отправить товар за отведенный срок(7 дней) или был отказ от сделки
  • етап, на якому угода була підтверджена, але продавець не встиг відправити товар за відведений термін (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
Ссылка на квитанцию завершения платежа
Пример
Посилання на квитанцію завершення платежу

Приклад:

Code Block
languagejs
{
    "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
        }
    }
}