Shipment Receipt Guidelines (.xml)

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

Message Type: PT_SHIPMENT_RECEIPT

Info Exchange Display Name: Shipping Receipt

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:PTShipmentReceiptMessage [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/*] - C Location where receipt of shipment occurs. *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. Attribute is required if Location is populated *7  
    cmn:ReceiptType [1...1] String [1/*] ReceiptType M Indicates if receipt is for a purchase or transfer of goods from one facility to another (e.g. warehouse to warehouse, 3PL transfer, pharmacy to pharmacy). *8

For intra-company transfer receipts, a transfer shipment must have been initiated and Transaction History (TH)/quantities transferred made accessible to new location.

  
    cmn:IsPharmacy [0...1] Boolean [0/*] - O Identifies if receiving entity is a pharmacy. Used only when ReceiptType = Purchase.

Valid values: *9

  • True
    • Indicates receiving party is a pharmacy.
    • LotNumber is optional.
  • False or empty
    • Indicates receiving party is not a pharmacy.
    • LotNumber required.
    • Empty means that this element is omitted.
  
    cmn:DeliveryNumber [1...1] String [1/*] - M The delivery number for the shipment. The system uses the Delivery Number to match against TH received from a supplier (against the Delivery Number in the ASN), or to match against the transfer Delivery Number associated with transferred TH for an intra-company transfer. *10  
    pt:ReceivedItem [1...*] - - - M List of one or more products received against the delivery.  
      cmn:NDC [1...1] String [1/*] - M The NDC of the product being received without hyphen separators. *11  
        @type [1...1] String [1/*] NDCType M Attribute that identifies the NDC type. *12  
      cmn:LotNumber [0...1] String [0/*] - C The lot/batch number of the product being received. *13
  • If IsPharmacy = False or empty
    • LotNumber is required, unless ReceiptType = Transfer, then LotNumber is optional
  • If IsPharmacy = True
    • LotNumber Optional
  
      cmn:Quantity [1...1] Integer [1/*] - M The each/unit quantity of the product being received. This value is used to represent the quantity received against the TH. Subsequent picks against the TH are against this quantity and the unit of measures (each/unit) must be consistent. *14

Reverse receipts are supported by providing a negative quantity. This quantity is decremented from the received quantity of the matching TH.

  
      cmn:ReferenceIdentifier [0...1] String [0/*] - O An identifier assigned to the TH. This value is used to precisely match against the TH in subsequent operations, (e.g. Pick/Ship, Update [void]). The ReferenceIdentifier can be used with both Purchase and Transfer receipts and sets the Reference Identifier against the TH at the receiving location. *15
If a ReferenceIdentifier is assigned to a TH, it must be used to subsequently reference the TH for any operation that can be performed on that TH. Once assigned, the ReferenceIdentifier is the only way to access the TH.
  
      cmn:ProductOrigin [0...1] String [0/*] ProductOrigin C Indicates how the product was sourced and informs the fields that appear on the outbound TH when the product is sold. If this value is not provided in the receiving interface, the NDC must be populated in Product Master Data, with the ProductOrigin flag set. *16
  • OriginatorExclusiveDistributor indicates the company that purchased this product is the Exclusive Distributor of the Product. In this case, the Exclusive Distributor will set ProductOrigin to be OriginatorExclusiveDistributor, and not DirectPurchaseManufacturer, even though the Exclusive Distributor did purchase from the manufacturer. This ensures that outbound Transaction Histories (THs) for this product start with the Exclusive Distributor and not "continue" the received TH.
  • ProductOrigin is used only for a Purchase receipt type. This does not apply to Transfer Receipts as the TH was already tagged on initial inbound receipt from purchase.
  
      cmn:TransactionIdentifier [0...*] String [0/*] - O Business transaction identifier for the business transaction that initiated the product receipt (e.g. PO Number, Transfer Number). *17  
        @type [1...1] String [1/*] TransactionIdentifier C Attribute that identifies the transaction identifier type. Attribute is required if TransactionIdentifier is populated. *18