/
Get a Price List

Get a Price List

Use this method to get a price list.

Valid Tokens: Company.

Table of Contents


Request


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

Method: GET

Content-Type: application/JSON


Header

authenticationToken (required)(string:50)

Komet Sales security token.


Input Parameters

priceListType(optional)(string:1) 

Price list type.

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


name(optional)(string:60)

Price list name.


Back to top

{ "priceListType": "", "name": "FS" }

Response


message (string:500)

Transaction status description.


status (integer:1)

Transaction status. 1 = Success | 0 = Failure


priceList (array)

An array containing price lists.


id (integer)

Price list ID.


name (string)

Price list name.


description (string)

Price list description.


type (string)

Price list type.


isMaster (boolean)

If the price list is a master price list.

Valid values: 1 = Yes | 0 = No

Back to top

{ "message":"OK", "status":1, "priceList":[ { "id": Number, "name": String, "description": String, "type": String, "isMaster": boolean } ] }

Peacock

Related content

Get a List of Seasonal Products
Get a List of Seasonal Products
More like this
Get a List of Seasons in a Price List
Get a List of Seasons in a Price List
More like this
Update a Product in a Seasonal Price List
Update a Product in a Seasonal Price List
Read with this
Get a Prebook list
Get a Prebook list
More like this
Add a Product to a Seasonal Price List
Add a Product to a Seasonal Price List
Read with this
Price and Cost Lists
Price and Cost Lists
More like this