Finding product parameters
Introduction
You will need to supply a number of parameters (params for short) when for example displaying a Product or listing the content of a Catalogue.
cidlangenterpriseprdCatprdCatVersionvendorpriceListpartNumber(Product ID essentially)
tip
CID is not Catalogue ID, but rather Portfolio ID. A Portfolio can contain multiple Catalogues. The Catalogue ID is prdCat.
Where to find
You normally start using the API by calling one of the Authorize endpoints to obtain a SessionToken.
In addition to the SessionToken this reply also contains information about which Catalogues the token grants access to.
In the example-app this call is used to display a list of all available Catalogues.
Next, we use the parameters extracted from the Authorize response to find out which Products are available in a given Catalogue. This is done via one of the TOC endpoints in the API and the result contains all available Products for that Catalogue as well as some additional data.
In the example-app this call is used to display a list of all available Products after the user selected a Catalogue.
Where do they come from
The parameters are set in Catalogue Creator, the desktop software where Catalogues are created. Developers integrating Stage are typically not the ones working in Catalogue Creator, but nevertheless this can be useful information.
cid In the Publish tab, at the end of the Portfolio name. The cid will be a number found at the end of the label, like "Testing - Testing [1234]" where 1234 is the cid.
lang In the Projects tab, Languages. The language code will be xx-XX, like sv-SE.
enterprise In the Projects tab, "Enterprise / Manufacturer"-block, Code
vendor If you want to see which are available: In the Projects tab, "Vendors"-block, Code is the code of the vendor selected in the dropdown. If you want for a specific Product: In the Products tab, for the specific Product, you find it in the Vendor-column.
In the Product Catalogues tab, select your Catalogue in the top dropdown, then:
prdCat In the Product Catalogues tab, "Catalogue Information"-block, Code
prdCatVersion In most cases you should just pass "-" to let the API pick the default version, but if you want a specific version it's next to prdCat.
priceList In the Product Catalogues tab, "Catalogue Information"-block, Active Price Lists. In the dropdown you find all Price Lists that are available for the Catalogue.
How they are used
In the Example app
When running the example-app you will see the parameters in the URL in your browser.
An URL to a Product in the example-app will look something like this:
http://localhost:1234/<cid>/<lang>/<enterprise>/<prdCat>/<prdCatVersion>/<vendor>/<priceList>/product/<partNumber>
prdCatVersion, vendor and priceList are sometimes empty, which is represented as "-" in the URL.
An empty value for these params means that the Catalogue in question either does not use that feature or that the default value should be used where applicable.
Browse at MyConfigura
If you have an account at MyConfigura with the right access you can browse your Stage enabled Catalogues there.
An URL to a Product in MyConfigura will look something like this:
https://app.configura.com/my/projects/manufacturer/<your manufacturer>/catalogues/stage-browser/<cid>/<lang>/<enterprise>/<prdCat>/<prdCatVersion>/<vendor>/<priceList>/product/<partNumber>
prdCatVersion, vendor and priceList are sometimes empty, which is represented as "-" in the URL.
An empty value for these params means that the Catalogue in question either does not use that feature or that the default value should be used where applicable.