RESOURCE | 3D Mockup

PUT '/dielines/{dieline_id}/3d-mockups/{id}'

Update an existing 3D Mockup.

Request Parameters

dieline_id string	Unique identifier for the "dieline" object required Example: "di_fwe4iu3vngty"
id string	Unique ID for the 3D mockup. For example: "llnmb1oh8r"
file file	Artwork (image) file to upload. For example:
name string	Name of the 3D mockup.
outside_design boolean	Boolean flag indicating whether the uploaded file is intended for the inside or outside of the box. Default is "true". When set to "false", it means the uploaded file is for the "inside_design"
scene_background_color string	Optional hex color for the 3D scene background behind the box, for example "#707070" . Useful when the default grey blends into a grey box. When omitted, the mockup's current scene background is left unchanged.
substrate string	Optional substrate (box material) the mockup is rendered with. Pass one of the substrate keys below, or an empty string to reset to the plain material. An unknown key returns a 400. When omitted, the mockup's current substrate is left unchanged. Updating only the substrate does not re-render the artwork. Available substrates: "black_embossedpaper" — Black Embossed paper "black_hardcardboards" — Black Hard Cardboards "corrugated_brown" — Corrugated Brown "corrugated_white" — Corrugated White "gray_hardcardboards" — Gray Hard Cardboards "kraft_brown" — Kraft Brown "kraft_hardcardboards" — Kraft Hard Cardboards "white_embossedpaper" — White Embossed paper "white_hardcardboards" — White Hard Cardboards "white_sbs" — White SBS
part_substrates object	For boxes whose faces use more than one material (e.g. a body plus a separate "Cover"), a map of part number to substrate key — for example part_substrates[1]="corrugated_brown" . Replaces the full set of per-part picks; each value accepts a substrate key (from the list above) or an empty string for that part's plain material. When omitted, the mockup's current per-part substrates are left unchanged. Updating only substrates does not re-render the artwork. Discover the parts from the substrate_parts array on the dieline response.

Response Object

Returns a "3d_mockup" object.

Objects | 3d_mockup

This object represents a 3D mockup, which is a three-dimensional visualization of a dieline with custom artwork.

type string

"3d_mockup"

id string

Unique ID for the 3D mockup. For example: "llnmb1oh8r"

url URL

Hosted URL for the 3D Mockup
For example: https://www.diecuttemplates.com/3d/llnmb1oh8r

name string

Name of the 3D mockup, if specified during creation.

dieline dieline

Dieline for the 3d mockup.

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".

links [dieline_link]

created_at DateTime

For example: 2024-11-25T10:00:00Z

links [3d_mockup_link]

Code Examples


curl -i -X PUT \
https://api.diecuttemplates.com/dielines/di_fwe4iu3vngty/3d-mockups/cq8fwgnjvt9s \
  -H 'Authorization: Bearer <YOUR_DIELINES_API_KEY_HERE>' \
  -H "Content-Type: multipart/form-data" \
  -H 'Dielines-Api-Version: 1.0'
  -F "file=@/path/to/your/artwork.png" \
  -F "name=my design" \
  -F "outside_design=false"


require 'net/http'
require 'uri'
require 'json'

# Define the endpoint and headers
uri = URI('https://api.diecuttemplates.com/dielines/di_fwe4iu3vngty/3d-mockups/cq8fwgnjvt9s')
headers = {
  'Authorization' => 'Bearer <YOUR_DIELINES_API_KEY_HERE>',
  'Dielines-Api-Version' => '1.0'
}

# Create the form data
form_data = [
  ['file', File.open('/path/to/your/artwork.png')],
  ['name', 'my design'],
  ['outside_design', 'false'] # 'false' is sent as a string
]

# Make the HTTP request
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

request = Net::HTTP::Put.new(uri, headers)
request.set_form form_data, 'multipart/form-data'

response = http.request(request)

# Output the response
puts "Status Code: #{response.code}"
puts "Response Body: #{response.body}"



// Define the endpoint and headers
$url = "https://api.diecuttemplates.com/dielines/di_fwe4iu3vngty/3d-mockups/cq8fwgnjvt9s";
$headers = [
    "Authorization: Bearer <YOUR_DIELINES_API_KEY_HERE>",
    "Dielines-Api-Version: 1.0"
];

// Initialize cURL
$ch = curl_init();

// Attach the file and form data
$filePath = "/path/to/your/artwork.png"; // Replace with the actual file path
$postFields = [
    "file" => new CURLFile($filePath),
    "name" => "my design",
    "outside_design" => "false" // 'false' is sent as a string
];

// Set cURL options
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "PUT");   // Set HTTP method to PUT
curl_setopt($ch, CURLOPT_POSTFIELDS, $postFields);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

// Execute the request
$response = curl_exec($ch);
$httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);

// Handle errors
if (curl_errno($ch)) {
    echo "cURL Error: " . curl_error($ch);
} else {
    // Output the response
    echo "HTTP Status Code: " . $httpCode . PHP_EOL;
    echo "Response Body: " . $response . PHP_EOL;
}

// Close the cURL session
curl_close($ch);

Example Response, Status = 200

application/json

{
  "3d_mockup": {
    "type": "3d_mockup",
    "id": "llnmb1oh8r",
    "url": "https://www.diecuttemplates.com/3d/llnmb1oh8r",
    "name": "My design",
    "dieline": {
      "type": "dieline",
      "id": "ueipnpyp0rlw",
      "dieline_template_id": "becf-10301",
      "variables": {
        "unit": "mm",
        "length": 250.0,
        "width": 200.0,
        "height": 200.0,
        "material": 0.389
      },
      "format": "pdf",
      "url": "https://d2atdwxjx7uc4i.cloudfront.net/campaigns/0e9d742f-bdcd-4b41-8122-88e0426d263f20241218-14172-y29ocn.pdf",
      "artwork_dimensions": {
        "unit": "mm",
        "width": "723.06",
        "height": "502.44"
      },
      "created_at": "2024-12-18T19:27:22Z"
    },
    "links": [
      {
        "rel": "update",
        "href": "/dielines/ueipnpyp0rlw/3d-mockups/llnmb1oh8r",
        "method": "PUT"
      },
      {
        "rel": "delete",
        "href": "/dielines/ueipnpyp0rlw/3d-mockups/llnmb1oh8r",
        "method": "DELETE"
      }
    ]
  }
}

Rest API Reference