Manage SEO | Spurtcommerce

Spurtcommerce

Document API Reference Add-ons

Get product SEO list

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

get

/product-seo

Query parameters

limitinteger

The maximum number of products to return.

offsetinteger

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

countinteger

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

Header parameters

Authorizationstringrequired

Bearer token for authentication.

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'http://139.59.67.17/backend/api/product-seo' \
  --header 'Authorization: text'

200

400

500

{
  "status": 1,
  "message": "Successfully got the product list."
}

Successfully retrieved the product SEO list.

Get product SEO details

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

get

/product-seo/{productId}

Path parameters

productIdintegerrequired

The ID of the product to retrieve SEO details for.

Header parameters

Authorizationstringrequired

Bearer token for authentication.

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'http://139.59.67.17/backend/api/product-seo/{productId}' \
  --header 'Authorization: text'

200

404

500

{
  "status": 1,
  "message": "Successfully got SEO details."
}

Successfully retrieved the SEO details.

Update product SEO details

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

post

/product-seo/{productId}

Path parameters

productIdintegerrequired

The ID of the product to update SEO details for.

Header parameters

Authorizationstringrequired

Bearer token for authentication.

Body

metaTagTitlestringrequired

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

metaTagDescriptionstringrequired

Example: test

metaTagKeywordstringrequired

Example: test

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'http://139.59.67.17/backend/api/product-seo/{productId}' \
  --header 'Authorization: text' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data '{"metaTagTitle":"The Indian Beekeepers Combo Pack of 2 - Saffron Honey, Afghani Saffron","metaTagDescription":"test","metaTagKeyword":"test"}'

200

400

404

500

{
  "status": 1,
  "message": "SEO Updated successfully"
}

SEO updated successfully.

Get category SEO list

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

get

/category-seo

Query parameters

limitinteger

The maximum number of categories to return.

offsetinteger

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

countinteger

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

Header parameters

Authorizationstringrequired

Bearer token for authentication.

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'http://139.59.67.17/backend/api/category-seo' \
  --header 'Authorization: text'

200

400

500

{
  "status": 1,
  "message": "Successfully got category list."
}

Successfully retrieved the category SEO list.

Get category SEO details

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

get

/category-seo/{categoryId}

Path parameters

categoryIdintegerrequired

The ID of the category to retrieve SEO details for.

Header parameters

Authorizationstringrequired

Bearer token for authentication.

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'http://139.59.67.17/backend/api/category-seo/{categoryId}' \
  --header 'Authorization: text'

200

404

500

{
  "status": 1,
  "message": "Successfully got SEO details."
}

Successfully retrieved the SEO details.

Update category SEO details

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

post

/category-seo/{categoryId}

Path parameters

categoryIdintegerrequired

The ID of the category to update SEO details for.

Header parameters

Authorizationstringrequired

Bearer token for authentication.

Body

metaTagTitlestringrequired

Example: test

metaTagDescriptionstringrequired

Example: test

metaTagKeywordstringrequired

Example: test

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'http://139.59.67.17/backend/api/category-seo/{categoryId}' \
  --header 'Authorization: text' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data '{"metaTagTitle":"test","metaTagDescription":"test","metaTagKeyword":"test"}'

200

400

404

500

{
  "status": 1,
  "message": "SEO created Successfully."
}

SEO created successfully.

Get page SEO list

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

get

/page-seo

Query parameters

limitinteger

The maximum number of pages to return.

offsetinteger

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

countinteger

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

keywordstring

A keyword to filter the pages.

Header parameters

Authorizationstringrequired

Bearer token for authentication.

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'http://139.59.67.17/backend/api/page-seo' \
  --header 'Authorization: text'

200

400

500

{
  "status": 1,
  "message": "Successfully got the complete list of pages."
}

Successfully retrieved the complete list of pages.

Get page SEO details

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

get

/page-seo/{pageId}

Path parameters

pageIdintegerrequired

The ID of the page to retrieve SEO details for.

Header parameters

Authorizationstringrequired

Bearer token for authentication.

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'http://139.59.67.17/backend/api/page-seo/{pageId}' \
  --header 'Authorization: text'

200

404

500

