Method list

Test your request

Changelog

The method allows to retrieve price groups existing in BaseLinker storage.





The method returns the data in JSON format.

status	varchar(30)	SUCCESS - request executed correctly ERROR - an error occurred during an API request. Error details will be described in 2 additional returned fields: error_message and error_code
price_groups	array	An array of price group objects
| - price_group_id	int	Price group identifier
| - name	varchar(100)	Name of the price group
| - description	text	Price group description
| - currency	char(3)	3-letter currency symbol e.g. USD, EUR
| - is_default	bool	Flag indicating whether the price group is default
| - price_group_type	text	Type of the price group
| - source_price_group_id	int	ID of the source price group. 0 when price_group_type is not "dependent_on_price_group".
| - price_multiplier	float	Multiplier applied to source price. 1 for standard groups.
| - price_addition	float	Fixed value added to the price after multiplier. 0 for standard groups.
| - is_bundle_price_calculated	bool	Whether bundle prices are automatically calculated from components
| - bundle_price_multiplier	float	Multiplier for calculated bundle prices. 1 when bundle calculation is off.
| - bundle_price_addition	float	Fixed value added to calculated bundle prices. 0 when bundle calculation is off.

Input data:
{} Output data:
{ "status": "SUCCESS", "price_groups": [ { "price_group_id": 104, "name": "USD Wholesale", "description": "Default USD price group", "currency": "USD", "is_default": true, "price_group_type": "standard", "source_price_group_id": 0, "price_multiplier": 1, "price_addition": 0, "is_bundle_price_calculated": false, "bundle_price_multiplier": 1, "bundle_price_addition": 0 }, { "price_group_id": 105, "name": "EUR Retail", "description": "EUR prices derived from USD wholesale", "currency": "EUR", "is_default": false, "price_group_type": "dependent_on_price_group", "source_price_group_id": 104, "price_multiplier": 0.92, "price_addition": 0.99, "is_bundle_price_calculated": true, "bundle_price_multiplier": 1.1, "bundle_price_addition": 0 } ] } A sample request in PHP:
<?php $methodParams = '{}'; $apiParams = [ "method" => "getInventoryPriceGroups", "parameters" => $methodParams ]; $curl = curl_init("https://api.baselinker.com/connector.php"); curl_setopt($curl, CURLOPT_POST, 1); curl_setopt($curl, CURLOPT_HTTPHEADER, ["X-BLToken: xxx"]); curl_setopt($curl, CURLOPT_POSTFIELDS, http_build_query($apiParams)); $response = curl_exec($curl);