Spurtcommerce
DocumentAPI ReferenceAdd-ons
API Reference
API Reference
  • About Spurtcommerce APIs
  • Spurtcommerce
    • Admin API
      • Admin
        • Authentication
        • My Profile
        • Support
      • Buyers
        • Manage Buyer
      • Chat
      • CMS
        • Manage Banner
        • Manage Blogs
        • Manage Pages
        • Manage SEO
      • Dashboard
      • Marketing
        • Manage Cross Selling
          • Related Products
        • Manage Promotions
          • Coupon
      • Marketplace
        • Manage Products
        • Manage Sales
        • Manage Settlements
        • Product Configuration
        • Reports
      • Sellers
        • Seller
        • Seller Group
        • Seller KYC Request
      • Settings
        • Add-ons
        • Add-ons Product Attributes
        • Localization
        • Order Fulfilment Status
        • Personalise
        • Site Settings
        • Store Settings
        • System
        • User and Permission
        • Support-Category
    • Store API
      • Account Settings
        • Customer
        • My Order
        • My Quotation
        • My Wishlist
        • Profile
        • Support
      • Checkouts
      • Store
        • Admin Contact
        • Categories
        • Home
        • Product Detail Page
    • Vendor API
      • Page 1
      • Catalogue
        • Bulk Product Imports
          • Custom
          • Standard
        • Common Product
        • Data Export
        • Pricing
        • Product Localisation
        • Product List
        • Product Variants
        • Related Products
      • CRM
        • Customer
        • Customer Group
        • Question and Answer
        • Rating and Review
      • Dashboard
      • Marketing
      • Payments
        • Archeived Payments
        • Earnings
        • Settlements
      • Profile
        • Account Settings
          • My Business
          • My KYC
          • My Profile
          • My Shop
          • Personalised Setting
        • Chat
        • Vendor
        • Support
      • Reports
      • Sales
        • Archeive Orders
        • Back Orders
        • Failed Orders
        • Orders
        • Quotation Request
        • Stock Update
        • Variant Stock Update
      • Supplier
        • Contact
        • Supplier
Powered by GitBook
On this page
  1. Spurtcommerce
  2. Admin API
  3. CMS

Manage Pages

PreviousManage BlogsNextManage SEO

Last updated 4 months ago

Get a list of page groups

get

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
400
Bad request, invalid parameters
500
Internal server error
get
GET /backend/api/page-group HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*
<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Successfully got the group list.</message>
</object>

Get a list of languages

get

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
400
Bad request, invalid or missing parameters
500
Internal server error
get
GET /backend/api/language HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*
<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Successfully got all language List</message>
</object>

Get a page translation by ID

get

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
400
Bad request, invalid `pageId` parameter
404
Page not found
500
Internal server error
get
GET /backend/api/page-translation/page/{pageId} HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*
<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Successfully got page translation detail</message>
</object>

Delete a page by pageId

delete

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
404
Page not found
500
Internal server error
delete
DELETE /backend/api/page/{pageId} HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*
<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Successfully deleted the page</message>
</object>

Get the count of page groups

get

This endpoint retrieves the count of page groups.

Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Responses
200
Successfully retrieved the page group count
400
Bad request
500
Internal server error
get
GET /backend/api/page-group/pagegroup-count HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*
<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Successfully got the page group count</message>
</object>

Get page group translation by ID

get

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
400
Bad request
404
Page group translation not found
500
Internal server error
get
GET /backend/api/page-group-translation/page-group/{id} HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*
<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Successfully got page Group translation detail</message>
</object>

Get a page group by ID

get

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
400
Bad request
404
Page group not found
500
Internal server error
get
GET /backend/api/page-group/get-page-group/{id} HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*
<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Successfully Got page group</message>
</object>

Delete a page group

delete

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
404
Page group not found
500
Internal server error
delete
DELETE /backend/api/page-group/{id} HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*
<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Successfully deleted the group</message>
</object>

Get widget list

get

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
400
Invalid query parameters
500
Internal server error
get
GET /backend/api/widget HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*
<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Successfully got Widget list</message>
</object>

Get vendor category list

get

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
400
Invalid query parameters
500
Internal server error
get
GET /backend/api/category HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*
<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Successfully got the vendor category list.</message>
</object>

