Skip to content
Navigation

Pages a product's requests: buyers waiting for approval, an event's waitlist, and those decided.

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

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
    or
    latest
  • direction
    optional
    asc
    or
    desc
  • limit
    optional
    integer
    maximum: 100 · minimum: 1
  • cursor
    optional
    string
    maxLength: 8192
  • count
    optional
    boolean
  • search
    optional
    string
    maxLength: 200 · minLength: 1
  • facets
    optional
    array of
    string

Returns

200

Pages a product's requests: buyers waiting for approval, an event's waitlist, and those decided.

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

      pending until the seller decides, waitlisted while it waits for a seat, then approved or declined.

    • tier
      required

      The tier asked for; null for none.

      One of the following:

      • object
      • null
    • price_id
      required

      The price asked at.

      One of the following:

      • string
      • null
    • payment
      required

      A paid request's payment: saved while its card waits to be charged on approval, held while its total is held on the card, charging once approved, due from the buyer once a charge failed or found no card; null for a free one or once decided.

      One of the following:

      • string
      • null
    • hold_expires_at
      required

      When a held request's card hold is released, closing it as expired unless decided first; null otherwise.

      One of the following:

      • string
      • null
    • quantity
      integer
      required

      How many tickets it asks for.

      minimum: 1
    • order_item_id
      required

      The order line that asked, or the one a promotion recorded; null while on a waitlist.

      One of the following:

      • string
      • null
    • grant_id
      required

      The grant an approval gave.

      One of the following:

      • string
      • null
    • created_at
      string
      required
    • decided_at
      required

      One of the following:

      • string
      • null
    • closed_reason
      required

      expired for a request declined because its card hold was released before anyone decided; null otherwise.

      One of the following:

      • string
      • null
    • customer
      required

      Who they are, erased once their details are wiped.

      One of the following:

      • object
      • null
    • answers
      array of
      object
      required

      Their answers to the product's registration questions, in the questions' order; none without customer:read.

      • question_id
        string
        required
      • value
        required

        One of the following:

        • boolean
        • string
        • array<string>
  • 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