Servers Playground How we check Add a server Log in

Printdash

Working

io.printdash/printdashv0.6.0 Domain verified

Online printing for Australia: products, exact prices, quotes, artwork checks and orders.

Commerce

Website Registry entry

Maintain this server? Claim it

Try it

Call this server's tools from your browser. Nothing to install.

https://api.printdash.io/functions/v1/mcp

Requests go through mcptry because browsers can't call most MCP servers directly. Header values are sent to the server for that request only and are never stored or logged.

Tool list from our last check. Connect live to refresh it.

add_to_cart

Prices one job with Printdash's pricing engine (product id and a configuration of option ids, as price_job takes them) and puts it in the cart exactly as the product page's Add to cart does. If the job cannot be priced, nothing is added and the result says what is missing or the nearest combinations. Nothing is ordered or charged: checkout on printdash.io re-prices, takes artwork and payment. Printdash prints in Australia and delivers within Australia only; prices are in AUD and include GST. Needs a signed-in Printdash account: called without one, the connection asks the customer to sign in on printdash.io.

product_idstring, required

configurationobject, required

The job, as option ids from get_product. Everything optional: the result says what is missing.

This tool isn't marked read-only, so it may change something on the server or in an account you connected.

I understand, run it anyway

Printdash MCP server | mcptry

Printdash

Working

io.printdash/printdashv0.6.0 Domain verified

Online printing for Australia: products, exact prices, quotes, artwork checks and orders.

Commerce

Website Registry entry

Maintain this server? Claim it

Try it

Call this server's tools from your browser. Nothing to install.

https://api.printdash.io/functions/v1/mcp

Requests go through mcptry because browsers can't call most MCP servers directly. Header values are sent to the server for that request only and are never stored or logged.

Tool list from our last check. Connect live to refresh it.

add_to_cart

product_idstring, required

configurationobject, required

The job, as option ids from get_product. Everything optional: the result says what is missing.

This tool isn't marked read-only, so it may change something on the server or in an account you connected.

I understand, run it anyway

Tools (58)

add_to_cart

Argument	Type	Description
product_id*	string
configuration*	object	The job, as option ids from get_product. Everything optional: the result says what is missing.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "product_id",
    "configuration"
  ],
  "properties": {
    "product_id": {
      "type": "string"
    },
    "configuration": {
      "type": "object",
      "properties": {
        "pages": {
          "type": "integer",
          "maximum": 9007199254740991,
          "description": "Booklets: page count, one of the pages field's presets.",
          "exclusiveMinimum": 0
        },
        "sides": {
          "type": "integer",
          "maximum": 2,
          "minimum": 1,
          "description": "1 for single-sided, 2 for double-sided."
        },
        "width": {
          "type": "number",
          "description": "Custom finished width in mm (with height), within the size field's limits.",
          "exclusiveMinimum": 0
        },
        "height": {
          "type": "number",
          "description": "Custom finished height in mm (with width).",
          "exclusiveMinimum": 0
        },
        "sizeId": {
          "type": "string",
          "description": "A preset size id from get_product's size field. Or give width and height for a custom size."
        },
        "designs": {
          "type": "integer",
          "maximum": 500,
          "minimum": 1,
          "description": "Several different designs with the same specs on one item, where get_product offers designs."
        },
        "stockId": {
          "type": "string",
          "description": "Stock id from the stock field."
        },
        "quantity": {
          "type": "integer",
          "maximum": 9007199254740991,
          "description": "How many. With designs above 1, how many of EACH design.",
          "exclusiveMinimum": 0
        },
        "orientation": {
          "enum": [
            "portrait",
            "landscape"
          ],
          "type": "string"
        },
        "coverStockId": {
          "type": "string",
          "description": "Booklets: cover stock id, or self for a self cover."
        },
        "finishingIds": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "maxItems": 30,
          "description": "Finishing option ids, from every finishing field the customer chose."
        },
        "stickerShape": {
          "enum": [
            "square",
            "circle",
            "custom"
          ],
          "type": "string"
        },
        "coverFinishingIds": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "maxItems": 10,
          "description": "Booklets: cover finishing ids."
        },
        "attributeSelections": {
          "type": "object",
          "description": "Simple products: attribute name to the chosen value's label.",
          "propertyNames": {
            "type": "string"
          },
          "additionalProperties": {
            "type": "string"
          }
        }
      },
      "description": "The job, as option ids from get_product. Everything optional: the result says what is missing."
    }
  }
}

approve_order

For a Team owner: prepares approving one held order (from list_pending_approvals) and returns the summary to show the customer and a confirmation_token. Nothing is decided until confirm is called after they agree. Approving an on-account order sends it to production; approving a card order makes it payable by any member. A member who is not an owner cannot approve. Needs a signed-in Printdash account: called without one, the connection asks the customer to sign in on printdash.io.

destructive

Argument	Type	Description
order*	string	The order number (or the order id from its link).

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "order"
  ],
  "properties": {
    "order": {
      "type": "string",
      "maxLength": 64,
      "minLength": 1,
      "description": "The order number (or the order id from its link)."
    }
  }
}

attach_artwork

After the file has been PUT to request_artwork_upload's upload_url: puts it on the line (in the design and side chosen then, replacing a file already in that slot), makes the page 1 and page 2 previews, runs Printdash's file checks, and returns the preview as an image with the checks' notices. The notices are the ones checkout shows; none of them blocks an order. Needs a signed-in Printdash account: called without one, the connection asks the customer to sign in on printdash.io.

destructive

Argument	Type	Description
upload_id*	string	The upload_id request_artwork_upload returned.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "upload_id"
  ],
  "properties": {
    "upload_id": {
      "type": "string",
      "maxLength": 8192,
      "minLength": 1,
      "description": "The upload_id request_artwork_upload returned."
    }
  }
}

attach_artwork_from_url

Fetches the file at an https link (a Canva, Figma or design tool export, Dropbox or Drive download link, a signed storage URL) up to 700 MB and attaches it like attach_artwork: target (cart_line, quote_line or order_item with its id, design, side), url, and file_name when the link's own name has no extension. A link that opens a web page instead of the file is refused, and so is a file whose contents do not match its extension. For a Canva export, name it canva-<designId>.pdf with the Canva design id: Printdash recognises Canva files by that name (they arrive at finished size by design, so the bleed notice is dropped and the studio checks bleed). Needs a signed-in Printdash account: called without one, the connection asks the customer to sign in on printdash.io.

destructive

Argument	Type	Description
url*	string	An https link that downloads the file itself (not a page showing it).
target*	object	Where the artwork goes.
file_name	string	The name to store it under, with its extension, when the link's own name has none. For a Canva export: canva-<designId>.pdf.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "target",
    "url"
  ],
  "properties": {
    "url": {
      "type": "string",
      "maxLength": 4096,
      "minLength": 1,
      "description": "An https link that downloads the file itself (not a page showing it)."
    },
    "target": {
      "type": "object",
      "required": [
        "kind",
        "id"
      ],
      "properties": {
        "id": {
          "type": "string",
          "maxLength": 64,
          "minLength": 1,
          "description": "The line_id or item_id."
        },
        "kind": {
          "enum": [
            "cart_line",
            "quote_line",
            "order_item"
          ],
          "type": "string",
          "description": "cart_line (line_id from get_cart), quote_line (line_id from get_quote) or order_item (item_id from get_order)."
        },
        "side": {
          "enum": [
            "front",
            "back"
          ],
          "type": "string",
          "description": "front (default) or back, on a double-sided job."
        },
        "design": {
          "type": "integer",
          "maximum": 500,
          "minimum": 1,
          "description": "Which design (1 to N) on a job with several designs. Omit on a one-design job."
        }
      },
      "description": "Where the artwork goes."
    },
    "file_name": {
      "type": "string",
      "maxLength": 200,
      "description": "The name to store it under, with its extension, when the link's own name has none. For a Canva export: canva-<designId>.pdf."
    }
  }
}

attach_artwork_inline

For programmatic clients only: attaches a file sent as base64 in data_base64, up to 10 MB, like attach_artwork (target, file_name with its extension). Never paste a file a customer dropped into a chat here; use attach_artwork_from_url or get_artwork_uploader_link. Needs a signed-in Printdash account: called without one, the connection asks the customer to sign in on printdash.io.

destructive

