Product Track Processing Response Guidelines

See How To Use this Guide before selecting the below fields.

Message Type: IE_PROCESSING_RESPONSE

Info Exchange Display Name: Processing Response

These fields are sent by TraceLink back to the sender of the initiating message.

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 Product Track messages supported by Processing Response are Shipment Receipt, Return Receipt, Create Initial Transaction, Update Transaction, Increment TH Quantity, Decrement TH Quantity, Pick Ship, Manufacturer Sales Shipment TH & LSP Shipment.
Data Element Occurs Format Length Enum Req Description
ie:IEProcessingAckMessage [1...1] - - - M Root element of message.
  ie:ControlFileHeader [1...1] - - - M XML file control header record.
    cmn:FileSenderNumber [1...1] String [1/20] - M File sender's company identifier.1
    cmn:FileReceiverNumber [1...1] String [1/20] - M File recipient's company identifier. *2
    cmn:FileControlNumber [1...1] String [1/*] - M Unique file control ID number. *3
    cmn:FileDate [1...1] Date [10/10] - M Date file generated in XML YYYY-MM-DD format. *4
    cmn:FileTime [1...1] Time [9/9] - M Time file generated in XML HH:MM:SSZ format (must be GMT). *5
  ie:MessageBody [1...1] - - - M Main body of message.
    ie:ProcessingResultsHeader [1...1] - - - M Provides identification of the processed message with information from the original message header, including message type, original message identifier, message sender and receiver identifiers, and original message date and time.
      ie:InputFileTransactionType [1...1] String [1/*] TransactionType M Transaction type of the processed message. Valid values: *6
  • PT_CREATE_INITIAL_TRANSACTION
  • PT_DECREMENT_TH_QTY
  • PT_INCREMENT_TH_QTY
  • PT_LSP_SHIPMENT
  • PT_PICK_SHIP
  • PT_RETURN_RECEIPT
  • PT_SHIPMENT_RECEIPT
  • PT_SHIPMENT_TH
  • PT_UPDATE_TRANSACTION
      ie:InputFileSenderNumber [1...1] String [1/20] - M FileSenderNumber that was provided in the processed message. *7
      ie:InputFileReceiverNumber [1...1] String [1/20] - M FileReceiverNumber that was provided in the processed message. *8
      ie:InputFileControlNumber [1...1] String [1/*] - M FileControlNumber that was provided in the processed message. *9
      ie:InputFileDate [1...1] Date [10/10] - M FileDate that was provided in the processed message in XML YYYY-MM-DD format. *10
      ie:InputFileTime [1...1] Time [9/9] - M FileTime that was provided in the processed message in XML HH:MM:SSZ format. *11
    ie:ProcessingResults [1...1] - - - M Provides the processing results of the message with a summary of:
  • Total number of items updated.
  • Total items (of the updated) processed with no warning.
  • Total items (of the updated) processed with warning.
  • Total failed items.

For each of these categories, the system returns an "item spec" with identifying information about each item processed, the processing code, and the processing message.
      ie:ProcessingSummary [1...1] - - - M Provides the processing results of the message with a summary of:
  • Total number of items updated.
  • Total (of the updated) processed with no warning.
  • Total (of the updated) processed with warning.
  • Total failed items. 
        ie:TotalUpdated [1...1] Integer - - M The total number of items from the originating message that were updated by the system.
        ie:TotalProcessedNoWarning [1...1] Integer - - M The total number of updated items from the originating message that were updated without warning. This is a subset of TotalUpdated. If this value is greater than zero, the ProcessedNoWarning element will be populated with the item spec containing identifying information about each item processed including the processing code.
        ie:TotalProcessedWithWarning [1...1] Integer - - M The total number of updated items from the originating message that were updated with warning. This is a subset of TotalUpdated. If this value is greater than zero, the ProcessedWithWarning element will be populated with the item spec containing identifying information about each item that had a warning, including the processing code and processing message.
        ie:TotalFailed [1...1] Integer - - M The total number of updated items from the originating message that were not updated as a result of errors. If this value is greater than zero, the FailedItem element will be populated with the item spec containing identifying information about each item that failed, including the processing code and processing message.
      ie:ProcessedNoWarning [0...1] - - - C This element contains one item spec with the processing code for each item updated without warning. The item spec contains identifying information about each item processed. The number of item specs will be equal to the value of TotalProcessedNoWarning. If TotalProcessedNoWarning = 0,  ProcessedNoWarning will not be populated.
        ie:ProcessedItem [1...*] - - - M List of one or more item specs with the processing code for each item updated without warning.
          choice%1 [0...1] Choice - - O The choice%1 element is optional, but one of the following choices can be optionally provided:
  • Option 1 within choice%1 is the Product Track ShipmentReceiptSpec, used for shipment receipt messages submitted to the system for purchase or transfer receipts.
  • Option 2 within choice%1 is the Product Track ReturnReceiptSpec, which indicates the receipt of sellable and non-sellable returns.
  • Option 3 within choice%1 is the Product Track CreateIntitialTransactionSpec, used to create the initial transaction messages submitted to the system to create pre-2015 baseline transactions or initial transactions for repackaged goods.
  • Option 4 within choice%1 is the Product Track UpdateTransactionSpec, used for updating transaction messages already submitted to the system. Updates may include Transaction History (TH) quantities, the state of THs associated with an NDC and Lot, or to void THs associated with a delivery.
  • Option 5 for choice%1 group is the Product Track IncrementTHQuantitySpec, used to update transaction messages submitted to the system to increment TH quantities associated with an NDC and Lot.
  • Option 6 for choice%1 group is the Product Track DecrementTHQuantitySpec, used to update transaction messages submitted to the system to decrement TH quantities associated with an NDC and Lot.
  • Option 7 within choice%1 is the Product Track PickShipTHSpec, used for pick/ship messages submitted to the system for pick-matching the THs for a customer sale or warehouse transfer shipment.
  • Option 8 within choice%1 is the Product Track  MfrSalesShipmentTHSpec, used for the manufacturer sales shipment transaction type for the picking and shipping of goods (for the purpose of the sale of goods), resulting in the TH creation.
  • Option 9 within choice%1 is the Product Track LSPShipmentTHSpec,  used for a shipment transaction type for the picking and shipping of goods (for the purpose of the sale of the goods), by 3PL providers submitted to the manufacturer, resulting in TH creation via Product Track.
          ie:ShipmentReceiptSpec [0...1] - - - O Option 1 for the choice%1 group is used for shipment receipt messages, which are submitted to the system to indicate either a purchase or to transfer receipts.
            cmn:Location [0...1] String [1/*] - C Location indicates where the shipment is received. If the Product Track Service is configured to use locations to model a company's facilities, this element should be populated with one of the configured location values. *12
If the Product Track Service is not configured to use Locations, omit this element.
              @type [1...1] String [1/*] Location C This attribute identifies the location types.
Mandatory if cmn:Location is populated.
            cmn:ReceiptType [1...1] String [1/*] ReceiptType M Indicates if the receipt reflects a purchase or a of goods from one facility to another (e.g. from warehouse to warehouse, a 3PL transfer, or from pharmacy to pharmacy). For intra-company transfer receipts, a transfer shipment must have been initiated and TH quantities transferred made accessible to new location.
            cmn:DeliveryNumber [1...1] String [1/*] - M The delivery number for the shipment. The system uses the DeliveryNumber to match against THs received from a supplier (against the DeliveryNumber in the ASN), or to match against the transfer DeliveryNumber associated with transferred THs for an intra-company transfer. *13
            cmn:NDC [1...1] String [1/*] - M The NDC of the product being received without hyphen separators (see data sample). *14
              @type [1...1] String [1/*] NDCType M The attribute that identifies the NDC type.
            cmn:LotNumber [0...1] String [0/*] - C The lot/batch number of the product being received. The LotNumber is optional for pharmacies. *15
            cmn:Quantity [1...1] Integer - - M The each/unit quantity of the product being received. This value will be used to represent the quantity received against the TH. Subsequent picks against the TH will be against this quantity to confirm the unit of measures (each /unit) is consistent. Reverse receipts are supported by providing a negative quantity. This quantity will be decremented from the received quantity of the matching TH. *16
            cmn:TransactionIdentifier [0...*] String [0/*] - O The business transaction identifier for the business transaction that initiated the product receipt (e.g. PO Number or Transfer Number). *17
              @type [1...1] String [1/*] TransactionIdentifier C The attribute identifies the transaction identifier type.
Mandatory if cmn:TransactionIdentifier is populated.
          ie:ReturnReceiptSpec [0...1] - - - O Option 2 for the choice%1 group is used for return receipt messages submitted to the system for sellable or non-sellable returns.
            cmn:Location [0...1] String [1/*] - C Location where the receiving of a return shipment occurred. If the Product Track Service is configured to use locations to model company facilities, this element must be populated with one of the configured location values. If the Product Track Service is not configured to use Locations, omit this element.
              @type [1...1] String [1/*] Location C The attribute identifies the location types.
Mandatory if cmn:Location is populated.
            cmn:ReturnReceiptType [1...1] String [1/*] ReturnReceiptType M Indicates if the return receipt is sellable or non-sellable. For sellable returns, there must be a matching TH in the company against the NDC and Lot. The system will first attempt to match at the receiving location, if not found, it is matched at the company level. The system will increment the quantity against the matching TH and make the quantity available at the receiving location for subsequent picks/ships from this location. If no match is found, the system generates an error. For non-sellable returns, the system creates a record indicating that the non-sellable return was received for audit trail purposes.
            cmn:NDC [0...1] String [1/*] - M The NDC for the sellable or non-sellable return. This is provided without hyphen separators.
              @type [1...1] String [1/*] NDCType M This attribute identifies the NDC type.
            cmn:NDCLookupId [0...1] String [1/*] - M The NDC of the non-sellable return product without hyphen separators. This value is used for a Product Master Data lookup of the NDC attributes to create the non-sellable return entry. *18
              @type [1...1] String [1/*] NDCType M This attribute identifies the NDC type.
            cmn:LotNumber [1...1] String [1/*] - M The lot/batch number of the product.
            cmn:Quantity [1...1] Integer - - M The quantity of product returned.
            cmn:TransactionIdentifier [0...*] String [0/*] - O A list of one or more business documents associated with the return receipt for audit trailing purposes.
              @type [1...1] String [1/*] TransactionIdentifier C The attribute identifies the transaction identifier type.
Mandatory if cmn:TransactionIdentifier is populated.
          ie:CreateInitialTransactionSpec [0...1] - - - O Option 3 for the choice%1 group is used to create the initial transaction messages that are submitted to the system to create pre-2015 baseline transactions or initial transactions for repackaged goods.
            cmn:Location [0...1] String [1/*] - C Location where the inventory for the new THs resides. This associates the THs with that location when they are created. If the Product Track Service is configured to use Locations to model company facilities, this element is populated with one of the configured location values. If the Product Track Service is not configured to use Locations, omit this element.
              @type [1...1] String [1/*] Location M This attribute identifies the location type.
Mandatory if cmn:Location is populated.
            ie:SourceProduct [0...*] - - - C Indicates the source product within repackaging operations. This is included only when CreateInitialTransaction is used to create repack transactions.
              cmn:NDC [1...1] String [1/*] - M The NDC of the source product without hyphen separators. 
                @type [1...1] String [1/*] NDCType M This attribute identifies the NDC type.
              cmn:LotNumber [1...1] String [1/*] - M The lot/batch number of the source product.
              cmn:ReferenceIdentifier [0...1] String [0/*] - O The Reference Identifier assigned to the TH for the source product NDC and Lot during receiving. *19
            cmn:NDC [0...1] String [1/*] - O The NDC of the product without hyphen separators. 
              @type [1...1] String [1/*] NDCType C This attribute identifies the NDC type.
Mandatory if cmn:NDC is populated.
            cmn:NDCLookupId [0...1] String [1/*] - O The NDC of the product without hyphen separators. Used to instruct the system to perform a Product Master Data lookup for the NDC attributes required for the TH.
              @type [1...1] String [1/*] NDCType C This attribute identifies the NDC type.
Mandatory if cmn:NDCLookUpId is populated.
            cmn:LotNumber [0...1] String [0/*] - O The lot/batch number of the product.
            cmn:ExpirationDate [0...1] Date [10/10] - O The expiration date of the product in YYYY-MM-DD format. *20
            cmn:ReferenceIdentifier [0...1] String [0/*] - O The Reference Identifier assigned to the TH for this NDC and Lot during receiving. The Reference Identifier is only used for precise matching once assigned at receiving.
            cmn:Quantity [1...1] Integer - - M The quantity of THs to create corresponding to the quantity of sellable eaches/units that exist in the inventory.
          ie:UpdateTransactionSpec [0...1] - - - O Option 4 for the choice%1 group is used to update transaction messages submitted to the system to update TH quantities, update the state of the THs associated with an NDC and Lot, or to void shipment THs associated with a delivery (in submitted transactions).
            cmn:Location [0...1] String [1/*] - C Location where the inventory exists for which TH metadata updates are occurring. If the Product Track Service is configured to use Locations to model company facilities, this element is populated with one of the configured location values.
If the Product Track Service is not configured to use Locations, omit this element.
              @type [1...1] String [1/*] Location C The attribute identifies the location types.

Valid values:

  • COMPANYSITEID
  • DEA
  • DUNS4
  • GLN
  • HIN
Mandatory if cmn:Location is populated.
            cmn:NDC [0...1] String [1/*] - O The NDC associated with a TH, without hyphen separators. 
              @type [1...1] String [1/*] NDCType M This attribute identifies the NDC type.
Mandatory if cmn:NDC is populated.
            cmn:LotNumber [0...1] String [0/*] - O The lot number associated with the TH.
            cmn:ReferenceIdentifier [0...1] String [0/*] - O The Reference Identifier assigned to a TH for this NDC and Lot during receiving. The Reference Identifier is only used for precise matching, once assigned at receiving.
            cmn:DeliveryNumber [0...1] String [0/*] - O The original receiving delivery number associated with a TH for this NDC and Lot. The DeliveryNumber should only be used for precise matching when the original DeliveryNumber for a TH is known.
            cmn:TransactionIdentifier [0...*] String [0/*] - O A list of one or more business documents associated with the updated transaction for audit trailing purposes.
              @type [1...1] String [1/*] TransactionIdentifier C This attribute identifies the transaction identifier type.
Mandatory if cmn:TransactionIdentifier is populated.
            cmn:UpdateQuantity [0...1] Integer - - O Provides either the adjustment or replacement TH quantity to be applied to the matching THs. AdjustBy instructs the system to increment or decrement the current available TH quantity. A positive number will increment the current count by that value. A negative number will decrement the current count by that value. A negative number can result in a negative count. Replace instructs the system to replace the available TH quantity with the new supplied value. *21
              @type [1...1] String [1/*] UpdateQuantityType C The attribute identifies the quantity type.
Mandatory if cmn:UpdateQuantity is populated.
            cmn:THState [0...1] String [1...1] THState O The new state to apply to the matching available THs. All THs with remaining quantities for the entire NDC and Lot at the specified location are updated to the new state.
            cmn:TransactionHistoryType [0...1] String [1/*] THType O Indicates if the TH to be voided was one sent or received from a trade partner. This is required to disambiguate THs that may have the same Delivery Number (across THs sent and received).
            cmn:PartnerId [0...1] String [1/*] - O Identifies the trade partner that the TH was sent to or received from. This is required to disambiguate THs that may have the same Delivery Number (across THs sent and received). *22
              @type [1...1] String [1/*] PartnerId C This attribute identifies the location types.
Mandatory if cmn:PartnerId is populated.
          ie:PTIncrementTHQuantitySpec [0...1] - - - O Option 5 for choice%1 group. Used to update transaction messages submitted to the system to increment TH quantities associated with an NDC and Lot.
            cmn:Location [0...1] String [1/*] - O Location where inventory exists for which TH meta data update is occurring. 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.
              @type [1...1] String [1/*] SubscriberLocation C Attribute identifies the location types.
Mandatory if cmn:Location is populated.
            ie:THMatchingCriteria [1...1] - - - M Identifies the items for which quantities associated with one or more THs will be incremented.
              cmn:NDC [1...1] String [1/*] - M The NDC associated with a TH without hyphen separators.
                @type [1...1] String [1/*] NDCType M Attribute identifies the NDC type.
              cmn:LotNumber [1...1] String [1/*] - M The lot number associated with a TH.
              cmn:ReferenceIdentifier [0...1] String [0/*] - O The Reference Identifier assigned to a TH for this NDC and Lot during receiving. The Reference Identifier should only be used for precise matching and when one was assigned at receiving.
              cmn:DeliveryNumber [0...1] String [0/*] - O The original receiving Delivery Number associated with a TH for this NDC and Lot. The DeliveryNumber should only be used for precise matching and when the original DeliveryNumber for a TH is known.
            cmn:Quantity [1...1] Integer - - M Provides the increment quantity to be applied to the matching THs.
            cmn:ReferenceIdentifier [0...1] String [0/*] - O Reference identifier assigned to identify this Increment transaction.
            cmn:TransactionIdentifier [0...*] String [0/*] - O A list of one or more business documents associated with the return receipt for audit trailing purposes.
              @type [1...1] String [1/*] TransactionIdentifier C Attribute that identifies the transaction identifier type.
Mandatory if cmn:TransactionIdentifier is populated.
          ie:PTDecrementTHQuantitySpec [0...1] - - - O Option 6 for choice%1 group. Used to update transaction messages submitted to the system to decrement TH quantities associated with an NDC and Lot.
            cmn:Location [0...1] String [1/*] - O Location where inventory exists for which TH meta data update is occurring. 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.
              @type [1...1] String [1/*] SubscriberLocation C Attribute identifies the location types.
Mandatory if cmn:Location is populated.
            ie:THMatchingCriteria [1...1] - - - M Identifies the items for which quantities associated with one or more THs will be decremented.
              cmn:NDC [1...1] String [1/*] - M The NDC associated with a TH without hyphen separators.
                @type [1...1] String [1/*] NDCType M Attribute identifies the NDC type.
              cmn:LotNumber [1...1] String [1/*] - M The lot number associated with a TH.
              cmn:ReferenceIdentifier [0...1] String [0/*] - O The Reference Identifier assigned to a TH for this NDC and Lot during receiving. The Reference Identifier should only be used for precise matching and when one was assigned at receiving.
              cmn:DeliveryNumber [0...1] String [0/*] - O The original receiving Delivery Number associated with a TH for this NDC and Lot. The DeliveryNumber should only be used for precise matching and when the original DeliveryNumber for a TH is known.
            cmn:Quantity [1...1] Integer - - M Provides the decrement quantity to be applied to the matching THs.
            cmn:TransactionIdentifier [0...*] String [0/*] - O A list of one or more business documents associated with the return receipt for audit trailing purposes.
              @type [1...1] String [1/*] TransactionIdentifier C Attribute that identifies the transaction identifier type.
          ie:PickShipTHSpec  [0...1] - - - O Option 7 for choice%1 group. Used for pick/ship messages submitted to the system to pick-match THs for a customer sale or a warehouse transfer shipment.
            cmn:PickLocation [0...1] String [0/*] - O Warehouse location where product was picked. *23
              @type [1...1] String [1/*] Location C Type of pick location entered.

Valid values:

  • COMPANYSITEID
  • DEA
  • DUNS4
  • GLN
  • HIN
Mandatory if cmn:Location is populated.
            cmn:TransferToLocation [0...1] String [0/*] - O Warehouse location where the product is being transferred. *24
              @type [1...1] String [1/*] Location C Type of pick location entered.

Valid values:

  • COMPANYSITEID
  • DEA
  • DUNS4
  • GLN
  • HIN
Mandatory if cmn:Location is populated.
            cmn: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.
            cmn:DeliveryIdentifiers [1...1] - - - M Ship document identification numbers group.
              cmn:DeliveryDocument [1...*] - - - M List of one or more delivery document identification numbers, minimally including DeliveryDocument.
                cmn:DeliveryDocumentId [1...1] String [1/*] - M Delivery document/ship document identifier. *25
                  @type [1...1] String [1/*] ShipmentIDType M Type of shipment ID.

Valid values:

  • BillOfLading
  • DeliveryDocument
  • ExternalDelivery
  • GoodsReceiptIssue
  • ShipmentNumber
  • TrackingNumber
                cmn:DocumentDate [0...1] Date [0/*] - O Date for the shipment document in XML date format YYYY-MM-DD. *26
                cmn:DocumentTime [0...1] Date [0/*] - O Time for the shipment document in XML Time format HH:MM:SS. *27
            cmn:PickShipAction [1...1] String [1/*] PickActionCode 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 THs.
            cmn:InternalMaterialNumber [0...1] String [0/*] - O Material number in sender's internal system for a sellable shipped item or packing item recorded in detail record. *28
            cmn:NDC [0...1] String [1/*] - O National drug code number of the product.
              @type [1...1] String [0/*] NDCType C NDC code type.
Mandatory if cmn:NDC is populated.
            cmn:LotNumber [0...1] String [0/*] - O Batch or lot number for sellable shipped product.
Lot number is optional, but must be included if the product was acquired as an indirect purchase.
            cmn:ReferenceIdentifier [0...1] String [0/*] - O Identification number assigned to the TH during receiving, such as a location identifier. 
            cmn:PickQuantity [1...1] Decimal [1/*] - M Quantity recorded for pick/unpick transaction. *29
              @quantityUnitOfMeasure [1...1] String [0/*] QuantityUOM M Quantity unit of measure.
            cmn:THItemQuantity [1...1] String [1/*] - M Number of sellable units in the lot to represent the Transaction Information "number of containers" that were part of the THs.
            cmn:ItemReferenceDocuments [0...*] - - - O Business documents relevant to the shipment of sellable items.
              cmn:BusinessDocument [1...1] String [1/*] - M Shipment document identification number. *30
                @type [1...1] String [1/*] BusinessDocumentType M Type of document identifier.
              cmn:LineItemNumber [0...1] String [0/6] - O Document line item number for the reference document. *31
              cmn:DocumentDate [0...1] String [10/10] - O Date of the reference document. *32
            cmn:AvailableQuantity  [0...1] Integer - - O Returns available in TH quantity when an overpick has occurred. *33
          ie:MfrSalesShipmentTHSpec [0...1] - - - O Option 8 for choice%1 group. Used for manufacturer sales shipment transaction types for the picking and shipping of goods (for the sale of goods), resulting in TH creation.
            cmn:Location [0...1] String [0/*] - O Warehouse location where product was picked. 
              @type [1...1] String [1/*] Location C Type of pick location entered.

Valid values:

  • COMPANYSITEID
  • DEA
  • DUNS4
  • GLN
  • HIN
Mandatory if cmn:Location is populated.
            cmn:cmn:ShipmentIdentifiers [1...1] - - - M Ship document identification numbers group.
              cmn:ShipmentId [1...*] String [1/*] - M Delivery document/ship document identifier. *34
                @type [1...1] String [1/*] ShipmentIDType M Type of shipment ID.
              cmn:DocumentDate [0...1] Date [0/*] - O Date for the shipment document in XML date format YYYY-MM-DD.
            cmn:LineItemNumber [0...1] String [0/*] - O Line item number for the order item.
            cmn:ShipTHAction [0...1] String [1/*] ShipTHAction O Instructs the system whether to create a TH or to pick the TH from the TH repository. Picking is used only when a manufacturer is a reseller of the product.
            cmn:InternalMaterialNumber [0...1] String [0/*] - O Material number in sender's internal system for sellable shipped item or packing item recorded in detail record.
            cmn:NDC [0...1] String [1/*] - O National drug code number of the product.
              @type [1...1] String [0/*] NDCType M NDC code type.
            cmn:LotNumber [0...1] String [0/*] - O Batch or lot number for sellable shipped product.
Lot number is optional, but must be included if the product was acquired as an indirect purchase.
            cmn:ReferenceIdentifier [0...1] String [0/*] - O Identification number assigned to the TH during receiving (e.g. a location identifier).
            cmn:ItemQuantity [1...1] String [1/*] - M Number of sellable units in the lot to represent the Transaction Information "number of containers" that were part of the THs.
            cmn:SalesQuantity [0...1] Decimal [1/*] - O Quantity recorded for sales transaction for use in ASN.
              @quantityUnitOfMeasure [1...1] String [0/*] QuantityUOM C Quantity unit of measure.
Mandatory if cmn:SalesQuantity is populated.
            cmn:ItemReferenceDocuments [0...*] - - - O Business documents relevant to shipment of sellable items.
              cmn:BusinessDocument [1...1] String [1/*] - M Shipment document identification number.
                @type [1...1] String [1/*] BusinessDocumentType M Type of document identifier.
              cmn:LineItemNumber [0...1] String [0/6] - O Document line item number for the reference document.
              cmn:DocumentDate [0...1] String [10/10] - O Date of the reference document.
          ie:LSPShipmentTHSpec [0...1] - - - O Option 9 for choice%1 group. Used for 3PL provider shipment transaction type for picking and shipping of goods (for sale of goods), submitted to manufacturer, resulting in TH creation by manufacturer Product Track.
            cmn:Location [0...1] String [0/*] - O Warehouse location where product was picked. 
              @type [1...1] String [1/*] Location M Type of pick location entered.

Valid values:

  • COMPANYSITEID
  • DEA
  • DUNS4
  • GLN
  • HIN
Mandatory if cmn:Location is populated.
            cmn:ShipmentIdentifiers [1...1] - - - M Ship document identification numbers group.
              cmn:ShipmentId [1...*] String [1/*] - M Delivery document/ship document identifier.
                @type [1...1] String [1/*] ShipmentIDType M Type of shipment ID.
              cmn:DocumentDate [0...1] Date [0/*] - O Date for the shipment document in XML date format YYYY-MM-DD.
            cmn:LineItemNumber [0...1] String [0/*] - O Line item number for the order item.
            cmn:ShipTHAction [0...1] String [1/*] ShipTHAction O Instructs system whether to create a TH or pick the TH from the TH repository. Picking is used only when a manufacturer is a reseller of product.
            cmn:InternalMaterialNumber [0...1] String [0/*] - O Material number in sender's internal system for sellable shipped item or packing item recorded in detail record.
            cmn:NDC [0...1] String [1/*] - O National drug code number of the product.
              @type [1...1] String [0/*] NDCType C NDC code type.
Mandatory if cmn:NDC is populated.
            cmn:LotNumber [0...1] String [0/*] - O Batch or lot number for sellable shipped product.
Lot number is optional, but must be included if the product was acquired as an indirect purchase.
            cmn:ReferenceIdentifier [0...1] String [0/*] - O Identification number assigned to the TH during receiving, such as a location identifier. 
            cmn:ItemQuantity [1...1] String [1/*] - M Number of sellable units in the lot to represent the Transaction Information "number of containers" that were part of the THs.
            cmn:SalesQuantity [0...1] Decimal [1/*] - O Quantity recorded for sales transaction for use in ASN.
              @quantityUnitOfMeasure [1...1] String [0/*] QuantityUOM C Quantity unit of measure.
Mandatory if cmn:SalesQuantity is populated.
            cmn:ShippingReferenceDocuments [0...*] - - - O Business documents relevant to shipment of sellable items.
              cmn:BusinessDocument [1...1] String [1/*] - M Shipment document identification number.
                @type [1...1] String [1/*] BusinessDocumentType M Type of document identifier.
              cmn:LineItemNumber [0...1] String [0/6] - O Document line item number for the reference document.
              cmn:DocumentDate [0...1] String [10/10] - O Date of the reference document.
          ie:ProcessingCode [1...1] String [1/*] - M The processing code assigned by the system to indicate the success, failure, or warning.
          ie:ProcessingMessage [0...*] String [1/*] - O The processing message with detail on why the item in the item spec incurred a warning or failure.
      ie:ProcessedWithWarning [0...1] - - - O This element contains one item spec with processing code and processing message for each item updated without warning. The item spec contains identifying information about each item processed. The number of item specs will be equal to the value of TotalProcessedWithWarning.  If TotalProcessedWithWarning = 0, ProcessedWithWarning will not be populated. The items specs that follow use the exact same item specs as described in rows 24-128.
        ie:ProcessedItem [1...*] - - - M List of one or more item specs with processing code for each item updated with warning.
          choice%2 [0...1] Choice - - O The choice%2 element is optional, but one of the following choices can be optionally provided:
  • Option 1 within choice%2 is the ShipmentReceiptSpec used for shipment receipt messages that are submitted to the system for purchase or transfer receipts.
  • Option 2 within choice%2 indicates the ReturnReceiptSpec.
  • Option 3 within choice%2 is the CreateIntitialTransactionSpec, used to create the initial transaction messages submitted to the system to create pre-2015 baseline transactions or initial transactions for repackaged goods.
  • Option 4 within choice%2 is the UpdateTransactionSpec, used to update transaction messages that are submitted to the system to update TH / quantities, which also updates the state of THs associated with an NDC and Lot, or to void the THs associated with a delivery.
  • Option 5 for choice%2 group is the Product Track IncrementTHQuantitySpec, used to update transaction messages submitted to the system to increment TH quantities associated with an NDC and Lot.
  • Option 6 for choice%2 group is the Product Track DecrementTHQuantitySpec, used to update transaction messages submitted to the system to decrement TH quantities associated with an NDC and Lot.
  • Option 7 within choice%2 is the PickShipTHSpec, used for pick/ship messages submitted to the system for pick-matching THs for customer sales or warehouse transfer shipments.
  • Option 8 within choice%2 is the Product Track MfrSalesShipmentTHSpec, used for the Manufacturer sales shipment transaction for the picking and shipping of goods (for the sale of goods), resulting in the TH creation.
  • Option 9 within choice%2 is the Product Track LSPShipmentTHSpec, used for a 3PL shipment transaction for the picking and shipping of goods (for sale of goods), submitted to the manufacturer, resulting in the TH creation by the manufacturer via Product Track.
          ie:ShipmentReceiptSpec [0...1] - - - O Option 1 for choice%2 group. Used for shipment receipt messages submitted to the system for purchase or transfer receipts.
            cmn:Location [0...1] String [1/*] - O Location where receiving of shipment is occurring. 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.
              @type [1...1] String [1/*] Location M Type of pick location entered.

Valid values:

  • COMPANYSITEID
  • DEA
  • DUNS4
  • GLN
  • HIN
Mandatory if cmn:Location is populated.
            cmn:ReceiptType [1...1] String [1/*] ReceiptType M Indicates if the receipt reflects a purchase or a transfer of goods from one facility to another (e.g. from warehouse to warehouse, a 3PL transfer, or from pharmacy to pharmacy). For intra-company transfer receipts, a transfer shipment must have been initiated and TH quantities transferred made accessible to new location.
            cmn:DeliveryNumber [1...1] String [1/*] - M The delivery number for the shipment. The system will use the Delivery Number to match against THs received from a supplier (against the Delivery Number in the ASN), or to match against the transfer Delivery Number associated with transferred THs for an intra-company transfer.
            cmn:NDC [1...1] String [1/*] - M The NDC of the product being received without hyphen separators.
              @type [1...1] String [1/*] NDCType M This attribute identifies the NDC type.
            cmn:LotNumber [0...1] String [0/*] - O The lot/batch number of the product being received.
Lot number is optional for pharmacies.
            cmn:Quantity [1...1] Integer - - M The each/unit quantity of the product being received. This value will be used to represent the quantity received against the TH. Subsequent picks against the TH will be against this quantity and the unit of measures (each /unit) must be consistent. Reverse receipts are supported by providing a negative quantity. This quantity will be decremented from the received quantity of the matching TH.
            cmn:TransactionIdentifier [0...*] String [0/*] - O Business transaction identifier for the business transaction that initiated the product receipt (e.g. PO Number or Transfer Number).
              @type [1...1] String [1/*] TransactionIdentifier M This attribute identifies the transaction identifier type.

Valid values:

  • ASN
  • INVOICE
  • PACKSLIP
  • PO
  • RETURN
  • SALESORDER
  • TRANSFER
  • OTHER
Mandatory if cmn:TransactionIdentifier is populated.
          ie:ReturnReceiptSpec [0...1] - - - O Option 2 for choice%2 group. Used for return receipt messages submitted to the system for sellable or non-sellable returns.
            cmn:Location [0...1] String [1/*] - O Location where receiving of return shipment is occurring. 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.
              @type [1...1] String [1/*] Location C The attribute identifies the location types and includes.

Valid values:

  • COMPANYSITEID
  • DEA
  • DUNS4
  • GLN
  • HIN
Mandatory if cmn:Location is populated.
            cmn:ReturnReceiptType [1...1] String [1/*] ReturnReceiptType M Indicates if return receipt is sellable or non-sellable. For sellable returns, there must be a matching TH in the company against the NDC and Lot. The system will first attempt to match at the receiving location, and if none found, match at the company level. The system will increment the quantity against the matching TH and make the quantity available at the receiving location for subsequent pick/ship from this location. If no match is found, the system will generate an error. For Non-sellable returns, the system will create a record of the fact that the non-sellable return was received for audit trail purposes.
            cmn:NDC [0...1] String [1/*] - M The NDC for the sellable or non-sellable return, provided without hyphen separators.
              @type [1...1] String [1/*] NDCType M This attribute identifies the NDC type.
            cmn:NDCLookupId [0...1] String [1/*] - M The NDC of the non-sellable return product without hyphen separators. This value is used for Product Master Data lookup of NDC attributes to create the non-sellable return entry.
              @type [1...1] String [1/*] NDCType M This attribute identifies the NDC type.
            cmn:LotNumber [1...1] String [1/*] - M The lot/batch number of the product.
            cmn:Quantity [1...1] Integer - - M The quantity of product returned.
            cmn:TransactionIdentifier [0...*] String [0/*] - O A list of one or more business documents associated with the return receipt for audit trailing purposes.
              @type [1...1] String [1/*] TransactionIdentifier M The attribute identifies the transaction identifier type and includes.

Valid values:

  • ASN
  • INVOICE
  • PACKSLIP
  • PO
  • RETURN
  • SALESORDER
  • TRANSFER
  • OTHER
Mandatory if cmn:TransactionIdentifier is populated.
          ie:CreateInitialTransactionSpec [0...1] - - - O Option 3 for choice%2 group. Used for create initial transaction messages submitted to the system to create pre-2015 baseline transactions or initial transactions for repackaged goods.
            cmn:Location [0...1] String [1/*] - O Location where the inventory for the new THs will reside. This will associate the THs with that location 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.
              @type [1...1] String [1/*] Location C This attribute identifies the location types and includes.

Valid values:

  • COMPANYSITEID
  • DEA
  • DUNS4
  • GLN
  • HIN
Mandatory if cmn:Location is populated.
            ie:SourceProduct [0...*] - - - O Source product in repackaging operations. This is included only when CreateInitialTransaction is used for creating repack Transactions.
              cmn:NDC [1...1] String [1/*] - M The NDC of the source product without hyphen separators. 
                @type [1...1] String [1/*] NDCType M This attribute identifies the NDC type.
              cmn:LotNumber [1...1] String [1/*] - M The lot/batch number of the source product.
              cmn:ReferenceIdentifier [0...1] String [0/*] - O The Reference Identifier assigned to the TH for the source product NDC and Lot during receiving. 
            cmn:NDC [0...1] String [1/*] - O The NDC of the product without hyphen separators. 
              @type [1...1] String [1/*] NDCType C This attribute identifies the NDC type.
Mandatory if cmn:NDC is populated.
            cmn:NDCLookupId [0...1] String [1/*] - O The NDC of the product without hyphen separators. Used to instruct the system to perform Product Master Data look-up for the NDC attributes required for the TH. 
              @type [1...1] String [1/*] NDCType C This attribute identifies the NDC type.
Mandatory if cmn:NDCLookUpId is populated.
            cmn:LotNumber [0...1] String [0/*] - O The lot/batch number of the product.
            cmn:ExpirationDate [0...1] Date [10/10] - O The expiration date of the product in YYYY-MM-DD format.
            cmn:ReferenceIdentifier [0...1] String [0/*] - O The Reference Identifier assigned to the TH for this NDC and Lot during receiving. The Reference Identifier should only be used for precise matching and when one was assigned at receiving.
            cmn:Quantity [1...1] Integer - - M The quantity of THs to create, corresponding to the quantity of sellable eaches/units that exist in inventory.
          ie:UpdateTransactionSpec [0...1] - - - O Option 4 for choice%2 group. Used to update transaction messages submitted to the system to update TH quantities, update the state of THs associated with an NDC and Lot, or void THs associated with a delivery.
            cmn:Location [0...1] String [1/*] - O Location where inventory exists for which TH metadata update is occurring. 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.
              @type [1...1] String [1/*] Location C Type of pick location entered.

Valid values:

  • COMPANYSITEID
  • DEA
  • DUNS4
  • GLN
  • HIN
Mandatory if cmn:Location is populated.
            cmn:NDC [0...1] String [1/*] - O The NDC associated with a TH without hyphen separators. 
              @type [1...1] String [1/*] NDCType C This attribute identifies the NDC type and includes.
Mandatory if NDC is populated.
            cmn:LotNumber [0...1] String [0/*] - O The lot number associated with a TH.
            cmn:ReferenceIdentifier [0...1] String [0/*] - O The Reference Identifier assigned to a TH for this NDC and Lot during receiving. The Reference Identifier should only be used for precise matching and when one was assigned at receiving.
            cmn:DeliveryNumber [0...1] String [0/*] - O The original receiving Delivery Number associated with a TH for this NDC and Lot. The DeliveryNumber should only be used for precise matching and when the original DeliveryNumber for a TH is known.
            cmn:TransactionIdentifier [0...*] String [0/*] - O A list of one or more business documents associated with the return receipt for audit trailing purposes.
              @type [1...1] String [1/*] TransactionIdentifier C This attribute identifies the transaction identifier type and includes.

Valid values:

  • ASN
  • INVOICE
  • PACKSLIP
  • PO
  • RETURN
  • SALESORDER
  • TRANSFER
  • OTHER
Mandatory if cmn:TransactionIdentifier is populated.
            cmn:UpdateQuantity [0...1] Integer - - O Provides either the adjustment  or replacement TH quantity to be applied to the matching THs. AdjustBy instructs the system to increment or decrement the current available TH quantity. A positive number will increment the current count by that value. A negative number will decrement the current count by that value.
A negative number can result in a negative count. Replace instructs the system to replace the available TH quantity with the new supplied value.
              @type [1...1] String [1/*] UpdateQuantityType C This attribute identifies the quantity type.
Mandatory if cmn:UpdateQuantity is populated.
            cmn:THState [0...1] String [1...1] THState O The new state to apply to the matching available THs. All THs with remaining quantities for the entire NDC and Lot at the specified location will be updated to the new state. Supported state values are: Available, Quarantine. THs with a state of Available will be included in pick operations. THs with a state of Quarantine will be excluded from pick operations.
            cmn:TransactionHistoryType [0...1] String [1/*] THType O Indicates if the TH to be voided was one sent or received from a trade partner. This is required to disambiguate THs that may have the same Delivery Number (across THs sent and received).
            cmn:PartnerId [0...1] String [1/*] - O Identifies the trade partner that TH was sent to or received from. This is required to disambiguate THs that may have the same Delivery Number (across THs sent and received).
              @type [1...1] String [1/*] PartnerId C This attribute identifies the location types and includes.
Mandatory if cmn:PartnerId is populated.
          ie:PTIncrementTHQuantitySpec [0...1] - - - O Option 5 for choice%2 group. Used to update transaction messages submitted to the system to increment TH quantities associated with an NDC and Lot.
            cmn:Location [0...1] String [1/*] - O Location where inventory exists for which TH meta data update is occurring. 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.
              @type [1...1] String [1/*] SubscriberLocation C Attribute identifies the location types.
            ie:THMatchingCriteria [1...1] - - - M Identifies the items for which quantities associated with one or more THs will be incremented.
              cmn:NDC [1...1] String [1/*] - M The NDC associated with a TH without hyphen separators.
                @type [1...1] String [1/*] NDCType M Attribute identifies the NDC type.
              cmn:LotNumber [1...1] String [1/*] - M The lot number associated with a TH.
              cmn:ReferenceIdentifier [0...1] String [0/*] - O The Reference Identifier assigned to a TH for this NDC and Lot during receiving. The Reference Identifier should only be used for precise matching and when one was assigned at receiving.
              cmn:DeliveryNumber [0...1] String [0/*] - O The original receiving Delivery Number associated with a TH for this NDC and Lot. The DeliveryNumber should only be used for precise matching and when the original DeliveryNumber for a TH is known.
            cmn:Quantity [1...1] Integer - - M Provides the increment quantity to be applied to the matching THs.
            cmn:ReferenceIdentifier [0...1] String [0/*] - O Reference identifier assigned to identify this Increment transaction.
            cmn:TransactionIdentifier [0...*] String [0/*] - O A list of one or more business documents associated with the return receipt for audit trailing purposes.
              @type [1...1] String [1/*] TransactionIdentifier C Attribute identifies the transaction identifier type.

Valid values:

  • ASN
  • INVOICE
  • PACKSLIP
  • PO
  • RETURN
  • SALESORDER
  • TRANSFER
  • OTHER
Mandatory if cmn:TransactionIdentifier is populated.
          ie:PTDecrementTHQuantitySpec [0...1] - - - O Option 6 for choice%2 group. Used to update transaction messages submitted to the system to decrement TH quantities associated with an NDC and Lot.
            cmn:Location [0...1] String [1/*] - O Location where inventory exists for which TH meta data update is occurring. 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.
              @type [1...1] String [1/*] SubscriberLocation C Attribute identifies the location types.
Mandatory if cmn:Location is populated.
            ie:THMatchingCriteria [1...1] - - - M Identifies the items for which quantities associated with one or more THs will be decremented.
              cmn:NDC [1...1] String [1/*] - M The NDC associated with a TH without hyphen separators.
                @type [1...1] String [1/*] NDCType M Attribute identifies the NDC type.
              cmn:LotNumber [1...1] String [1/*] - M The lot number associated with a TH.
              cmn:ReferenceIdentifier [0...1] String [0/*] - O The Reference Identifier assigned to a TH for this NDC and Lot during receiving. The Reference Identifier should only be used for precise matching and when one was assigned at receiving.
              cmn:DeliveryNumber [0...1] String [0/*] - O The original receiving Delivery Number associated with a TH for this NDC and Lot. The DeliveryNumber should only be used for precise matching and when the original DeliveryNumber for a TH is known.
            cmn:Quantity [1...1] Integer - - M Provides the decrement quantity to be applied to the matching THs.
            cmn:TransactionIdentifier [0...*] String [0/*] - O A list of one or more business documents associated with the return receipt for audit trailing purposes.
              @type [1...1] String [1/*] TransactionIdentifier C Attribute identifies the transaction identifier type.

Valid values:

  • ASN
  • INVOICE
  • PACKSLIP
  • PO
  • RETURN
  • SALESORDER
  • TRANSFER
  • OTHER
Mandatory if cmn:TransactionIdentifier is populated.
          ie:PickShipTHSpec  [0...1] - - - O Option 7 for choice%2 group. Used for pick/ship messages submitted to the system for to pick matching THs for customer sale or warehouse transfer shipments.
            cmn:PickLocation [0...1] String [0/*] - O Warehouse location where product was picked. 
              @type [1...1] String [1/*] Location M The attribute identifies the location types. Valid values:
  • COMPANYSITEID
  • DEA
  • DUNS4
  • GLN
  • HIN
Mandatory if cmn:PickLocation is populated.
            cmn:TransferToLocation [0...1] String [0/*] - O Warehouse location to which the product is being transferred. 
              @type [1...1] String [1/*] Location C The attribute identifies the location types.

Valid values:

  • COMPANYSITEID
  • DEA
  • DUNS4
  • GLN
  • HIN
Mandatory if cmn:TransferToLocation is populated.
            cmn: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.
            cmn:DeliveryIdentifiers [1...1] - - - M Ship document identification numbers group.
              cmn:DeliveryDocument [1...*] - - - M List of one or more delivery document identification numbers, minimally including a Delivery document.
                cmn:DeliveryDocumentId [1...1] String [1/*] - M Delivery document/ship document identifier
                  @type [1...1] String [1/*] ShipmentIDType M Type of shipment ID.

Valid values:

  • BillOfLading
  • DeliveryDocument
  • ExternalDelivery
  • GoodsReceiptIssue
  • ShipmentNumber
  • TrackingNumber
                cmn:DocumentDate [0...1] Date [0/*] - M Date for the shipment document in XML date format YYYY-MM-DD.
                cmn:DocumentTime [0...1] Date [0/*] - M Time for the shipment document in XML Time format HH:MM:SS.
            cmn:PickShipAction [1...1] String [1/*] PickActionCode 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 THs.
            cmn:InternalMaterialNumber [0...1] String [0/*] - O Material number in sender's internal system for sellable shipped item or packing item recorded in detail record.
            cmn:NDC [0...1] String [1/*] - O National drug code number of the product.
              @type [1...1] String [0/*] NDCType C NDC code type.
Mandatory if cmn:NDC is populated.
            cmn:LotNumber [0...1] String [0/*] - O Batch or lot number for sellable shipped product.
Lot number is optional, but must be included if the product was acquired as an indirect purchase.
            cmn:ReferenceIdentifier [0...1] String [0/*] - O Identification number assigned to the TH during receiving (e.g. a location identifier).
            cmn:PickQuantity [1...1] Decimal [1/*] - M Quantity recorded for pick/unpick transaction.
              @quantityUnitOfMeasure [1...1] String [0/*] QuantityUOM M Quantity unit of measure.
            cmn:THItemQuantity [1...1] String [1/*] - M Number of sellable units in the lot to represent the Transaction Information "number of containers" that were part of the THs.
            cmn:ItemReferenceDocuments [0...*] - - - O Business documents relevant to shipment of sellable items.
              cmn:BusinessDocument [1...1] String [1/*] - M Shipment document identification number.
                @type [1...1] String [1/*] BusinessDocumentType M Type of document identifier.
              cmn:LineItemNumber [0...1] String [0/6] - O Document line item number for the reference document.
              cmn:DocumentDate [0...1] String [10/10] - O Date of the reference document.
            cmn:AvailableQuantity  [0...1] Integer - - O Returns available TH quantity when an overpick has occurred.
          ie:MfrSalesShipmentTHSpec [0...1] - - - O Option 8 for choice%2 group. Used for Manufacturer sales shipment transaction type for picking and shipping of goods (for sale of goods), resulting in TH creation.
            cmn:Location [0...1] String [0/*] - O Warehouse location where product was picked. 
              @type [1...1] String [1/*] Location C The attribute identifies the location types.

Valid values:

  • COMPANYSITEID
  • DEA
  • DUNS4
  • GLN
  • HIN
Mandatory if cmn:Location is populated.
            cmn:cmn:ShipmentIdentifiers [1...1] - - - M Ship document identification numbers group.
              cmn:ShipmentId [1...*] String [1/*] - M Delivery document/ship document identifier.
                @type [1...1] String [1/*] ShipmentIDType M Type of shipment ID.

Valid values:

  • BillOfLading
  • DeliveryDocument
  • ExternalDelivery
  • GoodsReceiptIssue
  • ShipmentNumber
  • TrackingNumber
              cmn:DocumentDate [0...1] Date [0/*] - O Date for the shipment document in XML date format YYYY-MM-DD.
            cmn:LineItemNumber [0...1] String [0/*] - O Line item number for the order item.
            cmn:ShipTHAction [0...1] String [1/*] ShipTHAction O Instructs system whether to create a TH or pick the TH from the TH repository. Picking is used only when a manufacturer is a reseller of product.
            cmn:InternalMaterialNumber [0...1] String [0/*] - O Material number in sender's internal system for sellable shipped item or packing item recorded in detail record.
            cmn:NDC [0...1] String [1/*] - O National drug code number of the product.
              @type [1...1] String [0/*] NDCType C NDC code type.
Mandatory if cmn:NDC is populated.
            cmn:LotNumber [0...1] String [0/*] - O Batch or lot number for sellable shipped product.
Lot number is optional, but must be included if the product was acquired as an indirect purchase.
            cmn:ReferenceIdentifier [0...1] String [0/*] - O Identification number assigned to the TH during receiving, such as a location identifier. 
            cmn:ItemQuantity [1...1] String [1/*] - M Number of sellable units in the lot to represent the Transaction Information "number of containers" that were part of the THs.
            cmn:SalesQuantity [0...1] Decimal [1/*] - O Quantity recorded for sales transaction for use in ASN.
              @quantityUnitOfMeasure [1...1] String [0/*] QuantityUOM C Quantity unit of measure.
Mandatory if cmn:SalesQuantity is populated.
            cmn:ItemReferenceDocuments [0...*] - - - O Business documents relevant to shipment of sellable items.
              cmn:BusinessDocument [1...1] String [1/*] - M Shipment document identification number.
                @type [1...1] String [1/*] BusinessDocumentType M Type of document identifier.
              cmn:LineItemNumber [0...1] String [0/6] - O Document line item number for the reference document.
              cmn:DocumentDate [0...1] String [10/10] - O Date of the reference document.
          ie:LSPShipmentTHSpec [0...1] - - - O Option 9 for choice%2 group. Used for third-party logistics provider shipment transaction type for picking and shipping of goods (for sale of goods), submitted to manufacturer, resulting in TH creation by manufacturer Product Track.
            cmn:Location [0...1] String [0/*] - O Warehouse location where product was picked. 
              @type [1...1] String [1/*] Location C The attribute identifies the location types.

Valid values:

  • COMPANYSITEID
  • DEA
  • DUNS4
  • GLN
  • HIN
Mandatory if cmn:Location is populated.
            cmn:ShipmentIdentifiers [1...1] - - - M Ship document identification numbers group.
              cmn:ShipmentId [1...*] String [1/*] - M Delivery document/ship document identifier.
                @type [1...1] String [1/*] ShipmentIDType M Type of shipment ID.
              cmn:DocumentDate [0...1] Date [0/*] - O Date for the shipment document in XML date format YYYY-MM-DD.
            cmn:LineItemNumber [0...1] String [0/*] - O Line item number for the order item.
            cmn:ShipTHAction [0...1] String [1/*] ShipTHAction O Instructs system whether to create a TH or pick the TH from the TH repository. Picking is used only when a manufacturer is a reseller of product.
            cmn:InternalMaterialNumber [0...1] String [0/*] - O Material number in sender's internal system for sellable shipped item or packing item recorded in detail record.
            cmn:NDC [0...1] String [1/*] - O National drug code number of the product.
              @type [1...1] String [0/*] NDCType C NDC code type.
Mandatory if cmn:NDC is populated.
            cmn:LotNumber [0...1] String [0/*] - O Batch or lot number for sellable shipped product.
Lot number is optional, but must be included if the product was acquired as an indirect purchase.
            cmn:ReferenceIdentifier [0...1] String [0/*] - O Identification number assigned to the TH during receiving, such as a location identifier. 
            cmn:ItemQuantity [1...1] String [1/*] - M Number of sellable units in the lot to represent the Transaction Information "number of containers" that were part of the THs.
            cmn:SalesQuantity [0...1] Decimal [1/*] - O Quantity recorded for sales transaction for use in ASN.
              @quantityUnitOfMeasure [1...1] String [0/*] QuantityUOM M Quantity unit of measure.
            cmn:ShippingReferenceDocuments [0...*] - - - O Business documents relevant to shipment of sellable items.
              cmn:BusinessDocument [1...1] String [1/*] - M Shipment document identification number.
                @type [1...1] String [1/*] BusinessDocumentType M Type of document identifier.
              cmn:LineItemNumber [0...1] String [0/6] - O Document line item number for the reference document.
              cmn:DocumentDate [0...1] String [10/10] - O Date of the reference document.
          ie:ProcessingCode [1...1] String [1/*] - M The processing code assigned by the system to indicate the success, failure, or warning.
          ie:ProcessingMessage [0...*] String [1/*] - O The processing message with detail on why the item in the item spec incurred a warning or failure.
      ie:FailedItem [0...1] - - - O This element contains one item spec with processing code and processing message for each item that failed to be updated. The item spec contains identifying information about each item that failed. The number of item specs will be equal to the value of TotalFailed. If TotalFailed = 0,  FailedItem will not be populated.
        ie:ProcessedItem [1...*] - - - M List of one or more item specs with processing code for each item updated with warning.
          choice%3 [0...1] Choice - - O The choice%3 group is optional. ie:FailedItem may include only an error code and message if the inbound failure occurs before the incoming message is translated. One of the following choice options can be provided:
  • Option 1 within choice%3 is the Product Track ShipmentReceiptSpec, used for shipment receipt messages submitted to the system for purchase or transfer receipts.
  • Option 2 within choice%3 is the Product Track ReturnReceiptSpec, which indicates the receipt of sellable and non-sellable returns.
  • Option 3 within choice%3 is the Product Track CreateIntitialTransactionSpec, used to create the initial transaction messages submitted to the system to create pre-2015 baseline transactions or initial transactions for repackaged goods.
  • Option 4 within choice%3 is the Product Track UpdateTransactionSpec, used for update transaction messages submitted to the system to update TH quantities, update the state of THs associated with an NDC and Lot, or to void THs associated with a delivery.
  • Option 5 for choice%3 group is the Product Track IncrementTHQuantitySpec, used to update transaction messages submitted to the system to increment TH quantities associated with an NDC and Lot.
  • Option 6 for choice%3 group is the Product Track DecrementTHQuantitySpec, used to update transaction messages submitted to the system to decrement TH quantities associated with an NDC and Lot.
  • Option 7 within choice%3 is the Product Track PickShipTHSpec, used for pick/ship messages submitted to the system for pick-matching THs for a customer sale or warehouse transfer shipment.
  • Option 8 within choice%3 is the Product Track  MfrSalesShipmentTHSpec, used for the Manufacturer sales shipment transaction type for the picking and shipping of goods (for the purpose of the sale of goods), resulting in the TH creation.
  • Option 9 within choice%3 is the Product Track LSPShipmentTHSpec, used for third-party logistics provider shipment transaction type for picking and shipping of goods for sale of goods, submitted to manufacturer, resulting in TH creation by manufacturer Product Track.
          ie:ShipmentReceiptSpec [0...1] - - - O Option 1 for choice%3 group. Used for shipment receipt messages submitted to the system for purchase or transfer receipts.
            cmn:Location [0...1] String [1/*] - O Location where receiving of shipment is occurring. 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.
              @type [1...1] String [1/*] Location C The attribute identifies the location types.

Valid values:

  • COMPANYSITEID
  • DEA
  • DUNS4
  • GLN
  • HIN
Mandatory if cmn:Location is populated.
            cmn:ReceiptType [1...1] String [1/*] ReceiptType M Indicates if the receipt reflects a purchase or a transfer of goods from one facility to another (e.g. from warehouse to warehouse, a 3PL transfer, or from pharmacy to pharmacy). For intra-company transfer receipts, a transfer shipment must have been initiated and TH/quantities transferred made accessible to new location.
            cmn:DeliveryNumber [1...1] String [1/*] - M The delivery number for the shipment. The system will use the Delivery Number to match against  THs received from a supplier (against the Delivery Number in the ASN), or to match against the transfer Delivery Number associated with transferred THs for an intra-company transfer.
            cmn:NDC [1...1] String [1/*] - M The NDC of the product being received without hyphen separators.
              @type [1...1] String [1/*] NDCType M This attribute identifies the NDC type.
            cmn:LotNumber [0...1] String [0/*] - O The lot/batch number of the product being received.
Lot number is optional for pharmacies.
            cmn:Quantity [1...1] Integer - - M The each/unit quantity of the product being received. This value will be used to represent the quantity received against the TH. Subsequent picks against the TH will be against this quantity and the unit of measures (each /unit) must be consistent. Reverse receipts are supported by providing a negative quantity. This quantity will be decremented from the received quantity of the matching TH.
            cmn:TransactionIdentifier [0...*] String [0/*] - O Business transaction identifier for the business transaction that initiated the product receipt (e.g. PO Number, Transfer Number).
              @type [1...1] String [1/*] TransactionIdentifier M The attribute identifies the transaction identifier type.

Valid values:

  • ASN
  • INVOICE
  • PACKSLIP
  • PO
  • RETURN
  • SALESORDER
  • TRANSFER
  • OTHER
Mandatory if cmn:TransactionIdentifier is populated.
          ie:ReturnReceiptSpec [0...1] - - - O Option 2 for choice%3 group. Used for return receipt messages submitted to the system for sellable or non-sellable returns.
            cmn:Location [0...1] String [1/*] - O Location where receiving of return shipment is occurring. 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.
              @type [1...1] String [1/*] Location M The attribute identifies the location types.
Mandatory if cmn:Location is populated.
            cmn:ReturnReceiptType [1...1] String [1/*] ReturnReceiptType M Indicates if return receipt is sellable or non-sellable. For sellable returns, there must be a matching TH in the company against the NDC and Lot. The system will first attempt to match at the receiving location, and if none found, match at the company level. The system will increment the quantity against matching TH and make the quantity available at the receiving location for subsequent pick/ship from this location. If no match is found, the system will generate an error. For NonSellable returns,the system will create a record of the fact that the non-sellable return was received for audit trail purposes.
            cmn:NDC [0...1] String [1/*] - M The NDC for the sellable or non-sellable return without hyphen separators.
              @type [1...1] String [1/*] NDCType M This attribute identifies the NDC type.
            cmn:NDCLookupId [0...1] String [1/*] - M The NDC of the non-sellable return product without hyphen separators. This value is used for Product Master Data lookup of NDC attributes to create the non-sellable return entry.
              @type [1...1] String [1/*] NDCType M This attribute identifies the NDC type.
            cmn:LotNumber [1...1] String [1/*] - M The lot/batch number of the product.
            cmn:Quantity [1...1] Integer - - M The quantity of product returned.
            cmn:TransactionIdentifier [0...*] String [0/*] - O A list of one or more business documents associated with the return receipt for audit trail purposes.
              @type [1...1] String [1/*] TransactionIdentifier M The attribute identifies the transaction identifier type and includes.
Mandatory if cmn:TransactionIdentifier is populated.
          ie:CreateInitialTransactionSpec [0...1] - - - O Option 3 for choice%3 group. Used for create initial transaction messages submitted to the system to create pre-2015 baseline transactions or initial transactions for repackaged goods.
            cmn:Location [0...1] String [1/*] - O Location where the inventory for the new THs will reside. This will associate the THs with that location 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.
              @type [1...1] String [1/*] Location M The attribute identifies the location types.
Mandatory if cmn:Location is populated.
            ie:SourceProduct [0...*] - - - O Source product in repackaging operations. This is included only when CreateInitialTransaction is used for creating repack Transactions.
              cmn:NDC [1...1] String [1/*] - M The NDC of the source product without hyphen separators. 
                @type [1...1] String [1/*] NDCType M This attribute identifies the NDC type.
              cmn:LotNumber [1...1] String [1/*] - M The lot / batch number of the source product.
              cmn:ReferenceIdentifier [0...1] String [0/*] - O The Reference Identifier assigned to the TH for the source product NDC and Lot during receiving. 
            cmn:NDC [0...1] String [1/*] - O The NDC of the product without hyphen separators. 
              @type [1...1] String [1/*] NDCType C This attribute identifies the NDC type.
Mandatory if cmn:NDC is populated.
            cmn:NDCLookupId [0...1] String [1/*] - O The NDC of the product without hyphen separators. Used to instruct the system to perform Product Master Data look-up for the NDC attributes required for the TH. 
              @type [1...1] String [1/*] NDCType M This attribute identifies the NDC type.
            cmn:LotNumber [0...1] String [0/*] - O The lot/batch number of the product.
            cmn:ExpirationDate [0...1] Date [10/10] - O The expiration date of the product in YYYY-MM-DD format.
            cmn:ReferenceIdentifier [0...1] String [0/*] - O The Reference Identifier assigned to the TH for this NDC and Lot during receiving. The Reference Identifier should only be used for precise matching and when one was assigned at receiving.
            cmn:Quantity [1...1] Integer - - M The quantity of THs to create, corresponding to the quantity of sellable eaches/units that exist in inventory.
          ie:UpdateTransactionSpec [0...1] - - - O Option 4 for choice%3 group. Used to update transaction messages submitted to the system to update TH quantities, update the state of THs associated with an NDC and Lot, or void THs associated with a delivery.
            cmn:Location [0...1] String [1/*] - O Location where inventory exists for which TH metadata update is occurring. 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.
              @type [1...1] String [1/*] Location M The attribute identifies the location types.
Mandatory if cmn:Location is populated.
            cmn:NDC [0...1] String [1/*] - O The NDC associated with a TH without hyphen separators. 
              @type [1...1] String [1/*] NDCType C This attribute identifies the NDC type.
Mandatory if cmn:NDC is populated.
            cmn:LotNumber [0...1] String [0/*] - O The lot number associated with a TH.
            cmn:ReferenceIdentifier [0...1] String [0/*] - O The Reference Identifier assigned to a TH for this NDC and Lot during receiving. The Reference Identifier should only be used for precise matching and when one was assigned at receiving.
            cmn:DeliveryNumber [0...1] String [0/*] - O The original receiving Delivery Number associated with a TH for this NDC and Lot. The DeliveryNumber should only be used for precise matching and when the original DeliveryNumber for a TH is known.
            cmn:TransactionIdentifier [0...*] String [0/*] - O A list of one or more business documents associated with the return receipt for audit trail purposes.
              @type [1...1] String [1/*] TransactionIdentifier M The attribute identifies the transaction identifier type.
Mandatory if cmn:TransactionIdentifier is populated.
            cmn:UpdateQuantity [0...1] Integer - - O Provides either the adjustment  or replacement TH quantity to be applied to the matching THs. AdjustBy instructs the system to increment or decrement the current available TH quantity. A positive number will increment the current count by that value. A negative number will decrement the current count by that value. A negative number can result in a negative count. Replace instructs the system to replace the available TH quantity with the new supplied value.
              @type [1...1] String [1/*] UpdateQuantityType C The attribute identifies the quantity type.
Mandatory if cmn:UpdateQuantity is populated.
            cmn:THState [0...1] String [1...1] THState O The new state to apply to the matching available THs.  All THs with remaining quantities for the entire NDC and Lot at the specified location will be updated to the new state. THs with a state of Available will be included in pick operations. THs with a state of Quarantine will be excluded from pick operations.
            cmn:TransactionHistoryType [0...1] String [1/*] THType O Indicates if the TH to be voided was one sent or received from a trade partner. This is required to disambiguate THs that may have the same Delivery Number (across THs sent and received).
            cmn:PartnerId [0...1] String [1/*] - O Identifies the trade partner that TH was sent to or received from. This is required to disambiguate THs that may have the same Delivery Number (across THs sent and received).
              @type [1...1] String [1/*] PartnerId C The attribute identifies the location types.
Mandatory if cmn:PartnerId is populated.
          ie:PTIncrementTHQuantitySpec [0...1] - - - O Option 5 for choice%3 group. Used to update transaction messages submitted to the system to increment TH quantities associated with an NDC and Lot.
            cmn:Location [0...1] String [1/*] - O Location where inventory exists for which TH meta data update is occurring. 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.
              @type [1...1] String [1/*] SubscriberLocation C Attribute identifies the location types.
Mandatory if cmn:Location is populated.
            ie:THMatchingCriteria [1...1] - - - M Identifies the items for which quantities associated with one or more THs will be incremented.
              cmn:NDC [1...1] String [1/*] - M The NDC associated with a TH WITHOUT hyphen separators.
                @type [1...1] String [1/*] NDCType M Attribute identifies the NDC type.
              cmn:LotNumber [1...1] String [1/*] - M The lot number associated with a TH.
              cmn:ReferenceIdentifier [0...1] String [0/*] - O The Reference Identifier assigned to a TH for this NDC and Lot during receiving. The Reference Identifier should only be used for precise matching and when one was assigned at receiving.
              cmn:DeliveryNumber [0...1] String [0/*] - O The original receiving Delivery Number associated with a TH for this NDC and Lot. The DeliveryNumber should only be used for precise matching and when the original DeliveryNumber for a TH is known.
            cmn:Quantity [1...1] Integer - - M Provides the increment quantity to be applied to the matching THs.
            cmn:ReferenceIdentifier [0...1] String [0/*] - O Reference identifier assigned to identify this Increment transaction.
            cmn:TransactionIdentifier [0...*] String [0/*] - O A list of one or more business documents associated with the return receipt for audit trailing purposes.
              @type [1...1] String [1/*] TransactionIdentifier C This attribute identifies the transaction identifier type.

Valid values:

  • ASN
  • INVOICE
  • PACKSLIP
  • PO
  • RETURN
  • SALESORDER
  • TRANSFER
  • OTHER
Mandatory if cmn:TransactionIdentifier is populated.
          ie:PTDecrementTHQuantitySpec [0...1] - - - O Option 6 for choice%3 group. Used to update transaction messages submitted to the system to decrement TH quantities associated with an NDC and Lot.
            cmn:Location [0...1] String [1/*] - O Location where inventory exists for which TH meta data update is occurring. 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.
              @type [1...1] String [1/*] SubscriberLocation C Attribute identifies the location types.
Mandatory if cmn:Location is populated.
            ie:THMatchingCriteria [1...1] - - - M Identifies the items for which quantities associated with one or more THs will be decremented.
              cmn:NDC [1...1] String [1/*] - M The NDC associated with a TH WITHOUT hyphen separators.
                @type [1...1] String [1/*] NDCType M Attribute identifies the NDC type.
              cmn:LotNumber [1...1] String [1/*] - M The lot number associated with a TH.
              cmn:ReferenceIdentifier [0...1] String [0/*] - O The Reference Identifier assigned to a TH for this NDC and Lot during receiving. The Reference Identifier should only be used for precise matching and when one was assigned at receiving.
              cmn:DeliveryNumber [0...1] String [0/*] - O The original receiving Delivery Number associated with a TH for this NDC and Lot. The DeliveryNumber should only be used for precise matching and when the original DeliveryNumber for a TH is known.
            cmn:Quantity [1...1] Integer - - M Provides the decrement quantity to be applied to the matching Transaction Histories.
            cmn:TransactionIdentifier [0...*] String [0/*] - O A list of one or more business documents associated with the return receipt for audit trailing purposes.
              @type [1...1] String [1/*] TransactionIdentifier C This attribute identifies the transaction identifier type.

Valid values:

  • ASN
  • INVOICE
  • PACKSLIP
  • PO
  • RETURN
  • SALESORDER
  • TRANSFER
  • OTHER
Mandatory if cmn:TransactionIdentifier is populated.
          ie:PickShipTHSpec  [0...1] - - - O Option 7 for choice%3 group. Used for pick/ship messages submitted to the system for pick matching THs for customer sale or warehouse transfer shipments.
            cmn:PickLocation [0...1] String [0/*] - O Warehouse location where product was picked. 
              @type [1...1] String [1/*] Location C Type of pick location entered.
Mandatory if cmn:PickLocation is populated.
            cmn:TransferToLocation [0...1] String [0/*] - O Warehouse location to which the product is being transferred. 
              @type [1...1] String [1/*] Location C Type of pick location entered.
Mandatory if cmn:TransferToLocation is populated.
            cmn: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. TH quantities are available to different locations but no outbound TH message is created.
            cmn:DeliveryIdentifiers [1...1] - - - M Ship document identification numbers group.
              cmn:DeliveryDocument [1...*] - - - M List of one or more delivery document identification numbers, minimally including Delivery document.
                cmn:DeliveryDocumentId [1...1] String [1/*] - M Delivery document/ship document identifier.
                  @type [1...1] String [1/*] ShipmentIDType M Type of shipment ID.
                cmn:DocumentDate [0...1] Date [0/*] - O Date for the shipment document in XML date format YYYY-MM-DD.
                cmn:DocumentTime [0...1] Date [0/*] - O Time for the shipment document in XML Time format HH:MM:SS.
            cmn:PickShipAction [1...1] String [1/*] PickActionCode M Tells the system whether to add a new line item to a delivery or to remove it from the delivery, and to reserve or unreserve the corresponding THs.
            cmn:InternalMaterialNumber [0...1] String [0/*] - O Material number in sender's internal system for sellable shipped item or packing item recorded in detail record.
            cmn:NDC [0...1] String [1/*] - O National drug code number of the product.
              @type [1...1] String [0/*] NDCType C NDC code type.
Mandatory if cmn:NDC is populated.
            cmn:LotNumber [0...1] String [0/*] - O Batch or lot number for sellable shipped product.
Lot number is optional, but must be included if the product was acquired as an indirect purchase.
            cmn:ReferenceIdentifier [0...1] String [0/*] - O Identification number assigned to the TH during receiving, such as a location identifier. 
            cmn:PickQuantity [1...1] Decimal [1/*] - M Quantity recorded for pick/ unpick transaction.
              @quantityUnitOfMeasure [1...1] String [0/*] QuantityUOM M Quantity unit of measure.
            cmn:THItemQuantity [1...1] String [1/*] - M Number of sellable units in the lot to represent the Transaction Information "number of containers" that were part of the THs.
            cmn:ItemReferenceDocuments [0...*] - - - O Business documents relevant to shipment of sellable items.
              cmn:BusinessDocument [1...1] String [1/*] - M Shipment document identification number.
                @type [1...1] String [1/*] BusinessDocumentType M Type of document identifier.
              cmn:LineItemNumber [0...1] String [0/6] - O Document line item number for the reference document.
              cmn:DocumentDate [0...1] String [10/10] - O Date of the reference document.
            cmn:AvailableQuantity  [0...1] Integer - - O Returns available TH quantity when an overpick has occurred.
          ie:MfrSalesShipmentTHSpec [0...1] - - - O Option 8 for choice%3 group. Used for Manufacturer sales shipment transaction type for picking and shipping of goods for sale of goods, resulting in TH creation.
            cmn:Location [0...1] String [0/*] - O Warehouse location where product was picked. 
              @type [1...1] String [1/*] Location C This attribute identifies the location types.
Mandatory if cmn:Location is populated.
            cmn:cmn:ShipmentIdentifiers [1...1] - - - M Ship document identification numbers group.
              cmn:ShipmentId [1...*] String [1/*] - M Delivery document/ship document identifier.
                @type [1...1] String [1/*] ShipmentIDType M Type of shipment ID.
              cmn:DocumentDate [0...1] Date [0/*] - M Date for the shipment document in XML date format YYYY-MM-DD.
            cmn:LineItemNumber [0...1] String [0/*] - O Line item number for the order item.
            cmn:ShipTHAction [0...1] String [1/*] ShipTHAction O Instructs system whether to create a TH or pick the TH from the TH repository. Picking is used only when a manufacturer is a reseller of product.
            cmn:InternalMaterialNumber [0...1] String [0/*] - O Material number in sender's internal system for sellable shipped item or packing item recorded in detail record.
            cmn:NDC [0...1] String [1/*] - O National drug code number of the product.
              @type [1...1] String [0/*] NDCType C NDC code type.
Mandatory if cmn:NDC is populated.
            cmn:LotNumber [0...1] String [0/*] - O Batch or lot number for sellable shipped product.
Lot number is optional, but must be included if the product was acquired as an indirect purchase.
            cmn:ReferenceIdentifier [0...1] String [0/*] - O Identification number assigned to the TH during receiving (e.g. a location identifier.) 
            cmn:ItemQuantity [1...1] String [1/*] - M Number of sellable units in the lot to represent the Transaction Information "number of containers" that were part of the THs.
            cmn:SalesQuantity [0...1] Decimal [1/*] - O Quantity recorded for sales transaction for use in ASN.
              @quantityUnitOfMeasure [1...1] String [0/*] QuantityUOM C Quantity unit of measure.
Mandatory if cmn:SalesQuantity is populated.
            cmn:ItemReferenceDocuments [0...*] - - - O Business documents relevant to shipment of sellable items.
              cmn:BusinessDocument [1...1] String [1/*] - M Shipment document identification number.
                @type [1...1] String [1/*] BusinessDocumentType M Type of document identifier.
              cmn:LineItemNumber [0...1] String [0/6] - O Document line item number for the reference document.
              cmn:DocumentDate [0...1] String [10/10] - O Date of the reference document.
          ie:LSPShipmentTHSpec [0...1] - - - O Option 9 for choice%3 group. Used for third-party logistics provider shipment transaction type for picking and shipping of goods for sale of goods, submitted to manufacturer, resulting in TH creation by manufacturer Product Track.
            cmn:Location [0...1] String [0/*] - O Warehouse location where product was picked. 
              @type [1...1] String [1/*] Location M This attribute identifies the location types.
Mandatory if Location is populated.
            cmn:ShipmentIdentifiers [1...1] - - - M Ship document identification numbers group.
              cmn:ShipmentId [1...*] String [1/*] - M Delivery document/ship document identifier.
                @type [1...1] String [1/*] ShipmentIDType M Type of shipment ID.
              cmn:DocumentDate [0...1] Date [0/*] - O Date for the shipment document in XML date format YYYY-MM-DD.
            cmn:LineItemNumber [0...1] String [0/*] - O Line item number for the order item.
            cmn:ShipTHAction [0...1] String [1/*] ShipTHAction O Instructs system whether to create a TH or pick the TH from the TH repository. Picking is used only when a manufacturer is a reseller of product.
            cmn:InternalMaterialNumber [0...1] String [0/*] - O Material number in sender's internal system for sellable shipped item or packing item recorded in detail record.
            cmn:NDC [0...1] String [1/*] - O National drug code number of the product.
              @type [1...1] String [0/*] NDCType C NDC code type.
Mandatory if cmn:NDC is populated.
            cmn:LotNumber [0...1] String [0/*] - O Batch or lot number for sellable shipped product.
Lot number is optional, but must be included if the product was acquired as an indirect purchase.
            cmn:ReferenceIdentifier [0...1] String [0/*] - O Identification number assigned to the TH during receiving, such as a location identifier. 
            cmn:ItemQuantity [1...1] String [1/*] - M Number of sellable units in the lot to represent the Transaction Information "number of containers" that were part of the THs.
            cmn:SalesQuantity [0...1] Decimal [1/*] - O Quantity recorded for sales transaction for use in ASN.
              @quantityUnitOfMeasure [1...1] String [0/*] QuantityUOM C Quantity unit of measure.
Mandatory if cmn:SalesQuantity is populated.
            cmn:ShippingReferenceDocuments [0...*] - - - O Business documents relevant to shipment of sellable items.
              cmn:BusinessDocument [1...1] String [1/*] - M Shipment document identification number.
                @type [1...1] String [1/*] BusinessDocumentType M Type of document identifier.
              cmn:LineItemNumber [0...1] String [0/6] - O Document line item number for the reference document.
              cmn:DocumentDate [0...1] String [10/10] - O Date of the reference document.
          ie:ProcessingCode [1...1] String [1/*] - M The processing code assigned by the system to indicate the success, failure, or warning.
          ie:ProcessingMessage [0...*] String [1/*] - O The processing message with detail on why the item in the item spec incurred a warning or failure.