---
title: "Pages the store's products."
---

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

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

## Authentication

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

## Path parameters

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

## 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) — Sorted by published or rating, rows without a value come last either way.
  - one of `"catalog"`, `"created"`, `"published"`, `"title"`, `"priority"`, `"sales"`, `"rating"`
- `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
- `facets` (`listProducts.query.facets`; array<string>, optional)

## Code samples

### cURL

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

### TypeScript

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

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

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

print(response.text)
```

## Responses

### 200

Pages the store's products.

#### Example

```json
{
  "items": [
    {
      "event_map": {
        "light": {
          "url": "string",
          "width": 0,
          "height": 0,
          "resized": [
            {
              "width": 0,
              "avif": "string",
              "webp": "string"
            }
          ]
        },
        "dark": {
          "url": "string",
          "width": 0,
          "height": 0,
          "resized": [
            {
              "width": 0,
              "avif": "string",
              "webp": "string"
            }
          ]
        },
        "attribution": "string",
        "attribution_url": "string"
      },
      "seats": {
        "capacity": 0,
        "held": 0,
        "sold": 0,
        "spots_left": 0,
        "sold_out": true,
        "tickets": [
          {
            "tier_id": "string",
            "capacity": 0,
            "held": 0,
            "sold": 0,
            "spots_left": 0,
            "sold_out": true
          }
        ]
      },
      "sales": 0,
      "rating": {
        "count": 0,
        "average": 0
      },
      "poster": {
        "id": "string",
        "target": {
          "kind": "string",
          "id": "string"
        },
        "role": "string",
        "delivery": "string",
        "preview_only": true,
        "from_body": true,
        "release_file": true,
        "position": 0,
        "asset": {
          "id": "string",
          "locator": "string",
          "origin": "string",
          "custodian": "string",
          "enforcement": "string",
          "mime": "string",
          "bytes": 0,
          "quota_bytes": 0,
          "name": "string",
          "title": "string",
          "ext": "string",
          "status": "string",
          "optimized": true,
          "parent_id": "string",
          "redacted": true,
          "security": "string",
          "description": "string",
          "processed_at": "string",
          "metadata": {
            "width": 0,
            "height": 0,
            "duration": 0,
            "pages": 0,
            "waveform": "string",
            "transcript": {
              "language": "string",
              "confidence": 0
            },
            "arguments": [
              {}
            ],
            "property1": true,
            "property2": true
          },
          "created_at": "string"
        },
        "url": "string"
      },
      "id": "string",
      "slug": "string",
      "path": "string",
      "url": "string",
      "title": "string",
      "subtitle": "string",
      "category": "string",
      "listing": "string",
      "priority": 0,
      "status": "string",
      "unlisted": true,
      "feed_url": "string",
      "published_at": "string",
      "discontinued_at": "string",
      "unlisted_at": "string",
      "created_at": "string",
      "updated_at": "string",
      "settings": {
        "refund_policy": "string",
        "progress_tracking": "string",
        "reviews_enabled": true,
        "review_summary_visible": true,
        "purchase_note": "string",
        "approval": "string",
        "approval_payment": "string",
        "calendar": {
          "calcom": {
            "username": "string",
            "event_slug": "string"
          },
          "host": {
            "identity": {
              "kind": "member",
              "user": {}
            },
            "title": "string",
            "subtitle": "string",
            "description": "string",
            "tags": [
              "string"
            ]
          }
        },
        "coffee": {
          "emoji": "string",
          "descriptor": "string"
        },
        "software": {
          "key_prefix": "string",
          "activation_limit": 1,
          "inactive_days": 1,
          "offline_days": 1
        },
        "event": {
          "format": "string",
          "location": {
            "venue": "string",
            "address": "string",
            "city": "string",
            "region": "string",
            "postal_code": "string",
            "country": "st",
            "latitude": -90,
            "longitude": -180,
            "map_url": "string"
          },
          "reveal_location": "string",
          "waitlist": true,
          "capacity": 1
        },
        "fundraising": {
          "goal": 1,
          "currency": "str"
        },
        "feeds": {
          "private": true,
          "category": "string",
          "explicit": true,
          "owner_email": "string"
        },
        "storefront": {
          "sales_counter": true,
          "background_poster": true,
          "require_dark": true
        },
        "property1": true,
        "property2": true
      },
      "metadata": {
        "property1": true,
        "property2": true
      }
    }
  ],
  "cursor": "string",
  "total": 0,
  "facets": {
    "property1": {
      "property1": 0,
      "property2": 0
    },
    "property2": {
      "property1": 0,
      "property2": 0
    }
  }
}
```

