DOKUMENTACJA TECHNICZNA USŁUGI API ver. 1.27

Transkrypt

1 RedCart.pl ul. wrocławska Wałbrzych Polska DOKUMENTACJA TECHNICZNA USŁUGI API ver Infolinia: pn-pt: połączenie wg stawki operatora 1

2 Spis treści 1.Historia dokumentacji Opis usługi API Wprowadzenie Sposób przekazywania danych Moduł testowy 'hello' Moduły i metody products customers customersAddress orders ordersToProducts categories productsToCategories productsOptions productsOptionsValues productsToOptions producers ordersToOptions gallery ordersStatus productsTemplates productsTemplatesValues productsToTemplates inventoryOptions Units Deliverers Tax Allegro Auctions Details Allegro Auctions Inventories Komunikaty błędów TABELE Products moduł: 'products' Customers moduł: 'customers' Customers Address moduł: 'customersaddress' Orders moduł: 'orders' Orders To Products moduł: 'orderstoproducts' Categories moduł: 'categories' Products To Categories moduł: 'productstocategories' Products Options moduł: 'productsoptions' Products Options Values moduł: 'productsoptionsvalues' Products To Options moduł: 'productstooptions' Producers moduł: 'producers' Orders To Options moduł: 'orderstooptions' Gallery moduł: 'gallery' Orders Status moduł: 'ordersstatus' Products Templates moduł: 'productstemplates' Products Templates Values moduł: 'productstemplatesvalues'

3 6.17. Products To Templates moduł: 'productstotemplates' Inventory Options moduł: 'inventoryoptions' Units moduł: 'units' Deliverers moduł: 'deliverers' Tax moduł: 'tax' Allegro auctions details moduł: 'allegroauctionsdetails' Allegro auctions moduł: 'allegroauctions' Inventories moduł: 'inventories' Błędy Przykłady PHP Python wysyłanie danych json Historia dokumentacji Data modyfikacji Wersja Opis zmian osoba Dodanie waluty i kursu walut do zamówień currency_name, currency_value Dodanie filtra do zamówień: identyfikator statusu zamówienia orders_status_id Łukasz Bartoszewicz Dodanie kodu EAN do metody inventoryoptions Łukasz Bartoszewicz Nowy kod błędu E_PACK_PRODUCTS_LIMIT Grabowski Dominik Dodany moduł Inventories, Dodane przy produkcie pole quantity_all Dodana obsługa magazynów dla modułów products i inventoryoptions Grabowski Dominik Dodany moduł AllegroAuctions Grabowski Dominik Dodany moduł AllegroAuctionsDetails Grabowski Dominik Dodanie pole w Products - currency Grabowski Dominik Dodanie pole w Orders - payments_add Grabowski Dominik Dodanie pole w Products - promotions_type Grabowski Dominik Dodanie pole w Orders - aid Grabowski Dominik Dodanie modułu Tax Grabowski Dominik Poprawki w tabeli Products Grabowski Dominik Możliwość dodawania zdjęć do producentów Grabowski Dominik Dodanie modułu dostawców Grabowski Dominik Dodany komunikat błędu E_PACK_CONNECTION_LIMIT Grabowski Dominik Dodanie producers_code do produktu Grabowski Dominik Zwiększenie limitu ilości przesyłanych elementów do 200 Dodanie obsługi gwarancji i długości czasu realizacji zamówienia do produktu Dodanie modułu Units Nowa metoda products/updatestatustodate Nowy kod błędu E_PACK Nowa opcja fromdate dla select z modułu 'orders' Nowe kody błędów E_INPUT_UNKNOWN, E_INPUT_JSON Dodanie modułu 'hello' do testów Dodane zabezpieczenie przed dodawaniem tych samych obrazków do produktów w module 'gallery' Dodanie możliwości przesyłania danych w formacie json Przykłady w PHP i python Grabowski Dominik Grabowski Dominik Grabowski Dominik Grabowski Dominik 3

4 Data modyfikacji Wersja Opis zmian osoba Dodanie możliwości przypisania produktów do szablonów Dodanie możliwości przypisywania magazynu opcji do produktów Zmiana wymaganych pól w metodzie delete w productstooptions Dodanie obsługi statusów zamówień Dodanie obsługi tworzenia szablonów Dodanie obsługi galerii do produktów Dodatkowe pola w zamówieniach Dodanie obsługi producentów Dodanie obsługi opcji dla zamówień Dodanie dodatkowych pól dla zamówień Grabowski Dominik Grabowski Dominik Grabowski Dominik Grabowski Dominik Dodanie obsługi opcji Grabowski Dominik Dodanie adresu https, Metody add nie wszystkie zwracają tablice id dodanych rekordów Metoda categories/select i categories/selectids zwraca dodatkowo ścieżkę kategorii Dodany komunikat błędu: E_CONNECTION_LIMIT, Dodane moduły: categories i productstocategories Grabowski Dominik Grabowski Dominik Utworzenie dokumentacji Grabowski Dominik, Kot Wojciech 2. Opis usługi API Usługa pozwalająca na wymianę danych ze sklepem bez pośrednictwa interfejsu. Usługa jest przeznaczona dla programistów. 3. Wprowadzenie 3.1. Sposób przekazywania danych Adres usługi: lub Wszystkie wywołania muszą być przekazane poprzez metodę POST jako tablica lub jsonem. Aby przekazać dane jsonem należy dodać parametr w adresie input=json np. a dane należy przekazać w zmiennej 'json'. Dane są zwracane zawsze jako tablica array. Zarówno dane zwracane jak i wysyłane ograniczone są do 200 elementów i są indeksowane od 0. Każde wywołanie powinno zawierać następujące dane pola: key string, wymagane unikalny klucz przypisany dla każdego sklepu, dostępny po uprzednim kontakcie z obsługą klienta z panelu administratora: Marketing->Integracje->Serwisy Zewnętrzne->Subiekt->Klucz API np. aa3455xx43x5654gs2a3ga5fs5gaasla viewtype string, domyślnie: 'json' typ zwracanych danych 4

5 dostępne: 'json' np. 'json' module string, wymagane nazwa modułu np. 'products' method string, wymagane nazwa metody np. 'count' parameters array tablica parametrów pól bazy danych np. array'products_id' => 100, 'products_name' => 'Pralka J23' options array tablica opcji dodatkowe opcje do wywołań np. array'limit' => Moduł testowy 'hello' Moduł przeznaczony do testowania zapytań. Metody hello Zwraca podane w parametrze imięjeśli je podałeś oraz request name - imię 'module' => 'hello', 'method' => 'hello', [parameters] => stdclass Object [name] => 'RED CART' ; [hello] => RED CART [request] => stdclass Object 5

6 [key] => xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx [viewtype] => json [module] => hello [method] => hello [parameters] => stdclass Object [name] => RED CART 4. Moduły i metody 4.1. products Moduł do operacji na produktach. Metody count Zwraca ilość rekordów w bazie danych. - 'module' => 'products', 'method' => 'count', ; [count] => selectids Zwraca rekordy o podanych w parametrze identyfikatorach. 'products_id' tablica identyfikatorów 'module' => 'products', 6

