Skip to main content

List Promotions

GET 
/api/walmart/:integrationInstance/promotions

List every promotional price recorded for a Walmart integration instance, most recent first.

Required scope: integrations:read

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

Prices and costs are snapshots taken when the promotion was submitted, so discount_pct and margin_pct report what the promotion actually carried rather than a figure recomputed from a catalogue that has moved since.

display_status is the merchant-facing state, derived from the promotion's window and what Walmart said: pending (submitted, Walmart still ingesting), scheduled, live, ending_soon (within two days of the end date), ended, rejected, cancelled. status is the underlying lifecycle — pending, accepted, rejected, cancelled — which is what tells a promotion that simply ran its course apart from one that was ended early.

Filter with filter[outstanding]=1 for promotions that are still running, scheduled or submitting — the working view. filter[guardrail_breached]=1 returns the ones whose promotional price broke a price guardrail.

Allowed sorts: id, channel_sku, list_price, promo_price, discount_pct, margin_pct, display_status, effective_date, expiration_date, created_at, updated_at. Prefix with - for descending.

Authentication: Requires Bearer token.

Requires the integrations.view permission.

Request​

Responses​

OK

Response Headers
    Content-Type