Info
Welcome to the generated API reference. Get Postman Collection
Authentication
APIs for Authenticating users
api/v1/auth/refresh
Requires authentication
Example request:
curl -X GET \
-G "http://localhost/api/v1/auth/refresh" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"http://localhost/api/v1/auth/refresh"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
Example response (401):
{
"message": "Token not provided"
}
HTTP Request
GET api/v1/auth/refresh
Allow Users to register for an account
Example request:
curl -X POST \
"http://localhost/api/v1/auth/register" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"name":"Micheale Mwangi","email":"mike@gmail.com","phone":"0701828384","Type":"Wholesaler,retailer,customer or rider","County":"Nairobi county","Password":"*******","Password_confirmation":"*******"}'
const url = new URL(
"http://localhost/api/v1/auth/register"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"name": "Micheale Mwangi",
"email"<EMAIL_ADDRESS>"phone": "0701828384",
"Type": "Wholesaler,retailer,customer or rider",
"County": "Nairobi county",
"Password": "*******",
"Password_confirmation": "*******"
}
fetch(url, {
method: "POST",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));
Example response (200):
{
"status": "success",
"data": {
"name": "shem",
"email"<EMAIL_ADDRESS>"phone": "0715511302",
"county": "uasingishu",
"role": "customer",
"longitude": "0.01919191",
"latitude": "9.08888884",
"location_name": "eldoret",
"address": "30100",
"updated_at": "2020-11-05T08:09:18.000000Z",
"created_at": "2020-11-05T08:09:18.000000Z",
"id": 16
}
}
HTTP Request
POST api/v1/auth/register
Body Parameters
| Parameter | Type | Status | Description |
|---|---|---|---|
name |
string | required | full name of the user . |
email |
required | email address of the user . | |
phone |
integar | required | phone number for the user . |
Type |
string | required | the account the user intend to reqister . |
County |
string | required | County residence of the user . |
Password |
Password | required | user's password for authentication . |
Password_confirmation |
Password | required | password for authentication . |
Allow registered users to login
Example request:
curl -X POST \
"http://localhost/api/v1/auth/login" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"email":"mike@gmail.com","Password":"*******"}'
const url = new URL(
"http://localhost/api/v1/auth/login"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"email"<EMAIL_ADDRESS>"Password": "*******"
}
fetch(url, {
method: "POST",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));
Example response (200):
null
HTTP Request
POST api/v1/auth/login
Body Parameters
| Parameter | Type | Status | Description |
|---|---|---|---|
email |
required | email address of the user . | |
Password |
Password | required | user's password for authentication . |
Create a new Rider's account
[Insert optional longer description of the API endpoint here.]
Example request:
curl -X POST \
"http://localhost/api/v1/auth/createRider" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"http://localhost/api/v1/auth/createRider"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "POST",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
HTTP Request
POST api/v1/auth/createRider
Verifying Rider's account
[Insert optional longer description of the API endpoint here.]
Example request:
curl -X POST \
"http://localhost/api/v1/auth/verify_phone" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"http://localhost/api/v1/auth/verify_phone"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "POST",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
HTTP Request
POST api/v1/auth/verify_phone
Login function of rider
Example request:
curl -X POST \
"http://localhost/api/v1/auth/loginRider" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"Phone":"0715929293","Password":"********"}'
const url = new URL(
"http://localhost/api/v1/auth/loginRider"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"Phone": "0715929293",
"Password": "********"
}
fetch(url, {
method: "POST",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));
Example response (200):
null
HTTP Request
POST api/v1/auth/loginRider
Body Parameters
| Parameter | Type | Status | Description |
|---|---|---|---|
Phone |
Phone | required | phone of the Rider . |
Password |
Password | required | email address of the user . |
Allows a rider to reset passwod
[Insert optional longer description of the API endpoint here.]
Example request:
curl -X POST \
"http://localhost/api/v1/auth/resetPasswordRider" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"http://localhost/api/v1/auth/resetPasswordRider"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "POST",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
HTTP Request
POST api/v1/auth/resetPasswordRider
api/v1/auth/user
Requires authentication
Example request:
curl -X GET \
-G "http://localhost/api/v1/auth/user" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"http://localhost/api/v1/auth/user"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
Example response (401):
{
"message": "Token not provided"
}
HTTP Request
GET api/v1/auth/user
Allow authenticated users to log out
[Insert optional longer description of the API endpoint here.]
Example request:
curl -X POST \
"http://localhost/api/v1/auth/logout" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"http://localhost/api/v1/auth/logout"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "POST",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
HTTP Request
POST api/v1/auth/logout
Brands
APIs for Managing Brands
Display a listing of the resource.
Example request:
curl -X GET \
-G "http://localhost/api/v1/admin/shopLocal/brands" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"http://localhost/api/v1/admin/shopLocal/brands"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
Example response (401):
{
"message": "Please, attach a Bearer Token to your request",
"success": false
}
HTTP Request
GET api/v1/admin/shopLocal/brands
Store a newly created resource in storage.
Example request:
curl -X POST \
"http://localhost/api/v1/admin/shopLocal/brands" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"http://localhost/api/v1/admin/shopLocal/brands"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "POST",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
HTTP Request
POST api/v1/admin/shopLocal/brands
Display the specified resource.
Example request:
curl -X GET \
-G "http://localhost/api/v1/admin/shopLocal/brands/1" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"http://localhost/api/v1/admin/shopLocal/brands/1"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
Example response (401):
{
"message": "Please, attach a Bearer Token to your request",
"success": false
}
HTTP Request
GET api/v1/admin/shopLocal/brands/{brand}
Update the specified resource in storage.
Example request:
curl -X PUT \
"http://localhost/api/v1/admin/shopLocal/brands/1" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"http://localhost/api/v1/admin/shopLocal/brands/1"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "PUT",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
HTTP Request
PUT api/v1/admin/shopLocal/brands/{brand}
PATCH api/v1/admin/shopLocal/brands/{brand}
Remove the specified resource from storage.
Example request:
curl -X DELETE \
"http://localhost/api/v1/admin/shopLocal/brands/1" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"http://localhost/api/v1/admin/shopLocal/brands/1"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "DELETE",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
HTTP Request
DELETE api/v1/admin/shopLocal/brands/{brand}
api/v1/admin/shopLocal/my-brands/{id}
Example request:
curl -X GET \
-G "http://localhost/api/v1/admin/shopLocal/my-brands/1" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"http://localhost/api/v1/admin/shopLocal/my-brands/1"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
Example response (401):
{
"message": "Please, attach a Bearer Token to your request",
"success": false
}
HTTP Request
GET api/v1/admin/shopLocal/my-brands/{id}
api/v1/retailer/dashboard/my-brands/{id}
Example request:
curl -X GET \
-G "http://localhost/api/v1/retailer/dashboard/my-brands/1" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"http://localhost/api/v1/retailer/dashboard/my-brands/1"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
Example response (429):
{
"message": "Too Many Attempts."
}
HTTP Request
GET api/v1/retailer/dashboard/my-brands/{id}
Display a listing of the resource.
Example request:
curl -X GET \
-G "http://localhost/api/v1/retailer/dashboard/brands" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"http://localhost/api/v1/retailer/dashboard/brands"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
Example response (429):
{
"message": "Too Many Attempts."
}
HTTP Request
GET api/v1/retailer/dashboard/brands
Store a newly created resource in storage.
Example request:
curl -X POST \
"http://localhost/api/v1/retailer/dashboard/brands" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"http://localhost/api/v1/retailer/dashboard/brands"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "POST",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
HTTP Request
POST api/v1/retailer/dashboard/brands
Display the specified resource.
Example request:
curl -X GET \
-G "http://localhost/api/v1/retailer/dashboard/brands/1" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"http://localhost/api/v1/retailer/dashboard/brands/1"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
Example response (429):
{
"message": "Too Many Attempts."
}
HTTP Request
GET api/v1/retailer/dashboard/brands/{brand}
Update the specified resource in storage.
Example request:
curl -X PUT \
"http://localhost/api/v1/retailer/dashboard/brands/1" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"http://localhost/api/v1/retailer/dashboard/brands/1"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "PUT",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
HTTP Request
PUT api/v1/retailer/dashboard/brands/{brand}
PATCH api/v1/retailer/dashboard/brands/{brand}
Remove the specified resource from storage.
Example request:
curl -X DELETE \
"http://localhost/api/v1/retailer/dashboard/brands/1" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"http://localhost/api/v1/retailer/dashboard/brands/1"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "DELETE",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
HTTP Request
DELETE api/v1/retailer/dashboard/brands/{brand}
Coupons
APIs for Managing Coupons
api/v1/shopLocal/apply-coupon
Example request:
curl -X POST \
"http://localhost/api/v1/shopLocal/apply-coupon" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"http://localhost/api/v1/shopLocal/apply-coupon"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "POST",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
HTTP Request
POST api/v1/shopLocal/apply-coupon
Display a listing of the resource.
Example request:
curl -X GET \
-G "http://localhost/api/v1/admin/shopLocal/coupon" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"http://localhost/api/v1/admin/shopLocal/coupon"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
Example response (401):
{
"message": "Please, attach a Bearer Token to your request",
"success": false
}
HTTP Request
GET api/v1/admin/shopLocal/coupon
Store a newly created resource in storage.
Example request:
curl -X POST \
"http://localhost/api/v1/admin/shopLocal/coupon" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"http://localhost/api/v1/admin/shopLocal/coupon"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "POST",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
HTTP Request
POST api/v1/admin/shopLocal/coupon
Display the specified resource.
Example request:
curl -X GET \
-G "http://localhost/api/v1/admin/shopLocal/coupon/1" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"http://localhost/api/v1/admin/shopLocal/coupon/1"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
Example response (401):
{
"message": "Please, attach a Bearer Token to your request",
"success": false
}
HTTP Request
GET api/v1/admin/shopLocal/coupon/{coupon}
Update the specified resource in storage.
Example request:
curl -X PUT \
"http://localhost/api/v1/admin/shopLocal/coupon/1" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"http://localhost/api/v1/admin/shopLocal/coupon/1"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "PUT",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
HTTP Request
PUT api/v1/admin/shopLocal/coupon/{coupon}
PATCH api/v1/admin/shopLocal/coupon/{coupon}
Remove the specified resource from storage.
Example request:
curl -X DELETE \
"http://localhost/api/v1/admin/shopLocal/coupon/1" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"http://localhost/api/v1/admin/shopLocal/coupon/1"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "DELETE",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
HTTP Request
DELETE api/v1/admin/shopLocal/coupon/{coupon}
Customer Profile
APIs for Managing customer Profile
api/v1/customer/profile/account
Example request:
curl -X PUT \
"http://localhost/api/v1/customer/profile/account" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"http://localhost/api/v1/customer/profile/account"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "PUT",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
HTTP Request
PUT api/v1/customer/profile/account
api/v1/customer/profile/location
Example request:
curl -X PUT \
"http://localhost/api/v1/customer/profile/location" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"http://localhost/api/v1/customer/profile/location"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "PUT",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
HTTP Request
PUT api/v1/customer/profile/location
api/v1/customer/profile/password
Example request:
curl -X PUT \
"http://localhost/api/v1/customer/profile/password" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"http://localhost/api/v1/customer/profile/password"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "PUT",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
HTTP Request
PUT api/v1/customer/profile/password
Dashboard
APIs for Managing User Dashboard.
api/v1/admin/shopLocal/sales
Example request:
curl -X GET \
-G "http://localhost/api/v1/admin/shopLocal/sales" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"http://localhost/api/v1/admin/shopLocal/sales"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
Example response (401):
{
"message": "Please, attach a Bearer Token to your request",
"success": false
}
HTTP Request
GET api/v1/admin/shopLocal/sales
api/v1/admin/shopLocal/value
Example request:
curl -X GET \
-G "http://localhost/api/v1/admin/shopLocal/value" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"http://localhost/api/v1/admin/shopLocal/value"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
Example response (401):
{
"message": "Please, attach a Bearer Token to your request",
"success": false
}
HTTP Request
GET api/v1/admin/shopLocal/value
Display a listing of the resource.

}
HTTP Request
GET api/v1/retailer/dashboard/Usersales
api/v1/retailer/dashboard/Uservalue
Example request:
curl -X GET \
-G "http://localhost/api/v1/retailer/dashboard/Uservalue" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"http://localhost/api/v1/retailer/dashboard/Uservalue"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
Example response (429):
{
"message": "Too Many Attempts."
}
HTTP Request
GET api/v1/retailer/dashboard/Uservalue
api/v1/retailer/dashboard/Userdash
Example request:
curl -X GET \
-G "http://localhost/api/v1/retailer/dashboard/Userdash" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"http://localhost/api/v1/retailer/dashboard/Userdash"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
Example response (429):
{
"message": "Too Many Attempts."
}
HTTP Request
GET api/v1/retailer/dashboard/Userdash
api/v1/rider/dashboard/UserDelivery
Example request:
curl -X GET \
-G "http://localhost/api/v1/rider/dashboard/UserDelivery" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"http://localhost/api/v1/rider/dashboard/UserDelivery"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
Example response (429):
{
"message": "Too Many Attempts."
}
HTTP Request
GET api/v1/rider/dashboard/UserDelivery
api/v1/rider/dashboard/UserEarning
Example request:
curl -X GET \
-G "http://localhost/api/v1/rider/dashboard/UserEarning" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"http://localhost/api/v1/rider/dashboard/UserEarning"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
Example response (429):
{
"message": "Too Many Attempts."
}
HTTP Request
GET api/v1/rider/dashboard/UserEarning
api/v1/rider/dashboard/Riderdash
Example request:
curl -X GET \
-G "http://localhost/api/v1/rider/dashboard/Riderdash" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"http://localhost/api/v1/rider/dashboard/Riderdash"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
Example response (429):
{
"message": "Too Many Attempts."
}
HTTP Request
GET api/v1/rider/dashboard/Riderdash
Delivery
APIs for Managing Delivery of Items
Store a newly created resource in storage.
Example request:
curl -X POST \
"http://localhost/api/v1/admin/shopLocal/delivery/1" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"http://localhost/api/v1/admin/shopLocal/delivery/1"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "POST",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
HTTP Request
POST api/v1/admin/shopLocal/delivery/{id}
api/v1/admin/shopLocal/myRider/{id}
Example request:
curl -X GET \
-G "http://localhost/api/v1/admin/shopLocal/myRider/1" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"http://localhost/api/v1/admin/shopLocal/myRider/1"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
Example response (401):
{
"message": "Please, attach a Bearer Token to your request",
"success": false
}
HTTP Request
GET api/v1/admin/shopLocal/myRider/{id}
api/v1/admin/shopLocal/getShop/{id}
Example request:
curl -X GET \
-G "http://localhost/api/v1/admin/shopLocal/getShop/1" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"http://localhost/api/v1/admin/shopLocal/getShop/1"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
Example response (401):
{
"message": "Please, attach a Bearer Token to your request",
"success": false
}
HTTP Request
GET api/v1/admin/shopLocal/getShop/{id}
api/v1/admin/shopLocal/Rider/{id}
Example request:
curl -X POST \
"http://localhost/api/v1/admin/shopLocal/Rider/1" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"http://localhost/api/v1/admin/shopLocal/Rider/1"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "POST",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
HTTP Request
POST api/v1/admin/shopLocal/Rider/{id}
Display a listing of the resource.
Example request:
curl -X GET \
-G "http://localhost/api/v1/rider/dashboard/shipping" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"http://localhost/api/v1/rider/dashboard/shipping"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
Example response (429):
{
"message": "Too Many Attempts."
}
HTTP Request
GET api/v1/rider/dashboard/shipping
api/v1/rider/dashboard/showShippingInfo/{id}
Example request:
curl -X GET \
-G "http://localhost/api/v1/rider/dashboard/showShippingInfo/1" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"http://localhost/api/v1/rider/dashboard/showShippingInfo/1"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
Example response (429):
{
"message": "Too Many Attempts."
}
HTTP Request
GET api/v1/rider/dashboard/showShippingInfo/{id}
Location Tracking
APIs for Controlling Riders Location
api/v1/new_coordinates
Example request:
curl -X POST \
"http://localhost/api/v1/new_coordinates" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"http://localhost/api/v1/new_coordinates"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "POST",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
HTTP Request
POST api/v1/new_coordinates
Logs
APIs for Controlling users Logs
Display a listing of the resource.
Example request:
curl -X GET \
-G "http://localhost/api/v1/admin/logs" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"http://localhost/api/v1/admin/logs"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
Example response (401):
{
"message": "Please, attach a Bearer Token to your request",
"success": false
}
HTTP Request
GET api/v1/admin/logs
Store a newly created resource in storage.
Example request:
curl -X POST \
"http://localhost/api/v1/admin/logs" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"http://localhost/api/v1/admin/logs"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "POST",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
HTTP Request
POST api/v1/admin/logs
Display the specified resource.
Example request:
curl -X GET \
-G "http://localhost/api/v1/admin/logs/1" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"http://localhost/api/v1/admin/logs/1"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
Example response (401):
{
"message": "Please, attach a Bearer Token to your request",
"success": false
}
HTTP Request
GET api/v1/admin/logs/{log}
Update the specified resource in storage.
Example request:
curl -X PUT \
"http://localhost/api/v1/admin/logs/1" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"http://localhost/api/v1/admin/logs/1"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "PUT",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
HTTP Request
PUT api/v1/admin/logs/{log}
PATCH api/v1/admin/logs/{log}
Remove the specified resource from storage.
Example request:
curl -X DELETE \
"http://localhost/api/v1/admin/logs/1" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"http://localhost/api/v1/admin/logs/1"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "DELETE",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
HTTP Request
DELETE api/v1/admin/logs/{log}
Newsletter
APIs for Controlling Newsletter
Store a newly created resource in storage.
Example request:
curl -X POST \
"http://localhost/api/v1/newsletter" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"http://localhost/api/v1/newsletter"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "POST",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
HTTP Request
POST api/v1/newsletter
Orders
APIs for Managing orders
Store a newly created resource in storage.
Example request:
curl -X POST \
"http://localhost/api/v1/shopLocal/order" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"http://localhost/api/v1/shopLocal/order"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "POST",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
HTTP Request
POST api/v1/shopLocal/order
api/v1/shopLocal/order
Example request:
curl -X GET \
-G "http://localhost/api/v1/shopLocal/order" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"http://localhost/api/v1/shopLocal/order"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
Example response (401):
{
"message": "Token not provided"
}
HTTP Request
GET api/v1/shopLocal/order
api/v1/shopLocal/show-details/{id}
Example request:
curl -X GET \
-G "http://localhost/api/v1/shopLocal/show-details/1" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"http://localhost/api/v1/shopLocal/show-details/1"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
Example response (401):
{
"message": "Token not provided"
}
HTTP Request
GET api/v1/shopLocal/show-details/{id}
api/v1/shopLocal/showshipment/{id}
Example request:
curl -X GET \
-G "http://localhost/api/v1/shopLocal/showshipment/1" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"http://localhost/api/v1/shopLocal/showshipment/1"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
Example response (401):
{
"message": "Token not provided"
}
HTTP Request
GET api/v1/shopLocal/showshipment/{id}
api/v1/shopLocal/comment/{id}
Example request:
curl -X POST \
"http://localhost/api/v1/shopLocal/comment/1" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"http://localhost/api/v1/shopLocal/comment/1"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "POST",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
HTTP Request
POST api/v1/shopLocal/comment/{id}
api/v1/shopLocal/getComments/{id}
Example request:
curl -X GET \
-G "http://localhost/api/v1/shopLocal/getComments/1" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"http://localhost/api/v1/shopLocal/getComments/1"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
Example response (401):
{
"message": "Token not provided"
}
HTTP Request
GET api/v1/shopLocal/getComments/{id}
api/v1/shopLocal/rate/{id}
Example request:
curl -X POST \
"http://localhost/api/v1/shopLocal/rate/1" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"http://localhost/api/v1/shopLocal/rate/1"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "POST",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
HTTP Request
POST api/v1/shopLocal/rate/{id}
api/v1/shopLocal/cancel-order/{id}
Example request:
curl -X PATCH \
"http://localhost/api/v1/shopLocal/cancel-order/1" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"http://localhost/api/v1/shopLocal/cancel-order/1"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "PATCH",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
HTTP Request
PATCH api/v1/shopLocal/cancel-order/{id}
api/v1/shopLocal/pay/{id}
Example request:
curl -X POST \
"http://localhost/api/v1/shopLocal/pay/1" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"http://localhost/api/v1/shopLocal/pay/1"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "POST",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
HTTP Request
POST api/v1/shopLocal/pay/{id}
Display the specified resource.
Example request:
curl -X GET \
-G "http://localhost/api/v1/admin/shopLocal/order" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"http://localhost/api/v1/admin/shopLocal/order"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
Example response (401):
{
"message": "Please, attach a Bearer Token to your request",
"success": false
}
HTTP Request
GET api/v1/admin/shopLocal/order
api/v1/admin/shopLocal/show-details/{id}
Example request:
curl -X GET \
-G "http://localhost/api/v1/admin/shopLocal/show-details/1" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"http://localhost/api/v1/admin/shopLocal/show-details/1"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
Example response (401):
{
"message": "Please, attach a Bearer Token to your request",
"success": false
}
HTTP Request
GET api/v1/admin/shopLocal/show-details/{id}
api/v1/admin/shopLocal/shipment/{id}
Example request:
curl -X GET \
-G "http://localhost/api/v1/admin/shopLocal/shipment/1" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"http://localhost/api/v1/admin/shopLocal/shipment/1"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
Example response (401):
{
"message": "Please, attach a Bearer Token to your request",
"success": false
}
HTTP Request
GET api/v1/admin/shopLocal/shipment/{id}
api/v1/admin/shopLocal/change-status/{id}
Example request:
curl -X PATCH \
"http://localhost/api/v1/admin/shopLocal/change-status/1" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"http://localhost/api/v1/admin/shopLocal/change-status/1"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "PATCH",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
HTTP Request
PATCH api/v1/admin/shopLocal/change-status/{id}
api/v1/retailer/dashboard/myOrders
Example request:
curl -X GET \
-G "http://localhost/api/v1/retailer/dashboard/myOrders" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"http://localhost/api/v1/retailer/dashboard/myOrders"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
Example response (429):
{
"message": "Too Many Attempts."
}
HTTP Request
GET api/v1/retailer/dashboard/myOrders
api/v1/retailer/dashboard/order-details/{id}
Example request:
curl -X GET \
-G "http://localhost/api/v1/retailer/dashboard/order-details/1" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"http://localhost/api/v1/retailer/dashboard/order-details/1"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
Example response (429):
{
"message": "Too Many Attempts."
}
HTTP Request
GET api/v1/retailer/dashboard/order-details/{id}
api/v1/retailer/dashboard/showOrderDetails/{id}
Example request:
curl -X GET \
-G "http://localhost/api/v1/retailer/dashboard/showOrderDetails/1" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"http://localhost/api/v1/retailer/dashboard/showOrderDetails/1"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
Example response (429):
{
"message": "Too Many Attempts."
}
HTTP Request
GET api/v1/retailer/dashboard/showOrderDetails/{id}
Password Control
APIs for Managing password reset
Send a reset link to the given user.
Example request:
curl -X POST \
"http://localhost/api/v1/password/email" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"http://localhost/api/v1/password/email"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "POST",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
HTTP Request
POST api/v1/password/email
Product
APIs for Managing Products
api/v1/subcat_brands/{id}
Example request:
curl -X GET \
-G "http://localhost/api/v1/subcat_brands/1" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"http://localhost/api/v1/subcat_brands/1"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
Example response (200):
[
{
"id": 1,
"name": "Nike",
"sub_category_id": 1,
"description": "Just do it",
"created_at": "2020-08-06T13:18:36.000000Z",
"updated_at": "2020-08-06T13:18:36.000000Z"
},
{
"id": 2,
"name": "Jordan",
"sub_category_id": 1,
"description": "life is good",
"created_at": "2020-08-06T13:18:58.000000Z",
"updated_at": "2020-08-06T13:18:58.000000Z"
}
]
HTTP Request
GET api/v1/subcat_brands/{id}
api/v1/featured-products
Example request:
curl -X GET \
-G "http://localhost/api/v1/featured-products" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"http://localhost/api/v1/featured-products"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
Example response (500):
{
"message": "Server Error"
}
HTTP Request
GET api/v1/featured-products
api/v1/visited
Example request:
curl -X POST \
"http://localhost/api/v1/visited" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"http://localhost/api/v1/visited"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "POST",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
HTTP Request
POST api/v1/visited
api/v1/shopLocal/filter-products
Example request:
curl -X POST \
"http://localhost/api/v1/shopLocal/filter-products" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"http://localhost/api/v1/shopLocal/filter-products"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "POST",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
HTTP Request
POST api/v1/shopLocal/filter-products
Display a listing of the resource.
Example request:
curl -X GET \
-G "http://localhost/api/v1/admin/shopLocal/products" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"http://localhost/api/v1/admin/shopLocal/products"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
Example response (401):
{
"message": "Please, attach a Bearer Token to your request",
"success": false
}
HTTP Request
GET api/v1/admin/shopLocal/products
Store a newly created resource in storage.
Example request:
curl -X POST \
"http://localhost/api/v1/admin/shopLocal/products" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"http://localhost/api/v1/admin/shopLocal/products"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "POST",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
HTTP Request
POST api/v1/admin/shopLocal/products
Display the specified resource.
Example request:
curl -X GET \
-G "http://localhost/api/v1/admin/shopLocal/products/1" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"http://localhost/api/v1/admin/shopLocal/products/1"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
Example response (401):
{
"message": "Please, attach a Bearer Token to your request",
"success": false
}
HTTP Request
GET api/v1/admin/shopLocal/products/{product}
Update the specified resource in storage.
Example request:
curl -X PUT \
"http://localhost/api/v1/admin/shopLocal/products/1" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"http://localhost/api/v1/admin/shopLocal/products/1"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "PUT",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
HTTP Request
PUT api/v1/admin/shopLocal/products/{product}
PATCH api/v1/admin/shopLocal/products/{product}
Remove the specified resource from storage.
Example request:
curl -X DELETE \
"http://localhost/api/v1/admin/shopLocal/products/1" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"http://localhost/api/v1/admin/shopLocal/products/1"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "DELETE",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
HTTP Request
DELETE api/v1/admin/shopLocal/products/{product}
api/v1/admin/shopLocal/shop
Example request:
curl -X GET \
-G "http://localhost/api/v1/admin/shopLocal/shop" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"http://localhost/api/v1/admin/shopLocal/shop"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
Example response (401):
{
"message": "Please, attach a Bearer Token to your request",
"success": false
}
HTTP Request
GET api/v1/admin/shopLocal/shop
api/v1/admin/shopLocal/brand-products/{id}
Example request:
curl -X GET \
-G "http://localhost/api/v1/admin/shopLocal/brand-products/1" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"http://localhost/api/v1/admin/shopLocal/brand-products/1"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
Example response (401):
{
"message": "Please, attach a Bearer Token to your request",
"success": false
}
HTTP Request
GET api/v1/admin/shopLocal/brand-products/{id}
Display a listing of the resource.
Example request:
curl -X GET \
-G "http://localhost/api/v1/admin/shopLocal/all-products" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"http://localhost/api/v1/admin/shopLocal/all-products"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
Example response (401):
{
"message": "Please, attach a Bearer Token to your request",
"success": false
}
HTTP Request
GET api/v1/admin/shopLocal/all-products
api/v1/admin/shopLocal/update-status/{id}
Example request:
curl -X PATCH \
"http://localhost/api/v1/admin/shopLocal/update-status/1" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"http://localhost/api/v1/admin/shopLocal/update-status/1"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "PATCH",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
HTTP Request
PATCH api/v1/admin/shopLocal/update-status/{id}
api/v1/admin/shopLocal/delete-image/{id}
Example request:
curl -X DELETE \
"http://localhost/api/v1/admin/shopLocal/delete-image/1" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"http://localhost/api/v1/admin/shopLocal/delete-image/1"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "DELETE",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
HTTP Request
DELETE api/v1/admin/shopLocal/delete-image/{id}
Remove the specified resource from storage.
Example request:
curl -X DELETE \
"http://localhost/api/v1/admin/shopLocal/delete-product/1" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"http://localhost/api/v1/admin/shopLocal/delete-product/1"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "DELETE",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
HTTP Request
DELETE api/v1/admin/shopLocal/delete-product/{id}
api/v1/admin/shopLocal/activate-product/{id}
Example request:
curl -X PATCH \
"http://localhost/api/v1/admin/shopLocal/activate-product/1" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"http://localhost/api/v1/admin/shopLocal/activate-product/1"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "PATCH",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
HTTP Request
PATCH api/v1/admin/shopLocal/activate-product/{id}
Update the specified resource in storage.
Example request:
curl -X POST \
"http://localhost/api/v1/admin/shopLocal/update-product/1" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"http://localhost/api/v1/admin/shopLocal/update-product/1"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "POST",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
HTTP Request
POST api/v1/admin/shopLocal/update-product/{id}
api/v1/retailer/dashboard/products
Example request:
curl -X POST \
"http://localhost/api/v1/retailer/dashboard/products" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"http://localhost/api/v1/retailer/dashboard/products"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "POST",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
HTTP Request
POST api/v1/retailer/dashboard/products
api/v1/retailer/dashboard/all-products
Example request:
curl -X GET \
-G "http://localhost/api/v1/retailer/dashboard/all-products" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"http://localhost/api/v1/retailer/dashboard/all-products"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
Example response (429):
{
"message": "Too Many Attempts."
}
HTTP Request
GET api/v1/retailer/dashboard/all-products
Remove the specified resource from storage.
Example request:
curl -X DELETE \
"http://localhost/api/v1/retailer/dashboard/delete-product/1" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"http://localhost/api/v1/retailer/dashboard/delete-product/1"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "DELETE",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
HTTP Request
DELETE api/v1/retailer/dashboard/delete-product/{id}
api/v1/retailer/dashboard/delete-image/{id}
Example request:
curl -X DELETE \
"http://localhost/api/v1/retailer/dashboard/delete-image/1" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"http://localhost/api/v1/retailer/dashboard/delete-image/1"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "DELETE",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
HTTP Request
DELETE api/v1/retailer/dashboard/delete-image/{id}
Update the specified resource in storage.
Example request:
curl -X POST \
"http://localhost/api/v1/retailer/dashboard/update-product/1" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"http://localhost/api/v1/retailer/dashboard/update-product/1"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "POST",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
HTTP Request
POST api/v1/retailer/dashboard/update-product/{id}
api/v1/retailer/dashboard/update-status/{id}
Example request:
curl -X PATCH \
"http://localhost/api/v1/retailer/dashboard/update-status/1" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"http://localhost/api/v1/retailer/dashboard/update-status/1"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "PATCH",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
HTTP Request
PATCH api/v1/retailer/dashboard/update-status/{id}
Product Category
APIs for Managing Product Category
api/v1/featured-category
Example request:
curl -X GET \
-G "http://localhost/api/v1/featured-category" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"http://localhost/api/v1/featured-category"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
Example response (500):
{
"message": "Server Error"
}
HTTP Request
GET api/v1/featured-category
api/v1/shopLocal/categories_sub_brands
Example request:
curl -X GET \
-G "http://localhost/api/v1/shopLocal/categories_sub_brands" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"http://localhost/api/v1/shopLocal/categories_sub_brands"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
Example response (200):
[
{
"id": 2,
"name": "Drinks",
"image": "1596719989.jpeg",
"created_at": "2020-08-06T13:19:49.000000Z",
"updated_at": "2020-08-06T13:19:49.000000Z",
"filePath": "http:\/\/localhost\/storage\/products_category\/1596719989.jpeg",
"sub_category": [
{
"id": 4,
"name": "Smoothies",
"product_category_id": 2,
"created_at": "2020-08-06T13:20:10.000000Z",
"updated_at": "2020-08-06T13:20:10.000000Z",
"brands": [
{
"id": 3,
"name": "fruits2go",
"sub_category_id": 4,
"description": "bursting with natural flavour",
"created_at": "2020-08-06T13:21:26.000000Z",
"updated_at": "2020-08-06T13:21:26.000000Z"
}
]
},
{
"id": 5,
"name": "Juice",
"product_category_id": 2,
"created_at": "2020-08-06T13:20:32.000000Z",
"updated_at": "2020-08-06T13:20:32.000000Z",
"brands": [
{
"id": 4,
"name": "fruits2go",
"sub_category_id": 5,
"description": "bursting with natuural flavour",
"created_at": "2020-08-06T13:22:05.000000Z",
"updated_at": "2020-08-06T13:22:05.000000Z"
}
]
}
]
},
{
"id": 1,
"name": "Shoes",
"image": "1596719839.jpeg",
"created_at": "2020-08-06T13:17:20.000000Z",
"updated_at": "2020-08-06T13:17:20.000000Z",
"filePath": "http:\/\/localhost\/storage\/products_category\/1596719839.jpeg",
"sub_category": [
{
"id": 1,
"name": "Men",
"product_category_id": 1,
"created_at": "2020-08-06T13:17:39.000000Z",
"updated_at": "2020-08-06T13:17:39.000000Z",
"brands": [
{
"id": 1,
"name": "Nike",
"sub_category_id": 1,
"description": "Just do it",
"created_at": "2020-08-06T13:18:36.000000Z",
"updated_at": "2020-08-06T13:18:36.000000Z"
},
{
"id": 2,
"name": "Jordan",
"sub_category_id": 1,
"description": "life is good",
"created_at": "2020-08-06T13:18:58.000000Z",
"updated_at": "2020-08-06T13:18:58.000000Z"
}
]
},
{
"id": 2,
"name": "women",
"product_category_id": 1,
"created_at": "2020-08-06T13:17:57.000000Z",
"updated_at": "2020-08-06T13:17:57.000000Z",
"brands": []
},
{
"id": 3,
"name": "children",
"product_category_id": 1,
"created_at": "2020-08-06T13:18:12.000000Z",
"updated_at": "2020-08-06T13:18:12.000000Z",
"brands": []
}
]
}
]
HTTP Request
GET api/v1/shopLocal/categories_sub_brands
Display a listing of the resource.
Example request:
curl -X GET \
-G "http://localhost/api/v1/admin/shopLocal/category" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"http://localhost/api/v1/admin/shopLocal/category"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
Example response (401):
{
"message": "Please, attach a Bearer Token to your request",
"success": false
}
HTTP Request
GET api/v1/admin/shopLocal/category
Store a newly created resource in storage.
Example request:
curl -X POST \
"http://localhost/api/v1/admin/shopLocal/category" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"http://localhost/api/v1/admin/shopLocal/category"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "POST",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
HTTP Request
POST api/v1/admin/shopLocal/category
Display the specified resource.
Example request:
curl -X GET \
-G "http://localhost/api/v1/admin/shopLocal/category/1" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"http://localhost/api/v1/admin/shopLocal/category/1"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
Example response (401):
{
"message": "Please, attach a Bearer Token to your request",
"success": false
}
HTTP Request
GET api/v1/admin/shopLocal/category/{category}
Update the specified resource in storage.
Example request:
curl -X PUT \
"http://localhost/api/v1/admin/shopLocal/category/1" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"http://localhost/api/v1/admin/shopLocal/category/1"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "PUT",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
HTTP Request
PUT api/v1/admin/shopLocal/category/{category}
PATCH api/v1/admin/shopLocal/category/{category}
Remove the specified resource from storage.
Example request:
curl -X DELETE \
"http://localhost/api/v1/admin/shopLocal/category/1" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"http://localhost/api/v1/admin/shopLocal/category/1"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "DELETE",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
HTTP Request
DELETE api/v1/admin/shopLocal/category/{category}
Display a listing of the resource.
Example request:
curl -X GET \
-G "http://localhost/api/v1/retailer/dashboard/category" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"http://localhost/api/v1/retailer/dashboard/category"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
Example response (401):
{
"message": "Please, attach a Bearer Token to your request",
"success": false
}
HTTP Request
GET api/v1/retailer/dashboard/category
Store a newly created resource in storage.
Example request:
curl -X POST \
"http://localhost/api/v1/retailer/dashboard/category" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"http://localhost/api/v1/retailer/dashboard/category"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "POST",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
HTTP Request
POST api/v1/retailer/dashboard/category
Display the specified resource.
Example request:
curl -X GET \
-G "http://localhost/api/v1/retailer/dashboard/category/1" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"http://localhost/api/v1/retailer/dashboard/category/1"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
Example response (401):
{
"message": "Please, attach a Bearer Token to your request",
"success": false
}
HTTP Request
GET api/v1/retailer/dashboard/category/{category}
Update the specified resource in storage.
Example request:
curl -X PUT \
"http://localhost/api/v1/retailer/dashboard/category/1" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"http://localhost/api/v1/retailer/dashboard/category/1"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "PUT",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
HTTP Request
PUT api/v1/retailer/dashboard/category/{category}
PATCH api/v1/retailer/dashboard/category/{category}
Remove the specified resource from storage.
Example request:
curl -X DELETE \
"http://localhost/api/v1/retailer/dashboard/category/1" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"http://localhost/api/v1/retailer/dashboard/category/1"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "DELETE",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
HTTP Request
DELETE api/v1/retailer/dashboard/category/{category}
Product Sub_Category
APIs for Managing product Sub category
Display a listing of the resource.
Example request:
curl -X GET \
-G "http://localhost/api/v1/admin/shopLocal/Subcategory" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"http://localhost/api/v1/admin/shopLocal/Subcategory"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
Example response (401):
{
"message": "Please, attach a Bearer Token to your request",
"success": false
}
HTTP Request
GET api/v1/admin/shopLocal/Subcategory
Store a newly created resource in storage.
Example request:
curl -X POST \
"http://localhost/api/v1/admin/shopLocal/Subcategory" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"http://localhost/api/v1/admin/shopLocal/Subcategory"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "POST",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
HTTP Request
POST api/v1/admin/shopLocal/Subcategory
Display the specified resource.
Example request:
curl -X GET \
-G "http://localhost/api/v1/admin/shopLocal/Subcategory/1" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"http://localhost/api/v1/admin/shopLocal/Subcategory/1"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
Example response (401):
{
"message": "Please, attach a Bearer Token to your request",
"success": false
}
HTTP Request
GET api/v1/admin/shopLocal/Subcategory/{Subcategory}
Update the specified resource in storage.
Example request:
curl -X PUT \
"http://localhost/api/v1/admin/shopLocal/Subcategory/1" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"http://localhost/api/v1/admin/shopLocal/Subcategory/1"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "PUT",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
HTTP Request
PUT api/v1/admin/shopLocal/Subcategory/{Subcategory}
PATCH api/v1/admin/shopLocal/Subcategory/{Subcategory}
Remove the specified resource from storage.
Example request:
curl -X DELETE \
"http://localhost/api/v1/admin/shopLocal/Subcategory/1" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"http://localhost/api/v1/admin/shopLocal/Subcategory/1"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "DELETE",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
HTTP Request
DELETE api/v1/admin/shopLocal/Subcategory/{Subcategory}
api/v1/admin/shopLocal/sub-category/{id}
Example request:
curl -X GET \
-G "http://localhost/api/v1/admin/shopLocal/sub-category/1" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"http://localhost/api/v1/admin/shopLocal/sub-category/1"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
Example response (401):
{
"message": "Please, attach a Bearer Token to your request",
"success": false
}
HTTP Request
GET api/v1/admin/shopLocal/sub-category/{id}
Display a listing of the resource.
Example request:
curl -X GET \
-G "http://localhost/api/v1/retailer/dashboard/Subcategory" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"http://localhost/api/v1/retailer/dashboard/Subcategory"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
Example response (401):
{
"message": "Please, attach a Bearer Token to your request",
"success": false
}
HTTP Request
GET api/v1/retailer/dashboard/Subcategory
Store a newly created resource in storage.
Example request:
curl -X POST \
"http://localhost/api/v1/retailer/dashboard/Subcategory" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"http://localhost/api/v1/retailer/dashboard/Subcategory"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "POST",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
HTTP Request
POST api/v1/retailer/dashboard/Subcategory
Display the specified resource.
Example request:
curl -X GET \
-G "http://localhost/api/v1/retailer/dashboard/Subcategory/1" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"http://localhost/api/v1/retailer/dashboard/Subcategory/1"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
Example response (429):
{
"message": "Too Many Attempts."
}
HTTP Request
GET api/v1/retailer/dashboard/Subcategory/{Subcategory}
Update the specified resource in storage.
Example request:
curl -X PUT \
"http://localhost/api/v1/retailer/dashboard/Subcategory/1" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"http://localhost/api/v1/retailer/dashboard/Subcategory/1"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "PUT",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
HTTP Request
PUT api/v1/retailer/dashboard/Subcategory/{Subcategory}
PATCH api/v1/retailer/dashboard/Subcategory/{Subcategory}
Remove the specified resource from storage.
Example request:
curl -X DELETE \
"http://localhost/api/v1/retailer/dashboard/Subcategory/1" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"http://localhost/api/v1/retailer/dashboard/Subcategory/1"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "DELETE",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
HTTP Request
DELETE api/v1/retailer/dashboard/Subcategory/{Subcategory}
api/v1/retailer/dashboard/sub-category/{id}
Example request:
curl -X GET \
-G "http://localhost/api/v1/retailer/dashboard/sub-category/1" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"http://localhost/api/v1/retailer/dashboard/sub-category/1"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
Example response (429):
{
"message": "Too Many Attempts."
}
HTTP Request
GET api/v1/retailer/dashboard/sub-category/{id}
Reports
APIs for Managing Reports
api/v1/admin/shopLocal/shopping-report
Example request:
curl -X POST \
"http://localhost/api/v1/admin/shopLocal/shopping-report" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"http://localhost/api/v1/admin/shopLocal/shopping-report"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "POST",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
HTTP Request
POST api/v1/admin/shopLocal/shopping-report
api/v1/retailer/dashboard/shopping-report
Example request:
curl -X POST \
"http://localhost/api/v1/retailer/dashboard/shopping-report" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"http://localhost/api/v1/retailer/dashboard/shopping-report"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "POST",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
HTTP Request
POST api/v1/retailer/dashboard/shopping-report
ResetPasswod
APIs for managing Password Reset
Reset the given user's password.
Example request:
curl -X POST \
"http://localhost/api/v1/password/reset" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"http://localhost/api/v1/password/reset"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "POST",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
HTTP Request
POST api/v1/password/reset
Rider
APIs for Managing Riders
api/v1/rider/dashboard/rider-details/{id}
Example request:
curl -X GET \
-G "http://localhost/api/v1/rider/dashboard/rider-details/1" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"http://localhost/api/v1/rider/dashboard/rider-details/1"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
Example response (429):
{
"message": "Too Many Attempts."
}
HTTP Request
GET api/v1/rider/dashboard/rider-details/{id}
Shipment
APIs for controlling shipment
api/v1/clear-shipment
Example request:
curl -X GET \
-G "http://localhost/api/v1/clear-shipment" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"http://localhost/api/v1/clear-shipment"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
Example response (500):
{
"message": "Server Error"
}
HTTP Request
GET api/v1/clear-shipment
Display a listing of the resource.
Example request:
curl -X GET \
-G "http://localhost/api/v1/rider/available-shipment" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"http://localhost/api/v1/rider/available-shipment"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
Example response (429):
{
"message": "Too Many Attempts."
}
HTTP Request
GET api/v1/rider/available-shipment
Display the specified resource.
Example request:
curl -X GET \
-G "http://localhost/api/v1/rider/rider-shipment/1" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"http://localhost/api/v1/rider/rider-shipment/1"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
Example response (429):
{
"message": "Too Many Attempts."
}
HTTP Request
GET api/v1/rider/rider-shipment/{id}
Update the specified resource in storage.
Example request:
curl -X POST \
"http://localhost/api/v1/rider/take-ride/1" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"http://localhost/api/v1/rider/take-ride/1"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "POST",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
HTTP Request
POST api/v1/rider/take-ride/{id}
Remove the specified resource from storage.
Example request:
curl -X GET \
-G "http://localhost/api/v1/rider/my-rides" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"http://localhost/api/v1/rider/my-rides"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
Example response (429):
{
"message": "Too Many Attempts."
}
HTTP Request
GET api/v1/rider/my-rides
api/v1/rider/complete-ride/{id}
Example request:
curl -X GET \
-G "http://localhost/api/v1/rider/complete-ride/1" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"http://localhost/api/v1/rider/complete-ride/1"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
Example response (429):
{
"message": "Too Many Attempts."
}
HTTP Request
GET api/v1/rider/complete-ride/{id}
api/v1/rider/comment/{id}
Example request:
curl -X POST \
"http://localhost/api/v1/rider/comment/1" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"http://localhost/api/v1/rider/comment/1"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "POST",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
HTTP Request
POST api/v1/rider/comment/{id}
api/v1/rider/comments/{id}
Example request:
curl -X GET \
-G "http://localhost/api/v1/rider/comments/1" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"http://localhost/api/v1/rider/comments/1"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
Example response (429):
{
"message": "Too Many Attempts."
}
HTTP Request
GET api/v1/rider/comments/{id}
Shop
APIs for Managing Shops
Display a listing of the resource.
Example request:
curl -X GET \
-G "http://localhost/api/v1/categories" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"http://localhost/api/v1/categories"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
Example response (200):
[
{
"id": 2,
"name": "Drinks",
"image": "1596719989.jpeg",
"filePath": "http:\/\/localhost\/storage\/products_category\/1596719989.jpeg"
},
{
"id": 1,
"name": "Shoes",
"image": "1596719839.jpeg",
"filePath": "http:\/\/localhost\/storage\/products_category\/1596719839.jpeg"
}
]
HTTP Request
GET api/v1/categories
api/v1/search-categories
Example request:
curl -X POST \
"http://localhost/api/v1/search-categories" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"http://localhost/api/v1/search-categories"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "POST",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
HTTP Request
POST api/v1/search-categories
Display a listing of the resource.
Example request:
curl -X GET \
-G "http://localhost/api/v1/shopLocal/categories" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"http://localhost/api/v1/shopLocal/categories"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
Example response (200):
[
{
"id": 2,
"name": "Drinks",
"image": "1596719989.jpeg",
"filePath": "http:\/\/localhost\/storage\/products_category\/1596719989.jpeg"
},
{
"id": 1,
"name": "Shoes",
"image": "1596719839.jpeg",
"filePath": "http:\/\/localhost\/storage\/products_category\/1596719839.jpeg"
}
]
HTTP Request
GET api/v1/shopLocal/categories
Display the specified resource.
Example request:
curl -X GET \
-G "http://localhost/api/v1/shopLocal/products/1" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"http://localhost/api/v1/shopLocal/products/1"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
Example response (200):
[
{
"id": 3,
"title": "Airforce max II",
"slug": "airforce-max-ii",
"category_id": 1,
"sub_category_id": 1,
"brand_id": 1,
"user_id": 2,
"status": 1,
"description": "<p>just do it<\/p>",
"price": "2400.00",
"visitors": 4,
"quantity": null,
"disabled": "enabled",
"uniqueId":<PHONE_NUMBER>,
"created_at": "2020-08-06T13:43:15.000000Z",
"updated_at": "2020-08-12T05:24:24.000000Z",
"brand": {
"id": 1,
"name": "Nike",
"sub_category_id": 1,
"description": "Just do it",
"created_at": "2020-08-06T13:18:36.000000Z",
"updated_at": "2020-08-06T13:18:36.000000Z"
},
"files": [
{
"id": 5,
"height": "194.00",
"product_id": 3,
"path": "1596721395airfore2.jpg",
"created_at": "2020-08-06T13:43:15.000000Z",
"updated_at": "2020-08-06T13:43:15.000000Z",
"filePath": "http:\/\/localhost\/storage\/uploads\/1596721395airfore2.jpg",
"largePath": "http:\/\/localhost\/storage\/uploads\/large\/1596721395airfore2.jpg"
}
]
}
]
HTTP Request
GET api/v1/shopLocal/products/{id}
Store a newly created resource in storage.
Example request:
curl -X GET \
-G "http://localhost/api/v1/shopLocal/sub-categories/1" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"http://localhost/api/v1/shopLocal/sub-categories/1"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
Example response (200):
[
{
"id": 3,
"name": "children",
"products": []
},
{
"id": 1,
"name": "Men",
"products": [
{
"id": 3,
"title": "Airforce max II",
"slug": "airforce-max-ii",
"category_id": 1,
"sub_category_id": 1,
"brand_id": 1,
"user_id": 2,
"status": 1,
"description": "<p>just do it<\/p>",
"price": "2400.00",
"visitors": 4,
"quantity": null,
"disabled": "enabled",
"uniqueId":<PHONE_NUMBER>,
"created_at": "2020-08-06T13:43:15.000000Z",
"updated_at": "2020-08-12T05:24:24.000000Z",
"files": [
{
"id": 5,
"height": "194.00",
"product_id": 3,
"path": "1596721395airfore2.jpg",
"created_at": "2020-08-06T13:43:15.000000Z",
"updated_at": "2020-08-06T13:43:15.000000Z",
"filePath": "http:\/\/localhost\/storage\/uploads\/1596721395airfore2.jpg",
"largePath": "http:\/\/localhost\/storage\/uploads\/large\/1596721395airfore2.jpg"
}
]
}
]
},
{
"id": 2,
"name": "women",
"products": []
}
]
HTTP Request
GET api/v1/shopLocal/sub-categories/{id}
Update the specified resource in storage.
Example request:
curl -X GET \
-G "http://localhost/api/v1/shopLocal/details/1" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"http://localhost/api/v1/shopLocal/details/1"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
Example response (404):
{
"message": "No query results for model [App\\Product]."
}
HTTP Request
GET api/v1/shopLocal/details/{id}
api/v1/shopLocal/search-products
Example request:
curl -X POST \
"http://localhost/api/v1/shopLocal/search-products" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"http://localhost/api/v1/shopLocal/search-products"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "POST",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
HTTP Request
POST api/v1/shopLocal/search-products
Update the specified resource in storage.
Example request:
curl -X GET \
-G "http://localhost/api/v1/admin/shopLocal/details/1" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"http://localhost/api/v1/admin/shopLocal/details/1"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
Example response (401):
{
"message": "Please, attach a Bearer Token to your request",
"success": false
}
HTTP Request
GET api/v1/admin/shopLocal/details/{id}
Update the specified resource in storage.
Example request:
curl -X GET \
-G "http://localhost/api/v1/retailer/dashboard/details/1" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"http://localhost/api/v1/retailer/dashboard/details/1"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
Example response (429):
{
"message": "Too Many Attempts."
}
HTTP Request
GET api/v1/retailer/dashboard/details/{id}
api/v1/retailer/dashboard/shop-details/{id}
Example request:
curl -X GET \
-G "http://localhost/api/v1/retailer/dashboard/shop-details/1" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"http://localhost/api/v1/retailer/dashboard/shop-details/1"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
Example response (429):
{
"message": "Too Many Attempts."
}
HTTP Request
GET api/v1/retailer/dashboard/shop-details/{id}
Shops
APIs for Managing Shops
Get wholesaler and retailer shops
[Here we get verified shop with the ID, shop Name, profile image and User_id : you can then use these details to get Wholesaler products.]
Example request:
curl -X GET \
-G "http://localhost/api/v1/shops" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"http://localhost/api/v1/shops"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
Example response (200):
[
{
"id": 2,
"shop": {
"id": 1,
"shop_name": "Hollywood mini supermarket",
"profile_image": null,
"user_id": 2,
"filePath": "http:\/\/localhost\/storage\/uploads"
}
},
{
"id": 4,
"shop": {
"id": 2,
"shop_name": "Marvick",
"profile_image": null,
"user_id": 4,
"filePath": "http:\/\/localhost\/storage\/uploads"
}
}
]
HTTP Request
GET api/v1/shops
Search for a given shop
Example request:
curl -X POST \
"http://localhost/api/v1/search-shops" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"search":"Nakumart"}'
const url = new URL(
"http://localhost/api/v1/search-shops"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"search": "Nakumart"
}
fetch(url, {
method: "POST",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));
HTTP Request
POST api/v1/search-shops
Body Parameters
| Parameter | Type | Status | Description |
|---|---|---|---|
search |
String | required | details of the shop . |
api/v1/sort-shops
Example request:
curl -X POST \
"http://localhost/api/v1/sort-shops" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"http://localhost/api/v1/sort-shops"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "POST",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
HTTP Request
POST api/v1/sort-shops
Verification
APIs for Managing account verification
Resend the email verification notification.
Example request:
curl -X GET \
-G "http://localhost/api/v1/email/resend/1" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"http://localhost/api/v1/email/resend/1"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
Example response (404):
{
"message": "No query results for model [App\\User]."
}
HTTP Request
GET api/v1/email/resend/{email}
Mark the authenticated user's email address as verified.
Example request:
curl -X POST \
"http://localhost/api/v1/email/verify/1/1" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"http://localhost/api/v1/email/verify/1/1"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "POST",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
HTTP Request
POST api/v1/email/verify/{id}/{hash}
Wallet
APIs for Managing Wallet transaction
api/v1/rider/wallet-balance
Example request:
curl -X GET \
-G "http://localhost/api/v1/rider/wallet-balance" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"http://localhost/api/v1/rider/wallet-balance"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
Example response (429):
{
"message": "Too Many Attempts."
}
HTTP Request
GET api/v1/rider/wallet-balance
api/v1/rider/wallet-transactions
Example request:
curl -X GET \
-G "http://localhost/api/v1/rider/wallet-transactions" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"http://localhost/api/v1/rider/wallet-transactions"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
Example response (429):
{
"message": "Too Many Attempts."
}
HTTP Request
GET api/v1/rider/wallet-transactions
api/v1/rider/stats
Example request:
curl -X GET \
-G "http://localhost/api/v1/rider/stats" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"http://localhost/api/v1/rider/stats"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
Example response (429):
{
"message": "Too Many Attempts."
}
HTTP Request
GET api/v1/rider/stats
api/v1/rider/earning-report
Example request:
curl -X GET \
-G "http://localhost/api/v1/rider/earning-report" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"http://localhost/api/v1/rider/earning-report"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
Example response (429):
{
"message": "Too Many Attempts."
}
HTTP Request
GET api/v1/rider/earning-report
general
Authenticate the request for channel access.
Example request:
curl -X GET \
-G "http://localhost/api/v1/broadcasting/auth" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"http://localhost/api/v1/broadcasting/auth"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
Example response (401):
{
"message": "Token not provided"
}
HTTP Request
GET api/v1/broadcasting/auth
POST api/v1/broadcasting/auth
api/v1/auth/emailCheck
Example request:
curl -X POST \
"http://localhost/api/v1/auth/emailCheck" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"http://localhost/api/v1/auth/emailCheck"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "POST",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
HTTP Request
POST api/v1/auth/emailCheck
api/v1/contact
Example request:
curl -X POST \
"http://localhost/api/v1/contact" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"http://localhost/api/v1/contact"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "POST",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
HTTP Request
POST api/v1/contact
Display a listing of the resource.
Example request:
curl -X GET \
-G "http://localhost/api/v1/admin/user" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"http://localhost/api/v1/admin/user"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
Example response (401):
{
"message": "Please, attach a Bearer Token to your request",
"success": false
}
HTTP Request
GET api/v1/admin/user
Store a newly created resource in storage.
Example request:
curl -X POST \
"http://localhost/api/v1/admin/user" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"http://localhost/api/v1/admin/user"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "POST",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
HTTP Request
POST api/v1/admin/user
Display the specified resource.
Example request:
curl -X GET \
-G "http://localhost/api/v1/admin/user/1" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"http://localhost/api/v1/admin/user/1"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
Example response (401):
{
"message": "Please, attach a Bearer Token to your request",
"success": false
}
HTTP Request
GET api/v1/admin/user/{user}
Update the specified resource in storage.
Example request:
curl -X PUT \
"http://localhost/api/v1/admin/user/1" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"http://localhost/api/v1/admin/user/1"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "PUT",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
HTTP Request
PUT api/v1/admin/user/{user}
PATCH api/v1/admin/user/{user}
Remove the specified resource from storage.
Example request:
curl -X DELETE \
"http://localhost/api/v1/admin/user/1" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"http://localhost/api/v1/admin/user/1"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "DELETE",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
HTTP Request
DELETE api/v1/admin/user/{user}
api/v1/admin/users/{id}
Example request:
curl -X POST \
"http://localhost/api/v1/admin/users/1" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"http://localhost/api/v1/admin/users/1"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "POST",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
HTTP Request
POST api/v1/admin/users/{id}
Display a listing of the resource.

