Get
/api/3/Design/GetDesignImage?designId={designId}&websiteId={websiteId}&webApiClientKey={webApiClientKey}&viewCode={viewCode}&width={width}&height={height}
This API is used to fetch and delete all the designs referenced by the user Id that is passed in the ‘userid’ parameter.
The method is triggered when the user on the webstore removes their customized products from the cart.
Request Information
Parameters
Parameter Name | Description |
DesignId (Int) | This is the ID of the designed product that gets added to cart. Design ID is created when the user adds the customized product to the cart. |
WebsiteId (Int) | This param refers to the website associated with customized products. The admin user of Artifi can create one or more websites and assign products to each of them. The ID of the website with which specified customized products are associated should be specified in this parameter. |
WebApiClientKey (String)
| When any company registers with Artifi, Artifi will generate a special and unique key for that company, which will be called the client key. This client key can be found in the registered company's profile tab in the Artifi Account. The client key will be used for client (company) authentication and will be referred to as WebApiClientKey. |
viewCode (String) | This parameter becomes mandatory when a specific view needs to be pulled from the product. If not specified, the default view image will be pulled by the API. |
Width (Int) | This parameter refers to the width of the output image. |
Height (Int) | This parameter refers to the height of the output image. |
Response Information
Response body formats
On Success
On success, this method will call back the JavaScript method in the website which is specified in the "successCallback" parameter with success Message.
{
"Response": "Success",
"Message": "Design status has been updated successfully.",
"Data": "",
"ErrorCode": ""
}
On Error
On error, this method will call back the JavaScript method in the website which is specified in the "errorCallback" parameter with errorMessage.
{
"Response": "Error",
"Message": "Order status is incorrect. Please provide proper order status.",
"Data": null,
"ErrorCode": "236"
}