Skip to main content
Knowledge Base content is available to TradeCentric customers. To access all articles and videos, log in using single sign-on from Portal.

Advanced Shipment Notice: Standard cXML payload

  • Updated

The ShipNoticeRequest payload sends an advanced shipment notice (ASN) request from your system, such as your eCommerce platform or ERP system, to the TradeCentric platform so that we can deliver the ASN to the buyer's eProcurement system. For standard integrations that send cXML payloads, we accept the ASN payload in our standard cXML format.

This article describes the standard cXML format to use for this payload.

Important: This payload is for ASNs associated with purchase orders (POs) only. The payload must include the PO identifier from the PO request payload that we sent.

Jump to:

Request payload (to TradeCentric)
Response payload (from TradeCentric)

 

Request payload (to TradeCentric)

The code block below shows an example ShipNoticeRequest payload in our standard cXML format:

cXML
HTTP POST
ShipNoticeRequest
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE cXML SYSTEM "http://xml.cxml.org/schemas/cXML/1.2.014/Fulfill.dtd">
<cXML payloadID="12345678" timestamp="2022-11-18T08:30:00-04:00">
  <Header>
    <From>
      <Credential domain="NetworkID">
        <Identity>SupplierSystem</Identity>
      </Credential>
    </From>
    <To>
      <Credential domain="NetworkID">
        <Identity>BuyerSystem</Identity>
      </Credential>
    </To>
    <Sender>
      <Credential domain="NetworkID">
        <Identity>SupplierSystem</Identity>
        <SharedSecret>ABCD1234efgh5678.IJKL9012mnopq</SharedSecret>
      </Credential>
      <UserAgent>eCommerceASN</UserAgent>
    </Sender>
  </Header>
  <Request deploymentMode="production">
    <ShipNoticeRequest>
      <ShipNoticeHeader noticeDate="2022-11-18T06:00:00-04:00" shipmentID="ASN-456" shipmentDate="2022-11-18T08:30:00-04:00" deliveryDate="2022-11-22T15:30:00-04:00">
        <Contact role="shipTo">
          <Name xml:lang="en">Test Corp. - Nashville Branch</Name>
          <PostalAddress name="Default">
            <DeliverTo>Contact Name</DeliverTo>
            <Street>123 Test St.</Street>
            <City>Nashville</City>
            <State>TN</State>
            <PostalCode>37011</PostalCode>
            <Country isoCountryCode="US">United States</Country>
          </PostalAddress>
          <Email>contact@buyer.com</Email>
          <Phone>
            <TelephoneNumber>
              <CountryCode isoCountryCode="US"/>
              <AreaOrCityCode/>
              <Number>888-555-9876</Number>
            </TelephoneNumber>
          </Phone>
        </Contact>
        <Contact role="billTo">
          <Name xml:lang="en">Test Corp. - Nashville Branch</Name>
          <PostalAddress name="Default">
            <DeliverTo>Contact Name</DeliverTo>
            <Street>123 Test St.</Street>
            <City>Nashville</City>
            <State>TN</State>
            <PostalCode>37011</PostalCode>
            <Country isoCountryCode="US">United States</Country>
          </PostalAddress>
          <Email>contact@buyer.com</Email>
        </Contact>
        <Contact role="buyer">
          <Name xml:lang="en">Contact Name</Name>
          <Email>contact@testbuyer.com</Email>
        </Contact>
        <Extrinsic name="RequestedDeliveryDate">2022-12-25</Extrinsic>
      </ShipNoticeHeader>
      <ShipControl>
        <CarrierIdentifier domain="SCAC">UPSC</CarrierIdentifier>
        <CarrierIdentifier domain="companyName">United Parcel Service Ground</CarrierIdentifier>
        <ShipmentIdentifier>1Z56F78A0450293517</ShipmentIdentifier>
      </ShipControl>
      <ShipNoticePortion>
        <OrderReference orderID="PO-123">
          <DocumentReference payloadID="93369535150910.10.57.136"/>
        </OrderReference>
        <Comments>Items in this shipment are subject to a per-item packing fee for quantities less than 50.</Comments>
        <ShipNoticeItem lineNumber="101" quantity="2">
          <UnitOfMeasure>EA</UnitOfMeasure>
        </ShipNoticeItem>
      </ShipNoticePortion>
    </ShipNoticeRequest>
  </Request>
</cXML>

 

Request element details

A standard cXML ShipNoticeRequest payload has a root element, a Header element, and a Request element. The subsections below explain each element and its fields.

 

cXML root

Required Max use: 1

Applies identifying information to the entire payload

