Skip to content
Navigation

Reads the store's settings.

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

Authorization

  • bearer
    HTTP
    required

Path parameters

  • store
    string
    required

    The store's id.

Returns

200

Reads the store's settings.

JSON
  • hostnames
    array of
    string
    required
  • locale
    string
    required
  • tint
    required

    One of the following:

    • string
    • null
  • tint_dark
    required

    One of the following:

    • string
    • null
  • delivery_ttl_seconds
    number
    required
  • refund_revokes_access
    boolean
    required
  • description
    required

    One of the following:

    • string
    • null
  • time_zone
    string
    required
  • currency
    required

    One of the following:

    • string
    • null
  • settings
    object
    required
    • storefront
      optional
      object
      • external_site
        optional
        string

        The seller's own site, linked from the header.

        maxLength: 2000 · minLength: 1
      • socials
        optional
        array of
        string

        Profile URLs on the networks the footer shows (Instagram, X, YouTube, LinkedIn, TikTok, Twitch, Threads, GitHub, Facebook, Discord, Telegram, Reddit, Bluesky, Slack, and Mastodon on mastodon.social, mastodon.online, fosstodon.org, hachyderm.io, infosec.exchange, techhub.social or a host with a mastodon or mstdn label), linked from the footer.

        maxLength: 2000 · minLength: 1
      • theme
        optional
        string

        The schemes visitors may pick; absent offers both.

      • no_index
        optional
        boolean
      • powered_by
        optional
        boolean
      • animated_background
        optional
        boolean

        The dots drifting behind the hero.

      • header_hidden
        optional
        boolean

        Whether the site's header and footer are left off its pages.

      • footer_hidden
        optional
        boolean
  • metadata
    map of
    any of
    required
  • revision
    number
    required
  • updated_at
    required

    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