Order Types

Embroidery Orders

Print Orders

Embroidery Style

Parameters

Field Required? Optional Description
Job
String		 no If Job is not supplied then an auto generated job value is created For the Render action, if Job is supplied all other parameters will be ignored and an existing Job will be rendered
CustomerOrderNumber
String		 no
OrderType
String		 yes OrderType for Embroidery Style is
embroidery-style
ProductCode
String		 yes
Style
String		 yes
Design
String		 conditional If Style is supplied Design are Required if Personalizations are not supplied
OutputFile
String		 no Additional output file will be created in specified location
LineSpacingOverride
Double		 no
DesignSpacingOverride
Double		 no
Justification
String		 no If Style is supplied there is the ability to shift final elements within the file when using Style Available justification types for Style are
center left right
OutputType
String		 no Default is a png image of the requested render action Available OutputType for Render action are
image - returns a png image of the render action
base64 - returns the base64 string representation of the render action
Personalizations
List		 conditional If Style is supplied Personalizations are Required if Design is not supplied Personalization Parameters

Personalization Parameters

Field Required? Optional Description
Text
String		 yes
TextColour
String		 yes
FontOverride
String		 no
HeightOverride
Double		 no
WidthOverride
Double		 no Specify the width of a line of text and have the system generate the height proportionally
IsRainbowText
Bool		 no The Rainbow text feature is a way to instantly create multi-colored text in a design. The Rainbow text inserts a color change at the end of each letter in the selected text, and the next color is chosen randomly from the threads in the active palette
ElementName
String		 conditional If IsRainbowText is true then an element name is required in order to set the rainbow to the correct text. Example: &IsRainbowText=true&ElementName=Text1 If ElementName is not submitted then Rainbow Text gets applied to all Text segements which might give unexpected results

Sample Render and Submit calls

# GET
https://pulsemicro.com/PulseID/api/Orders/Render?ProductCode=Pulse&OrderType=embroidery-style&Style=SCRIPT&Personalizations[0].Text=Pulse&Personalizations[0].TextColour=Blue

# POST
https://pulsemicro.com/PulseID/api/Orders/Submit?Job=TestJob&ProductCode=PULSE&OrderType=embroidery-style&Style=SCRIPT&Personalizations[0].Text=Pulse&Personalizations[0].TextColour=Blue

https://pulsemicro.com/PulseID/api/Orders/Submit
{
  "Job": "TestJob",
  "ProductCode": "PULSE",
  "OrderType": "embroidery-style",
  "Style": "Script",
  "Personalizations": [{
      "Text": "Pulse",
      "TextColour": "Blue"
    }
  ],
}

Embroidery Template

Parameters

Field Required? Optional Description
Job
String		 no If Job is not supplied then an auto generated job value is created For the Render action, if Job is supplied all other parameters will be ignored and an existing Job will be rendered
CustomerOrderNumber
String		 no
OrderType
String		 yes OrderType for Embroidery Template is
embroidery-template
ProductCode
String		 yes
TemplateCode
String		 yes See TemplateFile below
TemplateFile
String		 conditional If TemplateFile is supplied TemplateFile will be used instead of TemplateCode
OutputFile
String		 no Additional output file will be created in specified location
PrimaryColour
String		 no Replace primary colour with the specified colour in the output design. See TextColour below in Personalizations
SecondaryColour
String		 no Replace secondary colour with the specified colour in the output design. See TextColour below in Personalizations
TemplateColourOverride
String		 no Can be a single colour or a comma separated list of colours
OutputType
String		 no Default is a png image of the requested render action Available OutputType for Render action are
image - returns a png image of the render action
base64 - returns the base64 string representation of the render action
ImageHeight
Int		 no Height in pixels of the resulting image. Default is 1000.
ImageWidth
Int		 no Width in pixels of the resulting image. Default is 1000.
DPI
Int		 no DPI value to use when generating the image. Ignored if any of ImageWidth or ImageHeight are specified.
Personalizations
List		 conditional If Style is supplied Personalizations are Required if Design is not supplied Personalization Parameters

Personalization Parameters

Field Required? Optional Description
ElementName
String		 yes
IsText
Bool		 yes The IsText field is required for template orders. Determines if the text specified is for a text element or to replace a design element
Text
String		 conditional When the IsText property is set to false then Text determines the design to replace in a design element Template orders can have blank text, other order types cannot
Design
String		 conditional Can be used instead of Text property for design replacement Used to replace a design element in a Template and when the IsText property is set to false
DesignColourOverride
String		 no Can be a single colour or a comma separated list of colours
TextColour
String		 conditional If the order type is embroidery-template and the TextColour specified for the element is 'primary' or 'secondary' then the following will update
TextColour is 'primary' then TextColour will be updated to the order paramters value of PrimaryColour
Then it will check for the configuration setting to look up thread by Name or Code and and find a match in the pallete to set the RGB of the primary thread
TextColour is 'secondary' then TextColour will be updated to the order paramters value of SecondaryColour
Then it will check for the configuration setting to look up thread by Name or Code and and find a match in the pallete to set the RGB of the primary thread 		The TextColour field is required for non Template orders and is optional for Template orders
FontOverride
String		 no
HeightOverride
Double		 no
ElementJustification
String		 conditional If TemplateCode is supplied Available justification types for template elements are
center left right
IsRainbowText
Bool		 no The Rainbow text feature is a way to instantly create multi-colored text in a design. The Rainbow text inserts a color change at the end of each letter in the selected text, and the next color is chosen randomly from the threads in the active palette

