Shop.app API endpoint
Lists products related to a Shop.app product, by `id`. `limit` defaults to 20 and is capped at 50. Each card has the product's id, title, price, original price, currency, `on_sale` flag, image, shop name and URL. A product page with no related items returns an error.
/shop-app/products/{id}/relatedPath parameters:
id: required. Shop.app product id. Example: 4596217053229.Query parameters:
limit: optional integer. Maximum products to return. Default: 20; maximum: 50.Notable response behavior:
| Field | Filled in, of 20 checked | Values in the sample |
|---|---|---|
| id | 20 | |
| variant_id | 20 | |
| title | 20 | “Men's Wide Fit New Balance MX608BB5 (New 624) Walking/Runni…” and 19 other values |
| url | 20 | widefitshoes.co.uk |
| shop_id | 20 | |
| shop_name | 20 | Wide Fit Shoes UK in all 20 |
| price | 20 | 5 to 257, median 177 |
| original_price | 12 | 161 to 321, median 209 |
| currency | 20 | CAD in all 20 |
| image | 20 | cdn.shopify.com |
| image_alt | 20 | “Women's Wide Fit New Balance MX608 (New 624) Running Traine…” and 18 other values |
| position | 20 | 1 to 20, median 10 |
| group_title | 20 | related in all 20 |
| on_sale | 10 | true in 10 of 10 |
| Parameter | Type | Required | Default | Description | Example |
|---|---|---|---|---|---|
| id (path) | string | Yes | Product id | 4596217053229 | |
| limit | integer | No | 20 and supports up to 50 | Maximum products, defaults to 20 and supports up to 50 | 20 |
| x-api-key (header) | string | Yes | API key required |
curl -X GET "https://api.crawlora.net/api/v1/shop-app/products/4596217053229/related?limit=10" \ -H "x-api-key: $CRAWLORA_API_KEY"
{
"code": 200,
"msg": "OK",
"data": {
"product_id": "4596217053229",
"products": [
{
"id": "5176966185005",
"title": "Womens Wide Fit New Balance",
"position": 1
}
]
}
}Request schema
No body schema
Response schema
#/definitions/shopapp.relatedResponseDoc
| Field | Type | Required | Enum | Bounds | Example | Description |
|---|---|---|---|---|---|---|
| code | integer | No | 200 | |||
| data | shopapp.RelatedResponse | No | ||||
| data.limit | integer | No | 20 | Maximum number of related products requested. | ||
| data.product_id | string | No | 4596217053229 | Shop.app ID of the product the results relate to. | ||
| data.products | array | No | Products related to the requested product. | |||
| 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. | ||
| 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/products/4596217053229/related?limit=10" \
-H "x-api-key: $CRAWLORA_API_KEY"