- `items` (`listProducts.response.200.items`; array<object>, required)
  - `event_map` (`listProducts.response.200.items.event_map`; any of, required) — An event's venue maps at its location's point, one image per theme; null until drawn, or for any other product.
    - any of: `object`, `null`
  - `seats` (`listProducts.response.200.items.seats`; any of, required) — An event's seats as the product read answers them: what frozen carts hold and sales took, each ticket type's too; null for another category.
    - any of: `object`, `null`
  - `sales` (`listProducts.response.200.items.sales`; number, required)
  - `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`
  - `poster` (`listProducts.response.200.items.poster`; any of, required)
    - any of: `object`, `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`
  - `category` (`listProducts.response.200.items.category`; string, required)
  - `listing` (`listProducts.response.200.items.listing`; string, required)
  - `priority` (`listProducts.response.200.items.priority`; number, required)
  - `status` (`listProducts.response.200.items.status`; string, required)
  - `unlisted` (`listProducts.response.200.items.unlisted`; boolean, required)
  - `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`
  - `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`
  - `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`
  - `settings` (`listProducts.response.200.items.settings`; object, required)
    - `refund_policy` (`listProducts.response.200.items.settings.refund_policy`; string, optional)
    - `progress_tracking` (`listProducts.response.200.items.settings.progress_tracking`; string, optional)
    - `reviews_enabled` (`listProducts.response.200.items.settings.reviews_enabled`; boolean, optional)
    - `review_summary_visible` (`listProducts.response.200.items.settings.review_summary_visible`; boolean, optional) — Whether customers see the generated review summary; it is written either way.
    - `purchase_note` (`listProducts.response.200.items.settings.purchase_note`; string, optional) — Shown beside the buy button.
      - minLength 1; maxLength 2000
    - `approval` (`listProducts.response.200.items.settings.approval`; string, optional) — Whether each buyer waits as a pending request until the seller approves or declines it; none when unset.
    - `approval_payment` (`listProducts.response.200.items.settings.approval_payment`; string, optional) — How a paid purchase waits for approval; saved_card when unset. Holds last about 7 days on a card.
    - `calendar` (`listProducts.response.200.items.settings.calendar`; object, optional) — A bookable product: the seller's Cal.com event and the host card beside the widget; writes check it, reads answer it as stored.
      - `calcom` (`listProducts.response.200.items.settings.calendar.calcom`; object, optional)
        - `username` (`listProducts.response.200.items.settings.calendar.calcom.username`; string, optional)
        - `event_slug` (`listProducts.response.200.items.settings.calendar.calcom.event_slug`; string, optional)
      - `host` (`listProducts.response.200.items.settings.calendar.host`; object, optional)
        - `identity` (`listProducts.response.200.items.settings.calendar.host.identity`; any of, optional) — Set apart from `title`: a write of either clears the other.
          - any of: `object`, `object`, `object`
        - `title` (`listProducts.response.200.items.settings.calendar.host.title`; string, optional)
        - `subtitle` (`listProducts.response.200.items.settings.calendar.host.subtitle`; string, optional)
        - `description` (`listProducts.response.200.items.settings.calendar.host.description`; string, optional)
        - `tags` (`listProducts.response.200.items.settings.calendar.host.tags`; array<string>, optional)
    - `coffee` (`listProducts.response.200.items.settings.coffee`; object, optional) — A tip button: what it is called and what it shows.
      - `emoji` (`listProducts.response.200.items.settings.coffee.emoji`; string, optional)
      - `descriptor` (`listProducts.response.200.items.settings.coffee.descriptor`; string, optional)
        - minLength 3; maxLength 15; pattern `^\S(.*\S)?$`
    - `software` (`listProducts.response.200.items.settings.software`; object, optional) — A software product: how its license keys start and how many devices each holds by default.
      - `key_prefix` (`listProducts.response.200.items.settings.software.key_prefix`; string, optional) — Letters and digits, single hyphens or underscores between them.
        - minLength 1; maxLength 16; pattern `^[A-Za-z0-9]+(?:[-_][A-Za-z0-9]+)*$`
      - `activation_limit` (`listProducts.response.200.items.settings.software.activation_limit`; integer, optional) — The devices a license activates at once by default; none means no limit.
        - min 1; max 10000
      - `inactive_days` (`listProducts.response.200.items.settings.software.inactive_days`; integer, optional) — Days after which a device the software stopped reporting no longer counts; none keeps it until freed.
        - min 1; max 3650
      - `offline_days` (`listProducts.response.200.items.settings.software.offline_days`; integer, optional) — Days a signed license token lets the software run offline before it asks again; 30 when unset.
        - min 1; max 365
    - `event` (`listProducts.response.200.items.settings.event`; object, optional) — An event product: how it is attended, where, and how it takes guests.
      - `format` (`listProducts.response.200.items.settings.event.format`; string, optional) — In person, online or both; in person when unset.
      - `location` (`listProducts.response.200.items.settings.event.location`; object, optional) — Where an in-person event takes place.
        - `venue` (`listProducts.response.200.items.settings.event.location.venue`; string, optional) — Trimmed, with no line break or control character.
          - minLength 1; maxLength 200; pattern `^[^\s\u0000-\u001f\u007f-\u009f]([^\u0000-\u001f\u007f-\u009f\u2028\u2029]*[^\s\u0000-\u001f\u007f-\u009f])?$`
        - `address` (`listProducts.response.200.items.settings.event.location.address`; string, optional) — The street address, trimmed, its lines apart and no other control character.
          - minLength 1; maxLength 500; pattern `^[^\s\u0000-\u001f\u007f-\u009f]([^\u0000-\u0009\u000b\u000c\u000e-\u001f\u007f-\u009f]*[^\s\u0000-\u001f\u007f-\u009f])?$`
        - `city` (`listProducts.response.200.items.settings.event.location.city`; string, optional) — Trimmed, with no line break or control character.
          - minLength 1; maxLength 100; pattern `^[^\s\u0000-\u001f\u007f-\u009f]([^\u0000-\u001f\u007f-\u009f\u2028\u2029]*[^\s\u0000-\u001f\u007f-\u009f])?$`
        - `region` (`listProducts.response.200.items.settings.event.location.region`; string, optional) — A state, province or county. Trimmed, with no line break or control character.
          - minLength 1; maxLength 100; pattern `^[^\s\u0000-\u001f\u007f-\u009f]([^\u0000-\u001f\u007f-\u009f\u2028\u2029]*[^\s\u0000-\u001f\u007f-\u009f])?$`
        - `postal_code` (`listProducts.response.200.items.settings.event.location.postal_code`; string, optional) — Trimmed, with no line break or control character.
          - minLength 1; maxLength 20; pattern `^[^\s\u0000-\u001f\u007f-\u009f]([^\u0000-\u001f\u007f-\u009f\u2028\u2029]*[^\s\u0000-\u001f\u007f-\u009f])?$`
        - `country` (`listProducts.response.200.items.settings.event.location.country`; string, optional) — ISO 3166-1 alpha-2, upper case.
          - minLength 2; maxLength 2; pattern `^[A-Z]{2}$`
        - `latitude` (`listProducts.response.200.items.settings.event.location.latitude`; number, optional) — Where it is on a map, in decimal degrees, set together with `longitude`.
          - min -90; max 90
        - `longitude` (`listProducts.response.200.items.settings.event.location.longitude`; number, optional) — Where it is on a map, in decimal degrees, set together with `latitude`.
          - min -180; max 180
        - `map_url` (`listProducts.response.200.items.settings.event.location.map_url`; string, optional) — A map's page for the place. An https URL.
          - minLength 1; maxLength 2000; pattern `^https://`
      - `reveal_location` (`listProducts.response.200.items.settings.event.reveal_location`; string, optional) — Who sees the location: everyone, or ticket holders alone; everyone when unset.
      - `waitlist` (`listProducts.response.200.items.settings.event.waitlist`; boolean, optional) — Whether guests may join a waitlist once it is full; not when unset.
      - `capacity` (`listProducts.response.200.items.settings.event.capacity`; integer, optional) — How many guests it takes in all; none means no limit.
        - min 1; max 1000000
    - `fundraising` (`listProducts.response.200.items.settings.fundraising`; object, optional) — A fundraiser: the goal, in minor units of its currency.
      - `goal` (`listProducts.response.200.items.settings.fundraising.goal`; integer, required)
        - min 1
      - `currency` (`listProducts.response.200.items.settings.fundraising.currency`; string, required)
        - minLength 3; maxLength 3
    - `feeds` (`listProducts.response.200.items.settings.feeds`; object, optional) — A blog's or a podcast's feeds: the public one always stays; `private` false turns every customer's private feed off.
      - `private` (`listProducts.response.200.items.settings.feeds.private`; boolean, optional)
      - `category` (`listProducts.response.200.items.settings.feeds.category`; string, optional) — A podcast's directory category, one of Apple's, its subcategory after ` > ` (`Arts > Books`).
        - maxLength 64
      - `explicit` (`listProducts.response.200.items.settings.feeds.explicit`; boolean, optional) — Whether a podcast's episodes are explicit; not where unset.
      - `owner_email` (`listProducts.response.200.items.settings.feeds.owner_email`; string, optional) — The address directories mail to verify a podcast's owner; never in a private feed.
        - maxLength 254
    - `storefront` (`listProducts.response.200.items.settings.storefront`; object, optional)
      - `sales_counter` (`listProducts.response.200.items.settings.storefront.sales_counter`; boolean, optional) — A public count of orders on the product page.
      - `background_poster` (`listProducts.response.200.items.settings.storefront.background_poster`; boolean, optional) — The poster doubles as the page background.
      - `require_dark` (`listProducts.response.200.items.settings.storefront.require_dark`; boolean, optional) — The page renders dark whatever the visitor chose.
  - `metadata` (`listProducts.response.200.items.metadata`; map<any of>, required)
- `cursor` (`listProducts.response.200.cursor`; any of, required)
  - any of: `string`, `null`
- `total` (`listProducts.response.200.total`; number, optional)
- `facets` (`listProducts.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` (`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/merchant-api/reference/list-products/index.md
