EscAPI 2

string[] addItemCart( string $access_code, string $sesid, int $id_item, [int $amount = 1], [int $price = 0])

Dodaje pozycję do koszyka.

Wynik:

• Uaktualniona zawartość koszyka zamówień

Parametry:

• string $access_code - Kod dostępu do API
• string $sesid - Nazwa sesji
• int $id_item - Id pozycji
• int $amount - Ilość pozycji [OPTIONAL]
• int $price - Cena brutto pozycji (1 szt.) [OPTIONAL]

int addOrder( string $access_code, string[] $content)

Dodaje nowe zamówienie do zrealizowania.

Wynik:

• Id zamówienia

Parametry:

• string $access_code - Kod dostępu do API
• string[] $content - Szczegóły zamówienia

Opis zawartości tablicy $content:

• payment_id - typ płatności
  • 1 - zwykły przelew
  • 2 - za pobraniem
• delivery_id - sposób dostawy zamówienia (uzależniony od payment_id)
• items - tablica tablic z informacjami o zamówionych produktach, każdy produkt musi zawierać pola:
  • id - numer id produktu, np.: 2567
  • price - cena produktu (brutto), np.: 24.67
  • amount - ilość sztuk, np.: 2 (min. 1)
• priority - jeżeli równe 1 to wysyłka priorytetem
• email - adres e-mail klienta
• name - imie klienta
• surname - nazwisko klienta
• company - firma klienta
• address - adres klienta
• code - kod pocztowy
• place - miejsce zamieszkania
• invoice - jeżeli 1 to wystawić fakturę
• tax_tin - numer NIP niezbędny do wystawienia faktury
• tax_name, tax_surname, tax_company, tax_address, tax_code, tax_place - analogicznie jak przy danych klienta, dotyczą jednak informacji, które mają znaleźć się na fakturze
  

string[] delItemCart( string $access_code, string $sesid, int $id_item)

Usuwa pozycję z koszyka.

Wynik:

• Uaktualniona zawartość koszyka zamówień

Parametry:

• string $access_code - Kod dostępu do API
• string $sesid - Nazwa sesji
• int $id_item - Id pozycji

string[] getCategoryById( string $access_code, int $id_category)

Zwraca informacje o kategorii.

Wynik:

• Informacje o kategorii

Parametry:

• string $access_code - Kod dostępu do API
• int $id_category - Id kategorii

string[] getCategoryList( string $access_code, [int $parent = MAIN_CATEGORY])

Zwraca listę kategorii.

Wynik:

• Lista kategorii (id, nazwa, id ojca)

Parametry:

• string $access_code - Kod dostępu do API
• int $parent - Id kategorii-ojca [OPTIONAL]

string[] getDeliveryList( string $access_code, int $delivery_id)

Lista form dostawy.

Wynik:

• Lista sposobów dostawy (id, nazwa, cena)

Parametry:

• string $access_code - Kod dostępu do API
• int $delivery_id - Numer id formy dostawy

string[] getItemByBestseller( string $access_code, [int $limit = 1], [int $category_id = 0])

Zwraca informacje o produktach bedacych bestsellerami.

Wynik:

• Podstawowe informacje o produktach

Parametry:

• string $access_code - Kod dostępu do API
• int $limit - Ilość zwracanych pozycji [OPTIONAL]
• int $category_id - Numer kategorii [OPTIONAL]

string[] getItemById( string $access_code, int $id)

Podaje informacje o danym produkcie.

Wynik:

• Podstawowe informacje o produkcie

Parametry:

• string $access_code - Kod dostępu do API
• int $id - Id produktu

string[] getItemByCategory( string $access_code, int $category_id, [int $page = 1], [int $item_per_page = 20])

Podaje informacje o produktach w danej kategorii i jej podkategoriach.

Wynik:

• Podstawowe informacje o produktach

Parametry:

• string $access_code - Kod dostępu do API
• int $category_id - Numer id kategorii
• int $page - Numer strony
• int $item_per_page - Ilość pozycji na stronie [OPTIONAL]

