Shop.app API endpoint
Returns a Shop.app merchant profile by shop `handle`: name, description, logo, banner, rating, review count, storefront and Shop.app URLs, and collection summaries when the shop page lists them. Unknown handles return an error.
/shop-app/shops/{handle}Path parameters:
handle: required. Shop.app shop handle. Example: marcnolan.Query parameters: none.
Notable response behavior:
| Field | Filled in, of 4 checked | Values in the sample |
|---|---|---|
| id | 4 | |
| title | 4 | “Men's Loafers & Mules” and 3 other values |
| slug | 4 | |
| url | 4 | shop.app |
| Parameter | Type | Required | Default | Description | Example |
|---|---|---|---|---|---|
| handle (path) | string | Yes | Shop handle | marcnolan | |
| x-api-key (header) | string | Yes | API key required |
curl -X GET "https://api.crawlora.net/api/v1/shop-app/shops/marcnolan" \ -H "x-api-key: $CRAWLORA_API_KEY"
{
"code": 200,
"msg": "OK",
"data": {
"shop": {
"handle": "marcnolan",
"name": "Marc Nolan",
"rating": 4.7
}
}
}Request schema
No body schema
Response schema
#/definitions/shopapp.shopResponseDoc
| Field | Type | Required | Enum | Bounds | Example | Description |
|---|---|---|---|---|---|---|
| code | integer | No | 200 | |||
| data | shopapp.ShopResponse | No | ||||
| data.shop | object | No | Details of the shop. | |||
| data.shop.banner | string | No | URL of the shop's banner image. | |||
| data.shop.collections | array | No | Collections found on the shop's page. | |||
| data.shop.collections[].id | string | No | 292518002767 | Shop.app collection ID. | ||
| data.shop.collections[].slug | string | No | mens-dress-shoes | URL slug of the collection. | ||
| data.shop.collections[].title | string | No | Mens Dress Shoes | Collection title, for example `Mens Dress Shoes`. | ||
| data.shop.collections[].url | string | No | Shop.app page URL of the collection. | |||
| data.shop.description | string | No | Description of the shop. | |||
| data.shop.handle | string | No | marcnolan | Shop.app handle of the shop, as used in its page URL. | ||
| data.shop.id | string | No | 186720 | Shop.app shop ID. | ||
| data.shop.logo | string | No | URL of the shop's logo. | |||
| data.shop.name | string | No | Marc Nolan | Name of the shop. | ||
| data.shop.rating | number | No | 4.7 | Average shopper rating of the shop. | ||
| data.shop.reviews_count | integer | No | 19699 | Number of shopper ratings or reviews of the shop. | ||
| data.shop.shopify_id | string | No | Shopify ID of the shop. | |||
| data.shop.storefront | string | No | URL of the shop's own website. | |||
| data.shop.url | string | No | Shop.app page URL of the shop. | |||
| data.shop.uuid | string | No | UUID of the shop. | |||
| msg | string | No | OK |
| Status | Description | Schema |
|---|---|---|
| 400 | Bad Request | #/definitions/app.Response |
| 404 | Not Found | #/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/shops/marcnolan" \
-H "x-api-key: $CRAWLORA_API_KEY"