Create Digital Passports Group

Create a group of digital product passports working as a template for the multiple passports you wish to mint.

Overview

Use case

Let's say your brand created parent digital passports for the three new hoodie models available for your customers. You have produced 5,000 pieces of each model, so you need to produce 5,000 digital passports per group of products.

💡

  • Your productGroup works as a trunk for your group. Once your group is created, create your create Digital Passports per product. You'll need to call n times the request to create n digital passports for your n products.
  • You can either decide to create a digital passport group draft, and do not mint the passport on the network, or you can mint it directly.

⚠️

  • Each digital passport group minted spends 1 credit.
  • Digital passport recovery time is automatically 5 years.
  • To associated a digital passport with a group, the group must be minted on the network.
  • You must set unique productGroupId.

Workflow

Let's start 🚀

Create a digital passport group

URL

To create a product group draft, use /productManagement/productGroup/create.

POST - https://{{nmpUrl}}/productManagement/productGroup/create

Body

FieldTypeRequiredDefault ValueDescription
productGroupIdStringN/AIdentifier for the product group.
contentObjectN/AContent details (schema added by API).
tagsArrayN/ATags associated with the product.
publicContentBooleanfalseVisibility on platforms like OpenSea.
mintBooleanfalseWhether to create the digital passport directly on the blockchain.
If you do not mint the digital passport group, use the mint request.
⚠️ Reminder: The group must be minted to create its digital passports.
{
    "productGroupId": "navyclock", // required
    "tags": ["tagToBeCreated"], // optional
    "mint": false, // optional
    "publicContent": true, // optional
    "content": { // optional
        "language": "en-US",
        "name": "The Navyclock",
        "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"
            }
            ]
        }
        ]
    }
}

Return Payload

FieldTypeDescription
successBooleanIndicates whether the request was successful.
dataObjectContains the full payload and blockchain information.
{
    "success": true,
    "data": {
        "productGroupId": "Stradale",
        "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/version5/ArianeeProductCertificate-i18n.json"
        },
        "tags": [
            "tagToBeCreated",
            "parentPassport"
        ],
        "minted": false,
        "passphrase": "m5imf44sfv8z"
    }
}

Errors

Status CodeSuccessCodeError Message
400falsenpm.productManager.incorrectPayloadSome parameters of your payload are incorrect. See details.
409falsenpm.productManagement.productGroupIdAlreadyExistThis productGroupId Navitimer_B01 already exists.
500falsenpm.productManagement.UnknownErrorAn unknown error has occurred.
{
    "message": "productGroupId SF9 already exists",
    "code": "nmp.productManagement.PRODUCT_GROUP_ID_ALREADY_EXISTS"
}

Mint a Digital Product Passports Group

⚠️

Each group minted spends as many credit as there are product passport in this group.

URL

To mint on the network the digital passport group previously created, use /productManagement/productGroup/:productGroupId/mint.

POST - https://{{nmpUrl}}/productManagement/productGroup/:productGroupId/mint

Return Payload

FieldTypeDescription
successBooleanIndicates whether the request was successful.
dataObjectContains the full payload and blockchain information.
{
    "success": true,
    "data": {
        "productGroupId": "SF90",
        "content": {
            "language": "en-US",
            "name": "edited",
            "$schema": "https://cert.arianee.org/version5/ArianeeProductCertificate-i18n.json"
        },
        "tags": [
            "EDITED",
            "parentPassport"
        ],
        "minted": false,
        "passphrase": "y0m7x4pcl4wo"
    }
}

Errors

Status CodeSuccessCodeError Message
400falsenpm.productManager.incorrectPayloadSome parameters of your payload are incorrect. See details.
404falsenpm.productManager.ProductGroupIdDoesNotExistProduct group ID does not exist.
400falsenpm.productManager.alreadyMintedDigital passports are already minted.
500falsenpm.productManagement.UnknownErrorAn unknown error has occurred.

🗂️

To retrieve the legacy NFT Management API, see the V1.9 documentation.