Skip to content
Navigation

Creates a customer notification for an event.

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

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

  • event
    products.unlocked
    or
    request.received
    or
    request.waitlisted
    or
    request.approved
    or
    request.declined
    or
    request.expired
    +18 more
    required
  • target
    optional

    One of the following:

    • object
    • null
  • locale
    optional
    string
    maxLength: 5 · minLength: 1 · pattern: ^[a-z]{2}(?:-[A-Z]{2})?$
  • channel
    optional
    email
    or
    webhook

    Only email: webhook is refused, since webhooks are endpoints of their own.

  • enabled
    optional
    boolean

Returns

201

Creates a customer notification for an event.

JSON
  • id
    string
    required
  • event
    string
    required
  • target
    required

    One of the following:

    • object
    • null
  • locale
    string
    required
  • channel
    string
    required
  • enabled
    boolean
    required
  • in_effect
    boolean
    required
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