Skip to content
Docs
Shopify

Shopify recommendations

The store's own related products for one handle. A result keeps at most 100 variants and 25 images per product. variants_omitted and images_omitted count what was left off. An unknown handle is 404. A variants value that is not a list on that product is 503 and is not billed. An empty recommendation list is not billed.

POST/v1/retail/shopify/products/recommendations
2 creditsTry it2 (an empty list, an unknown handle and failed requests are free)

Request

POSThttps://api.scrapercompany.com/v1/retail/shopify/products/recommendations

Authenticate with your API key in the x-api-key header (see Authentication).

Run this request on your own API key from this page, with the values you type. Signed out? Sign in or get an API key.

Body

JSON object. Unknown fields are rejected with 422.

  • storestringrequiredmin length 1, max length 300

    Public store address, a domain or an https URL (allbirds.com).

  • marketstring | null

    Market code echoed on the answer. It does not change the currency the store publishes.

  • localestring | null

    Locale path prefix the store publishes, such as en or en-ca.

  • handlestringrequiredmin length 1, max length 300

    Product handle, or a product URL on this store.

Example request

curl -X POST "https://api.scrapercompany.com/v1/retail/shopify/products/recommendations" \
  -H "x-api-key: $SCRAPERCOMPANY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "handle": "tb0a2pdqamx1",
    "store": "kith.com"
  }'

Response

200 — Products the store recommends alongside one product. Metered responses carry x-credits-charged and x-credits-remaining headers (see credit headers).

200 response
{
  "store": "kith.com",
  "fetched_at": "2026-10-24T15:04:00Z",
  "request_id": "req_0123456789abcdef0123456789abcdef",
  "currency": "USD",
  "intent": "related",
  "products": [
    {
      "id": 7340901859408,
      "title": "Women's Allbirds Flip Flop - Dusty Pink",
      "handle": "womens-allbirds-flip-flop-dusty-pink",
      "url": "https://www.allbirds.com/products/womens-allbirds-flip-flop-dusty-pink",
      "vendor": "Allbirds",
      "product_type": "Shoes",
      "tags": [
        "allbirds::edition => limited"
      ],
      "body": "Light flip flops.",
      "available": false,
      "low_stock": false,
      "price": {
        "min": {
          "amount": "25.00",
          "amount_minor": 2500,
          "currency": "USD"
        },
        "max": {
          "amount": "25.00",
          "amount_minor": 2500,
          "currency": "USD"
        }
      },
      "compare_at_price": {
        "min": {
          "amount": "50.00",
          "amount_minor": 5000,
          "currency": "USD"
        },
        "max": {
          "amount": "50.00",
          "amount_minor": 5000,
          "currency": "USD"
        }
      },
      "on_sale": true,
      "discount_percent": 50,
      "images": [
        {
          "url": "https://cdn.shopify.com/s/files/1/1104/4168/files/flip.png",
          "width": 4000,
          "height": 4000
        }
      ],
      "options": [
        {
          "name": "Size",
          "values": [
            "5",
            "6"
          ]
        }
      ],
      "variants": [
        {
          "id": 42146889039952,
          "title": "5",
          "sku": "A12513W050",
          "available": false,
          "price": {
            "amount": "25.00",
            "amount_minor": 2500,
            "currency": "USD"
          },
          "compare_at_price": {
            "amount": "50.00",
            "amount_minor": 5000,
            "currency": "USD"
          },
          "quantity": 0,
          "low_stock": false,
          "requires_shipping": true,
          "option1": "5",
          "grams": 455
        }
      ],
      "selling_plans": [],
      "published_at": "2026-09-25T16:58:13-07:00"
    }
  ]
}

Errors

Errors return a JSON body with a detail field. Failed requests are not charged. See Errors for the full list and retry advice.

StatusMeaningRetry?
401Unauthorized

Missing or invalid API key.

{"detail":"missing or invalid API key"}		No, fix the request
402Payment Required

Not enough credits for this request: the account's credits mode is enforce (mode in GET /v1/billing) and the request costs more than the available credits. Nothing is run or charged.

{"detail":"insufficient credits: this request costs 5, 0 available. Credits renew 2026-11-01."}		No, fix the request
404Not Found

The property, stay, job or record was not found.

{"detail":"job not found"}		No, fix the request
422Unprocessable Content

Request validation failed. detail is a list of problems for schema errors, or a string for semantic checks performed by the endpoint.

{"detail":[{"loc":["body","name"],"msg":"Field required","type":"missing"}]}		No, fix the request
429Too Many Requests

Too many requests: the key's requests-per-minute limit was exceeded, or (in enforce credits mode) the plan's concurrent-request limit. No rate-limit or Retry-After headers are sent; back off and retry.

{"detail":"rate limit 60/min exceeded"}		Yes, with backoff
503Service Unavailable

Temporarily unavailable: a dependency of this endpoint is down, or the upstream source changed its contract. Retry later.

{"detail":"database unavailable: OperationalError"}		Yes, with backoff

Try it

Press Try it above to run this request on your own key, with the values you type (sign in first). For a no-code walkthrough, use the workspace’s guided Try it.

  1. Export your key: export SCRAPERCOMPANY_API_KEY=sk_... (no key yet? start a free trial).
  2. Copy the cURL example above and run it in a terminal.

Credits

2 credits per successful call (2 (an empty list, an unknown handle and failed requests are free)). Failed, blocked and empty results are free.

Questions about this page?

Send the page link and your question, and the team will answer.

Email support