string[] getItemByIdent( string $access_code, string $ident)

Podaje informacje o danym produkcie.

Wynik:

• Podstawowe informacje o produkcie

Parametry:

• string $access_code - Kod dostępu do API
• string $ident - Identyfikator produktu (pole producer_ident: isbn, kod producenta...)

string[] getItemByNew( string $access_code, [int $limit = 1], [int $category_id = 0])

Zwraca informacje o nowych produktach.

Wynik:

• Podstawowe informacje o produktach

Parametry:

• string $access_code - Kod dostępu do API
• int $limit - Ilość zwracanych pozycji [OPTIONAL]
• int $category_id - Numer kategorii [OPTIONAL]

string[] getItemByRecommend( string $access_code, [int $limit = 1], [int $category_id = 0])

Zwraca informacje o polecanych produktach.

Wynik:

• Podstawowe informacje o produktach

Parametry:

• string $access_code - Kod dostępu do API
• int $limit - Ilość zwracanych pozycji [OPTIONAL]
• int $category_id - Numer kategorii [OPTIONAL]

string[] getItemsById( string $access_code, array $id)

Podaje informacje o danych produktach.

Wynik:

• Podstawowe informacje o produktach

Parametry:

• string $access_code - Kod dostępu do API
• array $id - Tablica numerów id produktów

int getPagesAmountInCategory( string $access_code, int $category_id)

Podaje ilość stron (jedna strona to 20 produktów) w danej kategorii.

Wynik:

• Ilość stron

Parametry:

• string $access_code - Kod dostępu do API
• int $category_id - Numer id kategorii

string[] getPaymentList( string $access_code)

Zwraca listę dostępnych sposób płatności.

Wynik:

• Lista form płatności (id, nazwa)

Parametry:

• string $access_code - Kod dostępu do API

string[] searchItem( string $access_code, string $search, [int $page = 1], [int $item_per_page = 20])

Wyszukuje pozycje pasujące do danej frazy.

Wynik:

• Podstawowe informacje o znalezionych produktach

Parametry:

• string $access_code - Kod dostępu do API
• string $search - Wyszukiwana fraza
• int $page - Numer strony
• int $item_per_page - Ilość pozycji na stronie [OPTIONAL]

string[] showCart( string $access_code, string $sesid)

Wyświetla zawartość koszyka.

Wynik:

• Zawartość koszyka zamówień

Parametry:

• string $access_code - Kod dostępu do API
• string $sesid - Nazwa sesji

string[] updateItemCart( string $access_code, string $sesid, int $id_item, int $amount, [int $price = 0])

Aktualizuje koszyk.

Wynik:

• Uaktualniona zawartość koszyka zamówień

Parametry:

• string $access_code - Kod dostępu do API
• string $sesid - Nazwa sesji
• int $id_item - Id pozycji
• int $amount - Ilość pozycji
• int $price - Cena brutto pozycji (1 szt.) [OPTIONAL]

string getContentDeliveryCosts( string $access_code)

Pobiera stronę o kosztach przesyłki.

Wynik:

• Tabela z kosztami przesyłki

Parametry:

• string $access_code - Kod dostępu do API

string getContentRules( string $access_code)

Pobiera stronę z regulaminem.

Wynik:

• Treść regulaminu

Parametry:

• string $access_code - Kod dostępu do API

string getContentPrivacyPolicy( string $access_code)

Pobiera stronę z polityką prywatności.

Wynik:

• Treść polityki prywatności

Parametry:

• string $access_code - Kod dostępu do API

string getContentContact( string $access_code)

Pobiera stronę z danymi kontaktowymi.

Wynik:

• Dane kontaktowe BOK sklepu

Parametry:

• string $access_code - Kod dostępu do API

string getContentOrderAdded( string $access_code, string $ident)

Pobiera stronę, którąnależy wyświetlić klientowi po złożeniu zamówienia.

Wynik:

• Treść strony informującej o złożeniu zamówienia

Parametry:

• string $access_code - Kod dostępu do API
• string $ident - Identyfikator zamówienia (zwracany przez addOrder())