---
title: "Pages the customer's orders."
---

> Documentation Index
> Fetch the complete documentation index at: https://docs.sherpo.io/llms.txt
> Use this file to discover all available pages before exploring further.

Path: Sherpo customer API › order

`GET /v1/stores/{store}/orders`

## Authentication

- `bearer`, http, header `Authorization`, scopes: `read`

## Path parameters

- `store` (`listOrders.path.store`; string, required) — A hostname of the store.

## Query parameters

- `filter` (`listOrders.query.filter`; object, optional) — `filter[<field>]=<value>` is an equality, `filter[<field>][<op>]=<value>` names the operator; `in` repeats the parameter.
- `sort` (`listOrders.query.sort`; string, optional)
  - one of `"occurred"`
- `direction` (`listOrders.query.direction`; string, optional)
  - one of `"asc"`, `"desc"`
- `limit` (`listOrders.query.limit`; integer, optional)
  - min 1; max 100
- `cursor` (`listOrders.query.cursor`; string, optional)
  - maxLength 8192
- `count` (`listOrders.query.count`; boolean, optional)

## Code samples

### cURL

```bash
curl --request GET \
  --url 'https://api.sherpo.io/customer/v1/stores/<store>/orders' \
  --header 'Authorization: Bearer <token>'
```

### TypeScript

```typescript
const url = 'https://api.sherpo.io/customer/v1/stores/<store>/orders';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));
```

### Python

```python
import requests

url = "https://api.sherpo.io/customer/v1/stores/<store>/orders"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
```

## Responses

### 200

Pages the customer's orders.

#### Example

```json
{
  "total": 0,
  "items": [
    {
      "renewed_subscription_ids": [
        "string"
      ],
      "has_receipt": true,
      "item_count": 0,
      "items": [
        {
          "product": {
            "id": "string",
            "slug": "string",
            "path": "string",
            "url": "string",
            "title": "string",
            "category": "string",
            "deleted": true
          },
          "id": "string",
          "order_id": "string",
          "product_id": "string",
          "tier_id": "string",
          "price_id": "string",
          "position": 0,
          "quantity": 0,
          "amount": 0,
          "discount": 0,
          "total": 0,
          "descriptor": {
            "product": "string",
            "price": "string",
            "tier": "string",
            "coupon": "string",
            "display_name": "string",
            "message": "string"
          }
        }
      ],
      "refunded": 0,
      "refund_status": "string",
      "refund_count": 0,
      "refunds": [
        {
          "id": "string",
          "order_id": "string",
          "amount": 0,
          "currency": "string",
          "reason": "string",
          "occurred_at": "string"
        }
      ],
      "id": "string",
      "number": 0,
      "currency": "string",
      "exponent": 0,
      "amount": 0,
      "discount": 0,
      "total": 0,
      "source": "string",
      "note": "string",
      "statements": {
        "coupon": "string",
        "method": "string",
        "method_details": {
          "brand": "string",
          "last4": "string"
        },
        "refund_waiver": {
          "policy": "string",
          "accepted_at": "string"
        },
        "under_minimum": {
          "processor": "stripe",
          "amount": 0,
          "minimum": 0
        }
      },
      "occurred_at": "string"
    }
  ],
  "cursor": "string"
}
```

