Download Output File

Get

/api/3/Output/DownloadOutputFile?websiteId={websiteId}&webApiClientKey={webApiClientKey}&designId={designId}&type={type}&isRegenerate={isRegenerate}

This API will download PDF files of customized products. There are two types of pdf that are available for the user to download, Plate (this pdf contains only the customization that is done on the product)and Proof(this pdf has the complete preview of the product).

A zip file is downloaded when there are both Proof and Plate PDF.

Request Information

Parameters

Parameter Name	Description
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.
designId	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.
type	This is an Optional parameter. If no value is passed the API will consider the pdf for plate only.
isRegenerate	If this parameter is passed with ‘true’, the API will regenerate the PDF before downloading. If it is not provided, the existing generated file is downloaded..

Response Information

Response body formats

On Success

On success, this method will download the PDF files.

In case of both Proof and Plate PDF, a zip file will be downloaded.

On Error

On error, this method will show the validations based on the conditions in the form of error messages as given below.

Error messages with the Conditions:

When customizedProductID doesn't exist.
"Your customized product id is not valid."

When the product that has been added to cart is not print ready.
"Product is not print ready.

When passed parameters are other than ['Plate','Proof'] in pdfType.
""Your entered pdf type is not valid."
When the PDF is yet to be generated for requested customizedProductId.
"Your PDF is not created , Please try after some time."

Response Information

On Success

Headless API Documentation