7 'method' => 'selectids', 'products_id' => array7461, 10, 5019 ; 'count' ilość zwróconych rekordów 'products' tablica zawierająca informacje o produkcie [count] => 1 [products] => Array [0] => stdclass Object [products_id] => 7461 [products_name] => Kuchnia AEG E M M-MN [products_description_short] => Kuchnia [products_description] => E M M-MN Dane techniczne: piekarnik: 7 rodzajów [products_price] => [products_price_brutto] => [promotions_price] => 0.00 [promotions_price_brutto] => 0.00 [promotions_date_from] => [promotions_date_to] => :00:00 [products_model] => E M [ean] => [deliverer_code] => [products_status] => 1 [tax_value] => 1.23 [quantity] => 0 [fk_symbol] => select Zwraca rekordy wg zadanego filtra w parametrach lub wszystkie. tablica wg tabeli Products opcje: 'offset' odstęp pobieranych danych z bazy 7

8 'limit' ilość pobieranych danych z bazy 'module' => 'products', 'method' => 'select', array 'products_price' => 0, 'tax_value' => 1.23, 'options' => array 'offset' => 10, 'limit' => 3 ; 'count' ilość zwróconych rekordów 'products' tablica zawierająca informacje o produkcie jak dla selectids add Dodanie nowych rekordów do bazy. tablice wg tabeli Products opcje: 'inventory' dot. wszystkich dodawanych produktów, dozwolone wartości: 1 - kontrola stanu magazynowego 2 - produkt w ciągłej sprzedaży 3 - kontrola stanu magazynowego z prezentacją produktów niedostępnych 'inventories_id' id magazynu wg modułu 'inventories' 'module' => 'products', 'method' => 'add', 8

9 ;, array, 'products_name' => 'Pralka', 'products_description' => 'Nowa pralka', 'products_price' => , array 'products_name' => 'Telewizor', 'products_description' => 'Nowy telewizor', 'products_price' => , 'count' ilość przetworzonych rekordów update [count] => 1 [products_id] => Array [0] => Aktualizacja rekordów znajdujących się w bazie danych. Tablice rekordów muszą zawierać te same pola. Uwaga: Nie można aktualizować identyfikatora produktu. opcje: tablice wg tabeli Products 'inventories_id' id magazynu wg modułu 'inventories' 'module' => 'products', 'method' => 'update', array, 'products_name' => 'Nowa nazwa ', 'products_price' => 123, 'products_id' => 17873, array 'products_name' => 'Nowa nazwa2', 9

10 'products_price' => 321, 'products_id' => 17872, ; 'count' ilość przetworzonych rekordów [count] => 2 delete Usuwanie rekordów z bazy danych. products_id tablica identyfikatorów produktów do usunięcia 'module' => 'products', 'method' => 'delete', 'products_id' => array5019, 10 ; 'count' ilość przetworzonych rekordów [count] => 7 updatestatustodate Zmienia statusy produktów do zadanej daty products_status status produktu date_edit produkty ze wcześniejszą datą edycji zostaną zaktualizowane 10

11 'module' => 'products', 'method' => 'updatestatustodate', array 'products_status' => 0, 'date_edit' => ' :00:00' ; 'count' ilość przetworzonych rekordów [count] => customers Moduł do operacji na klientach. Metody count Zwraca ilość rekordów w bazie danych. - 'module' => 'customers', 'method' => 'count', ; [count] => 1234 selectids Zwraca rekordy o podanych w parametrze identyfikatorach. 'customers_id' tablica identyfikatorów klientów 11

12 'module' => 'customers', 'method' => 'selectids', 'customers_id' => array1, 2, 3 ; 'count' ilość zwróconych rekordów 'customers' tablica zawierająca informacje o klientach [count] => 2 [customers] => Array [0] => stdclass Object [customers_id] => 1 [customers_ ] => xxx@xxx.com [customers_phone] => [1] => stdclass Object [customers_id] => 5 [customers_ ] => yyy@yyy.com [customers_phone] => select Zwraca rekordy wg zadanego filtra w parametrach lub wszystkie. tablica wg tabeli Customers opcje: 'offset' odstęp pobieranych danych z bazy 'limit' ilość pobieranych danych z bazy 12

13 'module' => 'customers', 'method' => 'select', array 'customers_phone' => '123456', 'options' => array 'offset' => 10, 'limit' => 3 ; 'count' ilość zwróconych rekordów 'customers' tablica zawierająca informacje o klientach jak dla selectids add Dodanie nowych rekordów do bazy. tablice wg tabeli Customers 'module' => 'customers', 'method' => 'add', array 'customers_ ' => 'xxx@xxx.pl', 'customers_phone' => '12345',, array 'customers_ ' => 'yyy@yyy.pl', 'customers_phone' => '54321',,, ; 13

14 'count' ilość przetworzonych rekordów [count] => 11 [customers_id] => Array [0] => 11 [1] =>... update Aktualizacja rekordów znajdujących się w bazie danych. Tablice rekordów muszą zawierać te same pola. Uwaga: Nie można aktualizować identyfikatora klienta. tablice wg tabeli Customers 'module' => 'customers', 'method' => 'update', array 'customers_ ' => 'xxx@xxx.pl', 'customers_phone' => '12345', 'customers_id' => 1, array 'customers_ ' => 'yyy@yyy.pl', 'customers_phone' => '54321', 'customers_id' => 5, ; 'count' ilość przetworzonych rekordów [count] => 2 14

15 delete Usuwanie rekordów z bazy danych. Parametry: customers_id tablica identyfikatorów klientów do usunięcia 'module' => 'customers', 'method' => 'delete', 'customers_id' => array10 ; 'count' ilość przetworzonych rekordów [count] => customersaddress Moduł do operacji na adresach klientów. Metody count Zwraca ilość rekordów w bazie danych. - 'module' => 'customersaddress', 'method' => 'count', ; 15

16 [count] => 55 selectids Zwraca rekordy o podanych w parametrze identyfikatorach. 'customers_address_id' tablica identyfikatorów adresów klientów 'module' => 'customersaddress', 'method' => 'selectids', 'customers_address_id' => array1, 2, 3 ; 'count' ilość zwróconych rekordów 'customers_addresses' tablica zawierająca informacje o klientach [count] => 1 [customers_addresses] => Array [0] => stdclass Object [customers_address_id] => 1 [customers_id] => 1 [customers_first_name] => Jan [customers_last_name] => Kowalski [customers_street] => Uliczna [customers_home] => 123 [customers_zip_code] => [customers_city] => Wrocław [customers_countries] => PL select Zwraca rekordy wg zadanego filtra w parametrach lub wszystkie. 16

17 tablica wg tabeli Customers Address opcje: 'offset' odstęp pobieranych danych z bazy 'limit' ilość pobieranych danych z bazy 'module' => 'customersaddress', 'method' => 'select', array [customers_last_name] => Kowalski, 'options' => array 'offset' => 1, 'limit' => 3 ; 'count' ilość zwróconych rekordów 'customers_address' tablica zawierająca informacje o adresach klientów jak dla selectids add Dodanie nowych rekordów do bazy. tablice wg tabeli Customers Address 'module' => 'customersaddress', 'method' => 'add', array 'customers_id' => 1, 17

