Dodanie produktu metoda: /api/product/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 produktu | Pole obowiązkowe. | |
4 | description | string | Opis produktu | Pole nie wymagane. | |
5 | name+language_code | string | Nazwa produktu (w innych językach) | Pole nie wymagane. | Klucz musi być oznaczony dwuznakowym kodem innego języka, który jest podłączony w module wielojęzycznym, na przykład nameua, namen |
6 | description+language_code | string | Opis produktu (w innych językach) | Pole nie wymagane. | Klucz musi być oznaczony dwuznakowym kodem innego języka, który jest podłączony w module wielojęzycznym, na przykład opis, opis |
7 | price | decimal | cena produktu | Pole nie wymagane. | |
8 | pricebase | decimal | Bazowa cena produktu | Pole nie wymagane. | |
9 | currencyname | string | Nazwa waluty | Pole nie wymagane. | |
10 | categorycode | 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 |
11 | categoryid | integrer | id Kategorie | Pole nie wymagane. | Kod kategorii w systemie BOX. |
12 | brandname | string | Nazwa handlowa | Pole nie wymagane. | Jeśli takiej marki nie ma, silnik sam ją utworzy |
13 | articul | string | Kod produktu | Pole nie wymagane. | |
14 | unit | string | Jednostki | Pole nie wymagane. | |
15 | avail | boolean | Dostępność produktu | Pole nie wymagane. | Domyślnie produkt jest niedostępny (dostępność=0) |
16 | hidden | boolean | Ukryty produkt | Pole nie wymagane. | Domyślnie produkt nie jest ukryty (ukryty=0) |
17 | code1c | string | Kod produktu | Pole nie wymagane. | Identyfikator produktu z Twojego systemu (ze sklepu) |
18 | model | string | Model | Pole nie wymagane. | |
19 | seriesname | string | Asortyment produktów (seria, kolekcja) | Pole nie wymagane. | |
20 | imagegrouped | boolean | Użyj obrazu i karty jako głównego w asortymencie modeli | Pole nie wymagane. | |
21 | 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 |
22 | filter | array (filterid, filtervalue, filteractual, filteruse, filteroption) | Tablica filtrów dla produktu | Pole nie wymagane. |
filterid - id filtr do towarów z BOX
filtervalue - wartość filtra
filteractual - wyświetlenie wartości tej cechy w tabeli cech produktu. Domyślnie niedostępne (filteractual=0)
filteruse - dostęp do tego filtra podczas filtrowania. Domyślnie, niedostępne (filteruse=0)
filteroption - możliwość zamówienia tego produktu. Domyślnie nie (opcja filtra=0)
|
23 | prices | array (priceid, pricename, pricevalue) | Szereg dodatkowych cen produktu | Pole nie wymagane. |
priceid - id ceny towarów z BOX
pricename - nazwa ceny
pricevalue - wartość ceny
|
24 | divisibility | float | Kruszalność produktu | Pole nie wymagane. | Tutaj możesz wskazać kruchość produktu |
25 | priceold | decimal | Stara cena produktu | Pole nie wymagane. | |
26 | discount | integer | Rabat, % | Pole nie wymagane. | |
27 | taxvalue | float | Kwota podatku VAT | Pole nie wymagane. | |
28 | barcode | string | kod kreskowy | Pole nie wymagane. | |
29 | supplierName | string | Nazwa Dostawcy | Pole nie wymagane. | Lub nazwa lub identyfikator dostawcy musi znajdować się w żądaniu, jeśli chcesz zaktualizować informacje o dostawcy |
30 | supplierid | interger | id dostawca | Pole nie wymagane. | Lub nazwa lub identyfikator dostawcy musi znajdować się w żądaniu, jeśli chcesz zaktualizować informacje o dostawcy |
31 | suppliercode | string | Kod dostawcy produktu (artykuł) | Pole nie wymagane. | |
32 | suppliercode1c | string | Kod dostawcy produktu (artykuł) | Pole nie wymagane. | |
33 | supplierprice | float | Cena dostawcy | Pole nie wymagane. | |
34 | suppliercurrency | string | Waluta dostawcy | Pole nie wymagane. | (UAH lub RUB, USD lub EUR.... itp) |
35 | supplieravail | boolean | Dostępność dostawcy | Pole nie wymagane. | 1 - w magazynie, 0 - brak w magazynie |
36 | supplieravailtext | string | Tekst dotyczący dostępności dostawcy | Pole nie wymagane. | Tutaj możesz wskazać, ile danego produktu posiada dostawca lub tekst o dostępności |
37 | supplieractive | boolean | Działalność dostawców | Pole nie wymagane. | 1 - pozycja dostawcy jest aktywna, 0 - pozycja nie jest aktywna. Domyślnie stanowisko jest aktywne |
38 | supplierrrc | float | Cena dostawcy (ррц) | Pole nie wymagane. | |
39 | supplierrrccurrency | string | Waluta dostawcy (ррц) | Pole nie wymagane. | (UAH lub RUB, USD lub EUR.... itp) |
40 | suppliercurrent | boolean | Aktualny dostawca produktu | Pole nie wymagane. | 1 - ustawia dostawcę jako aktualnego dostawcę towaru |
41 | categories | string | Dodatkowe kategorie produktów | Pole nie wymagane. | productcategoryid1 - "Kategoria 1" productcategoryid2 - "Kategoria 2" productcategoryid3 - "Kategoria 3" productcategoryid4 - "Kategoria 4" productcategoryid5 - "Kategoria 5" productcategoryid6 - "Kategoria 6" |
42 | customfield_key | mixed | Dodatkowe pola produktowe | Pole nie wymagane. | Parametr należy przekazać: customfield_*klucz_dodatkowego_pola* |
Usuwanie produktu metoda: /api/product/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 | ID produktu | Wymagany jest identyfikator, kod lub artykuł produktu | Kod produktu w systemie BOX |
4 | code | string | ID produktu | Identyfikator produktu z Twojego systemu (ze sklepu) | |
5 | articul | string | Kod produktu | Artykuł produktowy z Twojego systemu (z Twojego sklepu) |
Edycja produktu, metoda: /api/product/update/
№ | 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 | ID produktu | Wymagany jest identyfikator, kod lub artykuł produktu | Kod produktu w systemie BOX |
4 | code | string | ID produktu | Identyfikator produktu z Twojego systemu (ze sklepu) | |
5 | articul | string | Kod produktu | Artykuł produktowy z Twojego systemu (z Twojego sklepu) | |
6 | name | string | Nazwa produktu | Pole obowiązkowe. | |
7 | description | string | Opis produktu | Pole nie wymagane. | |
9 | name+language_code | string | Nazwa produktu (w innych językach) | Pole nie wymagane. | Klucz musi być oznaczony dwuznakowym kodem innego języka, który jest podłączony w module wielojęzycznym, na przykład nameua, namen |
10 | description+language_code | string | Opis produktu (w innych językach) | Pole nie wymagane. | Klucz musi być oznaczony dwuznakowym kodem innego języka, który jest podłączony w module wielojęzycznym, na przykład opis, opis |
11 | price | decimal | cena produktu | Pole nie wymagane. | |
12 | pricebase | decimal | Bazowa cena produktu | Pole nie wymagane. | |
13 | currencyname | string | Nazwa waluty | Pole nie wymagane. | |
14 | categorycode | 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 |
15 | categoryid | integrer | id Kategorie | Pole nie wymagane. | Kod kategorii w systemie BOX. |
16 | brandname | string | Nazwa handlowa | Pole nie wymagane. | Jeśli takiej marki nie ma, silnik sam ją utworzy |
17 | unit | string | Jednostki | Pole nie wymagane. | |
18 | avail | boolean | Dostępność produktu | Pole nie wymagane. | Domyślnie produkt jest niedostępny (dostępność=0) |
19 | hidden | boolean | Ukryty produkt | Pole nie wymagane. | Domyślnie produkt nie jest ukryty (ukryty=0) |
20 | model | string | Zakres produktów | Pole nie wymagane. | |
21 | 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: gif, jpeg, png, pjpeg |
22 | filter | array (filterid, filtercode1c, filtervalue, filteractual, filteruse, filteroption) | Tablica filtrów dla produktu | Pole nie wymagane. |
filterid - id filtr do towarów z BOX
filtercode1c - Zewnętrzny identyfikator filtra dla produktu z BOX; jeżeli ten parametr występuje, filtr będzie wyszukiwany według niego, a nie według filteridu
filtervalue - wartość filtra
filteractual - wyświetlenie wartości tej cechy w tabeli cech produktu. Domyślnie niedostępne (filteractual=0)
filteruse - dostęp do tego filtra podczas filtrowania. Domyślnie, niedostępne (filteruse=0)
filteroption - możliwość zamówienia tego produktu. Domyślnie nie (opcja filtra=0)
|
23 | prices | array (priceid, pricename, pricevalue) | Szereg dodatkowych cen produktu | Pole nie wymagane. |
priceid - id ceny towarów z BOX
pricename - nazwa ceny
pricevalue - wartość ceny
|
24 | taxvalue | float | Kwota podatku VAT | Pole nie wymagane. | |
25 | barcode | string | kod kreskowy | Pole nie wymagane. | |
26 | storaged | integer | Ilość dostępnego artykułu | Pole nie wymagane. | |
27 | supplierName | string | Nazwa Dostawcy | Pole nie wymagane. | Lub nazwa lub identyfikator dostawcy musi znajdować się w żądaniu, jeśli chcesz zaktualizować informacje o dostawcy |
28 | supplierid | interger | id dostawca | Pole nie wymagane. | Lub nazwa lub identyfikator dostawcy musi znajdować się w żądaniu, jeśli chcesz zaktualizować informacje o dostawcy |
29 | suppliercode | string | Kod dostawcy produktu (artykuł) | Pole nie wymagane. | |
30 | suppliercode1c | string | Kod dostawcy produktu (artykuł) | Pole nie wymagane. | |
31 | supplierprice | float | Cena dostawcy | Pole nie wymagane. | |
32 | suppliercurrency | string | Waluta dostawcy | Pole nie wymagane. | (UAH lub RUB, USD lub EUR.... itp) |
33 | supplieravail | boolean | Dostępność dostawcy | Pole nie wymagane. | 1 - w magazynie, 0 - brak w magazynie |
34 | supplieravailtext | string | Tekst dotyczący dostępności dostawcy | Pole nie wymagane. | Tutaj możesz wskazać, ile danego produktu posiada dostawca lub tekst o dostępności |
35 | supplieractive | boolean | Działalność dostawców | Pole nie wymagane. | 1 - pozycja dostawcy jest aktywna, 0 - pozycja nie jest aktywna. Domyślnie stanowisko jest aktywne |
36 | supplierrrc | float | Cena dostawcy (ррц) | Pole nie wymagane. | |
37 | supplierrrccurrency | string | Waluta dostawcy (ррц) | Pole nie wymagane. | (UAH lub RUB, USD lub EUR.... itp) |
38 | suppliercurrent | boolean | Aktualny dostawca produktu | Pole nie wymagane. | 1 - ustawia dostawcę jako aktualnego dostawcę towaru |
39 | divisibility | float | Kruszalność produktu | Pole nie wymagane. | Tutaj możesz wskazać kruchość produktu |
40 | syncpricesup | boolean | Synchronizuj ceny z dostawcami i magazynami | Pole nie wymagane. | 1 - pozycja dostawcy jest aktywna, 0 - pozycja nie jest aktywna. Domyślnie stanowisko nie jest aktywne |
41 | syncavailsup | boolean | Synchronizuj dostępność z dostawcami i magazynami | Pole nie wymagane. | 0 - towary, które nie są zsynchronizowane pod względem dostępności z dostawcami i magazynami 1 - towary synchronizowane dostępnością z dostawcami i magazynami |
42 | priceold | decimal | Stara cena produktu | Pole nie wymagane. | |
43 | discount | integer | Rabat, % | Pole nie wymagane. | |
44 | categories | string | Dodatkowe kategorie produktów | Pole nie wymagane. | productcategoryid1 - "Kategoria 1" productcategoryid2 - "Kategoria 2" productcategoryid3 - "Kategoria 3" productcategoryid4 - "Kategoria 4" productcategoryid5 - "Kategoria 5" productcategoryid6 - "Kategoria 6" |
45 | customfield_key | mixed | Dodatkowe pola produktowe | Pole nie wymagane. | Parametr należy przekazać: customfield_*klucz_dodatkowego_pola* |
Odbiór jednej sztuki i odbiór wszystkich pozycji, metoda: /api/product/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 produktu w systemie BOX | Wymagany jest identyfikator, kod lub artykuł produktu | Zwróć wartości pól id - id dobra, name - Nazwa, description - opis, image - obraz produktu, price - cena produktu, currencyid - id waluty towarowe, categoryid - id kategorie w systemie BOX, brandid - id marka w systemie BOX, articul - artykuł produktowy, unit - jednostki, avail - Dostępność produktu, hidden - ukryte towary, code1c - id towary z Twojego systemu (ze Twojego sklepu), pricebase - cena bazowa produktu, supplierid - id dostawca w systemie BOX, model - zakres produktów, filterArray - szereg filtrów produktów, customfieldArray - dodatkowa tablica.pola produktowe, analogArray - szereg analogów produktów, relatedArray - szereg powiązanych produktów, storagedArray - szereg pozostałych towarów, additionalImagesArray - szereg dodatkowych zdjęć produktów, additionalFilesArray - szereg dodatkowych plików produktowych, cropimage - zmieniony rozmiar obrazu produktu |
4 | code | string | Identyfikator produktu z Twojego systemu (ze sklepu) | ||
5 | articul | string | Artykuł produktowy z Twojego systemu (z Twojego sklepu) | ||
6 | customfields | boolean | Wskaźnik konieczności przekazania dodatkowych pól | Pola nie wymagane | |
7 | related | boolean | Wskaźnik wskazujący, że powiązane produkty wymagają przeniesienia | ||
8 | analogs | boolean | Wskazanie na potrzebę transferu produktów analogowych | ||
9 | storagebalances | boolean | Wskaźnik konieczności przeniesienia resztek produktów | ||
10 | imageadditional | boolean | Wskazuje, że wymagane są dodatkowe zdjęcia produktu | ||
11 | filesadditional | boolean | Wskaźnik konieczności przesłania dodatkowych plików produktów | ||
12 | width | integer | Wskazanie na konieczność ustawienia rozmiaru (szerokości) zdjęć produktów | ||
13 | height | integer | Wskazanie na konieczność ustawienia rozmiaru (wysokości) zdjęć produktów |
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 produktu | Pole nie wymagane. | Podaj nazwę, a wybór obejmie produkty, które zawierają ten parametr w nazwie |
4 | categorycode | string | Kod kategorii z systemu zewnętrznego | Pole nie wymagane. | Określ kategorię, z której chcesz otrzymywać produkty |
5 | categoryid | string | Wewnętrzny kod kategorii | Pole nie wymagane. | Określ kategorię, z której chcesz otrzymywać produkty |
6 | brandname | string | Nazwa handlowa | Pole nie wymagane. | Podaj nazwę marki produktu, według której nastąpi filtrowanie |
7 | avail | boolean | Dostępność produktu | Pole nie wymagane. | Tylko pokaz: 0 - towar w magazynie 1 - brak produktów w magazynie |
8 | hidden | boolean | Produkt ukryty | Pole nie wymagane. | Tylko pokaz: 0 - żadnych ukrytych towarów 1 - ukryte towary |
9 | suppliered | boolean | Dostępne u dostawcy | Pole nie wymagane. | Tylko pokaz: 0 - towarów, których nie ma w magazynie u dostawcy 1 - towarów, które dostawca posiada na magazynie |
10 | syncpricesup | boolean | Synchronizuj ceny z dostawcami i magazynami | Pole nie wymagane. | Tylko pokaz: 0 - towary niezsynchronizowane cenowo z dostawcami i magazynami 1 - produkty zsynchronizowane cenowo z dostawcami i magazynami |
11 | syncavailsup | boolean | Synchronizuj dostępność z dostawcami i magazynami | Pole nie wymagane. | Tylko pokaz: 0 - towary, które nie są zsynchronizowane pod względem dostępności z dostawcami i magazynami 1 - produkty synchronizowane według dostępności z dostawcami i magazynami |
12 | customproduct_[key] | string | Dodatkowe pole produktu | Pole nie wymagane. | Otrzymuj produkty tylko z określoną wartością dodatkowego pola produktu. Przykład: customproduct_idkey=123 |
13 | part | integer | Część towaru | Pole obowiązkowe. |
API rozdaje do 1000 towarów w pierwszej części, aby otrzymać kolejne 1000 towarów w ramach transferu 2 (otrzymujesz część 2) i tak dalej. |
14 | customfields | boolean | Wskaźnik konieczności przekazania dodatkowych pól | Pola nie wymagane | |
15 | related | boolean | Wskaźnik wskazujący, że powiązane produkty wymagają przeniesienia | ||
16 | analogs | boolean | Wskazanie na potrzebę transferu produktów analogowych | ||
17 | storagebalances | boolean | Wskaźnik konieczności przeniesienia resztek produktów | ||
18 | imageadditional | boolean | Wskazuje, że wymagane są dodatkowe zdjęcia produktu | ||
19 | filesadditional | boolean | Wskaźnik konieczności przesłania dodatkowych plików produktów | ||
20 | width | integer | Wskazanie na konieczność ustawienia rozmiaru (szerokości) zdjęć produktów | ||
21 | height | integer | Wskazanie na konieczność ustawienia rozmiaru (wysokości) zdjęć produktów |
Możliwe odpowiedzi na zapytanie
№ | Status | Wiadomość | Opis wiadomości |
1 | ok | productid | Zwraca identyfikator dodanego/zmienionego produktu |
2 | fail | Login is empty! | Brak logowania |
3 | fail | Password is empty! | Brak hasła |
4 | fail | Product name is empty! | Brak nazwy produktu |
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 | Product with this Code1c exist! | Nie ma produktu z tym kodem |
8 | fail | Product with this Articul exist! | Nie ma produktu o tym numerze pozycji |
9 | fail | ID of category is not corectly! | id kategoria produktu jest nieprawidłowa |
10 | fail | 'Code of category is not corectly!' | Kod kategorii produktu jest nieprawidłowy |
11 | fail | You don't available product for delete! | Nie wybrałeś produktu do usunięcia |
12 | fail | Product with this ID does not exists! | Nie ma produktu o tym identyfikatorze |
13 | fail | Product with this Code does not exists! | Nie ma produktu z tym kodem |
14 | fail | Product with this Articul does not exists! | Nie ma produktu o tym numerze SKU |
15 | fail | Product with this Id does not found! | Nie znaleziono produktu o tym identyfikatorze |
16 | fail | Product with this Articul does not found! | Nie znaleziono produktu o tym numerze części |
17 | fail | Product with this Code does not found! | Nie znaleziono produktu z tym kodem |
18 | fail | Product name is empty! | Brak nazwy produktu |
19 | fail | You don't available product for update! | Nie wybrałeś produktu do aktualizacji |
20 | fail | Product not found by id/code1c/articul | Nie znaleziono produktu według identyfikatora/kodu/artykułu |
21 | fail | dublicate articul | Produkt o tym numerze SKU już istnieje |
22 | fail | dublicate code1c | Produkt z tym kodem już istnieje |