shelfatlas-com Seo Terms API

openapi: 3.2.0
info:
  title: ShelfAtlas Catalog Seo Terms API
  version: 1.0.0
  description: 'Read access to normalised Danish retail catalog data — products, offers, stores, and chains. Authenticate with a Bearer `sa_live_` API key. This document is the contract the official ShelfAtlas SDKs conform to. Data coverage: the offer feed covers every major Danish chain, but the curated product catalog is smaller and actively expanding — an empty data array from /products/{id}/offers or /price-history means no offers are linked to that product yet, not an error.'
  termsOfService: https://shelfatlas.com/legal/terms
servers:
- url: https://api.shelfatlas.com
  description: Production
security:
- bearerAuth: []
tags:
- name: SeoTerms
paths:
  /api/v1/public/catalog/seo-terms:
    get:
      operationId: listSeoTerms
      summary: Generated SEO term list (SA-0137 B1)
      description: 'The daily-refreshed list of SEO terms derived from currently-active campaign offers, intended for per-term landing pages (e.g. `/tilbud/`). Unauthenticated like `/stats`: bounded by a per-IP rate limit and a CDN cache (`Cache-Control: public, s-maxage=3600, stale-while-revalidate=86400`).'
      tags:
      - SeoTerms
      security: []
      parameters:
      - name: min_offers
        in: query
        required: false
        schema:
          type: integer
          minimum: 1
          default: 3
        description: Only terms with at least this many offers in the last refresh.
      - name: min_chains
        in: query
        required: false
        schema:
          type: integer
          minimum: 1
          default: 2
        description: Only terms carried by at least this many distinct chains.
      - name: limit
        in: query
        required: false
        schema:
          type: integer
          minimum: 1
          maximum: 1000
          default: 1000
        description: Page size (1–1000, default 1000).
      responses:
        '200':
          description: Terms meeting the thresholds, ordered by offers_7d desc.
          content:
            application/json:
              schema:
                type: object
                required:
                - ok
                - data
                additionalProperties: false
                properties:
                  ok:
                    type: boolean
                    enum:
                    - true
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/SeoTerm'
        '400':
          $ref: '#/components/responses/BadRequest'
        '429':
          $ref: '#/components/responses/RateLimited'
components:
  schemas:
    Error:
      type: object
      additionalProperties: true
      required:
      - error
      properties:
        error:
          type: string
          description: Machine-readable error code.
        message:
          type: string
        detail:
          type: string
        retry_after_sec:
          type: integer
          description: Seconds to wait before retrying (429).
        plan:
          type: string
          description: Caller's resolved plan id (present on monthly_limit_reached).
        limit:
          type: integer
          description: The plan monthly request quota (present on monthly_limit_reached).
        used:
          type: integer
          description: Requests already spent this UTC month (present on monthly_limit_reached).
        resets_at:
          type: string
          format: date-time
          description: When the quota resets — next UTC month start (present on monthly_limit_reached).
        next_plan:
          type: object
          nullable: true
          description: The cheapest plan with a larger quota, or null at the top of the ladder.
          properties:
            id:
              type: string
            name:
              type: string
            monthly_price_dkk:
              type: integer
            monthly_request_quota:
              type: integer
        plans_url:
          type: string
          format: uri
          description: Public pricing page — no sign-in required.
        upgrade_url:
          type: string
          format: uri
    SeoTerm:
      type: object
      additionalProperties: false
      required:
      - slug
      - term
      - query
      - offers_7d
      - chains_7d
      - chain_offers
      - last_seen
      properties:
        slug:
          type: string
          description: URL-safe identifier, e.g. `pepsi-max`.
        term:
          type: string
          description: Display form, e.g. "Pepsi Max".
        query:
          type: string
          description: Lowercase search text to feed `offers.search({ q })`.
        offers_7d:
          type: integer
          description: Active campaign offers behind this term at the last refresh.
        chains_7d:
          type: integer
          description: Distinct chains carrying an offer behind this term.
        chain_offers:
          type: array
          nullable: true
          description: Per-chain breakdown of the offers behind this term, ordered offers desc then chain_slug asc; the offers sum to `offers_7d` and the length is `chains_7d`. Campaign offers are chain-level, so a consumer sums the chains near a place to size a place × term page. null until the term's first refresh after this field was added.
          items:
            type: object
            additionalProperties: false
            required:
            - chain_slug
            - offers
            properties:
              chain_slug:
                type: string
                description: Chain slug, as in `/chains` and `/stores/nearest`, e.g. `netto`.
              offers:
                type: integer
                description: Active campaign offers from this chain behind the term.
        last_seen:
          type: string
          format: date-time
          description: When this term last met the thresholds.
  responses:
    RateLimited:
      description: Rate limit or monthly limit reached (`rate_limited` / `monthly_limit_reached`).
      headers:
        Retry-After:
          description: Seconds to wait before retrying (present on `rate_limited`).
          schema:
            type: integer
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    BadRequest:
      description: Invalid parameters (`invalid_params`, `incompatible_params`).
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: 'A ShelfAtlas API key: `Authorization: Bearer sa_live_<key>`.'
    deviceTokenAuth:
      type: apiKey
      in: header
      name: X-Device-Token
      description: 'Anonymous per-device identity for POST /api/v1/observations: a UUID the client generates and keeps locally. Any UUID version is accepted — the check is purely the 8-4-4-4-12 hex-digit shape.'