Skip to content
Navigation

Updates the business's name and details.

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

Authorization

  • bearer
    HTTP
    required

Path parameters

  • store
    string
    required

    The store's id.

Request body JSON optional

  • name
    optional
    string

    Stored trimmed; a blank one is refused.

    maxLength: 120 · minLength: 1
  • short_name
    optional
    string
    maxLength: 63 · minLength: 3 · pattern: ^[a-z0-9][a-z0-9-]{1,61}[a-z0-9]$
  • email
    optional
    string
    maxLength: 254 · minLength: 1 · pattern: ^[^\s@]+@[^\s@]+\.[^\s@]+$
  • description
    optional

    One of the following:

    • string
    • null
  • swatch
    optional

    One of the following:

    • string
    • null

Returns

200

Updates the business's name and details.

JSON
  • plan
    required

    One of the following:

    • object
    • null
  • base_plan
    required

    The plan held for good beneath any bought, whether or not one is live; null for none.

    One of the following:

    • object
    • null
  • standing
    required

    One of the following:

    • object
    • null
  • has_customer
    boolean
    required

    Whether the business is a customer at Stripe, so its billing portal can open.

  • fee
    required

    One of the following:

    • object
    • null
  • connections
    array of
    object
    required
    • processor
      string
      required
    • external_ref
      string
      required
    • status
      string
      required
    • enabled
      boolean
      required
    • held
      boolean
      required
    • updated_at
      required

      One of the following:

      • string
      • null
  • stores
    object
    required
    • items
      array of
      object
      required
      • id
        string
        required
      • name
        string
        required
      • locale
        string
        required
      • location
        required

        One of the following:

        • string
        • null
      • hostname
        required

        One of the following:

        • string
        • null
      • swatch
        required

        One of the following:

        • string
        • null
      • icon
        string
        required
      • created_at
        required

        One of the following:

        • string
        • null
    • total
      number
      required
    • limit
      number
      required
  • members
    object
    required
    • total
      number
      required
    • limit
      number
      required
  • id
    string
    required
  • name
    string
    required
  • short_name
    string
    required
  • email
    string
    required
  • description
    required

    One of the following:

    • string
    • null
  • swatch
    required

    One of the following:

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