18 'customers_first_name' => 'Jan', 'customers_last_name' => 'Kowalski', 'customers_street' => 'Testowa', 'customers_home' => '12/11', 'customers_zip_code' => '55-555', 'customers_city' => 'Wrocław', 'customers_countries' => 'PL',, ; 'count' ilość przetworzonych rekordów [count] => 1 [customers_address_id] => Array [0] => 565 update Aktualizacja rekordów znajdujących się w bazie danych. Tablice rekordów muszą zawierać te same pola. Uwaga: Nie można aktualizować identyfikatora adresu klienta. tablice wg tabeli Customers Address 'module' => 'customersaddress', 'method' => 'update', array 'customers_address_id' => 1, 'customers_first_name' => 'Jan', 'customers_last_name' => 'Kowalski',, array 'customers_address_id' => 2, 'customers_first_name' => 'Janina', 'customers_last_name' => 'Kowalska', 18

19 , ; 'count' ilość przetworzonych rekordów [count] => 2 delete Usuwanie rekordów z bazy danych. Parametry: customers_address_id tablica identyfikatorów adresów klientów do usunięcia 'module' => 'customersaddress', 'method' => 'delete', 'customers_address_id' => array55, 12 ; 'count' ilość przetworzonych rekordów [count] => orders Moduł do operacji na zamówieniach. Metody count Zwraca ilość rekordów w bazie danych. - 19

20 'module' => 'orders', 'method' => 'count', ; [count] => 12 selectids Zwraca rekordy o podanych w parametrze identyfikatorach. 'orders_id' tablica identyfikatorów zamówień 'module' => 'orders', 'method' => 'selectids', 'orders_id' => array55, 77 ; 'count' ilość zwróconych rekordów 'orders' tablica zawierająca informacje o zamówieniach [count] => 1 [orders] => Array [0] => stdclass Object [orders_id] => 1 [customers_id] => 1 [orders_subtotal] => [orders_total] => [orders_discount_value] => 0.00 [orders_discount_percent] => 0.00 [customers_first_name] => Jan [customers_last_name] => Kowalski [customers_countries] => PL 20

21 [customers_zip_code] => [customers_city] => Wrocław [customers_street] => Testowa [customers_home] => 123 [customers_phone] => [customers_gg] => 0 [customers_mail] => xxx@xxx.com [customers_firms] => [i_customers_firms] => [i_customers_nip] => [i_customers_city] => [i_customers_zip_code] => [i_customers_street] => [i_customers_home] => [currency_name]=>eur [currency_value]=> select Zwraca rekordy wg zadanego filtra w parametrach lub wszystkie. tablica wg tabeli Orders opcje: 'offset' odstęp pobieranych danych z bazy 'limit' ilość pobieranych danych z bazy 'fromdate' wyświetla zamówienia od zadanej daty daty wg pola orders_date 'module' => 'orders', 'method' => 'select', array [customers_id] => 1, 'options' => array 'offset' => 1, 'limit' => 50, 'fromdate' => ' :00:00', 21

22 orders_status_id =>3 ; 'count' ilość zwróconych rekordów 'orders' tablica zawierająca informacje o zamówieniach jak dla selectids add Dodanie nowych rekordów do bazy. tablice wg tabeli Orders 'module' => 'orders', 'method' => 'add', array 'customers_id' => 2, 'orders_subtotal' => 10.00, 'orders_total' => 12.30, 'orders_discount_value' => 0, 'orders_discount_percent' => 0, 'customers_first_name' => 'Mariusz', 'customers_last_name' => 'Przykładowy', 'customers_countries' => 'PL', 'customers_zip_code' => '55-555', 'customers_city' => 'Wrocław', 'customers_street' => 'Testowa', 'customers_home' => '11/7', 'customers_phone' => '456123', 'customers_gg' => '8889', 'customers_mail' => 'xxx@xxx.pl', 'customers_firms' => 'Testowa', 'i_customers_firms' => 'Testowa', 'i_customers_nip' => ' ', 'i_customers_city' => 'Wrocław', 'i_customers_zip_code' => '55-555', 22

23 'i_customers_street' => 'Tstowa', 'i_customers_home' => '11/7',, ; 'count' ilość przetworzonych rekordów [count] => 1 [orders_id] => Array [0] => 8 update Aktualizacja rekordów znajdujących się w bazie danych. Tablice rekordów muszą zawierać te same pola. Uwaga: Nie można aktualizować identyfikatora zamówienia. tablice wg tabeli Orders 'module' => 'orders', 'method' => 'update', array 'orders_id' => 2, 'customers_first_name' => 'Tomasz', 'customers_last_name' => 'Przykładowy', 'customers_countries' => 'PL', 'customers_zip_code' => '55-555', 'customers_city' => 'Wrocław', 'customers_street' => 'Przykładowa', 'customers_home' => '11/7',, ; 'count' ilość przetworzonych rekordów 23

24 [count] => 1 delete Usuwanie rekordów z bazy danych. Parametry: orders_id tablica identyfikatorów zamówień do usunięcia 'module' => 'orders', 'method' => 'delete', 'orders_id' => array1, 2, 3 ; 'count' ilość przetworzonych rekordów [count] => orderstoproducts Moduł do operacji na produktach z zamówień. Metody count Zwraca ilość rekordów w bazie danych. - 'module' => 'orderstoproducts', 'method' => 'count', 24

25 [count] => 21 ; selectids Zwraca rekordy o podanych w parametrze identyfikatorach. 'orders_id' tablica identyfikatorów zamówień 'module' => 'orderstoproducts', 'method' => 'selectids', 'orders_id' => array1, 5 ; 'count' ilość zwróconych rekordów 'orders_to_products' tablica zawierająca informacje o zamówionych produktach [count] => 1 [orders_to_products] => Array [0] => stdclass Object [products_id] => 5 [orders_id] => 5 [products_name] => klej [products_model] => [products_price] => [discount] => [profit] => [products_tax] => 1.23 [products_items] => 1 [products_symbol] => [confirm_status] => 0 [base_price] =>

26 select Zwraca rekordy wg zadanego filtra w parametrach lub wszystkie. tablica wg tabeli Orders To Products opcje: 'offset' odstęp pobieranych danych z bazy 'limit' ilość pobieranych danych z bazy 'module' => 'orderstoproducts', 'method' => 'select',, 'options' => array 'offset' => 1, 'limit' => 50 ; 'count' ilość zwróconych rekordów 'orders_to_products' tablica zawierająca informacje o zamówieniach jak dla selectids add Dodanie nowych rekordów do bazy. tablice wg tabeli Orders To Products 'module' => 'orderstoproducts', 26

27 'method' => 'add', array 'products_name' => 'Produkt testowy 1', 'orders_id' => 2, 'products_id' => 7461, 'products_price' => , 'products_tax' => 1.23, array 'products_name' => 'Produkt testowy 2', 'orders_id' => 2, 'products_id' => 7472 'products_price' => , 'products_tax' => 1.23, ; 'count' ilość przetworzonych rekordów [count] => 1 update Aktualizacja rekordów znajdujących się w bazie danych. Tablice rekordów muszą zawierać te same pola. Uwaga: Nie można aktualizować identyfikatora zamówienia. tablice wg tabeli Orders To Products 'module' => 'orderstoproducts', 'method' => 'update', array 'orders_id' => 2, 'products_id' => 7652, 'products_name' => 'Produkt testowy', 27