Sample Render and Submit calls

# GET
https://pulsemicro.com/PulseID/api/Orders/Render?ProductCode=Pulse&OrderType=embroidery-template&TemplateCode=TemplateOne&Personalizations[0].Text=Pulse&Personalizations[0].TextColour=Blue

# POST
https://pulsemicro.com/PulseID/api/Orders/Submit?Job=TestJob&ProductCode=Pulse&OrderType=embroidery-template&TemplateCode=TemplateOne&Personalizations[0].Text=Pulse&Personalizations[0].TextColour=Blue

https://pulsemicro.com/PulseID/api/Orders/Submit
{
  "Job": "TestJob",
  "ProductCode": "Pulse",
  "OrderType": "embroidery-template",
  "TemplateCode": "TemplateOne",
  "Personalizations": [{
      "Text": "Pulse",
      "TextColour": "Blue"
    }
  ],
}

Coloreel Template

Parameters

Field Required? Optional Description
Job
String		 no If Job is not supplied then an auto generated job value is created For the Render action, if Job is supplied all other parameters will be ignored and an existing Job will be rendered
CustomerOrderNumber
String		 no
OrderType
String		 yes OrderType for Coloreel Template is
coloreel-template
ProductCode
String		 yes
TemplateCode
String		 yes See TemplateFile below
TemplateFile
String		 conditional If TemplateFile is supplied TemplateFile will be used instead of TemplateCode
OutputFile
String		 no Additional output file will be created in specified location
PrimaryColour
String		 no Replace primary colour with the specified colour in the output design. See TextColour below in Personalizations
SecondaryColour
String		 no Replace secondary colour with the specified colour in the output design. See TextColour below in Personalizations
TemplateColourOverride
String		 no Can be a single colour or a comma separated list of colours
OutputType
String		 no Default is a png image of the requested render action Available OutputType for Render action are
image - returns a png image of the render action
base64 - returns the base64 string representation of the render action
ImageHeight
Int		 no Height in pixels of the resulting image. Default is 1000.
ImageWidth
Int		 no Width in pixels of the resulting image. Default is 1000.
DPI
Int		 no DPI value to use when generating the image. Ignored if any of ImageWidth or ImageHeight are specified.
Personalizations
List		 conditional If Style is supplied Personalizations are Required if Design is not supplied Personalization Parameters

Personalization Parameters

Field Required? Optional Description
ElementName
String		 yes
IsText
Bool		 yes The IsText field is required for template orders. Determines if the text specified is for a text element or to replace a design element
Text
String		 conditional When the IsText property is set to false then Text determines the design to replace in a design element Template orders can have blank text, other order types cannot
Design
String		 conditional Can be used instead of Text property for design replacement Used to replace a design element in a Template and when the IsText property is set to false
DesignColourOverride
String		 no Can be a single colour or a comma separated list of colours
DesignColoreelLibraryOverride
String		 no Affects only the design elements of a embroidery coloreel template.
To have effect must be used with DesignColoreelSwatchOverride and
at least a coloreel swatch must already been applied to design's element 		Can be a single coloreel library or a comma separated list of coloreel libraries.
In each case must be a match 1:1 to DesignColoreelSwatchOverride field
DesignColoreelSwatchOverride
String		 no Affects only the design elements of a embroidery coloreel template.
To have effect must be used with DesignColoreelLibraryOverride and
at least a coloreel swatch must already been applied to design's element 		Can be a single coloreel swatch or a comma separated list of coloreel swatches.
In each case must be a match 1:1 to DesignColoreelLibraryOverride field
TextColour
String		 conditional If the order type is embroidery-template and the TextColour specified for the element is 'primary' or 'secondary' then the following will update
TextColour is 'primary' then TextColour will be updated to the order paramters value of PrimaryColour
Then it will check for the configuration setting to look up thread by Name or Code and and find a match in the pallete to set the RGB of the primary thread
TextColour is 'secondary' then TextColour will be updated to the order paramters value of SecondaryColour
Then it will check for the configuration setting to look up thread by Name or Code and and find a match in the pallete to set the RGB of the primary thread 		The TextColour field is required for non Template orders and is optional for Template orders
TextColoreelLibrary
String		 conditional If the order type is coloreel-template the TextColoreelLibrary should have a value like Coloreel Medium
To have effect must be used with TextColoreelSwatch
If value not set then the rendering will be done with the default coloreel effects 		The TextColoreelLibrary field is optional for coloreel-template orders and affects only text elements
TextColoreelSwatch
String		 conditional If the order type is coloreel-template the TextColoreelSwatch should have a value like #ED1212.
It is the Name of a coloreel swatch that belongs to the coloreel library passed in the field TextColoreelLibrary
To have effect must be used with TextColoreelLibrary
If value not set then the rendering will be done with the default coloreel effects 		The TextColoreelSwatch field is optional for coloreel-template orders and affects only text elements
FontOverride
String		 no
HeightOverride
Double		 no
ElementJustification
String		 conditional If TemplateCode is supplied Available justification types for template elements are
center left right
IsRainbowText
Bool		 no The Rainbow text feature is a way to instantly create multi-colored text in a design. The Rainbow text inserts a color change at the end of each letter in the selected text, and the next color is chosen randomly from the threads in the active palette