Argument	Type	Description
target*	object	Where the artwork goes.
file_name*	string	The file's name with its extension.
data_base64*	string	The file's bytes, base64-encoded, up to 10 MB decoded.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "target",
    "file_name",
    "data_base64"
  ],
  "properties": {
    "target": {
      "type": "object",
      "required": [
        "kind",
        "id"
      ],
      "properties": {
        "id": {
          "type": "string",
          "maxLength": 64,
          "minLength": 1,
          "description": "The line_id or item_id."
        },
        "kind": {
          "enum": [
            "cart_line",
            "quote_line",
            "order_item"
          ],
          "type": "string",
          "description": "cart_line (line_id from get_cart), quote_line (line_id from get_quote) or order_item (item_id from get_order)."
        },
        "side": {
          "enum": [
            "front",
            "back"
          ],
          "type": "string",
          "description": "front (default) or back, on a double-sided job."
        },
        "design": {
          "type": "integer",
          "maximum": 500,
          "minimum": 1,
          "description": "Which design (1 to N) on a job with several designs. Omit on a one-design job."
        }
      },
      "description": "Where the artwork goes."
    },
    "file_name": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1,
      "description": "The file's name with its extension."
    },
    "data_base64": {
      "type": "string",
      "maxLength": 14000000,
      "minLength": 1,
      "description": "The file's bytes, base64-encoded, up to 10 MB decoded."
    }
  }
}

cancel_order

Prepares cancelling one order: returns the summary to show the customer and a confirmation_token. Nothing is cancelled until confirm is called with it after the customer agrees. Only an unpaid order that is not in production can be cancelled, as on the order page; otherwise it says so. Needs a signed-in Printdash account: called without one, the connection asks the customer to sign in on printdash.io.

destructive

Argument	Type	Description
order*	string	The order number (or the order id from its link).

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "order"
  ],
  "properties": {
    "order": {
      "type": "string",
      "maxLength": 64,
      "minLength": 1,
      "description": "The order number (or the order id from its link)."
    }
  }
}

cancel_quote_request

Cancels a custom quote request that is still pending review. Needs a signed-in Printdash account: called without one, the connection asks the customer to sign in on printdash.io.

destructive

Argument	Type	Description
request*	string	The request number (or the request id from its link).

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "request"
  ],
  "properties": {
    "request": {
      "type": "string",
      "maxLength": 64,
      "minLength": 1,
      "description": "The request number (or the request id from its link)."
    }
  }
}

check_artwork

Runs Printdash's file checks on a line's artwork, the same ones the product page and checkout show: page size against the ordered size, pages against sides or booklet pages, ink to the edge for bleed, spot finish and cut line layers found, missing or misnamed, finishes knocked out, template guides left in. Each notice comes with a guide link; anything the check could not measure says nothing. Returns the preview as an image. Never blocks an order. Needs a signed-in Printdash account: called without one, the connection asks the customer to sign in on printdash.io.

read-only

Argument	Type	Description
target*	object	Where the artwork goes.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "target"
  ],
  "properties": {
    "target": {
      "type": "object",
      "required": [
        "kind",
        "id"
      ],
      "properties": {
        "id": {
          "type": "string",
          "maxLength": 64,
          "minLength": 1,
          "description": "The line_id or item_id."
        },
        "kind": {
          "enum": [
            "cart_line",
            "quote_line",
            "order_item"
          ],
          "type": "string",
          "description": "cart_line (line_id from get_cart), quote_line (line_id from get_quote) or order_item (item_id from get_order)."
        },
        "side": {
          "enum": [
            "front",
            "back"
          ],
          "type": "string",
          "description": "front (default) or back, on a double-sided job."
        },
        "design": {
          "type": "integer",
          "maximum": 500,
          "minimum": 1,
          "description": "Which design (1 to N) on a job with several designs. Omit on a one-design job."
        }
      },
      "description": "Where the artwork goes."
    }
  }
}

clear_cart

Removes every line from the cart in the current buying context. Saved quotes are not affected. Ask the customer before emptying a cart they did not just fill. Needs a signed-in Printdash account: called without one, the connection asks the customer to sign in on printdash.io.

destructive

No arguments.

Input schema (JSON)

{
  "type": "object",
  "properties": {}
}

confirm

Carries out an action prepared by delete_address, delete_quote, email_quote, request_custom_quote, send_invite, prepare_checkout (placing the order), cancel_order, request_reorder, approve_order or reject_order, after the customer has seen its summary and said yes. Pass its confirmation_token and a new UUID as idempotency_key; retrying with the same key returns the first outcome and never acts twice. Never call it without the customer's agreement. Needs a signed-in Printdash account: called without one, the connection asks the customer to sign in on printdash.io.

destructive

Argument	Type	Description
idempotency_key*	string	A UUID you generate for this confirmation; reuse it only to retry the same one.
confirmation_token*	string	The confirmation_token a prepare tool returned.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "confirmation_token",
    "idempotency_key"
  ],
  "properties": {
    "idempotency_key": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
      "description": "A UUID you generate for this confirmation; reuse it only to retry the same one."
    },
    "confirmation_token": {
      "type": "string",
      "maxLength": 32768,
      "description": "The confirmation_token a prepare tool returned."
    }
  }
}

convert_quote_to_order

Puts a saved quote's lines in the cart, as the quote page's Convert to order does, and returns the checkout link. No order is placed: the customer chooses delivery and pays (or orders on account) at checkout on printdash.io. Only the quote's owner can, and every line needs artwork unless Printdash priced it. Needs a signed-in Printdash account: called without one, the connection asks the customer to sign in on printdash.io.

destructive

Argument	Type	Description
quote*	string	The quote number (or the quote id from its link).

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "quote"
  ],
  "properties": {
    "quote": {
      "type": "string",
      "maxLength": 64,
      "minLength": 1,
      "description": "The quote number (or the quote id from its link)."
    }
  }
}

create_address

Saves an Australian delivery address to the address book in the current buying context (names, street, suburb, state code, four-digit postcode, optional company, mobile and type), optionally as the default. Collect it from the customer; never invent one. Needs a signed-in Printdash account: called without one, the connection asks the customer to sign in on printdash.io.

Argument	Type	Description
city*	string	Suburb or town.
type	string
state*	string	NSW, VIC, QLD, SA, WA, TAS, NT or ACT.
mobile	string
last_name*	string
first_name*	string
postal_code*	string	Four-digit Australian postcode.
company_name	string
address_line1*	string	Street address.

create_quote

Saves a new quote with a quote number from up to 20 jobs (each a product id and configuration, priced by the engine first), with an optional saved address for delivery, pickup where the account has it, an order reference and notes. Prices are locked for 30 days. It is the customer's saved quote, ready to share with a client (share_quote, email_quote) or convert to an order. If a job cannot be priced, nothing is saved. Printdash prints in Australia and delivers within Australia only; prices are in AUD and include GST. Needs a signed-in Printdash account: called without one, the connection asks the customer to sign in on printdash.io.

Argument	Type	Description
lines*	array	The jobs, each priced by the engine before anything is saved.
notes	string
reference	string	The customer's order reference or job name.
address_id	string	A saved address id for delivery (list_addresses). Omit to choose at checkout.
fulfilment	string	pickup only where the account has pickup (estimate_delivery says pickup_available).

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "lines"
  ],
  "properties": {
    "lines": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "product_id",
          "configuration"
        ],
        "properties": {
          "product_id": {
            "type": "string"
          },
          "configuration": {
            "type": "object",
            "properties": {
              "pages": {
                "type": "integer",
                "maximum": 9007199254740991,
                "description": "Booklets: page count, one of the pages field's presets.",
                "exclusiveMinimum": 0
              },
              "sides": {
                "type": "integer",
                "maximum": 2,
                "minimum": 1,
                "description": "1 for single-sided, 2 for double-sided."
              },
              "width": {
                "type": "number",
                "description": "Custom finished width in mm (with height), within the size field's limits.",
                "exclusiveMinimum": 0
              },
              "height": {
                "type": "number",
                "description": "Custom finished height in mm (with width).",
                "exclusiveMinimum": 0
              },
              "sizeId": {
                "type": "string",
                "description": "A preset size id from get_product's size field. Or give width and height for a custom size."
              },
              "designs": {
                "type": "integer",
                "maximum": 500,
                "minimum": 1,
                "description": "Several different designs with the same specs on one item, where get_product offers designs."
              },
              "stockId": {
                "type": "string",
                "description": "Stock id from the stock field."
              },
              "quantity": {
                "type": "integer",
                "maximum": 9007199254740991,
                "description": "How many. With designs above 1, how many of EACH design.",
                "exclusiveMinimum": 0
              },
              "orientation": {
                "enum": [
                  "portrait",
                  "landscape"
                ],
                "type": "string"
              },
              "coverStockId": {
                "type": "string",
                "description": "Booklets: cover stock id, or self for a self cover."
              },
              "finishingIds": {
                "type": "array",
                "items": {
                  "type": "string"
                },
                "maxItems": 30,
                "description": "Finishing option ids, from every finishing field the customer chose."
              },
              "stickerShape": {
                "enum": [
                  "square",
                  "circle",
                  "custom"
                ],
                "type": "string"
              },
              "coverFinishingIds": {
                "type": "array",
                "items": {
                  "type": "string"
                },
                "maxItems": 10,
                "description": "Booklets: cover finishing ids."
              },
              "attributeSelections": {
                "type": "object",
                "description": "Simple products: attribute name to the chosen value's label.",
                "propertyNames": {
                  "type": "string"
                },
                "additionalProperties": {
                  "type": "string"
                }
              }
            },
            "description": "The job, as option ids from get_product. Everything optional: the result says what is missing."
          }
        }
      },
      "maxItems": 20,
      "minItems": 1,
      "description": "The jobs, each priced by the engine before anything is saved."
    },
    "notes": {
      "type": "string",
      "maxLength": 1000
    },
    "reference": {
      "type": "string",
      "maxLength": 200,
      "description": "The customer's order reference or job name."
    },
    "address_id": {
      "type": "string",
      "maxLength": 64,
      "description": "A saved address id for delivery (list_addresses). Omit to choose at checkout."
    },
    "fulfilment": {
      "enum": [
        "delivery",
        "pickup"
      ],
      "type": "string",
      "description": "pickup only where the account has pickup (estimate_delivery says pickup_available)."
    }
  }
}

