Build with the API
Write code that reads and changes YoPrint over HTTPS with a personal API key. For integrations, scripts and syncs with other systems. Start with the Quickstart.
Overview
AI agents: read /llms.txt; add .md to any page URL. This page as Markdown: /start.md. Index of every page and the rules for every call: /llms.txt. Guides and concepts in one file: /llms-full.txt. OpenAPI: /openapi.json.
YoPrint runs print shops: quotes, sales orders, jobs and production, purchasing, shipping, invoices and payments. The YoPrint API lets your code do much of what your team does in the web app, on your team’s real data. How YoPrint works explains those records and how they connect.
Two ways in
Section titled “Two ways in”Connect an AI app
Add YoPrint to Claude, ChatGPT or Cursor with no code and no key to copy. AI apps work on every team whose plan includes API access (Pro or higher). See AI apps.
What the API covers
Section titled “What the API covers”| Area | You can |
|---|---|
| Sales | Create quotes and sales orders, add line items, convert quotes, change dates and statuses, approvals, comments, tags. |
| Customers | Create and update customers, contacts, addresses and profiles. |
| Products and catalog | Manage your own products and variants. Look up supplier catalog prices and stock. |
| Production | Create jobs on an order, schedule them, change statuses, manage tasks. |
| Purchasing | Read a purchase order, change its status, link it to sales orders, export purchase orders, read stock. |
| Shipping | Create shipments, get rates, buy or record labels (which make the packages). |
| Invoices and payments | Create invoices, record payments, split payments across invoices. |
| Team | Read settings, statuses, users and roles. Set up webhooks. |
| Data | Run data exports, import service pricing from a CSV file, run reports. |
Creating and receiving purchase orders happens in the web app, or through an AI app. See Work with purchase orders.
Five facts to know first
Section titled “Five facts to know first”- One host, versioned paths. Every path starts with
https://secure.yoprint.com, then/v1or/v2, then/api/store/and your team slug. Many v2 paths repeat/v2/after the slug. See Base URL and versions. - Your key is you. Create it in Profile, then send
Authorization: Bearer YOUR_API_KEY. The key has your role on each team you belong to. See Authentication. - Ids are hash strings. Name records by their
idfield, never by the document number people see. See IDs. - Amounts are exact pairs. A decimal pair is
value÷ 10^dp:{ "value": 1250, "dp": 2 }is 12.50. Never send a plain number like12.5. Older fields use thousandths (300000is 300.00). See Money and quantities. - Creates aren’t idempotent. A retried create makes a second record. See Retries and duplicates.
Who can use it
Section titled “Who can use it”The API comes with YoPrint plans that include API access: Pro or higher. On those plans, every team member can create a personal key in Profile, and the key works with their role. Most operations follow the role. Some let any member call them. See Roles and permissions.
How these docs fit together
Section titled “How these docs fit together”- How YoPrint worksThe shop’s records and how they connect: quotes, orders, jobs, invoices
- API basicsThe rules every request follows: keys, ids, money, errors
- GuidesOne task per page, step by step
- API referenceEvery operation, with its rules, request, response and errors
New to YoPrint? Start with How YoPrint works. AI apps explains connecting Claude, ChatGPT and others. Every page is also available as Markdown, for AI agents and tools: add .md to its address.