Get widget translation details

get

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
400
Bad request
404
Widget translation not found
get
GET /backend/api/widget-translation/widget/{id} HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*
<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>text</message>
</object>

Get widget product list

get

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
400
Invalid query parameters
500
Internal server error
get
GET /backend/api/widget/productlist HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*
<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Successfully got the complete product list.</message>
</object>

Delete a widget

delete

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
400
Bad request due to invalid parameters
delete
DELETE /backend/api/widget/{id} HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*
<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>text</message>
</object>

Retrieve a list of product questions

get

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.
400
Bad request
500
Internal server error
get
GET /backend/api/product-question-list HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*
<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Successfully got the complete product list.</message>
</object>

Retrieve product details

get

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.
400
Bad request
404
Product not found
500
Internal server error
get
GET /backend/api/product-detail/{productId} HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*
<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Successfully get productDetail</message>
</object>

Delete a product question

delete

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.
400
Bad request
404
Question not found
500
Internal server error
delete
DELETE /backend/api/admin-product-question/{questionId} HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*
<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Successfully deleted the Question.</message>
</object>

Retrieve product details

get

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.
400
Bad request
404
Product not found
500
Internal server error
get
GET /backend/api/product/product-detail/{productId} HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*
<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Successfully get productDetail</message>
</object>

Retrieve user profile

get

This endpoint retrieves the profile information of the authenticated user.

Responses
200
Successfully retrieved the user profile.
401
Unauthorized access
500
Internal server error
get
GET /backend/api/auth/get-profile HTTP/1.1
Host: 139.59.67.17
Accept: */*
<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Successfully got the profile</message>
</object>

Retrieve vendor list

get

This endpoint retrieves a list of vendor details.

Responses
200
Successfully retrieved vendor details.
400
Bad request
500
Internal server error
get
GET /backend/api/vendor-list HTTP/1.1
Host: 139.59.67.17
Accept: */*
<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Successfully Got Vendor Details</message>
</object>

Retrieve vendor list

get

This endpoint retrieves a list of vendor details.

