Skip to content
Navigation

Records a release, whose files become the current download, or a note on a software product.

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

Authorization

  • bearer
    HTTP
    required

Path parameters

  • store
    string
    required

    The store's id.

  • product
    string
    required

    An id, or slug:<slug>.

    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 required

One of the following:

  • object
  • object

Returns

201

Records a release, whose files become the current download, or a note on a software product.

JSON
  • id
    string
    required
  • product_id
    string
    required
  • type
    string
    required

    release or note.

  • version
    required

    A release's version; null for a note.

    One of the following:

    • string
    • null
  • body
    required

    The release notes or the note, as plain text.

    One of the following:

    • string
    • null
  • current
    boolean
    required

    Whether it is the product's current download: its newest release that ships files.

  • files
    array of
    object
    required
    • attachment_id
      string
      required
    • asset_id
      string
      required
    • tier
      required

      The lowest tier that downloads the file, by its own gate; null for every tier.

      One of the following:

      • object
      • null
    • name
      string
      required
    • ext
      required

      One of the following:

      • string
      • null
    • mime
      required

      One of the following:

      • string
      • null
    • bytes
      number
      required
    • description
      required

      The file's description, as its download shows it to holders; null for none.

      One of the following:

      • string
      • null
  • tier
    required

    The lowest tier whose holders download its files, while every file is gated to it; null for every tier.

    One of the following:

    • object
    • null
  • push
    string
    required

    Its push: none never asked, pending owed, sent to its holders, or dropped for good (its files failed, or a newer release came first).

  • push_reason
    required

    Why a dropped push was dropped: superseded, files (failed or never finished), removed (they left the release), unavailable (the product wasn't open) or failed; null otherwise.

    One of the following:

    • string
    • null
  • notified
    number
    required

    How many holders its push reached so far.

  • occurred_at
    required

    One of the following:

    • string
    • null
  • created_at
    required

    One of the following:

    • string
    • null
  • updated_at
    required

    One of the following:

    • string
    • null
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