curl --request POST \
--url https://storefront.glood.ai/api/storefront/v3/headless/recommendations \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'x-shop: <x-shop>' \
--data '
{
"client_id": "client-abc",
"user_id": "user-xyz",
"queries": [
{
"id": "rec-1",
"recommendation_type": "similar_products",
"product_ids": [
123,
456
],
"view": "product_ids",
"max_recommendations": 10
}
]
}
'{
"status": "ok",
"serve_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"data": {
"rec-1": {
"recommendation_serve_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"recommendation_type": "similar_products",
"max_recommendations": 10,
"creation_type": "automatic",
"product_ids": [123, 456],
"view": "product_details",
"recommendations": [
{
"product_id": 9311227838783,
"title": "Classic Cotton T-Shirt",
"handle": "classic-cotton-t-shirt",
"price": 1025,
"compare_at_price": null,
"image": {
"id": "gid://shopify/ProductImage/123456",
"url": "https://cdn.shopify.com/s/files/1/example/products/t-shirt.jpg",
"altText": "Classic Cotton T-Shirt",
"width": 1600,
"height": 1600
},
"tags": "cotton,casual,bestseller",
"options": [
{
"id": 123,
"name": "Title",
"position": 1,
"values": ["Default Title"]
}
],
"variants": [
{
"variant_id": 48328566276415,
"title": "Default Title",
"display_name": "Classic Cotton T-Shirt - Default Title",
"price": "1025.00",
"compare_at_price": null,
"sku": "",
"position": 1,
"is_in_stock": true,
"available_for_sale": true,
"sellable_online_quantity": 50,
"selected_options": [
{
"name": "Title",
"value": "Default Title"
}
]
}
],
"metafields": []
}
]
}
}
}
{
"status": "ok",
"serve_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"data": {
"rec-1": {
"recommendation_serve_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"recommendation_type": "similar_products",
"max_recommendations": 10,
"creation_type": "automatic",
"product_ids": [123, 456],
"view": "product_ids",
"recommendations": [
{ "product_id": 9311227838783 },
{ "product_id": 9311227838784 }
]
}
}
}
{
"errors": [
{
"message": "\"product_ids\" is required",
"path": ["queries", 0, "product_ids"],
"type": "any.required",
"context": {
"label": "queries[0].product_ids",
"key": "product_ids"
}
}
]
}
Headless APIs
Get Headless Recommendations using Query
Get AI recommendations including Manual, Rules, LLM & AI using Query.
The product_ids field within each query item accepts either a JSON array of integers (e.g. [123, 456]) or a comma-separated string (e.g. "123,456"). The CSV form is provided for clients whose serializers cannot construct arrays from variables.
POST
/
api
/
storefront
/
v3
/
headless
/
recommendations
curl --request POST \
--url https://storefront.glood.ai/api/storefront/v3/headless/recommendations \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'x-shop: <x-shop>' \
--data '
{
"client_id": "client-abc",
"user_id": "user-xyz",
"queries": [
{
"id": "rec-1",
"recommendation_type": "similar_products",
"product_ids": [
123,
456
],
"view": "product_ids",
"max_recommendations": 10
}
]
}
'{
"status": "ok",
"serve_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"data": {
"rec-1": {
"recommendation_serve_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"recommendation_type": "similar_products",
"max_recommendations": 10,
"creation_type": "automatic",
"product_ids": [123, 456],
"view": "product_details",
"recommendations": [
{
"product_id": 9311227838783,
"title": "Classic Cotton T-Shirt",
"handle": "classic-cotton-t-shirt",
"price": 1025,
"compare_at_price": null,
"image": {
"id": "gid://shopify/ProductImage/123456",
"url": "https://cdn.shopify.com/s/files/1/example/products/t-shirt.jpg",
"altText": "Classic Cotton T-Shirt",
"width": 1600,
"height": 1600
},
"tags": "cotton,casual,bestseller",
"options": [
{
"id": 123,
"name": "Title",
"position": 1,
"values": ["Default Title"]
}
],
"variants": [
{
"variant_id": 48328566276415,
"title": "Default Title",
"display_name": "Classic Cotton T-Shirt - Default Title",
"price": "1025.00",
"compare_at_price": null,
"sku": "",
"position": 1,
"is_in_stock": true,
"available_for_sale": true,
"sellable_online_quantity": 50,
"selected_options": [
{
"name": "Title",
"value": "Default Title"
}
]
}
],
"metafields": []
}
]
}
}
}
{
"status": "ok",
"serve_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"data": {
"rec-1": {
"recommendation_serve_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"recommendation_type": "similar_products",
"max_recommendations": 10,
"creation_type": "automatic",
"product_ids": [123, 456],
"view": "product_ids",
"recommendations": [
{ "product_id": 9311227838783 },
{ "product_id": 9311227838784 }
]
}
}
}
{
"errors": [
{
"message": "\"product_ids\" is required",
"path": ["queries", 0, "product_ids"],
"type": "any.required",
"context": {
"label": "queries[0].product_ids",
"key": "product_ids"
}
}
]
}
{
"status": "ok",
"serve_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"data": {
"rec-1": {
"recommendation_serve_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"recommendation_type": "similar_products",
"max_recommendations": 10,
"creation_type": "automatic",
"product_ids": [123, 456],
"view": "product_details",
"recommendations": [
{
"product_id": 9311227838783,
"title": "Classic Cotton T-Shirt",
"handle": "classic-cotton-t-shirt",
"price": 1025,
"compare_at_price": null,
"image": {
"id": "gid://shopify/ProductImage/123456",
"url": "https://cdn.shopify.com/s/files/1/example/products/t-shirt.jpg",
"altText": "Classic Cotton T-Shirt",
"width": 1600,
"height": 1600
},
"tags": "cotton,casual,bestseller",
"options": [
{
"id": 123,
"name": "Title",
"position": 1,
"values": ["Default Title"]
}
],
"variants": [
{
"variant_id": 48328566276415,
"title": "Default Title",
"display_name": "Classic Cotton T-Shirt - Default Title",
"price": "1025.00",
"compare_at_price": null,
"sku": "",
"position": 1,
"is_in_stock": true,
"available_for_sale": true,
"sellable_online_quantity": 50,
"selected_options": [
{
"name": "Title",
"value": "Default Title"
}
]
}
],
"metafields": []
}
]
}
}
}
{
"status": "ok",
"serve_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"data": {
"rec-1": {
"recommendation_serve_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"recommendation_type": "similar_products",
"max_recommendations": 10,
"creation_type": "automatic",
"product_ids": [123, 456],
"view": "product_ids",
"recommendations": [
{ "product_id": 9311227838783 },
{ "product_id": 9311227838784 }
]
}
}
}
{
"errors": [
{
"message": "\"product_ids\" is required",
"path": ["queries", 0, "product_ids"],
"type": "any.required",
"context": {
"label": "queries[0].product_ids",
"key": "product_ids"
}
}
]
}
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
Was this page helpful?
⌘I