Get Lot Status 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. SOAP Envelope root element.
  S:Body [1...1]
[-]		 - Required. SOAP Message Body.
    ns3:GetLotQuantityResponse [1...1]
[-]		 - Required. Get Lot Quantity Response Message.
      LotStatusReturnResponse [0...1]
[-]		 - Required. Response.
        Success [0...1]
[-]		 - Required. Indicates if Get Lot Quantity request message processed successfully.
        ExceptionReturn [0...1]
[-]		 - Conditionally required if an error occurred, otherwise omitted. Populated with error information if Success = false.
          CallException [1...*]
[-]		 - Required. Contains error details.
            ExceptionCode [0...1]
[0/*]		 String Required. Error Code. See Get Lot Quantity Errors for all potential error exceptions and exception codes.
            ExceptionMessage [0...1]
[0/*]		 String Conditionally required if an error occurred for which an exception message is provided. Message that further describes error condition, if available.
        LotStatusReturn [1...1]
[-]		 - Required. Return from the Get Lot Quantity message.
          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 = 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 [1...1]
[-]		 - Required. List of one or more serial numbers in the recall event.
              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

See the Encoding enumeration list for valid values.
          MarketWithdrawalStatus [1...1]
[1/*]		 Boolean Required. Lot withdrawal status. *11
          MarketWithdrawalEvent [0...1]
[-]		 - Conditionally required 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.
          MarketReleaseStatus [1...1]
[1/*]		 String Required. Market release status of the lot.

Valid values: *14

  • Yes – Lot is fully market released in one or more markets.
  • No – Lot is not released in any market.
  • Partial – Part of the lot is released in one or more markets.
          MarketReleaseEvent [0...*]
[-]		 - Conditionally required if MarketReleaseStatus = Yes or Partial. Contains information relevant to the market release.
  • If MarketReleaseStatus = Yes or Partial, one or more MarketReleaseEvent must be present.
  • If MarketReleaseStatus = No, MarketReleaseEvent is not used.
            MarketReleaseMarket [1...1]
[1/*]		 String Required. Country using the standard two or three-letter abbreviation specified in ISO 3166-1alpha-2:1997 country code. *15

See the ISOCountryCode enumeration list for valid values.
            Transactions [0...1]
[-]		 - Transaction identifier associated with the market release.
              Transaction [1...*]
[-]		 - Required. List of one or more transaction identifiers.
                ItemId [0...1]
[1/*]		 String Required. Transaction identifier associated with the status update, for regulatory reporting and business tracking purposes. *16
                ItemType [0...1]
[1/*]		 String Required. Transaction identifier type. *17

Valid values:

  • CIVILCIRCULATION – Number of the document from a government agency for introduction of medicine into circulation. Used for immunobiological medicine only.
  • STATECONFIRMATION – Number of the document confirming the medicine complies with state registration requirements.
                Date [0...1]
[1/*]		 String The date of the transaction in YYYY-MM-DD format. *18
            PartialMarketReleaseSerialNumberList [1...1]
[-]		 - Required. List of one or more serial numbers in the market release event.
              SerialNumber [1...*]
[-]		 - Required. Released serial number.
                sn [1...1]
[1/*]		 String Required. Serial number in one of the following formats: *19

AI(01)+AI(21)

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

AI(00)

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

CN_CUR_CODE

  • Format: 20-digit China EDMC code
  • Example: 81530070000022519351
          InternalMaterialCode [0...1]
[1/*]		 String Use to identify the product using the internal material number configured in the Product Master Data. Specifying an internal material number will update all serial numbers at all packaging levels (e.g. item or case) that are linked to the internal material number and lot number. *20
          ExpirationDate [0...1]
[10/10]		 Date Expiration date associated with queried serial number. Date format YYYY-MM-DD. *21
          BarcodeExpirationDate [0...1]
[8/8]		 String The new lot barcode expiration date reflecting the expiration date on the barcode of the product in YYYYMMDD format. This supports a DD value of "00".
          Quantity [1...1]
[-]		 Integer Required. The quantity of commissioned SGTINs and SSCCs at the lot level. *22
          Pallets [0...1]
[-]		 Integer The quantity of the pallet-level serial numbers at the lot level. *23
          Cases [0...1]
[-]		 Integer The quantity of the case level serial numbers at the lot level. *24
          Innerpacks [0...1]
[-]		 Integer The quantity of the inner pack-level serial numbers at the lot level. *25
          Eaches [0...1]
[-]		 Integer The quantity of the each-level serial numbers at the lot level. *26
          Primaries [0...1]
[-]		 Integer The quantity of the primary-level serial numbers at the lot level.
          RepackSourceLotAggregateReturn [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. *27
            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.Valid values: *28
  • GTIN_14
  • NTIN

See the ItemCodeType enumeration list for valid values.
              ItemCodeValue [0...1]
[1/*]		 String The original packaging-level item code value (e.g. the GTIN-14 or GS1 Company Prefix value). *29
            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. *30
          RepackDestinationLotAggregateReturn [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. *31
            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. Valid values: *32
  • GTIN_14
  • NTIN

See the ItemCodeType enumeration list for valid values.
              ItemCodeValue [0...1]
[1/*]		 String The repackaged product packaging level item code value (e.g. the GTIN-14 or GS1 Company Prefix value). *33
            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. *34
        RequestId [0...1]
[1/*]		 String Identifies the id for asynchronous mode requests. Use this id in the FetchLotStatusResult call for lot quantity. The asynchronous call is recommended for high-volume lots of more than 100,000 serial numbers.