Report Digital Passport Group using ID

Fetch data associated with a digital product passport group, such as the number of passports and how many are already minted.

Use Case

As a brand, you wish to follow up on your digital passport claiming rate for a given group. To do so, this API returns the total count of passports in a group and the count of claimed passports.

URL

To get the analytics of a specific product group, use productManagement/productGroup/:productGroup/stats.

URL

GET - https://{{nmpUrl}}/productManagement/productGroup/:productGroupId/stats

📌

The API is authenticated with the user rights required → certRead

Input	Type	Required	Description
productGroupId	String	✅	ID of the product group.

Return Payload

Field	Type	Description
success	Boolean	Indicates whether the request was successful.
data	Object	It contains the full payload and blockchain information.
stats	Object	Contains more info.
stats.productCount	Number	The number of digital passports associated with the group.
stats.mintedProduct	Number	The number of minted digital passports associated with a group.

200 Return Payload

[
    {
        "totalProducts": 2,
        "mintedProducts": 0
    }
]

Errors

Status Code	Success	Code	Error Message
404	false	npm.productManager.ProductGroupIdDoesNotExist	Product group ID does not exist.
500	false	npm.productManagement.UnknownError	An unknown error has occurred.