Skip to main content
POST
/
api
/
storefront
/
v3
/
headless
/
recommendations
/
automatic
cURL
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
  }
}
'
{
  "status": "ok",
  "serve_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "pagination": {
    "cursor": null
  },
  "products": [
    {
      "product_id": 9311227838783,
      "title": "Classic Cotton T-Shirt",
      "handle": "classic-cotton-t-shirt",
      "price": 1025,
      "compare_at_price": null,
      "tags": "cotton,casual,bestseller",
      "product_type": "T-Shirts",
      "vendor": "BrandName",
      "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
      },
      "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": []
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.glood.ai/llms.txt

Use this file to discover all available pages before exploring further.

{
  "status": "ok",
  "serve_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "pagination": {
    "cursor": null
  },
  "products": [
    {
      "product_id": 9311227838783,
      "title": "Classic Cotton T-Shirt",
      "handle": "classic-cotton-t-shirt",
      "price": 1025,
      "compare_at_price": null,
      "tags": "cotton,casual,bestseller",
      "product_type": "T-Shirts",
      "vendor": "BrandName",
      "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
      },
      "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

​
product_ids
integer[]
required

List of product IDs to get recommendations for

​
recommendation_type
enum<string>
required

Type of recommendations to retrieve

Available options:
similar_products
​
view
enum<string>
required

Context where recommendations will be displayed

Available options:
product_details,
product_ids
​
filter
object
​
pagination
object

Response

Recommendations

​
status
enum<string>

Status of the response

Available options:
ok
​
serve_id
string

Unique identifier for this recommendation serve

​
pagination
object
​
products
object[]