Zakeke uses cookies to provide necessary site functionality and improve your experience. By using our website, you agree to our privacy policy and our cookie policy.   

API Integration

Importing customizable products

Through the "Import products from CSV" feature in the "Products" section of Zakeke back office, you can send the list of customizable products from your store.
N.B.It is possible to use this function both to add and to update the products.

Below is the screenshot of the form to upload, which can be reached after clicking on "Import products from CSV

Importing products

At the end of the CSV import you will need to configure "pricing" and eventually "preview 3D" for each products.
Go to how to configure a customizable product for more information on configuring imported products.

File to send must be a ZIP archive with the following CSV files (in .txt format):

File name Description
products.txt
Required
Customizable products catalogue. Go to CSV data specification.
sides.txt
Optional (required if printing methods or areas CSV is sent)
List of sides for product. Go to CSV data specification.
N.B. It is not possible to send sides for products not present in the products CSV.
areas.txt
Optional
List of customizable areas for product. Go to CSV data specification.
N.B. It is not possible to send customizable areas for products not present in the products CSV.
printTypes.txt
Optional (required if sides CSV is sent)
List of printing method for product. Go to CSV data specification.
N.B. It is not possible to send printing method for products not present in the products CSV.

Click here to download a sample ZIP file with product, printing methods and customizable areas.

1. Product data specification

The product data you send using these attributes are the basis for creating your templates to be customized with Zakeke.

Attributes that must be specified in the CSV

Attribute Format Minimum requirements
ProductID Mandatory
Product Unique ID

Sintax
Maximum 100 characters
Example
100A1
  • Use a unique value for each product. If possible, use the SKU of the product
  • Note: for Woocommerce integrations you must use the product ID, not the SKU
  • Use only valid Unicode characters. Avoid invalid characters such as control, function or private area characters
MasterProductID Mandatory
ID for a product group available in different versions

Sintax
Maximum 100 characters
Example
100A
  • Use a unique value for each group of variants
  • If the product has no variants, the MasterProductID must match the ProductID
  • Keep the same value when updating product data
  • Use only valid Unicode characters
ProductName Mandatory
Product name

Sintax
Maximum 400 characters
Value must be enclosed with quotes
Example
"Customizable t-shirt"
  • Carefully describe the product so that it matches the title on your target page
ImageLink Mandatory
The URL of the main image of your product

Example
http://​your.store.​com/​product-image.​jpg
  • For the image URL:
    • Insert the link to the main product image
    • Starts with http or https
    • Use a coded URL in compliance with RFC 2396 or RFC 1738. For example, a comma is coded in "%2C"
  • For the image:
    • Use an accepted format: non-animated (.gif), JPEG (.jpg/.jpeg), PNG (.png)
    • Do not enlarge the image or send thumbnails
    • Do not include promotional text, watermarks or borders
VariantName Mandatory for product variants
Name of product variant applicable for customization localized in your ecommerce language

Sintax
Maximum 400 characters
Value must be enclosed with quotes
Example
"Red"
  • Carefully describe the variant by specifying all the attributes that distinguish it, such as colour
  • Name must be in your e-commerce default language (english in the example)
VariantNameLocale Optional (applicable for products with variants)
List of pairs formed by culture and respective localized variant name

Sintax
Pairs are formed by culture and localized text seperated from colon character; they are separated from pipe character and culture must be coded according Microsoft Language Culture Names. Click here for more details about language culture names.

Value must be enclosed with quotes
Example
"it-IT:Rosso|fr-FR:Rouge"
  • Use only valid unicode characters
  • Variante name in your e-commerce default language, must be excluded
Attributes Mandatory for product variants
Identification attributes for variant applicable for customization
(e.g. for product "red t-shirt size S" will be sent red attribute)

Sintax
"Attributes" uses several secondary attributes divided by the comma.
Each of them is formed by a key-value pair consisting respectively of the attribute name (used in forms) and the coded value:
<attributeKey1>=<value1>,...,<attributeKeyN>=<valueN>
Value must be enclosed with quotes
Example
"color=1"
  • The defined keys and values will be the reference for the scripts used in the product page of your e-commerce.
    Go to integration on product page for more details

2. Printing methods data specification

Printing methods data, that you send with these attributes, are the basis for creating your printing techniques for your customizable products.
N.B.For every printing methods, default printing output is: RASTER.
For more information go to management of printing methods.

Attributes that must be specified in the CSV

Attribute Format Minimum requirements
MasterProductID Mandatory
ID for a product group available in different versions

Sintax
Maximum 100 characters
Example
100A
  • Use a unique value for each group of variants
  • If the product has no variants, the MasterProductID must match the ProductID
  • Keep the same value when updating product data
  • Use only valid Unicode characters
