---
title: "Search Catalog"
method: GET
path: "/Catalog/search"
---

# Search Catalog

`GET /Catalog/search`

## Request

- Base URL: `https://api.shopmy.us/v1/Partners`
- URL: `https://api.shopmy.us/v1/Partners/Catalog/search`
- Auth: API key in header `Authorization`

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.

## Query parameters

- `search` string
- `url` string
- `limit` integer
- `page` integer

## Response `200`

200

- object
  - `success` boolean, required
  - `results` CatalogResult[], required
    - `title` string, nullable, required
    - `image` string, nullable, required
    - `brand` object, required
      - `id` integer, nullable
      - `name` string, nullable
    - `retailers` object[], required
      - `name` string, required
      - `domain` string, required
      - `url` string, required
      - `rate` number, float, required
      - `isDefault` boolean, required
  - `pagination` Pagination, required
    - `page` integer, required
    - `limit` integer, required
    - `totalHits` integer, required
    - `hasMore` boolean, required

## Other responses

- `400`: 400
- `401`: 401

---

[API](https://skmtc.dev/shopmy/apis/shopmy-for-developers.md) - [All operations](https://skmtc.dev/shopmy/apis/shopmy-for-developers/llms.txt) - [OpenAPI document](https://skmtc.dev/shopmy/apis/shopmy-for-developers/revisions/9beecb9e11f7?raw)
