For the complete documentation index, see llms.txt. This page is also available as Markdown.

Sending POX (Plain Old XML) Messages to Unimarket

POX (Plain Old XML) is a simplified protocol used for communicating with Unimarket when full SOAP overhead is not required. It is primarily used for administrative and data-sync integrations like user provisioning, budget checks, and approval configurations.

The POX Message Structure

Unlike standard cXML, which includes its own authentication headers, POX messages must be wrapped in a specific pox-envelope. This envelope contains two main parts:

  • Authentication Header: Contains your tenant identifier, username, and shared secret.

  • Request Body: Contains the actual uXML request (e.g., a budget check or user update).

Implementation Guide

To get started with POX integration, follow these four steps:

Step 1: Obtain Credentials

Contact Unimarket to receive the following mandatory security details:

  • Tenant Identifier: Your unique community or supplier ID.

  • Integration Username: The specific service account name.

  • Shared Secret: The secure password for the integration.

Step 2: Identify the Request Type

Determine which uXML element you need to send. Common top-level elements include:

  • validate-account-code-request

  • user-detail-request

  • approval-configuration-request

Step 3: Construct the Envelope

Wrap your request and credentials in the pox-envelope.

POX Envelope Example:

Step 4: Submit to the Endpoint

Send your message as an HTTPS POST to the applicable regional URL.

Location
Supplier Endpoint
Community Endpoint

United States

https://supplier.unimarket.com/ws

https://<code>.unimarket.com/ws

New Zealand

https://supplier.unimarket.co.nz/ws

https://<code>.unimarket.co.nz/ws

Australia

https://supplier.unimarket.com.au/ws

https://<code>.unimarket.com.au/ws

Important Distinction: cXML vs. POX

It is important to note that cXML messages (such as OrderRequest or InvoiceDetailRequest) do not require a POX envelope. These messages already contain an internal <Header> with <Sender> credentials, so they can be posted directly to the endpoint without the pox-envelope wrapper.

For the SOAP equivalent of this transport, see Sending SOAP Messages to Unimarket. For a full list of available message types, see Webservice Integration Technical Documentation & Examples.

Last updated