The shipment service is used to prepare each shipment / parcel. It's typically called from software in the customer terminal, as part of a job. Send the shipment addresses (sender / consignee) and parcel details for customs. The service returns a shipping label, and tracking number.
Sample request, with return to shipper indicated. Don't specify a return address in this case. createshipment_noreturn.xml
<xml>
<shipment service="Parcel Max" account="ABC" datetime="2020-07-18T13:04:53" reference="123-12345" jobnumber="54321" value="250" currency="USD" uom="kg" weight="0.82" returntoshipper="1" originterminal="LHR" merchantARN="12345" purchaserABN="234" GSTexemptioncode="8675309" dutystatus="DDU" taxidcode="GB100569447000">
<shipper name="ABC Company" attention="Harold Styles" addr1="123 Main Street" addr2="Apartment 123" city="Braeside" state="VIC" country="AU" postal="3195" phone="+61 3 8586 1200" email="support@daipost.com" />
<consignee name="ABC Company" attention="Harold Styles" addr1="123 Main Street" addr2="Apartment 123" city="Braeside" state="VIC" country="AU" postal="3195" phone="+61 3 8586 1200" email="support@daipost.com" />
<item description="iPad" qty="5" unit="pc" value="250.00" origin="CN" cpc="1000001" />
</shipment>
</xml>Sample request, with multiple items in a single parcel. createshipment_multipleitems.xml
<xml>
<shipment service="Parcel Max" datetime="2020-07-18T13:04:53" reference="123-12345" jobnumber="54321" value="260" currency="USD" uom="kg" weight="0.82" originterminal="LHR" dutystatus="DDU">
<shipper name="ABC Company" attention="Harold Styles" addr1="123 Main Street" addr2="Apartment 123" city="Braeside" state="VIC" country="AU" postal="3195" phone="+61 3 8586 1200" email="support@daipost.com" />
<consignee name="ABC Company" attention="Harold Styles" addr1="123 Main Street" addr2="Apartment 123" city="Braeside" state="VIC" country="AU" postal="3195" phone="+61 3 8586 1200" email="support@daipost.com" />
<item description="iPad" qty="5" unit="pc" value="250.00" origin="CN" cpc="1000001" />
<item description="iPad Case" qty="5" unit="pc" value="10.00" origin="CN" />
</shipment>
</xml>XSD / Schema - shipment.xsd Download shipment.xsd
<xs:schema elementFormDefault="qualified" attributeFormDefault="unqualified" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:element name="xml">
<xs:complexType>
<xs:sequence>
<xs:element name="shipment" minOccurs="1" maxOccurs="1">
<xs:complexType>
<xs:sequence>
<xs:element name="shipper" minOccurs="1" maxOccurs="1">
<xs:complexType>
<xs:attribute name="name" use="required">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="80" />
<xs:minLength value="1" />
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="lastname">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="80" />
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="attention">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="80" />
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="addr1" use="required">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="80" />
<xs:minLength value="1" />
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="addr2">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="80" />
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="addr3">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="80" />
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="city" use="required">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="80" />
<xs:minLength value="1" />
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="state">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="50" />
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="country" use="required">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="2" />
<xs:minLength value="1" />
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="postal" use="required">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="20" />
<xs:minLength value="1" />
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="phone">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="40" />
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="email">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="150" />
</xs:restriction>
</xs:simpleType>
</xs:attribute>
</xs:complexType>
</xs:element>
<xs:element name="consignee" minOccurs="1" maxOccurs="1">
<xs:complexType>
<xs:attribute name="name" use="required">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="80" />
<xs:minLength value="1" />
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="lastname">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="80" />
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="attention">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="80" />
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="addr1" use="required">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="80" />
<xs:minLength value="1" />
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="addr2">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="80" />
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="addr3">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="80" />
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="city" use="required">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="80" />
<xs:minLength value="1" />
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="state">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="50" />
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="country" use="required">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="2" />
<xs:minLength value="1" />
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="postal" use="required">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="20" />
<xs:minLength value="1" />
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="phone">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="40" />
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="email">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="150" />
</xs:restriction>
</xs:simpleType>
</xs:attribute>
</xs:complexType>
</xs:element>
<xs:element name="return" minOccurs="0" maxOccurs="1">
<xs:complexType>
<xs:attribute name="name" use="required">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="80" />
<xs:minLength value="1" />
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="lastname">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="80" />
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="attention">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="80" />
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="addr1" use="required">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="80" />
<xs:minLength value="1" />
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="addr2">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="80" />
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="addr3">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="80" />
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="city" use="required">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="80" />
<xs:minLength value="1" />
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="state">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="50" />
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="country" use="required">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="2" />
<xs:minLength value="1" />
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="postal" use="required">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="20" />
<xs:minLength value="1" />
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="phone">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="40" />
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="email">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="150" />
</xs:restriction>
</xs:simpleType>
</xs:attribute>
</xs:complexType>
</xs:element>
<xs:element name="item" minOccurs="0" maxOccurs="unbounded">
<xs:complexType>
<xs:attribute name="itemcode">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="50" />
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="description" use="required">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="250" />
<xs:minLength value="1" />
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="qty" use="required" type="xs:string" />
<xs:attribute name="unit" use="required">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="25" />
<xs:minLength value="1" />
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="value" use="required">
<xs:simpleType>
<xs:restriction base="xs:decimal">
<xs:fractionDigits value="2" />
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="hscode">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="30" />
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="origin">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="2" />
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="exportreason">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="15" />
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="cpc">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="7" />
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="ordernbr">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="50" />
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="descriptioncn">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="250" />
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="taxcode">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="50" />
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="producturl">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="250" />
</xs:restriction>
</xs:simpleType>
</xs:attribute>
</xs:complexType>
</xs:element>
</xs:sequence>
<xs:attribute name="service" use="required">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:enumeration value="Parcel Max">
<!--Parcel Max-->
</xs:enumeration>
<xs:enumeration value="INTL-S">
<!--International Standard-->
</xs:enumeration>
<xs:enumeration value="DOM-T">
<!--Domestic Tracked-->
</xs:enumeration>
<xs:enumeration value="returnlabel">
<!--DAI Return Label-->
</xs:enumeration>
<xs:enumeration value="Parcel Right">
<!--Parcel Right-->
</xs:enumeration>
<xs:enumeration value="Reship">
<!--ReShip Tracked-->
</xs:enumeration>
<xs:enumeration value="Parcel Max Access">
<!--Parcel Max Access-->
</xs:enumeration>
<xs:enumeration value="Parcel Right International">
<!--Parcel Right International-->
</xs:enumeration>
<xs:maxLength value="20" />
<xs:minLength value="1" />
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="labelformat">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="3" />
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="account">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="5" />
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="originterminal">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="8" />
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="reference" use="required">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="40" />
<xs:minLength value="1" />
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="referencesuffix" type="xs:boolean" />
<xs:attribute name="datetime" use="required">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="30" />
<xs:minLength value="1" />
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="jobnumber">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="30" />
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="costcentre">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="50" />
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="value">
<xs:simpleType>
<xs:restriction base="xs:decimal">
<xs:fractionDigits value="2" />
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="currency" use="required">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="3" />
<xs:minLength value="1" />
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="uom" use="required">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="2" />
<xs:minLength value="1" />
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="weight" use="required">
<xs:simpleType>
<xs:restriction base="xs:decimal">
<xs:fractionDigits value="4" />
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="leaveatdoor" type="xs:boolean" />
<xs:attribute name="signature" type="xs:boolean" />
<xs:attribute name="donotdropship" type="xs:boolean" />
<xs:attribute name="returntoshipper" type="xs:boolean" />
<xs:attribute name="dimunit">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="2" />
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="length">
<xs:simpleType>
<xs:restriction base="xs:decimal">
<xs:fractionDigits value="2" />
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="width">
<xs:simpleType>
<xs:restriction base="xs:decimal">
<xs:fractionDigits value="2" />
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="height">
<xs:simpleType>
<xs:restriction base="xs:decimal">
<xs:fractionDigits value="2" />
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="merchantARN">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="20" />
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="purchaserABN">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="20" />
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="GSTexemptioncode">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="20" />
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="insurance" type="xs:string" />
<xs:attribute name="insuredvalue">
<xs:simpleType>
<xs:restriction base="xs:decimal">
<xs:fractionDigits value="2" />
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="dangerous" type="xs:boolean" />
<xs:attribute name="iossid">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="50" />
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="merchanttaxref">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="50" />
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="gstpaid" type="xs:boolean" />
<xs:attribute name="dutystatus">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="3" />
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="dropofflocationid" type="xs:string" />
<xs:attribute name="taxidcode">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="14" />
</xs:restriction>
</xs:simpleType>
</xs:attribute>
</xs:complexType>
</xs:element>
<xs:sequence>
<xs:element name="error" minOccurs="0" maxOccurs="unbounded">
<xs:complexType>
<xs:attribute name="code" use="required" type="xs:string" />
<xs:attribute name="description" use="required">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="500" />
<xs:minLength value="1" />
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="context">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="50" />
</xs:restriction>
</xs:simpleType>
</xs:attribute>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:sequence>
<xs:anyAttribute />
</xs:complexType>
</xs:element>
</xs:schema>Represents a single shipment
| Name | Description | Type | Optional | Sample Value |
|---|---|---|---|---|
| service | Specify the level of service for shipment See reference values for "product" | Text (20) | Parcel Max | |
| labelformat | PDF or ZPL | Text (3) | Optional | |
| account | 3 letter account code, optional except for customers supporting multiple accounts | Text (5) | Optional | ABC |
| originterminal | 3 Letter IATA code of the origin terminal. Optional for the return service only | Text (8) | Optional | LHR |
| reference | Customer reference code that uniquely identifies this parcel. The value will be included in the shipping label and invoice data. Duplicate reference values will trigger an error. | Text (40) | 123-12345 | |
| referencesuffix | Use this field to disable the requirement for unique reference field values. A unique date-time suffix is added to any reference record that previously used the current reference number. When using this setting, customers must ensure that they do not send a parcel more than one time. | boolean | Optional | 1 |
| datetime | Local Date Time | datetime | 2020-07-18T13:04:53 | |
| jobnumber | Job number that groups shipments together. Optional if calling the manifest with each shipment in the job. | Text (30) | Optional | 54321 |
| costcentre | Secondary reference field | Text (50) | Optional | Project 123 |
| value | Total value of all items. Optional for AU to AU shipments | Decimal (2) | Optional | 10.99 |
| currency | Currency for shipment and item value. Use 3 character ISO 4217 Currency Code (ie USD, CAD, AUD, GBP, EUR) | Text (3) | USD | |
| uom | Unit of measure (LB or KG. KG by default) | Text (2) | KG | |
| weight | Total weight of the shipment, in the specified unit of measure | Decimal (4) | 1.123 | |
| leaveatdoor | Instructs driver to leave at door (incompatible with signature) | boolean | Optional | 1 |
| signature | Indicates if a signature is required. | boolean | Optional | 1 |
| donotdropship | Delivery driver should not leave the parcel at the door, if no one is there to receive it. | boolean | Optional | 1 |
| returntoshipper | Use the shipper address for returns, otherwise use the specified return address. | boolean | Optional | |
| dimunit | Dimension Unit (IN = inches, CM = Centimeters) Defaults to CM if not specified | Text (2) | Optional | CM |
| length | Length of Parcel, in the specified dimensional units | Decimal (2) | Optional | 20.0 |
| width | Width of Parcel in specified dimensional units | Decimal (2) | Optional | 15.5 |
| height | Height of parcel in specified dimensional units | Decimal (2) | Optional | 3.0 |
| merchantARN | Merchant (sub-client) needs to provide the ARN for GST calculation | Text (20) | Optional | 123456 |
| purchaserABN | Merchant to provide ABN of purchaser (if applicable) | Text (20) | Optional | 2345 |
| GSTexemptioncode | If GST has not been charged then provide the exemption code | Text (20) | Optional | 12345 |
| insurance | Indicate if you wish to insure the parcel. See your customer contract for insurance coverage terms. | Text () | Optional | 1 |
| insuredvalue | Insured value in AUD | Decimal (2) | Optional | 100.00 |
| dangerous | Indicates dangerous goods | boolean | Optional | 1 |
| iossid | International shipment tax reference | Text (50) | Optional | |
| merchanttaxref | The seller’s GST registration number for Singapore shipments | Text (50) | Optional | 12345 |
| gstpaid | Indicate whether GST has been paid for Singapore shipments | boolean | Optional | 1 |
| dutystatus | Duty Status/Incoterm value | Text (3) | Optional | DDP |
| dropofflocationid | Drop-Off Location ID | Text () | Optional | |
| taxidcode | Is a Retailer/Shipper specific Tax ID required for export/import purposes by customs | Text (14) | Optional | GB100569447000 |
Address of shipper or consignee
| Name | Description | Type | Optional | Sample Value |
|---|---|---|---|---|
| name | name of shipper or consignee | Text (80) | ABC Company | |
| lastname | Last name of shipper or consignee | Text (80) | Optional | |
| attention | 2nd, optional name of the shipper or consignee | Text (80) | Optional | Harold Styles |
| addr1 | Address line 1 | Text (80) | 123 Main Street | |
| addr2 | Address line 2 | Text (80) | Optional | Apartment 123 |
| addr3 | Address line 3 | Text (80) | Optional | |
| city | City | Text (80) | Braeside | |
| state | State / Province. Use standard postal abbreviations. Required for AU, US | Text (50) | Optional | VIC |
| country | ISO 3166 Alpha 2 letter country code | Text (2) | AU | |
| postal | Postal Code | Text (20) | 3195 | |
| phone | Local phone number | Text (40) | Optional | +61 3 8586 1200 |
| email address, used for follow-up communication | Text (150) | Optional | support@daipost.com |
Address of shipper or consignee
| Name | Description | Type | Optional | Sample Value |
|---|---|---|---|---|
| name | name of shipper or consignee | Text (80) | ABC Company | |
| lastname | Last name of shipper or consignee | Text (80) | Optional | |
| attention | 2nd, optional name of the shipper or consignee | Text (80) | Optional | Harold Styles |
| addr1 | Address line 1 | Text (80) | 123 Main Street | |
| addr2 | Address line 2 | Text (80) | Optional | Apartment 123 |
| addr3 | Address line 3 | Text (80) | Optional | |
| city | City | Text (80) | Braeside | |
| state | State / Province. Use standard postal abbreviations. Required for AU, US | Text (50) | Optional | VIC |
| country | ISO 3166 Alpha 2 letter country code | Text (2) | AU | |
| postal | Postal Code | Text (20) | 3195 | |
| phone | Local phone number | Text (40) | Optional | +61 3 8586 1200 |
| email address, used for follow-up communication | Text (150) | Optional | support@daipost.com |
Specify a return address, if the return to shipper is not indicated.
| Name | Description | Type | Optional | Sample Value |
|---|---|---|---|---|
| name | name of shipper or consignee | Text (80) | ABC Company | |
| lastname | Last name of shipper or consignee | Text (80) | Optional | |
| attention | 2nd, optional name of the shipper or consignee | Text (80) | Optional | Harold Styles |
| addr1 | Address line 1 | Text (80) | 123 Main Street | |
| addr2 | Address line 2 | Text (80) | Optional | Apartment 123 |
| addr3 | Address line 3 | Text (80) | Optional | |
| city | City | Text (80) | Braeside | |
| state | State / Province. Use standard postal abbreviations. Required for AU, US | Text (50) | Optional | VIC |
| country | ISO 3166 Alpha 2 letter country code | Text (2) | AU | |
| postal | Postal Code | Text (20) | 3195 | |
| phone | Local phone number | Text (40) | Optional | +61 3 8586 1200 |
| email address, used for follow-up communication | Text (150) | Optional | support@daipost.com |
Include 1 item element for each item in the shipment. Optional for AU to AU shipments only.
| Name | Description | Type | Optional | Sample Value |
|---|---|---|---|---|
| itemcode | Account Item identifier / SKU | Text (50) | Optional | SKU-123 |
| description | Description of the item. | Text (250) | iPad Case | |
| qty | Quantity. The number of items, must be at least 1 | int | 5 | |
| unit | Type of item (box, pc, carton) | Text (25) | pc | |
| value | Total value for all items. If each piece costs 2.00, and qty=5, then indicate 10.00 | Decimal (2) | 10.00 | |
| hscode | Harmonization Code | Text (30) | Optional | OU812 |
| origin | Country of origin. Specify the ISO 3166-1 Alpha 2 Letter code for the country of origin | Text (2) | Optional | CN |
| exportreason | Identifies why the item is being exported (Sale, Gift, etc.) | Text (15) | Optional | Sale |
| cpc | (Customs procedure code) Used to determine nature of export, ie Bonded, Non Bonded etc | Text (7) | Optional | 1000001 |
| ordernbr | Specific order number of the item to be updated | Text (50) | Optional | 1234567890 |
| descriptioncn | Description CN of the item | Text (250) | Optional | 商品描述 |
| taxcode | Taxcode of the item | Text (50) | Optional | 1234567890 |
| producturl | Product URL of the item | Text (250) | Optional | https://sampleproductURL.com/order/1234567890 |
Sample shipment response with base64 encoded ZPL label. createshipment_response.xml
<xml> <shipmentresponse tracknbr="1234567" label="^XA^CF,0,0,0^PR12^MD30^PW800^POI^CI13^LH0,20
^FO12...Value Truncated" /> </xml>
Sample shipment with a duplicate reference response. createshipment_err_response.xml
<xml>
<shipmentresponse>
<error code="102" description="Duplicate Reference" context="Shipment reference 123 has already been used." />
</shipmentresponse>
</xml>XSD / Schema - shipmentresponse.xsd Download shipmentresponse.xsd
<xs:schema elementFormDefault="qualified" attributeFormDefault="unqualified" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:element name="xml">
<xs:complexType>
<xs:sequence>
<xs:element name="shipmentresponse" minOccurs="1" maxOccurs="unbounded">
<xs:complexType>
<xs:sequence>
<xs:element name="error" minOccurs="0" maxOccurs="unbounded">
<xs:complexType>
<xs:attribute name="code" use="required" type="xs:string" />
<xs:attribute name="description" use="required">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="500" />
<xs:minLength value="1" />
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="context">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="50" />
</xs:restriction>
</xs:simpleType>
</xs:attribute>
</xs:complexType>
</xs:element>
</xs:sequence>
<xs:attribute name="tracknbr" use="required">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="30" />
<xs:minLength value="1" />
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="labelformat">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="3" />
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="label" use="required" type="xs:string" />
<xs:attribute name="barcode">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="100" />
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="lodgement">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="10" />
</xs:restriction>
</xs:simpleType>
</xs:attribute>
</xs:complexType>
</xs:element>
<xs:sequence>
<xs:element name="error" minOccurs="0" maxOccurs="unbounded">
<xs:complexType>
<xs:attribute name="code" use="required" type="xs:string" />
<xs:attribute name="description" use="required">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="500" />
<xs:minLength value="1" />
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="context">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="50" />
</xs:restriction>
</xs:simpleType>
</xs:attribute>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:sequence>
<xs:anyAttribute />
</xs:complexType>
</xs:element>
</xs:schema>The shipment response is returned in response to the shipment request. Callers should first check for any error nodes before processing the response. The response contains a tracking number, and shipping label.
| Name | Description | Type | Optional | Sample Value |
|---|---|---|---|---|
| tracknbr | Tracking Number that can be used for all subsequent tracking requests. | Text (30) | 8675309 | |
| labelformat | PDF or ZPL returned. ZPL is not base 64 encoded. PDF is based 64 encoded. | Text (3) | Optional | |
| label | Shipping Label in the specified label format | Text () | ||
| barcode | Shipment barcode # | Text (100) | Optional | |
| lodgement | Shipment lodgement point | Text (10) | Optional |
Errors are formatted into error elements / objects. A full list of error codes appears in the reference section of this document.
| Name | Description | Type | Optional | Sample Value |
|---|---|---|---|---|
| code | Code value of the error | int | 100 | |
| description | Text description of the error message | Text (500) | Invalid XML | |
| context | Error context information | Text (50) | Optional | Error on line 1 |