Embroidery files of checked-out customized product Id

GET Designer/Services/GenerateEmbroideryFileByType?websiteId={websiteId}&webApiClientKey={webApiClientKey}&customizedProductId={customizedProductId}&fileType={fileType}&viewCode={viewCode}

This api is used to generate embroidery files using customizedProductId. Here viewcode as parameter is optional; It is mandatory and should be uniquely defined in product setup.

Request Information

Parameters

Name	Descriptions
websiteId	This is the website with which customizedProductId is associated. Admin user of Artifi can create one or more websites and assign products to each of the websites.
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's(company) authentication and will be called as WebApiClientKey.
customizedProductId	Once the order is checked-out it gets customizedProductId which is unique, It is used to get the details associated with that particular customizedProductId.
fileType	Machine ready embroidery files have specific file formats such as (.emb),(.dst) It is used to get the specific file format.
viewCode [Optional Parameter]	It is an optional parameter. Comma(,) separated multiple viewcodes can be passed at any given time.

Response Information

Response body formats

application/json, text/json

Sample: Files are downloaded in zip format.

On Success

On failure, 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"
}


If the filetype is empty or invalid, then it will give the message.
{
    "Response": "Error",
    "Message": "Invalid filetype.",
    "Data": null,
    "ErrorCode": "276"
}


If one or more viewcode is not valid , then it will give the message.
{
    "Response": "Error",
    "Message": "Invalid View Code.",
    "Data": null,
    "ErrorCode": "250"
}


If provided customizedProductId is not checked out, then it will give the message.
{
    "Response": "Error",
    "Message": "The associated order for provided customized Id is not yet Checked-Out.",
    "Data": null,
    "ErrorCode": "277"
}


If one or more viewcode don't have an embroidery widget, then it will give the message.
{
    "Response": "Error",
    "Message": "Selected view(s) don't have any embroidery widget.",
    "Data": null,
    "ErrorCode": "278"
}