Skip to content
Navigation

Pages a canceled event's refunds: what each gives back, where it stands, and why one failed.

GET
https://api.sherpo.io/merchant/v1/stores/{store}/products/{product}/event_refunds

Authorization

  • bearer
    HTTP
    required

Path parameters

  • store
    string
    required

    The store's id.

  • product
    string
    required

    An id, or slug:<slug>.

    minLength: 1

Query parameters

  • filter
    optional
    object

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

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

Returns

200

Pages a canceled event's refunds: what each gives back, where it stands, and why one failed.

JSON
  • items
    array of
    object
    required
    • id
      string
      required
    • product_id
      string
      required
    • customer_id
      string
      required
    • order_id
      string
      required
    • settlement_id
      string
      required
    • status
      string
      required

      pending while owed, refunded once given back, failed for the seller to retry, manual for a sale paid outside the store, which the seller refunds.

    • amount
      required

      One of the following:

      • number
      • null
    • currency
      string
      required
    • exponent
      required

      One of the following:

      • number
      • null
    • failure
      required

      Why the last try failed: processor_refused, account_gone, processor_failed, processor_unavailable, nothing_left or order_unreconciled; null unless failed.

      One of the following:

      • string
      • null
    • refund_id
      required

      The refund recorded on the order once it landed.

      One of the following:

      • string
      • null
    • processor_ref
      required

      One of the following:

      • string
      • null
    • refunded_at
      required

      One of the following:

      • string
      • null
    • created_at
      string
      required
    • customer
      required

      Who it gives back to, erased once their details are wiped.

      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