> ## Documentation Index
> Fetch the complete documentation index at: https://docs.shoply.gg/llms.txt
> Use this file to discover all available pages before exploring further.

# Permissions

> What each permission lets a key do, group by group

A key carries the permissions you tick when you make it, and reaches a route only when it carries that route's permission. Each route's page says which it needs. You can change a key's permissions afterwards, under **Developers** in the dashboard.

Give a key only what its job needs. A script that reads orders for a report has no use for `orders.refund`.

## Store

| Permission | In the dashboard | What it reaches |
| - | - | - |
| `store.read` | Read Store | The store's details, branding and settings. |
| `store.write` | Change Store | Change the store's details, branding, address and domain. |
| `payments.read` | Read Payment Methods | Which payment methods are connected and switched on, the store's custom payment methods, and how long an unpaid order is kept. Never their credentials. |
| `payments.write` | Change Payment Methods | Switch payment methods on and off and sort them, set how long an unpaid order is kept, and add, change and delete custom payment methods. Never their credentials. |
| `routing.read` | Read Payment Routing | Payment Routing's settings, the card processors in it with their shares, caps and figures, and its rules. |
| `routing.write` | Change Payment Routing | Switch Payment Routing on and off, add, change, sort and remove its processors and rules, and put a paused processor back. |
| `analytics.read` | Read Analytics | Visits, revenue figures, the live view and search reports. |

## Catalogue

| Permission | In the dashboard | What it reaches |
| - | - | - |
| `products.read` | Read Products | Products, their variants, pictures and stock counts. |
| `products.write` | Change Products | Add, change, sort and delete products, variants and pictures. |
| `stock.read` | Read Stock | The license keys and files a variant has in stock, unsold ones included. |
| `stock.write` | Change Stock | Add, replace and remove a variant's license keys and files. |
| `categories.read` | Read Categories | Product categories and what is in them. |
| `categories.write` | Change Categories | Add, change, sort and delete product categories. |
| `upsells.read` | Read Upsells | Add-ons, cart and checkout offers, upgrades and what is bought together, with their figures. |
| `upsells.write` | Change Upsells | Add, change, switch, sort and delete upsells. |
| `subscriptions.read` | Read Subscriptions | Subscriptions with their buyers, history and renewals, which options are sold as subscriptions, and the settings. |
| `subscriptions.write` | Change Subscriptions | Cancel, pause and resume subscriptions, add free days, email a renewal again, and choose which options are subscriptions and the settings. |

## Orders

| Permission | In the dashboard | What it reaches |
| - | - | - |
| `orders.read` | Read Orders | Orders with what was bought, what was delivered and the buyer's details. |
| `orders.write` | Change Orders | Write an order's note. |
| `orders.fulfil` | Deliver Orders | Mark an order as paid, deliver it again and send its email again, and approve or reject a payment made with a custom payment method, with its proof of payment. |
| `orders.refund` | Refund Orders | Refund an order, to what paid for it or as store credit. |
| `invoices.read` | Read Invoices | Invoices the store has raised. |
| `invoices.write` | Raise Invoices | Raise an invoice for a buyer to pay, and send it. |
| `reviews.read` | Read Reviews | Reviews buyers have left. |

## Customers

| Permission | In the dashboard | What it reaches |
| - | - | - |
| `customers.read` | Read Customers | Customers, what they have spent and their balance. |
| `customers.write` | Change Customers | Add a customer, and blacklist or clear one. |
| `customers.balance` | Change Balances | Add to, take from or set a customer's store balance. |
| `customers.tags` | Change Tags | Add, change and delete the store's customer tags, put them on customers and take them off, and change VIP and Disputed Before. |
| `affiliates.read` | Read Affiliates | Affiliates, what their links led to, their balances and payouts. |
| `affiliates.write` | Change Affiliates | Add, change and remove affiliates, and change the programme's settings. |
| `tickets.read` | Read Support Tickets | Support tickets with their conversations and pictures, and whether the store takes them. |
| `tickets.write` | Answer Support Tickets | Reply to support tickets, resolve and reopen them, and switch Support Tickets on and off. |
| `affiliates.payouts` | Answer Payouts | Mark a payout as paid or decline it, change an affiliate's balance, and ask for a payout or take one back in an affiliate's name. |

## Marketing

| Permission | In the dashboard | What it reaches |
| - | - | - |
| `coupons.read` | Read Coupons | Coupons, their categories and the coupon pop-up. |
| `coupons.write` | Change Coupons | Add, change and delete coupons, their categories and the pop-up. |
| `sales.read` | Read Sales | Sales and the products each one covers. |
| `sales.write` | Change Sales | Add, change, switch and delete sales. |
| `blog.read` | Read Blog | Blog categories and posts, drafts included. |
| `blog.write` | Change Blog | Add, change, publish and delete blog categories and posts. |
| `seo.read` | Read Search Settings | Search settings, redirects, broken links and the sitemap. |
| `seo.write` | Change Search Settings | Change search settings, redirects and the sitemap's rules. |
| `recovery.read` | Read Cart Recovery | Cart Recovery's settings and figures, and the checkouts buyers left with where each stands. |
| `recovery.write` | Change Cart Recovery | Switch Cart Recovery on and off, and change its three emails and the second one's coupon. |
| `marketing.read` | Read Email Marketing | Win-Back's settings and figures, the buyers it writes to, and who said yes to the store's emails at checkout. |
| `marketing.write` | Change Email Marketing | Switch Win-Back and asking at checkout on and off, change Win-Back's two emails and who gets them, and unsubscribe a subscriber. |
| `emails.read` | Read Email Templates | The emails buyers get in the store's name as the store has written them, their originals, and a preview of any of them. |
| `emails.write` | Change Email Templates | Change the emails buyers get in the store's name, their CSS and their subjects, and put any of them back to the original. |

## Fraud Shield

| Permission | In the dashboard | What it reaches |
| - | - | - |
| `fraud.read` | Read Fraud Protection | The blacklist, its settings and what it has stopped. |
| `fraud.write` | Change Fraud Protection | Add, change and remove blacklist rules, and change the settings. |
| `disputes.read` | Read Disputes | Disputes on the store's payments, what Shoply recorded about each order, the answers, their PDFs and the dispute settings. |
| `disputes.write` | Answer Disputes | Save, submit and accept answers to disputes, mark them as answered, add their files, hide what a disputed order delivered, and change the dispute settings. A submitted or accepted answer cannot be taken back. |

## Finance

| Permission | In the dashboard | What it reaches |
| - | - | - |
| `finance.read` | Read Finance | Profit, accounting, tax settings and their exports. |
| `finance.write` | Change Finance | Product costs, payment fee rates and tax settings. |
| `expenses.read` | Read Expenses | Expenses, their categories, recurring ones and rules. |
| `expenses.write` | Change Expenses | File, change and delete expenses and what organises them. |

## Storefronts

| Permission | In the dashboard | What it reaches |
| - | - | - |
| `storefronts.read` | Read Storefronts | The store's storefronts, and an export of one. |
| `storefronts.write` | Change Storefronts | Add, import, rename and delete storefronts, and choose the live one. |

## Developers

| Permission | In the dashboard | What it reaches |
| - | - | - |
| `webhooks.read` | Read Webhooks | Webhook endpoints and the record of what was sent to them. |
| `webhooks.write` | Change Webhooks | Add, change, test and delete webhook endpoints. A webhook is sent the store's orders, with buyers' emails and what they were delivered. |
| `logs.read` | Read API Requests | The record of requests made with the store's API keys. |


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.