delete_address

Prepares deleting one saved address: returns the summary to show the customer and a confirmation_token. Nothing is deleted until confirm is called with it after the customer agrees. An address an order or quote was made with leaves the address book but stays on those orders and quotes, as on printdash.io. The only saved address cannot be deleted: add the new one with create_address first. When the default is deleted, the newest other address becomes the default. Needs a signed-in Printdash account: called without one, the connection asks the customer to sign in on printdash.io.

destructive

Argument	Type	Description
address_id*	string

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "address_id"
  ],
  "properties": {
    "address_id": {
      "type": "string",
      "maxLength": 64
    }
  }
}

delete_quote

Prepares deleting a saved quote for good: returns the summary to show the customer and a confirmation_token. Nothing is deleted until confirm is called with it after the customer agrees. Accepted and ordered quotes cannot be deleted. Needs a signed-in Printdash account: called without one, the connection asks the customer to sign in on printdash.io.

destructive

Argument	Type	Description
quote*	string	The quote number (or the quote id from its link).

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "quote"
  ],
  "properties": {
    "quote": {
      "type": "string",
      "maxLength": 64,
      "minLength": 1,
      "description": "The quote number (or the quote id from its link)."
    }
  }
}

duplicate_quote

Saves a copy of a quote as a new quote with its own number, every line re-priced today (artwork is not copied). The original is unchanged. Needs a signed-in Printdash account: called without one, the connection asks the customer to sign in on printdash.io.

Argument	Type	Description
quote*	string	The quote number (or the quote id from its link).

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "quote"
  ],
  "properties": {
    "quote": {
      "type": "string",
      "maxLength": 64,
      "minLength": 1,
      "description": "The quote number (or the quote id from its link)."
    }
  }
}

email_quote

Prepares emailing a saved quote's public link to someone (usually the customer's client): returns the summary to show the customer and a confirmation_token. Nothing is sent until confirm is called with it after the customer agrees. Needs a signed-in Printdash account: called without one, the connection asks the customer to sign in on printdash.io.

destructive

Argument	Type	Description
quote*	string	The quote number (or the quote id from its link).
recipient_name	string
recipient_email*	string	Who to send it to (not the customer's own address).
include_branding	boolean	Show the customer's own branding on the public page (default true).
recipient_business	string

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "quote",
    "recipient_email"
  ],
  "properties": {
    "quote": {
      "type": "string",
      "maxLength": 64,
      "minLength": 1,
      "description": "The quote number (or the quote id from its link)."
    },
    "recipient_name": {
      "type": "string",
      "maxLength": 120
    },
    "recipient_email": {
      "type": "string",
      "maxLength": 200,
      "description": "Who to send it to (not the customer's own address)."
    },
    "include_branding": {
      "type": "boolean",
      "description": "Show the customer's own branding on the public page (default true)."
    },
    "recipient_business": {
      "type": "string",
      "maxLength": 120
    }
  }
}

estimate_delivery

Whether Printdash delivers to an Australian postcode (or, signed in, a saved address) and, given the jobs being ordered, the delivery fee and the delivered total, priced the way checkout prices it. Australian postcodes only: anywhere else is refused, because Printdash delivers within Australia only. Prices in AUD; totals include GST.

read-only

Argument	Type	Description
jobs	array	The jobs being ordered together; the fee depends on the order's value.
postcode	string	An Australian postcode (four digits) for the delivered price. Printdash delivers within Australia only.
address_id	string	Signed in: a saved address id from list_addresses, instead of a postcode.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "jobs": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "product_id",
          "configuration"
        ],
        "properties": {
          "product_id": {
            "type": "string"
          },
          "configuration": {
            "type": "object",
            "properties": {
              "pages": {
                "type": "integer",
                "maximum": 9007199254740991,
                "description": "Booklets: page count, one of the pages field's presets.",
                "exclusiveMinimum": 0
              },
              "sides": {
                "type": "integer",
                "maximum": 2,
                "minimum": 1,
                "description": "1 for single-sided, 2 for double-sided."
              },
              "width": {
                "type": "number",
                "description": "Custom finished width in mm (with height), within the size field's limits.",
                "exclusiveMinimum": 0
              },
              "height": {
                "type": "number",
                "description": "Custom finished height in mm (with width).",
                "exclusiveMinimum": 0
              },
              "sizeId": {
                "type": "string",
                "description": "A preset size id from get_product's size field. Or give width and height for a custom size."
              },
              "designs": {
                "type": "integer",
                "maximum": 500,
                "minimum": 1,
                "description": "Several different designs with the same specs on one item, where get_product offers designs."
              },
              "stockId": {
                "type": "string",
                "description": "Stock id from the stock field."
              },
              "quantity": {
                "type": "integer",
                "maximum": 9007199254740991,
                "description": "How many. With designs above 1, how many of EACH design.",
                "exclusiveMinimum": 0
              },
              "orientation": {
                "enum": [
                  "portrait",
                  "landscape"
                ],
                "type": "string"
              },
              "coverStockId": {
                "type": "string",
                "description": "Booklets: cover stock id, or self for a self cover."
              },
              "finishingIds": {
                "type": "array",
                "items": {
                  "type": "string"
                },
                "maxItems": 30,
                "description": "Finishing option ids, from every finishing field the customer chose."
              },
              "stickerShape": {
                "enum": [
                  "square",
                  "circle",
                  "custom"
                ],
                "type": "string"
              },
              "coverFinishingIds": {
                "type": "array",
                "items": {
                  "type": "string"
                },
                "maxItems": 10,
                "description": "Booklets: cover finishing ids."
              },
              "attributeSelections": {
                "type": "object",
                "description": "Simple products: attribute name to the chosen value's label.",
                "propertyNames": {
                  "type": "string"
                },
                "additionalProperties": {
                  "type": "string"
                }
              }
            },
            "description": "The job, as option ids from get_product. Everything optional: the result says what is missing."
          }
        }
      },
      "maxItems": 10,
      "description": "The jobs being ordered together; the fee depends on the order's value."
    },
    "postcode": {
      "type": "string",
      "maxLength": 8,
      "description": "An Australian postcode (four digits) for the delivered price. Printdash delivers within Australia only."
    },
    "address_id": {
      "type": "string",
      "maxLength": 64,
      "description": "Signed in: a saved address id from list_addresses, instead of a postcode."
    }
  }
}

get_account

Who the signed-in customer is: name, company, pricing tier and its discount in percent (discount_percent 5 means 5% off, already in every price the pricing tools return), whether they are buying personally or as a Team (and their role), the Teams they can switch to, whether the Team orders on account, and what the account is still missing (a delivery address, a phone number). Needs a signed-in Printdash account: called without one, the connection asks the customer to sign in on printdash.io.

read-only

No arguments.

Input schema (JSON)

{
  "type": "object",
  "properties": {}
}

get_artwork_guide

Printdash's artwork setup guides as Markdown (bleed and safe zone, print-ready PDFs, colour, double-sided, cut lines, spot finishes, lamination, stocks, white ink, booklets, folding, wide format, Illustrator and InDesign export). Without a topic, the list. With a product (and its configuration), what that product's page says on the topic, sized for the job.

read-only

