Saltar al contenido principal
POST

Autorizaciones

Authorization
string
header
requerido

Your API key, sent as Authorization: Bearer <key>.

Encabezados

Prefer
string

wait=<seconds> holds the request at most that long, up to 290. wait=0 answers with the task id at once.

Ejemplo:

"wait=120"

Cuerpo

application/json
query
string
requerido

The search, 1-500 characters.

Required string length: 1 - 500
Pattern: \S
limit
integer
predeterminado:20

Products to return, 1-40, default 20.

Rango requerido: 1 <= x <= 40
sort
enum<string>
predeterminado:relevance

The order of the results. relevance, the default, keeps Walmart's own order; price_asc ranks the lowest price first; price_desc ranks the highest price first; rating ranks the highest rated first; newest ranks the newest first; best_selling ranks the best sellers first. Walmart's price_asc is not strictly ascending.

Opciones disponibles:
relevance,
price_asc,
price_desc,
rating,
newest,
best_selling
minPrice
number

Lowest price in USD, in whole units: a fraction rounds inward. Either bound works alone.

Rango requerido: x >= 0
maxPrice
number

Highest price in USD, in whole units: a fraction rounds inward. Either bound works alone.

Rango requerido: x >= 0
page
integer
predeterminado:1

The store's results page, 1-10. rank counts from 1 within the page.

Rango requerido: 1 <= x <= 10
brand
string

A brand as Walmart lists it, such as Sony.

Pattern: ^[^\x00-\x20|:](?:[^\x00-\x1f|:]{0,62}[^\x00-\x20|:])?$
soldByWalmart
boolean

true keeps the products Walmart sells itself.

fastDelivery
boolean

true keeps the products that arrive by tomorrow, Walmart's Get it fast filter.

minRating
enum<integer>

4 keeps the products rated 4 stars or more.

Opciones disponibles:
4
idempotencyKey
string

Optional. A repeat of the key within at least 30 days answers with the task that holds it, so a caller that hung up can ask again.

priority
integer
predeterminado:1

Compatibility field; does not guarantee execution order. Values outside 1–10 are clamped, not rejected.

Rango requerido: 1 <= x <= 10
webhook
object

Optional. Omit to collect the result by polling instead.

Respuesta

The search ended: the body GET /v1/async/task/{id} returns, with the products in response or the reason in error.

success
boolean
requerido
task
object
requerido
credits
object
requerido

Credits, with up to two decimals (for example 1.25). The submit response always shows 0: nothing is charged yet, and the task's price is held from your balance when it starts. Polling shows 0 until the task is terminal, then the settled charge: the task's price for COMPLETED, 0 for FAILED. A task webhook reports the same charge in creditsCharged; on a FAILED task it reports the task's price in creditsToCharge and 0 in creditsCharged. CITATION_ANALYSIS, GOOGLE_PLACES and GOOGLE_NEWS are charged by usage, up to the hold placed when the task starts.

response
object

The engine-specific result. Absent until the task is terminal. See the Engines guide for per-engine shapes. NAVER_AI_TAB preserves the original text, markdown, sources and cards when Naver returns HTTP success, a valid stream ending in done, and nonempty answer text with unknown_error. It includes upstreamError and returns immediately without retrying or rephrasing, even with retryQuery. COMPLETED means collection finished; the answer may still be incomplete. Empty, cut-off or malformed streams still fail. Policy refusals complete with a policy_declined notice. rawContent is returned only with include.rawResponse. With include.citationAnalysis, answer results also carry citationAnalysis (see Include). CITATION_ANALYSIS returns CitationAnalysisResult; see the Citation Analysis guide. PROMPT_RESEARCH returns PromptResearchResult; see the Prompt Research guide. GEO_SCORE returns GeoScoreResult; see the GEO Score guide. Answer engines with include.analysis add analysis (AnswerAnalysis).

error
string

Present when task.status is FAILED. A plain string, not the {code, message, timestamp} object used by request-level errors.