Introduction
The GetXml API is used to retrieve the complete XML representation of a customized product. It provides detailed information about the order, product configuration, and design elements created within the editor.
The response includes structured data such as order details, product metadata, design views, and all associated objects like text and images along with their properties (position, size, styling, and applied effects). Additionally, it provides preview URLs and downloadable output files in multiple formats.
This API acts as a single source of truth for the finalized design, enabling downstream systems to process, render, or generate output files accurately.
Use Cases
- Order Processing
Retrieve complete design data to process and store finalized customized product orders.
- Print & Production
Use design and asset details (images, fonts, layout) to generate print-ready files such as PDF, AI, or SVG.
- Preview Rendering
Utilize preview URLs to display the final product design to users or internal teams.
- Design Reconstruction
Rebuild or re-edit the design in the editor using the object-level data (text, images, positioning, etc.).
- Integration with External Systems
Share structured XML data with third-party systems.
API Details
Endpoint
GET/api/4/XML/GetXML
Sample Request:
curl --location 'https://api.artifi.net/api/4/XML/GetXML?designId=39294378'
--header 'accept: /'
--header 'websiteId: 94'
--header 'webApiClientKey: c961461a-b287-448c-b9ea-e1162bd80b8e'
Parameters
Header validation
Header Name | Type | Required | Description |
websiteId | int | Yes | Unique identifier of the website. |
webApiClientKey | string | Yes | API client key used for authentication. |
Query Parameters
Name | Type | Required | Description |
DesignId | int | Yes | This is the ID of the designed product that gets added to the cart. |
Success Responses
The GetXml API returns a detailed XML response containing complete information about the customized product and its design configuration.
This includes:
- Order Details – such as order ID, product ID, product name, and timestamps
- Design Data – including all views (e.g., Front, Back) and associated design elements
- Object Information – details of each element used in the design, such as textboxes and images, along with their properties (position, size, styling, font, colors, etc.)
- Image and Asset URLs – links to preview images, source files, and print-ready assets
- Preview and Output Files – URLs to download files in multiple formats like PDF, TIFF, and SVG
Overall, the response provides a complete representation of the designed product, which can be used for rendering previews, processing orders, or generating print-ready outputs.
<?xml version="1.0"?>
<product>
<orderdata>
<orderid>39294378</orderid>
<productid>27702</productid>
<productname>T-Shirt_Two Views</productname>
</orderdata>
<designdata>
<views>
<view name="Front">
<objectlist>
<objects>
<type>textbox</type>
<text>Add Text Here</text>
</objects>
<objects>
<type>image</type>
<src>https://exampledomain.artifi.net/...png</src>
</objects>
</objectlist>
</view>
</views>
</designdata>
</product>
Error Code List (Click Here)
Q&A
1. What does the GetXml API return?
The API returns a complete XML response containing order details, product information, design data (views and objects), preview URLs, and output file links.
2. What kind of design elements are included in the response?
The response includes all design objects such as textboxes and images, along with their properties like position, size, font, color, scaling, and applied effects.
3. Can I use this response to recreate the design?
Yes, the XML contains detailed object-level data that can be used to reconstruct or re-edit the design in the editor.
4. Does the API provide preview images?
Yes, the response includes preview URLs that can be used to display the designed product.
5. Are print-ready files available through this API?
Yes, the response provides URLs to download output files in formats such as PDF, TIFF, and SVG.
6. What is the purpose of the ‘views’ section in the response?
The views section represents different sides or perspectives of the product (e.g. Front, Back), each containing its own set of design elements.
7. What is included in the orderdata section?
The orderdata section contains metadata such as order ID, product ID, product name, creation date, and website details.
8. Can this API be used for order processing?
Yes, it provides complete design and product information required for processing customized product orders.
8. Can this API be used for order processing?
Yes, it includes URLs for images, preview files, and print assets that can be used for rendering or downloading.
10. Is the response static or dynamic?
The response is dynamic and reflects the current state of the customized product and its design at the time of the API call.