Sample Render and Submit calls

# GET
https://pulsemicro.com/PulseID/api/Orders/Render?TemplateCode=TSSTemplateCode&ProductCode=TSSProduct&OrderType=coloreel-template&Personalizations[0].ElementName=Element1&Personalizations[0].Text=TSS&Personalizations[0].IsText=true&Personalizations[0].TextColoreelLibrary=Coloreel$20Small&Personalizations[0].TextColoreelSwatch=%23B4D98E

# POST
https://pulsemicro.com/PulseID/api/Orders/Submit?TemplateCode=TSSTemplateCode&ProductCode=TSSProduct&OrderType=coloreel-template&Personalizations[0].ElementName=ColText1&Personalizations[0].Text=TSS&Personalizations[0].IsText=true&Personalizations[0].TextColoreelLibrary=Coloreel%20Small&Personalizations[0].TextColoreelSwatch=%23B80E0E&Personalizations[1].ElementName=ColText2&Personalizations[1].Text=SOFTWARE&Personalizations[1].IsText=true&Personalizations[1].TextColoreelLibrary=Coloreel%20Medium&Personalizations[1].TextColoreelSwatch=%23FF8000

https://pulsemicro.com/PulseID/api/Orders/Submit
{
    "TemplateCode": "TSSTemplateCode",
    "ProductCode": "TSSProduct",
    "OrderType": "coloreel-template",
    "Personalizations": [
        {
            "ElementName": "TextElementName",
            "Text": "TSS",
             "IsText": true,
            "TextColoreelLibrary": "Coloreel Small",
            "TextColoreelSwatch": "#B4D98E"
        },
        {
            "ElementName": "DesignElementName",
            "IsText": false,
            "Design": "ReplacementDesignName",
            "Text": "ReplacementDesignName",
            "DesignColoreelLibraryOverride": "Coloreel Small,Coloreel Medium",
            "DesignColoreelSwatchOverride": "#4CA9A9,#4D2F29"
        }
    ]
}

Embroidery Design

Parameters

Field Required? Optional Description
Job
String		 no Can be empty string or omitted
CustomerOrderNumber
String		 no
OrderType
String		 yes OrderType for Embroidery Design is
embroidery-design
ProductCode
String		 conditional The ProductCode parameter is required if the File parameter is specified
Input
String		 conditional If the File parameter is specified then Input is not required Full path to Input file that will be used to generate Output file
Output
String		 conditional If the File parameter is specified then Input is not required Full path where Output file will be created in specified location
FileFormat
String		 conditional If Input and Output are not specified or if File is a base64 string, FileFormat is required. Optional for the File parameter. Current supported file formats are valid Embroidery file supported formats.
File
String		 conditional Required if Input and Output are not specified. If the source of the File parameter is a URL the API will attempt to download the file. If it is not a URL then the required format is a base64 string version of the file and the FileFormat parameter is required.
IsColorizeError
Bool		 yes If true with cause order to be in exception if the available needles in the design are less than the Colours submitted with the order
See Colours below
PiecesOrdered
Integer		 no Used to let operators know how many of the order should be sewn
PiecesRemaining
Integer		 no If no value is specified, this gets set to the same value as PiecesOrdered Used to let operators know how many of the order are left to be sewn
PiecesInDesign
Integer		 no If no value is specified, this gets set to the same value as PiecesOrdered This indicates when a single design actually has multiple pieces in a single file. When an order contains PiecesInDesign, multiply the Sum of the Active Heads by the PiecesInDesign value. Pieces Sewn in the Orders view is updated to reflect this value.
BeginMessage
String		 no Used to let operators know of any messages prior to sewing
EndMessage
String		 no Used to let operators know of any messages after completing sewing
MaxRPM
Integer		 no Maximum RPM the Machine can sew at for the job
Colours
List		 conditional Colour Parameters
ColorTheme
String		 no Used to find the Colours of an existing Product Design and replace the original Colours of the embroidery design with them

Personalization Parameters

Field Required? Optional Description
Name
String		 yes Thread name
Manufacturer
String		 no Thread manufacturer
Code
String		 yes Thread code
Red
Integer		 yes Amount of red in the thread. 0-255
Green
Integer		 yes Amount of green in the thread. 0-255
Blue
Integer		 yes Amount of blue in the thread. 0-255

Sample Submit calls

# POST
https://pulsemicro.com/PulseID/api/Orders/Submit?Job=&ProductCode=Pulse&OrderType=embroidery-template&TemplateCode=TemplateOne&Personalizations[0].Text=Pulse&Personalizations[0].TextColour=Blue

