Dielines API | Dieline Template

Objects | dieline_template

type string

"dieline_template"

id string

Unique identifier for the template. For example : "becf-10319"

group object

Dieline templates are organised under "groups" such as "Food Boxes", "Tuck End Boxes".
Each group belongs to a "category".

There are 3 categories:
"Cartons"
"Corrugated Cardboards"
"Hard Cardboards"

Groups under "Cartons" are:
"Tuck End Boxes"
"Snap Lock Boxes"
"Tuck Top Auto Bottom Boxes"
"Tray Boxes"
"Standard Boxes"
"Special Boxes"
"Separators"
"Food Boxes"
"Carton Bags & Pillows"
"Shirt Boxes"
"Wrap Around Labels"
"Tags"
"Polygonal Boxes"
"Angled Boxes"
"Envelopes"
"Folders"

Groups under "Corrugated Cardboards" are
"Tuck End Boxes"
"Snap Lock Boxes"
"Tuck Top Auto Bottom Boxes"
"Tray Boxes"
"Standard Boxes"
"Special Boxes"
"Separators"

Groups under "Hard Cardboards" are
"Covered Solid Board Boxes"
"Boxes With Hinged Lid"
"Binders"
"Swatch Cards"
"Display materials"

Objects | group

type	dieline_template_group
id	Unique identifier for the group. For example "cartons_food_boxes"
name	Name of group. Possible values are: "Cartons" "Hard Cardboards" "Corrugated Cardboards"
category	the category that includes the group. possible values: "Cartons", "Hard Cardboards", "Corrugated Cardboards"

flap flap

Identifies the flap for the dieline template.

top_flap flap

Identifies the top_flap for the dieline template.

bottom_flap flap

Identifies the bottom_flap for the dieline template.

tuck tuck

Identifies the tuck for the dieline template.

top_tuck tuck

Identifies the top_tuck for the dieline template.

bottom_tuck tuck

Identifies the bottom_tuck for the dieline template.

dust_flap dust_flap

Identifies the dust_flap for the dieline template.

top_dust_flap dust_flap

Identifies the top_dust_flap for the dieline template.

bottom_dust_flap dust_flap

Identifies the bottom_dust_flap for the dieline template.

glue_flap glue_flap

Identifies the glue_flap for the dieline template.

cover cover

Identifies the cover for the dieline template.

hanger hanger

Identifies the hanger for the dieline template.

style style

Identifies the style for the dieline template. Styles are used to differentiate between similar templates.

tags [string]

These are the "tags" for the dieline template.
Possible values are
"hanger_tab"
"triangle_hanger_tab"
"circular_hanger_tab"
"postal_lock"
"top_postal_lock"
"bottom_postal_lock"
"thumb_cut"
"top_thumb_cut"
"bottom_thumb_cut"
"bottom_separator"
"bottom_separator_circle"
"bottom_separator_square"
"top_separator"
"top_separator_circle"
"top_separator_square"

variables [dieline_template_variable]

List of "dieline_template_variables".

Objects | dieline_template_variable

Every dieline_template supports a number of dieline_template_variables allowing customisation.

type string

"dieline_template_variable"

name string

Name of the variable
"a" , "b" , "c" , "dust_flap"

data_type string

Data type
"length" : They represent a lenght with a unit.
"integer" : They represent an integer.
"angle" : They represent an angle betwen "0" and "360"
"boolean" : They represent a boolean, "true" or "false"
"alignment" : They represent an alignment. .

There are 9 possible values each represented by an integer value.

TOP_LEFT = 2	TOP_CENTER = 12	TOP_RIGHT = 22
LEFT = 1	CENTER = 11	RIGHT = 21
BOTTOM_LEFT = 0	BOTTOM_CENTER = 10	BOTTOM_RIGHT = 20

required boolean

Set to true if variable is required to create a dieline.

default_value {value:, unit:}

Default value for the variable.
For example:
length => { "value": 5.23, "unit": "mm" }
integer => { "value": 4 }
boolean => { "value": true }
angle => { "value": 45 }

image object

Image for the dieline template variable.
For example:

