---
title: "Pages the store's products with what the customer holds of each."
---

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

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

## Authentication

Requires one of the following:

- `bearer`, http, header `Authorization`, scopes: `read`
- `publishableKey`, apiKey, in header, header `Publishable-Key`

## Path parameters

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

## Query parameters

- `filter` (`listProducts.query.filter`; object, optional) — `filter[<field>]=<value>` is an equality, `filter[<field>][<op>]=<value>` names the operator; `in` repeats the parameter.
- `sort` (`listProducts.query.sort`; string, optional)
  - one of `"catalog"`, `"published"`, `"title"`
- `direction` (`listProducts.query.direction`; string, optional)
  - one of `"asc"`, `"desc"`
- `limit` (`listProducts.query.limit`; integer, optional)
  - min 1; max 100
- `cursor` (`listProducts.query.cursor`; string, optional)
  - maxLength 8192
- `count` (`listProducts.query.count`; boolean, optional)
- `search` (`listProducts.query.search`; string, optional)
  - minLength 1; maxLength 200
- `coupon` (`listProducts.query.coupon`; string, optional) — A discount's code, or its id as an affiliate link carries it, priced into the offers.
  - minLength 1; maxLength 64

## Code samples

### cURL

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

### TypeScript

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

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

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

print(response.text)
```

## Responses

### 200

Pages the store's products with what the customer holds of each.

#### Example

```json
{
  "total": 0,
  "items": [
    {
      "files": {
        "property1": {
          "id": "string",
          "kind": "string",
          "mime": "string",
          "name": "string",
          "bytes": 0,
          "width": 0,
          "height": 0,
          "duration": 0,
          "pages": 0,
          "status": "string",
          "url": "string",
          "resized": [
            {
              "width": 1,
              "avif": "string",
              "webp": "string"
            }
          ],
          "attachment_id": "string",
          "unlocks": [
            {
              "product_id": "string",
              "product_name": "string",
              "tier": {}
            }
          ],
          "video": {
            "attachment_id": "string",
            "tracks": [
              {}
            ],
            "outputs": [
              "string"
            ]
          },
          "audio": {
            "waveform": "string",
            "attachment_id": "string",
            "tracks": [
              {}
            ],
            "outputs": [
              "string"
            ]
          }
        },
        "property2": {
          "id": "string",
          "kind": "string",
          "mime": "string",
          "name": "string",
          "bytes": 0,
          "width": 0,
          "height": 0,
          "duration": 0,
          "pages": 0,
          "status": "string",
          "url": "string",
          "resized": [
            {
              "width": 1,
              "avif": "string",
              "webp": "string"
            }
          ],
          "attachment_id": "string",
          "unlocks": [
            {
              "product_id": "string",
              "product_name": "string",
              "tier": {}
            }
          ],
          "video": {
            "attachment_id": "string",
            "tracks": [
              {}
            ],
            "outputs": [
              "string"
            ]
          },
          "audio": {
            "waveform": "string",
            "attachment_id": "string",
            "tracks": [
              {}
            ],
            "outputs": [
              "string"
            ]
          }
        }
      },
      "event": {
        "format": "string",
        "reveal_location": "string",
        "capacity": 0,
        "spots_left": 0,
        "sold_out": true,
        "location": {
          "venue": "string",
          "address": "string",
          "city": "string",
          "region": "string",
          "postal_code": "string",
          "country": "string",
          "latitude": 0,
          "longitude": 0,
          "map_url": "string"
        },
        "map": {
          "light": {
            "url": "string",
            "width": 0,
            "height": 0,
            "resized": [
              {}
            ]
          },
          "dark": {
            "url": "string",
            "width": 0,
            "height": 0,
            "resized": [
              {}
            ]
          },
          "attribution": "string",
          "attribution_url": "string"
        },
        "location_hidden": true,
        "sessions": [
          {
            "id": "string",
            "starts_at": "string",
            "ends_at": "string",
            "time_zone": "string",
            "venue": "string",
            "online_label": "string",
            "add_to_calendar": {
              "google": "string",
              "outlook": "string",
              "office": "string"
            }
          }
        ],
        "ics": {
          "path": "string",
          "url": "string"
        },
        "session_count": 0,
        "upcoming_count": 0,
        "first_starts_at": "string",
        "last_session": {
          "starts_at": "string",
          "ends_at": "string",
          "time_zone": "string"
        }
      },
      "settings": {
        "progress_tracking": "string",
        "refund_policy": "string",
        "reviews_enabled": true,
        "purchase_note": "string",
        "approval": "string",
        "calendar": {
          "can_schedule": true,
          "calcom": {
            "username": "string",
            "event_slug": "string"
          },
          "host": {
            "title": "string",
            "subtitle": "string",
            "description": "string",
            "tags": [
              "string"
            ]
          }
        },
        "coffee": {
          "emoji": "string",
          "descriptor": "string"
        },
        "fundraising": {
          "goal": 1,
          "currency": "str"
        },
        "storefront": {
          "sales_counter": true,
          "background_poster": true,
          "require_dark": true
        }
      },
      "category": {
        "id": "string",
        "label": "string",
        "discountable": true,
        "subscribable": true,
        "reviewable": true,
        "repeatable": true,
        "aside_size": "string"
      },
      "access": "string",
      "mcp": {
        "requires": {
          "kind": "everyone"
        },
        "prompts": 0
      },
      "offers": [
        {
          "id": "string",
          "tier": {
            "id": "string",
            "rank": 0,
            "name": "string"
          },
          "currency": "string",
          "exponent": 0,
          "amount": 0,
          "discounted": 0,
          "charge": 0,
          "highlighted": true,
          "title": "string",
          "description": "string",
          "settings": {
            "refund_policy": "string",
            "autorenew": true,
            "renewal_discount": 0
          },
          "discount": {
            "id": "string",
            "code": "string",
            "starts_at": "string",
            "ends_at": "string"
          },
          "first_charge_at": "string",
          "kind": "one_time",
          "period": null,
          "mode": "string",
          "upgrade": null
        }
      ],
      "owned": {
        "tier_rank": 0,
        "source": "string",
        "tier_expires_at": "string",
        "expires_at": "string"
      },
      "request": {
        "id": "string",
        "status": "string",
        "tier_rank": 0,
        "payment": "string",
        "checkout": "string",
        "created_at": "string"
      },
      "poster": {
        "tracks": [
          {
            "id": "string",
            "label": "string",
            "language": "string",
            "generated": true
          }
        ],
        "outputs": [
          "string"
        ],
        "access": "string",
        "id": "string",
        "role": "string",
        "delivery": "string",
        "preview_only": true,
        "from_body": true,
        "position": 0,
        "asset": {
          "id": "string",
          "name": "string",
          "title": "string",
          "ext": "string",
          "description": "string",
          "mime": "string",
          "bytes": 0,
          "enforcement": "string",
          "locator": "string",
          "metadata": {
            "width": 0,
            "height": 0,
            "duration": 0,
            "pages": 0
          },
          "status": "string"
        }
      },
      "stats": {
        "sales": 0,
        "raised": [
          {
            "currency": "string",
            "exponent": 0,
            "amount": 0
          }
        ]
      },
      "release": {
        "id": "string",
        "version": "string",
        "occurred_at": "string"
      },
      "rating": {
        "count": 0,
        "average": 0,
        "histogram": {
          "1": 0,
          "2": 0,
          "3": 0,
          "4": 0,
          "5": 0
        },
        "summary": "string",
        "summary_locale": "string"
      },
      "id": "string",
      "slug": "string",
      "path": "string",
      "url": "string",
      "title": "string",
      "subtitle": "string",
      "listing": "string",
      "priority": 0,
      "published_at": "string",
      "discontinued_at": "string",
      "unlisted_at": "string",
      "feed_url": "string",
      "created_at": "string",
      "updated_at": "string"
    }
  ],
  "cursor": "string"
}
```

- `items` (`listProducts.response.200.items`; array<object>, required)
  - `files` (`listProducts.response.200.items.files`; map<object>, required)
  - `event` (`listProducts.response.200.items.event`; any of, required) — An event product's format, place and next sessions as a visitor sees them; null for any other product.
    - any of: `object`, `null`
  - `settings` (`listProducts.response.200.items.settings`; object, required)
    - `progress_tracking` (`listProducts.response.200.items.settings.progress_tracking`; string, required)
    - `refund_policy` (`listProducts.response.200.items.settings.refund_policy`; any of, required)
      - any of: `string`, `null`
    - `reviews_enabled` (`listProducts.response.200.items.settings.reviews_enabled`; boolean, required)
    - `purchase_note` (`listProducts.response.200.items.settings.purchase_note`; any of, required)
      - any of: `string`, `null`
    - `approval` (`listProducts.response.200.items.settings.approval`; string, required) — Whether each buyer waits for the seller's approval; an unknown value reads as required, the side that promises nothing.
    - `calendar` (`listProducts.response.200.items.settings.calendar`; any of, required)
      - any of: `object`, `null`
    - `coffee` (`listProducts.response.200.items.settings.coffee`; any of, required)
      - any of: `object`, `null`
    - `fundraising` (`listProducts.response.200.items.settings.fundraising`; any of, required)
      - any of: `object`, `null`
    - `storefront` (`listProducts.response.200.items.settings.storefront`; object, required)
      - `sales_counter` (`listProducts.response.200.items.settings.storefront.sales_counter`; boolean, required)
      - `background_poster` (`listProducts.response.200.items.settings.storefront.background_poster`; boolean, required)
      - `require_dark` (`listProducts.response.200.items.settings.storefront.require_dark`; boolean, required)
  - `category` (`listProducts.response.200.items.category`; any of, required)
    - any of: `object`, `null`
  - `access` (`listProducts.response.200.items.access`; string, required)
  - `mcp` (`listProducts.response.200.items.mcp`; object, required)
    - `requires` (`listProducts.response.200.items.mcp.requires`; any of, required) — What its gate asks there: anyone, a rank of its tiers, or nobody for a closed or broken gate.
      - any of: `object`, `object`, `object`
    - `prompts` (`listProducts.response.200.items.mcp.prompts`; number, required) — How many of its prompts someone could run there, whoever reads it.
  - `offers` (`listProducts.response.200.items.offers`; array<any of>, required)
    - any of: `object`, `object`, `object`, `object`
  - `owned` (`listProducts.response.200.items.owned`; any of, required)
    - any of: `object`, `null`
  - `request` (`listProducts.response.200.items.request`; any of, required) — The caller's latest request for it: waiting for the seller's approval, on the waitlist, or decided; null for none or a visitor.
    - any of: `object`, `null`
  - `poster` (`listProducts.response.200.items.poster`; any of, required)
    - any of: `object`, `null`
  - `stats` (`listProducts.response.200.items.stats`; object, required)
    - `sales` (`listProducts.response.200.items.stats.sales`; any of, required)
      - any of: `number`, `null`
    - `raised` (`listProducts.response.200.items.stats.raised`; any of, required)
      - any of: `array<object>`, `null`
  - `release` (`listProducts.response.200.items.release`; any of, required)
    - any of: `object`, `null`
  - `rating` (`listProducts.response.200.items.rating`; object, required)
    - `count` (`listProducts.response.200.items.rating.count`; number, required)
    - `average` (`listProducts.response.200.items.rating.average`; any of, required)
      - any of: `number`, `null`
    - `histogram` (`listProducts.response.200.items.rating.histogram`; object, required)
      - `1` (`listProducts.response.200.items.rating.histogram.1`; number, required)
      - `2` (`listProducts.response.200.items.rating.histogram.2`; number, required)
      - `3` (`listProducts.response.200.items.rating.histogram.3`; number, required)
      - `4` (`listProducts.response.200.items.rating.histogram.4`; number, required)
      - `5` (`listProducts.response.200.items.rating.histogram.5`; number, required)
    - `summary` (`listProducts.response.200.items.rating.summary`; any of, required) — The generated summary of what reviews say; null while the seller hides it or none is written.
      - any of: `string`, `null`
    - `summary_locale` (`listProducts.response.200.items.rating.summary_locale`; any of, required) — The language the summary is written in, which trails a store's new language until it is written again.
      - any of: `string`, `null`
  - `id` (`listProducts.response.200.items.id`; string, required)
  - `slug` (`listProducts.response.200.items.slug`; string, required)
  - `path` (`listProducts.response.200.items.path`; string, required) — The storefront path.
  - `url` (`listProducts.response.200.items.url`; any of, required) — The absolute URL on the store's verified hostname, or null before it has one.
    - any of: `string`, `null`
  - `title` (`listProducts.response.200.items.title`; string, required)
  - `subtitle` (`listProducts.response.200.items.subtitle`; any of, required) — The short line shown under the title.
    - any of: `string`, `null`
  - `listing` (`listProducts.response.200.items.listing`; string, required)
  - `priority` (`listProducts.response.200.items.priority`; number, required)
  - `published_at` (`listProducts.response.200.items.published_at`; any of, required)
    - any of: `string`, `null`
  - `discontinued_at` (`listProducts.response.200.items.discontinued_at`; any of, required)
    - any of: `string`, `null`
  - `unlisted_at` (`listProducts.response.200.items.unlisted_at`; any of, required)
    - any of: `string`, `null`
  - `feed_url` (`listProducts.response.200.items.feed_url`; any of, required) — The public feed's absolute URL, for a blog or a podcast that is published (discontinued too), listed and on a verified hostname; else null.
    - any of: `string`, `null`
  - `created_at` (`listProducts.response.200.items.created_at`; any of, required)
    - any of: `string`, `null`
  - `updated_at` (`listProducts.response.200.items.updated_at`; any of, required)
    - any of: `string`, `null`
- `cursor` (`listProducts.response.200.cursor`; any of, required)
  - any of: `string`, `null`
- `total` (`listProducts.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` (`listProducts.response.default.type`; string, required)
  - format `uri`
- `title` (`listProducts.response.default.title`; string, required)
- `status` (`listProducts.response.default.status`; integer, required)
- `detail` (`listProducts.response.default.detail`; string, required)
- `code` (`listProducts.response.default.code`; string, optional)
- `context` (`listProducts.response.default.context`; object, optional)
- `reached_core` (`listProducts.response.default.reached_core`; boolean, optional)
- `core_answer` (`listProducts.response.default.core_answer`; string, optional)


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