PRprivy
Products

List a collection's products

Changed on

Retrieve the products in one collection (Shopify) or category (BigCommerce) of your connected store, in the same shape as /v1/products.

Uses the same cursor pagination as /v1/products. total_count is null on Shopify stores when the collection holds more products than Shopify will count exactly. The title and handle filters of /v1/products are not available here and return 422 validation_failed.

Requires a connected Shopify or BigCommerce store — without one, this endpoint returns 404 no_connected_store.

Required scope: products_read

get/product_collections/{id}/products

Request

  • Base URL
    https://api.privy.com/v1
  • Auth
    HTTP bearer

Path parameters

idinteger required

The store's collection id (returned as id in collection responses).

Query parameters

per_pageinteger

Number of results per page, clamped to 1–50.

cursorstring

Opaque pagination cursor from a previous response's pagination.next_cursor.

Headers

Privy-Account-Idstring

Target a subaccount instead of the main connected account. Pass a subaccount id from get_account's subaccounts list. Only direct subaccounts of the connected account are reachable — omit this for the main account itself.

Response

A page of the collection's products.

Example response

{
  "data": [
    {
      "id": 7890123456789,
      "title": "Classic T-Shirt",
      "handle": "classic-t-shirt",
      "status": "active",
      "product_type": "Shirts",
      "vendor": "Acme Apparel",
      "url": "https://mystore.com/products/classic-t-shirt",
      "image_url": "https://cdn.shopify.com/s/files/1/0001/products/tshirt.jpg",
      "price_range": {
        "min": "10.00",
        "max": "15.00",
        "currency_code": "USD"
      },
      "total_inventory": 42,
      "tracks_inventory": true,
      "variants_count": 3,
      "variants": [
        {
          "id": 40012345678901,
          "title": "Small",
          "price": "10.00",
          "compare_at_price": "15.00",
          "sku": "TSHIRT-S",
          "inventory_quantity": 12,
          "available": true
        }
      ],
      "created_at": "2026-01-10T09:00:00Z",
      "updated_at": "2026-06-01T09:00:00Z"
    }
  ],
  "pagination": {
    "per_page": 40,
    "total_count": 128,
    "has_more": true,
    "next_cursor": "eyJsYXN0X2lkIjo3ODkwMTIzNDU2Nzg5fQ=="
  }
}

Changes

  • cf0885e90d5aRevision changes
    • warning

      added the new forbidden enum value to the / response property for the response status

    • warning

      added the new forbidden enum value to the / response property for the response status

    • warning

      added the new forbidden enum value to the / response property for the response status

    • warning

      added the new forbidden enum value to the / response property for the response status

    • warning

      added the new forbidden enum value to the / response property for the response status

    • warning

      added the new forbidden enum value to the / response property for the response status

    • warning

      added the new segment_builder_required enum value to the / response property for the response status

    • warning

      added the new segment_builder_required enum value to the / response property for the response status

    • warning

      added the new segment_builder_required enum value to the / response property for the response status

    • warning

      added the new segment_builder_required enum value to the / response property for the response status

    • warning

      added the new segment_builder_required enum value to the / response property for the response status

    • warning

      added the new segment_builder_required enum value to the / response property for the response status

  • fe500ab59b3bRevision changes
    • info

      endpoint added