Skip to content
Navigation

Pages a product's entries, 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

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: 100 · minimum: 1
  • cursor
    optional
    string
    maxLength: 8192
  • count
    optional
    boolean
  • search
    optional
    string
    maxLength: 200 · minLength: 1

Returns

200

Pages a product's entries, 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
    • 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