Skip to content
Navigation

Reads the store: its name, hostname, subdomain, branding and plan.

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

Authorization

  • bearer
    HTTP
    required

Path parameters

  • store
    string
    required

    The store's id.

Returns

200

Reads the store: its name, hostname, subdomain, branding and plan.

JSON
  • site
    object
    required
    • plan
      string
      required
    • limits
      required

      What the plan alone applies; store_limits is the store's own.

      One of the following:

      • object
      • object
      • object
      • object
    • store_limits
      object
      required

      How many of each the store's website applies and what it turns on, staff's raises counted; room is what it may hold.

      • pages
        number
        required
      • menu
        number
        required
      • internal
        number
        required
      • external
        number
        required
      • stylesheet
        boolean
        required
      • unbranded
        boolean
        required
    • applies
      object
      required

      How many of each the store applies now, as its business last told it, else as its limits set.

      • pages
        number
        required
      • menu
        number
        required
      • internal
        number
        required
      • external
        number
        required
    • room
      object
      required
      • pages
        number
        required
      • menu
        number
        required
      • internal
        number
        required
      • external
        number
        required
    • used
      object
      required
      • pages
        number
        required
      • menu
        number
        required
      • internal
        number
        required
      • external
        number
        required
  • plan
    object
    required
    • tier
      string
      required
    • features
      object
      required
      • domain
        boolean
        required
      • learning
        boolean
        required
      • api
        boolean
        required
      • self_hosted
        boolean
        required
      • ai
        boolean
        required
    • marketing_emails
      required

      The plan's own; store_marketing_emails is what the store holds.

      One of the following:

      • number
      • number
      • number
    • customers
      required

      Against the plan's own cap; store_customers is against the store's.

      One of the following:

      • object
      • null
    • store_marketing_emails
      required

      Marketing emails the store may send a month, staff's raises counted; null is not metered.

      One of the following:

      • number
      • null
    • store_customers
      required

      The store's customers against its own cap, staff's raises counted; null without one.

      One of the following:

      • object
      • null
    • standing
      required

      One of the following:

      • object
      • null
  • files
    map of
    object
    required
  • integrations
    array of
    object
    required
    • id
      string
      required
    • name
      string
      required
    • description
      required

      One of the following:

      • string
      • null
    • kind
      string
      required
    • sets_cookies
      boolean
      required
    • enabled
      boolean
      required
    • connection_ended_at
      required

      One of the following:

      • string
      • null
    • config_schema
      map of
      any of
      required
    • secret_set
      map of
      boolean
      required
  • redirects
    object
    required
    • items
      array of
      object
      required
      • id
        string
        required
      • from_path
        string
        required
      • to_path
        string
        required
      • status
        number
        required
      • enabled
        boolean
        required
      • live
        boolean
        required

        Resolved: enabled and within the redirects of its kind the plan applies.

      • connection_ended_at
        required

        When it was turned off because the connection that set it up ended.

        One of the following:

        • string
        • null
      • created_at
        required

        One of the following:

        • string
        • null
    • total
      number
      required
  • notifications
    object
    required
    • items
      array of
      object
      required
      • id
        string
        required
      • event
        string
        required
      • target
        required

        One of the following:

        • object
        • null
      • locale
        string
        required
      • channel
        string
        required
      • enabled
        boolean
        required
      • in_effect
        boolean
        required
    • total
      number
      required
  • work
    object
    required
    • pending
      number
      required
    • parked
      number
      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
  • id
    string
    required
  • name
    string
    required
  • merchant_id
    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
  • subdomain
    required

    One of the following:

    • string
    • null
  • hostnames
    array of
    string
    required
  • swatch
    required

    One of the following:

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