Get Design JSON

GetDesignJson API Signature

GET Designer/Services/GetDesignJson?designOrderId={designOrderId}&websiteId={wesiteId}&webApiClientKey={webApiClientKey}

This API is used to get the order designs JSON.  The product which is customized/designed using Artifi (Product customization tool) and saved or Added to the cart its design JSON is created and saved at Artifi.

Request Information

Parameters

NameDescriptions
designOrderIdDesign id is the customized product id. The product which is customized/designed using Artifi (Product customization tool) and saved or Added to the cart is called a customized product.

When this customized product id is specified, It will launch the Artifi editor with the specified customized product.

This means, that when the Artifi editor gets open in a specified HTML div element, you will get to see/edit the customized product whose id is specified in this parameter.

websiteId

This is the website with which products, images and colors 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 the product which user is customizing should be specified in this parameter is associated.

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.

Response Information

On Success

{
  "Response": "Success",
  "Message": "",
  "Data": "{\"custmizeProductId\":25329489,\"userId\":\"923\",\"productCode\":\"0490_Name and Number\",\"sku\":\"0490RBCHS34\",\"customAttributes\":[],\"attributes\":[{\"Size\":\"LAR\"},{\"Master Color List\":\"Black\"}],\"savedDesigns\":[\"https://stagedesigner.artifi.net/Designer/Services/GetPreviewImage?personalization=d2Vic2l0ZUlkPTMxMSZ3ZWJBcGlDbGllbnRLZXk9OTRmMjhkNTItZDAyMi00Y2I5
LWEyYTctNjZmYzY4MTQ1MDM0JmN1c3RvbWl6ZWRQcm9kdWN0SWQ9MjUzMjk0ODkmNk1qWkg1RjAmdmll
d0lkPTQ2ODc1NyZpc1RodW1ibmFpbD10cnVl\",\"https://stagedesigner.artifi.net/Designer
/Services/GetPreviewImage?personalization=d2Vic2l0ZUlkPTMxMSZ3ZWJBcGlDbGllbnRLZXk9OTRmMjhkNTItZDAy
Mi00Y2I5LWEyYTctNjZmYzY4MTQ1MDM0JmN1c3RvbWl6ZWRQcm9kdWN0SWQ9MjUzMjk0ODkmNk1qWkg1RjAmdmll
d0lkPTQ2ODc1OCZpc1RodW1ibmFpbD10cnVl\",\"https://stagedesigner.artifi.net/Designer/
Services/GetPreviewImage?personalization=d2Vic2l0ZUlkPTMxMSZ3ZWJBcGlDbGllbnRLZXk9OTRmMjhkNTItZDAyMi00Y2I5
LWEyYTctNjZmYzY4MTQ1MDM0JmN1c3RvbWl6ZWRQcm9kdWN0SWQ9MjUzMjk0ODkmNk1q
Wkg1RjAmdmlld0lkPTQ2ODc1OSZpc1RodW1ibmFpbD10cnVl\",\"https://stagedesigner.artifi.net/Designer/
Servipersonalization=d2Vic2l0ZUlkPTMxMSZ3ZWJBcGlDbGllbnRLZXk9OTRmMjhkNTItZDAyMi00Y2I5LWEy
YTctNjZmYzY4MTQ1MDM0JmN1c3RvbWl6ZWRQcm9kdWN0SWQ9MjUzMjk0ODkmNk1qWk
g1RjAmdmlld0lkPTQ2
ODc2NSZpc1RodW1ibmFpbD10cnVl\",personalization=d2Vic2l0ZUlkPTMxMSZ3ZWJBcGlDbGllbnRLZXk9O
TRmMjhkNTItZDAyMi00Y2I5LWEyYTctNjZmYzY4MTQ1MDM0JmN1c3RvbWl6ZWRQcm9kdWN0SWQ9MjUzMjk0O
DkmNk1qWkg1RjAmdmlld0lkPTQ2ODc2Ng==\"],\"photoCount\":0,\"clipartCount\":0,\"customizedData\":{\"Right Chest\":{\"text\":[{\"widgetKey\":\"RC Line1\",\"text\":\"wwww\",\"charCount\":4,\"fontFamily\":\"Block1\",\
"fontCode\":\"\",\"colorCode\":\"\",\"color\":\"rgb(255,255,255)\",\"fontSize\":1,
\"stroke\":null,\"isVisible\":true,\"stitchCount\":565,\"numberOfColors\":1},{\"widgetKey\":\"RC Line2\",\"text\":\"\",\"fontFamily\":\"Block1\",
\"fontCode\":\"\",\"colorCode\":\"\",\"color\":\"rgb(255,255,255)\",\"fontSize\":1,
\"stroke\":null,\"isVisible\":true,\"stitchCount\":\"\",\"numberOfColors\":\"\"},{\"widgetKey\":\"RC Line3\",\"text\":\"\",\"fontFamily\":\"Block1\",\"fontCode\":\"\",\"colorCode\":
\"\",\"color\":\"rgb(255,255,255)\",\"fontSize\":1,\"stroke\":null,\"isVisible\":
true,\"stitchCount\":\"\",\"numberOfColors\":\"\"}],\"image\":[],\"circletext\":[],\"viewId\":468757,\"viewCode\":\"0490RNAV\",\"viewNote\":\"\",
\"customAttributes\":{\"AttributeCode\":\"Embroidery List\",\"AttributeName\":\"Embroidery List\",\"TemplateId\":400503,\"TemplateCode\":\"0490RNAV - RC - Embroidery List\",\"AttributeValueCode\":\"\",\"AttributeValueName\":\"\"},\"textCode\":[{\"code\":\"Embroidery Text 1 inch\",\"quantityInList\":1}]},\"Left Chest\":{\"text\":[],\"image\":[],\"circletext\":[],\"viewId\":468758,\"viewCode\":\"265045\",\"viewNote\":\"\",\"adminNote\":
\"\",\"customAttributes\":{\"AttributeCode\":\"\",\"AttributeName\":\"\",\"TemplateId\":\"\",\"TemplateCode\":
\"\",\"AttributeValueCode\":\"\",\"AttributeValueName\":\"\"},\"textCode\":null},\"Lower Left Chest\":{\"text\":[],\"image\":[],\"circletext\":{\"AttributeCode\":\"\",\"AttributeName\":\"\",\"TemplateId\":\"\",\"TemplateCode\":
\"\",\"AttributeValueCode\":\"\",\"AttributeValueName\":\"\"},\"textCode\":null}},\"colorAttribute\":[],\"isPrintReady\":true,\"appMode\":\"\",\"specialInstructionData\":
\"\",\"productionInstructionData\":\"\",\"uploadedNameListCount\":1,\"customizedDetails\":{\"Right Chest\":{\"textCode\":[{\"code\":\"Embroidery Text 1 inch\",\"quantityInList\":1}],\"clipartNote\":null,\"attributeValueCode\":\"\"}},
\"previewUrl\":\"https://stagedesigner.artifi.net//Preview?personalization=c2t1PTA0OTBSQkNIUzM0QCZ3ZWJzaXRlSWQ9MzExJnVzZXJJZD05MjMmaXNHdWVzd
D1mYWxzZSZ3ZWJBcGljbGllbnRLZXk9OTRmMjhkNTItZDAyMi00Y2I5LWEyYTctNjZmYzY4MTQ1MDM0JmN1c3
RvbWl6ZWRQcm9kdWN0SWQ9MjUzMjk0ODk\",\"RC Line1_Text\":\"wwww\",\"RC Line1_Font\":\"Block1\",\"RC Line1_Color\":\"rgb(255,255,255)\",\"RC Line2_Text\":\"\",\"RC Line2_Font\":\"Block1\",\"RC Line2_Color\":\"rgb(255,255,255)\",\"RC Line3_Text\":\"\",\"RC Line3_Font\":\"Block1\",\"RC Line3_Color\":\"rgb(255,255,255)\"}",
  "ErrorCode": null
}

On Failure

{ "Response": "Error", "Message": "Design JSON not found.", "Data": null, "ErrorCode": "" }

Did you find it helpful? Yes No

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