Shop.app API endpoint
Searches Shop.app product results. Limit defaults to 20 and accepts values up to 50.
/shop-app/searchSearches Shop.app product results and returns product cards.
Query parameters:
query: required. Search keywords. Example: sneakers.limit: optional integer. Maximum products to return. Default: 20; maximum: 50.in_stock: optional boolean. Request in-stock products. Default: true.on_sale: optional boolean. Request sale products. Default: false.deep_search: optional boolean. Accepted for compatibility. Shop.app no longer offers a separate deep search mode, so this flag does not change the results. Default: false.Notable response behavior:
limit above one feed page is filled by following the feed's cursor.groups and each product's group_title are returned only when Shop.app supplies expanded product groups. Its current search feed does not, so they are normally absent.200 [].| Field | Filled in, of 20 checked | Values in the sample |
|---|---|---|
| id | 20 | |
| variant_id | 20 | |
| title | 20 | “Crossover™ Victory Trainer” and 19 other values |
| url | 20 | wolfandshepherd.com and 10 other hosts |
| shop_id | 20 | |
| shop_name | 20 | “Wolf & Shepherd” and 10 other values |
| price | 20 | 75 to 257, median 135 |
| currency | 20 | USD in all 20 |
| image | 20 | cdn.shopify.com |
| image_alt | 10 | “khaki / honey” and 9 other values |
| position | 20 | 1 to 20, median 10 |
| original_price | 5 | 75 to 399.99, median 150 |
| on_sale | 3 | true in 3 of 3 |
| Parameter | Type | Required | Default | Description | Example |
|---|---|---|---|---|---|
| query | string | Yes | Search query | sneakers | |
| limit | integer | No | 20 and supports up to 50 | Maximum products, defaults to 20 and supports up to 50 | 20 |
| in_stock | boolean | No | Request in-stock products | true | |
| on_sale | boolean | No | Request sale products | false | |
| deep_search | boolean | No | Accepted for compatibility; Shop.app no longer offers a separate deep search mode, so results are unchanged | false | |
| x-api-key (header) | string | Yes | API key required |
curl -X GET "https://api.crawlora.net/api/v1/shop-app/search?query=sneakers&limit=10&in_stock=true&on_sale=true&deep_search=true" \ -H "x-api-key: $CRAWLORA_API_KEY"
{
"code": 200,
"msg": "OK",
"data": {
"query": "sneakers",
"limit": 5,
"products": [
{
"id": "8075903107261",
"variant_id": "46242960965821",
"title": "Black/Black/Gum BILLY Sport Inclusion DZ1",
"url": "https://billyfootwear.com/products/black-black-gum-billy-sport-inclusion-dz1-zipper-shoes?utm_source=shop_app",
"shop_id": "62696",
"shop_name": "BILLY Footwear",
"price": 100,
"currency": "USD",
"position": 1
}
]
}
}Request schema
No body schema
Response schema
#/definitions/shopapp.searchResponseDoc
| Field | Type | Required | Enum | Bounds | Example | Description |
|---|---|---|---|---|---|---|
| code | integer | No | 200 | |||
| data | shopapp.SearchResponse | No | ||||
| data.groups | array | No | Groups of related products. Returned only when Shop.app supplies them. | |||
| data.groups[].product_ids | array | No | IDs of the products in the group. | |||
| data.groups[].products_seen | integer | No | 4 | Number of products seen in the group. | ||
| data.groups[].query | string | No | men's running sneakers | Search query that defines the group. | ||
| data.groups[].title | string | No | men's running sneakers | Group heading, for example `men's running sneakers`. | ||
| data.limit | integer | No | 20 | Maximum number of products requested. | ||
| data.products | array | No | Products matching the query, in Shop.app ranking order. | |||
| data.products[].currency | string | No | USD | Currency code of `price` and `original_price`. | ||
| data.products[].group_query | string | No | kids' athletic sneakers | Search query of the product group this item belongs to. | ||
| data.products[].group_title | string | No | kids' athletic sneakers | Title of the product group this item belongs to. | ||
| data.products[].id | string | No | 8075903107261 | Shop.app product ID. | ||
| data.products[].image | string | No | https://cdn.shopify.com/s/files/1/1145/5784/files/example.jpg | URL of the product's first image. | ||
| data.products[].image_alt | string | No | Black sneaker side view | Alt text of the product's first image. | ||
| data.products[].on_sale | boolean | No | `true` when the original price is higher than the current price. | |||
| data.products[].original_price | number | No | 120 | Price before the discount, in `currency`. | ||
| data.products[].position | integer | No | 1 | Position of the product in the results, starting at 1. | ||
| data.products[].price | number | No | 100 | Current price of the product, in `currency`. | ||
| data.products[].shop_id | string | No | 62696 | Shop.app ID of the shop selling the product. | ||
| data.products[].shop_name | string | No | BILLY Footwear | Name of the shop selling the product. | ||
| data.products[].title | string | No | Black/Black/Gum BILLY Sport Inclusion DZ1 | Product title as shown on the Shop.app card. | ||
| data.products[].url | string | No | https://billyfootwear.com/products/black-black-gum-billy-sport-inclusion-dz1-zipper-shoes?utm_source=shop_app | Link to the product page. | ||
| data.products[].variant_id | string | No | 46242960965821 | ID of the product variant shown on the card. | ||
| data.query | string | No | sneakers | Search query that was run. | ||
| msg | string | No | OK |
| Status | Description | Schema |
|---|---|---|
| 400 | Bad Request | #/definitions/app.Response |
| 429 | Too Many Requests | #/definitions/app.Response |
| 503 | Service Unavailable | #/definitions/app.Response |
Use environment variables for secrets and keep Crawlora API keys server-side.
curl -X GET "https://api.crawlora.net/api/v1/shop-app/search?query=sneakers&limit=10&in_stock=true&on_sale=true&deep_search=true" \
-H "x-api-key: $CRAWLORA_API_KEY"