Shipment Notification Guidelines

See How To Use this Guide before interpreting the guidelines below.

Message Types:

  • KRGR_SHIP_NOTICE
  • RU_SHIPMENT_NOTIFICATION

Info Exchange Display Name: Shipment Notice

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
Length
Type Description
gr:GRShipmentNotificationMessage [1...1]
[-]
-

Required. The root data element.

  gr:ControlFileHeader [1...1]
[-]
-

Required. The Header fields.

    cmn:FileSenderNumber [1...1]
[1/*]
String

Required. Identifies the sender of the message. When the sender is the TraceLink application owner, this value is used in the link key to identify the link to the application. *1

    cmn:FileReceiverNumber [1...1]
[1/*]
String

Required. Identifies the receiver of the message. When receiver is the TraceLink application owner, this value used in the link key to identify the link to the application. *2

    cmn:FileControlNumber [1...1]
[1/*]
String

Required. The unique file identifier assigned by the sender. *3

    cmn:FileDate [1...1]
[10/10]
Date

Required. The date file created in XML date YYYY-MM-DD. *4

    cmn:FileTime [1...1]
[8/8]
Time

Required. The time file generated in XML HH:MM:SSZ format. *5

  gr:MessageBody [1...1]
[-]
-

Required. Informs the receiving party of the information submitted by the supplier to government reporting when the supplier has processed the shipment of the goods. The shipment notification provides information for each product that is part of the shipment.

The file can contain information about serialized or non-serialized products. Products are grouped by Product Code/Lot/Quantity/Unit Price or Product Code/Quantity/Unit Price if a non-serialized product does not have a lot number. Serial numbers for serialized product are recorded in the picked items or serialized aggregation groups. The serialized aggregation contains the full packing hierarchy for the product.

    cmn:DeliveryNumber [0...1]
[0/*]
String

Required. Supplier-provided delivery number if included in the comments field of the Shipment Notice to KPIS. If not provided, TraceLink assigns a delivery number unique to the supplier of the shipment in the following format: <Supplier Business Registration Number>-<Supply Date><nnnnnn> is the sequence number of the supplier's KPIS Shipment Notice. *6

    gr:OrderDetails [0...1]
[-]
-

Conditionally required. The gr.OrderDetails group communicates the business transaction identifier and date, order item pick list, and sender and recipient information. This element is required before the delivery complete flag is set. However, it can be communicated at any time (e.g. with, before, or after the picked serial numbers have been communicated).

      cmn:TransactionIdentifier [0...*]
[0/*]
String

The transaction identifier associated with the picked or aggregated serial numbers. *7

        @type [1...1]
[0/*]
String

Required. The transaction identifier type using the supported enumeration values.

See the TransactionId enumeration list for valid values.

      cmn:TransactionDate [1...1]
[1/*]
Date

Required. The transaction date. The invoice date for the sale of product in XML date format YYYY-MM-DD. *8

      cmn:TransactionTime [0...1]
[0/*]
Time

The time of the transaction in XML HH:MM:SS format. *9

      cmn:ShipToCountryCode [0...1]
[2/2]
String

The ISO country code for ship to country. *10

See the ISOCountryCode enumeration list for valid values.

      cmn:ShipFromCountryCode [0...1]
[2/2]
String

The ISO country code for ship from country. *11

See the ISOCountryCode enumeration list for valid values.

      cmn:SalesDistributionType [1...1]
[1/*]
String

Required. The cmn:SalesDistributionType value is referenced to advise regulatory reporting of exportation, if it is required for the specified country market. Setting this value alone does not trigger regulatory reporting. Actual triggering of regulatory reporting is governed by customer administrative configuration in the TraceLink application. To set this value, compare the ship from country with the ship to country.

  • Set to INCOUNTRYSALE if ship from country = ship to country (indicates a sale within the same country).
  • Set to EXPORTSALE if ship from country <> ship to country (indicates a sale that is an export to another country).
  • EXPORT value is not used.

See the SalesDistType enumeration list for valid values.

      cmn:SupplyType [0...1]
[0/*]
String

Conditionally required if ShipFromCountryCode = KR. Identifies the type of supply performed using one of the permitted values, all values except for Collection apply. Valid values:

  • Donation
  • MedicalCareDistribution
  • MilitaryDistribution
  • PatientDistribution
  • ProviderDistribution
  • SafetyLifeReserves
  • SampleDistribution
  • SpecialMedicalCareDistribution

See the SupplyType enumeration list for valid values.

      cmn:ContractType [0...1]
[0/*]
String

Conditionally required if ShipFromCountryCode = KR. Identifies the type of contract for the sale of goods using one of the permitted values.

See the ContractType enumeration list for valid values.

      cmn:Comments [0...1]
[0/*]
String

Optional remarks or comments associated with delivery. *12

      cmn:DropShipment [0...1]
[0/*]
Boolean

Indicates if the shipment is a drop shipment. *13

      gr:ItemList [0...*]
[-]
-

Item list for the shipment.

        gr:ItemDetails [1...*]
[-]
-

Required. The gr:ItemDetails details list group communicates expected pick quantities or serialized packing aggregation hierarchies for each item code at the EACH (unit) level.

          cmn:InternalMaterialCode [0...1]
[1/*]
String

Conditionally required if cmn:PackagingItemCode is not present. The product identifier using the internal material number configured in Product Master Data. *14

          cmn:CountryDrugCode [0...1]
[1/*]
String

The national drug code for the commissioned item (e.g. NDC number for US products). *15

            @type [0...1]
[0/*]
String

Required. The national drug code type using the supported enumeration values and any formatting instructions provided.

See the CountryDrugCode enumeration list for valid values.

          cmn:PackagingItemCode [0...1]
[0/*]
String

Identifies the product using the packaging-level item code configured in Product Master Data. *16

            @type [0...1]
[1/*]
String

Required. The product code type for the packaging item code using the supported enumeration values.

See the ItemCode enumeration list for valid values.

          cmn:LotNumber [0...1]
[0/*]
String

The lot or batch code for the items to be picked (if available) in an alphanumeric string. *17

          cmn:ExpirationDate [0...1]
[1/*]
Date

The expiration date for the sold product in XML date format YYYY-MM-DD. *18

          cmn:Quantity [1...1]
[1/*]
Integer

Required. Number of products sold, in eaches. *19

          cmn:UnitPrice [0...1]
[-]
Decimal

The unit price of item. *20

            @currencyCode [1...1]
[0/3]
String

Required. Currency ISO code using ISO 4217-2015 format. *21

See the ISOCurrency enumeration list for valid values.

          cmn:IsSerialized [0...1]
[0/*]
Boolean

Indicates if the item is serialized or not. If omitted, defaults value to true, indicating the item is serialized. *22

      cmn:SenderInfo [1...1]
[-]
-

Required. The identifier and full address information about the supply chain partner that is sending the shipment.

        cmn:FromBusinessPartyInfo [1...1]
[-]
-

Required. The full business identifier and address information associated with the sold from business entity.

          cmn:BusinessId [1...1]
[1/*]
String

Required. The identifier associated with the sold from or transfer from business entity. This value is required for regulatory reporting. Different countries require different values as noted below. *23

  • Argentina: Provide both the GLN and the CUIT number associated with the sold from party.
  • Brazil: Provide the CNPJ number associated with the sold from party.
  • China: Provide the company identifier registered with China SFDA used to identify the sold from party. This is the identifier provided in the China SFDA application master data and must match up. Use the appropriate qualifier code to identify this value.
  • Korea: Provide the KR_BUS_REG_NUMBER or KR_PROVIDER_CODE.
  • Turkey: Provide the GLN associated with the sold from party.
  • US: Provide the GLN, DEA, or HIN identifier associated with the sold from party.
            @type [1...1]
[0/*]
String

Required. The type of the business identifier. One of the supported enumerations must be provided.

See the BusinessAndLocationId enumeration list for valid values.

          cmn:BusinessClassification [0...1]
[0/*]
String

Conditionally required for Argentina. Identifies the type of business for the supplier. Provide the business classification of the sold from party using one of the provided enumerations.

See the BusinessClassification enumeration list for valid values.

          cmn:BusinessInfo [0...1]
[-]
-

The business address of the trade partner.

            cmn:BusinessName [1...1]
[1/*]
String

Required. The business name of the trade partner. *24

            cmn:Street1 [1...1]
[1/*]
String

Required. The first line of the street address. *25

            cmn:Street2 [0...1]
[0/*]
String

The second line of the street address.

            cmn:City [1...1]
[1/*]
String

Required. The city address. *26

            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. The state, province, or region using the standard two-letter abbreviation specified in ISO 3166-2:1998 country subdivision code. *27

            cmn:PostalCode [1...1]
[1/*]
String

Required. The ZIP or other postal code. *28

            cmn:Country [0...1]
[0/*]
String

The country code using the standard two-letter abbreviation specified in ISO 3166-1alpha-2:1997 country code. *29

See the ISOCountryCode enumeration list for valid values.

        cmn:ShipFromLocationInfo [0...1]
[-]
-

The full business address information associated with the ship from location is provided directly.

          cmn:FacilityId [1...1]
[1/*]
String

Required. The ship from location identifier. *30

            @type [1...1]
[1/*]
String

Required. The type of the cmn:FacilityId identifier.

See the BusinessAndLocationId enumeration list for valid values.

          cmn:LocationInfo [0...1]
[-]
 

The business name and address of the ship from location.

            cmn:BusinessName [1...1]
[1/*]
String

Required. The business name of the trade partner.

            cmn:Street1 [1...1]
[1/*]
String

Required. The first line of the street address.

            cmn:Street2 [0...1]
[0/*]
String

The second line of the street address.

            cmn:City [1...1]
[1/*]
String

Required. The city address.

            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. The state, province, or region using the standard two-letter abbreviation specified in ISO 3166-2:1998 country subdivision code.

            cmn:PostalCode [1...1]
[1/*]
String

Required. The ZIP or other postal code.

            cmn:Country [0...1]
[0/*]
String

The country code using the standard two-letter abbreviation specified in ISO 3166-1alpha-2:1997 country code.

See the ISOCountryCode enumeration list for valid values.

      cmn:ReceiverInfo [0...1]
[-]
-

Name and address information of company receiving goods. Group is not present if Supply Type is Export or Military.

        cmn:ToBusinessPartyInfo [0...1]
[-]
-

The full business identifier and address information associated with the sold to business.

          cmn:BusinessId [1...*]
[1/*]
String

Required. The identifier associated with the sold to or transfer to business entity. This value is required for regulatory reporting. Different countries require different values as noted below.

  • Argentina: Provide both the GLN and the CUIT number associated with the sold to party.
  • China: Provide the company identifier registered with China SFDA used to identify the sold to party. This is the identifier provided in the China SFDA application master data and must match up. Use the appropriate qualifier code to identify this value.
  • S. Korea: Populate with KR_BUS_REG_NUMBER or KR_PROVIDER_CODE associated with the sold to party.
  • Turkey: Provide the GLN associated with the sold to party.
  • US: Provide the GLN, DEA, or HIN identifier associated with the sold to party.
            @type [1...1]
[1/*]
String

Required. The type of the business identifier. One of the supported enumerations must be provided.

See the BusinessAndLocationId enumeration list for valid values.

          cmn:BusinessClassification [0...1]
[0/*]
String

The type of business. Not mapped for the receiver.

          cmn:BusinessInfo [0...1]
[-]
-

The business name and address of the sold to business entity.

            cmn:BusinessName [1...1]
[1/*]
String

Required. The business name of the trade partner ship-to location.

            cmn:Street1 [1...1]
[1/*]
String

Required. The first line of the street address.

            cmn:Street2 [0...1]
[0/*]
String

The second line of the street address. *31

            cmn:City [1...1]
[1/*]
String

Required. The city.

            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. The state, province, or region using the standard two-letter abbreviation specified in ISO 3166-2:1998 country subdivision code.

            cmn:PostalCode [1...1]
[1/*]
String

Required. The ZIP or other postal code.

            cmn:Country [0...1]
[0/*]
String

The country code using the standard two-letter abbreviation specified in ISO 3166-1alpha-2:1997 country code.

See the ISOCountryCode enumeration list for valid values.

        cmn:ShipToLocationInfo [0...1]
[-]
-

The full business address information associated with the ship to location is provided directly.

          cmn:FacilityId [1...1]
[1/*]
String

Required. The ship to location identifier.

            @type [1...1]
[1/*]
String

Required. The type of the cmn:FacilityId identifier. One of the supported enumerations must be provided.

See the BusinessAndLocationId enumeration list for valid values.

          cmn:LocationInfo [0...1]
[-]
 

Conditionally required for US. Populated with the business name and address of the ship to location.

            cmn:BusinessName [1...1]
[1/*]
String

Required. The business name of the trade partner.

            cmn:Street1 [1...1]
[1/*]
String

Required. The first line of the street address.

            cmn:Street2 [0...1]
[0/*]
String

The second line of the street address.

            cmn:City [1...1]
[1/*]
String

Required. The city.

            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. The state, province, or region using the standard two-letter abbreviation specified in ISO 3166-2:1998 country subdivision code.

            cmn:PostalCode [1...1]
[1/*]
String

Required. The ZIP or other postal code.

            cmn:Country [0...1]
[0/*]
String

The country code using the standard two-letter abbreviation specified in ISO 3166-1alpha-2:1997 country code.

See the ISOCountryCode enumeration list for valid values.

      cmn:CarrierInfo [0...1]
[-]
-

Name and address information of the transport carrier partner.

        cmn:CarrierBusinessPartyInfo [0...1]
[-]
-

The full business identifier and address information associated with the carrier business entity is provided.

          cmn:BusinessId [1...*]
[1/*]
String

Required. The Receiver South Korean Business Registration Number (10-digit number without hyphen separators).

For S. Korea, populate with the KR_BUS_REG_NUMBER or KR_PROVIDER_CODE associated with the sold to party. Both are required.
            @type [1...1]
[1/*]
String

Required. The type of the BusinessId identifier.

For S. Korea, valid values are KR_BUS_REG_NUBMER and KR_PROVIDER_CODE.

See the BusinessAndLocationId enumeration list for valid values.

          cmn:BusinessClassification [0...1]
[0/*]
String

Identifies the type of business. Not used for receiver.

          cmn:BusinessInfo [0...1]
[-]
-

Populated with the business name and address of the carrier business entity.

            cmn:BusinessName [1...1]
[1/*]
String

Required. The business name of the trade partner location.

            cmn:Street1 [1...1]
[1/*]
String

Required. The first line of the street address.

            cmn:Street2 [0...1]
[0/*]
String

The second line of the street address.

            cmn:City [1...1]
[1/*]
String

Required. The city.

            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. The state, province, or region using the standard two-letter abbreviation specified in ISO 3166-2:1998 country subdivision code.

            cmn:PostalCode [1...1]
[1/*]
String

Required. The ZIP or other postal code.

            cmn:Country [0...1]
[0/*]
String

The country code using the standard two-letter abbreviation specified in ISO 3166-1alpha-2:1997 country code.

See the ISOCountryCode enumeration list for valid values.

    cmn:NumberList [0...1]
[0/*]
String

The list of serial numbers for the items packed into the parent serial number.

      cmn:Serial [1...*]
[0/*]
String

Required. Serial number expressed in the GS1 Application Identifier format with or without parentheses for the AI keys. *32

AI (01)(21) formatted serial number for GTINs -or- AI(00) formatted serial number for SSCCs.

Non-GS1 serial numbers (e.g. China) are expressed in native format.
        @companyPrefix [0...1]
[1/*]
String

The GS1 Company Prefix associated with SGTIN or SSCC code. Used in conjunction with Application Identifier number and filter value in the event the serial number needs to be translated into an alternate format for the customer system (e.g. GS1 HEX, GS1 EPC URI or GS1 Tag URI format).

        @format [0...1]
[1/*]
String Attribute that identifies the format of the serial numbers. Valid values:
  • AI(00)
  • AI(01)+AI(21)
  • AI(8003)
  • CN-EDMC
  • GRAI-170
  • GRAI-96
  • SGTIN-198
  • SGTIN-96
  • SSCC-96
        @packedStatus [0...1]
[1/*]
String

The packed status.

    gr:Commissioning [1...*]
[-]
-

Required. Required looping group. Contains commission event detail data for all serial numbers included in the shipment. Each commission event represents all serial numbers that share the same packaging level and packaging item code.

SSCCs are commissioned in their own commission event. Adapter groups commissioned by SSCC, CA, IP, EA based on Packaging Level, Packaging Code (for GTIN) or Company Prefix (for SSCC), and Lot Number (for GTIN).

      cmn:PackagingLevel [1...1]
[1/*]
String

Required. The packaging level of the commissioned item using the supported enumeration values.

See the PackagingLevel enumeration list for valid values.

      cmn:InternalMaterialCode [0...1]
[0/*]
String

Internal material number for the product in the pharmaceutical manufacturer's internal systems, e.g. ERP.

      cmn:CountryDrugCode [0...1]
[1/*]
String

The national drug code for the commissioned item, e.g. NDC number for US products.

        @type [0...1]
[0/*]
String

Required. The national drug code type using the supported enumeration values and any formatting instructions provided.

See the CountryDrugCode enumeration list for valid values.

      cmn:PackagingItemCode [0...1]
[0/*]
String

The product code for the commissioned item, e.g. GTIN-14.

        @type [0...1]
[0/*]
String

Required. The product code type for the packaging item code using the supported enumeration values, e.g. GTIN-14.

See the ItemCode enumeration list for valid values.

      cmn:CountryMarket [0...1]
[0/*]
String

Identifies the target market for commissioned products.

      cmn:LotNumber [0...1]
[0/*]
String

Conditionally required for lots with non-SSCC serial numbers. An error occurs if not provided. The lot or batch code for the products in an alphanumeric string.

      cmn:ExpirationDate [0...1]
[1/*]
Date

Expiration date for product in XML date format YYYY-MM-DD.

      cmn:ManufacturingDate [0...1]
[0/10]
Date

The date of manufacture for the product, in YYYY-MM-DD format.

      cmn:NumberList [0...1]
[-]
-

List of serial numbers for all commissioned products in commissioning group by Packaging Level, Packaging Code (for GTIN) or Company Prefix (for SSCC), and Lot Number (for GTIN).

        cmn:Serial [1...*]
[1/*]
String

Required. Serial number expressed in the GS1 Application Identifier format with or without parentheses for the AI keys.

AI(01)(21) formatted serial number for GTINs or AI(00) formatted serial number for SSCCs.

Non-GS1 serial numbers, e.g. China, are expressed in native format.
          @companyPrefix [0...1]
[1/*]
String

The GS1 Company Prefix associated with an SGTIN or SSCC code. Used in conjunction with Application Identifier number and filter value in the event the serial number needs to be translated into an alternate format for the customer system, e.g. GS1 HEX, GS1 EPC URI or GS1 Tag URI format.

          @format [0...1]
[1/*]
String

Attribute that identifies the format of serial numbers. Valid values:

  • AI(00)
  • AI(01)+AI(21)
  • AI(8003)
  • CN-EDMC
  • GRAI-170
  • GRAI-96
  • SGTIN-198
  • SGTIN-96
  • SSCC-96
          @packedStatus [0...1]
[0/*]
String

Packed status.

    cmn:PackingHierarchy [0...1]
[0/*]
String

Full packing aggregation hierarchy.

      cmn:ParentSerial [1...1]
[1/*]
String

Required. Serial number expressed in the GS1 Application Identifier format with or without parenthesis for the AI keys. *33

AI (01)(21) formatted serial number for GTINs or AI(00) formatted serial number for SSCCs.

Non-GS1 serial numbers (e.g. China) are expressed in native format.
        @companyPrefix [0...1]
[1/*]
String

The GS1 Company Prefix associated with SGTIN or SSCC code. Used in conjunction with Application Identifier number and filter value in the event the serial number needs to be translated into an alternate format for the customer system (e.g. GS1 HEX, GS1 EPC URI or GS1 Tag URI format).

        @format [0...1]
[1/*]
String

The attribute that identifies the format of the serial numbers.

See the Format enumeration list for valid values.

        @packedStatus [0...1]
[1/*]
String

The packed status.

      PackagingLevel [0...1]
[0/*]
String

Identifies packaging level of parent serial number. Valid values:  *34

  • CA = Case
  • PK = Inner Pack/Bundle
  • PL = Pallet
      cmn:NumberList [0...1]
[-]
-

The serial numbers for the top-level aggregation of the serialized products in the ItemDetailsList.

        cmn:Serial [1...*]
[1/*]
String

Required. The serial numbers for the current line item packaging child or saleable product unit. *35

          @companyPrefix [0...1]
[1/*]
String

The GS1 Company Prefix associated with an SGTIN or SSCC code. Used in conjunction with Application Identifier number and filter value in the event the serial number needs to be translated into an alternate format for the customer system (e.g. GS1 HEX, GS1 EPC URI or GS1 Tag URI format).

          @format [0...1]
[1/*]
String

The attribute that identifies the format of the serial numbers.

See the Format enumeration list for valid values.

          @packedStatus [0...1]
[1/*]
String

Packed status.