Argument	Type	Description
topic	string	A guide id (bleed, pdf-export, colour, double-sided, dieline, spot-finishes, lamination, stock-finishes, white-ink, booklets, folding, wide-format, export-illustrator, export-indesign). Omit for the list.
product_id	string	A product, for what its page says on the topic.
configuration	object	The job, to size the product's lead (page size with bleed, pages, plate names).

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "topic": {
      "type": "string",
      "maxLength": 60,
      "description": "A guide id (bleed, pdf-export, colour, double-sided, dieline, spot-finishes, lamination, stock-finishes, white-ink, booklets, folding, wide-format, export-illustrator, export-indesign). Omit for the list."
    },
    "product_id": {
      "type": "string",
      "description": "A product, for what its page says on the topic."
    },
    "configuration": {
      "type": "object",
      "properties": {
        "pages": {
          "type": "integer",
          "maximum": 9007199254740991,
          "description": "Booklets: page count, one of the pages field's presets.",
          "exclusiveMinimum": 0
        },
        "sides": {
          "type": "integer",
          "maximum": 2,
          "minimum": 1,
          "description": "1 for single-sided, 2 for double-sided."
        },
        "width": {
          "type": "number",
          "description": "Custom finished width in mm (with height), within the size field's limits.",
          "exclusiveMinimum": 0
        },
        "height": {
          "type": "number",
          "description": "Custom finished height in mm (with width).",
          "exclusiveMinimum": 0
        },
        "sizeId": {
          "type": "string",
          "description": "A preset size id from get_product's size field. Or give width and height for a custom size."
        },
        "designs": {
          "type": "integer",
          "maximum": 500,
          "minimum": 1,
          "description": "Several different designs with the same specs on one item, where get_product offers designs."
        },
        "stockId": {
          "type": "string",
          "description": "Stock id from the stock field."
        },
        "quantity": {
          "type": "integer",
          "maximum": 9007199254740991,
          "description": "How many. With designs above 1, how many of EACH design.",
          "exclusiveMinimum": 0
        },
        "orientation": {
          "enum": [
            "portrait",
            "landscape"
          ],
          "type": "string"
        },
        "coverStockId": {
          "type": "string",
          "description": "Booklets: cover stock id, or self for a self cover."
        },
        "finishingIds": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "maxItems": 30,
          "description": "Finishing option ids, from every finishing field the customer chose."
        },
        "stickerShape": {
          "enum": [
            "square",
            "circle",
            "custom"
          ],
          "type": "string"
        },
        "coverFinishingIds": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "maxItems": 10,
          "description": "Booklets: cover finishing ids."
        },
        "attributeSelections": {
          "type": "object",
          "description": "Simple products: attribute name to the chosen value's label.",
          "propertyNames": {
            "type": "string"
          },
          "additionalProperties": {
            "type": "string"
          }
        }
      },
      "description": "The job, to size the product's lead (page size with bleed, pages, plate names)."
    }
  }
}

get_artwork_requirements

What a print-ready file must be for a product and configuration: finished size, bleed, safe zone, the PDF page size including bleed, pages or sides expected, the spot plate names a spot finish needs, the cut line rule, resolution, accepted file types and the size limit. The same rules the product page's guide card uses.

read-only

Argument	Type	Description
product_id*	string
configuration	object	The job, as option ids from get_product. Everything optional: the result says what is missing.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "product_id"
  ],
  "properties": {
    "product_id": {
      "type": "string"
    },
    "configuration": {
      "type": "object",
      "properties": {
        "pages": {
          "type": "integer",
          "maximum": 9007199254740991,
          "description": "Booklets: page count, one of the pages field's presets.",
          "exclusiveMinimum": 0
        },
        "sides": {
          "type": "integer",
          "maximum": 2,
          "minimum": 1,
          "description": "1 for single-sided, 2 for double-sided."
        },
        "width": {
          "type": "number",
          "description": "Custom finished width in mm (with height), within the size field's limits.",
          "exclusiveMinimum": 0
        },
        "height": {
          "type": "number",
          "description": "Custom finished height in mm (with width).",
          "exclusiveMinimum": 0
        },
        "sizeId": {
          "type": "string",
          "description": "A preset size id from get_product's size field. Or give width and height for a custom size."
        },
        "designs": {
          "type": "integer",
          "maximum": 500,
          "minimum": 1,
          "description": "Several different designs with the same specs on one item, where get_product offers designs."
        },
        "stockId": {
          "type": "string",
          "description": "Stock id from the stock field."
        },
        "quantity": {
          "type": "integer",
          "maximum": 9007199254740991,
          "description": "How many. With designs above 1, how many of EACH design.",
          "exclusiveMinimum": 0
        },
        "orientation": {
          "enum": [
            "portrait",
            "landscape"
          ],
          "type": "string"
        },
        "coverStockId": {
          "type": "string",
          "description": "Booklets: cover stock id, or self for a self cover."
        },
        "finishingIds": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "maxItems": 30,
          "description": "Finishing option ids, from every finishing field the customer chose."
        },
        "stickerShape": {
          "enum": [
            "square",
            "circle",
            "custom"
          ],
          "type": "string"
        },
        "coverFinishingIds": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "maxItems": 10,
          "description": "Booklets: cover finishing ids."
        },
        "attributeSelections": {
          "type": "object",
          "description": "Simple products: attribute name to the chosen value's label.",
          "propertyNames": {
            "type": "string"
          },
          "additionalProperties": {
            "type": "string"
          }
        }
      },
      "description": "The job, as option ids from get_product. Everything optional: the result says what is missing."
    }
  }
}

get_artwork_uploader_link

The printdash.io page whose own uploader takes artwork for this line: checkout for a cart line, the quote page for a saved quote's line, the order page for an order job. It opens signed in in the browser the customer connected with. Use it when the customer has the file but the chat cannot send it. Refused when the line's artwork can no longer change. Needs a signed-in Printdash account: called without one, the connection asks the customer to sign in on printdash.io.

read-only

Argument	Type	Description
target*	object	Where the artwork goes.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "target"
  ],
  "properties": {
    "target": {
      "type": "object",
      "required": [
        "kind",
        "id"
      ],
      "properties": {
        "id": {
          "type": "string",
          "maxLength": 64,
          "minLength": 1,
          "description": "The line_id or item_id."
        },
        "kind": {
          "enum": [
            "cart_line",
            "quote_line",
            "order_item"
          ],
          "type": "string",
          "description": "cart_line (line_id from get_cart), quote_line (line_id from get_quote) or order_item (item_id from get_order)."
        },
        "side": {
          "enum": [
            "front",
            "back"
          ],
          "type": "string",
          "description": "front (default) or back, on a double-sided job."
        },
        "design": {
          "type": "integer",
          "maximum": 500,
          "minimum": 1,
          "description": "Which design (1 to N) on a job with several designs. Omit on a one-design job."
        }
      },
      "description": "Where the artwork goes."
    }
  }
}

get_cart

The cart in the current buying context: each line with its line_id, job summary, price inc GST and whether it has artwork, the total before delivery, and the checkout link. Needs a signed-in Printdash account: called without one, the connection asks the customer to sign in on printdash.io.

read-only

No arguments.

Input schema (JSON)

{
  "type": "object",
  "properties": {}
}

get_invoice

The tax invoice for one order as a PDF attached to the result, once the order is invoiced (paid, or on a Team's account once approved). Otherwise it says plainly that there is no invoice yet. The order page link has Download invoice too. Needs a signed-in Printdash account: called without one, the connection asks the customer to sign in on printdash.io.

read-only

Argument	Type	Description
order*	string	The order number (or the order id from its link).

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "order"
  ],
  "properties": {
    "order": {
      "type": "string",
      "maxLength": 64,
      "minLength": 1,
      "description": "The order number (or the order id from its link)."
    }
  }
}

get_mockup

The 3D mockup of a line's artwork on the product, as an image. An order job is rendered by Printdash's server and cached; if it is still rendering the result says so and you call again in about 20 seconds. A cart or quote line returns the mockup checkout or the quote page stored, or else Printdash's server renders it the same way (rendering, then call again); the flat preview comes back when there is no 3D view to show. Needs a signed-in Printdash account: called without one, the connection asks the customer to sign in on printdash.io.

read-only

Argument	Type	Description
target*	object	Where the artwork goes.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "target"
  ],
  "properties": {
    "target": {
      "type": "object",
      "required": [
        "kind",
        "id"
      ],
      "properties": {
        "id": {
          "type": "string",
          "maxLength": 64,
          "minLength": 1,
          "description": "The line_id or item_id."
        },
        "kind": {
          "enum": [
            "cart_line",
            "quote_line",
            "order_item"
          ],
          "type": "string",
          "description": "cart_line (line_id from get_cart), quote_line (line_id from get_quote) or order_item (item_id from get_order)."
        },
        "side": {
          "enum": [
            "front",
            "back"
          ],
          "type": "string",
          "description": "front (default) or back, on a double-sided job."
        },
        "design": {
          "type": "integer",
          "maximum": 500,
          "minimum": 1,
          "description": "Which design (1 to N) on a job with several designs. Omit on a one-design job."
        }
      },
      "description": "Where the artwork goes."
    }
  }
}

get_order

One order by its order number: status and payment as the order page shows them, every item with its job status, tracking, dispatch, delivery address, whether it can still be cancelled, whether the invoice is available, which items can be reordered, and the order page link. Read only. Needs a signed-in Printdash account: called without one, the connection asks the customer to sign in on printdash.io.

read-only

Argument	Type	Description
order*	string	The order number (or the order id from its link).

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "order"
  ],
  "properties": {
    "order": {
      "type": "string",
      "maxLength": 64,
      "minLength": 1,
      "description": "The order number (or the order id from its link)."
    }
  }
}

get_product

