API Keyword Product

Home / API / Keyword Product

The API Keyword Product A Keyword Product is a search keyword, related to an individual product, that is used to enable searches. These APIs control the creation and reading of Keyword Products. Methods list with Parameters and Return examples.

Read

Reads product keywords. If all parameters are sent then all Keyword Products are returned. Otherwise the set will be restricted to Keyword Products that correspond to the parameter combination.

Authentication: Windows

Privilege : Administrator , Power User

Method: PxStat.System.Navigation.Keyword_Product_API.Read

Parameters:

Name	Type	Default	Description
SbjCode	Integer	0 or empty	Subject Code
PrcCode	Integer	0 or empty	Product Code
KprCode	Integer	0 or empty	Keyword Product Code

Return: Array [ Object ]

Name	Type	Description
KprCode	Integer	Keyword Product Code
KprValue	String	Keyword Product Value
KprMandatoryFlag	Boolean	Denotes if this is a Mandatory Keyword
SbjCode	Integer	Subject Code
SbjValue	Integer	Subject Value
KprSingularisedFlag	Boolean	Indicates if the keyword has been singularised*

*Generally speaking, this refers to acronyms etc which are not singularised as part of the search process.

---

Create

Creates a non-mandatory product keyword

Authentication: Windows

Privilege : Administrator , Power User

Method: PxStat.System.Navigation.Keyword_Product_API.Create

Parameters:

Name	Type	Default	Description
KprValue	String		Keyword Product Code
PrcCode	Integer		Product Code
KprMandatoryFlag	boolean	false	Product Code
LngIsoCode	string		Language ISO Code*
*This value is passed if the word has been singularised. The code must correspond to the language in which the word has been singularised.

Return: String with value of success

---

Update

Updates a product keyword.

Authentication: Windows

Privilege : Administrator , Power User

Method: PxStat.System.Navigation.Keyword_Product_API.Update

Parameters:

Name	Type	Default	Description
KprValue	String		Keyword Product Code
PrcCode	Integer		Product Code
KprMandatoryFlag	boolean	false	Product Code
LngIsoCode	string		Language ISO Code*
*This value is passed if the word has been singularised. The code must correspond to the language in which the word has been singularised.

Return: String with value of success

---

Delete

Deletes a product keyword.

Authentication: Windows

Privilege : Administrator , Power User

Method: PxStat.System.Navigation.Keyword_Product_API.Delete

Parameters:

Name	Type	Default	Description
KprCode	Integer		Keyword Product Code

Return: String with value of success