28 , ; 'count' ilość przetworzonych rekordów [count] => 1 delete Usuwanie rekordów z bazy danych. Parametry: orders_id identyfikator zamówienia products_id tablica identyfikatorów produktów do usunięcia 'module' => 'orderstoproducts', 'method' => 'delete', 'orders_id' => 1, 'products_id' => array1, 2, 3 ; 'count' ilość przetworzonych rekordów [count] => categories Moduł do operacji na kategoriach. Metody count Zwraca ilość rekordów w bazie danych. - 28

29 'module' => 'categories', 'method' => 'count', ; [count] => 151 selectids Zwraca rekordy o podanych w parametrze identyfikatorach. 'id' tablica identyfikatorów kategorii 'module' => 'categories', 'method' => 'selectids', 'id' => array111, 555 ; 'count' ilość zwróconych rekordów 'categories' tablica zawierająca informacje o kategoriach 'treepath' - ścieżka w drzewie kategorii [count] => 2 [categories] => Array [0] => stdclass Object [id] => 111 [name] => AGD DO ZABUDOWY [ordering] => 1 [info] => [treepath] => /111 29

30 [1] => stdclass Object [id] => 555 [name] => Produkty archiwalne [ordering] => 5 [info] => [treepath] => /1/5 select Zwraca rekordy wg zadanego filtra w parametrach lub wszystkie. tablica wg tabeli Categories opcje: 'offset' odstęp pobieranych danych z bazy 'limit' ilość pobieranych danych z bazy 'module' => 'categories', 'method' => 'select',, 'options' => array 'offset' => 10, 'limit' => 15 ; 'count' ilość zwróconych rekordów 'categories' tablica zawierająca informacje o zamówieniach jak dla selectids add Dodanie nowych rekordów do bazy. 30

31 tablice wg tabeli Categories opcje: 'categoryparentid' id kategorii nadrzędnej dla dodawanych kategorii 'module' => 'categories', 'method' => 'add', array 'name' => 'Nowa kategoria',, 'options' => array 'categoryparentid' => 148 ; 'count' ilość przetworzonych rekordów ['count'] => 2 [id] => Array [0] => 259 [1] => 260 update Aktualizacja rekordów znajdujących się w bazie danych. Tablice rekordów muszą zawierać te same pola. Uwaga: Nie można aktualizować identyfikatora kategorii ani kategorii nadrzędnej. tablice wg tabeli Categories 'module' => 'categories', 'method' => 'update', 31

32 array 'id' => 1, 'name' => 'Zmieniona nazwa',, ; 'count' ilość przetworzonych rekordów [count] => 1 delete Usuwanie rekordów z bazy danych. Parametry: id tablica identyfikatorów kategorii do usunięcia 'module' => 'categories', 'method' => 'delete', 'id' => array15, 17, 36 ; 'count' ilość przetworzonych rekordów [count] => productstocategories Moduł do operacji na produktach w kategoriach. Metody count Zwraca ilość rekordów w bazie danych. - 32

33 'module' => 'productstocategories', 'method' => 'count', ; [count] => 65 select Zwraca rekordy wg zadanego filtra w parametrach lub wszystkie. opcje: tablica wg tabeli Products To Categories 'offset' odstęp pobieranych danych z bazy 'limit' ilość pobieranych danych z bazy ; 'module' => 'productstocategories', 'method' => 'select',, 'options' => array 'offset' => 8, 'limit' => 15 'count' ilość zwróconych rekordów 'products_to_categories' tablica zawierająca informacje o produktach przypisanych do kategorii [count] => 3 [products_to_categories] => Array 33

34 [0] => stdclass Object [products_id] => 5019 [categories_id] => 32 [1] => stdclass Object [products_id] => 5020 [categories_id] => 32 [2] => stdclass Object [products_id] => 5021 [categories_id] => 32 add Dodanie nowych rekordów do bazy. tablice wg tabeli Products To Categories 'module' => 'productstocategories', 'method' => 'add', array 'categories_id' => 11, 'products_id' => 10,, ; 'count' ilość przetworzonych rekordów [count] => 1 34

35 delete Usuwanie rekordów z bazy danych. Parametry: categories_id identyfikator kategorii products_id tablica identyfikatorów produktów do usunięcia 'module' => 'orderstoproducts', 'method' => 'delete', 'categories_id' => 11, 'products_id' => array18, 19 ; 'count' ilość przetworzonych rekordów [count] => productsoptions Moduł do operacji na opcjach Metody count Zwraca ilość rekordów w bazie danych. - 'module' => 'productsoptions', 'method' => 'count', ; 35

36 [count] => 153 selectids Zwraca rekordy o podanych w parametrze identyfikatorach. 'id' tablica identyfikatorów 'module' => 'productsoptions', 'method' => 'selectids', 'id' => array3, 8, 14 ; 'count' ilość zwróconych rekordów 'products_options' tablica rekordów [count] => 1 [products_options] => Array [0] => stdclass Object [id] => 1 [name] => dostępne kolory select Zwraca rekordy wg zadanego filtra w parametrach lub wszystkie. tablica wg tabeli opcje: 'offset' odstęp pobieranych danych z bazy 36

37 'limit' ilość pobieranych danych z bazy 'module' => 'productsoptions', 'method' => 'select',, 'options' => array 'offset' => 1, 'limit' => 50 ; 'count' ilość zwróconych rekordów 'products_options' tablica zwróconych rekordów jak dla selectids add Dodanie nowych rekordów do bazy. tablice wg tabeli 'module' => 'productsoptions', 'method' => 'add', array 'name' => 'nowa opcja 1',, array 'name' => 'nowa opcja 2',, ; 'count' ilość przetworzonych rekordów 37

38 [count] => 2 [id] => Array [0] => 18 [1] => 19 update Aktualizacja rekordów znajdujących się w bazie danych. Tablice rekordów muszą zawierać te same pola. Uwaga: Nie można aktualizować identyfikatora. tablice wg tabeli 'module' => 'productsoptionsvalues', 'method' => 'update', array 'id' => 47, 'name' => 'nowa nazwa 1',, array 'id' => 48, 'name' => 'nowa nazwa 2',, ; 'count' ilość przetworzonych rekordów [count] => 2 delete Usuwanie rekordów z bazy danych. Parametry: id identyfikator 38

39 'module' => 'productsoptions', 'method' => 'delete', 'id' => array1, 2, 3 ; 'count' ilość przetworzonych rekordów [count] => 3 39

40 4.9. productsoptionsvalues Moduł do operacji na wartościach opcji Metody count Zwraca ilość rekordów w bazie danych. - 'module' => 'productsoptionsvalues', 'method' => 'count', ; [count] => 225 selectids Zwraca rekordy o podanych w parametrze identyfikatorach. 'id' tablica identyfikatorów 'module' => 'productsoptionsvalues', 'method' => 'selectids', 'id' => array3, 17, 55 ; 'count' ilość zwróconych rekordów 'products_options_values' tablica rekordów 40

