Метод для створення оголошення в системі Escrow Box. Оголошення створюється зі статусом "NEW". Оголошення, насамперед, - це предзаповнені поля для угоди. Також є можливість в оголошенні вказати кілька варіантів платіжних систем для оплати товару і декілька варіантів оброблювачів. Оголошення може використовуватися багато разів.
Запит
Method | POST |
URL | /ads |
Параметри запиту
Поле | Обов'язковість | Тип | Опис | Приклад |
---|---|---|---|---|
externalId | Ні | String | Зовнішній ID, має бути унікальним | "myExternalId209081" |
sellerFirstName | Ні | String | Ім'я продавця, лише кирилиця української та російської абетки, а також апостроф. Не дозволяється повторення одного і того самого символу більш ніж 2 рази підряд | "Іван" |
sellerLastName | Ні | String | Прізвище продавця, лише кирилиця української та російської абетки, а також апостроф. Не дозволяється повторення одного і того самого символу більш ніж 2 рази підряд | "Іванов" |
sellerPatronymic | Ні | String | По-батькові продавця, лише кирилиця української та російської абетки, а також апостроф. Не дозволяється повторення одного і того самого символу більш ніж 2 рази підряд | "Іванович" |
sellerEmail | Ні | String | Електронна пошта продавця | "ivanov@mail.test" |
sellerPhone | Ні | String | Номер телефону продавця в форматі "380XXXXXXXXX" | "380123456789" |
productTitle | Ні | String | Назва товару | "Стіл" |
productDescription | Ні | String | Опис товару | "Стіл дубовий, б/в" |
productPrice | Ні | Number | Ціна товару в копійках, валюта - гривня, лише цілі числа, більше нуля | 100000 |
productWeight | Ні | Number | Вага товару, в грамах, лише цілі числа, більше нуля | 15000 |
handlersConfigs | Ні | Array | Масив можливих об'єктів з даними обробника для цього оголошення | |
handlersConfigs[].{}.type | Ні | String | Тип обробника за допомогою якого буде проводитися доставка товару | "NovaPoshta" |
handlersConfigs[].{}.senderFirstName | Ні | String | Ім'я відправника, лише кирилиця української та російської абетки, а також апостроф. Не дозволяється повторення одного і того самого символу більш ніж 2 рази підряд | "Іван" |
handlersConfigs[].{}.senderLastName | Ні | String | Прізвище відправника, лише кирилиця української та російської абетки, а також апостроф. Не дозволяється повторення одного і того самого символу більш ніж 2 рази підряд | "Іванов" |
handlersConfigs[].{}.senderPatronymic | Ні | String | По-батькові відправника, лише кирилиця української та російської абетки, а також апостроф. Не дозволяється повторення одного і того самого символу більш ніж 2 рази підряд | "Іванович" |
handlersConfigs[].{}.senderPhone | Ні | String | Номер телефону відправника в форматі "380XXXXXXXXX" | "380123456789" |
handlersConfigs[].{}.senderEmail | Ні | String | Електронна пошта відправника | "ivanov@mail.test" |
handlersConfigs[].{}.senderCityId | Ні | String | ID міста в системі обраного обробника, з якогого буде виконана відправка | "8d5a980d-391c-11dd-90d9-001a92567626" |
handlersConfigs[].{}.senderOfficeId | Ні | String | ID відділення/офісу в системі обраного обробника, з якого буде виконана відправка | "7b2cc7fd-84ff-11e4-acce-0050568002cf" |
paymentsConfigs | Ні | Array | Масив можливих об'єктів з даними платежу за товар для цього оголошення | |
paymentsConfigs[].{}.type | Ні | String | Тип платіжної системи, за допомогою якої буде проводитися оплата товару | "P2P" |
paymentsConfigs[].{}.cardToId | Ні | String | Токен платіжної картки продавця в обраній платіжній системі, на яку будуть зараховані гроші після успішної операції | "058a2fa1-8dee-4c39-8796-574cdc573530" |
Приклад:
POST /ads
{ "externalId": "myExternalId209081", "sellerFirstName": "Іван", "sellerLastName": "Іванов", "sellerPatronymic": "Іванович", "sellerPhone": "380123456789", "sellerEmail": "ivanov@mail.test", "productTitle": "Стіл", "productDescription": "Стіл дубовий, б/в", "productPrice": 100000, "productWeight": 15000, "handlersConfigs": [ { "type": "NovaPoshta", "senderFirstName": "Іван", "senderLastName": "Іванов", "senderPatronymic": "Іванович", "senderPhone": "380987654321", "senderEmail": "ivanov@mail.test", "senderCityId": "8d5a980d-391c-11dd-90d9-001a92567626", "senderOfficeId": "7b2cc7fd-84ff-11e4-acce-0050568002cf" } ], "paymentsConfigs": [ { "type": "P2P", "cardToId": "058a2fa1-8dee-4c39-8796-574cdc573530" } ] }
Параметри відповіді
Поле | Опис |
---|---|
data | Об'єкт з відповіддю |
data.id | ID оголошення |
data.externalId | Зовнішній ID оголошення |
data.url | URL на угоду в системі Escrow Box |
Приклад:
{ "data": { "id": "A-D7ZL93Z", "externalId": "myExternalId209081", "url": "https://escrowbox.demo.uapay.ua/ads/A-D7ZL93Z" } }