Manage SEO | API Reference

Get product SEO list

get

/product-seo

Retrieves a list of product SEO details based on the provided filters.

Query parameters

limitintegerOptional

The maximum number of products to return.

Default: 10

offsetintegerOptional

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

Default: 0

countintegerOptional

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

Default: 0

Header parameters

AuthorizationstringRequired

Bearer token for authentication.

Responses

200

Successfully retrieved the product SEO list.

400

Bad request due to invalid parameters.

500

Internal server error.

get

/product-seo

GET /backend/api/product-seo HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*

<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Successfully got the product list.</message>
</object>

Get product SEO details

get

/product-seo/{productId}

Retrieves the SEO details of a specific product by its ID.

Path parameters

productIdintegerRequired

The ID of the product to retrieve SEO details for.

Header parameters

AuthorizationstringRequired

Bearer token for authentication.

Responses

200

Successfully retrieved the SEO details.

404

Product SEO details not found.

500

Internal server error.

get

/product-seo/{productId}

GET /backend/api/product-seo/{productId} HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*

<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Successfully got SEO details.</message>
</object>

Update product SEO details

post

/product-seo/{productId}

Updates the SEO details of a specific product by its ID.

Path parameters

productIdintegerRequired

The ID of the product to update SEO details for.

Header parameters

AuthorizationstringRequired

Bearer token for authentication.

Body

metaTagTitlestringRequiredExample: The Indian Beekeepers Combo Pack of 2 - Saffron Honey, Afghani Saffron

metaTagDescriptionstringRequiredExample: test

metaTagKeywordstringRequiredExample: test

Responses

200

SEO updated successfully.

400

Bad request due to invalid parameters.

404

Product not found.

500

Internal server error.

post

/product-seo/{productId}

POST /backend/api/product-seo/{productId} HTTP/1.1
Host: 139.59.67.17
Authorization: text
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 141

"metaTagTitle='The Indian Beekeepers Combo Pack of 2 - Saffron Honey, Afghani Saffron'&metaTagDescription='test'&metaTagKeyword='test'"

<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>SEO Updated successfully</message>
</object>

Get category SEO list

get

/category-seo

Retrieves a list of category SEO details based on the provided filters.

Query parameters

limitintegerOptional

The maximum number of categories to return.

Default: 10

offsetintegerOptional

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

Default: 0

countintegerOptional

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

Default: 0

Header parameters

AuthorizationstringRequired

Bearer token for authentication.

Responses

200

Successfully retrieved the category SEO list.

400

Bad request due to invalid parameters.

500

Internal server error.

get

/category-seo

GET /backend/api/category-seo HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*

<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Successfully got category list.</message>
</object>

Get category SEO details

get

/category-seo/{categoryId}

Retrieves the SEO details of a specific category by its ID.

Path parameters

categoryIdintegerRequired

The ID of the category to retrieve SEO details for.

Header parameters

AuthorizationstringRequired

Bearer token for authentication.

Responses

200

Successfully retrieved the SEO details.

404

Category SEO details not found.

500

Internal server error.

get

/category-seo/{categoryId}

GET /backend/api/category-seo/{categoryId} HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*

<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Successfully got SEO details.</message>
</object>

Update category SEO details

post

/category-seo/{categoryId}

Updates the SEO details of a specific category by its ID.

Path parameters

categoryIdintegerRequired

The ID of the category to update SEO details for.

Header parameters

AuthorizationstringRequired

Bearer token for authentication.

Body

metaTagTitlestringRequiredExample: test

metaTagDescriptionstringRequiredExample: test

metaTagKeywordstringRequiredExample: test

Responses

200

SEO created successfully.

400

Bad request due to invalid parameters.

404

Category not found.

500

Internal server error.

post

/category-seo/{categoryId}

POST /backend/api/category-seo/{categoryId} HTTP/1.1
Host: 139.59.67.17
Authorization: text
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 75

"metaTagTitle='test'&metaTagDescription='test'&metaTagKeyword='test'"

<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>SEO created Successfully.</message>
</object>

Get page SEO list

get

/page-seo

Retrieves a list of page SEO details based on the provided filters.

Query parameters

limitintegerOptional

The maximum number of pages to return.

Default: 10

offsetintegerOptional

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

Default: 0

countintegerOptional

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

Default: 0

keywordstringOptional

A keyword to filter the pages.

Header parameters

AuthorizationstringRequired

Bearer token for authentication.

Responses

200

Successfully retrieved the complete list of pages.

400

Bad request due to invalid parameters.

500

Internal server error.

get

/page-seo

GET /backend/api/page-seo 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>

Get page SEO details

get

/page-seo/{pageId}

Retrieves the SEO details of a specific page by its ID.

Path parameters

pageIdintegerRequired

The ID of the page to retrieve SEO details for.

Header parameters

AuthorizationstringRequired

Bearer token for authentication.

Responses

200

Successfully retrieved the SEO details.

404

Page SEO details not found.

500

Internal server error.

get

/page-seo/{pageId}