The whole option form for one Printdash product, as its product page offers it: every field in the order to ask, whether it is required, each option's id and label, defaults, quantity and custom size limits, page counts, what is applied automatically, which stocks a finish is priced on, the product image, the artwork guides that apply, and default_configuration (the page's starting job, ready for price_job). Read this before asking the customer anything. Printdash prints in Australia and delivers within Australia only; prices are in AUD and include GST.

read-only

Argument	Type	Description
product_id*	string	A product id from list_products or search_products.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "product_id"
  ],
  "properties": {
    "product_id": {
      "type": "string",
      "description": "A product id from list_products or search_products."
    }
  }
}

get_quote

One saved quote by its quote number: status, lines with their quoted quantities, the lines' subtotal, delivery and the total with delivery as the quote page shows it, expiry, the public share link if it has one, whether it can be converted to an order, and the quote page link. Read only. Needs a signed-in Printdash account: called without one, the connection asks the customer to sign in on printdash.io.

read-only

Argument	Type	Description
quote*	string	The quote number (or the quote id from its link).

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "quote"
  ],
  "properties": {
    "quote": {
      "type": "string",
      "maxLength": 64,
      "minLength": 1,
      "description": "The quote number (or the quote id from its link)."
    }
  }
}

get_quote_request

One custom quote request by its request number: what was asked for, its status, whether it can still be cancelled, and the quote it became. Needs a signed-in Printdash account: called without one, the connection asks the customer to sign in on printdash.io.

read-only

Argument	Type	Description
request*	string	The request number (or the request id from its link).

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "request"
  ],
  "properties": {
    "request": {
      "type": "string",
      "maxLength": 64,
      "minLength": 1,
      "description": "The request number (or the request id from its link)."
    }
  }
}

get_referral_summary

The customer's referral code and link, how many customers and orders they have referred, their credit balance and commission. Needs a signed-in Printdash account: called without one, the connection asks the customer to sign in on printdash.io.

read-only

No arguments.

Input schema (JSON)

{
  "type": "object",
  "properties": {}
}

list_addresses

The saved delivery addresses in the current buying context, the default first, with the ids price_job and estimate_delivery take. Needs a signed-in Printdash account: called without one, the connection asks the customer to sign in on printdash.io.

read-only

No arguments.

Input schema (JSON)

{
  "type": "object",
  "properties": {}
}

list_artwork

The files on a cart line, quote line or order job, in order, with which file and page is each design's front and back (as the site resolves them), how many designs are ready, whether the artwork can still change, and the uploader link. Needs a signed-in Printdash account: called without one, the connection asks the customer to sign in on printdash.io.

read-only

Argument	Type	Description
target*	object	Where the artwork goes.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "target"
  ],
  "properties": {
    "target": {
      "type": "object",
      "required": [
        "kind",
        "id"
      ],
      "properties": {
        "id": {
          "type": "string",
          "maxLength": 64,
          "minLength": 1,
          "description": "The line_id or item_id."
        },
        "kind": {
          "enum": [
            "cart_line",
            "quote_line",
            "order_item"
          ],
          "type": "string",
          "description": "cart_line (line_id from get_cart), quote_line (line_id from get_quote) or order_item (item_id from get_order)."
        },
        "side": {
          "enum": [
            "front",
            "back"
          ],
          "type": "string",
          "description": "front (default) or back, on a double-sided job."
        },
        "design": {
          "type": "integer",
          "maximum": 500,
          "minimum": 1,
          "description": "Which design (1 to N) on a job with several designs. Omit on a one-design job."
        }
      },
      "description": "Where the artwork goes."
    }
  }
}

list_orders

The most recent orders in the current buying context, each with its status as the order page shows it, payment, total, tracking and items. Read only. Needs a signed-in Printdash account: called without one, the connection asks the customer to sign in on printdash.io.

read-only

Argument	Type	Description
limit	integer	How many, newest first (default 10).

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "limit": {
      "type": "integer",
      "maximum": 20,
      "minimum": 1,
      "description": "How many, newest first (default 10)."
    }
  }
}

list_pending_approvals

For a Team owner: every held order of each Team they own, oldest first, with who placed it, the total, whether it is on account, its items and its page. An account that owns no Team is told only an owner approves. Needs a signed-in Printdash account: called without one, the connection asks the customer to sign in on printdash.io.

read-only

No arguments.

Input schema (JSON)

{
  "type": "object",
  "properties": {}
}

list_products

Every product Printdash sells (business cards, flyers, stickers, labels, booklets, signs, banners and more), with its id, a one-line description and its page. Start here or with search_products. No prices: price_job prices an exact job. Printdash prints in Australia and delivers within Australia only; prices are in AUD and include GST.

read-only

No arguments.

Input schema (JSON)

{
  "type": "object",
  "properties": {}
}

list_quote_requests

The customer's custom quote requests in the current buying context, newest first, each with its status as /quotes shows it and the quote it became, if any. Needs a signed-in Printdash account: called without one, the connection asks the customer to sign in on printdash.io.

read-only

No arguments.

Input schema (JSON)

{
  "type": "object",
  "properties": {}
}

list_quotes

The most recent saved quotes in the current buying context, each with its status as the Quotes list shows it, total (with delivery, as the Quotes list shows it), expiry and link. Read only. Needs a signed-in Printdash account: called without one, the connection asks the customer to sign in on printdash.io.

read-only

Argument	Type	Description
limit	integer	How many, newest first (default 10).

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "limit": {
      "type": "integer",
      "maximum": 20,
      "minimum": 1,
      "description": "How many, newest first (default 10)."
    }
  }
}

match_options

Turns the customer's words ("velvet", "A5", "double sided", "500", "90 x 55mm", "round corners") into option ids for one product, given what is already chosen. Returns matches, the ambiguous phrases with every candidate (never a guess: ask the customer), options not available with what is chosen, the words it could not place, and the configuration so far for price_job.

read-only

Argument	Type	Description
chosen	object	What is already chosen, so options are filtered by it (finishes the chosen stock does not offer, combinations the supplier cannot make).
phrases*	array	The customer's words, one option each: ["velvet", "A5", "double sided", "500"].
product_id*	string

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "product_id",
    "phrases"
  ],
  "properties": {
    "chosen": {
      "type": "object",
      "properties": {
        "pages": {
          "type": "integer",
          "maximum": 9007199254740991,
          "description": "Booklets: page count, one of the pages field's presets.",
          "exclusiveMinimum": 0
        },
        "sides": {
          "type": "integer",
          "maximum": 2,
          "minimum": 1,
          "description": "1 for single-sided, 2 for double-sided."
        },
        "width": {
          "type": "number",
          "description": "Custom finished width in mm (with height), within the size field's limits.",
          "exclusiveMinimum": 0
        },
        "height": {
          "type": "number",
          "description": "Custom finished height in mm (with width).",
          "exclusiveMinimum": 0
        },
        "sizeId": {
          "type": "string",
          "description": "A preset size id from get_product's size field. Or give width and height for a custom size."
        },
        "designs": {
          "type": "integer",
          "maximum": 500,
          "minimum": 1,
          "description": "Several different designs with the same specs on one item, where get_product offers designs."
        },
        "stockId": {
          "type": "string",
          "description": "Stock id from the stock field."
        },
        "quantity": {
          "type": "integer",
          "maximum": 9007199254740991,
          "description": "How many. With designs above 1, how many of EACH design.",
          "exclusiveMinimum": 0
        },
        "orientation": {
          "enum": [
            "portrait",
            "landscape"
          ],
          "type": "string"
        },
        "coverStockId": {
          "type": "string",
          "description": "Booklets: cover stock id, or self for a self cover."
        },
        "finishingIds": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "maxItems": 30,
          "description": "Finishing option ids, from every finishing field the customer chose."
        },
        "stickerShape": {
          "enum": [
            "square",
            "circle",
            "custom"
          ],
          "type": "string"
        },
        "coverFinishingIds": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "maxItems": 10,
          "description": "Booklets: cover finishing ids."
        },
        "attributeSelections": {
          "type": "object",
          "description": "Simple products: attribute name to the chosen value's label.",
          "propertyNames": {
            "type": "string"
          },
          "additionalProperties": {
            "type": "string"
          }
        }
      },
      "description": "What is already chosen, so options are filtered by it (finishes the chosen stock does not offer, combinations the supplier cannot make)."
    },
    "phrases": {
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 120
      },
      "maxItems": 20,
      "minItems": 1,
      "description": "The customer's words, one option each: [\"velvet\", \"A5\", \"double sided\", \"500\"]."
    },
    "product_id": {
      "type": "string"
    }
  }
}

ping

Checks that Printdash is reachable and says whether you are signed in. Printdash prints in Australia and delivers within Australia only; prices are in AUD and include GST.

read-only

No arguments.

Input schema (JSON)

{
  "type": "object",
  "properties": {}
}

place_order

