local_shipping

১২০০ টাকার উপরে অর্ডার করলেই ফ্রী ডেলিভারী

Khan Signature
favorite
Menu
search
card_giftcard Gift Cards local_offer Special Offers
code v2.0.0 — REST API

Developer API

Build on the Flint Commerce Engine. Integrate commerce capabilities directly into your applications with our powerful, RESTful API.

bolt Get Started key Authentication

01 Overview

The Flint Shop Engine REST API provides programmatic access to the core commerce platform. It allows you to manage products, orders, categories, customers, inventory, and more through standard HTTP requests.

Designed for performance and simplicity, the API returns JSON responses and supports full CRUD operations on all major resources. Whether you are building a custom storefront, a mobile app, a marketplace integration, or automating back-office workflows, the Flint API gives you the building blocks you need.

rocket_launch

100ms Avg Response

Globally distributed edge caching

verified

99.99% Uptime SLA

Enterprise-grade reliability

lock

AES-256 Encrypted

All data in transit and at rest

02 Authentication

All API requests require authentication via an API key passed in the request header. You can generate API keys from your admin dashboard under Settings → Developer API Keys.

Authentication Header

Authorization: Bearer your_api_key_here

info API Key Scopes

Each API key is scoped to specific permissions (read, write, admin). You can create multiple keys with different scopes for different applications. Store your keys securely — they are shown only once at creation time.

03 Base URL

All API endpoints are relative to the following base URL. All requests must use HTTPS.

https://api.flintshopengine.com/v1

Responses are formatted in JSON. All timestamps are in ISO 8601 format and UTC timezone. Paginated endpoints return the following structure:

{
  "data": [],
  "meta": {
    "current_page": 1,
    "per_page": 25,
    "total": 142,
    "last_page": 6
  }
}

04 Products API

Manage your product catalog programmatically. The Products API supports full CRUD operations, inventory tracking, variant management, and media uploads.

GET /api/v1/products

List all products with optional filtering, sorting, and pagination.

GET https://api.flintshopengine.com/v1/products
?page=1&per_page=25&category=electronics&sort=created_at
Example Response
{
  "data": [{
    "id": 1,
    "name": "Wireless Headphones",
    "sku": "WH-1000XM5",
    "price": 349.99,
    "stock": 42,
    "status": "active",
    "created_at": "2024-01-15T10:30:00Z"
  }],
  "meta": { "current_page": 1, "per_page": 25, "total": 128, "last_page": 6 }
}
POST /api/v1/products

Create a new product. Returns the created product object.

POST https://api.flintshopengine.com/v1/products

// Request Body
{
  "name": "Wireless Headphones",
  "sku": "WH-1000XM5",
  "price": 349.99,
  "category_id": 5,
  "stock": 100,
  "description": "Premium noise-canceling headphones"
}
GET /api/v1/products/{id}

Retrieve a single product by its ID, including variants and media.

GET https://api.flintshopengine.com/v1/products/42
PUT /api/v1/products/{id}

Update an existing product. Only include fields that need to change.

PUT https://api.flintshopengine.com/v1/products/42

// Request Body
{
  "price": 299.99,
  "stock": 85
}
DELETE /api/v1/products/{id}

Delete a product permanently. Returns a confirmation message.

DELETE https://api.flintshopengine.com/v1/products/42

// Response
{ "message": "Product deleted successfully" }

05 Orders API

Manage orders, process refunds, and track fulfillment status in real time.

GET /api/v1/orders

List all orders. Supports filtering by status, date range, and customer.

GET https://api.flintshopengine.com/v1/orders
?status=processing&from=2024-01-01&to=2024-12-31
Example Response
{
  "data": [{
    "id": 1024,
    "customer": { "id": 5, "name": "Jane Doe" },
    "total": 524.50,
    "status": "processing",
    "items": 3,
    "created_at": "2024-06-12T14:22:00Z"
  }]
}
GET /api/v1/orders/{id}

Retrieve detailed order information including line items, payments, and shipping details.

GET https://api.flintshopengine.com/v1/orders/1024

06 Categories API

Organize your product catalog with a flexible, hierarchical category system.

GET /api/v1/categories

Retrieve the full category tree with nested children.

GET https://api.flintshopengine.com/v1/categories
Example Response
{
  "data": [{
    "id": 1,
    "name": "Electronics",
    "slug": "electronics",
    "children": [{
      "id": 2,
      "name": "Headphones",
      "slug": "headphones",
      "product_count": 42
    }]
  }]
}

07 Rate Limits

Rate limiting is applied per API key to ensure fair usage and platform stability. Limits are enforced on a rolling 60-second window.

Free Plan

100

requests per minute

Pro Plan

1,000

requests per minute

speed Rate Limit Headers

Every API response includes the following headers: X-RateLimit-Limit, X-RateLimit-Remaining, and X-RateLimit-Reset. When exceeded, the API returns a 429 Too Many Requests status.

08 SDKs & Libraries

Official client libraries make integrating with the Flint API faster and more reliable.

javascript

JavaScript / Node.js

npm install @flintcommerce/api
View on npm →
python

Python

pip install flintcommerce
View on PyPI →
php

PHP

composer require flintcommerce/api-client
View on Packagist →
terminal

cURL / CLI

curl -H "Authorization: Bearer $KEY" ...
View Examples →

09 Getting Started

Follow these steps to make your first API call in under 5 minutes:

  1. Generate an API Key

    Navigate to Settings → Developer → API Keys in your admin dashboard and click Create New Key. Give it a name and select the appropriate permissions.

  2. Make Your First Request

    Use any HTTP client to send a request:

    # Using cURL
    curl -H "Authorization: Bearer YOUR_API_KEY" \
      https://api.flintshopengine.com/v1/products

  3. Explore the Response

    Your first response will return a paginated list of products. Use the meta object to navigate through pages.

  4. Check Your Rate Limit

    Inspect the X-RateLimit-Remaining response header to track your usage.

Start Building Today

Get your free API key and start integrating the Flint Commerce Engine into your applications. No credit card required.

vpn_key Get API Key description Read the Docs