{
"error": true,
"code": "unsupported_media_type",
"message": "Send the request body as JSON, with \"Content-Type: application/json\".",
"requestId": "FZn-uhymjoEEJow="
}
{
"message": "Too Many Requests"
}
{
"error": true,
"code": "internal_error",
"message": "Something went wrong on our side. Retry the request; if it keeps failing, contact support with the requestId.",
"requestId": "FZn-uhymjoEEJow="
}
Connectors
Test a connector
Plays a connector (saved, or one you are about to create) against a design for every choice of its field: what the product page sends, which mapping matches, and what the editor then does, such as the pages it shows or the design it opens. With url, the field and its choices are read from your product page, and the test also checks the selector finds it, the design is assigned to the product, and no other connector on the design fights it. Nothing is saved.
{
"error": true,
"code": "unsupported_media_type",
"message": "Send the request body as JSON, with \"Content-Type: application/json\".",
"requestId": "FZn-uhymjoEEJow="
}
{
"message": "Too Many Requests"
}
{
"error": true,
"code": "internal_error",
"message": "Something went wrong on our side. Retry the request; if it keeps failing, contact support with the requestId.",
"requestId": "FZn-uhymjoEEJow="
}
Authorizations
Authorization
string
header
required
A secret key from Print.App admin → Domains → Secret keys, sent as Authorization: Bearer sk_…. Server-side only.
Body
application/json
A connector to play against a design: a saved one (connectorId) or one to try before saving (connector).
designId
string
required
The design it is (or will be) attached to.
Required string length: 1 - 200
connectorId
string
A saved connector.
Required string length: 1 - 100
connector
object
A connector to try without saving it, as POST /v2/connectors takes it.
Show child attributes
url
string<uri>
The product page, to read the field and its choices from it. A page of your store only.
Maximum string length: 2000
values
(string | object)[]
The choices to play, when there is no page to read them from (or to play others than the page has): a value, or { value, label } for a choice whose label differs.
Maximum array length: 100
Maximum string length: 200
Response
OK.
What a connector does for each choice, and what stands in its way.
object
string
required
Allowed value: "connector_test"
ok
boolean
required
Every choice does what it should and nothing blocks it.
connector
Connector · object
required
Links an option on a store's product page to the editor: the choice a customer makes shows the right pages, opens the right design, sets the size or the colour.
One per choice played (pageCount and printedPageCount: one per page count).
Show child attributes
issues
object[]
required
Show child attributes
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Print.App Documentation","colors":{"primary":"#00AC13","light":"#00CD17","dark":"#008B10"},"logo":{"light":"https://mintcdn.com/printapp/8ZfPxlJeGBl6BLAD/logo/light.svg?fit=max\u0026auto=format\u0026n=8ZfPxlJeGBl6BLAD\u0026q=85\u0026s=f2dc8c61d71358f310658fb8b3756287","dark":"https://mintcdn.com/printapp/8ZfPxlJeGBl6BLAD/logo/dark.svg?fit=max\u0026auto=format\u0026n=8ZfPxlJeGBl6BLAD\u0026q=85\u0026s=74402b22cc2694c2d990b57771f9422c"},"favicon":"https://mintcdn.com/printapp/CwAEBcf61sfC7N4Y/favicon.svg?fit=max\u0026auto=format\u0026n=CwAEBcf61sfC7N4Y\u0026q=85\u0026s=cb170a7b273f77e0921c312176e48c99","navbar":{"links":[{"href":"https://discord.gg/XNdtdFxNdE","label":"Community"}],"primary":{"type":"button","label":"Dashboard","href":"https://admin.print.app"}},"footer":{"socials":{"twitter":"https://twitter.com/print_dot_app","instagram":"https://github.com/print_dot_app","github":"https://github.com/printapp","discord":"https://discord.gg/XNdtdFxNdE"}},"styling":{"latex":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"printapp","hasAudioNarration":false,"actualSubdomain":"printapp","customDomains":["print.app"],"gitSource":{"type":"github","owner":"printapp","repo":"documentation","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":"","_id":"6aee29ef3dd0f82bef4f9995"},"entitlements":{},"buildId":"6af702e5d091d1e54976cd62","clientVersion":"0.0.4143","searchFilterCounts":[{"language":"default","tag":"API References","count":112},{"language":"default","tag":"Endpoints","count":100},{"language":"default","tag":"Documentation","count":64},{"language":"default","tag":"Design Guides","count":64},{"language":"default","tag":"Designs","count":35},{"language":"default","tag":"Print Options","count":24},{"language":"default","tag":"Platforms","count":18},{"language":"default","tag":"Guides","count":12},{"language":"default","tag":"Gang Sheet Builder","count":12},{"language":"default","tag":"Configuration","count":8}],"searchSettings":{"fullPageSearch":true}},"assistantConfig":{},"basePath":"/docs","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/v2/connectors/test-connector","slug":"/api-reference/v2/connectors/test-connector","pageMetadata":{"title":"Test a connector","openapi":"openapi.json POST /v2/connectors/test","description":"Plays a connector (saved, or one you are about to create) against a design for every choice of its field: what the product page sends, which mapping matches, and what the editor then does, such as the pages it shows or the design it opens. With `url`, the field and its choices are read from your product page, and the test also checks the selector finds it, the design is assigned to the product, and no other connector on the design fights it. Nothing is saved.","href":"/api-reference/v2/connectors/test-connector"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_components.p, {\n children: [\"Plays a connector (saved, or one you are about to create) against a design for every choice of its field: what the product page sends, which mapping matches, and what the editor then does, such as the pages it shows or the design it opens. With \", _jsx(_components.code, {\n children: \"url\"\n }), \", the field and its choices are read from your product page, and the test also checks the selector finds it, the design is assigned to the product, and no other connector on the design fights it. Nothing is saved.\"]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Test a connector","openapi":"openapi.json POST /v2/connectors/test","description":"Plays a connector (saved, or one you are about to create) against a design for every choice of its field: what the product page sends, which mapping matches, and what the editor then does, such as the pages it shows or the design it opens. With `url`, the field and its choices are read from your product page, and the test also checks the selector finds it, the design is assigned to the product, and no other connector on the design fights it. Nothing is saved.","href":"/api-reference/v2/connectors/test-connector"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/docs/_mintlify/custom/printapp/5668d2dd18a12f25/ga-consent.js"],"openApiReferenceData":{"operation":{"tags":["Connectors"],"operationId":"testConnector","summary":"Test a connector","description":"Plays a connector (saved, or one you are about to create) against a design for every choice of its field: what the product page sends, which mapping matches, and what the editor then does, such as the pages it shows or the design it opens. With `url`, the field and its choices are read from your product page, and the test also checks the selector finds it, the design is assigned to the product, and no other connector on the design fights it. Nothing is saved.","parameters":[],"requestBody":"537b5e39-dfb1-4b44-9537-8a40fee21ced","responses":{"200":"9f160aca-1d81-4a21-b183-55c591feb5de","400":"d7da58cb-0b77-4d77-90ad-58cf4c7dc8fd","401":"709dd2ed-a0c5-48e2-9c3b-34eba10835f9","403":"e4fee687-c076-4fee-9cbe-0a2fa2b36fd0","404":"b23a6e9a-9f6a-43ef-9c6e-b46b1ca74112","415":"f391c711-c3ca-4c30-9bd7-3f8a366d6640","429":"ec4529b4-4df7-4a51-8d6b-7b84c8d4dec3","500":"9dd32e56-0ed9-4d21-853e-9e55ce5dfb87"},"method":"post","type":"path","servers":["d00c9747-3648-481f-bbd7-e7328a87209d"],"security":["fca69934-0d8a-4a5f-a493-d8b685eade93"],"path":"/v2/connectors/test","baseUrlOptions":["https://api.print.app"],"title":"Test a connector","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"required":true,"content":{"application/json":{"schema":{"title":"ConnectorTest","description":"A connector to play against a design: a saved one (`connectorId`) or one to try before saving (`connector`).","type":"object","additionalProperties":false,"required":["designId"],"properties":{"designId":{"type":"string","minLength":1,"maxLength":200,"description":"The design it is (or will be) attached to.","isRequired":true,"uniqueKey":"designId","typeLabel":"string"},"connectorId":{"type":"string","minLength":1,"maxLength":100,"description":"A saved connector.","uniqueKey":"connectorId","typeLabel":"string"},"connector":{"type":"object","additionalProperties":false,"required":["title","mode","source"],"properties":{"title":{"type":"string","minLength":1,"maxLength":200,"description":"The connector's name, shown in the dashboard.","isRequired":true,"uniqueKey":"connector.title","typeLabel":"string"},"mode":{"type":"string","enum":["pageIndex","designSelector","templateFilter","pageClone","pageCount","printedPageCount","pageWidth","pageHeight","pageOrientation","textValue","underlayColor","event"],"description":"What the connector does:\n- `pageIndex`: Shows only the pages a choice maps to (`to`: page numbers such as `1` or `1,2`). The other pages are set aside: not shown, printed or saved.\n- `designSelector`: Opens another design for each choice (`to`: a design id). Every design it can open must be assigned to the product and carry this connector too.\n- `templateFilter`: Lists only the designs a choice maps to in the editor's Templates tab (`to`: design ids, comma-separated), and the customer picks one of them; a choice with no mapping lists them all. When the open design is not listed for a new choice, the first one listed opens. Every design listed must be assigned to the product and carry this connector too. PrintFx editor only.\n- `pageClone`: Repeats one page (`page`, default the first) as many times as the number chosen, when the editor opens.\n- `pageCount`: Sends the number of pages to the field as the customer adds or removes pages (editor to product page).\n- `printedPageCount`: Sends the number of pages (sides) that carry a print to the field, so the price can follow (editor to product page). The field takes a number.\n- `pageWidth`: Sets the page width from a number field, in the design's unit (a Print Options size field carries its own). With twoWay, a resize in the editor is sent back.\n- `pageHeight`: Sets the page height from a number field, in the design's unit (a Print Options size field carries its own). With twoWay, a resize in the editor is sent back.\n- `pageOrientation`: Turns the pages (or `page` alone) landscape or portrait, from the choice's wording or its mapping (`to`: landscape or portrait).\n- `textValue`: Puts what the customer types into the text item titled `text`. With twoWay, edits in the editor are sent back.\n- `underlayColor`: Sets the product colour of an underlay design (a T-shirt, a mug): `to` is a hex colour, or leave the choice unmapped when it is the colour's name in the design.\n- `event`: Fires an editor event (`event.name`, with `event.data`) when the field changes. For integrations that listen to editor events.","isRequired":true,"uniqueKey":"connector.mode","typeLabel":"enum\u003cstring>"},"source":{"type":"object","additionalProperties":false,"minProperties":1,"description":"Where on the product page the connector reads (and, for two-way modes, writes): a CSS selector for a control of the store's theme, or a Print Options field by `role` (preferred: one connector then works on every product) or by `field` id. `GET /v2/product-page` lists both for a page.","properties":{"selector":{"type":"string","minLength":1,"maxLength":500,"description":"A CSS selector for the control, as `GET /v2/product-page` gives it: `select[name=\"options[Size]\"]`, or `input[name=\"Color\"]:checked` for a group of radio choices.","uniqueKey":"connector.source.selector","typeLabel":"string"},"role":{"type":"string","minLength":1,"maxLength":50,"description":"A Print Options field role: `size`, `pages`, `material`, `orientation`, or the field types `quantity`, `dimensions` and `file`.","uniqueKey":"connector.source.role","typeLabel":"string"},"field":{"type":"string","minLength":1,"maxLength":100,"description":"A Print Options field id, when the field has no role.","uniqueKey":"connector.source.field","typeLabel":"string"},"axis":{"type":"string","enum":["w","h"],"description":"For a Print Options `dimensions` field: the width (`w`) or the height (`h`).","uniqueKey":"connector.source.axis","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"connector.source","typeLabel":"object"},"mappings":{"type":"array","maxItems":200,"description":"What each choice on the product page becomes in the editor. `from` is the choice as the page sends it: its value, or for dropdowns and Print Options choices also the text the customer sees (case and surrounding spaces ignored). Radio choices send their value only.","items":{"type":"object","additionalProperties":false,"required":["from","to"],"properties":{"from":{"type":"string","minLength":1,"maxLength":200,"description":"The choice: its value or (dropdowns, Print Options) its label.","isRequired":true,"uniqueKey":"connector.mappings.items.[INDEX].from","typeLabel":"string"},"to":{"type":"string","minLength":1,"maxLength":200,"description":"What it means to the editor: page numbers such as `1` or `1,2` (pageIndex), a design id (designSelector), design ids, comma-separated (templateFilter), a hex colour (underlayColor), or landscape / portrait (pageOrientation).","isRequired":true,"uniqueKey":"connector.mappings.items.[INDEX].to","typeLabel":"string"}},"uniqueKey":"connector.mappings.items.[INDEX]","typeLabel":"object"},"uniqueKey":"connector.mappings","typeLabel":"object[]"},"twoWay":{"type":"boolean","default":true,"description":"For pageWidth, pageHeight, textValue and underlayColor: also send changes made in the editor back to the product page.","uniqueKey":"connector.twoWay","typeLabel":"boolean"},"page":{"oneOf":[{"type":"integer","minimum":1,"maximum":500,"description":"For pageClone, pageWidth, pageHeight and pageOrientation: the page (from 1) it acts on. Default: the first page (pageOrientation: every page).","uniqueKey":"connector.page.oneOf.0","typeLabel":"integer"},{"type":"null","minimum":1,"maximum":500,"description":"For pageClone, pageWidth, pageHeight and pageOrientation: the page (from 1) it acts on. Default: the first page (pageOrientation: every page).","uniqueKey":"connector.page.oneOf.1","typeLabel":"null"}],"uniqueKey":"connector.page","typeLabel":"integer | null"},"text":{"oneOf":[{"type":"string","minLength":1,"maxLength":200,"description":"For textValue: the title of the text item it fills.","uniqueKey":"connector.text.oneOf.0","typeLabel":"string"},{"type":"null","minLength":1,"maxLength":200,"description":"For textValue: the title of the text item it fills.","uniqueKey":"connector.text.oneOf.1","typeLabel":"null"}],"uniqueKey":"connector.text","typeLabel":"string | null"},"event":{"oneOf":[{"type":"object","additionalProperties":false,"required":["name"],"description":"For event: the editor event to fire.","properties":{"name":{"type":"string","pattern":"^[\\w:.-]{1,100}$","description":"The event name, for example `page:select`.","isRequired":true,"uniqueKey":"connector.event.oneOf.0.name","typeLabel":"string"},"data":{"oneOf":[{"type":"string","maxLength":2000,"description":"Data sent with the event.","uniqueKey":"connector.event.oneOf.0.data.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":2000,"description":"Data sent with the event.","uniqueKey":"connector.event.oneOf.0.data.oneOf.1","typeLabel":"null"}],"uniqueKey":"connector.event.oneOf.0.data","typeLabel":"string | null"}},"uniqueKey":"connector.event.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":false,"required":["name"],"description":"For event: the editor event to fire.","properties":{"name":{"type":"string","pattern":"^[\\w:.-]{1,100}$","description":"The event name, for example `page:select`."},"data":{"oneOf":[{"type":"string","maxLength":2000,"description":"Data sent with the event."},{"type":"null","maxLength":2000,"description":"Data sent with the event."}]}},"uniqueKey":"connector.event.oneOf.1","typeLabel":"null"}],"uniqueKey":"connector.event","typeLabel":"object | null"}},"description":"A connector to try without saving it, as `POST /v2/connectors` takes it.","uniqueKey":"connector","typeLabel":"object"},"url":{"type":"string","format":"uri","maxLength":2000,"description":"The product page, to read the field and its choices from it. A page of your store only.","uniqueKey":"url","typeLabel":"string\u003curi>"},"values":{"type":"array","maxItems":100,"description":"The choices to play, when there is no page to read them from (or to play others than the page has): a value, or `{ value, label }` for a choice whose label differs.","items":{"oneOf":[{"type":"string","maxLength":200,"uniqueKey":"values.items.[INDEX].oneOf.0","typeLabel":"string"},{"type":"object","required":["value"],"properties":{"value":{"type":"string","maxLength":200,"isRequired":true,"uniqueKey":"values.items.[INDEX].oneOf.1.value","typeLabel":"string"},"label":{"type":"string","maxLength":200,"uniqueKey":"values.items.[INDEX].oneOf.1.label","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"values.items.[INDEX].oneOf.1","typeLabel":"object"}],"uniqueKey":"values.items.[INDEX]","typeLabel":"string | object"},"uniqueKey":"values","typeLabel":"(string | object)[]"}},"examples":[{"connectorId":"01KADX3Q7M2B8C4D5E6F7G8H9J","designId":"design_01J8Z9K2M3N4P5Q6R7S8T9V0W1","url":"https://shop.example.com/products/custom-tee"}],"uniqueKey":"","typeLabel":"ConnectorTest · object"},"example":{"connectorId":"01KADX3Q7M2B8C4D5E6F7G8H9J","designId":"design_01J8Z9K2M3N4P5Q6R7S8T9V0W1","url":"https://shop.example.com/products/custom-tee"},"examples":{"Example":{"title":"Example","value":{"connectorId":"01KADX3Q7M2B8C4D5E6F7G8H9J","designId":"design_01J8Z9K2M3N4P5Q6R7S8T9V0W1","url":"https://shop.example.com/products/custom-tee"}}},"exampleType":"examples"}},"exampleType":"examples"},"responses":{"9f160aca-1d81-4a21-b183-55c591feb5de":{"description":"OK.","headers":{"x-request-id":{"description":"Identifies the request. Quote it when contacting support.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"title":"ConnectorTestResult","description":"What a connector does for each choice, and what stands in its way.","type":"object","required":["object","ok","connector","design","page","results","issues"],"properties":{"object":{"type":"string","const":"connector_test","isRequired":true,"uniqueKey":"object","typeLabel":"string"},"ok":{"type":"boolean","description":"Every choice does what it should and nothing blocks it.","isRequired":true,"uniqueKey":"ok","typeLabel":"boolean"},"connector":{"title":"Connector","description":"Links an option on a store's product page to the editor: the choice a customer makes shows the right pages, opens the right design, sets the size or the colour.","type":"object","required":["object","id","title","mode","source","query","mappings","twoWay","page","text","event","created","modified"],"properties":{"object":{"type":"string","const":"connector","isRequired":true,"uniqueKey":"connector.object","typeLabel":"string"},"id":{"oneOf":[{"type":"string","description":"`null` for a connector tried in a test without saving it.","isRequired":true,"uniqueKey":"connector.id.oneOf.0","typeLabel":"string"},{"type":"null","description":"`null` for a connector tried in a test without saving it.","isRequired":true,"uniqueKey":"connector.id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"connector.id","typeLabel":"string | null"},"title":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"connector.title.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"connector.title.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"connector.title","typeLabel":"string | null"},"mode":{"type":"string","description":"One of: pageIndex, designSelector, pageClone, pageCount, printedPageCount, pageWidth, pageHeight, pageOrientation, textValue, underlayColor, event.","isRequired":true,"uniqueKey":"connector.mode","typeLabel":"string"},"source":{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["selector","printOptions"],"isRequired":true,"uniqueKey":"connector.source.type","typeLabel":"enum\u003cstring>"},"selector":{"type":"string","description":"The CSS selector (type selector).","uniqueKey":"connector.source.selector","typeLabel":"string"},"role":{"oneOf":[{"type":"string","description":"The Print Options role (type printOptions).","uniqueKey":"connector.source.role.oneOf.0","typeLabel":"string"},{"type":"null","description":"The Print Options role (type printOptions).","uniqueKey":"connector.source.role.oneOf.1","typeLabel":"null"}],"uniqueKey":"connector.source.role","typeLabel":"string | null"},"field":{"oneOf":[{"type":"string","description":"The Print Options field id (type printOptions).","uniqueKey":"connector.source.field.oneOf.0","typeLabel":"string"},{"type":"null","description":"The Print Options field id (type printOptions).","uniqueKey":"connector.source.field.oneOf.1","typeLabel":"null"}],"uniqueKey":"connector.source.field","typeLabel":"string | null"},"name":{"oneOf":[{"type":"string","description":"A Print Options field id or role, from connectors made before roles (type printOptions).","uniqueKey":"connector.source.name.oneOf.0","typeLabel":"string"},{"type":"null","description":"A Print Options field id or role, from connectors made before roles (type printOptions).","uniqueKey":"connector.source.name.oneOf.1","typeLabel":"null"}],"uniqueKey":"connector.source.name","typeLabel":"string | null"},"axis":{"oneOf":[{"type":"string","enum":["w","h",null],"uniqueKey":"connector.source.axis.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["w","h",null],"uniqueKey":"connector.source.axis.oneOf.1","typeLabel":"null"}],"uniqueKey":"connector.source.axis","typeLabel":"enum\u003cstring> | null"}},"isRequired":true,"uniqueKey":"connector.source","typeLabel":"object"},"query":{"type":"string","description":"The source as the editor stores it: the selector, or `po:role/\u003crole>`, `po:field/\u003cid>`.","isRequired":true,"uniqueKey":"connector.query","typeLabel":"string"},"mappings":{"type":"array","items":{"type":"object","required":["from","to"],"properties":{"from":{"type":"string","isRequired":true,"uniqueKey":"connector.mappings.items.[INDEX].from","typeLabel":"string"},"to":{"type":"string","isRequired":true,"uniqueKey":"connector.mappings.items.[INDEX].to","typeLabel":"string"}},"uniqueKey":"connector.mappings.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"connector.mappings","typeLabel":"object[]"},"twoWay":{"type":"boolean","isRequired":true,"uniqueKey":"connector.twoWay","typeLabel":"boolean"},"page":{"oneOf":[{"type":"integer","isRequired":true,"uniqueKey":"connector.page.oneOf.0","typeLabel":"integer"},{"type":"null","isRequired":true,"uniqueKey":"connector.page.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"connector.page","typeLabel":"integer | null"},"text":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"connector.text.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"connector.text.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"connector.text","typeLabel":"string | null"},"event":{"oneOf":[{"type":"object","required":["name","data"],"properties":{"name":{"type":"string","isRequired":true,"uniqueKey":"connector.event.oneOf.0.name","typeLabel":"string"},"data":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"connector.event.oneOf.0.data.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"connector.event.oneOf.0.data.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"connector.event.oneOf.0.data","typeLabel":"string | null"}},"isRequired":true,"uniqueKey":"connector.event.oneOf.0","typeLabel":"object"},{"type":"null","required":["name","data"],"properties":{"name":{"type":"string"},"data":{"oneOf":[{"type":"string"},{"type":"null"}]}},"isRequired":true,"uniqueKey":"connector.event.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"connector.event","typeLabel":"object | null"},"created":{"oneOf":[{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"connector.created.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","isRequired":true,"uniqueKey":"connector.created.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"connector.created","typeLabel":"string\u003cdate-time> | null"},"modified":{"oneOf":[{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"connector.modified.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","isRequired":true,"uniqueKey":"connector.modified.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"connector.modified","typeLabel":"string\u003cdate-time> | null"}},"examples":[{"object":"connector","id":"01KADX3Q7M2B8C4D5E6F7G8H9J","title":"Print side → pages","mode":"pageIndex","source":{"type":"selector","selector":"input[name=\"Print side\"]:checked"},"query":"input[name=\"Print side\"]:checked","mappings":[{"from":"Front","to":"1"},{"from":"Back","to":"2"},{"from":"Front and back","to":"1,2"}],"twoWay":true,"page":null,"text":null,"event":null,"created":"2026-10-27T10:00:00Z","modified":"2026-10-27T10:00:00Z"}],"isRequired":true,"uniqueKey":"connector","typeLabel":"Connector · object"},"design":{"type":"object","required":["id","title","editor","attached","pages"],"properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"design.id","typeLabel":"string"},"title":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"design.title.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"design.title.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"design.title","typeLabel":"string | null"},"editor":{"type":"string","enum":["new","classic"],"description":"The editor the design opens in. They differ for pageIndex: the classic one applies it only when it opens.","isRequired":true,"uniqueKey":"design.editor","typeLabel":"enum\u003cstring>"},"attached":{"type":"boolean","description":"The connector is attached to the design.","isRequired":true,"uniqueKey":"design.attached","typeLabel":"boolean"},"pages":{"type":"array","items":{"type":"object","required":["index","title","previewUrl"],"properties":{"index":{"type":"integer","isRequired":true,"uniqueKey":"design.pages.items.[INDEX].index","typeLabel":"integer"},"title":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"design.pages.items.[INDEX].title.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"design.pages.items.[INDEX].title.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"design.pages.items.[INDEX].title","typeLabel":"string | null"},"previewUrl":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"design.pages.items.[INDEX].previewUrl.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"design.pages.items.[INDEX].previewUrl.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"design.pages.items.[INDEX].previewUrl","typeLabel":"string | null"}},"uniqueKey":"design.pages.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"design.pages","typeLabel":"object[]"}},"isRequired":true,"uniqueKey":"design","typeLabel":"object"},"page":{"oneOf":[{"type":"null","isRequired":true,"uniqueKey":"page.oneOf.0","typeLabel":"null"},{"type":"object","required":["url","productId","passwordProtected","control","field"],"properties":{"url":{"type":"string","isRequired":true,"uniqueKey":"page.oneOf.1.url","typeLabel":"string"},"productId":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"page.oneOf.1.productId.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"page.oneOf.1.productId.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"page.oneOf.1.productId","typeLabel":"string | null"},"passwordProtected":{"type":"boolean","isRequired":true,"uniqueKey":"page.oneOf.1.passwordProtected","typeLabel":"boolean"},"control":{"oneOf":[{"type":"null","description":"The control the selector finds.","isRequired":true,"uniqueKey":"page.oneOf.1.control.oneOf.0","typeLabel":"null"},{"type":"object","description":"The control the selector finds.","required":["kind","name","label","selector","matches","inProductForm","sends","choices"],"properties":{"kind":{"type":"string","enum":["select","radio","fieldset","checkbox","text","number","textarea","element"],"isRequired":true,"uniqueKey":"page.oneOf.1.control.oneOf.1.kind","typeLabel":"enum\u003cstring>"},"name":{"oneOf":[{"type":"string","description":"Its form name.","isRequired":true,"uniqueKey":"page.oneOf.1.control.oneOf.1.name.oneOf.0","typeLabel":"string"},{"type":"null","description":"Its form name.","isRequired":true,"uniqueKey":"page.oneOf.1.control.oneOf.1.name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"page.oneOf.1.control.oneOf.1.name","typeLabel":"string | null"},"label":{"oneOf":[{"type":"string","description":"Its label on the page.","isRequired":true,"uniqueKey":"page.oneOf.1.control.oneOf.1.label.oneOf.0","typeLabel":"string"},{"type":"null","description":"Its label on the page.","isRequired":true,"uniqueKey":"page.oneOf.1.control.oneOf.1.label.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"page.oneOf.1.control.oneOf.1.label","typeLabel":"string | null"},"selector":{"type":"string","description":"The selector to give as `source.selector`.","isRequired":true,"uniqueKey":"page.oneOf.1.control.oneOf.1.selector","typeLabel":"string"},"matches":{"type":"integer","description":"How many elements the selector finds as the page loads. The client uses the first; 0 for radio choices means none is selected by default.","isRequired":true,"uniqueKey":"page.oneOf.1.control.oneOf.1.matches","typeLabel":"integer"},"inProductForm":{"type":"boolean","description":"It is part of the add-to-cart form.","isRequired":true,"uniqueKey":"page.oneOf.1.control.oneOf.1.inProductForm","typeLabel":"boolean"},"sends":{"type":"string","description":"What the client sends for it: `value and text`, `value`, or `its text`.","isRequired":true,"uniqueKey":"page.oneOf.1.control.oneOf.1.sends","typeLabel":"string"},"choices":{"type":"array","items":{"type":"object","required":["value","label","selected"],"properties":{"value":{"type":"string","description":"What the page sends for it.","isRequired":true,"uniqueKey":"page.oneOf.1.control.oneOf.1.choices.items.[INDEX].value","typeLabel":"string"},"label":{"oneOf":[{"type":"string","description":"What the customer sees.","isRequired":true,"uniqueKey":"page.oneOf.1.control.oneOf.1.choices.items.[INDEX].label.oneOf.0","typeLabel":"string"},{"type":"null","description":"What the customer sees.","isRequired":true,"uniqueKey":"page.oneOf.1.control.oneOf.1.choices.items.[INDEX].label.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"page.oneOf.1.control.oneOf.1.choices.items.[INDEX].label","typeLabel":"string | null"},"selected":{"type":"boolean","description":"Selected when the page loads.","isRequired":true,"uniqueKey":"page.oneOf.1.control.oneOf.1.choices.items.[INDEX].selected","typeLabel":"boolean"}},"uniqueKey":"page.oneOf.1.control.oneOf.1.choices.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"page.oneOf.1.control.oneOf.1.choices","typeLabel":"object[]"},"value":{"oneOf":[{"type":"string","description":"Its value as the page loads (inputs).","uniqueKey":"page.oneOf.1.control.oneOf.1.value.oneOf.0","typeLabel":"string"},{"type":"null","description":"Its value as the page loads (inputs).","uniqueKey":"page.oneOf.1.control.oneOf.1.value.oneOf.1","typeLabel":"null"}],"uniqueKey":"page.oneOf.1.control.oneOf.1.value","typeLabel":"string | null"},"notes":{"type":"array","items":{"type":"string","uniqueKey":"page.oneOf.1.control.oneOf.1.notes.items.[INDEX]","typeLabel":"string"},"description":"What could stop a connector working with it.","uniqueKey":"page.oneOf.1.control.oneOf.1.notes","typeLabel":"string[]"}},"isRequired":true,"uniqueKey":"page.oneOf.1.control.oneOf.1","typeLabel":"object"}],"isRequired":true,"uniqueKey":"page.oneOf.1.control","typeLabel":"null | object"},"field":{"oneOf":[{"type":"null","description":"The Print Options field the source finds.","isRequired":true,"uniqueKey":"page.oneOf.1.field.oneOf.0","typeLabel":"null"},{"type":"object","description":"The Print Options field the source finds.","required":["id","label","type","role","source","reference","sends","choices"],"properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"page.oneOf.1.field.oneOf.1.id","typeLabel":"string"},"label":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"page.oneOf.1.field.oneOf.1.label.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"page.oneOf.1.field.oneOf.1.label.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"page.oneOf.1.field.oneOf.1.label","typeLabel":"string | null"},"type":{"oneOf":[{"type":"string","description":"select-one, select-many, quantity, dimensions, number, text, file…","isRequired":true,"uniqueKey":"page.oneOf.1.field.oneOf.1.type.oneOf.0","typeLabel":"string"},{"type":"null","description":"select-one, select-many, quantity, dimensions, number, text, file…","isRequired":true,"uniqueKey":"page.oneOf.1.field.oneOf.1.type.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"page.oneOf.1.field.oneOf.1.type","typeLabel":"string | null"},"role":{"oneOf":[{"type":"string","description":"Its role, explicit or from its type (quantity, dimensions, file).","isRequired":true,"uniqueKey":"page.oneOf.1.field.oneOf.1.role.oneOf.0","typeLabel":"string"},{"type":"null","description":"Its role, explicit or from its type (quantity, dimensions, file).","isRequired":true,"uniqueKey":"page.oneOf.1.field.oneOf.1.role.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"page.oneOf.1.field.oneOf.1.role","typeLabel":"string | null"},"source":{"type":"object","description":"What to give as `source`: `{ role }` when it has one, else `{ field }`.","properties":{"role":{"type":"string","uniqueKey":"page.oneOf.1.field.oneOf.1.source.role","typeLabel":"string"},"field":{"type":"string","uniqueKey":"page.oneOf.1.field.oneOf.1.source.field","typeLabel":"string"}},"isRequired":true,"uniqueKey":"page.oneOf.1.field.oneOf.1.source","typeLabel":"object"},"reference":{"type":"string","description":"The stored query: `po:role/\u003crole>` or `po:field/\u003cid>`.","isRequired":true,"uniqueKey":"page.oneOf.1.field.oneOf.1.reference","typeLabel":"string"},"sends":{"type":"string","isRequired":true,"uniqueKey":"page.oneOf.1.field.oneOf.1.sends","typeLabel":"string"},"choices":{"type":"array","items":{"type":"object","required":["value","label","selected"],"properties":{"value":{"type":"string","description":"What the page sends for it.","isRequired":true,"uniqueKey":"page.oneOf.1.field.oneOf.1.choices.items.[INDEX].value","typeLabel":"string"},"label":{"oneOf":[{"type":"string","description":"What the customer sees.","isRequired":true,"uniqueKey":"page.oneOf.1.field.oneOf.1.choices.items.[INDEX].label.oneOf.0","typeLabel":"string"},{"type":"null","description":"What the customer sees.","isRequired":true,"uniqueKey":"page.oneOf.1.field.oneOf.1.choices.items.[INDEX].label.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"page.oneOf.1.field.oneOf.1.choices.items.[INDEX].label","typeLabel":"string | null"},"selected":{"type":"boolean","description":"Selected when the page loads.","isRequired":true,"uniqueKey":"page.oneOf.1.field.oneOf.1.choices.items.[INDEX].selected","typeLabel":"boolean"}},"uniqueKey":"page.oneOf.1.field.oneOf.1.choices.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"page.oneOf.1.field.oneOf.1.choices","typeLabel":"object[]"}},"isRequired":true,"uniqueKey":"page.oneOf.1.field.oneOf.1","typeLabel":"object"}],"isRequired":true,"uniqueKey":"page.oneOf.1.field","typeLabel":"null | object"}},"isRequired":true,"uniqueKey":"page.oneOf.1","typeLabel":"object"}],"isRequired":true,"uniqueKey":"page","typeLabel":"null | object"},"results":{"type":"array","description":"One per choice played (pageCount and printedPageCount: one per page count).","items":{"type":"object","required":["outcome","result","ok"],"properties":{"outcome":{"type":"string","description":"pages, design, designs, all_designs, orientation, color, copies, size, text, event, sets_field, no_mapping or nothing.","isRequired":true,"uniqueKey":"results.items.[INDEX].outcome","typeLabel":"string"},"result":{"type":"string","description":"What the editor does, in words.","isRequired":true,"uniqueKey":"results.items.[INDEX].result","typeLabel":"string"},"ok":{"type":"boolean","isRequired":true,"uniqueKey":"results.items.[INDEX].ok","typeLabel":"boolean"},"choice":{"type":"object","required":["value","label"],"properties":{"value":{"type":"string","isRequired":true,"uniqueKey":"results.items.[INDEX].choice.value","typeLabel":"string"},"label":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"results.items.[INDEX].choice.label.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"results.items.[INDEX].choice.label.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"results.items.[INDEX].choice.label","typeLabel":"string | null"}},"uniqueKey":"results.items.[INDEX].choice","typeLabel":"object"},"count":{"type":"integer","description":"pageCount, printedPageCount: the count the editor writes.","uniqueKey":"results.items.[INDEX].count","typeLabel":"integer"},"sends":{"type":"object","required":["value"],"properties":{"value":{"type":"string","isRequired":true,"uniqueKey":"results.items.[INDEX].sends.value","typeLabel":"string"},"text":{"type":"string","uniqueKey":"results.items.[INDEX].sends.text","typeLabel":"string"}},"uniqueKey":"results.items.[INDEX].sends","typeLabel":"object"},"mapping":{"oneOf":[{"type":"null","uniqueKey":"results.items.[INDEX].mapping.oneOf.0","typeLabel":"null"},{"type":"object","required":["from","to"],"properties":{"from":{"type":"string","isRequired":true,"uniqueKey":"results.items.[INDEX].mapping.oneOf.1.from","typeLabel":"string"},"to":{"type":"string","isRequired":true,"uniqueKey":"results.items.[INDEX].mapping.oneOf.1.to","typeLabel":"string"}},"uniqueKey":"results.items.[INDEX].mapping.oneOf.1","typeLabel":"object"}],"uniqueKey":"results.items.[INDEX].mapping","typeLabel":"null | object"},"problem":{"type":"string","uniqueKey":"results.items.[INDEX].problem","typeLabel":"string"},"note":{"type":"string","uniqueKey":"results.items.[INDEX].note","typeLabel":"string"},"pages":{"type":"array","items":{"type":"object","required":["index","number","title"],"properties":{"index":{"type":"integer","isRequired":true,"uniqueKey":"results.items.[INDEX].pages.items.[INDEX].index","typeLabel":"integer"},"number":{"type":"integer","description":"From 1, as mappings count.","isRequired":true,"uniqueKey":"results.items.[INDEX].pages.items.[INDEX].number","typeLabel":"integer"},"title":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"results.items.[INDEX].pages.items.[INDEX].title.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"results.items.[INDEX].pages.items.[INDEX].title.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"results.items.[INDEX].pages.items.[INDEX].title","typeLabel":"string | null"}},"uniqueKey":"results.items.[INDEX].pages.items.[INDEX]","typeLabel":"object"},"description":"pageIndex: the pages shown.","uniqueKey":"results.items.[INDEX].pages","typeLabel":"object[]"},"designId":{"type":"string","description":"designSelector: the design opened.","uniqueKey":"results.items.[INDEX].designId","typeLabel":"string"},"designIds":{"type":"array","items":{"type":"string","uniqueKey":"results.items.[INDEX].designIds.items.[INDEX]","typeLabel":"string"},"description":"templateFilter: the designs the Templates tab lists, in order.","uniqueKey":"results.items.[INDEX].designIds","typeLabel":"string[]"},"orientation":{"oneOf":[{"type":"string","uniqueKey":"results.items.[INDEX].orientation.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"results.items.[INDEX].orientation.oneOf.1","typeLabel":"null"}],"uniqueKey":"results.items.[INDEX].orientation","typeLabel":"string | null"},"color":{"oneOf":[{"type":"null","uniqueKey":"results.items.[INDEX].color.oneOf.0","typeLabel":"null"},{"type":"object","required":["title","hex"],"properties":{"title":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"results.items.[INDEX].color.oneOf.1.title.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"results.items.[INDEX].color.oneOf.1.title.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"results.items.[INDEX].color.oneOf.1.title","typeLabel":"string | null"},"hex":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"results.items.[INDEX].color.oneOf.1.hex.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"results.items.[INDEX].color.oneOf.1.hex.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"results.items.[INDEX].color.oneOf.1.hex","typeLabel":"string | null"}},"uniqueKey":"results.items.[INDEX].color.oneOf.1","typeLabel":"object"}],"uniqueKey":"results.items.[INDEX].color","typeLabel":"null | object"}},"uniqueKey":"results.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"results","typeLabel":"object[]"},"issues":{"type":"array","items":{"type":"object","required":["level","code","message"],"properties":{"level":{"type":"string","enum":["error","warning"],"isRequired":true,"uniqueKey":"issues.items.[INDEX].level","typeLabel":"enum\u003cstring>"},"code":{"type":"string","isRequired":true,"uniqueKey":"issues.items.[INDEX].code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"issues.items.[INDEX].message","typeLabel":"string"}},"uniqueKey":"issues.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"issues","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"ConnectorTestResult · object"},"examples":{"Example":{"title":"Example","value":{"object":"connector_test","ok":true,"connector":{"object":"connector","id":"01KADX3Q7M2B8C4D5E6F7G8H9J","title":"Print side → pages","mode":"pageIndex","source":{"type":"selector","selector":"input[name=\"Print side\"]:checked"},"query":"input[name=\"Print side\"]:checked","mappings":[{"from":"Front","to":"1"},{"from":"Back","to":"2"},{"from":"Front and back","to":"1,2"}],"twoWay":true,"page":null,"text":null,"event":null,"created":"2026-10-27T10:00:00Z","modified":"2026-10-27T10:00:00Z"},"design":{"id":"\u003cstring>","title":"\u003cstring>","editor":"new","attached":true,"pages":[{"index":123,"title":"\u003cstring>","previewUrl":"\u003cstring>"}]},"page":{"url":"\u003cstring>","productId":"\u003cstring>","passwordProtected":true,"control":{"kind":"select","name":"\u003cstring>","label":"\u003cstring>","selector":"\u003cstring>","matches":123,"inProductForm":true,"sends":"\u003cstring>","choices":[{"value":"\u003cstring>","label":"\u003cstring>","selected":true}],"value":"\u003cstring>","notes":["\u003cstring>"]},"field":{"id":"\u003cstring>","label":"\u003cstring>","type":"\u003cstring>","role":"\u003cstring>","source":{"role":"\u003cstring>","field":"\u003cstring>"},"reference":"\u003cstring>","sends":"\u003cstring>","choices":[{"value":"\u003cstring>","label":"\u003cstring>","selected":true}]}},"results":[{"outcome":"\u003cstring>","result":"\u003cstring>","ok":true,"choice":{"value":"\u003cstring>","label":"\u003cstring>"},"count":123,"sends":{"value":"\u003cstring>","text":"\u003cstring>"},"mapping":{"from":"\u003cstring>","to":"\u003cstring>"},"problem":"\u003cstring>","note":"\u003cstring>","pages":[{"index":123,"number":123,"title":"\u003cstring>"}],"designId":"\u003cstring>","designIds":["\u003cstring>"],"orientation":"\u003cstring>","color":{"title":"\u003cstring>","hex":"\u003cstring>"}}],"issues":[{"level":"error","code":"\u003cstring>","message":"\u003cstring>"}]}}},"exampleType":"generated"}},"exampleType":"generated"},"d7da58cb-0b77-4d77-90ad-58cf4c7dc8fd":{"description":"A parameter or body field is malformed: `param` names it and `details` lists every problem found.","headers":{"x-request-id":{"description":"Identifies the request. Quote it when contacting support.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"title":"Error","description":"Every error the API itself returns. Match on `code`; `message` is for people and may be reworded.","type":"object","required":["error","code","message","requestId"],"properties":{"error":{"type":"boolean","const":true,"isRequired":true,"uniqueKey":"error","typeLabel":"boolean"},"code":{"type":"string","enum":["unauthorized","account_suspended","invalid_request","not_found","route_not_found","idempotency_key_reused","idempotency_in_progress","folder_not_empty","builtin_folder","builtin_palette","editor_not_supported","design_changed","payload_too_large","unsupported_media_type","ops_failed","internal_error","service_unavailable"],"description":"`unauthorized` (401): missing, unknown, revoked or expired secret key. `account_suspended` (403): the account has an unpaid invoice. `invalid_request` (400): a parameter or body field is malformed — see `param` and `details`. `not_found` (404): no such resource in your account. `route_not_found` (404): no such endpoint. `idempotency_key_reused` (409): the Idempotency-Key was used for a different request. `idempotency_in_progress` (409): the first request with that key is still running. `folder_not_empty` (409): the folder still holds designs or folders. `builtin_folder`, `builtin_palette` (409): Print.App's own folders and palettes cannot be changed. `editor_not_supported` (409): page content can only be edited on accounts that use the new editor. `design_changed` (409): the design was saved elsewhere while the batch ran; read it again and retry. `payload_too_large` (413): a body or file over the limit. `unsupported_media_type` (415): send JSON. `ops_failed` (422): an operation in the batch failed, nothing was saved — see `details`. `internal_error` (500): retry; contact support with the `requestId` if it persists. `service_unavailable` (503): retry in a few seconds.","isRequired":true,"uniqueKey":"code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"requestId":{"type":"string","description":"Also sent as the `x-request-id` header. Quote it when contacting support.","isRequired":true,"uniqueKey":"requestId","typeLabel":"string"},"param":{"type":"string","description":"The parameter or body field at fault, as a path (`pages[0].title`).","uniqueKey":"param","typeLabel":"string"},"details":{"type":"array","description":"Every problem found, when there was more than one (`invalid_request`), or each operation's result (`ops_failed`).","items":{"type":"object","uniqueKey":"details.items.[INDEX]","typeLabel":"object"},"uniqueKey":"details","typeLabel":"object[]"}},"examples":[{"error":true,"code":"invalid_request","message":"limit must be an integer from 1 to 100.","param":"limit","requestId":"FZn-uhymjoEEJow="}],"uniqueKey":"","typeLabel":"Error · object"},"example":{"error":true,"code":"invalid_request","message":"width is required.","param":"width","requestId":"FZn-uhymjoEEJow="},"examples":{"Example":{"title":"Example","value":{"error":true,"code":"invalid_request","message":"width is required.","param":"width","requestId":"FZn-uhymjoEEJow="}}},"exampleType":"examples"}},"exampleType":"examples"},"709dd2ed-a0c5-48e2-9c3b-34eba10835f9":{"description":"Missing, unknown, revoked or expired secret key.","headers":{"x-request-id":{"description":"Identifies the request. Quote it when contacting support.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"title":"Error","description":"Every error the API itself returns. Match on `code`; `message` is for people and may be reworded.","type":"object","required":["error","code","message","requestId"],"properties":{"error":{"type":"boolean","const":true,"isRequired":true,"uniqueKey":"error","typeLabel":"boolean"},"code":{"type":"string","enum":["unauthorized","account_suspended","invalid_request","not_found","route_not_found","idempotency_key_reused","idempotency_in_progress","folder_not_empty","builtin_folder","builtin_palette","editor_not_supported","design_changed","payload_too_large","unsupported_media_type","ops_failed","internal_error","service_unavailable"],"description":"`unauthorized` (401): missing, unknown, revoked or expired secret key. `account_suspended` (403): the account has an unpaid invoice. `invalid_request` (400): a parameter or body field is malformed — see `param` and `details`. `not_found` (404): no such resource in your account. `route_not_found` (404): no such endpoint. `idempotency_key_reused` (409): the Idempotency-Key was used for a different request. `idempotency_in_progress` (409): the first request with that key is still running. `folder_not_empty` (409): the folder still holds designs or folders. `builtin_folder`, `builtin_palette` (409): Print.App's own folders and palettes cannot be changed. `editor_not_supported` (409): page content can only be edited on accounts that use the new editor. `design_changed` (409): the design was saved elsewhere while the batch ran; read it again and retry. `payload_too_large` (413): a body or file over the limit. `unsupported_media_type` (415): send JSON. `ops_failed` (422): an operation in the batch failed, nothing was saved — see `details`. `internal_error` (500): retry; contact support with the `requestId` if it persists. `service_unavailable` (503): retry in a few seconds.","isRequired":true,"uniqueKey":"code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"requestId":{"type":"string","description":"Also sent as the `x-request-id` header. Quote it when contacting support.","isRequired":true,"uniqueKey":"requestId","typeLabel":"string"},"param":{"type":"string","description":"The parameter or body field at fault, as a path (`pages[0].title`).","uniqueKey":"param","typeLabel":"string"},"details":{"type":"array","description":"Every problem found, when there was more than one (`invalid_request`), or each operation's result (`ops_failed`).","items":{"type":"object","uniqueKey":"details.items.[INDEX]","typeLabel":"object"},"uniqueKey":"details","typeLabel":"object[]"}},"examples":[{"error":true,"code":"invalid_request","message":"limit must be an integer from 1 to 100.","param":"limit","requestId":"FZn-uhymjoEEJow="}],"uniqueKey":"","typeLabel":"Error · object"},"example":{"error":true,"code":"unauthorized","message":"Missing or invalid secret key. Send it as \"Authorization: Bearer sk_…\".","requestId":"FZn-uhymjoEEJow="},"examples":{"Example":{"title":"Example","value":{"error":true,"code":"unauthorized","message":"Missing or invalid secret key. Send it as \"Authorization: Bearer sk_…\".","requestId":"FZn-uhymjoEEJow="}}},"exampleType":"examples"}},"exampleType":"examples"},"e4fee687-c076-4fee-9cbe-0a2fa2b36fd0":{"description":"The account is suspended for an unpaid invoice.","headers":{"x-request-id":{"description":"Identifies the request. Quote it when contacting support.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"title":"Error","description":"Every error the API itself returns. Match on `code`; `message` is for people and may be reworded.","type":"object","required":["error","code","message","requestId"],"properties":{"error":{"type":"boolean","const":true,"isRequired":true,"uniqueKey":"error","typeLabel":"boolean"},"code":{"type":"string","enum":["unauthorized","account_suspended","invalid_request","not_found","route_not_found","idempotency_key_reused","idempotency_in_progress","folder_not_empty","builtin_folder","builtin_palette","editor_not_supported","design_changed","payload_too_large","unsupported_media_type","ops_failed","internal_error","service_unavailable"],"description":"`unauthorized` (401): missing, unknown, revoked or expired secret key. `account_suspended` (403): the account has an unpaid invoice. `invalid_request` (400): a parameter or body field is malformed — see `param` and `details`. `not_found` (404): no such resource in your account. `route_not_found` (404): no such endpoint. `idempotency_key_reused` (409): the Idempotency-Key was used for a different request. `idempotency_in_progress` (409): the first request with that key is still running. `folder_not_empty` (409): the folder still holds designs or folders. `builtin_folder`, `builtin_palette` (409): Print.App's own folders and palettes cannot be changed. `editor_not_supported` (409): page content can only be edited on accounts that use the new editor. `design_changed` (409): the design was saved elsewhere while the batch ran; read it again and retry. `payload_too_large` (413): a body or file over the limit. `unsupported_media_type` (415): send JSON. `ops_failed` (422): an operation in the batch failed, nothing was saved — see `details`. `internal_error` (500): retry; contact support with the `requestId` if it persists. `service_unavailable` (503): retry in a few seconds.","isRequired":true,"uniqueKey":"code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"requestId":{"type":"string","description":"Also sent as the `x-request-id` header. Quote it when contacting support.","isRequired":true,"uniqueKey":"requestId","typeLabel":"string"},"param":{"type":"string","description":"The parameter or body field at fault, as a path (`pages[0].title`).","uniqueKey":"param","typeLabel":"string"},"details":{"type":"array","description":"Every problem found, when there was more than one (`invalid_request`), or each operation's result (`ops_failed`).","items":{"type":"object","uniqueKey":"details.items.[INDEX]","typeLabel":"object"},"uniqueKey":"details","typeLabel":"object[]"}},"examples":[{"error":true,"code":"invalid_request","message":"limit must be an integer from 1 to 100.","param":"limit","requestId":"FZn-uhymjoEEJow="}],"uniqueKey":"","typeLabel":"Error · object"},"example":{"error":true,"code":"account_suspended","message":"This account is suspended. Settle the outstanding invoice in the Print.App dashboard.","requestId":"FZn-uhymjoEEJow="},"examples":{"Example":{"title":"Example","value":{"error":true,"code":"account_suspended","message":"This account is suspended. Settle the outstanding invoice in the Print.App dashboard.","requestId":"FZn-uhymjoEEJow="}}},"exampleType":"examples"}},"exampleType":"examples"},"b23a6e9a-9f6a-43ef-9c6e-b46b1ca74112":{"description":"Not found in your account. Another account's resources answer 404 too.","headers":{"x-request-id":{"description":"Identifies the request. Quote it when contacting support.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"title":"Error","description":"Every error the API itself returns. Match on `code`; `message` is for people and may be reworded.","type":"object","required":["error","code","message","requestId"],"properties":{"error":{"type":"boolean","const":true,"isRequired":true,"uniqueKey":"error","typeLabel":"boolean"},"code":{"type":"string","enum":["unauthorized","account_suspended","invalid_request","not_found","route_not_found","idempotency_key_reused","idempotency_in_progress","folder_not_empty","builtin_folder","builtin_palette","editor_not_supported","design_changed","payload_too_large","unsupported_media_type","ops_failed","internal_error","service_unavailable"],"description":"`unauthorized` (401): missing, unknown, revoked or expired secret key. `account_suspended` (403): the account has an unpaid invoice. `invalid_request` (400): a parameter or body field is malformed — see `param` and `details`. `not_found` (404): no such resource in your account. `route_not_found` (404): no such endpoint. `idempotency_key_reused` (409): the Idempotency-Key was used for a different request. `idempotency_in_progress` (409): the first request with that key is still running. `folder_not_empty` (409): the folder still holds designs or folders. `builtin_folder`, `builtin_palette` (409): Print.App's own folders and palettes cannot be changed. `editor_not_supported` (409): page content can only be edited on accounts that use the new editor. `design_changed` (409): the design was saved elsewhere while the batch ran; read it again and retry. `payload_too_large` (413): a body or file over the limit. `unsupported_media_type` (415): send JSON. `ops_failed` (422): an operation in the batch failed, nothing was saved — see `details`. `internal_error` (500): retry; contact support with the `requestId` if it persists. `service_unavailable` (503): retry in a few seconds.","isRequired":true,"uniqueKey":"code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"requestId":{"type":"string","description":"Also sent as the `x-request-id` header. Quote it when contacting support.","isRequired":true,"uniqueKey":"requestId","typeLabel":"string"},"param":{"type":"string","description":"The parameter or body field at fault, as a path (`pages[0].title`).","uniqueKey":"param","typeLabel":"string"},"details":{"type":"array","description":"Every problem found, when there was more than one (`invalid_request`), or each operation's result (`ops_failed`).","items":{"type":"object","uniqueKey":"details.items.[INDEX]","typeLabel":"object"},"uniqueKey":"details","typeLabel":"object[]"}},"examples":[{"error":true,"code":"invalid_request","message":"limit must be an integer from 1 to 100.","param":"limit","requestId":"FZn-uhymjoEEJow="}],"uniqueKey":"","typeLabel":"Error · object"},"example":{"error":true,"code":"not_found","message":"Not found.","requestId":"FZn-uhymjoEEJow="},"examples":{"Example":{"title":"Example","value":{"error":true,"code":"not_found","message":"Not found.","requestId":"FZn-uhymjoEEJow="}}},"exampleType":"examples"}},"exampleType":"examples"},"f391c711-c3ca-4c30-9bd7-3f8a366d6640":{"description":"The body is not JSON.","headers":{"x-request-id":{"description":"Identifies the request. Quote it when contacting support.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"title":"Error","description":"Every error the API itself returns. Match on `code`; `message` is for people and may be reworded.","type":"object","required":["error","code","message","requestId"],"properties":{"error":{"type":"boolean","const":true,"isRequired":true,"uniqueKey":"error","typeLabel":"boolean"},"code":{"type":"string","enum":["unauthorized","account_suspended","invalid_request","not_found","route_not_found","idempotency_key_reused","idempotency_in_progress","folder_not_empty","builtin_folder","builtin_palette","editor_not_supported","design_changed","payload_too_large","unsupported_media_type","ops_failed","internal_error","service_unavailable"],"description":"`unauthorized` (401): missing, unknown, revoked or expired secret key. `account_suspended` (403): the account has an unpaid invoice. `invalid_request` (400): a parameter or body field is malformed — see `param` and `details`. `not_found` (404): no such resource in your account. `route_not_found` (404): no such endpoint. `idempotency_key_reused` (409): the Idempotency-Key was used for a different request. `idempotency_in_progress` (409): the first request with that key is still running. `folder_not_empty` (409): the folder still holds designs or folders. `builtin_folder`, `builtin_palette` (409): Print.App's own folders and palettes cannot be changed. `editor_not_supported` (409): page content can only be edited on accounts that use the new editor. `design_changed` (409): the design was saved elsewhere while the batch ran; read it again and retry. `payload_too_large` (413): a body or file over the limit. `unsupported_media_type` (415): send JSON. `ops_failed` (422): an operation in the batch failed, nothing was saved — see `details`. `internal_error` (500): retry; contact support with the `requestId` if it persists. `service_unavailable` (503): retry in a few seconds.","isRequired":true,"uniqueKey":"code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"requestId":{"type":"string","description":"Also sent as the `x-request-id` header. Quote it when contacting support.","isRequired":true,"uniqueKey":"requestId","typeLabel":"string"},"param":{"type":"string","description":"The parameter or body field at fault, as a path (`pages[0].title`).","uniqueKey":"param","typeLabel":"string"},"details":{"type":"array","description":"Every problem found, when there was more than one (`invalid_request`), or each operation's result (`ops_failed`).","items":{"type":"object","uniqueKey":"details.items.[INDEX]","typeLabel":"object"},"uniqueKey":"details","typeLabel":"object[]"}},"examples":[{"error":true,"code":"invalid_request","message":"limit must be an integer from 1 to 100.","param":"limit","requestId":"FZn-uhymjoEEJow="}],"uniqueKey":"","typeLabel":"Error · object"},"example":{"error":true,"code":"unsupported_media_type","message":"Send the request body as JSON, with \"Content-Type: application/json\".","requestId":"FZn-uhymjoEEJow="},"examples":{"Example":{"title":"Example","value":{"error":true,"code":"unsupported_media_type","message":"Send the request body as JSON, with \"Content-Type: application/json\".","requestId":"FZn-uhymjoEEJow="}}},"exampleType":"examples"}},"exampleType":"examples"},"ec4529b4-4df7-4a51-8d6b-7b84c8d4dec3":{"description":"Rate limited by the API gateway. Back off and retry. This response comes from the gateway, so its body is `{ \"message\": \"Too Many Requests\" }`, not the standard error.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","uniqueKey":"message","typeLabel":"string"}},"description":"Returned by the API gateway itself (429).","uniqueKey":"","typeLabel":"object"},"example":{"message":"Too Many Requests"},"examples":{"Example":{"title":"Example","value":{"message":"Too Many Requests"}}},"exampleType":"examples"}},"exampleType":"examples"},"9dd32e56-0ed9-4d21-853e-9e55ce5dfb87":{"description":"Something failed on our side. Retry; quote the requestId to support if it persists.","headers":{"x-request-id":{"description":"Identifies the request. Quote it when contacting support.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"title":"Error","description":"Every error the API itself returns. Match on `code`; `message` is for people and may be reworded.","type":"object","required":["error","code","message","requestId"],"properties":{"error":{"type":"boolean","const":true,"isRequired":true,"uniqueKey":"error","typeLabel":"boolean"},"code":{"type":"string","enum":["unauthorized","account_suspended","invalid_request","not_found","route_not_found","idempotency_key_reused","idempotency_in_progress","folder_not_empty","builtin_folder","builtin_palette","editor_not_supported","design_changed","payload_too_large","unsupported_media_type","ops_failed","internal_error","service_unavailable"],"description":"`unauthorized` (401): missing, unknown, revoked or expired secret key. `account_suspended` (403): the account has an unpaid invoice. `invalid_request` (400): a parameter or body field is malformed — see `param` and `details`. `not_found` (404): no such resource in your account. `route_not_found` (404): no such endpoint. `idempotency_key_reused` (409): the Idempotency-Key was used for a different request. `idempotency_in_progress` (409): the first request with that key is still running. `folder_not_empty` (409): the folder still holds designs or folders. `builtin_folder`, `builtin_palette` (409): Print.App's own folders and palettes cannot be changed. `editor_not_supported` (409): page content can only be edited on accounts that use the new editor. `design_changed` (409): the design was saved elsewhere while the batch ran; read it again and retry. `payload_too_large` (413): a body or file over the limit. `unsupported_media_type` (415): send JSON. `ops_failed` (422): an operation in the batch failed, nothing was saved — see `details`. `internal_error` (500): retry; contact support with the `requestId` if it persists. `service_unavailable` (503): retry in a few seconds.","isRequired":true,"uniqueKey":"code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"requestId":{"type":"string","description":"Also sent as the `x-request-id` header. Quote it when contacting support.","isRequired":true,"uniqueKey":"requestId","typeLabel":"string"},"param":{"type":"string","description":"The parameter or body field at fault, as a path (`pages[0].title`).","uniqueKey":"param","typeLabel":"string"},"details":{"type":"array","description":"Every problem found, when there was more than one (`invalid_request`), or each operation's result (`ops_failed`).","items":{"type":"object","uniqueKey":"details.items.[INDEX]","typeLabel":"object"},"uniqueKey":"details","typeLabel":"object[]"}},"examples":[{"error":true,"code":"invalid_request","message":"limit must be an integer from 1 to 100.","param":"limit","requestId":"FZn-uhymjoEEJow="}],"uniqueKey":"","typeLabel":"Error · object"},"example":{"error":true,"code":"internal_error","message":"Something went wrong on our side. Retry the request; if it keeps failing, contact support with the requestId.","requestId":"FZn-uhymjoEEJow="},"examples":{"Example":{"title":"Example","value":{"error":true,"code":"internal_error","message":"Something went wrong on our side. Retry the request; if it keeps failing, contact support with the requestId.","requestId":"FZn-uhymjoEEJow="}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"fca69934-0d8a-4a5f-a493-d8b685eade93":{"bearerAuth":{"type":"http","scheme":"bearer","description":"A secret key from Print.App admin → Domains → Secret keys, sent as `Authorization: Bearer sk_…`. Server-side only.","scopes":[],"schemeName":"bearerAuth"}}},"servers":{"d00c9747-3648-481f-bbd7-e7328a87209d":{"url":"https://api.print.app","description":"Production"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"A secret key from Print.App admin → Domains → Secret keys, sent as `Authorization: Bearer sk_…`. Server-side only.","scopes":[],"schemeName":"bearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"A secret key from Print.App admin → Domains → Secret keys, sent as `Authorization: Bearer sk_…`. Server-side only.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"openapi.json"},"subdomain":"printapp","siteName":"Print.App Documentation","title":"Test a connector - Print.App Documentation","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-27T13:28:42.327Z","originalFileLocation":"api-reference/v2/connectors/test-connector.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Plays a connector (saved, or one you are about to create) against a design for every choice of its field: what the product page sends, which mapping matches, and what the editor then does, such as the pages it shows or the design it opens. With url, the field and its choices are read from your product page, and the test also checks the selector finds it, the design is assigned to the product, and no other connector on the design fights it. Nothing is saved.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Print.App Documentation\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/printapp/QZ41IcGsgV91EEVQ/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/docs/mintlify-assets/_mintlify/favicons/printapp/QZ41IcGsgV91EEVQ/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/printapp/QZ41IcGsgV91EEVQ/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/printapp/QZ41IcGsgV91EEVQ/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/printapp/QZ41IcGsgV91EEVQ/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/printapp/QZ41IcGsgV91EEVQ/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/printapp/QZ41IcGsgV91EEVQ/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/printapp/QZ41IcGsgV91EEVQ/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/printapp/QZ41IcGsgV91EEVQ/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Test a connector - Print.App Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"Plays a connector (saved, or one you are about to create) against a design for every choice of its field: what the product page sends, which mapping matches, and what the editor then does, such as the pages it shows or the design it opens. With url, the field and its choices are read from your product page, and the test also checks the selector finds it, the design is assigned to the product, and no other connector on the design fights it. Nothing is saved.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Print.App Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://print.app/docs/api-reference/v2/connectors/test-connector\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://printapp.mintlify.site/docs/_mintlify/api/og/v2?division=Connectors\u0026amp;title=Test+a+connector\u0026amp;description=Plays+a+connector+%28saved%2C+or+one+you+are+about+to+create%29+against+a+design+for+every+choice+of+its+field%3A+what+the+product+page+sends%2C+which+mapping+matches%2C+an\u0026amp;theme=634763f1f287d389464516ed\u0026amp;signature=f18d334729372eae840e5fd5a54a4f86bffe07eb6bc6b28226db8a6444529f9a\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Test a connector - Print.App Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Plays a connector (saved, or one you are about to create) against a design for every choice of its field: what the product page sends, which mapping matches, and what the editor then does, such as the pages it shows or the design it opens. With url, the field and its choices are read from your product page, and the test also checks the selector finds it, the design is assigned to the product, and no other connector on the design fights it. Nothing is saved.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://printapp.mintlify.site/docs/_mintlify/api/og/v2?division=Connectors\u0026amp;title=Test+a+connector\u0026amp;description=Plays+a+connector+%28saved%2C+or+one+you+are+about+to+create%29+against+a+design+for+every+choice+of+its+field%3A+what+the+product+page+sends%2C+which+mapping+matches%2C+an\u0026amp;theme=634763f1f287d389464516ed\u0026amp;signature=f18d334729372eae840e5fd5a54a4f86bffe07eb6bc6b28226db8a6444529f9a\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/docs/mintlify-assets/_mintlify/favicons/printapp/QZ41IcGsgV91EEVQ/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Print.App Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#00AC13\">\u003clink data-mint-head rel=\"canonical\" href=\"https://print.app/docs/api-reference/v2/connectors/test-connector\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/docs/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/docs/api-reference/v2/connectors/test-connector.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://print.app/#organization\",\"name\":\"Print.App Documentation\",\"url\":\"https://print.app\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/printapp/8ZfPxlJeGBl6BLAD/logo/light.svg?fit=max\u0026auto=format\u0026n=8ZfPxlJeGBl6BLAD\u0026q=85\u0026s=f2dc8c61d71358f310658fb8b3756287\"}},{\"@type\":\"WebSite\",\"@id\":\"https://print.app/docs#website\",\"name\":\"Print.App Documentation\",\"url\":\"https://print.app/docs\",\"publisher\":{\"@id\":\"https://print.app/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://print.app/docs/api-reference/v2/connectors/test-connector#webpage\",\"url\":\"https://print.app/docs/api-reference/v2/connectors/test-connector\",\"name\":\"Test a connector\",\"description\":\"Plays a connector (saved, or one you are about to create) against a design for every choice of its field: what the product page sends, which mapping matches, and what the editor then does, such as the pages it shows or the design it opens. With url, the field and its choices are read from your product page, and the test also checks the selector finds it, the design is assigned to the product, and no other connector on the design fights it. Nothing is saved.\",\"dateModified\":\"2026-10-27T13:28:42.327Z\",\"isPartOf\":{\"@id\":\"https://print.app/docs#website\"},\"breadcrumb\":{\"@id\":\"https://print.app/docs/api-reference/v2/connectors/test-connector#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://print.app/docs/api-reference/v2/connectors/test-connector#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Endpoints\",\"item\":\"https://print.app/docs/api-reference/v2/account/get\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Connectors\",\"item\":\"https://print.app/docs/api-reference/v2/connectors/list-connectors\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Test a connector\",\"item\":\"https://print.app/docs/api-reference/v2/connectors/test-connector\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://print.app/docs/api-reference/v2/connectors/test-connector#apireference\",\"headline\":\"Test a connector\",\"name\":\"Test a connector\",\"description\":\"Plays a connector (saved, or one you are about to create) against a design for every choice of its field: what the product page sends, which mapping matches, and what the editor then does, such as the pages it shows or the design it opens. With url, the field and its choices are read from your product page, and the test also checks the selector finds it, the design is assigned to the product, and no other connector on the design fights it. Nothing is saved.\",\"url\":\"https://print.app/docs/api-reference/v2/connectors/test-connector\",\"mainEntityOfPage\":{\"@id\":\"https://print.app/docs/api-reference/v2/connectors/test-connector#webpage\"},\"dateModified\":\"2026-10-27T13:28:42.327Z\",\"publisher\":{\"@id\":\"https://print.app/#organization\"},\"isPartOf\":{\"@id\":\"https://print.app/docs#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Print.App Documentation\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Print.App Documentation\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/docs/api-reference/v2/connectors/test-connector.md","siteName":"Print.App Documentation","nav":{"global":null,"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/introduction"}]},{"tab":"Design Guides","pages":[{"title":"Design Guides","href":"/guides/designs/about-designs"}]},{"tab":"API References","groups":[{"group":"REST API (v2)","pages":[{"title":"API overview","href":"/api-reference/v2/introduction"},{"title":"Authentication","href":"/api-reference/v2/authentication"},{"title":"Errors \u0026 rate limits","href":"/api-reference/v2/errors"},{"title":"Pagination","href":"/api-reference/v2/pagination"},{"title":"OpenAPI spec","href":"/api-reference/v2/openapi"},{"title":"MCP reference","href":"/api-reference/v2/mcp"}]},{"group":"Guides","pages":[{"title":"Verify a project before fulfilling","href":"/api-reference/v2/verify-a-project"},{"title":"Create a design through the API","href":"/api-reference/v2/create-a-design"},{"title":"Automate fulfilment from WooCommerce","href":"/api-reference/guides/woocommerce-fulfilment"}]},{"group":"Endpoints","pages":[{"group":"Account","pages":[{"title":"Get the account","openapi":"openapi.json GET /v2/account","href":"/api-reference/v2/account/get"}]},{"group":"Designs","pages":[{"title":"List designs","openapi":"openapi.json GET /v2/designs","href":"/api-reference/v2/designs/list"},{"title":"Create a design","openapi":"openapi.json POST /v2/designs","href":"/api-reference/v2/designs/create-design"},{"title":"Get a design","openapi":"openapi.json GET /v2/designs/{id}","href":"/api-reference/v2/designs/get"},{"title":"Update a design","openapi":"openapi.json PATCH /v2/designs/{id}","href":"/api-reference/v2/designs/update-design"},{"title":"Delete a design","openapi":"openapi.json DELETE /v2/designs/{id}","href":"/api-reference/v2/designs/delete-design"},{"title":"Duplicate a design","openapi":"openapi.json POST /v2/designs/{id}/duplicate","href":"/api-reference/v2/designs/duplicate-design"},{"title":"Get page content","openapi":"openapi.json GET /v2/designs/{id}/content","href":"/api-reference/v2/designs/get-design-content"},{"title":"Edit page content","openapi":"openapi.json POST /v2/designs/{id}/ops","href":"/api-reference/v2/designs/apply-ops"},{"title":"Add pages","openapi":"openapi.json POST /v2/designs/{id}/pages","href":"/api-reference/v2/designs/add-pages"},{"title":"Update a page","openapi":"openapi.json PATCH /v2/designs/{id}/pages/{index}","href":"/api-reference/v2/designs/update-page"},{"title":"Delete a page","openapi":"openapi.json DELETE /v2/designs/{id}/pages/{index}","href":"/api-reference/v2/designs/delete-page"},{"title":"Attach a connector","openapi":"openapi.json POST /v2/designs/{id}/connectors","href":"/api-reference/v2/designs/attach-connector"},{"title":"Detach a connector","openapi":"openapi.json DELETE /v2/designs/{id}/connectors/{connectorId}","href":"/api-reference/v2/designs/detach-connector"}]},{"group":"Design folders","pages":[{"title":"List design folders","openapi":"openapi.json GET /v2/design-folders","href":"/api-reference/v2/design-folders/list-design-folders"},{"title":"Create a design folder","openapi":"openapi.json POST /v2/design-folders","href":"/api-reference/v2/design-folders/create-design-folder"},{"title":"Get a design folder","openapi":"openapi.json GET /v2/design-folders/{id}","href":"/api-reference/v2/design-folders/get-design-folder"},{"title":"Update a design folder","openapi":"openapi.json PATCH /v2/design-folders/{id}","href":"/api-reference/v2/design-folders/update-design-folder"},{"title":"Delete a design folder","openapi":"openapi.json DELETE /v2/design-folders/{id}","href":"/api-reference/v2/design-folders/delete-design-folder"},{"title":"Add a design to a folder","openapi":"openapi.json POST /v2/design-folders/{id}/designs","href":"/api-reference/v2/design-folders/add-design-to-folder"},{"title":"Remove a design from a folder","openapi":"openapi.json DELETE /v2/design-folders/{id}/designs/{designId}","href":"/api-reference/v2/design-folders/remove-design-from-folder"}]},{"group":"Files","pages":[{"title":"List files","openapi":"openapi.json GET /v2/files","href":"/api-reference/v2/files/list-files"},{"title":"Upload a file from a URL","openapi":"openapi.json POST /v2/files","href":"/api-reference/v2/files/create-file"},{"title":"Start a direct upload","openapi":"openapi.json POST /v2/files/uploads","href":"/api-reference/v2/files/create-file-upload"},{"title":"Get a file","openapi":"openapi.json GET /v2/files/{id}","href":"/api-reference/v2/files/get-file"},{"title":"Update a file","openapi":"openapi.json PATCH /v2/files/{id}","href":"/api-reference/v2/files/update-file"},{"title":"Delete a file","openapi":"openapi.json DELETE /v2/files/{id}","href":"/api-reference/v2/files/delete-file"}]},{"group":"Graphic folders","pages":[{"title":"List graphic folders","openapi":"openapi.json GET /v2/graphic-folders","href":"/api-reference/v2/graphic-folders/list-graphic-folders"},{"title":"Create a graphic folder","openapi":"openapi.json POST /v2/graphic-folders","href":"/api-reference/v2/graphic-folders/create-graphic-folder"},{"title":"Get a graphic folder","openapi":"openapi.json GET /v2/graphic-folders/{id}","href":"/api-reference/v2/graphic-folders/get-graphic-folder"},{"title":"Update a graphic folder","openapi":"openapi.json PATCH /v2/graphic-folders/{id}","href":"/api-reference/v2/graphic-folders/update-graphic-folder"},{"title":"Delete a graphic folder","openapi":"openapi.json DELETE /v2/graphic-folders/{id}","href":"/api-reference/v2/graphic-folders/delete-graphic-folder"},{"title":"Add a file to a folder","openapi":"openapi.json POST /v2/graphic-folders/{id}/files","href":"/api-reference/v2/graphic-folders/add-file-to-folder"},{"title":"Remove a file from a folder","openapi":"openapi.json DELETE /v2/graphic-folders/{id}/files/{fileId}","href":"/api-reference/v2/graphic-folders/remove-file-from-folder"}]},{"group":"Fonts","pages":[{"title":"List fonts","openapi":"openapi.json GET /v2/fonts","href":"/api-reference/v2/fonts/list-fonts"},{"title":"Add a font","openapi":"openapi.json POST /v2/fonts","href":"/api-reference/v2/fonts/create-font"},{"title":"Get a font","openapi":"openapi.json GET /v2/fonts/{family}","href":"/api-reference/v2/fonts/get-font"},{"title":"Remove a font","openapi":"openapi.json DELETE /v2/fonts/{family}","href":"/api-reference/v2/fonts/delete-font"}]},{"group":"Palettes","pages":[{"title":"List palettes","openapi":"openapi.json GET /v2/palettes","href":"/api-reference/v2/palettes/list-palettes"},{"title":"Create a palette","openapi":"openapi.json POST /v2/palettes","href":"/api-reference/v2/palettes/create-palette"},{"title":"Get a palette","openapi":"openapi.json GET /v2/palettes/{id}","href":"/api-reference/v2/palettes/get-palette"},{"title":"Update a palette","openapi":"openapi.json PATCH /v2/palettes/{id}","href":"/api-reference/v2/palettes/update-palette"},{"title":"Delete a palette","openapi":"openapi.json DELETE /v2/palettes/{id}","href":"/api-reference/v2/palettes/delete-palette"}]},{"group":"Products","pages":[{"title":"List products","openapi":"openapi.json GET /v2/products","href":"/api-reference/v2/products/list-products"},{"title":"List your store's products","openapi":"openapi.json GET /v2/store-products","href":"/api-reference/v2/products/list-store-products"},{"title":"Get a product","openapi":"openapi.json GET /v2/products/{productId}","href":"/api-reference/v2/products/get-product"},{"title":"Assign designs to a product","openapi":"openapi.json PUT /v2/products/{productId}","href":"/api-reference/v2/products/set-product"},{"title":"Clear a product","openapi":"openapi.json DELETE /v2/products/{productId}","href":"/api-reference/v2/products/delete-product"}]},{"group":"Projects","pages":[{"title":"List projects","openapi":"openapi.json GET /v2/projects","href":"/api-reference/v2/projects/list"},{"title":"Create a project","openapi":"openapi.json POST /v2/projects","href":"/api-reference/v2/projects/create-project"},{"title":"Get a project","openapi":"openapi.json GET /v2/projects/{id}","href":"/api-reference/v2/projects/get"},{"title":"Update a project","openapi":"openapi.json PATCH /v2/projects/{id}","href":"/api-reference/v2/projects/update-project"},{"title":"Delete a project","openapi":"openapi.json DELETE /v2/projects/{id}","href":"/api-reference/v2/projects/delete-project"},{"title":"Get project page content","openapi":"openapi.json GET /v2/projects/{id}/content","href":"/api-reference/v2/projects/get-project-content"},{"title":"Edit project page content","openapi":"openapi.json POST /v2/projects/{id}/ops","href":"/api-reference/v2/projects/apply-project-ops"}]},{"group":"Links","pages":[{"title":"Create a project URL","openapi":"openapi.json POST /v2/links","href":"/api-reference/v2/links/create-link"},{"title":"Get a project URL","openapi":"openapi.json GET /v2/links/{id}","href":"/api-reference/v2/links/get-link"},{"title":"Expire a project URL","openapi":"openapi.json DELETE /v2/links/{id}","href":"/api-reference/v2/links/delete-link"}]},{"group":"Connectors","pages":[{"title":"List connectors","openapi":"openapi.json GET /v2/connectors","href":"/api-reference/v2/connectors/list-connectors"},{"title":"Create a connector","openapi":"openapi.json POST /v2/connectors","href":"/api-reference/v2/connectors/create-connector"},{"title":"Get a connector","openapi":"openapi.json GET /v2/connectors/{id}","href":"/api-reference/v2/connectors/get-connector"},{"title":"Update a connector","openapi":"openapi.json PATCH /v2/connectors/{id}","href":"/api-reference/v2/connectors/update-connector"},{"title":"Delete a connector","openapi":"openapi.json DELETE /v2/connectors/{id}","description":"Detaches a connector from every design and deletes it. It can be restored by support for 30 days.","href":"/api-reference/v2/connectors/delete-connector"},{"title":"Test a connector","openapi":"openapi.json POST /v2/connectors/test","href":"/api-reference/v2/connectors/test-connector"},{"title":"Read a product page","openapi":"openapi.json GET /v2/product-page","description":"Reads a product page of your store as the Print.App client sees it when it loads: each option control with a selector that finds it and its choices, the Print Options fields with their roles and choices, the store's product id and the designs it opens. Only pages of your own store (its address, Shopify shop or Print.App key) are read. Controls a theme builds in JavaScript after loading are not seen.","href":"/api-reference/v2/connectors/inspect-product-page"}]},{"group":"Print Options","pages":[{"title":"Get Print Options for the store","openapi":"openapi.json GET /v2/print-options","href":"/api-reference/v2/print-options/get-print-options"},{"title":"List option set templates","openapi":"openapi.json GET /v2/print-options/templates","href":"/api-reference/v2/print-options/list-option-set-templates"},{"title":"Get an option set template","openapi":"openapi.json GET /v2/print-options/templates/{key}","href":"/api-reference/v2/print-options/get-option-set-template"},{"title":"Price choices on an option set","openapi":"openapi.json POST /v2/print-options/quote","href":"/api-reference/v2/print-options/quote-option-set"},{"title":"List option sets","openapi":"openapi.json GET /v2/option-sets","href":"/api-reference/v2/print-options/list-option-sets"},{"title":"Create an option set","openapi":"openapi.json POST /v2/option-sets","href":"/api-reference/v2/print-options/create-option-set"},{"title":"Get an option set","openapi":"openapi.json GET /v2/option-sets/{id}","href":"/api-reference/v2/print-options/get-option-set"},{"title":"Update an option set","openapi":"openapi.json PATCH /v2/option-sets/{id}","href":"/api-reference/v2/print-options/update-option-set"},{"title":"Delete an option set","openapi":"openapi.json DELETE /v2/option-sets/{id}","href":"/api-reference/v2/print-options/delete-option-set"}]},{"group":"Resource profiles","pages":[{"title":"List resource profiles","openapi":"openapi.json GET /v2/resource-profiles","href":"/api-reference/v2/resource-profiles/list-resource-profiles"},{"title":"Create a resource profile","openapi":"openapi.json POST /v2/resource-profiles","href":"/api-reference/v2/resource-profiles/create-resource-profile"},{"title":"Get a resource profile","openapi":"openapi.json GET /v2/resource-profiles/{id}","href":"/api-reference/v2/resource-profiles/get-resource-profile"},{"title":"Update a resource profile","openapi":"openapi.json PATCH /v2/resource-profiles/{id}","href":"/api-reference/v2/resource-profiles/update-resource-profile"},{"title":"Delete a resource profile","openapi":"openapi.json DELETE /v2/resource-profiles/{id}","href":"/api-reference/v2/resource-profiles/delete-resource-profile"}]},{"group":"PDF profiles","pages":[{"title":"List PDF profiles","openapi":"openapi.json GET /v2/pdf-profiles","href":"/api-reference/v2/pdf-profiles/list-pdf-profiles"},{"title":"Create a PDF profile","openapi":"openapi.json POST /v2/pdf-profiles","href":"/api-reference/v2/pdf-profiles/create-pdf-profile"},{"title":"Get a PDF profile","openapi":"openapi.json GET /v2/pdf-profiles/{id}","href":"/api-reference/v2/pdf-profiles/get-pdf-profile"},{"title":"Update a PDF profile","openapi":"openapi.json PATCH /v2/pdf-profiles/{id}","href":"/api-reference/v2/pdf-profiles/update-pdf-profile"},{"title":"Delete a PDF profile","openapi":"openapi.json DELETE /v2/pdf-profiles/{id}","href":"/api-reference/v2/pdf-profiles/delete-pdf-profile"}]},{"group":"Imposition rules","pages":[{"title":"List imposition rules","openapi":"openapi.json GET /v2/imposition-rules","href":"/api-reference/v2/imposition-rules/list-imposition-rules"},{"title":"Create an imposition rule","openapi":"openapi.json POST /v2/imposition-rules","href":"/api-reference/v2/imposition-rules/create-imposition-rule"},{"title":"Get an imposition rule","openapi":"openapi.json GET /v2/imposition-rules/{id}","href":"/api-reference/v2/imposition-rules/get-imposition-rule"},{"title":"Update an imposition rule","openapi":"openapi.json PATCH /v2/imposition-rules/{id}","href":"/api-reference/v2/imposition-rules/update-imposition-rule"},{"title":"Delete an imposition rule","openapi":"openapi.json DELETE /v2/imposition-rules/{id}","href":"/api-reference/v2/imposition-rules/delete-imposition-rule"}]},{"group":"3D scenes","pages":[{"title":"List 3D scenes","openapi":"openapi.json GET /v2/scenes","href":"/api-reference/v2/3d-scenes/list-scenes"},{"title":"Get a 3D scene","openapi":"openapi.json GET /v2/scenes/{id}","href":"/api-reference/v2/3d-scenes/get-scene"}]},{"group":"Library","pages":[{"title":"Search library designs","openapi":"openapi.json GET /v2/library/designs","href":"/api-reference/v2/library/list-library-designs"},{"title":"Get a library design","openapi":"openapi.json GET /v2/library/designs/{id}","href":"/api-reference/v2/library/get-library-design"},{"title":"Import a library design","openapi":"openapi.json POST /v2/library/designs/{id}/import","href":"/api-reference/v2/library/import-library-design"},{"title":"List library kits","openapi":"openapi.json GET /v2/library/kits","href":"/api-reference/v2/library/list-library-kits"},{"title":"Search library graphics","openapi":"openapi.json GET /v2/library/graphics","href":"/api-reference/v2/library/list-library-graphics"},{"title":"Import a library kit","openapi":"openapi.json POST /v2/library/kits/{id}/import","href":"/api-reference/v2/library/import-library-kit"},{"title":"Import library graphics","openapi":"openapi.json POST /v2/library/graphics/import","href":"/api-reference/v2/library/import-library-graphics"}]},{"group":"Settings","pages":[{"title":"Get the settings","openapi":"openapi.json GET /v2/settings","href":"/api-reference/v2/settings/get-settings"},{"title":"Update the settings","openapi":"openapi.json PATCH /v2/settings","href":"/api-reference/v2/settings/update-settings"}]}]},{"group":"Editor","pages":[{"title":"Basic Installation","href":"/api-reference/editor/installation"},{"title":"Configuration","href":"/api-reference/editor/configuration"},{"title":"Generate Embed Code","href":"/api-reference/editor/embed"}]}]}]},"basePath":"","title":"Test a connector - Print.App Documentation","buildId":"dpl_Aw98ji4XvBsgtZwL1VrkUF9ehFqz","deploymentId":"dpl_Aw98ji4XvBsgtZwL1VrkUF9ehFqz","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CQGbdtm4.js","utils-D88A1f-Z.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-ChqWdz1A.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-yBrxdh_6.js","snippetPresets-BgqDrFJC.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-Duxc2rZw.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-C7jidOil.js","shallow-xkjpHm-U.js","getApiPlaygroundDisplay-fE3rVpvL.js","CodeSnippet-LgxljKed.js","CodeSnippets-D-pXWDHq.js","Page-C2-BijcO.js","getPastedJson-CLRcu-uo.js","icon-Cxirpjgo.js","MethodPill-D49eqY5e.js","DuplicateIcon-CivCz5Rp.js","createIcon-D71qL3f5.js","DynamicMarkdown-BcGRTrw6.js","SectionHeading-DzaqmmSD.js","axios-vUo_bRtp.js","Markdown-CZqUYmMp.js","clsx-B6IZIRsp.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-B0ZV6X5T.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-MqLyPtsW.js"]}