Places the order prepare_checkout summarised, after the customer has seen that summary and said yes. Pass its confirmation_token and a new UUID as idempotency_key; retrying with the same key returns the same order and never places a second. Printdash re-prices every line and refuses a price that moved since the review (then call prepare_checkout again). Payment never happens here: a card order comes back with payment_url, the order page on printdash.io where the customer pays; an on-account order needs no payment; a held order waits for a Team owner. Never call it without the customer's agreement. Needs a signed-in Printdash account: called without one, the connection asks the customer to sign in on printdash.io.

destructive

Argument	Type	Description
idempotency_key*	string	A UUID you generate for this order; reuse it only to retry the same one.
confirmation_token*	string	The confirmation_token prepare_checkout returned.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "confirmation_token",
    "idempotency_key"
  ],
  "properties": {
    "idempotency_key": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
      "description": "A UUID you generate for this order; reuse it only to retry the same one."
    },
    "confirmation_token": {
      "type": "string",
      "maxLength": 32768,
      "description": "The confirmation_token prepare_checkout returned."
    }
  }
}

prepare_checkout

Checkout's review of the whole cart in the current buying context, as printdash.io's checkout shows it: every line with its artwork state and Printdash's file notices, delivery to a saved address (address_id, else the default) or pickup where the account has it, the order reference (required, up to 50 characters), notes, a PO number for a Team on account, is_whitelabel (Remove Printdash Branding), the totals from Printdash's own delivery pricing, expected_total, and what placing it will do: placed unpaid with a pay link on printdash.io, on the Team's account, or held for a Team owner's approval. When it is ready, the summary and a confirmation_token for place_order. Writes nothing; nothing is ordered until place_order is called after the customer agrees. Printdash prints in Australia and delivers within Australia only; prices are in AUD and include GST. Needs a signed-in Printdash account: called without one, the connection asks the customer to sign in on printdash.io.

read-only

Argument	Type	Description
notes	string	Notes for Printdash's team about this order.
po_number	string	A Team on account: the purchase order number (required when the Team says so).
reference	string	The order reference, required as at checkout: a name for this order. Kept to 50 characters.
address_id	string	A saved address id for delivery (list_addresses). Omit for the context's default address.
fulfilment	string	pickup only where the account has it (pickup_available).

price_job

Prices one exact job with Printdash's pricing engine: a product id and a configuration of option ids (from get_product or match_options). Returns the price ex GST, GST and total inc GST, turnaround, a config_id and a share_url that opens the job on printdash.io; with an Australian postcode (or, signed in, a saved address id) the delivered price too. Signed in, the price is the customer's own account price. If the job cannot be priced it says what is missing, what is wrong, or the nearest combinations that can be. Relay prices exactly as returned. Printdash prints in Australia and delivers within Australia only; prices are in AUD and include GST.

read-only

Argument	Type	Description
postcode	string	An Australian postcode (four digits) for the delivered price. Printdash delivers within Australia only.
address_id	string	Signed in: a saved address id from list_addresses, instead of a postcode.
product_id*	string
configuration*	object	The job, as option ids from get_product. Everything optional: the result says what is missing.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "product_id",
    "configuration"
  ],
  "properties": {
    "postcode": {
      "type": "string",
      "maxLength": 8,
      "description": "An Australian postcode (four digits) for the delivered price. Printdash delivers within Australia only."
    },
    "address_id": {
      "type": "string",
      "maxLength": 64,
      "description": "Signed in: a saved address id from list_addresses, instead of a postcode."
    },
    "product_id": {
      "type": "string"
    },
    "configuration": {
      "type": "object",
      "properties": {
        "pages": {
          "type": "integer",
          "maximum": 9007199254740991,
          "description": "Booklets: page count, one of the pages field's presets.",
          "exclusiveMinimum": 0
        },
        "sides": {
          "type": "integer",
          "maximum": 2,
          "minimum": 1,
          "description": "1 for single-sided, 2 for double-sided."
        },
        "width": {
          "type": "number",
          "description": "Custom finished width in mm (with height), within the size field's limits.",
          "exclusiveMinimum": 0
        },
        "height": {
          "type": "number",
          "description": "Custom finished height in mm (with width).",
          "exclusiveMinimum": 0
        },
        "sizeId": {
          "type": "string",
          "description": "A preset size id from get_product's size field. Or give width and height for a custom size."
        },
        "designs": {
          "type": "integer",
          "maximum": 500,
          "minimum": 1,
          "description": "Several different designs with the same specs on one item, where get_product offers designs."
        },
        "stockId": {
          "type": "string",
          "description": "Stock id from the stock field."
        },
        "quantity": {
          "type": "integer",
          "maximum": 9007199254740991,
          "description": "How many. With designs above 1, how many of EACH design.",
          "exclusiveMinimum": 0
        },
        "orientation": {
          "enum": [
            "portrait",
            "landscape"
          ],
          "type": "string"
        },
        "coverStockId": {
          "type": "string",
          "description": "Booklets: cover stock id, or self for a self cover."
        },
        "finishingIds": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "maxItems": 30,
          "description": "Finishing option ids, from every finishing field the customer chose."
        },
        "stickerShape": {
          "enum": [
            "square",
            "circle",
            "custom"
          ],
          "type": "string"
        },
        "coverFinishingIds": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "maxItems": 10,
          "description": "Booklets: cover finishing ids."
        },
        "attributeSelections": {
          "type": "object",
          "description": "Simple products: attribute name to the chosen value's label.",
          "propertyNames": {
            "type": "string"
          },
          "additionalProperties": {
            "type": "string"
          }
        }
      },
      "description": "The job, as option ids from get_product. Everything optional: the result says what is missing."
    }
  }
}

price_quantities

The same job priced at up to 8 quantities (the price ladder), each from Printdash's pricing engine, with the delivered price when an Australian postcode is given. Relay prices exactly as returned. Printdash prints in Australia and delivers within Australia only; prices are in AUD and include GST.

read-only

Argument	Type	Description
postcode	string	An Australian postcode (four digits) for the delivered price. Printdash delivers within Australia only.
address_id	string	Signed in: a saved address id from list_addresses, instead of a postcode.
product_id*	string
quantities*	array	Up to 8 quantities, for example [250, 500, 1000, 2000].
configuration*	object	The job without its quantity (any quantity given is replaced).

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "product_id",
    "configuration",
    "quantities"
  ],
  "properties": {
    "postcode": {
      "type": "string",
      "maxLength": 8,
      "description": "An Australian postcode (four digits) for the delivered price. Printdash delivers within Australia only."
    },
    "address_id": {
      "type": "string",
      "maxLength": 64,
      "description": "Signed in: a saved address id from list_addresses, instead of a postcode."
    },
    "product_id": {
      "type": "string"
    },
    "quantities": {
      "type": "array",
      "items": {
        "type": "integer",
        "maximum": 9007199254740991,
        "exclusiveMinimum": 0
      },
      "maxItems": 8,
      "minItems": 1,
      "description": "Up to 8 quantities, for example [250, 500, 1000, 2000]."
    },
    "configuration": {
      "type": "object",
      "properties": {
        "pages": {
          "type": "integer",
          "maximum": 9007199254740991,
          "description": "Booklets: page count, one of the pages field's presets.",
          "exclusiveMinimum": 0
        },
        "sides": {
          "type": "integer",
          "maximum": 2,
          "minimum": 1,
          "description": "1 for single-sided, 2 for double-sided."
        },
        "width": {
          "type": "number",
          "description": "Custom finished width in mm (with height), within the size field's limits.",
          "exclusiveMinimum": 0
        },
        "height": {
          "type": "number",
          "description": "Custom finished height in mm (with width).",
          "exclusiveMinimum": 0
        },
        "sizeId": {
          "type": "string",
          "description": "A preset size id from get_product's size field. Or give width and height for a custom size."
        },
        "designs": {
          "type": "integer",
          "maximum": 500,
          "minimum": 1,
          "description": "Several different designs with the same specs on one item, where get_product offers designs."
        },
        "stockId": {
          "type": "string",
          "description": "Stock id from the stock field."
        },
        "quantity": {
          "type": "integer",
          "maximum": 9007199254740991,
          "description": "How many. With designs above 1, how many of EACH design.",
          "exclusiveMinimum": 0
        },
        "orientation": {
          "enum": [
            "portrait",
            "landscape"
          ],
          "type": "string"
        },
        "coverStockId": {
          "type": "string",
          "description": "Booklets: cover stock id, or self for a self cover."
        },
        "finishingIds": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "maxItems": 30,
          "description": "Finishing option ids, from every finishing field the customer chose."
        },
        "stickerShape": {
          "enum": [
            "square",
            "circle",
            "custom"
          ],
          "type": "string"
        },
        "coverFinishingIds": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "maxItems": 10,
          "description": "Booklets: cover finishing ids."
        },
        "attributeSelections": {
          "type": "object",
          "description": "Simple products: attribute name to the chosen value's label.",
          "propertyNames": {
            "type": "string"
          },
          "additionalProperties": {
            "type": "string"
          }
        }
      },
      "description": "The job without its quantity (any quantity given is replaced)."
    }
  }
}

