Skip to content
Navigation

Pages the prices of the store's products, or of one product.

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

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
    product
  • direction
    optional
    asc
    or
    desc
  • limit
    optional
    integer
    maximum: 100 · minimum: 1
  • cursor
    optional
    string
    maxLength: 8192
  • count
    optional
    boolean

Returns

200

Pages the prices of the store's products, or of one product.

JSON
  • items
    array of
    object
    required
    • product
      required

      One of the following:

      • object
      • null
    • tier
      required

      One of the following:

      • object
      • null
    • in_use
      object
      required
      • orders
        number
        required
      • subscriptions
        number
        required
      • checkouts
        number
        required
      • automations
        number
        required
      • discounts
        number
        required
    • id
      string
      required
    • product_id
      string
      required
    • tier_id
      string
      required
    • currency
      string
      required
    • exponent
      required

      One of the following:

      • number
      • null
    • amount
      number
      required
    • kind
      string
      required
    • period
      required

      One of the following:

      • object
      • null
    • highlighted
      boolean
      required
    • title
      required

      One of the following:

      • string
      • null
    • description
      required

      One of the following:

      • string
      • null
    • settings
      object
      required
      • autorenew
        optional
        boolean

        Recurring only; false stops the renewal, absent renews.

      • renewal_discount
        optional
        integer

        Recurring only, a percent off every renewal.

        maximum: 100 · minimum: 0
      • upgrade_multiplier
        optional
        number

        One-time only, a factor on the difference paid to move up a tier.

        maximum: 10 · minimum: 1
      • refund_policy
        optional
        string

        Overrides the product's.

    • archived_at
      required

      One of the following:

      • string
      • null
    • created_at
      required

      One of the following:

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