Skip to content
Navigation

Pages the payouts recorded to affiliates.

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

Authorization

  • bearer
    HTTP
    required

Path parameters

  • store
    string
    required

    The store's id.

Query parameters

  • filter
    optional
    object

    filter[<field>]=<value> is an equality, filter[<field>][<op>]=<value> names the operator; in repeats the parameter.

  • sort
    optional
    occurred
  • direction
    optional
    asc
    or
    desc
  • limit
    optional
    integer
    maximum: 100 · minimum: 1
  • cursor
    optional
    string
    maxLength: 8192
  • count
    optional
    boolean

Returns

200

Pages the payouts recorded to affiliates.

JSON
  • items
    array of
    object
    required
    • commissions
      number
      required
    • fees
      required

      One of the following:

      • number
      • null
    • id
      string
      required
    • user_id
      string
      required
    • currency
      string
      required
    • exponent
      required

      One of the following:

      • number
      • null
    • kind
      string
      required
    • amount
      required

      One of the following:

      • number
      • null
    • processor
      required

      One of the following:

      • string
      • null
    • processor_ref
      required

      One of the following:

      • string
      • null
    • reason
      required

      One of the following:

      • string
      • null
    • occurred_at
      required

      One of the following:

      • string
      • null
    • recorded_at
      required

      One of the following:

      • string
      • null
    • user
      required

      One of the following:

      • object
      • null
  • cursor
    required

    One of the following:

    • string
    • null
  • total
    optional
    number
  • facets
    optional
    map of
    map<number>
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