Shipment Information Update (XML) API

Smart Inventory Tracker Owners receive this asynchronous outbound message from TraceLink when a warehouse operator completes a shipment. 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 Shipment event workflow and set the message to be delivered automatically in the Transaction Delivery Rules in Company Administration to receive this message.

Smart Inventory Tracker sends this message to the Owner's ERP system or WMS only when the delivery number already exists in Serialized Operations Manager and is shipped, rather than just saved.

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

Body guidelines

Element Occurs
Length		 Type

Description
sit:SITShipmentInformationUpdate [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 shipment information message details.
    cmn:DeliveryNumber [1...1]
[1/*]		 String Required. The unique identifier for the shipment.
    cmn:SalesDistributionType [1...1]
[1/*]		 String

Required. The type of sale or transfer. 

Valid values:

  • EXPORTRETURN – A shipment of goods returned to the supplier, shipped from one country to another.
  • EXPORTSALE – A sale and distribution made from one country to another.
  • EXPORTTRANSFER – A transfer within a company or with a Partner, such as 3PL, CMO, or contract packager, made from one country to another.
  • INCOUNTRYRETURN – A shipment of goods returned to the supplier, shipped within the same country.
  • INCOUNTRYSALE – A sale and distribution made within the same country.
  • INCOUNTRYTRANSFER – A transfer within a company or with a Partner, such as 3PL, CMO, or contract packager, occurring within the same country.
    cmn:TransactionIdentifiers [1...1]
[–]		 – Required. List of transaction identifiers associated with the shipment.
      cmn:TransactionIdentifier [1...*]

[1/*]

 String Required. The shipment'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:DeliveryInspection [0...1]
[0/*]		 String

The inspection status of the physical delivery against the delivery documentation.

Valid values:

  • NOTINSPECTED – The contents of the delivery have not been inspected.

  • PASSED – The contents of the delivery have been inspected and match the associated documentation.
  • FAILED – The contents of the delivery have been inspected and do not match the associated documentation.
      cmn:DeliveryInspectionDate [0...1]
[0/*]		 Date The date of the physical delivery inspection against the delivery documentation.
      cmn:DeliveryInspectionNote [0...1]
[0/*]		 String Comments about the physical delivery inspection against the delivery documentation.
      cmn:AggregationInspection [0...1]
[0/*]		 String

The inspection status of the aggregation hierarchy of the container.

Valid values:

  • VERIFIED – The aggregation hierarchy of the delivery has been scanned down to the each level.
  • UNVERIFIED – Only the top-level (e.g. pallet) aggregation hierarchy of the delivery has been scanned, and the remaining aggregation levels are unknown to TraceLink.
  • IMPLIED – The entire aggregation hierarchy for the delivery is known to TraceLink, but only the top level (e.g. pallet) has been scanned. The lower aggregation levels have been provided previously (e.g. in an aggregation or shipment).
      cmn:CarrierInfo [0...*]
[–] 		 – The full business information associated with the carrier responsible for delivering the shipment. cmn:CarrierInfo contains an XML Choice element that governs whether master data lookup will be used to populate the address elements. The choice elements allow only one of the element sets contained in the choice declaration to be present within the containing element.
        cmn:CarrierBusinessPartyInfo [0...1]
[–]		 – Conditionally required if cmn:CarrierBusinessPartyLookupId is not populated. This is Option 2 for cmn:CarrierInfo option. This element contains the full business information associated with the transportation carrier business entity.
          cmn:BusinessId [1...*]
[1/*]
 String

Required. Indicates the identifier associated with either the sold from business entity or the sold to business entity. This value is mandatory for regulatory reporting. Different countries require different values as noted below:

Country requirements:
  • Argentina: Both the GLN and the CUIT number are mandatory.

  • For companies physically located in Brazil: Provide the CNPJ number.

  • China: The company identifier registered with China CFDA.
  • India: Populate with IN_COMPANY_ID or IN_LOCATION_ID. If not available, populate with IN_PAN.
  • South Korea: Populate with KR_BUS_REG_NUMBER.
  • Turkey: The GLN.
  • US: A GLN, DEA, or HIN identifier.
            @type [1...1]
[1/*] 		 String

Required. The business id type.

  • AR_CUIT – 11-character Argentina Tax ID. Format is 00-00000000-0 (e.g. 33-56899856-8). Cannot be set as the Primary Identifier.
  • AM_TIN – 8-character Armenia Taxpayer Identification Number (e.g. 53663456). Cannot be set as the Primary Identifier.
  • BR_CNES – Brazil National Registry of Health Facilities Number (e.g. 3868249).
  • BR_CNPJ – 14-character Brazil Tax/Legal Entity ID. Format is 00.000.000/0001-00 (e.g. 71.116.165/0001-71).
  • BR_CPF – 11-character Brazil Individual Taxpayer Registration Number. Format is 000.000.000-00 (e.g. 605.085.153-00). The first 8 digits identify the company, the next 4 digits identify the branch or subsidiary ("0001" designates the headquarters), and the last 2 are check digits.
  • BR_PROF_REG – Brazil Professional Registration Number (e.g. CRODFCD9952).
  • BY_TIN – 9-character Belarus Taxpayer Identification Number (e.g. 004893223). Cannot be set as the Primary Identifier.
  • CN_CHINA_ID – Alphanumeric China identifier (e.g. 352J685B548N).
  • CN_FOREIGN_MAH – China Foreign MAH ID (e.g. 0678645).
  • CN_FOREIGN_MFR – China Foreign Manufacturer ID (e.g. 665S55D).
  • CN_USCID – China Unified Social Credit Identifier (e.g. 9771221453).
  • COMPANYID – Alphanumeric internal company identifier (e.g. KENDALL).
  • COMPANYSITEID – Alphanumeric internal location, plant, or site identifier (e.g. 465MEMPHIS).
  • DE_IFA_REG_NUM – 6-character Informationsstelle für Arzneispezialitäten (IFA) Registration Number (e.g. 548726). Cannot be set as the Primary Identifier.
  • DEA – 9-character US Drug Enforcement Agency Number (e.g. F92547851).
  • DUNS – 9-character Dunn and Bradstreet Number (e.g. 82-759-6961).
  • DUNS4 – 13-character Dunn and Bradstreet Number, which includes a 4 digit extension (e.g. 82-759-6961-KP89).
  • GCP – 6- to 12-character GS1 Global Company Prefix (e.g. 8856277).
  • GLN – 13-character Global Location Number (e.g. 8856277233311). To send and receive EPCIS messages, companies and locations need a GLN.
  • HIN – Maximum 9-alphanumeric character Health Industry Number assigned by HIBCC (e.g. 214Z65H00).
  • ID_BPOM_FACILITYID – Indonesia Facility ID (e.g. 45764574).
  • IN_COMPANY_ID – India Company ID (e.g. 5423695784236).
  • IN_GSTN – India Goods and Services Tax ID (e.g. 55876215).
  • IN_IEC – 10-character India Importer Exporter Code (e.g. 0255411222). Cannot be set as the Primary Identifier.
  • IN_LOCATION_ID – India Location ID (e.g. 65874532).
  • IN_MFR – India Manufacturing Code (e.g. 00552101).
  • IN_MRCH – India Merchant Exporter Code (e.g. 601227644).
  • IN_PAN – 10-character India Permanent Account Number. The first five characters are letters, next four numbers, last character is a letter (e.g. AFZPK7190K). Cannot be set as the Primary Identifier.
  • IN_TIN – 11-character India Taxpayer Identification Number (e.g. 95684444523). Cannot be set as the Primary Identifier.
  • KG_TIN – 14-character Kyrgyzstan Taxpayer Identification Number (e.g. 56200044505998). Cannot be set as the Primary Identifier.
  • KR_BUS_REG_NUMBER – 10-character South Korea Corporate Registration Number. Format is xxx-xx-xxxxx (e.g. 324-84-22451).
  • KR_PROVIDER_CODE – 8-character South Korea Provider Code (e.g. 45632196).
  • KZ_BIN – 12-character Kazakhstan Business Identification Number (e.g. 220110668755). Cannot be set as the Primary Identifier.
  • RU_ACCOUNT_NUMBER – 14- to 36-character Russia Account Number (e.g. 19527400000001 or 19406412-0001-000a-0000-000000000022). Cannot be set as the Primary Identifier.
  • RU_INN_FOREIGN_ENTITY – 10-character Russia Foreign Business Taxpayer Identification Number (e.g. 7744000912). Cannot be set as the Primary Identifier. Only one of the following identifier types can be assigned to an entity: RU - INN Local, RU - IN Foreign, and RU - INN Individual.
  • RU_INN_INDIV – 12-character Russia Individual Taxpayer Identification Number (e.g. 123456789001). Cannot be set as the Primary Identifier. Only one of the following identifier types can be assigned to an entity: RU - INN Local, RU - IN Foreign, and RU - INN Individual.
  • RU_INN_KPP_TAX_CODE – 9-character Russia KPP Registration Code (e.g. 771301001). Cannot be set as the Primary Identifier.
  • RU_INN_LOCAL_ENTITY – 10-character Russia Local Business Taxpayer Identification Number (e.g. 7728640746). Cannot be set as the Primary Identifier. Only one of the following identifier types can be assigned to an entity: RU - INN Local, RU - IN Foreign, and RU - INN Individual.
  • SGLN – 15-character SGLN format representation of Global Location Number:
    • Format for company entities is [CompanyPrefix].[LocationRef].0 or [CompanyPrefix]..0. The LocationRef segment is optional. If the LocationRef is included, the first two segments contain only digits separated by the dot, and must be 13 characters in total. If the LocationRef is not included, then the first segment must be 12 digits, followed by two dot seperators. The third segment should always be the digit 0. For example, 539885451928..0 or urn:epc:id:sgln:0614141.12345.0.
    • Format for location entities is [CompanyPrefix].[LocationRef].[sub-location identifier] or [CompanyPrefix]..[sub-location identifier].The LocationRef segment is optional. If the LocationRef is included, the first two segments contain only digits separated by the dot, and must be 13 characters in total. If the LocationRef is not included, then the first segment must be 12 digits, followed by two dot seperators. The third segment is always alphanumeric and can be any length, with at least one character in it preceded by the dot separator. For example, 8856277.23331.6 or 539885451928..11.
  • TRACELINK_ID – TraceLink Identification Number (e.g. KENDALLPHARM).
  • UZ_TIN – 9-character Uzbekistan Taxpayer Identification Number (e.g. 000181244). Cannot be set as the Primary Identifier.
Only one of the following values may be used per message:
  • RU_INN_FOREIGN_ENTITY
  • RU_INN_INDIV
  • RU_INN_LOCAL_ENTITY
          cmn:BusinessClassification [0...1]
[0/*] 		 String

This field classifies the business type of the TraceLink customer or trading partner.

Valid values:

  • CARRYING_FORWARDING_AGENT - Carrying Forwarding Agent.
  • CHEMIST - Chemist
  • DISTRIBUTOR - Business is a distributor of pharmaceuticals.
  • EXPORTER - Exporter
  • FINANCER - Business is a financier/payer.
  • HEALTHCARE - Business is a healthcare facility.
  • IMPORTER - Importer
  • LOGISTICS - Business is a third party logistics provider.
  • MANUFACTURER - Business is a manufacturer of pharmaceuticals.
  • PACKAGER - Packager
  • PHARMACY - Business is a pharmacy.
  • RETURNSPROCESSOR - Returns Processor.
  • STOCKIST - Stockist
  • WHOLESALER - Business is a wholesaler of pharmaceuticals.
Do not populate for Brazil.
          cmn:BusinessInfo [0...1]
[–]  
 – Conditionally required for Brazil. Populated with the business name and address of the transportation carrier business entity.
            cmn:BusinessName [1...1]
[1/*] 		 String Required. The name of the receiving business entity.
            cmn:Street1 [1...1]
[1/*] 		 String Required. The first line of the street address for the company indicated in cmn:BusinessName.
            cmn:Street2 [0...1]
[0/*] 		 String The second line of the street address for the company indicated in cmn:BusinessName.
            cmn:City [1...1]

 


 String Required. The city of the company indicated in cmn:BusinessName.
            cmn:Village [0...1]
[0/*] 
 String Name of the village in which the company is located.
            cmn:HouseNumber [0...1]
[0/*] 
 String Building, house, or unit number of the company. House numbers are usually only separated from the street address in China. For all addresses outside of China, continue to enter the building, house, or unit number in Street1.
            cmn:Township [0...1]
[0/*] 
 String Name of the township in which the company is located.
            cmn:District [0...1]
[0/*] 
 String Conditionally required for India. District Code only for India. Must be a 3-digit numeric code.
            cmn:StateOrRegion [1...1]
[1/*] 
 String Required. Two-letter abbreviation specified in ISO 3166-2:1998 country subdivision code. The state, province, or region of the company specified in cmn:BusinessName.
            cmn:PostalCode [1...1]
[1/*] 
 String Required. The zip or other postal code of the company indicated in cmn:BusinessName.
            cmn:Country [1...1]
[1/*]  
 String Required. Standard two-letter abbreviation specified in ISO 3166-1alpha-2:1997 country code. The country code of the company indicated in cmn:BusinessName.
  • AED – UAE Dirham.
  • AFN – Afghani.
  • ALL – Lek.
  • AMD – Armenian Dram.
  • ANG – Netherlands Antillean Guilder.
  • AOA – Kwanza.
  • ARS – Argentine Peso.
  • AUD – Australian Dollar.
  • AWG – Aruban Florin.
  • AZN – Azerbaijanian Manat.
  • BAM – Convertible Mark.
  • BBD – Barbados Dollar.
  • BDT – Taka.
  • BGN – Bulgarian Lev.
  • BHD – Bahraini Dinar.
  • BIF – Burundi Franc.
  • BMD – Bermudian Dollar.
  • BND – Brunei Dollar.
  • BOB – Boliviano.
  • BRL – Brazilian Real.
  • BSD – Bahamian Dollar.
  • BTN – Ngultrum.
  • BWP – Pula.
  • BYR – Belarussian Ruble.
  • BZD – Belize Dollar.
  • CAD – Canadian Dollar.
  • CDF – Congolese Franc.
  • CHF – Swiss Franc.
  • CLP – Chilean Peso.
  • CNY – Yuan Renminbi.
  • COP – Colombian Peso.
  • CRC – Costa Rican Colon.
  • CUC – Peso Convertible.
  • CUP – Cuban Peso.
  • CVE – Cabo Verde Escudo.
  • CZK – Czech Koruna.
  • DJF – Djibouti Franc.
  • DKK – Danish Krone.
  • DOP – Dominican Peso.
  • DZD – Algerian Dinar.
  • EGP – Egyptian Pound.
  • ERN – Nakfa.
  • ETB – Ethiopian Birr.
  • EUR – Euro.
  • FJD – Fiji Dollar.
  • FKP – Falkland Islands Pound.
  • GBP – Pound Sterling.
  • GEL – Lari.
  • GHS – Ghana Cedi.
  • GIP – Gibraltar Pound.
  • GMD – Dalasi.
  • GNF – Guinea Franc.
  • GTQ – Quetzal.
  • GYD – Guyana Dollar.
  • HKD – Hong Kong Dollar.
  • HNL – Lempira.
  • HRK – Kuna.
  • HTG – Gourde.
  • HUF – Forint.
  • IDR – Rupiah.
  • ILS – New Israeli Sheqel.
  • INR – Indian Rupee.
  • IQD – Iraqi Dinar.
  • IRR – Iranian Rial.
  • ISK – Iceland Krona.
  • JMD – Jamaican Dollar.
  • JOD – Jordanian Dinar.
  • JPY – Yen.
  • KES – Kenyan Shilling.
  • KGS – Som.
  • KHR – Riel.
  • KMF – Comoro Franc.
  • KPW – North Korean Won.
  • KRW – Won.
  • KWD – Kuwaiti Dinar.
  • KYD – Cayman Islands Dollar.
  • KZT – Tenge.
  • LAK – Kip.
  • LBP – Lebanese Pound.
  • LKR – Sri Lanka Rupee.
  • LRD – Liberian Dollar.
  • LSL – Loti.
  • LYD – Libyan Dinar.
  • MAD – Moroccan Dirham.
  • MDL – Moldovan Leu.
  • MGA – Malagasy Ariary.
  • MKD – Denar.
  • MMK – Kyat.
  • MNT – Tugrik.
  • MOP – Pataca.
  • MRO – Ouguiya.
  • MUR – Mauritius Rupee.
  • MVR – Rufiyaa.
  • MWK – Kwacha.
  • MXN – Mexican Peso.
  • MYR – Malaysian Ringgit.
  • MZN – Mozambique Metical.
  • NAD – Namibia Dollar.
  • NGN – Naira.
  • NIO – Cordoba Oro.
  • NOK – Norwegian Krone.
  • NPR – Nepalese Rupee.
  • NZD – New Zealand Dollar.
  • OMR – Rial Omani.
  • PAB – Balboa.
  • PEN – Nuevo Sol.
  • PGK – Kina.
  • PHP – Philippine Peso.
  • PKR – Pakistan Rupee.
  • PLN – Zloty.
  • PYG – Guarani.
  • QAR – Qatari Rial.
  • RON – Romanian Leu.
  • RSD – Serbian Dinar.
  • RUB – Russian Ruble.
  • RWF – Rwanda Franc.
  • SAR – Saudi Riyal.
  • SBD – Solomon Islands Dollar.
  • SCR – Seychelles Rupee.
  • SDG – Sudanese Pound.
  • SEK – Swedish Krona.
  • SGD – Singapore Dollar.
  • SHP – Saint Helena Pound.
  • SLL – Leone.
  • SOS – Somali Shilling.
  • SRD – Surinam Dollar.
  • SSP – South Sudanese Pound.
  • STD – Dobra.
  • SVC – El Salvador Colon.
  • SYP – Syrian Pound.
  • SZL – Lilangeni.
  • THB – Baht.
  • TJS – Somoni.
  • TMT – Turkmenistan New Manat.
  • TND – Tunisian Dinar.
  • TOP – Pa'anga.
  • TRY – Turkish Lira.
  • TTD – Trinidad and Tobago Dollar.
  • TWD – New Taiwan Dollar.
  • TZS – Tanzanian Shilling.
  • UAH – Hryvnia.
  • UGX – Uganda Shilling.
  • USD – US Dollar.
  • UYU – Peso Uruguayo.
  • UZS – Uzbekistan Sum.
  • VEF – Bolivar.
  • VND – Dong.
  • VUV – Vatu.
  • WST – Tala.
  • XAF – CFA Franc BEAC.
  • XCD – East Caribbean Dollar.
  • XOF – CFA Franc BCEAO.
  • XPF – CFP Franc.
  • YER – Yemeni Rial.
  • ZAR – Rand.
  • ZMW – Zambian Kwacha.
  • ZWL – Zimbabwe Dollar.

 
            cmn:CorporateFax [0...1]
[0/*] 
 String Company fax number.
            cmn:AddressObjectGUID [0...1]
[0/*] 
 String

The global identifier assigned by the Russian Federation Information Address System (FIAS). Maximum 36 characters, using the digits 0-9 and letters A-F.
            cmn:HouseGUID [0...1]
[0/*] 
 String

The global House identifier assigned by the Russian Federation Information Address System (FIAS). Maximum 36 characters, using the digits 0-9 and letters A-F.
            cmn:TaxRegistrationCode [0...1]
[0/*] 
 String The code used to identify this entity for tax or other legal reporting purposes (e.g. a Russia KPP Registration Code).
            cmn:PremisesCode [0...1]
[0/*] 
 String Identifier representing a physical area within the company location (e.g. a location's second floor).
    cmn:OrderItemAssociations [1...1]
[–]		 – Required. List of the unique product, lot, and quantity combinations in the shipment. Taken from the order items in Serialized Operations Manager and includes any updates made to the shipment 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 shipment.
Might be less than the order item quantity entered in Serialized Operations Manager if short shipment 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:SalesDistributionType Valid sales 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:SITShipmentInformationUpdate xmlns:sit="urn:tracelink:mapper:sl:smart_inventory_tracker" xmlns:cmn="urn:tracelink:mapper:sl:commontypes">
    <sit:ControlFileHeader>
        <cmn:FileSenderNumber>8888882028655</cmn:FileSenderNumber>
        <cmn:FileReceiverNumber>8888882028677</cmn:FileReceiverNumber>
        <cmn:FileControlNumber>20190728063132</cmn:FileControlNumber>
        <cmn:FileDate>2019-07-28</cmn:FileDate>
        <cmn:FileTime>06:52:45Z</cmn:FileTime>
    </sit:ControlFileHeader>
    <sit:MessageBody>
        <cmn:DeliveryNumber>80013145</cmn:DeliveryNumber>
        <cmn:SalesDistributionType>EXPORTSALE</cmn:SalesDistributionType>
        <cmn:TransactionIdentifiers>
            <cmn:TransactionIdentifier type="PO">DG-20031211-1</cmn:TransactionIdentifier>
            <cmn:TransactionIdentifier type="SALESORDER">10054</cmn:TransactionIdentifier>
        </cmn:TransactionIdentifiers>
        <cmn:OrderItemAssociations>
            <cmn:OrderItemAssociation>
                <cmn:InternalMaterialCode>1400-315</cmn:InternalMaterialCode>
                <cmn:PackagingItemCode type="GTIN-14">00882026030229</cmn:PackagingItemCode>
                <cmn:LotNumber>A12345</cmn:LotNumber>
                <cmn:ExpirationDate>2021-08-15</cmn:ExpirationDate>
                <cmn:Quantity>100</cmn:Quantity>
                <cmn:IsSerialized>true</cmn:IsSerialized>
                <cmn:PackagingLevel>EA</cmn:PackagingLevel>
                <cmn:PackGroups>
                    <cmn:PackGroup>
                        <cmn:ContainerQty>100</cmn:ContainerQty>
                        <cmn:NumberOfPacks>5</cmn:NumberOfPacks>
                        <cmn:PackagingItemCode type="GTIN-14">00882026030229</cmn:PackagingItemCode>
                        <cmn:PackagingLevel>EA</cmn:PackagingLevel>
                    </cmn:PackGroup>
                </cmn:PackGroups>
                <cmn:OrderItemContainers>
                    <cmn:OrderItemContainer>
                        <cmn:SerialNumber>015088202501033321100000060001</cmn:SerialNumber>
                        <cmn:PackagingLevel>EA</cmn:PackagingLevel>
                        <cmn:Quantity>100</cmn:Quantity>
                        <cmn:PackGroups>
                            <cmn:PackGroup>
                                <cmn:ContainerQty>100</cmn:ContainerQty>
                                <cmn:NumberOfPacks>5</cmn:NumberOfPacks>
                                <cmn:PackagingItemCode type="GTIN-14">00882026030229</cmn:PackagingItemCode>
                                <cmn:PackagingLevel>EA</cmn:PackagingLevel>
                            </cmn:PackGroup>
                        </cmn:PackGroups>
                    </cmn:OrderItemContainer>
                </cmn:OrderItemContainers>
            </cmn:OrderItemAssociation>
        </cmn:OrderItemAssociations>
    </sit:MessageBody>
</sit:SITShipmentInformationUpdate>