Get Order JSON

GET Designer/Services/GetOrderDetailXml?customizedProductId={customizedProductId}&websiteId={websiteId}&webApiClientKey={webApiClientKey}

If complete details of customized product that are added to cart or saved are required in xml format, this method can be used.

This method will return the order details of the specified customized product.

Request Information

Parameters

NameDescriptions
customizedProductId

Id of the customized (Saved/Added to cart) product. The product which is customized/designed using Artifi (Product customization tool) and saved or added to cart is called a 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 the user wants to place an order.

This customized product id will be the id of a product whose order details are required.

websiteId

This is the website with which customized products are associated.

Admin users of Artifi can create one or more websites and assign products to each of the website.

The Id of the website with which user photos are 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 the registered company's profile tab in Artifi Account.

This client key will be used for the client(company) authentication and will be called as WebApiClientKey.

On Success

On success, this method will return the customized product details in xml format as shown below.

<?xml version="1.0"?>
<product xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
                    <orderdata specversion="1.0.0">
                    <orderid>1110</orderid>
                    <productid>1206</productid>
                    <productname>Tshirt</productname>
                    <productcode>tshirt</productcode>
                    <userid>185</userid>
                    <createddate>12/2/2014 2:39:56 PM</createddate>
                    <modifieddate>12/2/2014 2:39:56 PM</modifieddate>
                    <websiteid>221</websiteid>
                    <websitecode>w1</websitecode>
                    </orderdata>
                    <designdata specversion="1.0.2">
                    <views>
                    <view id="2786" name="Front">
                    <objectlist>
                    <objects json:Array="true" xmlns:json="http://james.newtonking.com/projects/json">
                    <type>image</type>
                    <originX>center</originX>
                    <originY>center</originY>
                    <left>127.50240206185568</left>
                    <top>122.00256701030928</top>
                    <width>178.57</width>
                    <height>200</height>
                    <fill>rgb(0,0,0)</fill>
                    <overlayFill />
                    <stroke />
                    <strokeWidth>1
                    <strokeDashArray />
                    <strokeLineCap>butt</strokeLineCap>
                    <strokeLineJoin>miter</strokeLineJoin>
                    <strokeMiterLimit>10</strokeMiterLimit>
                    <scaleX>0.52680412371134022</scaleX>
                    <scaleY>0.52680412371134022</scaleY>
                    <angle>0</angle>
                    <flipX>false</flipX>
                    <flipY>false</flipY>
                    <opacity>1</opacity>
                    <shadow />
                    <visible>true</visible>
                    <clipTo />
                    <widgetType>clipart</widgetType>
                    <widgetSubType />
                    <id>2786-image_1</id>
                    <originalWidth>150</originalWidth>
                    <originalHeight>168</originalHeight>
                    <imageUniqueName>artifi-header-logo</imageUniqueName>
                    <originalUrl>http://localhost:3505/UserImages/4/241/Cliparts/Standard/f1929bd1-835d-4544-adf0-b6d4fd76aaa9.jpg</originalUrl>
                    <scaleFactor>1.8982387475538161</scaleFactor>
                    <span><cropArea>
                    <width>150</width>
                    <height>168</height>
                    <positionX>0</positionX>
                    <positionY>0</positionY>
                    <positionEndX>150</positionEndX>
                    <positionEndY>168</positionEndY>
                    </cropArea>
                    <currentWidgetWidth>178.57</currentWidgetWidth>
                    <currentWidgetHeight>200</currentWidgetHeight>
                    <ImageUniqueNameOnUGC>artifi-header-logo</ImageUniqueNameOnUGC>
                    <decalId>
                    </decalId>
                    <svgData />
                    <libProp>
                    <ClipartId>1147</ClipartId>
                    </libProp>
                    <src>http://localhost:3505/UserImages/4/241/Cliparts/Standard/f1929bd1-835d-4544-adf0-b6d4fd76aaa9.jpg</src>
                    </objects>
                    </objectlist>
                    <background>
                    </background>
                    </view>
                    </views>
                    </designdata>
</product>

Node Description

NodeDescription
productThis node contains all the information regarding the Product that is added to cart. All nodes come under the Product node.
orderdataThis section contains all the details related to the order.
orderid
The unique design ID is generated on the add to cart/ save design.
productid
The unique ID of the product that is added to the cart.
productname
The name of the product that is added to the cart.
productcode
The unique code of the product that is added to the cart.
sku

The unique variant code of the product that is added to the cart. [Not a mandatory field]

websiteid
The unique ID of the website from where we have placed the order.
websitename
The Name of the website from where we have placed the order.
productattribute
This node contains all the information related to the Product Attributes like their color, shape, size, and material depending on the setup.
designdata
This node contains all the data related to the customization we performed on the product.
objectlist
This node contains details of all the widgets added to the product. [Image / Text / Arc Text]
originalUrl
This node contains the URL of the original uploaded file by the shopper.
viewId
The unique view ID of the product.
printImage
This node contains the URL of the original uploaded image / Clipart Image that will be used to generate the output files.
overlayImage
This node contains the details regarding the overlay image. The overlay image can be uploaded on the template as a mask. The overlay image is a transparent file.
previewurl
This node contains the URL of the Preview design. Using the preview URL the shopper can view the customized design created.
outputFileType

This node contains the URL to access the PDF.

The PDF is a print-ready output.

You cannot directly access this URL unless your IP is whitelisted.

On Failure

On failure, this method will return the following response based on parameters.

If the customizedProductId is passed as 0, then it will give message.
"CustomizedProductId / DesignId should not be empty or null."

If the webApiClientKey is passed as null or not provided, then it will give message.
"WebApiclientKey should not be empty or null."

If the customizedProductId does not exist, then it will give the message.
"Invalid  customizedProductId / DesignId."

If the webApiClientKey does not exist, then it will give the message.
"Invalid webApiclientKey."


Did you find it helpful? Yes No

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