Common cXML Elements

  • Updated

This documentation outlines how Unimarket uses common cXML elements, specifically the Address element, which is utilized across various cXML integration points (e.g. orders and invoices).

 

cXML Address Elements

The cXML Address element is used to represent location information (e.g., Ship To, Bill To). Below is the mapping of cXML fields to Unimarket address fields, based on the current format.

 

Example cXML Address Element (used in a 'ShipTo' context)

<Address addressID="testcode" isoCountryCode="NZ">
    <Name xml:lang="en">Anne Arundel</Name>
    <PostalAddress name="default">
        <DeliverTo>Amy Demo</DeliverTo>
        <Street>testline1</Street>
        <Street>testline2</Street>
        <Street>testline3</Street>
        <City>auckland</City>
        <State>Auckland</State>
        <PostalCode>1000</PostalCode>
        <Country isoCountryCode="NZ">New Zealand</Country>
    </PostalAddress>
</Address>

 

Field Mapping

The cXML fields map to Unimarket fields as follows:

cXML Field Example Unimarket Location Code Mandatory
<Address addressID> testcode Location Code N
<Name> Anne Arundel Organisation or Community name N
<DeliverTo> Amy Demo Buyer name N
<Street> (first occurrence) testline1 Location Address Line1 Y
<Street> (second occurrence) testline2 Location Address Line2 N
<Street> (third occurrence) testline3 Location Address Line3 N
<City> auckland Location City Y
<State> Auckland Location State or Region N
<PostalCode> 1000 Location Zip code N
<Country> New Zealand Location Country Y
<Country isoCountryCode> NZ Country Code Y