Serial Number Manager Response Guidelines (Verify Brand for Russia Crypto Codes)

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

Message Type: SNM_RESPONSE

Info Exchange Display Name: Serial Number Replenish Response

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 Format Length Enums Req Description
CodeRequestReport [1...1] - - - M Root data element.
  Quantity [1...1] Integer [1/*] - M The total quantity of UIDs contained in the file. *1
  CompanyPrefix [0...1] Integer [1/*] - C The company prefix (product number value) associated with the allocated UIDs. *2
At least one, and only one, of CompanyPrefix or AssociatedProducts, or AssociatedProducts | Value is required.
Mandatory if UID contains SSCCs.
  ExtensionDigit [0...1] Integer [1/*] - O This field not used.
  DateCodesWereGenerated [1...1] DateTime [1/*] - M The date/time the UIDs were generated in the Verify Platform. *3
  CodeRequestKey [1...1] String [0/*] - M The unique key associated with the UID request. *4
  AssociatedProducts [1...1] - - - M Request identifier fields. Populated with TraceLink and Verify Brand request identifiers.
For SSCCs, an empty tag is sent.
At least one, and only one, of CompanyPrefix or AssociatedProducts, or AssociatedProducts | Value is required.
    AssociatedProduct [0…*] - - - C Message group header for looping group.
Mandatory if UID contains SGTINs.
      Type [1...1] String [0/*] - M The product reference identifier type. The most common value is "GTIN". Valid values: *5
  • GTIN
  • NTIN
      Value [1...1] String [0/*] - M The product reference identifier. The most common value is the class-level urn for GTIN, (e.g. urn:epc:id:sgtin:0369999.039801).* *6
At least one, and only one, of CompanyPrefix or AssociatedProducts, or AssociatedProducts | Value is required.
  SenderId [1...1] String [0/*] - M Identifier for the sender of the file.
  UIDs [1...1] - - - O Request identifier fields. Populated with TraceLink and Verify Brand request identifiers.
    UID [1...*] - - - M Parent element for serial numbers in urn format, crypto key, and crypto code.
      URN [1...1] String [0/*] - M Explicit list of UIDs (serial numbers) in urn format. This is a repeating element. *7
      CryptoKey [1...1] String [0/*] - M The crypto key value retrieved from the OMS owned by the pharmaceutical manufacturer. Crypto keys are alphanumeric and are 4 characters long. *8
      CryptoCode [1...1] String [0/*] - M The crypto key value retrieved from the OMS owned by the pharmaceutical manufacturer. Crypto codes can contain alphanumeric values as well as symbols and are either 44 or 88 characters long. AI(92) denotes this value in the serial number. The following are valid symbols: *9
  • !
  • " – (")
  • %
  • & – (&)
  • ' – (')
  • *
  • +
  • -
  • .
  • /
  • _
  • ,
  • :
  • ;
  • =
  • &lt; – (<)
  • &gt; – (>)
  • ?
TraceLink escapes the following special XML characters before sending the Serial Number Manager Response message:
  • &quot; – (")
  • &amp; – (&)
  • &apos; – (')
  • &lt; – (<)
  • &gt; – (>)
  Location [1...1] - - - M Location group header.
    References [1...1] - - - M Location reference identifier.
      Reference [1...1] String [0/*] - M The location reference identifier type. The most common value is "SGLN". Location refers to the location the UIDs were requested for. *10
      Name [1...1] String [0/*] - O The location reference identifier name. *11
  BusinessTransactions [1...1] - - - M Business Transactions group header.
    BusinessTransaction [0…*] - - - O Business Transaction group header.
      Type [1...1] String [0/*] - M Not used.
      ID [1...1] String [0/*] - M Not used.