# Shopify Collections

## Overview

| Property | Value |
|----------|-------|
| **Status** | active |
| **Method** | `GET` |
| **Endpoint** | `/v2/shopify/collections` |
| **Base URL** | `https://api.piloterr.com` |
| **Credit Cost** | 1 credit per call |
| **Documentation** | https://www.piloterr.com/library/shopify-collections |

## Description

List collections from a Shopify shop. query is the shop domain or a URL on that shop. page and limit choose the slice.

## Authentication

- **Key Name:** `x-api-key`
- **Location:** HTTP Header
- **Get an API key:** https://app.piloterr.com/register

## Example Request

```bash
curl --location --request GET 'https://api.piloterr.com/v2/shopify/collections' \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: YOUR_API_KEY'
```

## Example Response

### Decathlon collections, first collection

```json
{
  "results": [
    {
      "id": 261040504894,
      "url": "https://www.decathlon.com/collections/camping-tents-2-3-person",
      "image": null,
      "title": "2-Person Tents",
      "handle": "camping-tents-2-3-person",
      "updated_at": "2026-10-29T04:06:55-07:00",
      "description": "<h2><span>The perfect 2-person tent for camping</span></h2>\n<p dir=\"ltr\"><span>Embark on your next outdoor adventure with a Decathlon 2-person tent that’s tailored for comfort and practicality. Lightweight and easy to carry, these tents ensure a hassle-free experience for creating lasting memories in a cozy space.</span></p>\n<h2 dir=\"ltr\"><span>Versatility for every journey</span></h2>\n<p dir=\"ltr\"><span>Our 2-person camping tents feature top-notch insulation, ventilation, and waterproofing. Ideal for any adventure, these small but comfortable tents offer reliable protection and performance. Find the perfect tent for your outdoor excursions, and explore our </span><a href=\"https://www.decathlon.com/collections/3-person-camping-tents\"><span>3-person tents</span></a><span> if you need more space.</span></p>\n<h2 dir=\"ltr\"><span>Portability and practicality</span></h2>\n<p dir=\"ltr\"><span>Travel effortlessly with Decathlon’s 2-person tents. They’re lightweight, compact, easy to store, and quick to set up. Perfect for any trip intensity, these tents are made from durable performance materials. Pair our tents with camping mattresses and other </span><a href=\"https://www.decathlon.com/collections/tent-accessories\"><span>accessories</span></a><span> for an optimal camping experience.</span></p>\n<h2 dir=\"ltr\"><span>Innovative cooling and insulating features</span></h2>\n<p dir=\"ltr\"><span>Stay comfortable with advanced ventilation and insulation technologies, featuring a flysheet and effective ventilation that keeps the interior cool and dark. Browse our sleeping bags and easy-to-transport </span><a href=\"https://www.decathlon.com/collections/blackout-tents\"><span>blackout camping tents</span></a><span> for additional comfort in various climates.</span></p>\n<h2 dir=\"ltr\"><span>Robust windproofing and waterproofing</span></h2>\n<p dir=\"ltr\"><span>Our 2-person camping tents are built to endure adverse weather, including rain and strong winds. For extra comfort, explore our inflatable camping pillows to enhance your camping setup. Their lightweight design lets you easily carry them without compromising your performance.</span></p>\n<h2 dir=\"ltr\"><span>Decathlon: Your go-to for outdoor gear</span></h2>\n<p>Decathlon provides everything needed for unforgettable outdoor adventures. With our durable <a href=\"https://www.decathlon.com/collections/camping-tents\">camping tents</a> and extensive range of camping gear, you’ll be prepared for any environment. Discover our collection and embark on your next incredible nature experience.</p>\n<!---->",
      "published_at": "2021-04-15T12:37:52-07:00",
      "products_count": 2
    }
  ],
  "pagination": {
    "next": "https://www.decathlon.com/collections.json?limit=1&page=2",
    "page": 1,
    "per_page": 1,
    "total_pages": null,
    "total_results": null
  }
}
```

## Documentation

## Overview
The Shopify Collections API lists collections from a public Shopify shop. `query` is the shop domain or any URL on that shop, such as `decathlon.com` or `https://www.decathlon.com`. A collection link on the same host selects that shop too. `shopify.com` and `apps.shopify.com` are rejected.

The shop's public `/collections.json` feed is returned as `results` and `pagination`.

## Quickstart
```
GET https://api.piloterr.com/v2/shopify/collections?query=decathlon.com&page=1&limit=30
```

## Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| `query` | string | yes | Shop domain or shop URL. `decathlon.com` and `https://www.decathlon.com/collections/camping-tents` both read the Decathlon shop. |
| `page` | integer | no | Page number, starting at 1. Omit it for page 1. `page=2` is the next slice. |
| `limit` | integer | no | Collections on this page. Default 30. Maximum 250. |

## Response fields
| Field | Type | Description |
|---|---|---|
| `results[].title` | string | Collection title |
| `results[].handle` | string | Collection handle |
| `results[].url` | string | Collection URL on the shop |
| `results[].description` | string | Collection description |
| `results[].products_count` | number | Products in the collection |
| `results[].image` | object or null | Collection image when the shop sends one |
| `results[].published_at` | string | Publish time |
| `results[].updated_at` | string | Update time |
| `pagination.page` | number | Requested page |
| `pagination.per_page` | number | Requested limit |
| `pagination.total_results` | null | The shop JSON does not include a total |
| `pagination.total_pages` | null | The shop JSON does not include a page count |
| `pagination.next` | string or null | Next shop JSON URL when this page is full, otherwise null |

## Use cases
- List a shop's collections before opening each one
- Track collection titles and product counts
- Follow `pagination.next` until the shop runs out of collections

## Error codes
| Code | Meaning |
|---|---|
| 400 | Missing query, a domain that is not a shop, or `page` / `limit` out of range |
| 403 | The shop blocked the JSON feed |
| 404 | This page has no collections |
| 500 | The feed could not be fetched |