Skip to content
Navigation

Pages the registration questions a product asks its buyers in checkout, in order.

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

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
    position
  • direction
    optional
    asc
    or
    desc
  • limit
    optional
    integer
    maximum: 100 · minimum: 1
  • cursor
    optional
    string
    maxLength: 8192
  • count
    optional
    boolean

Returns

200

Pages the registration questions a product asks its buyers in checkout, in order.

JSON
  • items
    array of
    object
    required
    • 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
  • 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