Product verification APIs

Producers can verify against their own serial number information to ensure that the verification response returned by Product Information Manager is correct.

Product Verification (REST)

Producers use this message to verify against serial numbers they own. Verification is performed against serial number information stored in the Product Information Manager repository.

Guidelines

Element Type Description
product Object Required. Contains the serial number information for verification.
  packagingCode String

Required. The serialized product's packaging code.
  packagingCodeType Enum

Required. Indicates the type of the serialized product's associated packagingCode. Valid value: GTIN-14
  serialNumber String Required. The serial number of the product.
  lotNumber String Required. The lot number of the product.
  expiry String Required. The expiration date of the product in YYMMDD format.
context Enum Required. The reason the product is being verified. Valid values: 
  • dscsaStatusCheck – The product is being verified for routine reasons to retrieve basic verification information, such as the product's expiration date.
  • dscsaExceptionVerification – The product is being verified to retrieve more information about a product.
  • dscsaSuspectIllegitimate – The product is being verified because it is suspected as being illegitimate.
  • dscsaSaleableReturn – The product is being verified to confirm that it can be resold after being returned.
ctrlPossessAtt Boolean Required. Indicates whether the company submitting the verification request is in possession of the product they are verifying. Valid values: 
  • True – The company is in possession of the product they are verifying.
  • False – The company is not in possession of the product they are verifying.

Example

{
    "t": {
        "v": 1,
        "m": "pie--producer-verify--v1",
        "app-id": "D29A8B05-F8A7-4F35-9C7D-84344E0BE095",
	 "cid": "860d16e5-99f5-4a9f-8ac5-f84e244a4065"
    },
    "p": {
        "product": {
            "packagingCode": "64385625627039",
            "packagingCodeType": "GTIN-14",
            "serialNumber": "100000000000",
            "lotNumber": "1234567890",
            "expiry": "230918"
        },
	     "context":"dscsaExceptionVerification",
	     "ctrlPossessAtt":true
	}
}

Guidelines

Element Type Description
product Object Required. Contains the serial number information for verification.
  packagingCode String

Required. The serialized product's packaging code.
  packagingCodeType Enum

Required. Indicates the type of the serialized product's associated packagingCode. Valid value: GTIN-14
  serialNumber String Required. The serial number of the product.
  lotNumber String Required. The lot number of the product.
  expiry String Required. The expiration date of the lot in YYMMDD format.
  serialNumberStatus Enum The serial number status of the product. Valid values:
  • COMMISSIONED
  • DECOMMISSIONED
  • DESTROYED
  itemStatus Enum The item status of the product. Valid values:
  • AVAILABLE – Item is available for picking.
  • BLOCKED – Item is unavailable for picking.
  • PENDING_RECEIPT – Item is pending receipt confirmation at the receiving location.
  • PICKED – Item has been picked.
  • RECEIVED – Item has been received.
  • SHIPPED – Item has been shipped.
  • UNDER_INVESTIGATION – Item is under investigation, e.g. because of a suspect product investigation or for product quality or condition issue.
  attribute String The attribute of the product.
data Object Required. The verification data.
  verified Boolean

Required. Indicates the success of the product verification request.

  • true – The product verification request is successful.
  • false – The product verification request is not successful.
  additionalInfo Enum

Additional information that indicates if the verified product has a status of Recalled, Expiration Extended, Illegitimate, Suspect, or Expired. Valid values:

  • Recalled – The product has been recalled.
  • ExpirationExtended – The product's original expiration date has passed, but its expiration date has been extended to a date in the future.
  • Illegitimate – The manufacturer has identified the product as illegitimate.
  • Suspect – The manufacturer has identified the product as suspect.
  • Expired – The product has expired.
  verificationFailureReason Enum

Conditionally required if verified = "FALSE". Indicates the reason for the unsuccessful product verification. Valid values:

  • No_match_GTIN_Serial – There was not a match for the given serial number.
  • No_match_GTIN_Serial_Expiry – There was not a match for the given expiration date.
  • No_match_GTIN_Serial_Lot – There was not a match for the given lot number.
  • No_match_GTIN_Serial_Lot_Expiry – There was not a match for the given lot number and lot expiration date.
  • No_reason_provided – A reason is not available for the product verification failure.
  • Manufacturer_policy – The serial number information matches, but the Producer has indicated that the product is not fit for distribution because of an internal policy (e.g. recalled product, expired product).
  • Not_for_re-distribution – The serial number information matches, but the Producer has indicated that the product is suspect and not fit for distribution to the downstream supply chain.

Example

{
    "t": {
        "v": 1,
        "m": "pie--producer-verify-response--v1",
        "app-id": "223C3176-6F7C-438D-B06F-DDCDA21C2E5C",
        "cid": "8iq04329-72be-4e3e-a4d5-ba7433c89a88"
    },
    "p": {
        "product": {
            "packagingCode": "00300015555015",
            "packagingCodeType": "GTIN-14",
            "serialNumber": "12345",
            "lotNumber": "5678912",
            "expiry": "221121"
        },
        "data": {
            "verified": "true"		
        }
    }
}