Attributes by Order Type

Sample API Calls

Common Attributes for All Types

Attributes

Field Required? Default Value Description
Name
String		 yes
Code
String		 yes
SKU
String		 no
Description
String		 no
OrderType
String		 yes One or more comma separated types
MaxWidth
Double		 no 5
MaxHeight
Double		 no 3
Disabled
Bool		 no false
LasFileName
String		 no It is a filename used for laser engraving, should be one of existing files inside configured LasFilesFolder.
DesignerMode
String		 no Available Designer Modes are:
"Basic" "Advanced"
ProductionInfo
String		 no
Instructions
String		 no Instructions used in the Designer to inform the customer what they should do.
SpecialInstructions
String		 no
AlertSpecialInstructions
Bool		 no false
ProductSetUpImage
String		 no It is a filename, should be one of existing image files inside configured InputProductsFolder.
It represents an image shown to the operator to assist placement of the product in the machine.
RotationAngle
Double		 no 0 Rotates the final production/output file.
PreviewRotationAngle
Double		 no Rotates the product preview for the Designer and the station product preview for Gravotech orders.
ProductCategoryName
String		 no On Create or Update this set the product's category only if there is an existing Product (sub) category on the database with that name. To empty on update, set to "".
Keywords
List		 no List of strings. On update, if provided, it fully overrides the existing keywords if any; to empty set to an empty array ([]).
AvailableTemplates
List		 no List of strings, template names. On create or update, only matching template names in the database are inserted. On update, if provided, it fully overrides the existing available templates if any; to empty set to an empty array ([]).
IsAllTemplates
Bool		 no false On create or update, if true, available templates are emptied.
AvailableStyles
List		 no List of strings, style names. On create or update, only matching style names in the database are inserted. On update, if provided, it fully overrides the existing available styles if any; to empty set to an empty array ([]).
IsAllStyles
Bool		 no false On create or update, if true, available styles are emptied.
DefaultTemplateName
String		 no On create or update, only an existing in the database template is set, should be one of the available ones. To empty on update, set to "".
DefaultStyleName
String		 no On create or update, only an existing in the database style is set, should be one of the available ones. To empty on update, set to "".
TemplateColourOverrideName
String		 no On create or update, only an existing in the database colour is set. To empty on update, set to "".
If set, the colour is applied to text and shapes of a template placed on this product. Useful if the product is dark and the template needs to be more legible.
ProductSizes
String		 no Comma separated size names. On create or update only matching size names in the database are set. To empty, set to "" or null.
ConfiguredColorsAndProfiles
List		 no List of Product Configured Colors And Profiles Objects. On update, if provided, it fully overrides the existing views and locations if any; to empty set to an empty array ([]).
LocationGroups
List		 no List of Location Group Objects. On update, if provided, it fully overrides the existing views and locations if any; to empty set to an empty array ([]).


Product Configured Colors And Profiles Attributes

Field Required? Default Value Description
Color
String		 yes On create or update, the record is created only if there is an existing Colour with that name in the database.
ColorProfile
String		 no On create or update, this is set only if there is an existing Color Profile with that name in the database.


Location Group (or View) Attributes

Field Required? Default Value Description
Name
String		 yes On create, if not provided a generated value is given.
IsRequired
Bool		 yes false
URL
String		 no Use this on create or update to set the view image. Should be a valid url to an image, accepting png, bmp or jpeg.
Locations
List		 no List of Location Objects.
ImageName
String		 no This is meaningful only when getting product info. If not empty, it is a filename to the view image existing inside configured InputProductsFolder.


Location Attributes

Field Required? Default Value Description
LocationName
String		 yes
Width
Double		 no 0
Height
Double		 no 0
X
Double		 no 0
Y
Double		 no 0
Alignment
String		 no Available Alignments are: "top-left", "center-left", "bottom-left", "top-center", "center-center", "bottom-center", "top-right", "center-right", "bottom-right".
ScalingRules
String		 no Available Scaling Rules are: "Always Scales", "Scale If Larger", "Scale If Smaller", "Never Scale".
ScalingMethod
String		 no Available Scaling Methods are: "Proportional", "Stretch".
DPI
Double		 no 0 Represents dots per inches for both x and y axis.
AvailableTemplates
List		 no List of strings: templates names. On create or update, only matching template names in the database are inserted.
DefaultTemplateName
String		 no On create or update, only an existing in the database template is set, should be one of the available ones.
RotationAngle
Double		 no This overrides the product's rotation angle if any.
PreviewRotationAngle
Double		 no This overrides the product's preview rotation angle if any.
OffsetX
Double		 no
OffsetY
Double		 no
CenteredX
Bool		 no
MaxStitchCount
Double		 no
PricingSKU
String		 no
ProductLocationsOffsetsSizes
List		 no List of Location Offsets Objects. This should contain values when the product has configured sizes.


Location Offsets Attributes

Field Required? Default Value Description
ProductSizeName
String		 yes On create or update, this should be an existing size name in the database, configured on product available sizes. If no database size is matched the record is ignored.
SOffsetX
Double		 no
SOffsetY
Double		 no
SCenteredX
Bool		 no false


