Product Variants

Get Vendor Product List

get

Retrieves a list of vendor products with the option to filter by various parameters.

Query parameters

offsetintegerOptional

The offset for pagination

limitintegerOptional

The number of records to return

keywordstringOptional

Search keyword for filtering the products

skustringOptional

Filter by SKU of the product

productNamestringOptional

Filter by the name of the product

statusstringOptional

Filter by product status

priceintegerOptional

Filter products by price, where 0 can represent no filter

Header parameters

AuthorizationstringRequired

Responses

200

Successfully retrieved the vendor product list.

application/xmlapplication/json

400

Bad Request

401

Unauthorized

500

Internal Server Error

get

HTTPcURLJavaScriptPython

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

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

Get Complete List of Variants

get

Retrieves a complete list of product variants available for the vendor.

Query parameters

keywordstringOptional

Header parameters

AuthorizationstringRequired

Responses

200

Successfully retrieved the complete list of variants.

application/xmlapplication/json

400

Bad Request

401

Unauthorized

500

Internal Server Error

get

HTTPcURLJavaScriptPython

GET /backend/api/vendor-product-variant/variants 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 varients.</message>
</object>

Get Product Variant Detail

get

Retrieves the details of a specific product variant for the given product ID.

Path parameters

idintegerRequired

The ID of the product for which the variant details are being fetched.

Header parameters

AuthorizationstringRequired

Responses

200

Successfully retrieved product variant details.

application/xmlapplication/json

400

Bad Request

401

Unauthorized

500

Internal Server Error

get

HTTPcURLJavaScriptPython

GET /backend/api/vendor-product-variant/product/{id} HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*

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

Update Product Variant

post

Update product variants for a specific product.

Header parameters

AuthorizationstringRequired

Body

productIdinteger · int32Required

The ID of the product for which variants are being updated.

productVariantOptionsstring[]Optional

An array of product variant options for the product. (Just as strings)

productVariantsstring[]Optional

An array of product variants with their details. (Just as strings)

Responses

200

Successfully updated the product variant.

application/xmlapplication/json

400

Bad Request

401

Unauthorized

500

Internal Server Error

post

HTTPcURLJavaScriptPython

POST /backend/api/vendor-product-variant/ HTTP/1.1
Host: 139.59.67.17
Authorization: text
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 75

"productId=1&productVariantOptions=['text']&productVariants=['text']"

<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Successfully Updated the Product Variant</message>
</object>