reject_order

For a Team owner: prepares rejecting one held order, with an optional reason the member who placed it is told, and returns the summary to show the customer and a confirmation_token. Nothing is decided until confirm is called after they agree. Rejecting cancels the order. Needs a signed-in Printdash account: called without one, the connection asks the customer to sign in on printdash.io.

destructive

Argument	Type	Description
order*	string	The order number (or the order id from its link).
reason	string	Why, in the owner's words; the member who placed it is told.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "order"
  ],
  "properties": {
    "order": {
      "type": "string",
      "maxLength": 64,
      "minLength": 1,
      "description": "The order number (or the order id from its link)."
    },
    "reason": {
      "type": "string",
      "maxLength": 500,
      "description": "Why, in the owner's words; the member who placed it is told."
    }
  }
}

remove_artwork

Takes artwork off a line: one design's file (design, and side for one face only), or on a one-design job the front, the back, or (no side) every file. The file itself is deleted only if no other line, quote or order uses it. Refused when the line's artwork can no longer change. Needs a signed-in Printdash account: called without one, the connection asks the customer to sign in on printdash.io.

destructive

Argument	Type	Description
target*	object	The line, and the design (and side, for one face only) to remove. On a one-design job, no side removes every file.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "target"
  ],
  "properties": {
    "target": {
      "type": "object",
      "required": [
        "kind",
        "id"
      ],
      "properties": {
        "id": {
          "type": "string",
          "maxLength": 64,
          "minLength": 1,
          "description": "The line_id or item_id."
        },
        "kind": {
          "enum": [
            "cart_line",
            "quote_line",
            "order_item"
          ],
          "type": "string",
          "description": "cart_line (line_id from get_cart), quote_line (line_id from get_quote) or order_item (item_id from get_order)."
        },
        "side": {
          "enum": [
            "front",
            "back"
          ],
          "type": "string",
          "description": "front (default) or back, on a double-sided job."
        },
        "design": {
          "type": "integer",
          "maximum": 500,
          "minimum": 1,
          "description": "Which design (1 to N) on a job with several designs. Omit on a one-design job."
        }
      },
      "description": "The line, and the design (and side, for one face only) to remove. On a one-design job, no side removes every file."
    }
  }
}

remove_cart_line

Removes one line from the cart by its line_id. Saved quotes are not affected. Needs a signed-in Printdash account: called without one, the connection asks the customer to sign in on printdash.io.

destructive

Argument	Type	Description
line_id*	string

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "line_id"
  ],
  "properties": {
    "line_id": {
      "type": "string",
      "maxLength": 64
    }
  }
}

reorder

Turns one job from a past order (item_id from get_order, where can_reorder is true) back into a configuration and prices it at today's price, optionally at another quantity, exactly as price_job does. Writes nothing: add_to_cart with its product_id and configuration_input puts it in the cart. Jobs priced by Printdash's team (reorder_by_request) go through request_reorder instead. Printdash prints in Australia and delivers within Australia only; prices are in AUD and include GST. Needs a signed-in Printdash account: called without one, the connection asks the customer to sign in on printdash.io.

read-only

Argument	Type	Description
order*	string	The order number (or the order id from its link).
item_id	string	The job's item_id from get_order (optional on a one-job order).
quantity	integer	Another quantity; omit for the same.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "order"
  ],
  "properties": {
    "order": {
      "type": "string",
      "maxLength": 64,
      "minLength": 1,
      "description": "The order number (or the order id from its link)."
    },
    "item_id": {
      "type": "string",
      "maxLength": 64,
      "description": "The job's item_id from get_order (optional on a one-job order)."
    },
    "quantity": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Another quantity; omit for the same.",
      "exclusiveMinimum": 0
    }
  }
}

request_artwork_upload

For a client that holds the file (Claude Code, Cursor, a script): returns a signed upload_url to PUT the file's bytes to, and an upload_id for attach_artwork. target says where it goes: a cart line (line_id from get_cart), a saved quote's line (line_id from get_quote) or an order job (item_id from get_order), plus design (1 to N, on a job with several designs) and side (front or back). Give the file name with its extension (pdf is best; ai, eps, psd, jpg, png and tif are accepted) and its size in bytes, up to 700 MB. Refused when the line's artwork can no longer change. A chat client that cannot send a file should use attach_artwork_from_url or get_artwork_uploader_link instead. Needs a signed-in Printdash account: called without one, the connection asks the customer to sign in on printdash.io.

Argument	Type	Description
target*	object	Where the artwork goes.
file_name*	string	The file's name with its extension: business-card.pdf. PDF is best.
size_bytes*	integer	The file's size in bytes (up to 700 MB).
content_type	string	Optional; the type is decided by the extension, as the site's uploaders do.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "target",
    "file_name",
    "size_bytes"
  ],
  "properties": {
    "target": {
      "type": "object",
      "required": [
        "kind",
        "id"
      ],
      "properties": {
        "id": {
          "type": "string",
          "maxLength": 64,
          "minLength": 1,
          "description": "The line_id or item_id."
        },
        "kind": {
          "enum": [
            "cart_line",
            "quote_line",
            "order_item"
          ],
          "type": "string",
          "description": "cart_line (line_id from get_cart), quote_line (line_id from get_quote) or order_item (item_id from get_order)."
        },
        "side": {
          "enum": [
            "front",
            "back"
          ],
          "type": "string",
          "description": "front (default) or back, on a double-sided job."
        },
        "design": {
          "type": "integer",
          "maximum": 500,
          "minimum": 1,
          "description": "Which design (1 to N) on a job with several designs. Omit on a one-design job."
        }
      },
      "description": "Where the artwork goes."
    },
    "file_name": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1,
      "description": "The file's name with its extension: business-card.pdf. PDF is best."
    },
    "size_bytes": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "The file's size in bytes (up to 700 MB).",
      "exclusiveMinimum": 0
    },
    "content_type": {
      "type": "string",
      "maxLength": 100,
      "description": "Optional; the type is decided by the extension, as the site's uploaders do."
    }
  }
}

request_custom_quote

Prepares a custom quote request for a job the catalogue does not cover (description, quantities, size, sides, stock, finishing, deadline, similar product, delivery address): returns the summary to show the customer and a confirmation_token. Nothing is filed or emailed until confirm is called after the customer agrees; then Printdash's team prices it by hand. Needs a signed-in Printdash account: called without one, the connection asks the customer to sign in on printdash.io.

destructive

Argument	Type	Description
size	string	Finished size, for example 90 x 55mm or A5.
sides	integer
stock	string
deadline	string	Date needed, YYYY-MM-DD.
finishing	string
address_id	string	A saved address id for delivery.
quantities*	array
description*	string	The job in the customer's words: what it is, size, material, finish.

request_reorder

For a job on a past order that Printdash's team priced (reorder_by_request in get_order): prepares the order page's reorder request, at the same or another quantity with optional notes, and returns the summary to show the customer and a confirmation_token. Nothing is filed until confirm is called after the customer agrees; then the team confirms today's price and sends a quote or pay link. Needs a signed-in Printdash account: called without one, the connection asks the customer to sign in on printdash.io.

Argument	Type	Description
notes	string	Any change to the specs, in the customer's words.
order*	string	The order number (or the order id from its link).
item_id	string	The job's item_id from get_order (optional on a one-job order).
quantity	integer

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "order"
  ],
  "properties": {
    "notes": {
      "type": "string",
      "maxLength": 1000,
      "description": "Any change to the specs, in the customer's words."
    },
    "order": {
      "type": "string",
      "maxLength": 64,
      "minLength": 1,
      "description": "The order number (or the order id from its link)."
    },
    "item_id": {
      "type": "string",
      "maxLength": 64,
      "description": "The job's item_id from get_order (optional on a one-job order)."
    },
    "quantity": {
      "type": "integer",
      "maximum": 9007199254740991,
      "exclusiveMinimum": 0
    }
  }
}

search_products

Finds the Printdash products that match the customer's words ("A5 flyers", "round stickers", "pull up banner"), best first. Returns ids for get_product. Printdash prints in Australia and delivers within Australia only; prices are in AUD and include GST.

read-only

Argument	Type	Description
query*	string	The customer's words for what they want printed.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "query"
  ],
  "properties": {
    "query": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1,
      "description": "The customer's words for what they want printed."
    }
  }
}

send_invite

Prepares emailing someone an invitation with the customer's referral link: returns the summary to show the customer and a confirmation_token. Nothing is sent until confirm is called after the customer agrees. Needs a signed-in Printdash account: called without one, the connection asks the customer to sign in on printdash.io.

destructive

Argument	Type	Description
email*	string	Who to invite (not the customer's own address).

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "email"
  ],
  "properties": {
    "email": {
      "type": "string",
      "maxLength": 200,
      "description": "Who to invite (not the customer's own address)."
    }
  }
}

set_context

