Przejdź do treści

Metoda setShippingTrackingId

Metoda pozwala dodać lub zaktualizować numer śledzenia przesyłki pocztowej w transakcji. Przy podawaniu numeru listu przewozowego usługa dostawy musi być podłączona w integracjach R7K12CRM. Maksymalna liczba danych wejściowych — 100.  Metoda: POST Link: https://api.r7k12.com/{{TOKEN}}/R7K12Crm Parametry: Tabela nr 1 Dane wejściowe:

{

 "method": "setShippingTrackingId",

 "input": [

   {

     "dealId": (string),

     "type": (string),

     "shippingId": (string)

   },

   ...

 ]

}

Tabela nr 1

Parametr Typ Obowiązkowy Opis
method string Tak Wywoływana metoda. Zawsze „setShippingTrackingId”
input array[object] Tak Parametry wejściowe metody
input[index].dealId string Tak Identyfikator transakcji
input[index].type string Tak Identyfikator usługi dostawy, do której odnosi się numer śledzenia - „novaPoshta” - Nova Poshta
input[index].shippingId string Tak Numer śledzenia przesyłki pocztowej

Przykład żądania:

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);

Obsługa odpowiedzi:

{

 "success": true,

 "warning": [

   {

     "dealId": (string),

     "type": (syting),

     "shippingId": (string),

     "error": (string)

   }

 ]

}

Tabela nr 2

Parametr Typ Obowiązkowy Opis
success true Nie Flaga pomyślnego przetworzenia wszystkich przesłanych danych. Występuje tylko wtedy, gdy wszystkie dane zostały pomyślnie przetworzone
warning array[object] Nie Tablica nieprzetworzonych danych wejściowych
warning[index].dealId string Tak Identyfikator transakcji
warning[index].type string Tak Identyfikator usługi dostawy, do której odnosi się numer śledzenia - „novaPoshta” - Nova Poshta
warning[index].shippingId string Tak Numer śledzenia przesyłki pocztowej
warning[index].error string Tak Przyczyna, dla której dane nie zostały przetworzone: - 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

Błędy API

Format odpowiedzi:

{

 "error": {

   "code": (int),

   "error": (string),

   "error_detail": (string)

 }

}

Tabela nr 3

Kod Błąd Opis
-1 Nie udało się wykonać żądania Wystąpił wewnętrzny błąd API. Skontaktuj się z pomocą techniczną, podając requestId
20 Nieprawidłowy klucz dostępu
21 Nieprawidłowa metoda
22 Nieprawidłowy format danych
23 Nie podano wymaganych parametrów
24 Integracja z API nie jest podłączona
25 Błąd zapisu
26 Maksymalna liczba rekordów w żądaniu wynosi 100
27 Odstęp między żądaniami musi wynosić co najmniej 3 sekundy
28 Brak dostępu do wybranego projektu
29 Niewystarczające uprawnienia do wykonania tej metody
210 Do wykonania wybranej metody wymagany jest klucz dostępu użytkownika Należy uzyskać klucz zgodnie ze schematem OAUTH2
211 Token dostępu jest zablokowany Aby uzyskać więcej informacji, skontaktuj się z pomocą techniczną
212 Nie można równolegle wykonywać żądań z tymi samymi metodami Wybrana metoda API jest już używana w równoległym żądaniu dla podanego tokena
301 Invalid API Method Wywołano nieprawidłową metodę API R7K12 CRM
302 R7K12 CRM is not connected in the project R7K12 CRM nie jest podłączony w projekcie
303 Integration not connected in R7K12 CRM Integracja nie jest podłączona w R7K12 CRM
304 Incorrect input data Nieprawidłowe dane wejściowe
305 A lot of data Przekroczono maksymalną liczbę danych wejściowych