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 Reference

Designs API

The Design API allows you to get design information on pricing, url image preview and the image files required for printing of a customized product ordered.

Overview

The API for design consists in 3 endpoints:

  1. Get design info: allows to get, given a Zakeke Design ID, information on design, such as pricing and preview image
  2. Get design files: allows to get, given a Zakeke Design ID, design files compressed into a ZIP archive
  3. Get design items: allows to get, given a Zakeke Design ID, information on the customization items

Authentication

Design endpoints must be called in S2S (server to server) mode.
For further information see how to get a S2S OAuth token.

1. Get design information

Allows to get, given a Zakeke Design ID, information on design, such as pricing and preview image

GET https://api.zakeke.com/v1/designs/{designID}[?quantity={quantity}]

Input parameter

Parameter Data type Description Required
designID string Unique design ID generated by Zakeke Iframe Customizer. yes
quantity integer Quantity ordered of product with this design no (if not sent, default value is 1)

Output

Json object with design information retrieved:

{
    "designID" : "000-01234567880ACVD",
    "name" : "Test Design",
    "modelCode" : "0001",
    "tempPreviewImageUrl": 
    "https://zakeketest.blob.core.windows.net/files/693f0d8c63b44636860bf6be68e514d3.png",
    "designUnitPercentagePrice": 0,
    "designUnitPrice": 10,
    "customerCode" : "c-000000001",
    "visitorCode" : "v-000000001"
}
Property Data type Description
designID string Design unique identifier
name string Name of design saved in draft mode
modelCode string SKU of product model of this design
tempPreviewImageUrl string URL preview PNG image in 165 pixel square format of product with this design
designUnitPercentagePrice decimal Unit design price in percentage to apply (value depends on back office pricing rules settings)
designUnitPrice money Unit design price to apply (value depends on back office pricing rules settings)
customerCode string Registered customer identificator of your store, owner of this design
visitorCode string Visitor identificator of your store, owner of this design

HTTP Response codes

Code Description
200 Design information was successfully returned.
404 Unable to retrieve design information (e.g. design not found)

2. Get designs for seller

Allows to get designs for a seller authenticated (by authentication token)

GEThttps://api.zakeke.com/v1/designs/seller[?pageSize={pageSize}&designID={designID}&customerCode={customerCode}&draft={draft}&onlyForCustomers={onlyForCustomers}&queryText={queryText}]

Input parameter

Parameter Data type Description Required
pageSize integer Page size design results no (if no value is sent, all designs will be returned in a single page)
designID string Design ID to filter designs no
customerCode string Customer code to filter designs no
draft boolean True: only draft saved designs will be returned - False: will be returned no draft designs (those added to cart or purchased) no (if no value is sent, all designs will be returned )
onlyForCustomers boolean True: only designs created by registered customers will be returned - False: will be returned all design created both customers and visitors no (default value: false)
queryText string Query keyword for searching designs by name or tags no

Header parameter

Parameter Data type Description Required
x-ms-continuation string Token for requesting next designs page no

Output

Json object with design information retrieved:

{
    "continuationToken" : "",
    "designs" : [{design1},....,{designN}]
}
Property Data type Description
continuationToken string Continuation token for next designs page (if page size parameter is sent)
designs array objects List of object designs (the design properties are defined above)

HTTP Response codes

Code Description
200 Designs list was successfully returned.
404 Unable to retrieve designs

3. Get number of designs for seller

Get number of designs created for a seller authenticated (by authentication token)

GEThttps://api.zakeke.com/v1/designs/seller/occurrences[?customerCode={customerCode}&draft={draft}&onlyForCustomers={onlyForCustomers}&queryText={queryText}]

Input parameter

Parameter Data type Description Required
customerCode string Customer code to filter designs no
draft boolean True: only draft saved designs will be returned - False: will be returned no draft designs (those added to cart or purchased) no (if no value is sent, all designs will be returned )
onlyForCustomers boolean True: only designs created by registered customers will be returned - False: will be returned all design created both customers and visitors no (default value: false)
queryText string Query keyword for searching designs by name or tags no

Output

Number of design created

HTTP Response codes

Code Description
200 Number of designs created successfully returned.
404 Unable to retrieve designs

4. Get customer codes with design for seller

Get array of customer codes with designs for a seller authenticated (by authentication token)

GEThttps://api.zakeke.com/v1/designs/seller/customers[?onlyDraftDesigns={onlyDraftDesigns}]

