Receipt Guidelines (XML)

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

Message Type: SOM_RECEIPT

Info Exchange Display Name: Shipment 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
SOMReceiptMessage [1...1]
[-]		 - Required. The SOMReceiptMessage input is the root element of the Serialized Operations Manager Receipt message. This element contains additional elements/segments that detail the message's header information (e.g. sender, receiver information) as well as the body of the actual message. This is the first element in the document.
  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. The Message Body includes all of the Serialized Operations Manager Receipt message details including, but not restricted to, location, delivery, and order information.
    cmn:EventDateTime [0…1]
[0/*]		 DateTime 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 Time zone offset in effect time and place where the event occurred.
    cmn:LocationId [0...1]
[0/34]		 String Required. The LocationId field specifies the identifier of the facility/warehouse so as to scope the Receipt status update for the serial numbers matching the specified item code and lot number only at the specified location. If the location is omitted, the Receipt status update will be applied globally to all matching serial numbers in the system. *6
    cmn:DeliveryNumber [1...1]
[1/*]		 String Required. This field indicates the DeliveryNumber that links the order information to the serialized pick information for this customer delivery. *7
    cmn:DeliveryCompleteFlag [1...1]
[1/*]		 Boolean Required. This mandatory field supports incremental receipts. If all of the information (e.g. order details, picked serial numbers) are provided in a single message, the delivery complete flag is set to true. Values must be lowercase. *8

When set to true, the DeliveryCompleteFlag instructs TraceLink to:

  1. Process an outbound delivery.
  2. Update the status of all serial numbers and sub-child aggregations to be shipped.
  3. Trigger generation of regulatory reporting messages based on customer configuration.

If only partial information is provided in the message (e.g. only the order details are provided and picked items are sent incrementally) the delivery complete flag is set to false for all intermediate messages. The flag is then set to true when all information has been communicated to TraceLink and the delivery is complete.
    cmn:RegisterUnknownSNs [0...1]
[0/*]		 Boolean Determines whether the serial numbers that are unknown to SOM should be registered. Valid values: *9
  • true – register all serial numbers that do not currently exist in Serialized Operations Manager in an available state.
  • false – (default) all serial numbers that do not currently exist in Serialized Operations Manager are rejected.
    som:OrderDetails [0...1]
[-]		 - Conditionally required if som:AddReceivedItems is present. The OrderDetails complex message communicates pertinent details such as the business transaction identifiers, date, order item pick list, sender, and recipient information. This element is mandatory before the delivery complete flag can be set. However, it can be communicated at any time (e.g. with, before, or after the picked 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:

  • true – The receipt is a corrective receipt.
  • false – (default) The receipt is not 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 [0...*]
[ 0/*]		 String Conditionally required for the following countries:
  • Argentina: provide Packing Slip Number.
  • China: provide Sales Order Number.
  • US: provide PO Number, ASN Number, and Invoice Number if available.

The transaction identifier is associated with the picked serial numbers for regulatory reporting purposes. *10
        @type [1...1]
[1/*]		 String Required. The transaction identifier type. *11

See the TransactionId enumeration list for valid values.
        @date [0...1]
[0/*]		 Date Conditionally required if cmn:ShipToCountryCode = RU. The transaction identifier date. *12
      cmn:TransactionDate [1...1]
[1/*]		 Date Required. The date of the transaction in XML YYYY-MM-DD format. This field indicates the date when the transfer of ownership occurred between the shipper and receiver. *13
      cmn:TransactionTime [0...1]
[0/*]		 Time Conditionally required for China. The time of the transaction in XML HH:MM:SS format. *14
      cmn:ShipToCountryCode [1...1]
[2/2]		 String Required. Two-letter ISO country code for ship-to country. This value will be referenced to advise regulatory reporting if it is mandatory for the specified country market. Setting this value alone does not trigger regulatory reporting. The actual trigger for regulatory reporting is governed by customer administrative configuration in the TraceLink application. *15

See the ISOCountryCode enumeration list for valid values.
      cnm:ShipFromCountryCode [0...1]
[2/2]		 String Required. Two-letter ISO country code for the ship-from country. This value will be referenced to advise regulatory reporting 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. *16

See the ISOCountryCode enumeration list for valid values.
      cmn:ReceiptDistributionType [0...1]
[1/*]		 String

Conditionally required if cmn:ReceiptDistributionType was not provided in a previously saved incomplete or pending receipt for the delivery number. This field indicates which types of regulatory reporting may be triggered based on the nature of the transaction. Can send the ReceiptDistributionType in a previously saved incomplete or pending receipt for the delivery number.

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 cmn:ReceiptDistributionType = INCOUNTRYTRANSFER or IMPORTTRANSFER.
      cmn:SupplyType [0...1]
[0/*]		 String Conditionally required if cmn:shipToCountryCode = KR and cmn:ReceiptDistributionType = INCOUNTRYRETURN. Identifies the type of supply that is being performed using one of the permitted values. All values except for Collection apply.

See the SupplyType enumeration list for valid values.

Brazil: populate only if performing a Collection, Donation or SampleDistribution.
      cmn:ContractType [0...1]
[0/*]		 String

Conditionally required if cmn:ShipFromCountryCode = KR and cmn:SalesDistributionType = EXPORTSALE or INCOUNTRYSALE. Identifies if a private or competitive bid contract is used for the sale of goods.

See the ContractType enumeration list for valid values.
      cmn:Comments [0...1]
[0/*]		 String Optional remarks or comments associated 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:DisaggregateFromParent [0...1]
[0/*]		 Boolean

Indicates whether the child serial number should be implicitly disaggregated from the parent container. Valid values:

  • true – The child serial number is disaggregated from the parent container.
  • false – (default) The child serial number is not disaggregated from the parent container. An error displays if the child serial number is received but the parent serial number is not.
      cmn:OrderItemList [0...1]
[-]		 - Conditionally required if cmn:ShipToCountryCode = KR and ReceiptDistributionType = INCOUNTRYRETURN. Order item list group is populated to communicate the expected pick quantities for each item code at the EACH (unit) level. This information is used in verification of the actual serial number picked to verify the correct product, correct lot number (if provided) and correct each quantity.
        cmn:AllowShortVerificationCount [0...1]
[0/*]		 Boolean Allow a short verification count flag. When comparing picked or received serial number counts in the ItemList counts this flag instructs the system to whether an error should be generated if the picked or received counts are less than expected. *20
     

 

 cmn:OrderItem [1...*]
[-]		 - Required. Order item group is a repeating element that captures the item code, lot number, and quantity for each item that will be picked 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 to the price, VAT, and cost taxes reported in a specific instance of cmn:OrderItem.
          choice%1 [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 required if neither cmn:PackagingItemCode nor cmn:CountryDrugCode is present. Option 1 for choice%1 in cmn:OrderItem. Use to identify the product using the internal material number configured in Product Master Data. *21
          cmn:PackagingItemCode [0...1]
[1/*]		 String Conditionally required if neither cmn:InternalMaterialCode nor cmn:CountryDrugCode is present. Option 2 for choice%1 in cmn:OrderItem. Use to identify the product using the packaging level item code (e.g. GTIN-14) configured in Product Master Data. *22
            @type [0...1]
[0/*]		 String Required. The product code type for the packaging item code using the supported enumeration values.

Valid values:

  • CN-RESCODE
  • GTIN-14
  • NTIN
          cmn:CountryDrugCode [0...1]
[1/*]		 String Conditionally required if neither cmn:InternalMaterialCode nor cmn:PackagingItemCode is present. Option 3 for choice%1 in cmn:OrderItem. Use to identify the product using the country drug code configured in Product Master Data. *23
            @type [0...1]
[0/*]		 String Required. The national drug code type using the supported enumeration values. * 24
          cmn:LotNumber [0...1]
[0/*]		 String The lot or batch code for the items to be picked (if available) in an alphanumeric string. *25
          cmn:ExpirationDate [0...1]
[1/*]		 Date Expiration date of the serialized item, in YYYY-MM-DD format.
          cmn:Quantity [1...1]
[1/*]		 Integer Required. The quantity of items at the EACH (unit) level of the item code and lot if specified to be picked. Quantity must be greater than zero if cmn:IsSerialized = false. *26
          cmn:UnitPrice [0...1]
[-]		 Decimal Conditionally required if:
  • Mandatory if cmn:ShipToCountryCode = KR and cmn:ReceiptDistributionType = INCOUNTRYRETURN.
  • Mandatory if cmn:ShipToCountryCode = RU and cmn:shipFromCountryCode = AM, BY, KG, KZ, or RU.

Unit price of item. *27
            @currencyCode [1...1]
[3/3]		 String Required. Currency ISO code using ISO 4217-2015 format.

See the ISOCurrency enumeration list for valid values.
          cmn:VAT [0...1]
[-]		 Decimal Value Added Tax per unit. *28
            @currencyCode [1...1]
[3/3]		 String Required. Currency ISO code using ISO 4217-2015 format. *29

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

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

Required. The transaction identifier type.

Valid values:

  • DESTRUCTION
  • INVOICE
  • NOTAFISCALELETRONICA
  • OTHER
  • PO
  • RETURN
            @date [0...1]
[0/*]		 Date Conditionally required if cmn:ShipToCountryCode = RU. The date of the transaction in XML YYY-MM-DD format. This value is used for regulatory reporting of the transaction date. *34
      cmn:SenderInfo [0...1]
[ -]		 - Conditional requirements:

Optional if:

  • Transfer or sale within EU FMD countries.
  • Transfer or sale import into an EU FMD country.
  • Transfer or sale export from an EU FMD country to a country other than US, CN, KR, or RU.

Mandatory if:

  • Transfer or sale involving non-EU FMD countries.
  • Transfer or sale export from an EU FMD country to US, CN, KR, or RU because of country compliance requirements.

This message contains information about the supply chain partner that is sending the return shipment. The FromBusinessParty and ShipFromLocation elements determine whether to use master data lookup to populate the address, license, and contact elements. Only one of FromBusinessParty or ShipFromLocation elements may be present at once.
        choice%1 [0...1]
[ -]		 Choice Option 1 within choice%1 of cmn:SenderInfo contains only the FromBusinessPartyLookupId (in this case, TraceLink will populate all of the FromBusinessPartyInfo field data based on company master data lookup). Populate this element only if no master data lookup is desired.

Option 2 within choice%1 of cmn:SenderInfo contains full FromBusinessPartyInfo business address field data that is populated by the customer directly in the interface. Populate this element fully only if no master data lookup is desired.
        cmn:FromBusinessPartyLookupId [0...1]
[0/*]		 String Option 1 for SenderInfo group. The FromBusinessPartyLookupId is a look-up identifier associated with the sold from business entity from the provided enumeration list. Use this value will as the look-up key in master data to populate the details in FromBusinessPartyInfo. *35
This field is optional, but may be used for master data lookup in TraceLink. An error is thrown if both cmn:FromBusinessPartyLookupId and cmn:FromBusinessPartyInfo are populated.
          @type [1...1]
[1/*]		 String Required. The type of the sold from business entity identifier.

See the BusinessLookupId enumeration list for valid values.
        cmn:FromBusinessPartyInfo [0...1]
[ 1/*]		 - Conditionally required if cmn:SenderInfo is present, but cmn:FromBusinessPartyLookupId is not present. This is option 2 within the SenderInfo field. This field contains full FromBusinessPartyInfo business address field data that will be populated by the customer directly in the interface.

Populate this element fully only if no master data look-up is desired.
          cmn:BusinessId [1...*]
[1/*]		 String Required.   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: *36

Country Requirements:

  • Argentina: Both the GLN and the CUIT number associated with the sold from party are provided.
  • For company's physically located in Brazil: Provide the BR_CNPJ number associated with the sold from party.
  • China: The company identifier registered with China SFDA used to identify the sold from party is provided.
  • Turkey: The GLN associated with the sold from party is provided.
  • US: A DEA, GLN, or HIN identifier associated with the sold from party is provided.
            @type [1...1]
[1/*]		 String Required. The business id type.

See the BusinessAndLocationId enumeration list for valid values.

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 Conditionally required :
  • For Argentina.
  • If cmn:ShipToCountryCode = KR and cmn:ReceiptDistributionType = INCOUNTRYRETURN.

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

See the BusinessClassification enumeration list for valid values.

          cmn:BusinessInfo [0...1]
[-]		 - Conditionally required for the US: Provide all required child data elements. Populated with the business name and address of the sold from business entity.
            cmn:BusinessName [1...1]
[1/*]		 String Required. The business name of the TraceLink Customer or Trading Partner. *37
            cmn:Street1 [1...1]
[1/*]		 String Required. The first line of the street address for the company indicated in cmn:BusinessName. *38
            cmn:Street2 [0...1]
[0/*]		 String The second line of the street address for the company indicated in cmn:BusinessName. *39
            cmn:City [1...1]
[1/*		 String Required. The city of the company indicated in cmn:BusinessName. *40
            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]
[1/*]		 String Required. The standard two-letter abbreviation specified in ISO 3166-2:1998 country subdivision code. The state, province, or region of the company specified in cmn:BusinessName. *41

See the ISOCountryCode enumeration list for valid values.
            cmn:PostalCode [0...1]
[0/*]		 String The zip or other postal code of the company indicated in cmn:BusinessName. *42
            cmn:Country [1...1]
[1/*]		 String Required. Two-letter abbreviation specified in ISO 3166-1alpha-2:1997 country code. The country code of the company indicated in cmn:BusinessName. *43

See the ISOCountryCode enumeration list for valid values.

            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).
        choice%2 [0...1]
[-]		 Choice Choice of either cmn:ShipFromLocationLookupId or cmn:ShipFromLocationInfo. Only one can be present.
        cmn:ShipFromLocationLookupId [0...1]
[1/*]		 String Option 1 for the SenderInfo group . This field is a partner identifier (e.g. GLN, DUNS) which triggers the look-up of the partner's address information in TraceLink (the master data). This information then populates the details in the ShipFromLocationInfo. *44
          @type [1...1]
[1/*]		 String Required. The location type.

See the LocationLookupId enumeration list for valid values.
        cmn:ShipFromLocationInfo [0...1]
[-]		 - Conditionally required for the US or if cmn:ShipFromLocationLookupId is not populated. This is Option 2 for the SenderInfo group. The full business information associated with the ship-from location is provided directly. Countries outside the U.S. do not track sold from business and ship-from location separately.
          cmn:FacilityId [1...*]
[1/*]		 String Required. This field is populated with either the ship-from Location Identifier or the ship-to location identifier. *45
For the for US: Provide a DEA, GLN, HIN, or SGLN identifier associated with the ship-from location, and provide the SGLN for the location where the event occurred if not already provided as the selected location identifier.
            @type [1...1]
[1/*]		 String Required. The facility type.

See the BusinessAndLocationId enumeration list for valid values.

Only one of the following values may be used per message:
  • RU_INN_FOREIGN_ENTITY
  • RU_INN_INDIV
  • RU_INN_LOCAL_ENTITY
          cmn:LocationInfo [0...1]
[-]		 String Conditionally required for the US. This field is populated with the business name and address of the business entity. This field is contingent on if this field is associated with the ShipFromLocationInfo or ShipToLocationInfo element.
            cmn:BusinessName [1...1]
[1/*]		 String Required. The business name of the ship-from 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]
[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

Name of the district subdividing the state or region.
            cmn:StateOrRegion [1...1]
[1/*]		 String Required. The state, province, or region of the company specified in cmn:BusinessName. Use the standard two-letter abbreviation specified in ISO 3166-2:1998 country subdivision code.
            cmn:PostalCode [0...1]
[0/*]		 String The zip or other postal code of the company indicated in cmn:BusinessName.
            cmn:Country [1...1]
[1/*]		 String Required. The country code of the company indicated in cmn:BusinessName.

See the ISOCountryCode enumeration list for valid values.

            cmn:CorporateFax [0...1]
[0/*]		 String Comnpany 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:LicenseNumber [0...*]
[0/*]		 String Conditionally required for the US. The LicenseNumber field is populated with the license number of the ship-to or ship-from facility. This element may be repeated to include as many license numbers as required (e.g. state and federal license). *46
            @state [0...1]
[0/*]		 String 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. *47
            @agency [0...1]
[0/*]		 String This attribute is used to give additional context to the LicenseNumber field. It indicates the agency that granted the license to the facility (e.g. Florida DOH, NABP). *48
          cmn:ContactInfo [0...1]
[-]		 String The ContactInfo field contains contact information for use by downstream trading partners to authenticate (i.e. verify) the transaction information recorded on the pedigree with the sender party. This field must contain a name and telephone number but could also include an individual's title, email and/or URL.

Do not include for Ship-From Location.

            cmn:Name [0...1]
[0/*]		 String Required. The name of the contact department or individual at the designated company. *49
            cmn:Title [0...1]
[0/*]		 String The title refers to the individual's job title who is indicated in the Name field. Title information is optional within cmn:ContactInfo. *50
            cmn:Telephone [1...1]
[1/*]		 String Required. The phone number of the contact department or individual at the designated company. This value must begin with the “+” character followed by the Country Calling Code. *51
            cmn:Email [0...1]
[0/*]		 String The email address of the contact department or individual at the designated company. Should be included if available. *52
            cmn:Url [0...1]
[0/*]		 String URL information is optional within cmn:ContactInfo. The URL refers to the designated company’s web address that facilitates authentication. *53
      cmn:ReceiverInfo [0...1]
[ -]		 String Conditional requirements:

Optional if:

  • Transfer or sale within EU FMD countries.
  • Transfer or sale import into an EU FMD country.
  • Transfer or sale export from an EU FMD country to a country other than US, CN, KR, or RU.

Mandatory if:

  • Transfer or sale involving non-EU FMD countries.
  • Transfer or sale export from an EU FMD country to US, CN, KR, or RU because of country compliance requirements.

Information about the supply chain partner that is receiving the shipment. ReceiverInfo contains an XML Choice element on the ToBusinessPartyLookupId and ShipToLocationLookupId that decide whether master data look-up is used to populate the address, license, and contact elements.

        choice%1 [0...1]
[ -]		 Choice Option 1 within choice%1 of Receiverinfo contains only the ToBusinessPartyLookupId (in this case TraceLink populates all of the ToBusinessPartyInfo field data based on company master data lookup). Populate this element only if master data lookup is desired.

Option 2 within choice%1 of ReceiverInfo contains full ToBusinessPartyInfo business address field data that is populated by the customer directly in the interface. Populate this element fully only if no master data lookup is desired.
        cmn:ToBusinessPartyLookupId [0...1]
[0/*]		 String Option 1 for ReceiverInfo message. A look-up identifier associated with the sold to business entity from the provided enumeration list. Use this value as the look-up key in master data to populate the details in ToBusinessPartyInfo. *54
This field is optional, but may be used for master data lookup in TraceLink. An error is thrown if both cmn:ToBusinessPartyLookupId and cmn:ToBusinessPartyInfo are populated.
          @type [1...1]
[1/*]		 String Required. The type of the sold to business entity identifier.

See the BusinessLookupId enumeration list for valid values.
        cmn:ToBusinessPartyInfo [0...1]
[-]		 String Conditionally required if the cmn:ReceiverInfo group is populated, but cmn:ToBusinessPartyLookupId is not populated. Option 2 for ReceiverInfo group. This field is populated with the full business information associated with the sold to business entity.
          cmn:BusinessId [1...*]
[1/*]		 String Required. This field is populated with the full business information associated with the sold to business entity. This value is mandatory for regulatory reporting. Different countries require different values as noted below: *55

Country Requirements:

  • Argentina: Both the GLN and the CUIT number associated with the sold from party are provided.

  • For company's physically located in Brazil: The BR_CNPJ number associated with the sold from party.

  • China: The company identifier registered with China SFDA used to identify the sold from party is provided.
  • Turkey: The GLN associated with the sold from party is provided.
  • US: A DEA, GLN, or HIN identifier associated with the sold from party is provided.
            @type [1...1]
[1/*]		 String

Required. The business id type.

See the BusinessAndLocationId enumeration list for valid values.

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]
[1/*]		 String Conditionally required:
  • For Argentina.
  • If cmn:shipToCountryCode = KR and ReceiptDistributionType = INCOUNTRYRETURN.

This field classifies the business type of the receiving business entity.

See the BusinessClassification enumeration list for valid values.

          cmn:BusinessInfo [0...1]
[0/*]		 String Conditionally required for the US. Populated with the business name and address of the sold to 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]
[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

Name of the district subdividing the state or region.
            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 [0...1]
[0/*]		 String 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.

See the ISOCountryCode enumeration list for valid values.
            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).
        choice%2 [1...1]
[-]		 Choice Can choose either cmn:ShipToLocationLookupId or cmn:ShipToLocationInfo; cannot choose both. No error thrown if none are present.
        cmn:ShipToLocationLookupId [0...1]
[0/*]		 String Option 1 for ReceiverInfo. A look-up identifier associated with the ship-to location using the provided enumeration list. This value will be used as the look-up key in master data to populate the details in ShipToLocationInfo.
          @type [1...1]
[1/*]		 String Required. ship-to location type.

See the LocationLookupId enumeration list for valid values.
        cmn:ShipToLocationInfo [0...1]
[0/*]		 String Conditionally required if for the US, or if cmn:ShipToLocationInfo is available and cmn:ShipToLocationLookupId is not present. Option 2 for ReceiverInfo group. This field is populated with the full business information associated with the ship-to location, which is provided directly.
          cmn:FacilityId [1...*]
[1/*]		 String Required. This field is populated with either the ship-from Location Identifier or the ship-to location identifier. *56
For the US: Provide a DEA, GLN, HIN, or SGLN identifier associated with the ship-to location.
            @type [1...1]
[1/*]		 String Required. The facility id type.

See the BusinessAndLocationId enumeration list for valid values.

Only one of the following values may be used per message:
  • RU_INN_FOREIGN_ENTITY
  • RU_INN_INDIV
  • RU_INN_LOCAL_ENTITY
          cmn:LocationInfo [0...1]
[1/*]		 String Conditionally required for the US. This field is populated with the business name and address of the 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]
[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

Name of the district subdividing the state or region.
            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 [0...1]
[0/*]		 String 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.

See the ISOCountryCode enumeration list for valid values.
            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:LicenseNumber [0...*]
[0/*]		 String Conditionally required for the US. The LicenseNumber field is populated with the license number of the ship-to or ship-from facility. This element may be repeated to include as many license numbers as required (such as, state and federal license).
              @state [0...1]
[0/*]		 String Use the standard two-letter abbreviation specified in ISO 3166-2:1998 country sub-division code. This attribute is used to give additional context to the LicenseNumber field. It indicates the state or region in which the trading partner is licensed.
              @agency [0...1]
[0/*]		 String This attribute is used to give additional context to the LicenseNumber field. It indicates the agency that granted the license to the facility (e.g. Florida DOH, NABP).
            cmn:ContactInfo [0...1]
[-]		 String Conditionally required for the US, do not include for cmn:ShipFromLocation for all other countries. This element contains the contact information to be used by downstream trading partners to verify the message's information. This information may be associated with the fromBusiness, shipFromLocation, toBusiness, and/or shipToLocation elements.
              cmn:Name [0...1]
[0/*]		 String The name field is an attribute of cmn:ContactInfo. It indicates the name of either an individual or department that represents the fromBusiness entity, the shipFromLocation entity, the toBusiness entity, and/or the shipToLocation entity, contingent on which entity the attribute is affixed to.
              cmn:Title [0...1]
[0/*]		 String The title field is an optional attribute of cmn:ContactInfo. It indicates the title of the person indicated in the name field of either the fromBusiness entity, the shipFromLocation entity, the toBusiness entity, and/or the shipToLocation entity, contingent on which entity the attribute is affixed to.
              cmn:Telephone [1...1]
[1/*]		 String Required. This value must begin with the + character followed by the Country Calling Code. The telephone field is an optional attribute of cmn:ContactInfo. It indicates the telephone number of either the fromBusiness entity, the shipFromLocation entity, the toBusiness entity, and/or the shipToLocation entity, contingent on which entity the attribute is affixed to.
              cmn:Email [0...1]
[0/*]		 String The email field is a recommended attribute of cmn:ContactInfo. It indicates the email address of either the fromBusiness entity, the shipFromLocation entity, the toBusiness entity, and/or the shipToLocation entity, contingent on which entity the attribute is affixed to.
              cmn:Url [0...1]
[0/*]		 String The url field is an optional attribute of cmn:ContactInfo. It indicates the website of either the fromBusiness entity, the shipFromLocation entity, the toBusiness entity and/or the shipToLocation entity, contingent on which entity the url field is affixed to.
      cmn:CarrierInfo [0...*]
[-]		 - Conditionally required for Brazil and is required for shipments made into and within Brazil (where cmn:ShipToCountryCode = BR). Information about the transportation partner that is transporting the shipment.
        choice1 [1...1]
[-]		 Choice Required. Must choose populate cmn:CarrierBusinessPartyLookupId or cmn:CarrierBusinessPartyInfo.
        cmn:CarrierBusinessPartyLookupId [0...1]
[1/*]		 String Conditionally required if cmn:CarrierBusinessPartyInfo is not populated. This is Option 1 for cmn:CarrierInfo . This value indicates the look-up identifier associated with the Carrier entity from the provided enumeration list. This value will be used as the look-up key in master data to populate the details in CarrierBusinessPartyInfo. *57
          @type [1...1]
[1/*]		 String Required. The business party type.

See the BusinessLookupId enumeration list for valid values.
        cmn:CarrierBusinessPartyInfo [0...1]
[-]		 - Conditionally required for Brazil, or if cmn:CarrierBusinessPartyLookupId is not populated. Option 2 for cmn:CarrierInfo choice%1 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.
For Brazil: provide the BR_CNPJ, BR_CPF, BR_CNES or BR_PROF_REG, and BR_CNPJ is the value preferred by ANVISA if the company has one.
            @type [1...1]
[1/*]		 String Required. The business id type.

See the BusinessAndLocationId enumeration list for valid values.

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 carrier party.

Valid values:

  • DISTRIBUTOR
  • HEALTHCARE
  • LOGISTICS
  • MANUFACTURER
  • PHARMACY
  • WHOLESALER
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]
[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

Name of the district subdividing the state or region.
            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 [0...1]
[0/*]		 String 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.

See the ISOCountryCode enumeration list for valid values.
            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:WarehouseOperatorName [0...1]
[0/*]		 String Conditionally required for China. This field indicates the 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 picked items have been communicated). *58
    som:AddReceivedItems [0...1]
[-]		 - Conditionally required if som:RemoveReceivedItems is not populated. The som:AddReceivedItems group is populated with the list of serial numbers for the outermost handling units received for this order. TraceLink will look up the child aggregations of the serial numbers provided in the list and update the container and all sub-child items with the received status.
      cmn:Serial [1...*]
[1/*]		 String Required. This attribute identifies the received serial numbers included in the message and their format. *59
        @format [0...1]
[0/*]		 String Required. The format of the serial number.

See the Format enumeration list for valid values.
        @orderItemNumber [0...1]
[0/*]		 String Order item number attribute associating specific serial numbers to the price, VAT, and cost taxes reported in a specific instance of cmn:OrderItem.
    som:RemoveReceivedItems [0...1]
[-]		 - Conditionally required if som:AddReceivedItems is not populated. The som:RemoveReceivedItems group is populated with the list of serial numbers that were previously reported as received for this delivery, but have been unreceived (e.g. will not be a part of the order). TraceLink will look up the child aggregations of the serial numbers provided in the list and update the container and all sub-child items with the available status and disassociate it from the order.
      cmn:Serial [1...*]
[1/*]		 String Required. This attribute identifies the unreceived serial numbers included in the transaction and their format.
        @format [0...1]
[0/*]		 String Required. The format of the serial number.

See the Format enumeration list for valid values.