Fetch Digital Passport Group Data

Fetch Statistics using ProductGroup ID

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.

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

📌

The API is authenticated with the user rights required → certRead

InputTypeRequiredDescription
productGroupIdStringID of the product group.

Return Payload

FieldTypeDescription
successBooleanIndicates whether the request was successful.
dataObjectIt contains the full payload and blockchain information.
statsObjectContains more info.
stats.productCountNumberThe number of digital passports associated with the group.
stats.mintedProductNumberThe number of minted digital passports associated with a group.
[
    {
        "totalProducts": 2,
        "mintedProducts": 0
    }
]

Errors

Status CodeSuccessCodeError Message
404falsenpm.productManager.ProductGroupIdDoesNotExistProduct group ID does not exist.
500falsenpm.productManagement.UnknownErrorAn unknown error has occurred.

Fetch Data using ProductGroup ID

As a brand, you wish to retrieve data attached to a created digital passport batch for a given product group.

URL

To fetch the information reading a digital passport batch, use /productManagement/productGroup/:productGroupId.

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

Return Payload

FieldTypeDescription
productGroupIdStringIdentifier for the product group.
contentObjectContent details (schema added by API).
tagsArrayTags associated with the product.
publicContentBooleanVisibility on platforms like OpenSea.
mintedBooleanWhether the NFT is minted or not.
tokenIdStringtokenId of the NFT on the network.
passphraseStringView key of the NFT.
{
    "data": {
        "productGroupId": "5349",
        "content": {
            "language": "en-US",
            "name": "Blop blop",
            "sku": "NAC-BB-LS20-06",
            "gtin": "0 00 12345 60001 2",
            "brandInternalId": "NYC12345",
            "category": "apparel",
            "subCategory": "watch",
            "intended": "womens",
            "serialnumber": [
                {
                    "type": "serialnumber",
                    "value": "DEMO#001"
                },
                {
                    "type": "casenumber",
                    "value": "Cas pratique - Clara"
                },
                {
                    "type": "movementnumber",
                    "value": "85QR18 [demo]"
                }
            ],
            "subBrand": "Arianee watches",
            "model": "Limited serie 2020",
            "description": "<b>Description</b>\nThe Navyclock by Arianee watch, small model, quartz movement. Case in 18k pink gold, beaded crown in 18k pink gold set with a synthetic cabochon-shaped spinel, strap in leather. \n\n<b>Case dimensions</b>\ndiameter: 29.5 mm, thickness: 6.35 mm, water-resistant to 3 bar (approx. 30 meters/100 feet).",
            "subDescription": [
                {
                    "type": "other",
                    "title": "The Navyclock watchmaking process",
                    "content": "The Navyclock preserves the perfectly pitched classical elegance and signature Arianee features. The brand has been producing its own in-house movements since 2017. The movements boast a host of features but are designed to be thin by incorporating various complications into the mainplate."
                },
                {
                    "type": "service",
                    "title": "Customer service information",
                    "content": "The Navyclock is rarely down. When it happens you can be sure our network will be here for you. "
                }
            ],
            "externalContents": [
                {
                    "type": "website",
                    "title": "Website",
                    "url": "https://www.arianee.org/"
                },
                {
                    "type": "website",
                    "title": "About Arianee",
                    "url": "https://www.arianee.org/about-arianee"
                },
                {
                    "type": "website",
                    "title": "History of Watches",
                    "url": "https://en.wikipedia.org/wiki/History_of_watches"
                },
                {
                    "type": "proofLinkAction",
                    "title": "Link with a proof of ownership",
                    "url": "https://test.arian.ee/proofLinkAction.html"
                }
            ],
            "msrp": [
                {
                    "msrp": "35000",
                    "currency": "EUR",
                    "msrpCountry": "Europe"
                },
                {
                    "msrp": "32000",
                    "currency": "GBP",
                    "msrpCountry": "United Kingdom"
                },
                {
                    "msrp": "40000",
                    "currency": "USD",
                    "msrpCountry": "USA"
                }
            ],
            "medias": [
                {
                    "mediaType": "picture",
                    "type": "product",
                    "url": "https://bdharianeetest.firebaseapp.com/pub/-Lzfbb6qGXMN3LVhPRWG_arianeeResized"
                },
                {
                    "mediaType": "picture",
                    "type": "product",
                    "url": "https://bdharianeetest.firebaseapp.com/pub/-LzfbcJwhZPNES_2NK1h_arianeeResized"
                },
                {
                    "mediaType": "picture",
                    "type": "product",
                    "url": "https://bdharianeetest.firebaseapp.com/pub/-LzfbdNMkhOxvu5n_cPv_arianeeResized"
                },
                {
                    "mediaType": "picture",
                    "type": "brandItemBackgroundPicture",
                    "url": "https://bdharianeetest.firebaseapp.com/pub/-LtzQIIK-FD65qAFCBEm"
                },
                {
                    "mediaType": "youtube",
                    "type": "product",
                    "url": "https://www.youtube.com/watch?v=Z7v41l4I-Gc",
                    "ytId": "Z7v41l4I-Gc",
                    "thumbnail": "https://img.youtube.com/vi/Z7v41l4I-Gc/0.jpg",
                    "embedURL": "https://www.youtube.com/embed/Z7v41l4I-Gc"
                },
                {
                    "mediaType": "picture",
                    "type": "itemBackgroundPicture",
                    "url": "https://bdharianeemaxime.firebaseapp.com/pub/-LzI78FCrDVaPk8tQkl9"
                },
                {
                    "mediaType": "picture",
                    "type": "certificateBackgroundPicture",
                    "url": "https://bdharianeemaxime.firebaseapp.com/pub/-LzI7CrFW31aP_hyx1ZE"
                }
            ],
            "attributes": [
                {
                    "type": "color",
                    "value": "Gold"
                }
            ],
            "materials": [
                {
                    "material": "gold",
                    "pourcentage": "50%"
                }
            ],
            "size": [
                {
                    "type": "depth",
                    "value": "6",
                    "unit": "in"
                },
                {
                    "type": "depth",
                    "value": "3,6",
                    "unit": "cm"
                }
            ],
            "manufacturingCountry": "Switzerland",
            "facilityId": "12345",
            "productCertification": [
                {
                    "name": "fairtrade"
                }
            ],
            "i18n": [
                {
                    "language": "fr-FR",
                    "description": "<b>Description</b>\nLa montre The Navyclock d'Arianee est un petit modèle utilisant le mouvement à quartz. Boitier en or rose 18 carats, Couronne perlée en or rose 18 carats sertie d'un spinelle synthétique en forme de cabochon, bracelet en cuir.\n\n<b>Dimensions</b>\ndiamètre: 29.5 mm, épaisseur: 6.35 mm, étanche à 3 bar (environ 30 mètres/100 pieds).",
                    "externalContents": [
                        {
                            "type": "website",
                            "title": "Site",
                            "url": "https://www.arianee.org/"
                        },
                        {
                            "type": "website",
                            "title": "Arianee",
                            "url": "https://www.arianee.org/about-arianee"
                        },
                        {
                            "type": "website",
                            "title": "L'Histoires des montres ",
                            "url": "https://fr.wikipedia.org/wiki/Montre_(horlogerie)"
                        },
                        {
                            "type": "proofLinkAction",
                            "title": "Link with a proof of ownership",
                            "url": "https://test.arian.ee/proofLinkAction.html"
                        }
                    ]
                },
                {
                    "language": "zh-CN",
                    "description": "<b>描述</b>\nThe Navyclock by Arianee 手表,小型款,石英机芯. 18k玫瑰金表壳,18k玫瑰金串珠状表冠,镶有凸圆形人造合成尖晶石,皮革表带.\n\n<b>外壳尺寸</b>\n直径:29.5毫米,厚度:6.35毫米,防水深度达3巴(约30米/ 100英尺\n",
                    "externalContents": [
                        {
                            "type": "website",
                            "title": " 网站",
                            "url": "https://www.arianee.org/"
                        },
                        {
                            "type": "website",
                            "title": " 关于 Arianee",
                            "url": "https://www.arianee.org/about-arianee"
                        },
                        {
                            "type": "website",
                            "title": " 手表的历史",
                            "url": "https://zh.wikipedia.org/wiki/%E6%89%8B%E8%A1%A8"
                        }
                    ]
                }
            ],
            "$schema": "https://cert.arianee.org/version2/ArianeeProductCertificate-i18n.json"
        },
        "tags": [
            "test"
        ],
        "protocol": "testnet",
        "minted": false,
        "passphrase": "889hrvvc8975"
    }
}

Errors

Status CodeSuccessCodeError Message
404falsenpm.productManager.ProductGroupIdDoesNotExistProduct group ID does not exist.
500falsenpm.productManagement.UnknownErrorAn unknown error has occurred.