{
  "type": "svg",
  "url": "https://d2atdwxjx7uc4i.cloudfront.net/api/drawing_option_svg_example.svg"
}

allowed_values object

Array of allowed values.
For example:

[
  true,
  false,
  0,
  1
]

children [dieline_template_variable]

"dieline_template_variables" can have children. This parent/child relationship between variables help grouping related variables together.
For example:

{
  "type": "dieline_template_variable",
  "name": "overflow",
  "description": "overflow",
  "data_type": "boolean",
  "required": false,
  "default_value": {
    "value": false
  },
  "childen": [
    {
      "type": "dieline_template_variable",
      "name": "overflow_margin",
      "description": "",
      "data_type": "length",
      "required": false,
      "default_value": {
        "value": "3",
        "unit": "mm"
      },
      "childen": [ ]
    }
  ]
}

links dieline_template_link

Links providing a way to navigate between dieline templates.

Objects | dieline_template_link

rel string

relationship identifier for the given link.
Possible values:
self
current dieline template

change_flap
identifies the link for the template when "flap" is changed. New value of the "flap" is given in the "name" attribute of the _link. For example :

{
   "rel": "change_flap",
   "name": "uni_tuck_flap",
   "href": "/dieline_templates/in/becf-10325",
   "method": "GET"
}

Possible "name" values: uni_tuck_flap, friction_fit_tuck_in_flap, chamfer_flap

change_top_flap
identifies the link for the template when "top_flap" is changed. New value of the "top_flap" is given in the "name" attribute of the _link. For example :

{
   "rel": "change_top_flap",
   "name": "uni_tuck_flap",
   "href": "/dieline_templates/in/becf-10325",
   "method": "GET"
}

Possible "name" values: uni_tuck_flap, friction_fit_tuck_in_flap, chamfer_flap

change_bottom_top_flap
identifies the link for the template when "bottom_top_flap" is changed. New value of the "bottom_top_flap" is given in the "name" attribute of the _link. For example :

{
   "rel": "change_bottom_top_flap",
   "name": "uni_tuck_flap",
   "href": "/dieline_templates/in/becf-10325",
   "method": "GET"
}

Possible "name" values: uni_tuck_flap, friction_fit_tuck_in_flap, chamfer_flap

change_dust_flap
identifies the link for the template when "dust_flap" is changed. New value of the "dust_flap" is given in the "name" attribute of the _link. For example :

{
   "rel": "change_dust_flap",
   "name": "slit_lock_dust_flap",
   "href": "/dieline_templates/in/becf-10325",
   "method": "GET"
}

Possible "name" values: slit_lock_dust_flap, full_angled_dust_flap, rounded_dust_flap

change_top_dust_flap
identifies the link for the template when "top_dust_flap" is changed. New value of the "top_dust_flap" is given in the "name" attribute of the _link. For example :

{
   "rel": "change_top_dust_flap",
   "name": "slit_lock_dust_flap",
   "href": "/dieline_templates/in/becf-10325",
   "method": "GET"
}

Possible "name" values: slit_lock_dust_flap, full_angled_dust_flap, rounded_dust_flap

change_bottom_dust_flap
identifies the link for the template when "bottom_dust_flap" is changed. New value of the "bottom_dust_flap" is given in the "name" attribute of the _link. For example :

{
   "rel": "change_bottom_dust_flap",
   "name": "slit_lock_dust_flap",
   "href": "/dieline_templates/in/becf-10325",
   "method": "GET"
}

Possible "name" values: slit_lock_dust_flap, full_angled_dust_flap, rounded_dust_flap

change_tuck
identifies the link for the template when "tuck" is changed. New value of the "tuck" is given in the "name" attribute of the _link. For example :

{
   "rel": "change_tuck",
   "name": "sit_lock_tuck",
   "href": "/dieline_templates/in/becf-10325",
   "method": "GET"
}

Possible "name" values: sit_lock_tuck, friction_fit_tuck

change_top_tuck
identifies the link for the template when "top_tuck" is changed. New value of the "top_tuck" is given in the "name" attribute of the _link. For example :

