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 for men

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

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 FAQ by ID

path Parameters
faqId
required
string

Responses

Get countries

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 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 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

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"
}

Delete a domain by ID

path Parameters
domainId
required
string

Responses

Team Api

Webhook Api

Reviews Api