Skip to content
Navigation

Pages the tiers of the store's products, or of one product.

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

Authorization

  • bearer
    HTTP
    required

Path parameters

  • store
    string
    required

    The store's id.

Query parameters

  • product
    optional
    string

    An id, or slug:<slug>.

    minLength: 1
  • filter
    optional
    object

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

  • sort
    optional
    product
  • direction
    optional
    asc
    or
    desc
  • limit
    optional
    integer
    maximum: 100 · minimum: 1
  • cursor
    optional
    string
    maxLength: 8192
  • count
    optional
    boolean

Returns

200

Pages the tiers of the store's products, or of one product.

JSON
  • items
    array of
    object
    required
    • product
      required

      One of the following:

      • object
      • null
    • in_use
      object
      required
      • prices
        number
        required
      • grants
        number
        required
      • orders
        number
        required
      • discounts
        number
        required
      • gates
        number
        required
    • id
      string
      required
    • product_id
      string
      required
    • rank
      number
      required
    • name
      string
      required
    • settings
      object
      required
      • software
        optional
        object

        A software tier: what its licenses unlock, answered by a license check.

        • features
          optional
          array of
          string

          Distinct flags the seller's software reads: letters and digits, single hyphens, underscores, dots or colons between them.

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

          The devices its licenses activate at once, over the product's default; none holds the product's.

          maximum: 10000 · minimum: 1
      • event
        optional
        object

        An event's ticket type: how many guests it takes.

        • capacity
          optional
          integer

          How many guests this ticket type takes, within the event's own capacity; none means no limit of its own.

          maximum: 1000000 · minimum: 1
  • 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