Type Alias MockupTemplates

MockupTemplates: {
    background_color?: number | null;
    background_url?: string | null;
    catalog_variant_ids?: number[];
    image_url?: string;
    orientation?: orientation;
    placement?: string;
    print_area_height?: number;
    print_area_left?: number;
    print_area_top?: number;
    print_area_width?: number;
    technique?: string;
    template_height?: number;
    template_positioning?: template_positioning;
    template_width?: number;
}

Data containing information about the available mockup templates which can be used for user-side positioning. For example for intention of generating mockups without the use of Printful's mockup generator.

Type declaration

  • Optionalbackground_color?: number | null

    HEX color code that should be used as a background color of image_url.

  • Optionalbackground_url?: string | null

    Background image URL (optional). Used for certain mockups e.g. a wall behind hanged poster. If it's defined it is intended to be layered under the image defined in image_url.

  • Optionalcatalog_variant_ids?: number[]

    A list of variant IDs for which the positions apply

  • Optionalimage_url?: string

    Semi-transparent main template image URL.

  • Optionalorientation?: orientation

    Wall art product orientation. Possible values: horizontal, vertical, any

  • Optionalplacement?: string

    Catalog product placement that is used for the design

  • Optionalprint_area_height?: number

    Print area height (image is positioned in this area).

  • Optionalprint_area_left?: number

    Print area left offset (offset in template).

  • Optionalprint_area_top?: number

    Print area top offset (offset in template).

  • Optionalprint_area_width?: number

    Print area width (image is positioned in this area).

  • Optionaltechnique?: string

    Catalog product technique that is used for the design

  • Optionaltemplate_height?: number

    Height of the whole template in pixels.

  • Optionaltemplate_positioning?: template_positioning

    Should the main template image (image_url) be used as an overlay or as a background.

  • Optionaltemplate_width?: number

    Width of the whole template in pixels.

Settings

Member Visibility