Endpoint Examples
Get Automatic Recommendations
Get automatic recommendations powered using LLMs
POST
/
api
/
storefront
/
v3
/
headless
/
recommendations
/
automatic
Copy
curl --request POST \
--url https://storefront.glood.ai/api/storefront/v3/headless/recommendations/automatic \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'x-shop: <x-shop>' \
--data '{
"product_ids": [
123
],
"recommendation_type": "similar_products",
"view": "product_details",
"filter": {
"variants": {
"options": [
{
"name": "<string>",
"value": "<string>"
}
],
"is_in_stock": true,
"sku": [
"<string>"
],
"available_for_sale": true
},
"tags": [
"<string>"
],
"vendors": [
"<string>"
],
"metafields": [
{
"namespace": "<string>",
"key": "<string>",
"value": "<string>"
}
]
},
"pagination": {
"cursor": "<string>",
"limit": 25
}
}'
Copy
{
"status": "ok",
"serve_id": "<string>",
"pagination": {
"cursor": "<string>"
},
"products": [
{
"product_id": 123,
"title": "<string>",
"price": 123,
"tags": "<string>",
"product_type": "<string>",
"vendor": "<string>",
"image": {
"id": "<string>",
"url": "<string>",
"height": 123,
"width": 123,
"altText": "<string>"
},
"handle": "<string>",
"compare_at_price": 123,
"options": [
{
"id": 123,
"name": "<string>",
"values": [
"<string>"
],
"position": 123
}
],
"variants": [
{
"variant_id": 123,
"title": "<string>",
"display_name": "<string>",
"position": 123,
"sku": "<string>",
"selected_options": [
{
"name": "<string>",
"value": "<string>"
}
],
"price": "<string>",
"compare_at_price": "<string>"
}
]
}
]
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Headers
Shopify store URL
Example:
"shop.myshopify.com"
Body
application/json
Request body
The body is of type object
.
Response
200
application/json
Recommendations
The response is of type object
.
Was this page helpful?
Copy
curl --request POST \
--url https://storefront.glood.ai/api/storefront/v3/headless/recommendations/automatic \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'x-shop: <x-shop>' \
--data '{
"product_ids": [
123
],
"recommendation_type": "similar_products",
"view": "product_details",
"filter": {
"variants": {
"options": [
{
"name": "<string>",
"value": "<string>"
}
],
"is_in_stock": true,
"sku": [
"<string>"
],
"available_for_sale": true
},
"tags": [
"<string>"
],
"vendors": [
"<string>"
],
"metafields": [
{
"namespace": "<string>",
"key": "<string>",
"value": "<string>"
}
]
},
"pagination": {
"cursor": "<string>",
"limit": 25
}
}'
Copy
{
"status": "ok",
"serve_id": "<string>",
"pagination": {
"cursor": "<string>"
},
"products": [
{
"product_id": 123,
"title": "<string>",
"price": 123,
"tags": "<string>",
"product_type": "<string>",
"vendor": "<string>",
"image": {
"id": "<string>",
"url": "<string>",
"height": 123,
"width": 123,
"altText": "<string>"
},
"handle": "<string>",
"compare_at_price": 123,
"options": [
{
"id": 123,
"name": "<string>",
"values": [
"<string>"
],
"position": 123
}
],
"variants": [
{
"variant_id": 123,
"title": "<string>",
"display_name": "<string>",
"position": 123,
"sku": "<string>",
"selected_options": [
{
"name": "<string>",
"value": "<string>"
}
],
"price": "<string>",
"compare_at_price": "<string>"
}
]
}
]
}
Assistant
Responses are generated using AI and may contain mistakes.