Skip to content
Navigation

Updates a portfolio's settings.

PATCH
https://api.sherpo.io/merchant/v1/stores/{store}/products/{product}/portfolio

Authorization

  • bearer
    HTTP
    required

Path parameters

  • store
    string
    required

    The store's id.

  • product
    string
    required

    An id, or slug:<slug>.

    minLength: 1

Header parameters

  • Idempotency-Key
    optional
    string

    Repeats within 24 hours answer the first result; the same key with other arguments is a conflict.

    maxLength: 255 · minLength: 1 · pattern: ^[\x21-\x7E]+$

Request body JSON optional

  • settings
    optional
    object

    Merged onto the stored settings; null deletes a key.

    • show_absolute_values
      optional

      Amounts, not only percentages.

      One of the following:

      • boolean
      • null
    • locked_chart_delay
      optional

      One of the following:

      • string
      • null
  • currency
    optional
    string

    Only while the portfolio holds no holding, event or snapshot.

    maxLength: 3 · minLength: 3

Returns

200

Updates a portfolio's settings.

JSON
  • product
    object
    required
    • id
      string
      required
    • slug
      string
      required
    • path
      required

      The product's storefront path, or null once deleted, since another product may take its slug.

      One of the following:

      • string
      • null
    • url
      required

      The absolute URL on the store's verified hostname, or null before it has one or once deleted.

      One of the following:

      • string
      • null
    • title
      string
      required
    • category
      string
      required
    • deleted
      boolean
      required
  • holdings
    object
    required
    • items
      array of
      object
      required
      • id
        string
        required
      • portfolio_id
        string
        required
      • symbol
        string
        required
      • shares
        number
        required
      • avg_cost
        required

        One of the following:

        • number
        • null
      • cost_currency
        string
        required
      • cost_exponent
        required

        One of the following:

        • number
        • null
      • price_currency
        string
        required
      • price_exponent
        required

        One of the following:

        • number
        • null
      • name
        string
        required
      • symbol_type
        required

        One of the following:

        • string
        • null
      • currency
        required

        One of the following:

        • string
        • null
      • note
        required

        One of the following:

        • string
        • null
      • removed_note
        required

        One of the following:

        • string
        • null
      • removed_at
        required

        One of the following:

        • string
        • null
      • updated_at
        required

        One of the following:

        • string
        • null
      • metadata
        map of
        any of
        required
    • total
      number
      required
  • events
    number
    required
  • snapshots
    number
    required
  • id
    string
    required
  • product_id
    string
    required
  • currency
    string
    required
  • exponent
    required

    One of the following:

    • number
    • null
  • settings
    object
    required
    • show_absolute_values
      optional
      boolean

      Amounts, not only percentages.

    • locked_chart_delay
      optional
      string
  • 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