Skip to main content

​
Welcome

The Salesive Apps API is what your installed app calls to read and write a merchant’s store data — orders, catalog, customers, notifications, and more. You authenticate with the app access token (prefixed app_) your app receives when a merchant installs it, and every endpoint is gated by the OAuth scopes that merchant granted. 
https://api.salesive.com/api/v1
The target store is bound to your token server-side from the installation. You never send a shop id — no x-shop-id header — so a token can only ever touch the one store it was installed on. Use the Try it playground on any endpoint page: paste your app_ token as the Bearer credential and call the live endpoint.

​
Three things, don’t confuse them

Apps API (this)Store APIApp management
Wherehttps://api.salesive.comhttps://store.salesive.comSalesive dashboard
WhatAn installed app reads/writes store dataA storefront serves shoppers (products, cart, checkout)Create, edit & submit your app
Authapp_ access token (Bearer)Shopper JWT / guest sessionYour dashboard login
  • The Store API (store.salesive.com) is a different API for storefronts, not for apps.
  • Managing your app — registering it, editing its listing, requesting scopes, submitting it for review — happens in the Salesive dashboard Developer console, not through an API.

​
Authentication

Send your app access token as a Bearer header on every request: 
Authorization: Bearer app_<your-app-access-token>
You obtain this token through the OAuth install flow when a merchant installs your app — see Install your app. The token is bound to that one installation (one store); uninstalling it revokes the token immediately.

​
Scopes gate everything

Every endpoint requires a specific scope that the merchant granted at install. A call without the required scope is rejected with 403. Request only the scopes your app needs — see Scopes & permissions for the full catalog and what each unlocks. 
# List the installed store's orders — no shop id needed; the token is store-bound.
curl https://api.salesive.com/api/v1/orders \
  -H "Authorization: Bearer app_<your-app-access-token>"
A successful response uses the standard envelope: 
{
  "status": 200,
  "success": true,
  "message": "Orders retrieved",
  "data": { "orders": [], "pagination": { "total": 0, "page": 1, "limit": 10, "pages": 0 } }
}

​
What you can call

Each resource group is gated by its matching READ_* / WRITE_* scope (a few are read-only for apps). Open any group in the sidebar to see its endpoints and run them from the Try it playground.

Orders

List, inspect, create POS orders, and update orders.

Catalog

Products, menu items (foods) and services — full CRUD.

Customers

Read and manage the store’s customers.

Categories

Organize the catalog into categories.

Discounts

Coupons and discount codes.

Blogs

Storefront blog posts.

Notifications

Read the merchant’s notifications and send new ones.

Emails

Email the merchant, customers, or subscribers.

Tasks & Notes

Operational tasks and notes.

Scripts

Custom storefront scripts and tracking.

Comments

Reply to and moderate storefront comments.

Shipping & Shipday

Shipping options, shipments and Shipday dispatch.

Domains, Roles & Payouts

Read-only access to store domains, roles and payouts.

KYC

Read status and start identity verification.