Embroidery Attributes

Attributes

Field Required? Default Value Description
Recipe
String		 no "Normal" This should be one of existing DG embroidery Styles.
RenderingRecipe
String		 no This should be one of existing DG embroidery Styles.
StartLocation
String		 no "use from template" Available Strt/Stop Locations are: "first-stitch", "last-stitch", "top-left", "top-centre", "top-right", "middle-left", "centre", "middle-right", "bottom-left", "bottom-centre", "bottom-right", "use from template".
StopLocation
String		 no "use from template" Available Strt/Stop Locations are: "first-stitch", "last-stitch", "top-left", "top-centre", "top-right", "middle-left", "centre", "middle-right", "bottom-left", "bottom-centre", "bottom-right", "use from template".
Rpm
Int		 no
OriginX
Double		 no
OriginY
Double		 no
RenderingMachineFormat
String		 no This should be one of existing DG embroidery Machine Formats.
BeforeSewingMessage
String		 no Message on the embroidery machine panel when a design is loaded
AfterSewingMessage
String		 no Message on the embroidery machine panel when a design has completed sewing


Print Attributes

Attributes

Field Required? Default Value Description
PrinterProfileXml
String		 no This is a Colour Profile name. On create or update, this should be an existing in the database Colour Profile Name. To empty on update, set to "" or null.
ImageOffsetX
Double		 no
ImageOffsetY
Double		 no
ImageCenteredX
Bool		 no false
PretreatmentCodeName
String		 no On create or update, only an existing in the database Pre Treatment Code is set.


Print Design Attributes

Attributes

Field Required? Default Value Description
FrameName
String		 no On create or update, only an existing in the databaseonly Frame(Media) is set. To empty on update, set to "".
Orientation
String		 no "portrait" Available Orientations are: "landscape", "portrait".
Duplicate
Bool		 no


Laser Engraving Attributes

Attributes

Field Required? Default Value Description
PlateXOrigin
Double		 no 0
PlateYOrigin
Double		 no 0
LaserPlateOrientation
String		 no "Direct_Engraving_OnTop_0" Available Laser Plate Orientations are: "Direct_Engraving_OnTop_0", "Direct_Engraving_OnTop_90", "Direct_Engraving_OnTop_180", "Direct_Engraving_OnTop_270", "Direct_Engraving_OnBack_0", "Direct_Engraving_OnBack_90", "Direct_Engraving_OnBack_180", "Direct_Engraving_OnBack_270".
Cylinder
Bool		 no false
LaserCylinderDiameter
Double		 no 0
ZClearance
Bool		 no false
ZClearanceValue
Double		 no 0
Exhaust
Bool		 no false
ExhaustExtraTime
Double		 no 0 This should range between between 0 and 10000 sec.
Dpi
Int		 no
Galvo Settings
RestrictedZoneOnOff
String		 no This should be set to: "On" or "Off".
CylinderName
String		 no Available Cylinder Names are: "TC1", "TC2", "RD1", "RD2", "RDM", "RDJewel".
DefocusingThreshold
Double		 no 0 This should range between between 0 and 65.
FinalWobblingDiameter
Double		 no 0 This should range between between 0 and 65.
NumberOfRepeats
Double		 no 0 This should range between between 0 and 100.
LSolution settigns
QuickProcessing
String		 no "Off" This should be set to: "On" or "Off".
BlackWhiteMode
String		 no "Off" This should be set to: "On" or "Off".
Wood
String		 no "Off" This should be set to: "On" or "Off".
Stamp
String		 no "Off" This should be set to: "On" or "Off".
StampShoulderInflexionPointHeight
Double		 no 0
StampShoulderTotalLength
Double		 no 0 This should range between between 0 and 10.
StampShoulderInflexionPointLength
Double		 no 0 This should range between between 0 and 10.
Advanced settigns
PhotoMode
String		 no "Off" This should be set to: "On" or "Off".
AutoMode
String		 no "Off" This should be set to: "On" or "Off".
GreyScaleMode
String		 no "Off" This should be set to: "On" or "Off".
FrameMode
String		 no "Off" This should be set to: "On" or "Off".
Negative
String		 no "Off" This should be set to: "On" or "Off".
DarkLightValue
Double		 no 50 This should range between 0 and 100.


Gravotech Laser Engraving Attributes

Attributes

Field Required? Default Value Description
LaserColorSetup
Object		 no A Laser Color Setup object. On update, if provided it fully overrides the existing if any.


Laser Color Setup Attributes

Field Required? Default Value Description
LaserColorName
String		 yes This should be an existing in the database Colour name. On create, if empty no Laser Color Setup is created for the product. On update, if empty no Laser Color Setup is created for the product, and any existing is removed.
LaserColors
List		 no List of Laser Color Objects.


Laser Color Attributes

