Tracelink University ## Breadcrumb 1. [Home](/) 2. [Resources](/resources/resource-center) 3. [TraceLink University](/resources/tracelink-university) # Advance ship notice (XML) - [Download PDF](/node/626261/pdf) - [Share](#) - [ LinkedIn ](https://www.linkedin.com/shareArticle?mini=true&url=https://www.tracelink.com/resources/tracelink-university/advance-ship-notice-xml&title=Advance ship notice (XML)&summary=Shipment notices allow companies to exchange serialized data for sales shipments with upstream and downstream supply chain trade partners without giving these trade partners access to their serialization system of record. &source=TraceLink "LinkedIn") - [ Facebook ](https://www.facebook.com/share.php?u=https://www.tracelink.com/resources/tracelink-university/advance-ship-notice-xml&t=Advance ship notice (XML) "Facebook") - [ Mail ](mailto:?subject=Advance ship notice (XML)+|+TraceLink&body=https://www.tracelink.com/resources/tracelink-university/advance-ship-notice-xml "Mail") - [ Twitter ](https://twitter.com/intent/tweet?text=Advance ship notice (XML) https://www.tracelink.com/resources/tracelink-university/advance-ship-notice-xml&via=TraceLink "Twitter") #### Table of contents Shipment notices allow companies to exchange serialized data for sales shipments with upstream and downstream supply chain trade partners without giving these trade partners access to their serialization system of record. These shipment notices can be used to inform their Partners of the contents of a shipment, and the notices also allow these companies to comply with government regulations or recommendations for sharing serialized data about shipments. The Advance ship notice (ASN) XML message sends data about a purchase order the supplier is fulfilling and notifies the buyer of the pending goods delivery. ![](/sites/default/files/tech_comms/mpl/Content/Resources/Images/global_images/note_tip_24x24.png) Contact your TraceLink Services representative for more information about integrating with this message. - **Message Type**: MPC\_ADVANCE\_SHIP\_NOTICE (Advanced Ship Notice) - **XML Format**: TL\_XML - **Transform Names**: - B2B\_TL\_XML\_AdvanceShipNotice\_IB\_V4 [![Closed](/sites/default/files/tech_comms/mpl/Skins/Default/Stylesheets/Images/transparent.gif)Guidelines](#) Input Element Occurs Length Description Example pt:ControlFileHeader 1…1 - XML file control header record. - cmn:FileSenderNumber 1…1 1/20 - For Manufacturer Shipment: File sender's company or location identifier. - For LSP Shipment: File sender's company or location identifier. GLN:2222224043588 cmn:FileSenderNumber - - Sender identification mapping to linkIdentifier. GLN:2222224043588 cmn:FileReceiverNumber 1…1 1/20 - For Manufaturer Shipment: File recipient's company or location identifier. - For LSP Shipment: End customer's company or location identifier (e.g., party that will receive the goods) DUNS:7000829072 cmn:FileControlNumber 1…1 1/\* Unique file control ID number. 00619827 cmn:FileDate 1…1 10/10 Date file generated in XML YYYY-MM-DD format. 2014-08-22 cmn:FileTime 1…1 9/9 Time file generated in XML HH:MM:SSZ format (must be GMT). 14:20:00Z pt:MessageBody 1…1 - Canonical file control header. - pt:LSPTransaction 0…1 - Optional data element group that will identify an ASN as an LSP shipment transaction rather than the default manufacturer's message. - pt:LSPTransaction 1…1 1/\* Flag identifying ASN as LSP transaction. If field null or empty default value will be false and ASN will be treated as a manufacturer message. Valid values: - true = ASN is LSP transaction - false = ASN is standard manufacturer ASN true cmn:ServicePublisherId 0…1 0/\* Party identification number for the Service Publisher (e.g., manufacturer) that will receive the LSP transaction and then generate the outbound ASN to the end customer. Also mapped to Publisher in ServiceLinkId. 3333331013655 @type 1…1 1/\* This identifies the party identification type for the identification number of the end customer that will receive the outbound ASN. Valid values: - `GLN` - Global location number - `DEA` - Drug Enforcement Agency number - `HIN` - Health Industry Number - `DUNS` - Dun and Bradstreet ID - `DUNS4` - DUNS+4 ID - `COMPANYID` - Company ID - `COMPANYSITEID` - Company site ID - `CUIT` - Argentina Tax ID - `AR_CUIT` - Argentina Tax ID - `SGLN` - Serialized Global Location Number DEA pt:ShipmentTransaction 1…1 - Header data for shipment. - cmn:Location 0…1 1/\* Location to associate the Transaction Histories when they are created. If the Product Track Service is configured to use Locations to model your facilities, populate this element with one of the configured location values. If the Product Track Service is not configured to use Locations, omit this element. 3333331013655 @type 1…1 1/\* Attribute identifies the location types and includes: - `GLN` - Global location number - `DEA` - US Drug Enforcement Agency ID number - `HIN` - Health Industry Number - `DUNS` - D-U-N-S number, Dun and Bradstreet - `DUNS4` - Duns+4 ID number - `COMPANYID` - Assigned by seller company identifier - `COMPANYSITEID` - ERP/WMS plant / location id - `CUIT` - Argentina Tax ID - `SGLN` - Serialized Global Location Number Attribute is required if Location is populated. DEA cmn:ShipmentIdentifiers 1…1 - Shipment document or other identification numbers. - cmn:ShipmentId 1…\* 1/\* Shipment document instance of shipment identifiers. 0080016047 @type 1…1 1/\* Type of shipment ID. Values include: - ShipmentNumber - DeliveryDocument - BillOfLading - ExternalDelivery - GoodsReceiptIssue - TrackingNumber - CarrierReference - MasterBOL - SealNumber ShipmentNumber cmn:ShipmentId 1…\* 1/\* Shipment identifiers … all other instances 1100001014507 @type 1…1 1/\* Type of shipment ID. Other values besides ShipmentNumber include: - DeliveryDocument - BillOfLading - ExternalDelivery - GoodsReceiptIssue - TrackingNumber - CarrierReference - MasterBOL - SealNumber BillOfLading cmn:DocumentDate 0…1 0/\* Shipment document date in XML date format YYYY-MM-DD. This is the date for shipment ID type ShipmentNumber. 2014-08-22 cmn:TransactionDates 1…1 - Header level DQS transaction information for ASN. - cmn:TransactionDate 1…1 1/\* Transaction date for DQSA compliance purposes. 2014-08-22 cmn:ShipmentDate 0…1 0/\* Shipment date if greater than 24 hours after transaction date. Also serves as EPCIS shipping event date/time - must be in GMT format. 2014-08-22 cmn:TransactionStatement 1…1 - Transaction statement - Will store all encompassing single statement qualifier and send outbound HDMA documented standard text statement. Key value is "true" in the transaction statement indicator. - cmn:TransactionStatementIndicator 1…\* 1/\* Transaction statement indicator. Valid values: - true - false true @statement 1…1 1/\* Full transaction statement if all 8 are required. Last statement (MeetAllTSReqts) is a catch-all TS. - AuthorizedUnderDSCSA - Is authorized and registered under DSCSA - true - ReceivedFromDSCSAAuthorizedParty - Received product from authorized, registered party under DSCSA - false - ReceivedTIAndTS - Received Transaction Information and a Transaction Statement from the prior owner - false - MeetShipmentReqts - Did not knowingly ship suspect or illegitimate product - true - MeetSection852Reqts - Had systems and processes in place to comply with verification requirements under Section 852 - true - MeetTIReqts - Did not knowingly provide false transaction info - true - MeetTHReqts - Did not knowingly alter the transaction history - true MeetsAllApplicableTSReqts - Meets all applicable transaction statement requirements - true MeetsAllApplicableTSReqts @statementText 0…1 1/256 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" - 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" - 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). Meets all applicable transaction statement requirements pt:ShipmentInformation 0…1 - Transport, routing, and shipping information for shipment or delivery. - cmn:DocumentControl 0…1 0/\* Indicates ASN a new original document or that an existing ASN should be replaced. Valid options include: - Original - Document is original - Replace - Replace original message Original cmn:LadingQuantity 0…1 0/\* Total number of packages in shipment. 180.000 cmn:NetWeight 0…1 0/\* Net weight for shipment. 1248.000 @weightUnitOfMeasure 0…1 0/\* HDMA weight units of measure. [![Closed](/sites/default/files/tech_comms/mpl/Skins/Default/Stylesheets/Images/transparent.gif).Valid values ](#)- `02` – Statute Mile - `4G` – Microliter - `AM` – Ampoule - `AV` – Capsule - `BD` – Bundle - `BG` – Bag - `BO` – Bottle - `BX` – Box - `C3` – Centiliter - `CA` – Case - `CC` – Cubic Centimeter - `CF` – Cubic Feet - `CG` – Card, Blister - `CI` – Cubic Inches - `CL` – Cylinder - `CM` – Centimeter - `CN` – Can - `CP` – Crate - `CQ` – Cartridge - `CR` – Cubic Meters - `CT` – Carton - `DA` – Day - `DI` – Dispenser - `DK` – Kilometers - `DL` – Deciliter - `DM` – Decimeter - `DR` – Drum - `DS` – Display - `DZ` – Dozen - `EA` – Each - `FO` – Fluid Ounce - `FT` – Foot - `GA` – Gallon - `GL` – Gram/liter - `GR` – Gram - `GS` – Gross - `H4` – Hectoliter - `HF` – Hundred Feet - `HR` – Hours - `IN` – Inch - `K6` – Kiloliters - `KG` – Kilogram - `KT` – Kit - `LB` – Pounds - `LF` – Linear Foot - `LO` – Lot (unit of procurement) - `LT` – Liter - `LY` – Linear Yard - `MC` – Microgram - `ME` – Milligram - `ML` – Milliliter - `MM` – Millimeter - `MO` – Months - `MR` – Meter - `OZ` – Ounces - `PC` – Piece - `PF` – Pallet - `PK` – Package - `PR` – Pair - `PT` – Pint - `QT` – Quart - `RL` – Roll - `SC` – Square Centimeter - `SF` – Square Foot - `SH` – Sheet - `SI` – Square Inch - `SM` – Square Meter - `ST` – Set - `SY` – Square Yard - `T3` – Thousand Pieces - `TB` – Tube - `TH` – Thousand - `TY` – Tray - `U2` – Tablet - `UM` – Million - `UN` – Unit - `V2` – Pouch - `VI` – Vial - `WK` – Week - `YD` – Yard - `YR` – Years LB cmn:GrossWeight 0…1 0/\* Gross weight for shipment. 1248.000 @weightUnitOfMeasure 0…1 0/\* HDMA weight units of measure. Required if gross weight sent. [![Closed](/sites/default/files/tech_comms/mpl/Skins/Default/Stylesheets/Images/transparent.gif).Valid values ](#)- `02` – Statute Mile - `4G` – Microliter - `AM` – Ampoule - `AV` – Capsule - `BD` – Bundle - `BG` – Bag - `BO` – Bottle - `BX` – Box - `C3` – Centiliter - `CA` – Case - `CC` – Cubic Centimeter - `CF` – Cubic Feet - `CG` – Card, Blister - `CI` – Cubic Inches - `CL` – Cylinder - `CM` – Centimeter - `CN` – Can - `CP` – Crate - `CQ` – Cartridge - `CR` – Cubic Meters - `CT` – Carton - `DA` – Day - `DI` – Dispenser - `DK` – Kilometers - `DL` – Deciliter - `DM` – Decimeter - `DR` – Drum - `DS` – Display - `DZ` – Dozen - `EA` – Each - `FO` – Fluid Ounce - `FT` – Foot - `GA` – Gallon - `GL` – Gram/liter - `GR` – Gram - `GS` – Gross - `H4` – Hectoliter - `HF` – Hundred Feet - `HR` – Hours - `IN` – Inch - `K6` – Kiloliters - `KG` – Kilogram - `KT` – Kit - `LB` – Pounds - `LF` – Linear Foot - `LO` – Lot (unit of procurement) - `LT` – Liter - `LY` – Linear Yard - `MC` – Microgram - `ME` – Milligram - `ML` – Milliliter - `MM` – Millimeter - `MO` – Months - `MR` – Meter - `OZ` – Ounces - `PC` – Piece - `PF` – Pallet - `PK` – Package - `PR` – Pair - `PT` – Pint - `QT` – Quart - `RL` – Roll - `SC` – Square Centimeter - `SF` – Square Foot - `SH` – Sheet - `SI` – Square Inch - `SM` – Square Meter - `ST` – Set - `SY` – Square Yard - `T3` – Thousand Pieces - `TB` – Tube - `TH` – Thousand - `TY` – Tray - `U2` – Tablet - `UM` – Million - `UN` – Unit - `V2` – Pouch - `VI` – Vial - `WK` – Week - `YD` – Yard - `YR` – Years LB cmn:CarrierSCACNumber 0…1 0/\* The carrier’s 4-character standard SCAC number code. 4WAY cmn:CarrierName 0…1 0/\* Carrier name. 4 WAY TRANSPORT cmn:TransportMethod 0…1 0/\* Transportation method type code identifying the method or type of transport used for the shipment. Valid values: - Air - AirExpress - CustomerPickup - Ground - Rail - Ship - SupplierTruck - Multimodal Air cmn:ShipmentStatus 0…1 0/\* Current status of shipment. Valid values: - Complete - Shipment Completed - Partial - Partial shipment Complete cmn:DropShipIndicator 0…1 0/\* Transaction type code identifying delivery type transaction, ie ASN or drop ship notice. The system will default to ASN if the data element is missing or empty. Valid values: - ASN - Advanced ship notice - DropShip - Drop ship notice ASN cmn:CustomerPortalHistoryCode 0…1 0/\* Unique customer-generated code for use in TraceLink portal to retrieve transaction histories. Customer is responsible for generating this code. - cmn:PackageTrackingNumber 0…1 0/\* Carrier's tracking number for package. - cmn:ShipmentPackagingCode 0…1 0/\* Packaging code at shipment header level. Valid values: - Case - Pallet Case cmn:CustomerVendorId 0…1 0/\* Vendor identifier number in customer's internal system. 95857627 cmn:AdministrativeContactInfo(1) 0…\* - Administrative Communications Contact - Manufacturer instance of cmn:AdministrativeContactInfo with cmn:ContactFunctionCode = Manufacturer. Required for Walgreens if sender a manufacturer, wholesaler, or secondary wholesaler. - cmn:Name 0…1 0/\* Name of the contact person responsible for authenticating the pedigree information. John Smith cmn:Title 0…1 0/\* Title of the contact person. - cmn:Telephone 0…1 0/\* Telephone number of the contact person expected in this field. 516.747.6849 cmn:Email 0…1 0/\* Email address for the contact person expected in this field. jsmith@manufac.com cmn:Url 0…1 0/\* url for website of the contact person. - cmn:ContactFunctionCode 0…1 0/\* Contact function code identifying major duty or responsibility of person or group named as contact. Valid value for manufacturer: - Manufacturer A manufacturer must provide valid contact information of the person responsible for authenticating the pedigree information. A wholesaler or secondary wholesaler must also provide valid contact info person for manufacturer. Manufacturer pt:BusinessEntityDetails 1…1 - All parties and 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 - Business address for transfer to party - Required - Shipping address for transfer to party - Required - Drop-ship recipient party - Optional - Shipping address for transfer from party - Required - cmn:SenderInfo 1…1 - Business and shipping address Information about the supply chain partner from whom ownership is being transferred in the shipment. - 1…1 - Option 1 within choice%1 of SenderInfo contains only the business party ID. In this case TraceLink will populate all of the FromBusinessPartyInfo field data based on company master data lookup. Populated ONLY when master data lookup is desired. 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 0/\* Choice 1 for senderInfo choice%1 group. Mandatory if full business address not provided in FromBusinessPartyInfo option. 8888882028677 @type 1…1 1/\* The type of the FromBusinessPartyLookupId identifier. The value of the type attribute SHALL be one of the supported enumerations. - `GLN` - Global location number - `DUNS` - Dun and Bradstreet ID - `COMPANYID` - Company ID - `CUIT` - Argentine Tax ID - `AR_CUIT` - Argentine Tax ID GLN cmn:FromBusinessPartyInfo 0…1 1/\* Choice 2 for senderInfo choice%1 group. All required fields must be filled in if this option is selected. Mandatory if Lookup ID not provided. - cmn:BusinessId 1…\* 1/\* This identifies the sending party who is transferring ownership of the product to the receiving party. 8888882028677 @type 1…1 1/\* The type of the BusinessID identifier. Valid values: - `GLN` - Global location number - `DEA` - US Drug Enforcement Agency ID number - `HIN` - Health Industry Number - `DUNS` - D-U-N-S number, Dun and Bradstreet - `DUNS4` - Duns+4 ID number - `COMPANYID` - Assigned by seller company identifier - `COMPANYSITEID` - ERP/WMS plant / location id GLN cmn:BusinessInfo 0…1 - Address details. - cmn:BusinessName 1…1 1/\* The business name of the trading partner. Kendall Pharma cmn:Name2 0…1 0/\* Business name line 2 for the trading partner. - cmn:Street1 1…1 1/\* The first line of the street address. 300 Trade Center cmn:Street2 0…1 0/\* The second line of the street address. Suite 7690 cmn:City 1…1 1/\* The city. Woburn cmn:StateOrRegion 1…1 1/\* The state, province, or region using the standard two-letter abbreviation specified in ISO 3166-2:1998 country subdivision code. MA cmn:PostalCode 1…1 1/\* The ZIP or other postal code. 01801 cmn:Country 1…1 1/\* The country using the standard two-letter abbreviation specified in ISO 3166-1alpha-2:1997 country code. US 1…1 - Option 1 within choice%2 of SenderInfo contains only the ShipFromLocationLookupId (in this case TraceLink will populate all of the ShipFromLocationInfo field data based on master data lookup). Populate this element ONLY if master data lookup is desired. 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 0/\* Choice 1 for senderInfo choice%2 group. Mandatory if full set of required elements not provided in ShipFromLocationInfo option. 8888882028677 @type 1…1 1/\* The type of the ShipFromLocationInfoLookupId identifier. The value of the type attribute SHALL be one of the supported enumerations. - `GLN` - Global location number - `DEA` - US Drug Enforcement Agency ID number - `HIN` - Health Industry Number - `DUNS` - D-U-N-S number, Dun and Bradstreet - `DUNS4` - Duns+4 ID number `SGLN` - Serialized Global Location Number - `COMPANYSITEID` - ERP/WMS plant / location id - cmn:ShipFromLocationInfo 0…1 - Choice 2 for senderInfo choice%2 group. All required fields must be filled in if this option is selected. Mandatory if Lookup ID not provided. - cmn:FacilityId 1…\* 1/\* This identifies the ship from location who is transferring ownership of the product to the receiving party. 8888882028677 @type 1…1 1/\* The type of the BusinessID identifier. Valid values: Valid values: - `GLN` - Global location number - `DEA` - Drug Enforcement Agency number - `HIN` - Health Industry Number - `DUNS` - Dun and Bradstreet ID - `DUNS4` - DUNS+4 ID - `COMPANYID` - Company ID - `COMPANYSITEID` - Company site ID - `CUIT` - Argentina Tax ID - `AR_CUIT` - Argentina Tax ID - `SGLN` - Serialized Global Location Number Not Supported: `PARTNERCOMPANYID` - Customer's internal supplier number GLN cmn:LocationInfo 1…1 - Address details. - cmn:BusinessName 1…1 1/\* The business name of the trading partner. Kendall Pharma cmn:Name2 0…1 0/\* Business name line 2 for the trading partner - cmn:Street1 1…1 1/\* The first line of the street address. 300 Trade Center cmn:Street2 0…1 0/\* The second line of the street address. Warehouse 1234 cmn:City 1…1 1/\* The city. Woburn cmn:StateOrRegion 1…1 1/\* The state, province, or region using the standard two-letter abbreviation specified in ISO 3166-2:1998 country subdivision code. MA cmn:PostalCode 1…1 1/\* The ZIP or other postal code. 01801 cmn:Country 1…1 1/\* The country using the standard two-letter abbreviation specified in ISO 3166-1alpha-2:1997 country code. US cmn:LicenseNumber 0…\* 0/\* License number value for the trade partner. Optional for DQSA. 3836300205731 @state 0…1 0/\* 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. MA @agency 0…1 0/\* License number value for the trade partner. Optional for DQSA. Valid values: - `FAWD` - State License Identification Number - `FW` - State License Identification Number - `NABP` - National Association of Boards of Pharmacy Number - `D3` - National Association of Boards of Pharmacy Number FAWD cmn:ContactInfo 0…1 - Contact information for use by downstream trading partners to authenticate (e.g., verify) the transaction information. Optional for DQSA. - cmn:Name 0…1 0/\* Full name of the person or name of the company. Customer Service cmn:Title 0…1 0/\* Job title of the person. - cmn:Telephone 0…1 0/\* Phone number of the person. 1-716-865-1258 cmn:Email 0…1 0/\* Email of the person. - cmn:Url 0…1 0/\* Web address to facilitate authentication. - cmn:ReceiverInfo 1…1 - Business and shipping address Information about the supply chain partner to whom ownership is being transferred in the shipment. - 1…1 - Option 1 within choice%1 of ReceiverInfo contains only the business party ID. In this case TraceLink will populate all of the ToBusinessPartyInfo field data based on master data lookup. Populated ONLY when master data lookup is desired. Option 2 within choice%1 of ReveiverInfo contains full ToBusinessPartyInfo data fields that will be populated by the customer in the interface. - cmn:ToBusinessPartyLookupId 0…1 - Interchange level identification data elements and groups. Applies to entire transmission packet. 3333331013655 @type 1…1 1/\* The type of the ToBusinessPartyLookupId identifier. The value of the type attribute SHALL be one of the supported enumerations: - `GLN` - Global location number - `GCP` - GS1 global company prefix - `DUNS` - Dun and Bradstreet ID - `COMPANYID` - Company ID - `CUIT` - Argentina Tax ID - `AR_CUIT` - Argentina Tax ID GLN cmn:ToBusinessPartyInfo 0…1 - Choice 2 for ReceiverInfo choice%1 group. All required fields must be filled in if this option is selected. Mandatory if Lookup ID not provided. - cmn:BusinessId 1…\* 1/\* This identifies the receiving party to whom ownership is being transferred of the product from the sending party. 3333331013655 @type 1…1 1/\* The type of the BusinessID identifier. Valid values: - `GLN` - Global location number - `DEA` - Drug Enforcement Agency number - `HIN` - Health Industry Number - `DUNS` - Dun and Bradstreet ID - `DUNS4` - DUNS+4 ID - `COMPANYID` - Company ID - `COMPANYSITEID` - Company site ID - `CUIT` - Argentina Tax ID - `AR_CUIT` - Argentina Tax ID - `SGLN` - Serialized Global Location Number GLN cmn:BusinessInfo 1…1 - Address details. - cmn:BusinessName 1…1 1/\* The business name of the trading partner. Wholesale Inc cmn:Name2 0…1 0/\* Business name line 2 for the trading partner - cmn:Street1 1…1 1/\* The first line of the street address. 555 Neelan Road cmn:Street2 0…1 0/\* The second line of the street address. Suite 123 cmn:City 1…1 1/\* The city Sacramento cmn:StateOrRegion 1…1 1/\* The state, province, or region using the standard two-letter abbreviation specified in ISO 3166-2:1998 country subdivision code CA cmn:PostalCode 1…1 1/\* The ZIP or other postal code. 95833 cmn:Country 1…1 1/\* The country using the standard two-letter abbreviation specified in ISO 3166-1alpha-2:1997 country code. US 1…1 - 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 0/\* Choice 1 for ReceiverInfo choice%2 group. Mandatory if full business address not provided in ShipToLocationInfo option. 3333331013655 @type 1…1 1/\* The type of the ShipToLoationLookupId identifier. The value of the type attribute SHALL be one of the supported enumerations: - `GLN` - Global location number - `DEA` - Drug Enforcement Agency number - `HIN` - Health Industry Number - `DUNS4` - DUNS+4 number - `COMPANYSITEID` - Company site ID - `SGLN` - Serialized Global Location Number DEA cmn:ShipToLocationInfo 0…1 - Choice 2 for ReceiverInfo choice%2 group. All required fields must be filled in if this option is selected. Mandatory if Lookup ID not provided. - cmn:FacilityId 1…\* 1/\* This identifies the ship-to party to whom ownership is being transferred of the product from the sending party. 3333331013655 @type 1…1 1/\* The type of the FacilityId identifier. Valid values: - `GLN` - Global location number - `DEA` - Drug Enforcement Agency number - `HIN` - Health Industry Number - `DUNS` - Dun and Bradstreet ID - `DUNS4` - DUNS+4 ID - `COMPANYID` - Company ID - `COMPANYSITEID` - Company site ID - `CUIT` - Argentina Tax ID - `AR_CUIT` - Argentina Tax ID - `SGLN` - Serialized Global Location Number Note: multiple identifiers can be sent. DEA cmn:LocationInfo 1…1 - Address details. - cmn:BusinessName 1…1 1/\* The business name of the trading partner. Wholesale Inc cmn:Name2 0…1 0/\* Business name line 2 for the trading partner - cmn:Street1 1…1 1/\* The first line of the street address. 555 Neelan Road cmn:Street2 0…1 0/\* The second line of the street address. Suite 123 cmn:City 1…1 1/\* The city. Sacramento cmn:StateOrRegion 1…1 1/\* The state, province, or region using the standard two-letter abbreviation specified in ISO 3166-2:1998 country subdivision code CA cmn:PostalCode 1…1 1/\* The ZIP or other postal code. 95833 cmn:Country 1…1 1/\* The country using the standard two-letter abbreviation specified in ISO 3166-1alpha-2:1997 country code. US cmn:LicenseNumber 0…\* 0/\* License number value for the trade partner. Optional for DQSA. 3333300008701 @state 0…1 0/\* 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. CA @agency 0…1 0/\* License number value for the trade partner. Optional for DQSA. Valid values: - `FAWD` - State License Identification Number - `FW` - State License Identification Number - `NABP` - National Association of Boards of Pharmacy Number - `D3` - National Association of Boards of Pharmacy Number FAWD cmn:ContactInfo 0…1 - Contact information for use by downstream trading partners to authenticate (e.g., verify) the transaction information. Not used for receiving party. - cmn:Name 0…1 0/\* Full name of the person or name of the company. - cmn:Title 0…1 0/\* Job title of the person. - cmn:Telephone 0…1 0/\* Phone number of the person. - cmn:Email 0…1 0/\* Email of the person. - cmn:Url 0…1 0/\* Web address to facilitate authentication. - cmn:BusinessPartyInfo 0…\* - Additional business party info for drop-ship parties - 1…1 - Option 1 within choice%1 of BusinessPartyInfo contains only the business party ID. In this case TraceLink will populate all of the BusinessPartyDetail field data based on master data lookup. Populated ONLY when master data lookup is desired. Option 2 within choice%1 of BusinessPartyInfo contains full BusinessPartyDetail data fields that will be populated by the customer in the interface. - cmn:BusinessPartyLookupId 0…1 0/\* Choice 1 for BusinessPartyInfo choice%1 group. Mandatory if full business address not provided in BusinessPartyDetail option. - @type 1…1 1/\* The type of the BusinessPartyLookupId identifier. The value of the type attribute SHALL be one of the supported enumerations: - `GLN` - Global location number - `GCP` - GS1 global company prefix - `DUNS` - Dun and Bradstreet ID - `COMPANYID` - Company ID - `CUIT` - Argentina Tax ID - `AR_CUIT` - Argentina Tax ID - cmn:BusinessPartyDetail 0…1 - Choice 2 for BusinessPartyInfo choice%1 group. All required fields must be filled in if this option is selected. - cmn:BusinessId 1…\* 1/\* This identifies the additional business party. 333333101365 @type 1…1 1/\* The type of the BusinessID identifier. Valid values: - `GLN` - Global location number - `DEA` - Drug Enforcement Agency number - `HIN` - Health Industry Number - `DUNS` - Dun and Bradstreet ID - `DUNS4` - DUNS+4 ID - `COMPANYID` - Company ID - `COMPANYSITEID` - Company site ID - `CUIT` - Argentina Tax ID - `AR_CUIT` - Argentina Tax ID - `SGLN` - Serialized Global Location Number GLN cmn:BusTransactionRole 0…1 0/\* Identifies role of trading partner in BusinessPartyInfo. For drop-ship party use: DropShip - cmn:BusinessInfo 1…1 - Address details. - cmn:BusinessName 1…1 1/\* The business name of the trading partner. Acme Dispensers cmn:Name2 0…1 0/\* Business name line 2 for the trading partner. - cmn:Street1 1…1 1/\* The first line of the street address. 555 Neelan Road cmn:Street2 0…1 0/\* The second line of the street address. Suite 123 cmn:City 1…1 1/\* The city. Sacramento cmn:StateOrRegion 1…1 1/\* The state, province, or region using the standard two-letter abbreviation specified in ISO 3166-2:1998 country subdivision code. CA cmn:PostalCode 1…1 1/\* The ZIP or other postal code. 95833 cmn:Country 1…1 1/\* The country using the standard two-letter abbreviation specified in ISO 3166-1alpha-2:1997 country code. US pt:ASNMilestoneDates 1…\* - Milestone target and actual dates for ASN - Estimated delivery date instance is required in McKesson guidelines. - cmn:DeliveryDateType 1…1 1/\* Type of date-time recorded. Include all important delivery and shipping dates here. Valid value for required estimated delivery date and time: EstimatedDelivery (Required) Note: can be same as transaction date. EstimatedDelivery cmn:Date 1…1 10/10 Milestone date. 2014-08-22 cmn:Time 1…1 8/9 Milestone time. 14:20:00Z cmn:TimeZone 0…1 0/\* Milestone timezone. ES pt:ShipmentItemDetails 0…\* - 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 hierarching in the ContainerAggregation segment below. - - - Generate sequential internal identifier mapping to ShipmentItemDetails. - cmn:LineItemNumber 0…1 0/\* 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 numbers. 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, error willl be thrown if PackingAggregation is present.. 000010 cmn:ShipTHAction 0…1 0/\* Indicates whether the system should create a new Transaction History (default behavior if value is not set) or match (pick) against an existing Transaction History in the system for the line item. This supports the use case where manufacturer is also a redistributor of other manufacturer’s products, and captured the prior Transaction History directly in the Product Track application. This flag needs to be set ONLY for the use case when the manufacturer is also a redistributor of other manufacturer’s 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 Valid options are: Create Pick Create cmn:InternalMaterialNumber 0…1 0/\* Material number in sender's internal system for saleable shipped item or packing item recorded in detail record. CS-100 cmn:ItemDescription 0…1 0/\* Description of material (saleable or packing item) in senders internal system. CS-100 Finished Goods cmn:LotNumber 1…1 1/\* Batch or lot number for saleable shipped product A12345 cmn:ExpirationDate 0…1 0/\* Expiration date for delivery item/lot in XML date format YYY-MM-DD. 2018-08-22 cmn:SerializedLotIndicator 0…1 0/\* Serialized lot identifier. Identifies if lot-based transaction (ASN) will also include serialized data that will be sent to TraceLink in a separate SOM or TL XML EPCIS message. Valid values: - X = Yes, separate serialized transaction to be sent - Null or empty = No - cmn:NonRxProductCode 0…1 0/\* Non Rx product identification code. 943845757 @type 0…1 0/\* Product service ID qualifier for non-Rx product code types recorded in cmn:NonRxProductCode. Required if NonRxProductCode populated. Valid values include: - `UA` - Case UPC. UPC Case Code (2-5-5). Legacy UPC. (Wal-Mart, Meijer, CVS) - `UI` - Package UPC. Consumer Package Code (1-5-5). Legacy UPC. (Wal-Mart, Walgreens, Meijer, RiteAid, Publix, CVS) - `UK` - EAN/UCC-14. 14 digit EAN.UCC (1-2-5-5-1). GTIN-14. (Wal-Mart, Walgreens, Meijer, RiteAid, Publix, CVS) - `UP` - UCC-12. 12 digit EAN.UCC (1-5-5-1). Also UPC-A and GTIN-12. (Wal-Mart, Walgreens, Meijer, RiteAid, Publix, CVS) - `UX` - Universal Product Number. Unique identifier for a healthcare product. (Wal-Mart, CVS) - `VC` - Vendor Catalog Number. Vendor's (Seller's) Catalog Number. (Wal-Mart, Walgreens, Meijer, RiteAid, Publix, CVS UA cmn:DSCSAExempt 0…1 0/\* DSCSAExempt Flag set to true indicates the product does NOT require Transaction History. If Product does not require Transaction History, the system will include the line item in outbound mapping, but will not create a Transaction History for the product. If this flag is not present, the system will default to a false value (e.g., Transaction History IS created). Valid values: true = Indicates the product does NOT require Transaction History false = Indicates teh product DOES require Transaction History false cmn:ItemQuantity 1…1 1/\* Number of saleable units in the lot to represent the Transaction Information “number of containers” that were part of the transaction. 180.000 cmn:SalesQuantity 0…1 0/\* Quantity actually delivered in sales unit of measure. 180.000 @quantityUnitOfMeasure 0…1 0/\* Quantity unit of measure. EA cmn:Volume 0…1 0/\* Volume for item. - @volumeUnitOfMeasure 0…1 0/\* Volume unit of measure. - cmn:NetWeight 0…1 0/\* Net weight for item. - @weightUnitOfMeasure 0…1 0/\* Weight unit of measure. - cmn:GrossWeight 0…1 0/\* Gross weight for item. 14000.000 @weightUnitOfMeasure 0…1 0/\* Weight unit of measure. LB pt:TransactionProductDetails 0…1 - Transaction information per DQSA requirements. Will not be populated for packing items. - 1…1 - 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. Populated ONLY when master data lookup is desired. Option 2 within choice%1 of TransactionProductDetails contains full ProductInfo data fields that will be populated by the customer in the interface. - cmn:ProductCodeLookupId 0…1 0/\* Choice 1 for TransactionProductDetails choice%1 group. Mandatory if full product info not provided in ProductInfo option. NDC542 value as it would appear in master data / Redbook. 08202000230 @type 1…1 1/\* Product code type. Valid Values supported for redbook lookup: NDC542 NDC532 NDC442 NDC541 NDC542 cmn:ProductInfo 0…1 - Choice 2 for TransactionProductDetails choice%2 group. - cmn:ProductCode(1) 1…\* 1/\* National drug code number of the product. 08202000230 cmn:ProductCode(2) - - If populated moved ProductCodeLookupId to //cmn:AggregationItem/cmn:InternalItemNumber. 08202000230 @type 1…1 1/\* The product code type for the value provided in ProductCode - `NDC542` - National Drug Code in 542 format - `NDC442` - National Drug Code in 442 format - `NDC532` - National Drug Code in 432 format - `NDC541` - National Drug Code in 541 format - `NDC` - National Drug Code - `GTIN-14` - GTIN-14 identification number At least one of the NDC formats must be provided for DQSA. GTIN-14 is also recommended. NDC542 cmn:DrugName 1…1 1/\* The proprietary or established name or names of the product that would appear on the label. MIGRAINE MED cmn:Manufacturer 0…1 0/\* The manufacturer of the product. Kendall Pharmaceuticals cmn:DosageForm 1…1 1/\* The dosage form of the product (for example, TABLET, CAPSULE). TABS cmn:Strength 1…1 1/\* The strength or potency of the product, including the unit of measure (for example, 60 mg, 25 ml). 90 MG cmn:ContainerSize 1…1 1/\* The number of units contained in a package of the product (for example, 60, 100). 30 pt:ReferenceDocuments 1…\* - Business documents relevant to shipment of saleable items … Mandatory purchase order instance of group. - cmn:BusinessDocument 1…1 1/\* Purchase order number. 04563869 @type 1…1 1/\* Type of document identifier. Valid values: - PurchaseOrder - Customer purchase order - ReleaseNumber - Purchase order release number - Invoice - Invoice - VendorOrder - Vendore sales order PurchaseOrder cmn:LineItemNumber 0…1 0/'\* Document line item number for the reference document. 000010 cmn:DocumentDate 0…1 10/10 Date of the reference document. 2014-08-22 cmn:ProductOrigin 0…1 0/'\* Identifies how the product was sourced, and is used to determine what fields should appear on the outbound Transaction History based on the sourcing. This flag needs to be set ONLY for the use case when the manufacturer is also a redistributor of other manufacturer’s 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. Applicable values include: - Originator - DirectPurchaseManufacturer - DirectPurchaseRepackager - DirectPurchaseExclusiveDistributor - IndirectPurchase - PreExistingInventory - RepackInventory Originator cmn:OrderNDC 0…1 0/'\* NDC number used to order material in the original customer purchase order. 08202000230 @type 1…1 1/\* The product code type for the value provided in ProductCode NDC542 or NDC. At least one of the 2 NDC formats must be provided for DQSA. NDC542 cmn:DirectPurchaseStatement 0…1 - Direct Purchase statement indicator used to provide Direct Purchase Statement or Received DirectPurchase Statement at line item level, where applicable. Values: - true - false true @statement 1…1 1/\* Direct Purchase or Received Direct Purchase Statement AcquiredAsDirectPurchase - Acquired as a Direct Purchase ReceivedDirectPurchaseStatement - Received a Direct Purchase statement AcquiredAsDirectPurchase @statementText 0…1 1/\* 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: AcquiredAsDirectPurchase - "Product was purchased directly from the manufacturer, manufacturer’s exclusive distributor or repackager who purchased directly from a manufacturer." ReceivedDirectPurchaseStatement - "Received direct purchase statement." - pt:TransactionHistory 0…\* - Captures prior Transaction History 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 where a manufacturer chooses to manage initial Transaction History outside of Product Track and communicate it at time of shipment of the product. - cmn:ShipmentIdentifiers 0…1 - Shipment document or other identification numbers. - cmn:ShipmentID 1…\* 1/\* Shipment ID number. 0080016047 @type 1…1 1/\* Type of shipment ID. Only ShipmentNumber is expected for TransactionHistory. ShipmentNumber cmn:DocumentDate 0…1 0/\* Date for the shipment document in XML date format YYYY-MM-DD 2014-06-06 cmn:TransactionDates 1…1 - Information about the Transfer To Party for prior the Transaction in the Transaction History. - cmn:TransactionDate 1…1 1/\* Transaction date. 2014-08-22 cmn:ShipmentDate 0…1 0/\* Shipment date if greater than 24 hours after transaction date. Also serves as EPCIS shipping event date/time - must be in GMT format. 2014-08-22 pt:DSCSATransferFromParty 1…1 - Information about the Transfer From Party for prior the Transaction in the Transaction History. - cmn:BusinessId 1…\* 1/\* This identifies the sending party who is transferring ownership of the product to the receiving party. 8888882028677 @type 1…1 1/\* The type of the BusinessID identifier. Valid values: - `GLN` - Global location number - `DEA` - Drug Enforcement Agency numbre - `HIN` - Health Industry Number - `DUNS` - Dun and Bradstreet ID - `DUNS4` - DUNS+4 ID - `COMPANYID` - Company ID - `COMPANYSITEID` - Company site ID GLN cmn:DSCSABusinessRole 1…1 1/\* The DSCSA supply chain role of the trading partner in the business transaction. This data element mapping is required for the Transfer From Party only. - Manufacturer - Repackager - ExclusiveDistributor - IndirectSupplier - cmn:BusinessInfo 0…1 - Address details. - cmn:BusinessName 1…1 1/\* The business name of the trading partner. Kendall Pharma cmn:Name2 0…1 0/\* Business name line 2 for the trading partner. - cmn:Street1 1…1 1/\* The first line of the street address. 300 Trade Center cmn:Street2 0…1 0/\* The second line of the street address. Suite 7690 cmn:City 1…1 1/\* The city Woburn cmn:StateOrRegion 1…1 1/\* The state, province, or region using the standard two-letter abbreviation specified in ISO 3166-2:1998 country subdivision code. MA cmn:PostalCode 1…1 1/\* The ZIP or other postal code. 01801 cmn:Country 1…1 1/\* The country using the standard two-letter abbreviation specified in ISO 3166-1alpha-2:1997 country code. US pt:DSCSATransferToParty 1…1 - Information about the Transfer To Party for prior the Transaction in the Transaction History. - cmn:BusinessId 1…\* 1/\* This identifies the receiving party to whom ownership is being transferred of the product from the sending party. 3333331013655 @type 1…1 1/\* The type of the BusinessID identifier. Valid values: - `GLN` - Global location number - `DEA` - Drug Enforcement Agency numbre - `HIN` - Health Industry Number - `DUNS` - Dun and Bradstreet ID - `DUNS4` - DUNS+4 ID - `COMPANYID` - Company ID - `COMPANYSITEID` - Company site ID GLN cmn:DSCSABusinessRole 0…1 0/\* The DSCSA supply chain role of the trading partner in the business transaction. This is needed for the Transfer From Party only. - Manufacturer - Repackager - ExclusiveDistributor - IndirectSupplier - cmn:BusinessInfo 0…1 - Address details. - cmn:BusinessName 1…1 1/\* The business name of the trading partner. Wholesale Inc cmn:Name2 0…1 0/\* Business name line 2 for the trading partner. - cmn:Street1 1…1 1/\* The first line of the street address. 555 Neelan Road cmn:Street2 0…1 0/\* The second line of the street address. Suite 123 cmn:City 1…1 1/\* The city. Sacramento cmn:StateOrRegion 1…1 1/\* The state, province, or region using the standard two-letter abbreviation specified in ISO 3166-2:1998 country subdivision code. CA cmn:PostalCode 1…1 1/\* The ZIP or other postal code. 95833 cmn:Country 1…1 1/\* The country using the standard two-letter abbreviation specified in ISO 3166-1alpha-2:1997 country code. US cmn:LineItemStatusCode 0…1 0/\* Line item status for the shipment. Mapped to SN108 in outbound ASN. Valid values: - AcceptedChanges - AcceptedPartialShipped - AcceptedPriceChange - AcceptedPricePending - AcceptedQuantityChange - AcceptedShipped - AcceptedSubstitution - Backordered - Deleted - Hold - HoldWaiver - InvalidProductNumber - InvalidUnit Required for: Walgreens Optional for: RiteAid AcceptedShipped pt:PackingAggregation 0…\* - Logistic unit header data for delivery -- highest level Logistic unit, ie, container, pallet, pack, etc, for shipment. Contains all other packaged items for one delivery in shipment. TL XML map expects only the following packing hierarchies: - Shipment --> Order --> Pallet --> Item - Shipment --> Order --> Case --> Item - - - Generate sequential internal identifier mapping to PackingAggregagtion. - cmn:ContainerIdentifier 1…1 1/\* SSCC or SGTIN identifier for the container in the packaging aggregation. 03820230000001 cmn:PackagingLevel 1…1 1/\* Identifies type of container for parent packing item. Valid values: - `PL` - Pallet - `CA` - Case / outer pack - `PK` - Pack / inner pack PL cmn:InternalPackingItemDescription 0…1 0/\* Description of packing material from sender's internal system. Standard pallet cmn:PackCount 0…1 0/\* The number of packs or inner packs per outer pack or pallet. Count is only reported here for packaging items. - cmn:TareWeight 0…1 0/\* Tare weight of packing material. 1400.000 @weightUnitOfMeasure 0…1 0/\* HDMA weight unit of measure. [![Closed](/sites/default/files/tech_comms/mpl/Skins/Default/Stylesheets/Images/transparent.gif)Valid values](#)- `02` – Statute Mile - `4G` – Microliter - `AM` – Ampoule - `AV` – Capsule - `BD` – Bundle - `BG` – Bag - `BO` – Bottle - `BX` – Box - `C3` – Centiliter - `C8` – Cubic decimeters - `CA` – Case - `CC` – Cubic Centimeter - `CF` – Cubic Feet - `CG` – Card Blister - `CH` – Container - `CI` – Cubic Inches - `CL` – Cylinder - `CM` – Centimeter - `CN` – Can - `CP` – Crate - `CQ` – Cartridge - `CR` – Cubic Meters - `CT` – Carton - `DA` – Day - `DI` – Dispenser - `DK` – Kilometers - `DL` – Deciliter - `DM` – Decimeter - `DR` – Drum - `DS` – Display - `DZ` – Dozen - `EA` – Each - `FO` – US Fluid Ounce - `FT` – Foot - `GA` – US Gallon - `GL` – Gram/Liter - `GR` – Gram - `GS` – Gross - `H4` – Hectoliter - `HF` – Hundred Feet - `HR` – Hours - `IN` – Inch - `K6` – Kiloliters - `KG` – Kilogram - `KT` – Kit - `LB` – US Pound - `LF` – Linear Foot - `LO` – Lot (unit of procurement) - `LT` – Liter - `LY` – Linear Yard - `MC` – Microgram - `ME` – Milligram - `ML` – Milliliter - `MM` – Millimeter - `MO` – Months - `MQ` – Cubic millimeter - `MR` – Meter - `OZ` – Ounce - `P1` – Percent - `PC` – Piece - `PF` – Pallet - `PK` – Pack (Only supported Outbound) - `PK` – Package - `PR` – Pair - `PT` – Pint - `QT` – Quart - `RL` – Roll - `SC` – Square Centimeter - `SF` – Square Foot - `SH` – Sheet - `SI` – Square Inch - `SM` – Square Meter - `SP` – Self Package - `ST` – Set - `SY` – Square Yard - `SZ` – Syringe - `T3` – Thousand Pieces - `TB` – Tube - `TH` – Thousands - `TN` – Tonne - `TS` – Thousands - `TY` – Tray - `U2` – Tablet - `UM` – Million - `UN` – Unit - `US` – Dosage Form - `V2` – Pouch - `VI` – Vial - `WK` – Week - `YD` – Yard - `YR` – Years LB cmn:GrossWeight 0…1 0/\* Gross total weight of aggregation and packing material 1400.000 @weightUnitOfMeasure 0…1 0/\* HDMA weight unit of measure. [![Closed](/sites/default/files/tech_comms/mpl/Skins/Default/Stylesheets/Images/transparent.gif)Valid values](#)- `02` – Statute Mile - `4G` – Microliter - `AM` – Ampoule - `AV` – Capsule - `BD` – Bundle - `BG` – Bag - `BO` – Bottle - `BX` – Box - `C3` – Centiliter - `C8` – Cubic decimeters - `CA` – Case - `CC` – Cubic Centimeter - `CF` – Cubic Feet - `CG` – Card Blister - `CH` – Container - `CI` – Cubic Inches - `CL` – Cylinder - `CM` – Centimeter - `CN` – Can - `CP` – Crate - `CQ` – Cartridge - `CR` – Cubic Meters - `CT` – Carton - `DA` – Day - `DI` – Dispenser - `DK` – Kilometers - `DL` – Deciliter - `DM` – Decimeter - `DR` – Drum - `DS` – Display - `DZ` – Dozen - `EA` – Each - `FO` – US Fluid Ounce - `FT` – Foot - `GA` – US Gallon - `GL` – Gram/Liter - `GR` – Gram - `GS` – Gross - `H4` – Hectoliter - `HF` – Hundred Feet - `HR` – Hours - `IN` – Inch - `K6` – Kiloliters - `KG` – Kilogram - `KT` – Kit - `LB` – US Pound - `LF` – Linear Foot - `LO` – Lot (unit of procurement) - `LT` – Liter - `LY` – Linear Yard - `MC` – Microgram - `ME` – Milligram - `ML` – Milliliter - `MM` – Millimeter - `MO` – Months - `MQ` – Cubic millimeter - `MR` – Meter - `OZ` – Ounce - `P1` – Percent - `PC` – Piece - `PF` – Pallet - `PK` – Pack (Only supported Outbound) - `PK` – Package - `PR` – Pair - `PT` – Pint - `QT` – Quart - `RL` – Roll - `SC` – Square Centimeter - `SF` – Square Foot - `SH` – Sheet - `SI` – Square Inch - `SM` – Square Meter - `SP` – Self Package - `ST` – Set - `SY` – Square Yard - `SZ` – Syringe - `T3` – Thousand Pieces - `TB` – Tube - `TH` – Thousands - `TN` – Tonne - `TS` – Thousands - `TY` – Tray - `U2` – Tablet - `UM` – Million - `UN` – Unit - `US` – Dosage Form - `V2` – Pouch - `VI` – Vial - `WK` – Week - `YD` – Yard - `YR` – Years LB cmn:GrossVolume 0…1 0/\* Gross volume of packing material. - @volumeUnitOfMeasure 0…1 0/\* HDMA volume unit of measure. [![Closed](/sites/default/files/tech_comms/mpl/Skins/Default/Stylesheets/Images/transparent.gif)Valid values:](#)1. `CC` - Cubic centimeter 2. `CF` - Cubic feet 3. `CI` - Cubic inches 4. `CR` - Cubic meter 5. `CY` - Cubic yard - cmn:Length 0…1 0/\* Length of packing material. - @dimensionUnitOfMeasure 0…1 0/\* HDMA dimension unit of measure. [![Closed](/sites/default/files/tech_comms/mpl/Skins/Default/Stylesheets/Images/transparent.gif)Valid values:](#)1. `CM` - Centimeter 2. `IN` - Inch 3. `MM` - Milimeter - cmn:Height 0…1 0/\* Height of packing material. - @dimensionUnitOfMeasure 0…1 0/\* HDMA dimension unit of measure. [![Closed](/sites/default/files/tech_comms/mpl/Skins/Default/Stylesheets/Images/transparent.gif)Valid values:](#)1. `CM` - Centimeter 2. `IN` - Inch 3. `MM` - Milimeter - cmn:Width 0…1 0/\* Width of packing material. - @dimensionUnitOfMeasure 0…1 0/\* HDMA dimension unit of measure. [![Closed](/sites/default/files/tech_comms/mpl/Skins/Default/Stylesheets/Images/transparent.gif)Valid values:](#)1. `CM` - Centimeter 2. `IN` - Inch 3. `MM` - Milimeter - cmn:PackageTrackingNumber 0…1 0/\* Packaging tracking number at PackingAggregation level. - cmn:AggregationItem 0…\* - Items aggregated to parent packing item in can:PackingAggregation. - - - Generate sequential internal identifier mapping to AggregagtionItem. - cmn:LineItemNumber 0…1 0/'\* Line item number for saleable product and lot in the shipping or delivery document. When no line item number is sent for the AggregationItem, error willl be thrown if PackingAggregation is present. Combination of LineItemNumber and LotNumber will be used to loolup for the correct item info in the ShipmentItemDetails. Purchase order number is not present in the PackingAggregation so unqiue combination of the above is needed. 000010 cmn:AggregationItemId 0…1 0/\* ID number for saleable item or package in list. 08202000230 cmn:LotNumber 0…1 0/\* Batch or lot number for saleable shipped product. A12345 cmn:PackedQuantity 1…1 1/\* Quantity of saleable item packed in parent container. Not populated for packs or inner packs. 40.000 @quantityUnitOfMeasure 1…1 1/\* HDMA quantity unit of measure. [![Closed](/sites/default/files/tech_comms/mpl/Skins/Default/Stylesheets/Images/transparent.gif)Valid values:](#)- `AM` - Ampoule - `BG` - Bag - `BO` - Bottle - `BX` - Box - `CA` – Case - `CH` - Container - `CT` – Carton - `CY` – Cubic Decimeters - `DS` – Display - `DZ` – Dozen - `EA` – Each - `GS` - Gross - `KT` - Kit - `OZ` - Ounce - `P1` – Percent - `PC` – Piece - `PF` – Pallet - `PK` – Package - `SP` – Self Package - `SZ` – Syringe - `TS` – Thousands - `UN` – Unit - `US` - Dosage Form - `VI` - Vial EA [![Closed](/sites/default/files/tech_comms/mpl/Skins/Default/Stylesheets/Images/transparent.gif)Example](#)```plaintext 6543210987654 6543210987654 00000000006198272112dlksj 2014-06-06 14:20:00.123Z false 3333331013655 location1 1100001014507 0080016040 2014-06-06 2014-06-06T13:47:50 true Replace 180 995.894 995.894 4WAYNumber 4WAY AirExpress Complete ASN X25Y4617 ptn666 Case KB007 John Smith 1234567890 jsmith@manufac.com Manufacturer Bill Poulos 805.634.6849 bpoulos@wholesaler.com Wholesaler 8402111111111 PharmaWholeSalerBus2 WholeSaler 2 business address 3180 McKinley St Unit 901 Buffalo NY 14215 US 8402101030023 PharmaWholeSalerShip2 WholeSaler 2 Ship Address 623 Broadway Street Loading point alpha Buffalo NY 14215 US 8888800003604 8888800003607 Letitia Fernandes Logistics Liaison (716) 450-8502 lfer@ll.com http://www.ll.com 333333101365 PharmaDispenserBus Dispenser business address 2978 Hampshire Road Suite 805 Thousand Oaks CA 91360 US 333333101366 PharmaDispenserShip Dispenser shipping address 2999 Hampshire Road Receiving dock 2 Thousand Oaks CA 91361 US 9878500402913 Ron Wilkins Supplier Coordinator (805) 358-8502 lfer@ll.com http://www.ll.com 333333101367 DropShip Acme Dispensers Dropship receiving address 100 Thousand Oaks Blvd Receiving dock 2 Thousand Oaks CA 91360 US EstimatedDelivery 2014-06-16 12:06:46:056Z ES Shipped 2014-06-05 11:23:02 GM OutboundDelivery 2014-06-17 11:23:02 CT 000010 Create TCC-1101-282 Allergy Med 120 MG CAPS 60 Lot-1 2016-08-31 X UX-nonRX-4444444440 true 90 90.000 1781.500 497.947 497.947 Gtin143333B MIGRAINE MED Kendall Pharmaceuticals TABS 90 MG 30 04563869 000010 2014-02-16 Originator 1111111110 true 1222555566 C50664 2014-08-15 2014-08-06 2014-08-09 DEA1111 Manufacturer HELLO Corp. Subsidary of Hello Kitty 1555 Greetings Street Suite 10 Bloomindale FL 12243 US DEA3333 ExclusiveDistributor Goodbye Corp. Subsidary of Goodbye Kitty 1555 Ciao Street Suite 20 Rome TX 12345 US AcceptedShipped 382025401033400000 PL Standard pallet 1 118.000 140.842 282.000 391.4 280.000 100.100 ptn02 000010 TCC-1101-282 Lot-1 30.000 ``` ![](/sites/default/files/tech_comms/mpl/Content/Resources/Images/global_images/note_tip_24x24.png) Review TraceLink's [API: Terms of Use](https://www.tracelink.com/legal-and-trust/api-terms-of-use) #### Table of contents ##### Related Content [ ![Related content](https://www.tracelink.com/sites/default/files/2024-09/cloud.svg) ](/resources/tracelink-university/forecast-plan-idoc) ##### Forecast plan (IDoc) Forecasting APIs allow companies to exchange data about anticipated product demand and supply availability with upstream supply chain Partners without giving these Partners access to their serialization system of record. [View More](/resources/tracelink-university/forecast-plan-idoc) [ ![Related content](https://www.tracelink.com/sites/default/files/2024-09/cloud.svg) ](/resources/tracelink-university/forecast-plan-x12) ##### Forecast plan (X12) Forecasting APIs allow companies to exchange data about anticipated product demand and supply availability with upstream supply chain Partners without giving these Partners access to their serialization system of record. [View More](/resources/tracelink-university/forecast-plan-x12) [ ![Related content](https://www.tracelink.com/sites/default/files/2024-09/cloud.svg) ](/resources/tracelink-university/forecast-plan-response-idoc) ##### Forecast plan response (IDoc) Forecasting APIs allow companies to exchange data about anticipated product demand and supply availability with downstream supply chain Partners without giving these Partners access to their serialization system of record. [View More](/resources/tracelink-university/forecast-plan-response-idoc)