Manage Pages

Get a list of pages

get
/page

Fetches a paginated list of pages, with optional filtering by keyword.

Query parameters
limitintegerOptional

Limit the number of records returned

offsetintegerOptional

Offset the records for pagination

keywordstringOptional

Optional keyword for filtering the pages by title or content

Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Responses
200

Successfully retrieved the list of pages

get
/page

Create a new page

post
/page

Creates a new page with the specified details.

Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Body
titlestringRequired

Title of the new page

contentstringRequired

HTML content of the page

metaTagTitlestringOptional

Meta tag title for SEO purposes

Default: ""
metaTagContentstringOptional

Meta tag content for SEO purposes

Default: ""
metaTagKeywordstringOptional

Meta tag keywords for SEO purposes

Default: ""
activeintegerRequired

Indicates whether the page is active (1 for active, 0 for inactive)

pageGroupIdintegerRequired

The ID of the page group this page belongs to

Responses
200

Successfully created a new page

post
/page

Get a list of page groups

get
/page-group

Fetches a paginated list of page groups with an optional status filter.

Query parameters
limitintegerOptional

Limit the number of records returned

offsetintegerOptional

Offset the records for pagination

statusinteger · enumOptional

Filter by page group status (1 for active, 0 for inactive)

Possible values:
Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Responses
200

Successfully retrieved the list of page groups

get
/page-group

Create a new page group

post
/page-group

This endpoint allows you to create a new page group.

Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Body
pageGroupNamestringRequiredExample: test
statusintegerRequiredExample: 1
Responses
200

Successfully created the page group

post
/page-group

Get a list of languages

get
/language

Returns a list of languages based on provided query parameters.

Query parameters
limitintegerOptional

Limit the number of results

Default: 10
offsetintegerOptional

Offset for pagination

Default: 0
countbooleanOptional

If true, return the total count of languages available

Default: false
keywordstringOptional

Search keyword for filtering languages

statusstringOptional

Filter by language status (active or inactive)

defaultLanguagebooleanOptional

Filter languages by default language setting

Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Responses
200

Successfully fetched language list

get
/language

Get a page translation by ID

get
/page-translation/page/{pageId}

Returns the translation details of a specific page identified by pageId.

Path parameters
pageIdintegerRequired

ID of the page to get the translation details

Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Responses
200

Successfully fetched page translation details

get
/page-translation/page/{pageId}

Create or update a page translation by pageId

post
/page-translation/page/{pageId}

This endpoint allows creating or updating the translation details for a page identified by pageId.

Path parameters
pageIdintegerRequired

ID of the page to create or update the translation

Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Body
languagestringOptionalExample: en
titlestringOptionalExample: Home
contentstringOptionalExample: <p>Welcome to our homepage</p>
Responses
200

Successfully created or updated page translation

post
/page-translation/page/{pageId}

Update a page by pageId

put
/page/{pageId}

This endpoint allows updating the details of a page identified by pageId.

Path parameters
pageIdintegerRequired

ID of the page to update

Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Body
titlestringOptionalExample: test
contentstringOptionalExample: <p>test</p>
pageSlugstringOptionalExample: test
activeintegerOptionalExample: 1
pageGroupIdintegerOptionalExample: 23
pageIdstringOptionalExample: 161
Responses
200

Successfully updated the page

put
/page/{pageId}

Delete a page by pageId

delete
/page/{pageId}

This endpoint allows deleting a page by its pageId.

Path parameters
pageIdintegerRequired

ID of the page to delete

Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Responses
200

Successfully deleted the page

delete
/page/{pageId}

Get the count of page groups

get
/page-group/pagegroup-count

This endpoint retrieves the count of page groups.

Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Responses
200

Successfully retrieved the page group count

get
/page-group/pagegroup-count

Get page group translation by ID

get
/page-group-translation/page-group/{id}

This endpoint retrieves the translation details of a page group by its ID.

Path parameters
idintegerRequired

ID of the page group to retrieve the translation for

Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Responses
200

Successfully retrieved page group translation details

get
/page-group-translation/page-group/{id}

Create a new page group translation

post
/page-group-translation/page-group/{id}

This endpoint allows creating a new translation for a page group.

Path parameters
idintegerRequired

ID of the page group for which to create a translation

Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Body
Responses
200

Successfully created new page group translation

post
/page-group-translation/page-group/{id}

Get a page group by ID

get
/page-group/get-page-group/{id}

This endpoint retrieves a page group by its ID.

Path parameters
idintegerRequired

ID of the page group to retrieve

Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Responses
200

Successfully retrieved page group