Field Required? Default Value Description
Name
String		 yes Available Color Names are: "Black", "Red", "Green", "Yellow", "Blue", "Magenta", "Cyan", "Orange".
SpotColour
String		 yes
MarkingMode
String		 yes Available Marking Modes are: "Raster", "Vector", "Dot", "None", "Raster/Vector", "Raster/Dot".
Power
String		 yes "0" This should be a number.
Speed
String		 yes "1" This should be a number.
SpeedLSolution
String		 yes "1" This should be a number.
PassesNumber
Int		 no 1 This should range between 1 and 100.
RefocusingValue
Double		 no 0 This should range between -50 and 50.
Refocusing
String		 no Available Refocusing values are: "Before", "After".
AirAssitance
String		 no This should be set to : "On" or "Off".
RefocusingValue
Double		 no 5000 This should range between 5000 and 200000.
InitialFocal
Double		 no 0 This should range between -1000.0 and 1000.0.
FinalFocal
Double		 no 0 This should range between -1000.0 and 1000.0.
WobblingDiameter
Double		 no 0.01 This should range between 0.01 and 65.0.
WobblingDistance
Double		 no 0.01 This should range between 0.01 and 65.0.


Gravotech Rotary Engraving Attributes

Attributes

Field Required? Default Value Description
NumberOfPasses
Int		 no 1 This should range between 1 and 4.
SpindleMotor
Bool		 no false
RotaryPlateOrientation
Int		 no 0 ("Orientation0") (if a wrong string value is provided it also falls back to 0) Available Rotary Plate Orientaions are: "Orientation0" or 0, "Orientation90" or 5, "Orientation180" or 3, "Orientation270" or 6.
Zauto
Int		 no 0 ("WithoutZauto") Available Zauto values are: "WithoutZauto" or 0, "ZautoWithSpindle" or 1, "ZautoWithDiamond" or 2.
ZStroke
Double		 no Distance between the tool and the material during a raised tool movement (in).
ZRefEnable
Bool		 no false
ZRef
Double		 no Distance between the upper position of the tool and the material (in).
CylindricalAttachment
String		 no Available Cylindrical Attachments are: "TS10o20", "TC50_41o200", "TC38o110", "TC100o350", "TC38o146", "TC38o230", "TC1o30", "TC1o146", "TC10o24spaceIn", "TC10o27spaceOut", "TC10o80spaceIn", "TC10o80spaceOut", "TC10o27spaceInspaceBlack".
ProductXOffsetAdjustment
Double		 no 0
ProductYOffsetAdjustment
Double		 no 0
XySpeedPass1
Int		 no
ZspeedPass1
Int		 no
DepthPass1
Double		 no
DwellTimePass1
Int		 no
XySpeedPass2
Int		 no
ZspeedPass2
Int		 no
DepthPass2
Double		 no
DwellTimePass2
Int		 no
XySpeedPass3
Int		 no
ZspeedPass3
Int		 no
DepthPass3
Double		 no
DwellTimePass3
Int		 no
XySpeedPass4
Int		 no
ZspeedPass4
Int		 no
DepthPass4
Double		 no
DwellTimePass4
Int		 no


Sample API calls 

Sample Create Product API call
# POST

/api/Products/CreateProduct
{
    "Name": "test_product",
    "DesignerMode": "Basic",
    "OrderType":"print-template",
    "Code": "test_product",
    "SKU": "test_product",
    "MaxWidth": 15,
    "MaxHeight": 5,
    "Description": "test_product",
    "ProductCategoryName": "test",
    "TemplateColourOverrideName": "1078 - Paprika",
    "PretreatmentCodeName": "test2",
    "Keywords": ["keyword1", "keyword2"],
    "AvailableTemplates": [
        "deerTemplate"
    ],
    "AvailableStyles": [
        "testStyle1",
        "testStyle2"
    ],
    "DefaultTemplateName": null,
    "DefaultStyleName": "testStyle1",
    "LocationGroups": [
        {
            "Name": "test_product_View1",
            "URL": null,
            "Locations": [
                {
                    "LocationName": "view1_loc1",
                    "X": 10,
                    "Y": 10,
                    "OffsetX": 5,
                    "OffsetY": 5,
                    "CenteredX": true,
                    "DPI": 72,
                    "Alignment": "center-center"
                }
            ]
        }
    ]
}


Sample Patch Product API call
# PATCH

/api/Products/PatchProduct?productsku=test_product
{
    "ProductSizes": "S, M",
    "LocationGroups": [
        {
            "Name": "test_product_View1",
            "URL": null,
            "Locations": [
                {
                    "LocationName": "view1_loc1",
                    "X": 10,
                    "Y": 10,
                    "OffsetX": 5,
                    "OffsetY": 5,
                    "CenteredX": true,
                    "DPI": 72,
                    "Alignment": "center-center",
                    "ProductLocationsOffsetsSizes":[{
                            "ProductSizeName": "S",
                            "SOffsetX": 5,
                            "SOffsetY": 5,
                            "SCenteredX": true
                        },
                        {   "ProductSizeName": "M",
                            "SOffsetX": 6,
                            "SOffsetY": 6
                        }]
                }
            ]
        }
    ]
}