{
  "status": 1,
  "message": "Successfully got SEO details."
}

Successfully retrieved the SEO details.

Update page SEO details

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

post

/page-seo/{pageId}

Path parameters

pageIdintegerrequired

The ID of the page to update SEO details for.

Header parameters

Authorizationstringrequired

Bearer token for authentication.

Body

metaTagTitlestringrequired

Example: test

metaTagDescriptionstringrequired

Example: test

metaTagKeywordstringrequired

Example: test

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'http://139.59.67.17/backend/api/page-seo/{pageId}' \
  --header 'Authorization: text' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data '{"metaTagTitle":"test","metaTagDescription":"test","metaTagKeyword":"test"}'

200

400

404

500

{
  "status": 1,
  "message": "SEO created Successfully."
}

SEO created successfully.

Get blog category list

Retrieves a list of blog categories.

get

/blog-category

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'http://139.59.67.17/backend/api/blog-category'

200

500

{
  "status": 1,
  "message": "Successfully got the blog category list."
}

Successfully retrieved the blog category list.

Get blog list

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

get

/blog-seo

Query parameters

limitinteger

The maximum number of blogs to return.

offsetinteger

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

countinteger

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

Header parameters

Authorizationstringrequired

Bearer token for authentication.

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'http://139.59.67.17/backend/api/blog-seo' \
  --header 'Authorization: text'

200

500

{
  "status": 1,
  "message": "Successfully got blog list."
}

Successfully retrieved the blog list.

Get blog SEO details

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

get

/blog-seo/{blogId}

Path parameters

blogIdintegerrequired

The ID of the blog to retrieve SEO details for.

Header parameters

Authorizationstringrequired

Bearer token for authentication.

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'http://139.59.67.17/backend/api/blog-seo/{blogId}' \
  --header 'Authorization: text'

200

404

500

{
  "status": 1,
  "message": "Successfully got SEO detail."
}

Successfully retrieved the SEO details.

Update blog SEO details

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

post

/blog-seo/{blogId}

Path parameters

blogIdintegerrequired

The ID of the blog to update SEO details for.

Header parameters

Authorizationstringrequired

Bearer token for authentication.

Body

metaTagTitlestringrequired

Example: test

metaTagDescriptionstringrequired

Example: test

metaTagKeywordstringrequired

Example: test

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'http://139.59.67.17/backend/api/blog-seo/{blogId}' \
  --header 'Authorization: text' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data '{"metaTagTitle":"test","metaTagDescription":"test","metaTagKeyword":"test"}'

200

400

404

500

{
  "status": 1,
  "message": "Seo created Successfully."
}

SEO created successfully.

Get site map list

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

get

/site-map

Query parameters

limitinteger

The maximum number of site map entries to return.

offsetinteger

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

countinteger

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

keywordstring

A keyword to filter the site map entries.

Header parameters

Authorizationstringrequired

Bearer token for authentication.

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'http://139.59.67.17/backend/api/site-map' \
  --header 'Authorization: text'

200

400

500

{
  "status": 1,
  "message": "Successfully got the list !!"
}

Successfully retrieved the list of site map entries.

Create a new site map entry

Creates a new site map entry with the provided details.

post

/site-map

Header parameters

Authorizationstringrequired

Bearer token for authentication.

Body

urlstringrequired

Example: http://example.com/page

lastModifiedstring date-timerequired

Example: 2023-01-01T12:00:00Z

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'http://139.59.67.17/backend/api/site-map' \
  --header 'Authorization: text' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data '{"url":"http://example.com/page","lastModified":"2023-01-01T12:00:00Z"}'

201

400

500

{
  "status": 1,
  "message": "Successfully created !!"
}

Successfully created the site map entry.

Delete a site map entry

Deletes the site map entry identified by the given ID.

delete

/site-map/{entryId}

Path parameters

entryIdintegerrequired

The ID of the site map entry to delete.

Header parameters

Authorizationstringrequired

Bearer token for authentication.

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'http://139.59.67.17/backend/api/site-map/{entryId}' \
  --header 'Authorization: text'

200

404

500

{
  "status": 1,
  "message": "Successfully Deleted the data !!"
}

Successfully deleted the site map entry.