Serial Number Manager Request Guidelines

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

Message Type: SNM_REQUEST

Info Exchange Display Name: Serial Number Replenish Request

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:SNMRequestType [1...1] - - - M Root data element.
  snm:ControlFileHeader [1...1] - - - M Serial Number Manager control header record group.
    cmn:FileSenderNumber [1...1] String [1/*] - M File sender's company identifier. *1
    cmn:FileReceiverNumber [1...1] String [1/*] - 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 [0/*] - M Date file generated in XML YYYY-MM-DD format. *4
    cmn:FileTime [1...1] Time [0/*] - M Time file generated in XML HH:MM:SSZ format (must be GMT). *5
  snm:MessageBody [1...1] - - - M Request Details.
    cmn:RequestId [1...1] String [1/*] - M Unique identifier for the serial number request. This is used to link the Serial Number Response from Serial Number Manager back to the originating Serial Number Response. *6
    cmn:PlantIdentifier [0...1] String [0/*] - O Identifier of plant location requesting serial numbers. Required by Serial Number Manager applications to track the plant that commissioned the serial numbers. *7
      @type [1...1] String [0/*] LocationType M Plant location identifier type. Indicates the encoding type that is used to identify the requesting site location. *8
    cmn:ReferenceDocuments [0...1] - - - - Reference to specific manufacturing orders associated with the Serial Number Request. Indicates that the requested serial numbers will be used for the referenced manufacturing orders.
      cmn:PONumber [0...1] String [0/*] - O Purchase order (PO) number associated with Serial Number Request. *9
      cmn:POLine [0...1] String [0/*] - O PO line number associated with Serial Number Request. *10
      cmn:WorkOrderNumber [0...1] String [0/*] - O Work order number associated with Serial Number Request. *11
      cmn:ReferenceIdentifier [0...1] String [0/*] - O Reference identifier. *12
    cmn:NumberEncoding [1...1] String [0/*] Encoding M Encoding format for the type of serial numbers that are being requested from the enumeration list (e.g. AI(01)+AI(21) for serialized GTIN, AI(00) for SSCC-18). *13
    cmn:RU_CryptoCodeRequest [0...1] Boolean - - C Indicates a request for Kazakhstan Crypto Codes, Russia crypto codes , or Uzbekistan Crypto Codes. The default value is "false". Valid values: *14
  • true = Request crypto codes. Kazakhstan Crypto Codes, Russia crypto codes, or Uzbekistan Crypto Codes are expected in the Serial Number Manager Response Serial Number Manager Response.
  • false = Do not request crypto codes. Kazakhstan Crypto Codes, Russia crypto codes , or Uzbekistan Crypto Codes are not expected in the Serial Number Manager Response Serial Number Manager Response.

Mandatory for Kazakhstan, Russia , or Uzbekistan Crypto Codes serial number requests from SAP.

    cmn:ObjectIdentifier [1...1] Choice - - M The identifier associated with the cmn:NumberEncoding for the serial numbers being requested. There is a choice element within the ObjectIdentifier data element, meaning that only one of the four options below can be populated.
      cmn:CompanyPrefixObjectKey [0...1] String [1/*] - O The company prefix assigned by GS1 for the required SSCC numbers. Used only when cmn:NumberEncoding is for SSCC numbers. *15
        @filterValue [0...1] Integer [0/*] FilterValue O The Filter Value for the packaging level of the SSCC number that is being requested to indicate if the SSCC is for a pallet, mixed case, etc. This should be an integer with a value 0-7.
      cmn:GTIN-14 [0...1] String [1/*] - O The GTIN-14 for the required SGTIN and AI(01)+AI(21) serial numbers. The GTIN-14 also informs logistical unit. Used only when cmn:NumberEncoding is for SGTIN and AI(01)+AI(21). *16
      cmn:CNSubtypeObjectKey [0...1] String [10/10] - O China encoded number. If populated, source cmn:NumberEncoding = CN-EDMC. *17
        @codeLevel [1...1] Integer [0/*] - C Code level. *18
Mandatory if cmn:CNSubtypeObjectKey is populated.
        @packageRatio [0...1] String [0/*] - O Package ratio. *19

Optional if CNSubtypeObjectKey is populated.
        @codeVersion [0...1] Integer [0/*] - O Specific packaging ratio associated with the product.20

Optional if CNSubtypeObjectKey is populated.
      cmn:CNResCodeObjectKey [0...1] String [5/5] - O China encoded number. 5-digit product (RES) code *21
        @codeLevel [1...1] Integer [0/*] - M 2-digit code level.22
        @packageRatio [0...1] String [0/*] - O 2-digit code version.
        @codeVersion [0...1] Integer [0/*] - O Specific packaging ratio associated with the product. 23
      cmn:NTINObjectKey [0...1] String [1/*] - C The NTIN for the required NTIN and AI(01)+AI(21) serial numbers. The NTIN also informs logistical unit. Used only when cmn:NumberEncoding is for SGTIN and AI(01)+AI(21). *24
    cmn:Quantity [1...1] Int [1/*] - M Quantity of serial numbers requested. *25