Update Digital Passport Group
Overview
Use Cases
- Update complete JSON Schema: Your brand wishes to fix issues and review the entire content.
- Update JSON schema & metadata: Update digital passports group' tag(s).
- Update one JSON schema property: The URL of the external content you linked to a digital passport group such as a YouTube video needs to be updated in the passport group content and the tags.
- Update extra-languages JSON schema:
- Your brand wishes to provide additional language for the passport group content.
- Your brand wishes to update the content of an extra language of a digital passport group to fix issues, review the content, or add additional information.
- Remove one property in the JSON schema: Remove information in the content such as the product model.
- Remove one property in extra-languages JSON schema: Remove information in the content such as the product model in an extra language such as French.
Workflow
Update Content & Metadata
Fields with multiple values
Example: If you defined two tags (
tag1,tag2) while creating your digital passport group, and udpate with a new one (tag3), the two previous ones will be erased. So if you wish to keep them all, update withtag1,tag2,tag3.This works will all the fields that may have multiple values.
Update Complete JSON Schema
This request will update all the digital passport data, and erase all the existing fields of your digital passport group.
URL
To update the complete JSON schema of a target digital passport, use /productManagement/productGroup/:productGroupId.
PUT - https://{{nmpUrl}}/productManagement/productGroup/:productGroupId
The update override all objects.
Body
{
"tags": ["EDITED"],
"content": {
"language": "en-US",
"name": "product",
"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
| Field | Type | Description |
|---|---|---|
success | Boolean | Indicates whether the request was successful. |
data | Object | Contains the full payload of the group information. |
{
"success": true,
"data": {
"productGroupId": "productGroupID",
"content": {
"language": "en-US",
"name": "product",
"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"
},
{
"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": [
"EDITED",
"public_v2"
],
"minted": false,
"passphrase": "6d8j0envby6d",
"productId": "productId"
}
}
Update JSON Schema Property & Metadata
You wish to replace some information in the JSON schema of a digital passport group or metadata such as tags.
URL
To update specific data in the JSON body, use /productManagement/productGroup/:productGroupId.
PATCH - https://{{nmpUrl}}/productManagement/productGroup/:productGroupId
Body
{
"tags": ["EDITED"],
"content": {
"language": "en-US",
"name": "Navy Clock",
"sku": "NAC-BB-LS20-06",
"gtin": "0 00 12345 60001 2",
"brandInternalId": "NYC12345",
"category": "apparel",
"subCategory": "Apparel",
"intended": "men",
"serialnumber": [
{
"type": "movementnumber",
"value": "85QR18 [demo]"
}
],
"size": [
{
"type": "depth",
"value": "3,6",
"unit": "cm"
}
]
}
}
{
"tags": ["newtag"]
}
Return Payload
| Field | Type | Description |
|---|---|---|
success | Boolean | Indicates whether the request was successful. |
data | Object | Contains the full payload of the group information. |
{
"success": true,
"data": {
"productGroupId": "productGroupID",
"content": {
"language": "en-US",
"name": "Black shirt",
"sku": "NAC-BB-LS20-06",
"gtin": "0 00 12345 60001 2",
"brandInternalId": "NYC12345",
"category": "apparel",
"subCategory": "Apparel",
"intended": "men",
"serialnumber": [
{
"type": "movementnumber",
"value": "85QR18 [demo]"
}
],
"size": [
{
"type": "depth",
"value": "3,6",
"unit": "cm"
}
],
"$schema": "https://cert.arianee.org/version5/ArianeeProductCertificate-i18n.json"
},
"tags": [
"EDITED"
],
"minted": false,
"passphrase": "813op6s5ow8x"
}
}
Update One JSON Schema Property
You wish to update one specific property of the digital passport schema. Find below the supported properties.
URL
To update one specific field, use /productManagement/product/:productId/:property. The new property value is passed in the body.
When updating a property, pass all the associated values in the body if you do not want to erase them from the content.
See thematerialsupdate example: Pourcentage ofgoldhas been updated butsilverremains the same, however we have both values.
Supported properties
language,name,sku,gtin,brandInternalId,category,subCategory,intended,serialnumber,subBrand,model,description,subDescription,externalContents,msrp,medias,customAttributes,attributes,materials,size,manufacturingCountry,facilityId,productCertification,transparencyItems,i18n,parentCertificates,image,image_data,external_url,background_color,animation_url,youtube_url
PUT - https://{{nmpUrl}}/productManagement/productGroup/:productGroupId/:property
Body
{
"data": "New name"
}
{
"data": [
{
"type": "serialnumber",
"value": "12324"
}
]
}
{
"data": [
{
"material": "gold",
"pourcentage": "99"
},
{
"material": "silver",
"pourcentage": "1"
}
],
}
Return Payload
| Field | Type | Description |
|---|---|---|
success | Boolean | Indicates whether the request was successful. |
data | Object | Contains the full payload of the group information. |
{
"success": true,
"data": {
"productGroupId": "productGroupId",
"content": {
"language": "en-US",
"name": "Navy Clock",
"sku": "NAC-BB-LS20-06",
"gtin": "0 00 12345 60001 2",
"brandInternalId": "NYC12345",
"category": "apparel",
"subCategory": "Apparel",
"intended": "men",
"serialnumber": [
{
"type": "movementnumber",
"value": "85QR18 [demo]"
}
],
"size": [
{
"type": "depth",
"value": "3,6",
"unit": "cm"
}
],
"$schema": "https://cert.arianee.org/version5/ArianeeProductCertificate-i18n.json",
"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"
}
]
}
]
},
"tags": [
"Edited"
],
"minted": false,
"passphrase": "813op6s5ow8x"
}
}
Errors
| Status Code | Success | Error Message |
|---|---|---|
400 | false | Property passed as param must be a string and one of language, name, sku, gtin, brandInternalId, category, subCategory, intended, serialnumber, subBrand, model, description, subDescription, externalContents, msrp, medias, customAttributes, attributes, materials, size, manufacturingCountry, facilityId, productCertification, transparencyItems, i18n, parentCertificates, image, image_data, external_url, background_color, animation_url, youtube_url |
{
"errors": [
{
"value": "wrongproperty",
"msg": "property passed as param must be a string and one of language, name, sku, gtin, brandInternalId, category, subCategory, intended, serialnumber, subBrand, model, description, subDescription, externalContents, msrp, medias, customAttributes, attributes, materials, size, manufacturingCountry, facilityId, productCertification, transparencyItems, i18n, parentCertificates, image, image_data, external_url, background_color, animation_url, youtube_url",
"param": "property",
"location": "params"
}
]
}
Update One Property in Extra-language JSON Schema
You wish to update data for the extra languages of your digital passport group.
URL
To update an additional language, use /productManagement/productGroup/:productGroupId/i18n/:language/:property.
Supported languages
fr-FR,en-US,zh-TW,zh-CN,ko-KR,ja-JP,de-DE,es,it,ru
PUT - https://{{nmpUrl}}/productManagement/productGroup/:productGroupId/i18n/:language/:property
Body
{
"data": [{
"type": "edited",
"value": "edited"
}]
}
Return Payload
| Field | Type | Description |
|---|---|---|
success | Boolean | Indicates whether the request was successful. |
data | Object | Contains the full payload of the group information. |
{
"success": true,
"data": {
"productGroupId": "productGroupID",
"content": {
"language": "en-US",
"name": "Navy Clock",
"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"
},
{
"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"
}
]
},
{
"language": "de-DE",
"serialnumber": [
{
"type": "website",
"title": "Site",
"url": "https://www.arianee.org/"
}
]
}
],
"$schema": "https://cert.arianee.org/version5/ArianeeProductCertificate-i18n.json"
},
"tags": [
"EDITED"
],
"minted": false,
"passphrase": "813op6s5ow8x"
}
}
Errors
| Status Code | Success | Error Message |
|---|---|---|
400 | false | Language passed as param must be a string and one of fr-FR, en-US, zh-TW, zh-CN, ko-KR, ja-JP, de-DE, es, it, ru. |
{
"errors": [
{
"value": "deDE",
"msg": "language passed as param must be a string and one of fr-FR, en-US, zh-TW, zh-CN, ko-KR, ja-JP, de-DE, es, it, ru",
"param": "language",
"location": "params"
}
]
}
Remove Property in Content
Remove One Property in the JSON Schema
You wish to remove one specific property in the JSON schema of a digital passport group.
Supported properties
language,name,sku,gtin,brandInternalId,category,subCategory,intended,serialnumber,subBrand,model,description,subDescription,externalContents,msrp,medias,customAttributes,attributes,materials,size,manufacturingCountry,facilityId,productCertification,transparencyItems,i18n,parentCertificates,image,image_data,external_url,background_color,animation_url,youtube_url
URL
To remove on specific property in the JSON schema, use /productManagement/productGroup/:productGroupId/:property.
DELETE - https://{{nmpUrl}}/productManagement/productGroup/:productGroupId/:property
Return Payload
| Field | Type | Description |
|---|---|---|
success | Boolean | Indicates whether the request was successful. |
data | Object | Contains the full payload of the group information. |
{
"success": true,
"data": {
"productGroupId": "productgroupId",
"content": {
"language": "en-US",
"name": "Hybrid 450",
"model": "SF90",
"description": "Product description.",
"medias": [
{
"mediaType": "picture",
"type": "product",
"url": "https://www.sites/default/files/slideshow/slides/2022-07/62c4188892bc3.jpg"
},
{
"mediaType": "picture",
"type": "product",
"url": "https://site.fr/wp-content/uploads/2022/07/5__fitmaxwzeyodasmtaynf0.jpeg"
}
],
"attributes": [
{
"type": "color",
"value": "Red"
}
],
"manufacturingCountry": "Italy",
"i18n": [
{
"language": "fr-FR",
"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": [
"parentPassport"
],
"minted": true,
"passphrase": "dr3qu5h7af7h",
"tokenId": 216529552
}
}
Errors
| Status Code | Success | Error Message |
|---|---|---|
400 | false | Property passed as param must be a string and one of language, name, sku, gtin, brandInternalId, category, subCategory, intended, serialnumber, subBrand, model, description, subDescription, externalContents, msrp, medias, customAttributes, attributes, materials, size, manufacturingCountry, facilityId, productCertification, transparencyItems, i18n, parentCertificates, image, image_data, external_url, background_color, animation_url, youtube_url |
Remove One Property in Extra-languages JSON Schema
You wish to remove a property for a target extra-language in a digital passport group.
URL
To remove a property, use /productManagement/productGroup/:productGroupId/i18n/:language/:property.
- Supported languages:
fr-FR,en-US,zh-TW,zh-CN,ko-KR,ja-JP,de-DE,es,it,ru- Supported properties:
language,name,sku,gtin,brandInternalId,category,subCategory,intended,serialnumber,subBrand,model,description,subDescription,externalContents,msrp,medias,customAttributes,attributes,materials,size,manufacturingCountry,facilityId,productCertification,transparencyItems,i18n,parentCertificates,image,image_data,external_url,background_color,animation_url,youtube_url
DELETE - https://{{nmpUrl}}/productManagement/productGroup/:productGroupId/i18n/:language/:property
Return Payload
| Field | Type | Description |
|---|---|---|
success | Boolean | Indicates whether the request was successful. |
data | Object | Contains the full payload of the group information. |
{
"success": true,
"data": {
"productGroupId": "productGroupId",
"content": {
"language": "en-US",
"name": "Hybrid 450",
"model": "SF90",
"description": "Product description",
"medias": [
{
"mediaType": "picture",
"type": "product",
"url": "https://www.sites/default/files/slideshow/slides/2022-07/62c4188892bc3.jpg"
},
{
"mediaType": "picture",
"type": "product",
"url": "https://site.fr/wp-content/uploads/2022/07/5__fitmaxwzeyodasmtaynf0.jpeg"
}
],
"attributes": [
{
"type": "color",
"value": "Red"
}
],
"manufacturingCountry": "Italy",
"i18n": [
{
"language": "fr-FR",
"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": [
"parentPassport"
],
"minted": true,
"passphrase": "dr3qu5h7af7h",
"tokenId": 216529552
}
}
Errors
| Status Code | Success | Error Message |
|---|---|---|
400 | false | Language passed as param must be a string and one of fr-FR, en-US, zh-TW, zh-CN, ko-KR, ja-JP, de-DE, es, it, ru. |
400 | false | Property passed as param must be a string and one of language, name, sku, gtin, brandInternalId, category, subCategory, intended, serialnumber, subBrand, model, description, subDescription, externalContents, msrp, medias, customAttributes, attributes, materials, size, manufacturingCountry, facilityId, productCertification, transparencyItems, i18n, parentCertificates, image, image_data, external_url, background_color, animation_url, youtube_url |
Updated 21 days ago