Fetch Lot Status Result Response Guidelines

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

If the response contains less than 100,000 serial numbers, use the Get Lot Status request.

The following data is included in the message response:

Data Element Occurs
Length		 Type Description
S:ES:Envelope [1...1]
[–]		 - Required. SOAP Envelope root element.
  S:Body [1...1]
[–]		 - Required. SOAP Message Body.
    ns3:FetchLotStatusResultResponse [1...1]
[–]		 - Required. FetchLotStatusResultResponse Response Message.
      Success [0...1]
[–]		 - Required. Indicates whether FetchLotStatusResult request message processed successfully.
      LotStatusReturn [1...1]
[–]		 - Required. Return from the FetchLotStatusResultResponse API call when asynchronous API call is completed.
        ItemCode [0...1]
[1/*]		 String Packaging level item code value (e.g. the GTIN-14, CN-ResCode, or GS1 Company Prefix value). *1
        packagingItemCodeType [0...1]
[1/*]		 String

Identifies the packaging level item code type. *2

See the CountryDrugCode enumeration list for valid values.
        PackagingCodes [0...1]
[–]		 String The packaging level item code(s) associated with the serial numbers commissioned against the lot.
          ItemCodeType [0...1]
[1/*]		 String Required. Identifies the packaging level item code type. *3

See the ItemCodeType enumeration list for valid values.
          ItemCode [0...1]
[1/*]		 String Required. Packaging level item code value (e.g. the GTIN-14, CN-ResCode, or GS1 Company Prefix value). *4
        LotNumber [0...1]
[1/*]		 String Required. Lot Number that was queried against. *5
        QualityReleased [0...1]
[1/5]		 Boolean Indicates if the lot has been released.
        ProductRecallStatus [1...1]
[1/*]		 String Required. Lot recall status. Valid values: *6
  • Yes
  • No
  • Partial
        ProductRecallEvent [0...*]
[–]		 - Conditionally required if ProductRecallStatus equals Yes or Partial. Group containing lot recall information.
  • If the lot is fully recalled (ProductRecallStatus = Yes), one product recall event is present.
  • If the lot is partially recalled (ProductRecallStatus= Partial), one or more product recall events are present.
  • If the lot is not recalled (ProductRecallStatus = No), no product recall events are present.
            ProductRecallMarketList [1...1]
[–]		 - Required. List of one or more target market countries where the product lot is recalled.
              ProductRecallMarket [1...*]
[1/*]		 String Required. Country using the standard two or three-letter abbreviation specified in ISO 3166-1alpha-2:1997 country code. *7

See the ISOCountryCode enumeration list for valid values.
            ProductRecallEffectiveDate [1...1]
[10/10]		 Date Required. Recall effective date in MM/DD/YYYY format. *8
            ProductRecallReasonDescription [1...1]
[1/*]		 String Reason for the recall and any relevant information.
            PartialProductRecallSerialNumberList [0...1]
[–]		 - Conditionally required if the Get Lot Status request element includePartialRecallSerialNumbers = true. List of one or more serial numbers in the recall event.
Only present for partial recalls.
              SerialNumber [1...*]
[–]		 - Required. Recalled serial number.
                @sn [1...1]
[1/*]		 String Required. Serial number in one of the following formats: *9
  • AI(01)+AI(21)
  • AI(00)
  • CN_CUR_CODE
                @namespace [0...1]
[1/*]		 String Serial number format. Valid serial number formats: *10
  • AI(01)+AI(21)
  • AI(00)
  • CN_CUR_CODE
        MarketWithdrawalStatus [1...1]
[1/*]		 Boolean Required. Lot withdrawal status. *11
        MarketWithdrawalEvent [0...1]
[–]		 - Conditionally required if MarketWithdrawalStatus = true. Group containing market withdrawal information.
          MarketWithdrawalMarketList [0...1]
[–]		 - Required. List of one or more Target Market countries where the product lot is withdrawn.
            MarketWithdrawalMarket [1...*]
[1/*]		 String Required. Country using the standard two or three-letter abbreviation specified in ISO 3166-1alpha-2:1997 country code. *12

See the ISOCountryCode enumeration list for valid values.
          MarketWithdrawalEffectiveDate [0...1]
[10/10]		 Date Market withdrawal effective date in MM/DD/YYYY format. *13
          MarketWithdrawalReasonDescription [0...1]
[1/*]		 String Reason for the withdrawal and any relevant information.
        InternalMaterialCode [0...1]
[1/*]		 String Identifies the 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 linked to the internal material number and lot number. *14
        ExpirationDate [0...1]
[10/10]		 Date Expiration date associated with the queried serial number in YYYY-MM-DD format. *15
        Quantity [1...1]
[–]		 Integer Required. The quantity of serial numbers at the lot level. *16
        Pallets [0...1]
[–]		 Integer The quantity of the pallet-level serial numbers at the lot level. *17
        Cases [0...1]
[–]		 Integer The quantity of the case level serial numbers at the lot level. *18
        Innerpacks [0...1]
[–]		 Integer The quantity of the inner pack-level serial numbers at the lot level. *19
        Eaches [0...1]
[–]		 Integer The quantity of the each-level serial numbers at the lot level. *20
        Primaries [0...1]
[–]		 Integer The quantity of the primary-level serial numbers at the lot level.
        RepackecSourceLotAggregateReturn [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. *21
          ItemCode [0…1]
[1/*]		 string Identifies the item code and type for the original product.
            ItemCodeType [0...1]
[1/*]		 String Identifies the packaging level item code type. *22

Valid values:

  • GTIN_14
  • NTIN
            ItemCodeValue [0...1]
[1/*]		 String The original packaging-level item code value (e.g. the GTIN-14 or GS1 Company Prefix value). *23
          InternalMaterialNumber [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. *24
        RepackecDestinationLotAggregateReturn [0...*]
[–]		 - Identifies the repackaged (output) product lot(s) (could be one or more) when the request specifies the source product/lot in the repackaging activity.
          LotNumber [1...1]
[1/*]		 String Required. The repackaged lot number from the repackaging activity. *25
          ItemCode [0…1]
[1/*]		 string Identifies the item code and type for the repackaged product.
            ItemCodeType [0...1]
[1/*]		 String Identifies the packaging level item code type. *26

Valid values:

  • GTIN_14
  • NTIN
            ItemCodeValue [0...1]
[1/*]		 String The repackaged product packaging level item code value (e.g. the GTIN-14 or GS1 Company Prefix value). *27
          InternalMaterialNumber [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. *28