Skip to content
Navigation

Pages the store's orders.

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

Authorization

  • bearer
    HTTP
    required

Path parameters

  • store
    string
    required

    The store's id.

Query parameters

  • filter
    optional
    object

    filter[<field>]=<value> is an equality, filter[<field>][<op>]=<value> names the operator; in repeats the parameter.

  • sort
    optional
    occurred
    or
    number
    or
    amount
    or
    fees
    or
    customer
    or
    coupon

    Sorted by customer or coupon, rows without a value come last either way.

  • direction
    optional
    asc
    or
    desc
  • limit
    optional
    integer
    maximum: 100 · minimum: 1
  • cursor
    optional
    string
    maxLength: 8192
  • count
    optional
    boolean
  • search
    optional
    string
    maxLength: 200 · minLength: 1
  • facets
    optional
    array of
    string

Returns

200

Pages the store's orders.

JSON
  • items
    array of
    object
    required
    • customer
      required

      One of the following:

      • object
      • null
    • settled
      required

      One of the following:

      • number
      • null
    • refunded
      required

      One of the following:

      • number
      • null
    • revocable
      boolean
      required

      Whether a revocation of the order would end anything: its customer's grants or running subscriptions on its products, or its guests' tickets.

    • revocation
      required

      The latest revocation of its access for cause; null while none.

      One of the following:

      • object
      • null
    • failed_revocations
      object
      required
      • items
        array of
        object
        required
        • id
          string
          required
        • customer_id
          string
          required
        • order_id
          required

          One of the following:

          • string
          • null
        • grant_id
          required

          One of the following:

          • string
          • null
        • product_ids
          array of
          string
          required
        • cause
          string
          required
        • note
          required

          One of the following:

          • string
          • null
        • message
          required

          One of the following:

          • string
          • null
        • refund
          required

          One of the following:

          • object
          • null
        • revoked_by
          required

          One of the following:

          • string
          • null
        • token_id
          required

          One of the following:

          • string
          • null
        • created_at
          required

          One of the following:

          • string
          • null
      • total
        number
        required
    • refund_status
      required

      How much of what it settled came back: none, part or all of it; null while it settled and refunded nothing, or withheld.

      One of the following:

      • string
      • null
    • lines
      object
      required
      • 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
      • total
        number
        required
    • settlements
      object
      required
      • items
        array of
        object
        required
        • id
          string
          required
        • order_id
          string
          required
        • processor
          required

          One of the following:

          • string
          • null
        • processor_ref
          required

          One of the following:

          • string
          • null
        • account_ref
          required

          One of the following:

          • string
          • null
        • custodian
          string
          required
        • currency
          string
          required
        • exponent
          required

          One of the following:

          • number
          • null
        • amount
          required

          One of the following:

          • number
          • null
        • platform_fee
          required

          One of the following:

          • number
          • null
        • processor_fee
          required

          One of the following:

          • number
          • null
        • occurred_at
          required

          One of the following:

          • string
          • null
        • recorded_at
          required

          One of the following:

          • string
          • null
      • total
        number
        required
    • refunds
      object
      required
      • items
        array of
        object
        required
        • id
          string
          required
        • settlement_id
          string
          required
        • order_id
          string
          required
        • processor_ref
          required

          One of the following:

          • string
          • null
        • amount
          required

          One of the following:

          • number
          • null
        • currency
          string
          required
        • exponent
          required

          One of the following:

          • number
          • null
        • reason
          required

          One of the following:

          • string
          • null
        • occurred_at
          required

          One of the following:

          • string
          • null
        • recorded_at
          required

          One of the following:

          • string
          • null
      • total
        number
        required
    • affiliates
      object
      required
      • items
        array of
        object
        required
        • settlement_id
          string
          required
        • order_item_id
          string
          required
        • order_id
          string
          required
        • user_id
          string
          required
        • discount_id
          required

          One of the following:

          • string
          • null
        • currency
          string
          required
        • exponent
          required

          One of the following:

          • number
          • null
        • fee
          required

          One of the following:

          • number
          • null
        • resolution_id
          required

          One of the following:

          • string
          • null
      • total
        number
        required
    • id
      string
      required
    • number
      number
      required
    • customer_id
      required

      One of the following:

      • string
      • null
    • 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
    • free
      boolean
      required
    • fees
      required

      One of the following:

      • number
      • null
    • source
      string
      required
    • source_key
      required

      One of the following:

      • string
      • null
    • statements
      object
      required
      • coupon
        optional
        string
      • customer_status
        optional
        string

        How well the buyer was known; fake is a seeded order.

      • method
        optional
        string

        The payment method the processor reported.

      • method_details
        optional
        object

        What the method shows, as a saved instrument's display: its brand and last 4 digits.

        • brand
          required

          One of the following:

          • string
          • null
        • last4
          required

          One of the following:

          • string
          • null
      • refund_waiver
        optional
        object

        Carried from the checkout.

        • policy
          string
          required

          The strictest policy among the lines, the one consented to.

        • accepted_at
          string
          required
      • under_minimum
        optional
        object
        • processor
          string
          required
        • minimum
          required

          Null when the processor refused the payment as too small rather than core reading its minimum.

          One of the following:

          • number
          • null
        • amount
          required

          One of the following:

          • number
          • null
    • note
      required

      One of the following:

      • string
      • null
    • occurred_at
      required

      One of the following:

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