Get XML

Get

/api/3/XML/GetXML?designId={designId}&websiteId={websiteId}&webApiClientKey={webApiClientKey}

This API operates in the All Order module in Artifi admin.

The purpose of this API is to get the complete data associated with an order in xml format.

Request Information

Parameters

NameDescription

DesignIds (String)

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.


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.



Response Information

Response body formats

On Success

On success, this method will revert with a downloadable xml file that will contain the complete information of the order and the products with their customization information associated with it. 


On Error

On error, this method will call back the JavaScript method in the website which is specified in "errorCallback" parameter with errorMessage.

  {

    "Response": "",

    "Message": "Invalid design Id.",

    "Data": null,

    "ErrorCode": "225"

    }


Did you find it helpful? Yes No

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