Example
<cXML payloadID="12345678" timestamp="2022-11-18T08:30:00-04:00">
  ...
</cXML>
Root field breakdown
  • payloadID
    ASN payload identifier

    RequiredType: String

    Provides the unique identifier for the ASN payload

    Example: payloadID="12345678"

  • timestamp
    Payload timestamp

    RequiredFormat: ISO 8601

    Provides the date and time when the payload was created

    Example: timestamp="2022-11-18T08:30:00-04:00"

 

Header

Required Max use: 1

Identifies the organizations involved in the transaction

Example
<Header>
  <From>
    <Credential domain="NetworkID">
      <Identity>SupplierSystem</Identity>
    </Credential>
  </From>
  <To>
    <Credential domain="NetworkID">
      <Identity>BuyerSystem</Identity>
    </Credential>
  </To>
  <Sender>
    <Credential domain="NetworkID">
      <Identity>SupplierSystem</Identity>
      <SharedSecret>ABCD1234efgh5678.IJKL9012mnopq</SharedSecret>
    </Credential>
    <UserAgent>eCommerceASN</UserAgent>
  </Sender>
</Header>
Header field breakdown
  • From
    Supplier credential

    Required

    Identifies your organization

    • domain Identifier type

      RequiredType: String

      Specifies the type of identifier provided in the credential

      Example: domain="NetworkID" = Network identifier value for your system

    • Identity Identifier

      RequiredType: String

      Provides the identifier value for the credential

      Example: <Identity>SupplierSystem</Identity>

  • To
    Buyer credential

    Required

    Identifies the buyer organization

    • domain Identifier type

      RequiredType: String

      Specifies the type of identifier provided in the credential

      Example: domain="NetworkID" = Network identifier value for the eProcurement system

    • Identity Identifier

      RequiredType: String

      Provides the identifier value for the credential

      Example: <Identity>BuyerSystem</Identity>

  • Sender
    Sender credential

    Required

    Identifies your system and provides its authentication information

    • domain Identifier type

      RequiredType: String

      Specifies the type of identifier provided in the credential

      Example: domain="NetworkID" = Network identifier value for your system

    • Identity Identifier

      RequiredType: String

      Provides the identifier value for the credential

      Example: <Identity>SupplierSystem</Identity>

    • SharedSecret Shared secret

      RequiredType: String

      Provides your shared secret, which is the password that your organization and TradeCentric agreed to use for authentication

      Example: <SharedSecret>ABCD1234efgh5678.IJKL9012mnopq</SharedSecret>

    • UserAgent User agent

      OptionalType: String

      Provides an informational identifier, such as a name, for the sending system

      Example: <UserAgent>eCommerceASN</UserAgent>

 

Request

Provides the ASN details, which are described in the subsections below

 

Shipment identification

Required Max use: 1

Provides identifying information about the shipment

Example
<Request deploymentMode="production">
  <ShipNoticeRequest>
    <ShipNoticeHeader noticeDate="2022-11-18T06:00:00-04:00" shipmentID="ASN-456" shipmentDate="2022-11-18T08:30:00-04:00" deliveryDate="2022-11-22T15:30:00-04:00">
Shipment identification field breakdown
  • deploymentMode
    Deployment mode

    RequiredType: StringValues: test, production

    Specifies whether the request is for test or production

    Example: deploymentMode="production"

  • noticeDate
    ASN date

    RequiredFormat: ISO 8601

    Provides the ASN issue date

    Example: noticeDate="2022-11-18T06:00:00-04:00"

  • shipmentID
    ASN identifier

    RequiredType: String

    Provides the unique identifier for the ASN

    Example: shipmentID="ASN-456"

  • shipmentDate
    Shipment date

    RequiredFormat: ISO 8601

    Provides the shipment date

    Example: shipmentDate="2022-11-18T08:30:00-04:00"

  • deliveryDate
    Delivery date

    OptionalFormat: ISO 8601

    Provides the expected delivery date

    Example: deliveryDate="2022-11-22T15:30:00-04:00"

 

Contacts and addresses

Required Max use: Many

Provides the ASN contact and address details

Example
<Contact role="shipTo">
  <Name xml:lang="en">Test Corp. - Nashville Branch</Name>
  <PostalAddress name="Default">
    <DeliverTo>Contact Name</DeliverTo>
    <Street>123 Test St.</Street>
    <City>Nashville</City>
    <State>TN</State>
    <PostalCode>37011</PostalCode>
    <Country isoCountryCode="US">United States</Country>
  </PostalAddress>
  <Email>contact@buyer.com</Email>
  <Phone>
    <TelephoneNumber>
      <CountryCode isoCountryCode="US"/>
      <AreaOrCityCode/>
      <Number>888-555-9876</Number>
    </TelephoneNumber>
  </Phone>
