The purpose of this section is to provide an overview of the cXML ASN (Advance Ship Notice) in conjunction with cXML specifications for BuyerQuest.

Overview

ASNs are used to convey shipment information, including data about the carrier, tracking number(s), ship date, and more.

ASN Specifications

The ASN Specification is included in this file:

cXMLASN11.8.xlsx

An ASN cXML message broadly consists of two important elements: Header and Request. These elements are described in further detail below.

ASN Transaction Header

The ASN Header contains authentication and addressing information. Specific user information should not be included in the header, as it is not relevant to addressing or authentication.

ASN Request

Within the ASN Request, the ShipNoticeRequest element contains three main sub-elements:

ShipNoticeHeader

Contains data which applies to all packages within the shipment

ShipControl

Contains carrier information

ShipNoticePortion

Contains specific order reference and item information

ASN cXML Example 

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE cXML SYSTEM
"http://xml.cXML.org/schemas/cXML/1.2.009/Fulfill.dtd">
<cXML version="1.2.009" payloadID="1442348263.76879@ip-172.0.0.1" timestamp="2015-09-22T13:19:49.0418701-07:00" xml:lang="en-US">
     <Header>
          <From>
               <Credential domain="NetworkID">
                    <Identity>xxxxxx</Identity>
               </Credential>
          </From>
          <To>
               <Credential domain="NetworkID">
                    <Identity>xxxxxx</Identity>
               </Credential>
          </To>
          <Sender>
               <Credential domain="NetworkID">
                    <Identity>bqtest</Identity>
                    <SharedSecret>buyerquest</SharedSecret>
               </Credential>
               <UserAgent>Ecommerce Supplier</UserAgent>
          </Sender>
     </Header>
     <Request deploymentMode="production">
          <ShipNoticeRequest>
               <ShipNoticeHeader shipmentID="216736371082402" operation="new" noticeDate="2016-08-07T12:00:00-00:00" shipmentDate="2016-08- 07T06:41:00-00:00">
                    <Contact role="shipFrom">
                         <Name xml:lang="en-US">Supplier</Name>
                         <PostalAddress>
                              <Street>12345 Smith Rd</Street>
                              <City>Annapolis</City>
                              <State>MD</State>
                              <PostalCode>21075</PostalCode>
                              <Country isoCountryCode="US">United States</Country>
                         </PostalAddress>
                    </Contact>
               </ShipNoticeHeader>
               <ShipControl>
                    <CarrierIdentifier domain="SCAC">UPSG</CarrierIdentifier>
                    <CarrierIdentifier domain="companyName">UPS</CarrierIdentifier>
                    <ShipmentIdentifier trackingURL="http://wwwapps.ups.com/WebTracking/track? track=yes&trackNums=1Z123AB98765432101">1Z123AB98765432101</Shipment Identifier>
               </ShipControl>
               <ShipNoticePortion>
                    <OrderReference orderID="PO-01998" orderDate="2016-08- 03T01:26:41+00:00">
                         <DocumentReference payloadID="1507128668.37307@ip-127-0-0-1"/>
                    </OrderReference>
                    <ShipNoticeItem quantity="2" lineNumber="1">
                         <UnitOfMeasure>EA</UnitOfMeasure>
                         <Packaging>
                              <PackagingCode xml:lang="en- US">0976142736439xx</PackagingCode>
                              <Dimension quantity="2" type="weight">
                                   <UnitOfMeasure>EA</UnitOfMeasure>
                              </Dimension>
                         </Packaging>
                    </ShipNoticeItem>
               </ShipNoticePortion>
          </ShipNoticeRequest>
     </Request>
</cXML>

Next Steps

BuyerQuest will supply the following information:

1. URL the supplier will use to post their test cXML ASNs
2. URL the supplier will use to post their production cXML ASNs

ASN Endpoint URL

The URL for posting Advance Ship Notices is in this form: https://{buyerquest_site_url}/{client}/cxmlgate/abc/shipment