41 [count] => 1 [products_options_values] => Array [0] => stdclass Object [id] => 1 [po_id] => 1 [name] => popielaty x84 select Zwraca rekordy wg zadanego filtra w parametrach lub wszystkie. tablica wg tabeli opcje: 'offset' odstęp pobieranych danych z bazy 'limit' ilość pobieranych danych z bazy 'module' => 'productsoptionsvalues', 'method' => 'select',, 'options' => array 'offset' => 0, 'limit' => 10 ; 'count' ilość zwróconych rekordów 'products_options_values' tablica rekordów jak dla selectids add Dodanie nowych rekordów do bazy. 41

42 tablice wg tabeli 'module' => 'productsoptionsvalues', 'method' => 'add', array 'po_id' => 1, 'name' => 'nowy1',, ; 'count' ilość przetworzonych rekordów 'id' tablica nadanych identyfikatorów [count] => 1 [id] => Array [0] => 12 update Aktualizacja rekordów znajdujących się w bazie danych. Tablice rekordów muszą zawierać te same pola. Uwaga: Nie można aktualizować identyfikatora. tablice wg tabeli 'module' => 'productsoptionsvalues', 'method' => 'update', array 42

43 ;, [id] => 111 [name] => nowa nazwa 'count' ilość przetworzonych rekordów [count] => 1 delete Usuwanie rekordów z bazy danych. Parametry: id identyfikator 'module' => 'productsoptionsvalues', 'method' => 'delete', 'id' => array1, 2, 3 ; 'count' ilość przetworzonych rekordów [count] => 3 43

44 4.10. productstooptions Moduł do przypisywania produktów do wybranych opcji Metody count Zwraca ilość rekordów w bazie danych. - 'module' => 'productstooptions', 'method' => 'count', ; [count] => 54 select Zwraca rekordy wg zadanego filtra w parametrach lub wszystkie. tablica wg tabeli opcje: 'offset' odstęp pobieranych danych z bazy 'limit' ilość pobieranych danych z bazy 'module' => 'productstooptions', 'method' => 'select',, 'options' => array ; 44

45 'count' ilość zwróconych rekordów 'products_to_options' tablica rekordów add [count] => 1 [products_to_options] => Array [0] => stdclass Object [poid] => 1 [povid] => 1 [products_id] => [direct] => + [kind] => $ [value] => 0.00 [default_value] => 0 Dodanie nowych rekordów do bazy. tablice wg tabeli ; 'module' => 'productstooptions', 'method' => 'add',, Array [poid] => 1 [povid] => 1 [products_id] => 1 [direct] => '+' [kind] => '$' 'count' ilość przetworzonych rekordów 45

46 [count] => 1 update Aktualizacja rekordów znajdujących się w bazie danych. Tablice rekordów muszą zawierać te same pola. Uwaga: Nie można aktualizować identyfikatora. tablice wg tabeli ; 'module' => 'productstooptions', 'method' => 'update',, array [poid] => 1 [products_id] => 1 [povid] => 1 [direct] => '-' 'count' ilość przetworzonych rekordów [count] => 1 delete Usuwanie rekordów z bazy danych. Parametry: products_id identyfikator produktu poid identyfikator opcji opcjonalnie povid tablica identyfikatorów wartości opcjonalnie 'module' => 'productstooptions', 46

47 'method' => 'delete', 'poid' => 1, 'products_id' => 2, 'povid' => array1, 2 ; 'count' ilość przetworzonych rekordów [count] => 2 47

48 4.11. producers Moduł do operacji na producentach Metody count Zwraca ilość rekordów w bazie danych. - 'module' => 'producers', 'method' => 'count', ; [count] => 100 selectids Zwraca rekordy o podanych w parametrze identyfikatorach. 'id' tablica identyfikatorów 'module' => 'producers', 'method' => 'selectids', 'id' => array1, 85 ; 'count' ilość zwróconych rekordów 'producers' tablica rekordów 48

49 [count] => 1 [producers] => Array [0] => stdclass Object [id] => 1 [pr_name] => SIEMENS [pr_href] => [description] => [title] => select Zwraca rekordy wg zadanego filtra w parametrach lub wszystkie. tablica wg tabeli opcje: 'offset' odstęp pobieranych danych z bazy 'limit' ilość pobieranych danych z bazy 'module' => 'producers', 'method' => 'select',, 'options' => array 'offset' => 0, 'limit' => 10 ; 'count' ilość zwróconych rekordów 'products_options_values' tablica rekordów jak dla selectids 49

50 add Dodanie nowych rekordów do bazy. tablice wg tabeli 'module' => 'producers', 'method' => 'add', array 'pr_name' => 'nowy1', 'image_data' => base64_encodefile_get_contents'test.jpg', 'image_ext' => 'jpg', ; 'count' ilość przetworzonych rekordów 'id' tablica nadanych identyfikatorów [count] => 1 [id] => Array [0] => 1 update Aktualizacja rekordów znajdujących się w bazie danych. Tablice rekordów muszą zawierać te same pola. Uwaga: Nie można aktualizować identyfikatora; Aby usunąć zdjęcie należy przesłać parametr image data jako pusty string: 'image_data' => '' 50

51 tablice wg tabeli ; 'module' => 'producers', 'method' => 'update',, array [id] => 1 [pr_name] => 'nowa nazwa' 'count' ilość przetworzonych rekordów [count] => 1 delete Usuwanie rekordów z bazy danych. Parametry: id identyfikator 'module' => 'producers', 'method' => 'delete', 'id' => array1, 2, 3 ; 'count' ilość przetworzonych rekordów [count] => 3 51

52 4.12. orderstooptions Moduł do operacji na opcjach w zamówieniach Metody count Zwraca ilość rekordów w bazie danych. - 'module' => 'orderstooptions', 'method' => 'count', ; [count] => 12 select Zwraca rekordy wg zadanego filtra w parametrach lub wszystkie. tablica wg tabeli opcje: 'offset' odstęp pobieranych danych z bazy 'limit' ilość pobieranych danych z bazy 'module' => 'orderstooptions', 'method' => 'select', array 'orders_id' => 18, 'options' => array 52

53 'offset' => 0, 'limit' => 10 ; 'count' ilość zwróconych rekordów 'products_options_values' tablica rekordów [count] => 2 [orders_to_options] => Array [0] => stdclass Object [povid] => 7 [orders_id] => 18 [products_id] => 300 [options_name] => kolor [options_value_name] => kremowy [1] => stdclass Object [povid] => 3 [orders_id] => 18 [products_id] => 1138 [options_name] => kolor [options_value_name] => zielony add Dodanie nowych rekordów do bazy. tablice wg tabeli 'module' => 'orderstooptions', 'method' => 'add', array 53

54 'povid' => 2, 'orders_id' => 22, 'products_id' => 7461, 'options_name' => 'nazwa opcji', 'options_value_name' => 'nazwa wartości opcji',, ; 'count' ilość przetworzonych rekordów [count] => 1 delete Usuwanie rekordów z bazy danych. Parametry: id identyfikator 'module' => 'orderstooptions', 'method' => 'delete', 'id' => array1, 2, 3 ; 'count' ilość przetworzonych rekordów [count] => 3 54

