API docs by Redocly

LiteKart API (1.0.0)

Download OpenAPI specification:Download

Stateless Api

Get home data

query Parameters
store
required
string
pageId
string

Responses

Get top reviews

query Parameters
store
required
string

Responses

Initialize app

query Parameters
domain
string

Responses

Get page data

query Parameters
store
required
string

Responses

Get page data using elasticsearch

query Parameters
store
required
string

Responses

Get page data by ID

query Parameters
store
required
string

Responses

Get autocomplete suggestions

query Parameters
store
required
string
q
required
string

Responses

Get popular search terms

query Parameters
store
required
string

Responses

Add a popular search term

Add a new popular search term to the database.

Request Body schema: application/json

Popular search term to be added

term
required
string

The popular search term to add

Responses

Request samples

Content type
application/json
{
  • "term": "string"
}

Get banners using Elasticsearch

query Parameters
store
required
string

Responses

Get banners

query Parameters
store
required
string

Responses

Get banners by group

query Parameters
store
required
string
pageId
string

Responses

Get blogs

query Parameters
store
required
string

Responses

Get blogs using Elasticsearch

query Parameters
store
required
string

Responses

Get blog by ID using Elasticsearch

path Parameters
blogId
required
string
query Parameters
store
required
string

Responses

Get blog by ID

path Parameters
blogId
required
string

Responses

Get deals

query Parameters
store
required
string

Responses

Get FAQs

query Parameters
store
required
string

Responses

Get FAQs using Elasticsearch

query Parameters
store
required
string

Responses

Get FAQ by ID

path Parameters
faqId
required
string

Responses

Get countries

Responses

Get countries using elasticsearch

Responses

Get products using Elasticsearch

query Parameters
store
required
string
zip
string

Responses

Get frequently bought together products

query Parameters
store
required
string
groupId
string

Responses

Get product by ID

path Parameters
productId
required
string

Responses

Get product by ID using Elasticsearch

path Parameters
id
required
string

Responses

Get product information by ID using Elasticsearch

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "123",
  • "name": "Sample Product",
  • "description": "This is a sample product.",
  • "price": 99.99,
  • "category": "Electronics"
}

Get categories

query Parameters
store
required
string

Responses

Get all categories

query Parameters
store
required
string

Responses

Get categories for megamenu

query Parameters
store
required
string

Responses

Get categories by name using Elasticsearch

path Parameters
categoryName
required
string
query Parameters
store
required
string
children
boolean

Responses

Get categories by id using Elasticsearch

path Parameters
id
required
string
query Parameters
store
required
string
children
boolean

Responses

Get category by ID

path Parameters
categoryId
required
string

Responses

Get coupons

query Parameters
store
required
string

Responses

Get coupon by ID

path Parameters
couponId
required
string

Responses

Get gallery items

Retrieves a list of gallery items.

Responses

Get pricing information

Retrieves a list of pricing information.

Responses

Get vendors

Retrieves a list of vendors.

Responses

Get vendor by ID

Retrieves vendor details by ID.

path Parameters
id
required
string

Vendor ID

Responses

Retrieve reels

Get a list of reels

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    }
]

JWT Api

Get order items by order ID

Authorizations:
BearerAuth
path Parameters
orderId
required
string
query Parameters
store
required
string

Responses

Response samples

Content type
application/json
"{\n \"orderItems\": [\n {\n \"id\": \"64bf59061eff08f0da7a8ff2\",\n \"name\": \"Product A\",\n \"quantity\": 2,\n \"price\": 100.0\n },\n {\n \"id\": \"74be49112fde08f0da8a9fe2\",\n \"name\": \"Product B\",\n \"quantity\": 3,\n \"price\": 150.0\n }\n ]\n}\n"

Get orders using Elasticsearch

Authorizations:
BearerAuth
query Parameters
store
required
string

Responses

Response samples

Content type
application/json
"{\n \"orders\": [\n {\n \"id\": \"64bf59061eff08f0da7a8ff2\",\n \"totalAmount\": 250.0,\n \"status\": \"shipped\"\n },\n {\n \"id\": \"74be49112fde08f0da8a9fe2\",\n \"totalAmount\": 400.0,\n \"status\": \"completed\"\n }\n ]\n}\n"

Checkout Api

Add item to order

Request Body schema: application/json
orderId
string
pid
string
qty
integer
store
string

Responses

Request samples

Content type
application/json
{
  • "orderId": "string",
  • "pid": "string",
  • "qty": 0,
  • "store": "string"
}

Refresh cart

query Parameters
store
required
string

Responses

Add item to cart

query Parameters
store
required
string
Request Body schema: application/json
pid
string
vid
string
qty
integer
options
Array of any

Responses

Request samples

Content type
application/json
{
  • "pid": "string",
  • "vid": "string",
  • "qty": 0,
  • "options": [
    ]
}

Checkout using COD

Request Body schema: application/json
address
string
store
string

Responses

Request samples

Content type
application/json
{
  • "address": "string",
  • "store": "string"
}

Notify payment success

Request Body schema: application/json
paymentMode
string
orderId
string

Responses

Request samples

Content type
application/json
{
  • "paymentMode": "string",
  • "orderId": "string"
}

Checkout using Cashfree

Request Body schema: application/json
address
string
store
string

Responses

Request samples

Content type
application/json
{
  • "address": "string",
  • "store": "string"
}

Checkout using Razorpay

Request Body schema: application/json
address
string
store
string

