openapi: 3.0.3
info:
title: 'ECom API'
description: ''
version: 1.0.0
servers:
-
url: 'https://ecomapi.bmehul.com'
paths:
/api/v1/admin/generate:
post:
summary: 'Generate the admin user'
operationId: generateTheAdminUser
description: "API to generate the super administrator. It is only a one-time call\nin the entire lifetime of the application."
parameters: []
responses: { }
tags:
- 'Generate Administrator'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
first_name:
type: string
description: 'Required. Your first name.'
example: John
nullable: false
last_name:
type: string
description: 'Required. Your last name.'
example: Doe
nullable: false
email:
type: string
description: 'Required. Should be a valid and unique email address. This will be used at the time of signing in to the application. Must be a valid email address.'
example: johndoe@example.com
nullable: false
password:
type: string
description: 'Required. Choose a strong password.'
example: Secret
nullable: false
confirm_password:
type: string
description: 'Required. Should be same as password field. The value and password must match.'
example: Secret
nullable: false
required:
- first_name
- last_name
- email
- password
- confirm_password
security: []
/api/common/register:
post:
summary: Registration
operationId: registration
description: 'API to register a user in the application.'
parameters: []
responses:
201:
description: ''
content:
application/json:
schema:
type: object
example:
status: success
message: 'You have registered successfully.'
data:
first_name: John
last_name: Doe
email: johndoe@example.com
updated_at: '2023-06-01T14:46:10.000000Z'
created_at: '2023-06-01T14:46:10.000000Z'
id: 2
properties:
status:
type: string
example: success
message:
type: string
example: 'You have registered successfully.'
data:
type: object
properties:
first_name:
type: string
example: John
last_name:
type: string
example: Doe
email:
type: string
example: johndoe@example.com
updated_at:
type: string
example: '2023-06-01T14:46:10.000000Z'
created_at:
type: string
example: '2023-06-01T14:46:10.000000Z'
id:
type: integer
example: 2
422:
description: ''
content:
text/plain:
schema:
type: string
example: "{\n \"message\": \"The first name field is required. (and 4 more errors)\",\n \"errors\": {\n \"first_name\": [\n \"The first name field is required.\",\n ],\n \"last_name\": [\n \"The last name field is required.\",\n ],\n \"email\": [\n \"The email field is required.\",\n ],\n \"password\": [\n \"The password field is required.\",\n ],\n \"confirm_password\": [\n \"The confirm password field is required.\",\n ]\n }\n}\n"
tags:
- 'Common Endpoints'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
first_name:
type: string
description: 'Required. Your first name.'
example: John
nullable: false
last_name:
type: string
description: 'Required. Your last name.'
example: Doe
nullable: false
email:
type: string
description: 'Required. Should be a valid and unique email address. This will be used at the time of signing in to the application. Must be a valid email address.'
example: johndoe@example.com
nullable: false
password:
type: string
description: 'Required. Choose a strong password.'
example: Secret
nullable: false
confirm_password:
type: string
description: 'Required. Should be same as password field. The value and password must match.'
example: Secret
nullable: false
required:
- first_name
- last_name
- email
- password
- confirm_password
security: []
/api/common/login:
post:
summary: Login
operationId: login
description: "Login the user (admin and non-admin), and generate the bearer token.\nThis token will be used for further requests in the admin user panel or in the non-admin user panel."
parameters: []
responses: { }
tags:
- 'Common Endpoints'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
email:
type: string
description: 'Requred. The email address of the user that you are trying to authenticate. Should be a valid email address. Must be a valid email address. The email of an existing record in the users table.'
example: userone@example.com
nullable: false
password:
type: string
description: 'Required. The password associated with the above email address.'
example: Secret
nullable: false
required:
- email
- password
security: []
/api/common/forgot-password:
post:
summary: 'Send Password Reset Link'
operationId: sendPasswordResetLink
description: 'Send the password reset link to the provided email address via an E-Mail.'
parameters: []
responses: { }
tags:
- 'Common Endpoints'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
email:
type: string
description: 'Required. The email address that you have registered your account with. Should be a valid email address. Must be a valid email address. The email of an existing record in the users table.'
example: userone@example.com
nullable: false
required:
- email
security: []
/api/common/reset-password:
post:
summary: 'Reset Password'
operationId: resetPassword
description: "Reset the admin's or the user's password with the new password.\nDeletes the record from the database table after resetting."
parameters: []
responses: { }
tags:
- 'Common Endpoints'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
email:
type: string
description: 'Required. The email address that you have registered with. Should be valid and should exist in the application. Must be a valid email address. The email of an existing record in the password_reset_tokens table.'
example: johndoe@example.com
nullable: false
token:
type: string
description: 'Required. The token that was sent to the email address. The token of an existing record in the password_reset_tokens table.'
example: PZj7o5NBJmWhmaJ6mAH8zMSOck5vFTlPOuaT
nullable: false
new_password:
type: string
description: 'Required. The new password to log in to your account.'
example: Secret
nullable: false
repeat_new_password:
type: string
description: 'Required. Repeat the same password that has been added in new_password field. The value and new_password must match.'
example: Secret
nullable: false
required:
- email
- token
- new_password
- repeat_new_password
security: []
/api/common/logout:
post:
summary: Logout
operationId: logout
description: "Logout the admin user or non-admin user. When they log out, all the tokens\nrelated to their account will also get deleted."
parameters: []
responses: { }
tags:
- 'Common Endpoints'
/api/common/account-settings/general:
put:
summary: 'General Settings'
operationId: generalSettings
description: 'Update the general settings of the user.'
parameters: []
responses:
201:
description: ''
content:
application/json:
schema:
type: object
example:
status: success
message: 'General Settings updated successfully.'
data:
id: 1
first_name: John
last_name: Doe
email: johndoe@example.com
created_at: '2023-05-17T00:00:00.000000Z'
updated_at: '2023-05-17T00:00:00.000000Z'
deleted_at: null
properties:
status:
type: string
example: success
message:
type: string
example: 'General Settings updated successfully.'
data:
type: object
properties:
id:
type: integer
example: 1
first_name:
type: string
example: John
last_name:
type: string
example: Doe
email:
type: string
example: johndoe@example.com
created_at:
type: string
example: '2023-05-17T00:00:00.000000Z'
updated_at:
type: string
example: '2023-05-17T00:00:00.000000Z'
deleted_at:
type: string
example: null
tags:
- 'Common Endpoints'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
first_name:
type: string
description: 'The first name of the admin user.'
example: John
nullable: false
last_name:
type: string
description: 'The last name of the admin user.'
example: Doe
nullable: false
email:
type: string
description: 'The email of the admin user.'
example: johndoe@example.com
nullable: false
required:
- first_name
- last_name
- email
/api/common/account-settings/change-password:
put:
summary: 'Change Password'
operationId: changePassword
description: "Update the password of the currently authenticated admin user.\nIt will be updated only when the current password is matched."
parameters: []
responses:
201:
description: ''
content:
application/json:
schema:
type: object
example:
status: success
message: 'Password updated successfully.'
data: []
properties:
status:
type: string
example: success
message:
type: string
example: 'Password updated successfully.'
data:
type: array
example: []
tags:
- 'Common Endpoints'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
current_password:
type: string
description: "The admin user's current password."
example: Pa$$w0rd
nullable: false
new_password:
type: string
description: 'The new password.'
example: Secret
nullable: false
new_password_confirmation:
type: string
description: 'Confirm the new password, should match new_password.'
example: Secret
nullable: false
required:
- current_password
- new_password
- new_password_confirmation
/api/v1/admin/categories:
get:
summary: 'List All categories'
operationId: listAllCategories
description: "Display all the categories with pagination.\nAt a time, there are total of 16 records that will be displayed."
parameters:
-
in: query
name: page
description: 'The page number. Defaults to 1.'
example: 1
required: false
schema:
type: integer
description: 'The page number. Defaults to 1.'
example: 1
nullable: false
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
status: success
message: ''
data:
current_page: 1
data:
-
id: 1
name: 'Qui Nobis Nisi'
slug: qui-nobis-nisi
meta_title: 'Qui Nobis Nisi Laravel E-Commerce API'
meta_description: 'Qui Nobis Nisi Laravel E-Commerce API'
meta_keywords: 'Qui Nobis Nisi Laravel E-Commerce API'
-
id: 2
name: 'Aut Et Quidem'
slug: aut-et-quidem
meta_title: 'Aut Et Quidem Laravel E-Commerce API'
meta_description: 'Aut Et Quidem Laravel E-Commerce API'
meta_keywords: 'Aut Et Quidem Laravel E-Commerce API'
-
id: 3
name: 'Nostrum Aut Optio'
slug: nostrum-aut-optio
meta_title: 'Nostrum Aut Optio Laravel E-Commerce API'
meta_description: 'Nostrum Aut Optio Laravel E-Commerce API'
meta_keywords: 'Nostrum Aut Optio Laravel E-Commerce API'
-
id: 4
name: 'Perspiciatis Commodi Est'
slug: perspiciatis-commodi-est
meta_title: 'Perspiciatis Commodi Est Laravel E-Commerce API'
meta_description: 'Perspiciatis Commodi Est Laravel E-Commerce API'
meta_keywords: 'Perspiciatis Commodi Est Laravel E-Commerce API'
-
id: 5
name: 'Nisi In Eveniet'
slug: nisi-in-eveniet
meta_title: 'Nisi In Eveniet Laravel E-Commerce API'
meta_description: 'Nisi In Eveniet Laravel E-Commerce API'
meta_keywords: 'Nisi In Eveniet Laravel E-Commerce API'
-
id: 6
name: 'Possimus Placeat Ad'
slug: possimus-placeat-ad
meta_title: 'Possimus Placeat Ad Laravel E-Commerce API'
meta_description: 'Possimus Placeat Ad Laravel E-Commerce API'
meta_keywords: 'Possimus Placeat Ad Laravel E-Commerce API'
-
id: 7
name: 'Maiores Quia Ut'
slug: maiores-quia-ut
meta_title: 'Maiores Quia Ut Laravel E-Commerce API'
meta_description: 'Maiores Quia Ut Laravel E-Commerce API'
meta_keywords: 'Maiores Quia Ut Laravel E-Commerce API'
-
id: 8
name: 'Qui Repellat Molestias'
slug: qui-repellat-molestias
meta_title: 'Qui Repellat Molestias Laravel E-Commerce API'
meta_description: 'Qui Repellat Molestias Laravel E-Commerce API'
meta_keywords: 'Qui Repellat Molestias Laravel E-Commerce API'
-
id: 9
name: 'Nisi Soluta Nihil'
slug: nisi-soluta-nihil
meta_title: 'Nisi Soluta Nihil Laravel E-Commerce API'
meta_description: 'Nisi Soluta Nihil Laravel E-Commerce API'
meta_keywords: 'Nisi Soluta Nihil Laravel E-Commerce API'
-
id: 10
name: 'Esse Placeat Corrupti'
slug: esse-placeat-corrupti
meta_title: 'Esse Placeat Corrupti Laravel E-Commerce API'
meta_description: 'Esse Placeat Corrupti Laravel E-Commerce API'
meta_keywords: 'Esse Placeat Corrupti Laravel E-Commerce API'
-
id: 11
name: 'Est Quas Libero'
slug: est-quas-libero
meta_title: 'Est Quas Libero Laravel E-Commerce API'
meta_description: 'Est Quas Libero Laravel E-Commerce API'
meta_keywords: 'Est Quas Libero Laravel E-Commerce API'
-
id: 12
name: 'Dolorem Beatae Ipsa'
slug: dolorem-beatae-ipsa
meta_title: 'Dolorem Beatae Ipsa Laravel E-Commerce API'
meta_description: 'Dolorem Beatae Ipsa Laravel E-Commerce API'
meta_keywords: 'Dolorem Beatae Ipsa Laravel E-Commerce API'
-
id: 13
name: 'Voluptatem Dolorem Doloremque'
slug: voluptatem-dolorem-doloremque
meta_title: 'Voluptatem Dolorem Doloremque Laravel E-Commerce API'
meta_description: 'Voluptatem Dolorem Doloremque Laravel E-Commerce API'
meta_keywords: 'Voluptatem Dolorem Doloremque Laravel E-Commerce API'
-
id: 14
name: 'Necessitatibus Doloribus Beatae'
slug: necessitatibus-doloribus-beatae
meta_title: 'Necessitatibus Doloribus Beatae Laravel E-Commerce API'
meta_description: 'Necessitatibus Doloribus Beatae Laravel E-Commerce API'
meta_keywords: 'Necessitatibus Doloribus Beatae Laravel E-Commerce API'
-
id: 15
name: 'Corrupti Eveniet Dolor'
slug: corrupti-eveniet-dolor
meta_title: 'Corrupti Eveniet Dolor Laravel E-Commerce API'
meta_description: 'Corrupti Eveniet Dolor Laravel E-Commerce API'
meta_keywords: 'Corrupti Eveniet Dolor Laravel E-Commerce API'
-
id: 16
name: 'Dolorum Commodi Qui'
slug: dolorum-commodi-qui
meta_title: 'Dolorum Commodi Qui Laravel E-Commerce API'
meta_description: 'Dolorum Commodi Qui Laravel E-Commerce API'
meta_keywords: 'Dolorum Commodi Qui Laravel E-Commerce API'
first_page_url: 'http://localhost:8000/api/v1/admin/categories?page=1'
from: 1
last_page: 4
last_page_url: 'http://localhost:8000/api/v1/admin/categories?page=4'
links:
-
url: null
label: '« Previous'
active: false
-
url: 'http://localhost:8000/api/v1/admin/categories?page=1'
label: '1'
active: true
-
url: 'http://localhost:8000/api/v1/admin/categories?page=2'
label: '2'
active: false
-
url: 'http://localhost:8000/api/v1/admin/categories?page=3'
label: '3'
active: false
-
url: 'http://localhost:8000/api/v1/admin/categories?page=4'
label: '4'
active: false
-
url: 'http://localhost:8000/api/v1/admin/categories?page=2'
label: 'Next »'
active: false
next_page_url: 'http://localhost:8000/api/v1/admin/categories?page=2'
path: 'http://localhost:8000/api/v1/admin/categories'
per_page: 16
prev_page_url: null
to: 16
total: 50
properties:
status:
type: string
example: success
message:
type: string
example: ''
data:
type: object
properties:
current_page:
type: integer
example: 1
data:
type: array
example:
-
id: 1
name: 'Qui Nobis Nisi'
slug: qui-nobis-nisi
meta_title: 'Qui Nobis Nisi Laravel E-Commerce API'
meta_description: 'Qui Nobis Nisi Laravel E-Commerce API'
meta_keywords: 'Qui Nobis Nisi Laravel E-Commerce API'
-
id: 2
name: 'Aut Et Quidem'
slug: aut-et-quidem
meta_title: 'Aut Et Quidem Laravel E-Commerce API'
meta_description: 'Aut Et Quidem Laravel E-Commerce API'
meta_keywords: 'Aut Et Quidem Laravel E-Commerce API'
-
id: 3
name: 'Nostrum Aut Optio'
slug: nostrum-aut-optio
meta_title: 'Nostrum Aut Optio Laravel E-Commerce API'
meta_description: 'Nostrum Aut Optio Laravel E-Commerce API'
meta_keywords: 'Nostrum Aut Optio Laravel E-Commerce API'
-
id: 4
name: 'Perspiciatis Commodi Est'
slug: perspiciatis-commodi-est
meta_title: 'Perspiciatis Commodi Est Laravel E-Commerce API'
meta_description: 'Perspiciatis Commodi Est Laravel E-Commerce API'
meta_keywords: 'Perspiciatis Commodi Est Laravel E-Commerce API'
-
id: 5
name: 'Nisi In Eveniet'
slug: nisi-in-eveniet
meta_title: 'Nisi In Eveniet Laravel E-Commerce API'
meta_description: 'Nisi In Eveniet Laravel E-Commerce API'
meta_keywords: 'Nisi In Eveniet Laravel E-Commerce API'
-
id: 6
name: 'Possimus Placeat Ad'
slug: possimus-placeat-ad
meta_title: 'Possimus Placeat Ad Laravel E-Commerce API'
meta_description: 'Possimus Placeat Ad Laravel E-Commerce API'
meta_keywords: 'Possimus Placeat Ad Laravel E-Commerce API'
-
id: 7
name: 'Maiores Quia Ut'
slug: maiores-quia-ut
meta_title: 'Maiores Quia Ut Laravel E-Commerce API'
meta_description: 'Maiores Quia Ut Laravel E-Commerce API'
meta_keywords: 'Maiores Quia Ut Laravel E-Commerce API'
-
id: 8
name: 'Qui Repellat Molestias'
slug: qui-repellat-molestias
meta_title: 'Qui Repellat Molestias Laravel E-Commerce API'
meta_description: 'Qui Repellat Molestias Laravel E-Commerce API'
meta_keywords: 'Qui Repellat Molestias Laravel E-Commerce API'
-
id: 9
name: 'Nisi Soluta Nihil'
slug: nisi-soluta-nihil
meta_title: 'Nisi Soluta Nihil Laravel E-Commerce API'
meta_description: 'Nisi Soluta Nihil Laravel E-Commerce API'
meta_keywords: 'Nisi Soluta Nihil Laravel E-Commerce API'
-
id: 10
name: 'Esse Placeat Corrupti'
slug: esse-placeat-corrupti
meta_title: 'Esse Placeat Corrupti Laravel E-Commerce API'
meta_description: 'Esse Placeat Corrupti Laravel E-Commerce API'
meta_keywords: 'Esse Placeat Corrupti Laravel E-Commerce API'
-
id: 11
name: 'Est Quas Libero'
slug: est-quas-libero
meta_title: 'Est Quas Libero Laravel E-Commerce API'
meta_description: 'Est Quas Libero Laravel E-Commerce API'
meta_keywords: 'Est Quas Libero Laravel E-Commerce API'
-
id: 12
name: 'Dolorem Beatae Ipsa'
slug: dolorem-beatae-ipsa
meta_title: 'Dolorem Beatae Ipsa Laravel E-Commerce API'
meta_description: 'Dolorem Beatae Ipsa Laravel E-Commerce API'
meta_keywords: 'Dolorem Beatae Ipsa Laravel E-Commerce API'
-
id: 13
name: 'Voluptatem Dolorem Doloremque'
slug: voluptatem-dolorem-doloremque
meta_title: 'Voluptatem Dolorem Doloremque Laravel E-Commerce API'
meta_description: 'Voluptatem Dolorem Doloremque Laravel E-Commerce API'
meta_keywords: 'Voluptatem Dolorem Doloremque Laravel E-Commerce API'
-
id: 14
name: 'Necessitatibus Doloribus Beatae'
slug: necessitatibus-doloribus-beatae
meta_title: 'Necessitatibus Doloribus Beatae Laravel E-Commerce API'
meta_description: 'Necessitatibus Doloribus Beatae Laravel E-Commerce API'
meta_keywords: 'Necessitatibus Doloribus Beatae Laravel E-Commerce API'
-
id: 15
name: 'Corrupti Eveniet Dolor'
slug: corrupti-eveniet-dolor
meta_title: 'Corrupti Eveniet Dolor Laravel E-Commerce API'
meta_description: 'Corrupti Eveniet Dolor Laravel E-Commerce API'
meta_keywords: 'Corrupti Eveniet Dolor Laravel E-Commerce API'
-
id: 16
name: 'Dolorum Commodi Qui'
slug: dolorum-commodi-qui
meta_title: 'Dolorum Commodi Qui Laravel E-Commerce API'
meta_description: 'Dolorum Commodi Qui Laravel E-Commerce API'
meta_keywords: 'Dolorum Commodi Qui Laravel E-Commerce API'
items:
type: object
properties:
id:
type: integer
example: 1
name:
type: string
example: 'Qui Nobis Nisi'
slug:
type: string
example: qui-nobis-nisi
meta_title:
type: string
example: 'Qui Nobis Nisi Laravel E-Commerce API'
meta_description:
type: string
example: 'Qui Nobis Nisi Laravel E-Commerce API'
meta_keywords:
type: string
example: 'Qui Nobis Nisi Laravel E-Commerce API'
first_page_url:
type: string
example: 'http://localhost:8000/api/v1/admin/categories?page=1'
from:
type: integer
example: 1
last_page:
type: integer
example: 4
last_page_url:
type: string
example: 'http://localhost:8000/api/v1/admin/categories?page=4'
links:
type: array
example:
-
url: null
label: '« Previous'
active: false
-
url: 'http://localhost:8000/api/v1/admin/categories?page=1'
label: '1'
active: true
-
url: 'http://localhost:8000/api/v1/admin/categories?page=2'
label: '2'
active: false
-
url: 'http://localhost:8000/api/v1/admin/categories?page=3'
label: '3'
active: false
-
url: 'http://localhost:8000/api/v1/admin/categories?page=4'
label: '4'
active: false
-
url: 'http://localhost:8000/api/v1/admin/categories?page=2'
label: 'Next »'
active: false
items:
type: object
properties:
url:
type: string
example: null
label:
type: string
example: '« Previous'
active:
type: boolean
example: false
next_page_url:
type: string
example: 'http://localhost:8000/api/v1/admin/categories?page=2'
path:
type: string
example: 'http://localhost:8000/api/v1/admin/categories'
per_page:
type: integer
example: 16
prev_page_url:
type: string
example: null
to:
type: integer
example: 16
total:
type: integer
example: 50
tags:
- 'Administrator Endpoints'
post:
summary: 'Add new category'
operationId: addNewCategory
description: "Create a new category and store it's details."
parameters: []
responses:
201:
description: ''
content:
application/json:
schema:
type: object
example:
status: success
message: 'Category added successfully.'
data:
name: 'Category 1'
description: 'Qui aut quia soluta ut et repellendus aut.'
meta_title: jqfpfenwpledzbrovcmnsylb
meta_description: sdovbzcbfmbwnxpgvrqzdi
meta_keywords: dvrisbpzc
slug: qblbi
updated_at: '2023-05-18T00:00:00.000000Z'
created_at: '2023-05-18T00:00:00.000000Z'
id: 1
properties:
status:
type: string
example: success
message:
type: string
example: 'Category added successfully.'
data:
type: object
properties:
name:
type: string
example: 'Category 1'
description:
type: string
example: 'Qui aut quia soluta ut et repellendus aut.'
meta_title:
type: string
example: jqfpfenwpledzbrovcmnsylb
meta_description:
type: string
example: sdovbzcbfmbwnxpgvrqzdi
meta_keywords:
type: string
example: dvrisbpzc
slug:
type: string
example: qblbi
updated_at:
type: string
example: '2023-05-18T00:00:00.000000Z'
created_at:
type: string
example: '2023-05-18T00:00:00.000000Z'
id:
type: integer
example: 1
422:
description: ''
content:
application/json:
schema:
type: object
example:
message: 'The name field is required. (and 3 more errors)'
errors:
name:
- 'The name field is required.'
description:
- 'The description field is required.'
meta_title:
- 'The meta title field is required.'
meta_description:
- 'The meta description field is required.'
properties:
message:
type: string
example: 'The name field is required. (and 3 more errors)'
errors:
type: object
properties:
name:
type: array
example:
- 'The name field is required.'
items:
type: string
description:
type: array
example:
- 'The description field is required.'
items:
type: string
meta_title:
type: array
example:
- 'The meta title field is required.'
items:
type: string
meta_description:
type: array
example:
- 'The meta description field is required.'
items:
type: string
tags:
- 'Administrator Endpoints'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
name:
type: string
description: 'Required. The name of the category, should be unique. Must not be greater than 100 characters.'
example: 'T-shirt for Women'
nullable: false
description:
type: string
description: 'Required. The description of the category. Must not be greater than 255 characters.'
example: 'T-shirt for Women made of the best quality materials sold all over the world.'
nullable: false
meta_title:
type: string
description: 'Required. The title of the page. Refers to the text that is displayed on search engine result pages and browser tabs to indicate the topic of a webpage. Must not be greater than 80 characters.'
example: 'T-shirt for Women made of the best quality materials.'
nullable: false
meta_description:
type: string
description: 'Required. This informs and interests users with a short, relevant summary of what a particular page is about. Must not be greater than 180 characters.'
example: 'T-shirt for Women made of the best quality materials sold all over the world.'
nullable: false
meta_keywords:
type: string
description: 'A comma separated words or phrases related to the category. Must not be greater than 255 characters.'
example: 'T-shirt, t-shirt for women, best quality tshirt for women'
nullable: true
required:
- name
- description
- meta_title
- meta_description
'/api/v1/admin/categories/{id}':
get:
summary: 'Get single category'
operationId: getSingleCategory
description: 'Fetch the details about the given category id.'
parameters: []
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
status: success
message: ''
data:
name: 'Category 1'
description: 'Qui aut quia soluta ut et repellendus aut.'
meta_title: jqfpfenwpledzbrovcmnsylb
meta_description: sdovbzcbfmbwnxpgvrqzdi
meta_keywords: dvrisbpzc
id: 1
properties:
status:
type: string
example: success
message:
type: string
example: ''
data:
type: object
properties:
name:
type: string
example: 'Category 1'
description:
type: string
example: 'Qui aut quia soluta ut et repellendus aut.'
meta_title:
type: string
example: jqfpfenwpledzbrovcmnsylb
meta_description:
type: string
example: sdovbzcbfmbwnxpgvrqzdi
meta_keywords:
type: string
example: dvrisbpzc
id:
type: integer
example: 1
404:
description: ''
content:
application/json:
schema:
type: object
example:
status: failed
message: 'Category not found.'
data: []
properties:
status:
type: string
example: failed
message:
type: string
example: 'Category not found.'
data:
type: array
example: []
tags:
- 'Administrator Endpoints'
put:
summary: 'Update category'
operationId: updateCategory
description: 'Update the category details of the given id.'
parameters: []
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
status: success
message: 'Category updated successfully.'
data:
name: 'Category 1'
description: 'Qui aut quia soluta ut et repellendus aut.'
meta_title: jqfpfenwpledzbrovcmnsylb
meta_description: sdovbzcbfmbwnxpgvrqzdi
meta_keywords: dvrisbpzc
slug: qblbi
updated_at: '2023-05-18T00:00:00.000000Z'
created_at: '2023-05-18T00:00:00.000000Z'
id: 1
properties:
status:
type: string
example: success
message:
type: string
example: 'Category updated successfully.'
data:
type: object
properties:
name:
type: string
example: 'Category 1'
description:
type: string
example: 'Qui aut quia soluta ut et repellendus aut.'
meta_title:
type: string
example: jqfpfenwpledzbrovcmnsylb
meta_description:
type: string
example: sdovbzcbfmbwnxpgvrqzdi
meta_keywords:
type: string
example: dvrisbpzc
slug:
type: string
example: qblbi
updated_at:
type: string
example: '2023-05-18T00:00:00.000000Z'
created_at:
type: string
example: '2023-05-18T00:00:00.000000Z'
id:
type: integer
example: 1
404:
description: ''
content:
application/json:
schema:
type: object
example:
status: failed
message: 'Category not found.'
data: []
properties:
status:
type: string
example: failed
message:
type: string
example: 'Category not found.'
data:
type: array
example: []
422:
description: ''
content:
application/json:
schema:
type: object
example:
message: 'The name field is required. (and 3 more errors)'
errors:
name:
- 'The name field is required.'
description:
- 'The description field is required.'
meta_title:
- 'The meta title field is required.'
meta_description:
- 'The meta description field is required.'
properties:
message:
type: string
example: 'The name field is required. (and 3 more errors)'
errors:
type: object
properties:
name:
type: array
example:
- 'The name field is required.'
items:
type: string
description:
type: array
example:
- 'The description field is required.'
items:
type: string
meta_title:
type: array
example:
- 'The meta title field is required.'
items:
type: string
meta_description:
type: array
example:
- 'The meta description field is required.'
items:
type: string
tags:
- 'Administrator Endpoints'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
name:
type: string
description: 'Required. The name of the category, should be unique. Must not be greater than 100 characters.'
example: 'T-shirt for Women'
nullable: false
description:
type: string
description: 'Required. The description of the category. Must not be greater than 255 characters.'
example: 'T-shirt for Women made of the best quality materials sold all over the world.'
nullable: false
meta_title:
type: string
description: 'Required. The title of the page. Refers to the text that is displayed on search engine result pages and browser tabs to indicate the topic of a webpage. Must not be greater than 80 characters.'
example: 'T-shirt for Women made of the best quality materials.'
nullable: false
meta_description:
type: string
description: 'Required. This informs and interests users with a short, relevant summary of what a particular page is about. Must not be greater than 180 characters.'
example: 'T-shirt for Women made of the best quality materials sold all over the world.'
nullable: false
meta_keywords:
type: string
description: 'A comma separated words or phrases related to the category. Must not be greater than 255 characters.'
example: 'T-shirt, t-shirt for women, best quality tshirt for women'
nullable: true
required:
- name
- description
- meta_title
- meta_description
delete:
summary: 'Delete a category'
operationId: deleteACategory
description: "Delete the category details of the given id.\nThis will soft delete the category.\nMeaning the record will be present in the database, however,\nit won't be available to access."
parameters: []
responses:
200:
description: ''
content:
text/plain:
schema:
type: string
example: "{\n \"status\": \"success\",\n \"message\": \"Category deleted successfully.\",\n \"data\": [],\n}\n"
404:
description: ''
content:
application/json:
schema:
type: object
example:
status: failed
message: 'Category not found.'
data: []
properties:
status:
type: string
example: failed
message:
type: string
example: 'Category not found.'
data:
type: array
example: []
tags:
- 'Administrator Endpoints'
parameters:
-
in: path
name: id
description: 'The id of the category.'
example: 1
required: true
schema:
type: integer
/api/v1/admin/tags:
get:
summary: 'List All tags'
operationId: listAllTags
description: "Display all the tags with pagination.\nAt a time, there are total of 16 records that will be displayed."
parameters:
-
in: query
name: page
description: 'The page number. Defaults to 1.'
example: 1
required: false
schema:
type: integer
description: 'The page number. Defaults to 1.'
example: 1
nullable: false
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
status: success
message: ''
data:
current_page: 1
data:
-
id: 1
name: 'Laborum Tempora Maxime'
slug: laborum-tempora-maxime
description: 'Eos qui esse magnam molestiae dolorem perspiciatis.'
meta_title: 'Laborum Tempora Maxime Laravel E-Commerce API'
meta_description: 'Laborum Tempora Maxime Laravel E-Commerce API'
meta_keywords: 'Laborum Tempora Maxime Laravel E-Commerce API'
-
id: 2
name: 'Officiis Sit Cum'
slug: officiis-sit-cum
description: 'Dolores optio sapiente voluptatem.'
meta_title: 'Officiis Sit Cum Laravel E-Commerce API'
meta_description: 'Officiis Sit Cum Laravel E-Commerce API'
meta_keywords: 'Officiis Sit Cum Laravel E-Commerce API'
-
id: 3
name: 'Sed Eaque Sapiente'
slug: sed-eaque-sapiente
description: 'Nostrum est autem ut consectetur.'
meta_title: 'Sed Eaque Sapiente Laravel E-Commerce API'
meta_description: 'Sed Eaque Sapiente Laravel E-Commerce API'
meta_keywords: 'Sed Eaque Sapiente Laravel E-Commerce API'
-
id: 4
name: 'Porro Sunt Et'
slug: porro-sunt-et
description: 'Consequatur enim eos sed voluptatum eos.'
meta_title: 'Porro Sunt Et Laravel E-Commerce API'
meta_description: 'Porro Sunt Et Laravel E-Commerce API'
meta_keywords: 'Porro Sunt Et Laravel E-Commerce API'
-
id: 5
name: 'Voluptatem Esse Commodi'
slug: voluptatem-esse-commodi
description: 'Ipsum ullam voluptatem debitis dolorem.'
meta_title: 'Voluptatem Esse Commodi Laravel E-Commerce API'
meta_description: 'Voluptatem Esse Commodi Laravel E-Commerce API'
meta_keywords: 'Voluptatem Esse Commodi Laravel E-Commerce API'
-
id: 6
name: 'Fugit Maiores Voluptas'
slug: fugit-maiores-voluptas
description: 'Culpa aut sit voluptatem ut et.'
meta_title: 'Fugit Maiores Voluptas Laravel E-Commerce API'
meta_description: 'Fugit Maiores Voluptas Laravel E-Commerce API'
meta_keywords: 'Fugit Maiores Voluptas Laravel E-Commerce API'
-
id: 7
name: 'Et Ex Molestiae'
slug: et-ex-molestiae
description: 'Asperiores sit et natus.'
meta_title: 'Et Ex Molestiae Laravel E-Commerce API'
meta_description: 'Et Ex Molestiae Laravel E-Commerce API'
meta_keywords: 'Et Ex Molestiae Laravel E-Commerce API'
-
id: 8
name: 'Dicta Est Sunt'
slug: dicta-est-sunt
description: 'Tenetur eum aperiam non error.'
meta_title: 'Dicta Est Sunt Laravel E-Commerce API'
meta_description: 'Dicta Est Sunt Laravel E-Commerce API'
meta_keywords: 'Dicta Est Sunt Laravel E-Commerce API'
-
id: 9
name: 'Perferendis Earum Facilis'
slug: perferendis-earum-facilis
description: 'Aut aut molestiae similique commodi nam iure.'
meta_title: 'Perferendis Earum Facilis Laravel E-Commerce API'
meta_description: 'Perferendis Earum Facilis Laravel E-Commerce API'
meta_keywords: 'Perferendis Earum Facilis Laravel E-Commerce API'
-
id: 10
name: 'Vero Aut Architecto'
slug: vero-aut-architecto
description: 'Delectus dolorem mollitia eius.'
meta_title: 'Vero Aut Architecto Laravel E-Commerce API'
meta_description: 'Vero Aut Architecto Laravel E-Commerce API'
meta_keywords: 'Vero Aut Architecto Laravel E-Commerce API'
-
id: 11
name: 'Nihil Eum Aut'
slug: nihil-eum-aut
description: 'Voluptatem laboriosam eum error nulla quo facilis.'
meta_title: 'Nihil Eum Aut Laravel E-Commerce API'
meta_description: 'Nihil Eum Aut Laravel E-Commerce API'
meta_keywords: 'Nihil Eum Aut Laravel E-Commerce API'
-
id: 12
name: 'Omnis Optio Ipsam'
slug: omnis-optio-ipsam
description: 'Rerum eveniet et qui non minima aperiam id.'
meta_title: 'Omnis Optio Ipsam Laravel E-Commerce API'
meta_description: 'Omnis Optio Ipsam Laravel E-Commerce API'
meta_keywords: 'Omnis Optio Ipsam Laravel E-Commerce API'
-
id: 13
name: 'Incidunt Nesciunt Hic'
slug: incidunt-nesciunt-hic
description: 'Eum nulla laborum eius ut sit hic.'
meta_title: 'Incidunt Nesciunt Hic Laravel E-Commerce API'
meta_description: 'Incidunt Nesciunt Hic Laravel E-Commerce API'
meta_keywords: 'Incidunt Nesciunt Hic Laravel E-Commerce API'
-
id: 14
name: 'Velit Quia Sit'
slug: velit-quia-sit
description: 'Deleniti voluptatem rerum et necessitatibus voluptas.'
meta_title: 'Velit Quia Sit Laravel E-Commerce API'
meta_description: 'Velit Quia Sit Laravel E-Commerce API'
meta_keywords: 'Velit Quia Sit Laravel E-Commerce API'
-
id: 15
name: 'Omnis Sint Est'
slug: omnis-sint-est
description: 'Totam quasi velit occaecati non ducimus.'
meta_title: 'Omnis Sint Est Laravel E-Commerce API'
meta_description: 'Omnis Sint Est Laravel E-Commerce API'
meta_keywords: 'Omnis Sint Est Laravel E-Commerce API'
-
id: 16
name: 'Inventore Earum Aliquam'
slug: inventore-earum-aliquam
description: 'Libero commodi laboriosam ipsam accusantium laborum voluptas.'
meta_title: 'Inventore Earum Aliquam Laravel E-Commerce API'
meta_description: 'Inventore Earum Aliquam Laravel E-Commerce API'
meta_keywords: 'Inventore Earum Aliquam Laravel E-Commerce API'
first_page_url: 'http://localhost:8000?page=1'
from: 1
last_page: 4
last_page_url: 'http://localhost:8000?page=4'
links:
-
url: null
label: '« Previous'
active: false
-
url: 'http://localhost:8000?page=1'
label: '1'
active: true
-
url: 'http://localhost:8000?page=2'
label: '2'
active: false
-
url: 'http://localhost:8000?page=3'
label: '3'
active: false
-
url: 'http://localhost:8000?page=4'
label: '4'
active: false
-
url: 'http://localhost:8000?page=2'
label: 'Next »'
active: false
next_page_url: 'http://localhost:8000?page=2'
path: 'http://localhost:8000'
per_page: 16
prev_page_url: null
to: 16
total: 50
properties:
status:
type: string
example: success
message:
type: string
example: ''
data:
type: object
properties:
current_page:
type: integer
example: 1
data:
type: array
example:
-
id: 1
name: 'Laborum Tempora Maxime'
slug: laborum-tempora-maxime
description: 'Eos qui esse magnam molestiae dolorem perspiciatis.'
meta_title: 'Laborum Tempora Maxime Laravel E-Commerce API'
meta_description: 'Laborum Tempora Maxime Laravel E-Commerce API'
meta_keywords: 'Laborum Tempora Maxime Laravel E-Commerce API'
-
id: 2
name: 'Officiis Sit Cum'
slug: officiis-sit-cum
description: 'Dolores optio sapiente voluptatem.'
meta_title: 'Officiis Sit Cum Laravel E-Commerce API'
meta_description: 'Officiis Sit Cum Laravel E-Commerce API'
meta_keywords: 'Officiis Sit Cum Laravel E-Commerce API'
-
id: 3
name: 'Sed Eaque Sapiente'
slug: sed-eaque-sapiente
description: 'Nostrum est autem ut consectetur.'
meta_title: 'Sed Eaque Sapiente Laravel E-Commerce API'
meta_description: 'Sed Eaque Sapiente Laravel E-Commerce API'
meta_keywords: 'Sed Eaque Sapiente Laravel E-Commerce API'
-
id: 4
name: 'Porro Sunt Et'
slug: porro-sunt-et
description: 'Consequatur enim eos sed voluptatum eos.'
meta_title: 'Porro Sunt Et Laravel E-Commerce API'
meta_description: 'Porro Sunt Et Laravel E-Commerce API'
meta_keywords: 'Porro Sunt Et Laravel E-Commerce API'
-
id: 5
name: 'Voluptatem Esse Commodi'
slug: voluptatem-esse-commodi
description: 'Ipsum ullam voluptatem debitis dolorem.'
meta_title: 'Voluptatem Esse Commodi Laravel E-Commerce API'
meta_description: 'Voluptatem Esse Commodi Laravel E-Commerce API'
meta_keywords: 'Voluptatem Esse Commodi Laravel E-Commerce API'
-
id: 6
name: 'Fugit Maiores Voluptas'
slug: fugit-maiores-voluptas
description: 'Culpa aut sit voluptatem ut et.'
meta_title: 'Fugit Maiores Voluptas Laravel E-Commerce API'
meta_description: 'Fugit Maiores Voluptas Laravel E-Commerce API'
meta_keywords: 'Fugit Maiores Voluptas Laravel E-Commerce API'
-
id: 7
name: 'Et Ex Molestiae'
slug: et-ex-molestiae
description: 'Asperiores sit et natus.'
meta_title: 'Et Ex Molestiae Laravel E-Commerce API'
meta_description: 'Et Ex Molestiae Laravel E-Commerce API'
meta_keywords: 'Et Ex Molestiae Laravel E-Commerce API'
-
id: 8
name: 'Dicta Est Sunt'
slug: dicta-est-sunt
description: 'Tenetur eum aperiam non error.'
meta_title: 'Dicta Est Sunt Laravel E-Commerce API'
meta_description: 'Dicta Est Sunt Laravel E-Commerce API'
meta_keywords: 'Dicta Est Sunt Laravel E-Commerce API'
-
id: 9
name: 'Perferendis Earum Facilis'
slug: perferendis-earum-facilis
description: 'Aut aut molestiae similique commodi nam iure.'
meta_title: 'Perferendis Earum Facilis Laravel E-Commerce API'
meta_description: 'Perferendis Earum Facilis Laravel E-Commerce API'
meta_keywords: 'Perferendis Earum Facilis Laravel E-Commerce API'
-
id: 10
name: 'Vero Aut Architecto'
slug: vero-aut-architecto
description: 'Delectus dolorem mollitia eius.'
meta_title: 'Vero Aut Architecto Laravel E-Commerce API'
meta_description: 'Vero Aut Architecto Laravel E-Commerce API'
meta_keywords: 'Vero Aut Architecto Laravel E-Commerce API'
-
id: 11
name: 'Nihil Eum Aut'
slug: nihil-eum-aut
description: 'Voluptatem laboriosam eum error nulla quo facilis.'
meta_title: 'Nihil Eum Aut Laravel E-Commerce API'
meta_description: 'Nihil Eum Aut Laravel E-Commerce API'
meta_keywords: 'Nihil Eum Aut Laravel E-Commerce API'
-
id: 12
name: 'Omnis Optio Ipsam'
slug: omnis-optio-ipsam
description: 'Rerum eveniet et qui non minima aperiam id.'
meta_title: 'Omnis Optio Ipsam Laravel E-Commerce API'
meta_description: 'Omnis Optio Ipsam Laravel E-Commerce API'
meta_keywords: 'Omnis Optio Ipsam Laravel E-Commerce API'
-
id: 13
name: 'Incidunt Nesciunt Hic'
slug: incidunt-nesciunt-hic
description: 'Eum nulla laborum eius ut sit hic.'
meta_title: 'Incidunt Nesciunt Hic Laravel E-Commerce API'
meta_description: 'Incidunt Nesciunt Hic Laravel E-Commerce API'
meta_keywords: 'Incidunt Nesciunt Hic Laravel E-Commerce API'
-
id: 14
name: 'Velit Quia Sit'
slug: velit-quia-sit
description: 'Deleniti voluptatem rerum et necessitatibus voluptas.'
meta_title: 'Velit Quia Sit Laravel E-Commerce API'
meta_description: 'Velit Quia Sit Laravel E-Commerce API'
meta_keywords: 'Velit Quia Sit Laravel E-Commerce API'
-
id: 15
name: 'Omnis Sint Est'
slug: omnis-sint-est
description: 'Totam quasi velit occaecati non ducimus.'
meta_title: 'Omnis Sint Est Laravel E-Commerce API'
meta_description: 'Omnis Sint Est Laravel E-Commerce API'
meta_keywords: 'Omnis Sint Est Laravel E-Commerce API'
-
id: 16
name: 'Inventore Earum Aliquam'
slug: inventore-earum-aliquam
description: 'Libero commodi laboriosam ipsam accusantium laborum voluptas.'
meta_title: 'Inventore Earum Aliquam Laravel E-Commerce API'
meta_description: 'Inventore Earum Aliquam Laravel E-Commerce API'
meta_keywords: 'Inventore Earum Aliquam Laravel E-Commerce API'
items:
type: object
properties:
id:
type: integer
example: 1
name:
type: string
example: 'Laborum Tempora Maxime'
slug:
type: string
example: laborum-tempora-maxime
description:
type: string
example: 'Eos qui esse magnam molestiae dolorem perspiciatis.'
meta_title:
type: string
example: 'Laborum Tempora Maxime Laravel E-Commerce API'
meta_description:
type: string
example: 'Laborum Tempora Maxime Laravel E-Commerce API'
meta_keywords:
type: string
example: 'Laborum Tempora Maxime Laravel E-Commerce API'
first_page_url:
type: string
example: 'http://localhost:8000?page=1'
from:
type: integer
example: 1
last_page:
type: integer
example: 4
last_page_url:
type: string
example: 'http://localhost:8000?page=4'
links:
type: array
example:
-
url: null
label: '« Previous'
active: false
-
url: 'http://localhost:8000?page=1'
label: '1'
active: true
-
url: 'http://localhost:8000?page=2'
label: '2'
active: false
-
url: 'http://localhost:8000?page=3'
label: '3'
active: false
-
url: 'http://localhost:8000?page=4'
label: '4'
active: false
-
url: 'http://localhost:8000?page=2'
label: 'Next »'
active: false
items:
type: object
properties:
url:
type: string
example: null
label:
type: string
example: '« Previous'
active:
type: boolean
example: false
next_page_url:
type: string
example: 'http://localhost:8000?page=2'
path:
type: string
example: 'http://localhost:8000'
per_page:
type: integer
example: 16
prev_page_url:
type: string
example: null
to:
type: integer
example: 16
total:
type: integer
example: 50
tags:
- 'Administrator Endpoints'
post:
summary: 'Add new tag'
operationId: addNewTag
description: "Create a new tag and store it's details."
parameters: []
responses:
201:
description: ''
content:
application/json:
schema:
type: object
example:
status: success
message: 'Tag added successfully.'
data:
name: 'Tag 1'
description: 'Qui aut quia soluta ut et repellendus aut.'
meta_title: jqfpfenwpledzbrovcmnsylb
meta_description: sdovbzcbfmbwnxpgvrqzdi
meta_keywords: dvrisbpzc
slug: qblbi
updated_at: '2023-05-18T00:00:00.000000Z'
created_at: '2023-05-18T00:00:00.000000Z'
id: 1
properties:
status:
type: string
example: success
message:
type: string
example: 'Tag added successfully.'
data:
type: object
properties:
name:
type: string
example: 'Tag 1'
description:
type: string
example: 'Qui aut quia soluta ut et repellendus aut.'
meta_title:
type: string
example: jqfpfenwpledzbrovcmnsylb
meta_description:
type: string
example: sdovbzcbfmbwnxpgvrqzdi
meta_keywords:
type: string
example: dvrisbpzc
slug:
type: string
example: qblbi
updated_at:
type: string
example: '2023-05-18T00:00:00.000000Z'
created_at:
type: string
example: '2023-05-18T00:00:00.000000Z'
id:
type: integer
example: 1
422:
description: ''
content:
application/json:
schema:
type: object
example:
message: 'The name field is required. (and 3 more errors)'
errors:
name:
- 'The name field is required.'
description:
- 'The description field is required.'
meta_title:
- 'The meta title field is required.'
meta_description:
- 'The meta description field is required.'
properties:
message:
type: string
example: 'The name field is required. (and 3 more errors)'
errors:
type: object
properties:
name:
type: array
example:
- 'The name field is required.'
items:
type: string
description:
type: array
example:
- 'The description field is required.'
items:
type: string
meta_title:
type: array
example:
- 'The meta title field is required.'
items:
type: string
meta_description:
type: array
example:
- 'The meta description field is required.'
items:
type: string
tags:
- 'Administrator Endpoints'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
name:
type: string
description: 'Required. The name of the tag, should be unique. Must not be greater than 100 characters.'
example: 'T-shirt for Women'
nullable: false
description:
type: string
description: 'Required. The description of the tag. Must not be greater than 255 characters.'
example: 'T-shirt for Women made of the best quality materials sold all over the world.'
nullable: false
meta_title:
type: string
description: 'Required. The title of the page. Refers to the text that is displayed on search engine result pages and browser tabs to indicate the topic of a webpage. Must not be greater than 80 characters.'
example: 'T-shirt for Women made of the best quality materials.'
nullable: false
meta_description:
type: string
description: 'Required. This informs and interests users with a short, relevant summary of what a particular page is about. Must not be greater than 180 characters.'
example: 'T-shirt for Women made of the best quality materials sold all over the world.'
nullable: false
meta_keywords:
type: string
description: 'A comma separated words or phrases related to the tag. Must not be greater than 255 characters.'
example: 'T-shirt, t-shirt for women, best quality tshirt for women'
nullable: true
required:
- name
- description
- meta_title
- meta_description
'/api/v1/admin/tags/{id}':
get:
summary: 'Get single tag'
operationId: getSingleTag
description: 'Fetch the details about the given tag id.'
parameters: []
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
status: success
message: ''
data:
name: 'Tag 1'
description: 'Qui aut quia soluta ut et repellendus aut.'
meta_title: jqfpfenwpledzbrovcmnsylb
meta_description: sdovbzcbfmbwnxpgvrqzdi
meta_keywords: dvrisbpzc
id: 1
properties:
status:
type: string
example: success
message:
type: string
example: ''
data:
type: object
properties:
name:
type: string
example: 'Tag 1'
description:
type: string
example: 'Qui aut quia soluta ut et repellendus aut.'
meta_title:
type: string
example: jqfpfenwpledzbrovcmnsylb
meta_description:
type: string
example: sdovbzcbfmbwnxpgvrqzdi
meta_keywords:
type: string
example: dvrisbpzc
id:
type: integer
example: 1
404:
description: ''
content:
application/json:
schema:
type: object
example:
status: failed
message: 'Tag not found.'
data: []
properties:
status:
type: string
example: failed
message:
type: string
example: 'Tag not found.'
data:
type: array
example: []
tags:
- 'Administrator Endpoints'
put:
summary: 'Update tag'
operationId: updateTag
description: 'Update the tag details of the given id.'
parameters: []
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
status: success
message: 'Tag updated successfully.'
data:
name: 'Tag 1'
description: 'Qui aut quia soluta ut et repellendus aut.'
meta_title: jqfpfenwpledzbrovcmnsylb
meta_description: sdovbzcbfmbwnxpgvrqzdi
meta_keywords: dvrisbpzc
slug: qblbi
updated_at: '2023-05-18T00:00:00.000000Z'
created_at: '2023-05-18T00:00:00.000000Z'
id: 1
properties:
status:
type: string
example: success
message:
type: string
example: 'Tag updated successfully.'
data:
type: object
properties:
name:
type: string
example: 'Tag 1'
description:
type: string
example: 'Qui aut quia soluta ut et repellendus aut.'
meta_title:
type: string
example: jqfpfenwpledzbrovcmnsylb
meta_description:
type: string
example: sdovbzcbfmbwnxpgvrqzdi
meta_keywords:
type: string
example: dvrisbpzc
slug:
type: string
example: qblbi
updated_at:
type: string
example: '2023-05-18T00:00:00.000000Z'
created_at:
type: string
example: '2023-05-18T00:00:00.000000Z'
id:
type: integer
example: 1
404:
description: ''
content:
application/json:
schema:
type: object
example:
status: failed
message: 'Tag not found.'
data: []
properties:
status:
type: string
example: failed
message:
type: string
example: 'Tag not found.'
data:
type: array
example: []
422:
description: ''
content:
application/json:
schema:
type: object
example:
message: 'The name field is required. (and 3 more errors)'
errors:
name:
- 'The name field is required.'
description:
- 'The description field is required.'
meta_title:
- 'The meta title field is required.'
meta_description:
- 'The meta description field is required.'
properties:
message:
type: string
example: 'The name field is required. (and 3 more errors)'
errors:
type: object
properties:
name:
type: array
example:
- 'The name field is required.'
items:
type: string
description:
type: array
example:
- 'The description field is required.'
items:
type: string
meta_title:
type: array
example:
- 'The meta title field is required.'
items:
type: string
meta_description:
type: array
example:
- 'The meta description field is required.'
items:
type: string
tags:
- 'Administrator Endpoints'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
name:
type: string
description: 'Required. The name of the category, should be unique. Must not be greater than 100 characters.'
example: 'T-shirt for Women'
nullable: false
description:
type: string
description: 'Required. The description of the category. Must not be greater than 255 characters.'
example: 'T-shirt for Women made of the best quality materials sold all over the world.'
nullable: false
meta_title:
type: string
description: 'Required. The title of the page. Refers to the text that is displayed on search engine result pages and browser tabs to indicate the topic of a webpage. Must not be greater than 80 characters.'
example: 'T-shirt for Women made of the best quality materials.'
nullable: false
meta_description:
type: string
description: 'Required. This informs and interests users with a short, relevant summary of what a particular page is about. Must not be greater than 180 characters.'
example: 'T-shirt for Women made of the best quality materials sold all over the world.'
nullable: false
meta_keywords:
type: string
description: 'A comma separated words or phrases related to the category. Must not be greater than 255 characters.'
example: 'T-shirt, t-shirt for women, best quality tshirt for women'
nullable: true
required:
- name
- description
- meta_title
- meta_description
delete:
summary: 'Delete a tag'
operationId: deleteATag
description: "Delete the tag details of the given id.\nThis will soft delete the tag.\nMeaning the record will be present in the database, however,\nit won't be available to access."
parameters: []
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
status: success
message: 'Tag deleted successfully.'
data: []
properties:
status:
type: string
example: success
message:
type: string
example: 'Tag deleted successfully.'
data:
type: array
example: []
404:
description: ''
content:
application/json:
schema:
type: object
example:
status: failed
message: 'Tag not found.'
data: []
properties:
status:
type: string
example: failed
message:
type: string
example: 'Tag not found.'
data:
type: array
example: []
tags:
- 'Administrator Endpoints'
parameters:
-
in: path
name: id
description: 'The id of the tag.'
example: 1
required: true
schema:
type: integer
/api/v1/admin/brands:
get:
summary: 'List All brands'
operationId: listAllBrands
description: "Display all the brands with pagination.\nAt a time, there are total of 16 records that will be displayed."
parameters:
-
in: query
name: page
description: 'The page number. Defaults to 1.'
example: 1
required: false
schema:
type: integer
description: 'The page number. Defaults to 1.'
example: 1
nullable: false
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
status: success
message: ''
data:
current_page: 1
data:
-
id: 1
name: 'Sint Rerum Officiis'
slug: sint-rerum-officiis
meta_title: 'Sint Rerum Officiis Laravel E-Commerce API'
meta_description: 'Sint Rerum Officiis Laravel E-Commerce API'
meta_keywords: 'Sint Rerum Officiis Laravel E-Commerce API'
-
id: 2
name: 'Corporis Earum Quas'
slug: corporis-earum-quas
meta_title: 'Corporis Earum Quas Laravel E-Commerce API'
meta_description: 'Corporis Earum Quas Laravel E-Commerce API'
meta_keywords: 'Corporis Earum Quas Laravel E-Commerce API'
-
id: 3
name: 'Adipisci Incidunt Et'
slug: adipisci-incidunt-et
meta_title: 'Adipisci Incidunt Et Laravel E-Commerce API'
meta_description: 'Adipisci Incidunt Et Laravel E-Commerce API'
meta_keywords: 'Adipisci Incidunt Et Laravel E-Commerce API'
-
id: 4
name: 'Voluptatem Maiores Et'
slug: voluptatem-maiores-et
meta_title: 'Voluptatem Maiores Et Laravel E-Commerce API'
meta_description: 'Voluptatem Maiores Et Laravel E-Commerce API'
meta_keywords: 'Voluptatem Maiores Et Laravel E-Commerce API'
-
id: 5
name: 'Doloremque Sequi Aut'
slug: doloremque-sequi-aut
meta_title: 'Doloremque Sequi Aut Laravel E-Commerce API'
meta_description: 'Doloremque Sequi Aut Laravel E-Commerce API'
meta_keywords: 'Doloremque Sequi Aut Laravel E-Commerce API'
-
id: 6
name: 'Beatae Quidem Ipsam'
slug: beatae-quidem-ipsam
meta_title: 'Beatae Quidem Ipsam Laravel E-Commerce API'
meta_description: 'Beatae Quidem Ipsam Laravel E-Commerce API'
meta_keywords: 'Beatae Quidem Ipsam Laravel E-Commerce API'
-
id: 7
name: 'Quia Atque Consequatur'
slug: quia-atque-consequatur
meta_title: 'Quia Atque Consequatur Laravel E-Commerce API'
meta_description: 'Quia Atque Consequatur Laravel E-Commerce API'
meta_keywords: 'Quia Atque Consequatur Laravel E-Commerce API'
-
id: 8
name: 'Eaque Commodi Fugit'
slug: eaque-commodi-fugit
meta_title: 'Eaque Commodi Fugit Laravel E-Commerce API'
meta_description: 'Eaque Commodi Fugit Laravel E-Commerce API'
meta_keywords: 'Eaque Commodi Fugit Laravel E-Commerce API'
-
id: 9
name: 'Molestiae Pariatur Error'
slug: molestiae-pariatur-error
meta_title: 'Molestiae Pariatur Error Laravel E-Commerce API'
meta_description: 'Molestiae Pariatur Error Laravel E-Commerce API'
meta_keywords: 'Molestiae Pariatur Error Laravel E-Commerce API'
-
id: 10
name: 'Odio Omnis Et'
slug: odio-omnis-et
meta_title: 'Odio Omnis Et Laravel E-Commerce API'
meta_description: 'Odio Omnis Et Laravel E-Commerce API'
meta_keywords: 'Odio Omnis Et Laravel E-Commerce API'
-
id: 11
name: 'Totam Perferendis Provident'
slug: totam-perferendis-provident
meta_title: 'Totam Perferendis Provident Laravel E-Commerce API'
meta_description: 'Totam Perferendis Provident Laravel E-Commerce API'
meta_keywords: 'Totam Perferendis Provident Laravel E-Commerce API'
-
id: 12
name: 'Vitae Non Voluptas'
slug: vitae-non-voluptas
meta_title: 'Vitae Non Voluptas Laravel E-Commerce API'
meta_description: 'Vitae Non Voluptas Laravel E-Commerce API'
meta_keywords: 'Vitae Non Voluptas Laravel E-Commerce API'
-
id: 13
name: 'Tempora Et Aut'
slug: tempora-et-aut
meta_title: 'Tempora Et Aut Laravel E-Commerce API'
meta_description: 'Tempora Et Aut Laravel E-Commerce API'
meta_keywords: 'Tempora Et Aut Laravel E-Commerce API'
-
id: 14
name: 'Unde Quis Itaque'
slug: unde-quis-itaque
meta_title: 'Unde Quis Itaque Laravel E-Commerce API'
meta_description: 'Unde Quis Itaque Laravel E-Commerce API'
meta_keywords: 'Unde Quis Itaque Laravel E-Commerce API'
-
id: 15
name: 'Harum Nisi Sed'
slug: harum-nisi-sed
meta_title: 'Harum Nisi Sed Laravel E-Commerce API'
meta_description: 'Harum Nisi Sed Laravel E-Commerce API'
meta_keywords: 'Harum Nisi Sed Laravel E-Commerce API'
-
id: 16
name: 'Dolore Et Aperiam'
slug: dolore-et-aperiam
meta_title: 'Dolore Et Aperiam Laravel E-Commerce API'
meta_description: 'Dolore Et Aperiam Laravel E-Commerce API'
meta_keywords: 'Dolore Et Aperiam Laravel E-Commerce API'
first_page_url: 'http://localhost:8000?page=1'
from: 1
last_page: 4
last_page_url: 'http://localhost:8000?page=4'
links:
-
url: null
label: '« Previous'
active: false
-
url: 'http://localhost:8000?page=1'
label: '1'
active: true
-
url: 'http://localhost:8000?page=2'
label: '2'
active: false
-
url: 'http://localhost:8000?page=3'
label: '3'
active: false
-
url: 'http://localhost:8000?page=4'
label: '4'
active: false
-
url: 'http://localhost:8000?page=2'
label: 'Next »'
active: false
next_page_url: 'http://localhost:8000?page=2'
path: 'http://localhost:8000'
per_page: 16
prev_page_url: null
to: 16
total: 50
properties:
status:
type: string
example: success
message:
type: string
example: ''
data:
type: object
properties:
current_page:
type: integer
example: 1
data:
type: array
example:
-
id: 1
name: 'Sint Rerum Officiis'
slug: sint-rerum-officiis
meta_title: 'Sint Rerum Officiis Laravel E-Commerce API'
meta_description: 'Sint Rerum Officiis Laravel E-Commerce API'
meta_keywords: 'Sint Rerum Officiis Laravel E-Commerce API'
-
id: 2
name: 'Corporis Earum Quas'
slug: corporis-earum-quas
meta_title: 'Corporis Earum Quas Laravel E-Commerce API'
meta_description: 'Corporis Earum Quas Laravel E-Commerce API'
meta_keywords: 'Corporis Earum Quas Laravel E-Commerce API'
-
id: 3
name: 'Adipisci Incidunt Et'
slug: adipisci-incidunt-et
meta_title: 'Adipisci Incidunt Et Laravel E-Commerce API'
meta_description: 'Adipisci Incidunt Et Laravel E-Commerce API'
meta_keywords: 'Adipisci Incidunt Et Laravel E-Commerce API'
-
id: 4
name: 'Voluptatem Maiores Et'
slug: voluptatem-maiores-et
meta_title: 'Voluptatem Maiores Et Laravel E-Commerce API'
meta_description: 'Voluptatem Maiores Et Laravel E-Commerce API'
meta_keywords: 'Voluptatem Maiores Et Laravel E-Commerce API'
-
id: 5
name: 'Doloremque Sequi Aut'
slug: doloremque-sequi-aut
meta_title: 'Doloremque Sequi Aut Laravel E-Commerce API'
meta_description: 'Doloremque Sequi Aut Laravel E-Commerce API'
meta_keywords: 'Doloremque Sequi Aut Laravel E-Commerce API'
-
id: 6
name: 'Beatae Quidem Ipsam'
slug: beatae-quidem-ipsam
meta_title: 'Beatae Quidem Ipsam Laravel E-Commerce API'
meta_description: 'Beatae Quidem Ipsam Laravel E-Commerce API'
meta_keywords: 'Beatae Quidem Ipsam Laravel E-Commerce API'
-
id: 7
name: 'Quia Atque Consequatur'
slug: quia-atque-consequatur
meta_title: 'Quia Atque Consequatur Laravel E-Commerce API'
meta_description: 'Quia Atque Consequatur Laravel E-Commerce API'
meta_keywords: 'Quia Atque Consequatur Laravel E-Commerce API'
-
id: 8
name: 'Eaque Commodi Fugit'
slug: eaque-commodi-fugit
meta_title: 'Eaque Commodi Fugit Laravel E-Commerce API'
meta_description: 'Eaque Commodi Fugit Laravel E-Commerce API'
meta_keywords: 'Eaque Commodi Fugit Laravel E-Commerce API'
-
id: 9
name: 'Molestiae Pariatur Error'
slug: molestiae-pariatur-error
meta_title: 'Molestiae Pariatur Error Laravel E-Commerce API'
meta_description: 'Molestiae Pariatur Error Laravel E-Commerce API'
meta_keywords: 'Molestiae Pariatur Error Laravel E-Commerce API'
-
id: 10
name: 'Odio Omnis Et'
slug: odio-omnis-et
meta_title: 'Odio Omnis Et Laravel E-Commerce API'
meta_description: 'Odio Omnis Et Laravel E-Commerce API'
meta_keywords: 'Odio Omnis Et Laravel E-Commerce API'
-
id: 11
name: 'Totam Perferendis Provident'
slug: totam-perferendis-provident
meta_title: 'Totam Perferendis Provident Laravel E-Commerce API'
meta_description: 'Totam Perferendis Provident Laravel E-Commerce API'
meta_keywords: 'Totam Perferendis Provident Laravel E-Commerce API'
-
id: 12
name: 'Vitae Non Voluptas'
slug: vitae-non-voluptas
meta_title: 'Vitae Non Voluptas Laravel E-Commerce API'
meta_description: 'Vitae Non Voluptas Laravel E-Commerce API'
meta_keywords: 'Vitae Non Voluptas Laravel E-Commerce API'
-
id: 13
name: 'Tempora Et Aut'
slug: tempora-et-aut
meta_title: 'Tempora Et Aut Laravel E-Commerce API'
meta_description: 'Tempora Et Aut Laravel E-Commerce API'
meta_keywords: 'Tempora Et Aut Laravel E-Commerce API'
-
id: 14
name: 'Unde Quis Itaque'
slug: unde-quis-itaque
meta_title: 'Unde Quis Itaque Laravel E-Commerce API'
meta_description: 'Unde Quis Itaque Laravel E-Commerce API'
meta_keywords: 'Unde Quis Itaque Laravel E-Commerce API'
-
id: 15
name: 'Harum Nisi Sed'
slug: harum-nisi-sed
meta_title: 'Harum Nisi Sed Laravel E-Commerce API'
meta_description: 'Harum Nisi Sed Laravel E-Commerce API'
meta_keywords: 'Harum Nisi Sed Laravel E-Commerce API'
-
id: 16
name: 'Dolore Et Aperiam'
slug: dolore-et-aperiam
meta_title: 'Dolore Et Aperiam Laravel E-Commerce API'
meta_description: 'Dolore Et Aperiam Laravel E-Commerce API'
meta_keywords: 'Dolore Et Aperiam Laravel E-Commerce API'
items:
type: object
properties:
id:
type: integer
example: 1
name:
type: string
example: 'Sint Rerum Officiis'
slug:
type: string
example: sint-rerum-officiis
meta_title:
type: string
example: 'Sint Rerum Officiis Laravel E-Commerce API'
meta_description:
type: string
example: 'Sint Rerum Officiis Laravel E-Commerce API'
meta_keywords:
type: string
example: 'Sint Rerum Officiis Laravel E-Commerce API'
first_page_url:
type: string
example: 'http://localhost:8000?page=1'
from:
type: integer
example: 1
last_page:
type: integer
example: 4
last_page_url:
type: string
example: 'http://localhost:8000?page=4'
links:
type: array
example:
-
url: null
label: '« Previous'
active: false
-
url: 'http://localhost:8000?page=1'
label: '1'
active: true
-
url: 'http://localhost:8000?page=2'
label: '2'
active: false
-
url: 'http://localhost:8000?page=3'
label: '3'
active: false
-
url: 'http://localhost:8000?page=4'
label: '4'
active: false
-
url: 'http://localhost:8000?page=2'
label: 'Next »'
active: false
items:
type: object
properties:
url:
type: string
example: null
label:
type: string
example: '« Previous'
active:
type: boolean
example: false
next_page_url:
type: string
example: 'http://localhost:8000?page=2'
path:
type: string
example: 'http://localhost:8000'
per_page:
type: integer
example: 16
prev_page_url:
type: string
example: null
to:
type: integer
example: 16
total:
type: integer
example: 50
tags:
- 'Administrator Endpoints'
post:
summary: 'Add new Brand'
operationId: addNewBrand
description: "Create a new Brand and store it's details."
parameters: []
responses:
201:
description: ''
content:
application/json:
schema:
type: object
example:
status: success
message: 'Brand added successfully.'
data:
name: 'Brand 1'
description: 'Qui aut quia soluta ut et repellendus aut.'
meta_title: jqfpfenwpledzbrovcmnsylb
meta_description: sdovbzcbfmbwnxpgvrqzdi
meta_keywords: dvrisbpzc
slug: qblbi
updated_at: '2023-05-18T00:00:00.000000Z'
created_at: '2023-05-18T00:00:00.000000Z'
id: 1
properties:
status:
type: string
example: success
message:
type: string
example: 'Brand added successfully.'
data:
type: object
properties:
name:
type: string
example: 'Brand 1'
description:
type: string
example: 'Qui aut quia soluta ut et repellendus aut.'
meta_title:
type: string
example: jqfpfenwpledzbrovcmnsylb
meta_description:
type: string
example: sdovbzcbfmbwnxpgvrqzdi
meta_keywords:
type: string
example: dvrisbpzc
slug:
type: string
example: qblbi
updated_at:
type: string
example: '2023-05-18T00:00:00.000000Z'
created_at:
type: string
example: '2023-05-18T00:00:00.000000Z'
id:
type: integer
example: 1
422:
description: ''
content:
application/json:
schema:
type: object
example:
message: 'The name field is required. (and 3 more errors)'
errors:
name:
- 'The name field is required.'
description:
- 'The description field is required.'
meta_title:
- 'The meta title field is required.'
meta_description:
- 'The meta description field is required.'
properties:
message:
type: string
example: 'The name field is required. (and 3 more errors)'
errors:
type: object
properties:
name:
type: array
example:
- 'The name field is required.'
items:
type: string
description:
type: array
example:
- 'The description field is required.'
items:
type: string
meta_title:
type: array
example:
- 'The meta title field is required.'
items:
type: string
meta_description:
type: array
example:
- 'The meta description field is required.'
items:
type: string
tags:
- 'Administrator Endpoints'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
name:
type: string
description: 'Required. The name of the category, should be unique. Must not be greater than 100 characters.'
example: Gucci
nullable: false
description:
type: string
description: 'Required. The description of the category. Must not be greater than 255 characters.'
example: 'Gucci clothes made of the best quality materials sold all over the world.'
nullable: false
meta_title:
type: string
description: 'Required. The title of the page. Refers to the text that is displayed on search engine result pages and browser tabs to indicate the topic of a webpage. Must not be greater than 80 characters.'
example: 'Gucci clothes made of the best quality materials.'
nullable: false
meta_description:
type: string
description: 'Required. This informs and interests users with a short, relevant summary of what a particular page is about. Must not be greater than 180 characters.'
example: 'Gucci clothes made of the best quality materials sold all over the world.'
nullable: false
meta_keywords:
type: string
description: 'A comma separated words or phrases related to the category. Must not be greater than 255 characters.'
example: 'T-shirt, Gucci clothes, best quality tshirt for women'
nullable: true
required:
- name
- description
- meta_title
- meta_description
'/api/v1/admin/brands/{id}':
get:
summary: 'Get single Brand'
operationId: getSingleBrand
description: 'Fetch the details about the given Brand id.'
parameters: []
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
status: success
message: ''
data:
name: 'Brand 1'
description: 'Qui aut quia soluta ut et repellendus aut.'
meta_title: jqfpfenwpledzbrovcmnsylb
meta_description: sdovbzcbfmbwnxpgvrqzdi
meta_keywords: dvrisbpzc
id: 1
properties:
status:
type: string
example: success
message:
type: string
example: ''
data:
type: object
properties:
name:
type: string
example: 'Brand 1'
description:
type: string
example: 'Qui aut quia soluta ut et repellendus aut.'
meta_title:
type: string
example: jqfpfenwpledzbrovcmnsylb
meta_description:
type: string
example: sdovbzcbfmbwnxpgvrqzdi
meta_keywords:
type: string
example: dvrisbpzc
id:
type: integer
example: 1
404:
description: ''
content:
application/json:
schema:
type: object
example:
status: failed
message: 'Brand not found.'
data: []
properties:
status:
type: string
example: failed
message:
type: string
example: 'Brand not found.'
data:
type: array
example: []
tags:
- 'Administrator Endpoints'
put:
summary: 'Update Brand'
operationId: updateBrand
description: 'Update the Brand details of the given id.'
parameters: []
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
status: success
message: 'Brand updated successfully.'
data:
name: 'Brand 1'
description: 'Qui aut quia soluta ut et repellendus aut.'
meta_title: jqfpfenwpledzbrovcmnsylb
meta_description: sdovbzcbfmbwnxpgvrqzdi
meta_keywords: dvrisbpzc
slug: qblbi
updated_at: '2023-05-18T00:00:00.000000Z'
created_at: '2023-05-18T00:00:00.000000Z'
id: 1
properties:
status:
type: string
example: success
message:
type: string
example: 'Brand updated successfully.'
data:
type: object
properties:
name:
type: string
example: 'Brand 1'
description:
type: string
example: 'Qui aut quia soluta ut et repellendus aut.'
meta_title:
type: string
example: jqfpfenwpledzbrovcmnsylb
meta_description:
type: string
example: sdovbzcbfmbwnxpgvrqzdi
meta_keywords:
type: string
example: dvrisbpzc
slug:
type: string
example: qblbi
updated_at:
type: string
example: '2023-05-18T00:00:00.000000Z'
created_at:
type: string
example: '2023-05-18T00:00:00.000000Z'
id:
type: integer
example: 1
404:
description: ''
content:
application/json:
schema:
type: object
example:
status: failed
message: 'Brand not found.'
data: []
properties:
status:
type: string
example: failed
message:
type: string
example: 'Brand not found.'
data:
type: array
example: []
422:
description: ''
content:
application/json:
schema:
type: object
example:
message: 'The name field is required. (and 3 more errors)'
errors:
name:
- 'The name field is required.'
description:
- 'The description field is required.'
meta_title:
- 'The meta title field is required.'
meta_description:
- 'The meta description field is required.'
properties:
message:
type: string
example: 'The name field is required. (and 3 more errors)'
errors:
type: object
properties:
name:
type: array
example:
- 'The name field is required.'
items:
type: string
description:
type: array
example:
- 'The description field is required.'
items:
type: string
meta_title:
type: array
example:
- 'The meta title field is required.'
items:
type: string
meta_description:
type: array
example:
- 'The meta description field is required.'
items:
type: string
tags:
- 'Administrator Endpoints'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
name:
type: string
description: 'Required. The name of the category, should be unique. Must not be greater than 100 characters.'
example: Gucci
nullable: false
description:
type: string
description: 'Required. The description of the category. Must not be greater than 255 characters.'
example: 'Gucci clothes made of the best quality materials sold all over the world.'
nullable: false
meta_title:
type: string
description: 'Required. The title of the page. Refers to the text that is displayed on search engine result pages and browser tabs to indicate the topic of a webpage. Must not be greater than 80 characters.'
example: 'Gucci clothes made of the best quality materials.'
nullable: false
meta_description:
type: string
description: 'Required. This informs and interests users with a short, relevant summary of what a particular page is about. Must not be greater than 180 characters.'
example: 'Gucci clothes made of the best quality materials sold all over the world.'
nullable: false
meta_keywords:
type: string
description: 'A comma separated words or phrases related to the category. Must not be greater than 255 characters.'
example: 'T-shirt, Gucci clothes, best quality tshirt for women'
nullable: true
required:
- name
- description
- meta_title
- meta_description
delete:
summary: 'Delete a Brand'
operationId: deleteABrand
description: "Delete the Brand details of the given id.\nThis will soft delete the Brand.\nMeaning the record will be present in the database, however,\nit won't be available to access."
parameters: []
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
status: success
message: 'Brand deleted successfully.'
data: []
properties:
status:
type: string
example: success
message:
type: string
example: 'Brand deleted successfully.'
data:
type: array
example: []
404:
description: ''
content:
application/json:
schema:
type: object
example:
status: failed
message: 'Brand not found.'
data: []
properties:
status:
type: string
example: failed
message:
type: string
example: 'Brand not found.'
data:
type: array
example: []
tags:
- 'Administrator Endpoints'
parameters:
-
in: path
name: id
description: 'The id of the Brand.'
example: 1
required: true
schema:
type: integer
/api/v1/admin/products:
get:
summary: 'List All products'
operationId: listAllProducts
description: "Display all the products with pagination.\nAt a time, there are total of 16 records that will be displayed."
parameters:
-
in: query
name: page
description: 'The page number. Defaults to 1.'
example: 1
required: false
schema:
type: integer
description: 'The page number. Defaults to 1.'
example: 1
nullable: false
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
status: success
message: ''
data:
current_page: 1
data:
-
id: 1
category_id: 52
brand_id: 51
name: 'Iusto Occaecati Necessitatibus Non Asperiores'
slug: iusto-occaecati-necessitatibus-non-asperiores
rate: 64.46
quantity: 5
description: 'Inventore nihil repellat similique exercitationem. Optio veritatis commodi amet ipsum tempore mollitia. Dolor enim sunt repudiandae nemo eaque suscipit quis. Cum animi quia error vero natus ratione eveniet odio. Est consectetur doloremque qui fugiat recusandae facilis aut reprehenderit.'
meta_title: 'Iusto Occaecati Necessitatibus Non Asperiores Laravel E-Commerce API'
meta_description: 'Iusto Occaecati Necessitatibus Non Asperiores Laravel E-Commerce API'
meta_keywords: 'Iusto Occaecati Necessitatibus Non Asperiores Laravel E-Commerce API'
category:
id: 52
name: 'Natus Beatae Dolorem'
slug: natus-beatae-dolorem
brand:
id: 51
name: 'Quidem Natus Laboriosam'
slug: quidem-natus-laboriosam
-
id: 2
category_id: 53
brand_id: 52
name: 'Cum Sit Consequatur Sit Eum'
slug: cum-sit-consequatur-sit-eum
rate: 469.78
quantity: 7
description: 'Tempore voluptatem quia aut asperiores. Sit eos doloribus esse. Deleniti ea quod repellat aut officiis doloremque voluptatem aut. Eos quam omnis culpa ut laudantium sit dolores. Qui reiciendis qui sunt et repudiandae.'
meta_title: 'Cum Sit Consequatur Sit Eum Laravel E-Commerce API'
meta_description: 'Cum Sit Consequatur Sit Eum Laravel E-Commerce API'
meta_keywords: 'Cum Sit Consequatur Sit Eum Laravel E-Commerce API'
category:
id: 53
name: 'Sit Numquam Ducimus'
slug: sit-numquam-ducimus
brand:
id: 52
name: 'Provident Totam Quaerat'
slug: provident-totam-quaerat
-
id: 3
category_id: 54
brand_id: 53
name: 'Veniam Odio Ipsam Enim Quia'
slug: veniam-odio-ipsam-enim-quia
rate: 787.46
quantity: 0
description: 'Rerum itaque qui sint quo dolorem. Quis vel necessitatibus cum aliquid ullam fugit. In consequatur et cumque est et voluptas architecto. Dicta impedit velit quia vel neque culpa voluptatem. Adipisci nesciunt maiores cupiditate enim nihil id tenetur.'
meta_title: 'Veniam Odio Ipsam Enim Quia Laravel E-Commerce API'
meta_description: 'Veniam Odio Ipsam Enim Quia Laravel E-Commerce API'
meta_keywords: 'Veniam Odio Ipsam Enim Quia Laravel E-Commerce API'
category:
id: 54
name: 'Animi Fuga Quisquam'
slug: animi-fuga-quisquam
brand:
id: 53
name: 'Quia Ut Error'
slug: quia-ut-error
-
id: 4
category_id: 55
brand_id: 54
name: 'Maxime Repellat Perferendis Corrupti Quae'
slug: maxime-repellat-perferendis-corrupti-quae
rate: 144.82
quantity: 8
description: 'Rem ratione qui consectetur non. Velit dolor quia ad omnis consequatur. Velit soluta esse sunt aspernatur. Sed labore aut soluta est iure dicta est. Molestias aut earum quo.'
meta_title: 'Maxime Repellat Perferendis Corrupti Quae Laravel E-Commerce API'
meta_description: 'Maxime Repellat Perferendis Corrupti Quae Laravel E-Commerce API'
meta_keywords: 'Maxime Repellat Perferendis Corrupti Quae Laravel E-Commerce API'
category:
id: 55
name: 'Velit Animi Labore'
slug: velit-animi-labore
brand:
id: 54
name: 'Ipsum Libero Tenetur'
slug: ipsum-libero-tenetur
-
id: 5
category_id: 56
brand_id: 55
name: 'Non Perspiciatis Dignissimos Nesciunt Libero'
slug: non-perspiciatis-dignissimos-nesciunt-libero
rate: 896.54
quantity: 6
description: 'Fugit et sed aperiam sit quas libero harum. Quam quae eos quis nobis. Est dignissimos esse in unde ipsum. Sed asperiores rerum reiciendis architecto enim fugiat omnis et. Nihil facilis qui aut culpa.'
meta_title: 'Non Perspiciatis Dignissimos Nesciunt Libero Laravel E-Commerce API'
meta_description: 'Non Perspiciatis Dignissimos Nesciunt Libero Laravel E-Commerce API'
meta_keywords: 'Non Perspiciatis Dignissimos Nesciunt Libero Laravel E-Commerce API'
category:
id: 56
name: 'Consequatur Sapiente Dolores'
slug: consequatur-sapiente-dolores
brand:
id: 55
name: 'Voluptatem Ad Dicta'
slug: voluptatem-ad-dicta
-
id: 6
category_id: 57
brand_id: 56
name: 'Explicabo Impedit Officiis Voluptas Cum'
slug: explicabo-impedit-officiis-voluptas-cum
rate: 832.42
quantity: 8
description: 'Nulla ut ab ipsum molestiae dolor sit. Nam esse ab temporibus nam ad. Illo a beatae sequi. Enim similique sit aliquid eum quae omnis adipisci. Cum accusantium vel quam illum voluptates.'
meta_title: 'Explicabo Impedit Officiis Voluptas Cum Laravel E-Commerce API'
meta_description: 'Explicabo Impedit Officiis Voluptas Cum Laravel E-Commerce API'
meta_keywords: 'Explicabo Impedit Officiis Voluptas Cum Laravel E-Commerce API'
category:
id: 57
name: 'Suscipit Exercitationem Accusantium'
slug: suscipit-exercitationem-accusantium
brand:
id: 56
name: 'Totam Harum Voluptatem'
slug: totam-harum-voluptatem
-
id: 7
category_id: 58
brand_id: 57
name: 'Iure Quis Est Repellendus Quia'
slug: iure-quis-est-repellendus-quia
rate: 345.94
quantity: 2
description: 'Voluptas omnis incidunt quia nisi dolor quia magnam. Ea qui libero corporis eos. Qui architecto minus dolore quas atque. Adipisci consequuntur et a dolorem alias consequatur quas. Fuga voluptatibus maiores et minima.'
meta_title: 'Iure Quis Est Repellendus Quia Laravel E-Commerce API'
meta_description: 'Iure Quis Est Repellendus Quia Laravel E-Commerce API'
meta_keywords: 'Iure Quis Est Repellendus Quia Laravel E-Commerce API'
category:
id: 58
name: 'Aspernatur Quis Accusantium'
slug: aspernatur-quis-accusantium
brand:
id: 57
name: 'Expedita Aut Et'
slug: expedita-aut-et
-
id: 8
category_id: 59
brand_id: 58
name: 'Omnis Est Quisquam Et Occaecati'
slug: omnis-est-quisquam-et-occaecati
rate: 568.97
quantity: 8
description: 'Vero eaque non sint repudiandae ipsum. Vitae culpa quo porro placeat. Amet similique aliquid exercitationem eum. Vero nostrum doloremque occaecati. At ut laudantium quaerat qui exercitationem explicabo dolores.'
meta_title: 'Omnis Est Quisquam Et Occaecati Laravel E-Commerce API'
meta_description: 'Omnis Est Quisquam Et Occaecati Laravel E-Commerce API'
meta_keywords: 'Omnis Est Quisquam Et Occaecati Laravel E-Commerce API'
category:
id: 59
name: 'Nihil Unde Mollitia'
slug: nihil-unde-mollitia
brand:
id: 58
name: 'Nihil Praesentium Dicta'
slug: nihil-praesentium-dicta
-
id: 9
category_id: 60
brand_id: 59
name: 'A Assumenda Eaque Aperiam Omnis'
slug: a-assumenda-eaque-aperiam-omnis
rate: 204.36
quantity: 4
description: 'Possimus non ullam fugiat. Error culpa eveniet aut ipsum harum quia voluptate. Perspiciatis consequuntur asperiores magni aspernatur libero. A ut fuga quas iure ab. Recusandae ut ad dolores voluptas cupiditate odio voluptatem.'
meta_title: 'A Assumenda Eaque Aperiam Omnis Laravel E-Commerce API'
meta_description: 'A Assumenda Eaque Aperiam Omnis Laravel E-Commerce API'
meta_keywords: 'A Assumenda Eaque Aperiam Omnis Laravel E-Commerce API'
category:
id: 60
name: 'Error Consectetur Minus'
slug: error-consectetur-minus
brand:
id: 59
name: 'Mollitia Nam Quas'
slug: mollitia-nam-quas
-
id: 10
category_id: 61
brand_id: 60
name: 'Ratione Consequatur At Et Est'
slug: ratione-consequatur-at-et-est
rate: 862.41
quantity: 4
description: 'Et laborum repellat ipsam voluptatibus repellendus. Libero deleniti ut impedit ut iusto assumenda aut. Corporis et quia quis officiis. Illo eveniet velit necessitatibus fuga modi velit quo et. Dolores doloremque aut deserunt maiores.'
meta_title: 'Ratione Consequatur At Et Est Laravel E-Commerce API'
meta_description: 'Ratione Consequatur At Et Est Laravel E-Commerce API'
meta_keywords: 'Ratione Consequatur At Et Est Laravel E-Commerce API'
category:
id: 61
name: 'Fugit Facere Dolore'
slug: fugit-facere-dolore
brand:
id: 60
name: 'Qui Vel Ipsam'
slug: qui-vel-ipsam
-
id: 11
category_id: 62
brand_id: 61
name: 'Qui Doloremque Nulla Voluptatem Sequi'
slug: qui-doloremque-nulla-voluptatem-sequi
rate: 177.09
quantity: 7
description: 'Amet consequatur vel dolor quas quibusdam. Officiis repudiandae reprehenderit et voluptatem perspiciatis impedit. Quasi omnis ipsam eos. Eum sit earum incidunt. Est quod nisi quidem magnam aut quia.'
meta_title: 'Qui Doloremque Nulla Voluptatem Sequi Laravel E-Commerce API'
meta_description: 'Qui Doloremque Nulla Voluptatem Sequi Laravel E-Commerce API'
meta_keywords: 'Qui Doloremque Nulla Voluptatem Sequi Laravel E-Commerce API'
category:
id: 62
name: 'Sint Qui Est'
slug: sint-qui-est
brand:
id: 61
name: 'Ut Ut Tempore'
slug: ut-ut-tempore
-
id: 12
category_id: 63
brand_id: 62
name: 'Earum Impedit Illo Illum Beatae'
slug: earum-impedit-illo-illum-beatae
rate: 742.87
quantity: 7
description: 'Tempore quos consequatur nam unde sed ex quisquam. Asperiores cumque quo explicabo id mollitia ut accusamus. Aut ut aspernatur veritatis excepturi ex veniam. Fugit dolore quod est necessitatibus in tempora quo. Autem et tempora culpa sunt.'
meta_title: 'Earum Impedit Illo Illum Beatae Laravel E-Commerce API'
meta_description: 'Earum Impedit Illo Illum Beatae Laravel E-Commerce API'
meta_keywords: 'Earum Impedit Illo Illum Beatae Laravel E-Commerce API'
category:
id: 63
name: 'Error Pariatur Ut'
slug: error-pariatur-ut
brand:
id: 62
name: 'Qui Fuga Iste'
slug: qui-fuga-iste
-
id: 13
category_id: 64
brand_id: 63
name: 'Eum Culpa Ab Sunt Quo'
slug: eum-culpa-ab-sunt-quo
rate: 964.1
quantity: 6
description: 'Sit reprehenderit quasi aperiam aliquid est. Provident aut consequatur dolore quia eum et aut. Sit incidunt reprehenderit dolorum quisquam voluptatem. Officiis soluta aliquam quos deleniti. Qui labore doloribus dolores culpa.'
meta_title: 'Eum Culpa Ab Sunt Quo Laravel E-Commerce API'
meta_description: 'Eum Culpa Ab Sunt Quo Laravel E-Commerce API'
meta_keywords: 'Eum Culpa Ab Sunt Quo Laravel E-Commerce API'
category:
id: 64
name: 'Velit Eos Esse'
slug: velit-eos-esse
brand:
id: 63
name: 'Dolorem Cum Culpa'
slug: dolorem-cum-culpa
-
id: 14
category_id: 65
brand_id: 64
name: 'Non Sed Consectetur Molestiae Qui'
slug: non-sed-consectetur-molestiae-qui
rate: 756.76
quantity: 5
description: 'Impedit laboriosam dignissimos tenetur qui. Ut at sunt cum consequatur. Nisi quo quibusdam quo quo. Ut harum qui accusamus vel unde quia. Laboriosam cum repellat est magnam numquam voluptatem consequatur labore.'
meta_title: 'Non Sed Consectetur Molestiae Qui Laravel E-Commerce API'
meta_description: 'Non Sed Consectetur Molestiae Qui Laravel E-Commerce API'
meta_keywords: 'Non Sed Consectetur Molestiae Qui Laravel E-Commerce API'
category:
id: 65
name: 'Est Voluptatibus Nobis'
slug: est-voluptatibus-nobis
brand:
id: 64
name: 'Et Voluptatibus Molestiae'
slug: et-voluptatibus-molestiae
-
id: 15
category_id: 66
brand_id: 65
name: 'Tempora Voluptas Asperiores Ut Quis'
slug: tempora-voluptas-asperiores-ut-quis
rate: 212.04
quantity: 1
description: 'Debitis harum ullam suscipit ullam ut eum sint neque. Omnis aliquid natus voluptatem explicabo. Nam velit id eos fugiat. Fuga debitis voluptate necessitatibus vel repudiandae. Asperiores debitis quia dolor molestiae.'
meta_title: 'Tempora Voluptas Asperiores Ut Quis Laravel E-Commerce API'
meta_description: 'Tempora Voluptas Asperiores Ut Quis Laravel E-Commerce API'
meta_keywords: 'Tempora Voluptas Asperiores Ut Quis Laravel E-Commerce API'
category:
id: 66
name: 'Officia Eligendi Officia'
slug: officia-eligendi-officia
brand:
id: 65
name: 'Enim Ad Et'
slug: enim-ad-et
-
id: 16
category_id: 67
brand_id: 66
name: 'Ea Repellendus Autem Culpa Quasi'
slug: ea-repellendus-autem-culpa-quasi
rate: 417.03
quantity: 1
description: 'Illo ea voluptate est. Soluta et mollitia repellendus ut. Sapiente tempore quo quia tempora. Aperiam consectetur aut aut sint veritatis atque. Aliquid et qui quas repellendus.'
meta_title: 'Ea Repellendus Autem Culpa Quasi Laravel E-Commerce API'
meta_description: 'Ea Repellendus Autem Culpa Quasi Laravel E-Commerce API'
meta_keywords: 'Ea Repellendus Autem Culpa Quasi Laravel E-Commerce API'
category:
id: 67
name: 'Exercitationem Voluptatem Rerum'
slug: exercitationem-voluptatem-rerum
brand:
id: 66
name: 'Iste Molestias Earum'
slug: iste-molestias-earum
first_page_url: 'http://localhost:8000?page=1'
from: 1
last_page: 4
last_page_url: 'http://localhost:8000?page=4'
links:
-
url: null
label: '« Previous'
active: false
-
url: 'http://localhost:8000?page=1'
label: '1'
active: true
-
url: 'http://localhost:8000?page=2'
label: '2'
active: false
-
url: 'http://localhost:8000?page=3'
label: '3'
active: false
-
url: 'http://localhost:8000?page=4'
label: '4'
active: false
-
url: 'http://localhost:8000?page=2'
label: 'Next »'
active: false
next_page_url: 'http://localhost:8000?page=2'
path: 'http://localhost:8000'
per_page: 16
prev_page_url: null
to: 16
total: 50
properties:
status:
type: string
example: success
message:
type: string
example: ''
data:
type: object
properties:
current_page:
type: integer
example: 1
data:
type: array
example:
-
id: 1
category_id: 52
brand_id: 51
name: 'Iusto Occaecati Necessitatibus Non Asperiores'
slug: iusto-occaecati-necessitatibus-non-asperiores
rate: 64.46
quantity: 5
description: 'Inventore nihil repellat similique exercitationem. Optio veritatis commodi amet ipsum tempore mollitia. Dolor enim sunt repudiandae nemo eaque suscipit quis. Cum animi quia error vero natus ratione eveniet odio. Est consectetur doloremque qui fugiat recusandae facilis aut reprehenderit.'
meta_title: 'Iusto Occaecati Necessitatibus Non Asperiores Laravel E-Commerce API'
meta_description: 'Iusto Occaecati Necessitatibus Non Asperiores Laravel E-Commerce API'
meta_keywords: 'Iusto Occaecati Necessitatibus Non Asperiores Laravel E-Commerce API'
category:
id: 52
name: 'Natus Beatae Dolorem'
slug: natus-beatae-dolorem
brand:
id: 51
name: 'Quidem Natus Laboriosam'
slug: quidem-natus-laboriosam
-
id: 2
category_id: 53
brand_id: 52
name: 'Cum Sit Consequatur Sit Eum'
slug: cum-sit-consequatur-sit-eum
rate: 469.78
quantity: 7
description: 'Tempore voluptatem quia aut asperiores. Sit eos doloribus esse. Deleniti ea quod repellat aut officiis doloremque voluptatem aut. Eos quam omnis culpa ut laudantium sit dolores. Qui reiciendis qui sunt et repudiandae.'
meta_title: 'Cum Sit Consequatur Sit Eum Laravel E-Commerce API'
meta_description: 'Cum Sit Consequatur Sit Eum Laravel E-Commerce API'
meta_keywords: 'Cum Sit Consequatur Sit Eum Laravel E-Commerce API'
category:
id: 53
name: 'Sit Numquam Ducimus'
slug: sit-numquam-ducimus
brand:
id: 52
name: 'Provident Totam Quaerat'
slug: provident-totam-quaerat
-
id: 3
category_id: 54
brand_id: 53
name: 'Veniam Odio Ipsam Enim Quia'
slug: veniam-odio-ipsam-enim-quia
rate: 787.46
quantity: 0
description: 'Rerum itaque qui sint quo dolorem. Quis vel necessitatibus cum aliquid ullam fugit. In consequatur et cumque est et voluptas architecto. Dicta impedit velit quia vel neque culpa voluptatem. Adipisci nesciunt maiores cupiditate enim nihil id tenetur.'
meta_title: 'Veniam Odio Ipsam Enim Quia Laravel E-Commerce API'
meta_description: 'Veniam Odio Ipsam Enim Quia Laravel E-Commerce API'
meta_keywords: 'Veniam Odio Ipsam Enim Quia Laravel E-Commerce API'
category:
id: 54
name: 'Animi Fuga Quisquam'
slug: animi-fuga-quisquam
brand:
id: 53
name: 'Quia Ut Error'
slug: quia-ut-error
-
id: 4
category_id: 55
brand_id: 54
name: 'Maxime Repellat Perferendis Corrupti Quae'
slug: maxime-repellat-perferendis-corrupti-quae
rate: 144.82
quantity: 8
description: 'Rem ratione qui consectetur non. Velit dolor quia ad omnis consequatur. Velit soluta esse sunt aspernatur. Sed labore aut soluta est iure dicta est. Molestias aut earum quo.'
meta_title: 'Maxime Repellat Perferendis Corrupti Quae Laravel E-Commerce API'
meta_description: 'Maxime Repellat Perferendis Corrupti Quae Laravel E-Commerce API'
meta_keywords: 'Maxime Repellat Perferendis Corrupti Quae Laravel E-Commerce API'
category:
id: 55
name: 'Velit Animi Labore'
slug: velit-animi-labore
brand:
id: 54
name: 'Ipsum Libero Tenetur'
slug: ipsum-libero-tenetur
-
id: 5
category_id: 56
brand_id: 55
name: 'Non Perspiciatis Dignissimos Nesciunt Libero'
slug: non-perspiciatis-dignissimos-nesciunt-libero
rate: 896.54
quantity: 6
description: 'Fugit et sed aperiam sit quas libero harum. Quam quae eos quis nobis. Est dignissimos esse in unde ipsum. Sed asperiores rerum reiciendis architecto enim fugiat omnis et. Nihil facilis qui aut culpa.'
meta_title: 'Non Perspiciatis Dignissimos Nesciunt Libero Laravel E-Commerce API'
meta_description: 'Non Perspiciatis Dignissimos Nesciunt Libero Laravel E-Commerce API'
meta_keywords: 'Non Perspiciatis Dignissimos Nesciunt Libero Laravel E-Commerce API'
category:
id: 56
name: 'Consequatur Sapiente Dolores'
slug: consequatur-sapiente-dolores
brand:
id: 55
name: 'Voluptatem Ad Dicta'
slug: voluptatem-ad-dicta
-
id: 6
category_id: 57
brand_id: 56
name: 'Explicabo Impedit Officiis Voluptas Cum'
slug: explicabo-impedit-officiis-voluptas-cum
rate: 832.42
quantity: 8
description: 'Nulla ut ab ipsum molestiae dolor sit. Nam esse ab temporibus nam ad. Illo a beatae sequi. Enim similique sit aliquid eum quae omnis adipisci. Cum accusantium vel quam illum voluptates.'
meta_title: 'Explicabo Impedit Officiis Voluptas Cum Laravel E-Commerce API'
meta_description: 'Explicabo Impedit Officiis Voluptas Cum Laravel E-Commerce API'
meta_keywords: 'Explicabo Impedit Officiis Voluptas Cum Laravel E-Commerce API'
category:
id: 57
name: 'Suscipit Exercitationem Accusantium'
slug: suscipit-exercitationem-accusantium
brand:
id: 56
name: 'Totam Harum Voluptatem'
slug: totam-harum-voluptatem
-
id: 7
category_id: 58
brand_id: 57
name: 'Iure Quis Est Repellendus Quia'
slug: iure-quis-est-repellendus-quia
rate: 345.94
quantity: 2
description: 'Voluptas omnis incidunt quia nisi dolor quia magnam. Ea qui libero corporis eos. Qui architecto minus dolore quas atque. Adipisci consequuntur et a dolorem alias consequatur quas. Fuga voluptatibus maiores et minima.'
meta_title: 'Iure Quis Est Repellendus Quia Laravel E-Commerce API'
meta_description: 'Iure Quis Est Repellendus Quia Laravel E-Commerce API'
meta_keywords: 'Iure Quis Est Repellendus Quia Laravel E-Commerce API'
category:
id: 58
name: 'Aspernatur Quis Accusantium'
slug: aspernatur-quis-accusantium
brand:
id: 57
name: 'Expedita Aut Et'
slug: expedita-aut-et
-
id: 8
category_id: 59
brand_id: 58
name: 'Omnis Est Quisquam Et Occaecati'
slug: omnis-est-quisquam-et-occaecati
rate: 568.97
quantity: 8
description: 'Vero eaque non sint repudiandae ipsum. Vitae culpa quo porro placeat. Amet similique aliquid exercitationem eum. Vero nostrum doloremque occaecati. At ut laudantium quaerat qui exercitationem explicabo dolores.'
meta_title: 'Omnis Est Quisquam Et Occaecati Laravel E-Commerce API'
meta_description: 'Omnis Est Quisquam Et Occaecati Laravel E-Commerce API'
meta_keywords: 'Omnis Est Quisquam Et Occaecati Laravel E-Commerce API'
category:
id: 59
name: 'Nihil Unde Mollitia'
slug: nihil-unde-mollitia
brand:
id: 58
name: 'Nihil Praesentium Dicta'
slug: nihil-praesentium-dicta
-
id: 9
category_id: 60
brand_id: 59
name: 'A Assumenda Eaque Aperiam Omnis'
slug: a-assumenda-eaque-aperiam-omnis
rate: 204.36
quantity: 4
description: 'Possimus non ullam fugiat. Error culpa eveniet aut ipsum harum quia voluptate. Perspiciatis consequuntur asperiores magni aspernatur libero. A ut fuga quas iure ab. Recusandae ut ad dolores voluptas cupiditate odio voluptatem.'
meta_title: 'A Assumenda Eaque Aperiam Omnis Laravel E-Commerce API'
meta_description: 'A Assumenda Eaque Aperiam Omnis Laravel E-Commerce API'
meta_keywords: 'A Assumenda Eaque Aperiam Omnis Laravel E-Commerce API'
category:
id: 60
name: 'Error Consectetur Minus'
slug: error-consectetur-minus
brand:
id: 59
name: 'Mollitia Nam Quas'
slug: mollitia-nam-quas
-
id: 10
category_id: 61
brand_id: 60
name: 'Ratione Consequatur At Et Est'
slug: ratione-consequatur-at-et-est
rate: 862.41
quantity: 4
description: 'Et laborum repellat ipsam voluptatibus repellendus. Libero deleniti ut impedit ut iusto assumenda aut. Corporis et quia quis officiis. Illo eveniet velit necessitatibus fuga modi velit quo et. Dolores doloremque aut deserunt maiores.'
meta_title: 'Ratione Consequatur At Et Est Laravel E-Commerce API'
meta_description: 'Ratione Consequatur At Et Est Laravel E-Commerce API'
meta_keywords: 'Ratione Consequatur At Et Est Laravel E-Commerce API'
category:
id: 61
name: 'Fugit Facere Dolore'
slug: fugit-facere-dolore
brand:
id: 60
name: 'Qui Vel Ipsam'
slug: qui-vel-ipsam
-
id: 11
category_id: 62
brand_id: 61
name: 'Qui Doloremque Nulla Voluptatem Sequi'
slug: qui-doloremque-nulla-voluptatem-sequi
rate: 177.09
quantity: 7
description: 'Amet consequatur vel dolor quas quibusdam. Officiis repudiandae reprehenderit et voluptatem perspiciatis impedit. Quasi omnis ipsam eos. Eum sit earum incidunt. Est quod nisi quidem magnam aut quia.'
meta_title: 'Qui Doloremque Nulla Voluptatem Sequi Laravel E-Commerce API'
meta_description: 'Qui Doloremque Nulla Voluptatem Sequi Laravel E-Commerce API'
meta_keywords: 'Qui Doloremque Nulla Voluptatem Sequi Laravel E-Commerce API'
category:
id: 62
name: 'Sint Qui Est'
slug: sint-qui-est
brand:
id: 61
name: 'Ut Ut Tempore'
slug: ut-ut-tempore
-
id: 12
category_id: 63
brand_id: 62
name: 'Earum Impedit Illo Illum Beatae'
slug: earum-impedit-illo-illum-beatae
rate: 742.87
quantity: 7
description: 'Tempore quos consequatur nam unde sed ex quisquam. Asperiores cumque quo explicabo id mollitia ut accusamus. Aut ut aspernatur veritatis excepturi ex veniam. Fugit dolore quod est necessitatibus in tempora quo. Autem et tempora culpa sunt.'
meta_title: 'Earum Impedit Illo Illum Beatae Laravel E-Commerce API'
meta_description: 'Earum Impedit Illo Illum Beatae Laravel E-Commerce API'
meta_keywords: 'Earum Impedit Illo Illum Beatae Laravel E-Commerce API'
category:
id: 63
name: 'Error Pariatur Ut'
slug: error-pariatur-ut
brand:
id: 62
name: 'Qui Fuga Iste'
slug: qui-fuga-iste
-
id: 13
category_id: 64
brand_id: 63
name: 'Eum Culpa Ab Sunt Quo'
slug: eum-culpa-ab-sunt-quo
rate: 964.1
quantity: 6
description: 'Sit reprehenderit quasi aperiam aliquid est. Provident aut consequatur dolore quia eum et aut. Sit incidunt reprehenderit dolorum quisquam voluptatem. Officiis soluta aliquam quos deleniti. Qui labore doloribus dolores culpa.'
meta_title: 'Eum Culpa Ab Sunt Quo Laravel E-Commerce API'
meta_description: 'Eum Culpa Ab Sunt Quo Laravel E-Commerce API'
meta_keywords: 'Eum Culpa Ab Sunt Quo Laravel E-Commerce API'
category:
id: 64
name: 'Velit Eos Esse'
slug: velit-eos-esse
brand:
id: 63
name: 'Dolorem Cum Culpa'
slug: dolorem-cum-culpa
-
id: 14
category_id: 65
brand_id: 64
name: 'Non Sed Consectetur Molestiae Qui'
slug: non-sed-consectetur-molestiae-qui
rate: 756.76
quantity: 5
description: 'Impedit laboriosam dignissimos tenetur qui. Ut at sunt cum consequatur. Nisi quo quibusdam quo quo. Ut harum qui accusamus vel unde quia. Laboriosam cum repellat est magnam numquam voluptatem consequatur labore.'
meta_title: 'Non Sed Consectetur Molestiae Qui Laravel E-Commerce API'
meta_description: 'Non Sed Consectetur Molestiae Qui Laravel E-Commerce API'
meta_keywords: 'Non Sed Consectetur Molestiae Qui Laravel E-Commerce API'
category:
id: 65
name: 'Est Voluptatibus Nobis'
slug: est-voluptatibus-nobis
brand:
id: 64
name: 'Et Voluptatibus Molestiae'
slug: et-voluptatibus-molestiae
-
id: 15
category_id: 66
brand_id: 65
name: 'Tempora Voluptas Asperiores Ut Quis'
slug: tempora-voluptas-asperiores-ut-quis
rate: 212.04
quantity: 1
description: 'Debitis harum ullam suscipit ullam ut eum sint neque. Omnis aliquid natus voluptatem explicabo. Nam velit id eos fugiat. Fuga debitis voluptate necessitatibus vel repudiandae. Asperiores debitis quia dolor molestiae.'
meta_title: 'Tempora Voluptas Asperiores Ut Quis Laravel E-Commerce API'
meta_description: 'Tempora Voluptas Asperiores Ut Quis Laravel E-Commerce API'
meta_keywords: 'Tempora Voluptas Asperiores Ut Quis Laravel E-Commerce API'
category:
id: 66
name: 'Officia Eligendi Officia'
slug: officia-eligendi-officia
brand:
id: 65
name: 'Enim Ad Et'
slug: enim-ad-et
-
id: 16
category_id: 67
brand_id: 66
name: 'Ea Repellendus Autem Culpa Quasi'
slug: ea-repellendus-autem-culpa-quasi
rate: 417.03
quantity: 1
description: 'Illo ea voluptate est. Soluta et mollitia repellendus ut. Sapiente tempore quo quia tempora. Aperiam consectetur aut aut sint veritatis atque. Aliquid et qui quas repellendus.'
meta_title: 'Ea Repellendus Autem Culpa Quasi Laravel E-Commerce API'
meta_description: 'Ea Repellendus Autem Culpa Quasi Laravel E-Commerce API'
meta_keywords: 'Ea Repellendus Autem Culpa Quasi Laravel E-Commerce API'
category:
id: 67
name: 'Exercitationem Voluptatem Rerum'
slug: exercitationem-voluptatem-rerum
brand:
id: 66
name: 'Iste Molestias Earum'
slug: iste-molestias-earum
items:
type: object
properties:
id:
type: integer
example: 1
category_id:
type: integer
example: 52
brand_id:
type: integer
example: 51
name:
type: string
example: 'Iusto Occaecati Necessitatibus Non Asperiores'
slug:
type: string
example: iusto-occaecati-necessitatibus-non-asperiores
rate:
type: number
example: 64.46
quantity:
type: integer
example: 5
description:
type: string
example: 'Inventore nihil repellat similique exercitationem. Optio veritatis commodi amet ipsum tempore mollitia. Dolor enim sunt repudiandae nemo eaque suscipit quis. Cum animi quia error vero natus ratione eveniet odio. Est consectetur doloremque qui fugiat recusandae facilis aut reprehenderit.'
meta_title:
type: string
example: 'Iusto Occaecati Necessitatibus Non Asperiores Laravel E-Commerce API'
meta_description:
type: string
example: 'Iusto Occaecati Necessitatibus Non Asperiores Laravel E-Commerce API'
meta_keywords:
type: string
example: 'Iusto Occaecati Necessitatibus Non Asperiores Laravel E-Commerce API'
category:
type: object
properties:
id:
type: integer
example: 52
name:
type: string
example: 'Natus Beatae Dolorem'
slug:
type: string
example: natus-beatae-dolorem
brand:
type: object
properties:
id:
type: integer
example: 51
name:
type: string
example: 'Quidem Natus Laboriosam'
slug:
type: string
example: quidem-natus-laboriosam
first_page_url:
type: string
example: 'http://localhost:8000?page=1'
from:
type: integer
example: 1
last_page:
type: integer
example: 4
last_page_url:
type: string
example: 'http://localhost:8000?page=4'
links:
type: array
example:
-
url: null
label: '« Previous'
active: false
-
url: 'http://localhost:8000?page=1'
label: '1'
active: true
-
url: 'http://localhost:8000?page=2'
label: '2'
active: false
-
url: 'http://localhost:8000?page=3'
label: '3'
active: false
-
url: 'http://localhost:8000?page=4'
label: '4'
active: false
-
url: 'http://localhost:8000?page=2'
label: 'Next »'
active: false
items:
type: object
properties:
url:
type: string
example: null
label:
type: string
example: '« Previous'
active:
type: boolean
example: false
next_page_url:
type: string
example: 'http://localhost:8000?page=2'
path:
type: string
example: 'http://localhost:8000'
per_page:
type: integer
example: 16
prev_page_url:
type: string
example: null
to:
type: integer
example: 16
total:
type: integer
example: 50
tags:
- 'Administrator Endpoints'
post:
summary: 'Add new Product'
operationId: addNewProduct
description: "Create a new Product and store it's details."
parameters: []
responses:
201:
description: ''
content:
application/json:
schema:
type: object
example:
status: success
message: 'Product added successfully.'
data:
name: 'Product 1'
rate: 10
quantity: 10
category_id: 1
brand_id: 1
description: 'Qui aut quia soluta ut et repellendus aut.'
meta_title: jqfpfenwpledzbrovcmnsylb
meta_description: sdovbzcbfmbwnxpgvrqzdi
meta_keywords: dvrisbpzc
slug: product-1
updated_at: '2023-05-18T00:00:00.000000Z'
created_at: '2023-05-18T00:00:00.000000Z'
id: 1
properties:
status:
type: string
example: success
message:
type: string
example: 'Product added successfully.'
data:
type: object
properties:
name:
type: string
example: 'Product 1'
rate:
type: integer
example: 10
quantity:
type: integer
example: 10
category_id:
type: integer
example: 1
brand_id:
type: integer
example: 1
description:
type: string
example: 'Qui aut quia soluta ut et repellendus aut.'
meta_title:
type: string
example: jqfpfenwpledzbrovcmnsylb
meta_description:
type: string
example: sdovbzcbfmbwnxpgvrqzdi
meta_keywords:
type: string
example: dvrisbpzc
slug:
type: string
example: product-1
updated_at:
type: string
example: '2023-05-18T00:00:00.000000Z'
created_at:
type: string
example: '2023-05-18T00:00:00.000000Z'
id:
type: integer
example: 1
422:
description: ''
content:
application/json:
schema:
type: object
example:
message: 'The name field is required. (and 3 more errors)'
errors:
name:
- 'The name field is required.'
category_id:
- 'The category field is required.'
description:
- 'The description field is required.'
meta_title:
- 'The meta title field is required.'
meta_description:
- 'The meta description field is required.'
properties:
message:
type: string
example: 'The name field is required. (and 3 more errors)'
errors:
type: object
properties:
name:
type: array
example:
- 'The name field is required.'
items:
type: string
category_id:
type: array
example:
- 'The category field is required.'
items:
type: string
description:
type: array
example:
- 'The description field is required.'
items:
type: string
meta_title:
type: array
example:
- 'The meta title field is required.'
items:
type: string
meta_description:
type: array
example:
- 'The meta description field is required.'
items:
type: string
tags:
- 'Administrator Endpoints'
requestBody:
required: true
content:
multipart/form-data:
schema:
type: object
properties:
name:
type: string
description: 'Required. The name of the product. Must not be greater than 100 characters.'
example: Gucci
nullable: false
description:
type: string
description: 'Required. The description of the product.'
example: 'Gucci clothes made of the best quality materials sold all over the world.'
nullable: false
category_id:
type: integer
description: 'Required. The id of category that this product is being added in. Should be positive integer, and should exist in categories table. The id of an existing record in the categories table.'
example: 1
nullable: false
brand_id:
type: integer
description: 'Required. The id of brand that this product is being added in. Should be positive integer, and should exist in brands table. The id of an existing record in the brands table.'
example: 1
nullable: false
rate:
type: number
description: 'Required. The amount of the product that it will be sold to the customers. Should be positive integer, greater than 0. Must be at least 0.0.'
example: 119.0
nullable: false
quantity:
type: number
description: 'Required. The quantity of the product. Should be positive integer, greater than 0. Must be at least 0.'
example: 10.0
nullable: false
image:
type: string
format: binary
description: 'Required. The image of the product. Should be a valid file with a valid extension of either jpg, jpeg, or png. No other image file types are supported at the moment. Must be a file. Must not be greater than 1024 kilobytes.'
nullable: false
meta_title:
type: string
description: 'Required. The title of the page. Refers to the text that is displayed on search engine result pages and browser tabs to indicate the topic of a webpage. Must not be greater than 80 characters.'
example: 'Gucci clothes made of the best quality materials.'
nullable: false
meta_description:
type: string
description: 'Required. This informs and interests users with a short, relevant summary of what a particular page is about. Must not be greater than 180 characters.'
example: 'Gucci clothes made of the best quality materials sold all over the world.'
nullable: false
meta_keywords:
type: string
description: 'A comma separated words or phrases related to the product. Must not be greater than 255 characters.'
example: 'T-shirt, Gucci clothes, best quality tshirt for women'
nullable: true
required:
- name
- description
- category_id
- brand_id
- rate
- quantity
- image
- meta_title
- meta_description
'/api/v1/admin/products/{id}':
get:
summary: 'Get single Product'
operationId: getSingleProduct
description: 'Fetch the details about the given Product id.'
parameters: []
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
status: success
message: ''
data:
name: 'Product 1'
rate: 10
quantity: 10
category_id: 1
brand_id: 1
description: 'Qui aut quia soluta ut et repellendus aut.'
meta_title: jqfpfenwpledzbrovcmnsylb
meta_description: sdovbzcbfmbwnxpgvrqzdi
meta_keywords: dvrisbpzc
slug: product-1
updated_at: '2023-05-18T00:00:00.000000Z'
created_at: '2023-05-18T00:00:00.000000Z'
id: 1
properties:
status:
type: string
example: success
message:
type: string
example: ''
data:
type: object
properties:
name:
type: string
example: 'Product 1'
rate:
type: integer
example: 10
quantity:
type: integer
example: 10
category_id:
type: integer
example: 1
brand_id:
type: integer
example: 1
description:
type: string
example: 'Qui aut quia soluta ut et repellendus aut.'
meta_title:
type: string
example: jqfpfenwpledzbrovcmnsylb
meta_description:
type: string
example: sdovbzcbfmbwnxpgvrqzdi
meta_keywords:
type: string
example: dvrisbpzc
slug:
type: string
example: product-1
updated_at:
type: string
example: '2023-05-18T00:00:00.000000Z'
created_at:
type: string
example: '2023-05-18T00:00:00.000000Z'
id:
type: integer
example: 1
404:
description: ''
content:
application/json:
schema:
type: object
example:
status: failed
message: 'Product not found.'
data: []
properties:
status:
type: string
example: failed
message:
type: string
example: 'Product not found.'
data:
type: array
example: []
tags:
- 'Administrator Endpoints'
put:
summary: 'Update Product'
operationId: updateProduct
description: 'Update the Product details of the given id.'
parameters: []
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
status: success
message: 'Product updated successfully.'
data:
name: 'Product 1'
description: 'Qui aut quia soluta ut et repellendus aut.'
meta_title: jqfpfenwpledzbrovcmnsylb
meta_description: sdovbzcbfmbwnxpgvrqzdi
meta_keywords: dvrisbpzc
slug: product-1
updated_at: '2023-05-18T00:00:00.000000Z'
created_at: '2023-05-18T00:00:00.000000Z'
id: 1
properties:
status:
type: string
example: success
message:
type: string
example: 'Product updated successfully.'
data:
type: object
properties:
name:
type: string
example: 'Product 1'
description:
type: string
example: 'Qui aut quia soluta ut et repellendus aut.'
meta_title:
type: string
example: jqfpfenwpledzbrovcmnsylb
meta_description:
type: string
example: sdovbzcbfmbwnxpgvrqzdi
meta_keywords:
type: string
example: dvrisbpzc
slug:
type: string
example: product-1
updated_at:
type: string
example: '2023-05-18T00:00:00.000000Z'
created_at:
type: string
example: '2023-05-18T00:00:00.000000Z'
id:
type: integer
example: 1
404:
description: ''
content:
application/json:
schema:
type: object
example:
status: failed
message: 'Product not found.'
data: []
properties:
status:
type: string
example: failed
message:
type: string
example: 'Product not found.'
data:
type: array
example: []
422:
description: ''
content:
application/json:
schema:
type: object
example:
message: 'The name field is required. (and 3 more errors)'
errors:
name:
- 'The name field is required.'
category_id:
- 'The category field is required.'
description:
- 'The description field is required.'
meta_title:
- 'The meta title field is required.'
meta_description:
- 'The meta description field is required.'
properties:
message:
type: string
example: 'The name field is required. (and 3 more errors)'
errors:
type: object
properties:
name:
type: array
example:
- 'The name field is required.'
items:
type: string
category_id:
type: array
example:
- 'The category field is required.'
items:
type: string
description:
type: array
example:
- 'The description field is required.'
items:
type: string
meta_title:
type: array
example:
- 'The meta title field is required.'
items:
type: string
meta_description:
type: array
example:
- 'The meta description field is required.'
items:
type: string
tags:
- 'Administrator Endpoints'
requestBody:
required: true
content:
multipart/form-data:
schema:
type: object
properties:
name:
type: string
description: 'Required. The name of the product. Must not be greater than 100 characters.'
example: Gucci
nullable: false
description:
type: string
description: 'Required. The description of the product.'
example: 'Gucci clothes made of the best quality materials sold all over the world.'
nullable: false
category_id:
type: integer
description: 'Required. The id of category that this product is being added in. Should be positive integer, and should exist in categories table. The id of an existing record in the categories table.'
example: 1
nullable: false
brand_id:
type: integer
description: 'Required. The id of brand that this product is being added in. Should be positive integer, and should exist in brands table. The id of an existing record in the brands table.'
example: 1
nullable: false
rate:
type: number
description: 'Required. The amount of the product that it will be sold to the customers. Should be positive integer, greater than 0. Must be at least 0.0.'
example: 119.0
nullable: false
quantity:
type: number
description: 'Required. The quantity of the product. Should be positive integer, greater than 0. Must be at least 0.'
example: 10.0
nullable: false
image:
type: string
format: binary
description: 'Optional. The image of the product. Should be a valid file with a valid extension of either jpg, jpeg, or png. No other image file types are supported at the moment. Must be a file. Must not be greater than 1024 kilobytes.'
nullable: true
meta_title:
type: string
description: 'Required. The title of the page. Refers to the text that is displayed on search engine result pages and browser tabs to indicate the topic of a webpage. Must not be greater than 80 characters.'
example: 'Gucci clothes made of the best quality materials.'
nullable: false
meta_description:
type: string
description: 'Required. This informs and interests users with a short, relevant summary of what a particular page is about. Must not be greater than 180 characters.'
example: 'Gucci clothes made of the best quality materials sold all over the world.'
nullable: false
meta_keywords:
type: string
description: 'A comma separated words or phrases related to the product. Must not be greater than 255 characters.'
example: 'T-shirt, Gucci clothes, best quality tshirt for women'
nullable: true
required:
- name
- description
- category_id
- brand_id
- rate
- quantity
- meta_title
- meta_description
delete:
summary: 'Delete a Product'
operationId: deleteAProduct
description: "Delete the Product details of the given id.\nThis will soft delete the Product.\nMeaning the record will be present in the database, however,\nit won't be available to access."
parameters: []
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
status: success
message: 'Product deleted successfully.'
data: []
properties:
status:
type: string
example: success
message:
type: string
example: 'Product deleted successfully.'
data:
type: array
example: []
404:
description: ''
content:
application/json:
schema:
type: object
example:
status: failed
message: 'Product not found.'
data: []
properties:
status:
type: string
example: failed
message:
type: string
example: 'Product not found.'
data:
type: array
example: []
tags:
- 'Administrator Endpoints'
parameters:
-
in: path
name: id
description: 'The id of the Product.'
example: 1
required: true
schema:
type: integer
/api/user/billing-address:
get:
summary: 'List all billing addresses'
operationId: listAllBillingAddresses
description: 'Displays all the billing addresses that are added by the user.'
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- 'User Endpoints'
/api/user/billing-address/store:
post:
summary: 'Add new billing address'
operationId: addNewBillingAddress
description: 'Store the new billing address with the provided details.'
parameters: []
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
status: success
message: 'Billing address created successfully.'
data:
id: 1
user_id: 2
type: 1
first_name: John
last_name: Doe
email: johndoe@example.com
contact: '9876543210'
address_line_1: '24, Building Name'
address_line_2: 'Some street name'
area: 'St. Peters Stn'
landmark: 'Chill StarBucks Cafe'
city: Mumbai
postal_code: '400001'
state_province: Maharashtra
country: India
created_at: '2023-06-20T16:11:57.000000Z'
updated_at: '2023-06-20T16:11:57.000000Z'
properties:
status:
type: string
example: success
message:
type: string
example: 'Billing address created successfully.'
data:
type: object
properties:
id:
type: integer
example: 1
user_id:
type: integer
example: 2
type:
type: integer
example: 1
first_name:
type: string
example: John
last_name:
type: string
example: Doe
email:
type: string
example: johndoe@example.com
contact:
type: string
example: '9876543210'
address_line_1:
type: string
example: '24, Building Name'
address_line_2:
type: string
example: 'Some street name'
area:
type: string
example: 'St. Peters Stn'
landmark:
type: string
example: 'Chill StarBucks Cafe'
city:
type: string
example: Mumbai
postal_code:
type: string
example: '400001'
state_province:
type: string
example: Maharashtra
country:
type: string
example: India
created_at:
type: string
example: '2023-06-20T16:11:57.000000Z'
updated_at:
type: string
example: '2023-06-20T16:11:57.000000Z'
422:
description: ''
content:
application/json:
schema:
type: object
example:
message: 'The first name field is required. (and 9 more errors)'
errors:
first_name:
- 'The first name field is required.'
last_name:
- 'The last name field is required.'
email:
- 'The email field is required.'
contact:
- 'The contact field is required.'
address_line_1:
- 'The address line 1 field is required.'
area:
- 'The area field is required.'
city:
- 'The city field is required.'
postal_code:
- 'The postal code field is required.'
state_province:
- 'The state province field is required.'
country:
- 'The country field is required.'
properties:
message:
type: string
example: 'The first name field is required. (and 9 more errors)'
errors:
type: object
properties:
first_name:
type: array
example:
- 'The first name field is required.'
items:
type: string
last_name:
type: array
example:
- 'The last name field is required.'
items:
type: string
email:
type: array
example:
- 'The email field is required.'
items:
type: string
contact:
type: array
example:
- 'The contact field is required.'
items:
type: string
address_line_1:
type: array
example:
- 'The address line 1 field is required.'
items:
type: string
area:
type: array
example:
- 'The area field is required.'
items:
type: string
city:
type: array
example:
- 'The city field is required.'
items:
type: string
postal_code:
type: array
example:
- 'The postal code field is required.'
items:
type: string
state_province:
type: array
example:
- 'The state province field is required.'
items:
type: string
country:
type: array
example:
- 'The country field is required.'
items:
type: string
tags:
- 'User Endpoints'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
first_name:
type: string
description: 'Required. The first name of the user on whom the invoice will be generated. Generally, it is the first name of the authenticated user. Must not be greater than 100 characters.'
example: John
nullable: false
last_name:
type: string
description: 'Required. The last name of the user on whom the invoice will be generated. Generally, it is the last name of the authenticated user. Must not be greater than 100 characters.'
example: Doe
nullable: false
email:
type: string
description: 'Required. The email of the user of whom the invoice will be generated. Generally, it is the email of the authenticated user. Must be a valid email address. Must not be greater than 100 characters.'
example: johndoe@example.com
nullable: false
contact:
type: string
description: 'Required. The contact number of the user of whom the invoice will be generated. Generally, it is the contact number of the authenticated user. Must not be greater than 20 characters.'
example: '9876543210'
nullable: false
address_line_1:
type: string
description: 'Required. The first line of the address. Generally, this is the room/flat/apartment number of the user. Must not be greater than 100 characters.'
example: '24, Building Name'
nullable: false
address_line_2:
type: string
description: 'Optional. The second line of the address. Generally, this is the street name and/or number where the user lives. Must not be greater than 100 characters.'
example: 'Some street name'
nullable: true
area:
type: string
description: 'Required. Generally, it is the nearest railway station name. But you can give it anything of your choice. Must not be greater than 100 characters.'
example: 'St. Peters Stn'
nullable: false
landmark:
type: string
description: 'Optional. The famous landmark nearby to your house. Must not be greater than 100 characters.'
example: 'Chill StarBucks Cafe'
nullable: true
city:
type: string
description: 'Required. The city in which the user resides. Must not be greater than 100 characters.'
example: Mumbai
nullable: false
postal_code:
type: string
description: 'Required. The postal or zip or ping code. Must contain only letters and numbers. Must not be greater than 20 characters.'
example: '123456'
nullable: false
state_province:
type: string
description: 'Required. The state or province in which your city is. Must not be greater than 100 characters.'
example: Mahrashtra
nullable: false
country:
type: string
description: 'Required. The name of the country. Must not be greater than 100 characters.'
example: India
nullable: false
required:
- first_name
- last_name
- email
- contact
- address_line_1
- area
- city
- postal_code
- state_province
- country
'/api/user/billing-address/{id}':
put:
summary: 'Update billing address'
operationId: updateBillingAddress
description: 'Updates the existing billing address of the provided id with the provided details.'
parameters: []
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
status: success
message: 'Billing address updated successfully.'
data:
id: 1
user_id: 2
type: 1
first_name: John
last_name: Doe
email: johndoe@example.com
contact: '9876543210'
address_line_1: '24, Building Name'
address_line_2: 'Some street name'
area: 'St. Peters Stn'
landmark: 'Chill StarBucks Cafe'
city: Mumbai
postal_code: '400001'
state_province: Maharashtra
country: India
created_at: '2023-06-20T16:11:57.000000Z'
updated_at: '2023-06-20T16:11:57.000000Z'
properties:
status:
type: string
example: success
message:
type: string
example: 'Billing address updated successfully.'
data:
type: object
properties:
id:
type: integer
example: 1
user_id:
type: integer
example: 2
type:
type: integer
example: 1
first_name:
type: string
example: John
last_name:
type: string
example: Doe
email:
type: string
example: johndoe@example.com
contact:
type: string
example: '9876543210'
address_line_1:
type: string
example: '24, Building Name'
address_line_2:
type: string
example: 'Some street name'
area:
type: string
example: 'St. Peters Stn'
landmark:
type: string
example: 'Chill StarBucks Cafe'
city:
type: string
example: Mumbai
postal_code:
type: string
example: '400001'
state_province:
type: string
example: Maharashtra
country:
type: string
example: India
created_at:
type: string
example: '2023-06-20T16:11:57.000000Z'
updated_at:
type: string
example: '2023-06-20T16:11:57.000000Z'
422:
description: ''
content:
application/json:
schema:
type: object
example:
message: 'The first name field is required. (and 9 more errors)'
errors:
first_name:
- 'The first name field is required.'
last_name:
- 'The last name field is required.'
email:
- 'The email field is required.'
contact:
- 'The contact field is required.'
address_line_1:
- 'The address line 1 field is required.'
area:
- 'The area field is required.'
city:
- 'The city field is required.'
postal_code:
- 'The postal code field is required.'
state_province:
- 'The state province field is required.'
country:
- 'The country field is required.'
properties:
message:
type: string
example: 'The first name field is required. (and 9 more errors)'
errors:
type: object
properties:
first_name:
type: array
example:
- 'The first name field is required.'
items:
type: string
last_name:
type: array
example:
- 'The last name field is required.'
items:
type: string
email:
type: array
example:
- 'The email field is required.'
items:
type: string
contact:
type: array
example:
- 'The contact field is required.'
items:
type: string
address_line_1:
type: array
example:
- 'The address line 1 field is required.'
items:
type: string
area:
type: array
example:
- 'The area field is required.'
items:
type: string
city:
type: array
example:
- 'The city field is required.'
items:
type: string
postal_code:
type: array
example:
- 'The postal code field is required.'
items:
type: string
state_province:
type: array
example:
- 'The state province field is required.'
items:
type: string
country:
type: array
example:
- 'The country field is required.'
items:
type: string
tags:
- 'User Endpoints'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
first_name:
type: string
description: 'Required. The first name of the user on whom the invoice will be generated. Generally, it is the first name of the authenticated user. Must not be greater than 100 characters.'
example: John
nullable: false
last_name:
type: string
description: 'Required. The last name of the user on whom the invoice will be generated. Generally, it is the last name of the authenticated user. Must not be greater than 100 characters.'
example: Doe
nullable: false
email:
type: string
description: 'Required. The email of the user of whom the invoice will be generated. Generally, it is the email of the authenticated user. Must be a valid email address. Must not be greater than 100 characters.'
example: johndoe@example.com
nullable: false
contact:
type: string
description: 'Required. The contact number of the user of whom the invoice will be generated. Generally, it is the contact number of the authenticated user. Must not be greater than 20 characters.'
example: '9876543210'
nullable: false
address_line_1:
type: string
description: 'Required. The first line of the address. Generally, this is the room/flat/apartment number of the user. Must not be greater than 100 characters.'
example: '24, Building Name'
nullable: false
address_line_2:
type: string
description: 'Optional. The second line of the address. Generally, this is the street name and/or number where the user lives. Must not be greater than 100 characters.'
example: 'Some street name'
nullable: true
area:
type: string
description: 'Required. Generally, it is the nearest railway station name. But you can give it anything of your choice. Must not be greater than 100 characters.'
example: 'St. Peters Stn'
nullable: false
landmark:
type: string
description: 'Optional. The famous landmark nearby to your house. Must not be greater than 100 characters.'
example: 'Chill StarBucks Cafe'
nullable: true
city:
type: string
description: 'Required. The city in which the user resides. Must not be greater than 100 characters.'
example: Mumbai
nullable: false
postal_code:
type: string
description: 'Required. The postal or zip or ping code. Must contain only letters and numbers. Must not be greater than 20 characters.'
example: '123456'
nullable: false
state_province:
type: string
description: 'Required. The state or province in which your city is. Must not be greater than 100 characters.'
example: Mahrashtra
nullable: false
country:
type: string
description: 'Required. The name of the country. Must not be greater than 100 characters.'
example: India
nullable: false
required:
- first_name
- last_name
- email
- contact
- address_line_1
- area
- city
- postal_code
- state_province
- country
delete:
summary: 'Delete billing address'
operationId: deleteBillingAddress
description: 'Deletes the existing billing address of the provided id.'
parameters: []
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
status: success
message: 'Billing address deleted successfully.'
data: []
properties:
status:
type: string
example: success
message:
type: string
example: 'Billing address deleted successfully.'
data:
type: array
example: []
404:
description: ''
content:
application/json:
schema:
type: object
example:
status: failed
message: 'Billing address not found.'
data: []
properties:
status:
type: string
example: failed
message:
type: string
example: 'Billing address not found.'
data:
type: array
example: []
tags:
- 'User Endpoints'
parameters:
-
in: path
name: id
description: 'The id of the billing address.'
example: 1
required: true
schema:
type: integer
/api/user/shipping-address:
get:
summary: 'List all shipping addresses'
operationId: listAllShippingAddresses
description: 'Displays all the shipping addresses that are added by the user.'
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- 'User Endpoints'
/api/user/shipping-address/store:
post:
summary: 'Add new shipping address'
operationId: addNewShippingAddress
description: 'Store the new shipping address with the provided details.'
parameters: []
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
status: success
message: 'Shipping address created successfully.'
data:
id: 1
user_id: 2
type: 2
first_name: John
last_name: Doe
email: johndoe@example.com
contact: '9876543210'
address_line_1: '24, Building Name'
address_line_2: 'Some street name'
area: 'St. Peters Stn'
landmark: 'Chill StarBucks Cafe'
city: Mumbai
postal_code: '400001'
state_province: Maharashtra
country: India
created_at: '2023-06-20T16:11:57.000000Z'
updated_at: '2023-06-20T16:11:57.000000Z'
properties:
status:
type: string
example: success
message:
type: string
example: 'Shipping address created successfully.'
data:
type: object
properties:
id:
type: integer
example: 1
user_id:
type: integer
example: 2
type:
type: integer
example: 2
first_name:
type: string
example: John
last_name:
type: string
example: Doe
email:
type: string
example: johndoe@example.com
contact:
type: string
example: '9876543210'
address_line_1:
type: string
example: '24, Building Name'
address_line_2:
type: string
example: 'Some street name'
area:
type: string
example: 'St. Peters Stn'
landmark:
type: string
example: 'Chill StarBucks Cafe'
city:
type: string
example: Mumbai
postal_code:
type: string
example: '400001'
state_province:
type: string
example: Maharashtra
country:
type: string
example: India
created_at:
type: string
example: '2023-06-20T16:11:57.000000Z'
updated_at:
type: string
example: '2023-06-20T16:11:57.000000Z'
422:
description: ''
content:
application/json:
schema:
type: object
example:
message: 'The first name field is required. (and 9 more errors)'
errors:
first_name:
- 'The first name field is required.'
last_name:
- 'The last name field is required.'
email:
- 'The email field is required.'
contact:
- 'The contact field is required.'
address_line_1:
- 'The address line 1 field is required.'
area:
- 'The area field is required.'
city:
- 'The city field is required.'
postal_code:
- 'The postal code field is required.'
state_province:
- 'The state province field is required.'
country:
- 'The country field is required.'
properties:
message:
type: string
example: 'The first name field is required. (and 9 more errors)'
errors:
type: object
properties:
first_name:
type: array
example:
- 'The first name field is required.'
items:
type: string
last_name:
type: array
example:
- 'The last name field is required.'
items:
type: string
email:
type: array
example:
- 'The email field is required.'
items:
type: string
contact:
type: array
example:
- 'The contact field is required.'
items:
type: string
address_line_1:
type: array
example:
- 'The address line 1 field is required.'
items:
type: string
area:
type: array
example:
- 'The area field is required.'
items:
type: string
city:
type: array
example:
- 'The city field is required.'
items:
type: string
postal_code:
type: array
example:
- 'The postal code field is required.'
items:
type: string
state_province:
type: array
example:
- 'The state province field is required.'
items:
type: string
country:
type: array
example:
- 'The country field is required.'
items:
type: string
tags:
- 'User Endpoints'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
first_name:
type: string
description: 'Required. The first name of the user on whom the invoice will be generated. Generally, it is the first name of the authenticated user. Must not be greater than 100 characters.'
example: John
nullable: false
last_name:
type: string
description: 'Required. The last name of the user on whom the invoice will be generated. Generally, it is the last name of the authenticated user. Must not be greater than 100 characters.'
example: Doe
nullable: false
email:
type: string
description: 'Required. The email of the user of whom the invoice will be generated. Generally, it is the email of the authenticated user. Must be a valid email address. Must not be greater than 100 characters.'
example: johndoe@example.com
nullable: false
contact:
type: string
description: 'Required. The contact number of the user of whom the invoice will be generated. Generally, it is the contact number of the authenticated user. Must not be greater than 20 characters.'
example: '9876543210'
nullable: false
address_line_1:
type: string
description: 'Required. The first line of the address. Generally, this is the room/flat/apartment number of the user. Must not be greater than 100 characters.'
example: '24, Building Name'
nullable: false
address_line_2:
type: string
description: 'Optional. The second line of the address. Generally, this is the street name and/or number where the user lives. Must not be greater than 100 characters.'
example: 'Some street name'
nullable: true
area:
type: string
description: 'Required. Generally, it is the nearest railway station name. But you can give it anything of your choice. Must not be greater than 100 characters.'
example: 'St. Peters Stn'
nullable: false
landmark:
type: string
description: 'Optional. The famous landmark nearby to your house. Must not be greater than 100 characters.'
example: 'Chill StarBucks Cafe'
nullable: true
city:
type: string
description: 'Required. The city in which the user resides. Must not be greater than 100 characters.'
example: Mumbai
nullable: false
postal_code:
type: string
description: 'Required. The postal or zip or ping code. Must contain only letters and numbers. Must not be greater than 20 characters.'
example: '123456'
nullable: false
state_province:
type: string
description: 'Required. The state or province in which your city is. Must not be greater than 100 characters.'
example: Mahrashtra
nullable: false
country:
type: string
description: 'Required. The name of the country. Must not be greater than 100 characters.'
example: India
nullable: false
required:
- first_name
- last_name
- email
- contact
- address_line_1
- area
- city
- postal_code
- state_province
- country
'/api/user/shipping-address/{id}':
put:
summary: 'Update shipping address'
operationId: updateShippingAddress
description: 'Updates the existing shipping address of the provided id with the provided details.'
parameters: []
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
status: success
message: 'Shipping address updated successfully.'
data:
id: 1
user_id: 2
type: 2
first_name: John
last_name: Doe
email: johndoe@example.com
contact: '9876543210'
address_line_1: '24, Building Name'
address_line_2: 'Some street name'
area: 'St. Peters Stn'
landmark: 'Chill StarBucks Cafe'
city: Mumbai
postal_code: '400001'
state_province: Maharashtra
country: India
created_at: '2023-06-20T16:11:57.000000Z'
updated_at: '2023-06-20T16:11:57.000000Z'
properties:
status:
type: string
example: success
message:
type: string
example: 'Shipping address updated successfully.'
data:
type: object
properties:
id:
type: integer
example: 1
user_id:
type: integer
example: 2
type:
type: integer
example: 2
first_name:
type: string
example: John
last_name:
type: string
example: Doe
email:
type: string
example: johndoe@example.com
contact:
type: string
example: '9876543210'
address_line_1:
type: string
example: '24, Building Name'
address_line_2:
type: string
example: 'Some street name'
area:
type: string
example: 'St. Peters Stn'
landmark:
type: string
example: 'Chill StarBucks Cafe'
city:
type: string
example: Mumbai
postal_code:
type: string
example: '400001'
state_province:
type: string
example: Maharashtra
country:
type: string
example: India
created_at:
type: string
example: '2023-06-20T16:11:57.000000Z'
updated_at:
type: string
example: '2023-06-20T16:11:57.000000Z'
422:
description: ''
content:
application/json:
schema:
type: object
example:
message: 'The first name field is required. (and 9 more errors)'
errors:
first_name:
- 'The first name field is required.'
last_name:
- 'The last name field is required.'
email:
- 'The email field is required.'
contact:
- 'The contact field is required.'
address_line_1:
- 'The address line 1 field is required.'
area:
- 'The area field is required.'
city:
- 'The city field is required.'
postal_code:
- 'The postal code field is required.'
state_province:
- 'The state province field is required.'
country:
- 'The country field is required.'
properties:
message:
type: string
example: 'The first name field is required. (and 9 more errors)'
errors:
type: object
properties:
first_name:
type: array
example:
- 'The first name field is required.'
items:
type: string
last_name:
type: array
example:
- 'The last name field is required.'
items:
type: string
email:
type: array
example:
- 'The email field is required.'
items:
type: string
contact:
type: array
example:
- 'The contact field is required.'
items:
type: string
address_line_1:
type: array
example:
- 'The address line 1 field is required.'
items:
type: string
area:
type: array
example:
- 'The area field is required.'
items:
type: string
city:
type: array
example:
- 'The city field is required.'
items:
type: string
postal_code:
type: array
example:
- 'The postal code field is required.'
items:
type: string
state_province:
type: array
example:
- 'The state province field is required.'
items:
type: string
country:
type: array
example:
- 'The country field is required.'
items:
type: string
tags:
- 'User Endpoints'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
first_name:
type: string
description: 'Required. The first name of the user on whom the invoice will be generated. Generally, it is the first name of the authenticated user. Must not be greater than 100 characters.'
example: John
nullable: false
last_name:
type: string
description: 'Required. The last name of the user on whom the invoice will be generated. Generally, it is the last name of the authenticated user. Must not be greater than 100 characters.'
example: Doe
nullable: false
email:
type: string
description: 'Required. The email of the user of whom the invoice will be generated. Generally, it is the email of the authenticated user. Must be a valid email address. Must not be greater than 100 characters.'
example: johndoe@example.com
nullable: false
contact:
type: string
description: 'Required. The contact number of the user of whom the invoice will be generated. Generally, it is the contact number of the authenticated user. Must not be greater than 20 characters.'
example: '9876543210'
nullable: false
address_line_1:
type: string
description: 'Required. The first line of the address. Generally, this is the room/flat/apartment number of the user. Must not be greater than 100 characters.'
example: '24, Building Name'
nullable: false
address_line_2:
type: string
description: 'Optional. The second line of the address. Generally, this is the street name and/or number where the user lives. Must not be greater than 100 characters.'
example: 'Some street name'
nullable: true
area:
type: string
description: 'Required. Generally, it is the nearest railway station name. But you can give it anything of your choice. Must not be greater than 100 characters.'
example: 'St. Peters Stn'
nullable: false
landmark:
type: string
description: 'Optional. The famous landmark nearby to your house. Must not be greater than 100 characters.'
example: 'Chill StarBucks Cafe'
nullable: true
city:
type: string
description: 'Required. The city in which the user resides. Must not be greater than 100 characters.'
example: Mumbai
nullable: false
postal_code:
type: string
description: 'Required. The postal or zip or ping code. Must contain only letters and numbers. Must not be greater than 20 characters.'
example: '123456'
nullable: false
state_province:
type: string
description: 'Required. The state or province in which your city is. Must not be greater than 100 characters.'
example: Mahrashtra
nullable: false
country:
type: string
description: 'Required. The name of the country. Must not be greater than 100 characters.'
example: India
nullable: false
required:
- first_name
- last_name
- email
- contact
- address_line_1
- area
- city
- postal_code
- state_province
- country
delete:
summary: 'Delete shipping address'
operationId: deleteShippingAddress
description: 'Deletes the existing shipping address of the provided id.'
parameters: []
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
status: success
message: 'Shipping address deleted successfully.'
data: []
properties:
status:
type: string
example: success
message:
type: string
example: 'Shipping address deleted successfully.'
data:
type: array
example: []
404:
description: ''
content:
application/json:
schema:
type: object
example:
status: failed
message: 'Shipping address not found.'
data: []
properties:
status:
type: string
example: failed
message:
type: string
example: 'Shipping address not found.'
data:
type: array
example: []
tags:
- 'User Endpoints'
parameters:
-
in: path
name: id
description: 'The id of the shipping address.'
example: 1
required: true
schema:
type: integer
/api/user/wishlist:
get:
summary: 'List all products'
operationId: listAllProducts
description: 'Displays all the products that are added by the user in their wishlist.'
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- 'User Endpoints'
post:
summary: 'Add product'
operationId: addProduct
description: 'Store an existing product in their wishlist.'
parameters: []
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
status: success
message: 'Product has been successfully added.'
data:
id: 1
user_id: 2
product_id: 1
created_at: '2023-06-20T16:11:57.000000Z'
updated_at: '2023-06-20T16:11:57.000000Z'
properties:
status:
type: string
example: success
message:
type: string
example: 'Product has been successfully added.'
data:
type: object
properties:
id:
type: integer
example: 1
user_id:
type: integer
example: 2
product_id:
type: integer
example: 1
created_at:
type: string
example: '2023-06-20T16:11:57.000000Z'
updated_at:
type: string
example: '2023-06-20T16:11:57.000000Z'
422:
description: ''
content:
application/json:
schema:
type: object
example:
message: 'The product is required.'
errors:
product_id:
- 'The product is required.'
properties:
message:
type: string
example: 'The product is required.'
errors:
type: object
properties:
product_id:
type: array
example:
- 'The product is required.'
items:
type: string
tags:
- 'User Endpoints'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
product_id:
type: string
description: 'Required. The id of the product. The id of an existing record in the products table.'
example: 1
nullable: false
required:
- product_id
'/api/user/wishlist/{productId}':
delete:
summary: 'Remove a product'
operationId: removeAProduct
description: "Removes the product of the provided id from the user's wishlist."
parameters: []
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
status: success
message: 'Product has been successfully removed.'
data: []
properties:
status:
type: string
example: success
message:
type: string
example: 'Product has been successfully removed.'
data:
type: array
example: []
404:
description: ''
content:
application/json:
schema:
type: object
example:
status: failed
message: 'Product not found with the provided id.'
data: []
properties:
status:
type: string
example: failed
message:
type: string
example: 'Product not found with the provided id.'
data:
type: array
example: []
tags:
- 'User Endpoints'
parameters:
-
in: path
name: productId
description: 'The id of the product.'
example: 1
required: true
schema:
type: integer
/api/user/cart:
get:
summary: 'All products'
operationId: allProducts
description: "Lists all the products that are added in the cart.\nAlso, it will calculate the total amount of the cart."
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- 'User Endpoints'
/api/user/cart/add:
post:
summary: 'Add a product'
operationId: addAProduct
description: "Adds the product of the given id in to the cart.\nThe product is then stored in the database.\nIf the product is not found, 404 error will be returned."
parameters: []
responses:
201:
description: ''
content:
application/json:
schema:
type: object
example:
status: success
message: 'Product successfully added.'
data:
id: 1
user_id: 2
product_id: 6
product_name: 'Harum Recusandae Qui Voluptas Incidunt'
product_slug: harum-recusandae-qui-voluptas-incidunt
rate: 100
quantity: 3
amount: 300
created_at: '2023-11-29T12:47:57.000000Z'
updated_at: '2023-11-29T12:47:57.000000Z'
properties:
status:
type: string
example: success
message:
type: string
example: 'Product successfully added.'
data:
type: object
properties:
id:
type: integer
example: 1
user_id:
type: integer
example: 2
product_id:
type: integer
example: 6
product_name:
type: string
example: 'Harum Recusandae Qui Voluptas Incidunt'
product_slug:
type: string
example: harum-recusandae-qui-voluptas-incidunt
rate:
type: integer
example: 100
quantity:
type: integer
example: 3
amount:
type: integer
example: 300
created_at:
type: string
example: '2023-11-29T12:47:57.000000Z'
updated_at:
type: string
example: '2023-11-29T12:47:57.000000Z'
404:
description: ''
content:
application/json:
schema:
type: object
example:
status: success
message: 'Product with the provided id not found.'
data: null
properties:
status:
type: string
example: success
message:
type: string
example: 'Product with the provided id not found.'
data:
type: string
example: null
tags:
- 'User Endpoints'
'/api/user/cart/update/{cartProductId}':
put:
summary: 'Update product quantity'
operationId: updateProductQuantity
description: "Update the product's quantity of the given cartProduct id.\nIf the record is not found, 404 error will be returned."
parameters: []
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
status: success
message: 'Product successfully updated.'
data:
id: 1
user_id: 2
product_id: 6
product_name: 'Harum Recusandae Qui Voluptas Incidunt'
product_slug: harum-recusandae-qui-voluptas-incidunt
rate: 100
quantity: 2
amount: 200
created_at: '2023-11-29T12:47:57.000000Z'
updated_at: '2023-11-29T12:50:13.000000Z'
properties:
status:
type: string
example: success
message:
type: string
example: 'Product successfully updated.'
data:
type: object
properties:
id:
type: integer
example: 1
user_id:
type: integer
example: 2
product_id:
type: integer
example: 6
product_name:
type: string
example: 'Harum Recusandae Qui Voluptas Incidunt'
product_slug:
type: string
example: harum-recusandae-qui-voluptas-incidunt
rate:
type: integer
example: 100
quantity:
type: integer
example: 2
amount:
type: integer
example: 200
created_at:
type: string
example: '2023-11-29T12:47:57.000000Z'
updated_at:
type: string
example: '2023-11-29T12:50:13.000000Z'
404:
description: ''
content:
application/json:
schema:
type: object
example:
status: success
message: 'Product with the provided id not found.'
data: null
properties:
status:
type: string
example: success
message:
type: string
example: 'Product with the provided id not found.'
data:
type: string
example: null
tags:
- 'User Endpoints'
parameters:
-
in: path
name: cartProductId
description: 'The id of the cartProduct that you want to update the quantity of.'
example: 1
required: true
schema:
type: integer
'/api/user/cart/delete/{cartProductId}':
delete:
summary: 'Remove product'
operationId: removeProduct
description: "Removes the product of the given id from the cart.\nIf the product is not found, 404 error will be returned."
parameters: []
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
status: success
message: 'Product successfully removed.'
data: null
properties:
status:
type: string
example: success
message:
type: string
example: 'Product successfully removed.'
data:
type: string
example: null
404:
description: ''
content:
application/json:
schema:
type: object
example:
status: success
message: 'Product with the provided id not found.'
data: null
properties:
status:
type: string
example: success
message:
type: string
example: 'Product with the provided id not found.'
data:
type: string
example: null
tags:
- 'User Endpoints'
parameters:
-
in: path
name: cartProductId
description: 'The id of the product that you want to update the quantity of.'
example: 1
required: true
schema:
type: integer
/api/user/cart/empty:
delete:
summary: 'Empty cart'
operationId: emptyCart
description: 'Empties the cart entirely.'
parameters: []
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
status: success
message: 'Cart emptied successfully.'
data: null
properties:
status:
type: string
example: success
message:
type: string
example: 'Cart emptied successfully.'
data:
type: string
example: null
tags:
- 'User Endpoints'
/api/user/checkout/addresses:
get:
summary: 'Both addresses'
operationId: bothAddresses
description: 'Fetch all the billing and shipping addresses.'
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- 'User Endpoints'
/api/user/checkout/billing-address:
post:
summary: 'Billing Address'
operationId: billingAddress
description: 'Store the billing address in the session.'
parameters: []
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
status: success
message: 'Billing address successfully selected.'
data: []
properties:
status:
type: string
example: success
message:
type: string
example: 'Billing address successfully selected.'
data:
type: array
example: []
tags:
- 'User Endpoints'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
billing_address_id:
type: integer
description: 'Required. The id of the billing address that the invoice will be sent to. The id of an existing record in the user_addresses table.'
example: 1
nullable: false
required:
- billing_address_id
/api/user/checkout/shipping-address:
post:
summary: 'Shipping Address'
operationId: shippingAddress
description: 'Store the shipping address in the session.'
parameters: []
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
status: success
message: 'Shipping address successfully selected.'
data: []
properties:
status:
type: string
example: success
message:
type: string
example: 'Shipping address successfully selected.'
data:
type: array
example: []
tags:
- 'User Endpoints'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
shipping_address_id:
type: integer
description: 'Required. The id of the shipping address that the invoice will be sent to. The id of an existing record in the user_addresses table.'
example: 1
nullable: false
required:
- shipping_address_id
/api/user/checkout/place-order:
post:
summary: 'Place Order'
operationId: placeOrder
description: 'Create a new order'
parameters: []
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
status: success
message: 'Order successfully placed.'
data:
id: 1
code: ORD-BWUmJ
stripe_customer_id: null
user_id: 2
user_details:
full_name: 'Letitia Glover'
email: userone@example.com
billing_address:
id: 3
user_id: 2
type: 1
first_name: null
last_name: null
email: null
contact: null
address_line_1: null
address_line_2: null
area: null
landmark: null
city: null
postal_code: null
state_province: null
country: null
created_at: '2023-11-29T10:36:27.000000Z'
updated_at: '2023-11-29T10:36:27.000000Z'
shipping_address:
id: 4
user_id: 2
type: 2
first_name: null
last_name: null
email: null
contact: null
address_line_1: null
address_line_2: null
area: null
landmark: null
city: null
postal_code: null
state_province: null
country: null
created_at: '2023-11-29T10:36:27.000000Z'
updated_at: '2023-11-29T10:36:27.000000Z'
total_amount: 333.75
updated_at: '2023-11-29T10:36:27.000000Z'
created_at: '2023-11-29T10:36:27.000000Z'
properties:
status:
type: string
example: success
message:
type: string
example: 'Order successfully placed.'
data:
type: object
properties:
id:
type: integer
example: 1
code:
type: string
example: ORD-BWUmJ
stripe_customer_id:
type: string
example: null
user_id:
type: integer
example: 2
user_details:
type: object
properties:
full_name:
type: string
example: 'Letitia Glover'
email:
type: string
example: userone@example.com
billing_address:
type: object
properties:
id:
type: integer
example: 3
user_id:
type: integer
example: 2
type:
type: integer
example: 1
first_name:
type: string
example: null
last_name:
type: string
example: null
email:
type: string
example: null
contact:
type: string
example: null
address_line_1:
type: string
example: null
address_line_2:
type: string
example: null
area:
type: string
example: null
landmark:
type: string
example: null
city:
type: string
example: null
postal_code:
type: string
example: null
state_province:
type: string
example: null
country:
type: string
example: null
created_at:
type: string
example: '2023-11-29T10:36:27.000000Z'
updated_at:
type: string
example: '2023-11-29T10:36:27.000000Z'
shipping_address:
type: object
properties:
id:
type: integer
example: 4
user_id:
type: integer
example: 2
type:
type: integer
example: 2
first_name:
type: string
example: null
last_name:
type: string
example: null
email:
type: string
example: null
contact:
type: string
example: null
address_line_1:
type: string
example: null
address_line_2:
type: string
example: null
area:
type: string
example: null
landmark:
type: string
example: null
city:
type: string
example: null
postal_code:
type: string
example: null
state_province:
type: string
example: null
country:
type: string
example: null
created_at:
type: string
example: '2023-11-29T10:36:27.000000Z'
updated_at:
type: string
example: '2023-11-29T10:36:27.000000Z'
total_amount:
type: number
example: 333.75
updated_at:
type: string
example: '2023-11-29T10:36:27.000000Z'
created_at:
type: string
example: '2023-11-29T10:36:27.000000Z'
tags:
- 'User Endpoints'
tags:
-
name: 'Generate Administrator'
description: ''
-
name: 'Common Endpoints'
description: ''
-
name: 'Administrator Endpoints'
description: ''
-
name: 'User Endpoints'
description: ''
components:
securitySchemes:
default:
type: http
scheme: bearer
description: 'You can retrieve your token by visiting your dashboard and clicking Generate API token.'
security:
-
default: []