- `items` (`listOrders.response.200.items`; array<object>, required)
  - `renewed_subscription_ids` (`listOrders.response.200.items.renewed_subscription_ids`; array<string>, required) — The subscriptions it paid a later period of; empty for a first purchase, an upgrade or a fresh start.
  - `has_receipt` (`listOrders.response.200.items.has_receipt`; boolean, required)
  - `item_count` (`listOrders.response.200.items.item_count`; number, required)
  - `items` (`listOrders.response.200.items.items`; array<object>, required)
    - `product` (`listOrders.response.200.items.items.product`; any of, required)
      - any of: `object`, `null`
    - `id` (`listOrders.response.200.items.items.id`; string, required)
    - `order_id` (`listOrders.response.200.items.items.order_id`; string, required)
    - `product_id` (`listOrders.response.200.items.items.product_id`; any of, required)
      - any of: `string`, `null`
    - `tier_id` (`listOrders.response.200.items.items.tier_id`; any of, required)
      - any of: `string`, `null`
    - `price_id` (`listOrders.response.200.items.items.price_id`; any of, required)
      - any of: `string`, `null`
    - `position` (`listOrders.response.200.items.items.position`; number, required)
    - `quantity` (`listOrders.response.200.items.items.quantity`; number, required)
    - `amount` (`listOrders.response.200.items.items.amount`; number, required)
    - `discount` (`listOrders.response.200.items.items.discount`; number, required)
    - `total` (`listOrders.response.200.items.items.total`; number, required)
    - `descriptor` (`listOrders.response.200.items.items.descriptor`; object, required)
      - `product` (`listOrders.response.200.items.items.descriptor.product`; any of, required)
        - any of: `string`, `null`
      - `price` (`listOrders.response.200.items.items.descriptor.price`; any of, required)
        - any of: `string`, `null`
      - `tier` (`listOrders.response.200.items.items.descriptor.tier`; any of, required)
        - any of: `string`, `null`
      - `coupon` (`listOrders.response.200.items.items.descriptor.coupon`; any of, required)
        - any of: `string`, `null`
      - `display_name` (`listOrders.response.200.items.items.descriptor.display_name`; any of, required)
        - any of: `string`, `null`
      - `message` (`listOrders.response.200.items.items.descriptor.message`; any of, required)
        - any of: `string`, `null`
  - `refunded` (`listOrders.response.200.items.refunded`; number, required) — Every refund summed, past the preview.
  - `refund_status` (`listOrders.response.200.items.refund_status`; any of, required) — How much of what it settled came back: none, part or all of it; null while it settled and refunded nothing.
    - any of: `string`, `null`
  - `refund_count` (`listOrders.response.200.items.refund_count`; number, required)
  - `refunds` (`listOrders.response.200.items.refunds`; array<object>, required)
    - `id` (`listOrders.response.200.items.refunds.id`; string, required)
    - `order_id` (`listOrders.response.200.items.refunds.order_id`; string, required)
    - `amount` (`listOrders.response.200.items.refunds.amount`; number, required)
    - `currency` (`listOrders.response.200.items.refunds.currency`; string, required)
    - `reason` (`listOrders.response.200.items.refunds.reason`; any of, required)
      - any of: `string`, `null`
    - `occurred_at` (`listOrders.response.200.items.refunds.occurred_at`; any of, required)
      - any of: `string`, `null`
  - `id` (`listOrders.response.200.items.id`; string, required)
  - `number` (`listOrders.response.200.items.number`; number, required)
  - `currency` (`listOrders.response.200.items.currency`; string, required)
  - `exponent` (`listOrders.response.200.items.exponent`; any of, required)
    - any of: `number`, `null`
  - `amount` (`listOrders.response.200.items.amount`; number, required)
  - `discount` (`listOrders.response.200.items.discount`; number, required)
  - `total` (`listOrders.response.200.items.total`; number, required)
  - `source` (`listOrders.response.200.items.source`; string, required)
  - `note` (`listOrders.response.200.items.note`; any of, required)
    - any of: `string`, `null`
  - `statements` (`listOrders.response.200.items.statements`; object, required)
    - `coupon` (`listOrders.response.200.items.statements.coupon`; any of, required)
      - any of: `string`, `null`
    - `method` (`listOrders.response.200.items.statements.method`; any of, required)
      - any of: `string`, `null`
    - `method_details` (`listOrders.response.200.items.statements.method_details`; any of, required)
      - any of: `object`, `null`
    - `refund_waiver` (`listOrders.response.200.items.statements.refund_waiver`; any of, required)
      - any of: `object`, `null`
    - `under_minimum` (`listOrders.response.200.items.statements.under_minimum`; any of, required)
      - any of: `object`, `null`
  - `occurred_at` (`listOrders.response.200.items.occurred_at`; any of, required)
    - any of: `string`, `null`
- `cursor` (`listOrders.response.200.cursor`; any of, required)
  - any of: `string`, `null`
- `total` (`listOrders.response.200.total`; number, optional)

### default

A problem; see https://api.sherpo.io/customer/docs/errors.

#### Example

```json
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "code": "string",
  "context": {},
  "reached_core": true,
  "core_answer": "string"
}
```

- `type` (`listOrders.response.default.type`; string, required)
  - format `uri`
- `title` (`listOrders.response.default.title`; string, required)
- `status` (`listOrders.response.default.status`; integer, required)
- `detail` (`listOrders.response.default.detail`; string, required)
- `code` (`listOrders.response.default.code`; string, optional)
- `context` (`listOrders.response.default.context`; object, optional)
- `reached_core` (`listOrders.response.default.reached_core`; boolean, optional)
- `core_answer` (`listOrders.response.default.core_answer`; string, optional)


Source: https://docs.sherpo.io/customer-api/reference/list-orders/index.md
