# API reference

Every operation in YoPrint's public REST API (575 operations), grouped by what it works on. Web page: https://developer.yoprint.com/reference/

For one task, read the tag page, then the operation page. Each tag page also links one file with all its pages.

- Base URL `https://secure.yoprint.com`. Every path starts with the API version and your team slug: `/v1/api/store/{team_slug}/…` or `/v2/api/store/{team_slug}/…`. Most v2 paths repeat `/v2/` after the slug (`/v2/api/store/your-team/v2/sales_order/…`); copy each path from its reference page.
- Authentication: `Authorization: Bearer YOUR_API_KEY` on every request, with your personal API key from Profile in YoPrint. The team slug is the Team ID shown next to it. The key acts as you, with your role.
- Headers: always send `Accept: application/json` (without it a wrong path or method answers an HTML page), `X-Yoprint-Decimal-Format: exact-v1` so no amount is rounded, and `Content-Type: application/json` with a JSON body.
- Check `success`, not only the HTTP status. Some operations refuse with HTTP 200 and `success: false`; publishing answers 200 with `data.valid: false` when a check fails; some business refusals answer 500 with an `error.code`, and resending them unchanged fails again. Each operation's page lists its cases.
- Money: send amounts and quantities as decimal pairs, `{ "value": 1250, "dp": 2 }` for 12.50 (a plain `12.5` is refused). Some fields count thousandths instead: payment `amount` (`100000` is 100.00), product `default_price` and `paid_amount`. The order and invoice `calc_*` totals are deprecated (they count only what is invoiced, 0 until then): read `order_item_cart_total`, `invoiced_total` and the other `invoiced_*` decimal pairs. Check each field's encoding on its page.
- No general idempotency keys: a retried create makes a second record. Only shipment creates and address saves (`operation_key`) and data exports (`idempotency_key`) take one. After a timeout, read back before you resend.
- Real money: buying a shipping label charges the team's Shippo account, a text message costs what Twilio charges, and charging a card moves money. Pages mark these "Spends money" or "Moves money". Get a person's approval first and never retry them blindly.
- Email limits: going over a team's sending limit blocks the whole team from sending email until YoPrint support lifts it. Cap your own sending.
- Legacy (deprecated) and internal operations are marked on their pages and in each section's list. Build on the others.
- Placeholders: examples use `YOUR_API_KEY`, the team slug `your-team` and made-up ids such as `V4keXwwxMQyXw7`. Replace them with your own values.
- OpenAPI: https://developer.yoprint.com/openapi.json (OpenAPI 3.1.0).

## Sales

### [Sales orders](https://developer.yoprint.com/reference/sales-orders.md)

Sales orders and quotes: create a draft, add jobs and lines, publish it, then run actions on it.

