Request serial number APIs

Serial number request messages allow manufacturing locations to request serial numbers for their location during production. TraceLink responds to request messages with the serial numbers provisioned for that location.

Serial Number Request

This message uses the Park and Retry functionality. If a prerequisite condition for this message has not been met, TraceLink stops processing the message, returns the message to the queue, and then tries to process the message again every 15 minutes for up to 2 hours.

Request

  • Message type: SNM_REQUEST
  • Info Exchange display name: Serial Number Replenish Request
  • Map Version:TL_XML_SNM_Request_1_0_OB_V1_2

Element Occurs Length Type Description
snm:SNMRequestType [0...1]
[–]		 – Required. The SNM request root element.
  snm:ControlFileHeader [1...1]
[–]		 – Required. The XML file control header.
    cmn:FileSenderNumber [1...1]
[1/*]		 String Required. The unique identifier for the company sending the message (e.g. 7777776067344).
    cmn:FileReceiverNumber [1...1]
[1/*]		 String Required. The unique identifier for the company receiving the message (e.g. 8888884043588).
    cmn:FileControlNumber [1...1]
[1/*]		 String Required. The unique file identifier assigned by the message sender.
    cmn:FileDate [1...1]
[0/*]		 Date Required. The date the file was generated in YYYY-MM-DD format (e.g. 2023-06-30).
    cmn:FileTime [1...1]
[0/*]		 Time Required. The time the file was generated in HH:MM:SSZ format (e.g. 06:30:32Z).
  snm:MessageBody [1...1]
[–]		 – Required. The body of the XML message.
    cmn:RequestId [1...1]
[1/*]		 String

Required. The unique identifier for the serial number request, used to link the Serial Number Response from SNM back to the originating Serial Number Response (e.g. 20160201090909_08806500018314).
    cmn:PlantIdentifier [0...1]
[0/*]		 String The identifier for the plant location requesting serial numbers (e.g. PFZFG01).
      @type [1...1]
[0/*]		 String

Required. The plant location identifier type.

  • BR_CNPJ – Brazil Tax / Legal Entity ID (14 digits, with format 00.000.000/0001-00)

  • BR_CPF – Brazil Tax / Legal Entity ID (14 digits, with format 00.000.000/0001-00)

  • BR_PROF_REG – Brazil Professional Registration Number

  • CN_CHINA_ID – China identifier (alphanumeric)

  • COMPANYID – Internal company identifier (alphanumeric)

  • COMPANYSITEID – Internal Location or Site Id in Internal ERP System

  • DEA – Drug Enforcement Agency Number

  • DUNS – Dunn and Bradstreet Number (9 digit number)

  • DUNS4 – Dunn and Bradstreet Number with 4 digit extension (13 digit number)

  • GCP GS1 – Global Company Prefix (6-12 digit number)

  • GLN – Global Location Number (13 digit number)

  • HIN – Health Industry Number partnern address ID

  • IN_COMPANY_ID – India company identifier

  • IN_IEC – India Importer Exporter Code (10 digit number)

  • IN_PAN – India Permanent Account Number (10 character alphanumeric)

  • IN_TIN – India Taxpayer Identification Number (11 digit number)

  • KR_BUS_REG_NUMBER – Korea Business Registration Number (10 digit number, with format 000-00-0000)

  • KR_PROVIDER_CODE – Korea Provider Code (8 digit number)

  • SGLN – SGLN format representation of Global Location Number (e.g., <CompanyPrefix>.<LocationRef>.0, First two segments contain only digits, min length is 15)
    cmn:ReferenceDocuments [0...1]
[–]		 – A reference to specific manufacturing orders associated with the Serial Number Request and indicates that the requested serial numbers will be used for the referenced manufacturing orders.
      cmn:PONumber [0...1]
[0/*]		 String The number of the purchase order (PO) issued by the manufacturer for the lot production (e.g. 1001764).
      cmn:POLine [0...1]
[0/*]		 String The line number for the lot production from the PO issued by the manufacturer (e.g. 001).
      cmn:WorkOrderNumber [0...1]
[0/*]		 String The work order number associated with the serial number request (e.g. 1001764-00).
      cmn:ReferenceIdentifier [0...1]
[0/*]>		 String The reference number (e.g. RI942013).
    cmn:NumberEncoding [1...1]
[0/*]		 String Required. The encoding format for the type of serial numbers that are being requested from the enumeration list.

Valid values:

  • AI(00) – The bar code representation of an SSCC-18 number, and the equivalent of the SSCC-96 scheme.

  • AI(01)+AI(21) – The bar code representation of a serialized GTIN number, and the equivalent of the SGTIN-96 scheme.

  • CN-EDMC – The China number encoding format.
    cmn:RU_CryptoCodeRequest [0...1]
[–]		 Boolean

Conditionally required. Indicates a request for Kazakhstan Crypto Codes, Russia crypto codes , or Uzbekistan Crypto Codes. The default value is "false". Mandatory for Kazakhstan, Russia , or Uzbekistan Crypto Codes serial number requests from SAP.

Valid values:

  • true – Request crypto codes. Kazakhstan Crypto Codes, Russia crypto codes, or Uzbekistan Crypto Codes are expected in the 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.
    cmn:ObjectIdentifier [1...1]
[–]		 Choice Required. 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]
[1/*]		 String The company prefix assigned by GS1 for the required SSCC numbers. Used only when cmn:NumberEncoding is for SSCC numbers (e.g. 030074).
        @filterValue [0...1]
[0/*]		 Integer The filter value 0 to 7 which is used to translate the serial number to EPC URI Pure Identity format.
      cmn:GTIN-14 [0...1]
[1/*]		 String 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) (e.g. 80388882930006).
      cmn:CNSubtypeObjectKey [0...1]
[10/10]		 String The China encoded number (e.g. 8888888888).
        @codeLevel [1...1]
[0/*]		 Integer

Conditionally required. The code level. Mandatory if cmn:CNSubtypeObjectKey is populated (e.g. 2)
        @packageRatio [0...1]
[0/*]		 String The package ratio (e.g. 1:2).
        @codeVersion [0...1]
[0/*]		 Integer The specific packaging ratio associated with the product (e.g. 81).
      cmn:CNResCodeObjectKey [0...1]
[5/5]		 String A China encoded number (e.g. 10521).
        @codeLevel [1...1]
[0/*]		 Integer The code level (e.g. 1).
        @packageRatio [0...1]
[0/*]		 String The code version.
        @codeVersion [0...1]
[0/*]		 Integer The specific packaging ratio associated with the product (e.g. 81).
      cmn:NTINObjectKey [0...1]
[1/*]		 String Conditionally required. 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) (e.g. 30300743799027).
    cmn:Quantity [1...1]
[1/*]		 Integer Required. The quantity of serial numbers requested (e.g. 10000).

Copy 
<?xml version="1.0" encoding="UTF-8"?>
<snm:SNMRequestType xmlns:snm="urn:tracelink:mapper:sl:serial_number_manager" xmlns:cmn="urn:tracelink:mapper:sl:commontypes">
    <snm:ControlFileHeader>
        <cmn:FileSenderNumber>8888882028655</cmn:FileSenderNumber>
        <cmn:FileReceiverNumber>8888882028677</cmn:FileReceiverNumber>
        <cmn:FileControlNumber>20200610090932</cmn:FileControlNumber>
        <cmn:FileDate>2020-06-10</cmn:FileDate>
        <cmn:FileTime>09:09:32Z</cmn:FileTime>
    </snm:ControlFileHeader>
    <snm:MessageBody>
        <cmn:RequestId>20200610</cmn:RequestId>
        <cmn:PlantIdentifier type="GLN">8779891013658</cmn:PlantIdentifier>
        <cmn:ReferenceDocuments>
            <cmn:PONumber>4500018051</cmn:PONumber>
            <cmn:WorkOrderNumber>1001764-00</cmn:WorkOrderNumber>
            <cmn:ReferenceIdentifier>A12345</cmn:ReferenceIdentifier>
        </cmn:ReferenceDocuments>
        <cmn:NumberEncoding>AI(01)+AI(21)</cmn:NumberEncoding>
        <cmn:ObjectIdentifier>
            <cmn:GTIN-14>00992326050107</cmn:GTIN-14>
        </cmn:ObjectIdentifier>
        <cmn:Quantity>20</cmn:Quantity>
    </snm:MessageBody>
</snm:SNMRequestType>                          

Copy 
<?xml version="1.0" encoding="UTF-8"?>
<snm:SNMRequestType xmlns:snm="urn:tracelink:mapper:sl:serial_number_manager" xmlns:cmn="urn:tracelink:mapper:sl:commontypes">
<snm:ControlFileHeader>
    <cmn:FileSenderNumber>8888884043588</cmn:FileSenderNumber>
    <cmn:FileReceiverNumber>10021144</cmn:FileReceiverNumber>
    <cmn:FileControlNumber>0000000414236887</cmn:FileControlNumber>
    <cmn:FileDate>2016-09-15</cmn:FileDate>
    <cmn:FileTime>09:09:09Z</cmn:FileTime> 
</snm:ControlFileHeader>
    <snm:MessageBody>
        <cmn:RequestId>20160201090909_08806500018314</cmn:RequestId>
        <cmn:PlantIdentifier type="GLN">CMO_System</cmn:PlantIdentifier>
        <cmn:ReferenceDocuments>
            <cmn:PONumber>4500018051</cmn:PONumber>
            <cmn:POLine>10</cmn:POLine>
            <cmn:WorkOrderNumber>1001764-00</cmn:WorkOrderNumber>
            <cmn:ReferenceIdentifier>A12345</cmn:ReferenceIdentifier>
        </cmn:ReferenceDocuments>
        <cmn:NumberEncoding>AI(01)+AI(21)</cmn:NumberEncoding>
        <cmn:RU_CryptoCodeRequest>true</cmn:RU_CryptoCodeRequest>
        <cmn:ObjectIdentifier>
            <cmn:GTIN-14>80388882930006</cmn:GTIN-14>
        </cmn:ObjectIdentifier>
        <cmn:Quantity>10</cmn:Quantity>
    </snm:MessageBody>
</snm:SNMRequestType>

Element Error Message Description
Class 1
cmn:NumberEncoding Valid number encoding code is required !!!

This element must be specified as one of the valid values.
cmn:ObjectIdentifier Only one of CompanyPrefixObjectKey OR GTIN14ObjectKey OR CNSubtypeObjectKey OR NTINObjectKey is required !!! Exactly one identifier element must have a value specified.
Class 3

The following error returns for all Class 3 errors: “INTERNALERROR=Internal error from server [server details].” Contact TraceLink Support if this error returns.

Response

  • Message type: SNM_RESPONSE
  • Info Exchange display name: Serial Number Replenish Response
  • Map Version: TL_XML_SNM_Response_1_0_IB_V1_4

Data Element Occurs
Length		 Format Description
snm:SNMResponseMessage [1...1]
[–]		 - Required. The SNM response root data element.
  snm:ControlFileHeader [1...1]
[-]		 - Required. The XML file control header.
    cmn:FileSenderNumber [1...1]
[1/20]		 String Required. The unique identifier for the company sending the message (e.g. 7777776067344).
    cmn:FileReceiverNumber [1...1]
[1/20]		 String Required. The unique identifier for the company receiving the message (e.g. 8888884043588).
    cmn:FileControlNumber [1...1]
[1/*]		 String Required. The unique file identifier assigned by the message sender.
    cmn:FileDate [1...1]
[1/*]		 Date Required. The date the file was generated in YYYY-MM-DD format (e.g. 2023-06-30).
    cmn:FileTime [1...1]
[1/*]		 Time Required. The time the file was generated in HH:MM:SSZ format (e.g. 06:30:32Z).
  snm:MessageBody [1...1]
[-]		 - Required. The body of the XML message.
    cmn:RequestId [1...1]
[1/*]		 String

Required. The request identifier.
    cmn:ReferenceDocuments [0...1]
[-]		 - Optional reference documents related to the request.
      cmn:PONumber [0...1]
[0/*]		 String The number of the purchase order (PO) issued by the manufacturer for the lot production (e.g. 1001764).
      cmn:POLine [0...1]
[0/*]		 String The line number for the lot production from the PO issued by the manufacturer (e.g. 001).
      cmn:WorkOrderNumber [0...1]
[0/*]		 String The work order number associated with the serial number request (e.g. 1001764-00).
      cmn:ReferenceIdentifier [0...1]
[1/*]		 String The reference number (e.g. RI942013).
    cmn:NumberEncoding [1...1]
[0/*]		 String Required. The encoding format for the type of serial numbers that are being requested from the enumeration list.

Valid values:

  • AI(00) – The bar code representation of an SSCC-18 number, and the equivalent of the SSCC-96 scheme.

  • AI(01)+AI(21) – The bar code representation of a serialized GTIN number, and the equivalent of the SGTIN-96 scheme.

  • CN-EDMC – The China number encoding format.
    cmn:ObjectIdentifier [1...1]
[-]		 Choice Required. 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]
[0/*]		 String The company prefix assigned by GS1 for the required SSCC numbers. Used only when cmn:NumberEncoding is for SSCC numbers (e.g. 030074).
        @filterValue [0...1]
[0/*]		 String The filter value 0 to 7 which is used to translate the serial number to EPC URI Pure Identity format.
      cmn:GTIN-14 [0...1]
[0/*]		 String The GTIN-14 for the required SGTIN and AI(01)+AI(21) serial numbers. Used only when cmn:NumberEncoding is for SGTIN and AI(01)+AI(21) (e.g. 80388882930006).
      cmn:CNSubtypeObjectKey [0...1]
[10/10]		 String The China encoded number (e.g. 8888888888).
        @codeLevel [1...1]
[0/*]		 Integer Conditionally required. The code level. Mandatory if cmn:CNSubtypeObjectKey is populated (e.g. 2)
        @packageRatio [0...1]
[0/*]		 String The package ratio (e.g. 1:2).
        @codeVersion [0...1]
[0/*]		 Integer

The specific packaging ratio associated with the product (e.g. 81).
      cmn:CNResCodeObjectKey [0...1]
[5/5]		 String A China encoded number (e.g. 10521).
        @codeLevel [0...1]
[0/*]		 Integer

The code level (e.g. 1).
        @packageRatio [0...1]
[0/*]		 String The code version.
        @codeVersion [0...1]
[0/*]		 Integer

The specific packaging ratio associated with the product (e.g. 81).
      cmn:NTINObjectKey [1...1]
[1/*]		 String The NTIN for the serial numbers.
    cmn:Quantity [1...1]
[-]		 Integer Required. The quantity of serial numbers requested (e.g. 10000).
    choice%1 [1...1]
[-]		 Choice

Required. 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 the three below should be populated, else an error message will be thrown.
    cmn:SerialNumberRange [0...1]
[-]		 - The range of serial numbers being returned in the response.
      cmn:StartingNumber [1...1]
[1/*]		 String Required. The starting serial number in range (e.g. 00103007400000930261)
      cmn:EndingNumber [1...1]
[1/*]		 String Required. The ending serial number in the range (e.g. 00103007400000930501)
    cmn:SerialNumberList [0...1]
[-]		 - -
      @isRandom [0...1]
[-]		 Boolean Conditionally required. An attribute that identifies random list of serial numbers. Mandatory for Kazakhstan, Russia, and Uzbekistan serial numbers.
      cmn:SerialNumber [1...*]
[1/*]		 String Required. A serial number in a list of serial numbers. This is a repeating element. SGTINs are mandatory for Kazakhstan, Russia, and Uzbekistan serial numbers.
        @cryptoKey [0...1]
[4/4]		 String Conditionally required. 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. Mandatory for Kazakhstan, Russia, and Uzbekistan serial numbers (e.g. 911234).
        @cryptoCode [0...1]
[0/88]		 String

Conditionally required. 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. Mandatory for Kazakhstan, Russia and Uzbekistan serial numbers.

  • !
  • "
  • %
  • &
  • '
  • *
  • +
  • -
  • ,
  • :
  • ;
  • =
  • <
  • >
  • ?
        @cryptoAcquisitionDate [0...1]
[1/*]		 Date The date that @cryptoKey and @cryptoCode are retrieved from the OMS (e.g. 2021-07-13).
    cmn:ErrorMessage [0...1]
[-]		 -

Required.The error message returned if an error occurred.
      cmn:ErrorCode [1...1]
[0/24]		 String Required. The error code returned if an error occurred (e.g. ZOER_SNG2G01-100).
      cmn:ErrorDescription [1...1]
[0/219]		 String Required. The error message if an error occurred (e.g. GLN not authorized to request Serial Number for epc Class).

Copy 
<?xml version="1.0" encoding="UTF-8"?>
<snm:SNMResponseMessage xmlns:snm="urn:tracelink:mapper:sl:serial_number_manager" xmlns:cmn="urn:tracelink:mapper:sl:commontypes">
    <snm:ControlFileHeader>
        <cmn:FileSenderNumber>8888882028655</cmn:FileSenderNumber>
        <cmn:FileReceiverNumber>8888882028677</cmn:FileReceiverNumber>
        <cmn:FileControlNumber>20180610090932</cmn:FileControlNumber>
        <cmn:FileDate>2018-06-10</cmn:FileDate>
        <cmn:FileTime>09:09:32Z</cmn:FileTime>
    </snm:ControlFileHeader>
    <snm:MessageBody>
        <cmn:RequestId>20180610</cmn:RequestId>
        <cmn:ReferenceDocuments>
            <cmn:PONumber>4500018051</cmn:PONumber>
            <cmn:WorkOrderNumber>1001764-00</cmn:WorkOrderNumber>
            <cmn:ReferenceIdentifier>RI942013</cmn:ReferenceIdentifier>
        </cmn:ReferenceDocuments>
        <cmn:NumberEncoding>AI(01)+AI(21)</cmn:NumberEncoding>
        <cmn:ObjectIdentifier>
            <cmn:GTIN-14>00992326050107</cmn:GTIN-14>
        </cmn:ObjectIdentifier>
        <cmn:Quantity>24</cmn:Quantity>
        <!-- <cmn:SerialNumberRange>
            <cmn:StartingNumber>00103007400000930261</cmn:StartingNumber>
            <cmn:EndingNumber>00103007400000930501</cmn:EndingNumber>
        </cmn:SerialNumberRange> -->
        <cmn:SerialNumberList>
            <cmn:SerialNumber>015088202501033321100000060001</cmn:SerialNumber>
            <cmn:SerialNumber>015088202501033321100000060002</cmn:SerialNumber>
            <cmn:SerialNumber>015088202501033321100000060003</cmn:SerialNumber>
            <cmn:SerialNumber>015088202501033321100000060004</cmn:SerialNumber>
            <cmn:SerialNumber>015088202501033321100000060005</cmn:SerialNumber>
            <cmn:SerialNumber>015088202501033321100000060006</cmn:SerialNumber>
            <cmn:SerialNumber>015088202501033321100000060007</cmn:SerialNumber>
            <cmn:SerialNumber>015088202501033321100000060008</cmn:SerialNumber>
            <cmn:SerialNumber>015088202501033321100000060009</cmn:SerialNumber>
            <cmn:SerialNumber>015088202501033321100000060010</cmn:SerialNumber>
            <cmn:SerialNumber>015088202501033321100000060011</cmn:SerialNumber>
            <cmn:SerialNumber>015088202501033321100000060012</cmn:SerialNumber>
            <cmn:SerialNumber>015088202501033321100000060013</cmn:SerialNumber>
            <cmn:SerialNumber>015088202501033321100000060014</cmn:SerialNumber>
            <cmn:SerialNumber>015088202501033321100000060015</cmn:SerialNumber>
            <cmn:SerialNumber>015088202501033321100000060016</cmn:SerialNumber>
            <cmn:SerialNumber>015088202501033321100000060017</cmn:SerialNumber>
            <cmn:SerialNumber>015088202501033321100000060018</cmn:SerialNumber>
            <cmn:SerialNumber>015088202501033321100000060019</cmn:SerialNumber>
            <cmn:SerialNumber>015088202501033321100000060020</cmn:SerialNumber>
            <cmn:SerialNumber>010088202501033821100000880001</cmn:SerialNumber>
            <cmn:SerialNumber>010088202501033821100000880002</cmn:SerialNumber>
            <cmn:SerialNumber>010088202501033821100000880003</cmn:SerialNumber>
            <cmn:SerialNumber>010088202501033821100000880051</cmn:SerialNumber>
        </cmn:SerialNumberList>
    </snm:MessageBody>
</snm:SNMResponseMessage>            

Copy 
<?xml version="1.0" encoding="UTF-8"?>
<snm:SNMResponseMessage xmlns:snm="urn:tracelink:mapper:sl:serial_number_manager" xmlns:cmn="urn:tracelink:mapper:sl:commontypes">
    <snm:ControlFileHeader>
        <cmn:FileSenderNumber>7777776067348</cmn:FileSenderNumber>
        <cmn:FileReceiverNumber>8888884043540</cmn:FileReceiverNumber>
        <cmn:FileControlNumber>0000000002</cmn:FileControlNumber>
        <cmn:FileDate>2016-09-20</cmn:FileDate>
        <cmn:FileTime>06:30:32Z</cmn:FileTime>
    </snm:ControlFileHeader>
    <snm:MessageBody>
        <cmn:RequestId>20160201090909_08806500018314</cmn:RequestId>
        <cmn:ReferenceDocuments>
            <cmn:PONumber>4500018051</cmn:PONumber>
            <cmn:POLine>10</cmn:POLine>
            <cmn:WorkOrderNumber>1001764-00</cmn:WorkOrderNumber>
            <cmn:ReferenceIdentifier>RI942013</cmn:ReferenceIdentifier>
        </cmn:ReferenceDocuments>
        <cmn:NumberEncoding>AI(00)</cmn:NumberEncoding>
        <cmn:ObjectIdentifier>
            <cmn:CompanyPrefixObjectKey filterValue="1">030074</cmn:CompanyPrefixObjectKey>
        </cmn:ObjectIdentifier>
        <cmn:Quantity>1</cmn:Quantity>
        <cmn:SerialNumberList isRandom="true">
            <cmn:SerialNumber cryptoKey="911234" cryptoCode="921x&gt;S2RzaWbKSgI1RmYQnZyumM6Z&amp;hx3ktKOCw" cryptoAcquisitionDate="2021-07-13">0104650099780166212450363462885 
            </cmn:SerialNumber>
        </cmn:SerialNumberList>
    </snm:MessageBody>
</snm:SNMResponseMessage>        

Element Error Message Description
Class 1
cmn:NumberEncoding Valid number encoding code is required !!!

This element must be specified as one of the valid values.
cmn:ObjectIdentifier Only one of CompanyPrefixObjectKey OR GTIN14ObjectKey OR CNSubtypeObjectKey OR NTINObjectKey is required !!! Exactly one identifier element must have a value specified.
cmn:SerialNumberRange

 

 

 

One of cmn:SerialNumberRange OR cmn:SerialNumberList OR cmn:ErrorMessage is required !!!

 

 

The element must have only one of the following values present: ErrorMessage, SerialNumberList, or SerialNumberRange.
cmn:SerialNumberList One of cmn:SerialNumberRange OR cmn:SerialNumberList OR cmn:ErrorMessage is required !!! Exactly one identifier element must have a value specified.
cmn:ErrorMessage One of cmn:SerialNumberRange OR cmn:SerialNumberList OR cmn:ErrorMessage is required !!!

The element must have only one of the following values present: ErrorMessage, SerialNumberList, or SerialNumberRange.

 

 

 
cmn:ErrorCode Error code is required if group ErrorMessage is populated !!! This element must have a value specified if ErrorMessage is present.
cmn:ErrorDescription Error description is required if group ErrorMessage is populated !!! This element must have a value specified if ErrorMessage is present.
Class 2
Serial Number Template Sender is not authorized to provide serial numbers for this Serial Number Manager template. This means that the sender is not a subscriber to the service, the template is not set to auto replenishment, or the template is not configured to authorize the sender as a provider of serial numbers

The element template must either be setup for external replenishment, the Serial Number Manager subscriber is the same as the message sender, or the template is active.

Class 3

The following error returns for all Class 3 errors: “INTERNALERROR=Internal error from server [server details].” Contact TraceLink Support if this error returns.

[Overview of how and why this response should be used, and an explanation of why there's only a response here. See the SNX Help Center Request Serial Number APIs topic for an example (Arvato XML).]

Response

  • Message type: SNM_RESPONSE
  • Info Exchange display name: Serial Number Replenish Response
  • Map Version: TL_XML_SNM_Response_1_0_IB_V1_4

Data Element Occurs
Length		 Format Description
CodeRequestReport [1...1]
[–]		 - Required. The SNM response root data element.
  Quantity [1...1]
[-]		 - Required. The XML file control header.
  CompanyPrefix [0...1]
[-]		 -  
  ExtensionDigit [0...1]
[-]		 - Required. The body of the XML message.
  DateCodesWereGenerated [1...1]
[-]		 - Required. The body of the XML message.
  CodeRequestKey [1...1]
[-]		 - Required. The body of the XML message.
  AssociatedProducts [1...1]
[-]		 - Required. The body of the XML message.
    AssociatedProduct [1...1]
[1/*]		 String

Required. The request identifier.
      Type [0...1]
[0/*]		 String The number of the purchase order (PO) issued by the manufacturer for the lot production (e.g. 1001764).
      Value [0...1]
[0/*]		 String The line number for the lot production from the PO issued by the manufacturer (e.g. 001).
    SenderId [1...1]
[0/*]		 String Required. The encoding format for the type of serial numbers that are being requested from the enumeration list.

Valid values:

  • AI(00) – The bar code representation of an SSCC-18 number, and the equivalent of the SSCC-96 scheme.

  • AI(01)+AI(21) – The bar code representation of a serialized GTIN number, and the equivalent of the SGTIN-96 scheme.

  • CN-EDMC – The China number encoding format.
    UIDs [1...1]
[-]		 Choice Required. 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.
      UID [0...1]
[0/*]		 String The company prefix assigned by GS1 for the required SSCC numbers. Used only when cmn:NumberEncoding is for SSCC numbers (e.g. 030074).
    Location [1...1]
[-]		 Integer Required. The quantity of serial numbers requested (e.g. 10000).
      References [1...1]
[1/*]		 String Required. The starting serial number in range (e.g. 00103007400000930261)
        Reference [0...1]
[4/4]		 String Conditionally required. 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. Mandatory for Kazakhstan, Russia, and Uzbekistan serial numbers (e.g. 911234).
        Name [0...1]
[0/88]		 String

Conditionally required. 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. Mandatory for Kazakhstan, Russia and Uzbekistan serial numbers.
    BusinessTransactions [0...1]
[-]		 - Business Transactions group header
      BusinessTransaction [1...1]
[0/24]		 - Required. The error code returned if an error occurred (e.g. ZOER_SNG2G01-100).
        Type [0...1]
[-]		 String Not used
        ID [1...1]
[0/24]		 String Required. The error code returned if an error occurred (e.g. ZOER_SNG2G01-100).

Copy 
<?xml version="1.0" encoding="UTF-8"?>
            <snm:SNMResponseMessage xmlns:snm="urn:tracelink:mapper:sl:serial_number_manager" xmlns:cmn="urn:tracelink:mapper:sl:commontypes">
            <snm:ControlFileHeader>
            <cmn:FileSenderNumber>8888882028655</cmn:FileSenderNumber>
            <cmn:FileReceiverNumber>8888882028677</cmn:FileReceiverNumber>
            <cmn:FileControlNumber>20180610090932</cmn:FileControlNumber>
            <cmn:FileDate>2018-06-10</cmn:FileDate>
            <cmn:FileTime>09:09:32Z</cmn:FileTime>
            </snm:ControlFileHeader>
            <snm:MessageBody>
            <cmn:RequestId>20180610</cmn:RequestId>
            <cmn:ReferenceDocuments>
            <cmn:PONumber>4500018051</cmn:PONumber>
            <cmn:WorkOrderNumber>1001764-00</cmn:WorkOrderNumber>
            <cmn:ReferenceIdentifier>RI942013</cmn:ReferenceIdentifier>
            </cmn:ReferenceDocuments>
            <cmn:NumberEncoding>AI(01)+AI(21)</cmn:NumberEncoding>
            <cmn:ObjectIdentifier>
            <cmn:GTIN-14>00992326050107</cmn:GTIN-14>
            </cmn:ObjectIdentifier>
            <cmn:Quantity>24</cmn:Quantity>
            <!-- <cmn:SerialNumberRange>
            <cmn:StartingNumber>00103007400000930261</cmn:StartingNumber>
            <cmn:EndingNumber>00103007400000930501</cmn:EndingNumber>
            </cmn:SerialNumberRange>  -->
            <cmn:SerialNumberList>
            <cmn:SerialNumber>015088202501033321100000060001</cmn:SerialNumber>
            <cmn:SerialNumber>015088202501033321100000060002</cmn:SerialNumber>
            <cmn:SerialNumber>015088202501033321100000060003</cmn:SerialNumber>
            <cmn:SerialNumber>015088202501033321100000060004</cmn:SerialNumber>
            <cmn:SerialNumber>015088202501033321100000060005</cmn:SerialNumber>
            <cmn:SerialNumber>015088202501033321100000060006</cmn:SerialNumber>
            <cmn:SerialNumber>015088202501033321100000060007</cmn:SerialNumber>
            <cmn:SerialNumber>015088202501033321100000060008</cmn:SerialNumber>
            <cmn:SerialNumber>015088202501033321100000060009</cmn:SerialNumber>
            <cmn:SerialNumber>015088202501033321100000060010</cmn:SerialNumber>
            <cmn:SerialNumber>015088202501033321100000060011</cmn:SerialNumber>
            <cmn:SerialNumber>015088202501033321100000060012</cmn:SerialNumber>
            <cmn:SerialNumber>015088202501033321100000060013</cmn:SerialNumber>
            <cmn:SerialNumber>015088202501033321100000060014</cmn:SerialNumber>
            <cmn:SerialNumber>015088202501033321100000060015</cmn:SerialNumber>
            <cmn:SerialNumber>015088202501033321100000060016</cmn:SerialNumber>
            <cmn:SerialNumber>015088202501033321100000060017</cmn:SerialNumber>
            <cmn:SerialNumber>015088202501033321100000060018</cmn:SerialNumber>
            <cmn:SerialNumber>015088202501033321100000060019</cmn:SerialNumber>
            <cmn:SerialNumber>015088202501033321100000060020</cmn:SerialNumber>
            <cmn:SerialNumber>010088202501033821100000880001</cmn:SerialNumber>
            <cmn:SerialNumber>010088202501033821100000880002</cmn:SerialNumber>
            <cmn:SerialNumber>010088202501033821100000880003</cmn:SerialNumber>
            <cmn:SerialNumber>010088202501033821100000880051</cmn:SerialNumber>
            </cmn:SerialNumberList>
            </snm:MessageBody>
        </snm:SNMResponseMessage> 

Copy 
<?xml version="1.0" encoding="UTF-8"?>
<snm:SNMRequestType xmlns:snm="urn:tracelink:mapper:sl:serial_number_manager" xmlns:cmn="urn:tracelink:mapper:sl:commontypes">
<snm:ControlFileHeader>
    <cmn:FileSenderNumber>8888884043588</cmn:FileSenderNumber>
    <cmn:FileReceiverNumber>10021144</cmn:FileReceiverNumber>
    <cmn:FileControlNumber>0000000414236887</cmn:FileControlNumber>
    <cmn:FileDate>2016-09-15</cmn:FileDate>
    <cmn:FileTime>09:09:09Z</cmn:FileTime> 
</snm:ControlFileHeader>
    <snm:MessageBody>
        <cmn:RequestId>20160201090909_08806500018314</cmn:RequestId>
        <cmn:PlantIdentifier type="GLN">CMO_System</cmn:PlantIdentifier>
        <cmn:ReferenceDocuments>
            <cmn:PONumber>4500018051</cmn:PONumber>
            <cmn:POLine>10</cmn:POLine>
            <cmn:WorkOrderNumber>1001764-00</cmn:WorkOrderNumber>
            <cmn:ReferenceIdentifier>A12345</cmn:ReferenceIdentifier>
        </cmn:ReferenceDocuments>
        <cmn:NumberEncoding>AI(01)+AI(21)</cmn:NumberEncoding>
        <cmn:RU_CryptoCodeRequest>true</cmn:RU_CryptoCodeRequest>
        <cmn:ObjectIdentifier>
            <cmn:GTIN-14>80388882930006</cmn:GTIN-14>
        </cmn:ObjectIdentifier>
        <cmn:Quantity>10</cmn:Quantity>
    </snm:MessageBody>
</snm:SNMRequestType>

Element Error Message Description
Class 1
cmn:NumberEncoding Number encoding value is required !!!

This element must be specified as one of the valid values.
cmn:ObjectIdentifier One of CompanyPrefixObjectKey OR GTIN14ObjectKey OR CNSubtypeObjectKey OR CNResCodeObjectKey OR NTINObjectKey is required !!!

Exactly one identifier element must have a value specified.

The response is accepted when cmn:CNSubtypeObjectKey, or cmn:CNRescodeObjectKey, or both are present.
cmn:SerialNumberRange One of cmn:SerialNumberRange OR cmn:SerialNumberList OR cmn:ErrorMessage is required !!!

The element must have only one of the following values present: ErrorMessage, SerialNumberList, or SerialNumberRange.
cmn:SerialNumberList One of cmn:SerialNumberRange OR cmn:SerialNumberList OR cmn:ErrorMessage is required !!! The element must have only one of the following values present: ErrorMessage, SerialNumberList, or SerialNumberRange.
cmn:ErrorMessage One of cmn:SerialNumberRange OR cmn:SerialNumberList OR cmn:ErrorMessage is required !!! The element must have only one of the following values present: ErrorMessage, SerialNumberList, or SerialNumberRange.
cmn:ErrorCode Error code is required if group ErrorMessage is populated !!!

This element must have a value specified ifErrorMessage is present.
cmn:ErrorDescription Error description is required if group ErrorMessage is populated !!! This element must have a value specified ifErrorMessage is present.
Class 2
Serial Number Template Sender is not authorized to provide serial numbers for this Serial Number Manager template. This means that the sender is not a subscriber to the service, the template is not set to auto replenishment, or the template is not configured to authorize the sender as a provider of serial numbers.

The element template must either be setup for external replenishment, the Serial Number Manager subscriber is the same as the message sender, or the template is active
Class 3

The following error returns for all Class 3 errors: “INTERNALERROR=Internal error from server [server details].” Contact TraceLink Support if this error returns.