{
   "rel": "change_top_tuck",
   "name": "sit_lock_tuck",
   "href": "/dieline_templates/in/becf-10325",
   "method": "GET"
}

Possible "name" values: sit_lock_tuck, friction_fit_tuck

change_bottom_tuck
identifies the link for the template when "bottom_tuck" is changed. New value of the "bottom_tuck" is given in the "name" attribute of the _link. For example :

{
   "rel": "change_bottom_tuck",
   "name": "sit_lock_tuck",
   "href": "/dieline_templates/in/becf-10325",
   "method": "GET"
}

Possible "name" values: sit_lock_tuck, friction_fit_tuck

change_glue_flap
identifies the link for the template when "glue_flap" is changed. New value of the "glue_flap" is given in the "name" attribute of the _link. For example :

{
   "rel": "change_glue_flap",
   "name": "standard_flap",
   "href": "/dieline_templates/in/becf-10325",
   "method": "GET"
}

Possible "name" values: standard_flap, flap_with_separator, flap_with_lock

change_cover
identifies the link for the template when "cover" is changed. New value of the "cover" is given in the "name" attribute of the _link. For example :

{
   "rel": "change_cover",
   "name": "standard_cover",
   "href": "/dieline_templates/in/becf-10325",
   "method": "GET"
}

Possible "name" values: standard_cover, rounded_cover

change_hanger
identifies the link for the template when "hanger" is changed. New value of the "hanger" is given in the "name" attribute of the _link. For example :

{
   "rel": "change_hanger",
   "name": "standard_hanger",
   "href": "/dieline_templates/in/becf-10325",
   "method": "GET"
}

Possible "name" values: standard_hanger, rounded_hanger, chamfer_hanger, overflow_hanger

change_style
identifies the link for the template when "style" is changed. New value of the "style" is given in the "name" attribute of the _link. For example : Styles are used to differentiate between similar templates.

{
   "rel": "change_style",
   "name": "style_a",
   "href": "/dieline_templates/in/becf-10325",
   "method": "GET"
}

Possible "name" values: full_cover, half_cut_automatic, half_cut_manual, standard_cover, v_cut, alternative_1, alternative_2, alternative_3, cover_flat, cover_thumb_cut, double_flap, no_postal_lock, postal_lock, single_flap, style_a, style_a, style_b, style_c, style_d, style_e

add_flap , remove_flap
identifies the link for the template when "flap" tag is added to or removed from the current template.

add_top_flap , remove_top_flap
identifies the link for the template when "top_flap" tag is added to or removed from the current template.

add_bottom_flap , remove_bottom_flap
identifies the link for the template when "bottom_flap" tag is added to or removed from the current template.

add_dust_flap , remove_dust_flap
identifies the link for the template when "dust_flap" tag is added to or removed from the current template.

add_top_dust_flap , remove_top_dust_flap
identifies the link for the template when "top_dust_flap" tag is added to or removed from the current template.

add_bottom_dust_flap , remove_bottom_dust_flap
identifies the link for the template when "bottom_dust_flap" tag is added to or removed from the current template.

add_tuck , remove_tuck
identifies the link for the template when "tuck" tag is added to or removed from the current template.

add_top_tuck , remove_top_tuck
identifies the link for the template when "top_tuck" tag is added to or removed from the current template.

add_bottom_tuck , remove_bottom_tuck
identifies the link for the template when "bottom_tuck" tag is added to or removed from the current template.

add_glue_flap , remove_glue_flap
identifies the link for the template when "glue_flap" tag is added to or removed from the current template.

add_cover , remove_cover
identifies the link for the template when "cover" tag is added to or removed from the current template.

add_hanger , remove_hanger
identifies the link for the template when "hanger" tag is added to or removed from the current template.

Rest API Reference

Objects | dieline_template

Objects | group

Objects | flap

Objects | flap

Objects | flap

Objects | tuck

Objects | tuck

Objects | tuck

Objects | dust_flap

Objects | dust_flap

Objects | dust_flap

Objects | glue_flap

Objects | cover

Objects | hanger

Objects | style

Objects | dieline_template_variable

Objects | dieline_template_link