Endpoint Playground

Try the Search Shop.app products API

Test Crawlora's Search Shop.app products API with realistic prefilled parameters. Generate a cURL request, inspect the expected structured JSON response, and open the full docs or pricing page when you are ready to integrate this public web data extraction endpoint into your application.

Endpoint facts

Method: GET
API path: /shop-app/search
Platform: Shop.app
Auth: apiKey
Credits: 5 credits/request
Required params: query
Common optional params: limit, in_stock, on_sale, deep_search

Search Shop.app products API documentation Shop.app platform page Crawlora API pricing Try Analyze Shop.app query results API Try List Shop.app categories API Try Get Shop.app product API Try List Shop.app related products API Try List Shop.app product reviews API

Prefilled cURL

curl "https://api.crawlora.net/api/v1/shop-app/search?query=sneakers&limit=10&in_stock=true&on_sale=false&deep_search=false" \
  -H "x-api-key: $CRAWLORA_API_KEY"

Request parameters visible to crawlers

Parameter	Type	Required	Prefilled value	Description
query	string	Yes	sneakers	Search query
limit	integer	No	10	Maximum products, defaults to 20 and supports up to 50
in_stock	boolean	No	true	Request in-stock products
on_sale	boolean	No	false	Request sale products
deep_search	boolean	No	false	Enable Shop.app deep search mode

Example JSON response

{
  "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,
        "group_title": "kids' athletic sneakers"
      }
    ],
    "groups": [
      {
        "title": "kids' athletic sneakers",
        "query": "kids' athletic sneakers",
        "products_seen": 1
      }
    ]
  }
}

Public Playground

Preview the endpoint before sending a live request

Sample responses, schemas, request previews, and code snippets are visible before sign in. Create an account when you are ready to save an API key and run authenticated requests.

Set up API key Endpoint docs

Endpoint

Choose one catalog endpoint for this request.

16 shown

Group

Method

Auth

Endpoint

GETapiKey5 credits/requestshopapp.searchResponseDocShop.app

GET /shop-app/search

Search Shop.app products

Searches Shop.app product results using the credential-free public web search flow. Limit defaults to 20 and accepts values up to 50.

API key required. Paste a full key or rotate one from the API Keys page.

Set up API key

View docs

API key

API key required for live requests. Your key is only used to send requests from this Playground.

not configured

Active Playground key: not configured

Manage API keys in Console

Required query parameters

query

requiredstring

Search query

Add an API key to send a live request.

If an active API key is configured, Copy cURL includes it. Share links never include API keys.

View docs

Sample responseGET

Shown before your first request. Add an API key and send a request to see the live response, status, latency, and headers.

{
  "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,
        "group_title": "kids' athletic sneakers"
      }
    ],
    "groups": [
      {
        "title": "kids' athletic sneakers",
        "query": "kids' athletic sneakers",
        "products_seen": 1
      }
    ]
  }
}

Endpoint details

Searches Shop.app product results using the credential-free public web search flow. Limit defaults to 20 and accepts values up to 50.

Method: GET
Path: /shop-app/search
Authentication: apiKey
Credit cost: 5 credits/request
Platform: Shop.app
Parameters: 6 documented fields

Request parameters

query:querylimit:queryin_stock:queryon_sale:querydeep_search:queryx-api-key:header

Response schema fields

codedatadata.groupsdata.groups[].product_idsdata.groups[].products_seendata.groups[].querydata.groups[].titledata.limitdata.productsdata.products[].currencydata.products[].group_querydata.products[].group_title

Sample response summary

{
  "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,
        "group_title": "kids' athletic sneakers"
      }
    ],
    "groups": [
      {
        "title": "kids' athletic sneakers",
        "query": "kids' athletic sneakers",
        "products_seen": 1
      }
    ]
  }
}

cURL example

curl "https://api.crawlora.net/api/v1/shop-app/search?query=<query>" \
  -H "x-api-key: $CRAWLORA_API_KEY"

View endpoint docs Open platform page Browse all endpoints Pricing Analyze Shop.app query results List Shop.app categories Get Shop.app product List Shop.app related products List Shop.app product reviews

Try the Search Shop.app products API

Request parameters visible to crawlers

Parameter	Type	Required	Prefilled value	Description
query	string	Yes	sneakers	Search query
limit	integer	No	10	Maximum products, defaults to 20 and supports up to 50
in_stock	boolean	No	true	Request in-stock products
on_sale	boolean	No	false	Request sale products
deep_search	boolean	No	false	Enable Shop.app deep search mode

Example JSON response

{
  "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,
        "group_title": "kids' athletic sneakers"
      }
    ],
    "groups": [
      {
        "title": "kids' athletic sneakers",
        "query": "kids' athletic sneakers",
        "products_seen": 1
      }
    ]
  }
}

{ "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, "group_title": "kids' athletic sneakers" } ], "groups": [ { "title": "kids' athletic sneakers", "query": "kids' athletic sneakers", "products_seen": 1 } ] } }

Endpoint details

Searches Shop.app product results using the credential-free public web search flow. Limit defaults to 20 and accepts values up to 50.

Method: GET
Path: /shop-app/search
Authentication: apiKey
Credit cost: 5 credits/request
Platform: Shop.app
Parameters: 6 documented fields

Request parameters

query:querylimit:queryin_stock:queryon_sale:querydeep_search:queryx-api-key:header

Response schema fields

Sample response summary

{
  "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,
        "group_title": "kids' athletic sneakers"
      }
    ],
    "groups": [
      {
        "title": "kids' athletic sneakers",
        "query": "kids' athletic sneakers",
        "products_seen": 1
      }
    ]
  }
}

cURL example

curl "https://api.crawlora.net/api/v1/shop-app/search?query=<query>" \
  -H "x-api-key: $CRAWLORA_API_KEY"