Manage Banner

PreviousCMS NextManage Blogs

Last updated 3 months ago

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>

Retrieve a list of banners

get

This endpoint retrieves a list of banners 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 banners.

Header parameters

AuthorizationstringRequired

Bearer token for authentication.

Responses

200

Successfully retrieved the banner list.

400

Bad request

500

Internal server error

get

GET /backend/api/banner HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*

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

Get seller product list

get

Retrieves a list of seller products based on the provided filters.

Query parameters

offsetintegerOptional

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

Default: 0

limitintegerOptional

The maximum number of products to return.

Default: 0

keywordstringOptional

A keyword to filter the products.

skustringOptional

The SKU of the product to filter.

statusintegerRequired

The status of the products to retrieve (1 for active).

Default: 1

priceintegerOptional

The price filter for the products.

Default: 0

Header parameters

AuthorizationstringRequired

Bearer token for authentication.

Responses

200

Successfully retrieved the seller product list.

400

Bad request due to invalid parameters.

500

Internal server error.

get

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

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

Get banner count

get

Retrieves the total count of banners.

Header parameters

AuthorizationstringRequired

Bearer token for authentication.

Responses

200

Successfully retrieved the banner count.

400

Bad request due to invalid parameters.

500

Internal server error.

get

GET /backend/api/banner/banner-count HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*

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

Get bucket object list

get

Retrieves a list of objects in a specified media bucket.

Query parameters

limitintegerOptional

The maximum number of objects to return.

Default: 100

folderNamestringOptional

The name of the folder to filter the objects.

markerstringOptional

A marker for pagination to continue listing objects.

Header parameters

AuthorizationstringRequired

Bearer token for authentication.

Responses

200

Successfully retrieved the bucket object list.

400

Bad request due to invalid parameters.

500

Internal server error.

get

GET /backend/api/media/bucket-object-list HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*

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

Get banner detail

get

Retrieves the details of a specific banner by its ID.

Query parameters

bannerIdintegerRequired

The ID of the banner to retrieve details for.

Header parameters

AuthorizationstringRequired

Bearer token for authentication.

Responses

200

Successfully retrieved the banner detail.

400

Bad request due to invalid parameters.

404

Banner not found.

500

Internal server error.

get

GET /backend/api/banner/banner-detail HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*

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

Delete a specific banner

delete

Deletes the banner identified by the given ID.

Path parameters

bannerIdintegerRequired

The ID of the banner to delete.

Header parameters

AuthorizationstringRequired

Bearer token for authentication.

Responses

200

Successfully deleted banner.

404

Banner not found.

500

Internal server error.

delete

DELETE /backend/api/banner/{bannerId} HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*

<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Successfully deleted banner.</message>
</object>

Create a new banner

post

Creates a new banner with the provided details.

Header parameters

AuthorizationstringRequired

Bearer token for authentication.

Body

titlestringRequiredExample: test

contentstringRequiredExample: <p>test</p>

positionstringRequiredExample: 5

imagestringOptional

statusintegerRequiredExample: 1

linkstringRequiredExample: https://spurtcommerce-marketplace-store.vercel.app/

linkTypeintegerRequiredExample: 1

Responses

200

Successfully created new banner.

400

Bad request due to invalid parameters.

500

Internal server error.

post

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

"title='test'&content='<p>test</p>'&position='5'&image=''&status=1&bannerImage=[{'containerName':'','image':'317jvwy8tol1710502753887_1712037737942.png','isPrimary':1}]&link='https://spurtcommerce-marketplace-store.vercel.app/'&linkType=1"

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

Update an existing banner

put

Updates the details of a specific banner by its ID.

Path parameters

bannerIdintegerRequired

The ID of the banner to update.

Header parameters

AuthorizationstringRequired

Bearer token for authentication.

Body

titlestringRequired

contentstringRequired

positionstringRequired

statusintegerRequired

linkstringRequired

linkTypeintegerRequired

bannerIdstringRequired

Responses

200

Successfully updated banner.

400

Bad request due to invalid parameters.

404

Banner not found.

500

Internal server error.

put

PUT /backend/api/banner/{bannerId} HTTP/1.1
Host: 139.59.67.17
Authorization: text
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 345

"title='text'&content='text'&position='text'&status=1&bannerImage=[{'createdBy':'text','createdDate':'2025-05-18T02:26:16.472Z','modifiedBy':'text','modifiedDate':'2025-05-18T02:26:16.472Z','id':1,'isPrimary':1,'bannerId':1,'isActive':1,'isDelete':1,'image':'text','containerName':'text'}]&link='text'&linkType=1&bannerId='text'"

<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Successfully updated banner.</message>
</object>