</Contact>
<Contact role="billTo">
  <Name xml:lang="en">Test Corp. - Nashville Branch</Name>
  <PostalAddress name="Default">
    <DeliverTo>Contact Name</DeliverTo>
    <Street>123 Test St.</Street>
    <City>Nashville</City>
    <State>TN</State>
    <PostalCode>37011</PostalCode>
    <Country isoCountryCode="US">United States</Country>
  </PostalAddress>
  <Email>contact@buyer.com</Email>
</Contact>
<Contact role="buyer">
  <Name xml:lang="en">Contact Name</Name>
  <Email>contact@testbuyer.com</Email>
</Contact>
Contact field breakdown
  • role
    Contact type

    OptionalType: String

    Specifies the type of contact provided

    Example: role="shipTo", role="billTo", role="buyer"

  • Name
    Contact or address name

    OptionalType: String

    Provides the contact or address name

    Example: <Name xml:lang="en">Test Corp. - Nashville Branch</Name>

    • xml:lang Language

      OptionalFormat: IETF BCP 47

      Specifies the language used for the name

      Example: xml:lang="en"

  • PostalAddress
    Postal address

    Optional

    Groups the address details

    • name Address name

      OptionalType: String

      Provides the address name

      Example: name="Default"

    • DeliverTo Deliver-to name

      OptionalType: String

      Provides the recipient name

      Example: <DeliverTo>Contact Name</DeliverTo>

    • Street Street address

      OptionalType: String

      Provides the street address

      Example: <Street>123 Test St.</Street>

    • City City

      OptionalType: String

      Provides the city

      Example: <City>Nashville</City>

    • State State

      OptionalType: String

      Provides the state

      Example: <State>TN</State>

    • PostalCode Postal code

      OptionalType: String

      Provides the postal code

      Example: <PostalCode>37011</PostalCode>

    • Country Country

      OptionalType: String

      Provides the country

      Example: <Country isoCountryCode="US">United States</Country>

    • isoCountryCode Country code

      OptionalFormat: ISO 3166

      Specifies the country code

      Example: isoCountryCode="US"

  • Email
    Email address

    OptionalType: String

    Provides the email address

    Example: <Email>contact@buyer.com</Email>

  • Phone
    Contact phone number

    Optional

    Groups the contact's phone number details

    • TelephoneNumber Telephone number

      Optional

      Provides the phone number values

      • CountryCode Telephone country code

        OptionalType: String

        Specifies the telephone country code

        Example: <CountryCode isoCountryCode="US"/>

        • isoCountryCode ISO country code

          OptionalFormat: ISO 3166

          Specifies the ISO country code

          Example: isoCountryCode="US"

      • AreaOrCityCode Area or city code

        OptionalType: String

        Provides the area or city code

        Example: <AreaOrCityCode/>

      • Number Phone number

        OptionalType: String

        Provides the phone number

        Example: <Number>888-555-9876</Number>

 

Extrinsic information

Optional Max use: Many

Provides any additional shipment attributes, which may vary depending on the integration's requirements

Example
<Extrinsic name="RequestedDeliveryDate">2022-12-25</Extrinsic>
Extrinsic field breakdown
  • Extrinsic
    Additional information

    OptionalType: String

    Provides additional information that may vary depending on the integration's requirements

    Example: <Extrinsic name="RequestedDeliveryDate">2022-12-25</Extrinsic>

    • name Information type

      Required if Extrinsic is used Type: String

      Specifies the type of additional information provided

      Example: name="RequestedDeliveryDate" = requested delivery date

 

Shipment information

Required Max use: 1

Provides carrier and tracking information for the shipment

Note: Our standard integrations only support one shipping carrier per ASN. 

Example
<ShipControl>
  <CarrierIdentifier domain="SCAC">UPSC</CarrierIdentifier>
  <CarrierIdentifier domain="companyName">United Parcel Service Ground</CarrierIdentifier>
  <ShipmentIdentifier>1Z56F78A0450293517</ShipmentIdentifier>
