Back to Docs

API Reference

REST API documentation for developers

Introduction

The Cartaisy API is a RESTful API that allows you to integrate your applications with the Cartaisy platform. All API requests are made over HTTPS and return JSON responses.

Base URL: https://api.cartaisy.com/v1

Authentication

All API requests require authentication using JWT (JSON Web Tokens). Include your access token in the Authorization header:

Authorization: Bearer your_access_token

Tokens expire after 24 hours. Use the refresh endpoint to obtain new tokens.

API Endpoints

Authentication

/api/v1/auth/*

User authentication, token management, and session handling.

POST /loginPOST /registerPOST /refreshPOST /logout

Products

/api/v1/products/*

Retrieve and manage product data synced from Shopify.

GET /productsGET /products/:idGET /products/search

Orders

/api/v1/orders/*

Access order data and manage order status.

GET /ordersGET /orders/:idPOST /ordersPATCH /orders/:id

Customers

/api/v1/customers/*

Customer profiles, addresses, and preferences.

GET /customersGET /customers/:idPATCH /customers/:id

Push Notifications

/api/v1/notifications/*

Send and manage push notification campaigns.

POST /notifications/sendGET /notifications/historyGET /notifications/stats

Analytics

/api/v1/analytics/*

Access analytics data and performance metrics.

GET /analytics/dashboardGET /analytics/revenueGET /analytics/sessions

Full Documentation Coming Soon

We're working on comprehensive API documentation with code examples, SDKs, and interactive playground. Stay tuned for updates.

Contact us for API access →

Rate Limits

API requests are rate-limited to ensure fair usage:

  • Standard: 100 requests per minute
  • Pro: 500 requests per minute
  • Enterprise: Custom limits available