v1
latestOpenAPI 3.1.02026-07-247620.1 KBSearch Catalog
This API route allows a developer application to search the ShopMy catalog or resolve a product URL when building a link creation experience. This route requires the user to permission your app for the write_links scope.
get/Catalog/search
Query parameters
searchstring
Search query for catalog products. Provide exactly one of search or url.
urlstring
Product URL to resolve. Provide exactly one of search or url.
limitinteger
Number of search results to return. Defaults to 20, maximum 50. Applies to search requests.
pageinteger
Zero-indexed page to return for pagination. Defaults to first page (0). Applies to search requests.
Response
200
Example response
{
"success": true,
"results": [
{
"title": "Black Midi Dress",
"image": "https://example.com/image.jpg",
"brand": {
"id": 123,
"name": "Example Brand"
},
"retailers": [
{
"name": "Example Retailer",
"domain": "example.com",
"url": "https://www.example.com/products/black-dress",
"rate": 12.5,
"isDefault": true
}
]
}
],
"pagination": {
"limit": 20,
"totalHits": 142,
"hasMore": true
}
}