API documentation
Method list
Test your request
Changelog


getListingAgentRunItems
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.


Input parameters
listing_agent_run_idintRun identifier (getListingAgentRunsList).
filter_typevarchar(10)success – only products added to the queue; error – only rejected products. Omit to return both.
pageintResults page (100 items per page, numbered from 1).



Output data
The method returns the data in JSON format.
statusvarchar(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
pageintThe one-based page number returned.
marketplace_codevarchar(50)Marketplace code of the run.
itemsarrayItems ordered by type, product_id, variant_id.
| - typevarchar(10)success – added to the listing queue; error – rejected before the queue.
| - product_idvarchar(255)Product ID in the agent source of products (getInventoryProductsData for catalogs, getExternalStorageProductsData for external storages).
| - variant_idvarchar(255)Variant ID. Empty – not a variant.
| - product_nametextProduct name at the time of the run.
| - queue_idintListing queue row ID. 0 – not added to the queue.
| - queue_status_groupvarchar(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_errorstextCurrent errors of the queue row, e.g. returned by the marketplace (plain text, up to 1000 characters).
| - validation_errorsarrayErrors 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_errorsarrayAI 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_errortextError of the AI category detection. Empty – none.



Sample
Input data:
Output data:
A sample request in PHP: