API

API (Application Programming Interface)  of Showdown Displays Europe


pdf icon API connection FAQ

Functions

Place an order

URL :  https://shop.showdowndisplays.eu/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 - customer or supplier - required
      • email - registration email  - required
      • password - password used in registration for eshop - required
    • customer - required
      • person_type - required; organisation / person
      • 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 - iso codes 2 or 3 (e.g. DE or DEU for Germany) - required
        • telephone (45) - required
        • address_specification - delivery address specification
      • email - T&T email
    • products  - required
      • product - item for each product - required
        • code - product code - required
        • quantity - number of  items - required
        • printing_source - links to external printing source (occurrence 0:2)
        • print_guide_document - link to external printing guide document
        • frames - list of related frames for product (poster)
          • frame - for each relation between products
            • code - product code from list of products - required
            • quantity - relation qunatity - required
        • without_printing_source - order poster without printing (only paper)
    • currency - CZK  /  EUR / PLN / GBP / USD - required
    • shipping_type  -  delivery  : delivery to address /  pick_up : pick up in Přestanov - required
    • note
    • delivery_note - url of downloadable your own delivery note file
    • neutral_delivery - 1 for neutral delivery (without any logo on it)
    • delivery_date - requested delivery date in d.m.Y format
    • preferred_expedition_date - preferred expedition date in d.m.Y format
    • external_id (50) - your own order id
    • printing_related_order - code of existing order to take printing data from
    • preferred_warehouse - code of preferred warehouse, from which the Goods should be shipped. If empty, default warehouse.

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 / PLN / GBP / USD
      • 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
          • order_product_id -  order product id
          • 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 status request

URL :  https://shop.showdowndisplays.eu/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*
    • orders - list of orders to check (string containing order ids, delimited by commas or semicolons) - required*

    * (it is required to provide one of the fields order_id or orders)


        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 (1, 2, 3, 7)
            • status_label (Pending, Processing, Shipped, Canceled)
            • internal_id -  order id which can be used for communication with Showdown Customer care
            • shipping_date
            • shipping_company
            • tracking_numbers - list of tracking numbers
              • tracking_number - single tracking number
            • products 
              • product  -  each product which is ordered
                • order_product_id - order product id
                • code - product code
                • quantity  
                • printing_source  
                • print_proof_file   - link to print data preview if exists

        Order print proof confirmation

        URL :  https://shop.showdowndisplays.eu/api/order/print_confirmation

        Input : XML file matching scheme  order_print_proof_confirmation_request.xsd

        Output : XML file matching scheme   order_print_proof_confirmation_response.xsd

        Input structure :

        • order  - required
          • user  - required
            • email -  registration email - required
            • password -  password used in registration for eshop - required
          • order_id - order id for which you want to confirm print proofs - required


        Output structure :

        •  result
          • success  - 0 : unsuccess request / 1 : success request
          • error_code - if success == 0
          • error_message - if success == 0

        Print data change/deletion

        URL :  https://shop.showdowndisplays.eu/api/order/printing_source

        Input : XML file matching scheme  printing_source_api_request.xsd

        Output : XML file matching scheme   printing_source_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 for which you want to confirm print proofs - required
          • order_printing_sources - list of printing sources - required
            • order_printing_source -  specific order printing source - required
              • order_product_id - id of the specific order product whose printing source you want to change - required
              • printing_source - link to printing source itself - leaving this empty will lead to the deletion of printing source and marking as "without printing source"

        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