Skip to content
Navigation

Reads one of the customer's orders.

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

Authorization

  • bearer
    HTTP
    required

Path parameters

  • store
    string
    required

    A hostname of the store.

  • order
    string
    required
    minLength: 1

Returns

200

Reads one of the customer's orders.

JSON
  • renewed_subscription_ids
    array of
    string
    required

    The subscriptions it paid a later period of; empty for a first purchase, an upgrade or a fresh start.

  • has_receipt
    boolean
    required
  • item_count
    number
    required
  • items
    array of
    object
    required
    • product
      required

      One of the following:

      • object
      • 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
    • amount
      number
      required
    • discount
      number
      required
    • total
      number
      required
    • descriptor
      object
      required
      • product
        required

        One of the following:

        • string
        • null
      • price
        required

        One of the following:

        • string
        • null
      • tier
        required

        One of the following:

        • string
        • null
      • coupon
        required

        One of the following:

        • string
        • null
      • display_name
        required

        One of the following:

        • string
        • null
      • message
        required

        One of the following:

        • string
        • null
  • refunded
    number
    required

    Every refund summed, past the preview.

  • refund_status
    required

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

    One of the following:

    • string
    • null
  • refund_count
    number
    required
  • refunds
    array of
    object
    required
    • id
      string
      required
    • order_id
      string
      required
    • amount
      number
      required
    • currency
      string
      required
    • reason
      required

      One of the following:

      • string
      • null
    • occurred_at
      required

      One of the following:

      • string
      • null
  • id
    string
    required
  • number
    number
    required
  • currency
    string
    required
  • exponent
    required

    One of the following:

    • number
    • null
  • amount
    number
    required
  • discount
    number
    required
  • total
    number
    required
  • source
    string
    required
  • note
    required

    One of the following:

    • string
    • null
  • statements
    object
    required
    • coupon
      required

      One of the following:

      • string
      • null
    • method
      required

      One of the following:

      • string
      • null
    • method_details
      required

      One of the following:

      • object
      • null
    • refund_waiver
      required

      One of the following:

      • object
      • null
    • under_minimum
      required

      One of the following:

      • object
      • null
  • occurred_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