Get Serialized Hierarchy Response 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.

The following data is included in the message response:

Data Element   Occurs
Length		 Type Description
S:ES:Envelope [1...1]
[–]		 – Required. The SOAP envelope root element.
  S:Body [1...1]
[–]		 – Required. The SOAP message body.
    ns3:GetSerialNumberHierarchyResponse [1...1]
[–]		 – Required. The Get Serialized Hierarchy response message with hierarchical data.
      SerialNumberHierarchyResponse [0...1]
[–]		 – Required. Contains the response.
        Success [0...1]
[–]		 – Indicates whether Get Serialized Hierarchy request message processed successfully.
        ExceptionReturn [0...1]
[–]		 – Conditionally required if Success = false. Contains error information.
          CallException [1...*]
[–]		 – Required. Contains error details.
            ExceptionCode [0...1]
[0/*]		 String Required. The error code. See Get Serialized Hierarchy Errors for all potential error exceptions and exception codes.
            ExceptionMessage [0...1]
[0/*]		 String Conditionally required if exception message is present. A message describing the error.
        SerialNumberHierarchyList [0...1]
[–]		 – Contains the successful response to the request.
          SerialNumberHierarchies [0...1]
[–]		 – Contains a list of one or more SerialNumberHierarchy elements in response to the request. Each SerialNumberHierarchy element contains one hierarchy.
            SerialNumberHierarchy [0...*]
[–]		 – Each SerialNumberHierarchy element contains one hierarchy. If there are loose items returned, they are returned in this element with no ChildSerialNumbers present.
              SerialNumber [1...1]
[–]		 – Required. The parent container serial number, or a loose item.
                @sn [1...1]
[1/*]		 String Required. The serial number that was queried.
                @namespace [0...1]
[1/*]		 String The serial number format. For more information, see Serial Number Data Examples. Valid values:
  • AI(01)+AI(21)
  • AI(00)
  • CN_CUR_CODE
                @isUpdated [1...1]
[1/*]		 Boolean Required. Records whether the serial number is updated, which TraceLink uses for system processing.
              PackagingCode [0...1]
[1/*]		 String The packaging-level item code and type associated with the serial number.
                ItemCodeType [1...1]
[1/*]		 String Required. Identifies the packaging-level item code type of the serial number. Valid values:
  • GTIN_14
  • SSCC
  • CN_SUB_TYPE
  • NTIN
                ItemCode [1...1]
[1/*]		 String Required. The packaging-level item code value (e.g. GTIN-14, CN-ResCode, or GS1 Company Prefix value).
              CountryDrugCodeType [0...1]
[1/*]		 String

Conditionally required if CountryDrugCode is present.

See the CountryDrugCode enumeration list for valid values.
              CountryDrugCode [0...1]
[1/*]		 String The Country Drug Code associated with the serial number at the time of commissioning.
              InternalMaterialNumber [0...1]
[1/*]		 String The Internal Material Number associated with the serial number at time of commissioning.
              Location [0...1]
[1/*]		 String

The site-level SGLN of the location where the event occurred. Defaults to company-level if a location is not provided.

SGLN format is 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).
              CommissionDateTime [0...1]
[20/20]		 DateTime The date and time of the commissioning event in XSD DateTime format in GMT: YYYY-MM-ddTHH:mm:ss.SSSX. *1
              ManufacturingDate [0...1]
[10/10]		 Date The date of manufacture associated with the serial number in XSD Date format in GMT: YYYY-MM-DD. *2
              LotNumber [0...1]
[1/*]		 String The lot number associated with the serial number at time of commissioning.
              ExpirationDate [0...1]
[10/10]		 Date The expiration date associated with serial number at time of commissioning in XSD Date format in GMT: YYYY-MM-DD.
              PackagingLevel [0...1]
[1/*]		 String

The packaging level associated with queried serial number.

See the PackLevel enumeration list for valid values.
              SerialNumberState [0...1]
[1/*]		 String

Required. The serialization state of the queried serial number.

See the SNState enumeration list for valid values.
              ItemState [0...1]
[1/*]		 String

Required. The business process state of the physical item associated with the serial number.

See the ItemState enumeration list for valid values.
            ChildSerialNumbers [0...1]
[–]		 – The list of child serial numbers associated with the container serial number or lot number.

If SerialNumberHierarchy | SerialNumber has child serial numbers, they are included in the ChildSerialNumber element. This is a repeating element and contains only one level of aggregation. Sub-aggregations are represented as new SerialNumberHierarchy elements.
              ChildSerialNumber [1...*]
[–]		 – Required. Contains one level of aggregation below SerialNumberHierarchy | SerialNumber, with the immediate child serial numbers aggregated to SerialNumber.
                SerialNumber [1...1]
[–]		 – The child serial number of SerialNumberHierarchy | SerialNumber. Only the direct descendants (child serial numbers) for a given SerialNumberHierarchy | SerialNumber are reported. If a child itself also has children, it will be recognized as another top-level element.
                  @sn [1...1]
[1/*]		 String Required. The child serial number that is affixed to the queried container/lot.
                  @namespace [0...1]
[1/*]		 String

Not supported by TraceLink.

                  @isUpdated [1...1]
[1/*]		 Boolean Required. Records whether the serial number is updated, which TraceLink uses for system processing.
                PackagingCode [0...1]
[1/*]		 String Conditionally required when delivery number is not specified and CountryDrugCode and InternalMaterialNumber are not present.
                  ItemCodeType [1...1]
[1/*]		 String

Required. Identifies the packaging-level item code type of the serial number. Valid values:

  • GTIN_14
  • SSCC
  • CN_SUB_TYPE
  • NTIN
                  ItemCode [1...1]
[1/*]		 String Required. The packaging-level item code value (e.g. GTIN-14, CN-ResCode, or GS1 Company Prefix value).
                CountryDrugCodeType [0...1]
[1/*]		 String

Conditionally required if CountryDrugCode is present.

See the CountryDrugCode enumeration list for valid values.
                CountryDrugCode [0...1]
[1/*]		 String Conditionally required with internal material number when delivery number is not specified and packaging code is not present. Country Drug Code associated with the child serial number.
                InternalMaterialNumber [0...1]
[1/*]		 String The internal material number associated with the serial number at time of commissioning.
                Location [0...1]
[1/*]		 String

The site-level SGLN of the location where the event occurred. Defaults to company-level if a location is not provided.

SGLN format is 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).
                CommissionDateTime [0...1]
[29/29]		 DateTime The date and time of the commissioning event in XSD DateTime format in GMT: YYYY-MM-ddTHH:mm:ss.SSSX. *3
                ManufacturingDate [0...1]
[1/*]		 Date The date of manufacture associated with the serial number in XSD Date format in GMT: YYYY-MM-DD. *4
                LotNumber [0...1]
[1/*]		 String The lot number associated with the child serial number.
                ExpirationDate [0...1]
[10/10]		 Date Not supported by TraceLink.
                PackagingLevel [0...1]
[1/*]		 String

The packaging level associated with child serial number.

See the PackLevel enumeration list for valid values.
                SerialNumberState [0...1]
[1/*]		 String

Required. The serialization state of the child serial number.

See the SNState enumeration list for valid values.

                ItemState [0...1]
[1/*]		 String

Required. The business process state of the physical item associated with the child serial number.

See the ItemState enumeration list for valid values.
                ShipmentDeliveryInfo - - Identifies the shipment delivery information for the last shipment or return for the serial number.
                  DeliveryNumber [0...1]
[1/*]		 String Required. The delivery number of the last shipment or return for this serial number.
                  TransactionIdentifier - - Identifies the Transaction identifiers associated with the shipment.
                    @TransactionIdentifier [1...*]

[1/*]

 String

Required. Transaction identifier(s) associated with the shipment for regulatory reporting purposes.

At least one transaction id is mandatory. More than one may be mandatory depending on the country.
                    @type [1...1]

[1/*]

 String Required. The transaction identifier type supports the enumeration value PO.
                    @EventDateTime [1...1]

[0/*]


 DateTime Required. Specifies the timestamp of the date and time of the Transaction event with the UTC time zone indicator in the format: YYYY-MM-DDTHH:MM:SS.ssZ.
                ReceiptDeliveryInfo - - Identifies the receipt delivery information for the last receipt for the serial number.
                  DeliveryNumber [0...1]
[1/*]		 String Required. The delivery number of the last receipt for this serial number.
                  TransactionIdentifier - - Identifies the Transaction identifiers associated with the receipt.
                    @TransactionIdentifier [1...*]

[1/*]

 String Required. Transaction identifier(s) associated with the receipt for regulatory reporting purposes.

At least one transaction id is mandatory. More than one may be mandatory depending on the country.
                    @type [1...1]

[1/*]

 String Required. The transaction identifier type supports the enumeration value PO.
                    @EventDateTime [1...1]

[0/*]


 DateTime Required. Specifies the timestamp of the date and time of the Transaction event with the UTC time zone indicator in the format: YYYY-MM-DDTHH:MM:SS.ssZ.
        RequestId [0...1]
[–]		 String Returns the value for the RequestId field in the Fetch Serial Number Hierarchy Result Request that can return the full hierarchy containing all child serial numbers for the given container number (of 100,000 serial numbers or more). *5