get
/page-group/get-page-group/{id}

Update a page group

put
/page-group/{id}

This endpoint updates the page group by its ID.

Path parameters
idintegerRequired

ID of the page group to update

Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Body
pageGroupNamestringOptionalExample: test
statusintegerOptionalExample: 1
Responses
200

Successfully updated the page group

put
/page-group/{id}

Delete a page group

delete
/page-group/{id}

This endpoint deletes the page group by its ID.

Path parameters
idintegerRequired

ID of the page group to delete

Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Responses
200

Successfully deleted the page group

delete
/page-group/{id}

Get widget list

get
/widget

This endpoint retrieves a list of widgets based on the specified query parameters.

Query parameters
limitintegerOptional

The number of widgets to return

Default: 10
offsetintegerOptional

The number of items to skip before starting to return the widgets

Default: 0
countinteger · enumOptional

A flag indicating whether to return a count of widgets

Default: 0Possible values:
Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Responses
200

Successfully retrieved the widget list

get
/widget

Create a new widget

post
/widget

This endpoint allows the creation of a new widget with the specified parameters.

Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Body
titlestringOptional

The title of the widget

widgetLongTitlestringOptional

The long title of the widget

positionintegerOptional

The position where the widget will be placed

statusintegerOptional

Status of the widget (1 for active, 0 for inactive)

ShowHomePageWidgetintegerOptional

Flag to show the widget on the home page (1 for yes, 0 for no)

metaTagTitlestringOptional

Meta title for the widget

metaTagDescriptionstringOptional

Meta description for the widget

metaTagKeywordstringOptional

Meta keywords for the widget

contentstringOptional

HTML content for the widget

widgetLinkTypeintegerOptional

Type of the widget link

refIdinteger[]Optional

List of reference IDs associated with the widget

Responses
200

Successfully created a new widget

post
/widget

Get vendor category list

get
/category

This endpoint retrieves a list of vendor categories based on the specified query parameters.

Query parameters
offsetintegerOptional

The number of items to skip before starting to return categories

Default: 0
countbooleanOptional

Flag to include the count of categories (true/false)

Default: false
keywordstringOptional

Search keyword for filtering categories

sortOrderinteger · enumOptional

The order in which to sort the categories (0 for ascending, 1 for descending)

Default: 0Possible values:
statusinteger · enumOptional

Filter categories by status (1 for active, 0 for inactive)

Default: 1Possible values:
isSearchbooleanOptional

Flag to determine if the request is a search (true/false)

Default: false
Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Responses
200

Successfully retrieved the vendor category list

get
/category

Get widget translation details

get
/widget-translation/widget/{id}

This endpoint allows retrieval of widget translation details for a specific widget.

Path parameters
idintegerRequired

ID of the widget to get translation details

Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Responses
200

Successfully retrieved widget translation details

get
/widget-translation/widget/{id}

Create translations for a widget

post
/widget-translation/widget/{id}

This endpoint allows the creation of multiple translations for a specific widget.

Path parameters
idintegerRequired

ID of the widget to create translations for

Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Bodyobject[]
languageIdintegerRequired

ID of the language

widgetTitlestringRequired

Title of the widget in the given language

widgetLongTitlestringRequired

Long title of the widget in the given language

widgetDescriptionstringRequired

Description of the widget in HTML format for the given language

idintegerOptional

ID of the translation record

Responses
200

Successfully created translations for the widget

post
/widget-translation/widget/{id}

Get widget product list

get
/widget/productlist

This endpoint retrieves a list of products for a widget based on the specified query parameters.

Query parameters
offsetintegerOptional

The number of items to skip before starting to return the products

Default: 0
keywordstringOptional

Search keyword for product filtering

skustringOptional

SKU for product filtering

statusinteger · enumOptional

The status of the products to filter by (e.g., 1 for active)

Default: 1Possible values:
priceintegerOptional

Price filter for products

Default: 0
isRefreshbooleanOptional

A flag to determine if the product list should be refreshed (true/false)

Default: false
Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Responses
200

Successfully retrieved the widget product list

get
/widget/productlist

Update an existing widget

put
/widget/{id}

Updates the details of an existing widget based on the provided ID.

Path parameters
idintegerRequired

ID of the widget to update

Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Body
titlestringOptional

Title of the widget

widgetLongTitlestringOptional

Long title of the widget

positionintegerOptional

Position of the widget

statusintegerOptional

Status of the widget

ShowHomePageWidgetintegerOptional

Flag to show widget on homepage

metaTagTitlestringOptional

Meta tag title for the widget

