Skip to content
Navigation

Reads one product with its offers and access, its body too when asked.

GET
https://api.sherpo.io/customer/v1/stores/{store}/products/{product}

Authorization

  • bearer
    optional
    HTTP
  • publishableKey
    optional
    API key in header

Path parameters

  • store
    string
    required

    A hostname of the store.

  • product
    string
    required

    An id, or slug:<slug>.

    minLength: 1

Query parameters

  • coupon
    optional
    string

    A discount's code, or its id as an affiliate link carries it, priced into the offers.

    maxLength: 64 · minLength: 1
  • preview
    optional
    string

    A token a seller made for the product's page, which opens it unpublished with its staged body, or for one of its entries, which opens it unpublished as it is live.

    maxLength: 128 · minLength: 1
  • include
    optional
    array of
    string

    What else the read answers: body reads the body whole, as readBody does, and fails the read where readBody would.

Returns

200

Reads one product with its offers and access, its body too when asked.

JSON
  • files
    map of
    object
    required
  • maps
    array of
    object
    required

    The maps the body's map blocks show, matched to a block by latitude and longitude; none while the body is kept from the reader.

    • latitude
      number
      required
    • longitude
      number
      required
    • light
      object
      required

      For a light page.

      • url
        string
        required

        A lasting URL to the image.

      • width
        number
        required

        Its size in pixels.

      • height
        number
        required
      • resized
        optional

        Its smaller copies, narrowest first; null until made.

        One of the following:

        • array<object>
        • null
    • dark
      object
      required

      For a dark page.

      • url
        string
        required

        A lasting URL to the image.

      • width
        number
        required

        Its size in pixels.

      • height
        number
        required
      • resized
        optional

        Its smaller copies, narrowest first; null until made.

        One of the following:

        • array<object>
        • null
    • attribution
      string
      required

      The credit shown over the map, linking attribution_url.

    • attribution_url
      string
      required
  • entries
    array of
    object
    required
    • has_quiz
      boolean
      required
    • has_certificate
      boolean
      required

      A certificate is earned on the entry's quiz.

    • quiz_score
      required

      The caller's best finished sitting on the entry's quiz; null signed out or with none.

      One of the following:

      • number
      • null
    • media
      object
      required
      • duration
        required

        The lesson video's length in seconds.

        One of the following:

        • number
        • null
      • slides
        required

        Pages across the lesson's slides; null without slides.

        One of the following:

        • number
        • null
      • files
        number
        required

        Deliverable files, links apart.

    • access
      string
      required
    • requires
      required

      One of the following:

      • object
      • object
      • object
    • opens_at
      required

      When its content opens to everyone it admits; null once open or without a release, and for a broken one, which stays locked.

      One of the following:

      • string
      • null
    • poster
      required

      One of the following:

      • object
      • null
    • files
      map of
      object
      required
    • completed_at
      required

      One of the following:

      • string
      • null
    • 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; a member with no name, or one central no longer holds, answers a null name.

      One of the following:

      • 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
    • published_at
      required

      One of the following:

      • string
      • null
    • unlisted_at
      required

      Set while it is out of the product's lists and indexes, though still reachable.

      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
        boolean
        required
  • body
    required

    One of the following:

    • object
    • object
    • null
  • attachments
    array of
    object
    required
    • tracks
      array of
      object
      required
      • id
        string
        required
      • label
        required

        One of the following:

        • string
        • null
      • language
        required

        One of the following:

        • string
        • null
      • generated
        boolean
        required

        Subtitles the store generated with AI from the video's audio.

    • outputs
      array of
      string
      required

      The published AI outputs getMediaOutputs reads beside the video or audio file.

    • access
      string
      required
    • id
      string
      required
    • role
      string
      required
    • delivery
      string
      required
    • preview_only
      boolean
      required
    • from_body
      boolean
      required

      Named by its target's body text, rather than the target's own media (a lesson's video or slides).

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

        One of the following:

        • string
        • null
      • title
        required

        One of the following:

        • string
        • null
      • ext
        required

        One of the following:

        • string
        • null
      • description
        required

        One of the following:

        • string
        • null
      • mime
        required

        One of the following:

        • string
        • null
      • bytes
        required

        The file's size in bytes, null when it has none or is withheld.

        One of the following:

        • number
        • null
      • enforcement
        string
        required
      • locator
        required

        One of the following:

        • string
        • null
      • metadata
        object
        required
        • width
          required

          One of the following:

          • number
          • null
        • height
          required

          One of the following:

          • number
          • null
        • duration
          required

          One of the following:

          • number
          • null
        • pages
          required

          One of the following:

          • number
          • null
      • status
        string
        required
  • tiers
    array of
    object
    required
    • id
      string
      required
    • product_id
      string
      required
    • rank
      number
      required
    • name
      string
      required
  • can_review
    boolean
    required

    Whether the caller may write their review of it now: their scopes allow it, and a grant of theirs started and ended by nothing but a lapse, on a published product that takes reviews.

  • calendar_events
    array of
    object
    required

    The events a booking product's page offers to pick from, unlisted and discontinued ones too; empty for any other product.

    • id
      string
      required
    • slug
      string
      required
    • path
      string
      required

      The event's 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

      The short line shown under the title, plain text, or null for none.

      One of the following:

      • string
      • null
  • event
    required

    An event product's format, place, schedule and how it takes guests; null for any other product.

    One of the following:

    • object
    • null
  • questions
    array of
    object
    required

    What checkout asks each buyer before payment, in order; empty for a product that asks nothing.

    • id
      string
      required
    • product_id
      string
      required
    • position
      number
      required

      Where it shows among the product's questions, from zero.

    • kind
      string
      required

      text, long_text, select, multi_select or checkbox.

    • preset
      required

      The standard detail it asks for (name, phone, company or address), or null for one of the seller's own.

      One of the following:

      • string
      • null
    • label
      string
      required
    • required
      boolean
      required

      Whether checkout asks for an answer before payment; a required checkbox must be ticked.

    • options
      required

      A select's options, in order; null for any other kind.

      One of the following:

      • array<string>
      • null
    • pattern
      required

      The pattern a text answer must match whole, or null for none.

      One of the following:

      • string
      • null
    • example
      required

      An answer that fits the pattern, which checkout shows as the format to follow; null for none.

      One of the following:

      • string
      • null
    • created_at
      string
      required
    • updated_at
      string
      required
  • description
    required

    The page's long description, in the rich text format as stored.

    One of the following:

    • string
    • null
  • what_you_get
    required

    What a buyer gets, in the rich text format as stored.

    One of the following:

    • string
    • null
  • settings
    object
    required
    • progress_tracking
      string
      required
    • refund_policy
      required

      One of the following:

      • string
      • null
    • reviews_enabled
      boolean
      required
    • purchase_note
      required

      One of the following:

      • string
      • null
    • approval
      string
      required

      Whether each buyer waits for the seller's approval; an unknown value reads as required, the side that promises nothing.

    • calendar
      required

      One of the following:

      • object
      • null
    • coffee
      required

      One of the following:

      • object
      • null
    • fundraising
      required

      One of the following:

      • object
      • null
    • storefront
      object
      required
      • sales_counter
        boolean
        required
      • background_poster
        boolean
        required
      • require_dark
        boolean
        required
  • coupon
    required

    One of the following:

    • object
    • null
  • category
    required

    One of the following:

    • object
    • null
  • access
    string
    required
  • mcp
    object
    required
    • requires
      required

      What its gate asks there: anyone, a rank of its tiers, or nobody for a closed or broken gate.

      One of the following:

      • object
      • object
      • object
    • prompts
      number
      required

      How many of its prompts someone could run there, whoever reads it.

  • offers
    array of
    required

    One of the following:

    • object
    • object
    • object
    • object
  • owned
    required

    One of the following:

    • object
    • null
  • request
    required

    The caller's latest request for it: waiting for the seller's approval, on the waitlist, or decided; null for none or a visitor.

    One of the following:

    • object
    • null
  • poster
    required

    One of the following:

    • object
    • null
  • stats
    object
    required
    • sales
      required

      One of the following:

      • number
      • null
    • raised
      required

      One of the following:

      • array<object>
      • null
  • release
    required

    One of the following:

    • object
    • null
  • rating
    object
    required
    • count
      number
      required
    • average
      required

      One of the following:

      • number
      • null
    • histogram
      object
      required
      • 1
        number
        required
      • 2
        number
        required
      • 3
        number
        required
      • 4
        number
        required
      • 5
        number
        required
    • summary
      required

      The generated summary of what reviews say; null while the seller hides it or none is written.

      One of the following:

      • string
      • null
    • summary_locale
      required

      The language the summary is written in, which trails a store's new language until it is written again.

      One of the following:

      • string
      • null
  • 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

    The short line shown under the title.

    One of the following:

    • string
    • null
  • listing
    string
    required
  • priority
    number
    required
  • published_at
    required

    One of the following:

    • string
    • null
  • discontinued_at
    required

    One of the following:

    • string
    • null
  • unlisted_at
    required

    One of the following:

    • string
    • null
  • feed_url
    required

    The public feed's absolute URL, for a blog or a podcast that is published (discontinued too), listed and on a verified hostname; else null.

    One of the following:

    • string
    • null
  • created_at
    required

    One of the following:

    • string
    • null
  • updated_at
    required

    One of the following:

    • string
    • null
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