GET Designer/Services/DownloadImageFiles?websiteId={websiteId}&webApiClientKey={webApiClientKey}&customizedProductId={customizedProductId}&fileType={fileType}
This API would be used to download different image file types like the PNG, SVG, SVGz, EPS and TIFF. The download files would be made available through the download section under Reports>>All Orders>Action>>Output.
Request Information
Parameters
| Name | Descriptions |
| customizedProductId (Required) | Id of the customized (Saved/Added to cart) product. The product which are customized/designed using Artifi (Product customization tool) and saved or added to cart is called as customized product. Customized product will be listed in the cart and the order status of the products will be "Added to cart". This will be the product for which user wants to place an order. This customized product id will be the id of product whose order details are required. |
| websiteId (Required) | This is the website created in Artifi account by your e-commerce website, with which user is associated Admin user of Artifi can create one or more websites and assign products to each of the website. The Id of the website with which user is associated should be specified in this parameter. |
webApiClientKey (Required) | When any company gets registered with Artifi, Artifi will generate a special and unique key for that company which will be called as client key. This client key will be found in registered company's profile tab in Artifi Account. This client key will be used for client(company) authentication and will be called as webApiClientKey. |
| FileType (Required) | These are the various image file types like the PNG, SVG, SVGz, EPS and TIFF, which would be made available for download through this API. |
| viewId [Optional] | Id of the product view. |
Response Information
Response body formats
On Success
The image files would be downloaded (it would consider the files types like the PNG, SVG, SVGz, EPS and TIFF).
On Error
On error, this method will return the following response based on parameters.
If the webApiClientKey is invalid, then it will give the response.
{
"Response": "Error",
"Message": "Invalid webApiclientKey.",
"Data": null,
"ErrorCode": "226"
}
If the customizedProductId does not exist, then it will give the response.
{
"Response": "Error",
"Message": "Invalid customizedProductId / DesignId.",
"Data": null,
"ErrorCode": "225"
}
If the websiteId does not exist, then it will give the response.
{
"Response": "Error",
"Message": "Invalid website Id.",
"Data": null,
"ErrorCode": "221"
}