Skip to content
Navigation

Records a trade, cash movement or note in a portfolio.

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

Authorization

  • bearer
    HTTP
    required

Path parameters

  • store
    string
    required

    The store's id.

  • product
    string
    required

    An id, or slug:<slug>.

    minLength: 1

Request body JSON required

One of the following:

  • object
  • object
  • object
  • object
  • object
  • object
  • object
  • object
  • object

Returns

201

Records a trade, cash movement or note in a portfolio.

JSON
  • id
    string
    required
  • portfolio_id
    string
    required
  • symbol
    required

    One of the following:

    • string
    • null
  • type
    string
    required
  • shares
    required

    One of the following:

    • number
    • null
  • price
    required

    One of the following:

    • number
    • null
  • amount
    required

    One of the following:

    • number
    • null
  • note
    required

    One of the following:

    • string
    • null
  • effective_date
    required

    One of the following:

    • string
    • null
  • symbol_type
    required

    One of the following:

    • string
    • null
  • currency
    string
    required
  • exponent
    required

    One of the following:

    • number
    • null
  • price_currency
    string
    required
  • price_exponent
    required

    One of the following:

    • number
    • null
  • allocation
    required

    One of the following:

    • number
    • null
  • allocation_change
    required

    One of the following:

    • number
    • null
  • ratio
    required

    One of the following:

    • object
    • null
  • occurred_at
    required

    One of the following:

    • string
    • null
  • recorded_at
    required

    One of the following:

    • string
    • null
  • metadata
    object
    required
    • source
      optional
      string

      manual for a member's entry, auto for the pipeline.

    • recorded_by
      optional
      string

      The member who recorded a manual entry.

    • file_ids
      optional
      array of
      string

      For a file event, the assets it announces on the holding.

    • remediated
      optional
      boolean

      A later correction stands in for it.

    • kind
      optional
      string

      For a split, what the ratio alone cannot tell apart.

    • name
      optional
      string

      The instrument's name core resolved when the event was recorded, never a member's.

    • notify
      optional
      boolean

      For a trade, whether the seller asked to notify the customers with access.

    • price_quoted
      optional
      boolean

      The price was left empty and took the symbol's latest quote.

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