Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Anchor
topofpage
topofpage

Excerpt

Use this method to do get a list of seasons within a price list.

Tip

Valid Tokens: Company.

Table of Contents

Table of Contents
minLevel1
maxLevel1
absoluteUrltrue
excludeTable of Contents

Request


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

Method: GET

Content-Type: application/JSON


Header

authenticationToken (required)(string:50)

Komet Sales security token.


Input Parameters

priceListId (required)(integer:20)

Price list ID.


name (optional)(string:100)

Price list name.


Back to top

Code Block
{
  "priceListId": "12548",
  "name": "Valentines"
}

Response


message (string:500)

Transaction status description.


status (integer:1)

Transaction status. 1 = Success | 0 = Failure


seasons (array)

An array containing seasons within the price list.


id (integer)

Season ID.


name (string)

Season name.


startDate (date)

Season starting date.

Date format: YYY-MM-DD.


endDate (date)

Season end date.

Date format: YYY-MM-DD.


priceListId (integer:20)

Price list ID.


Back to top

Code Block
{  
   "message":"OK",
   "status":1,
   "seasons":[  
      {  
         "id": Number,
         "name": String,
         "startDate": Date(YYYY-MM-DD),
         "endDate": Date(YYYY-MM-DD),
         "priceListId": Number
       }
    ]
}

Filter by label (Content by label)
showLabelsfalse
max5
titleRelated Articles
cqllabel in ( "company-token" , "vendor-token" , "customer-token" )
We've encountered an issue exporting this macro. Please try exporting this page again later.