Методът setShippingTrackingId¶
Методът позволява да добавите или обновите номера за проследяване на пощенската пратка в сделката. Когато посочвате номер на електронна товарителница, куриерската служба трябва да бъде свързана в интеграциите на R7K12CRM. Максималният брой входни данни е 100. Метод: POST Линк: https://api.r7k12.com/{{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.com/'.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 | Превишен е максималният брой входни данни |