Skip to main content
POST
Run Walmart Product Search

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
keyword
string
required

Search term.

max_items
integer
default:25

Maximum number of records to return (1-250). Billed at 1 point per returned record.

Required range: 1 <= x <= 250
start_page
integer
default:1

Result page to start from.

Required range: x >= 1
sort
enum<string>
default:best_match
Available options:
best_match,
price_low,
price_high,
best_seller,
new,
rating_high
min_price
number
Required range: x >= 0
max_price
number
Required range: x >= 0

Response

Run completed.

session_id
string

Session identifier for this run.

kind
string

Data source identifier for this endpoint.

keyword
string
max_items
integer
start_page
integer
sort
string
min_price
any
max_price
any
timeout
integer
partial
boolean

True when the scrape stopped early and returned the records collected so far.

human
string

Markdown summary of the result, for display.

machine
object

Structured result payload.

total_points
integer

Points charged for this run.