metaTagDescriptionstringOptional

Meta tag description for the widget

metaTagKeywordstringOptional

Meta tag keywords for the widget

contentstringOptional

Content of the widget (HTML format)

widgetLinkTypeintegerOptional

Type of widget link

refIdinteger[]Optional

Reference IDs associated with the widget

widgetIdintegerOptional

ID of the widget to update

Responses
200

Successfully updated the widget

put
/widget/{id}

Delete a widget

delete
/widget/{id}

Deletes a widget based on the provided widget ID.

Path parameters
idintegerRequired

ID of the widget to delete

Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Responses
200

Widget deleted successfully

delete
/widget/{id}

Retrieve a list of product questions

get
/product-question-list

This endpoint retrieves a list of product questions based on the provided query parameters.

Query parameters
limitintegerOptional

The number of items to return.

Default: 10
offsetintegerOptional

The number of items to skip before starting to collect the result set.

Default: 0
keywordstringOptional

A keyword to filter the product questions.

productNamestringOptional

The name of the product to filter the questions.

countintegerOptional

A flag to indicate whether to return the count of items.

Default: 0
approvalFlagintegerOptional

A flag to filter questions based on approval status.

Default: 1
Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Responses
200

Successfully retrieved the product question list.

get
/product-question-list

Retrieve product details

get
/product-detail/{productId}

This endpoint retrieves the details of a specific product based on the product ID.

Path parameters
productIdintegerRequired

The ID of the product to retrieve details for.

Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Responses
200

Successfully retrieved product details.

get
/product-detail/{productId}

Post a new product question

post
/admin-product-question

This endpoint allows posting a new question and answer for a specific product.

Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Body
questionstringRequiredExample: test
answerstringRequiredExample: test
productIdstringRequiredExample: 2124
skuIdintegerRequiredExample: 4168
Responses
200

Successfully posted the question.

post
/admin-product-question

Update the status of a product question

put
/admin-product-question/{questionId}

This endpoint updates the status of a specific product question based on the question ID.

Path parameters
questionIdintegerRequired

The ID of the question to update.

Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Body
questionIdintegerRequiredExample: 832
statusintegerRequiredExample: 0
Responses
200

Successfully updated the question status.

put
/admin-product-question/{questionId}

Delete a product question

delete
/admin-product-question/{questionId}

This endpoint deletes a specific product question based on the question ID.

Path parameters
questionIdintegerRequired

The ID of the question to delete.

Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Responses
200

Successfully deleted the question.

delete
/admin-product-question/{questionId}

Retrieve product details

get
/product/product-detail/{productId}

This endpoint retrieves the details of a specific product based on the product ID.

Path parameters
productIdintegerRequired

The ID of the product to retrieve details for.

Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Responses
200

Successfully retrieved product details.

get
/product/product-detail/{productId}

Retrieve user profile

get
/auth/get-profile

This endpoint retrieves the profile information of the authenticated user.

Responses
200

Successfully retrieved the user profile.

get
/auth/get-profile

Retrieve vendor list

get
/vendor-list

This endpoint retrieves a list of vendor details.

Responses
200

Successfully retrieved vendor details.

get
/vendor-list

Retrieve vendor list

get
/chat-admin/vendor-list

This endpoint retrieves a list of vendor details.

Responses
200

Successfully retrieved vendor details.

get
/chat-admin/vendor-list

Retrieve product ratings and reviews

get
/admin-product-rating

This endpoint retrieves a list of product ratings and reviews based on the provided query parameters.

Query parameters
limitintegerOptional

The number of items to return.

Default: 10
offsetintegerOptional

The number of items to skip before starting to collect the result set.

Default: 0
countintegerOptional

A flag to indicate whether to return the count of items.

Default: 0
Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Responses
200

Successfully retrieved the complete product rating and review.

get
/admin-product-rating

Retrieve a specific product rating

get
/admin-product-rating/{ratingId}

This endpoint retrieves the details of a specific product rating based on the rating ID.

Path parameters
ratingIdintegerRequired

The ID of the product rating to retrieve.

Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Responses
200

Successfully retrieved the product rating.

get
/admin-product-rating/{ratingId}

Update the status of a product rating

put
/admin-product-rating/{ratingId}

This endpoint updates the status of a specific product rating based on the rating ID.

Path parameters
ratingIdintegerRequired

The ID of the product rating to update.

Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Body
ratingIdintegerRequiredExample: 633
statusintegerRequiredExample: 1
Responses
200

Successfully updated the rating status.

put
/admin-product-rating/{ratingId}

Last updated