Dodanie kategorii, metoda: /api/category/add/
Przykład:
№ | Pole | Typ | Opis | Obowiązkowe lub nie | Komentarz |
1 | login | string | Zaloguj się w systemie BOX | Pole obowiązkowe. | |
2 | password | string | Hasło w formacie md5 | Pole obowiązkowe. | Napisz do pomocy technicznej, a my przekażemy Ci hash dla API |
3 | name | string | Nazwa Kategorii | Pole obowiązkowe. | |
4 | code | string | id kategorie z Twojego systemu | Pole nie wymagane. | Jest to unikalny identyfikator kategorii z Twojego systemu (z Twojego sklepu). Jeśli istnieje kategoria o tym identyfikatorze, interfejs API zgłosi błąd |
5 | description | string | Opis kategorii | Pole nie wymagane. | |
6 | parentid | integer | id kategoria nadrzędna z naszego systemu | Pole nie wymagane. | W tym polu możesz wpisać kod kategorii nadrzędnej z naszego systemu. Jeżeli kategoria o tym kodzie nie istnieje, pole przyjmie wartość pustą. |
7 | image | array | Tablica obrazów kategorii | Pole nie wymagane. | Obrazy należy przesyłać w tablicy wskazującej pełną ścieżkę do nich. System współpracuje z następującymi formatami obrazów: jpg, png |
8 | hidden | boolean | ukryta kategoria | Pole nie wymagane. | Domyślnie kategoria nie jest ukryta (ukryta=0) |
9 | parentcode | string | code1c kategorie (identyfikator kategorii z Twojego systemu) | Pole nie wymagane. | W tym polu możesz wpisać kod kategorii nadrzędnej ze swojego systemu. Jeżeli kategoria o tym kodzie nie istnieje, pole przyjmie wartość pustą. |
Usuń kategorię, metoda: /api/category/delete/
Przykład:
№ | Pole | Typ | Opis | Obowiązkowe lub nie | Komentarz |
1 | login | string | Zaloguj się w systemie BOX | Pole obowiązkowe. | |
2 | password | string | Hasło w formacie md5 | Pole obowiązkowe. | Napisz do pomocy technicznej, a my przekażemy Ci hash dla API |
3 | id | integer | Identyfikator kategorii | Wymagany jest identyfikator kategorii lub kod | Kod kategorii w systemie BOX |
4 | code | string | Identyfikator kategorii | Identyfikator kategorii z Twojego systemu (ze sklepu) |
Edytowanie kategorii, metoda: /api/category/update/
Przykład:
№ | Pole | Typ | Opis | Obowiązkowe lub nie | Komentarz |
1 | login | string | Zaloguj się w systemie BOX | Pole obowiązkowe. | |
2 | password | string | Hasło w formacie md5 | Pole obowiązkowe. | Napisz do pomocy technicznej, a my przekażemy Ci hash dla API |
3 | id | integer | Identyfikator kategorii | Wymagany jest identyfikator kategorii lub kod | Kod kategorii w systemie BOX |
4 | code | string | Identyfikator kategorii | Identyfikator kategorii z Twojego systemu (ze sklepu) | |
5 | name | string | Nazwa Kategorii | Pole nie wymagane. | |
6 | description | string | Opis kategorii | Pole nie wymagane. | |
7 | parentid | string | id kategorię nadrzędną z systemu | Pole nie wymagane. | W tym polu możesz wpisać kod kategorii nadrzędnej ze swojego systemu. Jeżeli kategoria o tym kodzie nie istnieje, pole przyjmie wartość pustą. |
8 | image | array | Tablica obrazów kategorii | Pole nie wymagane. | Obrazy należy przesyłać w tablicy wskazującej pełną ścieżkę do nich. System współpracuje z następującymi formatami obrazów: jpg, png |
9 | hidden | boolean | ukryta kategoria | Pole nie wymagane. | Domyślnie kategoria nie jest ukryta (ukryta=0) |
10 | parentcode | string | code1c kategorie (identyfikator kategorii z Twojego systemu) | Pole nie wymagane. | W tym polu możesz wpisać kod kategorii nadrzędnej ze swojego systemu. Jeżeli kategoria o tym kodzie nie istnieje, pole przyjmie wartość pustą. |
Uzyskanie jednej kategorii i uzyskanie wszystkich kategorii metoda: /api/category/get/
Przykład:
№ | Pole | Typ | Opis | Obowiązkowe lub nie | Komentarz |
1 | login | string | Zaloguj się w systemie BOX | Pole obowiązkowe. | |
2 | password | string | Hasło w formacie md5 | Pole obowiązkowe. | Napisz do pomocy technicznej, a my przekażemy Ci hash dla API |
3 | id | integer | Identyfikator kategorii | Wymagany jest identyfikator kategorii lub kod | Jeżeli potrzebujesz konkretnej kategorii, to w tym polu podajesz albo identyfikator kategorii, który został Ci zwrócony przez nasze API podczas jej tworzenia. Lub określ zewnętrzny identyfikator kategorii (pole code podczas tworzenia kategorii) Silnik znajdzie tę kategorię i zwróci ją. Zwróć wartości pól id - id Kategorie, name - nazwa kategorii, code - zewnętrzny identyfikator kategorii, image - Tablica obrazów kategorii, description - Opis kategorii, parentid - id Kategoria nadrzędna, hidden - ukryta kategoria |
4 | code | string | Identyfikator kategorii |
Przykład:
№ | Pole | Typ | Opis | Obowiązkowe lub nie | Komentarz |
1 | login | string | Zaloguj się w systemie BOX | Pole obowiązkowe. | |
2 | password | string | Hasło w formacie md5 | Pole obowiązkowe. | Napisz do pomocy technicznej, a my przekażemy Ci hash dla API |
Zwróć wartości pól id - id Kategorie, name - nazwa kategorii, code - zewnętrzny identyfikator kategorii, image - Tablica obrazów kategorii, description - Opis kategorii, parentid - id Kategoria nadrzędna, hidden - ukryta kategoria |
Możliwe odpowiedzi na zapytanie
№ | Status | Wiadomość | Opis wiadomości |
1 | ok | categoryid | Zwraca identyfikator dodanej kategorii |
2 | fail | Login is empty! | Brak logowania |
3 | fail | Password is empty! | Brak hasła |
4 | fail | Category name is empty! | Brak nazwy kategorii |
5 | fail | Bad user level! | Niski poziom użytkownika, aby wykonać tę akcję (wymagany poziom 2 lub wyższy) |
6 | fail | Login or password not correct! | Login lub hasło wpisane niepoprawnie |
7 | fail | Category with this ID already exists! | Kategoria o tym samym identyfikatorze już istnieje |
8 | fail | Incorrect picture! | Nieprawidłowy format obrazu |
9 | fail | You don't available category for delete! | Nie wybrałeś kategorii do usunięcia |
10 | fail | Category with this ID does not exists! | Nie ma kategorii o tym identyfikatorze |
11 | fail | Category with this Code does not exists! | Nie ma kategorii z tym kodem |
12 | fail | You don't available category for update! | Nie wybrałeś kategorii do aktualizacji |
13 | fail | parentid = categoryid | id kategoria nadrzędna jest równa identyfikatorowi samej kategorii lub id kategorii nadrzędnej jest równy id dodawanej kategorii (pętla) |
14 | fail | Parentid is not corectly! | id kategoria nadrzędna jest nieprawidłowa |