Skip to main content

Welcome

The Salesive Store API provides a complete e-commerce solution for managing products, customer sessions, shopping carts, orders, shipping, and merchandising. Use this reference to build storefronts, mobile apps, or custom integrations that mirror production Salesive environments.
Quick integration: Use the salesive-api-axios package for typed Axios wrappers with automatic environment detection and token management. Perfect for React, Next.js, Nuxt, and Vite projects.

Base URL

https://store.salesive.com/api/v1
All examples use the production host; replace the domain if you are targeting a sandbox or environment-specific endpoint.

Authentication

The Salesive Store API uses JWT (JSON Web Token) authentication for protected endpoints.

Guest Sessions

Create anonymous guest users via POST /auth/ghost to enable browsing, cart management, and wishlist features without registration.

Authenticated Users

For full access, users authenticate via email with OTP (one-time password) verification:
  1. Send OTP to email: POST /auth/authenticate
  2. Verify OTP: POST /auth/verify
  3. Use the returned JWT token in the Authorization header as Bearer <token>

Public Endpoints

Product listings, banners, and blog content are publicly accessible without authentication.

Headers

HeaderDescription
AuthorizationJWT token as Bearer <token> for authenticated endpoints.
Content-Typeapplication/json when sending JSON payloads.
x-shop-idStorefront identifier to scope requests to a specific shop.

Rate limits

Salesive applies per-store throttling. If your integration receives 429 Too Many Requests, retry with exponential backoff. Contact support if you need higher throughput.

Collections

  • Authentication — Create guest sessions or authenticate users with email OTP verification.
  • Banners — Retrieve merchandising banners for storefronts.
  • Blogs — Access editorial content and announcements.
  • Cart — Manage shopping cart items, quantities, and product variants.
  • Comments — Engage users with product comments, replies, and likes.
  • Country — Retrieve countries, states, and cities information.
  • Coupons — Verify and apply discount coupons to orders.
  • Newsletter — Manage email subscriptions and updates.
  • Orders — Create orders from cart, track order status, and manage shipments.
  • Payments — Retrieve configured payment methods for the shop.
  • Products — List, filter, search, and retrieve product information with variants.
  • Push Subscriptions — Enable browser push notifications for order updates and marketing.
  • Reviews — Collect and display product ratings and feedback from verified customers.
  • Shipping — Get shipping options and track shipments for orders.
  • Shipping Address — Save, retrieve, and manage delivery addresses with geocoding support.
  • Shop — Access shop-specific branding, settings, and general information.
  • Wishlist — Save and manage customer wishlists across sessions.

Address Intelligence

The API integrates with Geoapify for enhanced address management:
  • Reverse Geocoding — Convert coordinates to addresses
  • Address Autocomplete — Real-time address suggestions as users type
Continue to the endpoint guides for detailed request/response examples and implementation patterns.