RESOURCE | 3D Mockups

GET '/dielines/{dieline_id}/3d-mockups'

Get list of your 3D mockups for a specific custom dieline.

Request Parameters

dieline_id string	Unique identifier for the custom dieline. required Example: "di_fwe4iu3vngty"
page integer	The page number for paginated results. Default is 1
page_size integer	Number of 3D mockups to return per page. Default is 100

Response Object

Returns "3d_mockup_list" object.

Objects | 3d_mockup_list

type string

"3d_mockup_list"

dieline_id string

Unique identifier for the custom dieline.
Example: "di_fwe4iu3vngty"

total integer

Total number of 3d mockups in the list.
Example: 42

page integer

Example: 1

page_size integer

Example: 100

3d_mockups [3d_mockup]

List of "3d_mockups".

Objects | 3d_mockup

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

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.

links [dieline_link]

created_at DateTime

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

links [3d_mockup_link]

links [link]

Links providing a way to navigate between 3d_mockup_lists.

Code Examples


curl -i -X GET \
https://api.diecuttemplates.com/dielines/di_fwe4iu3vngty/3d-mockups?page=2&page_size=50 \
  -H 'Authorization: Bearer <YOUR_DIELINES_API_KEY_HERE>' \
  -H 'Dielines-Api-Version: 1.0'


require 'uri'
require 'net/http'
require 'openssl'

url = URI('ttps://api.diecuttemplates.com/dielines/di_fwe4iu3vngty/3d-mockups?page=2&page_size=50')

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request['Dielines-Api-Version'] = '1.0'
request['Authorization'] = 'Bearer <YOUR_DIELINES_API_KEY_HERE>'

response = http.request(request)
puts response.read_body


$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <YOUR_DIELINES_API_KEY_HERE>",
    "Dielines-Api-Version: 1.0"
  ],
  CURLOPT_URL => "ttps://api.diecuttemplates.com/dielines/di_fwe4iu3vngty/3d-mockups?page=2&page_size=50",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$error = curl_error($curl);

curl_close($curl);

if ($error) {
  echo "cURL Error #:" . $error;
} else {
  echo $response;
}

Response - 200

application/json

