Get Preview Image

GET Designer/Services/GetPreviewImage?websiteId={websiteId}&webApiClientKey={webApiClientKey}&customizedProductId={customizedProductId}&angleId={angleId}&viewId={viewId}&isThumbnail={isThumbnail}


GetPreviewImage method is used to display preview image of saved product (Product which is customized or added to cart).


This method can be used when user customizes a product and add that product to the cart, and may want to see the final design of the product.


Request Information

Parameters

NameDescriptions
websiteId

This is the website with which customized products are 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

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.


customizedProductId    

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.


angleId [Optional]Id of the angle which has been created in 3d product.
viewId [Optional]Id of the product view.
isThumbnail [Optional]If this value is true then thumbnail image will be shown otherwise standard image.


Note : Either angleId or viewId must be passed.


Response Information

Response body formats

application/json, text/json


On success, this method will show Preview Image.

Did you find it helpful? Yes No

Send feedback
Sorry we couldn't be helpful. Help us improve this article with your feedback.