Input parameter

Parameter Data type Description Required
onlyDraftDesigns boolean True: returns customer with only draft designs - False: returns customers with no-draft designs (added to cart or purchased) no (if no value is sent, all customers with both draft and no-draft designs will be returned)

Output

Array of customer codes

{
    [{customerCode1},....,{customerCodeN}]
}

HTTP Response codes

Code Description
200 Array of customer codes was successfully returned
404 Unable to retrieve customers with designs

5. Get design files

GEThttps://api.zakeke.com/v1/designs/{designID}/outputfiles/zip

Allows to get, given a Zakeke Design ID, design files compressed into a ZIP archive

Important: Url zip will be available only if the order/s with products customized by this design, has been placed.

Input parameter

Parameter Data type Description Required
designID string Unique design ID generated by Zakeke Iframe Customizer. yes

Output

JSon object with url ZIP archive:

{
    "url": "https://zakeketest.blob.core.windows.net/files/693f0d8c63b44636860bf6be68e514d3.zip",
}

The archive contains:

1. PDF Summary
File name Type Description
Summary.pdf PDF A summary of design in PDF format
2. Image files for every side (e.g. front, back, etc.) and print area customized
File name Type Description
[side_identifier-area_identifier].dxf DXF Image in DXF format
[side_identifier-area_identifier].pdf PDF Image in PDF format
[side_identifier-area_identifier].png PNG Image in PNG format (available only if design print type accepts raster images)
[side_identifier-area_identifier].svg SVG Image in SVG format (vectorial)

HTTP Response codes

Code Description
200 Url ZIP file was successfully returned
204 Url ZIP not available (e.g. design files are not available although design ID was found)
404 Design not found therefore Url ZIP is not available

6. Get Items information

GEThttps://api.zakeke.com/v1/designs/{designID}/items

Input parameter

Parameter Data type Description Mandatory
designID string Unique design ID generated by Zakeke Iframe Customizer. yes

Output

Json object with design information retrieved:

{
    "designID": "000-Efzf7YDOr0xBazAkGjk8Mg", 
    "variant": [
     {
        "name": "XL - White",
        "code": "[{"Id":1,"Label":"Size","Value":{"Id":"XL","Label":"XL.......",
        "modelSide": [
        {
                    "name": "Front",
                    "PPCM": 13.349769694578864,
                    "modelArea": [
                        {
                            "name": "Central",
                            "item": [
                                {
                                    "Json": "["Raster",{"applyMatrix":false,"matrix":[0.61675,0,0,0.61675,2.37823,-141.91993],"data":{"guid":....",
                                    "coordinates": {
                                        "x": -122.55582126065119,
                                        "y": -260.78696941757283,
                                        "unit": "mm"
                                    },
                                    "dimensions": {
                                        "width": 124,
                                        "height": 57,
                                        "unit": "mm"
                                    },
                                    "itemColors": [
                                        {
                                            "RGBCode": "#000000",
                                            "PantoneCode": "Pantone 000"
                                        }
                                    ]

                                }
                            ]
                        }
                    ]
                }
            ]
        }
    ]
}
Property Data type Description
designID string Unique design ID generated by Zakeke.
variant.name string name of model color.
variant.code string JSON format contains attributes of model color.
variant.modelSide.name string name of model side.
variant.modelSide.PPCM double Point Per Centimeters.
variant.modelSide.modelArea.name string name of model area.
variant.modelSide.modelArea.item.JSON string JSON format contains attributes of item.
variant.modelSide.modelArea.item.coordinates.x double distance expressed in "mm" from the top left corner of the "Model Area" ("x" coordinate)
variant.modelSide.modelArea.item.coordinates.y double distance expressed in "mm" from the top left corner of the "Model Area" ("y" coordinate)
variant.modelSide.modelArea.item.coordinates.unit string unit of measure
variant.modelSide.modelArea.item.dimensions.width string item width in pixel
variant.modelSide.modelArea.item.dimensions.height string item height in pixel
variant.modelSide.modelArea.item.itemColors Array of item color Color list used for design item
variant.modelSide.modelArea.item.itemColors.RGBCode string RGB Hex code of item color
variant.modelSide.modelArea.item.itemColors.PantoneCode string Pantone code of item color

HTTP Response codes

Code Description
200 Design information was successfully returned.
404 Unable to retrieve item information (e.g. doc ID not found)

API reference

For API technical reference go to https://api.zakeke.com/docs/index