# Overview

> What the YoPrint API is, who it's for, what it covers today, and the five facts to know before your first request.

Web page: https://developer.yoprint.com/start/

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](https://developer.yoprint.com/how-yoprint-works.md) explains those records and how they connect.

## Two ways in

**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](https://developer.yoprint.com/start/quickstart.md).

**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](https://developer.yoprint.com/ai-apps.md).

## 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](https://developer.yoprint.com/ai-apps/capabilities.md). See [Work with purchase orders](https://developer.yoprint.com/guides/purchase-orders.md).

## Five facts to know first

1. **One host, versioned paths.** Every path starts with `https://secure.yoprint.com`, then `/v1` or `/v2`, then `/api/store/` and your team slug. Many v2 paths repeat `/v2/` after the slug. See [Base URL and versions](https://developer.yoprint.com/concepts/base-url-and-versions.md).
2. **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](https://developer.yoprint.com/concepts/authentication.md).
3. **Ids are hash strings.** Name records by their `id` field, never by the document number people see. See [IDs](https://developer.yoprint.com/concepts/ids.md).
4. **Amounts are exact pairs.** A decimal pair is `value` ÷ 10^`dp`: `{ "value": 1250, "dp": 2 }` is 12.50. Never send a plain number like `12.5`. Older fields use thousandths (`300000` is 300.00). See [Money and quantities](https://developer.yoprint.com/concepts/money-and-quantities.md).
5. **Creates aren't idempotent.** A retried create makes a second record. See [Retries and duplicates](https://developer.yoprint.com/concepts/retries-and-duplicates.md).

> **Caution:** The API works on live data and has the same effects as the web app. Some operations email customers, and buying a shipping label spends money. See [What a write also does](https://developer.yoprint.com/concepts/side-effects.md).

## 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](https://developer.yoprint.com/concepts/roles-and-permissions.md).

## How these docs fit together

**Diagram:** Read them in this order the first time.

1. **How YoPrint works**: The shop's records and how they connect: quotes, orders, jobs, invoices
2. **API basics**: The rules every request follows: keys, ids, money, errors
3. **Guides**: One task per page, step by step
4. **API reference**: Every operation, with its rules, request, response and errors

New to YoPrint? Start with [How YoPrint works](https://developer.yoprint.com/how-yoprint-works.md). [AI apps](https://developer.yoprint.com/ai-apps.md) explains connecting Claude, ChatGPT and others. Every page is also available as Markdown, for AI agents and tools: add `.md` to its address.