- [Create a sales order or quote](https://developer.yoprint.com/reference/sales-orders/v2-order-create.md): `POST /v2/api/store/{team_slug}/v2/sales_order/new`
- [List the history of a sales order or quote](https://developer.yoprint.com/reference/sales-orders/v2-order-history.md): `GET /v2/api/store/{team_slug}/v2/sales_order/{order_unique_key}/history`
- [List sales orders](https://developer.yoprint.com/reference/sales-orders/v2-sales-order-filter.md): `POST /v2/api/store/{team_slug}/v2/sales_order/filter`
- [Get a sales order or quote](https://developer.yoprint.com/reference/sales-orders/v2-order-show.md): `GET /v2/api/store/{team_slug}/v2/sales_order/{order_unique_key}`
- [Update a sales order or quote](https://developer.yoprint.com/reference/sales-orders/v2-order-update.md): `PUT /v2/api/store/{team_slug}/v2/sales_order/{order_unique_key}`
- [Run an action on a sales order or quote](https://developer.yoprint.com/reference/sales-orders/v2-order-single-action.md): `PUT /v2/api/store/{team_slug}/v2/sales_order/{order_unique_key}/action/{action_name}`
- [Set the Client Note of a sales order or quote](https://developer.yoprint.com/reference/sales-orders/v2-order-customer-note-update.md): `PUT /v2/api/store/{team_slug}/v2/sales_order/{order_unique_key}/customer_note`
- [Set the production note of a sales order or quote](https://developer.yoprint.com/reference/sales-orders/v2-order-production-note-update.md): `PUT /v2/api/store/{team_slug}/v2/sales_order/{order_unique_key}/production_note`
- [Publish a draft sales order or quote](https://developer.yoprint.com/reference/sales-orders/v2-order-publish.md): `PATCH /v2/api/store/{team_slug}/v2/sales_order/{order_unique_key}/publish`
- [Delete a sales order or quote](https://developer.yoprint.com/reference/sales-orders/v2-order-destroy.md): `DELETE /v2/api/store/{team_slug}/v2/sales_order/{order_unique_key}`
- [Restore a deleted sales order or quote](https://developer.yoprint.com/reference/sales-orders/v2-order-restore.md): `PATCH /v2/api/store/{team_slug}/v2/sales_order/{order_unique_key}/restore`
- [Export sales orders as CSV](https://developer.yoprint.com/reference/sales-orders/v1-sales-order-export.md): `POST /v1/api/store/{team_slug}/sales_order/export`
- [Filter sales orders (retired v1)](https://developer.yoprint.com/reference/sales-orders/v1-sales-order-filter.md): `POST /v1/api/store/{team_slug}/sales_order/filter` (legacy, deprecated)
- [Get an order's history (retired v1)](https://developer.yoprint.com/reference/sales-orders/v1-sales-order-history.md): `GET /v1/api/store/{team_slug}/sales_order/{hash_id}/history` (legacy, deprecated)

### [Sales order line items](https://developer.yoprint.com/reference/sales-order-line-items.md)

The lines of a sales order or quote: catalog products, your own products and their sizes and colors, custom lines and fees.

- [Add a line item to a sales order or quote](https://developer.yoprint.com/reference/sales-order-line-items/v2-order-item-store.md): `POST /v2/api/store/{team_slug}/v2/sales_order/{order_unique_key}/order_item`
- [Add, change and delete line items in one save](https://developer.yoprint.com/reference/sales-order-line-items/v2-order-item-bulk.md): `POST /v2/api/store/{team_slug}/v2/sales_order/{order_unique_key}/order_item/bulk`
- [List the line items of a sales order or quote](https://developer.yoprint.com/reference/sales-order-line-items/v2-order-item-index.md): `GET /v2/api/store/{team_slug}/v2/sales_order/{order_unique_key}/order_item`
- [Get one line item](https://developer.yoprint.com/reference/sales-order-line-items/v2-order-item-show.md): `GET /v2/api/store/{team_slug}/v2/sales_order/order_item/{order_item_unique_key}`
- [Update a line item](https://developer.yoprint.com/reference/sales-order-line-items/v2-order-item-update.md): `PUT /v2/api/store/{team_slug}/v2/sales_order/order_item/{order_item_unique_key}`
- [Delete a line item](https://developer.yoprint.com/reference/sales-order-line-items/v2-order-item-destroy.md): `DELETE /v2/api/store/{team_slug}/v2/sales_order/order_item/{order_item_unique_key}`

### [Sales order approvals](https://developer.yoprint.com/reference/sales-order-approvals.md)

Ask the customer to approve a whole sales order or quote, and record their answer.

- [Record the customer's answer to an order approval](https://developer.yoprint.com/reference/sales-order-approvals/v2-order-approval-complete.md): `PUT /v2/api/store/{team_slug}/v2/sales_order/{hash_id}/approval/{hash_id2}/complete`
- [List all approvals of an order, jobs included](https://developer.yoprint.com/reference/sales-order-approvals/v2-order-approval-all-approvals.md): `GET /v2/api/store/{team_slug}/v2/sales_order/{hash_id}/all_approvals`
- [List the order approvals of an order](https://developer.yoprint.com/reference/sales-order-approvals/v2-order-approval-index.md): `GET /v2/api/store/{team_slug}/v2/sales_order/{hash_id}/approval`
- [Get an order approval](https://developer.yoprint.com/reference/sales-order-approvals/v2-order-approval-show.md): `GET /v2/api/store/{team_slug}/v2/sales_order/{hash_id}/approval/{hash_id2}`
- [Ask the customer to approve an order](https://developer.yoprint.com/reference/sales-order-approvals/v2-order-approval-store.md): `POST /v2/api/store/{team_slug}/v2/sales_order/{hash_id}/approval`
- [Update an order approval](https://developer.yoprint.com/reference/sales-order-approvals/v2-order-approval-update.md): `PUT /v2/api/store/{team_slug}/v2/sales_order/{hash_id}/approval/{hash_id2}`
- [Delete an order approval](https://developer.yoprint.com/reference/sales-order-approvals/v2-order-approval-destroy.md): `DELETE /v2/api/store/{team_slug}/v2/sales_order/{hash_id}/approval/{hash_id2}`

### [Sales order files](https://developer.yoprint.com/reference/sales-order-files.md)

Files attached to a sales order or quote: the Files section in the web app.

- [List the files of an order](https://developer.yoprint.com/reference/sales-order-files/v2-order-media-index.md): `GET /v2/api/store/{team_slug}/v2/sales_order/{hash_id}/media`
- [Get a file of an order](https://developer.yoprint.com/reference/sales-order-files/v2-order-media-show.md): `GET /v2/api/store/{team_slug}/v2/sales_order/{hash_id}/media/{hash_id2}`
- [Attach uploaded files to an order](https://developer.yoprint.com/reference/sales-order-files/v2-order-media-attach.md): `PUT /v2/api/store/{team_slug}/v2/sales_order/{hash_id}/media/attach`
- [Delete a file from an order](https://developer.yoprint.com/reference/sales-order-files/v2-order-media-destroy.md): `DELETE /v2/api/store/{team_slug}/v2/sales_order/{hash_id}/media/{hash_id2}`

### [Sales order comments](https://developer.yoprint.com/reference/sales-order-comments.md)

Internal comments on a published sales order or quote.

- [Add a comment to an order](https://developer.yoprint.com/reference/sales-order-comments/v2-order-comment-store.md): `POST /v2/api/store/{team_slug}/v2/sales_order/{hash_id}/comment`
- [List the comments of an order](https://developer.yoprint.com/reference/sales-order-comments/v2-order-comment-index.md): `GET /v2/api/store/{team_slug}/v2/sales_order/{hash_id}/comment/index`
- [Get a comment](https://developer.yoprint.com/reference/sales-order-comments/v2-order-comment-show.md): `GET /v2/api/store/{team_slug}/v2/sales_order/{hash_id}/comment/{hash_id2}`
- [Edit a comment](https://developer.yoprint.com/reference/sales-order-comments/v2-order-comment-update.md): `PUT /v2/api/store/{team_slug}/v2/sales_order/{hash_id}/comment/{hash_id2}`
- [Delete a comment](https://developer.yoprint.com/reference/sales-order-comments/v2-order-comment-destroy.md): `DELETE /v2/api/store/{team_slug}/v2/sales_order/{hash_id}/comment/{hash_id2}`
- [Restore a deleted comment](https://developer.yoprint.com/reference/sales-order-comments/v2-order-comment-restore.md): `PATCH /v2/api/store/{team_slug}/v2/sales_order/{hash_id}/comment/{hash_id2}/restore`

### [Sales order messages](https://developer.yoprint.com/reference/sales-order-messages.md)

The conversation with the customer on an order: its participants and the emails and text messages sent to them.

- [Add a participant to an order](https://developer.yoprint.com/reference/sales-order-messages/v1-sales-order-participant-store.md): `POST /v1/api/store/{team_slug}/sales_order/{hash_id}/participant`
- [List the messages of an order](https://developer.yoprint.com/reference/sales-order-messages/v2-order-message-index.md): `GET /v2/api/store/{team_slug}/v2/sales_order/{hash_id}/message`
- [List the participants of an order](https://developer.yoprint.com/reference/sales-order-messages/v1-sales-order-participant-index.md): `GET /v1/api/store/{team_slug}/sales_order/{hash_id}/participant`
- [Send a message to the customer](https://developer.yoprint.com/reference/sales-order-messages/v2-order-message-store.md): `POST /v2/api/store/{team_slug}/v2/sales_order/{hash_id}/message`
- [Remove every participant from an order](https://developer.yoprint.com/reference/sales-order-messages/v1-sales-order-participant-clear.md): `PATCH /v1/api/store/{team_slug}/sales_order/{hash_id}/participant/clear`
- [List the messages of an order (v1)](https://developer.yoprint.com/reference/sales-order-messages/v1-sales-order-v1-message-index.md): `GET /v1/api/store/{team_slug}/sales_order/{hash_id}/message` (legacy, deprecated)
- [Send a message to the customer (v1)](https://developer.yoprint.com/reference/sales-order-messages/v1-sales-order-v1-message-store.md): `POST /v1/api/store/{team_slug}/sales_order/{hash_id}/message` (legacy, deprecated)

### [Sales order assignees](https://developer.yoprint.com/reference/sales-order-assignees.md)

The team members in an order's Assigned To list.

- [List the people assigned to an order](https://developer.yoprint.com/reference/sales-order-assignees/v2-assign-user-index.md): `GET /v2/api/store/{team_slug}/v2/sales_order/{hash_id}/assign_user`
- [Assign a team member to an order](https://developer.yoprint.com/reference/sales-order-assignees/v2-assign-user-add.md): `PUT /v2/api/store/{team_slug}/v2/sales_order/{hash_id}/assign_user/add`
- [Remove a team member from an order](https://developer.yoprint.com/reference/sales-order-assignees/v2-assign-user-remove.md): `PUT /v2/api/store/{team_slug}/v2/sales_order/{hash_id}/assign_user/remove`

### [Sales order tags](https://developer.yoprint.com/reference/sales-order-tags.md)

Add and remove the team's tags on a sales order or quote.

- [List the tags of an order](https://developer.yoprint.com/reference/sales-order-tags/v1-sales-order-tag-index.md): `GET /v1/api/store/{team_slug}/sales_order/{hash_id}/tag`
- [Tag an order](https://developer.yoprint.com/reference/sales-order-tags/v1-sales-order-tag-attach.md): `PUT /v1/api/store/{team_slug}/sales_order/{hash_id}/tag/attach`
- [Remove a tag from an order](https://developer.yoprint.com/reference/sales-order-tags/v1-sales-order-tag-detach.md): `PUT /v1/api/store/{team_slug}/sales_order/{hash_id}/tag/detach`

### [Sales order purchase orders](https://developer.yoprint.com/reference/sales-order-purchase-orders.md)

Purchase orders linked to a sales order, by the stock workflow or by hand.

- [List the purchase orders linked to an order](https://developer.yoprint.com/reference/sales-order-purchase-orders/v2-purchase-order-link-index.md): `GET /v2/api/store/{team_slug}/v2/sales_order/{hash_id}/purchase_order_link`
- [Link purchase orders to a sales order](https://developer.yoprint.com/reference/sales-order-purchase-orders/v2-purchase-order-link-add.md): `PUT /v2/api/store/{team_slug}/v2/sales_order/{hash_id}/purchase_order_link/add`
- [Unlink purchase orders from an order](https://developer.yoprint.com/reference/sales-order-purchase-orders/v2-purchase-order-link-remove.md): `PUT /v2/api/store/{team_slug}/v2/sales_order/{hash_id}/purchase_order_link/remove`

### [Quotes](https://developer.yoprint.com/reference/quotes.md)

Lists and exports for quotes only.

- [List quotes](https://developer.yoprint.com/reference/quotes/v2-quote-filter.md): `POST /v2/api/store/{team_slug}/v2/quote/filter`
- [Export quotes as CSV](https://developer.yoprint.com/reference/quotes/v1-quote-export.md): `POST /v1/api/store/{team_slug}/quote/export`
- [Filter quotes (retired v1)](https://developer.yoprint.com/reference/quotes/v1-quote-filter.md): `POST /v1/api/store/{team_slug}/quote/filter` (legacy, deprecated)

### [Search](https://developer.yoprint.com/reference/search.md)

Quick lookups that return the first matches, for search boxes and pickers.

- [Search sales orders and quotes](https://developer.yoprint.com/reference/search/v2-search-orders-get.md): `GET /v2/api/store/{team_slug}/search/orders`
- [Search sales orders and quotes](https://developer.yoprint.com/reference/search/v2-search-orders-post.md): `POST /v2/api/store/{team_slug}/search/orders`

### [Approvals](https://developer.yoprint.com/reference/approvals.md)

Every customer approval on your team, across all sales orders and quotes: artwork (job) approvals and whole-order approvals together, by approval id.

- [List approvals](https://developer.yoprint.com/reference/approvals/v1-approvals-index.md): `GET /v1/api/store/{team_slug}/approvals`
- [Filter approvals by type or status](https://developer.yoprint.com/reference/approvals/v1-approvals-filter.md): `POST /v1/api/store/{team_slug}/approvals/filter`
- [Get the approvals on an approval's order](https://developer.yoprint.com/reference/approvals/v1-approvals-show.md): `GET /v1/api/store/{team_slug}/approvals/{hash_id}`
- [Email an approval request to the customer](https://developer.yoprint.com/reference/approvals/v1-approvals-send-to-customer.md): `PATCH /v1/api/store/{team_slug}/approvals/{hash_id}/send_to_customer`
- [Delete an approval](https://developer.yoprint.com/reference/approvals/v1-approvals-destroy.md): `DELETE /v1/api/store/{team_slug}/approvals/{hash_id}`

### [Comments](https://developer.yoprint.com/reference/comments.md)

Any internal comment by its id, whatever it is on: a sales order, a quote, a job or a purchase order.

- [Get a comment](https://developer.yoprint.com/reference/comments/v1-comment-show.md): `GET /v1/api/store/{team_slug}/comment/{id}`
- [Edit a comment](https://developer.yoprint.com/reference/comments/v1-comment-update-put.md): `PUT /v1/api/store/{team_slug}/comment/{id}`
- [Edit a comment without checks](https://developer.yoprint.com/reference/comments/v1-comment-update-patch.md): `PATCH /v1/api/store/{team_slug}/comment/{id}`
- [Delete a comment](https://developer.yoprint.com/reference/comments/v1-comment-destroy.md): `DELETE /v1/api/store/{team_slug}/comment/{id}`
- [Restore a deleted comment](https://developer.yoprint.com/reference/comments/v1-comment-restore.md): `PATCH /v1/api/store/{team_slug}/comment/{hash_id}/restore`

### [Document numbers](https://developer.yoprint.com/reference/document-numbers.md)

Preview the next sales order, quote, purchase order or stock adjustment number.

- [Preview the next document number](https://developer.yoprint.com/reference/document-numbers/v1-misc-available-identifier.md): `GET /v1/api/store/{team_slug}/available_identifier`

### [Sales tax](https://developer.yoprint.com/reference/sales-tax.md)

Look up the automatic US sales tax rate for a shipping address.

- [Look up the automatic sales tax rate for an address](https://developer.yoprint.com/reference/sales-tax/v1-misc-calc-tax.md): `POST /v1/api/store/{team_slug}/misc/calc_tax`

## Customers

### [Customers](https://developer.yoprint.com/reference/customers.md)

The people and companies you sell to.

- [Create a customer](https://developer.yoprint.com/reference/customers/v1-customer-store.md): `POST /v1/api/store/{team_slug}/customer`
- [Create or update a customer by contact](https://developer.yoprint.com/reference/customers/v1-customer-upsert.md): `POST /v1/api/store/{team_slug}/customer/upsert`
- [List customers](https://developer.yoprint.com/reference/customers/v1-customer-index.md): `GET /v1/api/store/{team_slug}/customer`
- [List a customer's tags](https://developer.yoprint.com/reference/customers/v1-customer-tag-index.md): `GET /v1/api/store/{team_slug}/customer/{hash_id}/tag`
- [List the users assigned to a customer](https://developer.yoprint.com/reference/customers/v1-customer-assign-index.md): `GET /v1/api/store/{team_slug}/customer/{id}/assign`
- [Search customers with filters](https://developer.yoprint.com/reference/customers/v1-customer-filter.md): `POST /v1/api/store/{team_slug}/customer/filter`
- [Get a customer](https://developer.yoprint.com/reference/customers/v1-customer-show.md): `GET /v1/api/store/{team_slug}/customer/{hash_id}`
- [Get a customer's order counts and recent activity](https://developer.yoprint.com/reference/customers/v1-customer-activity-summary.md): `GET /v1/api/store/{team_slug}/customer/{hash_id}/activity_summary`
- [Get the QuickBooks customer linked to a customer](https://developer.yoprint.com/reference/customers/v1-customer-external-id-get.md): `GET /v1/api/store/{team_slug}/customer/{hash_id}/external_id/{id}`
- [Update a customer](https://developer.yoprint.com/reference/customers/v1-customer-update-put.md): `PUT /v1/api/store/{team_slug}/customer/{hash_id}`
- [Update a customer (PATCH)](https://developer.yoprint.com/reference/customers/v1-customer-update-patch.md): `PATCH /v1/api/store/{team_slug}/customer/{hash_id}`
- [Set a custom Customer Portal ID](https://developer.yoprint.com/reference/customers/v1-customer-customer-portal-token-override-update.md): `PATCH /v1/api/store/{team_slug}/customer/{hash_id}/customer_portal_token_override`
- [Link a customer to a QuickBooks customer](https://developer.yoprint.com/reference/customers/v1-customer-external-id-update.md): `PUT /v1/api/store/{team_slug}/customer/{hash_id}/external_id/{id}`
- [Recalculate a customer's totals](https://developer.yoprint.com/reference/customers/v1-customer-recount.md): `PATCH /v1/api/store/{team_slug}/customer/{hash_id}/recount`
- [Tag a customer](https://developer.yoprint.com/reference/customers/v1-customer-tag-attach.md): `PUT /v1/api/store/{team_slug}/customer/{hash_id}/tag/attach`
- [Assign or unassign a user on a customer](https://developer.yoprint.com/reference/customers/v1-customer-assign-update.md): `PUT /v1/api/store/{team_slug}/customer/{id}/assign`
- [Delete a customer](https://developer.yoprint.com/reference/customers/v1-customer-destroy.md): `DELETE /v1/api/store/{team_slug}/customer/{hash_id}`
- [Remove a custom Customer Portal ID](https://developer.yoprint.com/reference/customers/v1-customer-customer-portal-token-override-delete.md): `DELETE /v1/api/store/{team_slug}/customer/{hash_id}/customer_portal_token_override`
- [Unlink a customer from QuickBooks](https://developer.yoprint.com/reference/customers/v1-customer-external-id-delete.md): `DELETE /v1/api/store/{team_slug}/customer/{hash_id}/external_id/{id}`
- [Remove a tag from a customer](https://developer.yoprint.com/reference/customers/v1-customer-tag-detach.md): `PUT /v1/api/store/{team_slug}/customer/{hash_id}/tag/detach`
- [Remove every tag from a customer](https://developer.yoprint.com/reference/customers/v1-customer-tag-detach-all.md): `PATCH /v1/api/store/{team_slug}/customer/{hash_id}/tag/detach_all`
- [Restore a deleted customer](https://developer.yoprint.com/reference/customers/v1-customer-restore.md): `PATCH /v1/api/store/{team_slug}/customer/{hash_id}/restore`
- [Get a customer portal sign-in token](https://developer.yoprint.com/reference/customers/v1-customer-token-exchange.md): `PATCH /v1/api/store/{team_slug}/customer/{hash_id}/token_exchange` (internal: built for YoPrint's own apps, don't build on it)

### [Customer contacts](https://developer.yoprint.com/reference/customer-contacts.md)

The people at a customer.

- [Add a contact to a customer](https://developer.yoprint.com/reference/customer-contacts/v1-customer-contact-store.md): `POST /v1/api/store/{team_slug}/customer/{hash_id}/contact`
- [Create or update a customer contact by email or phone](https://developer.yoprint.com/reference/customer-contacts/v1-customer-contact-upsert.md): `POST /v1/api/store/{team_slug}/customer/{hash_id}/contact/upsert`
- [List a customer's contacts](https://developer.yoprint.com/reference/customer-contacts/v1-customer-contact-index.md): `GET /v1/api/store/{team_slug}/customer/{hash_id}/contact`
- [Get a customer contact](https://developer.yoprint.com/reference/customer-contacts/v1-customer-contact-show.md): `GET /v1/api/store/{team_slug}/customer/{hash_id}/contact/{id}`
- [Update a customer contact](https://developer.yoprint.com/reference/customer-contacts/v1-customer-contact-update-put.md): `PUT /v1/api/store/{team_slug}/customer/{hash_id}/contact/{id}`
- [Update a customer contact (PATCH)](https://developer.yoprint.com/reference/customer-contacts/v1-customer-contact-update-patch.md): `PATCH /v1/api/store/{team_slug}/customer/{hash_id}/contact/{id}`
- [Set the primary contact](https://developer.yoprint.com/reference/customer-contacts/v1-customer-contact-primary.md): `PATCH /v1/api/store/{team_slug}/customer/{hash_id}/contact/{id}/primary`
- [Delete a customer contact](https://developer.yoprint.com/reference/customer-contacts/v1-customer-contact-destroy.md): `DELETE /v1/api/store/{team_slug}/customer/{hash_id}/contact/{id}`
- [Restore a deleted customer contact](https://developer.yoprint.com/reference/customer-contacts/v1-customer-contact-restore.md): `PATCH /v1/api/store/{team_slug}/customer/{hash_id}/contact/{id}/restore`

### [Customer addresses](https://developer.yoprint.com/reference/customer-addresses.md)

A customer's billing and shipping addresses.

- [Add an address to a customer](https://developer.yoprint.com/reference/customer-addresses/v1-customer-address-store.md): `POST /v1/api/store/{team_slug}/customer/{hash_id}/address`
- [List a customer's addresses](https://developer.yoprint.com/reference/customer-addresses/v1-customer-address-index.md): `GET /v1/api/store/{team_slug}/customer/{hash_id}/address`
- [Get a customer address](https://developer.yoprint.com/reference/customer-addresses/v1-customer-address-show.md): `GET /v1/api/store/{team_slug}/customer/{hash_id}/address/{id}`
- [Update a customer address](https://developer.yoprint.com/reference/customer-addresses/v1-customer-address-update.md): `PUT /v1/api/store/{team_slug}/customer/{hash_id}/address/{id}`
- [Set the primary address](https://developer.yoprint.com/reference/customer-addresses/v1-customer-address-primary.md): `PATCH /v1/api/store/{team_slug}/customer/{hash_id}/address/{id}/primary`
- [Delete a customer address](https://developer.yoprint.com/reference/customer-addresses/v1-customer-address-destroy.md): `DELETE /v1/api/store/{team_slug}/customer/{hash_id}/address/{id}`
- [Restore a deleted customer address](https://developer.yoprint.com/reference/customer-addresses/v1-customer-address-restore.md): `PATCH /v1/api/store/{team_slug}/customer/{hash_id}/address/{id}/restore`

### [Customer brand profiles](https://developer.yoprint.com/reference/customer-brand-profiles.md)

Brand Profiles: the company name, logo, contact details and Ship From address printed on a customer's documents and used on its shipments.

- [Create a brand profile](https://developer.yoprint.com/reference/customer-brand-profiles/v1-customer-profile-store.md): `POST /v1/api/store/{team_slug}/customer/{hash_id}/profile`
- [List a customer's brand profiles](https://developer.yoprint.com/reference/customer-brand-profiles/v1-customer-profile-index.md): `GET /v1/api/store/{team_slug}/customer/{hash_id}/profile`
- [Get a brand profile](https://developer.yoprint.com/reference/customer-brand-profiles/v1-customer-profile-show.md): `GET /v1/api/store/{team_slug}/customer/{hash_id}/profile/{id}`
- [Update a brand profile](https://developer.yoprint.com/reference/customer-brand-profiles/v1-customer-profile-update-put.md): `PUT /v1/api/store/{team_slug}/customer/{hash_id}/profile/{id}`
- [Update a brand profile (same as PUT)](https://developer.yoprint.com/reference/customer-brand-profiles/v1-customer-profile-update-patch.md): `PATCH /v1/api/store/{team_slug}/customer/{hash_id}/profile/{id}`
- [Set the primary brand profile](https://developer.yoprint.com/reference/customer-brand-profiles/v1-customer-profile-primary.md): `PATCH /v1/api/store/{team_slug}/customer/{hash_id}/profile/{id}/primary`
- [Delete a brand profile](https://developer.yoprint.com/reference/customer-brand-profiles/v1-customer-profile-destroy.md): `DELETE /v1/api/store/{team_slug}/customer/{hash_id}/profile/{id}`

### [Customer credit](https://developer.yoprint.com/reference/customer-credit.md)

Customer credit: money held for a customer, added or taken out by hand and used to pay their sales orders.

- [Add or take out customer credit](https://developer.yoprint.com/reference/customer-credit/v1-customer-credit-store.md): `POST /v1/api/store/{team_slug}/customer/{hash_id}/credit`
- [List a customer's credit history](https://developer.yoprint.com/reference/customer-credit/v1-customer-credit-index.md): `GET /v1/api/store/{team_slug}/customer/{hash_id}/credit`
- [Get a customer credit entry](https://developer.yoprint.com/reference/customer-credit/v1-customer-credit-show.md): `GET /v1/api/store/{team_slug}/customer/{hash_id}/credit/{id}`

### [Customer files](https://developer.yoprint.com/reference/customer-files.md)

Files kept on a customer: tax exemption certificates, internal files and files the customer can see.

- [List a customer's files](https://developer.yoprint.com/reference/customer-files/v1-customer-media-index.md): `GET /v1/api/store/{team_slug}/customer/{hash_id}/media`
- [List a customer's files in one collection](https://developer.yoprint.com/reference/customer-files/v1-customer-media-get-media-by-collection.md): `GET /v1/api/store/{team_slug}/customer/{hash_id}/media/collection/{collection}`
- [Get a customer file](https://developer.yoprint.com/reference/customer-files/v1-customer-media-show.md): `GET /v1/api/store/{team_slug}/customer/{hash_id}/media/{id}`
- [Attach uploaded files to a customer](https://developer.yoprint.com/reference/customer-files/v1-customer-upload-multiple-files.md): `POST /v1/api/store/{team_slug}/customer/{hash_id}/media/attach`
- [Delete a customer file](https://developer.yoprint.com/reference/customer-files/v1-customer-media-destroy.md): `DELETE /v1/api/store/{team_slug}/customer/{hash_id}/media/{id}`

### [Contacts](https://developer.yoprint.com/reference/contacts.md)

Any contact by its id, whether it belongs to a customer or a vendor.

- [Get a contact by id](https://developer.yoprint.com/reference/contacts/v1-contact-show.md): `GET /v1/api/store/{team_slug}/contact/{id}`
- [Update a contact by id](https://developer.yoprint.com/reference/contacts/v1-contact-update-put.md): `PUT /v1/api/store/{team_slug}/contact/{id}`
- [Update a contact by id (PATCH)](https://developer.yoprint.com/reference/contacts/v1-contact-update-patch.md): `PATCH /v1/api/store/{team_slug}/contact/{id}`
- [Delete a contact by id](https://developer.yoprint.com/reference/contacts/v1-contact-destroy.md): `DELETE /v1/api/store/{team_slug}/contact/{id}`

## Products and catalog

### [Products](https://developer.yoprint.com/reference/products.md)

Your own products.

- [Create a product](https://developer.yoprint.com/reference/products/v1-products-store.md): `POST /v1/api/store/{team_slug}/product`
- [List all product brands](https://developer.yoprint.com/reference/products/v1-product-brands-index.md): `GET /v1/api/store/{team_slug}/get_all_product_brands`
- [List all size names](https://developer.yoprint.com/reference/products/v1-product-sizes-index.md): `GET /v1/api/store/{team_slug}/get_all_product_sizes`
- [List products](https://developer.yoprint.com/reference/products/v1-products-index.md): `GET /v1/api/store/{team_slug}/product`
- [Get a product](https://developer.yoprint.com/reference/products/v1-products-show.md): `GET /v1/api/store/{team_slug}/product/{hash_id}`
- [Check whether a product can be deleted](https://developer.yoprint.com/reference/products/v1-product-delete-check.md): `POST /v1/api/store/{team_slug}/product/{hash_id}/delete_check`
- [Load a product for a sales order line](https://developer.yoprint.com/reference/products/v1-hydrate-imported-product.md): `POST /v1/api/store/{team_slug}/hydrate_product`
- [Update a product](https://developer.yoprint.com/reference/products/v1-products-update-put.md): `PUT /v1/api/store/{team_slug}/product/{hash_id}`
- [Update a product (PATCH)](https://developer.yoprint.com/reference/products/v1-products-update-patch.md): `PATCH /v1/api/store/{team_slug}/product/{hash_id}`
- [Phase out a simple product](https://developer.yoprint.com/reference/products/v1-product-phase-out.md): `POST /v1/api/store/{team_slug}/product/{hash_id}/phase_out`
- [Put a phased-out simple product back on sale](https://developer.yoprint.com/reference/products/v1-product-resume.md): `POST /v1/api/store/{team_slug}/product/{hash_id}/resume`
- [Delete a product](https://developer.yoprint.com/reference/products/v1-products-destroy.md): `DELETE /v1/api/store/{team_slug}/product/{hash_id}`
- [Restore a deleted product](https://developer.yoprint.com/reference/products/v1-product-restore.md): `PATCH /v1/api/store/{team_slug}/product/{hash_id}/restore`

### [Product variants](https://developer.yoprint.com/reference/product-variants.md)

The size and color combinations of a variant product.

- [Add a variant to a product](https://developer.yoprint.com/reference/product-variants/v1-product-variant-store.md): `POST /v1/api/store/{team_slug}/product/{hash_id}/variant`
- [List a product's variants](https://developer.yoprint.com/reference/product-variants/v1-product-variant-index.md): `GET /v1/api/store/{team_slug}/product/{hash_id}/variant`
- [Get a variant](https://developer.yoprint.com/reference/product-variants/v1-product-variant-show.md): `GET /v1/api/store/{team_slug}/product/{hash_id}/variant/{id}`
- [Check whether variants can be deleted](https://developer.yoprint.com/reference/product-variants/v1-product-variant-delete-check.md): `POST /v1/api/store/{team_slug}/product/{hash_id}/variant/delete_check`
- [Update a variant](https://developer.yoprint.com/reference/product-variants/v1-product-variant-update.md): `PUT /v1/api/store/{team_slug}/product/{hash_id}/variant/{id}`
- [Phase out variants (stop selling them)](https://developer.yoprint.com/reference/product-variants/v1-product-variant-phase-out.md): `POST /v1/api/store/{team_slug}/product/{hash_id}/variant/phase_out`
- [Rename sizes and colors of a product](https://developer.yoprint.com/reference/product-variants/v1-product-variant-rename-options.md): `POST /v1/api/store/{team_slug}/product/{hash_id}/variant/rename_options`
- [Put phased-out variants back on sale](https://developer.yoprint.com/reference/product-variants/v1-product-variant-resume.md): `POST /v1/api/store/{team_slug}/product/{hash_id}/variant/resume`
- [Delete a variant](https://developer.yoprint.com/reference/product-variants/v1-product-variant-destroy.md): `DELETE /v1/api/store/{team_slug}/product/{hash_id}/variant/{id}`

### [Product stock](https://developer.yoprint.com/reference/product-stock.md)

Your own stock levels for products, read-only.

- [Get stock levels for products](https://developer.yoprint.com/reference/product-stock/v1-misc-product-stock.md): `POST /v1/api/store/{team_slug}/product_stock`

### [Supplier catalog](https://developer.yoprint.com/reference/supplier-catalog.md)

Live prices, stock and images from your connected suppliers (S&S Activewear, SanMar, Momentec, AS Colour), for catalog products you sell on sales orders.

- [Get supplier images for catalog products](https://developer.yoprint.com/reference/supplier-catalog/v1-real-time-data-fetcher-images.md): `POST /v1/api/store/{team_slug}/real_time_data_fetcher/images`
- [Get live supplier inventory for catalog products](https://developer.yoprint.com/reference/supplier-catalog/v1-real-time-data-fetcher-inventory.md): `POST /v1/api/store/{team_slug}/real_time_data_fetcher/inventory`
- [Get live supplier pricing for catalog products](https://developer.yoprint.com/reference/supplier-catalog/v1-real-time-data-fetcher-pricing.md): `POST /v1/api/store/{team_slug}/real_time_data_fetcher/pricing`
- [Get live supplier pricing and inventory together](https://developer.yoprint.com/reference/supplier-catalog/v1-real-time-data-fetcher-pricing-with-inventory.md): `POST /v1/api/store/{team_slug}/real_time_data_fetcher/pricing_with_inventory`

### [Tags](https://developer.yoprint.com/reference/tags.md)

Colored labels you put on customers and sales orders.

- [Create a tag](https://developer.yoprint.com/reference/tags/v1-tag-store.md): `POST /v1/api/store/{team_slug}/tag`
- [List tags](https://developer.yoprint.com/reference/tags/v1-tag-index.md): `GET /v1/api/store/{team_slug}/tag`
- [Get tags by id](https://developer.yoprint.com/reference/tags/v1-tag-get-by-id.md): `POST /v1/api/store/{team_slug}/tag/get_by_id`
- [Update a tag](https://developer.yoprint.com/reference/tags/v1-tag-update-put.md): `PUT /v1/api/store/{team_slug}/tag/{id}`
- [Update a tag (PATCH)](https://developer.yoprint.com/reference/tags/v1-tag-update-patch.md): `PATCH /v1/api/store/{team_slug}/tag/{id}`
- [Delete a tag](https://developer.yoprint.com/reference/tags/v1-tag-destroy.md): `DELETE /v1/api/store/{team_slug}/tag/{id}`

## Purchasing

### [Purchase orders](https://developer.yoprint.com/reference/purchase-orders.md)

Read one purchase order and change its status (two operations kept for the Zapier app), its history, the CSV export and the QuickBooks sync switch.

- [List a purchase order's history](https://developer.yoprint.com/reference/purchase-orders/v1-purchase-order-history.md): `GET /v1/api/store/{team_slug}/purchase_order/{hash_id}/history`
- [Get a purchase order](https://developer.yoprint.com/reference/purchase-orders/v1-purchase-order-show.md): `GET /v1/api/store/{team_slug}/purchase_order/{hash_id}`
- [Change a purchase order's status](https://developer.yoprint.com/reference/purchase-orders/v1-purchase-order-change-status.md): `PUT /v1/api/store/{team_slug}/purchase_order/{hash_id}/status`
- [Turn QuickBooks sync on or off for purchase orders](https://developer.yoprint.com/reference/purchase-orders/v1-purchase-order-bulk-action-mark-quickbook.md): `PUT /v1/api/store/{team_slug}/purchase_order/bulk_action/mark_quickbook/{on_or_off}`
- [Export purchase orders by issue date](https://developer.yoprint.com/reference/purchase-orders/v1-purchase-order-export.md): `POST /v1/api/store/{team_slug}/purchase_order/export`

### [Vendors](https://developer.yoprint.com/reference/vendors.md)

The suppliers you buy from.

- [Create a vendor](https://developer.yoprint.com/reference/vendors/v1-vendor-store.md): `POST /v1/api/store/{team_slug}/vendor`
- [List vendors](https://developer.yoprint.com/reference/vendors/v1-vendor-index.md): `GET /v1/api/store/{team_slug}/vendor`
- [Get a vendor](https://developer.yoprint.com/reference/vendors/v1-vendor-show.md): `GET /v1/api/store/{team_slug}/vendor/{hash_id}`
- [Get the QuickBooks vendor linked to a vendor](https://developer.yoprint.com/reference/vendors/v1-vendor-external-id-get.md): `GET /v1/api/store/{team_slug}/vendor/{hash_id}/external_id/{id}`
- [Update a vendor](https://developer.yoprint.com/reference/vendors/v1-vendor-update-put.md): `PUT /v1/api/store/{team_slug}/vendor/{hash_id}`
- [Update a vendor (PATCH)](https://developer.yoprint.com/reference/vendors/v1-vendor-update-patch.md): `PATCH /v1/api/store/{team_slug}/vendor/{hash_id}`
- [Link a vendor to a QuickBooks vendor](https://developer.yoprint.com/reference/vendors/v1-vendor-external-id-update.md): `PUT /v1/api/store/{team_slug}/vendor/{hash_id}/external_id/{id}`
- [Delete a vendor](https://developer.yoprint.com/reference/vendors/v1-vendor-destroy.md): `DELETE /v1/api/store/{team_slug}/vendor/{hash_id}`
- [Unlink a vendor from QuickBooks](https://developer.yoprint.com/reference/vendors/v1-vendor-external-id-delete.md): `DELETE /v1/api/store/{team_slug}/vendor/{hash_id}/external_id/{id}`
- [Restore a deleted vendor](https://developer.yoprint.com/reference/vendors/v1-vendor-restore.md): `PATCH /v1/api/store/{team_slug}/vendor/{hash_id}/restore`

### [Vendor contacts](https://developer.yoprint.com/reference/vendor-contacts.md)

The people at a vendor.

- [Add a contact to a vendor](https://developer.yoprint.com/reference/vendor-contacts/v1-vendor-contact-store.md): `POST /v1/api/store/{team_slug}/vendor/{hash_id}/contact`
- [List a vendor's contacts](https://developer.yoprint.com/reference/vendor-contacts/v1-vendor-contact-index.md): `GET /v1/api/store/{team_slug}/vendor/{hash_id}/contact`
- [Get a vendor contact](https://developer.yoprint.com/reference/vendor-contacts/v1-vendor-contact-show.md): `GET /v1/api/store/{team_slug}/vendor/{hash_id}/contact/{id}`
- [Update a vendor contact](https://developer.yoprint.com/reference/vendor-contacts/v1-vendor-contact-update-put.md): `PUT /v1/api/store/{team_slug}/vendor/{hash_id}/contact/{id}`
- [Update a vendor contact (PATCH)](https://developer.yoprint.com/reference/vendor-contacts/v1-vendor-contact-update-patch.md): `PATCH /v1/api/store/{team_slug}/vendor/{hash_id}/contact/{id}`
- [Set a vendor's primary contact](https://developer.yoprint.com/reference/vendor-contacts/v1-vendor-contact-primary.md): `PATCH /v1/api/store/{team_slug}/vendor/{hash_id}/contact/{id}/primary`
- [Delete a vendor contact](https://developer.yoprint.com/reference/vendor-contacts/v1-vendor-contact-destroy.md): `DELETE /v1/api/store/{team_slug}/vendor/{hash_id}/contact/{id}`
- [Restore a deleted vendor contact](https://developer.yoprint.com/reference/vendor-contacts/v1-vendor-contact-restore.md): `PATCH /v1/api/store/{team_slug}/vendor/{hash_id}/contact/{id}/restore`

### [Vendor files](https://developer.yoprint.com/reference/vendor-files.md)

Files kept on a vendor, such as price lists.

- [Upload a file to a vendor](https://developer.yoprint.com/reference/vendor-files/v1-vendor-media-store.md): `POST /v1/api/store/{team_slug}/vendor/{hash_id}/media`
- [List a vendor's files](https://developer.yoprint.com/reference/vendor-files/v1-vendor-media-index.md): `GET /v1/api/store/{team_slug}/vendor/{hash_id}/media`
- [Get a vendor file](https://developer.yoprint.com/reference/vendor-files/v1-vendor-media-show.md): `GET /v1/api/store/{team_slug}/vendor/{hash_id}/media/{media_reference}`
- [Rename, reorder or delete vendor files](https://developer.yoprint.com/reference/vendor-files/v1-vendor-media-sync.md): `POST /v1/api/store/{team_slug}/vendor/{hash_id}/media/{media_reference}`
- [Delete a vendor file](https://developer.yoprint.com/reference/vendor-files/v1-vendor-media-destroy.md): `DELETE /v1/api/store/{team_slug}/vendor/{hash_id}/media/{media_reference}`

## Production

### [Jobs](https://developer.yoprint.com/reference/jobs.md)

A job groups line items on a sales order or quote that are produced together, with their services (decorations), mockups, production files, tasks, dates and a status.

- [Add a job to a sales order or quote](https://developer.yoprint.com/reference/jobs/v2-job-store.md): `POST /v2/api/store/{team_slug}/v2/sales_order/{hash_id}/job`
- [Add a job from a job template](https://developer.yoprint.com/reference/jobs/v2-job-create-with-template.md): `POST /v2/api/store/{team_slug}/v2/sales_order/{hash_id}/job_template`
- [List the jobs of a sales order or quote](https://developer.yoprint.com/reference/jobs/v2-job-index-for-order.md): `GET /v2/api/store/{team_slug}/v2/sales_order/{hash_id}/job`
- [List jobs](https://developer.yoprint.com/reference/jobs/v1-job-index.md): `GET /v1/api/store/{team_slug}/job`
- [List jobs in a date range](https://developer.yoprint.com/reference/jobs/v1-job-calendar.md): `POST /v1/api/store/{team_slug}/job/calendar`
- [Filter jobs](https://developer.yoprint.com/reference/jobs/v1-job-filter.md): `POST /v1/api/store/{team_slug}/job/filter`
- [Get one job of an order](https://developer.yoprint.com/reference/jobs/v2-job-show.md): `GET /v2/api/store/{team_slug}/v2/sales_order/{hash_id}/job/{job_id}`
- [Update a job](https://developer.yoprint.com/reference/jobs/v2-job-update.md): `PUT /v2/api/store/{team_slug}/v2/job/{hash_id}`
- [Copy a job](https://developer.yoprint.com/reference/jobs/v2-job-clone.md): `PUT /v2/api/store/{team_slug}/v2/job/{hash_id}/clone`
- [Change a job number](https://developer.yoprint.com/reference/jobs/v2-job-update-scoped-id.md): `PUT /v2/api/store/{team_slug}/v2/job/{hash_id}/scoped_id`
- [Change a job's status](https://developer.yoprint.com/reference/jobs/v2-job-change-status.md): `PUT /v2/api/store/{team_slug}/v2/job/{hash_id}/status`
- [Schedule a job](https://developer.yoprint.com/reference/jobs/v2-job-update-prod-date.md): `PUT /v2/api/store/{team_slug}/v2/job/{hash_id}/update_prod_date`
- [Reorder the jobs of a sales order or quote](https://developer.yoprint.com/reference/jobs/v2-job-rearrange.md): `PUT /v2/api/store/{team_slug}/v2/sales_order/{hash_id}/job/rearrange`
- [Attach uploaded files to a job](https://developer.yoprint.com/reference/jobs/v1-sales-order-job-attach.md): `PUT /v1/api/store/{team_slug}/sales_order/{hash_id}/job/{id}/attach`
- [Reorder the files of a job](https://developer.yoprint.com/reference/jobs/v1-sales-order-job-rearrange.md): `PUT /v1/api/store/{team_slug}/sales_order/{hash_id}/job/{id}/rearrange`
- [Delete a job](https://developer.yoprint.com/reference/jobs/v2-job-destroy.md): `DELETE /v2/api/store/{team_slug}/v2/job/{hash_id}`
- [Download small job labels (PDF)](https://developer.yoprint.com/reference/jobs/v1-job-export-dymo-label.md): `POST /v1/api/store/{team_slug}/job/export_dymo_label`
- [Download job details (PDF)](https://developer.yoprint.com/reference/jobs/v1-job-export-job-detail.md): `POST /v1/api/store/{team_slug}/job/export_job_detail`
- [Download job details with mockups (PDF)](https://developer.yoprint.com/reference/jobs/v1-job-export-job-detail-mockup.md): `POST /v1/api/store/{team_slug}/job/export_job_detail_mockup`
- [Download job labels (PDF)](https://developer.yoprint.com/reference/jobs/v1-job-export-job-label.md): `POST /v1/api/store/{team_slug}/job/export_job_label`
- [Download a job list (PDF)](https://developer.yoprint.com/reference/jobs/v1-job-export-job-list.md): `POST /v1/api/store/{team_slug}/job/export_job_list`
- [Get a job (retired)](https://developer.yoprint.com/reference/jobs/v1-job-show.md): `GET /v1/api/store/{team_slug}/job/{hash_id}` (legacy, deprecated)
- [Change a job's status (retired)](https://developer.yoprint.com/reference/jobs/v1-job-change-status.md): `PUT /v1/api/store/{team_slug}/job/{hash_id}/status` (legacy, deprecated)

### [Tasks](https://developer.yoprint.com/reference/tasks.md)

Tasks are the production steps of a job (the work pipeline).

- [Add a task to a job](https://developer.yoprint.com/reference/tasks/v2-job-work-pipeline-store.md): `POST /v2/api/store/{team_slug}/v2/job/{hash_id}/work_pipeline`
- [List the tasks of a job](https://developer.yoprint.com/reference/tasks/v2-job-work-pipeline-index-for-job.md): `GET /v2/api/store/{team_slug}/v2/job/{hash_id}/work_pipeline`
- [List tasks in a date range](https://developer.yoprint.com/reference/tasks/v1-work-pipeline-calendar.md): `POST /v1/api/store/{team_slug}/work_pipeline/calendar`
- [Filter tasks](https://developer.yoprint.com/reference/tasks/v1-work-pipeline-filter.md): `POST /v1/api/store/{team_slug}/work_pipeline/filter`
- [Get a task](https://developer.yoprint.com/reference/tasks/v2-job-work-pipeline-show.md): `GET /v2/api/store/{team_slug}/v2/work_pipeline/{hash_id}`
- [Update a task](https://developer.yoprint.com/reference/tasks/v2-job-work-pipeline-update.md): `PUT /v2/api/store/{team_slug}/v2/work_pipeline/{hash_id}`
- [Assign or unassign a person on a task](https://developer.yoprint.com/reference/tasks/v2-job-work-pipeline-assign.md): `PUT /v2/api/store/{team_slug}/v2/work_pipeline/{hash_id}/assign`
- [Change a task's status](https://developer.yoprint.com/reference/tasks/v2-job-work-pipeline-change-status.md): `PUT /v2/api/store/{team_slug}/v2/work_pipeline/{hash_id}/status`
- [Reorder tasks](https://developer.yoprint.com/reference/tasks/v1-work-pipeline-bulk-update-position.md): `POST /v1/api/store/{team_slug}/work_pipeline/bulk_update_position`
- [Delete a task](https://developer.yoprint.com/reference/tasks/v2-job-work-pipeline-destroy.md): `DELETE /v2/api/store/{team_slug}/v2/work_pipeline/{hash_id}`

### [Barcodes](https://developer.yoprint.com/reference/barcodes.md)

Turn a barcode or QR code printed by YoPrint into the record it points to.

- [Decode a YoPrint barcode](https://developer.yoprint.com/reference/barcodes/v1-misc-decode-barcode.md): `POST /v1/api/store/{team_slug}/decode_barcode`

### [Production control](https://developer.yoprint.com/reference/production-control.md)

The Production Control calendar: orders with their jobs and tasks over a date range.

- [Read the production control calendar](https://developer.yoprint.com/reference/production-control/v1-production-control-filter.md): `POST /v1/api/store/{team_slug}/production_control/filter`

## Shipping

### [Shipments](https://developer.yoprint.com/reference/shipments.md)

Shipments send some or all of an order's lines to one address by one shipping type, with packages, labels and documents.

- [Create a shipment for a sales order](https://developer.yoprint.com/reference/shipments/v2-sales-order-shipment-create.md): `POST /v2/api/store/{team_slug}/v2/sales_order/{unique_key}/shipment`
- [List the shipments of a sales order](https://developer.yoprint.com/reference/shipments/v2-sales-order-shipment-index-for-order.md): `GET /v2/api/store/{team_slug}/v2/sales_order/{unique_key}/shipment`
- [Filter shipments](https://developer.yoprint.com/reference/shipments/v1-shipment-filter.md): `POST /v1/api/store/{team_slug}/shipment/filter`
- [Check a shipment's address with the carrier](https://developer.yoprint.com/reference/shipments/v2-sales-order-shipment-validate-address.md): `PATCH /v2/api/store/{team_slug}/v2/sales_order/{hash_id}/shipment/{id}/validate_address`
- [Get a shipment](https://developer.yoprint.com/reference/shipments/v2-shipment-show.md): `GET /v2/api/store/{team_slug}/v2/shipment/{unique_key}`
- [Assign or unassign a team member on a shipment](https://developer.yoprint.com/reference/shipments/v2-sales-order-shipment-assign.md): `PUT /v2/api/store/{team_slug}/v2/sales_order/{hash_id}/shipment/{id}/assign`
- [Change the status of a shipment](https://developer.yoprint.com/reference/shipments/v2-sales-order-shipment-change-status.md): `PUT /v2/api/store/{team_slug}/v2/sales_order/{hash_id}/shipment/{id}/status`
- [Update a shipment](https://developer.yoprint.com/reference/shipments/v2-shipment-update.md): `PUT /v2/api/store/{team_slug}/v2/shipment/{unique_key}`
- [Delete a shipment](https://developer.yoprint.com/reference/shipments/v2-shipment-destroy.md): `DELETE /v2/api/store/{team_slug}/v2/shipment/{unique_key}`
- [Download shipments as CSV](https://developer.yoprint.com/reference/shipments/v1-shipment-export-csv.md): `POST /v1/api/store/{team_slug}/shipment/action/export_csv`
- [Download 4x6 shipment labels (PDF)](https://developer.yoprint.com/reference/shipments/v1-shipment-export-label.md): `POST /v1/api/store/{team_slug}/shipment/export_label`
- [Download letter-size shipment labels (PDF)](https://developer.yoprint.com/reference/shipments/v1-shipment-export-label-full.md): `POST /v1/api/store/{team_slug}/shipment/export_label_full`
- [Download packing slips (PDF)](https://developer.yoprint.com/reference/shipments/v1-shipment-export-packing-slip.md): `POST /v1/api/store/{team_slug}/shipment/export_packing_slip`
- [Delete all shipments of an order (retired)](https://developer.yoprint.com/reference/shipments/v2-sales-order-shipment-destroy-all.md): `PATCH /v2/api/store/{team_slug}/v2/sales_order/{hash_id}/shipment/delete_all` (legacy, deprecated)

### [Shipment line items](https://developer.yoprint.com/reference/shipment-line-items.md)

The lines of a shipment: quantities of order lines, and shipping cost lines.

- [Add a line to a shipment](https://developer.yoprint.com/reference/shipment-line-items/v2-shipment-item-create.md): `POST /v2/api/store/{team_slug}/v2/shipment/{unique_key}/item`
- [Add, change and remove shipment lines at once](https://developer.yoprint.com/reference/shipment-line-items/v2-shipment-item-bulk.md): `POST /v2/api/store/{team_slug}/v2/shipment/{unique_key}/item/bulk`
- [List the lines of a shipment](https://developer.yoprint.com/reference/shipment-line-items/v2-shipment-item-index.md): `GET /v2/api/store/{team_slug}/v2/shipment/{unique_key}/item`
- [Get a shipment line](https://developer.yoprint.com/reference/shipment-line-items/v2-shipment-item-show.md): `GET /v2/api/store/{team_slug}/v2/shipment/item/{unique_key}`
- [Fix up shipment line positions](https://developer.yoprint.com/reference/shipment-line-items/v2-shipment-item-sort.md): `POST /v2/api/store/{team_slug}/v2/shipment/{unique_key}/item/sort`
- [Update a shipment line](https://developer.yoprint.com/reference/shipment-line-items/v2-shipment-item-update.md): `PUT /v2/api/store/{team_slug}/v2/shipment/item/{unique_key}`
- [Remove a line from a shipment](https://developer.yoprint.com/reference/shipment-line-items/v2-shipment-item-destroy.md): `DELETE /v2/api/store/{team_slug}/v2/shipment/item/{unique_key}`

### [Shipment packages](https://developer.yoprint.com/reference/shipment-packages.md)

The packages of a shipment: one per parcel of a label (a multi-parcel label makes several), with carrier, tracking number, size, weight, cost and status.

- [List the packages of a shipment](https://developer.yoprint.com/reference/shipment-packages/v2-shipment-package-index.md): `GET /v2/api/store/{team_slug}/v2/shipment/{hash_id}/packages`
- [Filter packages](https://developer.yoprint.com/reference/shipment-packages/v1-shipment-package-filter.md): `POST /v1/api/store/{team_slug}/shipment_package/filter`
- [Get a package](https://developer.yoprint.com/reference/shipment-packages/v2-shipment-package-show.md): `GET /v2/api/store/{team_slug}/v2/shipment_package/{hash_id}`
- [Get live tracking for a package](https://developer.yoprint.com/reference/shipment-packages/v1-shipment-package-track.md): `PATCH /v1/api/store/{team_slug}/shipment_package/{id}/track`
- [Change a package's status](https://developer.yoprint.com/reference/shipment-packages/v2-shipment-package-update.md): `PUT /v2/api/store/{team_slug}/v2/shipment_package/{hash_id}`
- [Change and delete packages at once](https://developer.yoprint.com/reference/shipment-packages/v2-shipment-package-bulk.md): `POST /v2/api/store/{team_slug}/v2/shipment/{unique_key}/package/bulk`
- [Delete a package (voids its label)](https://developer.yoprint.com/reference/shipment-packages/v2-shipment-package-destroy.md): `DELETE /v2/api/store/{team_slug}/v2/shipment_package/{hash_id}`

### [Shipping labels](https://developer.yoprint.com/reference/shipping-labels.md)

Buying Shippo labels (this spends real money), recording labels bought elsewhere, and printing labels.

- [Record a label bought elsewhere](https://developer.yoprint.com/reference/shipping-labels/v2-shipment-label-create-external.md): `POST /v2/api/store/{team_slug}/v2/shipment/{hash_id}/label/external`
- [Buy a shipping label (charges your Shippo account)](https://developer.yoprint.com/reference/shipping-labels/v2-shipment-label-create-goshippo.md): `POST /v2/api/store/{team_slug}/v2/shipment/{hash_id}/label/goshippo` (spends money)
- [Download labels as one PDF](https://developer.yoprint.com/reference/shipping-labels/v2-shipment-label-compile-goshippo.md): `POST /v2/api/store/{team_slug}/v2/shipment_package/labels/compile`

### [Shipping rates and estimates](https://developer.yoprint.com/reference/shipping-rates-and-estimates.md)

Shipping rates from your connected Shippo account, the carrier accounts behind them, and estimates (rate quotes saved on a shipment).

- [List Shippo carrier accounts](https://developer.yoprint.com/reference/shipping-rates-and-estimates/v2-shipment-carrier-goshippo.md): `POST /v2/api/store/{team_slug}/v2/carrier_account/goshippo`
- [List the shipping estimates of a shipment](https://developer.yoprint.com/reference/shipping-rates-and-estimates/v2-shipment-estimate-index.md): `GET /v2/api/store/{team_slug}/v2/shipment/{hash_id}/estimates`
- [Get a shipping estimate](https://developer.yoprint.com/reference/shipping-rates-and-estimates/v2-shipment-estimate-show.md): `GET /v2/api/store/{team_slug}/v2/shipment_estimate/{hash_id}`
- [Get shipping rates](https://developer.yoprint.com/reference/shipping-rates-and-estimates/v2-shipment-rate-goshippo.md): `POST /v2/api/store/{team_slug}/v2/shipment_rate/goshippo`
- [Save a shipping estimate](https://developer.yoprint.com/reference/shipping-rates-and-estimates/v2-shipment-estimate-create-goshippo.md): `POST /v2/api/store/{team_slug}/v2/shipment/{hash_id}/shipment_estimate/goshippo`
- [Delete a shipping estimate](https://developer.yoprint.com/reference/shipping-rates-and-estimates/v2-shipment-estimate-destroy.md): `DELETE /v2/api/store/{team_slug}/v2/shipment_estimate/{hash_id}`

## Invoices and payments

### [Invoices](https://developer.yoprint.com/reference/invoices.md)

Invoices bill some or all of a sales order or quote.

- [Create an invoice for a sales order](https://developer.yoprint.com/reference/invoices/v2-sales-order-invoice-create.md): `POST /v2/api/store/{team_slug}/v2/sales_order/{unique_key}/invoice`
- [Filter invoices](https://developer.yoprint.com/reference/invoices/v2-invoice-filter.md): `POST /v2/api/store/{team_slug}/v2/invoice/filter`
- [List the invoices of a sales order](https://developer.yoprint.com/reference/invoices/v2-sales-order-invoice-index-for-order.md): `GET /v2/api/store/{team_slug}/v2/sales_order/{unique_key}/invoice`
- [List invoice lines for export](https://developer.yoprint.com/reference/invoices/v1-sales-order-invoices-export-all-invoice-items.md): `POST /v1/api/store/{team_slug}/sales_order/invoices/export_all_sales_order_invoice_item`
- [List invoices for export](https://developer.yoprint.com/reference/invoices/v1-sales-order-invoices-export-list.md): `POST /v1/api/store/{team_slug}/sales_order/invoices/export_list`
- [Get an invoice](https://developer.yoprint.com/reference/invoices/v2-invoice-show.md): `GET /v2/api/store/{team_slug}/v2/invoice/{unique_key}`
- [Update an invoice](https://developer.yoprint.com/reference/invoices/v2-invoice-update.md): `PUT /v2/api/store/{team_slug}/v2/invoice/{unique_key}`
- [Change the tax on an invoice](https://developer.yoprint.com/reference/invoices/v2-invoice-tax-selection-update.md): `PUT /v2/api/store/{team_slug}/v2/invoice/{unique_key}/tax-selection`
- [Delete an invoice](https://developer.yoprint.com/reference/invoices/v2-invoice-destroy.md): `DELETE /v2/api/store/{team_slug}/v2/invoice/{unique_key}`
- [Download invoices as one PDF](https://developer.yoprint.com/reference/invoices/v1-invoice-export-pdf.md): `POST /v1/api/store/{team_slug}/invoice/export_pdf`
- [Export invoices as CSV](https://developer.yoprint.com/reference/invoices/v1-sales-order-invoices-export.md): `POST /v1/api/store/{team_slug}/sales_order/invoices/export`
- [List invoices (v1)](https://developer.yoprint.com/reference/invoices/v1-invoice-index.md): `GET /v1/api/store/{team_slug}/invoice` (legacy, deprecated)
- [Get an invoice (v1)](https://developer.yoprint.com/reference/invoices/v1-invoice-show.md): `GET /v1/api/store/{team_slug}/invoice/{hash_id}` (legacy, deprecated)
- [Change an invoice number (v1)](https://developer.yoprint.com/reference/invoices/v1-invoice-update-put.md): `PUT /v1/api/store/{team_slug}/invoice/{hash_id}` (legacy, deprecated)
- [Change an invoice number (v1) (same as PUT)](https://developer.yoprint.com/reference/invoices/v1-invoice-update-patch.md): `PATCH /v1/api/store/{team_slug}/invoice/{hash_id}` (legacy, deprecated)

### [Invoice line items](https://developer.yoprint.com/reference/invoice-line-items.md)

The lines of an invoice: billed sales order lines, shipping fees, discounts and one tax line.

- [Add a line to an invoice](https://developer.yoprint.com/reference/invoice-line-items/v2-invoice-item-create.md): `POST /v2/api/store/{team_slug}/v2/invoice/{unique_key}/item`
- [Add, change and remove invoice lines at once](https://developer.yoprint.com/reference/invoice-line-items/v2-invoice-item-bulk.md): `POST /v2/api/store/{team_slug}/v2/invoice/{unique_key}/item/bulk`
- [List the lines of an invoice](https://developer.yoprint.com/reference/invoice-line-items/v2-invoice-item-index.md): `GET /v2/api/store/{team_slug}/v2/invoice/{unique_key}/item`
- [Get an invoice line](https://developer.yoprint.com/reference/invoice-line-items/v2-invoice-item-show.md): `GET /v2/api/store/{team_slug}/v2/invoice/item/{unique_key}`
- [Update an invoice line](https://developer.yoprint.com/reference/invoice-line-items/v2-invoice-item-update.md): `PUT /v2/api/store/{team_slug}/v2/invoice/item/{unique_key}`
- [Remove a line from an invoice](https://developer.yoprint.com/reference/invoice-line-items/v2-invoice-item-destroy.md): `DELETE /v2/api/store/{team_slug}/v2/invoice/item/{unique_key}`

### [Payments](https://developer.yoprint.com/reference/payments.md)

Payments, refunds and customer credit on a sales order: payments you record yourself, card payments through a connected gateway, and Square Terminal checkouts.

- [Record a payment on a sales order](https://developer.yoprint.com/reference/payments/v2-sales-order-manual-payment-store.md): `POST /v2/api/store/{team_slug}/v2/sales_order/{hash_id}/payment`
- [Record a refund of a payment](https://developer.yoprint.com/reference/payments/v2-sales-order-manual-payment-refund.md): `PUT /v2/api/store/{team_slug}/v2/sales_order/{hash_id}/payment/{id}/refund`
- [List the payments of a sales order](https://developer.yoprint.com/reference/payments/v2-sales-order-payment-index.md): `GET /v2/api/store/{team_slug}/v2/sales_order/{hash_id}/payment`
- [Get one payment of a sales order](https://developer.yoprint.com/reference/payments/v2-sales-order-payment-show.md): `GET /v2/api/store/{team_slug}/v2/sales_order/{hash_id}/payment/{payment_reference}`
- [Pay an order from the customer's credit](https://developer.yoprint.com/reference/payments/v2-sales-order-credit-pay-with-customer-credit.md): `POST /v2/api/store/{team_slug}/v2/sales_order/{hash_id}/credit/pay_with_customer_credit`
- [Move all of an order's payments to customer credit](https://developer.yoprint.com/reference/payments/v2-sales-order-credit-refund-all-to-customer-credit.md): `PATCH /v2/api/store/{team_slug}/v2/sales_order/{hash_id}/credit/refund_all_to_customer_credit`
- [Move part of an order's payments to customer credit](https://developer.yoprint.com/reference/payments/v2-sales-order-credit-refund-to-customer-credit.md): `POST /v2/api/store/{team_slug}/v2/sales_order/{hash_id}/credit/refund_to_customer_credit`
- [Refund a card payment through the gateway](https://developer.yoprint.com/reference/payments/v2-sales-order-payment-gateway-refund.md): `PUT /v2/api/store/{team_slug}/v2/sales_order/{hash_id}/payment_gateway_refund/{id}`
- [Update a recorded payment](https://developer.yoprint.com/reference/payments/v2-sales-order-manual-payment-update.md): `PUT /v2/api/store/{team_slug}/v2/sales_order/{hash_id}/payment/{payment_reference}`
- [Delete a payment or refund](https://developer.yoprint.com/reference/payments/v2-sales-order-manual-payment-destroy.md): `DELETE /v2/api/store/{team_slug}/v2/sales_order/{hash_id}/payment/{payment_reference}`
- [Start a Square Terminal checkout (v1)](https://developer.yoprint.com/reference/payments/v1-sales-order-payment-square-terminal-create.md): `POST /v1/api/store/{team_slug}/sales_order/{hash_id}/square_terminal/create` (legacy, deprecated)
- [Check a pending card payment (v1, not usable)](https://developer.yoprint.com/reference/payments/v1-sales-order-payment-gateway-polling.md): `POST /v1/api/store/{team_slug}/sales_order/poll_pending_payment` (legacy, deprecated)
- [Refund a card payment (v1)](https://developer.yoprint.com/reference/payments/v1-sales-order-payment-gateway-refund.md): `PUT /v1/api/store/{team_slug}/sales_order/{hash_id}/payment_gateway_refund/{id}` (legacy, deprecated)
- [Charge a card through the gateway (v1)](https://developer.yoprint.com/reference/payments/v1-sales-order-payment-gateway-execute.md): `POST /v1/api/store/{team_slug}/sales_order/{hash_id}/payment/{payment_gateway}` (legacy, deprecated)
- [Prepare a card payment (v1)](https://developer.yoprint.com/reference/payments/v1-sales-order-payment-gateway-pre-execute.md): `POST /v1/api/store/{team_slug}/sales_order/{hash_id}/payment/{payment_gateway}/pre_execute` (legacy, deprecated)
- [Cancel a Square Terminal checkout (v1)](https://developer.yoprint.com/reference/payments/v1-sales-order-payment-square-terminal-cancel.md): `PATCH /v1/api/store/{team_slug}/sales_order/{hash_id}/square_terminal/{checkout_id}/cancel` (legacy, deprecated)
- [Start a Square Terminal checkout](https://developer.yoprint.com/reference/payments/v2-sales-order-payment-square-terminal-create.md): `POST /v2/api/store/{team_slug}/v2/sales_order/{hash_id}/square_terminal/create` (internal: built for YoPrint's own apps, don't build on it; moves money)
- [Check a pending card payment (not usable)](https://developer.yoprint.com/reference/payments/v2-sales-order-payment-gateway-polling.md): `POST /v2/api/store/{team_slug}/v2/sales_order/poll_pending_payment` (internal: built for YoPrint's own apps, don't build on it)
- [Prepare a card payment](https://developer.yoprint.com/reference/payments/v2-sales-order-payment-gateway-pre-execute.md): `POST /v2/api/store/{team_slug}/v2/sales_order/{hash_id}/payment/{payment_gateway}/pre_execute` (internal: built for YoPrint's own apps, don't build on it)
- [Charge a card through the payment gateway](https://developer.yoprint.com/reference/payments/v2-sales-order-payment-gateway-execute.md): `POST /v2/api/store/{team_slug}/v2/sales_order/{hash_id}/payment/{payment_reference}` (internal: built for YoPrint's own apps, don't build on it; moves money)
- [Cancel a Square Terminal checkout](https://developer.yoprint.com/reference/payments/v2-sales-order-payment-square-terminal-cancel.md): `PATCH /v2/api/store/{team_slug}/v2/sales_order/{hash_id}/square_terminal/{checkout_id}/cancel` (internal: built for YoPrint's own apps, don't build on it)

### [Payment links](https://developer.yoprint.com/reference/payment-links.md)

A payment link records how payments received on a sales order are split across its invoices (the web app calls this a payment allocation).

- [Create a payment link for a sales order](https://developer.yoprint.com/reference/payment-links/v2-sales-order-payment-link-create.md): `POST /v2/api/store/{team_slug}/v2/sales_order/{hash_id}/payment_link`
- [List the payment links of a sales order](https://developer.yoprint.com/reference/payment-links/v2-sales-order-payment-link-index.md): `GET /v2/api/store/{team_slug}/v2/sales_order/{hash_id}/payment_link`
- [Show one payment link with allocations](https://developer.yoprint.com/reference/payment-links/v2-payment-link-show.md): `GET /v2/api/store/{team_slug}/v2/payment_link/{hash_id}`
- [Get the starting point for editing a payment link](https://developer.yoprint.com/reference/payment-links/v2-payment-link-get-update-template.md): `GET /v2/api/store/{team_slug}/v2/payment_link/{hash_id}/get_update_template`
- [Get what a new payment link can allocate](https://developer.yoprint.com/reference/payment-links/v2-sales-order-payment-link-get-create-template.md): `GET /v2/api/store/{team_slug}/v2/sales_order/{hash_id}/payment_link/get_create_template`
- [Update a payment link](https://developer.yoprint.com/reference/payment-links/v2-payment-link-update.md): `PUT /v2/api/store/{team_slug}/v2/payment_link/{hash_id}`
- [Delete a payment link](https://developer.yoprint.com/reference/payment-links/v2-payment-link-delete.md): `DELETE /v2/api/store/{team_slug}/v2/payment_link/{hash_id}`

## Messages and activity

### [Messages](https://developer.yoprint.com/reference/messages.md)

Your team's whole message inbox: emails and texts exchanged with customers and vendors on all sales orders, quotes and purchase orders, with their delivery status.

- [List messages](https://developer.yoprint.com/reference/messages/v2-messages-index.md): `GET /v2/api/store/{team_slug}/messages`
- [List a message's recipients](https://developer.yoprint.com/reference/messages/v2-messages-recipients-index.md): `GET /v2/api/store/{team_slug}/messages/{hash_id}/recipients`
- [Filter messages](https://developer.yoprint.com/reference/messages/v2-messages-filter.md): `POST /v2/api/store/{team_slug}/messages/filter`
- [Get a message](https://developer.yoprint.com/reference/messages/v2-messages-show.md): `GET /v2/api/store/{team_slug}/messages/{hash_id}`
- [Get one recipient of a message](https://developer.yoprint.com/reference/messages/v2-messages-recipients-show.md): `GET /v2/api/store/{team_slug}/messages/{hash_id}/recipients/{id}`
- [Retry delivery to one recipient](https://developer.yoprint.com/reference/messages/v2-messages-recipients-retry.md): `PUT /v2/api/store/{team_slug}/messages/{hash_id}/recipients/{id}/retry`
- [Retry a message's failed deliveries](https://developer.yoprint.com/reference/messages/v2-messages-retry.md): `PUT /v2/api/store/{team_slug}/messages/{hash_id}/retry` (spends money)
- [Set a message's status](https://developer.yoprint.com/reference/messages/v2-messages-status.md): `PUT /v2/api/store/{team_slug}/messages/{hash_id}/status`

### [Message participants](https://developer.yoprint.com/reference/message-participants.md)

One person on an order's or purchase order's message thread, by participant id: who receives its customer emails and texts.

- [Get a message participant](https://developer.yoprint.com/reference/message-participants/v1-participant-show.md): `GET /v1/api/store/{team_slug}/participant/{id}`
- [Change a message participant](https://developer.yoprint.com/reference/message-participants/v1-participant-update-put.md): `PUT /v1/api/store/{team_slug}/participant/{id}`
- [Change a message participant without checks](https://developer.yoprint.com/reference/message-participants/v1-participant-update-patch.md): `PATCH /v1/api/store/{team_slug}/participant/{id}`
- [Remove a message participant](https://developer.yoprint.com/reference/message-participants/v1-participant-destroy.md): `DELETE /v1/api/store/{team_slug}/participant/{id}`

### [Notifications](https://developer.yoprint.com/reference/notifications.md)

Your own notification feed: the YoPrint activity that concerns you, such as new comments, customer replies, payments and approvals.

- [List your notifications](https://developer.yoprint.com/reference/notifications/v1-current-user-feed-index.md): `GET /v1/api/store/{team_slug}/current_user_feed`
- [Archive notifications](https://developer.yoprint.com/reference/notifications/v1-current-user-feed-archive.md): `PUT /v1/api/store/{team_slug}/current_user_feed/archive`
- [Archive all your notifications](https://developer.yoprint.com/reference/notifications/v1-current-user-feed-mark-all-as-archive.md): `PUT /v1/api/store/{team_slug}/current_user_feed/mark_all_as_archive`
- [Mark all your notifications as seen](https://developer.yoprint.com/reference/notifications/v1-current-user-feed-mark-all-as-seen.md): `PUT /v1/api/store/{team_slug}/current_user_feed/mark_all_as_seen`
- [Mark notifications as seen](https://developer.yoprint.com/reference/notifications/v1-current-user-feed-seen.md): `PUT /v1/api/store/{team_slug}/current_user_feed/seen`
- [Unarchive notifications](https://developer.yoprint.com/reference/notifications/v1-current-user-feed-unarchive.md): `PUT /v1/api/store/{team_slug}/current_user_feed/unarchive`
- [Mark notifications as not seen](https://developer.yoprint.com/reference/notifications/v1-current-user-feed-unseen.md): `PUT /v1/api/store/{team_slug}/current_user_feed/unseen`

### [Your preferences](https://developer.yoprint.com/reference/your-preferences.md)

Your saved web app preferences for one team, such as grid column layouts.

- [Get your preferences for this team](https://developer.yoprint.com/reference/your-preferences/v1-current-user-preference-show.md): `GET /v1/api/store/{team_slug}/current_user_preference`
- [Save your preferences for this team](https://developer.yoprint.com/reference/your-preferences/v1-current-user-preference-update.md): `POST /v1/api/store/{team_slug}/current_user_preference`

## Imports and exports

### [Data exports](https://developer.yoprint.com/reference/data-exports.md)

Whole-team CSV exports from the Download Center: customers, products, sales orders, invoices, payments, tax and purchase orders.

- [List data exports](https://developer.yoprint.com/reference/data-exports/v1-data-export-index.md): `GET /v1/api/store/{team_slug}/data_export`
- [List export types and their columns](https://developer.yoprint.com/reference/data-exports/v1-data-export-definitions.md): `GET /v1/api/store/{team_slug}/data_export/definitions`
- [List export column presets](https://developer.yoprint.com/reference/data-exports/v1-data-export-presets.md): `GET /v1/api/store/{team_slug}/data_export/presets`
- [Get a data export](https://developer.yoprint.com/reference/data-exports/v1-data-export-show.md): `GET /v1/api/store/{team_slug}/data_export/{id}`
- [Save an export column preset](https://developer.yoprint.com/reference/data-exports/v1-data-export-presets-store.md): `POST /v1/api/store/{team_slug}/data_export/presets`
- [Delete an export column preset](https://developer.yoprint.com/reference/data-exports/v1-data-export-presets-delete.md): `DELETE /v1/api/store/{team_slug}/data_export/presets/{presetId}`
- [Download a data export's file](https://developer.yoprint.com/reference/data-exports/v1-data-export-download.md): `GET /v1/api/store/{team_slug}/data_export/{id}/download`
- [Export all customers to CSV](https://developer.yoprint.com/reference/data-exports/v1-data-export-export-customer.md): `POST /v1/api/store/{team_slug}/data_export/export_customer`
- [Export invoices in a date range to CSV](https://developer.yoprint.com/reference/data-exports/v1-data-export-export-invoice.md): `POST /v1/api/store/{team_slug}/data_export/export_invoice`
- [Export invoice line items in a date range to CSV](https://developer.yoprint.com/reference/data-exports/v1-data-export-export-invoice-item.md): `POST /v1/api/store/{team_slug}/data_export/export_invoice_item`
- [Export payments and refunds in a date range to CSV](https://developer.yoprint.com/reference/data-exports/v1-data-export-export-payment-list.md): `POST /v1/api/store/{team_slug}/data_export/export_payment_list`
- [Export purchase orders in a date range to CSV](https://developer.yoprint.com/reference/data-exports/v1-data-export-export-purchase-order-list.md): `POST /v1/api/store/{team_slug}/data_export/export_purchase_order_list`
- [Export sales orders in a date range to CSV](https://developer.yoprint.com/reference/data-exports/v1-data-export-export-sales-order.md): `POST /v1/api/store/{team_slug}/data_export/export_sales_order`
- [Export all simple products to CSV](https://developer.yoprint.com/reference/data-exports/v1-data-export-export-simple-product-list.md): `POST /v1/api/store/{team_slug}/data_export/export_simple_product_list`
- [Export the tax report for a date range to CSV](https://developer.yoprint.com/reference/data-exports/v1-data-export-export-tax.md): `POST /v1/api/store/{team_slug}/data_export/export_tax`
- [Export all variant products to CSV](https://developer.yoprint.com/reference/data-exports/v1-data-export-export-variant-product-list.md): `POST /v1/api/store/{team_slug}/data_export/export_variant_product_list`

### [CSV imports](https://developer.yoprint.com/reference/csv-imports.md)

CSV templates, the service pricing CSV upload, and your import jobs.

- [Import a service's price table from CSV](https://developer.yoprint.com/reference/csv-imports/v1-imports-csv-store.md): `POST /v1/api/store/{team_slug}/imports/csv`
- [List import jobs](https://developer.yoprint.com/reference/csv-imports/v1-imports-index.md): `GET /v1/api/store/{team_slug}/imports`
- [List import activity](https://developer.yoprint.com/reference/csv-imports/v1-source-imports-activity-index.md): `GET /v1/api/store/{team_slug}/source-imports/activity`
- [Get an import job](https://developer.yoprint.com/reference/csv-imports/v1-imports-show.md): `GET /v1/api/store/{team_slug}/imports/{hash_id}`
- [Download the customer CSV template](https://developer.yoprint.com/reference/csv-imports/v1-csv-template-customer.md): `PUT /v1/api/store/{team_slug}/csv/template/customer`
- [Download the service pricing CSV template](https://developer.yoprint.com/reference/csv-imports/v1-csv-template-service-pricing.md): `PUT /v1/api/store/{team_slug}/csv/template/service_pricing`
- [Download the simple product CSV template](https://developer.yoprint.com/reference/csv-imports/v1-csv-template-simple-product.md): `PUT /v1/api/store/{team_slug}/csv/template/simple_product`
- [Download the variant product CSV template](https://developer.yoprint.com/reference/csv-imports/v1-csv-template-variant-product.md): `PUT /v1/api/store/{team_slug}/csv/template/variant_product`
- [Download the vendor CSV template](https://developer.yoprint.com/reference/csv-imports/v1-csv-template-vendor.md): `PUT /v1/api/store/{team_slug}/csv/template/vendor`
- [Download an import job's failed rows](https://developer.yoprint.com/reference/csv-imports/v1-imports-artifacts-error-csv.md): `GET /v1/api/store/{team_slug}/imports/{hash_id}/artifacts/error-csv`

### [Uploads](https://developer.yoprint.com/reference/uploads.md)

Upload a file first, then attach it to a job, an order, a purchase order or a customer by its id.

- [Upload a file](https://developer.yoprint.com/reference/uploads/v1-async-upload-store.md): `POST /v1/api/store/{team_slug}/async_upload`
- [Get an uploaded file](https://developer.yoprint.com/reference/uploads/v1-async-upload-show.md): `GET /v1/api/store/{team_slug}/async_upload/{hash_id}`
- [Set an uploaded file's location or mockup flag](https://developer.yoprint.com/reference/uploads/v1-async-upload-update-put.md): `PUT /v1/api/store/{team_slug}/async_upload/{hash_id}`
- [Set an uploaded file's location or mockup flag with PATCH](https://developer.yoprint.com/reference/uploads/v1-async-upload-update-patch.md): `PATCH /v1/api/store/{team_slug}/async_upload/{hash_id}`
- [Delete an uploaded file](https://developer.yoprint.com/reference/uploads/v1-async-upload-destroy.md): `DELETE /v1/api/store/{team_slug}/async_upload/{hash_id}`

## Reports

### [Reports](https://developer.yoprint.com/reference/reports.md)

Period reports of orders, purchase orders, payments and paid invoices, for your own reporting.

- [Report payments and refunds](https://developer.yoprint.com/reference/reports/v1-report-payment.md): `POST /v1/api/store/{team_slug}/report/payment`
- [Report purchase orders by issue date](https://developer.yoprint.com/reference/reports/v1-report-purchase-order.md): `POST /v1/api/store/{team_slug}/report/purchase_order`
- [Report quotes by issue date](https://developer.yoprint.com/reference/reports/v1-report-quote.md): `POST /v1/api/store/{team_slug}/report/quote`
- [Report sales orders by issue date](https://developer.yoprint.com/reference/reports/v1-report-sales-order.md): `POST /v1/api/store/{team_slug}/report/sales_order`
- [Report invoices of orders paid in full](https://developer.yoprint.com/reference/reports/v1-report-tax.md): `POST /v1/api/store/{team_slug}/report/tax`

## Team settings

### [Webhook subscriptions](https://developer.yoprint.com/reference/webhook-subscriptions.md)

Subscribe a URL to YoPrint events, such as a published sales order or a received payment.

- [Create a webhook subscription](https://developer.yoprint.com/reference/webhook-subscriptions/v1-webhook-subscription-store.md): `POST /v1/api/store/{team_slug}/setting/webhook_subscription`
- [List webhook subscriptions](https://developer.yoprint.com/reference/webhook-subscriptions/v1-webhook-subscription-index.md): `GET /v1/api/store/{team_slug}/setting/webhook_subscription`
- [List deliveries for a webhook subscription](https://developer.yoprint.com/reference/webhook-subscriptions/v1-webhook-subscription-log.md): `GET /v1/api/store/{team_slug}/setting/webhook_subscription/{id}/log`
- [Show a webhook subscription](https://developer.yoprint.com/reference/webhook-subscriptions/v1-webhook-subscription-show.md): `GET /v1/api/store/{team_slug}/setting/webhook_subscription/{hash_id}`
- [Show a sample event](https://developer.yoprint.com/reference/webhook-subscriptions/v1-webhook-subscription-sample.md): `GET /v1/api/store/{team_slug}/setting/webhook_subscription/sample/{event_name}`
- [Update a webhook subscription](https://developer.yoprint.com/reference/webhook-subscriptions/v1-webhook-subscription-update-put.md): `PUT /v1/api/store/{team_slug}/setting/webhook_subscription/{hash_id}`
- [Touch a webhook subscription](https://developer.yoprint.com/reference/webhook-subscriptions/v1-webhook-subscription-update-patch.md): `PATCH /v1/api/store/{team_slug}/setting/webhook_subscription/{hash_id}`
- [Delete a webhook subscription](https://developer.yoprint.com/reference/webhook-subscriptions/v1-webhook-subscription-destroy.md): `DELETE /v1/api/store/{team_slug}/setting/webhook_subscription/{hash_id}`

### [Statuses](https://developer.yoprint.com/reference/statuses.md)

The status lists for sales orders, quotes, jobs, purchase orders, shipments, message threads and task presets.

- [Create a status](https://developer.yoprint.com/reference/statuses/v1-status-store.md): `POST /v1/api/store/{team_slug}/setting/status`
- [List every status, including deleted ones](https://developer.yoprint.com/reference/statuses/v1-status-index.md): `GET /v1/api/store/{team_slug}/setting/status`
- [List message thread statuses](https://developer.yoprint.com/reference/statuses/v1-status-list-customer-message.md): `GET /v1/api/store/{team_slug}/setting/status/customer_message`
- [List job statuses](https://developer.yoprint.com/reference/statuses/v1-status-list-job.md): `GET /v1/api/store/{team_slug}/setting/status/job`
- [List the task statuses of a task preset](https://developer.yoprint.com/reference/statuses/v1-status-list-pipeline.md): `GET /v1/api/store/{team_slug}/setting/status/pipeline/{hash_id}`
- [List purchase order statuses](https://developer.yoprint.com/reference/statuses/v1-status-list-purchase-order.md): `GET /v1/api/store/{team_slug}/setting/status/purchase_order`
- [List purchase order statuses, without the ending one](https://developer.yoprint.com/reference/statuses/v1-status-list-purchase-order-without-end.md): `GET /v1/api/store/{team_slug}/setting/status/purchase_order_without_end`
- [List quote statuses](https://developer.yoprint.com/reference/statuses/v1-status-list-quote.md): `GET /v1/api/store/{team_slug}/setting/status/quote`
- [List sales order statuses](https://developer.yoprint.com/reference/statuses/v1-status-list-sales-order.md): `GET /v1/api/store/{team_slug}/setting/status/sales_order`
- [List shipment statuses](https://developer.yoprint.com/reference/statuses/v1-status-list-shipment.md): `GET /v1/api/store/{team_slug}/setting/status/shipment`
- [Get a status](https://developer.yoprint.com/reference/statuses/v1-status-show.md): `GET /v1/api/store/{team_slug}/setting/status/{status_reference}`
- [Save a set of status changes](https://developer.yoprint.com/reference/statuses/v1-status-sync.md): `POST /v1/api/store/{team_slug}/setting/status/{status_reference}`
- [Update a status](https://developer.yoprint.com/reference/statuses/v1-status-update-put.md): `PUT /v1/api/store/{team_slug}/setting/status/{status_reference}`
- [Update a status without checks](https://developer.yoprint.com/reference/statuses/v1-status-update-patch.md): `PATCH /v1/api/store/{team_slug}/setting/status/{status_reference}`
- [Delete a status](https://developer.yoprint.com/reference/statuses/v1-status-destroy.md): `DELETE /v1/api/store/{team_slug}/setting/status/{status_reference}`
- [Restore a deleted status](https://developer.yoprint.com/reference/statuses/v1-status-restore.md): `PATCH /v1/api/store/{team_slug}/setting/status/{id}/restore`

### [Team members](https://developer.yoprint.com/reference/team-members.md)

The people on your team, their permission groups, and ownership.

- [List team members](https://developer.yoprint.com/reference/team-members/v1-user-index.md): `GET /v1/api/store/{team_slug}/setting/user`
- [Get a team member](https://developer.yoprint.com/reference/team-members/v1-user-show.md): `GET /v1/api/store/{team_slug}/setting/user/{hash_id}`
- [Transfer team ownership](https://developer.yoprint.com/reference/team-members/v1-user-make-owner.md): `POST /v1/api/store/{team_slug}/setting/user/{hash_id}/make_owner`
- [Remove a member from the team](https://developer.yoprint.com/reference/team-members/v1-user-destroy.md): `DELETE /v1/api/store/{team_slug}/setting/user/{hash_id}`

### [Company locations](https://developer.yoprint.com/reference/company-locations.md)

The team's own addresses: the primary location, warehouses, the default warehouse and tax nexus.

- [Create a company location](https://developer.yoprint.com/reference/company-locations/v1-location-store.md): `POST /v1/api/store/{team_slug}/setting/location`
- [List company locations](https://developer.yoprint.com/reference/company-locations/v1-location-index.md): `GET /v1/api/store/{team_slug}/setting/location`
- [Show a company location](https://developer.yoprint.com/reference/company-locations/v1-location-show.md): `GET /v1/api/store/{team_slug}/setting/location/{hash_id}`
- [Update a company location](https://developer.yoprint.com/reference/company-locations/v1-location-update-put.md): `PUT /v1/api/store/{team_slug}/setting/location/{hash_id}`
- [Update a company location without checks](https://developer.yoprint.com/reference/company-locations/v1-location-update-patch.md): `PATCH /v1/api/store/{team_slug}/setting/location/{hash_id}`
- [Set the default warehouse](https://developer.yoprint.com/reference/company-locations/v1-location-default-warehouse.md): `PATCH /v1/api/store/{team_slug}/setting/location/{id}/default_warehouse`
- [Set a location as a warehouse](https://developer.yoprint.com/reference/company-locations/v1-location-hold-stock.md): `PATCH /v1/api/store/{team_slug}/setting/location/{id}/hold_stock`
- [Set the primary location](https://developer.yoprint.com/reference/company-locations/v1-location-primary.md): `PATCH /v1/api/store/{team_slug}/setting/location/{id}/primary`
- [Delete a company location](https://developer.yoprint.com/reference/company-locations/v1-location-destroy.md): `DELETE /v1/api/store/{team_slug}/setting/location/{hash_id}`
- [Restore a company location](https://developer.yoprint.com/reference/company-locations/v1-location-restore.md): `PATCH /v1/api/store/{team_slug}/setting/location/{id}/restore`

### [Company settings](https://developer.yoprint.com/reference/company-settings.md)

Your company's profile, logo, customer portal look, custom domain, general preferences and list columns.

- [Upload the customer portal background](https://developer.yoprint.com/reference/company-settings/v1-setting-customer-portal-bg-update.md): `POST /v1/api/store/{team_slug}/setting/customer_portal_bg`
- [Upload the customer portal favicon](https://developer.yoprint.com/reference/company-settings/v1-setting-customer-portal-favicon-update.md): `POST /v1/api/store/{team_slug}/setting/customer_portal_favicon`
- [Upload the team logo](https://developer.yoprint.com/reference/company-settings/v1-setting-photo-update.md): `POST /v1/api/store/{team_slug}/setting/photo`
- [Show team settings](https://developer.yoprint.com/reference/company-settings/v1-setting-show.md): `GET /v1/api/store/{team_slug}/setting`
- [Check a custom domain is allowed](https://developer.yoprint.com/reference/company-settings/v1-setting-custom-domain-check.md): `PUT /v1/api/store/{team_slug}/setting/custom_domain/check`
- [Check a custom domain's DNS](https://developer.yoprint.com/reference/company-settings/v1-setting-custom-domain-check-setup.md): `PUT /v1/api/store/{team_slug}/setting/custom_domain/check_setup`
- [Get your company details](https://developer.yoprint.com/reference/company-settings/v1-setting-detail-show.md): `GET /v1/api/store/{team_slug}/setting/detail`
- [Update company details](https://developer.yoprint.com/reference/company-settings/v1-setting-update.md): `PUT /v1/api/store/{team_slug}/setting`
- [Set the columns of a list](https://developer.yoprint.com/reference/company-settings/v1-setting-column-update.md): `PUT /v1/api/store/{team_slug}/setting/column`
- [Set the custom domain](https://developer.yoprint.com/reference/company-settings/v1-setting-custom-domain-update.md): `PUT /v1/api/store/{team_slug}/setting/custom_domain/update`
- [Update general settings](https://developer.yoprint.com/reference/company-settings/v1-setting-general-update.md): `PUT /v1/api/store/{team_slug}/setting/general`
- [Remove the customer portal background](https://developer.yoprint.com/reference/company-settings/v1-setting-customer-portal-bg-delete.md): `DELETE /v1/api/store/{team_slug}/setting/customer_portal_bg`
- [Remove the customer portal favicon](https://developer.yoprint.com/reference/company-settings/v1-setting-customer-portal-favicon-delete.md): `DELETE /v1/api/store/{team_slug}/setting/customer_portal_favicon`
- [Remove the team logo](https://developer.yoprint.com/reference/company-settings/v1-setting-photo-delete.md): `DELETE /v1/api/store/{team_slug}/setting/photo`

### [Compliance requests](https://developer.yoprint.com/reference/compliance-requests.md)

Files produced for privacy requests, such as a Shopify customer data request.

- [Download a Shopify customer data export](https://developer.yoprint.com/reference/compliance-requests/v1-compliance-shopify-data-request-download.md): `GET /v1/api/store/{team_slug}/setting/compliance/shopify-data-request/{id}/download` (internal: built for YoPrint's own apps, don't build on it)

### [Connected devices](https://developer.yoprint.com/reference/connected-devices.md)

Card terminals paired with your team.

- [List connected devices](https://developer.yoprint.com/reference/connected-devices/v1-connected-device-index.md): `GET /v1/api/store/{team_slug}/setting/connected_device`
- [Remove a connected device](https://developer.yoprint.com/reference/connected-devices/v1-connected-device-destroy.md): `DELETE /v1/api/store/{team_slug}/setting/connected_device/{hash_id}`

### [Currencies](https://developer.yoprint.com/reference/currencies.md)

The team's currencies.

- [Create a currency](https://developer.yoprint.com/reference/currencies/v1-currency-store.md): `POST /v1/api/store/{team_slug}/setting/currency`
- [List currencies](https://developer.yoprint.com/reference/currencies/v1-currency-index.md): `GET /v1/api/store/{team_slug}/setting/currency`
- [Show a currency](https://developer.yoprint.com/reference/currencies/v1-currency-show.md): `GET /v1/api/store/{team_slug}/setting/currency/{hash_id}`
- [Update a currency](https://developer.yoprint.com/reference/currencies/v1-currency-update-put.md): `PUT /v1/api/store/{team_slug}/setting/currency/{hash_id}`
- [Update a currency without checks](https://developer.yoprint.com/reference/currencies/v1-currency-update-patch.md): `PATCH /v1/api/store/{team_slug}/setting/currency/{hash_id}`
- [Delete a currency](https://developer.yoprint.com/reference/currencies/v1-currency-destroy.md): `DELETE /v1/api/store/{team_slug}/setting/currency/{hash_id}`
- [Restore a currency](https://developer.yoprint.com/reference/currencies/v1-currency-restore.md): `PATCH /v1/api/store/{team_slug}/setting/currency/{id}/restore`

### [Feature add-ons](https://developer.yoprint.com/reference/feature-add-ons.md)

Optional features a team turns on or off.

- [Turn off a feature add-on](https://developer.yoprint.com/reference/feature-add-ons/v1-setting-feature-addon-disable.md): `PUT /v1/api/store/{team_slug}/setting/feature_addon/{module}/disable`
- [Turn on a feature add-on](https://developer.yoprint.com/reference/feature-add-ons/v1-setting-feature-addon-enable.md): `PUT /v1/api/store/{team_slug}/setting/feature_addon/{module}/enable`

### [Fee presets](https://developer.yoprint.com/reference/fee-presets.md)

Saved fee names and prices to copy into fee line items.

- [Create a fee preset](https://developer.yoprint.com/reference/fee-presets/v1-fee-preset-store.md): `POST /v1/api/store/{team_slug}/setting/fee_preset`
- [List fee presets](https://developer.yoprint.com/reference/fee-presets/v1-fee-preset-index.md): `GET /v1/api/store/{team_slug}/setting/fee_preset`
- [Search fee presets by name](https://developer.yoprint.com/reference/fee-presets/v1-setting-fee-preset-search.md): `POST /v1/api/store/{team_slug}/setting/fee_preset/search`
- [Show a fee preset](https://developer.yoprint.com/reference/fee-presets/v1-fee-preset-show.md): `GET /v1/api/store/{team_slug}/setting/fee_preset/{hash_id}`
- [Update a fee preset](https://developer.yoprint.com/reference/fee-presets/v1-fee-preset-update-put.md): `PUT /v1/api/store/{team_slug}/setting/fee_preset/{hash_id}`
- [Update a fee preset without checks](https://developer.yoprint.com/reference/fee-presets/v1-fee-preset-update-patch.md): `PATCH /v1/api/store/{team_slug}/setting/fee_preset/{hash_id}`
- [Delete a fee preset](https://developer.yoprint.com/reference/fee-presets/v1-fee-preset-destroy.md): `DELETE /v1/api/store/{team_slug}/setting/fee_preset/{hash_id}`

### [Integration logs](https://developer.yoprint.com/reference/integration-logs.md)

Recent QuickBooks Online and Shopify sync errors for one sales order, purchase order or shipment.

- [List a sales order's integration errors](https://developer.yoprint.com/reference/integration-logs/v1-external-integration-logs-order.md): `GET /v1/api/store/{team_slug}/external_integration_logs/order/{hash_id}`
- [List a purchase order's integration errors](https://developer.yoprint.com/reference/integration-logs/v1-external-integration-logs-purchase-order.md): `GET /v1/api/store/{team_slug}/external_integration_logs/purchase_order/{hash_id}`
- [List a shipment's integration errors](https://developer.yoprint.com/reference/integration-logs/v1-external-integration-logs-shipment.md): `GET /v1/api/store/{team_slug}/external_integration_logs/shipment/{hash_id}`

### [Integrations](https://developer.yoprint.com/reference/integrations.md)

Connections to suppliers, Twilio, GoShippo, QuickBooks Online, Square and Shopify.

- [List integrations](https://developer.yoprint.com/reference/integrations/v1-external-integration-index.md): `GET /v1/api/store/{team_slug}/setting/external_integration`
- [List an integration's error log](https://developer.yoprint.com/reference/integrations/v1-external-integration-logs.md): `GET /v1/api/store/{team_slug}/setting/external_integration/{id}/logs`
- [Search integrations](https://developer.yoprint.com/reference/integrations/v1-external-integration-filter.md): `POST /v1/api/store/{team_slug}/setting/external_integration/filter`
- [Get an integration](https://developer.yoprint.com/reference/integrations/v1-external-integration-show.md): `GET /v1/api/store/{team_slug}/setting/external_integration/{external_integration_reference}`
- [Read data from an integration's provider](https://developer.yoprint.com/reference/integrations/v1-external-integration-data.md): `PUT /v1/api/store/{team_slug}/setting/external_integration/{id}/data`
- [Connect an integration](https://developer.yoprint.com/reference/integrations/v1-external-integration-store.md): `POST /v1/api/store/{team_slug}/setting/external_integration/{external_integration_reference}`
- [Update an integration](https://developer.yoprint.com/reference/integrations/v1-external-integration-update-put.md): `PUT /v1/api/store/{team_slug}/setting/external_integration/{external_integration_reference}`
- [Update an integration (same as PUT)](https://developer.yoprint.com/reference/integrations/v1-external-integration-update-patch.md): `PATCH /v1/api/store/{team_slug}/setting/external_integration/{external_integration_reference}`
- [Disconnect an integration](https://developer.yoprint.com/reference/integrations/v1-external-integration-destroy.md): `DELETE /v1/api/store/{team_slug}/setting/external_integration/{external_integration_reference}`
- [Run an integration action](https://developer.yoprint.com/reference/integrations/v1-external-integration-action.md): `PUT /v1/api/store/{team_slug}/setting/external_integration/{id}/action`
- [Restore a removed Shopify store](https://developer.yoprint.com/reference/integrations/v1-external-integration-restore.md): `PATCH /v1/api/store/{team_slug}/setting/external_integration/{id}/restore`
- [Search QuickBooks, or sync records to it](https://developer.yoprint.com/reference/integrations/v1-external-integration-public-action.md): `PUT /v1/api/store/{team_slug}/setting/external_integration/{id}/public_action` (internal: built for YoPrint's own apps, don't build on it)
- [Read Shopify orders through the integration](https://developer.yoprint.com/reference/integrations/v1-external-integration-proxy-request.md): `PUT /v1/api/store/{team_slug}/setting/external_integration/{id}/proxy_request` (internal: built for YoPrint's own apps, don't build on it)
- [Check a Shopify install signature](https://developer.yoprint.com/reference/integrations/v1-external-integration-shopify-verify-signature.md): `POST /v1/api/store/{team_slug}/setting/external_integration/shopify/verify-signature` (internal: built for YoPrint's own apps, don't build on it)
- [Retry a logged integration error](https://developer.yoprint.com/reference/integrations/v1-external-integration-retry-action.md): `PATCH /v1/api/store/{team_slug}/setting/external_integration/retry_action/{id}` (internal: built for YoPrint's own apps, don't build on it)
- [Finish a Shopify install](https://developer.yoprint.com/reference/integrations/v1-external-integration-shopify-finalize-install.md): `POST /v1/api/store/{team_slug}/setting/external_integration/shopify/finalize-install` (internal: built for YoPrint's own apps, don't build on it)

### [Job presets](https://developer.yoprint.com/reference/job-presets.md)

Ready-made jobs, with their services, tasks, people and files, that you add to a sales order or quote in one step.

- [Create a job preset](https://developer.yoprint.com/reference/job-presets/v1-job-preset-store.md): `POST /v1/api/store/{team_slug}/setting/job_preset`
- [List job presets](https://developer.yoprint.com/reference/job-presets/v1-job-preset-index.md): `GET /v1/api/store/{team_slug}/setting/job_preset`
- [Search job presets by name](https://developer.yoprint.com/reference/job-presets/v1-setting-job-preset-search.md): `POST /v1/api/store/{team_slug}/setting/job_preset/search`
- [Get a job preset](https://developer.yoprint.com/reference/job-presets/v1-job-preset-show.md): `GET /v1/api/store/{team_slug}/setting/job_preset/{hash_id}`
- [Update a job preset](https://developer.yoprint.com/reference/job-presets/v1-job-preset-update-put.md): `PUT /v1/api/store/{team_slug}/setting/job_preset/{hash_id}`
- [Touch a job preset](https://developer.yoprint.com/reference/job-presets/v1-job-preset-update-patch.md): `PATCH /v1/api/store/{team_slug}/setting/job_preset/{hash_id}`
- [Duplicate a job preset](https://developer.yoprint.com/reference/job-presets/v1-job-preset-duplicate.md): `POST /v1/api/store/{team_slug}/setting/job_preset/{hash_id}/duplicate`
- [Reorder job presets](https://developer.yoprint.com/reference/job-presets/v1-job-preset-arrange.md): `PUT /v1/api/store/{team_slug}/setting/job_preset/arrange`
- [Delete a job preset](https://developer.yoprint.com/reference/job-presets/v1-job-preset-destroy.md): `DELETE /v1/api/store/{team_slug}/setting/job_preset/{hash_id}`

### [Message template attachments](https://developer.yoprint.com/reference/message-template-attachments.md)

The files a message template attaches when it is sent: document PDFs, job sheets, invoices or an uploaded file.

- [Add an attachment to a template](https://developer.yoprint.com/reference/message-template-attachments/v2-message-template-internal-attachment-store.md): `POST /v2/api/store/{team_slug}/setting/message_template/{hash_id}/internal_attachment`
- [List a template's attachments](https://developer.yoprint.com/reference/message-template-attachments/v2-message-template-internal-attachment-index.md): `GET /v2/api/store/{team_slug}/setting/message_template/{hash_id}/internal_attachment`
- [Get a template attachment](https://developer.yoprint.com/reference/message-template-attachments/v2-message-template-internal-attachment-show.md): `GET /v2/api/store/{team_slug}/setting/message_template/{hash_id}/internal_attachment/{id}`
- [Update a template attachment](https://developer.yoprint.com/reference/message-template-attachments/v2-message-template-internal-attachment-update-put.md): `PUT /v2/api/store/{team_slug}/setting/message_template/{hash_id}/internal_attachment/{id}`
- [Change a template attachment with PATCH](https://developer.yoprint.com/reference/message-template-attachments/v2-message-template-internal-attachment-update-patch.md): `PATCH /v2/api/store/{team_slug}/setting/message_template/{hash_id}/internal_attachment/{id}`
- [Remove a template attachment](https://developer.yoprint.com/reference/message-template-attachments/v2-message-template-internal-attachment-destroy.md): `DELETE /v2/api/store/{team_slug}/setting/message_template/{hash_id}/internal_attachment/{id}`

### [Message templates](https://developer.yoprint.com/reference/message-templates.md)

Reusable email and text messages for sales orders, quotes and purchase orders, with placeholders and attachments.

- [Create a message template](https://developer.yoprint.com/reference/message-templates/v2-message-template-store.md): `POST /v2/api/store/{team_slug}/setting/message_template`
- [List message templates](https://developer.yoprint.com/reference/message-templates/v2-message-template-index.md): `GET /v2/api/store/{team_slug}/setting/message_template`
- [List message template types](https://developer.yoprint.com/reference/message-templates/v2-message-template-config-index.md): `GET /v2/api/store/{team_slug}/setting/message_template/config`
- [Get a message template](https://developer.yoprint.com/reference/message-templates/v2-message-template-show.md): `GET /v2/api/store/{team_slug}/setting/message_template/{hash_id}`
- [Get a message template type](https://developer.yoprint.com/reference/message-templates/v2-message-template-config-show.md): `GET /v2/api/store/{team_slug}/setting/message_template/config/{type}`
- [Preview template text](https://developer.yoprint.com/reference/message-templates/v2-message-template-preview.md): `POST /v2/api/store/{team_slug}/setting/message_template/preview`
- [Update a message template](https://developer.yoprint.com/reference/message-templates/v2-message-template-update-put.md): `PUT /v2/api/store/{team_slug}/setting/message_template/{hash_id}`
- [Touch a message template](https://developer.yoprint.com/reference/message-templates/v2-message-template-update-patch.md): `PATCH /v2/api/store/{team_slug}/setting/message_template/{hash_id}`
- [Fill in a template for a record](https://developer.yoprint.com/reference/message-templates/v2-message-template-compile.md): `POST /v2/api/store/{team_slug}/setting/message_template/compile`
- [Send a template for a record](https://developer.yoprint.com/reference/message-templates/v2-message-template-send.md): `POST /v2/api/store/{team_slug}/setting/message_template/send` (spends money)
- [Delete a message template](https://developer.yoprint.com/reference/message-templates/v2-message-template-destroy.md): `DELETE /v2/api/store/{team_slug}/setting/message_template/{hash_id}`

### [Payment gateways](https://developer.yoprint.com/reference/payment-gateways.md)

Card payment gateway credentials: Stripe, PayPal, Square, Charge It Pro and Authorize.Net.

- [List Square locations](https://developer.yoprint.com/reference/payment-gateways/v1-setting-payment-gateway-square-location-list.md): `PUT /v1/api/store/{team_slug}/setting/payment_gateway/get_square_location_list`
- [Update payment gateway settings](https://developer.yoprint.com/reference/payment-gateways/v1-setting-payment-gateway-update.md): `PUT /v1/api/store/{team_slug}/setting/payment_gateway`

### [Payment methods](https://developer.yoprint.com/reference/payment-methods.md)

Labels for payments you record yourself, such as Cash or Check.

- [Create a payment method](https://developer.yoprint.com/reference/payment-methods/v1-payment-method-store.md): `POST /v1/api/store/{team_slug}/setting/payment_method`
- [List payment methods](https://developer.yoprint.com/reference/payment-methods/v1-payment-method-index.md): `GET /v1/api/store/{team_slug}/setting/payment_method`
- [Show a payment method](https://developer.yoprint.com/reference/payment-methods/v1-payment-method-show.md): `GET /v1/api/store/{team_slug}/setting/payment_method/{hash_id}`
- [Update a payment method](https://developer.yoprint.com/reference/payment-methods/v1-payment-method-update-put.md): `PUT /v1/api/store/{team_slug}/setting/payment_method/{hash_id}`
- [Update a payment method without checks](https://developer.yoprint.com/reference/payment-methods/v1-payment-method-update-patch.md): `PATCH /v1/api/store/{team_slug}/setting/payment_method/{hash_id}`
- [Delete a payment method](https://developer.yoprint.com/reference/payment-methods/v1-payment-method-destroy.md): `DELETE /v1/api/store/{team_slug}/setting/payment_method/{hash_id}`
- [Restore a payment method](https://developer.yoprint.com/reference/payment-methods/v1-payment-method-restore.md): `PATCH /v1/api/store/{team_slug}/setting/payment_method/{id}/restore`

### [Payment terms](https://developer.yoprint.com/reference/payment-terms.md)

Deposit and due-date rules that new sales orders and quotes copy from the customer or the team default.

- [Create a payment term](https://developer.yoprint.com/reference/payment-terms/v1-payment-term-store.md): `POST /v1/api/store/{team_slug}/setting/payment_term`
- [List payment terms](https://developer.yoprint.com/reference/payment-terms/v1-payment-term-index.md): `GET /v1/api/store/{team_slug}/setting/payment_term`
- [Show a payment term](https://developer.yoprint.com/reference/payment-terms/v1-payment-term-show.md): `GET /v1/api/store/{team_slug}/setting/payment_term/{hash_id}`
- [Update a payment term](https://developer.yoprint.com/reference/payment-terms/v1-payment-term-update-put.md): `PUT /v1/api/store/{team_slug}/setting/payment_term/{hash_id}`
- [Update a payment term without checks](https://developer.yoprint.com/reference/payment-terms/v1-payment-term-update-patch.md): `PATCH /v1/api/store/{team_slug}/setting/payment_term/{hash_id}`
- [Set the default payment term](https://developer.yoprint.com/reference/payment-terms/v1-payment-term-default.md): `PATCH /v1/api/store/{team_slug}/setting/payment_term/{id}/default`
- [Delete a payment term](https://developer.yoprint.com/reference/payment-terms/v1-payment-term-destroy.md): `DELETE /v1/api/store/{team_slug}/setting/payment_term/{hash_id}`
- [Restore a payment term](https://developer.yoprint.com/reference/payment-terms/v1-payment-term-restore.md): `PATCH /v1/api/store/{team_slug}/setting/payment_term/{id}/restore`

### [Permission groups](https://developer.yoprint.com/reference/permission-groups.md)

What members can do.

- [Create a permission group](https://developer.yoprint.com/reference/permission-groups/v1-group-store.md): `POST /v1/api/store/{team_slug}/setting/group`
- [List permission groups](https://developer.yoprint.com/reference/permission-groups/v1-group-index.md): `GET /v1/api/store/{team_slug}/setting/group`
- [Show a permission group](https://developer.yoprint.com/reference/permission-groups/v1-group-show.md): `GET /v1/api/store/{team_slug}/setting/group/{hash_id}`
- [Update a permission group](https://developer.yoprint.com/reference/permission-groups/v1-group-update-put.md): `PUT /v1/api/store/{team_slug}/setting/group/{hash_id}`
- [Touch a permission group](https://developer.yoprint.com/reference/permission-groups/v1-group-update-patch.md): `PATCH /v1/api/store/{team_slug}/setting/group/{hash_id}`
- [Move a member to a permission group](https://developer.yoprint.com/reference/permission-groups/v1-group-change-user-group.md): `PATCH /v1/api/store/{team_slug}/setting/group/{id}/change_user_group`
- [Delete a permission group](https://developer.yoprint.com/reference/permission-groups/v1-group-destroy.md): `DELETE /v1/api/store/{team_slug}/setting/group/{hash_id}`

### [Running numbers](https://developer.yoprint.com/reference/running-numbers.md)

The next sales order, purchase order and invoice numbers.

- [Show the next document numbers](https://developer.yoprint.com/reference/running-numbers/v1-setting-running-number-show.md): `GET /v1/api/store/{team_slug}/setting/running_number`
- [Set the next document numbers](https://developer.yoprint.com/reference/running-numbers/v1-setting-running-number-update.md): `PUT /v1/api/store/{team_slug}/setting/running_number`

### [Service locations](https://developer.yoprint.com/reference/service-locations.md)

Where on an item a decoration goes, such as "Shirt - Front".

- [Create a service location](https://developer.yoprint.com/reference/service-locations/v1-service-location-store.md): `POST /v1/api/store/{team_slug}/service_location`
- [List service locations](https://developer.yoprint.com/reference/service-locations/v1-service-location-index.md): `GET /v1/api/store/{team_slug}/service_location`
- [Get a service location](https://developer.yoprint.com/reference/service-locations/v1-service-location-show.md): `GET /v1/api/store/{team_slug}/service_location/{hash_id}`
- [Update a service location](https://developer.yoprint.com/reference/service-locations/v1-service-location-update-put.md): `PUT /v1/api/store/{team_slug}/service_location/{hash_id}`
- [Update a service location (PATCH)](https://developer.yoprint.com/reference/service-locations/v1-service-location-update-patch.md): `PATCH /v1/api/store/{team_slug}/service_location/{hash_id}`
- [Delete a service location](https://developer.yoprint.com/reference/service-locations/v1-service-location-destroy.md): `DELETE /v1/api/store/{team_slug}/service_location/{hash_id}`
- [Restore a service location](https://developer.yoprint.com/reference/service-locations/v1-service-location-restore.md): `PATCH /v1/api/store/{team_slug}/service_location/{hash_id}/restore`

### [Shipping boxes](https://developer.yoprint.com/reference/shipping-boxes.md)

Saved box sizes for GoShippo parcels.

- [Create a shipping box](https://developer.yoprint.com/reference/shipping-boxes/v1-shipment-box-store.md): `POST /v1/api/store/{team_slug}/setting/shipment_box`
- [List shipping boxes](https://developer.yoprint.com/reference/shipping-boxes/v1-shipment-box-index.md): `GET /v1/api/store/{team_slug}/setting/shipment_box`
- [Show a shipping box](https://developer.yoprint.com/reference/shipping-boxes/v1-shipment-box-show.md): `GET /v1/api/store/{team_slug}/setting/shipment_box/{hash_id}`
- [Update a shipping box](https://developer.yoprint.com/reference/shipping-boxes/v1-shipment-box-update-put.md): `PUT /v1/api/store/{team_slug}/setting/shipment_box/{hash_id}`
- [Make a shipping box the default](https://developer.yoprint.com/reference/shipping-boxes/v1-shipment-box-update-patch.md): `PATCH /v1/api/store/{team_slug}/setting/shipment_box/{hash_id}`
- [Delete a shipping box](https://developer.yoprint.com/reference/shipping-boxes/v1-shipment-box-destroy.md): `DELETE /v1/api/store/{team_slug}/setting/shipment_box/{hash_id}`

### [Shipping methods](https://developer.yoprint.com/reference/shipping-methods.md)

How shipments go out: courier, own delivery, pick-up or a carrier integration service.

- [Create a shipping method](https://developer.yoprint.com/reference/shipping-methods/v1-shipping-type-store.md): `POST /v1/api/store/{team_slug}/setting/shipping_type`
- [List shipping methods](https://developer.yoprint.com/reference/shipping-methods/v1-shipping-type-index.md): `GET /v1/api/store/{team_slug}/setting/shipping_type`
- [Show a shipping method](https://developer.yoprint.com/reference/shipping-methods/v1-shipping-type-show.md): `GET /v1/api/store/{team_slug}/setting/shipping_type/{hash_id}`
- [Update a shipping method](https://developer.yoprint.com/reference/shipping-methods/v1-shipping-type-update-put.md): `PUT /v1/api/store/{team_slug}/setting/shipping_type/{hash_id}`
- [Make a shipping method the default](https://developer.yoprint.com/reference/shipping-methods/v1-shipping-type-update-patch.md): `PATCH /v1/api/store/{team_slug}/setting/shipping_type/{hash_id}`
- [Delete a shipping method](https://developer.yoprint.com/reference/shipping-methods/v1-shipping-type-destroy.md): `DELETE /v1/api/store/{team_slug}/setting/shipping_type/{hash_id}`
- [Restore a shipping method](https://developer.yoprint.com/reference/shipping-methods/v1-shipping-type-restore.md): `PATCH /v1/api/store/{team_slug}/setting/shipping_type/{id}/restore`

### [Stock adjustment reasons](https://developer.yoprint.com/reference/stock-adjustment-reasons.md)

The reasons offered when stock is adjusted by hand.

- [Create a stock adjustment reason](https://developer.yoprint.com/reference/stock-adjustment-reasons/v1-adjustment-reason-store.md): `POST /v1/api/store/{team_slug}/setting/adjustment_reason`
- [List stock adjustment reasons](https://developer.yoprint.com/reference/stock-adjustment-reasons/v1-adjustment-reason-index.md): `GET /v1/api/store/{team_slug}/setting/adjustment_reason`
- [Show a stock adjustment reason](https://developer.yoprint.com/reference/stock-adjustment-reasons/v1-adjustment-reason-show.md): `GET /v1/api/store/{team_slug}/setting/adjustment_reason/{hash_id}`
- [Update a stock adjustment reason](https://developer.yoprint.com/reference/stock-adjustment-reasons/v1-adjustment-reason-update-put.md): `PUT /v1/api/store/{team_slug}/setting/adjustment_reason/{hash_id}`
- [Update a stock adjustment reason without checks](https://developer.yoprint.com/reference/stock-adjustment-reasons/v1-adjustment-reason-update-patch.md): `PATCH /v1/api/store/{team_slug}/setting/adjustment_reason/{hash_id}`
- [Delete a stock adjustment reason](https://developer.yoprint.com/reference/stock-adjustment-reasons/v1-adjustment-reason-destroy.md): `DELETE /v1/api/store/{team_slug}/setting/adjustment_reason/{hash_id}`

### [Task presets](https://developer.yoprint.com/reference/task-presets.md)

Named sets of task statuses (pipelines in the API) that tasks on jobs follow.

- [Create a task preset](https://developer.yoprint.com/reference/task-presets/v1-pipeline-store.md): `POST /v1/api/store/{team_slug}/setting/pipeline`
- [List task presets](https://developer.yoprint.com/reference/task-presets/v1-pipeline-index.md): `GET /v1/api/store/{team_slug}/setting/pipeline`
- [Show a task preset](https://developer.yoprint.com/reference/task-presets/v1-pipeline-show.md): `GET /v1/api/store/{team_slug}/setting/pipeline/{hash_id}`
- [Update a task preset](https://developer.yoprint.com/reference/task-presets/v1-pipeline-update-put.md): `PUT /v1/api/store/{team_slug}/setting/pipeline/{hash_id}`
- [Update a task preset without checks](https://developer.yoprint.com/reference/task-presets/v1-pipeline-update-patch.md): `PATCH /v1/api/store/{team_slug}/setting/pipeline/{hash_id}`
- [Delete a task preset](https://developer.yoprint.com/reference/task-presets/v1-pipeline-destroy.md): `DELETE /v1/api/store/{team_slug}/setting/pipeline/{hash_id}`
- [Restore a task preset](https://developer.yoprint.com/reference/task-presets/v1-pipeline-restore.md): `PATCH /v1/api/store/{team_slug}/setting/pipeline/{id}/restore`

### [Tax presets](https://developer.yoprint.com/reference/tax-presets.md)

The taxes you apply to invoices: one rate, or named parts that add up, plus YoPrint's Auto Tax.

- [Create a tax preset](https://developer.yoprint.com/reference/tax-presets/v1-custom-tax-store.md): `POST /v1/api/store/{team_slug}/setting/tax_type`
- [List tax presets](https://developer.yoprint.com/reference/tax-presets/v1-custom-tax-index.md): `GET /v1/api/store/{team_slug}/setting/tax_type`
- [Show a tax preset](https://developer.yoprint.com/reference/tax-presets/v1-custom-tax-show.md): `GET /v1/api/store/{team_slug}/setting/tax_type/{hash_id}`
- [Update a tax preset](https://developer.yoprint.com/reference/tax-presets/v1-custom-tax-update-put.md): `PUT /v1/api/store/{team_slug}/setting/tax_type/{hash_id}`
- [Update a tax preset (same as PUT)](https://developer.yoprint.com/reference/tax-presets/v1-custom-tax-update-patch.md): `PATCH /v1/api/store/{team_slug}/setting/tax_type/{hash_id}`
- [Delete a tax preset](https://developer.yoprint.com/reference/tax-presets/v1-custom-tax-destroy.md): `DELETE /v1/api/store/{team_slug}/setting/tax_type/{hash_id}`
- [Restore a tax preset](https://developer.yoprint.com/reference/tax-presets/v1-tax-type-restore.md): `PATCH /v1/api/store/{team_slug}/setting/tax_type/{id}/restore`

### [Team invitations](https://developer.yoprint.com/reference/team-invitations.md)

Email invitations to join your team, with the permission group the person gets.

- [List invitations](https://developer.yoprint.com/reference/team-invitations/v1-invite-index.md): `GET /v1/api/store/{team_slug}/setting/invite`
- [Invite someone to the team](https://developer.yoprint.com/reference/team-invitations/v1-invite-store.md): `POST /v1/api/store/{team_slug}/setting/invite`
- [Change an invitation's permission group](https://developer.yoprint.com/reference/team-invitations/v1-invite-update-put.md): `PUT /v1/api/store/{team_slug}/setting/invite/{invite}`
- [Change an invitation with PATCH](https://developer.yoprint.com/reference/team-invitations/v1-invite-update-patch.md): `PATCH /v1/api/store/{team_slug}/setting/invite/{invite}`
- [Resend an invitation](https://developer.yoprint.com/reference/team-invitations/v1-team-invite-resend.md): `PATCH /v1/api/store/{team_slug}/setting/invite/resend/{invite}`
- [Delete an invitation](https://developer.yoprint.com/reference/team-invitations/v1-invite-destroy.md): `DELETE /v1/api/store/{team_slug}/setting/invite/{invite}`

### [YoPrint subscription](https://developer.yoprint.com/reference/yoprint-subscription.md)

Your shop's own YoPrint plan and billing: plans, checkout, card, invoices, cancellation and the billing operations that track each change.

- [List your YoPrint invoices](https://developer.yoprint.com/reference/yoprint-subscription/v1-setting-subscription-invoice-index.md): `GET /v1/api/store/{team_slug}/setting/subscription/invoice`
- [List YoPrint plans you can choose](https://developer.yoprint.com/reference/yoprint-subscription/v1-setting-subscription-plan-index.md): `GET /v1/api/store/{team_slug}/setting/subscription/plan`
- [Check a YoPrint coupon](https://developer.yoprint.com/reference/yoprint-subscription/v1-setting-subscription-check-coupon.md): `PUT /v1/api/store/{team_slug}/setting/subscription/check_coupon`
- [Get your YoPrint subscription](https://developer.yoprint.com/reference/yoprint-subscription/v1-setting-subscription-current-show.md): `GET /v1/api/store/{team_slug}/setting/subscription/current`
- [Check a failed YoPrint payment before retrying](https://developer.yoprint.com/reference/yoprint-subscription/v1-setting-subscription-current-retry-payment-preview.md): `GET /v1/api/store/{team_slug}/setting/subscription/current/retry_payment_preview`
- [Get a YoPrint billing operation](https://developer.yoprint.com/reference/yoprint-subscription/v1-setting-subscription-operation-show.md): `GET /v1/api/store/{team_slug}/setting/subscription/operation/{operation_id}`
- [Get the unfinished YoPrint billing operation](https://developer.yoprint.com/reference/yoprint-subscription/v1-setting-subscription-operation-current.md): `GET /v1/api/store/{team_slug}/setting/subscription/operation/current`
- [Preview a YoPrint plan change](https://developer.yoprint.com/reference/yoprint-subscription/v1-setting-subscription-plan-preview.md): `PUT /v1/api/store/{team_slug}/setting/subscription/plan/preview`
- [Resume your YoPrint subscription](https://developer.yoprint.com/reference/yoprint-subscription/v1-setting-subscription-current-resume.md): `PATCH /v1/api/store/{team_slug}/setting/subscription/current/resume`
- [Retry a failed YoPrint payment](https://developer.yoprint.com/reference/yoprint-subscription/v1-setting-subscription-current-retry-payment.md): `POST /v1/api/store/{team_slug}/setting/subscription/current/retry_payment`
- [Replace the card for your YoPrint subscription](https://developer.yoprint.com/reference/yoprint-subscription/v1-setting-subscription-current-update-card.md): `PUT /v1/api/store/{team_slug}/setting/subscription/current/update_card`
- [Recover a YoPrint billing operation](https://developer.yoprint.com/reference/yoprint-subscription/v1-setting-subscription-operation-recover.md): `POST /v1/api/store/{team_slug}/setting/subscription/operation/{operation_id}/recover`
- [Subscribe to or change your YoPrint plan](https://developer.yoprint.com/reference/yoprint-subscription/v1-setting-subscription-plan-checkout.md): `POST /v1/api/store/{team_slug}/setting/subscription/plan/checkout`
- [Choose the plan for your free trial](https://developer.yoprint.com/reference/yoprint-subscription/v1-setting-subscription-plan-select-trial.md): `POST /v1/api/store/{team_slug}/setting/subscription/plan/select_trial`
- [Cancel your YoPrint subscription](https://developer.yoprint.com/reference/yoprint-subscription/v1-setting-subscription-current-cancel.md): `PATCH /v1/api/store/{team_slug}/setting/subscription/current/cancel`
- [Get a link to the billing page](https://developer.yoprint.com/reference/yoprint-subscription/v1-setting-billing-portal-redirect.md): `GET /v1/api/store/{team_slug}/setting/billing_portal` (internal: built for YoPrint's own apps, don't build on it)

## Account

### [API key](https://developer.yoprint.com/reference/api-key.md)

Your personal API key.

- [Create your personal API key (refused on the public API)](https://developer.yoprint.com/reference/api-key/v1-user-api-key-create.md): `POST /v1/api/store/{team_slug}/user_api_key/create_api_key`
- [Check that your API key works for a team](https://developer.yoprint.com/reference/api-key/v1-misc-is-authenticated.md): `GET /v1/api/store/{team_slug}/is_authenticated`
- [Show your personal API key (refused on the public API)](https://developer.yoprint.com/reference/api-key/v1-user-api-key-show.md): `GET /v1/api/store/{team_slug}/user_api_key/get_api_key`
- [Replace your personal API key (refused on the public API)](https://developer.yoprint.com/reference/api-key/v1-user-api-key-reset.md): `POST /v1/api/store/{team_slug}/user_api_key/reset_api_key`