Skip to documentation
Browse documentation

Products Search

Search Carrefour KSA's anonymous product catalog by keyword with 0-based pagination, SAR prices, discounts, availability, suppliers, and product URLs.

Capability ID carrefourksa.products.search
Cost 1 credit per request
Maximum runtime 120 seconds
View raw

POST /execute Shared execution endpoint

Input parameters

page integer optional

0-based results page.

Example 0
page_size integer optional

Products per page. Maximum 100.

Example 5
query string required

Product search text, for example milk, rice, or diapers.

Example milk
sort_by string optional

Sort order.

Example relevance
Available values relevanceprice_ascprice_desc

Response

Successful output is returned in results[0].data. Raw platform output is intentionally open-ended and may evolve with the upstream source.

Illustrative sample The full redacted fixture is shown in the response panel.

Illustrative output fields

Derived from the sample above for orientation only. These observed fields are not a fixed response schema.

PathObserved typeExample
pagination object 3 fields
pagination.num_of_pages integer 228
pagination.page integer 0
pagination.total_products integer 1137
products array 3 items
products array 3 items
query string milk

Execution behavior

A 200 response completed inline. A 202 response was queued; poll GET /jobs/:id until the job reaches completed or failed.