REST API

Aktualna dokumentacja nowoczesnego interfejsu rest api jest dostępna pod adresem https://developers.shoper.pl/

REST API - dokumentacja interfejsu























order.create

Tworzy zamówienie

        array call(string $session_id, "order.create", array($data))
    

Parametry wejściowe

  • data (array) - tablica asocjacyjna z danymi obiektu o strukturze:
    • user_id (int) - (opcjonalne) identyfikator użytkownika - dla istniejącego użytkownika
    • password (string) - (opcjonalne) hasło użytkownika - dla nowego użytkownika z rejestracją
    • email (int) - (wymagane) email użytkownika
    • user_additional_fields () - pola dodatkowe dla użytkownika
      • 0-9+) (int|string) - (wymagane|opcjonalne) identyfikator pola dodatkowego => wartosc:
        • 0|1) () -
        • ----> dla "pola tekstowego" (string) -
        • ----> dla "pola wyboru" (string) - nazwa pola wyboru
    • billing_address_id (int) - (opcjonalne) identyfikator adresu klienta do danych bilingowych / do faktury
    • billing_address (array) - (opcjonalne) dla nowego użytkownika bez rejestracji / z rejestracją - w przypadku nie uzupełnienia pola delivery_address_id
      • company_name (string) - (opcjonalne) nazwa firmy
      • tax_id (string) - (opcjonalne) NIP
      • firstname (string) - (wymagane) imię
      • lastname (string) - (wymagane) nazwisko
      • street1 (string) - (wymagane) adres
      • street2 (string) - (opcjonalne) adres c.d
      • city (string|int) - (wymagane) miasto
      • postcode (string) - (wymagane) kod pocztowy
      • state (string|int) - (opcjonalne) województwo
      • country_code (string) - (opcjonalne) kod kraju - ISO 3166-2
      • country (string|int) - (opcjonalne) nazwa kraju / kod kraju - ISO 3166-2 / identyfikator kraju
      • pesel (string) - (opcjonalne) PESEL - brane pod uwagę jeśli opcja Konfiguracja -> Sprzedaż -> Zakupy -> "Włącz obsługę numeru PESEL dla osób fizycznych" jest aktywna
      • phone (string) - (wymagane) numer telefonu
    • delivery_address_id (int) - (opcjonalne) identyfikator adresu klienta do danych do wysyłki,
    • w przypadku niepodania będzie ustawiony na taki sam jak billing_address_id lub -
    • dane będą pobierane z pola billing_address lub dane zostaną pobrane z domyślnego adresu użytkownika -
    • delivery_address (array) - (opcjonalne) dla nowego użytkownika bez rejestracji / z rejestracją - w przypadku nie uzupełnienia pola delivery_address_id
      • company_name (string) - (opcjonalne) nazwa firmy
      • tax_id (string) - (opcjonalne) NIP
      • firstname (string) - (wymagane) imię
      • lastname (string) - (wymagane) nazwisko
      • street1 (string) - (wymagane) adres
      • street2 (string) - (opcjonalne) adres c.d
      • city (string|int) - (wymagane) miasto
      • postcode (string) - (wymagane) kod pocztowy
      • state (string|int) - (opcjonalne) województwo
      • country_code (string) - (opcjonalne) kod kraju - ISO 3166-2
      • country (string|int) - (opcjonalne) nazwa kraju / kod kraju - ISO 3166-2 / identyfikator kraju
      • pesel (string) - (opcjonalne) PESEL - brane pod uwagę jeśli opcja Konfiguracja -> Sprzedaż -> Zakupy -> "Włącz obsługę numeru PESEL dla osób fizycznych" jest aktywna
      • phone (string) - (wymagane) numer telefonu
    • use_default_shipping_address (int[0|1]) - (opcjonalne) - czy użyć domyślnego adresu do wysyłki użytkowika w przypadku
    • nie uzupełnienia pól billing_address, billing_address_id, delivery_address, delivery_address_id - domyślnie 1
    • different_address (int[0|1) - czy inny adres ma być do wysyłki - domyślnie 1
    • lang_id (int) - (opcjonalne) identyfikator języka - w przypadku niepodania ustawiany jest domyślny język sklepie
    • currency_id (int) - (opcjonalne) identyfikator waluty - w przypadku niepodania ustawiana jest domyślna waluta dla danego języka
    • status_id (int) - (wymagane) identyfikator statusu zamówienia
    • payment_id (int) - (wymagane) identyfikator metody płatności
    • shipping_id (int) - (wymagane) identyfikator metody dostawy
    • shipping_vat (int) - (wymagane) identyfikator stawki podatkowej dostawy
    • shipping_cost (double) - (opcjonalne) koszt dostawy - domyślnie 0
    • confirm (int[0|1]) - (opcjonalne) flaga potwierdzenia zamówienia - domyślnie 0
    • notes (string) - (opcjonalne) uwagi klienta
    • notes_priv (string) - (opcjonalne) prywatne uwagi administratora
    • notes_pub (string) - (opcjonalne) publiczne uwagi administratora
    • paid (double) - (opcjonalne) wpłacona kwota - domyślnie 0
    • date (string) - (opcjonalne) data utworzenia zamówienia (format: YYYY-MM-dd HH:mm:ss)
    • status_date (string) - (opcjonalne) data zmiany statusu (format: YYYY-MM-dd HH:mm:ss)
    • confirm_date (string) - (opcjonalne) data potwierdzenia (format: YYYY-MM-dd HH:mm:ss)
    • origin (int) - (opcjonalne) pochodzenie zamówienia (0 - sklep; 1 - facebook; 2 - mobile; 3 - allegro; 4 - webapi (domyślne))
    • additional_fields () - pola dodatkowe dla zamówienia
      • 0-9+) (int|string) - (wymagane|opcjonalne) - identyfikator pola dodatkowego => wartosc:
        • 0|1) () -
        • ----> dla "pola tekstowego" (string) -
        • ----> dla "pola wyboru" (string) - nazwa pola wyboru
    • products (array ) -
      • 0 (array|int) - tablica z danymi
        • product_id (int) - identyfikator produktu - w przypadku niepodania należy uzupełnić pole stock_id albo pozostałe pola
        • stock_id (int) - (opcjonalne) identyfikator wariantu produktu - w przypadku niepodania należy uzupełnić pole product_id albo pozostałe pola
        • quantity (float) - (wymagane) ilość
        • price (float) - (wymagane) cena produktu
        • special_offer_price (int[0|1]) - (opcjonalne) czy cena ma uwzględniać promocję - tylko jeśli podamy product_id lub stock_id - domyślnie true
        • discount_perc (float) - (opcjonalne) zniżka procentowa
        • delivery_time (float) - (wymagane) czas dostawy w dniach
        • name (string[0,255]) - (wymagane) nazwa produktu
        • code (string[0,100]) - (wymagane) kod produktu
        • pkwiu (string[0,20]) - (opcjonalne) PKWIU
        • tax (int) - (wymagane) wartość stawki podatkowej
        • unit_id (int) - (opcjonalne) identyfikator jednostki - w przypadku nieprzekazania danego parametru należy uzupełnić pola unit oraz unit_fp
        • unit (string[0,50]) - (opcjonalne) jednostka miary
        • unit_fp (int[0/1]) - (opcjonalne) flaga, czy jednostkia miary jest zmiennoprzecinkowa
        • option (string) - (opcjonalne) nazwa wariantu produktu -
        • weight (double) - (opcjonalne) waga

Wartość zwracana

  • dodatni identyfikator dodanego obiektu lub kod błędu: (int)

Rzucane wyjątki SoapFault

  • W przypadku nie podania danych w formie tablicy, rzucany jest wyjątek

Uwagi

  • Istnieje możliwość wystąpienia wyjątku SoapFault w przypadku nieprawidłowego działania modułu aplikacji. (np poprzez modyfikację kodu aplikacji lub poprzez nieoczekiwany błąd po stronie serwera)