Skip to content
Navigation

Pages a product's certificates.

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

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
    created
  • 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 certificates.

JSON
  • items
    array of
    object
    required
    • issued
      number
      required
    • id
      string
      required
    • product_id
      string
      required
    • quiz_id
      required

      One of the following:

      • string
      • null
    • headline_copy
      string
      required
    • title_copy
      required

      One of the following:

      • string
      • null
    • awarded_copy
      required

      One of the following:

      • string
      • null
    • reason_copy
      required

      One of the following:

      • string
      • null
    • score_copy
      required

      One of the following:

      • string
      • null
    • out_of_score_copy
      required

      One of the following:

      • string
      • null
    • settings
      object
      required
      • template
        string
        required
      • accent
        required

        One of the following:

        • string
        • null
      • requires_passing
        optional
        boolean

        Earned by passing the quiz, not by merely finishing it.

      • earned_on
        optional
        string

        Set on a certificate no quiz awards: finishing every entry of a course, or a check-in at an event, earns it; losing its quiz never makes one.

      • shows
        optional
        array of
        string
    • created_at
      required

      One of the following:

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