RTD API - FUNCTIONS REFERENCE
First, a note on Stores
There is one general optional parameter you can pass to the API to filter results at Stores level.
This includes the list ov availalbe products (as in the "GetProductIDs" Action), or rewriting links to go to the correct store (as in Template-related Actions).
Optional input parameter is:
-
'store_name' (INT) - a valid Store Name of your Company
For example, to limit results available for Store "MyTestStore", value should be: 'store_name'="MyTestStore"
If 'store_name' will not be provided, the action will assume it's the Main Store of your company.
If 'store_name' will be provided, results will be filtered accordingly to Store's preferences.
Second, a note on return values
Normally, the API responses are XML files. However if needed they can also be returned in JSON format.
Optional input parameter is:
-
'return_jsonp' (INT)
Use 1 to have JSON returned, 0 to ignore
If 'return_jsonp' will not be provided or is different than 1, the action will return XML.
If 'return_jsonp' will be provided and will be equal 1, the action will return JSON.
ACTION 'GetProductCompiledDescription'
This action will return an XML file with only one tag, containing your compiled HTML code for a specific Product ID.
Required input parameteres are:
-
'product_id' (INT) - the product id you want to query
For example, to query product 123, value should be: 'product_id'="123"
To find your product IDs, refer to the "GetProductIDs" action
-
'description' (STRING) - the string containing your live pricing code.
Direct link to the help section describing how to compile it is available here.
This method will parse only what's included between [MATRIX] and [ENDMATRIX].
FORMAT OF THE XML RESPONSE
<RTD_REPLY>
<PARSED_DESCRIPTION> string </PARSED_DESCRIPTION>
</RTD_REPLY>
The returned string uses the same codes of the Optional Long Description for producs in your admin panel.
ACTION 'GetProductIDs'
This action will return an XML file with details and IDs of your products and product categories.
Optional input parameteres are:
-
'category_id' (INT) - the Product Category ID # you want to query
For example, to query Product Category ID 123456, value should be: 'category_id'="123456"
If 'category_id' will not be provided, the action will return the list of all the available Products of your company.
If 'category_id' will be provided, only Products assigned to the Category will be shown
FORMAT OF THE XML RESPONSE
NOTE: the format of the <SIZES> block is different for ranged and fixed sizes.
Dump the reults to see the other availalbe entries.
<RTD_REPLY>
<CATEGORY_1>
<CATEGORY_NAME> string </CATEGORY_NAME>
<CATEGORY_ID> int </CATEGORY_ID>
<PRODUCT_1>
<PRODUCT_NAME> string </PRODUCT_NAME>
<PRODUCT_ID> int </PRODUCT_ID>
<PRODUCT_LINK> string </PRODUCT_LINK>
<PRODUCT_IS_HIDDEN> int </PRODUCT_IS_HIDDEN>
<PRODUCT_SIZE_TYPE> string </PRODUCT_SIZE_TYPE>
<PRODUCT_IMAGE> string </PRODUCT_IMAGE>
<PRODUCT_BIG_IMAGE> string </PRODUCT_BIG_IMAGE>
<PRODUCT_DESCRIPTION> string </PRODUCT_DESCRIPTION>
<PRODUCT_LONG_DESCRIPTION> string </PRODUCT_LONG_DESCRIPTION>
<SIZES>
<SIZE_1>
<SIZE_ID> int </SIZE_ID>
<SIZE_NAME> string </SIZE_NAME>
<SIZE_LINK> string </SIZE_LINK>
</SIZE_1>
<SIZE_2>
<SIZE_ID> int </SIZE_ID>
<SIZE_NAME> string </SIZE_NAME>
<SIZE_LINK> string </SIZE_LINK>
</SIZE_2>
[...]
</SIZES>
</PRODUCT_1>
<PRODUCT_2>
<PRODUCT_NAME> string </PRODUCT_NAME>
<PRODUCT_ID> int </PRODUCT_ID>
<PRODUCT_LINK> string </PRODUCT_LINK>
<PRODUCT_IS_HIDDEN> int </PRODUCT_IS_HIDDEN>
<PRODUCT_SIZE_TYPE> string </PRODUCT_SIZE_TYPE>
<PRODUCT_IMAGE> string </PRODUCT_IMAGE>
<PRODUCT_BIG_IMAGE> string </PRODUCT_BIG_IMAGE>
<PRODUCT_DESCRIPTION> string </PRODUCT_DESCRIPTION>
<PRODUCT_LONG_DESCRIPTION> string </PRODUCT_LONG_DESCRIPTION>
<SIZES>
<SIZE_1>
<SIZE_ID> int </SIZE_ID>
<SIZE_NAME> string </SIZE_NAME>
<SIZE_LINK> string </SIZE_LINK>
</SIZE_1>
<SIZE_2>
<SIZE_ID> int </SIZE_ID>
<SIZE_NAME> string </SIZE_NAME>
<SIZE_LINK> string </SIZE_LINK>
</SIZE_2>
[...]
</SIZES>
</PRODUCT_2>
[...]
</CATEGORY_1>
<CATEGORY_2>
<CATEGORY_NAME> string </CATEGORY_NAME>
<CATEGORY_ID> int </CATEGORY_ID>
<PRODUCT_1>
<PRODUCT_NAME> string </PRODUCT_NAME>
<PRODUCT_ID> int </PRODUCT_ID>
<PRODUCT_LINK> string </PRODUCT_LINK>
<PRODUCT_IS_HIDDEN> int </PRODUCT_IS_HIDDEN>
<PRODUCT_SIZE_TYPE> string </PRODUCT_SIZE_TYPE>
<PRODUCT_IMAGE> string </PRODUCT_IMAGE>
<PRODUCT_BIG_IMAGE> string </PRODUCT_BIG_IMAGE>
<PRODUCT_DESCRIPTION> string </PRODUCT_DESCRIPTION>
<PRODUCT_LONG_DESCRIPTION> string </PRODUCT_LONG_DESCRIPTION>
<SIZES>
<SIZE_1>
<SIZE_ID> int </SIZE_ID>
<SIZE_NAME> string </SIZE_NAME>
<SIZE_LINK> string </SIZE_LINK>
</SIZE_1>
<SIZE_2>
<SIZE_ID> int </SIZE_ID>
<SIZE_NAME> string </SIZE_NAME>
<SIZE_LINK> string </SIZE_LINK>
</SIZE_2>
[...]
</SIZES>
</PRODUCT_1>
[...]
</CATEGORY_2>
[...]
</RTD_REPLY>
ACTION 'GetProductCategoryDetails'
This action will return an XML file with details of a specific Product Category ID.
Optional input parameteres are:
-
'category_id' (INT) - the Product Category ID # you want to query
For example, to query Product Category ID 123456, value should be: 'category_id'="123456"
If 'category_id' will not be provided, the action will return the list of all the available Product Categories of your company, just as in Catalog.
If 'category_id' will be provided, only the specific Product Category will be shown, even if for any reason it's not meant to be shown in Catalog
FORMAT OF THE XML RESPONSE
A single record will be returned.
<RTD_REPLY>
<CATEGORY_1>
<CATEGORY_NAME> string </CATEGORY_NAME>
<CATEGORY_ID> int </CATEGORY_ID>
<CATEGORY_SUPER_ID> int </CATEGORY_SUPER_ID>
<CATEGORY_IMAGE> string </CATEGORY_IMAGE>
<CATEGORY_BIG_IMAGE> string </CATEGORY_BIG_IMAGE>
<CATEGORY_DESCRIPTION> string </CATEGORY_DESCRIPTION>
<CATEGORY_LONG_DESCRIPTION> string </CATEGORY_LONG_DESCRIPTION>
</CATEGORY_1>
<CATEGORY_2>
<CATEGORY_NAME> string </CATEGORY_NAME>
<CATEGORY_ID> int </CATEGORY_ID>
<CATEGORY_SUPER_ID> int </CATEGORY_SUPER_ID>
<CATEGORY_IMAGE> string </CATEGORY_IMAGE>
<CATEGORY_BIG_IMAGE> string </CATEGORY_BIG_IMAGE>
<CATEGORY_DESCRIPTION> string </CATEGORY_DESCRIPTION>
<CATEGORY_LONG_DESCRIPTION> string </CATEGORY_LONG_DESCRIPTION>
</CATEGORY_2>
[...]
</RTD_REPLY>
ACTION 'GetProductDetails'
This action will return an XML file with details of a specific Product ID.
Required input parameteres are:
-
'product_id' (INT) - the Product ID # you want to query
For example, to query Product ID 123456, value should be: 'product_id'="123456"
FORMAT OF THE XML RESPONSE
A single record will be returned.
NOTE: the format of the <SIZES> block is different for ranged and fixed sizes.
Dump the reults to see the other availalbe entries.
<RTD_REPLY>
<PRODUCT_NAME> string </PRODUCT_NAME>
<PRODUCT_ID> int </PRODUCT_ID>
<PRODUCT_LINK> string </PRODUCT_LINK>
<PRODUCT_INSTANTPRICING_LINK> string </PRODUCT_INSTANTPRICING_LINK>
<PRODUCT_IS_HIDDEN> int </PRODUCT_IS_HIDDEN>
<PRODUCT_SIZE_TYPE> string </PRODUCT_SIZE_TYPE>
<PRODUCT_IMAGE> string </PRODUCT_IMAGE>
<PRODUCT_BIG_IMAGE> string </PRODUCT_BIG_IMAGE>
<PRODUCT_DESCRIPTION> string </PRODUCT_DESCRIPTION>
<PRODUCT_LONG_DESCRIPTION> string </PRODUCT_LONG_DESCRIPTION>
<SIZES>
<SIZE_1>
<SIZE_ID> int </SIZE_ID>
<SIZE_NAME> string </SIZE_NAME>
<SIZE_LINK> string </SIZE_LINK>
</SIZE_1>
<SIZE_2>
<SIZE_ID> int </SIZE_ID>
<SIZE_NAME> string </SIZE_NAME>
<SIZE_LINK> string </SIZE_LINK>
</SIZE_2>
[...]
</SIZES>
</RTD_REPLY>
ACTION 'GetProductTemplates'
This action will return an XML file with details of Product Templates available in your Company.
Optional input parameteres are:
-
'product_id' (INT) - the Product ID # you want to query
For example, to query Product ID 123456, value should be: 'product_id'="123456"
If 'product_id' will not be provided, the action will return the list of all the available Product Templates
of your company, ordered by product_id.
If 'product_id' will be provided, only product templates assigned to that specific product_id will be shown.
FORMAT OF THE XML RESPONSE
<RTD_REPLY>
<TEMPLATE_1>
<TEMPLATE_ID> int </TEMPLATE_ID>
<PRODUCT_ID> int </PRODUCT_ID>
<TEMPLATE_THUMBNAIL> string </TEMPLATE_THUMBNAIL>
<TEMPLATE_IMAGE> string </TEMPLATE_IMAGE>
<TEMPLATE_LINK> string </TEMPLATE_LINK>
</TEMPLATE_1>
<TEMPLATE_2>
<TEMPLATE_ID> int </TEMPLATE_ID>
<PRODUCT_ID> int </PRODUCT_ID>
<TEMPLATE_THUMBNAIL> string </TEMPLATE_THUMBNAIL>
<TEMPLATE_IMAGE> string </TEMPLATE_IMAGE>
<TEMPLATE_LINK> string </TEMPLATE_LINK>
</TEMPLATE_2>
[...]
</RTD_REPLY>
ACTION 'GetGeneralTemplatesCategories'
This action will return an XML file with details of General Templates Categories available in your Company for a specific Product.
Optional input parameteres are:
-
'product_id' (INT) - the Product ID # you want to query
For example, to query Product ID 123456, value should be: 'product_id'="123456"
-
'forced_keyword' (STRING) - if passed, eventual keyword settings of the product will be ignored and the passed keyword will be used instead
For example, to query for templates including the keword "abc", value should be: 'forced_keyword'="abc"
FORMAT OF THE XML RESPONSE
<RTD_REPLY>
<TEMPLATE_CATEGORY_1>
<TEMPLATE_CATEGORY_ID> int </TEMPLATE_CATEGORY_ID>
<TEMPLATE_CATEGORY_NAME> string </TEMPLATE_CATEGORY_NAME>
<TEMPLATE_PARENT_CATEGORY_ID> int </TEMPLATE_PARENT_CATEGORY_ID>
<TEMPLATE_PARENT_CATEGORY_NAME> string </TEMPLATE_PARENT_CATEGORY_NAME>
<TEMPLATE_CATEGORY_IMAGE> string </TEMPLATE_CATEGORY_IMAGE>
<TEMPLATES_INSIDE> int </TEMPLATES_INSIDE>
</TEMPLATE_CATEGORY_1>
<TEMPLATE_CATEGORY_2>
<TEMPLATE_CATEGORY_ID> int </TEMPLATE_CATEGORY_ID>
<TEMPLATE_CATEGORY_NAME> string </TEMPLATE_CATEGORY_NAME>
<TEMPLATE_PARENT_CATEGORY_ID> int </TEMPLATE_PARENT_CATEGORY_ID>
<TEMPLATE_PARENT_CATEGORY_NAME> string </TEMPLATE_PARENT_CATEGORY_NAME>
<TEMPLATE_CATEGORY_IMAGE> string </TEMPLATE_CATEGORY_IMAGE>
<TEMPLATES_INSIDE> int </TEMPLATES_INSIDE>
</TEMPLATE_CATEGORY_2>
[...]
</RTD_REPLY>
ACTION 'GetGeneralTemplates'
This action will return an XML file with details of General Templates available in your Company crosslinking Products and General Template Categories.
Required input parameteres are:
-
'templates_categories_id' (INT) - the General Tempaltes Category ID ID # you want to query
For example, to query General Tempaltes Category ID 123456, value should be: 'templates_categories_id'="123456"
Optional input parameteres are:
-
'product_id' (INT) - the Product ID # you want to query
For example, to query Product ID 123456, value should be: 'product_id'="123456"
-
'fixed_size_id' (INT) - the specific size ID you want to query
For fixed sizes, value should be like: 'fixed_size_id'="123456"
For ranged sizes (IE, a 20x30 size), value should be like: 'fixed_size_id'="20,30"
-
'forced_keyword' (STRING) - if passed, eventual keyword settings of the product will be ignored and the passed keyword will be used instead
For example, to query for templates including the keword "abc", value should be: 'forced_keyword'="abc"
If 'product_id' will not be provided, the action will not return links to the template.
If 'fixed_size_id' will not be provided, the action will use the default or fist available fixed or ranged size of the product.
FORMAT OF THE XML RESPONSE
<RTD_REPLY>
<TEMPLATE_1>
<TEMPLATE_ID> int </TEMPLATE_ID>
<TEMPLATE_NAME> string </TEMPLATE_NAME>
<TEMPLATE_THUMBNAIL> string </TEMPLATE_THUMBNAIL>
<TEMPLATE_IMAGE> string </TEMPLATE_IMAGE>
<TEMPLATE_ASPECTRATIO_ORIGINAL> string </TEMPLATE_ASPECTRATIO_ORIGINAL>
<TEMPLATE_ASPECTRATIO_MIN> string </TEMPLATE_ASPECTRATIO_MIN>
<TEMPLATE_ASPECTRATIO_MAX> string </TEMPLATE_ASPECTRATIO_MAX>
<TEMPLATE_LINK> string </TEMPLATE_LINK>
<TEMPLATE_KEYWORDS> string </TEMPLATE_KEYWORDS>
</TEMPLATE_1>
<TEMPLATE_2>
<TEMPLATE_ID> int </TEMPLATE_ID>
<TEMPLATE_NAME> int </TEMPLATE_NAME>
<TEMPLATE_THUMBNAIL> string </TEMPLATE_THUMBNAIL>
<TEMPLATE_IMAGE> string </TEMPLATE_IMAGE>
<TEMPLATE_ASPECTRATIO_ORIGINAL> string </TEMPLATE_ASPECTRATIO_ORIGINAL>
<TEMPLATE_ASPECTRATIO_MIN> string </TEMPLATE_ASPECTRATIO_MIN>
<TEMPLATE_ASPECTRATIO_MAX> string </TEMPLATE_ASPECTRATIO_MAX>
<TEMPLATE_LINK> string </TEMPLATE_LINK>
<TEMPLATE_KEYWORDS> string </TEMPLATE_KEYWORDS>
</TEMPLATE_2>
[...]
</RTD_REPLY>
ACTION 'GetProductBGColors'
This action will return an XML file with details of Background Colors available for a specific Product ID.
Required input parameteres are:
-
'product_id' (INT) - the Product ID # you want to query
For example, to query Product ID 123456, value should be: 'product_id'="123456"
FORMAT OF THE XML RESPONSE
If the product will use no groups, COLORGROUP_1 will be returned anyhow and available colors will be listed into it.
<RTD_REPLY>
<BGBGCOLORGROUP_1>
<BGCOLORGROUP_NAME> string </BGCOLORGROUP_NAME>
<BGCOLOR_1>
<BGCOLOR_ID> int </BGCOLOR_ID>
<BGCOLOR_NAME> string </BGCOLOR_NAME>
<BGCOLOR_SOURCE> string </BGCOLOR_SOURCE>
<BGCOLOR_RGB> string </BGCOLOR_RGB>
<BGCOLOR_HEX> string </BGCOLOR_HEX>
<BGCOLOR_TEXTURE> string </BGCOLOR_TEXTURE>
</BGCOLOR_1>
<BGCOLOR_2>
<BGCOLOR_ID> int </BGCOLOR_ID>
<BGCOLOR_NAME> string </BGCOLOR_NAME>
<BGCOLOR_SOURCE> string </BGCOLOR_SOURCE>
<BGCOLOR_RGB> string </BGCOLOR_RGB>
<BGCOLOR_HEX> string </BGCOLOR_HEX>
<BGCOLOR_TEXTURE> string </BGCOLOR_TEXTURE>
</BGCOLOR_2>
[...]
</BGCOLORGROUP_1>
<BGCOLORGROUP_2>
<BGCOLORGROUP_NAME> string </BGCOLORGROUP_NAME>
<BGCOLOR_1>
[...]
</BGCOLOR_1>
<BGCOLOR_2>
[...]
</BGCOLOR_2>
[...]
</BGCOLORGROUP_2>
[...]
</RTD_REPLY>
ACTION 'GetProductColors'
This action will return an XML file with details of Colors available for a specific Product ID.
Required input parameteres are:
-
'product_id' (INT) - the Product ID # you want to query
For example, to query Product ID 123456, value should be: 'product_id'="123456"
FORMAT OF THE XML RESPONSE
If the product will use no groups, COLORGROUP_1 will be returned anyhow and available colors will be listed into it.
<RTD_REPLY>
<COLORGROUP_1>
<COLORGROUP_NAME> string </COLORGROUP_NAME>
<COLOR_1>
<COLOR_ID> int </COLOR_ID>
<COLOR_NAME> string </COLOR_NAME>
<COLOR_SOURCE> string </COLOR_SOURCE>
<COLOR_RGB> string </COLOR_RGB>
<COLOR_HEX> string </COLOR_HEX>
<COLOR_TEXTURE> string </COLOR_TEXTURE>
</COLOR_1>
<COLOR_2>
<COLOR_ID> int </COLOR_ID>
<COLOR_NAME> string </COLOR_NAME>
<COLOR_SOURCE> string </COLOR_SOURCE>
<COLOR_RGB> string </COLOR_RGB>
<COLOR_HEX> string </COLOR_HEX>
<COLOR_TEXTURE> string </COLOR_TEXTURE>
</COLOR_2>
[...]
</COLORGROUP_1>
<COLORGROUP_2>
<COLORGROUP_NAME> string </COLORGROUP_NAME>
<COLOR_1>
[...]
</COLOR_1>
<COLOR_2>
[...]
</COLOR_2>
[...]
</COLORGROUP_2>
[...]
</RTD_REPLY>
ACTION 'GetProductFonts'
This action will return an XML file with details of Fonts available for a specific Product ID.
Required input parameteres are:
-
'product_id' (INT) - the Product ID # you want to query
For example, to query Product ID 123456, value should be: 'product_id'="123456"
FORMAT OF THE XML RESPONSE
If the product will use no groups, FONTGROUP_1 will be returned anyhow and available fonts will be listed into it.
<RTD_REPLY>
<FONTGROUP_1>
<FONTGROUP_NAME> string </FONTGROUP_NAME>
<FONT_1>
<FONT_ID> int </FONT_ID>
<FONT_NAME> string </FONT_NAME>
<FONT_IMAGE> string </FONT_IMAGE>
</FONT_1>
<FONT_2>
<FONT_ID> int </FONT_ID>
<FONT_NAME> string </FONT_NAME>
<FONT_IMAGE> string </FONT_IMAGE>
</FONT_2>
[...]
</FONTGROUP_1>
<FONTGROUP_2>
<FONTGROUP_NAME> string </FONTGROUP_NAME>
<FONT_1>
[...]
</FONT_1>
<FONT_2>
[...]
</FONT_2>
[...]
</FONTGROUP_2>
[...]
</RTD_REPLY>
ACTION 'GetProductClipartsCategories'
This action will return an XML file with details of Clipart Categories available for a specific Product ID.
Required input parameteres are:
-
'product_id' (INT) - the Product ID # you want to query
For example, to query Product ID 123456, value should be: 'product_id'="123456"
FORMAT OF THE XML RESPONSE
If the product will use no groups, CLIPARTCATEGORYGROUP_1 will be returned anyhow and available categories will be listed into it.
<RTD_REPLY>
<CLIPARTCATEGORYGROUP_1>
<CLIPARTCATEGORYGROUP_NAME> string </CLIPARTCATEGORYGROUP_NAME>
<CLIPARTCATEGORY_1>
<CLIPARTCATEGORY_ID> int </CLIPARTCATEGORY_ID>
<CLIPARTCATEGORY_NAME> string </CLIPARTCATEGORY_NAME>
<CLIPARTCATEGORY_IMAGE> string </CLIPARTCATEGORY_IMAGE>
<CLIPARTCATEGORY_IS_HIDDEN> int </CLIPARTCATEGORY_IS_HIDDEN>
</CLIPARTCATEGORY_1>
<CLIPARTCATEGORY_2>
<CLIPARTCATEGORY_ID> int </CLIPARTCATEGORY_ID>
<CLIPARTCATEGORY_NAME> string </CLIPARTCATEGORY_NAME>
<CLIPARTCATEGORY_IMAGE> string </CLIPARTCATEGORY_IMAGE>
<CLIPARTCATEGORY_IS_HIDDEN> int </CLIPARTCATEGORY_IS_HIDDEN>
</CLIPARTCATEGORY_2>
[...]
</CLIPARTCATEGORYGROUP_1>
<CLIPARTCATEGORYGROUP_2>
<CLIPARTCATEGORYGROUP_NAME> string </CLIPARTCATEGORYGROUP_NAME>
<CLIPARTCATEGORY_1>
[...]
</CLIPARTCATEGORY_1>
<CLIPARTCATEGORY_2>
[...]
</CLIPARTCATEGORY_2>
[...]
</CLIPARTCATEGORYGROUP_2>
[...]
</RTD_REPLY>
ACTION 'GetProductCliparts'
This action will return an XML file with details of Clipart available into a specific Clipart Category.
Required input parameteres are:
-
'cliparts_categories_id' (INT) - the Clipart Category ID # you want to query
For example, to query Clipart Category ID 123456, value should be: 'cliparts_categories_id'="123456"
FORMAT OF THE XML RESPONSE
<RTD_REPLY>
<CLIPART_1>
<CLIPART_ID> int </CLIPART_ID>
<CLIPART_NAME> string </CLIPART_NAME>
<CLIPART_THUMB> string </CLIPART_THUMB>
<CLIPART_IMAGE> string </CLIPART_IMAGE>
<CLIPART_UNIQUECOLORS> int </CLIPART_UNIQUECOLORS>
<CLIPART_ASPECTRATIO> float </CLIPART_ASPECTRATIO>
<CLIPART_KEYWORDS> string </CLIPART_KEYWORDS>
</CLIPART_1>
<CLIPART_2>
<CLIPART_ID> int </CLIPART_ID>
<CLIPART_NAME> string </CLIPART_NAME>
<CLIPART_THUMB> string </CLIPART_THUMB>
<CLIPART_IMAGE> string </CLIPART_IMAGE>
<CLIPART_UNIQUECOLORS> int </CLIPART_UNIQUECOLORS>
<CLIPART_ASPECTRATIO> float </CLIPART_ASPECTRATIO>
<CLIPART_KEYWORDS> string </CLIPART_KEYWORDS>
</CLIPART_2>
[...]
</RTD_REPLY>
ACTION 'GetClipartDetail'
This action will return an XML file with details of one specific Clipart ID.
Required input parameteres are:
-
'clipart_id' (INT) - the Clipart ID you want to query
For example, to query Clipart ID 123456, value should be: 'clipart_id'="123456"
FORMAT OF THE XML RESPONSE
<RTD_REPLY>
<CLIPART_ID> int </CLIPART_ID>
<CLIPART_NAME> string </CLIPART_NAME>
<CLIPART_THUMB> string </CLIPART_THUMB>
<CLIPART_IMAGE> string </CLIPART_IMAGE>
<CLIPART_UNIQUECOLORS> int </CLIPART_UNIQUECOLORS>
<CLIPART_ASPECTRATIO> float </CLIPART_ASPECTRATIO>
<CLIPART_KEYWORDS> string </CLIPART_KEYWORDS>
</RTD_REPLY>
ACTION 'GetOrderDetails'
This action will return an XML file with details of one or more specific Order IDs.
Required input parameteres are:
-
'order_id' (STRING) - the order/s # you want to query
If you will pass just one number, that will be the parsed order.
To pass multiple IDs you need to send them comma-separated. Please read below as in this case the output of the response will be slightly different
For example, to query order #123456, value should be: 'order_id'="123456"
To query order #123456 and #234567, value should be: 'order_id'="123456,234567"
Optional input parameteres are:
- 'ExportTemplateID' (INT)
If you will pass this, these codes used to format the output will be grabbed directly from the existing template ID,
instead of returning the full list or Order's data.
Internal ID of export tempaltes can be seen in the Manage Email & Export Templates first page.
NOTE: if an invalid Template ID will be passed, returned string will be EMPTY.
FORMAT OF THE XML RESPONSE
If no ExportTemplateID will be passed, fields of the response response will be all the specialcodes normally available for templates.
<RTD_REPLY>
<FIELD_1> </FIELD_1>
<FIELD_2> </FIELD_2>
<FIELD_3> </FIELD_3>
[...]
</RTD_REPLY>
Otherwise, if ExportTemplateID is passed, a single record will be returned.
<RTD_REPLY>
<ORDERTEMPLATEOUTPUT> string </ORDERTEMPLATEOUTPUT>
</RTD_REPLY>
You can find details about them in your admin panel, by going in:
SYSTEM OPTIONS => Email & Export Templates => Click here to see all the special codes available
In case multiple order IDs are passed instead of one, the output will be like this instead:
<RTD_REPLY>
<ORDER_1>
[the same response as above for the specific order]
</ORDER_1>
<ORDER_2>
[the same response as above for the specific order]
</ORDER_2>
[...]
</RTD_REPLY>
ACTION 'GetOrdersByDate'
This action will return an XML file with details and IDs of orders placed within a given date range.
Required input parameteres are:
-
'date_start' - starting date in "yyyy-mm-dd" format
-
'date_end' - ending date in "yyyy-mm-dd" format
Both parameters must be provided.
For example, to query orders sent between January 1st and January 15th 2011, values should be:
'date_start'="2011-01-01"
'date_end'="2001-01-15"
FORMAT OF THE XML RESPONSE
A single record will be returned in this form, with matching order numbers comma-separated:
<RTD_REPLY>
<DATE_START> date </DATE_START>
<DATE_END> date </DATE_END>
<ORDERS_TOTAL> int </ORDERS_TOTAL>
<ORDERS_NEW> int </ORDERS_NEW>
<ORDERS_HOLD> int </ORDERS_HOLD>
<ORDERS_REFUNDED> int </ORDERS_REFUNDED>
<ORDERS_COMPLETED> int </ORDERS_COMPLETED>
<ORDERS_DELETED> int </ORDERS_DELETED>
<MATCHING_ORDER_IDS_TOTAL> string </MATCHING_ORDER_IDS_TOTAL>
<MATCHING_ORDER_IDS_NEW> string </MATCHING_ORDER_IDS_NEW>
<MATCHING_ORDER_IDS_HOLD> string </MATCHING_ORDER_IDS_HOLD>
<MATCHING_ORDER_IDS_REFUNDED> string </MATCHING_ORDER_IDS_REFUNDED>
<MATCHING_ORDER_IDS_COMPLETED> string </MATCHING_ORDER_IDS_COMPLETED>
<MATCHING_ORDER_IDS_DELETED> string </MATCHING_ORDER_IDS_DELETED>
</RTD_REPLY>
ACTION 'SetOrderInternalJobID'
This action change the Internal Job ID of a specific Order ID, and return an XML file with details of the operation.
Required input parameteres are:
-
'order_id' (INT) - the order # you want to edit
-
'new_internal_job_id' (STRING) - the new Order's Internal Job ID
FORMAT OF THE XML RESPONSE
A single record will be returned to confirm the new data.
<RTD_REPLY>
<ORD_NUM> int </ORD_NUM>
<ORD_INTERNALORDERID> string </ORD_INTERNALORDERID>
</RTD_REPLY>
ACTION 'SetOrderIsPaidFlag'
This action change the "IS PAID" flag of a specific Order ID, and return an XML file with details of the operation.
Required input parameteres are:
-
'order_id' (INT) - the order # you want to edit
-
'new_is_paid' (INT) - the new Order's IS PAID flag.
Can be 0 for unpaid, or 1 for paid.
If not passed, or passed with values different from 0 or 1, the flag will be set automaticaly to 0 (unpaid).
FORMAT OF THE XML RESPONSE
A single record will be returned to confirm the new data.
<RTD_REPLY>
<ORD_NUM> int </ORD_NUM>
<ORD_ISPAID> int </ORD_ISPAID>
</RTD_REPLY>
ACTION 'SetOrderStatus'
This action change the "status" flag of a specific Order ID, and return an XML file with details of the operation.
Required input parameteres are:
-
'order_id' (INT) - the order # you want to edit
-
'new_status' (STRING) - the new Order's status.
Possible values are:
new, hold, refunded, completed, deleted, userresubmits, pending, shipping, finishing, lowres, production
If not passed, or passed with values different from the above, the flag will be set automaticaly to NEW.
FORMAT OF THE XML RESPONSE
A single record will be returned to confirm the new data.
<RTD_REPLY>
<ORD_NUM> int </ORD_NUM>
<ORD_STATUS> string </ORD_STATUS>
</RTD_REPLY>
ACTION 'SetOrderLockFlag'
This action change the "LOCK REVISIONS" flag of all items included in a specific Order ID, and return an XML file with details of the operation.
Required input parameteres are:
-
'order_id' (INT) - the order # you want to edit
-
'new_lock' (INT) - the new Order's LOCK REVISIONS flag.
Can be 0 for unlocked, or 1 for locked.
If not passed, or passed with values different from 0 or 1, the flag will be set automaticaly to 0 (unlocked).
FORMAT OF THE XML RESPONSE
A single record will be returned to confirm the new data.
<RTD_REPLY>
<ORD_NUM> int </ORD_NUM>
<ORD_ISLOCKED> int </ORD_ISLOCKED>
</RTD_REPLY>
ACTION 'GetUserDetails'
This action will return an XML file with details of a registered user.
Accepted input parameteres are:
-
'login' - the registered user login name
-
'email' - the registered user email
-
'user_id' - the registered user ID
NOTES:
Only one of those parameters should be set. If not, only one will be used anyhow.
This method doe not search for substring, but for perfect matches.
So, if the username you are looking for is 'johnsmith', this method will not return any result if you search by 'john' only.
FORMAT OF THE XML RESPONSE
if a match is found, a single record will be returned in this form:
<RTD_REPLY>
<USER_ID> int </USER_ID>
<USER_LOGIN> string </USER_LOGIN>
<USER_EMAIL> string </USER_EMAIL>
<USER_REGISTER_DATE> date </USER_REGISTER_DATE>
<USER_LAST_ACCESS> date </USER_LAST_ACCESS>
</RTD_REPLY>
if no matches are found, returned USER_ID will be 0 (zero).
ACTION 'VerifyUserPassword'
This action will return an XML file with details of a registered user by verifying his password.
Requires input parameteres are:
-
'login' - the registered user login name
-
'password' - the registered user password
FORMAT OF THE XML RESPONSE
if a match is found, a single record will be returned in this form:
<RTD_REPLY>
<USER_ID> int </USER_ID>
<USER_LOGIN> string </USER_LOGIN>
<USER_EMAIL> string </USER_EMAIL>
<USER_REGISTER_DATE> date </USER_REGISTER_DATE>
<USER_LAST_ACCESS> date </USER_LAST_ACCESS>
</RTD_REPLY>
if no matches are found (IE, login and/or password incorrect), returned USER_ID will be 0 (zero).
ACTION 'GetUserDesigns'
This action will return an XML file with details of Saved Designs belonged to a USER ID.
Required input parameteres are:
-
'user_id' - the ID of the registered user
For example, to query for user #123456, value should be: 'user_id'="123456"
FORMAT OF THE XML RESPONSE
<RTD_REPLY>
<DESIGN_1>
<DESIGN_ID> int </DESIGN_ID>
<DESIGN_PRODUCT_CATEGORY> string </DESIGN_PRODUCT_CATEGORY>
<DESIGN_PRODUCT> string </DESIGN_PRODUCT>
<DESIGN_INSDATE> date </DESIGN_INSDATE>
<DESIGN_THUMB> string </DESIGN_THUMB>
<DESIGN_DESIGNERSIZE_JPG> string </DESIGN_DESIGNERSIZE_JPG>
<DESIGN_DESIGNERSIZE_PNG> string </DESIGN_DESIGNERSIZE_PNG>
<IMPORT_LINK> string </IMPORT_LINK>
</DESIGN_1>
<DESIGN_2>
<DESIGN_ID> int </DESIGN_ID>
<DESIGN_PRODUCT_CATEGORY> string </DESIGN_PRODUCT_CATEGORY>
<DESIGN_PRODUCT> string </DESIGN_PRODUCT>
<DESIGN_INSDATE> date </DESIGN_INSDATE>
<DESIGN_THUMB> string </DESIGN_THUMB>
<DESIGN_DESIGNERSIZE_JPG> string </DESIGN_DESIGNERSIZE_JPG>
<DESIGN_DESIGNERSIZE_PNG> string </DESIGN_DESIGNERSIZE_PNG>
<IMPORT_LINK> string </IMPORT_LINK>
</DESIGN_2>
[...]
</RTD_REPLY>
ACTION 'UploadUserClipart'
This action will allow to upload a clipart for a specific USER ID and will return an XML file with details of the action.
Required input parameteres are:
-
'user_id' - the ID of the registered user
For example, to query for user #123456, value should be: 'user_id'="123456"
-
'clipart_filename' - the original filename of the clipart
For example, "clipart.jpg"
-
'clipart_binary_data' - the base64 encoded version of clipart's binary content
For example, you can create this value in PHP with base64_encode(file_get_contents($clipartfile);
FORMAT OF THE XML RESPONSE
<RTD_REPLY>
<CLIPART_ID> int </CLIPART_ID>
<CLIPART_NAME> string </CLIPART_NAME>
<CLIPART_INSDATE> date </CLIPART_INSDATE>
<CLIPART_UNIQUECOLORS> int </CLIPART_UNIQUECOLORS>
<CLIPART_ASPECTRATIO> float </CLIPART_ASPECTRATIO>
<CLIPART_THUMB> string </CLIPART_THUMB>
<CLIPART_DESIGNERSIZE> string </CLIPART_DESIGNERSIZE>
<CLIPART_ORIGINAL> string </CLIPART_ORIGINAL>
<ERROR> string </ERROR>
</RTD_REPLY>
if the action fails, returned CLIPART_ID will be 0 (zero) and details will be available in ERROR.
ACTION 'GetUserCliparts'
This action will return an XML file with details of Saved Cliparts belonged to a USER ID.
Required input parameteres are:
-
'user_id' - the ID of the registered user
For example, to query for user #123456, value should be: 'user_id'="123456"
FORMAT OF THE XML RESPONSE
<RTD_REPLY>
<CLIPART_1>
<CLIPART_ID> int </CLIPART_ID>
<CLIPART_NAME> string </CLIPART_NAME>
<CLIPART_INSDATE> date </CLIPART_INSDATE>
<CLIPART_UNIQUECOLORS> int </CLIPART_UNIQUECOLORS>
<CLIPART_ASPECTRATIO> float </CLIPART_ASPECTRATIO>
<CLIPART_THUMB> string </CLIPART_THUMB>
<CLIPART_DESIGNERSIZE> string </CLIPART_DESIGNERSIZE>
<CLIPART_ORIGINAL> string </CLIPART_ORIGINAL>
</CLIPART_1>
<CLIPART_2>
<CLIPART_ID> int </CLIPART_ID>
<CLIPART_NAME> string </CLIPART_NAME>
<CLIPART_INSDATE> date </CLIPART_INSDATE>
<CLIPART_UNIQUECOLORS> int </CLIPART_UNIQUECOLORS>
<CLIPART_ASPECTRATIO> float </CLIPART_ASPECTRATIO>
<CLIPART_THUMB> string </CLIPART_THUMB>
<CLIPART_DESIGNERSIZE> string </CLIPART_DESIGNERSIZE>
<CLIPART_ORIGINAL> string </CLIPART_ORIGINAL>
</CLIPART_2>
[...]
</RTD_REPLY>
ACTION 'GetUserOrders'
This action will return an XML file with details of Orders sent by a USER ID.
Required input parameteres are:
-
'user_id' - the ID of the registered user
For example, to query for user #123456, value should be: 'user_id'="123456"
FORMAT OF THE XML RESPONSE
A single record will be returned in this form, with order numbers comma-separated:
<RTD_REPLY>
<USER_ORDER_IDS> string </USER_ORDER_IDS>
</RTD_REPLY>
ACTION 'CreateNewUser'
This action will add a new registered user to your company, and return an XML file with details of the operation.
Required input parameteres are:
-
'login' - the new user's login name
-
'email' - the new user's email
-
'password' - the new user's password
NOTES:
This action will not register the user if:
- the login is already in use
- the login is not composed exclusively of letters and/or digits
- the login is not at least 5 characters long
- the email is already in use
- the email is not at least a 6 characters valid formatted email address
- the password is not at least 5 characters long
FORMAT OF THE XML RESPONSE
<RTD_REPLY>
<USER_ID> int </USER_ID>
<USER_LOGIN> string </USER_LOGIN>
<USER_EMAIL> string </USER_EMAIL>
<USER_PASSWORD> string </USER_PASSWORD>
<USER_REGISTER_DATE> date </USER_REGISTER_DATE>
<ERROR> string </ERROR>
</RTD_REPLY>
if the action fails, returned USER_ID will be 0 (zero) and details will be available in ERROR.
ACTION 'EditUserDetails'
This action change email and/or password of a registered user, and return an XML file with details of the operation.
Required input parameteres are:
-
'user_id' - the ID of the registered user
-
'old_login' - the user's login name
-
'old_email' - the user's email
-
'new_email' - the new user's email
-
'new_password' - the new user's password
NOTES:
Even if the login name cannot be changed, old_login and old_email are required for security reasons.
If there will be no match of user_id, old_login and old_email, the action will fail.
This action will also not apply any change if:
- the new email is already in use by other users
- the new email is not at least a 6 characters valid formatted email address
- the new password is not empty and not at least 5 characters long
The new password field can be empty: in this case, only the email field will be changed.
If new password will not be ampty and not at least 5 characters long, the action will fail.
To keep the current email, just set the value of the new email to be the same os of the old one.
FORMAT OF THE XML RESPONSE
<RTD_REPLY>
<USER_ID> int </USER_ID>
<USER_LOGIN> string </USER_LOGIN>
<USER_EMAIL> string </USER_EMAIL>
<USER_PASSWORD> string </USER_PASSWORD>
<ERROR> string </ERROR>
</RTD_REPLY>
if the action fails, returned USER_ID will be 0 (zero) and details will be available in ERROR.
ACTION 'GetUserAutologinUrl'
This action will create a link to the RTD altering session statuses of users.
Required input parameteres are:
-
'rtd_link' - any full RTD link you want the user to be redirected to once logged in
Optional input parameteres are:
- 'user_id' - the ID of the registered user
If you will pass this, the link to the RTD will also log in a secific registered user.
Not passing this will log user out, in case he's already logged in.
FORMAT OF THE XML RESPONSE
<RTD_REPLY>
<AUTOLOGINURL> string </AUTOLOGINURL>
<ERROR> string </ERROR>
</RTD_REPLY>
if the action fails, returned AUTOLOGINURL will be empty and details will be available in ERROR.
If succesfull, loading the AUTOLOGINURL will auto login/logout the user in RTD, and redirect him to the original rtd_link.
ACTION 'GetAllUsers'
This action will return the list of your registered users.
Accepted input parameteres are:
-
'login' - return only users matching (even partially) this filter in the login field
-
'email' - return only users matching (even partially) this filter in the email field
-
'showpass' - return also user's password. Use carefully and only when really needed.
FORMAT OF THE XML RESPONSE
<RTD_REPLY>
<USER_1>
<USER_ID> int </USER_ID>
<USER_LOGIN> string </USER_LOGIN>
<USER_PASSWORD> string </USER_PASSWORD>
<USER_EMAIL> string </USER_EMAIL>
<USER_REGISTER_DATE> date </USER_REGISTER_DATE>
<USER_LAST_ACCESS> date </USER_LAST_ACCESS>
</USER_1>
<USER_2>
<USER_ID> int </USER_ID>
<USER_LOGIN> string </USER_LOGIN>
<USER_PASSWORD> string </USER_PASSWORD>
<USER_EMAIL> string </USER_EMAIL>
<USER_REGISTER_DATE> date </USER_REGISTER_DATE>
<USER_LAST_ACCESS> date </USER_LAST_ACCESS>
</USER_2>
[...]
</RTD_REPLY>
ACTION 'GenerateImportCode'
This action will perform various actions to conver and use designs based off of XML format.
Please not that, for the time being, this entry is just a basic reference: the formats involved here will require a more detailed and dedicated page to be explained in full.
Required input parameteres are:
-
'product_id' (INT) - the Product ID you want to query
For example, to query Product ID 123456, value should be: 'product_id'="123456"
Optional input parameteres are:
-
'size_id' (INT) - the specific size ID you want to query
For fixed sizes, value should be like: 'size_id'="123456"
For ranged sizes (IE, a 20x30 size), value should be like: 'size_id'="20,30"
-
'XMLEntries' (string) - this is the main XML file to be parsed
-
'ReturnBinaryImages' (INT)
Use 1 to have base64 encoded version of image rasters, 0 to ignore
-
'ReturnImagesLinks' (INT)
Use 1 to have real RTD links to every specific image, 0 to ignore
-
'custom_js_commands' (string) - javascirpt code you may eventually want to inject in the designer when loaded.
Note: do not use script tags and do not define functions in this code, as it will be injected inline!
-
'custom_querystring' (string) - extra variable you want to pass, as for example external variables in querystring format.
For example, in PHP, you can pass two variables like this:
$params['custom_querystring']="myvar1=abc&myvar2=def";
Or you could pass an array to be retrieved later to an external variable of yours named "myvar" this way:
$params['custom_querystring']="extvar_myvar=".base64_encode(serialize($my_array));
FORMAT OF THE XML RESPONSE
<RTD_REPLY>
<LINK> string </LINK>
<COMPILEDCODE> string </COMPILEDCODE>
<ERROR> string </ERROR>
</RTD_REPLY>
FORMAT OF THE XML RESPONSE in case ReturnBinaryImages or ReturnImagesLinks are on:
<RTD_REPLY>
<LINK> string </LINK>
<COMPILEDCODE> string </COMPILEDCODE>
<BINARY_IMAGES>
<IMAGES_TOTAL> int </IMAGES_TOTAL>
<IMAGES_1> string </IMAGES_1>
<IMAGES_2> string </IMAGES_2>
<IMAGES_3> string </IMAGES_3>
[...]
</BINARY_IMAGES>
<ERROR> string </ERROR>
</RTD_REPLY>
FORMAT OF THE XMLEntries FIELD
This is important and complex at the same time, as it's the format actually describing the design.
Everything works with IDs and specific names, so nothing here should be considered "copy/paste" proof
Any not passe value will be set to a default. In general, type, value, position and size are the only required ones.
The values are different depending the input: for example, for texts is the text itself, for cliparts is the ID of a clipart.
<?xml version="1.0"?>
<design>
<bgcolor>Bright Green</bgcolor>
<items>
<item_1>
<type>t</type>
<itemname>Menu Title</itemname>
<itemchangename>Update entry</itemchangename>
<value>Menu Test</value>
<x>25%</x>
<y>5%</y>
<width>50%</width>
<height>20%</height>
</item_1>
<item_2>
<type>t</type>
<itemname>Menu Entry</itemname>
<itemchangename>Update entry</itemchangename>
<value>- blah blah blah</value>
<x>5%</x>
<y>35%</y>
<width>90%</width>
<height>4%</height>
<fpalign>n</fpalign>
<color>White</color>
<strokecolor>Black</strokecolor>
<strokewidth>5</strokewidth>
</item_2>
[...]
</items>
</items>
General properties list:
side
layer
x
y
width
height
color
rot
steprepeat
colorkeywords
arch
arch_on
arch_curves
shadowcolor
shadowblur
flip
shadow_x
shadow_y
alpha
blurring
sk1x
sk2x
sk3x
sk4x
sk1y
sk2y
sk3y
sk4y
NOTE: x,y, width and height can be both % or absolute values
Text properties list (type: "t"):
value
fpalign
inalign
linespacing
vt
font
strokecolor
strokewidth
strokewidth_double
maxchars
Clipart properties list (type: "c"):
value
clipkeywords
forceoriginalratio
Shape properties list (type: "s"):
value
shape_poly
shape_poly_starcross
shape_poly_star
shape_roundrect1
shape_roundrect2
shape_edgeoffset
shape_arrow_top
shape_arrow_baseline
strokecolor
strokewidth
strokewidth_double
|
