Skip to content
Navigation

Reads commission totals over a period.

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

Authorization

  • bearer
    HTTP
    required

Path parameters

  • store
    string
    required

    The store's id.

Query parameters

  • from
    optional
    string
    format: date
  • to
    optional
    string
    format: date
  • bucket
    optional
    day
    or
    week
    or
    month
  • user
    optional
    string

    An id.

    minLength: 1
  • discount
    optional
    string

    An id.

    minLength: 1

Returns

200

Reads commission totals over a period.

JSON
  • currencies
    array of
    object
    required
    • currency
      string
      required
    • exponent
      required

      One of the following:

      • number
      • null
    • earned
      required

      One of the following:

      • number
      • null
    • unpaid
      required

      One of the following:

      • number
      • null
    • paid
      required

      One of the following:

      • number
      • null
    • voided
      required

      One of the following:

      • number
      • null
    • commissions
      number
      required
    • range_earned
      required

      One of the following:

      • object
      • null
    • range_commissions
      object
      required
      • current
        number
        required
      • previous
        number
        required
    • series
      array of
      object
      required
      • start
        string
        required
      • end
        string
        required
      • earned
        required

        One of the following:

        • number
        • null
      • commissions
        number
        required
      • previous_earned
        required

        One of the following:

        • number
        • null
      • previous_commissions
        number
        required
  • bucket
    string
    required
  • time_zone
    string
    required
  • from
    string
    required
  • to
    string
    required
  • previous_range
    object
    required
    • from
      string
      required
    • to
      string
      required
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