Get Serialized Entity 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		 Format Description
S:ES:Envelope [1...1]
[-]		 - Required.The SOAP envelope root element.
  S:Body [1...1]
[-]		 - Required. The SOAP message body.
    ns2:GetSerializedEntityResponse [1...1]
[-]		 - Required. The Get Serialized Entity response message.
      SerializedEntityResponse [0...1]
[-]		 - Required. Contains the response.
        Success [0...1]
[-]		 - Required. Indicates whether the Get Serialized Entity request message processed successfully. *1
        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 Entity Errors for list of potential exception codes and error messages.
            ExceptionMessage [0...1]
[0/*]		 String A message that further describes the error condition. See Get Serialized Entity Errors for list of potential exception codes and error messages.
        SerializedEntity [0...1]
[-]		 - Contains the successful response to the request. *2
          @sn [1...1]
[1/*]		 String Required. The serial Number that was requested.
          @namespace [1...1]
[-]		 String Not supported by TraceLink. See Serial Number Data Examples.
          @isUpdated [1...1]
[1/*]		 Boolean Required. Records whether the serial number is updated, which TraceLink uses for system processing.
          ItemCode [0...1]
[1/*]		 String The country drug code associated with the serial number at time of commissioning. *3
          ItemCodeType [0...1]
[1/*]		 String Conditionally required if CountryDrugCode is present. The country drug code type. *4

See the CountryDrugCode enumeration list for valid values.
          ProductDescription [0...1]
[1/*]		 String The product description from Product Master Data. *5
Not populated for SSCCs.
          ProductName [0...1]
[1/*]		 String The product name from Product Master Data. *6
Not populated for SSCCs.
          Strength [0...1]
[1/*]		 String The product strength from Product Master Data. *7
Not populated for SSCCs.
          DosageForm [0...1]
[1/*]		 String The product dosage from Product Master Data. *8
Not populated for SSCCs.
          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).
          CountryMarketCode [0...1]
[1/*]		 String

The 2-letter ISO country code for the country in which the serial number is commissioned.

See the CountryDrugCode enumeration list for valid values.
          InternalMaterialNumber [0...1]
[1/*]		 String A number assigned to the product for internal use and not for identifying the product externally. Defaults to the Product Master Data entry based on the packaging code provided.
          PackageSizeSpec [0...1]
[-]		 Decimal The product package size/spec from Product Master Data. *9
Not populated for SSCCs.
          PackagingItemCodeType [0...1]
[1/*]		 String Conditionally required if PackagingItemCode is present. Identifies the packaging level item code type. *10

See the ItemCodeType enumeration list for valid values.
          PackagingItemCode [0...1]
[1/*]		 String The packaging level item code value (e.g. the GTIN-14 value). *11
          PackagingLevel [0...1]
[1/*]		 String The packaging level associated with the serial number. *12

See the PackLevel enumeration list for valid values.
          Lot [0...1]
[1/*]		 String The lot number associated with the serial number at the time of commissioning. *13
          ExpirationDate [0...1]
[10/10]		 Date Not supported by TraceLink. The expiration date associated with serial number at time of commissioning in XSD D ate format in GMT: YYYY-MM-DD.
          ManufacturingDate [0...1]
[10/10]		 Date The date of manufacture associated with the serial number in XSD Date format in GMT: YYYY-MM-DD. *14
          SerialNumberState [0...1]
[1/*]		 String Required. The serialization state of the serial number. *15

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. *16

See the ItemState enumeration list for valid values.
          BarCode [0...1]
[1/*]		 String The actual bar code content associated with serial number in commissioning event. *17
          DeliveryNumber [0...1]
[1/*]		 String The delivery number of the last shipment or return for this serial number. *18
          SerialNumberEncoding [0...1]
[1/*]		 String The serial number encoding format. See Serial Number Data Examples. *19

See the Encoding enumeration list for valid values.
          LatestEventDatetime [0...1]
[1/*]		 String Not supported by TraceLink. The date and time of the last event for this serial number in XSD Date format in GMT.
          PackedStatus [0...1]
[1/*]		 String Not supported by TraceLink.
          QualityReleased [0...1]
[1/*]		 Boolean Item attribute set with SerialNumberState and ItemState, indicating the item was quality released. *20
          Sampled [0...1]
[1/*]		 Boolean Item attribute set with SerialNumberState and ItemState, indicating the item was sampled. *21
          Damaged [0...1]
[1/*]		 Boolean Item attribute set with SerialNumberState and ItemState, indicating the item was damaged. *22
          Recalled [0...1]
[1/*]		 Boolean Item attribute set with SerialNumberState and ItemState, indicating the item was recalled. *23
          Expired [0...1]
[1/*]		 Boolean Item attribute set with SerialNumberState and ItemState, indicating the item is expired. *24
          MarketReleased [0...1]
[1/*]		 Boolean Item attribute set with SerialNumberState and ItemState, indicating the item was market released. *25
          Misplaced [0...1]
[1/*]		 Boolean Item attribute set with SerialNumberState and ItemState, indicating the item was misplaced.
          Dispensed [0...1]
[1/*]		 Boolean Item attribute set with SerialNumberState and ItemState, indicating the item was dispensed.
          Disposed [0...1]
[1/*]		 Boolean Item attribute set with SerialNumberState and ItemState, indicating the item was disposed.
          Repackaged [0...1]
[1/*]		 Boolean Item attribute set with SerialNumberState and ItemState, indicating the item was repackaged.
          SampledByAuthorities [0...1]
[1/*]		 Boolean Item attribute set with SerialNumberState and ItemState, indicating the item was sampled by authorities.
          Stolen [0...1]
[1/*]		 Boolean Item attribute set with SerialNumberState and ItemState, indicating the item was stolen.
          Withdrawn [0...1]
[1/*]		 Boolean Item attribute set with SerialNumberState and ItemState, indicating the item was withdrawn.
          SampledArchival [0...1]
[1/*]		 Boolean Item attribute set with SerialNumberState and ItemState, indicating the item was sampled for archival purposes.
          SampledCustomsControl [0...1]
[1/*]		 Boolean Item attribute set with SerialNumberState and ItemState, indicating the item was sampled for customs inspection.
          SampledFederalInspection [0...1]
[1/*]		 Boolean Item attribute set with SerialNumberState and ItemState, indicating the item was sampled for federal inspection.
          SampledClinicalStudy [0...1]
[1/*]		 Boolean Item attribute set with SerialNumberState and ItemState, indicating the item was sampled for performing clinical studies.
          SampledPharmaStudy [0...1]
[1/*]		 Boolean Item attribute set with SerialNumberState and ItemState, indicating the item was sampled for post-registration pharmaceutical study supporting submitted changes to a dossier.
          SampledMarketingDemo [0...1]
[1/*]		 Boolean Item attribute set with SerialNumberState and ItemState, indicating the item was sampled for marketing demonstration purposes.
          SampledSelectiveControl [0...1]
[1/*]		 Boolean Item attribute set with SerialNumberState and ItemState, indicating the item was sampled for selective control.
          Spoilage [0...1]
[1/*]		 Boolean Item attribute set with SerialNumberState and ItemState, indicating the item is spoiled (e.g. due to heat, oxygen, moisture, microorganisms, etc.).
          WithdrawnExperiment [0...1]
[1/*]		 Boolean Item attribute set with SerialNumberState and ItemState, indicating the item is withdrawn from circulation of SSCC or SGTIN, piled or accumulated in the course of the experiment.
          Defective [0...1]
[1/*]		 Boolean Item attribute set with SerialNumberState and ItemState, indicating the item is defective.
          InappropriatelyStored [0...1]
[1/*]		 Boolean Item attribute set with SerialNumberState and ItemState, indicating the item was inappropriately stored.
          Returned [0...1]
[1/*]		 Boolean Item attribute set with SerialNumberState and ItemState, indicating the item was returned.
          Other [0...1]
[1/*]		 Boolean Item attribute set with SerialNumberState and ItemState, indicating the item was decommissioned or destroyed for other reasons.
          ProductRecallMarketList [0...1]
[-]		 - Conditionally required if Recalled = true. A list of one or more target market countries where the product lot is recalled.
            ProductRecallMarket [1...*]
[1/*]		 String Required. The country using the standard two or three-letter abbreviation specified in ISO 3166-1alpha-2:1997 country code. *26

See the ISOCountryCode enumeration list for valid values.
          MarketWithdrawalMarketList [0...1]
[-]		 - Conditionally required if Withdrawn = true. A list of one or more target market countries where the product lot is withdrawn.
            MarketWithdrawalMarket [1...*]
[1/*]		 String Required. The country using the standard two or three-letter abbreviation specified in ISO 3166-1alpha-2:1997 country code. *27

See the ISOCountryCode enumeration list for valid values.
          MarketReleaseMarket [0...*]
[1/*]		 String Required. The target market country using the standard two or three-letter abbreviation specified in ISO 3166-1alpha-2:1997 country code. *28

See the ISOCountryCode enumeration list for valid values.
          ReportingParty [0...1]
[1/*]		 String Not supported by TraceLink. If the reporting party identifier was set on a decommission or destroy operation, the identifier is provided.
          CryptoKey [0...1]
[0/4]		 String The alphanumeric value of the serial number's crypto key. *29
          CryptoCode [0...1]
[0/88]		 String The value of the serial number's crypto code. This value can contain alphanumeric values as well as symbols. *30 The following are valid symbols:
  • !
  • "
  • %
  • &
  • '
  • *
  • +
  • -
  • .
  • /
  • _
  • ,
  • :
  • ;
  • =
  • <
  • >
  • ?
          CryptoAcquisitionDate [0...1]
[10/10]		 - The date that CryptoKey and CryptoCode are retrieved from the OMS in YYYY-MM-DD format.
          Registered [0...1]
[1/*]		 -

Indicates whether the serial number was registered. Valid values:

  • true – The serial number was registered.
  • false – The serial number was not registered.
          Manifest [-]
[-]		 - The manifest contains summary information for each of the lowest items in a container aggregation hierarchy. If the container contains multiple products at the lowest level, there will be one Entries for the product in question.
            Entries [0...*]
[-]		 - A list of zero or more packaging levels with the summary information for the packaging level.
              Lot [0...1]
[1/*]		 String The lot number associated with the serial number at the time of commissioning. *31
              ExpirationDate [0...1]
[10/10]		 Date Not supported by TraceLink. The expiration date associated with the serial number at time of commissioning in XSD Date format in GMT:  YYYY-MM-DD.
              Manufacturing Date [0...1]
[10/10]		 Date The date of manufacture associated with the serial number in XSD Date format in GMT: YYYY-MM-DD. *32
              PackagingItemCodeType [1...1]
[1/*]		 String Conditionally required if PackagingItemCode is present. Identifies the packaging-level item code type. *33

See the ItemCodeType enumeration list for valid values.
              PackagingItemCode [1...1]
[1/*]		 String The packaging-level item code value (e.g. the GTIN-14 value). *34
              PackagingLevel [0...1]
[1/*]		 String The packaging level associated with the serial number. *35

See the PackLevel enumeration list for valid values.
              Qty [1...1]
[-]		 Integer Required. The quantity of serial numbers at the packaging level. *36
          Parent [0...1]
[-]		 - The parent serial number, if requested serial number is aggregated to a parent container.
            @sn [1...1]
[1/*]		 String Required. The serial Number that was requested. *37
            @namespace [0...1]
[1/*]		 String Not supported by TraceLink. See Serial Number Data Examples.
            @isUpdated [1...1]
[1/*]		 Boolean Required. Records whether the serial number is updated, which TraceLink uses for system processing.
          Children [0...*]
[-]		 - The list of child serial numbers, if requested serial number has child items aggregated to it.
            @sn [1...1]
[1/*]		 String Required. The serial number that was requested. *38
            @namespace [0...1]
[1/*]		 String Not supported by TraceLink. See Serial Number Data Examples.
            @isUpdated [1...1]
[1/*]		 Boolean Required. Records whether the serial number is updated, which TraceLink uses for system processing.
          CDEntries [0...*]
[1/*]		 String A customer-defined name.
            CDName [0...1]
[1/*]		 String A customer-defined name used to annotate serial numbers.
            CDValue [0...1]
[1/*]		 String A customer-defined value used to annotate serial numbers.
          SourceProductRepackInfo [0...1]
[-]		 - Identifies the source (original) product details at the lot level when the request specifies the repacakged product/lot information.
            LotNumber [1...1]
[1/*]		 String Required. The original lot number from the repackaging activity. *39
            ItemCode [0...1]
[1/*]		 String Identifies the item code and type for the original product.
              ItemCodeType [0...1]
[1/*]		 String Required. Identifies the packaging-level item code type.

Valid values:

  • GTIN_14
  • NTIN
              ItemCodeValue [1...1]
[1/*]		 String Required.The original packaging-level item code value (e.g. the GTIN-14 or GS1 Company Prefix value). *40
            InternalMaterialCode [0...1]
[1/*]		 String Identifies the original product using the internal material number configured in the Product Master Data. Specifying an internal material number updates all serial numbers at all packaging levels (e.g. item or case) that are associated with the internal material number and lot number. *41
          DestinationProductRepackInfo [0...1]
[-]		 - Identifies the repackaged (output) product lot(s) (could be one or more) when the request specifies the source product/lot in the repackaging activity. *42
            LotNumber [1...1]
[1/*]		 String Required. The repackaged lot number from the repackaging activity.
            ItemCode [0...1]
[1/*]		 String Identifies the item code and type for the repackaged product.
              ItemCodeType [0...1]
[1/*]		 String Required. Identifies the packaging-level item code type. Valid values: *43
  • GTIN_14
  • NTIN
              ItemCodeValue [1...1]
[1/*]		 String Required. The repackaged product packaging-level item code value (e.g. the GTIN-14 or GS1 Company Prefix value). *44
            InternalMaterialCode [0...1]
[1/*]		 String Identifies the repackaged product using the internal material number configured in the Product Master Data. Specifying an internal material number updates all serial numbers at all packaging levels (e.g. item or case) that are associated with the internal material number and lot number. *45
          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.