quikshope_client v1.0.6

QuikShope Client SDK

Class definition availlable in the SDK , which can be returned by functions or used internally will be dicussed in the later part

Install QuikShope Client Library

Install by npm

npm i quikshope_client

If you are not using any frontend framework or nodejs , then prefer to use the below method to import library.

To install directly in HTML, use the cdn link provided below

<script src="https://cdn.jsdelivr.net/gh/GiantsMeet/quikshope_client@main/dist/client.min.js"></script>

Import Library

In case of NodeJS / Frontend framework , the standard ES5 & ES6 import strategy will work

// For type "module"
const client = require("quikshope_client")

// For type "commonjs"
import client from "quikshope_client"

// For HTML javascript
let client = QuikShopeClient;

Initialize Library

For initialization, the username of the shop needed , that can be found in dashboard of seller

client.init("shop2")

Authenticate User Customer

Process flow for authentication 1. Create object of AuthenticateUser 1. Send OTP 2. Verify OTP If failed, resent OTP 3. Generate Auth Token or Generate Customer Object

Create AuthenticateUser object

The 10 digit phone number of customer without country code need to be pass as arguments.

Note : If the customer has not any account, account will be created , there is no need to check existance of customer account

const auth = new client.authenticate("9999999999")

Send OTP

await auth.sendOtp()

In return , we will receive a list of two items in the below format

[success (boolean), message(string)]

If success is true that's indicate OTP has been sent , in same way we will get message which can be shown to the user

Send OTP

await auth.sendOtp()

In return , we will receive a list of two items in the below format

[success (boolean), message(string)]

If success is true that's indicate OTP has been sent , in same way we will get message which can be shown to the user

Resend OTP

await auth.resendOtp()

In return , we will receive a list of two items in the below format

[success (boolean), message(string)]

If success is true that's indicate OTP has been resent , in same way we will get message which can be shown to the user

Verify OTP

It takes 6 digit otp as parameter

await auth.verifyOtp("111111")

In return , we will receive a list of two items in the below format

[success (boolean), message(string)]

If success is true that's indicate OTP has been verified so that we can proceed for generate auth token or customer object , in same way we will get message which can be shown to the user

Generate Auth Token

await auth.generateToken()

In return , we will receive a list of two items in the below format

[success (boolean), message(string), token(string)]

If success is true that's indicate user has been verified through otp verification and received auth token , in same way we will get message which can be shown to the user. the 3rd parmeter we will receive the Auth Token

There is various method to store the token in clientside 1. Cookie 2. LocalStorage 3. IndexedDB

Generate Customer Object

await auth.generateTokenAndCustomerDetils()

In return , we will receive a list of two items in the below format

[success (boolean), message(string), customer(Customer Object)]

If success is true that's indicate user has been verified through otp verification and received customer object , in same way we will get message which can be shown to the user. If success is false then the customer 3rd parameter will be null

Customer Object

The members of teh customer object

• id
• name
• phone_no
• address
• pincode
• country
• country_code
• token

Intialize a customer object

To initialize a customer object , the authentication token of the customer needed which have been discussed in Authenticate User section

const customer = new client.customer("authentication token")

Fetch all details of customer from server

await customer.fetchDetails()

In return , we will receive a list of two items in the below format

[success (boolean), message(string)]

If success is true that's indicate that customer details has been fetch successfully , in same way we will get message which can be shown to the user.

To get the customer details in JSON format,

customer.toJSON()

Update Customer Details

Note that, Mobile number of customer is not allowed. Only change of name, address, pincode is allowed

// all 3 parameters are required
await customer.updateDetails("Tanmoy", "Kolkata", 700032)

In return , we will receive a list of two items in the below format

[success (boolean), message(string)]

If success is true that's indicating that customer details has been updated successfully , in same way we will get message which can be shown to the user.

Fetch All Orders

await customer.fetchAllOrders()

In return , we will receive a list of three items in the below format

[success (boolean), message(string), List<Order>]

Get Particular Order By ID

Pass order id as argument

await customer.getOrderById(1)

In return , we will receive a list of three items in the below format

[success (boolean), message(string), Order]

Checkout

For checkout we need to collect the checkout details

• Instance of Shop
• Products cart map Preferred format below

// Schema
{
	"<product_id>" : quantity
}
// Example
{
    "1": 1,
    "2": 8,
    "6": 5
}

• Promo code
• Delivery mode home_delivery, self_pickup, table_order, advanced_table_order
• Payment mode pod or online
• Table Id Required for tale_order / advanced_table_order
• Table Time Slot Required for advanced_table_order
• Table Order Date Required for advanced_table_order

await customer.checkout(shop, {
    "1": 1,
    "2": 8,
    "6": 5
}, "YTUI", "home_delivery", "online", "" , "", "")

In return , we will receive a list of three items in the below format

[success (boolean), message(string), data(JSON)]

In JSON response, online_payment_redirection is true, then redirect user to redirection_link for payment. If online_payment_redirection is false , then either redirect user to redirection_link as default order confirmation page or fetch order details by order_id and show custom UI

Product Class

Data members

• id
• category_id
• title
• images List of images in multiple sizes and format
• price
• discounted_price
• dicount_percentage
• description
• in_stock
• is_pinned

ProductCategory Class

Data members

• id
• picture
• title

Functions

• fetchProducts : Will fetch all the product under this category

await category.fetchProducts()

In return we will get

[status(boolean), message(string), List<Product>]

Order Class

Data members

• products List
• promo_code null or Instance of PromoCode
• latest_status Instance of OrderStatus
• all_statues List
• address String
• pincode String
• country String
• country_code String
• home_delivery_charge
• home_delivery_details Instance of HomeDelivery
• self_pickup_details Instance of SelfPickup
• table_order_details Instance of TableOrder
• advanced_table_order_details Instance of AdvancedTableOrder

Inventory

Fetch All Categories

await client.inventory.FetchAllCategroies()

In return

[status(boolean), message(string), List<ProductCategory>]

Get Category By ID

await client.inventory.GetCategoryById("category_id")

In return

[status(boolean), message(string), ProductCategory]

Fetch All Products

await client.inventory.FetchAllProducts()

In return

[status(boolean), message(string), List<ProductCategory>, List<Product>]

Get Product By Id

await client.inventory.FetchAllProducts()

In return

[status(boolean), message(string), Product]

Search Products By Query

await client.inventory.SearchProducts("boat headphone")

In return

[status(boolean), message(string), List<ProductCategory>, List<Product>]

Filter Products By Selected Products Ids

await client.inventory.SearchProductsByIdsList([1,2,3])

In return

[status(boolean), message(string), List<ProductCategory>, List<Product>]

Shop

Data Members

• profile Instance of ShopProfile
• contact_information Instance of ShopContact
• address Instance of ShopAddress
• account_details Instance of ShopAccount
• config Instance of ShopConfig
• promo_codes List

Functions

• fetch_details() : This will load all the information regarding that shop.

const shop = new client.shop()
console.log(await shop.fetch_details())

In return

[status(boolean), message(string)]