Sweetwater Product API Documentation Get one public Sweetwater product by the objectID from search or by a product url, absolute or relative. The response has prices, availability, rating breakdown, specs, inline reviews and variants with prices. Specs are name and value pairs; specs and variants are empty when the page publishes none. Prices are numbers in USD, dates use ISO 8601, ids pass unchanged and images are full-size URLs. 72 credits per request. Failed requests are never billed.
Run this endpoint
Endpoint
Parameters
Start with the required fields, then add optional filters only when your use case needs them.
Runnable path
This endpoint has no required query parameters.
2 optional filters available.
string
Optional
objectID from a Sweetwater search result, e.g. SM7B
1234567890
string
Optional
Product url from a Sweetwater search result
https://example.com/product
Response Schema
Example response fields are illustrative; inspect the JSON before integrating.
Example response fields
Scan these fields before integrating.
data
meta
success
{
"data": {
"jsonld": {
"Product": {
"offers": [
{
"price": 399,
"availability": "InStock"
}
],
"productID": "SM7B",
"aggregateRating": {
"ratingValue": 4.8,
"reviewCount": 1234
}
}
},
"product": {
"brand": "Shure",
"price": {
"currency": "USD",
"finalPrice": 399
},
"specs": [
{
"name": "Type",
"value": "Dynamic"
}
],
"rating": {
"count": 1234,
"average": 4.8
},
"objectID": "SM7B",
"description": "Dynamic studio microphone.",
"productName": "Shure SM7B"
},
"variants": [
{
"price": {
"currency": "USD",
"finalPrice": 419
},
"objectID": "SM7B-BLK",
"productName": "Shure SM7B Black"
}
]
},
"meta": {
"credits": 72,
"billable": true,
"endpoint_family": "product_jsonld"
},
"success": true
}
Errors
Handle these documented responses before retrying or showing customer-facing failures.
Validation Error
Supply an id or a url. Failed requests are not billed.
Upstream Blocked
The source refused this request. Failed requests are not billed.
Generate Code with AI
Copy a ready-made prompt with all the endpoint details, parameters, and example responses. Paste it into ChatGPT, Claude, or any AI assistant to instantly generate working code.
Try It Live
Test this endpoint in our interactive playground with real data.