PrintType Mandatory
Name of the printing technique applicable to the product

Sintax
Maximum 100 characters
Value must be enclosed with quotes
Example
"Serigraphy"
  • Use only valid unicode characters
  • Name must be in your e-commerce default language (english in the example)
PrintTypeNameLocale Optional
List of pairs formed by culture and respective localized print type name

Sintax
Pairs are formed by culture and localized text seperated from colon character; they are separated from pipe character and culture must be coded according Microsoft Language Culture Names. Click here for more details about language culture names.

Value must be enclosed with quotes
Example
"it-IT:Serigrafia|fr-FR:Sérigraphies"
  • Use only valid unicode characters
  • PrintType name in your e-commerce default language, must be excluded
DPI Mandatory
Resolution in DPI (Dots Per Inch) to be applied for printing

Sintax
Positive integer number
Example
400
DisableSellerCliparts Optional
Indicates whether the clipart images uploaded by the seller are applicable for customization
Sintax
Boolean value "true" or "false"
Default value
false
  • true: prevents the user to view and apply cliparts
  • false: allows user to view and apply cliparts
DisableUploadImages Optional
Indicates whether the user is allowed to upload their photos and use his image gallery for product customization
Sintax
Boolean value "true" or "false"
Default value
false
  • true: prevents the user to upload their images
  • false: allows the user to upload their images
DisableText Optional
Indicates whether the user is allowed to add text for product customization
Sintax
Boolean value "true" or "false"
Default value
false
  • true: prevents the user to add text
  • false: allows the user to add text
UseFixedImageSizes Optional
Indicates whether the user is allowed to resize images that have a size specified in the customization
Sintax
Boolean value "true" or "false"
Default value
false
  • true: prevents the user to resize images within the customizer IFrame
  • false: allows the user to resize images within the customizer IFrame
CanChangeSvgColors Optional
Indicates whether the user is allowed to change the colors of the SVG images
Sintax
Boolean value "true" or "false"
Default value
true
  • true: allows the user to change the colors of the SVG images
  • false: prevents the user to change the colors of the SVG images
CanUseImageFilters Optional
Indicates whether the user is allowed to use the image editor in customizer
Sintax
Boolean value "true" or "false"
Default value
true
  • true: allows the user to use the image editor in customizer
  • false: prevents the user to use the image editor in customizer
CanIgnoreQualityWarning Optional
Indicates whether the user is allowed to buy if there are quality warnings in customizer
Sintax
Boolean value "true" or "false"
Default value
true
  • true: allows the user to buy even if there are quality warnings in customizer
  • false: prevents the user buy if there are quality warnings in customizer
EnableUserImageUpload Optional
Indicates whether the user is allowed to upload files from his/her own device
Sintax
Boolean value "true" or "false"
Default value
true
  • true: allows the user to upload files from his/her own device
  • false: prevents the user to upload files from his/her own device
EnableJpgUpload Optional
Indicates whether the user is allowed to upload JPG images
Sintax
Boolean value "true" or "false"
Default value
true
  • true: allows the user to upload JPG images
  • false: prevents the user to upload JPG images
EnablePngUpload Optional
Indicates whether the user is allowed to upload PNG images
Sintax
Boolean value "true" or "false"
Default value
true
  • true: allows the user to upload PNG images
  • false: prevents the user to upload PNG images
EnableSvgUpload Optional
Indicates whether the user is allowed to upload SVG images
Sintax
Boolean value "true" or "false"
Default value
true
  • true: allows the user to upload SVG images
  • false: prevents the user to upload SVG images
EnablePdfUpload Optional
Indicates whether the user is allowed to upload PDF files
Sintax
Boolean value "true" or "false"
Default value
true
  • true: allows the user to upload PDF files
  • false: prevents the user to upload PDF files
EnablePdfWithRasterUpload Optional
Indicates whether the user is allowed to upload PDF files with raster images inside
Sintax
Boolean value "true" or "false"
Default value
true
  • true: allows the user to upload PDF files with raster images inside
  • false: prevents the user to upload PDF files with raster images inside
EnableEpsUpload Optional
Indicates whether the user is allowed to upload EPS images
Sintax
Boolean value "true" or "false"
Default value
true
  • true: allows the user to upload EPS images
  • false: prevents the user to upload EPS images
EnableFacebookUpload Optional
Indicates whether the user is allowed to upload images from Facebook
Sintax
Boolean value "true" or "false"
Default value
true
  • true: allows the user to upload images from Facebook
  • false: prevents the user to upload images from Facebook
EnableInstagramUpload Optional
Indicates whether the user is allowed to upload images from Instagram
Sintax
Boolean value "true" or "false"
Default value
true
  • true: allows the user to upload images from Instagram
  • false: prevents the user to upload images from Instagram