https://pulsemicro.com/PulseID/api/Orders/Submit
{
  "Job": "",
  "OrderType": "embroidery-design",
  "Input": "c:\\PulseID\\Data\\PulseID\\Templates\\355.DST",
  "Output": "c:\\PulseID\\Data\\PulseID\\Output\\355.PCF",
  "CustomerOrderNumber": "Optional Customer Information",
  "IsColorizeError": false,
  "PiecesOrdered": 100,
      "Colours": [{
          "Name": "Red",
          "Manufacturer": "Madiera 40a",
          "Code": "1800",
          "Red": 255,
          "Green": 0,
          "Blue": 0
        },
          "Name": "White",
          "Manufacturer": "Madiera 40",
          "Code": "1801",
          "Red": 255,
          "Green": 255,
          "Blue": 255
        }
  ],
  "ColorTheme": "Color Theme 1"
  "BeginMessage": "Sew me.",
  "EndMessage": "I am done.",
  "MaxRPM": 550
}

Path Order

Parameters

Field Required? Optional Description
Job
String		 no If Job is not supplied then an auto generated job value is created For the Render action, if Job is supplied all other parameters will be ignored and an existing Job will be rendered
CustomerOrderNumber
String		 no
OrderType
String		 yes OrderType for Path Orders is
path
paths
Object		 yes paths
colors
List		 yes List of PathObjects.Color types
colors
strokes
List		 yes List of Integers
strokes
codes
List		 yes List of Strings
codes		 
# GET

https://pulsemicro.com/PulseID/api/Orders/RenderPathOrder
{  
   "paths":"[[[\"M\",190.1509218550812,129.14954351615134],[\"Q\",190.1509218550812,129.14954351615134,190.6509218550812,129.14954351615134],[\"Q\",191.1509218550812,129.14954351615134,191.40010606126998,129.14954351615134],[\"Q\",191.64929026745872,129.14954351615134,192.14847447364747,129.64828672004558],[\"Q\",192.6476586798362,130.1470299239398,193.64602709221373,131.64325953562252],[\"Q\",194.64439550459122,133.13948914730523,196.64113232934622,133.63823235119946],[\"Q\",198.63786915410122,134.1369755550937,201.13379018504497,136.13194837067064],[\"Q\",203.62971121598872,138.12692118624759,206.62481645312124,139.6231507979303],[\"Q\",209.61992169025373,141.119380409613,212.61502692738622,144.1118396329784],[\"Q\",215.61013216451872,147.1042988563438,219.10442160783998,149.09927167192075],[\"Q\",222.59871105116122,151.0942444874977,226.09300049448248,153.08921730307463],[\"Q\",229.58728993780375,155.08419011865158,232.0832109687475,157.07916293422852],[\"Q\",234.57913199969124,159.07413574980546,238.57260564920125,162.06659497317088],[\"Q\",242.56607929871123,165.05905419653627,246.0603687420325,168.55025662379592],[\"Q\",249.55465818535373,172.04145905105557,254.04731604105248,176.5301478861037],[\"Q\",258.53997389675123,181.01883672115179,264.0310001648275,184.0112959445172],[\"Q\",269.5220264329038,187.00375516788262,273.5155000824137,189.99621439124803],[\"Q\",277.50897373192373,192.98867361461345,280.0048947628675,194.9836464301904],[\"Q\",282.5008157938112,196.9786192457673,285.49592103094375,198.97359206134425],[\"Q\",288.49102626807627,200.9685648769212,289.9885788866425,202.96353769249814],[\"Q\",291.48613150520873,204.95851050807508,292.983684123775,206.4547401197578],[\"Q\",294.48123674234125,207.9509697314405,295.9787893609075,208.94845613922897],[\"Q\",297.4763419794738,209.94594254701744,297.4763419794738,210.9434289548059],[\"Q\",297.4763419794738,211.94091536259438,297.9755261856625,211.94091536259438],[\"Q\",298.47471039185126,211.94091536259438,298.47471039185126,211.94091536259438],[\"L\",298.47471039185126,211.94091536259438]]]",
   "colors":[  
      {  
         "R":"0",
         "G":"87",
         "B":"150"
      }
   ],
   "strokes":[  
      5
   ],
   "codes":[  
      "1076"
   ]
}

# POST

https://pulsemicro.com/PulseID/api/Orders/SubmitPathOrder
{  
   "paths":"[[[\"M\",190.1509218550812,129.14954351615134],[\"Q\",190.1509218550812,129.14954351615134,190.6509218550812,129.14954351615134],[\"Q\",191.1509218550812,129.14954351615134,191.40010606126998,129.14954351615134],[\"Q\",191.64929026745872,129.14954351615134,192.14847447364747,129.64828672004558],[\"Q\",192.6476586798362,130.1470299239398,193.64602709221373,131.64325953562252],[\"Q\",194.64439550459122,133.13948914730523,196.64113232934622,133.63823235119946],[\"Q\",198.63786915410122,134.1369755550937,201.13379018504497,136.13194837067064],[\"Q\",203.62971121598872,138.12692118624759,206.62481645312124,139.6231507979303],[\"Q\",209.61992169025373,141.119380409613,212.61502692738622,144.1118396329784],[\"Q\",215.61013216451872,147.1042988563438,219.10442160783998,149.09927167192075],[\"Q\",222.59871105116122,151.0942444874977,226.09300049448248,153.08921730307463],[\"Q\",229.58728993780375,155.08419011865158,232.0832109687475,157.07916293422852],[\"Q\",234.57913199969124,159.07413574980546,238.57260564920125,162.06659497317088],[\"Q\",242.56607929871123,165.05905419653627,246.0603687420325,168.55025662379592],[\"Q\",249.55465818535373,172.04145905105557,254.04731604105248,176.5301478861037],[\"Q\",258.53997389675123,181.01883672115179,264.0310001648275,184.0112959445172],[\"Q\",269.5220264329038,187.00375516788262,273.5155000824137,189.99621439124803],[\"Q\",277.50897373192373,192.98867361461345,280.0048947628675,194.9836464301904],[\"Q\",282.5008157938112,196.9786192457673,285.49592103094375,198.97359206134425],[\"Q\",288.49102626807627,200.9685648769212,289.9885788866425,202.96353769249814],[\"Q\",291.48613150520873,204.95851050807508,292.983684123775,206.4547401197578],[\"Q\",294.48123674234125,207.9509697314405,295.9787893609075,208.94845613922897],[\"Q\",297.4763419794738,209.94594254701744,297.4763419794738,210.9434289548059],[\"Q\",297.4763419794738,211.94091536259438,297.9755261856625,211.94091536259438],[\"Q\",298.47471039185126,211.94091536259438,298.47471039185126,211.94091536259438],[\"L\",298.47471039185126,211.94091536259438]]]",
   "colors":[  
      {  
         "R":"0",
         "G":"87",
         "B":"150"
      }
   ],
   "strokes":[  
      5
   ],
   "codes":[  
      "1076"
   ]
}

