Update Transaction Guidelines

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

Message Type: PT_UPDATE_TRANSACTION

Info Exchange Display Name: Update Transaction

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	Enum	Req	Description
pt:PTUpdateTransactionMessage						[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	[1/*]	-	C	Location where inventory exists for which Transaction History (TH) meta data update is occurring. *6 If the Product Track application is configured to use Locations to model facilities, populate this element with one of the configured location values. If the Product Track application is not configured to use Locations, omit this element.
			@type			[1...1]	String	[1/*]	Location	C	Attribute identifies the location types. *7 Mandatory if cmn:Location is populated.
		choice%1				[1...1]	Choice	-	-	M	The choice%1 group is required, which means that one of the three choice options must be provided: Option 1 within choice%1 is to adjust the quantities associated with Transaction Histories (THs). Option 2 within choice%1 is to change the state associated of THs between Available and Quarantine. THs with a state of Quarantine will be excluded from pick operations. Option 3 within choice%1 is to void the set of THs associated with a delivery that was sent to or received from a trade partner.
		pt:UpdateTransactionQuantity				[0...*]	-	-	-	C	Option1 for choice%1 group. Used to adjust the quantities associated with one or more THs. This is a list element, enabling multiple quantity updates to be provided
			pt:UpdateItems			[1...1]	-	-	-	M	Identifies the matching criteria for the THs to be updated. Providing more fields (e.g. NDC, LotNumber) enables more precise matching to be able to identify and update specific TH counts.
				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		[0...1]	String	[0/*]	-	C	The lot number associated with a TH. *10
				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. *11
				cmn:DeliveryNumber		[0...1]	String	[1/*]	-	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. *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 TL system.
			cmn:UpdateQuantity			[1...1]	Integer	-	-	M	Provides either the adjustment or replacement TH quantity to be applied to the matching THs. *13 "AdjustBy" instructs the system to increment or decrement the current available TH quantity. A positive number increments the current count by that value. A negative number decrements 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	M	Attribute identifies the Quantity type. *14
			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		TransactionIdentifier	M	Attribute identifies the Transaction type. *16
			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
		pt:UpdateTransactionState				[0...*]	-	-	-	C	Option 2 for choice%1 group. Used to change the state associated of THs between Available and Quarantine. This is a list element, enabling multiple status updates to be provided. THs with a state of Quarantine will be excluded from pick operations.
			cmn:NDC			[1...1]	String	[1/*]		M	The NDC associated with a TH without hyphen separators. *19
				@type		[1...1]	String	[1/*]	NDCType	M	Attribute that identifies the NDC type. *20
			cmn:LotNumber			[1...1]	String	[1...1]	-	M	The lot number associated with a TH. *21
			cmn:THState			[1...1]	String	[1...1]	THState	M	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. *22
			cmn:TransactionIdentifier			[0...*]	String	[0/*]	-	O	A list of one or more business documents associated with the status update for audit trailing purposes. *23
				@type		[1...1]	String	-	TransactionIdentifier	M	Attribute that identifies the Transaction type. *24
			cmn:THAdjustmentReasonCode			[1...1]	String	[1/*]	THAdjustReasonCode	M	A reason code associated with the status update for audit trailing purposes. *25
			cmn:ReasonText			[0...1]	String	[0/*]	-	O	Additional reason description text associated with the status update L27 for audit trailing purposes. *26
		pt:VoidTransaction				[0...*]	-	-	-	C	Option 3 for choice%1 group. Used to void a set of THs associated with a delivery that was sent to or received from a trade partner. This is a list element, enabling multiple voids to be provided
			cmn:DeliveryNumber			[1...1]	String	[1/*]	-	M	The original receiving Delivery Number for the delivery sent or received for which the THs should be voided. *27
			cmn:TransactionHistoryType			[1...1]	String	[1/*]	THType	M	Indicates if the TH to be voided was one sent or received from a trade partner. *28 This is required to disambiguate THs that may have the same Delivery Number (across THs sent and received).
			cmn:PartnerId			[1...1]	String	[1/*]	-	M	Identifies the trade partner that TH was sent to or received from. *29 This is required to disambiguate THs that may have the same Delivery Number (across THs sent and received).
				@type		[1...1]	String	[1/*]	PartnerId	M	Attribute that identifies the location types. *30
			cmn:VoidItem			[0...*]	-	-	-	O	Used to void a specific TH line item in the Delivery, by specifying the NDC, Lot Number, Business Document, and Quantity. The Quantity must exactly match the quantity of the TH line item.
				cmn:NDC		[1...1]	String	[1/*]	-	M	The NDC associated with a TH without hyphen separators. *31
					@type	[1...1]	String	[1/*]	NDCType	M	Attribute that identifies the NDC type. *32
				cmn:LotNumber		[1...1]	String	[1/*]	-	M	The lot number associated with a TH. *33
				cmn:BusinessDocument		[1...1]	String	[1/*]	-	M	Business document identifier for the transaction (e.g. PO, VendorOrder, Invoice) associated with the line item/TH to be voided. *34 This must be an exact match.
					@type	[1...1]	String	[1...1]	BusinessDocumentIDType	M	Type of document identifier. *35
				cmn:Quantity		[1...1]	Integer	-	-	M	Quantity of the TH line item. This must be an exact match. *36
			cmn:THAdjustmentReasonCode			[1...1]	String	[1/*]	THAdjustReasonCode	M	A reason code associated with the void operation for audit trailing purposes. *37
			cmn:ReasonText			[0...1]	String	[0/*]	-	O	Additional reason description text associated with the void operation for audit trailing purposes. *38