Master Data Exchange Processing Response Guidelines

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

Message Type: IE_PROCESSING_RESPONSE

Info Exchange Display Name: Processing Response

These fields are sent by TraceLink back to the sender of the initiating message.

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.
The Master Data Exchange messages supported by Processing Response are Master Data Exchange Product Master & Master Data Exchange Partner Master.
Data Element Occurs Format Length Enum Req Description
ie:IEProcessingAckMessage [1...1] - - - M Root element of message.
  ie:ControlFileHeader [1...1] - - - M XML file control header record.
    cmn:FileSenderNumber [1...1] String [1/20] - M File sender's company identifier.1
    cmn:FileReceiverNumber [1...1] String [1/20] - M File recipient's company identifier. *2
    cmn:FileControlNumber [1...1] String [1/*] - M Unique file control ID number. *3
    cmn:FileDate [1...1] Date [10/10] - M Date file generated in XML YYYY-MM-DD format. *4
    cmn:FileTime [1...1] Time [9/9] - M Time file generated in XML HH:MM:SSZ format (must be GMT). *5
  ie:MessageBody [1...1] - - - M Main body of message.
    ie:ProcessingResultsHeader [1...1] - - - M Provides identification of the processed message with information from the original message header, including message type, original message identifier, message sender and receiver identifiers, and original message date and time.
      ie:InputFileTransactionType [1...1] String [1/*] TransactionType M Transaction type of the processed message. Valid values: *6
  • MDX_PRODUCT_MASTER
  • MDX_TRADE_PARTNER_MASTER
      ie:InputFileSenderNumber [1...1] String [1/20] - M FileSenderNumber that was provided in the processed message. *7
      ie:InputFileReceiverNumber [1...1] String [1/20] - M FileReceiverNumber that was provided in the processed message. *8
      ie:InputFileControlNumber [1...1] String [1/*] - M FileControlNumber that was provided in the processed message. *9
      ie:InputFileDate [1...1] Date [10/10] - M FileDate that was provided in the processed message in XML YYYY-MM-DD format. *10
      ie:InputFileTime [1...1] Time [9/9] - M FileTime that was provided in the processed message in XML HH:MM:SSZ format. *11
    ie:ProcessingResults [1...1] - - - M Provides the processing results of the message with a summary of the total number of items updated, total items (of the updated) processed with no warning, total items (of the updated) processed with warning, and the total failed items. For each of these categories, the system returns an "item spec" with identifying information about each item processed, the processing code, and the processing message.
      ie:ProcessingSummary [1...1] - - - M Provides the processing results of the message with a summary of the total number of items updated, total (of the updated) processed with no warning, total (of the updated) processed with warning, and the total failed items. 
        ie:TotalUpdated [1...1] Integer - - M The total number of items from the originating message that were updated by the system.
        ie:TotalProcessedNoWarning [1...1] Integer - - M The total number of updated items from the originating message that were updated without warning. This is a subset of TotalUpdated. If this value is greater than zero, the ProcessedNoWarning element will be populated with the item spec containing identifying information about each item processed including the processing code.
        ie:TotalProcessedWithWarning [1...1] Integer - - M The total number of updated items from the originating message that were updated with warning. This is a subset of TotalUpdated. If this value is greater than zero, the ProcessedWithWarning element will be populated with the item spec containing identifying information about each item that had a warning, including the processing code and processing message.
        ie:TotalFailed [1...1] Integer - - M The total number of updated items from the originating message that were not updated as a result of errors. If this value is greater than zero, the FailedItem element will be populated with the item spec containing identifying information about each item that failed, including the processing code and processing message.
      ie:ProcessedNoWarning [0...1] - - - C This element contains one item spec with the processing code for each item updated without warning. The item spec contains identifying information about each item processed. The number of item specs will be equal to the value of TotalProcessedNoWarning. If TotalProcessedNoWarning = 0,  ProcessedNoWarning will not be populated.
        ie:ProcessedItem [1...*] - - - M List of one or more item specs with the processing code for each item updated without warning.
          choice%1 [0...1] Choice - - O The choice%1 element is optional, but one of the following choices can be optionally provided:
  • Option 1 within choice%1 is the ProductMasterDataSpec, used to create or update the product master data messages.
  • Option 2 within choice%1 is the PartnerMasterDataSpec, used to create or update partner company or location master data.
          ie:ProductMasterDataSpec [0...1] - - - O Option 1 for choice%1 group. Used to create or update product master data messages in the system.
            cmn:PrimaryItemCode [1...1] String [1/*] - M Primary product identifier that is used as the key for updating the product master data record. *12
              @type [1...1] String [1/*] ItemCodeType M The attribute identifies the item code types.
            cmn:AlternateItemCode [0...*] String [1/*] - O Alternate product identifier that is used to identify the product. *13
              @type [1...1] String [1/*] ItemCodeType M The attribute identifies the item code types.
              @action [0...1] String [0/*] - O Not currently used. The attribute identifies action.

Valid value: "DELETE".
            cmn:CountryMarket [0...*] String [1/3] - C The country using the standard two- or three-letter abbreviation specified in ISO 3166-1alpha-2:1997 country code. *14
EU Countries are required for master data reporting to EFPIA EMVS Hub.
            cmn:LanguageCode [0...*] String [1/3] Language O The language using the standard two- or three-letter abbreviation specified in ISO 639-1 language code.
            cmn:PackagingCode [0...*] String [1/*] - O Serialization packaging code identifier value for the unit of measure (e.g. each, innerpack, case). *15
              @type [1...*] String [1/*] PkgCode M Serialization packaging code identifier types.
          ie:PartnerMasterDataSpec [0...1] - - - O Option 2 for choice%1 group. Used to create or update partner company or location master data in messages submitted to the system.
            cmn:PrimaryCompanyId [0...1] String [1/*] - C Primary company identifier that is used as the key for updating the partner master data record. *16
Country Requirements:
  • Argentina: Requires GLN and CUIT to identify sold from and sold to entities.
  • Brazil: Requires CNPJ to identify sold from/to and ship from/to entities.
  • Turkey: Requires GLN to identify sold from and sold to entities.
  • US: Use of GLN, SGLN, DEA, HIN to identify sold from and sold to entities for EPCIS events.
              @type [1...1] String [1/*] LocationId M The attribute identifies the company id types.
            cmn:AlternateCompanyId [0...*] String [1/*] - C Alternate company identifier that is used to identify the company. *17
Country Requirements:
  • Argentina: Requires GLN and CUIT to identify sold from and sold to entities.
  • Brazil: Requires CNPJ to identify sold from/to and ship from/to entities.
  • Turkey: Requires GLN to identify sold from and sold to entities.
  • US: Use of GLN, SGLN, DEA, HIN to identify sold from and sold to entities for EPCIS events.
              @type [1...1] String [1/*] CompanyId M The attribute identifies the company id types.
Only one of the following values may be used per message:
  • RU_INN_FOREIGN_ENTITY
  • RU_INN_INDIV
  • RU_INN_LOCAL_ENTITY
              @action [0...1] String [0/*] - O Not currently used. The attribute identifies action.

Valid value: "DELETE".
            cmn:CompanyIdReference [0...1] String [1/*] - O Primary company identifier for the company to which the location belongs. *18
              @type [1...1] String [1/*] CompanyId M The attribute identifies the company id types.
Only one of the following values may be used per message:
  • RU_INN_FOREIGN_ENTITY
  • RU_INN_INDIV
  • RU_INN_LOCAL_ENTITY
            cmn:PrimaryLocationId [0...1] String [1/*] - C Primary location identifier that is used as the key for updating the location master data record. *19
Country Requirements:
  • Brazil: Requires CNPJ to identify sold from/to and ship from/to entities.
  • US: Use of GLN, SGLN, DEA, HIN to identify sold from and sold to entities for EPCIS events.
              @type [1...1] String [1/*] LocationId M The attribute identifies the location id types.
            cmn:AlternateLocationId [0...*] String [1/*] - O Alternate location identifier that is used to identify the company.
Country Requirements:
  • Brazil: Requires CNPJ to identify sold from/to and ship from/to entities.
  • US: Use of GLN, SGLN, DEA, HIN to identify sold from and sold to entities for EPCIS events.
              @type [1...1] String [1/*] CompanyId M The attribute identifies the location id types.
Only one of the following values may be used per message:
  • RU_INN_FOREIGN_ENTITY
  • RU_INN_INDIV
  • RU_INN_LOCAL_ENTITY
              @action [0...1] String [0/*] - O Not currently used. The attribute identifies action.

Valid value: "DELETE".
            cmn:LicenseInfo [0...*] String [1/*] - O The license number of the company for this facility. *20
              @stateOrRegion [0...1] String [0/*] - O The state or region in which the trading partner is licensed, using the standard two- or three-letter abbreviation specified in ISO 3166-2:1998 country sub-division code. *21
              @country [0...1] String [0/*] - O Country in which facility is licensed, using the standard two- or three-letter abbreviation specified in ISO 3166-1alpha-2:1997 country code. *22
              @agency [0...1] String [0/*] - O The agency that granted the license (e.g. Florida DOH, NABP, DEA, VAWD). *23
              @action [0...1] String [0/*] - O Attribute defining if the license should be deleted. The delete action only occurs if explicitly set to "DELETE". *24
          ie:ProcessingCode [1...1] String [1/*] - M The processing code assigned by the system to indicate the success, failure, or warning.
          ie:ProcessingMessage [0...*] String [1/*] - O The processing message with detail on why the item in the item spec incurred a warning or failure.
      ie:ProcessedWithWarning [0...1] - - - O This element contains one item spec with processing code and processing message for each item updated without warning. The item spec contains identifying information about each item processed. The number of item specs will be equal to the value of TotalProcessedWithWarning.  If TotalProcessedWithWarning = 0,  ProcessedWithWarning will not be populated. The items specs that follow use the exact same item specs as described above.
        ie:ProcessedItem [1...*] - - - M List of one or more item specs with processing code for each item updated WITH warning.
          choice%2 [0...1] Choice - - O The choice%2 element is optional, but one of the following choices can be optionally provided:
  • Option 1 within choice%2 is the ProductMasterDataSpec, used to create or update the product master data messages.
  • Option 2 within choice%2 is the PartnerMasterDataSpec, used to create or update partner company or location master data.
          ie:ProductMasterDataSpec [0...1] - - - O Option 1 for choice%2 group. Used for product master data messages submitted to the system to create or update product master data.
            cmn:PrimaryItemCode [1...1] String [1/*] - M Primary product identifier that is used as the key for updating the product master data record.
              @type [1...1] String [1/*] ItemCodeType M The attribute identifies the item code types.
            cmn:AlternateItemCode [0...*] String [1/*] - O Alternate product identifier that is used to identify the product.
              @type [1...1] String [1/*] ItemCodeType M The attribute identifies the item code types.
              @action [0...1] String [0/*] - O The attribute identifies action. Not currently used.

Valid value: " DELETE".
            cmn:CountryMarket [0...*] String [1/3] - O The country using the standard two- or three-letter abbreviation specified in ISO 3166-1alpha-2:1997 country code.
EU Countries: Required for master data reporting to EFPIA EMVS Hub.
            cmn:LanguageCode [0...*] String [1/3] Language O The language using the standard two- or three-letter abbreviation specified in ISO 639-1 language code.
            cmn:PackagingCode [0...*] String [1/*] - O Serialization packaging code identifier value for the unit of measure (e.g. each, innerpack, case).
              @type [1...*] String [1/*] PkgCode M Serialization packaging code identifier types.
          ie:PartnerMasterDataSpec [0...1] - - - O Option 2 for choice%2 group. Used for partner master data messages submitted to the system to create or update partner company or location master data.
            cmn:PrimaryCompanyId [0...1] String [1/*] - O Primary company identifier that is used as the key for updating the partner master data record.
              @type [1...1] String [1/*] LocationId M The attribute identifies the company id types.
            cmn:AlternateCompanyId [0...*] String [1/*] - O Alternate company identifier that is used to identify the company.
Country Requirements:
  • Argentina: Requires GLN and CUIT to identify sold from and sold to entities.
  • Brazil: Requires CNPJ to identify sold from/to and ship from/to entities.
  • Turkey: Requires GLN to identify sold from and sold to entities.
  • US: Use of GLN, SGLN, DEA, HIN to identify sold from and sold to entities for EPCIS events.
              @type [1...1] String [1/*] CompanyId M The attribute identifies the company id types.
Only one of the following values may be used per message:
  • RU_INN_FOREIGN_ENTITY
  • RU_INN_INDIV
  • RU_INN_LOCAL_ENTITY
              @action [0...1] String [0/*] - O The attribute identifies action. Not currently used.

Valid value: "DELETE".
            cmn:CompanyIdReference [0...1] String [1/*] - O Primary company identifier for the company to which the location belongs.
              @type [1...1] String [1/*] CompanyId M The attribute identifies the company id types.
Only one of the following values may be used per message:
  • RU_INN_FOREIGN_ENTITY
  • RU_INN_INDIV
  • RU_INN_LOCAL_ENTITY
            cmn:PrimaryLocationId [0...1] String [1/*] - O Primary location identifier that is used as the key for updating the location master data record.
Country Requirements:
  • Brazil: Requires CNPJ to identify sold from/to and ship from/to entities.
  • US: Use of GLN, SGLN, DEA, HIN to identify sold from and sold to entities for EPCIS events.
              @type [1...1] String [1/*] LocationId M The attribute identifies the location id types.
            cmn:AlternateLocationId [0...*] String [1/*] - O Alternate location identifier that is used to identify the company. Regulatory Use:
Country Requirements:
  • Brazil: Requires CNPJ to identify sold from/to and ship from/to entities.
  • US: Use of GLN, SGLN, DEA, HIN to identify sold from and sold to entities for EPCIS events.
              @type [1...1] String [1/*] CompanyId M The attribute identifies the Location ID types.
Only one of the following values may be used per message:
  • RU_INN_FOREIGN_ENTITY
  • RU_INN_INDIV
  • RU_INN_LOCAL_ENTITY
              @action [0...1] String [0/*] - O The attribute identifies action. Not currently used.

Valid value: DELETE
            cmn:LicenseInfo [0...*] String [1/*] - O The license number of the company for this facility. 
              @stateOrRegion [0...1] String [0/*] - O The state or region in which the trading partner is licensed, using the standard two- or three-letter abbreviation specified in ISO 3166-2:1998 country sub-division code.
              @country [0...1] String [0/*] - O Country in which facility is licensed using the standard two- or three-letter abbreviation specified in ISO 3166-1alpha-2:1997 country code.
              @agency [0...1] String [0/*] - O The agency that granted the license (e.g. Florida DOH, NABP, DEA, VAWD).
              @action [0...1] String [0/*] - O Attribute defining if the license should be deleted. The delete action only occurs if explicitly set to "DELETE". *25
          ie:ProcessingCode [1...1] String [1/*] - M The processing code assigned by the system to indicate the success, failure, or warning.
          ie:ProcessingMessage [0...*] String [1/*] - O The processing message with detail on why the item in the item spec incurred a warning or failure.
      ie:FailedItem [0...1] - - - O This element contains one item spec with processing code and processing message for each item that failed to be updated. The item spec contains identifying information about each item that failed. The number of item specs will be equal to the value of TotalFailed. If TotalFailed = 0,  FailedItem will not be populated.
        ie:ProcessedItem [1...*] - - - M List of one or more item specs with processing code for each item updated WITH warning.
          choice%3 [0...1] Choice - - O The choice%3 group is optional. ie:FailedItem may include only an error code and message if the inbound failure occurs before the incoming message is translated. One of the following choice options can be provided:
  • Option 1 within choice%3 is the ProductMasterDataSpec, used to create or update the product master data messages.
  • Option 2 within choice%3 is the PartnerMasterDataSpec, used to create or update partner company or location master data.
          ie:ProductMasterDataSpec [0...1] - - - O Option 1 for choice%3 group. Used for product master data messages submitted to the system to create or update product master data.
            cmn:PrimaryItemCode [1...1] String [1/*] - M Primary product identifier that is used as the key for updating the product master data record.
              @type [1...1] String [1/*] ItemCodeType M The attribute identifies the item code types.
            cmn:AlternateItemCode [1...1] String [1/*] - O Alternate product identifier that is used to identify the product.
              @type [1...1] String [1/*] ItemCodeType M The attribute identifies the item code types.
              @action [0...1] String [0/*] - O The attribute identifies action. Not currently used.

Valid value: " DELETE".
            cmn:CountryMarket [0...*] String [1/3] - O The country using the standard two- or three-letter abbreviation specified in ISO 3166-1alpha-2:1997 country code.
EU Countries: Mandatory for master data reporting to EFPIA EMVS Hub.
            cmn:LanguageCode [0...*] String [1/3] Language O The language using the standard two- or three-letter abbreviation specified in ISO 639-1 language code.
            cmn:PackagingCode [0...*] String [1/*] - O Serialization packaging code identifier value for the unit of measure (e.g. each, innerpack, case).
              @type [1...*] String [1/*] PkgCode M Serialization packaging code identifier types.
          ie:PartnerMasterDataSpec [0...1] - - - O Option 2 for choice%3 group. Used for partner master data messages submitted to the system to create or update partner company or location master data.
            cmn:PrimaryCompanyId [0...1] String [1/*] - O Primary company identifier that is used as the key for updating the partner master data record.
Country Requirements:
  • Argentina: Requires GLN and CUIT to identify sold from and sold to entities.
  • Brazil: Requires CNPJ to identify sold from/to and ship from/to entities.
  • Turkey: Requires GLN to identify sold from and sold to entities.
  • US: Use of GLN, SGLN, DEA, HIN to identify sold from and sold to entities for EPCIS events.
              @type [1...1] String [1/*] LocationId M The attribute identifies the company id types.
            cmn:AlternateCompanyId [0...*] String [1/*] - O Alternate company identifier that is used to identify the company.
Country Requirements:
  • Argentina: Requires GLN and CUIT to identify sold from and sold to entities.
  • Brazil: Requires CNPJ to identify sold from/to and ship from/to entities.
  • Turkey: Requires GLN to identify sold from and sold to entities.
  • US: Use of GLN, SGLN, DEA, HIN to identify sold from and sold to entities for EPCIS events.
              @type [1...1] String [1/*] CompanyId M The attribute identifies the company ID types.
Only one of the following values may be used per message:
  • RU_INN_FOREIGN_ENTITY
  • RU_INN_INDIV
  • RU_INN_LOCAL_ENTITY
              @action [0...1] String [0/*] - O The attribute identifies action. Not currently used.

Valid value: "DELETE".
            cmn:CompanyIdReference [0...1] String [1/*] - O Primary company identifier for the company to which the location belongs.
              @type [1...1] String [1/*] CompanyId M The attribute identifies the company ID types.
Only one of the following values may be used per message:
  • RU_INN_FOREIGN_ENTITY
  • RU_INN_INDIV
  • RU_INN_LOCAL_ENTITY
            cmn:PrimaryLocationId [0...1] String [1/*] - O Primary location identifier that is used as the key for updating the location master data record.
Country Requirements:
  • Brazil: Requires CNPJ to identify sold from/to and ship from/to entities.
  • US: Use of GLN, SGLN, DEA, HIN to identify sold from and sold to entities for EPCIS events.
              @type [1...1] String [1/*] LocationId M The attribute identifies the location id types.
            cmn:AlternateLocationId [0...*] String [1/*] - O Alternate location identifier that is used to identify the company.
Country Requirements:
  • Brazil: Requires CNPJ to identify sold from/to and ship from/to entities.
  • US: Use of GLN, SGLN, DEA, HIN to identify sold from and sold to entities for EPCIS events.
              @type [1...1] String [1/*] CompanyId M The attribute identifies the location ID types.
Only one of the following values may be used per message:
  • RU_INN_FOREIGN_ENTITY
  • RU_INN_INDIV
  • RU_INN_LOCAL_ENTITY
              @action [0...1] String [0/*] - O The attribute identifies action. Not currently used.

Valid value: "DELETE".
            cmn:LicenseInfo [0...*] String [1/*] - O The license number of the company for this facility. 
              @stateOrRegion [0...1] String [0/*] - O The state or region in which the trading partner is licensed, using the standard two- or three-letter abbreviation specified in ISO 3166-2:1998 country sub-division code.
              @country [0...1] String [0/*] - O Country in which facility is licensed using the standard two- or three-letter abbreviation specified in ISO 3166-1alpha-2:1997 country code.
              @agency [0...1] String [0/*] - O The agency that granted the license (e.g. Florida DOH, NABP, DEA, VAWD).
              @action [0...1] String [0/*] - O Attribute defining if the license should be deleted. The delete action only occurs if explicitly set to "DELETE". *26
          ie:ProcessingCode [1...1] String [1/*] - M The processing code assigned by the system to indicate the success, failure, or warning.
          ie:ProcessingMessage [0...*] String [1/*] - O The processing message with detail on why the item in the item spec incurred a warning or failure.