55 4.13. gallery Moduł do operacji na zdjęciach do produktów Metody count Zwraca ilość rekordów w bazie danych. - 'module' => 'gallery', 'method' => 'count', ; [count] => 100 selectids Zwraca rekordy o podanych w parametrze identyfikatorach. 'id' tablica identyfikatorów 'module' => 'gallery', 'method' => 'selectids', 'id' => array11 ; 'count' ilość zwróconych rekordów 'gallery' tablica rekordów 55

56 [count] => 1 [producers] => Array [0] => stdclass Object [id] => 2 [ordering] => 1 [products_id] => 7472 [image] => 1f aa8cea96096b56a517f5e7.jpg select Zwraca rekordy wg zadanego filtra w parametrach lub wszystkie. tablica wg tabeli opcje: 'offset' odstęp pobieranych danych z bazy 'limit' ilość pobieranych danych z bazy 'module' => 'gallery', 'method' => 'select',, 'options' => array 'offset' => 0, 'limit' => 10 ; 'count' ilość zwróconych rekordów 'gallery' tablica rekordów jak dla selectids add 56

57 Dodanie nowych rekordów do bazy. tablice wg tabeli ; 'module' => 'gallery', 'method' => 'add',, array 'products_id' => 17545, 'image_data' => base64_encodefile_get_contents'test.jpg', 'image_ext' => 'jpg' 'count' ilość przetworzonych rekordów 'countexists' ilość rekordów które już istniały i nie zostały ponownie dodane zabezpieczenie przed ponownym dodaniem takiego samego obrazka do produktu 'id' tablica nadanych identyfikatorów [count] => 1 [countexists] => 2 [id] => Array [0] => 100 delete Usuwanie rekordów z bazy danych. Parametry: id identyfikator 'module' => 'gallery', 57

58 'method' => 'delete', 'id' => array3 ; 'count' ilość przetworzonych rekordów [count] => 3 58

59 4.14. ordersstatus Moduł do operacji na statusach zamówień Metody count Zwraca ilość rekordów w bazie danych. - 'module' => 'ordersstatus', 'method' => 'count', ; [count] => 5 selectids Zwraca rekordy o podanych w parametrze identyfikatorach. 'orders_status_id' tablica identyfikatorów 'module' => 'ordersstatus', 'method' => 'selectids', 'orders_status_id' => array1 ; 'count' ilość zwróconych rekordów 'orders_status' tablica rekordów 59

60 [count] => 1 [producers] => Array [0] => stdclass Object [orders_status_id] => 1 [orders_status_name] => Produkt wysłany [orders_status_info] => select Zwraca rekordy wg zadanego filtra w parametrach lub wszystkie. tablica wg tabeli opcje: 'offset' odstęp pobieranych danych z bazy 'limit' ilość pobieranych danych z bazy 'module' => 'ordersstatus', 'method' => 'select',, 'options' => array 'offset' => 0, 'limit' => 10 ; 'count' ilość zwróconych rekordów 'products_options_values' tablica rekordów jak dla selectids add Dodanie nowych rekordów do bazy. 60

61 tablice wg tabeli 'module' => 'ordersstatus', 'method' => 'add', array 'orders_status_name' => 'nowy',,, ; 'count' ilość przetworzonych rekordów [count] => 1 delete Usuwanie rekordów z bazy danych. Parametry: orders_status_id identyfikator 'module' => 'ordersstatus', 'method' => 'delete', 'orders_status_id' => array3 ; 'count' ilość przetworzonych rekordów [count] => 3 61

62 4.15. productstemplates Moduł do operacji na szablonach Metody count Zwraca ilość rekordów w bazie danych. - 'module' => 'productstemplates', 'method' => 'count', ; [count] => 10 selectids Zwraca rekordy o podanych w parametrze identyfikatorach. 'id' tablica identyfikatorów 'module' => 'productstemplates', 'method' => 'selectids', 'id' => array52 ; 'count' ilość zwróconych rekordów 'products_templates' tablica rekordów 62

63 [count] => 1 [producers] => Array [0] => stdclass Object [id] => 1 [name] => Kolory [ordering_type] => az [ordering] => 0 select Zwraca rekordy wg zadanego filtra w parametrach lub wszystkie. tablica wg tabeli opcje: 'offset' odstęp pobieranych danych z bazy 'limit' ilość pobieranych danych z bazy 'module' => 'productstemplates', 'method' => 'select', ; 'count' ilość zwróconych rekordów 'products_templates_values' tablica rekordów jak dla selectids add Dodanie nowych rekordów do bazy. tablice wg tabeli 63

64 'module' => 'productstemplates', 'method' => 'add', array 'name' => 'Kolory', ; 'count' ilość przetworzonych rekordów 'id' tablica nadanych identyfikatorów [count] => 1 [id] => Array [0] => 1 update Aktualizacja rekordów znajdujących się w bazie danych. Tablice rekordów muszą zawierać te same pola. Uwaga: Nie można aktualizować identyfikatora. tablice wg tabeli 'module' => 'productstemplates', 'method' => 'update',, array [id] => 1 [name] => 'nowa nazwa' 64

65 ; 'count' ilość przetworzonych rekordów [count] => 1 delete Usuwanie rekordów z bazy danych. Parametry: id identyfikator 'module' => 'productstemplates', 'method' => 'delete', 'id' => array1, 2, 3 ; 'count' ilość przetworzonych rekordów [count] => 3 65

66 4.16. productstemplatesvalues Moduł do operacji na wartościach do szablonów Metody count Zwraca ilość rekordów w bazie danych. - 'module' => 'productstemplatesvalues', 'method' => 'count', ; [count] => 7 selectids Zwraca rekordy o podanych w parametrze identyfikatorach. 'id' tablica identyfikatorów 'module' => 'productstemplatesvalues', 'method' => 'selectids', 'id' => array12, 21 ; 'count' ilość zwróconych rekordów 'products_templates_values' tablica rekordów 66

67 [count] => 1 [producers] => Array [0] => stdclass Object [id] => 1 [pt_id] => 1 [name] => zielony [help] => Jakieś objasnienie [ordering] => 0 select Zwraca rekordy wg zadanego filtra w parametrach lub wszystkie. tablica wg tabeli opcje: 'offset' odstęp pobieranych danych z bazy 'limit' ilość pobieranych danych z bazy 'module' => 'productstemplatesvalues', 'method' => 'select', ; 'count' ilość zwróconych rekordów 'products_options_values' tablica rekordów jak dla selectids add Dodanie nowych rekordów do bazy. tablice wg tabeli 67

68 'module' => 'productstemplatesvalues', 'method' => 'add', array 'pt_id' => 1, 'name' => 'nowy1', ; 'count' ilość przetworzonych rekordów 'id' tablica nadanych identyfikatorów [count] => 1 [id] => Array [0] => 1 update Aktualizacja rekordów znajdujących się w bazie danych. Tablice rekordów muszą zawierać te same pola. Uwaga: Nie można aktualizować identyfikatora. tablice wg tabeli 'module' => 'productstemplatesvalues', 'method' => 'update',, array [id] => 1 [name] => 'nowa nazwa' 68

