Skip to content
Navigation

Lets a waitlisted buyer in once the event has their seats: a free order takes them and the buyer is granted at once.

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

Authorization

  • bearer
    HTTP
    required

Path parameters

  • store
    string
    required

    The store's id.

  • product
    string
    required

    An id, or slug:<slug>.

    minLength: 1
  • request
    string
    required
    minLength: 1

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 optional

Returns

200

Lets a waitlisted buyer in once the event has their seats: a free order takes them and the buyer is granted at once.

JSON
  • 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>
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