Preview Promotion
POST/api/walmart/:integrationInstance/promotions/preview
Report what a promotion would do — the resulting price, discount and margin for each listing, every price guardrail it would break, every listing that cannot be promoted, and what it costs of the feed budget — without sending anything to Walmart.
integrations:writeGrant this scope to your token under Settings → Developer → Personal Access Tokens.
The discount is a RULE rather than a price, because one promotion covers listings at different list prices:
percent_off— a percentage off each listing's list priceamount_off— a fixed amount off each listing's list pricetarget_price— the same price for every listing; the only rule that does not need a list price
round_to applies a charm ending after the discount (0.95 turns 13.16 into 12.95). It only ever rounds DOWN — rounding up would be a price rise wearing a discount's clothes.
overlapping lists listings that already carry a promotion in this window. Walmart keeps the last feed it accepts, so a new promotion replaces the old one.
Authentication: Requires Bearer token.
Requires the integrations.view permission.
Request
Responses
- 200
- 401
- 403
- 404
- 422
- 429
OK
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Not found — no record with the given identifier (or the route does not exist). Verify the ID before retrying.
Validation failed — the body is a field → messages map (Laravel shape) or the platform envelope with a stable machine-readable code. Fix the payload and resubmit.
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.