Method list

Test your request

Changelog

Returns per-product results of one Listing Agent run: products added to the listing queue (with the current queue status) and products rejected before the queue with their errors.

listing_agent_run_id	int	Run identifier (getListingAgentRunsList).
filter_type	varchar(10)	success – only products added to the queue; error – only rejected products. Omit to return both.
page	int	Results page (100 items 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.
marketplace_code	varchar(50)	Marketplace code of the run.
items	array	Items ordered by type, product_id, variant_id.
| - type	varchar(10)	success – added to the listing queue; error – rejected before the queue.
| - product_id	varchar(255)	Product ID in the agent source of products (getInventoryProductsData for catalogs, getExternalStorageProductsData for external storages).
| - variant_id	varchar(255)	Variant ID. Empty – not a variant.
| - product_name	text	Product name at the time of the run.
| - queue_id	int	Listing queue row ID. 0 – not added to the queue.
| - queue_status_group	varchar(20)	Current status of the queue row: in_progress, draft, error, listed. Empty when the row is being deleted, was deleted or no longer exists, or queue_id is 0.
| - queue_errors	text	Current errors of the queue row, e.g. returned by the marketplace (plain text, up to 1000 characters).
| - validation_errors	array	Errors found before the queue. message (text) - Error message in the account language at the time of the run. field (varchar(100)) - Offer field or parameter the error refers to. Empty when unknown. code (varchar(50)) - Error code. Empty when the error has no code.
| - ai_errors	array	AI processing errors: reason_code (ai_limit_reached, ai_request_error, ai_empty_output, ai_invalid_api_key, ai_missing_input, deepl_quota_exceeded, deepl_auth_error, deepl_request_error, ai_content_failure_unknown) and message. reason_code (varchar(50)) - AI failure reason code. message (text) - Reason description in the account language.
| - category_ai_error	text	Error of the AI category detection. Empty – none.

Input data:
{ "listing_agent_run_id": 990311 } Output data:
{ "status": "SUCCESS", "page": 1, "marketplace_code": "allegro", "items": [ { "type": "error", "product_id": "88213", "variant_id": "", "product_name": "USB-C wall charger 65 W GaN", "queue_id": 0, "queue_status_group": "", "queue_errors": "", "validation_errors": [ { "message": "The Category field is required", "field": "category", "code": "" } ], "ai_errors": [], "category_ai_error": "" }, { "type": "success", "product_id": "88240", "variant_id": "", "product_name": "Power bank 20000 mAh", "queue_id": 5521907, "queue_status_group": "error", "queue_errors": "Missing GPSR: responsible producer", "validation_errors": [], "ai_errors": [], "category_ai_error": "" } ] } A sample request in PHP:
<?php $methodParams = '{ "listing_agent_run_id": 990311 }'; $apiParams = [ "method" => "getListingAgentRunItems", "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);