Example for using the EditDesign API call

Example for using the EditDesign API call


We have a Golf Club customer and we want to provide a service, so Club members and friends can order their embroidered Polo Shirts or other branded garments and merchandise and personalise them with their own names or for their family members, friends.



In our Wilcom EmbroideryStudio e4.5 software we prepare a design with Lettering.

This embroidery would fit nicely on the left chest. Shown below with the EmbroideryStudio Product Visualiser. The customer’s website can do the same, showing the Trueview PNG image in the left chest position.


In EmbroideryStudio, the embroidery design can be set up for the given fabric (in this case we chose Pure Cotton). This automatically adjusts the stitch densities, pull compensation, underlay stitches, minimum stitch, etc. parameters for the given garment.

The web developer can upload a series of versions of the same EMB design, all set for different fabrics that are offered with the garment products. When the website visitor selects the particular garment, the website program automatically selects the proper EMB file that has the right stitch parameters for that garment. This way the machine (stitch) file (for example Tajima.DST) will be production-ready.


Let’s see what happens on the Website when we choose this design!

We are showing a Wilcom Concept App below that has a simple user interface, only to show the functionality, nothing fancy. (This Concept App is accessible through the Wilcom API developer website.)

Select our design (Choose file), which is then uploaded to the server which returns with the design data and the Trueview image.

Note that the App recognises the lettering object in the design. For simplicity, we converted the “Beverley Park Golf” letters to normal objects. With stock designs prepared for similar website use this can be a good practice to keep only the lettering object that we want to allow the user to change.

Regarding the Font, Letter size, Color, we may or may not allow the user to change those, that is a matter of commercial choice.


Type in the text and press “Update Design” (for developers: you can turn on the “Show Design recipe” to see how the Api call happens)

Note: this font only has Upper Case letters, otherwise it would follow my writing.

The script is very long, just pasting the beginning, to show the idea:

<?xml version="1.0" encoding="utf-8"?>

<xml xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">


    <design file="BeverleyPark_Golf_Template_CottonPolo.EMB" colorwaytype="current" colorway="Colorway 1">

      <transform scale="1" mirror="none" rotation="0" dx="0" dy="0" />


        <lettering_object index="0">

          <thread color="16744062" />

          <simple_lettering text="Janos Golf Champion" alphabet_name="College" height="10" />




    <output trueview_file="BeverleyPark_Golf_Template_CottonPolo - edited.png" design_file="" design_version="" dpi="0" />



    <file filename="BeverleyPark_Golf_Template_CottonPolo.EMB" filecontents="0M8R4KGxGuEAAAAAAAAAAAAAAAAAAAAAPgADAP7/CQAGAAAAAA



Note for developers: if you want a production-ready machine file that can be loaded to the embroidery machine, you need to use the proper extension (instead of .EMB, .DST for Tajima, .TAP for Happy, etc)



When preparing the Design in EmbroideryStudio, we can setup multiple colorways in the design. This means that if the Garment catalogue provides for example 10 different colors, we can have 10 different thread color arrangements and the thread colors harmonise with the color of the garment.

To properly utilise this feature, the web developer can create relationship between the selected garment color and the appropriate Colorway, i.e. calling “Colorway 2” Colorway 3”, etc.

    <design file="BeverleyPark_Golf_Template_CottonPolo.EMB" colorwaytype="current" colorway="Colorway 1">



The documentation describing how the above Concept App works can be found at the API developer website: Wilcom Embroidery Concept Example – Edit Design Lettering. Source code is also provided.

    • Related Articles

    • What Api calls are AutoDigitizing and why such call is not included in Standard API Plans?

      Q: What Api calls are AutoDigitizing and why such call is not included in Standard API Plans? In the Wilcom Web API service “AutoDigitizing” means that An image (bitmap or vector) is uploaded to the Wilcom Embroidery Engine and a Stitch file (a ...
    • How to create Production-ready Embroidery Lettering with Wilcom API?

      How to create Production-ready Embroidery Lettering with Wilcom API? INTRODUCTION Let’s imagine that we are selling garments on our website that are made of 4 different fabrics. We have FLEECE jumpers, WOOL jackets, SILK blouses and POLYESTER-COTTON ...
    • What are the Wilcom Thread Charts and how to use them in API calls?

      Q1: What are the Wilcom Thread Charts and how to use them in API calls? Q2: What are the Color Index numbers and how do they relate to Colors on the Embroidery machine? This article is prepared for Web developers or Wilcom API customers with only ...
    • Easy Access to Online API Documentation

      INTRODUCTION One of the first questions that customers ask about the Wilcom Embroidery Web API (EWA) is: how difficult is to implement it? Earlier, interested customers had to sign up to a Trial and Demo Account to read our more important API ...
    • About Embroidery Formats

      In the Wilcom Web API service most API calls return an “embroidery” file. This Article provides background information on this topic. NATIVE AND MACHINE FORMATS Wilcom developed a “native” internal embroidery design format in EmbroideryStudio, called ...