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: www.jansen-display.sk/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
  • user
    • email - email požitý při registraci
    • password - heslo používané pro přistup do eshopu
  • invoice_address - adresa uvedená na faktuře
    • customer
      • company - objednávka na právnickou osobu
        • company_id - IČO
        • tax_number - DIČ
        • name - název firmy
      • person
        • firstname
        • lastname
    • street - ulice a č.p.
    • city
    • postcode
    • country_code - CZE / SVK
    • telephone
  • delivery_address - adresa, na kterou bude doručeno zboží
    • customer
      • company - objednávka na právnickou osobu
        • company_id - IČO
        • tax_number - DIČ
        • name - název firmy
      • person
        • firstname
        • lastname
    • street - ulice a č.p.
    • city
    • postcode
    • country_code - CZE / SVK
    • telephone
  • products
    • product - pro každý objednávaný produkt
      • code - kód produktu
      • quantity - počet kusů
  • payment_type - cash_on_delivery : dobírka / bank_transfer : bankovní převod / invoice : faktura
  • note - libovolná poznámka

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