{
  "3d_mockup_list": {
    "type": "3d_mockup_list",
    "dieline_id": "wu1evfblev8y",
    "total": 7,
    "page": 1,
    "page_size": 100,
    "3d_mockups": [
      {
        "type": "3d_mockup",
        "id": "ntgmhkhdk390",
        "url": "https://diecuttemplates.com.dev/3d/ntgmhkhdk390",
        "name": "my design",
        "dieline": {
          "type": "dieline",
          "id": "wu1evfblev8y",
          "dieline_template_id": "becf-11f08",
          "variables": {
            "unit": "mm",
            "width": 51.51,
            "height": 51.51,
            "length": 51.51,
            "material": 0.5,
            "overflow": false
          },
          "format": "pdf",
          "url": "https://example.com/user-dielines/1b6453892473a467d07372d45eb05abc2031647a/e82524c4-5950-46af-9a79-08168d3565e120241226-91106-4g9qeg.pdf",
          "artwork_dimensions": {
            "unit": "mm",
            "width": "287.55",
            "height": "289.55"
          },
          "created_at": "2024-12-26T15:21:07Z"
        }
      },
      {
        "type": "3d_mockup",
        "id": "1d9u48ggo9dx",
        "url": "https://diecuttemplates.com.dev/3d/1d9u48ggo9dx",
        "name": "my design",
        "dieline": {
          "type": "dieline",
          "id": "wu1evfblev8y",
          "dieline_template_id": "becf-11f08",
          "variables": {
            "unit": "mm",
            "width": 51.51,
            "height": 51.51,
            "length": 51.51,
            "material": 0.5,
            "overflow": false
          },
          "format": "pdf",
          "url": "https://example.com/user-dielines/1b6453892473a467d07372d45eb05abc2031647a/e82524c4-5950-46af-9a79-08168d3565e120241226-91106-4g9qeg.pdf",
          "artwork_dimensions": {
            "unit": "mm",
            "width": "287.55",
            "height": "289.55"
          },
          "created_at": "2024-12-26T15:21:07Z"
        }
      },
      {
        "type": "3d_mockup",
        "id": "843bqoj5ctzo",
        "url": "https://diecuttemplates.com.dev/3d/843bqoj5ctzo",
        "name": "my design 1",
        "dieline": {
          "type": "dieline",
          "id": "wu1evfblev8y",
          "dieline_template_id": "becf-11f08",
          "variables": {
            "unit": "mm",
            "width": 51.51,
            "height": 51.51,
            "length": 51.51,
            "material": 0.5,
            "overflow": false
          },
          "format": "pdf",
          "url": "https://example.com/user-dielines/1b6453892473a467d07372d45eb05abc2031647a/e82524c4-5950-46af-9a79-08168d3565e120241226-91106-4g9qeg.pdf",
          "artwork_dimensions": {
            "unit": "mm",
            "width": "287.55",
            "height": "289.55"
          },
          "created_at": "2024-12-26T15:21:07Z"
        }
      },
      {
        "type": "3d_mockup",
        "id": "bi25dkloswv5",
        "url": "https://diecuttemplates.com.dev/3d/bi25dkloswv5",
        "name": "my design 1",
        "dieline": {
          "type": "dieline",
          "id": "wu1evfblev8y",
          "dieline_template_id": "becf-11f08",
          "variables": {
            "unit": "mm",
            "width": 51.51,
            "height": 51.51,
            "length": 51.51,
            "material": 0.5,
            "overflow": false
          },
          "format": "pdf",
          "url": "https://example.com/user-dielines/1b6453892473a467d07372d45eb05abc2031647a/e82524c4-5950-46af-9a79-08168d3565e120241226-91106-4g9qeg.pdf",
          "artwork_dimensions": {
            "unit": "mm",
            "width": "287.55",
            "height": "289.55"
          },
          "created_at": "2024-12-26T15:21:07Z"
        }
      },
      {
        "type": "3d_mockup",
        "id": "c7uq0o1ohgri",
        "url": "https://diecuttemplates.com.dev/3d/c7uq0o1ohgri",
        "name": "my design 1",
        "dieline": {
          "type": "dieline",
          "id": "wu1evfblev8y",
          "dieline_template_id": "becf-11f08",
          "variables": {
            "unit": "mm",
            "width": 51.51,
            "height": 51.51,
            "length": 51.51,
            "material": 0.5,
            "overflow": false
          },
          "format": "pdf",
          "url": "https://example.com/user-dielines/1b6453892473a467d07372d45eb05abc2031647a/e82524c4-5950-46af-9a79-08168d3565e120241226-91106-4g9qeg.pdf",
          "artwork_dimensions": {
            "unit": "mm",
            "width": "287.55",
            "height": "289.55"
          },
          "created_at": "2024-12-26T15:21:07Z"
        }
      },
      {
        "type": "3d_mockup",
        "id": "z3f6befxx69p",
        "url": "https://diecuttemplates.com.dev/3d/z3f6befxx69p",
        "name": "my design 1",
        "dieline": {
          "type": "dieline",
          "id": "wu1evfblev8y",
          "dieline_template_id": "becf-11f08",
          "variables": {
            "unit": "mm",
            "width": 51.51,
            "height": 51.51,
            "length": 51.51,
            "material": 0.5,
            "overflow": false
          },
          "format": "pdf",
          "url": "https://example.com/user-dielines/1b6453892473a467d07372d45eb05abc2031647a/e82524c4-5950-46af-9a79-08168d3565e120241226-91106-4g9qeg.pdf",
          "artwork_dimensions": {
            "unit": "mm",
            "width": "287.55",
            "height": "289.55"
          },
          "created_at": "2024-12-26T15:21:07Z"
        }
      },
      {
        "type": "3d_mockup",
        "id": "qmv0p7ektixl",
        "url": "https://diecuttemplates.com.dev/3d/qmv0p7ektixl",
        "name": "my design 1",
        "dieline": {
          "type": "dieline",
          "id": "wu1evfblev8y",
          "dieline_template_id": "becf-11f08",
          "variables": {
            "unit": "mm",
            "width": 51.51,
            "height": 51.51,
            "length": 51.51,
            "material": 0.5,
            "overflow": false
          },
          "format": "pdf",
          "url": "https://example.com/user-dielines/1b6453892473a467d07372d45eb05abc2031647a/e82524c4-5950-46af-9a79-08168d3565e120241226-91106-4g9qeg.pdf",
          "artwork_dimensions": {
            "unit": "mm",
            "width": "287.55",
            "height": "289.55"
          },
          "created_at": "2024-12-26T15:21:07Z"
        }
      }
    ],
    "links": [
      {
        "rel": "self",
        "href": "/3d-mockups/wu1evfblev8y?page=1&page_size=100",
        "method": "GET"
      }
    ]
  }
}

Rest API Reference

RESOURCE | 3D Mockups

Request Parameters

Response Object

Objects | 3d_mockup_list

Objects | 3d_mockup

Objects | dieline

Objects | dieline_link

Objects | 3d_mockup_link

Objects | 3d_mockup_list_link

Code Examples

Response - 200