Responses
200
Successfully retrieved vendor details.
400
Bad request
500
Internal server error
get
GET /backend/api/chat-admin/vendor-list HTTP/1.1
Host: 139.59.67.17
Accept: */*
<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Successfully Got Vendor Details</message>
</object>

Retrieve product ratings and reviews

get

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.
400
Bad request
500
Internal server error
get
GET /backend/api/admin-product-rating HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*
<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Successfully got the complete product rating and review.</message>
</object>

Retrieve a specific product rating

get

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.
400
Bad request
404
Rating not found
500
Internal server error
get
GET /backend/api/admin-product-rating/{ratingId} HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*
<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>successfully got the product Rating.</message>
</object>
  • GETGet a list of pages
  • POSTCreate a new page
  • GETGet a list of page groups
  • POSTCreate a new page group
  • GETGet a list of languages
  • GETGet a page translation by ID
  • POSTCreate or update a page translation by pageId
  • PUTUpdate a page by pageId
  • DELETEDelete a page by pageId
  • GETGet the count of page groups
  • GETGet page group translation by ID
  • POSTCreate a new page group translation
  • GETGet a page group by ID
  • PUTUpdate a page group
  • DELETEDelete a page group
  • GETGet widget list
  • POSTCreate a new widget
  • GETGet vendor category list
  • GETGet widget translation details
  • POSTCreate translations for a widget
  • GETGet widget product list
  • PUTUpdate an existing widget
  • DELETEDelete a widget
  • GETRetrieve a list of product questions
  • GETRetrieve product details
  • POSTPost a new product question
  • PUTUpdate the status of a product question
  • DELETEDelete a product question
  • GETRetrieve product details
  • GETRetrieve user profile
  • GETRetrieve vendor list
  • GETRetrieve vendor list
  • GETRetrieve product ratings and reviews
  • GETRetrieve a specific product rating
  • PUTUpdate the status of a product rating

Get a list of pages

get

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
400
Bad request, invalid parameters
500
Internal server error
get
GET /backend/api/page HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*
<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Successfully got the complete list of pages</message>
</object>

Create a new page

post

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
400
Bad request, invalid or missing parameters
500
Internal server error
post
POST /backend/api/page HTTP/1.1
Host: 139.59.67.17
Authorization: text
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 118

"title='text'&content='text'&metaTagTitle=''&metaTagContent=''&metaTagKeyword=''&active=1&pageGroupId=1"
<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Successfully created a new page</message>
</object>

Create a new page group

post

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
400
Bad request
500
Internal server error
post
POST /backend/api/page-group HTTP/1.1
Host: 139.59.67.17
Authorization: text
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 35

"pageGroupName='test'&status=1"
<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Successfully added Page Group.</message>
</object>

Create or update a page translation by pageId

post

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
400
Bad request, invalid `pageId` or `pageTranslation` format
404
Page not found
500
Internal server error
post
POST /backend/api/page-translation/page/{pageId} HTTP/1.1
Host: 139.59.67.17
Authorization: text
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 77

"[{'language':'en','title':'Home','content':'<p>Welcome to our homepage</p>'}]"
<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Successfully created new page translation</message>
</object>

Update a page by pageId

put

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
400
Bad request, invalid `pageId` or `page` data
404
Page not found
500
Internal server error
put
PUT /backend/api/page/{pageId} HTTP/1.1
Host: 139.59.67.17
Authorization: text
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 101

"title='test'&content='<p>test</p>'&pageSlug='test'&active=1&pageGroupId=23&pageId='161'"
<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Successfully updated the page</message>
</object>

Create a new page group translation

post

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
400
Bad request
404
Page group not found
500
Internal server error
post
POST /backend/api/page-group-translation/page-group/{id} HTTP/1.1
Host: 139.59.67.17
Authorization: text
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 63

"pageGroupTranslation=[{'languageId':57,'groupName':'test'}]"
<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Successfully created new page group translation</message>
</object>

Update a page group

put

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
400
Bad request
404
Page group not found
500
Internal server error
put
PUT /backend/api/page-group/{id} HTTP/1.1
Host: 139.59.67.17
Authorization: text
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 35

"pageGroupName='test'&status=1"
<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Successfully updated the Page group</message>
</object>

Create a new widget

post

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
400
Bad request
post
POST /backend/api/widget HTTP/1.1
Host: 139.59.67.17
Authorization: text
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 210

"title='text'&widgetLongTitle='text'&position=1&status=1&ShowHomePageWidget=1&metaTagTitle='text'&metaTagDescription='text'&metaTagKeyword='text'&content='text'&widgetLinkType=1&refId=[1]"
<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>text</message>
</object>

Create translations for a widget

post

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.

Body
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
400
Bad request
404
Widget not found
post
POST /backend/api/widget-translation/widget/{id} HTTP/1.1
Host: 139.59.67.17
Authorization: text
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 98

"[{'languageId':1,'widgetTitle':'text','widgetLongTitle':'text','widgetDescription':'text','id':1}]"
<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>text</message>
</object>

Update an existing widget

put

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
400
Bad request due to invalid parameters
put
PUT /backend/api/widget/{id} HTTP/1.1
Host: 139.59.67.17
Authorization: text
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 223

"title='text'&widgetLongTitle='text'&position=1&status=1&ShowHomePageWidget=1&metaTagTitle='text'&metaTagDescription='text'&metaTagKeyword='text'&content='text'&widgetLinkType=1&refId=[1]&widgetId=1"
<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>text</message>
</object>

Post a new product question

post

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.
400
Bad request
500
Internal server error
post
POST /backend/api/admin-product-question HTTP/1.1
Host: 139.59.67.17
Authorization: text
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 67

"question='test'&answer='test'&productId='2124'&skuId=4168"
<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Question Posted Successfully.</message>
</object>

Update the status of a product question

put

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.
400
Bad request
404
Question not found
500
Internal server error
put
PUT /backend/api/admin-product-question/{questionId} HTTP/1.1
Host: 139.59.67.17
Authorization: text
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 29

"questionId=832&status=0"
<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Updated Your Question Status</message>
</object>

Update the status of a product rating

put

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.
400
Bad request
404
Rating not found
500
Internal server error
put
PUT /backend/api/admin-product-rating/{ratingId} HTTP/1.1
Host: 139.59.67.17
Authorization: text
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 27

"ratingId=633&status=1"
<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Successfully Updated the Rating Status.</message>
</object>