Responses

Request samples

Content type
application/json
{
  • "address": "string",
  • "store": "string"
}

Capture payment on Razorpay

Request Body schema: application/json
rpOrderId
string

Responses

Request samples

Content type
application/json
{
  • "rpOrderId": "string"
}

Checkout using PhonePe

Request Body schema: application/json
address
string
store
string

Responses

Request samples

Content type
application/json
{
  • "address": "string",
  • "store": "string"
}

Capture payment on PhonePe

Request Body schema: application/json
rpOrderId
string

Responses

Request samples

Content type
application/json
{
  • "rpOrderId": "string"
}

Make payment using PayPal

Request Body schema: application/json
address
string
store
string

Responses

Request samples

Content type
application/json
{
  • "address": "string",
  • "store": "string"
}

Authorization Api Key

Admin Login

Request Body schema: application/json
email
string
password
string

Responses

Request samples

Content type
application/json
{
  • "email": "string",
  • "password": "string"
}

Create an API key

Request Body schema: application/json
id
string
store
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "store": "string"
}

Delete an API key by ID

path Parameters
apiKeyId
required
string

Responses

Coupon Api

User Login

Request Body schema: application/json
email
string
password
string

Responses

Request samples

Content type
application/json
{
  • "email": "string",
  • "password": "string"
}

Apply a coupon

Request Body schema: application/json
code
string
store
string

Responses

Request samples

Content type
application/json
{
  • "code": "string",
  • "store": "string"
}

Remove a coupon

query Parameters
code
required
string
store
required
string

Responses

Get coupons by store ID

path Parameters
storeId
required
string

Responses

Get admin's coupons

Responses

Create a coupon

Request Body schema: application/json
id
string
code
string
store
string
categories
Array of strings
tags
Array of strings
discountType
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "code": "string",
  • "store": "string",
  • "categories": [
    ],
  • "tags": [
    ],
  • "discountType": "string"
}

Delete a coupon by ID

path Parameters
couponId
required
string

Responses

Domain Api

Check DNS for a domain

query Parameters
domain
required
string

Responses

Get admin's domains by store

query Parameters
store
required
string

Responses

Create a domain

Request Body schema: application/json
id
string
domain
string
store
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "domain": "string",
  • "store": "string"
}

Get a domain by ID

path Parameters
domainId
required
string

Responses

Delete a domain by ID

path Parameters
domainId
required
string

Responses

Team Api

Get all teams for admin

path Parameters
page
integer
query Parameters
store
required
string

Responses

Webhook Api

Create a webhook

Request Body schema: application/json
id
string
event
string
name
string
description
string
url
string
store
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "event": "string",
  • "name": "string",
  • "description": "string",
  • "url": "string",
  • "store": "string"
}

Process webhook

path Parameters
webhookId
required
string
Request Body schema: application/json
store_name
string
user_first_name
string
user_last_name
string
email
string
domain
string
address
string

Responses

Request samples

Content type
application/json
{
  • "store_name": "string",
  • "user_first_name": "string",
  • "user_last_name": "string",
  • "email": "string",
  • "domain": "string",
  • "address": "string"
}

Reviews Api

Create a review

Request Body schema: application/json
id
string
pid
string
rating
integer
message
string
oid
string
store
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "pid": "string",
  • "rating": 0,
  • "message": "string",
  • "oid": "string",
  • "store": "string"
}

Get review summary for a product

query Parameters
pid
required
string

Responses

Delete a review by ID for admin

path Parameters
id
required
string

Responses

Get product reviews

query Parameters
pid
required
string
brandId
string
page
integer
sort
string
store
required
string

Responses

Create a review

Request Body schema: application/json
id
string
pid
string
rating
integer
message
string
oid
string
store
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "pid": "string",
  • "rating": 0,
  • "message": "string",
  • "oid": "string",
  • "store": "string"
}

Storefront API

Get user's addresses

Responses

Delete address by ID

path Parameters
id
required
string

Responses

Create a new address

Responses

Get user's cart

Responses

Send a contact us query

Responses

Send a bulk order enquiry

Responses

Get user's orders

Responses

Get orders

Responses

Get order by ID

path Parameters
id
required
string

Responses

Get order tracking details

Responses

Record successful payment page hit

Responses

Process payment using Cashfree

Responses

Capture Razorpay payment

Responses

Process payment using PayPal

Responses

Process payment using Stripe

Responses

Get available payment methods

Responses

Get products using Elasticsearch v2

Responses

Get products

Responses

Get product details by ID

path Parameters
id
required
string

ID of the product

Responses

Check discount for a product by ID

path Parameters
id
required
string

ID of the product

Responses

Get Varni product details by ID

path Parameters
id
required
string

ID of the Varni product

Responses

Get product combination details by ID

path Parameters
id
required
string

ID of the product combination

Responses

Get logged-in user details

Responses

User signup

Responses

Resend email verification

Responses

Verify email address

Responses

User logout

Responses

Get OTP (One-Time Password)

Responses

Verify OTP (One-Time Password)

Responses

Update user profile

Responses

Request password reset

Responses

Reset user password

Responses

Change user password (admin)

Responses

Get user's wishlist

Responses

Check if item is in wishlist

Responses

Toggle wishlist item

Responses

Move unavailable items to wishlist

Responses

Create a new prescription

Responses

Get user's prescriptions

Responses

Delete prescription by ID

path Parameters
id
required
string

Responses