Skip to content
Navigation

Pages the store's products.

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

Authorization

  • bearer
    HTTP
    required

Path parameters

  • store
    string
    required

    The store's id.

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
    created
    or
    published
    or
    title
    or
    priority
    or
    sales
    +1 more

    Sorted by published or rating, rows without a value come last 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
  • facets
    optional
    array of
    string

Returns

200

Pages the store's products.

JSON
  • items
    array of
    object
    required
    • event_map
      required

      An event's venue maps at its location's point, one image per theme; null until drawn, or for any other product.

      One of the following:

      • object
      • null
    • seats
      required

      An event's seats as the product read answers them: what frozen carts hold and sales took, each ticket type's too; null for another category.

      One of the following:

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

        One of the following:

        • number
        • null
    • poster
      required

      One of the following:

      • object
      • 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
    • category
      string
      required
    • listing
      string
      required
    • priority
      number
      required
    • status
      string
      required
    • unlisted
      boolean
      required
    • 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
    • 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
    • created_at
      required

      One of the following:

      • string
      • null
    • updated_at
      required

      One of the following:

      • string
      • null
    • settings
      object
      required
      • refund_policy
        optional
        string
      • progress_tracking
        optional
        string
      • reviews_enabled
        optional
        boolean
      • review_summary_visible
        optional
        boolean

        Whether customers see the generated review summary; it is written either way.

      • purchase_note
        optional
        string

        Shown beside the buy button.

        maxLength: 2000 · minLength: 1
      • approval
        optional
        string

        Whether each buyer waits as a pending request until the seller approves or declines it; none when unset.

      • approval_payment
        optional
        string

        How a paid purchase waits for approval; saved_card when unset. Holds last about 7 days on a card.

      • calendar
        optional
        object

        A bookable product: the seller's Cal.com event and the host card beside the widget; writes check it, reads answer it as stored.

        • calcom
          optional
          object
          • username
            optional
            string
          • event_slug
            optional
            string
        • host
          optional
          object
          • identity
            optional

            Set apart from title: a write of either clears the other.

            One of the following:

            • object
            • object
            • object
          • title
            optional
            string
          • subtitle
            optional
            string
          • description
            optional
            string
          • tags
            optional
            array of
            string
      • coffee
        optional
        object

        A tip button: what it is called and what it shows.

        • emoji
          optional
          string
        • descriptor
          optional
          string
          maxLength: 15 · minLength: 3 · pattern: ^\S(.*\S)?$
      • software
        optional
        object

        A software product: how its license keys start and how many devices each holds by default.

        • key_prefix
          optional
          string

          Letters and digits, single hyphens or underscores between them.

          maxLength: 16 · minLength: 1 · pattern: ^[A-Za-z0-9]+(?:[-_][A-Za-z0-9]+)*$
        • activation_limit
          optional
          integer

          The devices a license activates at once by default; none means no limit.

          maximum: 10000 · minimum: 1
        • inactive_days
          optional
          integer

          Days after which a device the software stopped reporting no longer counts; none keeps it until freed.

          maximum: 3650 · minimum: 1
        • offline_days
          optional
          integer

          Days a signed license token lets the software run offline before it asks again; 30 when unset.

          maximum: 365 · minimum: 1
      • event
        optional
        object

        An event product: how it is attended, where, and how it takes guests.

        • format
          optional
          string

          In person, online or both; in person when unset.

        • location
          optional
          object

          Where an in-person event takes place.

          • venue
            optional
            string

            Trimmed, with no line break or control character.

            maxLength: 200 · minLength: 1 · pattern: ^[^\s\u0000-\u001f\u007f-\u009f]([^\u0000-\u001f\u007f-\u009f\u2028\u2029]*[^\s\u0000-\u001f\u007f-\u009f])?$
          • address
            optional
            string

            The street address, trimmed, its lines apart and no other control character.

            maxLength: 500 · minLength: 1 · pattern: ^[^\s\u0000-\u001f\u007f-\u009f]([^\u0000-\u0009\u000b\u000c\u000e-\u001f\u007f-\u009f]*[^\s\u0000-\u001f\u007f-\u009f])?$
          • city
            optional
            string

            Trimmed, with no line break or control character.

            maxLength: 100 · minLength: 1 · pattern: ^[^\s\u0000-\u001f\u007f-\u009f]([^\u0000-\u001f\u007f-\u009f\u2028\u2029]*[^\s\u0000-\u001f\u007f-\u009f])?$
          • region
            optional
            string

            A state, province or county. Trimmed, with no line break or control character.

            maxLength: 100 · minLength: 1 · pattern: ^[^\s\u0000-\u001f\u007f-\u009f]([^\u0000-\u001f\u007f-\u009f\u2028\u2029]*[^\s\u0000-\u001f\u007f-\u009f])?$
          • postal_code
            optional
            string

            Trimmed, with no line break or control character.

            maxLength: 20 · minLength: 1 · pattern: ^[^\s\u0000-\u001f\u007f-\u009f]([^\u0000-\u001f\u007f-\u009f\u2028\u2029]*[^\s\u0000-\u001f\u007f-\u009f])?$
          • country
            optional
            string

            ISO 3166-1 alpha-2, upper case.

            maxLength: 2 · minLength: 2 · pattern: ^[A-Z]{2}$
          • latitude
            optional
            number

            Where it is on a map, in decimal degrees, set together with longitude.

            maximum: 90 · minimum: -90
          • longitude
            optional
            number

            Where it is on a map, in decimal degrees, set together with latitude.

            maximum: 180 · minimum: -180
          • map_url
            optional
            string

            A map's page for the place. An https URL.

            maxLength: 2000 · minLength: 1 · pattern: ^https://
        • reveal_location
          optional
          string

          Who sees the location: everyone, or ticket holders alone; everyone when unset.

        • waitlist
          optional
          boolean

          Whether guests may join a waitlist once it is full; not when unset.

        • capacity
          optional
          integer

          How many guests it takes in all; none means no limit.

          maximum: 1000000 · minimum: 1
      • fundraising
        optional
        object

        A fundraiser: the goal, in minor units of its currency.

        • goal
          integer
          required
          minimum: 1
        • currency
          string
          required
          maxLength: 3 · minLength: 3
      • feeds
        optional
        object

        A blog's or a podcast's feeds: the public one always stays; private false turns every customer's private feed off.

        • private
          optional
          boolean
        • category
          optional
          string

          A podcast's directory category, one of Apple's, its subcategory after > (Arts > Books).

          maxLength: 64
        • explicit
          optional
          boolean

          Whether a podcast's episodes are explicit; not where unset.

        • owner_email
          optional
          string

          The address directories mail to verify a podcast's owner; never in a private feed.

          maxLength: 254
      • storefront
        optional
        object
        • sales_counter
          optional
          boolean

          A public count of orders on the product page.

        • background_poster
          optional
          boolean

          The poster doubles as the page background.

        • require_dark
          optional
          boolean

          The page renders dark whatever the visitor chose.

    • 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