getCourierFields
Metoda umożliwia pobranie pól formularza do nadawania przesyłek dla wybranego kuriera.
Parametry wejściowe
Dane wyjściowe:
Przykładowe wywołanie w php:
| courier_code | varchar(20) | Kod kuriera |
Dane wyjściowe
Metoda zwraca dane w formacie JSON.
| status | varchar(30) | SUCCESS - poprawnie wykonano zapytanie ERROR - wystąpił bład podczas zapytania API. Szczegóły błedu opisane będą w 2 dodatkowych zwracanych polach: error_message i error_code |
| multi_packages | bool | Czy kurier obsługuje kilka przesyłek (0/1). |
| fields | array | Tablica z listą pól do nadania przesyłki zawierająca pola wymienione poniżej. |
| | - id | varchar(50) | Id pola |
| | - name | varchar(50) | Nazwa pola |
| | - type | varchar(10) | Typ pola(dostępne select, checkbox, text, date) |
| | - desc | text | Dodatkowy opis pola |
| | - options | array | Lista dostępnych opcji (występuje dla select, checkbox). Kluczem każdego elementu jest id opcji (varchar) Wartością jest nazwa opcji (varchar) |
| | - show_field | array | Lista pól dodatkowych które są dostępne dla wybranej opcji. Kluczem każdego elementu jest (varchar) - id opcji dla której mają być dostępne dodatkowe pola (varchar) Wartością jest lista pól które są dostępne dla tej opcji (array) |
| | - value | varchar(50) | Domyślna wartość dla danego pola |
| | - function | varchar(20) | Jeżeli ta wartość nie jest pusta oznacza to że pole ma dynamiczne opcje i aby pobrać aktualne opcje do konkretnego zamówienia należy odpytać zapytaniem getCourierServices |
Przykład
Dane wejściowe:Dane wyjściowe:
Przykładowe wywołanie w php:
Dokumentacja API