latestOpenAPI 3.0.02026-08-105585620.8 KB

18e2f2e178dd

Mockup Generator API

Layout templates

Retrieve list of templates that can be used for client-side positioning.

<div class="alert alert-info"> This endpoint uses DTG as a default printing technique for product layouts with more than one technique available. For products with DTG and more techniques available please specify the correct technique in query by using the `technique` parameter. For more information read the <a href="#tag/Examples/Mockup-Generator-API-examples">examples</a>. </div>

get/mockup-generator/templates/{id}

Path parameters

idinteger required

Product ID.

Query parameters

orientation'horizontal' | 'vertical'

Optional orientation for wall art product printfiles. Allowed values: horizontal, vertical

techniquestring

Optional technique for product. This can be used in cases where product supports multiple techniques like DTG and embroidery

Headers

X-PF-Store-Idstring

Use this to specify which store you want to use (required only for account level token).

The store IDs can be retrieved with the Get basic information about stores endpoint.

Response

codeinteger

Response status code 200

Example response

{
  "code": 200,
  "result": {
    "version": 1,
    "min_dpi": 300,
    "variant_mapping": [
      {
        "variant_id": 1,
        "templates": [
          {
            "placement": "front",
            "template_id": 1
          }
        ]
      }
    ],
    "templates": [
      {
        "template_id": 919,
        "image_url": "https://www.printful.com/files/generator/40/11oz_template.png",
        "printfile_id": 43,
        "template_width": 560,
        "template_height": 295,
        "print_area_width": 520,
        "print_area_height": 202,
        "print_area_top": 18,
        "print_area_left": 20,
        "is_template_on_front": true,
        "orientation": "any"
      }
    ],
    "conflicting_placements": [
      {
        "placement": "label_outside",
        "conflicts": [
          "back",
          "label_inside"
        ]
      }
    ]
  }
}