API

API (Application Programming Interface) eshopu jansen-display.cz umožňuje vytvářet nové objednávky a zjišťovat stav již vytvořených objednávek.

API je zabezpečené pomocí přihlašovacích údajů používaných při běžném přihlašování na eshop.

Funkce

Vložení objednávky

URL : tst.jansen-display.cz/api/order/add

Vstup : XML soubor odpovídající schématu order_api_request.xsd

Výstup : XML soubor odpovídající schématu  order_api_response.xsd

Struktura vstupu :

  • order  - povinné
    • user  - zákazník nebo dodavatel - povinné
      • email - registrovaný email  - povinné
      • password -heslo k přístupu na eshop - povinné
    • customer - povinné
      • company - povinné pokud jde o firmu
        • name - název firmy (120) - povinné
      • person  - povinné
        • firstname (32) - povinné
        • lastname (32) - povinné
      • delivery_address - povinné
        • street - ulice a č.p. (128) - povinné
        • city - město (128) - povinné
        • postcode   - PSČ bez mezer - povinné
        • country_code - CZE/ SVK - povinné
        • telephone (45) - povinné
    • products  - povinné
      • product - pro každý objednávaný produkt - povinné
        • code - kod produktu - povinné
        • quantity - počet kusů - povinné
    • payment_type - cash_on_delivery : dobírka / bank_transfer : bankovní převod / invoice : faktura - povinné
    • currency - CZK  /  EUR - povinné
    • shipping_type delivery  : doručení na adresu /  pick_up  : vyzvednutí v  Přestanově - povinné
    • note
    • delivery_note - url souboru s vlastním dodacím listem
    • external_id (50) - vaše ID objednávky

 

Struktura výstupu :

  • result
    • success - 0 : neúspěšný požadavek / 1 : úspěšný požadavek
    • error_code - pokud success == 0
    • error_message - pokud success == 0
    • order - pokud success == 1
      • currency_code - CZK  /  EUR
      • order_id
      • total
        • price_products_without_tax - cena produktů bez daně
        • price_shipping_without_tax - cena dopravy bez daně
        • price_with_tax - cena produktů i dopravy s daní
      • products 
        • product  - pro každý objednaný produkt
          • code - kod produktu
          • quantity - objednané množství
          • price_without_tax - jednotková cena bez daně
          • price_with_tax - jednotková cena s daní
          • total_without_tax - cena za všechny kusy bez daně
          • total_with_tax - cena za všechny kusy s daní

 

Získání stavu objednávky

URL : www.jansen-display.cz/api/order/status

Vstup : XML soubor odpovídající schématu order_status_api_request.xsd

Výstup : XML soubor odpovídající schématu  order_status_api_response.xsd

Struktura vstupu :

  • order
    • user
      • email - email požitý při registraci
      • password - heslo používané pro přistup do eshopu
    • order_id - id objednávky získané při založení objednávky

 

Struktura výstupu :

  •  result
    • success - 0 : neúspěšný požadavek / 1 : úspěšný požadavek
    • error_code - pokud success == 0
    • error_message - pokud success == 0
    • order - pokud success == 1
      • order_id
      • status_id
      • status_label
      • internal_id - id objednávky použitelné při komunikaci s back officem Jansen Display