Serial Number Manager Response Guidelines (XML)

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
snm:SNMResponseMessage [1...1] - - - M Root data element.
  snm:ControlFileHeader [1...1] - - - M Serial Number Manager control header record group.
    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 [1/*] - M Date file generated in XML YYYY-MM-DD format. *4
    cmn:FileTime [1...1] Time [1/*] - M Time file generated in XML HH:MM:SSZ format (must be GMT). *5
  snm:MessageBody [1...1] - - - M Main body of message.
    cmn:RequestId [1...1] String [1/*] - M Request Identifier. *6
    cmn:ReferenceDocuments [0...1] - - - O Optional reference documents related to the request.
      cmn:PONumber [0...1] String [0/*] - O Purchase order (PO) number associated with serial number request. *7
      cmn:POLine [0...1] String [0/*] - O PO line number associated with serial number request. *8
      cmn:WorkOrderNumber [0...1] String [0/*] - O Work order number associated with serial number request. *9
      cmn:ReferenceIdentifier [0...1] String [1/*] - O Reference Number. *10
    cmn:NumberEncoding [1...1] String [0/*] Encoding M Encoding format for the type of serial numbers that are being requested from the enumeration list. Valid values: *11
  • AI(00) = SSCC
  • AI(01)+AI(21) = GTIN or NTIN
  • CN-EDMC = China product code
    cmn:ObjectIdentifier [1...1] Choice - - M The identifier associated with the NumberEncoding for the serial numbers being requested. Valid values:
  • CNSubtypeObjectKey
  • CompanyPrefixObjectKey
  • GTIN-14
  • NTINObjectKey
      cmn:CompanyPrefixObjectKey [0...1] String [0/*] - O The company prefix assigned by GS1 for the required SSCC numbers. Used only when NumberEncoding is for SSCC numbers. *12
        @filterValue [0...1] String [0/*] - O Filter value identifying packaging hierarchy level of SSCC number being requested.
      cmn:GTIN-14 [0...1] String [0/*] - O The GTIN-14 identifier for the serial numbers. The GTIN-14 also informs logistical unit. *13
      cmn:CNSubtypeObjectKey [0...1] String [10/10] - O China encoded number. *14
        @codeLevel [1...1] Integer [0/*] - C Code level.
Mandatory if cmn:CNSubtypeObjectKey is populated.
        @packageRatio [0...1] String [0/*] - O Package ratio.
        @codeVersion [0...1] Integer [0/*] - O

Specific packaging ratio associated with the product.
      cmn:CNResCodeObjectKey [0...1] String [5/5] - O China encoded number. 5-digit product (RES) code *15
        @codeLevel [0...1] Integer [0/*] - O

2-digit code level.

        @packageRatio [0...1] String [0/*] - O 2-digit code version.

Optional if cmn:CNResCodeObjectKey is populated.
        @codeVersion [0...1] Integer [0/*] - O

Specific packaging ratio associated with the product.

      cmn:NTINObjectKey [1...1] String [1/*] - O The NTIN (National Trade Item Identifier) for the serial numbers. *16
    cmn:Quantity [1...1] Integer - - M Quantity of serial numbers requested. *17
    choice%1 [1...1] Choice - - M Only one of three different business use cases is supported in this choice:
  1. A serial number range
  2. A random list of serial numbers
  3. An error code and message

Only one of SerialNumberRange, SerialNumberList, or ErrorMessage should be populated, else an error message will be thrown.
    cmn:SerialNumberRange [0...1] - - - O Serial number range of serial numbers being returned in response.
      cmn:StartingNumber [1...1] String [1/*] - M Starting serial number in range. *18
Serial number is expected fully formatted in AI(00) or AI(01)+AI(21) format or China number formats.
      cmn:EndingNumber [1...1] String [1/*] - M Ending serial number in the range. *19
Serial number is expected fully formatted in AI(00) or AI(01)+AI(21) format or China number formats.
    cmn:SerialNumberList [0...1] - - - O -
      @isRandom [0...1] Boolean - - C Attribute that identifies random list of serial numbers.
Mandatory for Kazakhstan, Russia, and Uzbekistan serial numbers.
      cmn:SerialNumber [1...*] String [1/*] - M Serial number in a list of serial numbers. This is a repeating element. *20
Serial number is expected fully formatted in AI(00) or AI(01)+AI(21) format or China number formats.
SGTINs are mandatory for Kazakhstan, Russia, and Uzbekistan serial numbers.
        @cryptoKey [0...1] String [4/4] - C The crypto key value retrieved from the Order Management System.  AI(91) denotes this value in the serial number. Crypto keys are alphanumeric and are 4 characters long. *21
Mandatory for Kazakhstan, Russia, and Uzbekistan serial numbers.
        @cryptoCode [0...1] String [0/88] - C The crypto code value retrieved from the Order Management System. This value 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: *22
  • !
  • " – (")
  • %
  • & – (&)
  • ' – (')
  • *
  • +
  • -
  • .
  • /
  • _
  • ,
  • :
  • ;
  • =
  • &lt; – (<)
  • &gt; – (>)
  • ?
Mandatory for Kazakhstan, Russia and Uzbekistan serial numbers.
TraceLink escapes the following special XML characters before sending the Serial Number Manager Response message:
  • &quot; – (")
  • &amp; – (&)
  • &apos; – (')
  • &lt; – (<)
  • &gt; – (>)
        @cryptoAcquisitionDate [0...1] Date [1/* - O The date that @cryptoKey and @cryptoCode are retrieved from the OMS. *23
    cmn:ErrorMessage [0...1] - - - O -
      cmn:ErrorCode [1...1] String [0/24] - M Error code returned if an error occurred. *24
      cmn:ErrorDescription [1...1] String [0/219] - M Error message if an error occurred. *25