Skip to content
Navigation

Reads a portfolio product's book, as far as the customer may.

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

Authorization

  • bearer
    HTTP
    required

Path parameters

  • store
    string
    required

    A hostname of the store.

  • product
    string
    required

    An id, or slug:<slug>.

    minLength: 1

Query parameters

  • preview
    optional
    string

    A token a seller made for the product's page or one of its entries, which opens an unpublished product's portfolio, gated as ever.

    maxLength: 128 · minLength: 1

Returns

200

Reads a portfolio product's book, as far as the customer may.

JSON
  • exponent
    required

    One of the following:

    • number
    • null
  • product
    object
    required
    • id
      string
      required
    • slug
      string
      required
    • path
      string
      required

      The storefront path.

    • url
      required

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

      One of the following:

      • string
      • null
    • title
      string
      required
  • access
    string
    required
  • chart_cutoff
    required

    One of the following:

    • string
    • null
  • performance
    required

    One of the following:

    • object
    • object
  • holdings
    array of
    object
    required
    • id
      string
      required
    • symbol
      string
      required
    • name
      string
      required
    • symbol_type
      required

      One of the following:

      • string
      • null
    • currency
      required

      One of the following:

      • string
      • null
    • shares
      required

      One of the following:

      • number
      • null
    • avg_cost
      required

      One of the following:

      • number
      • null
    • note
      required

      One of the following:

      • string
      • null
    • updated_at
      required

      One of the following:

      • string
      • null
  • id
    string
    required
  • product_id
    string
    required
  • currency
    string
    required
  • settings
    object
    required
    • show_absolute_values
      boolean
      required
    • locked_chart_delay
      string
      required
  • 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