Objects | dieline

This object represents a custom dieline generated from a dieline template with specific variable values.

type string "dieline"
id string Unique identifier for custom dieline
"di_fwe4iu3vngty"
dieline_template_id string Unique identifier for the dieline template.
Example: "becf-10301"
variables object Key-value pairs including values for "dieline template variables" that define the dimensions when the custom dieline was generated.
unit enum Unit required
Possible values are:
"mm"
"in"
material decimal Material thickness. For example 1.23
{dieline_template_variable_name} string

Dieline template specific dieline template variable names.
For example a, b, top_tuck_flap
value for the {dieline_template_variable_name}
For example 100.00
format string File format. "dxf", "pdf" or "svg"
url URL URL for the dieline. The custom dieline can be downloaded directly from this link.
artwork_dimensions width and height This is the dimensions for uploading artwork to create a 3D Mockup. The image file doesn't need to be in this exact dimensions but it should have the same aspect ratio.
area The area of the dieline.
This information is only included in the result if area_calculation is set to true.
For example:
{
  "value": 200000,
  "unit": "mm2"
} 

Possible "unit" values are: "mm2" for "square millimeters".
part_areas A per-part breakdown of the area, keyed by part id, for a multi-part dieline (e.g. a box with a separate lid). Each part's area is measured on that part alone, using the same method as the whole-dieline area — so for a multi-part dieline the area above equals the sum of these part areas.
Only included when area_calculation is true and the dieline has more than one part; it is omitted for single-part dielines.
For example:
{
  "inner-tray":   { "value": "96574.47", "unit": "mm2" },
  "sleeve-cover": { "value": "83868.55", "unit": "mm2" }
} 
substrate_parts array The substrate fields the create and update 3D mockup endpoints accept for this dieline: one entry for the body, then one for each part that has its own material (for example a "Cover"), in ascending part number. A single-material box has only the body entry. The entries come from the dieline template, so they are the same for every dieline made from it.
Only included when the dieline template supports 3D mockups (the same dielines that get a create_3d_mockup link).
part integer or null null for the body; otherwise the part number, which is the key to use in part_substrates. It is not one of the part ids that key part_areas.
name string A name to show for the body or part, for example "Material" or "Cover". The body takes the template's own material label where it has one (for example "Box"), and a part without a name of its own gets a placeholder such as "Part Material 2". Use it for display only: identify an entry by its part or param.
param string The exact request field to send: "substrate" for the body, "part_substrates[<part>]" for a part, as a multipart form field. The update endpoint also accepts a JSON body, where part_substrates[1] is sent as {"part_substrates": {"1": "corrugated_brown"}}.
For example:
[
  { "part": null, "name": "Box",   "param": "substrate" },
  { "part": 1,    "name": "Cover", "param": "part_substrates[1]" }
] 
links [dieline_link]
created_at DateTime For example: 2024-11-25T10:00:00Z