Public API overview
Read, create, update and delete your quotes from your own server with the SA Request a Quote Public API.
Questi contenuti non sono ancora disponibili nella tua lingua.
The Public API lets your own software work with the quotes in your store. Use it to copy new quotes into a CRM or ERP, create a quote from another system, mark a quote as purchased when an order is closed, or clean up quotes in bulk.
It is a server-to-server REST API: you send an HTTPS request with an API key, and get JSON back. Every response is the same shape, so it is easy to wire into tools such as Make, n8n or your own code.
What you can do
Section titled “What you can do”| Area | What it covers | Permission |
|---|---|---|
| Quotes — View | List quotes, and read one quote with its customer, line items, answers and attachments. | quotes:read |
| Quotes — Create | Create a quote the same way a storefront submission does. | quotes:create |
| Quotes — Update | Change a quote's status and add an internal note. | quotes:update |
| Quotes — Delete | Delete one quote, or up to 50 at a time. | quotes:delete |
| Quote form — View | Read the fields of your quote form and the key of each field. | form:read |
Plan requirement
Section titled “Plan requirement”The Public API is available on the PRO plan and above. On other plans the Public API page in the app shows a padlock line, and any request returns the error plan_upgrade_required. See Plan comparison.
Base URL
Section titled “Base URL”All endpoints share one base address:
https://quote.samita.io/api/public/v1You can copy it from Advanced settings > Public API > Base URL. v1 is the version. Fields in v1 are not renamed or removed, so an integration you build today keeps working.
Endpoints
Section titled “Endpoints”| Method | Path | Permission | What it does |
|---|---|---|---|
| GET | /ping | none | Checks your key and shows the store and the key's permissions. |
| GET | /form | form:read | Lists the quote form's fields and their keys. |
| GET | /quotes | quotes:read | Lists quotes, newest first. |
| GET | /quotes/{id} | quotes:read | Returns one quote in full. |
| POST | /quotes | quotes:create | Creates a quote. |
| PATCH | /quotes/{id} | quotes:update | Changes status and adds a note. |
| DELETE | /quotes/{id} | quotes:delete | Deletes one quote. |
| POST | /quotes/bulk_delete | quotes:delete | Deletes up to 50 quotes. |
Ground rules
Section titled “Ground rules”- Server only. A request that carries a browser
Originheader is refused withcors_not_supported. Never put an API key in a web page or a mobile app. - Your store only. A key can only see and change the quotes of the store that created it.
- Keys are secret. Treat an API key like a password. The app shows it once, when you create it.
- Limits apply. Requests are limited per minute. See Requests and responses.
Read next
Section titled “Read next”- Create an API key — make a key and choose what it can do
- Authentication — send the key with every request
- Make your first call — a working request in a minute
- Requests and responses — format, paging and limits
- Errors — every error code
- Quotes and Quote form — the endpoints in detail