Документация »
add_recipient
URL
http://api.brain.com.ua/add_recipient/SID
HTTP Метод
POST
Описание
Метод для создания конечного клиента и адреса доставкиПараметры URL
| Название параметра | Обязательный параметр | Описание |
|---|---|---|
| SID | да | идентификатор сессии |
Параметры POST запроса
| Название параметра | Обязательный параметр | Описание |
|---|---|---|
| recipient_type | да | тип клиента: 1 - юрлицо, 0 - физлицо |
| name | да | ФИО получателя |
| legal_name | да (для юрлиц) | юр.название получателя |
| okpo | да (для юрлиц) | код ЕДРПОУ для юр.лица |
| vat_code | да (для юрлиц - плательщиков НДС) | код ИНН для юр.лица |
| non_payer_vat | нет (да - если не указан ИНН) | не плательщик НДС (0 - нет, 1 - да; по умолчанию 0) для юр.лица |
| legal_address | нет | юр.адрес для юр.лица |
| legal_phone | нет | номер телефона юр.лица в формате "0000000000" |
| phone_number | да | номер телефона получателя в формате "0000000000" |
| нет | адрес электронной почты | |
| delivery_type | да | вариант получения ("self" - склад, "home" - дверь) |
| delivery_service_code | да | код службы доставки |
| targetID | да (для варианта получения "склад") | идентификатор ПВ для варианта получения "склад" |
| cityID | да (для варианта получения "дверь") | идентификатор города для варианта получения "дверь" |
| streetID | да (для варианта получения "дверь") | идентификатор улицы для варианта получения "дверь" |
| building | да (для варианта получения "дверь") | номер дома |
| flat | нет | номер квартиры |
| floor | нет | этаж, только для Новой Почты |
| lift | нет | наличие лифта (0 - нет, 1 - есть), только для Новой Почты |
| comment | нет | комментарий для почтовой декларации |
Результат
Метод возвращает идентификаторы конечного клиента ("recipientID") и адреса доставки ("addressID").Пример
PHP код для отправки запроса с использованием CURL:
$url = "http://api.brain.com.ua/add_recipient/gpkavk4s0aciujg6m698gev040"; // URL адрес API с SID
$data = array(
"recipient_type" => 0,
"name" => "Іванов Іван Іванович",
"phone_number" => "0671234567",
"delivery_type" => "self",
"delivery_service_code" => "3",
"targetID" => "A1B23C45-6D78-90E1-FGH2-345678I9JKL0"
);
$ch = curl_init();
curl_setopt( $ch, CURLOPT_RETURNTRANSFER, true );
curl_setopt( $ch, CURLOPT_POST, 1 );
curl_setopt( $ch, CURLOPT_POSTFIELDS, $data );
curl_setopt( $ch, CURLOPT_URL, $url );
$result = curl_exec($ch); // JSON со статусом
Пример ответа
{
"status": 1,
"recipientID": 23,
"addressID": 456
}