Print Template

Parameters

Field Required? Optional Description
Job
String		 no If Job is not supplied then an auto generated job value is created For the Render action, if Job is supplied all other parameters will be ignored and an existing Job will be rendered
CustomerOrderNumber
String		 no
OrderType
String		 yes OrderType for Print Template is
print-template
ProductCode
String		 yes
TemplateCode
String		 yes See TemplateFile below
TemplateFile
String		 conditional If TemplateFile is supplied TemplateFile will be used instead of TemplateCode
OutputFile
String		 no Additional output file will be created in specified location
PrimaryColour
String		 no Replace primary colour with the specified colour in the output design. See TextColour below in Personalizations
SecondaryColour
String		 no Replace secondary colour with the specified colour in the output design. See TextColour below in Personalizations
TemplateColourOverride
String		 no Can be a single colour or a comma separated list of colours
LocationJustification
String		 no Available justification types are
top-left center-left bottom-left top-center center-center bottom-center top-right center-right bottom-right center
OutputType
String		 no Default is a png image of the requested render action Available OutputType for Render action are
image - returns a png image of the render action
base64 - returns the base64 string representation of the render action
ImageHeight
Int		 no Height in pixels of the resulting image. Default is 1000.
ImageWidth
Int		 no Width in pixels of the resulting image. Default is 1000.
DPI
Int		 no DPI value to use when generating the image. Ignored if ImageWidth and ImageHeight are specified.
Personalizations
Object		 conditional If Style is supplied Personalizations are Required if Design is not supplied Personalization Parameters

Personalization Parameters

Field Required? Optional Description
ElementName
String		 yes
IsText
Bool		 yes The IsText field is required for template orders. Determines if the text specified is for a text element or to replace a design element
Text
String		 conditional When the IsText property is set to false then Text determines the design to replace in a design element Template orders can have blank text, other order types cannot
FillColour
String		 conditional Requires the IsText property set to true or false Looks up the colour by name from the db to set the fill. If no fill exists on the text object then it creates a solid fill based on the fill colour passed. If the value is false, then it will set the fill colour of non text elements for the ElementName.
StrokeColour
String		 conditional Requires the IsText property set to true or false Looks up the colour by name from the db to set the stroke. If a stroke is not found on the text object then it creates a solid stroke based on the stroke colour passed. If the value is false, then it will set the stroke width of non text elements for the ElementName. Default is 2.
StrokeWidth
String		 conditional Requires the IsText property set to true or false and the StrokeColour has a value Allow setting the width of the stroke for text if the IsText property is true. If the value is false, then it will set the stroke width of non text elements for the ElementName. Default is 2. Units are in points.
TextColour
String		 no Sets the text objects colour to the value set from looking up the colour by name from the db
FontOverride
String		 no
Design
String		 conditional Can be used instead of Text property for design replacement Used to replace a design element in a Template and when the IsText property is set to false
FitDesign
String		 no Overrides the Setting in the configuration in Admin for Fit Design Available FitDesign options design replacement are
none - will not scale and center design in replace element
small - if the design being replaced is smaller than the replace element then the design will scale up
large - if the design being replaced is larger than the replace element then the design will scale down
all - will scale all designs being replaced to fit the replace element regardless of size
HideFillColour
Bool		 no The HideFillColour field is optional for template orders to hide the specified template element's fill colour.
HideStrokeColour
Bool		 no The HideStrokeColour field is optional for template orders to hide the specified template element's stroke colour.

Sample Render and Submit calls

# GET
https://pulsemicro.com/PulseID/api/Orders/Render?OrderType=print-template&ProductCode=product2&TemplateCode=MNF12&Personalizations[0].ElementName=ItemID&Personalizations[0].Text=Pulse1&Personalizations[0].IsText=true&Personalizations[1].ElementName=Logo&Personalizations[1].Text=NHL0222ADU_MidnightMascot&Personalizations[1].IsText=false&Personalizations[1].Design=NHL0222ADU_MidnightMascot

