Sales orders
AI agents: read /llms.txt; add .md to any page URL. This page as Markdown: /reference/sales-orders.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.
Sales orders and quotes: create a draft, add jobs and lines, publish it, then run actions on it. A quote is a sales order with object_type quote, and most operations here serve both.
Learn more: Quotes and sales orders · Create and change orders · Quote to payment
12 operations
- POSTCreate a sales order or quote
/Creates a new draft sales order or quote.v2/ api/ store/ {team_slug}/ v2/ sales_order/ new - GETList the history of a sales order or quote
/Returns the order's activity history: who changed what and when.v2/ api/ store/ {team_slug}/ v2/ sales_order/ {order_unique_key}/ history - POSTList sales orders
/Lists sales orders, a page at a time, with filters and sorting.v2/ api/ store/ {team_slug}/ v2/ sales_order/ filter - GETGet a sales order or quote
/Returns one sales order or quote with its line items (v2/ api/ store/ {team_slug}/ v2/ sales_order/ {order_unique_key} items), customer and message participants. - PUTUpdate a sales order or quote
/Changes an order's header fields.v2/ api/ store/ {team_slug}/ v2/ sales_order/ {order_unique_key} - PUTRun an action on a sales order or quote
/Runs one named action on an order.v2/ api/ store/ {team_slug}/ v2/ sales_order/ {order_unique_key}/ action/ {action_name} - PUTSet the Client Note of a sales order or quote
/Sets the order's Client Note.v2/ api/ store/ {team_slug}/ v2/ sales_order/ {order_unique_key}/ customer_note - PUTSet the production note of a sales order or quote
/Sets the order's production note, for your shop floor.v2/ api/ store/ {team_slug}/ v2/ sales_order/ {order_unique_key}/ production_note - PATCHPublish a draft sales order or quote
/Publishes a draft: what the Publish button does in the web app.v2/ api/ store/ {team_slug}/ v2/ sales_order/ {order_unique_key}/ publish - DELETEDelete a sales order or quote
/Deletes a sales order or quote.v2/ api/ store/ {team_slug}/ v2/ sales_order/ {order_unique_key} - PATCHRestore a deleted sales order or quote
/Brings back a deleted sales order or quote with its lines, jobs, invoices, shipments and messages.v2/ api/ store/ {team_slug}/ v2/ sales_order/ {order_unique_key}/ restore - POSTExport sales orders as CSV
/Downloads a CSV file of the published sales orders whose issue date is in a range.v1/ api/ store/ {team_slug}/ sales_order/ export
Legacy and internal (2)
Prefer the operations above. Legacy operations name their replacement; internal ones are built for YoPrint's own apps.
- POSTFilter sales orders (retired v1)Legacy · deprecated
/Retired: this v1 operation no longer works.v1/ api/ store/ {team_slug}/ sales_order/ filter - GETGet an order's history (retired v1)Legacy · deprecated
/Retired: this v1 operation no longer works.v1/ api/ store/ {team_slug}/ sales_order/ {hash_id}/ history