ESM Receipt Guidelines (XML)

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

Message Type: SOM_ESM_RECEIPT

Info Exchange Display Name: ESM 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
Length		 Type Description
som:SOMReceiptMessage [1…1]
[-]		 - Required. Root element of message.
  som:ControlFileHeader [1…1]
[-]		 - Required. The message document's header information.
    cmn:FileSenderNumber [1…1]
[1/20]		 String Required. The company identifier of the file’s sender. *1
    cmn:FileReceiverNumber [1…1]
[1/20]		 String Required. The company identifier of the file’s recipient. *2
    cmn:FileControlNumber [1…1]
[1/20]		 String Required. The message’s unique file control ID number. A file control ID number is mandatory for all messages. *3
    cmn:FileDate [1…1]
[10/10]		 Date Required. The date that the message is sent in YYYY-MM-DD format. Date and times must be in GMT. *4
    cmn:FileTime [1…1]
[9/9]		 Time Required. Time file generated in XML in HH:MM:SSZ format. The system expects the Z to be appended; however, if it is not included, the system assumes that the time is GMT and therefore appends the Z. *5
  som:MessageBody [1…1]
[-]		 - Required. Main body of the message.
    cmn:EventDateTime [0…1]
[0/*]		 DateTime Specifies the timestamp of the date/time of the Transaction event with the UTC time zone indicator in the format: YYYY-MM-DDTHH:MM:SS.ssZ.
If not present, the system defaults to the current GMT date/time.
    cmn:EventTimeZoneOffset [0…1]
[0/*]		 String Specifies the time zone offset in effect time and place where the event occurred.
    cmn:LocationId [1…1]
[0/34]		 String Specifies the facility or warehouse identifier to scope the Sales Shipment Status update for the serial numbers matching the specified item code and lot number. *6

If the location is omitted, the Sales Shipment status update is applied globally to all matching serial numbers in the system.
    cmn:DeliveryNumber [1…1]
[1/*]		 String Required. Links the order information to the serialized receive information for this customer delivery. *7
    cmn:DeliveryCompleteFlag [1…1]
[1/*]		 Boolean Required. Instructs TraceLink to process the outbound delivery, update the status of all serial numbers and child aggregations to be shipped, and trigger generation of regulatory reporting messages based on customer configuration. *8

If all of the information (order detail and received serial numbers) is in a single message, the delivery complete flag is set to true.

If only partial information is in the message (e.g. order detail only, received items sent incrementally, etc.) the delivery complete flag is set to false for all intermediate messages, and then set to true when the delivery is complete and all information has been communicated to TraceLink.

Values must be lower case only. True or TRUE will throw an error.
    cmn:RegisterUknownSNs [0…1]
[0/*]		 Boolean

Determines if serial numbers that are not known to SOM should be registered or not. Valid values:

  • true – All serial numbers that do not currently exist in SOM are registered in the Available state.
  • false – All serial numbers that do not currently exist in SOM are rejected.
    som:OrderDetails [1…1]
[-]		 - Required. Includes business transaction identifier and date, order item receive list, and sender and recipient information. This element is mandatory before the delivery complete flag can be set, though it can be communicated at any time (e.g. with, before, or after the received serial numbers have been communicated).
      cmn:CorrectiveReceipt [0…1]
[0/*]		 Boolean

Indicates that a new Serialized Operations Manager receipt is correcting a previously voided Serialized Operations Manager receipt. Valid values:

  • false – (default) The receipt is not a corrective receipt.
  • true – The receipt is a corrective receipt.
      cmn:OriginalDeliveryNumber [0…1]
[0/*]		 String

Original delivery number. Records the original delivery number that is replaced when a receipt is voided and corrections are made to that receipt.
      cmn:EntryPort [0…1]
[0/*]		 String

Name of the shipment's port of entry into a country (e.g. an airport, maritime port, border checkpoint).
      cmn:ExitPort [0…1]
[0/*]		 String

Name of the shipment's port of exit from a country (e.g. an airport, maritime port, border checkpoint).
      cmn:TransactionIdentifier [1…*]
[1/*]		 String Required. Identifier associated with the received serial numbers, for regulatory reporting purposes. *9

At least one transaction id is mandatory. More than one may be mandatory depending on country.

Country Requirements:
  • US provides PO Number, ASN Number, and Invoice Number if available.
  • China provides Sales Order Number.
  • Argentina provides Packing Slip Number.
        @type [1…1]
[1/*]		 String Required. The transaction identifier type using supported enumeration values (e.g. ASN, PO, RETURN). *10

See the TransactionId enumeration list for valid values.
        @date [0…1]
[0/*]		 Date Conditionally required if cmn:ShipFromCountryCode = RU. The transaction identifier date. *11
      cmn:TransactionDate [1…1]
[1/*]		 Date Required. The date of the message in YYYY-MM-DD format. *12
      cmn:TransactionTime [0…1]
[0/*]		 Time The time of the message in HH:MM:SS format. *13
      cmn:ShipToCountryCode [1…1]
[2/2]		 String Required. ISO country code for ship to country. Provides application with the information it needs to trigger regulatory reporting in response to relevant events. *14

See the ISOCountryCode enumeration list for valid values.
      cmn:ShipFromCountryCode [0…1]
[2/2]		 String Conditionally required if the product is being exported from country (e.g. when ReceiptDistributionType = EXPORTSALE, EXPORTTRANSFER, or EXPORTRETURN). ISO country code for ship from country. Provides application with the information it needs to trigger regulatory reporting in response to relevant events. *15

See the ISOCountryCode enumeration list for valid values.
      cmn:ReceiptDistributionType [1…1]
[1/*]		 String Required. Advises the application of sale (change of ownership of the product) and transfer (no change of ownership of product, but physical movement of product) for application and regulatory reporting purposes. The actual triggering of regulatory reporting is governed by the configuration in TraceLink. *16

INCOUNTRYTRANSFER and EXPORTTRANSFER include:

  • Intra-company warehouse transfer of goods.
  • Transfers between Manufacturer (Brand Owner) and 3PL.
  • Transfers between Manufacturer (Brand Owner) and CMO/CPO.
  • Transfers between CMO/CPO and 3PL of Manufacturer (Brand Owner).
Setting this value alone does not trigger regulatory reporting.

See the ReceiptDistributionType enumeration list for valid values.
      cmn:TransferWithoutShipment [0…1]
[0/*]		 Boolean

Indicates that the serial numbers are already in an Available state because there is no associated shipment event. Valid values:

  • true – Serial numbers are in the Available state.
  • false – (default) Serial numbers are in the Pending Receipt state.

Only use when tl:receiptDistributionType = INCOUNTRYTRANSFER or IMPORTTRANSFER.
      cmn:SupplyType [0…1]
[0/*]		 String Conditionally required:
  • If cmn:ShipFromCountryCode = KR and cmn:ReceiptDistributionType = EXPORTSALE or EXPORTRETURN; All values except for Collection apply.
  • Mandatory for Brazil: Populate only if performing Collection, Donation, or SampleDistribution.

Identifies the type of supply that is being performed using a valid value from the enumerations list.

See the SupplyType enumeration list for valid values.
      cmn:ContractType [0…1]
[0/*]		 String Conditionally required if cmn:ShipFromCountryCode = KR and cmn:ReceiptDistributionType = EXPORTSALE or EXPORTRETURN. Identifies the type of contract for the sale of goods using a valid value from the enumerations list.

See the ContractType enumeration list for valid values.
      cmn:Comments [0…1]
[0/*]		 String Optional remarks or comments regarding with delivery.
      cmn:ContractNumber [0…1]
[0/*]		 String Identification number of the contract. *17
      cmn:FundingSource [0…1]
[0/*]		 String Conditionally required if both cmn:ShipToCountryCode and cmn:ShipFromCountryCode = RU. Source of the funding. *18

See the FundingSource enumeration list for valid values.
      cmn:DeliveryInspection [0…1]
[0/*]		 String

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

See the DeliveryInspection enumeration list for valid values.
      cmn:DeliveryInspectionDate [0…1]
[10/10]		 Date The date of the physical delivery inspection against the delivery documentation in YYYY-MM-DD format. *19
      cmn:DeliveryInspectionNote [0…1]
[0/*]		 String Comments about the physical delivery inspection against the delivery documentation.
      cmn:RemovalFromCirculation [0…1]
[0/*]		 String

Reason the product in the delivery is taken out of the supply chain.

See the RemovalFromCirculation enumeration list for valid values.
      cmn:AggregationInspection [0…1]
[0/*]		 String

The inspection status of the aggregation hierarchy of the container.

See the AggregationInspection enumeration list for valid values.
      cmn:OrderItemList [1…1]
[-]		 - Conditionally required. Order item list group is populated to communicate the expected receive quantities for each item code at the EACH (unit) level. This information verifies the actual serial number received, the correct product, the correct lot number (if provided), and the correct each quantity.
        cmn:AllowShortVerificationCount [0…1]
[0/*]		 Boolean When set to true, allows the count to come up short without an error. If set to false, an error is thrown if the count does not match what is expected. *20
        cmn:OrderItem [1…*]
[-]		 - Required. A repeating element that captures the item code, lot number, and quantity for each item that will be received for the order. Each unique item code and lot number are communicated in a separate order item group.
          cmn:OrderItemNumber [0…1]
[0/*]		 String Order item number attribute associating specific serial numbers with the price, VAT, and cost taxes reported in a specific instance of cmn:OrderItem.
          choice1% [1…1]
[-]		 Choice

Required. Populate only one of cmnl:InternalMaterialCode, cmn:PackagingItemCode, or cmn:CountryDrugCode. One of the three options must be present.

          cmn:InternalMaterialCode [0…1]
[1/*]		 String Conditionally requiredif neither cmn:PackagingItemCode nor cmn:CountryDrugCode is present. Option 1 for OrderItem | choice1%. Use to identify the product using the internal material number configured in Product Master Data. *21
          cmn:PackagingItemCode [0…1]
[1/*]		 String Conditionally requiredif neither cmn:InternalMaterialCode nor cmn:CountryDrugCode is present. Option 2 for OrderItem | choice1%. Use to identify the product using the packaging level item code (e.g. GTIN-14) configured in Product Master Data. *22
            @type [1…1]
[1/*]		 String Required. The product code type for the packaging item code using the supported enumeration values (e.g. GTIN-14). *23

See the ItemCode enumeration list for valid values.
          cmn:CountryDrugCode [0…1]
[1/*]		 String Conditionally required if neither cmn:InternalMaterialCode nor cmn:PackagingItemCode is present. Option 3 for choice%1 in OrderItem. Use to identify the product using the country drug code configured in Product Master Data. *24
            @type [0…1]
[0/*]		 String The national drug code type using the supported enumeration values. * 25

See the CountryDrugCode enumeration list for valid values.
          cmn:LotNumber [0…1]
[0/*]		 String Conditionally required if cmn:ShipFromCountryCode = KR and cmn:IsSerialized = false. The lot or batch code for the items to be received (if available) in an alphanumeric String. *26
          cmn:ExpirationDate [0…1]
[0/*]		 Date Expiration date for product in YYYY-MM-DD format. *27
          cmn:Quantity [1…1]
[1/*]		 Integer Conditionally required if cmn:ShipFromCountryCode = KR and cmn:IsSerialized = false. The quantity of items at the EACH (unit) level of the item code and lot if specified to be received. *28
          cmn:UnitPrice [0…1]
[1/*]		 Decimal Conditionally required if cmn:ShipFromCountryCode = KR, or if cmn:ShipToCountryCode = RU and cmn:ShipFromCountryCode = AM, BY, KG, KZ, or RU. The unit price of an item. *29
            @currencyCode [1…1]
[3/3]		 String Required. Currency ISO code using ISO 4217-2015 format. *30
          cmn:VAT [0…1]
[-]		 Decimal Value Added Tax per unit. *31
            @currencyCode [1…1]
[3/3]		 String Required. Currency ISO code using ISO 4217-2015 format. *32

See the ISOCurrency enumeration list for valid values.
          cmn:GrossPrice [0…1]
[-]		 Decimal Gross price including unit price and all taxes and fees. *33
            @currencyCode [1…1]
[3/3]		 String Required. Currency ISO code using ISO 4217-2015 format. *34

See the ISOCurrency enumeration list for valid values.
          cmn:IsSerialized [0…1]
[0/*]		 Boolean Conditionally required. Indicates if the item is not serialized. *35
If omitted, and cmn:OrderItem exists, defaults value to true.
          cmn:TransactionIdentifier [0…*]
[0/*]		 String Transaction identifier at the line-item level of shipment. More than one transaction identifier may be present. *36
            @type [1…1]
[1/*]		 String

Required.

The transaction identifier type. Valid values:
  • DESTRUCTION
  • INVOICE
  • NOTAFISCAL
  • OTHER
  • PO
  • RETURN
            @date [0…1]
[0/*]		 Date Conditionally required if cmn:ShipToCountry = RU. The transaction identifier date. *37
      cmn:SenderInfo [1…1]
[-]		 - Required. Information about the supply chain partner that is sending the shipment. Contains XML choice elements of FromBusinessParty and ShipFromLocation that govern whether to use master data lookup to populate the address, license, and contact elements.

Only one option in choice1% may be populated.
        choice1% [1…1]
[-]		 Choice Required. One of the following options:
  • Option 1: Contains only cmn:FromBusinessPartyLookupId.
    • Populate this element only if master data lookup is desired.
  • Option 2: Contains full cmn:FromBusinessPartyInfo business address the customer populates directly in the interface.
    • Populate this element fully only if master data lookup is not desired.
        cmn:FromBusinessPartyLookupId [0…1]
[1/*]		 String Conditionally required if full business address is provided in cmn:FromBusinessPartyInfo option. Option 1 for senderInfo | choice1% group. *38

A lookup identifier associated with the sold-from business entity. This value is used as the lookup key in master data to populate the details in cmn:FromBusinessPartyInfo.

          @type [1…1]
[1/*]		 String Conditionally required if full business address is not provided in cmn:FromBusinessPartyInfo option. The type of the sold from business entity identifier from the provided enumeration list. *39

See the BusinessLookupId enumeration list for valid values.
        cmn:FromBusinessPartyInfo [0…1]
[-]		 - Conditionally required if cmn:FromBusinessPartyLookupId to leverage master data lookup is not populated. Option 2 for senderInfochoice1% group.

The full business information associated with the sold from business entity is provided.

          cmn:BusinessId [1…*]
[1/*]		 String Required. The identifier associated with the sold from business entity. Mandatory for regulatory reporting. *40
            @type [1…1]
[1/*]		 String Required. The type of the BusinessId identifier. *41
Only one of the following values may be used per message:
  • RU_INN_FOREIGN_ENTITY
  • RU_INN_INDIV
  • RU_INN_LOCAL_ENTITY

See the BusinessAndLocationId enumeration list for valid values.
          cmn:BusinessClassification [0…1]
[0/*]		 String Conditionally required for Argentina. Business classification. *42

See the BusinessClassification enumeration list for valid values.
          cmn:BusinessInfo [0…1]
[-]		 - Conditionally required for US. The business name and address of the sold from business entity.
            cmn:BusinessName [1…1]
[0/*]		 String Required. The business name of the trading partner. *43
            cmn:Street1 [1…1]
[0/*]		 String Required. The first line of the street address. *44
            cmn:Street2 [0…1]
[0/*]		 String The second line of the street address. *45
            cmn:City [1…1]
[1/*]		 String Required. The city. *46
            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

Name of the district subdividing the state or region.
            cmn:StateOrRegion [1…1]
[0/*]		 String Required. The state, province, or region using the standard two-letter abbreviation specified in ISO 3166-2:1998 country subdivision code. *47
            cmn:PostalCode [0…1]
[0/*]		 String The ZIP or other postal code. *48
            cmn:Country [0…1]
[0/*]		 String Required. The country using the standard two-letter abbreviation specified in ISO 3166-1alpha-2:1997 country code. *49
            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 of 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 of 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).
        choice2% [0…1]
[-]		 Choice Optional choice element (no error if neither are present):
  • Option 1: Contains only the cmn:ShipFromLocationLookupId.
    • Populate this element only if master data lookup is desired.
  • Option 2: Contains full cmn:ShipFromLocationInfo business address fielded data that will be populated by the customer directly in the interface.
    • Populate this element fully only if master data lookup is not desired.
        cmn:ShipFromLocationLookupId [0…1]
[1/*]		 String Required. Option 1 for senderInfo | choice2% group. *50

A lookup identifier associated with the ship from location. Use this value as the lookup key in master data to populate the details in cmn:ShipFromLocationInfo.
          @type [1…1]
[1/*]		 String Conditionally required if full business address is not provided in cmn:ShipFromLocationInfo option. The type of the ship from location identifier using the enumeration list. *51

See the LocationLookupId enumeration list for valid values.
        cmn:ShipFromLocationInfo [0…1]
[-]		 - Required. Option 2 for senderInfo | choice2% group.

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

          cmn:FacilityId [0…*]
[0/*]		 String Required. The ship from location identifier. *52
US: Must be a DEA, GLN, HIN, or SGLN.
            @type [1…1]
[1/*]		 String Required. The type of the cmn:FacilityId identifier. *53
Only one of the following values may be used per message:
  • RU_INN_FOREIGN_ENTITY
  • RU_INN_INDIV
  • RU_INN_LOCAL_ENTITY

See the BusinessAndLocationId enumeration list for valid values.
          cmn:LocationInfo [0…1]
[-]		 - Conditionally required for US. The business name and address of the ship from location.
            cmn:BusinessName [1…1]
[0/*]		 String Required. The business name of the trading partner. *54
            cmn:Street1 [1…1]
[0/*]		 String Required. The first line of the street address. *55
            cmn:Street2 [0…1]
[0/*]		 String The second line of the street address.
            cmn:City [1…1]
[0/*]		 String Required. The city. *56
            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

Name of the district subdividing the state or region.
            cmn:StateOrRegion [1…1]
[0/*]		 String Required. The state, province, or region using the standard two-letter abbreviation specified in ISO 3166-2:1998 country subdivision code. *57
            cmn:PostalCode [0…1]
[0/*]		 String The ZIP or other postal code. *58
            cmn:Country [0…1]
[0/*]		 String Required. The country using the standard two-letter abbreviation specified in ISO 3166-1 alpha-2:1997 country code. *59
            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 of 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 of 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:LicenseNumber [0…*]
[0/*]		 String Conditionally required for US. The license number of the facility. This element may be repeated to include as many license numbers as mandatory (e.g. state and federal license). *60
            @state [0…1]
[0/*]		 String Required. The state or region in which the trading partner is licensed, using the standard two letter abbreviation specified in ISO 3166-2:1998 country sub-division code. Used to give additional context to the license number. *61
            @agency [0…1]
[0/*]		 String Required. The agency that granted the license (e.g. Florida DOH, NABP). Used to give additional context to the license number. *62
          cmn:ContactInfo [0…1]
[-]		 - Conditionally required for US. Contact information for use by downstream trading partners to authenticate (e.g. verify) the message information recorded on the pedigree with the sender party.
            cmn:Name [0…1]
[0/*]		 String Required. The name of the contact department or individual at the company. *63
            cmn:Title [0…1]
[0/*]		 String The title of the individual if a person was provided in cmn:Name. *64
            cmn:Telephone [1…1]
[1/*]		 String Required. The phone number of the contact department or individual at the company. Must begin with the + character followed by the Country Calling Code. *65
            cmn:Email [0…1]
[0/*]		 String The email address of the contact department or individual at the company. Should be included if available. *66
            cmn:Url [0…1]
[0/*]		 String The Web address to facilitate authentication. *67
      cmn:ReceiverInfo [1…1]
[-]		 - Required. Information about the supply chain partner that is receiving the shipment. cmn:ReceiverInfo contains XML choice elements for ToBusinessParty and ShipToLocation that govern whether to use master data lookup to populate the address, license, and contact elements.

Only one option in choice1% may be populated.
        choice1% [1…1]
[-]		 Choice Required. Required choice element. One option must be selected, but not both.
  • Option 1: Contains only the cmn:ToBusinessPartyLookupId.
    • Populate this element only if master data lookup is desired.
  • Option 2: Contains full cmn:ToBusinessPartyInfo business address fielded data populated by the customer directly in the interface.
    • Populate this element fully only if master data lookup is not desired.
        cmn:ToBusinessPartyLookupId [0…1]
[0/*]		 String Required. Option 1 for ReceiverInfo | choice1% group. *68

A lookup identifier associated with the sold to business entity. Use this value as the lookup key in master data to populate the details in cmn: ToBusinessPartyInfo.
          @type [1…1]
[1/*]		 String Conditionally required if full business address not provided in cmn:ToBusinessPartyInfo option. The type of the sold to business entity identifier from the provided enumeration list. *69

See the BusinessLookupId enumeration list for valid values.
        cmn:ToBusinessPartyInfo [0…1]
[-]		 - Required. Option 2 for ReceiverInfo | choice1% group.

The full business information associated with the sold to business entity is provided.
          cmn:BusinessId [1…*]
[1/*]		 String Required. The return to business entity identifier. Mandatory for regulatory reporting. *70
            @type [1…1]
[1/*]		 String Required. The type of the cmn:BusinessId identifier. *71
Only one of the following values may be used per message:
  • RU_INN_FOREIGN_ENTITY
  • RU_INN_INDIV
  • RU_INN_LOCAL_ENTITY

See the BusinessAndLocationId enumeration list for valid values.
          cmn:BusinessClassification [0…1]
[0/*]		 String Conditionally required for Argentina. Business classification. *72

See the BusinessClassification enumeration list for valid values.
          cmn:BusinessInfo [0…1]
[-]		 - Conditionally required for US. The sold to business entity business name and address.
            cmn:BusinessName [1…1]
[0/*]		 String Required. The business name of the trading partner. *73
            cmn:Street1 [1…1]
[0/*]		 String Required. The first line of the street address. *74
            cmn:Street2 [0…1]
[0/*]		 String The second line of the street address.
            cmn:City [1…1]
[0/*]		 String Required. The city. *75
            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

Name of the district subdividing the state or region.
            cmn:StateOrRegion [1…1]
[0/*]		 String Required. The state, province, or region using the standard two-letter abbreviation specified in ISO 3166-2:1998 country subdivision code. *76
            cmn:PostalCode [0…1]
[0/*]		 String The ZIP or other postal code. *77
            cmn:Country [0…1]
[0/*]		 String Required. The country using the standard two-letter abbreviation specified in ISO 3166-1 alpha-2:1997 country code. *78
            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 of 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 of 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).
        choice2% [0…1]
[-]		 Choice Optional choice element:
  • Option 1: Contains only the cmn:ShipToLocationLookupId.
    • Populate this element only if master data lookup is desired.
  • Option 2: Contains full cmn:ShipToLocationInfo business address fielded data populated by the customer directly in the interface.
    • Populate this element fully only if master data lookup is not desired.
        cmn:ShipToLocationLookupId [0…1]
[1/*]		 String Required. Option 1 for ReceiverInfo | choice2% group. *79

A lookup identifier associated with the ship to location using the enumeration list. Use this value as the lookup key in master data to populate the details in cmn:ShipToLocationInfo.
          @type [1…1]
[1/*]		 String Required. The type of the ship to location identifier. *80

See the LocationLookupId enumeration list for valid values.
        cmn:ShipToLocationInfo [0…1]
[-]		 - Conditionally required for US. Option 2 for ReceiverInfo | choice2% group.

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

          cmn:FacilityId [0…*]
[0/*]		 String Required. Populated with the ship from location identifier. *81
US: Must be a DEA, GLN, HIN, or SGLN.
            @type [1…1]
[1/*]		 String Required. The type of the cmn:FacilityId identifier. *82
Only one of the following values may be used per message:
  • RU_INN_FOREIGN_ENTITY
  • RU_INN_INDIV
  • RU_INN_LOCAL_ENTITY

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]
[0/*]		 String Required. The business name of the trading partner. *83
            cmn:Street1 [1…1]
[0/*]		 String Required. The first line of the street address. *84
            cmn:Street2 [0…1]
[0/*]		 String The second line of the street address.
            cmn:City [1…1]
[0/*]		 String Required. The city. *85
            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

Name of the district subdividing the state or region.
            cmn:StateOrRegion [1…1]
[0/*]		 String Required. The state, province, or region using the standard two-letter abbreviation specified in ISO 3166-2:1998 country subdivision code. *86
            cmn:PostalCode [0…1]
[0/*]		 String The ZIP or other postal code. *87
            cmn:Country [0…1]
[0/*]		 String Required. The country using the standard two-letter abbreviation specified in ISO 3166-1 alpha-2:1997 country code. *88
            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 of 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 of 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:LicenseNumber [0…*]
[0/*]		 String Conditionally required for US. Populated with the license number of the facility. This element may be repeated to include as many license numbers as required (e.g. state and federal license). *89
            @state [0…1]
[0/*]		 String Required. The state or region in which the trading partner is licensed, using the standard two letter abbreviation specified in ISO 3166-2:1998 country sub-division code. Used to give additional context to the license number. *90
            @agency [0…1]
[0/*]		 String Required. The agency that granted the license (e.g. Florida DOH, NABP). Used to give additional context to the license number. *91
      cmn:CarrierInfo [0...*]
[-]		 - Conditionally required if ShipToCountryCode = BR. Information about the transportation partner that is transporting the shipment. cmn:CarrierInfo contains XML choice elements that govern whether master data lookup will be used to populate the address elements. Only one option in choice1% may be populated.
        choice1% [1…1]
[-]		 Choice Optional choice element: No error if neither are present.
  • Option 1: Contains only the cmn:CarrierBusinessPartyLookupId.
    • Populate this element ONLY if master data lookup is desired.
  • Option 2: Contains full cmn:CarrierBusinessPartyInfo business address fielded data that will be populated by the customer directly in the interface.
    • Populate this element fully ONLY if master data lookup is not desired.
        cmn:CarrierBusinessPartyLookupId [0…1]
[1/*]		 String Conditionally required if full business address not provided in cmn:CarrierBusinessPartyInfo option. Option 1 for CarrierInfo | choice1% group. *92

A lookup identifier associated with the Carrier entity from the enumeration list. This value is used as the lookup key in master data to populate the details in CarrierBusinessPartyInfo.

          @type [1…1]
[1/*]		 String Conditionally required if full business address not provided in cmn:CarrierBusinessPartyInfo option. The type of the carrier business entity identifier from the provided enumeration list. *93

See the BusinessLookupId enumeration list for valid values.
        cmn:CarrierBusinessPartyInfo [0…1]
[-]		 - Conditionally required if cmn:CarrierBusinessPartyLookupId to leverage master data lookup is not populated. Option 2 for CarrierInfo | choice1% group.

The full business information associated with the transportation carrier business entity is provided.

          cmn:BusinessId [1…*]
[1/*]		 String Required. The identifier associated with the transport carrier business entity. This value is mandatory for regulatory reporting. *94
For Brazil: Provide the BR_CNPJ, BR_CPF, BR_CNES, or BR_PROF_REG. BR_CNPJ is the value preferred by ANVISA if the company has one.
            @type [1…1]
[1/*]		 String Required. The type of the cmn:BusinessId identifier. *95
Only one of the following values may be used per message:
  • RU_INN_FOREIGN_ENTITY
  • RU_INN_INDIV
  • RU_INN_LOCAL_ENTITY

See the BusinessAndLocationId enumeration list for valid values.
          cmn:BusinessClassification [0…1]
[0/*]		 String N/A. *96
          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]
[0/*]		 String Required. The business name of the trading partner. *97
            cmn:Street1 [1…1]
[0/*]		 String Required. The first line of the street address. *98
            cmn:Street2 [0…1]
[0/*]		 String The second line of the street address.
            cmn:City [1…1]
[0/*]		 String Required. The city. *99
            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

Name of the district subdividing the state or region.
            cmn:StateOrRegion [1…1]
[0/*]		 String Required. The state, province, or region using the standard two-letter abbreviation specified in ISO 3166-2:1998 country subdivision code. *100
            cmn:PostalCode [0…1]
[0/*]		 String The ZIP or other postal code. *101
            cmn:Country [0…1]
[0/*]		 String Required. The country using the standard two-letter abbreviation specified in ISO 3166-1 alpha-2:1997 country code. *102
            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 of 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 of 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:WarehouseOperatorName [0…1]
[0/*]		 String Conditionally required for China. Name of the person responsible for warehouse operations. This element can be communicated at any time (e.g. with, before, or after the order details or received items have been communicated). *103
    som:AddReceivedItems [0…1]
[-]		 - Required. List of serial numbers for the outermost handling units received for this delivery. TraceLink looks up the child aggregations of the serial numbers provided in the list and updates the container and all child items with the received and subsequent shipped status.

This element is mandatory before the delivery complete flag can be set, though it can be communicated at any time (e.g. with, before, or after the order details have been communicated).
      cmn:Serial [1…*]
[1/*]		 String Required. Serial number of an outermost handling unit received for this delivery. One serial number is included per received container (or item if shipping loose items). This is typically a pallet or case serial number. *104
        @format [0…1]
[0/*]		 C Required. Attribute that identifies format of serial numbers. *105

See the Format enumeration list for valid values.
        @orderItemNumber [0…1]
[0/*]		 String Order item number attribute associating specific serial numbers with the price, VAT, and cost taxes reported in a specific instance of cmn:OrderItem.
    som:Aggregation [0…1]
[-]		 - Communicates new aggregations created by the warehouse that are included in the shipment.

The PickedItems includes the top-level container serial numbers and loose items. If the warehouse creates a new aggregation (e.g. a new pallet or mixed case), the new aggregation hierarchies are communicated in the cmn:Aggregation element group.

If an existing case ships, the case must be scanned and the case hierarchy is not provided. If a new mixed case is created, the hierarchy for that new case is communicated.

This enables the distribution warehouse to locally manage changes to aggregation hierarchies. The warehouse communicates the new aggregation hierarchies of the shipped goods at the time of shipment without having to send disaggregation and aggregation events. TraceLink implicitly disaggregates and aggregates operations to achieve the end state hierarchy prior to processing the shipment. TraceLink also auto-commissions the SSCC numbers for new cases and pallets when these SSCC numbers are not yet commissioned.
      cmn:EventDateTime [1…1]
[0/*]		 Datetime Required. The date and time of aggregation event with the UTC time zone indicator in YYYY-MM-DDTHH:MM:SS.ssZ format. If not provided, the current GMT date time is used.
      cmn:EventLocation [1…1]
[1/*]		 String Required. Site-level SGLN of the location where the event occurs. SGLN format is the numeric component only, with the urn prefix stripped (e.g. 8888882.02867.0 instead of urn:epc:id:sgln:8888882.02867.0 typically found in EPCIS events).
      cmn:ParentSerial [1…1]
[1/*]		 String Required. Serial number expressed in the GS1 Application Identifier format without parenthesis 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]
[0/*]		 String The GS1 Company Prefix present in GTIN-14 and SSCC serial numbers.
        @filterValue [0…1]
[0/*]		 String The filter value present in GTIN-14 and SSCC serial numbers.
        @format [0…1]
[0/*]		 String The format of the serial numbers.

See the Format enumeration list for valid values.
        @packedStatus [0…1]
[0/*]		 String The packaging status of the container.

See the PackedStatus enumeration list for valid values.
      cmn:PackagingLevel [0…1]
[0/*]		 String The packaging level of the commissioned items in cmn:NumberList.

See the PackagingLevel enumeration list for valid values.
      cmn:NumberList [1…1]
[-]		 - Required. List of serial numbers for the items packed into the container serial number.
        cmn:Serial [1…*]
[1/*]		 String Required. Serial number expressed in the GS1 Application Identifier format without parenthesis 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]
[0/*]		 String The GS1 Company Prefix present in GTIN-14 and SSCC serial numbers.
          @filterValue [0…1]
[0/*]		 String The filter value present in GTIN-14 and SSCC serial numbers.
          @format [0…1]
[0/*]		 String The format of the serial numbers.

See the Format enumeration list for valid values.
          @packedStatus [0…1]
[0/*]		 String The packaging status of the container.

See the PackedStatus enumeration list for valid values.
          @orderItemNumber [0…1]
[0/*]		 String Order item number attribute associating specific serial numbers with the price, VAT, and cost taxes reported in a specific instance of cmn:OrderItem.
    som:TransactionEvent [0…*]
[-]		 - Indicates the association of purchase orders with the serial numbers.
      cmn:EventDateTime [1…1]
[0/*]		 Datetime Required. The date and time of aggregation event with the UTC time zone indicator in YYYY-MM-DDTHH:MM:SS.ssZ format. If not provided, the current GMT date time is used.
      cmn:TransactionIdentifier [1…1]
[0/*]		 Datetime Required. Identifier associated with the received serial numbers, for regulatory reporting purposes. At least one transaction id is mandatory. More than one may be mandatory depending on the country.
        @type [1…1]
[1/*]		 String Required. The transaction identifier type supports the enumeration value PO.
        @date [0…1]
[0/*]		 Date

The transaction identifier date attribute in YYYY-MM-DD format.
      cmn:NumberList [1…1]
[-]		 - Required. List of serial numbers for the items packed into the parent serial number.
        cmn:Serial [1…*]
[1/*]		 String Required. Serial number expressed in the GS1 Application Identifier format without parenthesis 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]
[0/*]		 String Required. The GS1 Company Prefix present in GTIN-14 and SSCC serial numbers.
          @format [0…1]
[0/*]		 String Required. The format of the serial numbers.

See the Format enumeration list for valid values.
      cmn:EventLocation [0…1]
[0/34]		 String Required. Site-level SGLN of the location where the event occurs. SGLN format is the numeric component only, with the urn prefix stripped (e.g. 8888882.02867.0 instead of urn:epc:id:sgln:8888882.02867.0 typically found in EPCIS events).