Skip to documentation
Browse documentation

Promotions List

List genuinely discounted products from a selected live Carrefour KSA campaign: Best Deals, Weekend Sale, or Monthly Stock Up.

Capability ID carrefourksa.promotions.list
Cost 1 credit per request
Maximum runtime 120 seconds
View raw

POST /execute Shared execution endpoint

Input parameters

page integer optional

0-based campaign page.

Example 0
page_size integer optional

Campaign products inspected per page. Maximum 100.

Example 5
promotion_type string optional

Curated live Carrefour KSA promotion campaign.

Example best_deals
Available values best_dealsweekend_salemonthly_stock_up
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 4 fields
pagination.num_of_pages integer 109
pagination.page integer 0
pagination.returned_promotions integer 3
pagination.total_products integer 545
promotion object 5 fields
promotion.name string Best Deals
promotion.slug string promo-ksa-best-dealss
promotion.type string best_deals
promotion.upstream_name string Best deals
promotion.url string https://www.carrefourksa.com/mafsau/en/c/promo-ksa-best-dealss
promotions array 3 items
promotions array 3 items

Execution behavior

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