API reference · Walmart

walmart/scrape/product

Integrate this model through SandBase's unified API, with production-ready schemas and examples.

APIAsyncOpen model

Production endpoint

Send your first request

OpenAI-compatible endpoint with unified authentication and usage tracking.

POSThttps://api.sandbase.ai/v1/api/walmart/scrape/product

Model IDwalmart/scrape/product

Input Schema

4 parameters · 1 required · 3 optional

Parameter	Type	Required	Description
`url`	string	Required	Full Walmart page URL, e.g. https://www.walmart.com/ip/HP-14-Laptop/17581855155
`country`	string	Optional	Walmart marketplace country code, e.g. 'us', 'ca', 'mx' (default 'us'). · Min length: 2 · Max length: 2
`storeId`	string	Optional	Walmart store ID for localized inventory. · Min length: 1
`zipCode`	string	Optional	US zip code used to determine local product availability. · Min length: 3

Output Schema

Field	Type	Description
`id`	string	Unique identifier for the generation task
`status`	string	Task status: pending, running, completed, failed, timeout
`model`	string	Model used for the generation
`outputs`	array	Array of output items
`outputs[].url`	string	URL of the generated artifact
`outputs[].content_type`	string	MIME type (e.g. image/png, video/mp4)
`error`	object \| null	Error details if failed, null on success
`error.type`	string	Machine-readable error type code
`error.message`	string	Human-readable error description

Async Workflow

This model uses asynchronous execution. Submit a request and poll for the result.

Submit — POST to /v1/run, receive an id
Poll — GET /v1/run/{id} until status is completed, failed, or timeout
Retrieve — Read outputs from the completed response

Code Examples

Ready-to-run snippets

const apiKey = process.env.SANDBASE_API_KEY;
const response = await fetch("https://api.sandbase.ai/v1/api/walmart/scrape/product", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${apiKey}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({}),
});

if (!response.ok) throw new Error(await response.text());
console.log(await response.json());

← Back to Walmart Product Page