Method list

Test your request

Changelog

Returns Listing Agent runs from the last 14 days, newest first, including runs that failed to start. Agents listing to several sites have a separate run per site. Without listing_agent_id the date range is limited to 3 days.

listing_agent_id	int	Return runs of one agent (also deleted in the last 14 days).
filter_marketplace_code	varchar(50)	Return runs of 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.
date_from	int	Unix timestamp. Runs finished at or after this time. Default: 14 days ago with listing_agent_id, 3 days ago without it.
date_to	int	Unix timestamp. Runs finished at or before this time. Default: now.
filter_problems_only	bool	true – only runs that were stopped, failed to start or rejected products. Default false.
page	int	Results page (100 runs 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.
runs	array	Runs ordered by listing_agent_run_id descending.
| - 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).

Input data:
{ "listing_agent_id": 4812, "filter_problems_only": true } Output data:
{ "status": "SUCCESS", "page": 1, "runs": [ { "listing_agent_run_id": 990311, "listing_agent_id": 4812, "listing_agent_name": "Electronics \u2013 Allegro", "marketplace_code": "allegro", "site": "", "run_status": "stopped", "date_started": 1792396200, "date_finished": 1792396800, "products_matched": 38897, "products_added_to_queue": 0, "products_with_errors": 50, "products_skipped": 0, "products_skipped_unique_field": 0, "products_not_processed": 38847, "is_runtime_limit_reached": false, "stop_reason_code": "local_validation_errors_limit_reached", "stop_reason_message": "The listing agent was stopped because the validation error limit was reached.", "dispatch_status": "not_triggered", "has_items": true } ] } A sample request in PHP:
<?php $methodParams = '{ "listing_agent_id": 4812, "filter_problems_only": true }'; $apiParams = [ "method" => "getListingAgentRunsList", "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);