---
title: "Pages a product's requests: buyers waiting for approval, an event's waitlist, and those decided."
---

> 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 › customer

`GET /v1/stores/{store}/products/{product}/requests`

## Authentication

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

## Path parameters

- `store` (`listProductRequests.path.store`; string, required) — The store's id.
- `product` (`listProductRequests.path.product`; string, required) — An id, or `slug:<slug>`.
  - minLength 1

## Query parameters

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

## Code samples

### cURL

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

### TypeScript

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

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

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

print(response.text)
```

## Responses

### 200

Pages a product's requests: buyers waiting for approval, an event's waitlist, and those decided.

#### Example

```json
{
  "items": [
    {
      "id": "string",
      "product_id": "string",
      "customer_id": "string",
      "status": "string",
      "tier": {
        "id": "string",
        "name": "string",
        "rank": 0
      },
      "price_id": "string",
      "payment": "string",
      "hold_expires_at": "string",
      "quantity": 1,
      "order_item_id": "string",
      "grant_id": "string",
      "created_at": "string",
      "decided_at": "string",
      "closed_reason": "string",
      "customer": {
        "id": "string",
        "name": "string",
        "email": "string",
        "phone": "string",
        "erased": true
      },
      "answers": [
        {
          "question_id": "string",
          "value": true
        }
      ]
    }
  ],
  "cursor": "string",
  "total": 0,
  "facets": {
    "property1": {
      "property1": 0,
      "property2": 0
    },
    "property2": {
      "property1": 0,
      "property2": 0
    }
  }
}
```

- `items` (`listProductRequests.response.200.items`; array<object>, required)
  - `id` (`listProductRequests.response.200.items.id`; string, required)
  - `product_id` (`listProductRequests.response.200.items.product_id`; string, required)
  - `customer_id` (`listProductRequests.response.200.items.customer_id`; string, required)
  - `status` (`listProductRequests.response.200.items.status`; string, required) — `pending` until the seller decides, `waitlisted` while it waits for a seat, then `approved` or `declined`.
  - `tier` (`listProductRequests.response.200.items.tier`; any of, required) — The tier asked for; null for none.
    - any of: `object`, `null`
  - `price_id` (`listProductRequests.response.200.items.price_id`; any of, required) — The price asked at.
    - any of: `string`, `null`
  - `payment` (`listProductRequests.response.200.items.payment`; any of, required) — A paid request's payment: `saved` while its card waits to be charged on approval, `held` while its total is held on the card, `charging` once approved, `due` from the buyer once a charge failed or found no card; null for a free one or once decided.
    - any of: `string`, `null`
  - `hold_expires_at` (`listProductRequests.response.200.items.hold_expires_at`; any of, required) — When a `held` request's card hold is released, closing it as expired unless decided first; null otherwise.
    - any of: `string`, `null`
  - `quantity` (`listProductRequests.response.200.items.quantity`; integer, required) — How many tickets it asks for.
    - min 1
  - `order_item_id` (`listProductRequests.response.200.items.order_item_id`; any of, required) — The order line that asked, or the one a promotion recorded; null while on a waitlist.
    - any of: `string`, `null`
  - `grant_id` (`listProductRequests.response.200.items.grant_id`; any of, required) — The grant an approval gave.
    - any of: `string`, `null`
  - `created_at` (`listProductRequests.response.200.items.created_at`; string, required)
  - `decided_at` (`listProductRequests.response.200.items.decided_at`; any of, required)
    - any of: `string`, `null`
  - `closed_reason` (`listProductRequests.response.200.items.closed_reason`; any of, required) — `expired` for a request declined because its card hold was released before anyone decided; null otherwise.
    - any of: `string`, `null`
  - `customer` (`listProductRequests.response.200.items.customer`; any of, required) — Who they are, `erased` once their details are wiped.
    - any of: `object`, `null`
  - `answers` (`listProductRequests.response.200.items.answers`; array<object>, required) — Their answers to the product's registration questions, in the questions' order; none without `customer:read`.
    - `question_id` (`listProductRequests.response.200.items.answers.question_id`; string, required)
    - `value` (`listProductRequests.response.200.items.answers.value`; any of, required)
      - any of: `boolean`, `string`, `array<string>`
- `cursor` (`listProductRequests.response.200.cursor`; any of, required)
  - any of: `string`, `null`
- `total` (`listProductRequests.response.200.total`; number, optional)
- `facets` (`listProductRequests.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` (`listProductRequests.response.default.type`; string, required)
  - format `uri`
- `title` (`listProductRequests.response.default.title`; string, required)
- `status` (`listProductRequests.response.default.status`; integer, required)
- `detail` (`listProductRequests.response.default.detail`; string, required)
- `code` (`listProductRequests.response.default.code`; string, optional)
- `context` (`listProductRequests.response.default.context`; object, optional)
- `reached_core` (`listProductRequests.response.default.reached_core`; boolean, optional)
- `core_answer` (`listProductRequests.response.default.core_answer`; string, optional)


Source: https://docs.sherpo.io/merchant-api/reference/list-product-requests/index.md
