Registration Request Guidelines

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

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.

See SerialNumberStatus Transition Availability for rules/dependencies regarding serial number state transition.

The following data is sent in the request to TraceLink:

Data Element Occurs
Length		 Type Description
soapenv:Envelope [1...1]
[-]		 - Required. SOAP envelope root element.
  soapenv:Header [1...1]
[-]		 - Required. SOAP message header. Not used by TraceLink.
  soapenv:Body [1...1]
[-]		 - Required. SOAP message body.
    urn:Register [1...1]
[-]		 - Required. Registration message.
      RegisterRequest [0...1]
[-]		 - Required. Register request message registering a set of serial numbers that are unknown to TraceLink. May include registered serial numbers in subsequent actions.
        EventDateTime [1...1]
[-]		 Date Date and time of the event in XSD date format in GMT (YYYY-MM-DDTHH:MM:SSZ). If omitted, the system records the current date time.
        SerialNumberEncodingEnum [0...1]
[1/*]		 String Required. Serial number format. Valid values: *1
  • AI(01)+AI(21)
  • CN_CUR_CODE
Use CN_CUR_CODE for a China EDMC Code.
        PackagingLevel [0...1]
[1/*]		 String Packaging level associated with the serial number. Valid values: *2
  • CA = Case/Shipper
  • EA = Each
  • PK = Innerpack/Bundle
  • PL = Pallet
        Location [0...1]
[1/*]		 String Site-level location where the event occurred. Defaults to company-level SGLN if location is not provided. If value is an SGLN, the format is the numeric component only, with the urn prefix stripped (e.g. 8888882.02867.0 instead of urn:epc:id:sgln:8888882.02867.0 typically found in EPCIS events). *3
        LocationType [0...1]
[1/*]		 String The type of the Location. Defaults to SGLN if type is not provided.  *4

See the CompanyLocationId enumeration list for valid values.
        CompanyPrefix [0...1]
[1/*]		 String Conditionally required if the commissioned serial numbers are SSCCs that are used in pallets or mixed cases. GS1 Company Prefix associated with AI(00) SSCC, AI(01)+AI(21), GTIN, or AI(00) SSCC. Use only when Serial Number Manager templates are not configured. This value is used to convert serial numbers to EPC URI format. *5
Do not populate if the commissioned serial numbers are not SSCCs. Populate ItemDetails instead.
        MaterialCode [0...1]
[1/*]		 String Conditionally required if CountryDrugCode is not populated. Internal material number for the product. *6
If neither the MaterialCode nor CountryDrugCode are present, the GTIN is derived from the serial numbers.
        ItemCode [0...1]
[1/*]		 String Packaging-level item code value (e.g. the GTIN-14, CN-ResCode, or GS1 Company Prefix value). *7
        ItemCodeType [0...1]
[1/*]		 String Conditionally required if ItemCode is populated. Identifies the packaging- level item code type. Valid values: *8
  • CN_RESCODE
  • GTIN14
  • NTIN
        FilterValue [0...1]
[1/*]		 String Filter Value associated with AI(01)+AI(21) GTIN or AI(00) SSCC. This value is used to convert serial numbers to EPC URI format. *9
        CompanyPrefix [0...1]
[1/*]		 String GS1 Company Prefix associated with AI(01)+AI(21) GTIN or AI(00) SSCC. This value is used to convert serial numbers to EPC URI format. *10
        MarketCountryCode [0...1]
[2/3]		 String The country using the standard two-letter abbreviation specified in ISO 3166-1alpha-2:1997 country code. *11
        CountryDrugCode [0...1]
[1/*]		 String Country Drug Code associated with the serial number at time of registration. *12
If neither the MaterialCode nor CountryDrugCode are present, the GTIN is derived from the serial numbers.
        CountryDrugCodeType [0...1]
[1/*]		 String Conditionally required if CountryDrugCode is present. Country Drug Code type. *13

See the CountryDrugCode enumeration list for valid values.
        LotNumber [1...1]
[1/*]		 String Conditionally required if EncodingType = AI(01)+AI(21). Lot Number associated with the serial number at time of registration. *14
        ExpirationDate [1...1]
[10/10]		 Date Conditionally required for SGTINs. Expiration date associated with the serial number at time of registration. Date is in xsd:date format:YYYY-MM-DD. *15
        ManufacturingDate [0...1]
[10/10]		 Date Manufacturing date associated with the serial number at time of registration. Date is in xsd:date format:YYYY-MM-DD. *16
        PONumber [0...1]
[0/*]		 String PO Number associated with serial number use. *17
        POLine [0...1]
[0/*]		 String PO Line number. *18
        WorkOrderNumber [0...1]
[0/*]		 String Work Order number associated with serial number use. *19
        ReferenceIdentifier [0...1]
[0/*]		 String Reference identifier (e.g. any type of identifier) associated with serial number use. *20
        Items [1...1]
[-]		 - Required. List of one or more serial numbers that will be registered.
          Item [1...100]
[-]		 - Required. The serial number to register.

A maximum of 100 serial numbers can be sent per request.
            @sn [1...1]
[1/*]		 String Required. The serial number in one of the following formats: *21

AI(01)+AI(21):

  • Format: 01 + [GTIN14] + 21 + [serial number]
  • Example: 015088202503022521100000090109

AI(00):

  • Format: 00 + [SSCC18 code]
  • Example: 00008820200000047506

CN_CUR_CODE:

  • Format: 20-digit China EDMC code
  • Example: 81530070000022519351
            @barcodeContent [0...1]
[1/*]		 String Actual barcode content associated with the serial number in the registration event. *22
        ItemState [0...1]
[0/*]		 String

The item state for the serial number(s) being registered. Valid values: *23

  • AVAILABLE (default)
  • BLOCKED
  • PENDINGRECEIPT
  • PICKED
  • RECEIVED
  • SHIPPED
  • UNDERINVESTIGATION
        LongRunningRestSupport [0...*]
[0/*]		 Boolean Indicates whether or not to use the long running rest pattern.