EnablePreviewDesignsPDF Optional (only for premium)
Indicates whether the user is allowed to preview his designs by PDF document
Sintax
Boolean value "true" or "false"
Default value
true
  • true: allows the user to preview
  • false: prevents the user to preview

3. Sides data specification

Sides data, that you send with these attributes, are the basis for creating customizable printing sides applicable to your customizable products. For more informations, go to management of customizable areas.

Attributes that must be specified in the CSV

Attribute Format Minimum requirements
MasterProductID Mandatory
ID for a product group available in different versions

Sintax
Maximum 100 characters
Example
100A
  • Use a unique value for each group of variants
  • If the product has no variants, the MasterProductID must match the ProductID
  • Keep the same value when updating product data
  • Use only valid Unicode characters
VariantName Mandatory for product variants
Name of product variant applicable for customization

Sintax
Maximum 400 characters
Value must be enclosed with quotes
Example
"Red"
  • Carefully describe the variant by specifying all the attributes that distinguish it
  • Name must be in your e-commerce default language (english in the example)
SideName Mandatory
Name of product side

Sintax
Maximum 100 characters
Value must be enclosed with quotes
Example
"Front"
  • Name must be in your e-commerce default language (english in the example)
SideNameLocale Optional
List of pairs formed by culture and respective localized side name

Sintax
Pairs are formed by culture and localized text seperated from colon character; they are separated from pipe character and culture must be coded according Microsoft Language Culture Names. Click here for more details about language culture names.

Value must be enclosed with quotes
Example
"it-IT:Fronte |fr-FR:Avant"
  • Use only valid unicode characters
  • Side name in your e-commerce default language, must be excluded
SideCode Optional
Code to be used to identify a side

Sintax
Maximum 50 characters
Example
front
  • Use only valid unicode characters
UrlImageSide Mandatory
URL of product image that includes the reference customizable area

Example
http://​your.store.​com/​product-image-frontside.​jpg
  • For the image URL:
    • Starts with http or https
    • Use a coded URL in compliance with RFC 2396 or RFC 1738. For example, a comma is coded in "%2C"
  • For the image:
    • Use an accepted format: non-animated (.gif), JPEG (.jpg/.jpeg), PNG (.png)
    • Do not enlarge the image or send thumbnails
    • Do not include promotional text, watermarks or borders
PPCM Optional
The number of pixels per cm. It can be calculated by picking two points in the side image which you know the real cm dimensions; Then simply divide the pixel distance by the cm distance; The result will be your PPCM. NB: PPCM becomes mandatory if you want to upload the areas CSV too.

Sintax
Positive decimal number
Example
19.04

3. Areas data specification

Customizable areas data, that you send with these attributes, are the basis for creating customizable printing areas applicable to your customizable products.

Attributes that must be specified in the CSV

Attribute Format Minimum requirements
MasterProductID Mandatory
ID for a product group available in different versions

Sintax
Maximum 100 characters
Example
100A
  • Use a unique value for each group of variants
  • If the product has no variants, the MasterProductID must match the ProductID
  • Keep the same value when updating product data
  • Use only valid Unicode characters
VariantName Mandatory for product variants
Name of product variant applicable for customization

Sintax
Maximum 400 characters
Value must be enclosed with quotes
Example
"Red"
  • Carefully describe the variant by specifying all the attributes that distinguish it
  • Name must be in your e-commerce default language (english in the example)
SideName Mandatory
Name of product side

Sintax
Maximum 100 characters
Value must be enclosed with quotes
Example
"Front"
  • Name must be in your e-commerce default language (english in the example)
AreaName Optional
Name of product customizable area

Sintax
Maximum 100 characters
Value must be enclosed with quotes
Example
"Front area"
UrlAreaMask Mandatory
URL of mask image that defines the shape of the customizable area

Example
http://​your.store.​com/​product-image-frontside-area1-mask.​png
  • For the image URL:
    • Starts with http or https
    • Use a coded URL in compliance with RFC 2396 or RFC 1738. For example, a comma is coded in "%2C"
  • For the image:
    • Use PNG (.png)
    • Place one or more black shapes were you want to let the user add texts or images
    • The black shapes should be completely black (even inside)
    • The image background must be transparent
    • The image must have a transparent border wide at least 1 pixel
    • You can download an example mask image (there are three areas, both simple and complex ones)
ClipOut Optional
Indicates whether images and texts in the output files should be cropped to the shape of the area or should be at least wide at tall as the area outer bounds (this can lead to output images bigger than the area shape).
Sintax
Boolean value "true" or "false"
Default value
true
  • true: produces cropped out output files
  • false: produces output files which have the maximum length and height of the area (they could be bigger than the area shape)