Example request:
curl -X POST \
"http://localhost/api/v1/retailer/dashboard/user/1" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"http://localhost/api/v1/retailer/dashboard/user/1"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "POST",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
HTTP Request
POST api/v1/retailer/dashboard/user/{id}
api/v1/retailer/dashboard/verified_riders
Example request:
curl -X GET \
-G "http://localhost/api/v1/retailer/dashboard/verified_riders" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"http://localhost/api/v1/retailer/dashboard/verified_riders"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
Example response (429):
{
"message": "Too Many Attempts."
}
HTTP Request
GET api/v1/retailer/dashboard/verified_riders
api/v1/retailer/dashboard/dial_a_rider/{id}
Example request:
curl -X POST \
"http://localhost/api/v1/retailer/dashboard/dial_a_rider/1" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"http://localhost/api/v1/retailer/dashboard/dial_a_rider/1"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "POST",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
HTTP Request
POST api/v1/retailer/dashboard/dial_a_rider/{id}
Update the specified resource in storage.
Example request:
curl -X POST \
"http://localhost/api/v1/rider/dashboard/user/1" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"http://localhost/api/v1/rider/dashboard/user/1"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "POST",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
HTTP Request
POST api/v1/rider/dashboard/user/{id}
api/v1/rider/dashboard/documents
Example request:
curl -X POST \
"http://localhost/api/v1/rider/dashboard/documents" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"http://localhost/api/v1/rider/dashboard/documents"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "POST",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
HTTP Request
POST api/v1/rider/dashboard/documents
api/v1/rider/dashboard/docs/{id}
Example request:
curl -X GET \
-G "http://localhost/api/v1/rider/dashboard/docs/1" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"http://localhost/api/v1/rider/dashboard/docs/1"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
Example response (429):
{
"message": "Too Many Attempts."
}
HTTP Request
GET api/v1/rider/dashboard/docs/{id}
api/v1/rider/dashboard/deleteDocs/{id}
Example request:
curl -X DELETE \
"http://localhost/api/v1/rider/dashboard/deleteDocs/1" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"http://localhost/api/v1/rider/dashboard/deleteDocs/1"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "DELETE",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
HTTP Request
DELETE api/v1/rider/dashboard/deleteDocs/{id}
api/v1/rider/fcm-token
Example request:
curl -X POST \
"http://localhost/api/v1/rider/fcm-token" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"http://localhost/api/v1/rider/fcm-token"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "POST",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
HTTP Request
POST api/v1/rider/fcm-token
Show the application's login form.
Example request:
curl -X GET \
-G "http://localhost/login" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"http://localhost/login"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
Example response (200):
null
HTTP Request
GET login
Handle a login request to the application.
Example request:
curl -X POST \
"http://localhost/login" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"http://localhost/login"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "POST",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
HTTP Request
POST login
Log the user out of the application.
Example request:
curl -X POST \
"http://localhost/logout" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"http://localhost/logout"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "POST",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
HTTP Request
POST logout
Show the application registration form.
Example request:
curl -X GET \
-G "http://localhost/register" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"http://localhost/register"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
Example response (200):
null
HTTP Request
GET register
Handle a registration request for the application.
Example request:
curl -X POST \
"http://localhost/register" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"http://localhost/register"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "POST",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
HTTP Request
POST register
Display the form to request a password reset link.
Example request:
curl -X GET \
-G "http://localhost/password/reset" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"http://localhost/password/reset"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
Example response (200):
null
HTTP Request
GET password/reset
Send a reset link to the given user.
Example request:
curl -X POST \
"http://localhost/password/email" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"http://localhost/password/email"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "POST",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
HTTP Request
POST password/email
Display the password reset view for the given token.
If no token is present, display the link request form.
Example request:
curl -X GET \
-G "http://localhost/password/reset/1" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"http://localhost/password/reset/1"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
Example response (200):
null
HTTP Request
GET password/reset/{token}
Reset the given user's password.
Example request:
curl -X POST \
"http://localhost/password/reset" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"http://localhost/password/reset"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "POST",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
HTTP Request
POST password/reset
Display the password confirmation view.
Example request:
curl -X GET \
-G "http://localhost/password/confirm" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"http://localhost/password/confirm"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
Example response (401):
{
"message": "Unauthenticated."
}
HTTP Request
GET password/confirm
Confirm the given user's password.
Example request:
curl -X POST \
"http://localhost/password/confirm" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"http://localhost/password/confirm"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "POST",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
HTTP Request
POST password/confirm
Show the application dashboard.
Example request:
curl -X GET \
-G "http://localhost/home" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"http://localhost/home"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
Example response (401):
{
"message": "Unauthenticated."
}
HTTP Request
GET home