UAPAY - національний платіжний сервіс

Отримання даних по оголошенню


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

Запит

MethodGET
URL/ads/{{adId}}

Параметры запроса

ПолеОбов'яковістьТипОписПриклад
{{adId}}ТакStringID оголошення"A-D7ZL93Z"

Приклад:

GET /ads/A-D7ZL93Z

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

ПолеОпис
dataОб'єкт з відповіддю
data.idID оголошення
data.externalIdЗовнішній ID оголошення
data.sellerFirstNameІм'я продавця
data.sellerLastNameПрізвище продавця
data.sellerPatronymicПо батькові продавця
data.sellerPhoneНомер телефону продавця в форматі "380XXXXXXXXX"
data.sellerEmailЕлектронна пошта продавця
data.productTitleНазва товару
data.productDescriptionОпис товару
data.productPriceЦіна товару, в копійках
data.productWeightВага товару, в грамах
data.status

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

  • "NEW" - нове оголошення, початковий статус;
  • "CONFIRMED" - заповнене та підтверджене оголошення
data.handlersConfigsМасив можливих об'єктів з даними обробників для цього оголошення  
data.handlersConfigs[].{}.typeТип обробника, з допомогою якого буде виконуватися доставка товару
data.handlersConfigs[].{}.senderFirstNameІм'я відправника
data.handlersConfigs[].{}.senderLastNameПрізвище відправника
data.handlersConfigs[].{}.senderPatronymicПо батькові відправника
data.handlersConfigs[].{}.senderPhoneНомер телефону продавця в форматі "380XXXXXXXXX"
data.handlersConfigs[].{}.senderEmailЕлектронна пошта продавця
data.handlersConfigs[].{}.senderCityIdID міста в системі обраного обробника, з якого буде виконано відправлення
data.handlersConfigs[].{}.senderOfficeIdID відділення/офісу в системі обраного обробника, з якого буде виконано відправлення
data.handlersConfigs[].{}.paymentTypeТип платіжної системи, з допомогою якої буде проведена оплата за доставку товару
data.paymentsConfigsМасив можливих об'єктів з даними платежу за товар для цього оголошення
data.paymentsConfigs[].{}.typeТип платіжної системи, з допомогою якої буде проведена оплата за товар
data.paymentsConfigs[].{}.cardToIdТокен платіжної карти продавця в обраній платіжній системі, на яку будуть зараховані гроші після успішного завершення угоди  

Приклад:

{
    "data": {
        "id": "A-D7ZL93Z",
        "externalId": "myExternalId209081",
        "sellerFirstName": "Іван",
        "sellerLastName": "Іванов",
        "sellerPatronymic": "Іванович",
        "sellerPhone": "380123456789",
        "sellerEmail": "ivanov@mail.test",
        "productTitle": "Стіл",
        "productDescription": "Стіл дубовий, б/в",
        "productPrice": 100000,
        "productWeight": 15000,
        "status": "NEW",
        "handlersConfigs": [
            {
                "type": "NovaPoshta",
                "senderFirstName": "Іван",
                "senderLastName": "Іванов",
                "senderPatronymic": "Іванович",
                "senderPhone": "380987654321",
                "senderEmail": "ivanov@mail.test",
                "senderCityId": "8d5a980d-391c-11dd-90d9-001a92567626",
                "senderOfficeId": "7b2cc7fd-84ff-11e4-acce-0050568002cf",
                "paymentType": "ECOM"
            }
        ],
        "paymentsConfigs": [
            {
                "type": "P2P",
                "cardToId": "058a2fa1-8dee-4c39-8796-574cdc573530"
            }
        ]
    }
}

UAPAY - національний платіжний сервіс
pay@uapay.ua