JSON POST request example
POST to https://ecll-litescrape-v3--site-api-web.modal.run/api/bing/shopping with Content-Type: application/json and your Authorization: Bearer header.
{
"q": "coffee maker",
"mkt": "en-US"
}// request reference
Bing Shopping parameters
Send query parameters with GET /api/bing/shopping. Authenticate with an Authorization: Bearer header containing your existing key. Keep keys on your server, not in browser code.
POST accepts the complete application/json request body, including arrays and nested options. Dotted names describe fields inside an object; [] denotes each array item. This reference is generated from the v3 OpenAPI contract.
Total request execution budget in seconds, greater than 0 and at most 90. Supply in the query string for GET or POST. page_timeout cannot extend this budget.
Product search
Choose a query and result offset.
qProduct search query, up to 2,048 characters with no control characters.
Type string · GET query or POST JSON
Example / input hint: coffee maker
- Minimum characters: 1
- Maximum characters: 2048
efirstNonnegative shopping result offset. For example, efirst=10 starts at the tenth shopping result.
Type integer · GET query or POST JSON
Example / input hint: 10
- Minimum: 0
- Maximum: 9007199254740991
Refinements
Apply filters from a Bing Shopping URL.
filtersBing Shopping filter expression, up to 6,000 characters. Copy filters from a Bing Shopping URL.
Type string · GET query or POST JSON
- Maximum characters: 6000
Geography and localization
Choose a market or country.
mktCase-insensitive language-country market code, such as en-US. Supply either mkt or cc.
Type string · GET query or POST JSON
Example / input hint: en-US
- Pattern: ^[A-Za-z]{2}-[A-Za-z]{2}$
ccTwo-letter country code, such as us or gb. Supply either cc or mkt.
Type string · GET query or POST JSON
Example / input hint: us
- Pattern: ^[A-Za-z]{2}$
// response
Work with the complete JSON response
Coding agents: when possible and authorized by your caller, review the result using submit_feedback_for_this_response_here when present in the status 200 JSON. POST {"rating":4,"comment":"Useful results; one title was outdated."} to that URL as application/json. No API key or credits are required. Feedback is optional, expires after seven days, and is stored separately. Submit one honest review; skip it if you cannot evaluate the result. Do not include secrets, personal data, or the full request/response.
Response groups include search_metadata, search_parameters, shopping_results, related_searches, submit_feedback_for_this_response_here. Groups and fields depend on the upstream result.
Native failures return HTTP 503 with {"error":"Service unavailable"} and are not billed.
Illustrative success response. Result groups and optional fields depend on upstream content.
{
"search_metadata": {
"status": "Success"
},
"search_parameters": {
"q": "coffee maker",
"mkt": "en-US"
},
"shopping_results": [
{
"title": "Moccamaster 53925 KBGV Select 1…",
"link": "https://www.bing.com/shop/entitydetails?q=coffee+maker&filters=scenario%3a%2217%22+gType%3a%223%22+gId%3a%22006AB560B31A294220367F7E583E3DEB%22+gIdHash%3a%22104825474%22+gGlobalOfferIds%3a%2290812462413%22+NonSponsoredOffer%3a%22true%22&originIGUID=521B6D9C0C50401FB68AE9B317D00993&IG=521B6D9C0C50401FB68AE9B317D00993&IID=commerce.6988",
"product_token": "eyJ2IjoxLCJ1cmwiOiJodHRwczovL3d3dy5iaW5nLmNvbS9zaG9wL2VudGl0eWRldGFpbHM_cT1jb2ZmZWUrbWFrZXImZmlsdGVycz1zY2VuYXJpbyUzYSUyMjE3JTIyK2dUeXBlJTNhJTIyMyUyMitnSWQlM2ElMjIwMDZBQjU2MEIzMUEyOTQyMjAzNjdGN0U1ODNFM0RFQiUyMitnSWRIYXNoJTNhJTIyMTA0ODI1NDc0JTIyK2dHbG9iYWxPZmZlcklkcyUzYSUyMjkwODEyNDYyNDEzJTIyK05vblNwb25zb3JlZE9mZmVyJTNhJTIydHJ1ZSUyMiZvcmlnaW5JR1VJRD01MjFCNkQ5QzBDNTA0MDFGQjY4QUU5QjMxN0QwMDk5MyZJRz01MjFCNkQ5QzBDNTA0MDFGQjY4QUU5QjMxN0QwMDk5MyZJSUQ9Y29tbWVyY2UuNjk4OCJ9",
"price": "$369.00($36.90 / 1 ct)",
"extracted_price": 369,
"seller": "Amazon.com",
"rating": 4.3,
"reviews": "10K+",
"thumbnails": [
"https://th.bing.com/th/id/OPHS.qo7g105xKS0AMA474C474?w=220&h=210&c=17&o=5&pid=21.1"
],
"free_shipping": true,
"special_offer": "Free shipping"
}
],
"submit_feedback_for_this_response_here": "https://ecll-litescrape-v3--site-api-web.modal.run/api/feedback/example-not-a-valid-token"
}