Pick Ship Request Guidelines

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

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.

The following data is sent in the request to TraceLink:

Data Element Occurs Format Length Enums Req Description
soapenv:Envelope [1...1] - - - M The SOAP envelope.
  soapenv:Header [0...1] - - - O Not used by TraceLink, therefore the element can be null or omitted.
  soapenv:Body [1...1] - - - M SOAP message body.
    urn:PickShip [1...1] - - - M The PickShip message payload.
      WorkList [0...1] - - - O The WorkList allows TraceLink to identify a message so the same call can be made repeatedly while producing the same result.
        WorkListID [1...1] String 0/* - M A globally-unique value that groups related calls together (e.g. multiple calls within the same business message). A GUID is a good choice with which to populate this field.
      DeliveryId [1...1] String 1/* - M Delivery document identification number. *1
Delivery Document is mandatory.
        @type [1...1] String 1/* ShipmentIDType M Type of shipment ID. Delivery document number tells system which delivery to update with pick or unpick quantities. Valid values include the Delivery Document. *2
Delivery Document is mandatory.
      DeliveryType [1...1] String 1/* DeliveryType M Indicates if delivery is for a transfer or sale. Each option triggers a different workflow in the system. Transaction History quantities available to different locations but no outbound TH message created. *3
      infoExchangeID [0...1] String 0/* - N/A The info exchange id of the field that triggered the request. Not used.
      DeliveryTransactionType [1...1] String 1/* DeliveryType M This field indicates the type of delivery operation.
      PickLocation [0...1] String 0/* - C Pick location. Warehouse location where product was picked. System then matches to Transaction Histories. Value must match a configured Product Track location. Conditional value is dependent on DeliveryType. *4
  • DeliveryType = Purchase (Optional): Configured Product Track locations where items were picked. Transaction Histories matched against this location.
    • If Product Track Service configured to use Locations to model facilities, populate this element with one of the configured location values.
    • If Product Track Service not configured to use Locations, omit this data element.
  • DeliveryType = Transfer (Mandatory): PickLocation mandatory to represent the Product Track TransferFromLocation from which Transaction History quantities should be decremented.
        @Value [1...1] String 1/* SubscriberLocation M Type of pick location entered. *5
      TransferToLocation [0...1] String 0/* - C Transfer to location. Captures warehouse location to which the product is being transferred. System then assigns to Transaction Histories. Must match a configured Product Track location. Conditional value dependent on DeliveryType. *6
  • DeliveryType = Purchase - Do not populate.
  • DeliveryType = Transfer (Required): Element represents Product Track TransferToLocation where Transaction History quantities need to be made available.
        @Value [1...1] String 1/* SubscriberLocation M Type of pick location entered. *7
      DeliveryCompleteFlag [1...1] Boolean 1/* - M Delivery complete indicator. Flag determines how delivery is processed. Valid values: *8
  • False - Delivery remains open. Transaction History quantities incrementally captured, verified for availability, and reserved against Delivery. Value will be false for Pick.
  • True - Completes delivery. System processes Transaction History. System requires both Delivery Document number and Delivery Complete flag set to true or false each time a pick/ship API call is sent.
Mandatory for Delivery Document ID only.
      PickShipTransaction [0...1] - - - M Header data for shipment.
        DeliveryIdentifiers [0...1] - - - O Ship document identification numbers group.
          DeliveryDocument [0...*] - - - O All other delivery and ship document ID's are optional. DeliveryDocument is NOT returned in this group.
            DeliveryDocumentId [1...1] String 1/* - M Optional delivery and ship document IDs. *9
              @type [1...1] String 1/* ShipmentIDType M Type of optional shipment document ID except for Delivery document. Valid values: *10
  • ShipmentNumber
  • BillOfLading
  • ExternalDelivery
  • GoodsReceiptIssue
  • TrackingNumber
            DocumentDate [0...1] Date 0/* - O Date for the shipment document in XML date format YYYY-MM-DD. *11
            DocumentTime [0...1] Time 0/* - O Time for the shipment document in XML time format HH:MM:SS. *12
        TransactionDate [1...1] Date 1/* - M Transaction date. *13
        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. *14
        DSCSATransactionStatement [1...1] - - - M Transaction statement verifying compliance with DQSA.
          Affirmation [1...*] - - - M Transaction statement affirmation and customer text looping group.
            TransactionStatementIndicator [1...1] Boolean 1/* - M Transaction statement indicator. *15
              @statement [1...1] String 1/* TransactionStatement M Transaction statement. Tentative mapping until further clarification from FDA. Will accept whatever is sent by sender of transaction. Will only return an error if TransactionStatementIndicator is set to false. *16
            TransactionStatementText [0...1] String 0/* - O Customer provided transaction statement text. If provided, will be mapped to the outbound ASN. If not provided, TL will use default language for this field, one of the following statements: *17
  • Seller has complied with each applicable subsection of FDCA Sec. 581(27)(A)-(G).
  • The entity transferring ownership is authorized as required under the Drug Supply Chain Security Act.
  • The entity transferring ownership received the product from a person that is authorized as required under the Drug Supply Chain Security Act.
  • The entity transferring ownership received transaction information and a transaction statement from the prior owner of the product, as required under section 582.
  • The entity transferring ownership did not knowingly ship a suspect or illegitimate product.
  • The entity transferring ownership had systems and processes in place to comply with verification requirements under section 582.
  • The entity transferring ownership did not knowingly provide false transaction information.
  • The entity transferring ownership did not knowingly alter the Transaction History.
        BusinessEntityDetails [1...1] - - - M 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 (Optional)
  • Shipping address for transfer from party (Mandatory)
  • Business address for transfer to party (Mandatory)
  • Shipping address for transfer to party (Mandatory)
  • Drop-ship recipient party (Optional)
          SenderInfo [1...1] - - - M Business and shipping address information of the supply chain partner from whom ownership is being transferred in the shipment.
            choice%1 [1...1] Choice - - M 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.
            FromBusinessPartyLookupId [0...1] String 0/* - N/A NOT SUPPORTED.
              @type [1...1] String 1/* BusinessAddressIdLookup N/A NOT SUPPORTED.
            FromBusinessPartyInfo [0...1] String 1/* - C Choice 2 for senderInfo choice%1 group. All mandatory fields must be filled in if this option is selected.
Mandatory if LookupId is not provided.
              BusinessId [1...*] String 1/* - M This identifies the sending party who is transferring ownership of the product to the receiving party. Valid values: *18
  • GLN = Global location number (Wal-Mart, RiteAid, Meijer)
  • DEA = Drug Enforcement Agency number (CVS, RiteAid, Meijer)
  • HIN = Health Industry Number (Wal-Mart, RiteAid, Meijer)
  • DUNS = Dun and Bradstreet ID (Wal-Mart, Walgreens, Publix, Meijer)
  • DUNS4 = DUNS+4 ID (Wal-Mart, Walgreens, Meijer)
  • COMPANYID = Company ID (Wal-Mart, Meijer)
  • COMPANYSITEID = Company site ID (Wal-Mart, Walgreens, Meijer)
  • PARTNERCOMPANYID = Customer's internal supplier number (Wal-Mart, Walgreens
                @type [1...1] String 1/* AddressIdQualifier M The type of the BusinessId identifier. *19
  • For DQSA purposes, only GLN, DEA and HIN are allowed.
  • For X12 ASN purposes, DUNS, DUNS+4, COMPANYID, and COMPANYSITEID are also supported.
              BusinessInfo [0...1] - - - O Address details.
                BusinessName [1...1] String 1/* - M The business name of the trading partner. *20
                Name2 [0...1] String 0/* - O Business name line 2 for the trading partner.
                Street1 [1...1] String 1/* - M The first line of the street address. *21
                Street2 [0...1] String 0/* - O The second line of the street address. *22
                City [1...1] String 1/* - M The city. *23
                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. *24
                PostalCode [1...1] String 1/* - M The ZIP or other postal code. *25
                Country [1...1] String 1/*   M The country using the standard two-letter abbreviation specified in ISO 3166-1alpha-2:1997 country code. *26
            choice%2 [1...1] Choice - - M 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.
            ShipFromLocationLookupId [0...1] String 0/* - N/A NOT SUPPORTED.
              @type [1...1] String 1/* ShippingAddressIdLookupEnums N/A NOT SUPPORTED.
            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 LookupId is not provided.
              FacilityId [1...*] String 1/* - M This identifies the ship-from party transferring ownership of the product, and optionally identifies the store number. Multiple identifiers can be sent. If FacilityId/@type=STORENUMBER is sent, it must be in addition to one of the other supported identifier types. *27
                @type [1...1] String 1/* AddressIdQualifier M The type of the FacilityId identifier. FacilityId/@type=STORENUMBER is only sent for the ship-to party store number. Valid values: *28
  • 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
  • STORENUMBER = Store Number
              LocationInfo [1...1] - - - M Address details.
                BusinessName [1...1] String 1/* - M The business name of the trading partner. *29
                Name2 [0...1] String 0/* - O Business name line 2 for the trading partner.
                Street1 [1...1] String 1/* - M The first line of the street address. *30
                Street2 [0...1] String 0/* - O The second line of the street address. *31
                City [1...1] String 1/* - M The city. *32
                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. *33
                PostalCode [1...1] String 1/* - M The ZIP or other postal code. *34
                Country [1...1] String 1/* - M The country using the standard two-letter abbreviation specified in ISO 3166-1alpha-2:1997 country code. *35
              LicenseNumber [0...*] String 0/* - O License number value for the trade partner. Optional for DQSA. *36
                @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. *37
                @agency [0...1] String 0/* - O Issuing agency information. Valid values: *38
  • 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
              ContactInfo [0...1] - - - O Contact information for use by downstream trading partners to authenticate (e.g. verify) the message information. Optional for DQSA.
                Name [0...1] String 0/* - O Full name of the person or name of the company. *39
                Telephone [1...1] String 1/* - M Phone number of the person. *40
                Email [0...1] String 0/* - O Email of the person.
          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 - - M 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.
            ToBusinessPartyLookupId [0...1] - - - N/A NOT SUPPORTED.
              @type [1...1] String 1/* BusinessAddressIdLookup N/A NOT SUPPORTED.
            ToBusinessPartyInfo [0...1]     - C Choice 2 for ReceiverInfo choice%1 group. All mandatory fields must be filled in if this option is selected.
Mandatory if LookupId not provided.
              BusinessId [1...*] String 1/* - M This identifies the receiving party to whom ownership of the product is being transferred from the sending party. Valid values: *41
  • GLN = Global location number (Wal-Mart)
  • DEA = Drug Enforcement Agency number (CVS)
  • HIN = Health Industry Number (Wal-Mart)
  • DUNS = Dun and Bradstreet ID (Wal-Mart, Walgreens, Publix)
  • DUNS4 = DUNS+4 ID (Wal-Mart, Walgreens, Meijer)
  • COMPANYID = Company ID (Wal-Mart)
  • COMPANYSITEID = Company site ID (Wal-Mart, Walgreens)
  • PARTNERCOMPANYID = Customer's internal supplier number
                @type [1...1] String 1/* AddressIdQualifier M The type of the BusinessId identifier. *42
  • For DQSA purposes, only GLN, DEA and HIN are allowed.
  • For X12 ASN purposes, DUNS, DUNS+4, COMPANYID, and COMPANYSITEID are also supported.
              BusinessInfo [1...1] - - - M Address details.
                BusinessName [1...1] String 1/* - M The business name of the trading partner. *43
                Name2 [0...1] String 0/* - O Business name line 2 for the trading partner.
                Street1 [1...1] String 1/* - M The first line of the street address. *44
                Street2 [0...1] String 0/* - O The second line of the street address. *45
                City [1...1] String 1/* - M The city. *46
                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. *47
                PostalCode [1...1] String 1/* - M The ZIP or other postal code. *48
                Country [1...1] String 1/* - M The country using the standard two-letter abbreviation specified in ISO 3166-1alpha-2:1997 country code. *49
            choice%2 [1...1] choice   - M Option 1 within choice%2 of ReceiverInfo NOT SUPPORTED. Option 2 within choice%2 of Receiver contains full ShipToLocationInfo data fields that will be populated by the customer in the interface.
            ShipToLocationLookupId [0...1] String 0/* - N/A NOT SUPPORTED.
              @type [1...1] String 1/* ShippingAddressIdLookup N/A NOT SUPPORTED.
            ShipToLocationInfo [0...1] - - - C Choice 2 for ReceiverInfo choice%2 group. All mandatory fields must be filled in if this option is selected.
Mandatory if LookupId not provided.
              FacilityId [1...*] String 1/* - M This identifies the ship-to party to whom ownership of the product is being transferred from the sending party. Valid values: *50
  • GLN = Global location number (Wal-Mart)
  • DEA = Drug Enforcement Agency number (CVS, Meijer)
  • HIN = Health Industry Number
  • DUNS = Dun and Bradstreet ID
  • DUNS4 = DUNS+4 ID (Meijer)
  • COMPANYID = Company ID
  • COMPANYSITEID = Company site ID (Walgreens, RiteAid, Publix, Meijer)
  • PARTNERCOMPANYID = Customer's internal supplier number
  • STORENUMBER = Ship to store number. Multiple identifiers may be sent. If STORENUMBER is sent, it must be in addition to one of the other supported identifier types.
                @type [1...1] String 1/* AddressIdQualifier M The type of the FacilityId identifier. *51
  • For DQSA purposes, only GLN, DEA and HIN are allowed.
  • For X12 ASN purposes, DUNS, DUNS+4, COMPANYID, and COMPANYSITEID are also supported.
  • STORENUMBER is only sent for the ship-to party store number.
              LocationInfo [1...1] - - - M Address details.
                BusinessName [1...1] String 1/* - M The business name of the trading partner. *52
                Name2 [0...1] String 0/* - O Business name line 2 for the trading partner.
                Street1 [1...1] String 1/* - M The first line of the street address. *53
                Street2 [0...1] String 0/* - O The second line of the street address. *54
                City [1...1] String 1/* - M The city. *55
                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. *56
                PostalCode [1...1] String 1/* - M The ZIP or other postal code. *57
                Country [1...1] String 1/* - M The country using the standard two-letter abbreviation specified in ISO 3166-1alpha-2:1997 country code. *58
              LicenseNumber [0...*] String 0/* - O License number value for the trade partner. Optional for DQSA. *59
                @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. *60
                @agency [0...1] String 0/* - O License number value for the trade partner. Optional for DQSA. Valid values: *61
  • 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
              ContactInfo [0...1] - - - O Contact information for use by downstream trading partners to authenticate (e.g. verify) the message information. Optional for DQSA. Not used for the receiving party.
                Name [0...1] String 0/* - O Full name of the person or name of the company.
                Telephone [1...1] String 1/* - M Phone number of the person.
                Email [0...1] String 0/* - O Email of the person.
          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 - - M 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.
            BusinessPartyLookupId [0...1] String 0/* - N/A NOT SUPPORTED.
              @type [1...1] String 1/* BusinessAddressIdLookup N/A NOT SUPPORTED.
            BusinessPartyDetail [0...1] String - - C Choice 2 for BusinessPartyInfo choice%1 group. All mandatory fields must be filled in if this option is selected.
              BusinessId [1...*] String 1/* - M This identifies the business party recorded in this instance. Valid values include:
  • GLN = Global location number (Wal-Mart, RiteAid, Meijer)
  • DEA = Drug Enforcement Agency number (CVS, RiteAid, Meijer)
  • HIN = Health Industry Number (Wal-Mart, RiteAid, Meijer)
  • DUNS = Dun and Bradstreet ID (Wal-Mart, Walgreens, Publix, Meijer)
  • DUNS4 = DUNS+4 ID (Wal-Mart, Walgreens, Meijer)
  • COMPANYID = Company ID (Wal-Mart, Meijer)
  • COMPANYSITEID = Company site ID (Wal-Mart, Walgreens, Meijer)
  • PARTNERCOMPANYID = Customer's internal supplier number
                @type [1...1] String 1/* AddressIdQualifier M The type of the BusinessId identifier.
  • For DQSA purposes, only GLN, DEA and HIN are allowed.
  • For X12 ASN purposes, DUNS, DUNS+4, COMPANYID, and COMPANYSITEID are also supported.
              BusTransactionRole [0...1] String 0/* - O Identifies role of trading partner in BusinessPartyInfo. For drop-ship party use: DropShip. *62
              BusinessInfo [1...1] - - - M Address details. 
                BusinessName [1...1] String 1/* - M The business name of the trading partner.
                Name2 [0...1] String 0/* - O Business name line 2 for the trading partner.
                Street1 [1...1] String 1/* - M The first line of the street address.
                Street2 [0...1] String 0/* - O The second line of the street address.
                City [1...1] String 1/* - M The city.
                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.
                PostalCode [1...1] String 1/* - M The ZIP or other postal code.
                Country [1...1] String 1/* - M The country using the standard two-letter abbreviation specified in ISO 3166-1alpha-2:1997 country code.
        ASNMilestoneDates [0...*] - - - O Milestone target and actual dates for ASN.
          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 and times are required. Valid values: *63
  • Shipped (Mandatory)
  • EstimatedDelivery (Mandatory)
  • Outbound Delivery (Recommended)
  • CurrentScheduledDelivery
  • ProofOfDelivery
  • TransportationPlanning
  • Loading
          Date [1...1] Date 10/10 - M Milestone date. *64
          TimeZone [0...1] Time 8/9 - O Milestone time. Please note: time is mandatory for EstimatedDelivery date time. *65
        ShipmentInformation [1...1] - - - M Transport, routing, and shipping information for shipment or delivery.
          DocumentControl [0...1] String 0/* - O Optional field indicates purpose of message: create new or replace existing.
          LadingQuantity [0...1] Decimal 0/* - O Total number of packages in shipment. *66
          NetWeight [0...1] Decimal 0/* - O Net weight for shipment. *67
            @weightUnitOfMeasure [1...1] String 1/* WeightUOM M HDMA weight units of measure. *68
          GrossWeight [0...1] Decimal 0/* - O Gross weight for shipment. *69
            @weightUnitOfMeasure [1...1] String 1/* WeightUOM C HDMA weight units of measure. *70
Mandatory if GrossWeight is populated.
          CarrierSCACNumber [0...1] String 0/* - O The carrier's 4-character standard SCAC number code. *71
          CarrierName [0...1] String 0/* - O The carrier name.
          DropShipIndicator [0...1] String 0/* DropShipIndicator O Message type code identifying delivery type message, i.e. ASN or drop ship notice. The system will default to ASN if the data element is missing or empty. *72
          PortalAccessCode [0...1] String 0/* - O Unique customer-generated code for use in the TraceLink system to retrieve Transaction Histories. Customer is responsible for generating this code.
          ShipmentStatus [0...1] String 0/* ShipmentStatus O Status of shipment as a whole. Mapped to TD506 in outbound ASN (Mandatory for Meijer). *73
      ItemDetails [0...*] - - - O Pick/Ship item product details. Total quantities shipped for saleable units by material number, batch number, and quantity are stored here.
        LineItemNumber [0...1] String 0/* - C Delivery order line item ID number for saleable product and lot in the shipping or delivery document. While this is an optional data element, 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 with multiple POs only the first PO will be mapped. *74
        PickShipAction [1...1] String 1/* ActionCode M Tells system whether to add a new line item to a delivery or to remove it from the delivery, and to reserve or to unreserve the corresponding Transaction Histories. Valid values: *75
  • Pick = Add a line to delivery
  • Unpick = Remove a line from delivery
The following data elements are used as keys to match and select Transaction Histories:
  • NDC (Mandatory)
  • Lot Number (Optional)
  • Reference Identifier (Optional)
  • Quantity (DSCSA saleable unit / each quantity, mandatory)
          unpickDeliveryNumber [0...1] String 0/* - C Document identifier for another open delivery document used to unpick the reported quantity of the current item. Optional attribute will only be used in Unpick case. Will only be used if the attribute is populated and if PickShipAction = Unpick. If UnpickDeliveryNumber is not populated and PickShipAction = Unpick the unpick will occur from the current delivery.
        InternalMaterialNumber [0...1] String 0/* - C Material number in sender's internal system for saleable shipped item or packing item recorded in detail record. *76
If DSCSAExempt = True, then either InternalmaterialNumber or NDC is mandatory.
        NDC [0...1] String 0/* - C National drug code number of the product. *77
  • Mandatory for DSCSA products.
  • Can be omitted when DSCSAExempt = true.
  • If DSCSAExempt = false or is not set, then NDC is mandatory.
          @type [1...1] String 0/* NDCType M NDC code type. *78
        LotNumber [0...1] String 0/* - C Batch or lot number for saleable shipped product. Lot number is optional, but must be included if product was acquired as an indirect purchase. The system will throw an error if this is not provided for indirect purchases. *79
        ExpDate [0...1] Date 0/* - C The expiration date in YYYY-MM-DD format.
Mandatory if LotNumber is populated.
        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 include:
  • X = Yes, separate serialized transaction to be sent
  • Null or empty = No.
        PickQuantity [1...1] Decimal 1/* - M Quantity recorded for pick / unpick message. *80
          @quantityUnitOfMeasure [1...1] String 1/* QuantityUOM M Quantity unit of measure. *81
        THItemQuantity [1...1] String 1/* - M Number of saleable units in the lot to represent the Transaction Information 'number of containers' that were part of the Transaction Histories. *82
        NonRxProductCode [0...1] String 0/* - O Non Rx product identification code.  *83
          @type [1...1] String 1/* NonRxProductCode C Product service ID qualifier for non-Rx product code types recorded in NonRxProductCode. Valid values: *84
  • BP = Customer product code (CVS, Meijer)
  • CB = Buyer's catalog number (Meijer, CVS)
  • EN = EAN 2-5-5-1 (Wal-Mart, Walgreens, Meijer, CVS)
  • IN = Buyer's Item Number (Walgreens, Meijer, CVS)
  • VN = Seller's item number (Walgreens, Meijer, CVS)
  • MF = Manufacturer's code (Wal-Mart)
  • NH = National health code (Wal-Mart)
  • 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 (Wal-Mart, Walgreens, Meijer, RiteAid, Publix, CVS)
Mandatory if NonRxProductCode is populated.
        DSCSAExempt [0...1] Boolean 0/* - O Identifies whether product requires, or not, DSCSA Transaction History. Supports sending exempt Rx or OTC products in the delivery that can be included in the outbound ASN. Valid values: *85
  • True = Product does not require Transaction History. Data mapped to outbound ASN but no OB Transaction History created.
  • False = Product requires Transaction History. If not populated, defaults to false and Transaction History created.
        ReferenceIdentifier [0...1] String 0/* - O Identification number assigned to the product in receiving, such as a location identifier. The customer defines the Identifier as part of the pick information. Instructs system to precisely match a specific Transaction History with the ReferenceIdentifier and to use that Transaction History for outbound processing. *86
        SalesQuantity [0...1] Decimal 0/* - O Total quantity of saleable items for delivery at line item level. *87
          @quantityUnitOfMeasure [1...1] String 1/* QuantityUOM M Quantity unit of measure. *88
        Volume [0...1] Decimal 0/* - O Volume for item.
          @volumeUnitOfMeasure [1...1] String 1/* VolumeUOM M Volume unit of measure.
        NetWeight [0...1] Decimal 0/* - O Net weight for item.
          @weightUnitOfMeasure [1...1] String 1/* WeightUOM M Weight unit of measure.
        GrossWeight [0...1] Decimal 0/* - O Gross weight for item. *89
          @weightUnitOfMeasure [1...1] String 1/* WeightUOM M Weight unit of measure.
        ShippingReferenceDocuments [1...*] - - - M Business documents relevant to shipment of saleable items. Mandatory purchase order instance of group. *90
          BusinessDocument [1...1] String 1/* - M Shipment document identification number. Purchase order number is mandatory. An error will be thrown if it is not included. It is a mandatory HDMA data element. Mulitple purchase order numbers can be sent in any message, but only one PO number can be sent in any one line item. *91
            @type [1...1] String 1/* BusinessDocumentIdType M Type of document identifier. *92
          LineItemNumber [0...1] String 0/6 - O Document line item number for the reference document. *93
          DocumentDate [0...1] String 10/10 - O Date of the reference document. *94
      PackingAggregation [0...*] - - - O Logistic unit header data for delivery. Highest level Logistic unit, i.e. 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 > Item
  • Shipment > Order > Pallet > Item
  • Shipment > Order > Case > Item
        ContainerIdentifier [1...1] String 1/* - M SSCC-18 identifier for the container in the packaging aggregation. Expecting SSCC-18 code. *95
        PackagingLevel [1...1] String 1/* PackagingLevel M Identifies type of container for parent packing item. *96
        ExternalPackagingId [0...1] String 0/* - O The packing id number in the sender's internal system.
        ExternalPackagingIdType [0...1] String 0/* - O The type of the external packing material identifier. Typically used in SAP to identify how the handling unit (packaging items) identification, including SSCC-18, is generated in SAP.
        InternalPackagingItemCode [0...1] String 0/* - O The item code for the parent packaging material from the sender's internal system.
        InternalPackingItemDescription [0...1] String 0/* - O Description of packing material from sender's internal system. *97
        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.
        PackagingMaterialType [0...1] String 0/* - O Not used.
        PackagingMaterialTypeDescription [0...1] String 0/* - O Not used.
        PackagingMaterialTypeStatus [0...1] String 0/* - O Not used.
        PackagingMaterialGroup [0...1] String 0/* - O Not used.
        PackagingMaterialGroupDescription [0...1] String 0/* - O Not used.
        PackagingMaterialCategory [0...1] String 0/* - O The packaging material category of the packaging items.
        TravelTime [0...1] String 0/* - O The time traveled during the delivery.
        TrackingNumber [0...1] String 0/* - O The number tracking the delivery of the packaging items.
        DistanceTraveled [0...1] String 0/* - O The distance traveled during the delivery.
        SMGId [0...1] String 0/* - O Not used.
        WeightsAndMeasures - - - - - Lists the weight and measurement details of the items and packaging materials.
          TareWeight [0...1] Decimal 0/* - O Tare weight of packing material. *98
              @weightUnitOfMeasure [1...1] String 1/* WeightUOM M HDMA weight unit of measure. *99
           GrossWeight [0...1] Decimal 0/* - O Gross total weight of aggregation and packing material. *100
            @weightUnitOfMeasure [1...1] String 1/* WeightUOM M HDMA weight unit of measure. *101
          NetWeight [0...1] String 0/* - O Net weight for item.
            @weightUnitOfMeasure [1...1] String 1/* WeightUOM M HDMA weight unit of measure. *102
          AllowedWeight [0...1] String 0/* - O Allowed weight of the item.
            @weightUnitOfMeasure [1...1] String 1/* WeightUOM M HDMA weight unit of measure. *103
          GrossVolume [0...1] Decimal 0/* - O Gross volume of packing material.
            @volumeUnitOfMeasure [1...1] String 1/* VolumeUOM M HDMA volume unit of measure.
          NetVolume [1...1] String 1/* - M Net volume of packaging material.
            @volumeUnitOfMeasure [1...1] String 1/* VolumeUOM M HDMA volume unit of measure.
          AllowedVolume [1...1] String 1/* - M Allowed volume of packaging material.
            @volumeUnitOfMeasure [1...1] String 1/* VolumeUOM M HDMA volume unit of measure.
          TareVolume [1...1] String 1/* - M Tare volume of packing material.
            @volumeUnitOfMeasure [1...1] String 1/* VolumeUOM M HDMA volume unit of measure.
          Volume [1...1] String 0/* - N/A Not used.
            @volumeUnitOfMeasure [1...1] String 1/* VolumeUOM M HDMA volume unit of measure.
          Length [0...1] Decimal 0/* - O Length of packing material.
            @dimensionUnitOfMeasure [1...1] String 1/* DimensionUOM M HDMA dimension unit of measure.
          Height [0...1] Decimal 0/* - O Height of packing material.
            @dimensionUnitOfMeasure [1...1] String 1/* DimensionUOM M HDMA dimension unit of measure.
          Width [0...1] Decimal 0/* - O Width of packing material.
            @dimensionUnitOfMeasure [1...1] String 1/* DimensionUOM M HDMA dimension unit of measure.
          LoadingPlatformLength [0...1] String 0/* - O The length of the loading platform.
            @dimensionUnitOfMeasure [1...1] String 1/* DimensionUOM M HDMA dimension unit of measure.
        AggregationItem [0...*] - - - M Items aggregated to parent packing item in can: PackingAggregation.
          PackingContentsType [0...1] String 0/* PackingContentsTypeEnum O Indicates type of container or item in the aggregation. Defaults to valid value, "IT" = Item.
          ExternalPackagingId [0...1] String 0/* - O The packaging identifier of the aggregation item.
          ContainerIdentifier [0...1] String 0/* - O The identifier for the container in the packaging aggregation.
          LineItemNumber [0...1] String 0/* - R Line item number for saleable product and lot in the shipping or delivery document. Line item number is mandatory 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 with multiple POs only the first PO will be mapped. *104
          InternalMaterialNumber [0...1] String 0/* - O ID number for saleable item or package in list. Should match with the NDC or GTIN for the product lot in the aggregation group.
          LotNumber [0...1] String 0/* - O Batch or lot number for saleable shipped product. *105
          PackedQuantity [1...1] String 1/* - M Quantity of saleable item packed in parent container. Not populated for packs or inner packs. *106
            @quantityUnitOfMeasure [1...1] String 1/* QuantityUOM M HDMA quantity unit of measure. *107