Метод для создание сделки. Cделка создается со статусом "NEW", так же, если указаны данные по обработчику, то создаеться обработчик со статусом "NEW" и платеж за доставку со статусом "NEW", если указанные данные по платежу за товар, то создаеться платеж за товар со статусом "NEW". Обязательным, при создании, являеться только поле корзины, это позволяет обновлять сделку с помощью метода обновления сделки последующими итерациями и не указывать все необходимые данные сразу.
При указании объявления, такие поля как sellerFirstName, sellerLastName, sellerPatronymic, sellerPhone, sellerEmail, productTitle, productPrice, productWeight заполняються автоматически с полей объявления.
В сделке продавец не является обязательно отправителем, так же покупатель не являеться обязательно получателем.
Запрос
Method | POST |
URL | /deals |
Параметры запроса
Поле | Обязательное | Тип | Описание | Пример |
---|---|---|---|---|
externalId | Нет | String | Внешний ID, должен быть уникальным | "myExternalId537916" |
adId | Нет | String | ID объявления, объявления должно быть подтвержденно(статус - "CONFIRMED") | "A-D7ZL93Z" |
cartId | Да | Number | ID корзины | 338 |
cartExternalId | Да, если не указан cartId | String | Внешний ID корзины | "myExternalId478454" |
productTitle | Нет | String | Название товара | "Стол" |
productWeight | Нет | Number | Вес товара, в граммах, только целые числа, больше нуля | 15000 |
productPrice | Нет | Number | Цена товара в копейках, валюта - гривна, только целые числа, больше нуля | 100000 |
sellerFirstName | Нет | String | Имя продавца, только кириллические символы украинского и русского алфавита, а так же апостроф. Не разрешается повторение одного и того же символа более 2 раз | "Иван" |
sellerLastName | Нет | String | Фамилия продавца, только кириллические символы украинского и русского алфавита, а так же апостроф. Не разрешается повторение одного и того же символа более 2 раз | "Иванов" |
sellerPatronymic | Нет | String | Отчество продавца, только кириллические символы украинского и русского алфавита, а так же апостроф. Не разрешается повторение одного и того же символа более 2 раз | "Иванович" |
sellerPhone | Нет | String | Номер телефона продавца в формате "380XXXXXXXXX" | "380123456789" |
sellerEmail | Нет | String | Электронная почта продавца | "ivanov@mail.test" |
buyerFirstName | Нет | String | Имя покупателя, только кириллические символы украинского и русского алфавита, а так же апостроф. Не разрешается повторение одного и того же символа более 2 раз | "Петро" |
buyerLastName | Нет | String | Фамилия покупателя, только кириллические символы украинского и русского алфавита, а так же апостроф. Не разрешается повторение одного и того же символа более 2 раз | "Петров" |
buyerPatronymic | Нет | String | Отчество покупателя, только кириллические символы украинского и русского алфавита, а так же апостроф. Не разрешается повторение одного и того же символа более 2 раз | "Петрович" |
buyerPhone | Нет | String | Номер телефона покупателя в формате "380XXXXXXXXX" | "380987654321" |
buyerEmail | Нет | String | Электронная почта покупателя | "petrov@mail.test" |
payment | Нет | Object | Объект с данными платежа за товар | |
payment.type | Нет | String | Тип платежной системы с помощью которой будет производиться оплата товара | "P2P" |
payment.cardToId | Нет | String | Токен платежной карты продавца в выбранной платежной системе, куда будут зачислены деньги после успешной сделки | "b0be0af6-9c7e-4b62-bf16-9957b34549c9" |
handler | Нет | Object | Объект с данными обработчика | |
handler.type | Нет | String | Тип обработчика с помощью которого будет производиться доставка товара | "NovaPoshta" |
handler.senderFirstName | Нет | String | Имя отправителя, только кириллические символы украинского и русского алфавита, а так же апостроф. Не разрешается повторение одного и того же символа более 2 раз | "Иван" |
handler.senderLastName | Нет | String | Фамилия отправителя, только кириллические символы украинского и русского алфавита, а так же апостроф. Не разрешается повторение одного и того же символа более 2 раз | "Иванов" |
handler.senderPatronymic | Нет | String | Отчество отправителя, только кириллические символы украинского и русского алфавита, а так же апостроф. Не разрешается повторение одного и того же символа более 2 раз | "Иванович" |
handler.senderPhone | Нет | String | Номер телефона отправителя в формате "380XXXXXXXXX" | "380987654321" |
handler.senderEmail | Нет | String | Электронная почта отправителя | "ivanov@mail.test" |
handler.senderCityId | Нет | String | ID города в системе выбранного обработчика с которого будет осуществлена отправка | "8d5a980d-391c-11dd-90d9-001a92567626" |
handler.senderOfficeId | Нет | String | ID отделения/офиса в системе выбранного обработчика с которого будет осуществлена отправка | "7b2cc7fd-84ff-11e4-acce-0050568002cf" |
handler.recipientFirstName | Нет | String | Имя получателя, только кириллические символы украинского и русского алфавита, а так же апостроф. Не разрешается повторение одного и того же символа более 2 раз | "Петро" |
handler.recipientLastName | Нет | String | Фамилия получателя, только кириллические символы украинского и русского алфавита, а так же апостроф. Не разрешается повторение одного и того же символа более 2 раз | "Петров" |
handler.recipientPatronymic | Нет | String | Отчество получателя, только кириллические символы украинского и русского алфавита, а так же апостроф. Не разрешается повторение одного и того же символа более 2 раз | "Петрович" |
handler.recipientPhone | Нет | String | Номер телефона получателя в формате "380XXXXXXXXX" | "380987654321" |
handler.recipientEmail | Нет | String | Электронная почта получателя | "petrov@mail.test" |
handler.recipientCityId | Нет | String | ID города в системе выбранного обработчика в который будет осуществлена отправка | "8d5a980d-391c-11dd-90d9-001a92567626" |
handler.recipientOfficeId | Нет | String | ID отделения/офиса в системе выбранного обработчика в который будет осуществлена отправка | "1ec09d88-e1c2-11e3-8c4a-0050568002cf" |
Пример:
POST /deals
{ "externalId": "myExternalId537916", "adId": "A-D7ZL93Z", "cartId": 338, "productTitle": "Стол", "productWeight": 15000, "productPrice": 100000, "sellerFirstName": "Иван", "sellerLastName": "Иванов", "sellerPatronymic": "Иванович", "sellerPhone": "380123456789", "sellerEmail": "ivanov@mail.test", "buyerFirstName": "Петро", "buyerLastName": "Петров", "buyerPatronymic": "Петрович", "buyerPhone": "380987654321", "buyerEmail": "petrov@mail.test", "payment": { "type": "P2P", "cardToId": "058a2fa1-8dee-4c39-8796-574cdc573530" }, "handler": { "type": "NovaPoshta", "senderFirstName": "Иван", "senderLastName": "Иванов", "senderPatronymic": "Иванович", "senderPhone": "380987654321", "senderEmail": "ivanov@mail.test", "senderCityId": "8d5a980d-391c-11dd-90d9-001a92567626", "senderOfficeId": "7b2cc7fd-84ff-11e4-acce-0050568002cf", "recipientFirstName": "Петро", "recipientLastName": "Петров", "recipientPatronymic": "Петрович", "recipientPhone": "380987654321", "recipientEmail": "petrov@mail.test", "recipientCityId": "8d5a980d-391c-11dd-90d9-001a92567626", "recipientOfficeId": "1ec09d88-e1c2-11e3-8c4a-0050568002cf" } }
Параметры ответа
Поле | Описание |
---|---|
data | Объект с ответом |
data.id | ID сделки |
data.externalId | Внешний ID сделки |
Пример:
{ "data": { "id": "L8M95ER", "externalId": "myExternalId537916" } }