Articles in this section

Sending POX (Plain Old XML) Messages to Unimarket

Justin Gillion
  • Updated

Overview

POX stands for Plain Old XML and is a simpler alternative protocol for sending messages to Unimarket.


Basic getting started guide

  • Contact Unimarket to provide you with the authentication details required (tenant identifier, integration username and shared secret).
  • Review the Unimarket xml schema and identify the top-level request element to send to Unimarket.
  • Create a request message that conforms to the xml schema.
  • Send a valid POX message containing the request message and the authentication header element wrapped in a pox-envelope to one of the following two applicable urls.
  1. Supplier:
    1. https://supplier.unimarket.com/ws - US
    2. https://supplier.unimarket.co.nz/ws - NZ
    3. https://supplier.unimarket.com.au/ws - AU
  2. Community:
    1. https://<community code>.unimarket.com/ws - US
    2. https://<community code>.unimarket.com/ws - NZ
    3. https://<community code>.unimarket.com/ws - AU
Note: Please note that cXML requests (e.g. OrderRequest, InvoiceDetailRequst) do not need to be wrapped in a pox-envelope element as the authentication details are already included in the cXML request.

 

Example POX message

<?xml version="1.0" encoding="UTF-8"?>
<u:pox-envelope xmlns:u="http://www.unimarket.com/schema/unimarket-ws">
    <u:header>
        <u:authentication>
            <!-- Unique identifier of the Unimarket tenant (community or supplier) -->
            <u:tenant-ref identity="7f251a49-bd4d-4527-b234-d3d4a3e14e1b" domain="UNIMARKET_ID_DOMAIN"/>
            <u:sender>
                <!-- Unique identifier of the Unimarket integration user -->
                <u:user-ref identity="6cd91828-a4f4-4b70-b9ac-5f6f4d9e4082" domain="UNIMARKET_USERNAME_DOMAIN"/>
                <!-- Password used to authenticate the request -->
                <u:shared-secret>password1</u:shared-secret>
            </u:sender>
        </u:authentication>
    </u:header>
    <u:body>
        <create-quote-request xmlns='http://www.unimarket.com/schema/unimarket-ws'>
            <header>
                <to>
                    <!-- Unique Unimarket username of the user the quote is for -->
                    <user-ref identity='user1'/>
                    <!-- Unique Unimarket code of the user's community -->
                    <tenant-ref identity='AACC'/>
                </to>
                <summary>summary value</summary>
                <reference-code>quote ref value</reference-code>
                <expiry>2009-08-01T15:30:00</expiry>
            </header>
            <!-- e.g. line with tax -->
            <line quantity="2">
                <code>product code</code>
                <name>name value</name>
                <description>desc value</description>
                <unit-of-measure unit="EA"/>
                <unit-price iso-currency-code="USD">50.00</unit-price>
                <subtotal iso-currency-code="USD">100.00</subtotal>
                <tax iso-currency-code="USD">15</tax>
                <total iso-currency-code="USD">115</total>
            </line>
        </create-quote-request>
    </u:body>
</u:pox-envelope>

Related articles