api | jansen-display.de

API

API (Application Programming Interface)  of eshop of Jansen Display - can make new orders and find of status of them .

API is secure for all your details which are used for eshop and orders.

Functions

Place an order

URL : www.jansen-display.de/api/order/add

Input : XML  file matching scheme  order_api_request.xsd

Output : XML  file matching scheme   order_api_response.xsd

Input structure * :

  • order  - required
    • user
      • email - registration email  - required
      • password - password used in registration for eshop - required
    • customer - required
      • company - required for company
        • name - company name (120) - required
      • person  - required
        • firstname (32) - required
        • lastname (32) - required
      •  delivery_address - required
        • street - street and house number (128) - required
        • city (128) - required
        • postcode   - without spaces - required
        • country_code - DEU / AUT / CHE - required
        • telephone (45) - required
    • products  - required
      • product - item for each product - required
        • code - product code - required
        • quantity - number of  items - required
    • payment_type - cash_on_delivery / bank_transfer / invoice  - required
    • shipping_type  delivery  : delivery to address /  pick_up  : pick up in Přestanov - required
    • currency - EUR - required
    • note
    • delivery_note - url of downloadable self delivery note file
    • delivery_date - requested delivery date in d.m.Y format
    • external_id (50) - your own order id

Output structure :

  • result
    • success - 0 : unsuccess request / 1 : success request
    • error_code - if success == 0
    • error_message - if success == 0
    • order - if success == 1
      • currency_code - CZK  /  EUR
      • order_id
      • total
        • price_products_without_tax price of products without tax
        • price_shipping_without_tax price of shipping without tax
        • price_with_tax price of all products and shipping with tax
      • products 
        • product  each product which is ordered
          • code - product code
          • quantity  
          • price_without_tax price of one product without tax
          • price_with_tax price of one product with tax
          • total_without_tax price for all products without tax
          • total_with_tax - price for all products including tax

 

Order state request

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

Input : XML file matching scheme  order_status_api_request.xsd

Output : XML file matching scheme   order_status_api_response.xsd

Input structure * :

  • order  - required
    • user  - required
      • email registration email - required
      • password password used in registration for eshop - required
    • order_id - order id which you get on start - required

 

Output structure :

  •  result
    • success  - 0 : unsuccess request / 1 : success request
    • error_code - if success == 0
    • error_message - if success == 0
    • order - if success == 1
      • order_id
      • status_id
      • status_label
      • internal_id order id which can be used for communication with back office of Jansen Display

 

*

Bold typed attributes are required if all parent attributes are filled in.

The bracket behind the attribute is the maximum length of its value.