Method list

Test your request

Changelog

Returns Listing Agents (automatic listing of products to marketplaces) configured in the account, with their current status and the reason of the last stop.

filter_marketplace_code	varchar(50)	Return only agents of this marketplace. Marketplace code as used as keys in getInventoryIntegrations (the same values getSyncLogList accepts as source), e.g. allegro, ebay, amazon, kaufland. Omit to return agents of all marketplaces.
filter_account_id	int	Marketplace account ID (getInventoryIntegrations → accounts).
filter_is_active	bool	true – only enabled agents, false – only disabled agents. Omit to return both.
page	int	Results page (100 agents per page, numbered from 1). Default 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.
listing_agents	array	Agents 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.

Input data:
{ "filter_marketplace_code": "allegro", "filter_is_active": true } Output data:
{ "status": "SUCCESS", "page": 1, "listing_agents": [ { "listing_agent_id": 4812, "name": "Electronics \u2013 Allegro", "marketplace_code": "allegro", "account_id": 15502, "account_name": "My Allegro account", "sites": [], "source_type": "catalog", "inventory_id": 307, "storage_id": "", "connect_integration_id": 0, "listing_mode": "publish", "is_active": true, "is_stop_requested": false, "last_action_required": { "type": "run_stopped", "reason_code": "local_validation_errors_limit_reached", "reason_message": "The listing agent was stopped because the validation error limit was reached.", "date": 1792396800 }, "date_last_started": 1792400760, "date_updated": 1791900000 } ] } A sample request in PHP:
<?php $methodParams = '{ "filter_marketplace_code": "allegro", "filter_is_active": true }'; $apiParams = [ "method" => "getListingAgentsList", "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);