> ## Documentation Index
> Fetch the complete documentation index at: https://print.app/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Get an option set template

> A template as a complete option set, to adapt and save with `POST /v2/option-sets`: its currency set to the store's, and its choices and prices to the merchant's.



## OpenAPI

````yaml openapi.json GET /v2/print-options/templates/{key}
openapi: 3.1.0
info:
  title: Print.App API
  version: 2.1.0
  description: >-
    Server-to-server API for Print.App integrations: designs and their page
    content, folders, files, fonts, palettes, product assignments, projects and
    editor links. Authenticate every request with a secret key: `Authorization:
    Bearer sk_…`. Never call it from a browser.
servers:
  - url: https://api.print.app
    description: Production
security:
  - bearerAuth: []
tags:
  - name: Account
    description: The account a secret key belongs to.
  - name: Designs
    description: >-
      The designs (templates) your customers start from: create them at a size,
      manage their pages, and place text, images and shapes on them.
  - name: Design folders
    description: >-
      Folders that organise your designs. A design can sit in more than one
      folder.
  - name: Files
    description: >-
      Your own images and graphics, used in designs and offered to customers in
      the editor.
  - name: Graphic folders
    description: >-
      Folders of files, shown in the editor under Pictures, Backgrounds,
      Textures or Frames.
  - name: Fonts
    description: >-
      The fonts your designs and customers can use: the built-in set, imported
      Google fonts and fonts you upload.
  - name: Palettes
    description: Colour palettes offered in the editor.
  - name: Products
    description: Which designs open for each product (and variant) in your store.
  - name: Projects
    description: Your customers' saved designs.
  - name: Links
    description: >-
      Project URLs (the dashboard's Create new Project URL): shareable links
      that open a design or project in the editor at create.print.app, to share
      with customers or to test a design.
  - name: Connectors
    description: >-
      Links between the options on a store's product page and the editor: the
      choice a customer makes shows the right pages, opens the right design, or
      sets the size, orientation or colour. Read a product page for what a
      connector can point at, and test one against a design before customers
      meet it.
  - name: Print Options
    description: >-
      Print Options is Print.App's free product options app (options.print.app):
      the sizes, papers, quantities and prices customers choose on a product
      page, priced on our servers when they add to cart. An option set is those
      questions and their prices; Print.App designs fill its artwork step, and
      connectors read its answers. Option sets are managed here for Shopify
      stores with both apps installed; templates and quotes work for any
      account.
  - name: Resource profiles
    description: >-
      Limits on the fonts, colour palettes and graphic folders the editor
      offers, for the designs that use them.
  - name: PDF profiles
    description: >-
      The settings print PDFs are made with: colour conversion, PDF standard,
      cut lines, image resolution, fonts.
  - name: 3D scenes
    description: >-
      The 3D scenes the editor previews designs on: models with print areas,
      folds, flipbooks and sheets, yours and the Print.App library's. A design
      picks one with `sceneId`.
  - name: Library
    description: >-
      The Print.App library, the store catalogue the dashboard's Import Designs
      and Import from Library open: ready-made designs, and themed kits of
      graphics. Find what suits a product, then bring it into your account: a
      design as your own copy, a kit as a folder that follows it, single
      graphics into a folder.
  - name: Settings
    description: >-
      The account's editor and product page settings: how the editor opens and
      behaves, and the selectors Print.App uses on your product pages. Settings
      that run code in your store, send data elsewhere or delete projects are
      kept to the dashboard.
paths:
  /v2/print-options/templates/{key}:
    get:
      tags:
        - Print Options
      summary: Get an option set template
      description: >-
        A template as a complete option set, to adapt and save with `POST
        /v2/option-sets`: its currency set to the store's, and its choices and
        prices to the merchant's.
      operationId: getOptionSetTemplate
      parameters:
        - name: key
          in: path
          required: true
          schema:
            type: string
          description: The template key, such as `flyers`.
      responses:
        '200':
          description: OK.
          headers:
            x-request-id:
              $ref: '#/components/headers/RequestId'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OptionSetTemplate'
              example:
                object: option_set_template
                key: flyers
                name: Flyers
                description: Size, sides, tiered per-unit pricing.
                currency: USD
                fields:
                  - id: size
                    label: Size
                    type: select-one
                    role: size
                    source:
                      role: size
                    reference: po:role/size
                    sends: choice id as value, label as text
                    choices:
                      - value: a5
                        label: A5
                        selected: true
                      - value: a4
                        label: A4
                        selected: false
                config:
                  version: '2.0'
                  productId: flyers
                  title: Flyers
                  layout: stacked
                  pricing:
                    currency: USD
                    basePrice:
                      amount: 10
                      per: order
                  sections:
                    - id: main
                      title: Your flyer
                      fields:
                        - id: size
                          type: select-one
                          display: pills
                          label: Size
                          role: size
                          required: true
                          options:
                            - id: a5
                              label: A5
                              default: true
                              priceModifiers: []
                            - id: a4
                              label: A4
                              priceModifiers:
                                - type: fixed
                                  amount: 5
                          priceModifiers: []
        '401':
          description: Missing, unknown, revoked or expired secret key.
          headers:
            x-request-id:
              $ref: '#/components/headers/RequestId'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: true
                code: unauthorized
                message: >-
                  Missing or invalid secret key. Send it as "Authorization:
                  Bearer sk_…".
                requestId: FZn-uhymjoEEJow=
        '403':
          description: The account is suspended for an unpaid invoice.
          headers:
            x-request-id:
              $ref: '#/components/headers/RequestId'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: true
                code: account_suspended
                message: >-
                  This account is suspended. Settle the outstanding invoice in
                  the Print.App dashboard.
                requestId: FZn-uhymjoEEJow=
        '404':
          description: >-
            Not found in your account. Another account's resources answer 404
            too.
          headers:
            x-request-id:
              $ref: '#/components/headers/RequestId'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: true
                code: not_found
                message: Not found.
                requestId: FZn-uhymjoEEJow=
        '429':
          description: >-
            Rate limited by the API gateway. Back off and retry. This response
            comes from the gateway, so its body is `{ "message": "Too Many
            Requests" }`, not the standard error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GatewayError'
              example:
                message: Too Many Requests
        '500':
          description: >-
            Something failed on our side. Retry; quote the requestId to support
            if it persists.
          headers:
            x-request-id:
              $ref: '#/components/headers/RequestId'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: true
                code: internal_error
                message: >-
                  Something went wrong on our side. Retry the request; if it
                  keeps failing, contact support with the requestId.
                requestId: FZn-uhymjoEEJow=
components:
  headers:
    RequestId:
      description: Identifies the request. Quote it when contacting support.
      schema:
        type: string
  schemas:
    OptionSetTemplate:
      title: OptionSetTemplate
      description: A template as a complete option set.
      type: object
      required:
        - object
        - key
        - name
        - description
        - currency
        - fields
        - config
      properties:
        object:
          type: string
          const: option_set_template
        key:
          type: string
          description: For `GET /v2/print-options/templates/{key}`.
        name:
          type: string
        description:
          type: string
        currency:
          type: string
          description: 'The template''s currency: change it to the store''s.'
        fields:
          type: array
          items:
            $ref: '#/components/schemas/PrintOptionsField'
          description: >-
            Its fields as connectors address them: give a field's `source` as a
            connector's `source`.
        config:
          type: object
          description: >-
            The option set itself: Print Options' JSON (version "2.0"), as in
            the [option set JSON
            reference](https://print.app/docs/print-options/developers/option-set-json).
      examples:
        - object: option_set_template
          key: flyers
          name: Flyers
          description: Size, sides, tiered per-unit pricing.
          currency: USD
          fields:
            - id: size
              label: Size
              type: select-one
              role: size
              source:
                role: size
              reference: po:role/size
              sends: choice id as value, label as text
              choices:
                - value: a5
                  label: A5
                  selected: true
                - value: a4
                  label: A4
                  selected: false
          config:
            version: '2.0'
            productId: flyers
            title: Flyers
            layout: stacked
            pricing:
              currency: USD
              basePrice:
                amount: 10
                per: order
            sections:
              - id: main
                title: Your flyer
                fields:
                  - id: size
                    type: select-one
                    display: pills
                    label: Size
                    role: size
                    required: true
                    options:
                      - id: a5
                        label: A5
                        default: true
                        priceModifiers: []
                      - id: a4
                        label: A4
                        priceModifiers:
                          - type: fixed
                            amount: 5
                    priceModifiers: []
    Error:
      title: Error
      description: >-
        Every error the API itself returns. Match on `code`; `message` is for
        people and may be reworded.
      type: object
      required:
        - error
        - code
        - message
        - requestId
      properties:
        error:
          type: boolean
          const: true
        code:
          type: string
          enum:
            - unauthorized
            - account_suspended
            - invalid_request
            - not_found
            - route_not_found
            - idempotency_key_reused
            - idempotency_in_progress
            - folder_not_empty
            - builtin_folder
            - builtin_palette
            - editor_not_supported
            - design_changed
            - payload_too_large
            - unsupported_media_type
            - ops_failed
            - internal_error
            - service_unavailable
          description: >-
            `unauthorized` (401): missing, unknown, revoked or expired secret
            key. `account_suspended` (403): the account has an unpaid invoice.
            `invalid_request` (400): a parameter or body field is malformed —
            see `param` and `details`. `not_found` (404): no such resource in
            your account. `route_not_found` (404): no such endpoint.
            `idempotency_key_reused` (409): the Idempotency-Key was used for a
            different request. `idempotency_in_progress` (409): the first
            request with that key is still running. `folder_not_empty` (409):
            the folder still holds designs or folders. `builtin_folder`,
            `builtin_palette` (409): Print.App's own folders and palettes cannot
            be changed. `editor_not_supported` (409): page content can only be
            edited on accounts that use the new editor. `design_changed` (409):
            the design was saved elsewhere while the batch ran; read it again
            and retry. `payload_too_large` (413): a body or file over the limit.
            `unsupported_media_type` (415): send JSON. `ops_failed` (422): an
            operation in the batch failed, nothing was saved — see `details`.
            `internal_error` (500): retry; contact support with the `requestId`
            if it persists. `service_unavailable` (503): retry in a few seconds.
        message:
          type: string
        param:
          type: string
          description: The parameter or body field at fault, as a path (`pages[0].title`).
        details:
          type: array
          description: >-
            Every problem found, when there was more than one
            (`invalid_request`), or each operation's result (`ops_failed`).
          items:
            type: object
        requestId:
          type: string
          description: >-
            Also sent as the `x-request-id` header. Quote it when contacting
            support.
      examples:
        - error: true
          code: invalid_request
          message: limit must be an integer from 1 to 100.
          param: limit
          requestId: FZn-uhymjoEEJow=
    GatewayError:
      type: object
      properties:
        message:
          type: string
      description: Returned by the API gateway itself (429).
    PrintOptionsField:
      title: PrintOptionsField
      description: >-
        A Print Options field, as a connector points at it: by role when it has
        one, else by its id.
      type: object
      required:
        - id
        - label
        - type
        - role
        - source
        - reference
        - sends
        - choices
      properties:
        id:
          type: string
        label:
          type:
            - string
            - 'null'
        type:
          type:
            - string
            - 'null'
          description: select-one, select-many, quantity, dimensions, number, text, file…
        role:
          type:
            - string
            - 'null'
          description: Its role, explicit or from its type (quantity, dimensions, file).
        source:
          type: object
          description: >-
            What to give as `source`: `{ role }` when it has one, else `{ field
            }`.
          properties:
            role:
              type: string
            field:
              type: string
        reference:
          type: string
          description: 'The stored query: `po:role/<role>` or `po:field/<id>`.'
        sends:
          type: string
        choices:
          type: array
          items:
            type: object
            required:
              - value
              - label
              - selected
            properties:
              value:
                type: string
                description: What the page sends for it.
              label:
                type:
                  - string
                  - 'null'
                description: What the customer sees.
              selected:
                type: boolean
                description: Selected when the page loads.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        A secret key from Print.App admin → Domains → Secret keys, sent as
        `Authorization: Bearer sk_…`. Server-side only.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.