Guides
AI agents: read /llms.txt; add .md to any page URL. This page as Markdown: /guides.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.
Each guide does one job, step by step, with the operations it uses and a working example. They’re grouped by the record they work on, as in How YoPrint works and the API reference: an invoice’s lines are with invoices, a shipment’s with shipping.
New here? Quote to payment walks one order through every step, start to finish, and links to the guides below for the details.
Find a guide
Section titled “Find a guide”| I want to… | Guide |
|---|---|
| Create a quote or sales order, change its dates or status, publish it, ask for approval, convert it | Create and change orders |
| Put products, custom items and fees on an order | Add line items |
| Create jobs, schedule them, and move jobs and tasks through statuses | Schedule and track production |
| Ship some or all of an order, get rates and buy or record labels | Ship an order |
| Bill an order: create invoices and their lines | Invoice an order |
| Record payments, refunds and store credit, and split payments across invoices | Take payments and refunds |
| Create, find or update customers, contacts and addresses | Create and sync customers |
| Read your products and supplier catalog prices and stock | Look up products and prices |
| Read and update purchase orders | Work with purchase orders |
| Hear about changes as they happen | Receive webhooks |
| Export a quarter’s orders, or import a price table | Export and import data |
| Connect YoPrint to other apps without code | Zapier and no-code |
Before you start
Section titled “Before you start”Every guide assumes the API basics: your key in the Authorization header and ids from the id field. Amounts use different encodings: check Money and quantities for each field. If a call fails, see Errors.