Ship Notification Guidelines

See How To Use this Guide before reading the below information.

Message Type: IEXP_SHIP_NOTICE

Info Exchange Display Name: Shipment Notification

When sending an element in Date or DateTime format, a valid date must be given. "00" is not a valid day or month value and "0000" is not a valid year value.
Data Element Occurs Format Length Enums Req Description
pt:PTAdvanceShipmentNotification [1...1] - - - M Product Track Advance Shipment Notification root element.
  pt:ControlFileHeader [1...1] - - - M XML file control header record.
    cmn:FileSenderNumber [1...1] String [1/20] - M File sender's company identifier. *1
    cmn:FileReceiverNumber [1...1] String [1/20] - M File recipient's company identifier. *2
    cmn:FileControlNumber [1...1] String [1/*] - M Unique file control ID number. *3
    cmn:FileDate [1...1] Date [10/10] - M Date file generated in XML YYYY-MM-DD format. *4
    cmn:FileTime [1...1] Time [9/9] - M Time file generated in XML HH:MM:SSZ format (must be GMT). *5
  pt:MessageBody [1...1] - - - M Canonical file control header.
    pt:ShipmentTransaction [1...1] - - - M Header data for shipment.
      cmn:ShipmentIdentifiers [1...1] - - - M Shipment document or other identification numbers.

Shipment document ID required. Bill of Lading number should be sent if available but it is not mandatory.
        cmn:ShipmentId [1...*] String [1/*] - M Shipment or document number for the delivery. *6
          @type [1...1] String [1/*] ShipmentIDType M Type of shipment ID. *7
      cmn:DocumentDate [0...1] Date [0/*] - O Date for the shipment document in XML date format YYYY-MM-DD. *8
      pt:TransactionDates [0...1] - - - M Header level DQS transaction information for ASN.
        cmn:TransactionDate [0...1] Date [0/*] - O Transaction date. Date the transfer of ownership for the goods is effective. *9
       

cmn:ShipmentDate

 [0...1] Date [0/*] - M Shipment date for delivery. *10
      pt:ShipmentInformation [0...1] - - - M Header level shipping information for delivery.
        cmn:DocumentControl [0...1] String [0/*] - M Indicates ASN is a new original document.

Valid value: Original. *11
        cmn:LadingQuantity [0...1] Decimal [0/*] - O Total number of packages in shipment. *12
        cmn:GrossWeight [0...1] Decimal [0/*] - O Gross weight for shipment. *13
          @weightUnitOfMeasure [0...1] String [0/*] WeightUOM C HDMA weight units of measure. *14
Mandatory if cmn:GrossWeight is populated.
        cmn:ShipmentStatus [0...1] String [0/*] - O Shipment status code. Status of order or shipment or disposition of any difference between quantity ordered and quantity shipped for a transaction.

Valid values: *15

  • CC - Shipment complete
  • PR - Partial shipment
      pt:TransportationInformation [0...*] - - - O Transport, routing, and shipping information for shipment. Optional group.
        cmn:CarrierSCACNumber [0...1] String [0/*] - O The carrier's 4-character standard SCAC number code. *16
        cmn:CarrierName [0...1] String [0/*] - O Carrier name. *17
        cmn:TransportMethod [0...1] String [0/*] TransportMethod O Mode of transportation used for the shipment. *18
        cmn:PackageTrackingNumber [0...1] String [0/*] - O Carrier's tracking number for package at shipment header level. *19
      pt:BusinessEntityDetails [1...1] - - - M All parties, shipping organizations, and locations relevant to the shipment and delivery at the shipment header level. Accommodates the following partner address types:
  • Business address for transfer from party - Required
  • Shipping address for transfer from party - Required
  • Business address for transfer to party - Required
  • Shipping address for transfer to party - Required
        cmn:SenderInfo [1...1] - - - M Business and shipping address Information about the supply chain partner from whom ownership is being transferred in the shipment.
          cmn:FromBusinessPartyInfo [0...1] String [1/*] - M Transfer from business party address information.
            cmn:BusinessId [1...*] String [1/*] - M This identifies the sending party who is transferring ownership of the product to the receiving party.

Valid values: *20

  • COMPANYID = Company ID
  • COMPANYSITEID = Company site ID
  • DEA = Drug Enforcement Agency number
  • DUNS = Dun and Bradstreet ID
  • DUNS4 = DUNS+4 ID
  • GLN = Global Location Number
  • HIN = Health Industry Number
  • PARTNERCOMPANYID - Required for Wal-Mart.
              @type [1...1] String [1/*] AddressIdQualifier M The type of the BusinessID identifier. *21
  • For DQSA purposes, only GLN, DEA and HIN are allowed.
  • For X12 ASN purposes, DUNS, DUNS+4, COMPANYID, and COMPANYSITEID are also supported.
            cmn:BusinessInfo [0...1] - - - M Address details.
              cmn:BusinessName [1...1] String [1/*] - M The business name of the trading partner. *22
              cmn:Name2 [0...1] String [0/*] - O Business name line 2 for the trading partner.
              cmn:Street1 [1...1] String [1/*] - M The first line of the street address. *23
              cmn:Street2 [0...1] String [0/*] - O The second line of the street address. *24
              cmn:City [1...1] String [1/*] - M The city. *25
              cmn:StateOrRegion [1...1] String [1/*] - M The state, province, or region using the standard two-letter abbreviation specified in ISO 3166-2:1998 country subdivision code. *26
              cmn:PostalCode [1...1] String [1/*] - M The ZIP or other postal code. *27
              cmn:Country [0...1] String [1/*] - M The country using the standard two-letter abbreviation specified in ISO 3166-1alpha-2:1997 country code. *28
          cmn:ShipFromLocationInfo [0...1] - - - O Transfer from shipping location address information.
            cmn:FacilityId [0...*] String [1/*] - O This identifies the ship from location that is transferring ownership of the product to the receiving party.

Valid values: *29

  • COMPANYID = Company ID
  • COMPANYSITEID = Company site ID
  • DEA = Drug Enforcement Agency number
  • DUNS = Dun and Bradstreet ID
  • DUNS4 = DUNS+4 ID
  • GLN = Global Location Number
  • HIN = Health Industry Number
              @type [1...1] String [1/*] AddressIdQualifier C The type of the BusinessID identifier. *30
  • For DQSA purposes, only GLN, DEA and HIN are allowed.
  • For X12 ASN purposes, DUNS, DUNS+4, COMPANYID, and COMPANYSITEID are also supported.
            cmn:LocationInfo [1...1] - - - M Address details.
              cmn:BusinessName [1...1] String [1/*] - M The business name of the trading partner. *31
              cmn:Name2 [0...1] String [0/*] - O Business name line 2 for the trading partner.
              cmn:Street1 [1...1] String [1/*] - M The first line of the street address. *32
              cmn:Street2 [0...1] String [0/*] - O The second line of the street address. *33
              cmn:City [1...1] String [1/*] - M The city. *34
              cmn:StateOrRegion [1...1] String [1/*] - M The state, province, or region using the standard two-letter abbreviation specified in ISO 3166-2:1998 country subdivision code. *35
              cmn:PostalCode [1...1] String [1/*] - M The ZIP or other postal code. *36
              cmn:Country [0...1] String [1/*] - M The country using the standard two-letter abbreviation specified in ISO 3166-1alpha-2:1997 country code. *37
        cmn:ReceiverInfo [1...1] - - - M Business and shipping address information about the supply chain partner to whom ownership is being transferred in the shipment.
          cmn:ToBusinessPartyInfo [0...1] - - - M Transfer to business party address information.
            cmn:BusinessId [1...*] String [1/*] - M This identifies the receiving party to whom ownership is being transferred of the product from the sending party.

Valid values: *38

  • COMPANYID = Company ID
  • COMPANYSITEID = Company site ID
  • DEA = Drug Enforcement Agency number
  • DUNS = Dun and Bradstreet ID
  • DUNS4 = DUNS+4 ID
  • GLN = Global Location Number
  • HIN = Health Industry Number
              @type [1...1] String [1/*] AddressIdQualifier M The type of the BusinessID identifier. *39
  • For DQSA purposes, only GLN, DEA and HIN are allowed.
  • For X12 ASN purposes, DUNS, DUNS+4, COMPANYID, and COMPANYSITEID are also supported.
            cmn:BusinessInfo [1...1] - - - M Address details.
              cmn:BusinessName [1...1] String [1/*] - M The business name of the trading partner. *40
              cmn:Name2 [0...1] String [0/*] - O Business name line 2 for the trading partner.
              cmn:Street1 [1...1] String [1/*] - M The first line of the street address. *41
              cmn:Street2 [0...1] String [0/*] - O The second line of the street address. *42
              cmn:City [1...1] String [1/*] - M The city. *43
              cmn:StateOrRegion [1...1] String [1/*] - M The state, province, or region using the standard two-letter abbreviation specified in ISO 3166-2:1998 country subdivision code. *44
              cmn:PostalCode [1...1] String [1/*] - M The ZIP or other postal code. *45
              cmn:Country [0...1] String [1/*] - M The country using the standard two-letter abbreviation specified in ISO 3166-1alpha-2:1997 country code. *46
          cmn:ShipToLocationInfo [0...1] - - - M Transfer to shipping location address information.
            cmn:FacilityId [1...*] String [1/*] - M A DEA, HIN, GLN associated with the address. This identifies the ship to location for the product. *47
              @type [1...1] String [1/*] AddressIdQualifier M This identifies the ship-to party to whom ownership of the product is being transferred from the sending party.

Valid values: *48

  • COMPANYID = Company ID
  • COMPANYSITEID = Company site ID
  • DEA = Drug Enforcement Agency number
  • DUNS = Dun and Bradstreet ID
  • DUNS4 = DUNS+4 ID
  • GLN = Global Location Number
  • HIN = Health Industry Number
  • STORENUMBER = Ship to party store number identifier. Required for CVS.
            cmn:LocationInfo [1...1] - - - M The type of the BusinessID identifier.
  • For DQSA purposes, only GLN, DEA and HIN are allowed.
  • For X12 ASN purposes, DUNS, DUNS+4, COMPANYID, and COMPANYSITEID are also supported.
              cmn:BusinessName [1...1] String [1/*] - M The business name of the trading partner. *49
              cmn:Name2 [0...1] String [0/*] - O Business name line 2 for the trading partner.
              cmn:Street1 [1...1] String [1/*] - M The first line of the street address. *50
              cmn:Street2 [0...1] String [0/*] - O The second line of the street address. *51
              cmn:City [1...1] String [1/*] - M The city. *52
              cmn:StateOrRegion [1...1] String [1/*] - M The state, province, or region using the standard two-letter abbreviation specified in ISO 3166-2:1998 country subdivision code. *53
              cmn:PostalCode [1...1] String [1/*] - M The ZIP or other postal code. *54
              cmn:Country [0...1] String [1/*] - M The country using the standard two-letter abbreviation specified in ISO 3166-1alpha-2:1997 country code. *55
      pt:ASNMilestoneDates [0...*] - - - O Milestone target and actual dates for ASN.
        cmn:DeliveryDateType [1...1] String [1/*] - M Type of date-time recorded. Optional. *56
        cmn:Date [1...1] Date [10/10] - M Milestone date. *57
        cmn:Time [0...1] Time [8/9] - O Milestone time. *58
    pt:ShipmentItemDetails [0...*] - - - O Shipment/delivery order product details. Total quantities shipped for saleable units by material number, batch number, and quantity are stored here.
      cmn:LineItemNumber [0...1] String [0/*] - O Delivery order line item ID number. *59
      cmn:ItemDescription [0...1] String [0/*] - O Description of material (saleable or packing item) in senders internal system. *60
      cmn:LotNumber [0...1] String [0/*] - O Batch or lot number for saleable shipped product. *61
      cmn:OrderNDC [0...1] String [0/*] - O NDC number used to order material in original customer purchase order. *62
        @type [0...1] String [1/*] DQSAProductCode O The product code type for the value provided in ProductCode. At least one of the NDC formats must be provided for DQSA. *63
      cmn:NonRxProductCode [0...1] String [0/*] - O Non Rx product identification code. *64
        @type [1...1] String [1/*] NonRxProductCode C Product ID qualifier for non-Rx product code types recorded in cmn:NonRxProductCode. *65
Mandatory if cmn:NonRxProductCode is populated.
      cmn:ExpirationDate [0...1] Date [0/*] - O Expiration date for delivery item/lot in XML date format YYYY-MM-DD. *66
      cmn:SalesQuantity [0...1] Decimal [0/*] - O Quantity actually delivered in sales unit of measure. *67
        @quantityUnitOfMeasure [0...1] String [0/*] QuantityUOM M Quantity unit of measure. *68
Mandatory if SalesQuantity is populated.
      cmn:QuantityOrdered [0...1] Decimal [0/*] - O Quantity ordered against Purchase Order. *69
        @quantityUnitOfMeasure [0...1] String [0/*] QuantityUOM M Quantity unit of measure. *70
Mandatory if QuantityOrdered is populated.
      pt:ReferenceDocuments [0...*] - - - M Business documents relevant to shipment of saleable items.
        cmn:BusinessDocument [1...*] String [1/*] - M Shipment document identification number. *71
          @type [1...1] String [1/*] - M Type of document identifier.

Valid value: PurchaseOrder (Required). *72
        cmn:LineItemNumber [0...1] String [0/6] - O Document line item number for the reference document. *73
        cmn:DocumentDate [0...1] String [10/10] - O Date of the reference document. *74
      cmn:DirectPurchaseStatement [0...1] Boolean - - O Direct Purchase statement indicator used to provide Direct Purchase Statement or Received DirectPurchase Statement at line item level, where applicable. *75
        @statement [1...1] String [1/*] DirectPurchaseStatement M Direct Purchase or Received Direct Purchase Statement . *76
        @statementText [0...1] String [1/*] - M Optional text that can be provided by customer that will be used as the action Transaction Statement text. If no content is provided, default text will be used. *77

Default Text:

  • AcquiredAsDirectPurchase - "Product was purchased directly from the manufacturer, manufacturer's exclusive distributor or re-packager who purchased directly from a manufacturer."
  • ReceivedDirectPurchaseStatement - "Received direct purchase statement."
      pt:TransactionHistory [0...*] - - - O Captures prior TH fields (e.g. Sold From Party info, role, transactions, dates, direct purchase statement) for when products were previously purchased by the company. This supports the scenario in which a manufacturer chooses to manage initial TH outside of Product Track and communicate it at time of shipment of the product.
        cmn:ShipmentIdentifiers [0...1] - - - O Shipment document or other identification numbers.
          cmn:ShipmentId [1...*] String [1/*] - M Shipment or document number for the delivery. *78
            @type [1...1] String [1/*] ShipmentIDType O Type of shipment ID.

Shipment Number is mandatory, but all other delivery types in the enumeration list are optional.
          cmn:DocumentDate [0...1] String [1/*] - O Date of the shipment document. *79
        cmn:TransactionDates [0...1] - - - O Header-level DQS transaction information for ASN.
          cmn:TransactionDate [1...1] - [1/*] - M Transaction date.
          cmn:ShipmentDate [0...1] Date [1/*] - O Shipment date if greater than 24 hours after transaction date. Also serves as EPCIS shipping event date/time. Must be in GMT format.
        pt:DSCSATransferFromParty [0...1] - - - O Information about the Transfer From Party prior to the Transaction in the TH.
          cmn:BusinessId [1...1] String [0/*] - M This identifies the sending party who is transferring ownership of the product to the receiving party. *80
            @type [1...*] String [1/*] - M

The type of the BusinessID identifier.

Valid values: *81

  • COMPANYID = Company ID
  • COMPANYSITEID = Company site ID
  • DEA = Drug Enforcement Agency number
  • DUNS = Dun and Bradstreet ID
  • DUNS4 = DUNS+4 ID
  • GLN = Global location number
  • HIN = Health Industry Number
          cmn:DSCSABusinessRole [1...1] String [1/*] DSCSABusinessRole M

The DSCSA supply chain role of the trading partner in the business transaction.

This is a required data element for the Transfer From Party only.

          cmn:BusinessInfo [0...1] - - - O Address details.
            cmn:BusinessName [1...1] - [1/*] - M The business name of the trading partner. *82
            cmn:Name2 [0...1] String [1/*] - O Business name line 2 for the trading partner.
            cmn:Street1 [1...1] String [1/*] - M The first line of the street address. *83
            cmn:Street2 [0...1] String [0/*] - O The second line of the street address. *84
            cmn:City [1...1] String [1/*] - M The city. *85
            cmn:StateOrRegion [1...1] String [1/*] - M The state, province, or region using the standard two-letter abbreviation specified in ISO 3166-2:1998 country subdivision code. *86
            cmn:PostalCode [1...1] String [1/*] - M The ZIP or other postal code. *87
            cmn:Country [0...1] String [1/*] - O The country using the standard two-letter abbreviation specified in ISO 3166-1alpha-2:1997 country code. *88
        pt:DSCSATransferToParty [0...1] - - - O Information about the Transfer From Party prior to the Transaction in the TH.
          cmn:BusinessId [1...1] String [0/*] - M This identifies the sending party who is transferring ownership of the product to the receiving party. *89
            @type [1...*] String [1/*] - M

The type of the BusinessID identifier.

Valid values: *90

  • COMPANYID = Company ID
  • COMPANYSITEID = Company site ID
  • DEA = Drug Enforcement Agency number
  • DUNS = Dun and Bradstreet ID
  • DUNS4 = DUNS+4 ID
  • GLN = Global location number
  • HIN = Health Industry Number
          cmn:DSCSABusinessRole [0...1] String [1/*] DSCSABusinessRole O

The DSCSA supply chain role of the trading partner in the business transaction.

This is a required data element for the Transfer From Party only.

          cmn:BusinessInfo [0...1] - - - O Address details.
            cmn:BusinessName [1...1] - [1/*] - M The business name of the trading partner. *91
            cmn:Name2 [0...1] String [1/*] - O Business name line 2 for the trading partner.
            cmn:Street1 [1...1] String [1/*] - M The first line of the street address. *92
            cmn:Street2 [0...1] String [0/*] - O The second line of the street address. *93
            cmn:City [1...1] String [1/*] - M The city. *94
            cmn:StateOrRegion [1...1] String [1/*] - M The state, province, or region using the standard two-letter abbreviation specified in ISO 3166-2:1998 country subdivision code. *95
            cmn:PostalCode [1...1] String [1/*] - M The ZIP or other postal code. *96
            cmn:Country [0...1] String [1/*] - O The country using the standard two-letter abbreviation specified in ISO 3166-1alpha-2:1997 country code. *97
        cmn:ExtensionField [0...*] - - - O Extension for one or more name/value pairs containing additional data attributes that are not already supported in this transaction.
          cmn:FieldName [1...1] String [1/*] - M

The field name provided by the trade partner receiving the outbound transaction.

cmn:FieldName must match the field name provided by the trade partner exactly, including case.
          cmn:FieldValue [1...1] String [1/*] - M The value corresponding to cmn:FieldName.