Skip to documentation
Browse documentation

Category Products List

List one 0-based page of a leaf category shelf with SAR prices, discounts, availability, supplier (1P/3P), and product URLs.

Capability ID carrefourksa.category.products.list
Cost 1 credit per request
Maximum runtime 120 seconds
View raw Get an API key

POST /execute Shared execution endpoint

Input parameters

FieldTypeRequiredDescription
category_id string Required Leaf category id from carrefourksa.categories.list, e.g. FKSA1550000 (Soft Drinks). Root categories return empty sponsored pages upstream; use leaf ids.
page integer Optional 0-based shelf page. Defaults to 0; num_of_pages in the response is the page count.
page_size integer Optional Products per page. Defaults to 24, capped at 100.
sort_by string Optional Upstream sort key. Defaults to relevance.

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 19
pagination.page integer 0
pagination.total_products integer 455
products array 3 items
products array 3 items
raw object 16 fields
raw.algoliaQueryID string [redacted:token]
raw.breadCrumb array 2 items
raw.exactMatch boolean true
raw.hybridMeta object 2 fields
raw.is_food_category boolean true
raw.keywordSuggestions array 0 items
raw.numOfPages integer 19
raw.outOfStockProducts array 0 items
raw.pagination object 7 fields
raw.posInfo object 3 fields
raw.products array 3 items
raw.queryCategorizationTree array 0 items
raw.searchExperimentInfo object 2 fields
raw.sorts array 3 items
raw.title string Soft Drinks
raw.totalProducts integer 455

Execution behavior

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

Resources