# POST
https://pulsemicro.com/PulseID/api/Orders/Submit?Job=TestJob&OrderType=print-template&ProductCode=product2&TemplateCode=MNF12&Personalizations[0].ElementName=ItemID&Personalizations[0].Text=Pulse1&Personalizations[0].IsText=true&Personalizations[1].ElementName=Logo&Personalizations[1].Text=NHL0222ADU_MidnightMascot&Personalizations[1].IsText=false&Personalizations[1].Design=NHL0222ADU_MidnightMascot

https://pulsemicro.com/PulseID/api/Orders/Submit
{
  "OrderType": "print-template",
  "ProductCode": "product2",
  "TemplateCode": "MNF12",
      "Personalizations": [{
          "ElementName": "ItemID",
          "Text": "Pulse1",
          "IsText": "true"
      },
          "ElementName": "Logo",
          "Text": "NHL0222ADU_MidnightMascot",
          "IsText": "false",
          "Design": "NHL0222ADU_MidnightMascot"
      }
  ],
}

Laser Engraving Template

Parameters

Field Required? Optional Description
Job
String		 no If Job is not supplied then an auto generated job value is created For the Render action, if Job is supplied all other parameters will be ignored and an existing Job will be rendered
CustomerOrderNumber
String		 no
OrderType
String		 yes OrderType for Laser Engraving Template is
laser-engraving-template
ProductCode
String		 yes
TemplateCode
String		 yes See TemplateFile below
TemplateFile
String		 conditional If TemplateFile is supplied TemplateFile will be used instead of TemplateCode
OutputFile
String		 no Additional output file will be created in specified location
PrimaryColour
String		 no Replace primary colour with the specified colour in the output design. See TextColour below in Personalizations
SecondaryColour
String		 no Replace secondary colour with the specified colour in the output design. See TextColour below in Personalizations
TemplateColourOverride
String		 no Can be a single colour or a comma separated list of colours
OutputType
String		 no Default is a png image of the requested render action Available OutputType for Render action are
image - returns a png image of the render action
base64 - returns the base64 string representation of the render action
Personalizations
Object		 conditional If Style is supplied Personalizations are Required if Design is not supplied Personalization Parameters

Personalization Parameters

Field Required? Optional Description
ElementName
String		 yes
IsText
Bool		 yes The IsText field is required for template orders. Determines if the text specified is for a text element or to replace a design element
Text
String		 conditional When the IsText property is set to false then Text determines the design to replace in a design element Template orders can have blank text, other order types cannot
FillColour
String		 conditional Requires the IsText property set to true Looks up the colour by name from the db to set the fill. If no fill exists on the text object then it creates a solid fill based on the fill colour passed
StrokeColour
String		 conditional Requires the IsText property set to true Looks up the colour by name from the db to set the stroke. If a stroke is not found on the text object then it creates a solid stroke based on the stroke colour passed
TextColour
String		 no Sets the text objects colour to the value set from looking up the colour by name from the db
FontOverride
String		 no
Design
String		 conditional Can be used instead of Text property for design replacement Used to replace a design element in a Template and when the IsText property is set to false
FitDesign
String		 no Overrides the Setting in the configuration in Admin for Fit Design Available FitDesign options design replacement are
none - will not scale and center design in replace element
small - if the design being replaced is smaller than the replace element then the design will scale up
large - if the design being replaced is larger than the replace element then the design will scale down
all - will scale all designs being replaced to fit the replace element regardless of size
HeightOverride
String		 no
Alignment
String		 no Available Alignment options
Left
Right
Center
Case
String		 no Available Alignment options
Std
Upper
SmallUpper
Lower
FirstUpper
VerticalSpacing
String		 no
ItalicAngle
String		 no

Sample Render and Submit calls

# GET
https://pulsemicro.com/PulseID/api/Orders/Render?OrderType=laser-engraving-template&ProductCode=product2&TemplateCode=MNF12&Personalizations[0].ElementName=ItemID&Personalizations[0].Text=Pulse1&Personalizations[0].IsText=true&Personalizations[1].ElementName=Logo&Personalizations[1].Text=NHL0222ADU_MidnightMascot&Personalizations[1].IsText=false&Personalizations[1].Design=NHL0222ADU_MidnightMascot

# POST
https://pulsemicro.com/PulseID/api/Orders/Submit?Job=TestJob&OrderType=laser-engraving-template&ProductCode=product2&TemplateCode=MNF12&Personalizations[0].ElementName=ItemID&Personalizations[0].Text=Pulse1&Personalizations[0].IsText=true&Personalizations[1].ElementName=Logo&Personalizations[1].Text=NHL0222ADU_MidnightMascot&Personalizations[1].IsText=false&Personalizations[1].Design=NHL0222ADU_MidnightMascot

https://pulsemicro.com/PulseID/api/Orders/Submit
{
  "OrderType": "laser-engraving-template",
  "ProductCode": "product2",
  "TemplateCode": "MNF12",
      "Personalizations": [{
          "ElementName": "ItemID",
          "Text": "Pulse1",
          "IsText": "true"
      },
          "ElementName": "Logo",
          "Text": "NHL0222ADU_MidnightMascot",
          "IsText": "false",
          "Design": "NHL0222ADU_MidnightMascot"
      }
  ],
}

