Skip to content
Navigation

Pages a product's entries, each read whole, a blog's drafts first then newest first, a podcast's newest first, unless sorted.

GET
https://api.sherpo.io/merchant/v1/stores/{store}/products/{product}/entries/details

Authorization

  • bearer
    HTTP
    required

Path parameters

  • store
    string
    required

    The store's id.

  • product
    string
    required

    An id, or slug:<slug>.

    minLength: 1

Query parameters

  • filter
    optional
    object

    filter[<field>]=<value> is an equality, filter[<field>][<op>]=<value> names the operator; in repeats the parameter.

  • sort
    optional
    position
    or
    created
    or
    published
    or
    latest
    or
    title

    Sorted by published, rows without a value come last either way. Sorted by latest, rows without a value come first either way.

  • direction
    optional
    asc
    or
    desc
  • limit
    optional
    integer
    maximum: 50 · minimum: 1
  • cursor
    optional
    string
    maxLength: 8192
  • count
    optional
    boolean
  • search
    optional
    string
    maxLength: 200 · minLength: 1

Returns

200

Pages a product's entries, each read whole, a blog's drafts first then newest first, a podcast's newest first, unless sorted.

JSON
  • items
    array of
    object
    required
    • summary
      object
      required
      • poster
        required

        One of the following:

        • object
        • null
      • has_video
        boolean
        required
      • duration
        required

        One of the following:

        • number
        • null
      • presentations
        number
        required
      • slides
        number
        required
      • files
        number
        required
      • has_body
        boolean
        required
      • has_quiz
        boolean
        required
      • has_certificate
        boolean
        required
    • attachments
      array of
      object
      required
      • id
        string
        required
      • target
        object
        required
        • kind
          string
          required
        • id
          string
          required
      • role
        string
        required
      • delivery
        string
        required
      • preview_only
        boolean
        required
      • from_body
        boolean
        required
      • release_file
        boolean
        required

        A file a software release ships, which its release edits and the product's own list leaves out.

      • position
        number
        required
      • asset
        object
        required
        • id
          string
          required
        • locator
          required

          One of the following:

          • string
          • null
        • origin
          string
          required
        • custodian
          string
          required
        • enforcement
          string
          required
        • mime
          required

          One of the following:

          • string
          • null
        • bytes
          required

          The file's size in bytes; null when it is charged nothing.

          One of the following:

          • number
          • null
        • quota_bytes
          number
          required

          The file's size in bytes; zero when it is charged nothing.

        • name
          string
          required
        • title
          required

          One of the following:

          • string
          • null
        • ext
          required

          One of the following:

          • string
          • null
        • status
          string
          required
        • optimized
          boolean
          required
        • parent_id
          required

          One of the following:

          • string
          • null
        • redacted
          boolean
          required
        • security
          required

          One of the following:

          • string
          • null
        • description
          required

          One of the following:

          • string
          • null
        • processed_at
          required

          One of the following:

          • string
          • null
        • metadata
          object
          required
          • width
            optional
            integer
            minimum: 0
          • height
            optional
            integer
            minimum: 0
          • duration
            optional
            number

            Seconds, measured, so rarely whole.

          • pages
            optional
            integer
            minimum: 0
          • waveform
            optional

            An audio file's waveform: 256 levels from 0 to 255, base64; null when it can't be drawn.

            One of the following:

            • string
            • null
          • transcript
            optional
            object
            • language
              optional
              string
            • confidence
              optional
              number
          • arguments
            optional
            array of
            object

            What an MCP prompt asks for; only an authored prompt carries it.

            • name
              string
              required
            • description
              required

              One of the following:

              • string
              • null
            • required
              boolean
              required
            • default
              required

              One of the following:

              • string
              • null
            • match
              required

              Pattern the whole value must match, diacritic-insensitive.

              One of the following:

              • string
              • null
            • flags
              required

              Flags among i, s and u the pattern runs with; null for i alone.

              One of the following:

              • string
              • null
            • message
              required

              What a refused value is told instead of the default reason.

              One of the following:

              • string
              • null
            • lenient
              boolean
              required
        • created_at
          required

          One of the following:

          • string
          • null
    • files
      map of
      object
      required
    • access
      array of
      object
      required
      • resource
        object
        required
        • kind
          string
          required
        • id
          string
          required
      • channel
        string
        required
      • tier_id
        required

        One of the following:

        • string
        • null
      • closed
        boolean
        required
    • quizzes
      object
      required
      • items
        array of
        object
        required
        • id
          string
          required
        • entry_id
          string
          required
        • product_id
          string
          required
        • version
          number
          required
        • settings
          object
          required
          • attempts_allowed
            required

            One of the following:

            • number
            • null
          • pass_mark
            required

            One of the following:

            • number
            • null
          • show_answers
            boolean
            required
        • created_at
          required

          One of the following:

          • string
          • null
        • updated_at
          required

          One of the following:

          • string
          • null
      • total
        number
        required
    • in_use
      array of
      object
      required
      • kind
        string
        required
      • count
        number
        required
    • id
      string
      required
    • product_id
      string
      required
    • slug
      string
      required
    • path
      string
      required

      The storefront path.

    • url
      required

      The absolute URL on the store's verified hostname, or null before it has one.

      One of the following:

      • string
      • null
    • title
      string
      required
    • subtitle
      required

      One of the following:

      • string
      • null
    • section
      required

      One of the following:

      • string
      • null
    • author
      required

      Who signs it, or null when unsigned.

      One of the following:

      • object
      • object
      • null
    • tags
      array of
      string
      required
    • preview
      required

      The teaser, in the rich text format as stored.

      One of the following:

      • string
      • null
    • position
      number
      required
    • status
      string
      required
    • unlisted
      boolean
      required
    • published_at
      required

      One of the following:

      • string
      • null
    • unlisted_at
      required

      One of the following:

      • string
      • null
    • release
      required

      When its content opens relative to one of its event's sessions, or null when it opens as published.

      One of the following:

      • object
      • null
    • released_at
      required

      Since when a write keeps its passed release open, so a later release no longer locks it; cleared with the release.

      One of the following:

      • string
      • null
    • search
      required

      One of the following:

      • string
      • null
    • created_at
      required

      One of the following:

      • string
      • null
    • updated_at
      required

      One of the following:

      • string
      • null
    • settings
      object
      required
      • ai_generated
        optional
        boolean

        The description was machine-written, which readers are told.

    • metadata
      map of
      any of
      required
  • cursor
    required

    One of the following:

    • string
    • null
  • total
    optional
    number
  • facets
    optional
    map of
    map<number>
JSON
  • type
    string
    required
    format: uri
  • title
    string
    required
  • status
    integer
    required
  • detail
    string
    required
  • code
    optional
    string
  • context
    optional
    object
  • reached_core
    optional
    boolean
  • core_answer
    optional
    string

Type to search…

↑↓ navigate↵ selectEsc close