GET /backend/api/page-seo/{pageId} HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*

<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Successfully got SEO details.</message>
</object>

Update page SEO details

post

/page-seo/{pageId}

Updates the SEO details of a specific page by its ID.

Path parameters

pageIdintegerRequired

The ID of the page to update SEO details for.

Header parameters

AuthorizationstringRequired

Bearer token for authentication.

Body

metaTagTitlestringRequiredExample: test

metaTagDescriptionstringRequiredExample: test

metaTagKeywordstringRequiredExample: test

Responses

200

SEO created successfully.

400

Bad request due to invalid parameters.

404

Page not found.

500

Internal server error.

post

/page-seo/{pageId}

POST /backend/api/page-seo/{pageId} HTTP/1.1
Host: 139.59.67.17
Authorization: text
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 75

"metaTagTitle='test'&metaTagDescription='test'&metaTagKeyword='test'"

<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>SEO created Successfully.</message>
</object>

Get blog category list

get

/blog-category

Retrieves a list of blog categories.

Responses

200

Successfully retrieved the blog category list.

500

Internal server error.

get

/blog-category

GET /backend/api/blog-category HTTP/1.1
Host: 139.59.67.17
Accept: */*

<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Successfully got the blog category list.</message>
</object>

Get blog list

get

/blog-seo

Retrieves a list of blog SEO details based on the provided filters.

Query parameters

limitintegerOptional

The maximum number of blogs to return.

Default: 10

offsetintegerOptional

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

Default: 0

countintegerOptional

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

Default: 0

Header parameters

AuthorizationstringRequired

Bearer token for authentication.

Responses

200

Successfully retrieved the blog list.

500

Internal server error.

get

/blog-seo

GET /backend/api/blog-seo HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*

<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Successfully got blog list.</message>
</object>

Get blog SEO details

get

/blog-seo/{blogId}

Retrieves the SEO details of a specific blog by its ID.

Path parameters

blogIdintegerRequired

The ID of the blog to retrieve SEO details for.

Header parameters

AuthorizationstringRequired

Bearer token for authentication.

Responses

200

Successfully retrieved the SEO details.

404

Blog SEO details not found.

500

Internal server error.

get

/blog-seo/{blogId}

GET /backend/api/blog-seo/{blogId} HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*

<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Successfully got SEO detail.</message>
</object>

Update blog SEO details

post

/blog-seo/{blogId}

Updates the SEO details of a specific blog by its ID.

Path parameters

blogIdintegerRequired

The ID of the blog to update SEO details for.

Header parameters

AuthorizationstringRequired

Bearer token for authentication.

Body

metaTagTitlestringRequiredExample: test

metaTagDescriptionstringRequiredExample: test

metaTagKeywordstringRequiredExample: test

Responses

200

SEO created successfully.

400

Bad request due to invalid parameters.

404

Blog not found.

500

Internal server error.

post

/blog-seo/{blogId}

POST /backend/api/blog-seo/{blogId} HTTP/1.1
Host: 139.59.67.17
Authorization: text
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 75

"metaTagTitle='test'&metaTagDescription='test'&metaTagKeyword='test'"

<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Seo created Successfully.</message>
</object>

Get site map list

get

/site-map

Retrieves a list of site map entries based on the provided filters.

Query parameters

limitintegerOptional

The maximum number of site map entries to return.

Default: 10

offsetintegerOptional

The number of site map entries to skip before starting to collect the result set.

Default: 0

countintegerOptional

A flag to indicate whether to return the count of site map entries.

Default: 0

keywordstringOptional

A keyword to filter the site map entries.

Header parameters

AuthorizationstringRequired

Bearer token for authentication.

Responses

200

Successfully retrieved the list of site map entries.

400

Bad request due to invalid parameters.

500

Internal server error.

get

/site-map

GET /backend/api/site-map HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*

<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Successfully got the list !!</message>
</object>

Create a new site map entry

post

/site-map

Creates a new site map entry with the provided details.

Header parameters

AuthorizationstringRequired

Bearer token for authentication.

Body

urlstringRequiredExample: http://example.com/page

lastModifiedstring · date-timeRequiredExample: 2023-01-01T12:00:00Z

Responses

201

Successfully created the site map entry.

400

Bad request due to invalid parameters.

500

Internal server error.

post

/site-map

POST /backend/api/site-map HTTP/1.1
Host: 139.59.67.17
Authorization: text
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 71

"url='http://example.com/page'&lastModified='2023-01-01T12:00:00Z'"

<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Successfully created !!</message>
</object>

Delete a site map entry

delete

/site-map/{entryId}

Deletes the site map entry identified by the given ID.

Path parameters

entryIdintegerRequired

The ID of the site map entry to delete.

Header parameters

AuthorizationstringRequired

Bearer token for authentication.

Responses

200

Successfully deleted the site map entry.

404

Site map entry not found.

500

Internal server error.

delete

/site-map/{entryId}

DELETE /backend/api/site-map/{entryId} HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*

<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Successfully Deleted the data !!</message>
</object>