Skip to main content
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_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": []
        }
      ]
    }
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
x-shop
string
required

Shopify store URL

Example:

"shop.myshopify.com"

Body

application/json

Request body

​
queries
object[]
required
​
client_id
string

Client identifier

​
user_id
string

User identifier

​
customer_id
string

Customer identifier

Response

Recommendations response

​
status
enum<string>
required

Response status

Available options:
ok
​
serve_id
string<uuid>
required

Unique identifier for this recommendation serve request

​
data
object
required

Recommendation results keyed by query ID