Skip to content
Navigation

Answers a product's registration questions while the customer buys it; checkout asks for every required one, and any answer off its pattern, before payment.

PUT
https://api.sherpo.io/customer/v1/stores/{store}/products/{product}/answers

Authorization

  • bearer
    HTTP
    required

Path parameters

  • store
    string
    required

    A hostname of the store.

  • product
    string
    required

    An id, or slug:<slug>.

    minLength: 1

Request body JSON required

  • answers
    array of
    object
    required

    One answer per question; a question left out keeps what it holds.

    • question
      string
      required
    • value
      required

      A trimmed text for a text (one line, at most 300) or long_text (at most 3000) question, an option for a select, options for a multi_select, a boolean for a checkbox; null or a blank text clears an optional one.

      One of the following:

      • boolean
      • string
      • array<string>
      • null
  • checkout
    optional
    object

    The customer's cart the answers are given in; named, it must be theirs, open or frozen, and hold the product, else nothing is written.

    • id
      string
      required
      maxLength: 512 · minLength: 1

Returns

200

Answers a product's registration questions while the customer buys it; checkout asks for every required one, and any answer off its pattern, before payment.

JSON
  • product_id
    string
    required
  • answers
    array of
    object
    required

    The customer's answers in the questions' order; one no longer standing, as a pick since taken off, is absent.

    • 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