{ "info": { "name": "HeyMadeIt Printer API", "description": "Set baseUrl to your printer origin and apiKey to a scoped server key. Example UUIDs and customer IDs must be replaced. Writes modify real tenant resources.", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "variable": [ { "key": "baseUrl", "value": "https://YOUR-PRINTER-HOST" }, { "key": "apiKey", "value": "" } ], "item": [ { "name": "Orders", "item": [ { "name": "List orders", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/orders", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "orders" ], "variable": [] }, "description": "Print orders, verified payment updates and production files.\n\nRequired scope: `orders:read`. All resources are scoped to this printer hostname.\n\n\n\nEndpoint throttle: 60 requests per 60 seconds. Respect Retry-After on 429." }, "response": [] }, { "name": "Create orders", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "shop-order-1042" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/orders", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "orders" ], "variable": [] }, "description": "Print orders, verified payment updates and production files.\n\nRequired scope: `orders:write`. All resources are scoped to this printer hostname.\n\nIdempotency-Key is required (1\u2013120 letters, digits, underscores, dots, colons or hyphens). Reuse it for the same request body on retries; a different body with the same key returns 409. Shipping addresses are required when the shipping method requires one. Payment verification belongs on your server.\n\nEndpoint throttle: 120 requests per 60 seconds. Respect Retry-After on 429.", "body": { "mode": "raw", "raw": "{\n \"customer_id\": 123,\n \"payment_method\": \"external\",\n \"shipping_method_id\": 1,\n \"lines\": [\n {\n \"product\": \"00000000-0000-7000-8000-000000000001\",\n \"design\": \"00000000-0000-7000-8000-000000000001\",\n \"quantity\": 100\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Get orders", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/orders/:order", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "orders", ":order" ], "variable": [ { "key": "order", "value": "", "description": "Replace with your own resource UUID." } ] }, "description": "Print orders, verified payment updates and production files.\n\nRequired scope: `orders:read`. All resources are scoped to this printer hostname.\n\n\n\nEndpoint throttle: 60 requests per 60 seconds. Respect Retry-After on 429." }, "response": [] }, { "name": "Update orders", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/orders/:order", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "orders", ":order" ], "variable": [ { "key": "order", "value": "", "description": "Replace with your own resource UUID." } ] }, "description": "Print orders, verified payment updates and production files.\n\nRequired scope: `orders:write`. All resources are scoped to this printer hostname.\n\n", "body": { "mode": "raw", "raw": "{\n \"status\": \"paid\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] } ] }, { "name": "Products", "item": [ { "name": "List products", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/products", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "products" ], "variable": [], "query": [ { "key": "page", "value": "", "disabled": true }, { "key": "per_page", "value": "25", "disabled": true } ] }, "description": "Catalogue items and quantity prices. Monetary fields are integer minor currency units.\n\nRequired scope: `products:read`. All resources are scoped to this printer hostname.\n\n\n\nEndpoint throttle: 120 requests per 60 seconds. Respect Retry-After on 429." }, "response": [] }, { "name": "Create products", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/products", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "products" ], "variable": [] }, "description": "Catalogue items and quantity prices. Monetary fields are integer minor currency units.\n\nRequired scope: `products:write`. All resources are scoped to this printer hostname.\n\n\n\nEndpoint throttle: 120 requests per 60 seconds. Respect Retry-After on 429.", "body": { "mode": "raw", "raw": "{\n \"name\": \"A5 flyer\",\n \"width\": 148,\n \"height\": 210,\n \"unit\": \"mm\",\n \"active\": true,\n \"prices\": [\n {\n \"quantity\": 100,\n \"net_ore\": 25000\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Get products", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/products/:product", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "products", ":product" ], "variable": [ { "key": "product", "value": "", "description": "Replace with your own resource UUID." } ] }, "description": "Catalogue items and quantity prices. Monetary fields are integer minor currency units.\n\nRequired scope: `products:read`. All resources are scoped to this printer hostname.\n\n\n\nEndpoint throttle: 120 requests per 60 seconds. Respect Retry-After on 429." }, "response": [] }, { "name": "Update products", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/products/:product", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "products", ":product" ], "variable": [ { "key": "product", "value": "", "description": "Replace with your own resource UUID." } ] }, "description": "Catalogue items and quantity prices. Monetary fields are integer minor currency units.\n\nRequired scope: `products:write`. All resources are scoped to this printer hostname.\n\n\n\nEndpoint throttle: 120 requests per 60 seconds. Respect Retry-After on 429.", "body": { "mode": "raw", "raw": "{\n \"name\": \"A5 flyer\",\n \"width\": 148,\n \"height\": 210,\n \"unit\": \"mm\",\n \"active\": true,\n \"prices\": [\n {\n \"quantity\": 100,\n \"net_ore\": 25000\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Archive products", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/products/:product", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "products", ":product" ], "variable": [ { "key": "product", "value": "", "description": "Replace with your own resource UUID." } ] }, "description": "Catalogue items and quantity prices. Monetary fields are integer minor currency units.\n\nRequired scope: `products:write`. All resources are scoped to this printer hostname.\n\nArchives the product by setting active=false; retains existing orders.\n\nEndpoint throttle: 120 requests per 60 seconds. Respect Retry-After on 429." }, "response": [] } ] }, { "name": "Customers", "item": [ { "name": "List customers", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/customers", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "customers" ], "variable": [], "query": [ { "key": "page", "value": "", "disabled": true }, { "key": "per_page", "value": "25", "disabled": true }, { "key": "email", "value": "", "disabled": true } ] }, "description": "Find or create customer accounts on this printer only.\n\nRequired scope: `customers:read`. All resources are scoped to this printer hostname.\n\n\n\nEndpoint throttle: 120 requests per 60 seconds. Respect Retry-After on 429." }, "response": [] }, { "name": "Create customers", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/customers", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "customers" ], "variable": [] }, "description": "Find or create customer accounts on this printer only.\n\nRequired scope: `customers:write`. All resources are scoped to this printer hostname.\n\n\n\nEndpoint throttle: 120 requests per 60 seconds. Respect Retry-After on 429.", "body": { "mode": "raw", "raw": "{\n \"name\": \"Alex Example\",\n \"email\": \"alex@example.com\",\n \"locale\": \"en\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] } ] }, { "name": "Designs", "item": [ { "name": "List designs", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/designs", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "designs" ], "variable": [], "query": [ { "key": "page", "value": "", "disabled": true }, { "key": "per_page", "value": "25", "disabled": true } ] }, "description": "Customer-owned editable documents, created blank or copied from a published template.\n\nRequired scope: `designs:read`. All resources are scoped to this printer hostname.\n\n\n\nEndpoint throttle: 120 requests per 60 seconds. Respect Retry-After on 429." }, "response": [] }, { "name": "Create designs", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/designs", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "designs" ], "variable": [] }, "description": "Customer-owned editable documents, created blank or copied from a published template.\n\nRequired scope: `designs:write`. All resources are scoped to this printer hostname.\n\nChoose either a preset format or width_mm + height_mm. With a template, supply the exact trim size and omit format. Flat designs support 1\u20138 pages; booklet presets use their own sheet constraints. UUIDs identify designs and templates; customer_id is an integer.\n\nEndpoint throttle: 120 requests per 60 seconds. Respect Retry-After on 429.", "body": { "mode": "raw", "raw": "{\n \"customer_id\": 123,\n \"title\": \"Spring flyer\",\n \"width_mm\": 148,\n \"height_mm\": 210,\n \"pages\": 1\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Get designs", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/designs/:design", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "designs", ":design" ], "variable": [ { "key": "design", "value": "", "description": "Replace with your own resource UUID." } ] }, "description": "Customer-owned editable documents, created blank or copied from a published template.\n\nRequired scope: `designs:read`. All resources are scoped to this printer hostname.\n\n\n\nEndpoint throttle: 120 requests per 60 seconds. Respect Retry-After on 429." }, "response": [] } ] }, { "name": "Templates", "item": [ { "name": "List templates", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/templates", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "templates" ], "variable": [], "query": [ { "key": "category", "value": "", "disabled": true }, { "key": "width_mm", "value": "", "disabled": true }, { "key": "height_mm", "value": "", "disabled": true }, { "key": "pages", "value": "", "disabled": true }, { "key": "fields", "value": "", "disabled": true }, { "key": "page", "value": "", "disabled": true }, { "key": "per_page", "value": "25", "disabled": true } ] }, "description": "Published shared templates and this printer\u2019s own templates. Publishing uses MCP, not REST.\n\nRequired scope: `templates:read`. All resources are scoped to this printer hostname.\n\nContains published HeyMadeIt templates and this printer\u2019s templates, never another printer\u2019s own templates. Both dimensions are required when filtering by size. fields=browse includes description_da and category_name_da.\n\nEndpoint throttle: 120 requests per 60 seconds. Respect Retry-After on 429." }, "response": [] }, { "name": "Get templates", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/templates/:template", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "templates", ":template" ], "variable": [ { "key": "template", "value": "", "description": "Replace with your own resource UUID." } ] }, "description": "Published shared templates and this printer\u2019s own templates. Publishing uses MCP, not REST.\n\nRequired scope: `templates:read`. All resources are scoped to this printer hostname.\n\n\n\nEndpoint throttle: 120 requests per 60 seconds. Respect Retry-After on 429." }, "response": [] } ] }, { "name": "Editor sessions", "item": [ { "name": "Create editor sessions", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/editor-sessions", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "editor-sessions" ], "variable": [] }, "description": "One-use, five-minute sessions for embedding the editor without exposing a merchant key.\n\nRequired scope: `editor:write`. All resources are scoped to this printer hostname.\n\nThe design must belong to customer_id. parent_origin must exactly match an origin allowed on embed_key. Redeem session_token once by POST /embed/session, or pass it as sessionToken to the embed SDK. It expires after 300 seconds. Never put it in a URL or logs. The response uses Cache-Control: no-store.\n\nEndpoint throttle: 60 requests per 60 seconds. Respect Retry-After on 429.", "body": { "mode": "raw", "raw": "{\n \"customer_id\": 123,\n \"design\": \"00000000-0000-7000-8000-000000000001\",\n \"embed_key\": \"YOUR_EMBED_KEY\",\n \"parent_origin\": \"https://shop.example.com\",\n \"finish\": \"save\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] } ] }, { "name": "Memberships", "item": [ { "name": "List memberships", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/membership-plans", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "membership-plans" ], "variable": [] }, "description": "Printer-owned plans for its customers; separate from HeyMadeIt printer subscriptions.\n\nRequired scope: `subscriptions:read`. All resources are scoped to this printer hostname.\n\n" }, "response": [] } ] }, { "name": "Subscriptions", "item": [ { "name": "List subscriptions", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/subscriptions", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "subscriptions" ], "variable": [], "query": [ { "key": "page", "value": "1", "disabled": true } ] }, "description": "Sync your payment provider\u2019s verified membership state from your server.\n\nRequired scope: `subscriptions:read`. All resources are scoped to this printer hostname.\n\n" }, "response": [] }, { "name": "Create subscriptions", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/subscriptions", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "subscriptions" ], "variable": [] }, "description": "Sync your payment provider\u2019s verified membership state from your server.\n\nRequired scope: `subscriptions:write`. All resources are scoped to this printer hostname.\n\nOnly call after verifying your payment provider on your server. current_period_end must be in the future for active or trialing status. Reusing external_id for a different customer returns 409. The printer must enable subscriptions.", "body": { "mode": "raw", "raw": "{\n \"customer_id\": 123,\n \"plan\": \"00000000-0000-7000-8000-000000000001\",\n \"external_id\": \"provider-subscription-1042\",\n \"status\": \"active\",\n \"current_period_end\": \"2099-12-31T23:59:59Z\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] } ] }, { "name": "Exports", "item": [ { "name": "Create exports", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/designs/:design/exports", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "designs", ":design", "exports" ], "variable": [ { "key": "design", "value": "", "description": "Replace with your own resource UUID." } ] }, "description": "Asynchronous document rendering and authenticated downloads.\n\nRequired scope: `exports:write`. All resources are scoped to this printer hostname.\n\nPOST queues a render (202). Poll GET /exports/{export} until status=done or a terminal failed/canceled state; back off between polls. Download file_url with exports:read; it is null until done. Expired or unavailable files return 404. No webhook delivery is promised. PDF Print supports marks, bleed and bleed_mm.\n\nEndpoint throttle: 30 requests per 60 seconds. Respect Retry-After on 429.", "body": { "mode": "raw", "raw": "{\n \"format\": \"pdf_print\",\n \"marks\": true,\n \"bleed\": true,\n \"bleed_mm\": 3,\n \"layout\": \"pages\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Get exports", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/exports/:export", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "exports", ":export" ], "variable": [ { "key": "export", "value": "", "description": "Replace with your own resource UUID." } ] }, "description": "Asynchronous document rendering and authenticated downloads.\n\nRequired scope: `exports:read`. All resources are scoped to this printer hostname.\n\nPOST queues a render (202). Poll GET /exports/{export} until status=done or a terminal failed/canceled state; back off between polls. Download file_url with exports:read; it is null until done. Expired or unavailable files return 404. No webhook delivery is promised. PDF Print supports marks, bleed and bleed_mm." }, "response": [] }, { "name": "Get exports", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/exports/:export/file", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "exports", ":export", "file" ], "variable": [ { "key": "export", "value": "", "description": "Replace with your own resource UUID." } ] }, "description": "Asynchronous document rendering and authenticated downloads.\n\nRequired scope: `exports:read`. All resources are scoped to this printer hostname.\n\nPOST queues a render (202). Poll GET /exports/{export} until status=done or a terminal failed/canceled state; back off between polls. Download file_url with exports:read; it is null until done. Expired or unavailable files return 404. No webhook delivery is promised. PDF Print supports marks, bleed and bleed_mm." }, "response": [] } ] }, { "name": "Shipping", "item": [ { "name": "List shipping", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/shipping-methods", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "shipping-methods" ], "variable": [] }, "description": "Delivery choices and their net prices.\n\nRequired scope: `products:read`. All resources are scoped to this printer hostname.\n\n" }, "response": [] }, { "name": "Create shipping", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/shipping-methods", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "shipping-methods" ], "variable": [] }, "description": "Delivery choices and their net prices.\n\nRequired scope: `products:write`. All resources are scoped to this printer hostname.\n\n", "body": { "mode": "raw", "raw": "{\n \"name\": \"Collection\",\n \"net_ore\": 0,\n \"active\": true,\n \"requires_address\": false\n}", "options": { "raw": { "language": "json" } } } }, "response": [] } ] }, { "name": "Print files", "item": [ { "name": "Get print files", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/print-files/:printFile", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "print-files", ":printFile" ], "variable": [ { "key": "printFile", "value": "", "description": "Replace with your own resource UUID." } ] }, "description": "Authenticated order production PDF downloads.\n\nRequired scope: `orders:read`. All resources are scoped to this printer hostname.\n\n" }, "response": [] } ] }, { "name": "Client licences", "item": [ { "name": "List client licences", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/client-licences", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "client-licences" ], "variable": [] }, "description": "Allocate the printer\u2019s Business employee seat allowance across client company teams.\n\nRequired scope: `licences:read`. All resources are scoped to this printer hostname.\n\nLight / Pro / Plus include 5 / 15 / 50 Business employee seats in total. Team owners and pending invitations consume seats. POST without team creates a team (201); with team resizes it (200). DELETE releases allocation without deleting designs or the team. These are named employee seats, not unlimited company subscriptions." }, "response": [] }, { "name": "Create client licences", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/client-licences", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "client-licences" ], "variable": [] }, "description": "Allocate the printer\u2019s Business employee seat allowance across client company teams.\n\nRequired scope: `licences:write`. All resources are scoped to this printer hostname.\n\nLight / Pro / Plus include 5 / 15 / 50 Business employee seats in total. Team owners and pending invitations consume seats. POST without team creates a team (201); with team resizes it (200). DELETE releases allocation without deleting designs or the team. These are named employee seats, not unlimited company subscriptions.", "body": { "mode": "raw", "raw": "{\n \"customer_id\": 123,\n \"name\": \"Example Company\",\n \"seats\": 5\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Release client licences", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/client-licences/:team", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "client-licences", ":team" ], "variable": [ { "key": "team", "value": "", "description": "Replace with your own resource UUID." } ] }, "description": "Allocate the printer\u2019s Business employee seat allowance across client company teams.\n\nRequired scope: `licences:write`. All resources are scoped to this printer hostname.\n\nLight / Pro / Plus include 5 / 15 / 50 Business employee seats in total. Team owners and pending invitations consume seats. POST without team creates a team (201); with team resizes it (200). DELETE releases allocation without deleting designs or the team. These are named employee seats, not unlimited company subscriptions." }, "response": [] } ] } ] }