# shopify.collection_products

**stable** **Advanced**

Products in one collection of an allowlisted Shopify storefront.

`GET /v1/shopify/collection_products`

## What you get

A list of Shopify results in Onekey's unified shape, in `data` (an array). An empty array is a normal, successful answer and is charged like any other; a source that reports "nothing found" as an error returns a free `404 not_found` instead.

## What it costs

- **Advanced · 5 credits** for a fresh fetch, charged only when it succeeds.
- **Free when served from cache (0.2 credit for a cached response over 100 KB).**
- **Free** if the request is invalid (never charged) or the source fails or reports not found (refunded).

## Parameters

| Name | Type | Required | Default | What it is | Constraints |
| --- | --- | --- | --- | --- | --- |
| `domain` | string | yes | (required) | Storefront domain (allowlist only), e.g. www.allbirds.com | max 61 chars; must match `[a-z0-9][a-z0-9.-]{3,60}`; trimmed, lowercased |
| `handle` | string | yes | (required) | Collection handle | max 255 chars; must match `[a-z0-9][a-z0-9_-]{0,254}`; trimmed, lowercased |

## Request

```bash
curl "https://api.onekey.dev/v1/shopify/collection_products?domain=www.allbirds.com&handle=womens" \
  -H "x-api-key: YOUR_API_KEY"
```

```python
import requests

res = requests.get(
    "https://api.onekey.dev/v1/shopify/collection_products",
    params={"domain": "www.allbirds.com", "handle": "womens"},
    headers={"x-api-key": "YOUR_API_KEY"},
)
body = res.json()

if body["success"]:
    print(body["data"])
else:
    print(body["error"]["code"], body["error"]["message"])
```

```javascript
const params = new URLSearchParams({ domain: "www.allbirds.com", handle: "womens" });
const res = await fetch(`https://api.onekey.dev/v1/shopify/collection_products?${params}`, {
  headers: { "x-api-key": "YOUR_API_KEY" },
});
const body = await res.json();

