---
title: "Search Shop.app products"
method: GET
path: "/shop-app/search"
tags: ["Shop.app"]
---

# Search Shop.app products

`GET /shop-app/search`

## Request

- Base URL: `https://api.crawlora.net/api/v1`
- URL: `https://api.crawlora.net/api/v1/shop-app/search`
- Auth: API key in header `x-api-key`

Searches Shop.app product results. Limit defaults to 20 and accepts values up to 50.

## Query parameters

- `query` string, required
- `limit` integer
- `in_stock` boolean
- `on_sale` boolean
- `deep_search` boolean

## Headers

- `x-api-key` string, required

## Response `200`

OK

- ShopappSearchResponseDoc
  - `code` integer
  - `data` ShopappSearchResponse
    - `groups` ShopappSearchGroup[]: Groups of related products. Returned only when Shop.app supplies them.
      - `product_ids` string[]: IDs of the products in the group.
      - `products_seen` integer: Number of products seen in the group.
      - `query` string: Search query that defines the group.
      - `title` string: Group heading, for example `men's running sneakers`.
    - `limit` integer: Maximum number of products requested.
    - `products` ShopappProductItem[]: Products matching the query, in Shop.app ranking order.
      - `currency` string: Currency code of `price` and `original_price`.
      - `group_query` string: Search query of the product group this item belongs to.
      - `group_title` string: Title of the product group this item belongs to.
      - `id` string: Shop.app product ID.
      - `image` string: URL of the product's first image.
      - `image_alt` string: Alt text of the product's first image.
      - `on_sale` boolean: `true` when the original price is higher than the current price.
      - `original_price` number: Price before the discount, in `currency`.
      - `position` integer: Position of the product in the results, starting at 1.
      - `price` number: Current price of the product, in `currency`.
      - `shop_id` string: Shop.app ID of the shop selling the product.
      - `shop_name` string: Name of the shop selling the product.
      - `title` string: Product title as shown on the Shop.app card.
      - `url` string: Link to the product page.
      - `variant_id` string: ID of the product variant shown on the card.
    - `query` string: Search query that was run.
  - `msg` string

## Other responses

- `400`: Bad Request
- `429`: Too Many Requests
- `503`: Service Unavailable

---

[API](https://skmtc.dev/crawlora/apis/crawlora-api.md) · [All operations](https://skmtc.dev/crawlora/apis/crawlora-api/llms.txt) · [OpenAPI document](https://skmtc.dev/crawlora/apis/crawlora-api/revisions/afac9b012a27?raw)