Skip to content
Navigation

Pages an order's lines.

GET
https://api.sherpo.io/merchant/v1/stores/{store}/orders/{order}/items

Authorization

  • bearer
    HTTP
    required

Path parameters

  • store
    string
    required

    The store's id.

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

Returns

200

Pages an order's lines.

JSON
  • items
    array of
    object
    required
    • product
      required

      One of the following:

      • object
      • null
    • guests
      array of
      object
      required
      • id
        string
        required
      • status
        string
        required
      • customer_id
        string
        required
      • customer
        required

        One of the following:

        • object
        • null
    • revocable
      boolean
      required

      Whether a revocation of the order would end anything on the line: its customer's grant or running subscription of the product, or a guest's ticket to it.

    • platform_fee
      required

      One of the following:

      • number
      • null
    • processor_fee
      required

      One of the following:

      • number
      • null
    • affiliate_fee
      required

      One of the following:

      • number
      • null
    • refunded
      required

      One of the following:

      • number
      • null
    • id
      string
      required
    • order_id
      string
      required
    • product_id
      required

      One of the following:

      • string
      • null
    • tier_id
      required

      One of the following:

      • string
      • null
    • price_id
      required

      One of the following:

      • string
      • null
    • position
      number
      required
    • quantity
      number
      required
    • currency
      string
      required
    • exponent
      required

      One of the following:

      • number
      • null
    • amount
      required

      One of the following:

      • number
      • null
    • discount
      required

      One of the following:

      • number
      • null
    • total
      required

      One of the following:

      • number
      • null
    • descriptor
      object
      required
      • product
        optional

        One of the following:

        • string
        • null
      • price
        optional

        One of the following:

        • string
        • null
      • tier
        optional

        One of the following:

        • string
        • null
      • coupon
        optional
        string
      • display_name
        optional
        string

        The name and message the buyer left with a tip or a donation.

      • message
        optional
        string
  • 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