Skip to content
Navigation

Lists the businesses the token may act for, with their stores; an account token lists them whatever its access.

GET
https://api.sherpo.io/merchant/v1/merchants

Authorization

  • bearer
    HTTP
    required

Query parameters

  • merchant
    optional
    string

    An id.

    minLength: 1
  • store
    optional
    string

    An id.

    minLength: 1
  • cursor
    optional
    string

    Lists the memberships past a previous page, from that page's cursor.

    maxLength: 1024

Returns

200

Lists the businesses the token may act for, with their stores; an account token lists them whatever its access.

JSON
  • items
    array of
    object
    required
    • id
      string
      required
    • name
      string
      required
    • short_name
      string
      required
    • created_at
      required

      One of the following:

      • string
      • null
    • scopes
      required

      The scopes their membership spells, not narrowed to the credential presented.

      One of the following:

      • array<string>
      • null
    • swatch
      required

      One of the following:

      • string
      • null
    • stores
      object
      required
      • items
        array of
        object
        required
        • id
          string
          required
        • name
          string
          required
        • hostname
          required

          One of the following:

          • string
          • null
        • url
          required

          The store home's absolute URL on its verified hostname, or null before it has one.

          One of the following:

          • string
          • null
        • swatch
          required

          One of the following:

          • string
          • null
        • icon
          string
          required
      • total
        number
        required
  • total
    number
    required
  • owns_suspended
    boolean
    required
  • cursor
    required

    The next page's, null on the last; a page its seats leave empty may still have one.

    One of the following:

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