Transaction History Inventory Request Guidelines
See How to Use this Guide before reading the below information.
Message Type: PT_TH_INV_REQUEST
Info Exchange Display Name: TH Inventory Report Request
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:PTTransactionInventoryRequestMessage | 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:RequestId | 1...1 | String | 1/* | - | M | Request identifier associated
with this specific report request. The report response will include the
request identifier.6 This can help the receiving system correlate the report response to the originating request. |
||||||
| cmn:Location | 0...* | String | 0/* | - | O | List of zero or more Product
Track Locations for which the Transaction Inventory Report is being
requested.7 If no Location is specified, the system will return data across all locations and at the company level. |
||||||
| @type | 1...1 | String | 1/* | SubscriberLocation | M | Attribute identifies the
location types.8
Mandatory if cmn:Location is populated. |
||||||
| cmn:NDC | 0...* | String | 1/* | - | O | A list of zero or more NDCs
for which the inventory report is being requested, without hyphen separators.9 If no NDC is specified, the system will return data for all NDCs. |
||||||
| @type | 1...1 | String | 1/* | NDCType | M | Attribute identifies the NDC type.10 | ||||||
| cmn:PickModel | 0...1 | String | 0/* | PickModel | O | Identifies pick model supported: NDC only or NDC plus lot number. | ||||||
| cmn:IncludeZeroInventoryItems | 0...1 | Boolean | 0/* | - | O | Allows sending of zero quantity inventory report. System defaults to "false" if source field is not populated. Valid values:
|
||||||
