Release Product Request Guidelines

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

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. Not used by TraceLink. SOAP Message Header.
  soapenv:Body [1...1]
[-]		 - Required. SOAP Message Body.
    urn:ReleaseProduct [1...1]
[-]		 - Required. A request message that sets all serial numbers in a lot to "quality released".
      LotQueryRequest [0...1]
[-]		 - Required. Queries the serialization status of an ItemCode and Lot.
        ItemCode [1...1]
[1/*]		 String Required. Packaging level item code value (e.g. GTIN-14, CN-ResCode, or GS1 Company Prefix value). *1
        ItemCodeType [0...1]
[1/*]		 String Required. Identifies the packaging level item code type. *2

See the ItemCodeType enumeration list for valid values.
        Lot [0...1]
[1/*]		 String Lot Number associated with the designated serial numbers at time of the request. *3
        EventDateTime [0...1]
[-]		 Date Date and time of the event in XSD date time format in GMT (i.e. YYYY-MM-DDTHH:MM:SSZ). If empty or null, EventDateTime defaults to the current date time.
        QualityControlEntityID [0...1]
[1/*]		 String Conditionally required if at least one Target Market in Product Master Data = RU and the lot was commissioned outside of Russia. Business or location identifier of the entity responsible for quality control.
          @identifiertype [0...1]
[1/*]		 String Required. The business or location identifier type. See the BusinessAndLocationId enumeration list for valid values.
          @identifiervalue [0...1]
[1/*]		 String Required. The value of the entity responsible for quality control.
        Transactions [0...1]
[-]		 - Conditionally required if at least one Target Market in Product Master Data = RU and the lot was commissioned in Russia. The transaction identifier associated with the product being released.
If present, QualityControlEntityID most also be present.
          Transaction [1...*]
[-]		 - Required. List of one or more transaction identifiers.
            ItemID [0...1]
[1/*]		 String Required. The transaction identifier associated with the status update.
            ItemType [0...1]
[1/*]		 String Required. The transaction identifier type.

Valid values:

  • CERTIFICATECONFORMITY
  • CIVILCIRCULATION
  • DECLARATIONCONFORMITY
  • STATECONFIRMATION
            Date [0...1]
[1/*]		 String The date of the transaction in XML YYYY-MM-DD format.
      ProductionQuantities [0...1]
[-]		 - Container element for the repeating ProductionQuantity element group.
        ProductionQuantity [0...*]
[-]		 - List of each aggregation hierarchy level. Used to optionally validate serial number quantities.
          PackagingItemCode [0...1]
[-]		 - Conditionally required if CompanyPrefix is not populated. Identifies the product using the packaging level item code (e.g. GTIN-14) configured in Product Master Data.
            ItemCodeType [1...1]
[1/*]		 String Required. The packaging level item code type. Valid values:
  • CN-RESCODE
  • GTIN-14
  • NTIN
            ItemCode [1...1]
[1/*]		 String Required. The packaging level item code value.
          CompanyPrefix [0...1]
[0/*]		 String Conditionally required if PackagingItemCode is not present. The GS1 company prefix. *4
          PackagingLevel [1...1]
[1/*]		 String Required. The packaging level of the commissioned item. See the PackLevel enumeration list for valid values.
          QuantityReported [1...1]
[1/*]		 Integer Required. Quantity reported for the released product.
        LongRunningRestSupport [-]
[-]		 Boolean Not used.
        IncludePackageLevelQuantities [-]
[-]		 Boolean Not used.
        IncludePartialRecallSerialNumber [-]
[-]		 Boolean Not used.
        IncludePartialMarketReleaseSerialNumbers [-]
[-]		 Boolean Not used.
        asynchronousMode [-]
[-]		 String Not used.