Rotary Engraving Template

Parameters

Field Required? Optional Description
Job
String		 no If Job is not supplied then an auto generated job value is created For the Render action, if Job is supplied all other parameters will be ignored and an existing Job will be rendered
CustomerOrderNumber
String		 no
OrderType
String		 yes OrderType for Rotary Engraving Template is
rotary-engraving-template
ProductCode
String		 yes
TemplateCode
String		 yes See TemplateFile below
TemplateFile
String		 conditional If TemplateFile is supplied TemplateFile will be used instead of TemplateCode
OutputFile
String		 no Additional output file will be created in specified location
PrimaryColour
String		 no Replace primary colour with the specified colour in the output design. See TextColour below in Personalizations
SecondaryColour
String		 no Replace secondary colour with the specified colour in the output design. See TextColour below in Personalizations
TemplateColourOverride
String		 no Can be a single colour or a comma separated list of colours
OutputType
String		 no Default is a png image of the requested render action Available OutputType for Render action are
image - returns a png image of the render action
base64 - returns the base64 string representation of the render action
Personalizations
Object		 conditional If Style is supplied Personalizations are Required if Design is not supplied Personalization Parameters
ScaleToFit
Bool		 no
BackgroundColor
String		 no

Personalization Parameters

Field Required? Optional Description
ElementName
String		 yes
IsText
Bool		 yes The IsText field is required for template orders. Determines if the text specified is for a text element or to replace a design element
Text
String		 conditional When the IsText property is set to false then Text determines the design to replace in a design element Template orders can have blank text, other order types cannot
FillColour
String		 conditional Requires the IsText property set to true Looks up the colour by name from the db to set the fill. If no fill exists on the text object then it creates a solid fill based on the fill colour passed
StrokeColour
String		 conditional Requires the IsText property set to true Looks up the colour by name from the db to set the stroke. If a stroke is not found on the text object then it creates a solid stroke based on the stroke colour passed
TextColour
String		 no Sets the text objects colour to the value set from looking up the colour by name from the db
FontOverride
String		 no
Design
String		 conditional Can be used instead of Text property for design replacement Used to replace a design element in a Template and when the IsText property is set to false
FitDesign
String		 no Overrides the Setting in the configuration in Admin for Fit Design Available FitDesign options design replacement are
none - will not scale and center design in replace element
small - if the design being replaced is smaller than the replace element then the design will scale up
large - if the design being replaced is larger than the replace element then the design will scale down
all - will scale all designs being replaced to fit the replace element regardless of size
HeightOverride
String		 no
Alignment
String		 no Available Alignment options
Left
Right
Center
Case
String		 no Available Alignment options
Std
Upper
SmallUpper
Lower
FirstUpper
VerticalSpacing
String		 no
ItalicAngle
String		 no
HatchType
Integer		 no The hatching type. Fill, Engrave and none. If none is selected no hatching will be applied and all the hatch values will be ignored
HatchDensity
Double		 no The density of fill hatching. Used only for Fill hatching. (Range: 0 - 1)
HatchAngle
Double		 no Angle of hatching. (Range: 0 - 359)
HatchStrokeWidth
Double		 no The hatching stroke width. Used only for Fill hatching
HatchToolDiameter
Double		 no The diameter of hatching engraving tool. Used only for engrave hatching. (Units: Points)
HatchOffset
Double		 no Offset by which the hatching will start. Used only for engrave hatching. (Units: Points)
HatchPassWidth
Double		 no A measure of determing the overlap area when engraving. If pass width is equal to 0.8 then 20% overlapping will exist. Used only for engrave hatching. (Range: 0.1 - 1) (Units: Points)
HatchConnectSegmThres
Double		 no A thresshold for connecting lines. Used only for engrave hatching

Sample Render and Submit calls

# GET
https://pulsemicro.com/PulseID/api/Orders/Render?OrderType=rotary-engraving-template&ProductCode=product2&TemplateCode=MNF12&Personalizations[0].ElementName=ItemID&Personalizations[0].Text=Pulse1&Personalizations[0].IsText=true&Personalizations[1].ElementName=Logo&Personalizations[1].Text=NHL0222ADU_MidnightMascot&Personalizations[1].IsText=false&Personalizations[1].Design=NHL0222ADU_MidnightMascot

# POST
https://pulsemicro.com/PulseID/api/Orders/Submit?Job=TestJob&OrderType=rotary-engraving-template&ProductCode=product2&TemplateCode=MNF12&Personalizations[0].ElementName=ItemID&Personalizations[0].Text=Pulse1&Personalizations[0].IsText=true&Personalizations[1].ElementName=Logo&Personalizations[1].Text=NHL0222ADU_MidnightMascot&Personalizations[1].IsText=false&Personalizations[1].Design=NHL0222ADU_MidnightMascot

https://pulsemicro.com/PulseID/api/Orders/Submit
{
  "OrderType": "rotary-engraving-template",
  "ProductCode": "product2",
  "TemplateCode": "MNF12",
      "Personalizations": [{
          "ElementName": "ItemID",
          "Text": "Pulse1",
          "IsText": "true"
      },
          "ElementName": "Logo",
          "Text": "NHL0222ADU_MidnightMascot",
          "IsText": "false",
          "Design": "NHL0222ADU_MidnightMascot"
      }
  ],
}

