Skip to content
Navigation

Records a payout made to an affiliate.

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

Authorization

  • bearer
    HTTP
    required

Path parameters

  • store
    string
    required

    The store's id.

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 required

One of the following:

  • object
  • object

Returns

201

Records a payout made to an affiliate.

JSON
  • commissions
    number
    required
  • 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
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