69 ; 'count' ilość przetworzonych rekordów [count] => 1 delete Usuwanie rekordów z bazy danych. Parametry: id identyfikator 'module' => 'productstemplatesvalues', 'method' => 'delete', 'id' => array2 ; 'count' ilość przetworzonych rekordów [count] => 3 69

70 4.17. productstotemplates Moduł do dodawania szablonów do produktów Metody count Zwraca ilość rekordów w bazie danych. - 'module' => 'productstotemplates', 'method' => 'count', ; [count] => 8 select Zwraca rekordy wg zadanego filtra w parametrach lub wszystkie. tablica wg tabeli opcje: 'offset' odstęp pobieranych danych z bazy 'limit' ilość pobieranych danych z bazy 'module' => 'productstotemplates', 'method' => 'select',, 'options' => array 'offset' => 0, 'limit' => 10 70

71 ; 'count' ilość zwróconych rekordów 'products_to_templates' tablica rekordów [count] => 1 [products_to_templates] => Array [0] => stdclass Object [ptid] => 1 [ptvid] => 1 [products_id] => 1 [value] => jakaś wartość add Dodanie nowych rekordów do bazy. tablice wg tabeli 'module' => 'productstotemplates', 'method' => 'add', array 'ptid' => 1, 'ptvid' => 1, 'products_id' => 1, 'value' => 'jakaś wartość', ; 'count' ilość przetworzonych rekordów [count] => 1 71

72 delete Usuwanie rekordów z bazy danych. Parametry: ptid identyfikator szablonu products identyfikator produktu ptvid tablica identyfikatorów wartości 'module' => 'productstotemplates', 'method' => 'delete', 'ptid' => 1, 'products_id' => 1, 'ptvid' => array1, 100 ; 'count' ilość przetworzonych rekordów [count] => 4 72

73 4.18. inventoryoptions Moduł do operacji na magazynie opcji do produktów Metody count Zwraca ilość rekordów w bazie danych. - 'module' => 'inventoryoptions', 'method' => 'count', ; [count] => 10 select Zwraca rekordy wg zadanego filtra w parametrach lub wszystkie. tablica wg tabeli opcje: 'offset' odstęp pobieranych danych z bazy 'limit' ilość pobieranych danych z bazy 'module' => 'inventoryoptions', 'method' => 'select', 'products_id' => 17916,, ; 'count' ilość zwróconych rekordów 73

74 'inventory_options' tablica rekordów [count] => 1 [producers] => Array [0] => stdclass Object [products_id] => [quantity] => 100 [ean]=> [options_array] => stdclass Object [13] => 88 add Dodanie nowych rekordów do bazy. tablice wg tabeli opcje: - inventories_id id magazynu wg modułu Inventoris 'module' => 'inventoryoptions', 'method' => 'add', array 'products_id' => 22222, 'options_array' => array 1 => 2, 3 => 4,, 'quantity' => 20, 'ean'=> , ; 74

75 'count' ilość przetworzonych rekordów [count] => 1 update Aktualizacja rekordów znajdujących się w bazie danych. Tablice rekordów muszą zawierać te same pola. Uwaga: Nie można aktualizować identyfikatora. tablice wg tabeli opcje: - inventories_id id magazynu wg modułu Inventoris 'module' => 'inventoryoptions', 'method' => 'update', array 'products_id' => 22222, 'options_array' => array 1 => 2, 3 => 4,, 'quantity' => 20, 'quantity_critic' => 2, 'ean' => ,, ; 'count' ilość przetworzonych rekordów [count] => 1 delete Usuwanie rekordów z bazy danych. Uwaga: usunięcie wszystkich wpisów dla produktu wyłącza magazyn opcji dla tego produktu i 75

76 ustawia 'inventory' wg 'opcji' Parametry: products_id identyfikator options_array tablice opcji do usunięcia opcjonalnie opcje: - inventory jak w 'products' - inventories_id id magazynu wg modułu Inventoris 'module' => 'inventoryoptions', 'method' => 'delete', 'products_id' => 22222, 'options_array' => array array 1 => 2, 3 => 4,, array 1 => 20, 3 => 40,, 'options' => array 'inventory' => 3 ; 'count' ilość przetworzonych rekordów [count] => 1 76

77 4.19. Units Moduł do operacji na jednostkach Metody count Zwraca ilość rekordów w bazie danych. - 'module' => 'units', 'method' => 'count', ; [count] => 12 selectids Zwraca rekordy o podanych w parametrze identyfikatorach. 'id' tablica identyfikatorów 'module' => 'units', 'method' => 'selectids', 'id' => array1, 8 ; 'count' ilość zwróconych rekordów 'units' tablica rekordów 77

78 [count] => 2 [producers] => Array [0] => stdclass Object [id] => 24 [name] => rok [type] => 4 [1] => stdclass Object [id] => 25 [name] => lata [type] => 4 select Zwraca rekordy wg zadanego filtra w parametrach lub wszystkie. tablica wg tabeli opcje: 'offset' odstęp pobieranych danych z bazy 'limit' ilość pobieranych danych z bazy 'module' => 'units', 'method' => 'select', 'type' => 4, ; 'count' ilość zwróconych rekordów 'units' tablica rekordów jak dla selectids 78

79 4.20. Deliverers Moduł do operacji na dostawcach a Metody count Zwraca ilość rekordów w bazie danych. - 'module' => 'deliverers', 'method' => 'count', ; [count] => 10 selectids Zwraca rekordy o podanych w parametrze identyfikatorach. 'id' tablica identyfikatorów 'module' => 'deliverers', 'method' => 'selectids', 'id' => array1, 12 ; 'count' ilość zwróconych rekordów 'deliverers' tablica rekordów 79

80 [count] => 1 [deliverers] => Array [0] => stdclass Object [id] => 1 [name] => FABRYKA ZABAWEK [href] => select Zwraca rekordy wg zadanego filtra w parametrach lub wszystkie. tablica wg tabeli opcje: 'offset' odstęp pobieranych danych z bazy 'limit' ilość pobieranych danych z bazy 'module' => 'deliverers', 'method' => 'select',, 'options' => array 'offset' => 0, 'limit' => 30 ; 'count' ilość zwróconych rekordów 'deliverers' tablica rekordów jak dla selectids add 80

81 Dodanie nowych rekordów do bazy. tablice wg tabeli 'module' => 'deliverers', 'method' => 'add', array 'name' => 'nowy1',, ; 'count' ilość przetworzonych rekordów 'id' tablica nadanych identyfikatorów [count] => 1 [id] => Array [0] => 1 update Aktualizacja rekordów znajdujących się w bazie danych. Tablice rekordów muszą zawierać te same pola. Uwaga: Nie można aktualizować identyfikatora. tablice wg tabeli 'module' => 'deliverers', 'method' => 'update', array 81

82 ;, [id] => 1 [name] => 'nowa nazwa' 'count' ilość przetworzonych rekordów [count] => 1 delete Usuwanie rekordów z bazy danych. Parametry: id identyfikator 'module' => 'deliverers', 'method' => 'delete', 'id' => array1, 2 ; 'count' ilość przetworzonych rekordów [count] => 8 82

