| Anchor | ||||
|---|---|---|---|---|
|
| Excerpt | ||
|---|---|---|
Use this method to get a price list.
|
Table of Contents
| 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.
| Code Block |
|---|
{
"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
| Code Block |
|---|
{
"message":"OK",
"status":1,
"priceList":[
{
"id": Number,
"name": String,
"description": String,
"type": String,
"isMaster": boolean
}
]
} |
| Filter by label (Content by label) | ||||||||
|---|---|---|---|---|---|---|---|---|
|