Skip to content
Navigation

Pages the store's products with what the customer holds of each.

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

Authorization

  • bearer
    optional
    HTTP
  • publishableKey
    optional
    API key in header

Path parameters

  • store
    string
    required

    A hostname of the store.

Query parameters

  • filter
    optional
    object

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

  • sort
    optional
    catalog
    or
    published
    or
    title
  • 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
  • coupon
    optional
    string

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

    maxLength: 64 · minLength: 1

Returns

200

Pages the store's products with what the customer holds of each.

JSON
  • items
    array of
    object
    required
    • files
      map of
      object
      required
    • event
      required

      An event product's format, place and next sessions as a visitor sees them; null for any other product.

      One of the following:

      • object
      • 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
    • 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
  • cursor
    required

    One of the following:

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