Rating

These endpoints are called from a shopper's browser, so they take your publishable key rather than a secret one. Anything specific to one customer also takes a signed email and timestamp: see Identifying the customer for how to produce the signature.

GET `/widgets/rating`

Get rating summary for products

Query Parameters

apiPublishableKeystringrequired

Your organization's publishable key, from Settings, API keys.

productSlugsstringrequired

Comma-separated product slugs to summarize, one per widget on the page.

Request

curl \
  "https://api.cascade.dev/widgets/rating?apiPublishableKey=pk_YOUR_PUBLISHABLE_KEY&productSlugs=string"

Request

import { client } from "@cascade-commerce/api/widget/client"
import { getWidgetsRating } from "@cascade-commerce/api/widget"

client.setConfig({
  baseUrl: "https://api.cascade.dev",
})

const { data, error } = await getWidgetsRating({
  query: { apiPublishableKey: "pk_YOUR_PUBLISHABLE_KEY", productSlugs: "string" },
})

Request

require "net/http"

uri = URI("https://api.cascade.dev/widgets/rating?apiPublishableKey=pk_YOUR_PUBLISHABLE_KEY&productSlugs=string")
req = Net::HTTP::Get.new(uri)

res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |http| http.request(req) }
puts res.body

Request

import json
from urllib.request import Request, urlopen

req = Request(
    "https://api.cascade.dev/widgets/rating?apiPublishableKey=pk_YOUR_PUBLISHABLE_KEY&productSlugs=string",
)
with urlopen(req) as res:
    print(json.load(res))

Response

{
  "data": [
    {
      "productSlug": "string",
      "title": "string",
      "imageUrl": "string",
      "totalReviews": 0,
      "averageRating": 0
    }
  ]
}

Response schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "productSlug": {
            "type": "string"
          },
          "title": {
            "type": "string",
            "description": "Product title, used as the name in structured data."
          },
          "imageUrl": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "Product image, used in structured data."
          },
          "totalReviews": {
            "type": "integer",
            "minimum": -9007199254740991,
            "maximum": 9007199254740991
          },
          "averageRating": {
            "anyOf": [
              {
                "type": "number"
              },
              {
                "type": "null"
              }
            ]
          }
        },
        "required": ["productSlug", "title", "imageUrl", "totalReviews", "averageRating"],
        "additionalProperties": false
      }
    }
  },
  "required": ["data"],
  "additionalProperties": false
}

#Rating

GET /widgets/rating

Query Parameters

Rating

GET `/widgets/rating`