Method list

Test your request

Changelog

Returns details of up to 10 Listing Agents: settings, effective marketplace account settings used for listing (including a pause after marketplace API errors), detected configuration issues, the latest run per site and a summary of the agent listing queue.

listing_agent_ids

array

Listing Agent IDs (getListingAgentsList), up to 10 per request.

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
listing_agents	array	Agent details ordered by listing_agent_id ascending.
| - listing_agent_id	int	Listing Agent identifier.
| - name	varchar(100)	Agent name.
| - marketplace_code	varchar(50)	Marketplace the agent lists to. Empty when the agent setup was not finished.
| - account_id	int	Marketplace account identifier.
| - account_name	varchar(100)	Marketplace account name. Empty when the account no longer exists.
| - sites	array	Marketplace sites (countries) the agent lists to, e.g. ["de", "fr"].
| - source_type	varchar(20)	Source of products: catalog, shop, warehouse, blconnect.
| - inventory_id	int	Catalog ID (getInventories). 0 when the source is not a catalog.
| - storage_id	varchar(30)	External storage ID in getExternalStoragesList format (e.g. shop_2445). Empty for catalog and Base Connect.
| - connect_integration_id	int	Base Connect integration ID (getConnectIntegrations). 0 for other sources.
| - listing_mode	varchar(10)	publish – offers are listed immediately, draft – offers are saved as drafts.
| - is_active	bool	Whether the agent is enabled. Disabled agents do not run.
| - is_stop_requested	bool	Whether a stop was requested; the next run will be skipped.
| - last_action_required	array	The last reason the agent was disabled or a run was stopped. Cleared only when the agent is enabled or saved again. type (varchar(20)) - disabled – the agent was disabled by the system; run_stopped – a run was stopped and the agent tries again in the next run; empty – none (a disabled agent without a reason was disabled by a user). reason_code (varchar(50)) - Reason code, e.g. api_error_limit_reached, local_validation_errors_limit_reached, source_unavailable, inventory_view_not_found, kill_switch_activated. other – reason without a dedicated code, see reason_message. Empty when type is empty. reason_message (text) - Reason description in the account language. date (int) - Unix timestamp when the reason was recorded. 0 when type is empty.
| - date_last_started	int	Unix timestamp of the last start attempt. 0 – never started or unknown.
| - date_updated	int	Unix timestamp of the last change made by a user (settings or status). Disabling by the system is reported in last_action_required.
| - is_last_action_resolved	bool	true when the latest runs of all sites (last_runs) are completed and finished after last_action_required.date.
| - settings	array	Agent settings. inventory_view_id (int) - Inventory view ID. 0 – none. filters (array) - Product filters. Empty or 0 – not used. | - category_id (int) - Category ID. | - sku (text) - SKU. | - ean (text) - EAN. | - name (text) - Product name. | - price_from (float) - Minimum price. | - price_to (float) - Maximum price. | - quantity_from (int) - Minimum stock. | - quantity_to (int) - Maximum stock. | - manufacturer_id (int) - Manufacturer ID. | - tag_ids (array) - Tag IDs. variants_mode (varchar(30)) - products, variants_as_products, variant_groups. productization (array) - Productization settings. | - mode (varchar(30)) - Productization mode. | - price_margin (float) - Price margin. 0 – not used. | - method (varchar(30)) - Method of matching marketplace products. | - is_auto_create_enabled (bool) - Whether a new marketplace product is created when no match is found. ai (array) - AI settings. | - category_min_confidence (int) - Minimum confidence of AI category detection, 0–100. 0 – AI category detection off. | - category_detection_mode (varchar(30)) - AI category detection mode. | - parameter_fill_mode (varchar(20)) - none, mandatory, optional, all. | - content (array) - AI content settings per field. | - | - name (array) - Product name. | - | - description (array) - Product description. | - | - bulletpoints (array) - Bullet points. Only for marketplaces that support bullet points, e.g. Amazon. is_repricing_enabled (bool) - Whether repricing is enabled. is_auto_correct_enabled (bool) - Whether automatic correction of rejected offers is enabled.
| - effective_settings	array	Marketplace account settings used by the agent, one element per site and shared by all agents of the account. site (varchar(20)) - Marketplace site. Empty – the marketplace has no sites. price_group_id (int) - Price group ID. price_multiplier (float) - Price multiplier. price_addition (float) - Amount added to the price. stock_source (varchar(50)) - Stock source. default_category_id (varchar(100)) - Default category ID. Empty – none. offer_template_id (int) - Offer template ID. 0 – none. shipping_price_list_id (varchar(100)) - Shipping price list ID. Empty – none. blocked_until (int) - Unix timestamp until which runs of all agents of this account and site are paused after reaching the marketplace API error limit. 0 – not paused.
| - issues	array	Configuration problems detected now. code (varchar(50)) - account_not_found, source_unavailable, inventory_view_not_found, no_sites_selected, marketplace_fill_integration_settings, price_group_not_in_catalog. message (text) - Issue description in the account language.
| - last_runs	array	The latest run of each site. Empty – no run in the last 14 days. listing_agent_run_id (int) - Run identifier. listing_agent_id (int) - Agent identifier. The agent may have been deleted since. listing_agent_name (varchar(100)) - Agent name at the time of the run. marketplace_code (varchar(50)) - Marketplace code. site (varchar(10)) - Site of the run. Empty for marketplaces without sites or when unknown (run failed to start). run_status (varchar(20)) - completed – the run processed all matched products or reached max_items_per_run or the maximum run time (is_runtime_limit_reached); stopped – the run was stopped (see stop_reason_code); failed_to_start – the run stopped before processing products. date_started (int) - Unix timestamp of the run start. 0 when the run failed to start. date_finished (int) - Unix timestamp of the run end. products_matched (int) - Products matching the agent filters that have no offer and no queue row yet. products_added_to_queue (int) - Products added to the listing queue. Being added to the queue does not mean that the offer was created – check getListingAgentRunItems or getListingAgentQueueItems. products_with_errors (int) - Products rejected before the queue because of validation, currency, product matching or unique field errors. AI errors are not counted – see getListingAgentRunItems. products_skipped (int) - Products skipped because they already have an offer or a queue row. products_skipped_unique_field (int) - Products skipped because another source already uses the same unique field value (e.g. EAN). products_not_processed (int) - Matched products not handled in this run because of limits or a stop: products_matched − products_added_to_queue − products_with_errors, at least 0. is_runtime_limit_reached (bool) - Whether the run reached the maximum run time. stop_reason_code (varchar(50)) - Reason code when run_status is stopped or failed_to_start (codes as in last_action_required of getListingAgentsList). Empty otherwise. stop_reason_message (text) - Reason description in the account language. Empty when stop_reason_code is empty. dispatch_status (varchar(20)) - sent – queue rows were sent to the marketplace; error – sending failed; not_triggered – nothing to send. has_items (bool) - Whether per-product results are available (getListingAgentRunItems).
| - queue_summary	array	Number of listing queue rows created by the agent per status group. Rows created before 2026-09-24 are not counted. in_progress (int) - Rows waiting for listing or being listed. draft (int) - Rows saved as drafts. error (int) - Rows rejected with an error. listed (int) - Rows listed on the marketplace.

