Skip to content
Navigation

Reads the store: its name, branding and settings.

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

Authorization

  • bearer
    optional
    HTTP
  • publishableKey
    optional
    API key in header

Path parameters

  • store
    string
    required

    A hostname of the store.

Query parameters

  • preview
    optional
    string
    maxLength: 128 · minLength: 1

Returns

200

Reads the store: its name, branding and settings.

JSON
  • id
    string
    required
  • name
    string
    required
  • locale
    string
    required
  • currency
    required

    One of the following:

    • string
    • null
  • hostname
    required

    One of the following:

    • string
    • null
  • served_hostname
    required

    One of the following:

    • string
    • null
  • served_hostnames
    array of
    string
    required
  • unlocks_paused
    boolean
    required
  • mcp_endpoint
    required

    One of the following:

    • string
    • null
  • description
    required

    One of the following:

    • string
    • null
  • tint
    required

    One of the following:

    • string
    • null
  • tint_dark
    required

    One of the following:

    • string
    • null
  • favicon
    string
    required
  • apple_touch_icon
    string
    required
  • icon_96
    required

    One of the following:

    • string
    • null
  • icon_192
    string
    required
  • icon_512
    string
    required
  • icon
    string
    required
  • placeholder_icon
    string
    required
  • settings
    object
    required
    • storefront
      object
      required
      • external_site
        required

        One of the following:

        • string
        • null
      • socials
        array of
        string
        required
      • theme
        string
        required
      • no_index
        boolean
        required
      • powered_by
        boolean
        required
      • animated_background
        boolean
        required
      • header_hidden
        boolean
        required
      • footer_hidden
        boolean
        required
  • body
    required

    One of the following:

    • object
    • null
  • files
    map of
    object
    required
  • maps
    array of
    object
    required

    The maps the body's map blocks show, matched to a block by latitude and longitude; none while the body is kept from the reader.

    • latitude
      number
      required
    • longitude
      number
      required
    • light
      object
      required

      For a light page.

      • url
        string
        required

        A lasting URL to the image.

      • width
        number
        required

        Its size in pixels.

      • height
        number
        required
      • resized
        optional

        Its smaller copies, narrowest first; null until made.

        One of the following:

        • array<object>
        • null
    • dark
      object
      required

      For a dark page.

      • url
        string
        required

        A lasting URL to the image.

      • width
        number
        required

        Its size in pixels.

      • height
        number
        required
      • resized
        optional

        Its smaller copies, narrowest first; null until made.

        One of the following:

        • array<object>
        • null
    • attribution
      string
      required

      The credit shown over the map, linking attribution_url.

    • attribution_url
      string
      required
  • stylesheet
    required

    One of the following:

    • object
    • null
  • integrations
    array of
    object
    required
    • id
      string
      required
    • name
      string
      required
    • kind
      string
      required
    • sets_cookies
      boolean
      required
    • script
      array of
      object
      required
      • src
        required

        One of the following:

        • string
        • null
      • id
        required

        One of the following:

        • string
        • null
      • defer
        boolean
        required
      • async
        boolean
        required
      • inner_html
        required

        One of the following:

        • string
        • null
      • attributes
        map of
        string
        required

        Any other string attribute on the tag.

  • categories
    array of
    object
    required
    • id
      string
      required
    • label
      string
      required
    • discountable
      boolean
      required
    • subscribable
      boolean
      required
    • reviewable
      boolean
      required
    • repeatable
      boolean
      required

      Bought again and again: a coffee, a donation, an invoice, a seat, a slot.

    • aside_size
      string
      required
  • currencies
    map of
    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