Sales Shipment Guidelines (.xml)

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

Message Type: PT_SHIPMENT_TH:PT_LSP_SHIPMENT

Info Exchange Display Name: Shipment Transaction History

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:PTSalesShipmentASN [1...1] - - - M Product Track Shipment EPCIS Message root element.
  pt:ControlFileHeader [1...1] - - - M XML file control header record.
    cmn:FileSenderNumber [1...1] String [1/20] - M For Manufacturer Shipment: File sender's company or location identifier. For LSP Shipment: File sender's company or location identifier. *1
    cmn:FileReceiverNumber [1...1] String [1/20] - M For Manufacturer Shipment: File recipient's company or location identifier. For LSP Shipment: End Customer's company or location identifier (e.g. party receiving the goods). *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:LSPTransaction [0...1] - - - O Optional data element group that identifies an ASN as an LSP shipment message rather than the default manufacturer's message.
      pt:LSPTransaction [1...1] String [1/*] - M Flag identifying ASN as LSP message. If field is empty or null, default value is false and ASN is treated as a manufacturer message.

Valid values: *6

  • True = ASN is LSP message
  • False = ASN is standard manufacturer ASN
      cmn:ServicePublisherId [0...1] String [0/*] - O Party identification number for the application owner (e.g. manufacturer) receiving the LSP message and then generating the outbound ASN to the end customer. Also mapped to Owner in LinkId. *7
        @type [1...1] String [1/*] AddressIdQualifier C This identifies the party identification type for the identification number of the end customer receiving the outbound ASN.

Valid values: *8

  • 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
Mandatory if cmn:ServicePublisherId is populated.
    pt:ShipmentTransaction [1...1] - - - M Header data for shipment
      cmn:Location [0...1] String [1/*] - O Location to associate the Transaction Histories (THs) when they are created. *9

If the Product Track application is configured to use Locations to model your facilities, populate this element with one of the configured location values.

If the Product Track application is not configured to use Locations, omit this element.
        @type [1...1] String [1/*] Location C Attribute identifies the location types. *10
Mandatory if cmn:Location is populated.
      cmn:ShipmentIdentifiers [1...1] - - - M Shipment document or other identification numbers. Bill of Lading number and other delivery types are also supported but not required. BOL is recommended and should be sent if available but it is not mandatory.
Shipment document ID is mandatory.
        cmn:ShipmentId [1...*] String [1/*] - M Shipment ID number. *11
          @type [1...1] String [1/*] ShipmentIDType M Type of shipment ID. *12
      cmn:DocumentDate [0...1] Date [0/*] - O Date for the shipment document in XML date format YYYY-MM-DD. *13
      cmn:TransactionDates [1...1] - - - M Header level DQS transaction information for ASN.
        cmn:TransactionDate [1...1] Date [1/*] - M Transaction date. *14
        cmn:ShipmentDate [0...1] Date [0/*] - O Shipment date if greater than 24 hours after transaction date. Also serves as EPCIS shipping event date/time - must be in GMT format. *15
      cmn:TransactionStatement [1...1] - - - M Transaction statement - Will accept whatever statement is sent in source. May change as requirement for transaction statement better understood.
        cmn:TransactionStatementIndicator [1...*] Boolean [1/*] - M Transaction statement indicator. *16
          @statement [1...1] String [1/*] TransactionStatement M Full transaction statement if all eight are required. *17
          @statementText [0...1] String [0/256] - O 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.

Default Text:

  • AuthorizedUnderDSCSA - "The entity transferring ownership in a transaction is authorized as required under the Drug Supply Chain Security Act."
  • MeetShipmentReqts - "The entity transferring ownership did not knowingly ship a suspect or illegitimate product."
  • MeetSection852Reqts - "The entity transferring ownership had systems and processes in place to comply with verification requirements under section 582."
  • MeetTIReqts - "The entity transferring ownership did not knowingly provide false transaction information."
  • MeetTHReqts - "The entity transferring ownership did not knowingly alter the transaction history."
  • MeetsAllApplicableTSReqts: "Seller has complied with each applicable subsection of FDCA Sec. 581(27)(A)-(G).
  • ReceivedFromDSCSAAuthorizedParty - "The entity transferring ownership received the product from a person that is authorized as required under the Drug Supply Chain Security Act."
  • ReceivedTIAndTS - "The entity transferring ownership received transaction information and a transaction statement from the prior owner of the product, as required under section 582."
      pt:ShipmentInformation [0...1] - - - M Transport, routing, and shipping information for shipment or delivery.
        cmn:DocumentControl [0...1] String [0/*] TransactionControlCode O Indicates ASN a new original document or that an existing ASN should be replaced. *18
        cmn:LadingQuantity [0...1] Decimal [0/*] - O Total number of packages in shipment. *19
        cmn:NetWeight [0...1] Decimal [0/*] - O Net weight for shipment. *20
          @weightUnitOfMeasure [0...1] String [0/*] WeightUOM O HDMA weight units of measure. *21
        cmn:GrossWeight [0...1] Decimal [0/*] - O Gross weight for shipment. *22
          @weightUnitOfMeasure [0...1] String [0/*] WeightUOM C HDMA weight units of measure. *23
Mandatory if cmn:GrossWeight is populated.
        cmn:CarrierSCACNumber [0...1] String [0/*] - M The carrier's 4-character standard SCAC number code. *24
        cmn:CarrierName [0...1] String [0/*] - O Carrier name. *25
        cmn:TransportMethod [0...1] String [0/*] TransportMethod O Transportation method type code identifying the method or type of transport used for the shipment.

Valid values: *26

  • Air
  • AirExpress
  • CustomerPickup
  • Ground
  • Multimodal
  • Rail
  • Ship
  • SupplierTruck
        cmn:ShipmentStatus [0...1] String [0/*] ShipmentStatus C Status of shipment as a whole. Mapped to TD506 in outbound ASN. *27
Mandatory for Meijer.
        cmn:DropShipIndicator [0...1] String [0/*] - O Transaction type code identifying delivery type. The system defaults to ASN if the data element is missing or empty.

Valid values: *28

  • ASN - Advanced ship notice
  • DropShip - Drop ship notice
        cmn:CustomerPortalHistoryCode [0...1] String [0/*] - O Unique customer-generated code for use in TraceLink to retrieve THs. Customer is responsible for generating this code.
        cmn:PackageTrackingNumber [0...1] String [0/*] - O Carrier's tracking number for package at shipment header level.
        cmn:ShipmentPackagingCode [0...1] String [0/*] PackagingCode O Header level packaging code. This identifies the top level container type in the shipment. Maps to TD101 in outbound ASN. *29

Optional value for all dispensers.
        cmn:CustomerVendorId [0...1] String [0/*] - O Supplier identifier in customer's internal system. Maps to REF segment in outbound ASN. *30
Mandatory for Walgreens, Walmart.
        cmn:AdminContact [0...*] - - - O Administrative communications contact information. Identifies a person or office to whom administrative communications should be directed. Mapped to PER segment in OB ASN.
All fields in segment mandatory for Walgreens.
          cmn:ContactFunction [0...1] String [0/*] ContactFunction O Code identifying the major duty or responsibility of the person or group named as contact. Mapped to PER01. *31
  • Manufacturer must provide valid contact information of the person responsible for authenticating the pedigree information.
  • Wholesale distributor must also provide the manufacturer's contact information. In addition, they must provide contact information for the responsible person in the wholesaler's organization.
  • Secondary wholesale distributor must provide their own contact information in addition to the contact information for both the previous wholesale distributor and the manufacturer.
        cmn:ContactName [0...1] String [0/*] - O Name of the contact person responsible for authenticating the pedigree information. *32
        cmn:ContactTelephone [0...1] String [0/*] - O Telephone number of the contact person. *33
        cmn:ContactEmail [0...1] String [0/*] - O Email address for the contact person. *34
      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 - Mandatory
  • Business address for transfer to party - Mandatory
  • Shipping address for transfer from party - Mandatory
  • Shipping address for transfer to party - Mandatory
  • Drop-ship recipient party - Optional
        cmn:SenderInfo [1...1] - - - M Business and shipping address Information about the supply chain partner from whom ownership is being transferred in the shipment.
          choice%1 [1...1] Choice - - O Option 1 within choice%1 of SenderInfo NOT SUPPORTED.

Option 2 within choice%1 of SenderInfo contains full FromBusinessPartyInfo data fields that will be populated by the customer in the interface.
          cmn:FromBusinessPartyLookupId [0...1] String [0/*] - N/A MASTER DATA LOOKUP NOT SUPPORTED
            @type [1...1] String [1/*] BusinessAddressIdLookup N/A MASTER DATA LOOKUP NOT SUPPORTED
          cmn:FromBusinessPartyInfo [0...1] String [1/*] - C Choice 2 for senderInfo choice%1 group. All required fields must be filled in if this option is selected.
Mandatory if cmn:FromBusinesspartyLookupID is not populated.
            cmn:BusinessId [1...*] String [1/*] - M This identifies the sending party who is transferring ownership of the product to the receiving party. *35
              @type [1...1] String [1/*] AddressIdQualifier M The type of the BusinessID identifier.

Valid values: *36

  • COMPANYID = Company ID
  • COMPANYSITEID = Company site ID
  • HIN = Health Industry Number
  • DUNS = Dun and Bradstreet ID
  • DUNS4 = DUNS+4 ID
  • DEA = Drug Enforcement Agency number
  • GLN = Global location number
            cmn:BusinessInfo [0...1] - - - M Address details.
              cmn:BusinessName [1...1] String [1/*] - M The business name of the trading partner. *37
              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. *38
              cmn:Street2 [0...1] String [0/*] - O The second line of the street address. *39
              cmn:City [1...1] String [1/*] - M The city. *40
              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. *41
              cmn:PostalCode [1...1] String [1/*] - M The ZIP or other postal code. *42
              cmn:Country [1...1] String [1/*] - M The country using the standard two-letter abbreviation specified in ISO 3166-1alpha-2:1997 country code. *43
          choice%2 [1...1] Choice - - O Option 1 within choice%2 of SenderInfo NOT SUPPORTED.

Option 2 within choice%2 of SenderInfo contains full ShipFromLocationInfo data fields that will be populated by the customer in the interface.
          cmn:ShipFromLocationLookupId [0...1] String [0/*] - N/A MASTER DATA LOOKUP NOT SUPPORTED
            @type [1...1] String [1/*] BusinessAddressIdLookup N/A MASTER DATA LOOKUP NOT SUPPORTED
          cmn:ShipFromLocationInfo [0...1] - - - C Choice 2 for senderInfo choice%2 group. All required fields must be filled in if this option is selected.
Mandatory if cmn:ShipFromLocationLookupId not populated.
            cmn:FacilityId [1...*] String [1/*] - M This identifies the ship from location transferring ownership of the product to the receiving party. *44
              @type [1...1] String [1/*] AddressIdQualifier M The type of the BusinessID identifier.

Valid values: *45

  • COMPANYID = Company ID (Wal-Mart, Meijer)
  • COMPANYSITEID = Company site ID (Wal-Mart, Walgreens, Meijer)
  • DEA = Drug Enforcement Agency number (CVS, Wal-Mart, Publix, Meijer)
  • DUNS = Dun and Bradstreet ID (Wal-Mart, Walgreens, Meijer)
  • DUNS4 = DUNS+4 ID (Wal-Mart, Walgreens, Meijer)
  • GLN = Global location number (Wal-Mart, Meijer)
  • HIN = Health Industry Number (Wal-Mart, Meijer)
  • PARTNERCOMPANYID = Customer's internal supplier number
            cmn:LocationInfo [1...1] - - - M Address details.
              cmn:BusinessName [1...1] String [1/*] - M The business name of the trading partner. *46
              cmn:Name2 [0...1] String [0/*] - O Business name line two for the trading partner.
              cmn:Street1 [1...1] String [1/*] - M The first line of the street address. *47
              cmn:Street2 [0...1] String [0/*] - O The second line of the street address. *48
              cmn:City [1...1] String [1/*] - M The city. *49
              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. *50
              cmn:PostalCode [1...1] String [1/*] - M The ZIP or other postal code. *51
              cmn:Country [1...1] String [1/*] - M The country using the standard two-letter abbreviation specified in ISO 3166-1alpha-2:1997 country code. *52
            cmn:LicenseNumber [0...*] String [0/*] - O License number value for the trade partner. Optional for DQSA. *53
              @state [0...1] String [0/*] - O The state or region in which the trading partner is licensed, using the standard two letter abbreviation specified in ISO 3166-2:1998 country sub-division code. This attribute is used to give additional context to the license number. *54
              @agency [0...1] String [0/*] - O License number value for the trade partner. Optional for DQSA.

Valid values: *55

  • D3 = National Association of Boards of Pharmacy Number
  • FAWD = State License Identification Number
  • FW = State License Identification Number
  • NABP = National Association of Boards of Pharmacy Number
            cmn:ContactInfo [0...1] - - - O Contact information for use by downstream trading partners to authenticate (e.g. verify) the transaction information. Optional for DQSA.
              cmn:Name [0...1] String [0/*] - O The name of the organization within the company (e.g. Accounting Department). *56
              cmn:Telephone [0...1] String [0/*] - O Phone number of the person. *57
              cmn:Email [0...1] String [0/*] - O Email of the person.
        cmn:ReceiverInfo [1...1] - - - M Business and shipping address information about the supply chain partner to whom ownership is being transferred in the shipment.
          choice%1 [1...1] Choice - - O Option 1 within choice%1 of ReceiverInfo NOT SUPPORTED.

Option 2 within choice%1 of ReceiverInfo contains full ToBusinessPartyInfo data fields that will be populated by the customer in the interface.
          cmn:ToBusinessPartyLookupId [0...1] - - - N/A MASTER DATA LOOKUP NOT SUPPORTED
            @type [1...1] String [1/*] BusinessAddressIdLookup N/A MASTER DATA LOOKUP NOT SUPPORTED
          cmn:ToBusinessPartyInfo [0...1] - - - C Choice 2 for ReceiverInfo choice%1 group. All required fields must be filled in if this option is selected.
Mandatory if cmn:ToBusinessPartyLookupId is not populated.
            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: *58

  • COMPANYID = Company ID (Wal-Mart)
  • COMPANYSITEID = Company site ID (Wal-Mart, Walgreens)
  • DEA = Drug Enforcement Agency number (CVS)
  • DUNS = Dun and Bradstreet ID (Wal-Mart, Walgreens, Publix)
  • DUNS4 = DUNS+4 ID (Wal-Mart, Walgreens, Meijer)
  • GLN = Global location number (Wal-Mart)
  • HIN = Health Industry Number (Wal-Mart)
              @type [1...1] String [1/*] AddressIdQualifier M The type of the BusinessID identifier. *59
  • 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. *60
              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. *61
              cmn:Street2 [0...1] String [0/*] - O The second line of the street address. *62
              cmn:City [1...1] String [1/*] - M The city. *63
              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. *64
              cmn:PostalCode [1...1] String [1/*] - M The ZIP or other postal code. *65
              cmn:Country [1...1] String [1/*] - M The country using the standard two-letter abbreviation specified in ISO 3166-1alpha-2:1997 country code. *66
          choice%2 [1...1] Choice - - O Option 1 within choice%2 of ReceiverInfo contains only the ShipToLocationLookupId (in this case TraceLink will populate all of the ShipToLocationInfo field data based on master data lookup).

Populate this element ONLY if master data lookup is desired.

Option 2 within choice%2 of Receiver contains full ShipToLocationInfo data fields that will be populated by the customer in the interface.
          cmn:ShipToLocationLookupId [0...1] String [0/*] - N/A MASTER DATA LOOKUP NOT SUPPORTED
            @type [1...1] String [1/*] BusinessAddressIdLookup N/A MASTER DATA LOOKUP NOT SUPPORTED
          cmn:ShipToLocationInfo [0...1] - - - C Choice 2 for ReceiverInfo choice%2 group. All required fields must be filled in if this option is selected.
Mandatory if cmn:ShipToLocationLookupId is not populated.
            cmn:FacilityId [1...*] String [1/*] - M A DEA, HIN, GLN associated with the address. This identifies the ship-to party to whom ownership is being transferred of the product from the sending party. *67
              @type [1...1] String [1/*] AddressIdQualifier M The type of the FacilityId identifier.

Valid values: *68

  • 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 store number

Multiple identifiers can be sent. If STORENUMBER is sent it must be in addition to one of the other supported identifier types. STORENUMBER is only sent for the ship-to party store number.
            cmn:LocationInfo [1...1] - - - M Address details.
              cmn:BusinessName [1...1] String [1/*] - M The business name of the trading partner. *69
              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. *70
              cmn:Street2 [0...1] String [0/*] - O The second line of the street address. *71
              cmn:City [1...1] String [1/*] - M The city. *72
              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. *73
              cmn:PostalCode [1...1] String [1/*] - M The ZIP or other postal code. *74
              cmn:Country [1...1] String [1/*] - M The country using the standard two-letter abbreviation specified in ISO 3166-1alpha-2:1997 country code. *75
            cmn:LicenseNumber [0...*] String [0/*] - O License number value for the trade partner. Optional for DQSA. *76
              @state [0...1] String [0/*] - O The state or region in which the trading partner is licensed, using the standard two letter abbreviation specified in ISO 3166-2:1998 country sub-division code. This attribute is used to give additional context to the license number. *77
              @agency [0...1] String [0/*] - O License number value for the trade partner. Optional for DQSA.

Valid values: *78

  • D3 = National Association of Boards of Pharmacy Number
  • FAWD = State License Identification Number
  • FW = State License Identification Number
  • NABP = National Association of Boards of Pharmacy Number
            cmn:ContactInfo [0...1] - - - O Contact information for use by downstream trading partners to authenticate (e.g. verify) the transaction information.

Optional for DQSA. Not used for the receiving party.
              cmn:Name [0...1] String [0/*] - O Full name of the person or name of the company.
              cmn:Telephone [0...1] String [0/*] - O Phone number of the person.
              cmn:Email [0...1] String [0/*] - O Email of the person.
        cmn:BusinessPartyInfo [0...*] - - - O Additional business party info such as bill to information. Use for drop-ship recipient party or parties.
          choice%1 [1...1] Choice - - O Option 1 within choice%1 of BusinessPartyInfo NOT SUPPORTED.

Option 2 within choice%1 of BusinessPartyInfo contains full BusinessPartyDetail data fields that will be populated by the customer in the interface.
          cmnBusinessPartyLookupId [0...1] String [0/*] - C Choice 1 for BusinessPartyInfo choice%1 group. Mandatory if full business address not provided in BusinessPartyDetail option.
            @type [1...1] String [1/*] BusinessAddressIdLookup

M

 The type of the BusinessPartyLookupId identifier. The value of the type attribute SHALL be one of the supported enumerations.
          cmn:BusinessPartyDetail [0...1] String - - O Choice 2 for BusinessPartyInfo choice%1 group.

All mandatory fields must be filled in if this option is selected.
            cmn:BusinessId [1...*] String [1/*] - M This identifies the additional business party.

Valid values:

  • COMPANYID = Company ID (Wal-Mart, Meijer)
  • COMPANYSITEID = Company site ID (Wal-Mart, Walgreens, Meijer)
  • DEA = Drug Enforcement Agency numbre (CVS, RiteAid, Meijer)
  • DUNS = Dun and Bradstreet ID (Wal-Mart, Walgreens, Publix, Meijer)
  • DUNS4 = DUNS+4 ID (Wal-Mart, Walgreens, Meijer)
  • GLN = Global location number (Wal-Mart, RiteAid, Meijer)
  • HIN = Health Industry Number (Wal-Mart, RiteAid, Meijer)
  • PARTNERCOMPANYID = Customer's internal supplier number
              @type [1...1] String [1/*] AddressIdQualifier M The type of the BusinessID identifier.

Valid values:

  • COMPANYID = Company ID (Wal-Mart, Meijer)
  • COMPANYSITEID = Company site ID (Wal-Mart, Walgreens, Meijer)
  • DEA = Drug Enforcement Agency numbre (CVS, RiteAid, Meijer)
  • DUNS = Dun and Bradstreet ID (Wal-Mart, Walgreens, Publix, Meijer)
  • DUNS4 = DUNS+4 ID (Wal-Mart, Walgreens, Meijer)
  • GLN = Global location number (Wal-Mart, RiteAid, Meijer)
  • HIN = Health Industry Number (Wal-Mart, RiteAid, Meijer)
            cmn:BusTransactionRole [0...1] String [0/*] - O Identifies role of trading partner in BusinessPartyInfo. For drop-ship party use: DropShip. *79
            cmn:BusinessInfo [1...1] - - - M Address details.
              cmn:BusinessName [1...1] String [1/*] - M The business name of the trading partner.
              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.
              cmn:Street2 [0...1] String [0/*] - O The second line of the street address.
              cmn:City [1...1] String [1/*] - M The city.
              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.
              cmn:PostalCode [1...1] String [1/*] - M The ZIP or other postal code.
              cmn:Country [1...1] String [1/*] - M The country using the standard two-letter abbreviation specified in ISO 3166-1alpha-2:1997 country code.
      pt:ASNMilestoneDates [1...*] - - - M Milestone target and actual dates for ASN.
        cmn:DeliveryDateType [1...1] String [1/*] DeliveryDateType M Type of date-time recorded. Include all important delivery and shipping dates here. Shipped and estimated delivery dates are required. *80

Estimated Delivery Time is mandatory.
        cmn:Date [1...1] Date [10/10] - M Milestone date. *81
        cmn:Time [0...1] Time [8/9] - C Milestone time. *82

Estimated Delivery Time is mandatory, all other times are optional.
        cmn:TimeZone [0...1] String [0/*] - O Milestone timezone. *83
    pt:ShipmentItemDetails [0...*] - - - M Shipment/delivery order product details. Total quantities shipped for saleable units by material number, batch number, and quantity are stored here. The segment also records packing items used in the aggregation.

Quantities and weights recorded for packing items are for the total of the packing units used in the packing hierarchy in the ContainerAggregation segment below.
      cmn:LineItemNumber [0...1] String [0/*] - M Delivery order line item ID number for saleable product and lot in the shipping or delivery document. Line item number is required to support multiple Purchase Order (PO) numbers. The line item number must match the line item number for the purchase order linked to the aggregation item. *84

If the line item number is missing and there are multiple POs only the first PO number will be mapped to the outbound ASN 856.
      cmn:ShipTHAction [0...1] String [0/*] - O Indicates whether the system should create a new TH (default behavior if value is not set) or match (pick) against an existing TH in the system for the line item. *85

This is only needed for the use case when the manufacturer is also a re-distributor of other manufacturer products, and captured the prior Transaction History directly in the Product Track application. In this use case, the manufacturer needs to identify how the product was sourced so that the outbound TH is populated correctly .
      cmn:InternalMaterialNumber [0...1] String [0/*] - O Material number in sender's internal system for saleable shipped item or packing item recorded in detail record. *86
      cmn:ItemDescription [0...1] String [0/*] - O Description of material (saleable or packing item) in senders internal system. *87
      cmn:LotNumber [1...1] String [1/*] - M Batch or lot number for saleable shipped product. *88
      cmn:ExpirationDate [0...1] Date [0/*] - O Expiration date for delivery item/lot in XML date format YYYY-MM-DD. *89
      cmn:SerializedLotIndicator [0...1] String [0/*] - O Serialized lot identifier. Identifies if lot-based message (ASN) will also include serialized data that will be sent to TraceLink in a separate Serialized Operations Manager or TL XML EPCIS message.

Valid values:

  • Null or empty = No
  • X = Yes, separate serialized message to be sent.
      cmn:NonRxProductCode [0...1] String [0/*] - O Non Rx product identification code. *90
        @type [1...1] String [1/*] NonRxProductCode C Product service ID qualifier for non-Rx product code types recorded in cmn:NonRxProductCode. *91
Mandatory if cmn:NonRxProductCode is populated.
      cmn:DSCSAExempt [0...1] Boolean [0/*] - O DSCSAExempt Flag set to true indicates the product does not require TH. If Product does not require TH, the system will include the line item in outbound mapping, but will not create a TH for the product. If this flag is not present, the system will default to a false value.

Valid values: *92

  • True = Indicates the product does NOT require TH.
  • False = Indicates the product DOES require TH.
      cmn:ItemQuantity [1...1] Integer [1/*] - M Number of saleable units in the lot to represent the Transaction Information "number of containers that were part of the transaction. *93
      cmn:SalesQuantity [0...1] Decimal [0/*] - M Quantity actually delivered in sales unit of measure. *94
        @quantityUnitOfMeasure [0...1] String [0/*] QuantityUOM M Quantity unit of measure. *95
      cmn:Volume [0...1] Decimal [0/*] - O Volume for item.
        @volumeUnitOfMeasure [0...1] String [0/*] VolumeUOM O Volume unit of measure.
      cmn:NetWeight [0...1] Decimal [0/*] - O Net weight for item.
        @weightUnitOfMeasure [0...1] String [0/*] WeightUOM O Weight unit of measure.
      cmn:GrossWeight [0...1] Decimal [0/*] - O Gross weight for item. *96
        @weightUnitOfMeasure [0...1] String [0/*] WeightUOM O Weight unit of measure. *97
      pt:TransactionProductDetails [0...1] - - - M Transaction information per DQSA requirements. Will not be populated for packing items.
        choice%1 [1...1] Choice - - M Option 1 within choice%1 of TransactionProductDetails contains only the ProductCodeLookupId. In this case TraceLink will populate all of the ProductInfo field data based on master data lookup.

Option 2 within choice%1 of TransactionProductDetails contains full ProductInfo data fields that will be populated by the customer in the interface.

Populated only when Master Data Lookup is desired.

        cmn:ProductCodeLookupId [0...1] String [0/*] - C Choice 1 for TransactionProductDetails choice%1 group. NDC542 value as it would appear in master data/Redbook.
Mandatory if full product info not provided in cmn:ProductInfo.
          @type [1...1] String [1/*] ProductCodeLookupIdType M NDC542.
        cmn:ProductInfo [0...1] - - - O Choice 2 for TransactionProductDetails choice%1 group.

All mandatory fields must be filled in if this option is selected.
          cmn:ProductCode [1...*] String [1/*] - M National drug code number of the product. *98
            @type [1...1] String [1/*] DQSAProductCode M The product code type for the value provided in cmn:ProductCode. *99
          cmn:DrugName [1...1] String [1/*] - M the proprietary or established name or names of the product that would appear on the label. *100
          cmn:Manufacturer [0...1] String [0/*] - O The manufacturer of the product. *101
         

cmn:DosageForm

 [1...1] String [1/*] - M The dosage form of the product (e.g. TABLET, CAPSULE). *102
          cmn:Strength [1...1] String [1/*] - M The strength or potency of the product, including the unit of measure (e.g. 60 mg, 25 ml). *103
          cmn:ContainerSize [1...1] String [1/*] - M The number of units contained in a package of the product (e.g. 60, 100). *104
      pt:ReferenceDocuments [0...*] - - - M Business documents relevant to shipment of saleable items.

At least one instance of this group with purchase order number is required.
        cmn:BusinessDocument [1...1] String [1/*] - M Shipment document identification number. *105

PO number is mandatory. An error will be thrown if it is not included. It is a mandatory HDMA data element. Multiple PO numbers can be sent in any message, but only one PO number can be sent in any one line item.
          @type [1...1] String [1/*] ReferenceBusinessDocumentType M Type of document identifier. *106
        cmn:LineItemNumber [0...1] String [0/6] - O Document line item number for the reference document. *107
        cmn:DocumentDate [0...1] String [10/10] - O Date of the reference document. *108
      cmn:ProductOrigin [0...1] String [0/*] ProductOrigin O Identifies how the product was sourced, and is used to determine what fields should appear on the outbound TH based on the sourcing. *109

This is only needed for the use case when the manufacturer is also a re-distributor of other manufacturer's products, and captured the prior TH directly in the Product Track application. In this use case, the manufacturer needs to identify how the product was sourced so that the outbound TH is populated correctly.
      cmn:OrderNDC [0...1] String [0/*] - O NDC number used to order material in the original customer PO. *110

If the NDC number used in the customer purchase order is the same as the ProductCodeLookupId or ProductCode in rows 154 and 157 above, please provide that value to OrderNDC without hyphens.
        @type [1...1] String [1/*] DQSAProductCode C The product code type for the value provided in ProductCode NDC542 or NDC. At least one of the NDC formats must be provided for DQSA. *111
Mandatory if cmn:OrderNDC is populated.
      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. *112
        @statement [1...1] String [1/*] DirectPurchaseStatement M Direct Purchase or Received Direct Purchase Statement . *113
        @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. *114

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 ID number.
            @type [1...1] String [1/*] ShipmentIDType M Type of shipment ID.

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

Valid values: *116

  • 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] String [1/*] - M The business name of the trading partner. *117
            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. *118
            cmn:Street2 [0...1] String [0/*] - O The second line of the street address. *119
            cmn:City [1...1] String [1/*] - M The city. *120
            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. *121
            cmn:PostalCode [1...1] String [1/*] - M The ZIP or other postal code. *122
            cmn:Country [1...1] String [1/*] - M The country using the standard two-letter abbreviation specified in ISO 3166-1alpha-2:1997 country code. *123
        cmn:DSCSATransferToParty [1...1] - - - M Information about the Transfer To Party for prior the Transaction in the TH.
          cmn:BusinessId [1...*] String [1/*] - M This identifies the receiving party to whom ownership of the product is being transferred from the sending party. *124
            @type [1...1] String [1/*] AddressIdQualifier M The type of the BusinessID identifier.

Valid values: *125

  • 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 [0/*] DSCSABusinessRole O The DSCSA supply chain role of the trading partner in the business transaction.

This is needed for the Transfer From Party only.

          cmn:BusinessInfo [0...1] - - - O Address details.
            cmn:BusinessName [1...1] String [1/*] - M The business name of the trading partner. *126
            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. *127
            cmn:Street2 [0...1] String [0/*] - O The second line of the street address. *128
            cmn:City [1...1] String [1/*] - M The city. *129
            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. *130
            cmn:PostalCode [1...1] String [1/*] - M The ZIP or other postal code. *131
            cmn:Country [1...1] String [1/*] - M The country using the standard two-letter abbreviation specified in ISO 3166-1alpha-2:1997 country code. *132
      cmn:LineItemStatus [0...1] String [0/*] LineItemStatus C Line item status for the shipment. Mapped to SN108 in outbound ASN. *133
Mandatory for Walgreens. Optional for RiteAid.
    pt:PackingAggregation [0...*] - - - O Logistic unit header data for delivery - highest level Logistic unit (e.g. container, pallet, pack). Contains all other packaged items for one delivery in shipment.

TL XML map expects only the following packing hierarchies:

  • Shipment --> Order --> Item
  • Shipment --> Order --> Pallet --> Item
  • Shipment --> Order --> Case --> Item
      cmn:ContainerIdentifier [1...1] String [1/*] - M SSCC-18 identifier for the container in the packaging aggregation. Expecting SSCC-18 code. *134
      cmn:PackagingLevel [1...1] String [1/*] PackagingLevel M Identifies type of container for parent packing item. *135
      cmn:InternalPackingItemDescription [0...1] String [0/*] - O Description of packing material from sender's internal system. *136
      cmn:PackCount [0...1] Integer [0/*] - O The number of packs or inner packs per outer pack or pallet. Count is only reported here for packaging items.
      cmn:TareWeight [0...1] Decimal [0/*] - O Tare weight of packing material. *137
        @weightUnitOfMeasure [0...1] String [0/*] WeightUOM O HDMA weight unit of measure. *138
      cmn:GrossWeight [0...1] Decimal [0/*] - O Gross total weight of aggregation and packing material. *139
        @weightUnitOfMeasure [0...1] String [0/*] WeightUOM O HDMA weight unit of measure. *140
      cmn:GrossVolume [0...1] Decimal [0/*] - O Gross volume of packing material.
        @volumeUnitOfMeasure [0...1] String [0/*] VolumeUOM O HDMA volume unit of measure.
      cmn:Length [0...1] Decimal [0/*] - O Length of packing material.
        @dimensionUnitOfMeasure [0...1] String [0/*] DimensionUOM O HDMA dimension unit of measure.
      cmn:Height [0...1] Decimal [0/*] - O Height of packing material.
        @dimensionUnitOfMeasure [0...1] String [0/*] DimensionUOM O HDMA dimension unit of measure.
      cmn:Width [0...1] Decimal [0/*] - O Width of packing material.
        @dimensionUnitOfMeasure [0...1] String [0/*] DimensionUOM O HDMA dimension unit of measure.
      cmn:PackageTrackingNumber [0...1] String [0/*] - O Carrier's tracking number for package at shipment header level.
      cmn:AggregationItem [0...*] - - - M Items aggregated to parent packing item in PackingAggregation.
        cmn:LineItemNumber [0...1] String [0/*] - O Line item number for saleable product and lot in the shipping or delivery document. Line item number is required to support multiple PO numbers. *141

The line item number must match the line item number for the purchase order linked to the aggregation item. If line item number is missing with multiple POs only the first PO will be mapped.
        cmn:AggregationItemId [0...1] String [0/*] - O ID number for saleable item or package in list. *142
        cmn:LotNumber [0...1] String [0/*] - O Batch or lot number for saleable shipped product. *143
        cmn:PackedQuantity [1...1] String [1/*] - M Quantity of saleable item packed in parent container. Not populated for packs or inner packs. *144
          @quantityUnitOfMeasure [1...1] String [1/*] QuantityUOM M HDMA quantity unit of measure. *145