Метод setShippingTrackingId¶
Метод позволяет добавить или обновить номер отслеживания почтового отправления в сделке. При указании номера ЭН служба доставки должна быть подключена в интеграциях R7K12CRM. Максимальное количество вводных данных — 100. Метод: POST Ссылка: https://api.r7k12.ru/{{TOKEN}}/R7K12Crm Параметры: Таблица №1 Вводные данные:
{
"method": "setShippingTrackingId",
"input": [
{
"dealId": (string),
"type": (string),
"shippingId": (string)
},
...
]
}
Таблица №1
| Параметр | Тип | Обязательный | Описание |
| method | string | Да | Вызываемый метод. Всегда “setShippingTrackingId” |
| input | array[object] | Да | Входные параметры метода |
| input[index].dealId | string | Да | Идентификатор сделки |
| input[index].type | string | Да | Идентификатор службы доставки, к которой относится номер отслеживания - “novaPoshta” - Новая Почта |
| input[index].shippingId | string | Да | Номер отслеживания почтового отправления |
Пример запроса:
define('TOKEN','YOURTOKEN');
function POST ($request) {
$curl = curl_init();
curl_setopt($curl, CURLOPT_URL, 'https://api.r7k12.ru/'.TOKEN.'/R7K12Crm');
curl_setopt($curl, CURLOPT_RETURNTRANSFER,true);
curl_setopt($curl, CURLOPT_POST, true);
curl_setopt($curl, CURLOPT_POSTFIELDS, json_encode($request,JSON_UNESCAPED_UNICODE));
$out = curl_exec($curl);
curl_close($curl);
return json_decode($out,true);
}
$response = POST(
[
'method' => 'setShippingTrackingId' ,
'input' => [
[
'dealId' => '5e450c947e7c21254b42a942',
'fields' => 'novaPoshta',
'fields' => '1234567890',
]
]
]
);
print_r($response);
Обработка ответа:
{
"success": true,
"warning": [
{
"dealId": (string),
"type": (syting),
"shippingId": (string),
"error": (string)
}
]
}
Таблица №2
| Параметр | Тип | Обязательный | Описание |
| success | true | Нет | Флаг успешной обработки всех загруженных данных. Присутствует только в том случае если все данные были успешно обработаны |
| warning | array[object] | Нет | Массив необработанных входных данных |
| warning[index].dealId | string | Да | Идентификатор сделки |
| warning[index].type | string | Да | Идентификатор службы доставки, к которой относится номер отслеживания - “novaPoshta” - Новая Почта |
| warning[index].shippingId | string | Да | Номер отслеживания почтового отправления |
| warning[index].error | string | Да | Причина, по которой не обработаны данные: - Field "dealId": must be string (a-z0-9) - Deal not found - Incorrect field "shippingId" - Incorrect shipping system - The electronic invoice number "XXXXX" is already set on another deal - Shipping system is not enabled |
Ошибки API¶
Формат ответа:
{
"error": {
"code": (int),
"error": (string),
"error_detail": (string)
}
}
Таблица №3
| Код | Ошибка | Описание |
| -1 | Не удалось выполнить запрос | Произошла внутренняя ошибка API. Обратитесь в техническую поддержку с указанием requestId |
| 20 | Неверный ключ доступа | |
| 21 | Неверный метод | |
| 22 | Некорректный формат данных | |
| 23 | Не указаны обязательные параметры | |
| 24 | Интеграция с API не подключена | |
| 25 | Ошибка записи | |
| 26 | Максимальное количество записей в запросе 100 | |
| 27 | Интервал между запросами должен быть не менее 3 секунды | |
| 28 | Нет доступа к выбранному проекту | |
| 29 | Недостаточно прав для выполнения данного метода | |
| 210 | Для выполнения выбранного метода необходим ключ доступа пользователя | Необходимо получить ключ по схеме OAUTH2 |
| 211 | Токен доступа заблокирован | За дополнительной информацией обратитесь в техническую поддержку |
| 212 | Невозможно параллельное выполнение запросов с одинаковыми методами | Выбранный метод API уже используется в параллельном запросе по указанному токену |
| 301 | Invalid API Method | Вызван некорректный метод API R7K12 CRM |
| 302 | R7K12 CRM is not connected in the project | R7K12 CRM не подключена на проекте |
| 303 | Integration not connected in R7K12 CRM | Интеграция не подключена внутри R7K12 CRM |
| 304 | Incorrect input data | Некорректные входные данные |
| 305 | A lot of data | Превышено максимальное кол-во входных данных |