Receipt Information Update (XML) API

Smart Inventory Tracker Owners receive this asynchronous outbound message from TraceLink when a warehouse operator completes a receipt. This message includes the products, lot numbers, quantities, and container information associated with the delivery number, which can be used to update inventory within the company's ERP system or WMS.

Owners, or an Administrator for the Owner, must enable the Complete Receipt event workflow and set the message to be delivered automatically in the Transaction Delivery Rules in Company Administration to receive this message.

See the Body guidelines, Errors, and Body example for this message below.

Body guidelines

Element Occurs
Length		 Type

Description
sit:SITReceiptInformationUpdate [1...1]
[–]		 – Required. The TL XML message root element.
  sit:ControlFileHeader [1...1]
[–]		 – Required. Smart Inventory Tracker header record group.
    cmn:FileSenderNumber [1...1]
[1/*]		 String Required. Identifier for the sender of the file.
    cmn:FileReceiverNumber [1...1]
[1/*]		 String Required. Identifier for the receiver of the file.
    cmn:FileControlNumber [1...1]
[1/*]		 String Required. Unique file identifier assigned by the sender.
    cmn:FileDate [1...1]
[10/10]		 Date Required. Date the file is created in YYYY-MM-DD format.
    cmn:FileTime [1...1]
[8/8]		 Time Required. Time the file is created in HH:MM:SSZ format.
  sit:MessageBody [1...1]
[–]		 – Required. Smart Inventory Tracker receipt information message details.
    cmn:DeliveryNumber [1...1]
[1/*]		 String Required. The unique identifier for the receipt.
    cmn:ReceiptDistributionType [1...1]
[1/*]		 String

Required. The type of sale or transfer. 

Valid values:

  • INCOUNTRYPURCHASE – A purchase within the same country.
  • INCOUNTRYRETURN – A return within the same country.
  • INCOUNTRYTRANSFER – A transfer within the same country.
  • IMPORTPURCHASE – A purchase into one country from another.
  • IMPORTRETURN – A return into one country from another.
  • IMPORTTRANSFER – A transfer into one country from another.
    cmn:TransactionIdentifiers [1...1]
[–]		 – Required. List of transaction identifiers associated with the receipt.
      cmn:TransactionIdentifier [1...*]

[1/*]

 String Required. The receipt's transaction identifier.
        @type [1...1]

[1/*]

 String

Required. The transaction identifier type.

Valid values:

  • ASN – Shipment Notification number.
  • BOL – Bill of Lading number.
  • CERTIFICATECONFORMITY – Certificate of Conformity number.
  • DECLARATIONCONFORMITY – Declaration of Conformity number.
  • DESTRUCTION – Destruction Order number.
  • INVOICE – Invoice number.
  • OTHER – Another transaction identifier.
  • NOTAFISCALELETRONICA – Nota Fiscal Document number.
  • PACKSLIP – Packing Slip number.
  • PO – Purchase Order number.
  • PRONUMBER – Transportation Carrier Progressive number.
  • RETURN – Return Authorization number.
  • SALESORDER – Sales Order number.
  • TRANSFER – Transfer Order number.
        @date [0...1]
[0/*]		 Date The date printed on the transaction document in YYYY-MM-DD format.
    cmn:OrderItemAssociations [1...1]
[–]		 – Required. List of the unique product, lot, and quantity combinations in the receipt. Taken from the order items in Serialized Operations Manager and includes any updates made to the receipt in Smart Inventory Tracker.
Might be one-to many lot values associated to a given product from the delivery number to the ERP/WMS touchpoint.
      cmn:OrderItemAssociation [1...1]
[–]		 – Required. Information about a specific order item.
        cmn:InternalMaterialCode [0...1]
[0/*]		 String The Internal Material Number that identifies the product.
        cmn:CountryDrugCode [0...1]
[1/*]		 String The national drug code that identifies the product.
          @type [0...1]
[0/*]		 String

Required. The national drug code type.

  • AT_PZN – Austria PZN code. Format is Country ID (2) + Sector (4) + PZN (6) + Check Digit (1) (e.g. 9088884762098).
  • BE_ABP_CODE – 16-character Belgium ABP code. Format is APB (7) + Sequential Number (8) + Check Digit (1) (e.g. 5502892699183494).
  • BG_NATIONAL_NUMBER – 1- to 20-alphanumeric character Bulgaria National Drug Code (e.g. 9900211).
  • BR_ANVISA_REGISTRATION – 13-character Brazil ANVISA Drug Registration code (e.g. 1.1111.1111.1123).
  • CA_DIN – 8-character Canada DIN code (e.g. 50051934).
  • CH_SWISSMEDIC – Switzerland Swissmedic code. Format is 7680 + Code assigned by Swissmedic (consists of 5 digits Product License number + 3 digits Pack Size indicator) + check digit (e.g. 7680718523780).
  • CN_NDC – 1- to 20-alphanumeric character China National Drug Code (e.g. 02351000201).
  • CN_STANDARD – 1- to 20-alphanumeric character China Drug Standard Code (e.g. 3003310000999).
  • CN_SUBTYPE – 10-character China Subtype code. Format is Product Code (7) + 3 Digits (e.g. 1008721001).
  • DE_PPN – 12-character Germany PPN code (e.g. 111234567842).
  • DE_PZN – 8-character Germany PZN code. Format is PZN (7) + Check Digit (1) (e.g. 12345678).
  • EAN13 – 13-character International Article Number. Format is Country ID (2) + Sector (2) + Product ID (5) + Packaging Code (3) + Check Digit (1) (e.g. 2348856277129).
  • ES_CODIGO_NATIONAL – Spain Codigo National code. Format is 84 7000 + CN (6) + Check Digit (1) (e.g. 8470001874925).
  • FR_CIP13 – France CIP13 code. Format is Prefix 3400 + CIP/ACL (8) + Check Digit (1) (e.g. 3400750000210).
  • GR_EOFCODE – Greece EOF code (e.g. 829709833).
  • HR_NATIONAL_CODE – Croatia National code. Format is ATC (Generic) Code (7) + Product (SKU) ID (3) (e.g. 3297443232).
  • IN_PRODUCT_CODE – 8- to 12-character India product code. Format is Manufacturer Code + Product Code (e.g. 694832700711).
  • INTERNAL_MATERIAL_CODE – Internal Material Number (e.g. 3257458).
  • IT_BOLLINO – Italy Bollino code (e.g. 829709833).
  • KR_KFDA_CODE – 13-character Korea KFDA code (e.g. 1825060903760).
  • LU_NATIONAL_NUMBER – Luxembourg National Number (e.g. 25668974).
  • NL_KNMP_CODE – Netherlands KNMP code. Format is KNMP (7) + Check Digit (1) (e.g. 91757154).
  • NRD_VNR_CODE – Nordic countries VNR code (e.g. 025553).
  • PT_AIM – Portugal AIM number (e.g. 9279188).
  • SA_SAUDI_DRUG_CODE – 10-character Saudi Arabia alphanumeric Drug Code (e.g. SFDA17D224).
  • SUKL – Czech Republic State Institute for Drug Control Code (e.g. 24148725).
  • UK_AMPP – United Kingdom National Drug Code (e.g. 235145692).
  • US_NDC442 – 10- or 12-character US National Drug Code. Format is FDA Labeler Code (4) + Product Code (4) + Packaging Code (2) (e.g. 0003-7597-01). May have hyphen separators at positions 4-4-2.
  • US_NDC532 – 10- or 12-character US National Drug Code. Format is FDA Labeler Code (5) + Product Code (3) + Packaging Code (2) (e.g. 50232-040-62). May have hyphen separators at positions 5-3-2.
  • US_NDC541 – 10- or 12-character US National Drug Code. Format is FDA Labeler Code (5) + Product Code (4) + Packaging Code (1) (e.g. 60573-4112-1). May have hyphen separators at positions 5-4-1.
  • US_NDC542 – 11-or 13-character US normalized National Drug Code. Format is FDA Labeler Code (5) + Product Code (4) + Packaging Code (2) (e.g. 60573-4112-01). May have hyphen separators at positions 5-4-2.
        cmn:PackagingItemCode [1...1]
[1/*]		 String Required. The packaging code that identifies the product and its packaging level.
          @type [1...1]
[1/*]		 String Required. The type of packaging code. Valid values:
  • CN-RESCODE – China packaging code format.
  • GTIN-14 – Global Trade Item Number.
  • NTIN – National Trade Item Number.
        cmn:LotNumber [0...1]
[0/*]		 String The lot number associated with the product.
        cmn:ExpirationDate [0...1]
[0/*]		 Date The expiration date associated with the product in YYYY-MM-DD format.
        cmn:Quantity [1...1]
[1/*]		 Integer Required. The number of items with this product and lot number combination included in the receipt.
Might be less than the order item quantity entered in Serialized Operations Manager if short receipt is allowed, including a quantity of 0.
        cmn:IsSerialized [0...1]
[–]		 Boolean

Indicates whether the product is serialized.

Valid values:

  • true – The product is serialized.
  • false – The product is not serialized.

If a value is not specified, this element defaults to true.
        cmn:PackagingLevel [1...1]
[1/*]		 String Required. The packaging level (i.e. packaging unit of measure) of the product. At the cmn:OrderItemAssociation level, the packaging level is always each (i.e. EA).
        cmn:PackGroups [0...1]
[–]		 – List of the top-level parent containers within the order item.

Each pack is logically grouped with other packs that have the same container quantity (i.e. lowest saleable units). cmn:NumberOfPacks identifies the total number of packs in that group.
          cmn:PackGroup [1...*]
[–]		 – Required. Information about a specific top-level parent.
            cmn:ContainerQty [1...1]
[1/*]		 Integer Required. The number of eaches (i.e. lowest saleable units) contained within each top-level parent in this group.
            cmn:NumberOfPacks [1...1]
[1/*]		 Integer Required. The number of top-level parents that share the same cmn:ContainerQty.
            cmn:PackagingItemCode [0...1]
[1/*]		 String The packaging code value for the top-level parents in this group.
              @type [1...1]
[1/*]		 String

Required. The packaging code type for the top-level parents in this group.

Valid values:

  • CN-RESCODE – China packaging code format.
  • GTIN-14 – Global Trade Item Number.
  • NTIN – National Trade Item Number.
            cmn:PackagingLevel [1...1]
[1/*]		 String

Required. The packaging level for the top-level parents in this group.

Valid values:

  • CA – (Case / Shipper) A grouping of inner packs / bundles or a grouping of eaches if the packaging hierarchy does not include inner packs / bundles.
  • EA – (Each) Lowest saleable units.
  • PK – (Inner Pack / Bundle) A grouping of eaches.
  • PL – (Pallet) Cases grouped together on a pallet.
        cmn:OrderItemContainers [0...1]
[–]		 – The list of containers within the order item.
          cmn:OrderItemContainer [1...*]
[–]		 – Required. Information about the specific container.
            cmn:SerialNumber [1...1]
[1/*]		 String Required. The serial number for the container, formatted without parentheses (e.g. 00103123400000001515). GTIN, NTIN, SSCC, and EDMC serial numbers are allowed.
            cmn:PackagingLevel [1...1]
[1/*]		 String

Required. The packaging level (i.e. packaging unit of measure) of the container.

Valid values:

  • CA – (Case / Shipper) A grouping of inner packs / bundles or a grouping of eaches if the packaging hierarchy does not include inner packs / bundles.
  • EA – (Each) Lowest saleable units.
  • PK – (Inner Pack / Bundle) A grouping of eaches.
  • PL – (Pallet) Cases grouped together on a pallet.
            cmn:Quantity [1...1]
[1/*]		 Integer Required. Total number of eaches (i.e. lowest saleable units) aggregated to the container.
            cmn:PackGroups [0...1]
[–]		 – List of the top-level parents within this specific container.
              cmn:PackGroup [1...*]
[–]		 – Required. Information about a specific group within the container.
                cmn:ContainerQty [1...1]
[1/*]		 Integer Required. The number of eaches (i.e. lowest saleable units) contained within each top-level parent in this group.
                cmn:NumberOfPacks [1...1]
[1/*]		 Integer Required. The number of top-level parents that share the same cmn:ContainerQty.
                cmn:PackagingItemCode [0...1]
[1/*]		 String The packaging code value for the top-level parents in this group.
                  @type [1...1]
[1/*]		 String

Required. The packaging code type for the top-level parents in this group.

Valid values:

  • CN-RESCODE – China packaging code format.
  • GTIN-14 – Global Trade Item Number.
  • NTIN – National Trade Item Number.
                cmn:PackagingLevel [1...1]
[1/*]		 String

Required. The packaging level for the top-level parents in this group.

Valid values:

  • CA – (Case / Shipper) A grouping of inner packs / bundles or a grouping of eaches if the packaging hierarchy does not include inner packs / bundles.
  • EA – (Each) Lowest saleable units.
  • PK – (Inner Pack / Bundle) A grouping of eaches.
  • PL – (Pallet) Cases grouped together on a pallet.

Errors

Elements Error Message Description
cmn:DeliveryNumber Delivery number is required !!! The error occurs if the source is empty or null.
cmn:ReceiptDistributionType Valid receipt distribution type is required !!! The error occurs if the source is present, but there is no matching entry in the lookup file, or the source is empty or null.
cmn:TransactionIdentifier Transaction identifier is required !!! The error occurs if the source is empty or null.
cmn:TransactionIdentifier | @type Valid transaction identifier type is required !!! The error occurs if cmn:TransactionIdentifier is present, but the source is empty or null, or if there is no matching entry in the lookup file.
cmn:OrderItemAssociation | cmn:PackagingItemCode Packaging item code is required !!! The error occurs if the source is empty or null.
cmn:PackagingItemCode | @type Valid packaging item code type is required !!! The error occurs if cmn:PackagingItemCode is present, but the source is empty or null, or if there is no matching entry in the lookup file.
cmn:ContainerQty Container quantity is required !!! The error occurs if the source is empty or null.
cmn:NumberOfPacks Number of packs is required !!! The error occurs if the source is empty or null.
cmn:SerialNumber Serial number is required !!! The error occurs if the source is empty or null.
cmn:Quantity Order item container quantity is required !!! The error occurs if the source is empty or null.

Body Example

Copy 
<?xml version="1.0" encoding="UTF-8"?>
<sit:SITReceiptInformationUpdate xmlns:cmn="urn:tracelink:mapper:sl:commontypes" xmlns:sit="urn:tracelink:mapper:sl:smart_inventory_tracker">
    <sit:ControlFileHeader>
        <cmn:FileSenderNumber>8136957892091</cmn:FileSenderNumber>
        <cmn:FileReceiverNumber>8136957892855</cmn:FileReceiverNumber>
        <cmn:FileControlNumber>221108164952288</cmn:FileControlNumber>
        <cmn:FileDate>2022-11-08</cmn:FileDate>
        <cmn:FileTime>16:49:52Z</cmn:FileTime>
    </sit:ControlFileHeader>
    <sit:MessageBody>
        <cmn:DeliveryNumber>F2UU23U1N1D</cmn:DeliveryNumber>
        <cmn:ReceiptDistributionType>INCOUNTRYPURCHASE</cmn:ReceiptDistributionType>
        <cmn:TransactionIdentifiers>
            <cmn:TransactionIdentifier type="PO">Y3VK5R</cmn:TransactionIdentifier>
        </cmn:TransactionIdentifiers>
        <cmn:OrderItemAssociations>
            <cmn:OrderItemAssociation>
                <cmn:InternalMaterialCode>1400-315</cmn:InternalMaterialCode>
                <cmn:PackagingItemCode type="GTIN-14">88136957890680</cmn:PackagingItemCode>
                <cmn:LotNumber>129</cmn:LotNumber>
                <cmn:ExpirationDate>2025-08-19</cmn:ExpirationDate>
                <cmn:Quantity>2</cmn:Quantity>
                <cmn:IsSerialized>true</cmn:IsSerialized>
                <cmn:PackagingLevel>EA</cmn:PackagingLevel>
                <cmn:PackGroups>
                    <cmn:PackGroup>
                        <cmn:ContainerQty>1</cmn:ContainerQty>
                        <cmn:NumberOfPacks>2</cmn:NumberOfPacks>
                        <cmn:PackagingItemCode type="GTIN-14">88136957890680</cmn:PackagingItemCode>
                        <cmn:PackagingLevel>EA</cmn:PackagingLevel>
                    </cmn:PackGroup>
                </cmn:PackGroups>
                <cmn:OrderItemContainers>
                    <cmn:OrderItemContainer>
                        <cmn:SerialNumber>018813695789068021663319572999</cmn:SerialNumber>
                        <cmn:PackagingLevel>EA</cmn:PackagingLevel>
                        <cmn:Quantity>1</cmn:Quantity>
                        <cmn:PackGroups>
                            <cmn:PackGroup>
                                <cmn:ContainerQty>1</cmn:ContainerQty>
                                <cmn:NumberOfPacks>1</cmn:NumberOfPacks>
                                <cmn:PackagingItemCode type="GTIN-14">88136957890680</cmn:PackagingItemCode>
                                <cmn:PackagingLevel>EA</cmn:PackagingLevel>
                            </cmn:PackGroup>
                        </cmn:PackGroups>
                    </cmn:OrderItemContainer>
                    <cmn:OrderItemContainer>
                        <cmn:SerialNumber>018813695789068021663319572998</cmn:SerialNumber>
                        <cmn:PackagingLevel>EA</cmn:PackagingLevel>
                        <cmn:Quantity>1</cmn:Quantity>
                        <cmn:PackGroups>
                            <cmn:PackGroup>
                                <cmn:ContainerQty>1</cmn:ContainerQty>
                                <cmn:NumberOfPacks>1</cmn:NumberOfPacks>
                                <cmn:PackagingItemCode type="GTIN-14">88136957890680</cmn:PackagingItemCode>
                                <cmn:PackagingLevel>EA</cmn:PackagingLevel>
                            </cmn:PackGroup>
                        </cmn:PackGroups>
                    </cmn:OrderItemContainer>
                </cmn:OrderItemContainers>
            </cmn:OrderItemAssociation>
            <cmn:OrderItemAssociation>
                <cmn:CountryDrugCode type="US_NDC532">54989-142-15</cmn:CountryDrugCode>
                <cmn:PackagingItemCode type="GTIN-14">58136957898142</cmn:PackagingItemCode>
                <cmn:LotNumber>110</cmn:LotNumber>
                <cmn:ExpirationDate>2024-02-19</cmn:ExpirationDate>
                <cmn:Quantity>1</cmn:Quantity>
                <cmn:IsSerialized>true</cmn:IsSerialized>
                <cmn:PackagingLevel>EA</cmn:PackagingLevel>
                <cmn:PackGroups>
                    <cmn:PackGroup>
                        <cmn:ContainerQty>1</cmn:ContainerQty>
                        <cmn:NumberOfPacks>1</cmn:NumberOfPacks>
                        <cmn:PackagingItemCode type="GTIN-14">58136957898142</cmn:PackagingItemCode>
                        <cmn:PackagingLevel>EA</cmn:PackagingLevel>
                    </cmn:PackGroup>
                </cmn:PackGroups>
                <cmn:OrderItemContainers>
                    <cmn:OrderItemContainer>
                        <cmn:SerialNumber>015813695789814221663319573023</cmn:SerialNumber>
                        <cmn:PackagingLevel>EA</cmn:PackagingLevel>
                        <cmn:Quantity>1</cmn:Quantity>
                        <cmn:PackGroups>
                            <cmn:PackGroup>
                                <cmn:ContainerQty>1</cmn:ContainerQty>
                                <cmn:NumberOfPacks>1</cmn:NumberOfPacks>
                                <cmn:PackagingItemCode type="GTIN-14">58136957898142</cmn:PackagingItemCode>
                                <cmn:PackagingLevel>EA</cmn:PackagingLevel>
                            </cmn:PackGroup>
                        </cmn:PackGroups>
                    </cmn:OrderItemContainer>
                </cmn:OrderItemContainers>
            </cmn:OrderItemAssociation>
            <cmn:OrderItemAssociation>
                <cmn:CountryDrugCode type="US_NDC532">54989-142-15</cmn:CountryDrugCode>
                <cmn:PackagingItemCode type="GTIN-14">58136957898142</cmn:PackagingItemCode>
                <cmn:LotNumber>125</cmn:LotNumber>
                <cmn:ExpirationDate>2024-02-19</cmn:ExpirationDate>
                <cmn:Quantity>1</cmn:Quantity>
                <cmn:IsSerialized>true</cmn:IsSerialized>
                <cmn:PackagingLevel>EA</cmn:PackagingLevel>
                <cmn:PackGroups>
                    <cmn:PackGroup>
                        <cmn:ContainerQty>1</cmn:ContainerQty>
                        <cmn:NumberOfPacks>1</cmn:NumberOfPacks>
                        <cmn:PackagingItemCode type="GTIN-14">58136957898142</cmn:PackagingItemCode>
                        <cmn:PackagingLevel>EA</cmn:PackagingLevel>
                    </cmn:PackGroup>
                </cmn:PackGroups>
                <cmn:OrderItemContainers>
                    <cmn:OrderItemContainer>
                        <cmn:SerialNumber>015813695789814221663319572870</cmn:SerialNumber>
                        <cmn:PackagingLevel>EA</cmn:PackagingLevel>
                        <cmn:Quantity>1</cmn:Quantity>
                        <cmn:PackGroups>
                            <cmn:PackGroup>
                                <cmn:ContainerQty>1</cmn:ContainerQty>
                                <cmn:NumberOfPacks>1</cmn:NumberOfPacks>
                                <cmn:PackagingItemCode type="GTIN-14">58136957898142</cmn:PackagingItemCode>
                                <cmn:PackagingLevel>EA</cmn:PackagingLevel>
                            </cmn:PackGroup>
                        </cmn:PackGroups>
                    </cmn:OrderItemContainer>
                </cmn:OrderItemContainers>
            </cmn:OrderItemAssociation>
        </cmn:OrderItemAssociations>
    </sit:MessageBody>
</sit:SITReceiptInformationUpdate>