Get
/api/3/DecorationMethod/GetDecorationMethodList?websiteId={websiteId}&webApiClientKey={webApiClientKey}&sku={sku}&designId={designId}
The Get Decoration Method List API retrieves a list of decoration methods associated with a product, either based on a specific design ID or SKU. This API provides details on various decoration methods, their rendering types, and available templates.
This API is triggered when the products are added to cart on the webstore, after they are customized in the Artifi Designer.
Request Information
Parameters
Response Information
Response body formats
On Success
On success, this method will call back the JavaScript method in the website which is specified in "successCallback" parameter with success Message.
{
"Response":"Success",
"Message":"",
"Data":{
"templates":[
{
"ViewId":5378,
"Templates":[
{
"Name":"Front 1234",
"ImageUniqueName":"870b0111-e398-4f93-a593-ebffffa6bb5e.png",
"Code":"15638",
"DisplayImageUniqueName":null,
"DisplayName":null,
"DecorationMethodId":77,
"Id":15638
}
],
"DecorationMethods":[
{
"DecorationCode":"Default",
"RenderingTypeId":1,
"DecorationName":"Default",
"DisplayOrder":1,
"Id":77,
"IsSelected":true,
"RecolorLimit":null,
"Effects":null,
"TexturedImage":null,
"RestrictedFeatures":null
}
]
}
]
},
"ErrorCode":""
}
On Error
On error, this method will call back the JavaScript method in the website which is specified in "errorCallback" parameter with errorMessage.
{
"Response": "Error",
"Message": "Data mismatch.",
"Data": null,
"ErrorCode": "242"
}