if (body.success) console.log(body.data);
else console.error(body.error.code, body.error.message);
```

## Recorded response

A real Shopify response, recorded and returned in Onekey's shape. Fields the platform does not provide are `null`.

```json
{
  "success": true,
  "data": [
    {
      "content": {
        "id": "7205191090256",
        "createdAt": "2026-06-12T00:20:53Z",
        "updatedAt": "2026-09-28T20:00:32Z"
      },
      "entity": {
        "name": "Women's Canvas Cruiser - Warm White (Natural White Sole)",
        "description": "Classic court style, relaxed for warmer days. Cruiser Canvas pairs a familiar silhouette with a subtly textured hemp-and-cotton upper that feels light, breathable, and ready to wear on repeat. Comfortable enough for all day. Simple enough to go with everything.",
        "category": "Shoes",
        "tags": [
          "allbirds::carbon-score => undefined",
          "allbirds::cfId => color-f42508e2a00368acc9479031f9a048d4",
          "allbirds::complete => true",
          "allbirds::edition => classic",
          "allbirds::gender => womens",
          "allbirds::hue => white",
          "allbirds::master => womens-cruiser-canvas",
          "allbirds::material => canvas",
          "allbirds::price-tier => msrp",
          "allbirds::silhouette => runner",
          "DNAM BRANDS",
          "loop::returnable => true",
          "Wave#2 WC",
          "Wave#3 WC",
          "Wave#4 WC-(TRAILERS 09-011)",
          "WC WAVE 1 TRUCK #1-#16 7.30.2026",
          "YCRF_womens-move-shoes-half-sizes",
          "YGroup_ygroup_womens-cruiser-canvas"
        ]
      },
      "ext": {
        "handle": "womens-cruiser-canvas",
        "vendor": "Allbirds"
      },
      "listing": {
        "price": 75,
        "sku": "A12344W050",
        "available": false
      },
      "media": {
        "thumbnailUrl": "https://cdn.shopify.com/s/files/1/1104/4168/files/A12344_26Q1_Cruiser-Canvas-Warm-White-Natural-White_PDP_LEFT.png?v=1768946396"
      }
    },
    {
      "content": {
        "id": "7205191516240",
        "createdAt": "2026-09-25T22:55:13Z",
        "updatedAt": "2026-09-28T20:00:32Z"
      },
      "entity": {
        "name": "Women's Cruiser Canvas - Auburn (Warm White Sole)",
        "description": "Classic court style, relaxed for warmer days. Cruiser Canvas pairs a familiar silhouette with a subtly textured hemp-and-cotton upper that feels light, breathable, and ready to wear on repeat. Comfortable enough for all day. Simple enough to go with everything.",
        "category": "Shoes",
        "tags": [
          "allbirds::carbon-score => undefined",
          "allbirds::cfId => color-2a02699b7f8037dcf2be887c21f98e7d",
          "allbirds::complete => true",
          "allbirds::edition => limited",
          "allbirds::gender => womens",
          "allbirds::hue => red",
          "allbirds::master => womens-cruiser-canvas",
          "allbirds::material => canvas",
          "allbirds::price-tier => msrp",
          "allbirds::silhouette => runner",
          "loop::returnable => true",
          "OOS DNS",
          "Wave#2 WC",
          "WC WAVE 1 TRUCK #1-#16 7.30.2026",
          "YCRF_womens-move-shoes-half-sizes",
          "YGroup_ygroup_womens-cruiser-canvas"
        ]
      },
      "ext": {
        "handle": "womens-cruiser-canvas-auburn",
        "vendor": "Allbirds"
      },
      "listing": {
        "price": 75,
        "sku": "A12438W050",
        "available": false
      },
      "media": {
        "thumbnailUrl": "https://cdn.shopify.com/s/files/1/1104/4168/files/A12438_26Q1_Cruiser-Canvas-Auburn-Warm-White_PDP_LEFT_cceb74e2-4e2c-42cb-91b4-4b23348c9baa.png?v=1768946300"
      }
    }
  ],
  "metadata": {
    "platform": "shopify",
    "endpoint": "collection_products",
    "cached": false,
    "stale": false,
    "age_s": 0,
    "fetched_at": "2026-01-01T12:00:00+00:00",
    "credits_charged": 5,
    "request_id": "7f3a9c2e5b1d4c8fa2e6d0b9c4f18e37"
  },
  "error": null
}
```

## Field mapping

How this endpoint's source fields become Onekey's [unified schema](https://onekey.dev/docs/schema.md). Fields the source lacks come back as `null`.

| Source path | Onekey field | Transform |
| --- | --- | --- |
| `id` | `content.id` | `toString` |
| `title` | `entity.name` | - |
| `handle` | `ext.handle` | - |
| `body_html` | `entity.description` | `stripHtml` |
| `published_at` | `content.createdAt` | `toIsoDate` |
| `updated_at` | `content.updatedAt` | `toIsoDate` |
| `vendor` | `ext.vendor` | - |
| `product_type` | `entity.category` | - |
| `tags` | `entity.tags` | - |
| `variants.0.price` | `listing.price` | `toNumber` |
| `variants.0.sku` | `listing.sku` | - |
| `variants.0.available` | `listing.available` | `toBoolean` |
| `images.0.src` | `media.thumbnailUrl` | `safeUrl` |

## Caching and freshness

- Fresh for about 2 minutes. Repeat calls in that window are served from cache and are free.
- Between 2 minutes and 15 minutes the cached copy is still served instantly and marked `stale: true` while Onekey refreshes it in the background.
- If the source is down when a refresh is needed, the last copy can be served for up to 1 hour more (marked stale).
- A "not found" is remembered for 1 minute and is free.
- The cache is shared across all customers, which is what keeps repeat calls cheap.

## What can go wrong

| Status | Code | What to do |
| --- | --- | --- |
| 401 | `unauthorized` | Check the `x-api-key` header. |
| 402 | `insufficient_credits` | [Add credits](https://onekey.dev/pricing); your balance must cover the price. |
| 404 | `not_found` | Unknown endpoint path. |
| 422 | `invalid_params` | Fix the parameters using the table above. Free. |
| 429 | `rate_limited` | Wait `Retry-After` seconds, then retry. |
| 502 | `upstream_error` | The source failed. Refunded; retry with backoff. |

See [Errors](https://onekey.dev/docs/errors.md) for the full list and retry guidance.

Status: stable (verified against the live source).