83 4.21. Tax Moduł do operacji na podatkach a Metody count Zwraca ilość rekordów w bazie danych. - 'module' => 'tax', 'method' => 'count', ; [count] => 7 selectids Zwraca rekordy o podanych w parametrze identyfikatorach. 'id' tablica identyfikatorów 'module' => 'tax', 'method' => 'selectids', 'id' => array1, 12 ; 'count' ilość zwróconych rekordów 'taxes' tablica rekordów 83

84 [count] => 1 [taxes] => Array [0] => stdclass Object [id] => 1 [tax] => [value] => 1.23 [name] => VAT - 23 select Zwraca rekordy wg zadanego filtra w parametrach lub wszystkie. tablica wg tabeli opcje: 'offset' odstęp pobieranych danych z bazy 'limit' ilość pobieranych danych z bazy 'module' => 'tax', 'method' => 'select',, 'options' => array 'offset' => 0, 'limit' => 30 ; 'count' ilość zwróconych rekordów 'taxes' tablica rekordów jak dla selectids 84

85 add Dodanie nowych rekordów do bazy. tablice wg tabeli 'module' => 'tax', 'method' => 'add', array 'name' => 'nowy1', 'tax' => 'value' = 1.23, ; 'count' ilość przetworzonych rekordów 'id' tablica nadanych identyfikatorów [count] => 1 [id] => Array [0] => 1 update Aktualizacja rekordów znajdujących się w bazie danych. Tablice rekordów muszą zawierać te same pola. Uwaga: Nie można aktualizować identyfikatora. tablice wg tabeli 85

86 ; 'module' => 'tax', 'method' => 'update',, array [id] => 1 [name] => 'nowa nazwa' 'count' ilość przetworzonych rekordów [count] => 1 delete Usuwanie rekordów z bazy danych. Parametry: id identyfikator 'module' => 'tax', 'method' => 'delete', 'id' => array1, 2 ; 'count' ilość przetworzonych rekordów [count] => Allegro Auctions Details Moduł z danymi allegro i zamówień posiada metody tylko do odczytu a Metody count Zwraca ilość rekordów w bazie danych. - 86

87 'module' => 'allegroauctionsdetails', 'method' => 'count', ; [count] => 2525 selectids Zwraca rekordy o podanych w parametrze identyfikatorach. 'id' tablica identyfikatorów 'module' => 'tax', 'method' => 'allegroauctionsdetails', 'id' => array1, 2, 10 ; 'count' ilość zwróconych rekordów 'allegro_auctions_details' tablica rekordów [count] => 1 [allegro_auctions_details] => Array [0] => stdclass Object [id] => 1 [aid] => [orders_id] => 1 87

88 select Zwraca rekordy wg zadanego filtra w parametrach lub wszystkie. tablica wg tabeli opcje: 'offset' odstęp pobieranych danych z bazy 'limit' ilość pobieranych danych z bazy 'module' => 'allegroauctionsdetails', 'method' => 'select', 'orders_id' => 102, 'options' => array 'offset' => 0, 'limit' => 100 ; 'count' ilość zwróconych rekordów 'allegro_auctions_details' tablica rekordów jak dla selectids Allegro Auctions Moduł z danymi allegro i produktów posiada metody tylko do odczytu a Metody count Zwraca ilość rekordów w bazie danych. - 88

89 'module' => 'allegroauctions', 'method' => 'count', ; [count] => 2525 selectids Zwraca rekordy o podanych w parametrze identyfikatorach. 'id' tablica identyfikatorów 'module' => 'tax', 'method' => 'allegroauctions', 'id' => array1, 2, 10 ; 'count' ilość zwróconych rekordów 'allegro_auctions' tablica rekordów [count] => 1 [allegro_auctions] => Array [0] => stdclass Object [id] => 1 [aid] => [products_id] =>

90 select Zwraca rekordy wg zadanego filtra w parametrach lub wszystkie. tablica wg tabeli opcje: 'offset' odstęp pobieranych danych z bazy 'limit' ilość pobieranych danych z bazy 'module' => 'allegroauctions', 'method' => 'select', 'products_id' => 10, 'options' => array 'offset' => 0, 'limit' => 100 ; 'count' ilość zwróconych rekordów 'allegro_auctions' tablica rekordów jak dla selectids Inventories Moduł magazynów posiada metody tylko do odczytu a Metody count Zwraca ilość rekordów w bazie danych. - 90

91 'module' => 'inventories', 'method' => 'count', ; [count] => 2 selectids Zwraca rekordy o podanych w parametrze identyfikatorach. 'id' tablica identyfikatorów 'module' => 'tax', 'method' => 'inventories', 'id' => array1, 2, 10 ; 'count' ilość zwróconych rekordów 'inventories' tablica rekordów [count] => 1 [inventories] => Array [0] => stdclass Object [id] => 1 [name] => Magazyn Główny [short_name] => M1 [ordering] => 1 select 91

92 Zwraca rekordy wg zadanego filtra w parametrach lub wszystkie. tablica wg tabeli opcje: 'offset' odstęp pobieranych danych z bazy 'limit' ilość pobieranych danych z bazy 'module' => 'inventories', 'method' => 'select',, ; 'count' ilość zwróconych rekordów 'allegro_auctions' tablica rekordów jak dla selectids 5. Komunikaty błędów W momencie nieprawidłowego wywołania metody zostanie zwrócony komunikat błędu zostanie zwrócona tablica error. Wszystkie kody błędów znajdują się w tabeli Błędy. 'code' kod błędu 'message' komunikat błędu 'request' dane przesłane do usługi API Przykład zwróconego błędu: "error": { "code":"e_required_parameter", "message":"wymagany parametr: products_name"}, "request":{"key":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx", "viewtype":"json", "module":"products", "method":"add", 92

93 "parameters": [{ "products_price":"10.01" }, { "products_name":"zmywarka", "products_price":"222.01" }] } 6. TABELE Date format: Y-m-d - np DateTime format Y-m-d G:i:s - np :00: Products moduł: 'products' Nazwa kolumny Wymagane Typ count select selectids add update delete danych products_id N N T N T T Integer Unikalny identyfikator produktu products_name N N N T N N String 128 products_description _short N N N N N N String 255 Opis Nazwa produktu Krótki opis produktu products_description N N N N N N String Pełny opis produktu products_price N N N N N N Decimal Cena netto produktu products_price_brutto N N N N N N Decimal Cena brutto produktu promotions_price N N N N N N Decimal Cena promocyjna netto promotions_price_bru tto promotions_date_fro m N N N N N N Decimal Cena promocyjna brutto N N N N N N Date Data rozpoczęcia promocji promotions_date_to N N N N N N DateTime Data i godzina zakończenia promocji weight N N N N N N String 50 Waga produktu buy_price N N N N N N Decimal Cena zakupu netto buy_price_brutto N N N N N N Decimal Cena zakupu brutto suggest_price N N N N N N Decimal Cena rynkowa products_model N N N N N N String 100 products_symbol N N N N N N String 100 meta_title N N N N N N String 165 meta_desc N N N N N N String 200 Model produktu Symbol PKWiU Znacznik meta title Znacznik meta description meta_keywords N N N N N N String Znacznik meta keywords ean N N N N N N String 40 Kod kreskowy 93