Get a List of Seasonal Products

Owned by Andres Toledo, created
Last updated: Dec 04, 2023
2 min read

Use this method to get a seasonal product price list.

Valid Tokens: Company.

Table of Contents

Request

URL: https://api.kometsales.com/api/v2/price-list/season/product

Method: GET

Content-Type: application/JSON

authenticationToken (required)(string:50)

Komet Sales security token.

Input Parameters

priceListId (required)(integer:20)

Price list ID.

priceListSeasonId(required)(Integer:20)

Seasonal price list ID.

productDescription(optional)(String:100)

Product description or name.

companyProductId(optional)(Integer:20)

Internal Company Product ID.

If you use the companyProductId, the system will use this value and ignore the productDescription parameter.

vendorId(optional)(Integer:20)

Vendor ID.

categoryId(optional)(Integer:20)

Category ID.

Back to top

{ "priceListId":"1313", "priceListSeasonId":"13", "productDescription":"Black Rose", "companyProductId":"123", "vendorId":"99", "categoryId":"31" }

Response

message (string:500)

Transaction status description.

status (integer:1)

Transaction status. 1 = Success | 0 = Failure

priceListSeasonsProducts (array)

An array containing products of the seasonal price list.

id (integer)

Product ID.

name (string)

Product name.

cost (decimal)

Product cost.

price (decimal)

Product price.

productDescription (string)

Product description.

vendorId (integer)

Vendor ID.

vendorName (string)

Vendor name.

boxTypeId (integer)

Box type ID.

boxTypeCode (string)

Box type code.

seasonName (string)

Season name.

priceListName (string)

Price list name.

priceListId (integer)

Price list ID.

seasonId (integer)

Season ID.

priceListType (string)

Price list type.

Valid values: A = All | M = Open Market | P = Prebook | S = Standing Order

Back to top

{ "message":"OK", "status":1, "priceListSeasonProducts":[ { "id": Number, "name": String, "cost": Numeric(10,2)(if setting is enabled), "price": Numeric(10,2), "productDescription": String, "vendorId": Number, "VendorName": String(Name and code?), "boxTypeId": Number, "boxTypeCode": String, "seasonName": String, "priceListName": String, "priceListId": Number, "seasonId": Number, "priceListType": String } ] }

Related Articles

Peacock