Input data:
{ "listing_agent_ids": [ 4812 ] } Output data:
{ "status": "SUCCESS", "listing_agents": [ { "listing_agent_id": 4812, "name": "Electronics \u2013 Allegro", "marketplace_code": "allegro", "is_active": true, "is_last_action_resolved": false, "settings": { "inventory_view_id": 0, "filters": { "category_id": 1204, "sku": "", "ean": "", "name": "", "price_from": 0, "price_to": 0, "quantity_from": 0, "quantity_to": 0, "manufacturer_id": 0, "tag_ids": [ 12 ] }, "variants_mode": "products", "productization": { "mode": "none", "price_margin": 0, "method": "none", "is_auto_create_enabled": false }, "ai": { "category_min_confidence": 0, "category_detection_mode": "", "parameter_fill_mode": "mandatory", "content": { "name": { "mode": "keep" }, "description": { "mode": "keep" } } }, "is_repricing_enabled": false, "is_auto_correct_enabled": true }, "effective_settings": [ { "site": "", "price_group_id": 104, "price_multiplier": 1, "price_addition": 0, "stock_source": "bl_205", "default_category_id": "", "offer_template_id": 77, "shipping_price_list_id": "a1b2c3", "blocked_until": 0 } ], "issues": [], "last_runs": [ { "listing_agent_run_id": 990311, "site": "", "run_status": "stopped", "products_matched": 38897, "products_added_to_queue": 0, "products_with_errors": 50, "stop_reason_code": "local_validation_errors_limit_reached" } ], "queue_summary": { "in_progress": 0, "draft": 0, "error": 12, "listed": 431 } } ] } A sample request in PHP:
<?php $methodParams = '{ "listing_agent_ids": [ 4812 ] }'; $apiParams = [ "method" => "getListingAgentsData", "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);