---
title: "Reads one of 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/{order}`

## Authentication

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

## Path parameters

- `store` (`getOrder.path.store`; string, required) — A hostname of the store.
- `order` (`getOrder.path.order`; string, required)
  - minLength 1

## Code samples

### cURL

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

### TypeScript

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

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

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

print(response.text)
```

## Responses

### 200

Reads one of the customer's orders.

#### Example

```json
{
  "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"
}
```

- `renewed_subscription_ids` (`getOrder.response.200.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` (`getOrder.response.200.has_receipt`; boolean, required)
- `item_count` (`getOrder.response.200.item_count`; number, required)
- `items` (`getOrder.response.200.items`; array<object>, required)
  - `product` (`getOrder.response.200.items.product`; any of, required)
    - any of: `object`, `null`
  - `id` (`getOrder.response.200.items.id`; string, required)
  - `order_id` (`getOrder.response.200.items.order_id`; string, required)
  - `product_id` (`getOrder.response.200.items.product_id`; any of, required)
    - any of: `string`, `null`
  - `tier_id` (`getOrder.response.200.items.tier_id`; any of, required)
    - any of: `string`, `null`
  - `price_id` (`getOrder.response.200.items.price_id`; any of, required)
    - any of: `string`, `null`
  - `position` (`getOrder.response.200.items.position`; number, required)
  - `quantity` (`getOrder.response.200.items.quantity`; number, required)
  - `amount` (`getOrder.response.200.items.amount`; number, required)
  - `discount` (`getOrder.response.200.items.discount`; number, required)
  - `total` (`getOrder.response.200.items.total`; number, required)
  - `descriptor` (`getOrder.response.200.items.descriptor`; object, required)
    - `product` (`getOrder.response.200.items.descriptor.product`; any of, required)
      - any of: `string`, `null`
    - `price` (`getOrder.response.200.items.descriptor.price`; any of, required)
      - any of: `string`, `null`
    - `tier` (`getOrder.response.200.items.descriptor.tier`; any of, required)
      - any of: `string`, `null`
    - `coupon` (`getOrder.response.200.items.descriptor.coupon`; any of, required)
      - any of: `string`, `null`
    - `display_name` (`getOrder.response.200.items.descriptor.display_name`; any of, required)
      - any of: `string`, `null`
    - `message` (`getOrder.response.200.items.descriptor.message`; any of, required)
      - any of: `string`, `null`
- `refunded` (`getOrder.response.200.refunded`; number, required) — Every refund summed, past the preview.
- `refund_status` (`getOrder.response.200.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` (`getOrder.response.200.refund_count`; number, required)
- `refunds` (`getOrder.response.200.refunds`; array<object>, required)
  - `id` (`getOrder.response.200.refunds.id`; string, required)
  - `order_id` (`getOrder.response.200.refunds.order_id`; string, required)
  - `amount` (`getOrder.response.200.refunds.amount`; number, required)
  - `currency` (`getOrder.response.200.refunds.currency`; string, required)
  - `reason` (`getOrder.response.200.refunds.reason`; any of, required)
    - any of: `string`, `null`
  - `occurred_at` (`getOrder.response.200.refunds.occurred_at`; any of, required)
    - any of: `string`, `null`
- `id` (`getOrder.response.200.id`; string, required)
- `number` (`getOrder.response.200.number`; number, required)
- `currency` (`getOrder.response.200.currency`; string, required)
- `exponent` (`getOrder.response.200.exponent`; any of, required)
  - any of: `number`, `null`
- `amount` (`getOrder.response.200.amount`; number, required)
- `discount` (`getOrder.response.200.discount`; number, required)
- `total` (`getOrder.response.200.total`; number, required)
- `source` (`getOrder.response.200.source`; string, required)
- `note` (`getOrder.response.200.note`; any of, required)
  - any of: `string`, `null`
- `statements` (`getOrder.response.200.statements`; object, required)
  - `coupon` (`getOrder.response.200.statements.coupon`; any of, required)
    - any of: `string`, `null`
  - `method` (`getOrder.response.200.statements.method`; any of, required)
    - any of: `string`, `null`
  - `method_details` (`getOrder.response.200.statements.method_details`; any of, required)
    - any of: `object`, `null`
  - `refund_waiver` (`getOrder.response.200.statements.refund_waiver`; any of, required)
    - any of: `object`, `null`
  - `under_minimum` (`getOrder.response.200.statements.under_minimum`; any of, required)
    - any of: `object`, `null`
- `occurred_at` (`getOrder.response.200.occurred_at`; any of, required)
  - any of: `string`, `null`

### 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` (`getOrder.response.default.type`; string, required)
  - format `uri`
- `title` (`getOrder.response.default.title`; string, required)
- `status` (`getOrder.response.default.status`; integer, required)
- `detail` (`getOrder.response.default.detail`; string, required)
- `code` (`getOrder.response.default.code`; string, optional)
- `context` (`getOrder.response.default.context`; object, optional)
- `reached_core` (`getOrder.response.default.reached_core`; boolean, optional)
- `core_answer` (`getOrder.response.default.core_answer`; string, optional)


Source: https://docs.sherpo.io/customer-api/reference/get-order/index.md