</ShipControl>
Shipment information field breakdown
  • CarrierIdentifier
    Carrier identifier

    RequiredType: StringMax use: Many for 1 carrier

    Provides the shipping carrier identifier

    Example: <CarrierIdentifier domain="SCAC">UPSC</CarrierIdentifier>, <CarrierIdentifier domain="companyName">United Parcel Service Ground</CarrierIdentifier>

    • domain Identifier type

      RequiredType: String

      Specifies the type of carrier identifier provided

      Example: domain="SCAC" = Standard Carrier Alpha Code, domain="companyName"

  • ShipmentIdentifier
    Tracking number

    RequiredType: String

    Provides the shipment tracking number

    Example: <ShipmentIdentifier>1Z56F78A0450293517</ShipmentIdentifier>

 

Other ASN details

Required Max use: 1

Provides PO reference information, comments, and item details for the shipment

Example
<ShipNoticePortion>
  <OrderReference orderID="PO-123">
    <DocumentReference payloadID="93369535150910.10.57.136"/>
  </OrderReference>
  <Comments>Items in this shipment are subject to a per-item packing fee for quantities less than 50.</Comments>
  <ShipNoticeItem lineNumber="101" quantity="2">
    <UnitOfMeasure>EA</UnitOfMeasure>
  </ShipNoticeItem>
</ShipNoticePortion>
Other details field breakdown
  • OrderReference
    PO reference

    Required

    Provides details about the PO that the ASN is associated with

    • orderID Buyer PO identifier

      RequiredValue: Same as PO request

      Provides the PO identifier from the PO request payload that we sent

      Example: orderID="PO-123"

    • DocumentReference PO payload reference

      Optional

      Provides reference information for the PO payload

      Example: <DocumentReference payloadID="93369535150910.10.57.136"/>

      • payloadID Payload identifier

        Optional Value: Same as PO request

        Provides the unique payload identifier from the PO request payload that we sent

        Example: payloadID="93369535150910.10.57.136"

  • Comments
    Shipment comments

    OptionalType: String

    Provides any additional details about the shipment

    Example: <Comments>Items in this shipment are subject to a per-item packing fee for quantities less than 50.</Comments>

  • ShipNoticeItem
    Item details

    Required

    Provides details about each of the line items in the shipment

    • lineNumber PO line number

      RequiredType: String

      Provides the line number from the PO request payload that we sent

      Example: lineNumber="101"

    • quantity Item quantity

      RequiredType: Number

      Provides the shipped item quantity

      Example: quantity="2"

    • UnitOfMeasure Unit of measure

      RequiredType: String

      Provides the unit of measure for the item

      Example: <UnitOfMeasure>EA</UnitOfMeasure>

 

Response payload (from TradeCentric)

Once our platform processes the ASN payload, we'll return a cXML response payload. This response will indicate whether we created a final ASN payload to transmit to the buyer.

The code block below shows an example response in our standard cXML format:

cXML
HTTP response
ASN response
<?xml version="1.0" encoding="UTF-8"?>
<cXML xml:lang="en-US" payloadID="12345678-response" timestamp="2022-11-18T08:30:01-04:00">
  <Response>
    <Status code="200" text="OK">Successful</Status>
  </Response>
</cXML>

 

Response element details

A standard cXML response has a root element and a Response element. The subsections below explain each element and its fields.

 

cXML root

Applies identifying information to the entire response payload

Example
<cXML xml:lang="en-US" payloadID="12345678-response" timestamp="2022-11-18T08:30:01-04:00">
  ...
</cXML>
Root field breakdown
  • xml:lang
    Language

    Format: IETF BCP 47

    Specifies the language used for the response

    Example: xml:lang="en-US"

  • payloadID
    Response payload identifier

    Type: String

    Provides a unique identifier for the response payload

    Example: payloadID="12345678-response"

  • timestamp
    Response timestamp

    Format: ISO 8601

    Provides the date and time when the response was created

    Example: timestamp="2022-11-18T08:30:01-04:00"

 

Response

Indicates that we either accepted or rejected the ASN

Note: Errors are limited at this step of the process. For example, error responses may not indicate the specific issue on the buyer's side.

Example
<Response>
  <Status code="200" text="OK">Successful</Status>
</Response>
Response field breakdown
  • Status
    Response status

    Specifies the success or error status and a corresponding message

    Example: <Status code="200" text="OK">Successful</Status>, <Status code="400" text="Bad request">Unable to process ASN</Status>

    • code Status code

      Format: HTTP status code

      Provides the response status code

      Example: code="200" = success, code="400" = error

    • text Status text

      Type: String

      Provides a brief description of the status

      Example: text="OK", text="Bad request"

Was this article helpful?
0 out of 0 found this helpful
Return to top
© 2026 TradeCentric. All rights reserved.
Confidential and proprietary. For use by TradeCentric and organizations under NDA only. Not for public distribution.

Related articles