Method list

Test your request

Changelog

Returns account-level catalog promotion definitions in priority order with pagination.

page

int

(optional) Results page number (100 promotions per page, numbered from 1)

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
page	int	The one-based page number returned.
promotions	array	Complete promotion definitions in priority order.
| - promotion_id	int	Promotion identifier.
| - position	int	Priority order. Lower values are applied first.
| - name	varchar(100)	Promotion name.
| - is_enabled	bool	Whether the promotion is enabled.
| - products_filter_type	int	1 - all products with a price in the source price group, 2 - tags, 3 - categories, 4 - explicit product-price list.
| - products_filter_data	array	Filter data for the selected products_filter_type. Type 1: empty array. Types 2-3: integer ID arrays. Type 4: object with type (same value as csv_identifier) and a product_prices map.
| - is_include_subcategories	bool	Whether category descendants are included. True only when products_filter_type = 3 and the option is enabled.
| - source_price_group_id	int	Source price group identifier. 0 when products_filter_type = 4.
| - target_price_group_id	int	Target price group.
| - duration_type	int	0 for unlimited or 1 for a bounded range.
| - date_start	int	Start timestamp. 0 when duration_type = 0.
| - date_end	int	End timestamp. 0 when duration_type = 0.
| - price_multiplier	float	Numeric source-price multiplier. 1 when products_filter_type = 4.
| - price_addition	float	Numeric source-price addition. 0 when products_filter_type = 4.
| - price_round	int	Price rounding after the multiplier and addition: 0 - without rounding, 1 - round up to the full amount, 2 - round down to the full amount, 3 - round up to .99, 4 - round down to .99, 5 - round up to the nearest 0.09, 6 - round down to the nearest 0.09, 7 - round up and down with an accuracy of 0.09, 8 - round to the nearest 0.10, 9 - round units to closest 5. Ignored when products_filter_type = 4 (stored and returned as 0).
| - csv_identifier	varchar(10)	Identifier type used as keys in products_filter_data.product_prices: id or sku. Returned only when products_filter_type = 4.
| - date_added	int	Creation timestamp.
| - date_updated	int	Last definition update timestamp.
| - date_last_calculated	int	Last active-promotion processing-pass timestamp.

Input data:
{ "page": 1 } Output data:
{ "status": "SUCCESS", "page": 1, "promotions": [ { "promotion_id": 413, "position": 1, "name": "Weekend sale", "is_enabled": true, "products_filter_type": 1, "products_filter_data": [], "is_include_subcategories": false, "source_price_group_id": 104, "target_price_group_id": 105, "duration_type": 1, "date_start": 1773446400, "date_end": 1773705599, "price_multiplier": 0.8, "price_addition": -5, "price_round": 4, "date_added": 1757932800, "date_updated": 1757932800, "date_last_calculated": 1758019200 }, { "promotion_id": 414, "position": 2, "name": "Tag sale", "is_enabled": true, "products_filter_type": 2, "products_filter_data": [ 12, 18 ], "is_include_subcategories": false, "source_price_group_id": 104, "target_price_group_id": 105, "duration_type": 1, "date_start": 1773446400, "date_end": 1773705599, "price_multiplier": 0.8, "price_addition": -5, "price_round": 4, "date_added": 1757932800, "date_updated": 1757932800, "date_last_calculated": 1758019200 }, { "promotion_id": 415, "position": 3, "name": "Category sale", "is_enabled": true, "products_filter_type": 3, "products_filter_data": [ 3, 7 ], "is_include_subcategories": true, "source_price_group_id": 104, "target_price_group_id": 105, "duration_type": 0, "date_start": 0, "date_end": 0, "price_multiplier": 0.9, "price_addition": 0, "price_round": 0, "date_added": 1757932800, "date_updated": 1757932800, "date_last_calculated": 1758019200 }, { "promotion_id": 416, "position": 4, "name": "Long-term SKU sale", "is_enabled": true, "products_filter_type": 4, "products_filter_data": { "type": "sku", "product_prices": { "SHOE-RED-42": 49.9 } }, "is_include_subcategories": false, "source_price_group_id": 0, "target_price_group_id": 5, "duration_type": 0, "date_start": 0, "date_end": 0, "price_multiplier": 1, "price_addition": 0, "price_round": 0, "csv_identifier": "sku", "date_added": 1757932800, "date_updated": 1757932800, "date_last_calculated": 0 } ] } A sample request in PHP:
<?php $methodParams = '{ "page": 1 }'; $apiParams = [ "method" => "getInventoryPromotionsList", "parameters" => $methodParams ]; $curl = curl_init("https://api.base.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);