Walmart API
Walmart offers
Every seller offering a Walmart item: seller, price, stock, condition, shipping and pickup, return policy.
Endpoint
/v1/walmart/offerslive · proven2 creditsParameters
Query parameters
| Name | Required | Description | Example |
|---|---|---|---|
product_id | yes | A Walmart item id or product URL | 609040889 |
country | no | us or ca | us |
dry_run | no | Read a zero-credit estimate without fetching sources, running AI, or reserving credits. Cache status is a snapshot, not a guarantee at execution. | 1 |
Examples
Make the request
curl "https://www.monocrawl.com/v1/walmart/offers?product_id=609040889" \ -H "x-api-key: mn_your_key_here"
TypeScript
const key = process.env.MONOCRAWL_API_KEY;
if (!key) throw new Error('Set MONOCRAWL_API_KEY on your server.');
const res = await fetch(
"https://www.monocrawl.com/v1/walmart/offers?product_id=609040889",
{ headers: { "x-api-key": key } },
);
const body = await res.json();
if (!body.success) {
// one error shape for every endpoint — see /docs/errors
throw new Error(`${body.error.type}: ${body.error.message}`);
}
console.log(body.data, "credits left:", body.credits_remaining);Python
import os
import requests
res = requests.get(
"https://www.monocrawl.com/v1/walmart/offers?product_id=609040889",
headers={"x-api-key": os.environ["MONOCRAWL_API_KEY"]},
timeout=60,
)
body = res.json()
if not body["success"]:
# one error shape for every endpoint — see /docs/errors
raise RuntimeError(f"{body['error']['type']}: {body['error']['message']}")
print(body["data"], "credits left:", body["credits_remaining"])Response
Response fields and example
This example is illustrative, not a captured live response. Variable-cost operations may settle a charge different from the list price below. A successful response puts the platform payload in data and reports the exact credits used, remaining balance, request id and cache status beside it.
{
"success": true,
"platform": "walmart",
"endpoint": "/v1/walmart/offers",
"data": {
"count": 0,
"has_more": false,
"items": [
{
"availability": "example",
"condition": "example",
"currency": "example",
"free_shipping": false,
"fulfilled_by_walmart": false,
"in_stock": false,
"offer_id": "example",
"offer_type": "example",
"pickup_available": false,
"position": 0,
"price": 0,
"price_display": "example",
"return_policy": "example",
"seller": "example",
"seller_id": "example",
"seller_type": "example",
"storefront_url": "https://example.com/example"
}
],
"product_id": "example",
"title": "example",
"total_offers": 0,
"url": "https://example.com/example"
},
"credits_used": 2,
"credits_remaining": 99,
"request_id": "req_…",
"cached": false
}The example is illustrative and shows a documented subset of data. The fields below are optional across supported sources; nullable fields can also be absent. Preserve unknown values and accept additional fields.
Schema basis: observed response shapes, not an exhaustive field specification. See schema coverage and validation limits.
Download the data JSON Schema. Validate response.data, not the whole envelope. A valid shape does not establish that every field or source record was returned.
| Field inside data | Type | Meaning |
|---|---|---|
count | number | null | Number of records in this response, not lifetime or total matches. |
has_more | boolean | null | Source continuation indicator; null means unknown. |
items | array | null | Returned records. Source coverage and completeness vary. |
items[].availability | string | null | Optional availability supplied by this operation. Null means unknown. |
items[].condition | string | null | Optional condition supplied by this operation. Null means unknown. |
items[].currency | string | null | Optional currency supplied by this operation. Null means unknown. |
items[].free_shipping | boolean | null | Optional free shipping supplied by this operation. Null means unknown. |
items[].fulfilled_by_walmart | boolean | null | Optional fulfilled by walmart supplied by this operation. Null means unknown. |
items[].in_stock | boolean | null | Optional in stock supplied by this operation. Null means unknown. |
items[].offer_id | string | null | Optional offer id supplied by this operation. Null means unknown. |
items[].offer_type | string | null | Optional offer type supplied by this operation. Null means unknown. |
items[].pickup_available | boolean | null | Optional pickup available supplied by this operation. Null means unknown. |
items[].position | number | null | Optional position supplied by this operation. Null means unknown. |
items[].price | number | null | Source price. Currency, taxes and availability depend on the listing. |
items[].price_display | string | null | Optional price display supplied by this operation. Null means unknown. |
items[].return_policy | string | null | Optional return policy supplied by this operation. Null means unknown. |
items[].seller | string | null | Optional seller supplied by this operation. Null means unknown. |
items[].seller_id | string | null | Optional seller id supplied by this operation. Null means unknown. |
items[].seller_type | string | null | Optional seller type supplied by this operation. Null means unknown. |
items[].storefront_url | string | null | Optional storefront url supplied by this operation. Null means unknown. |
product_id | string | null | Optional product id supplied by this operation. Null means unknown. |
title | string | null | Source title when supplied. |
total_offers | number | null | Optional total offers supplied by this operation. Null means unknown. |
url | string | null | Original source URL when supplied. |
Optional fields reviewed from preserved successful responses. Additive fields and source variations remain allowed; validate the fields your workflow requires.
The example is invented and illustrates types only; zero and empty values are not claims about a real result.
Failures use the typed error envelope. A confirmed uncharged or refunded failure reports zero; a pending reconciliation can report an unknown charge. Read credits_used and error.details.billing_status, and keep request_id for recovery. Response contract · Error reference