Increment Transaction History Quantity Guidelines

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

Message Type: PT_INCREMENT_TH_QTY

Info Exchange Display Name: Increment TH Quantity

These fields are sent by the sender to TraceLink.

When sending an element in Date or DateTime format, a valid date must be given. "00" is not a valid day or month value and "0000" is not a valid year value.
Data Element Occurs Format Length Enums Req Description
pt:PTIncrementTHQuantity [1…1] - - - M Root element of message.
  pt:ControlFileHeader [1…1] - - - M XML file control header record.
    cmn:FileSenderNumber [1…1] String [1/20] - M File sender's company identifier. *1
    cmn:FileReceiverNumber [1…1] String [1/20] - M File recipient's company identifier. *2
    cmn:FileControlNumber [1…1] String [1/*] - M Unique file control ID number. *3
    cmn:FileDate [1…1] Date [10/10] - M Date file generated in XML YYYY-MM-DD format. *4
    cmn:FileTime [1…1] Time [9/9] - M Time file generated in XML HH:MM:SSZ format (must be GMT). *5
  pt:MessageBody [1…1] - - - M Main body of message.
    cmn:Location [0…1] String [0/*] - O Location where inventory exists for which Transaction History (TH) meta data update is occurring. If the Product Track Application is configured to use Locations to model your facilities, populate this element with one of the configured location values. *6
If the Product Track Application is not configured to use Locations, omit this element.
      @type [1…1] String [1/*] SubscriberLocation C Attribute identifies the location types. *7
Mandatory if cmn:Location is populated.
    pt:IncrementTHQuantity [1…*] - - - O Looping group for items or items and lots for which quantities associated with one or more THs will be incremented.
      pt: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. *8
          @type [1…1] String [1/*] NDCType M Attribute identifies the NDC type. *9
        cmn:LotNumber [1…1] String [1/*] - M The lot number associated with a TH. *10
        cmn:ReferenceIdentifier [0…1] String [0/*] - O The Reference Identifier assigned to a Transaction History for this NDC and Lot during receiving. *11
        cmn:DeliveryNumber [0…1] String [1/*] - O The original receiving Delivery Number associated with a Transaction History for this NDC and Lot. The DeliveryNumber should only be used for precise matching and when the original DeliveryNumber for a TH is known. *12
If there is no delivery number DO NOT send an empty tag. An empty tag on this field will trigger an error in the TraceLink system.
      pt:UpdateQuantity [1…1] - - - M Provides quantity used to increment quantities posted to one or more THs.
        cmn:Quantity [1…1] Integer   - M Provides the increment quantity to be applied to the matching THs. *13
        cmn:ReferenceIdentifier [0…1] String [0/*] - O Reference identifier assigned to identify this Increment message. *14
Use Reference Identifiers with caution. Once a Reference Identifier assignment to a Transaction History (TH) is complete, it can only be matched in the Pick/Ship operation using the exact NDC, Lot Number, and Reference Identifier. Only use this approach for strict matching against a specific TH for an outbound customer delivery.
        cmn:TransactionIdentifier [0…*] String [0/*] - O A list of one or more business documents associated with the adjustment for audit trailing purposes. *15
          @type [1…1] String [1/*] TransactionIdentifier C Attribute identifies the Transaction type. *16
Mandatory if cmn:TransactionIdentifier is populated.
        cmn:THAdjustmentReasonCode [1…1] String [1/*] THAdjustReasonCode M A reason code associated with the adjustment for audit trailing purposes. *17
        cmn:ReasonText [0…1] String [0/*] - O Additional reason description text associated with the adjustment for audit trailing purposes. *18