Switches the account between buying personally and buying as one of its Teams, as the account menu's Viewing as does on printdash.io. Prices, quotes, orders and addresses follow the context. Pass team_id null for personal. Needs a signed-in Printdash account: called without one, the connection asks the customer to sign in on printdash.io.

destructive

Argument	Type	Description
team_id*	string \| null	A team_id from get_account's contexts, or null for personal.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "team_id"
  ],
  "properties": {
    "team_id": {
      "type": [
        "string",
        "null"
      ],
      "description": "A team_id from get_account's contexts, or null for personal."
    }
  }
}

set_default_address

Makes one saved address the default for the current buying context; checkout and new quotes start from it. Needs a signed-in Printdash account: called without one, the connection asks the customer to sign in on printdash.io.

destructive

Argument	Type	Description
address_id*	string

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "address_id"
  ],
  "properties": {
    "address_id": {
      "type": "string",
      "maxLength": 64
    }
  }
}

share_quote

Makes, or returns the existing, public link for a saved quote: the page where the customer's client can view and approve it, and pay online when allow_payment is on. The link never changes once made. It sends nothing (email_quote does). Needs a signed-in Printdash account: called without one, the connection asks the customer to sign in on printdash.io.

destructive

Argument	Type	Description
quote*	string	The quote number (or the quote id from its link).
allow_payment	boolean	Let the recipient pay online from the link. Omit to keep the quote's current setting (off for a new link).

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "quote"
  ],
  "properties": {
    "quote": {
      "type": "string",
      "maxLength": 64,
      "minLength": 1,
      "description": "The quote number (or the quote id from its link)."
    },
    "allow_payment": {
      "type": "boolean",
      "description": "Let the recipient pay online from the link. Omit to keep the quote's current setting (off for a new link)."
    }
  }
}

update_address

Changes the fields given on one saved address (from list_addresses); the rest stay. If an order or quote was made with it, the change is saved as a new address with a new id (the result's address.id) and the orders and quotes keep the old one. Australian state codes and four-digit postcodes only. Needs a signed-in Printdash account: called without one, the connection asks the customer to sign in on printdash.io.

destructive

Argument	Type	Description
city	string	Suburb or town.
type	string
state	string	NSW, VIC, QLD, SA, WA, TAS, NT or ACT.
mobile	string
last_name	string
address_id*	string	An address id from list_addresses.
first_name	string
postal_code	string	Four-digit Australian postcode.
company_name	string

update_cart_line

Changes one cart line's options (only what is given: a new quantity, stock, finish or size) and re-prices it with the pricing engine. A line from a quote Printdash priced cannot be changed. Needs a signed-in Printdash account: called without one, the connection asks the customer to sign in on printdash.io.

destructive

Argument	Type	Description
line_id*	string	A line_id from get_cart.
configuration*	object	Only the options that change, as option ids: a new quantity, stock, finishing ids or size. Finishing ids replace the line's finishing.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "line_id",
    "configuration"
  ],
  "properties": {
    "line_id": {
      "type": "string",
      "maxLength": 64,
      "description": "A line_id from get_cart."
    },
    "configuration": {
      "type": "object",
      "properties": {
        "pages": {
          "type": "integer",
          "maximum": 9007199254740991,
          "description": "Booklets: page count, one of the pages field's presets.",
          "exclusiveMinimum": 0
        },
        "sides": {
          "type": "integer",
          "maximum": 2,
          "minimum": 1,
          "description": "1 for single-sided, 2 for double-sided."
        },
        "width": {
          "type": "number",
          "description": "Custom finished width in mm (with height), within the size field's limits.",
          "exclusiveMinimum": 0
        },
        "height": {
          "type": "number",
          "description": "Custom finished height in mm (with width).",
          "exclusiveMinimum": 0
        },
        "sizeId": {
          "type": "string",
          "description": "A preset size id from get_product's size field. Or give width and height for a custom size."
        },
        "designs": {
          "type": "integer",
          "maximum": 500,
          "minimum": 1,
          "description": "Several different designs with the same specs on one item, where get_product offers designs."
        },
        "stockId": {
          "type": "string",
          "description": "Stock id from the stock field."
        },
        "quantity": {
          "type": "integer",
          "maximum": 9007199254740991,
          "description": "How many. With designs above 1, how many of EACH design.",
          "exclusiveMinimum": 0
        },
        "orientation": {
          "enum": [
            "portrait",
            "landscape"
          ],
          "type": "string"
        },
        "coverStockId": {
          "type": "string",
          "description": "Booklets: cover stock id, or self for a self cover."
        },
        "finishingIds": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "maxItems": 30,
          "description": "Finishing option ids, from every finishing field the customer chose."
        },
        "stickerShape": {
          "enum": [
            "square",
            "circle",
            "custom"
          ],
          "type": "string"
        },
        "coverFinishingIds": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "maxItems": 10,
          "description": "Booklets: cover finishing ids."
        },
        "attributeSelections": {
          "type": "object",
          "description": "Simple products: attribute name to the chosen value's label.",
          "propertyNames": {
            "type": "string"
          },
          "additionalProperties": {
            "type": "string"
          }
        }
      },
      "description": "Only the options that change, as option ids: a new quantity, stock, finishing ids or size. Finishing ids replace the line's finishing."
    }
  }
}

update_quote

Changes a saved quote in place: lines to change (line_id plus only the options that change) or add (product_id and configuration), lines to remove, the reference, notes or delivery address. Changed and added lines are re-priced by the engine; untouched lines keep their prices. Accepted, ordered, expired and team-priced quotes cannot be changed. Needs a signed-in Printdash account: called without one, the connection asks the customer to sign in on printdash.io.

destructive

Argument	Type	Description
lines	array
notes	any
quote*	string	The quote number (or the quote id from its link).
reference	any
address_id	any	A saved address id, or null to clear it.
remove_line_ids	array

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "quote"
  ],
  "properties": {
    "lines": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "line_id": {
            "type": "string",
            "maxLength": 64,
            "description": "A line to change (from get_quote or create_quote). Omit to add a new line."
          },
          "product_id": {
            "type": "string",
            "description": "For a new line: the product id."
          },
          "configuration": {
            "type": "object",
            "properties": {
              "pages": {
                "type": "integer",
                "maximum": 9007199254740991,
                "description": "Booklets: page count, one of the pages field's presets.",
                "exclusiveMinimum": 0
              },
              "sides": {
                "type": "integer",
                "maximum": 2,
                "minimum": 1,
                "description": "1 for single-sided, 2 for double-sided."
              },
              "width": {
                "type": "number",
                "description": "Custom finished width in mm (with height), within the size field's limits.",
                "exclusiveMinimum": 0
              },
              "height": {
                "type": "number",
                "description": "Custom finished height in mm (with width).",
                "exclusiveMinimum": 0
              },
              "sizeId": {
                "type": "string",
                "description": "A preset size id from get_product's size field. Or give width and height for a custom size."
              },
              "designs": {
                "type": "integer",
                "maximum": 500,
                "minimum": 1,
                "description": "Several different designs with the same specs on one item, where get_product offers designs."
              },
              "stockId": {
                "type": "string",
                "description": "Stock id from the stock field."
              },
              "quantity": {
                "type": "integer",
                "maximum": 9007199254740991,
                "description": "How many. With designs above 1, how many of EACH design.",
                "exclusiveMinimum": 0
              },
              "orientation": {
                "enum": [
                  "portrait",
                  "landscape"
                ],
                "type": "string"
              },
              "coverStockId": {
                "type": "string",
                "description": "Booklets: cover stock id, or self for a self cover."
              },
              "finishingIds": {
                "type": "array",
                "items": {
                  "type": "string"
                },
                "maxItems": 30,
                "description": "Finishing option ids, from every finishing field the customer chose."
              },
              "stickerShape": {
                "enum": [
                  "square",
                  "circle",
                  "custom"
                ],
                "type": "string"
              },
              "coverFinishingIds": {
                "type": "array",
                "items": {
                  "type": "string"
                },
                "maxItems": 10,
                "description": "Booklets: cover finishing ids."
              },
              "attributeSelections": {
                "type": "object",
                "description": "Simple products: attribute name to the chosen value's label.",
                "propertyNames": {
                  "type": "string"
                },
                "additionalProperties": {
                  "type": "string"
                }
              }
            },
            "description": "For a changed line: only the options that change. For a new line: the whole configuration."
          }
        }
      },
      "maxItems": 20
    },
    "notes": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 1000
        },
        {
          "type": "null"
        }
      ]
    },
    "quote": {
      "type": "string",
      "maxLength": 64,
      "minLength": 1,
      "description": "The quote number (or the quote id from its link)."
    },
    "reference": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 200
        },
        {
          "type": "null"
        }
      ]
    },
    "address_id": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 64
        },
        {
          "type": "null"
        }
      ],
      "description": "A saved address id, or null to clear it."
    },
    "remove_line_ids": {
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 64
      },
      "maxItems": 20
    }
  }
}