---
title: "Pages the store'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 merchant API › transaction

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

## Authentication

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

## Path parameters

- `store` (`listOrders.path.store`; string, required) — The store's id.

## 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) — Sorted by customer or coupon, rows without a value come last either way.
  - one of `"occurred"`, `"number"`, `"amount"`, `"fees"`, `"customer"`, `"coupon"`
- `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)
- `search` (`listOrders.query.search`; string, optional)
  - minLength 1; maxLength 200
- `facets` (`listOrders.query.facets`; array<string>, optional)

## Code samples

### cURL

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

### TypeScript

```typescript
const url = 'https://api.sherpo.io/merchant/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/merchant/v1/stores/<store>/orders"

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

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

print(response.text)
```

## Responses

### 200

Pages the store's orders.

#### Example

```json
{
  "items": [
    {
      "customer": {
        "id": "string",
        "name": "string",
        "email": "string",
        "phone": "string",
        "erased": true
      },
      "settled": 0,
      "refunded": 0,
      "revocable": true,
      "revocation": {
        "id": "string",
        "customer_id": "string",
        "order_id": "string",
        "grant_id": "string",
        "product_ids": [
          "string"
        ],
        "cause": "string",
        "note": "string",
        "message": "string",
        "refund": {
          "via": "string",
          "amount": 0,
          "currency": "string",
          "exponent": 0,
          "settlement_id": "string",
          "refund_id": "string",
          "status": "string"
        },
        "revoked_by": "string",
        "token_id": "string",
        "created_at": "string"
      },
      "failed_revocations": {
        "items": [
          {
            "id": "string",
            "customer_id": "string",
            "order_id": "string",
            "grant_id": "string",
            "product_ids": [
              "string"
            ],
            "cause": "string",
            "note": "string",
            "message": "string",
            "refund": {
              "via": "string",
              "amount": 0,
              "currency": "string",
              "exponent": 0,
              "settlement_id": "string",
              "refund_id": "string",
              "status": "string"
            },
            "revoked_by": "string",
            "token_id": "string",
            "created_at": "string"
          }
        ],
        "total": 0
      },
      "refund_status": "string",
      "lines": {
        "items": [
          {
            "product": {
              "id": "string",
              "slug": "string",
              "path": "string",
              "url": "string",
              "title": "string",
              "category": "string",
              "deleted": true
            },
            "guests": [
              {}
            ],
            "revocable": true,
            "platform_fee": 0,
            "processor_fee": 0,
            "affiliate_fee": 0,
            "refunded": 0,
            "id": "string",
            "order_id": "string",
            "product_id": "string",
            "tier_id": "string",
            "price_id": "string",
            "position": 0,
            "quantity": 0,
            "currency": "string",
            "exponent": 0,
            "amount": 0,
            "discount": 0,
            "total": 0,
            "descriptor": {
              "product": "string",
              "price": "string",
              "tier": "string",
              "coupon": "string",
              "display_name": "string",
              "message": "string",
              "property1": true,
              "property2": true
            }
          }
        ],
        "total": 0
      },
      "settlements": {
        "items": [
          {
            "id": "string",
            "order_id": "string",
            "processor": "string",
            "processor_ref": "string",
            "account_ref": "string",
            "custodian": "string",
            "currency": "string",
            "exponent": 0,
            "amount": 0,
            "platform_fee": 0,
            "processor_fee": 0,
            "occurred_at": "string",
            "recorded_at": "string"
          }
        ],
        "total": 0
      },
      "refunds": {
        "items": [
          {
            "id": "string",
            "settlement_id": "string",
            "order_id": "string",
            "processor_ref": "string",
            "amount": 0,
            "currency": "string",
            "exponent": 0,
            "reason": "string",
            "occurred_at": "string",
            "recorded_at": "string"
          }
        ],
        "total": 0
      },
      "affiliates": {
        "items": [
          {
            "settlement_id": "string",
            "order_item_id": "string",
            "order_id": "string",
            "user_id": "string",
            "discount_id": "string",
            "currency": "string",
            "exponent": 0,
            "fee": 0,
            "resolution_id": "string"
          }
        ],
        "total": 0
      },
      "id": "string",
      "number": 0,
      "customer_id": "string",
      "currency": "string",
      "exponent": 0,
      "amount": 0,
      "discount": 0,
      "total": 0,
      "free": true,
      "fees": 0,
      "source": "string",
      "source_key": "string",
      "statements": {
        "coupon": "string",
        "customer_status": "string",
        "method": "string",
        "method_details": {
          "brand": "string",
          "last4": "string"
        },
        "refund_waiver": {
          "policy": "string",
          "accepted_at": "string"
        },
        "under_minimum": {
          "processor": "stripe",
          "minimum": 0,
          "amount": 0
        },
        "property1": true,
        "property2": true
      },
      "note": "string",
      "occurred_at": "string",
      "recorded_at": "string"
    }
  ],
  "cursor": "string",
  "total": 0,
  "facets": {
    "property1": {
      "property1": 0,
      "property2": 0
    },
    "property2": {
      "property1": 0,
      "property2": 0
    }
  }
}
```

- `items` (`listOrders.response.200.items`; array<object>, required)
  - `customer` (`listOrders.response.200.items.customer`; any of, required)
    - any of: `object`, `null`
  - `settled` (`listOrders.response.200.items.settled`; any of, required)
    - any of: `number`, `null`
  - `refunded` (`listOrders.response.200.items.refunded`; any of, required)
    - any of: `number`, `null`
  - `revocable` (`listOrders.response.200.items.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` (`listOrders.response.200.items.revocation`; any of, required) — The latest revocation of its access for cause; null while none.
    - any of: `object`, `null`
  - `failed_revocations` (`listOrders.response.200.items.failed_revocations`; object, required)
    - `items` (`listOrders.response.200.items.failed_revocations.items`; array<object>, required)
      - `id` (`listOrders.response.200.items.failed_revocations.items.id`; string, required)
      - `customer_id` (`listOrders.response.200.items.failed_revocations.items.customer_id`; string, required)
      - `order_id` (`listOrders.response.200.items.failed_revocations.items.order_id`; any of, required)
        - any of: `string`, `null`
      - `grant_id` (`listOrders.response.200.items.failed_revocations.items.grant_id`; any of, required)
        - any of: `string`, `null`
      - `product_ids` (`listOrders.response.200.items.failed_revocations.items.product_ids`; array<string>, required)
      - `cause` (`listOrders.response.200.items.failed_revocations.items.cause`; string, required)
      - `note` (`listOrders.response.200.items.failed_revocations.items.note`; any of, required)
        - any of: `string`, `null`
      - `message` (`listOrders.response.200.items.failed_revocations.items.message`; any of, required)
        - any of: `string`, `null`
      - `refund` (`listOrders.response.200.items.failed_revocations.items.refund`; any of, required)
        - any of: `object`, `null`
      - `revoked_by` (`listOrders.response.200.items.failed_revocations.items.revoked_by`; any of, required)
        - any of: `string`, `null`
      - `token_id` (`listOrders.response.200.items.failed_revocations.items.token_id`; any of, required)
        - any of: `string`, `null`
      - `created_at` (`listOrders.response.200.items.failed_revocations.items.created_at`; any of, required)
        - any of: `string`, `null`
    - `total` (`listOrders.response.200.items.failed_revocations.total`; number, required)
  - `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, or withheld.
    - any of: `string`, `null`
  - `lines` (`listOrders.response.200.items.lines`; object, required)
    - `items` (`listOrders.response.200.items.lines.items`; array<object>, required)
      - `product` (`listOrders.response.200.items.lines.items.product`; any of, required)
        - any of: `object`, `null`
      - `guests` (`listOrders.response.200.items.lines.items.guests`; array<object>, required)
        - `id` (`listOrders.response.200.items.lines.items.guests.id`; string, required)
        - `status` (`listOrders.response.200.items.lines.items.guests.status`; string, required)
        - `customer_id` (`listOrders.response.200.items.lines.items.guests.customer_id`; string, required)
        - `customer` (`listOrders.response.200.items.lines.items.guests.customer`; any of, required)
          - any of: `object`, `null`
      - `revocable` (`listOrders.response.200.items.lines.items.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` (`listOrders.response.200.items.lines.items.platform_fee`; any of, required)
        - any of: `number`, `null`
      - `processor_fee` (`listOrders.response.200.items.lines.items.processor_fee`; any of, required)
        - any of: `number`, `null`
      - `affiliate_fee` (`listOrders.response.200.items.lines.items.affiliate_fee`; any of, required)
        - any of: `number`, `null`
      - `refunded` (`listOrders.response.200.items.lines.items.refunded`; any of, required)
        - any of: `number`, `null`
      - `id` (`listOrders.response.200.items.lines.items.id`; string, required)
      - `order_id` (`listOrders.response.200.items.lines.items.order_id`; string, required)
      - `product_id` (`listOrders.response.200.items.lines.items.product_id`; any of, required)
        - any of: `string`, `null`
      - `tier_id` (`listOrders.response.200.items.lines.items.tier_id`; any of, required)
        - any of: `string`, `null`
      - `price_id` (`listOrders.response.200.items.lines.items.price_id`; any of, required)
        - any of: `string`, `null`
      - `position` (`listOrders.response.200.items.lines.items.position`; number, required)
      - `quantity` (`listOrders.response.200.items.lines.items.quantity`; number, required)
      - `currency` (`listOrders.response.200.items.lines.items.currency`; string, required)
      - `exponent` (`listOrders.response.200.items.lines.items.exponent`; any of, required)
        - any of: `number`, `null`
      - `amount` (`listOrders.response.200.items.lines.items.amount`; any of, required)
        - any of: `number`, `null`
      - `discount` (`listOrders.response.200.items.lines.items.discount`; any of, required)
        - any of: `number`, `null`
      - `total` (`listOrders.response.200.items.lines.items.total`; any of, required)
        - any of: `number`, `null`
      - `descriptor` (`listOrders.response.200.items.lines.items.descriptor`; object, required)
        - `product` (`listOrders.response.200.items.lines.items.descriptor.product`; any of, optional)
          - any of: `string`, `null`
        - `price` (`listOrders.response.200.items.lines.items.descriptor.price`; any of, optional)
          - any of: `string`, `null`
        - `tier` (`listOrders.response.200.items.lines.items.descriptor.tier`; any of, optional)
          - any of: `string`, `null`
        - `coupon` (`listOrders.response.200.items.lines.items.descriptor.coupon`; string, optional)
        - `display_name` (`listOrders.response.200.items.lines.items.descriptor.display_name`; string, optional) — The name and message the buyer left with a tip or a donation.
        - `message` (`listOrders.response.200.items.lines.items.descriptor.message`; string, optional)
    - `total` (`listOrders.response.200.items.lines.total`; number, required)
  - `settlements` (`listOrders.response.200.items.settlements`; object, required)
    - `items` (`listOrders.response.200.items.settlements.items`; array<object>, required)
      - `id` (`listOrders.response.200.items.settlements.items.id`; string, required)
      - `order_id` (`listOrders.response.200.items.settlements.items.order_id`; string, required)
      - `processor` (`listOrders.response.200.items.settlements.items.processor`; any of, required)
        - any of: `string`, `null`
      - `processor_ref` (`listOrders.response.200.items.settlements.items.processor_ref`; any of, required)
        - any of: `string`, `null`
      - `account_ref` (`listOrders.response.200.items.settlements.items.account_ref`; any of, required)
        - any of: `string`, `null`
      - `custodian` (`listOrders.response.200.items.settlements.items.custodian`; string, required)
      - `currency` (`listOrders.response.200.items.settlements.items.currency`; string, required)
      - `exponent` (`listOrders.response.200.items.settlements.items.exponent`; any of, required)
        - any of: `number`, `null`
      - `amount` (`listOrders.response.200.items.settlements.items.amount`; any of, required)
        - any of: `number`, `null`
      - `platform_fee` (`listOrders.response.200.items.settlements.items.platform_fee`; any of, required)
        - any of: `number`, `null`
      - `processor_fee` (`listOrders.response.200.items.settlements.items.processor_fee`; any of, required)
        - any of: `number`, `null`
      - `occurred_at` (`listOrders.response.200.items.settlements.items.occurred_at`; any of, required)
        - any of: `string`, `null`
      - `recorded_at` (`listOrders.response.200.items.settlements.items.recorded_at`; any of, required)
        - any of: `string`, `null`
    - `total` (`listOrders.response.200.items.settlements.total`; number, required)
  - `refunds` (`listOrders.response.200.items.refunds`; object, required)
    - `items` (`listOrders.response.200.items.refunds.items`; array<object>, required)
      - `id` (`listOrders.response.200.items.refunds.items.id`; string, required)
      - `settlement_id` (`listOrders.response.200.items.refunds.items.settlement_id`; string, required)
      - `order_id` (`listOrders.response.200.items.refunds.items.order_id`; string, required)
      - `processor_ref` (`listOrders.response.200.items.refunds.items.processor_ref`; any of, required)
        - any of: `string`, `null`
      - `amount` (`listOrders.response.200.items.refunds.items.amount`; any of, required)
        - any of: `number`, `null`
      - `currency` (`listOrders.response.200.items.refunds.items.currency`; string, required)
      - `exponent` (`listOrders.response.200.items.refunds.items.exponent`; any of, required)
        - any of: `number`, `null`
      - `reason` (`listOrders.response.200.items.refunds.items.reason`; any of, required)
        - any of: `string`, `null`
      - `occurred_at` (`listOrders.response.200.items.refunds.items.occurred_at`; any of, required)
        - any of: `string`, `null`
      - `recorded_at` (`listOrders.response.200.items.refunds.items.recorded_at`; any of, required)
        - any of: `string`, `null`
    - `total` (`listOrders.response.200.items.refunds.total`; number, required)
  - `affiliates` (`listOrders.response.200.items.affiliates`; object, required)
    - `items` (`listOrders.response.200.items.affiliates.items`; array<object>, required)
      - `settlement_id` (`listOrders.response.200.items.affiliates.items.settlement_id`; string, required)
      - `order_item_id` (`listOrders.response.200.items.affiliates.items.order_item_id`; string, required)
      - `order_id` (`listOrders.response.200.items.affiliates.items.order_id`; string, required)
      - `user_id` (`listOrders.response.200.items.affiliates.items.user_id`; string, required)
      - `discount_id` (`listOrders.response.200.items.affiliates.items.discount_id`; any of, required)
        - any of: `string`, `null`
      - `currency` (`listOrders.response.200.items.affiliates.items.currency`; string, required)
      - `exponent` (`listOrders.response.200.items.affiliates.items.exponent`; any of, required)
        - any of: `number`, `null`
      - `fee` (`listOrders.response.200.items.affiliates.items.fee`; any of, required)
        - any of: `number`, `null`
      - `resolution_id` (`listOrders.response.200.items.affiliates.items.resolution_id`; any of, required)
        - any of: `string`, `null`
    - `total` (`listOrders.response.200.items.affiliates.total`; number, required)
  - `id` (`listOrders.response.200.items.id`; string, required)
  - `number` (`listOrders.response.200.items.number`; number, required)
  - `customer_id` (`listOrders.response.200.items.customer_id`; any of, required)
    - any of: `string`, `null`
  - `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`; any of, required)
    - any of: `number`, `null`
  - `discount` (`listOrders.response.200.items.discount`; any of, required)
    - any of: `number`, `null`
  - `total` (`listOrders.response.200.items.total`; any of, required)
    - any of: `number`, `null`
  - `free` (`listOrders.response.200.items.free`; boolean, required)
  - `fees` (`listOrders.response.200.items.fees`; any of, required)
    - any of: `number`, `null`
  - `source` (`listOrders.response.200.items.source`; string, required)
  - `source_key` (`listOrders.response.200.items.source_key`; any of, required)
    - any of: `string`, `null`
  - `statements` (`listOrders.response.200.items.statements`; object, required)
    - `coupon` (`listOrders.response.200.items.statements.coupon`; string, optional)
    - `customer_status` (`listOrders.response.200.items.statements.customer_status`; string, optional) — How well the buyer was known; `fake` is a seeded order.
    - `method` (`listOrders.response.200.items.statements.method`; string, optional) — The payment method the processor reported.
    - `method_details` (`listOrders.response.200.items.statements.method_details`; object, optional) — What the method shows, as a saved instrument's display: its brand and last 4 digits.
      - `brand` (`listOrders.response.200.items.statements.method_details.brand`; any of, required)
        - any of: `string`, `null`
      - `last4` (`listOrders.response.200.items.statements.method_details.last4`; any of, required)
        - any of: `string`, `null`
    - `refund_waiver` (`listOrders.response.200.items.statements.refund_waiver`; object, optional) — Carried from the checkout.
      - `policy` (`listOrders.response.200.items.statements.refund_waiver.policy`; string, required) — The strictest policy among the lines, the one consented to.
      - `accepted_at` (`listOrders.response.200.items.statements.refund_waiver.accepted_at`; string, required)
    - `under_minimum` (`listOrders.response.200.items.statements.under_minimum`; object, optional)
      - `processor` (`listOrders.response.200.items.statements.under_minimum.processor`; string, required)
      - `minimum` (`listOrders.response.200.items.statements.under_minimum.minimum`; any of, required) — Null when the processor refused the payment as too small rather than core reading its minimum.
        - any of: `number`, `null`
      - `amount` (`listOrders.response.200.items.statements.under_minimum.amount`; any of, required)
        - any of: `number`, `null`
  - `note` (`listOrders.response.200.items.note`; any of, required)
    - any of: `string`, `null`
  - `occurred_at` (`listOrders.response.200.items.occurred_at`; any of, required)
    - any of: `string`, `null`
  - `recorded_at` (`listOrders.response.200.items.recorded_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)
- `facets` (`listOrders.response.200.facets`; map<map<number>>, optional)

### default

A problem; see https://api.sherpo.io/merchant/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/merchant-api/reference/list-orders/index.md