Print Design

Parameters

Field Required? Optional Description
Job
String		 no Can be an empty string or omitted
CustomerOrderNumber
String		 no
OrderType
String		 yes OrderType for Print Design is
print-design
Input
String		 conditional If File parameter is not used then Input is required Full path to Input file that will be used to generate Output file
Output
String		 conditional If File parameter is not used then Output is required Full path where Output file will be created in specified location
FileFormat
String		 conditional If Input and Output are not specified or if File is a base64 string, FileFormat is required. Optional for the File parameter. Current supported file formats are png jpg jpeg
File
String		 conditional Required if Input and Output are not specified. If the source of the File parameter is a URL the API will attempt to download the file. If it is not a URL then the required format is a base64 string version of the file and the FileFormat parameter is required.
Quantity
Integer		 no Used to let operators know how many of the order should be printed
CustomerName
String		 no Customer Name
CustomerAddress
String		 no Customer Address
Size
String		 no The Size associated with the Product.
Color
String		 no The Color associated with the Product.
ProductPreviewURL
String		 no A preview image of the graphic on the product as part of the order.
ProductLocation
String		 no The location where the final graphic will be printed on the product. Configured in Products in the Locations section.
City
String		 no City
State
String		 no State
ShippingMethod
String		 no Shipping Method
PostalCode
String		 no Postal Code
CustomerTelNumber
String		 no Customer Telephone Number
CustomerEmail
String		 no Customer Email
PreTreatmentCode
String		 no PreTreatmentCode

Sample Submit calls

# POST
https://pulsemicro.com/PulseID/api/Orders/Submit?Job=&ProductCode=Pulse&OrderType=print-template&TemplateCode=TemplateOne&Personalizations[0].Text=Pulse&Personalizations[0].TextColour=Blue

https://pulsemicro.com/PulseID/api/Orders/Submit
{
  "Job": "ABCDEF",
  "OrderType": "print-design",
  "Input": "c:\\PulseID\\Data\\PulseID\\Templates\\355.DST",
  "Output": "c:\\PulseID\\Data\\PulseID\\Output\\355.PCF",
  "CustomerOrderNumber": "Optional Customer Information",
  "FileFormat": "png",
  "Quantity": 100,
  "CustomerName": "customer name",
  "CustomerAddress": "customer address",
  "Color": "Blue",
  "Size": "Large or L"
  "ProductPreviewURL": "https://www.dropbox.com/s/abcxyz/sampleproductpreview.png?dl=1",
  "ProductLocation": "Front"
}
With optional File Parameter
{
  "Job": "123456",
  "OrderType": "print-design",
  "File": "https://www.dropbox.com/s/abcxyz/sampleimage.png?dl=1",
  "CustomerOrderNumber": "Optional Customer Information",
  "FileFormat": "png",
  "PiecesOrdered": 100,
  "CustomerName": "customer name",
  "CustomerAddress": "customer address",
  "Color": "Blue",
  "Size": "Large or L"
  "ProductPreviewURL": "https://www.dropbox.com/s/abcxyz/sampleproductpreview.png?dl=1",
  "ProductLocation": "Front"
  "City": "Toronto"
  "State": "Ontario"
  "ShippingMethod": "Fedex"
  "PostalCode": "N4X2J4"
  "CustomerTelNumber": "999-999-9999"
  "CustomerEmail": "abc@mail.com"
  "PreTreatmentCode": "Code1"
}

DTF/Wide Format

Parameters

Field Required? Optional Description
OrderType
String		 yes OrderType for DTF/Wide Format is
print-design
ProductCode
String		 yes
File
String		 yes The required format is a base64 string
Source
Integer		 yes Source For DTF/Wide Format is wideformatapi
Job
String		 no If Job is not supplied then an auto generated job value is created
Quantity
Integer		 no Used to let operators know how many of the order should be printed

Sample Submit calls

# POST

https://pulsemicro.com/PulseID/api/Orders/Submit
{
  "OrderType": "print-design",
  "ProductCode": "wide1",
  "File": "iVBORw0KGgoAAAANSUhEUgAAAAYAAAAGCAYAAADgzO9IAAAAGXRFWHRTb2Z0d2FyZQBBZG9iZSBJbWFnZVJlYWR5ccllPAAAACdJREFUeNpi+f//fwwDFGzZsgXGZGBiwAFwSrAga/fx8aHAKIAAAwDkiwiGLAwjOQAAAABJRU5ErkJggg==",
  "Source": "wideformatapi"
}
With optional File Parameter
{
  "OrderType": "print-design",
  "ProductCode": "wide1",
  "File": "iVBORw0KGgoAAAANSUhEUgAAAAYAAAAGCAYAAADgzO9IAAAAGXRFWHRTb2Z0d2FyZQBBZG9iZSBJbWFnZVJlYWR5ccllPAAAACdJREFUeNpi+f//fwwDFGzZsgXGZGBiwAFwSrAga/fx8aHAKIAAAwDkiwiGLAwjOQAAAABJRU5ErkJggg==",
  "Source": "wideformatapi"
  "Job": "ABCDEF",
  "CustomerOrderNumber": "12345678",
  "Quantity": 1,
}