> ## Documentation Index
> Fetch the complete documentation index at: https://help.privy.com/llms.txt
> Use this file to discover all available pages before exploring further.

# List a collection's products

> 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`




## OpenAPI

````yaml openapi/privy-api.yaml GET /product_collections/{id}/products
openapi: 3.1.0
info:
  title: Privy API
  version: '1.0'
  description: >
    The Privy API lets you programmatically manage your contact list and read
    what you have set up in Privy.

    Create, update, unsubscribe, and remove contacts; report orders;

    and read your campaigns, flows, segments, orders, store products, coupon
    pools,

    performance reports, and account setup.
servers:
  - url: https://api.privy.com/v1
    description: Production
security:
  - bearerAuth: []
tags:
  - name: Account
    description: Retrieve information about the authenticated Privy account.
  - name: Contacts
    description: Manage your contact list.
  - name: Imports
    description: >-
      Read your contact import history — CSV uploads, connected-provider syncs,
      and SMS consent imports.
  - name: Campaigns
    description: >-
      Read your message campaigns — email and SMS newsletters, plus the messages
      your flows send.
  - name: Displays
    description: >-
      Read your on-site displays (popups, flyouts, banners, embedded forms,
      landing pages).
  - name: Coupons
    description: Read your coupon pools, their code inventory, and individual codes.
  - name: Reports
    description: >-
      Read performance reporting — signups, views, conversion rates, and
      attributed revenue — for your business, displays, and flows.
  - name: Flows
    description: Read your automation flows and their configuration.
  - name: Segments
    description: Read your customer segments and their membership.
  - name: Orders
    description: Report orders placed in your store and read your order history.
  - name: Products
    description: Read the product catalog and collections of your connected store.
  - name: Events
    description: Ingest custom events to trigger Flows and other automations.
paths:
  /product_collections/{id}/products:
    get:
      tags:
        - Products
      summary: List a collection's products
      description: >
        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`
      operationId: listProductCollectionProducts
      parameters:
        - $ref: '#/components/parameters/AccountIdParam'
        - name: id
          in: path
          required: true
          description: >-
            The store's collection id (returned as `id` in collection
            responses).
          schema:
            type: integer
            format: int64
          example: 421123456789
        - name: per_page
          in: query
          description: Number of results per page, clamped to 1–50.
          schema:
            type: integer
            default: 25
            minimum: 1
            maximum: 50
          example: 25
        - name: cursor
          in: query
          description: >-
            Opaque pagination cursor from a previous response's
            `pagination.next_cursor`.
          schema:
            type: string
          example: eyJsYXN0X2lkIjo3ODkwMTIzNDU2Nzg5fQ==
      responses:
        '200':
          description: A page of the collection's products.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Product'
                  pagination:
                    $ref: '#/components/schemas/CursorPagination'
              example:
                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: 2
                    variants:
                      - id: 40012345678901
                        title: Small
                        price: '10.00'
                        compare_at_price: null
                        sku: TSHIRT-S
                        inventory_quantity: 12
                        available: true
                      - id: 40012345678902
                        title: Large
                        price: '15.00'
                        compare_at_price: '20.00'
                        sku: TSHIRT-L
                        inventory_quantity: 30
                        available: true
                    created_at: '2026-01-10T09:00:00Z'
                    updated_at: '2026-06-01T09:00:00Z'
                pagination:
                  per_page: 25
                  total_count: 12
                  has_more: false
                  next_cursor: null
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/InsufficientScope'
        '404':
          $ref: '#/components/responses/NotFound'
        '422':
          $ref: '#/components/responses/ValidationFailed'
        '429':
          $ref: '#/components/responses/ProductsRateLimited'
        '502':
          $ref: '#/components/responses/StoreUnavailable'
      security:
        - bearerAuth: []
components:
  parameters:
    AccountIdParam:
      name: Privy-Account-Id
      in: header
      required: false
      description: >
        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.
      schema:
        type: string
      example: S1U2B3A4C5C6T7
  schemas:
    Product:
      type: object
      properties:
        id:
          type: integer
          format: int64
          description: >-
            The store's product id. Use this value in `/v1/products/{id}`.
            Matches the product ids on order line items.
          example: 7890123456789
        title:
          type: string
          example: Classic T-Shirt
        handle:
          type:
            - string
            - 'null'
          description: >-
            The product's URL slug. `null` on BigCommerce products with no
            storefront path.
          example: classic-t-shirt
        status:
          type: string
          enum:
            - active
            - draft
            - archived
          example: active
        product_type:
          type:
            - string
            - 'null'
          description: >-
            The merchant-defined product category. Always `null` on BigCommerce
            stores.
          example: Shirts
        vendor:
          type:
            - string
            - 'null'
          description: The product's vendor/brand. Always `null` on BigCommerce stores.
          example: Acme Apparel
        url:
          type:
            - string
            - 'null'
          description: >-
            The product's storefront URL. `null` if not published to the online
            store; always `null` on BigCommerce stores.
          example: https://mystore.com/products/classic-t-shirt
        image_url:
          type:
            - string
            - 'null'
          example: https://cdn.shopify.com/s/files/1/0001/products/tshirt.jpg
        price_range:
          type:
            - object
            - 'null'
          properties:
            min:
              type: string
              example: '10.00'
            max:
              type: string
              example: '15.00'
            currency_code:
              type: string
              example: USD
        total_inventory:
          type:
            - integer
            - 'null'
          description: >-
            Total sellable inventory across variants. `null` when the store does
            not report it.
          example: 42
        tracks_inventory:
          type: boolean
          example: true
        variants_count:
          type:
            - integer
            - 'null'
          description: >-
            Total number of variants on the product (the `variants` array may be
            truncated below this).
          example: 3
        variants:
          type: array
          items:
            $ref: '#/components/schemas/ProductVariant'
        created_at:
          type: string
          format: date-time
          example: '2026-01-10T09:00:00Z'
        updated_at:
          type: string
          format: date-time
          example: '2026-06-01T09:00:00Z'
    CursorPagination:
      type: object
      description: >-
        Cursor-based pagination envelope, used by the Products and Product
        Collections endpoints.
      properties:
        per_page:
          type: integer
          example: 40
        total_count:
          type:
            - integer
            - 'null'
          description: >-
            Total items across every page. `null` when the store does not report
            one.
          example: 128
        has_more:
          type: boolean
          example: true
        next_cursor:
          type:
            - string
            - 'null'
          description: >-
            Opaque cursor for the next page. Pass as `?cursor=`. `null` on the
            last page.
          example: eyJsYXN0X2lkIjo3ODkwMTIzNDU2Nzg5fQ==
    ProductVariant:
      type: object
      properties:
        id:
          type: integer
          format: int64
          description: The store's variant id.
          example: 40012345678901
        title:
          type:
            - string
            - 'null'
          description: >-
            `null` on BigCommerce stores for a product's base variant (it has no
            option values); Shopify default variants carry "Default Title"
            instead.
          example: Small
        price:
          type:
            - string
            - 'null'
          description: Variant price in the store's currency, as a decimal string.
          example: '10.00'
        compare_at_price:
          type:
            - string
            - 'null'
          example: '15.00'
        sku:
          type:
            - string
            - 'null'
          example: TSHIRT-S
        inventory_quantity:
          type:
            - integer
            - 'null'
          example: 12
        available:
          type: boolean
          description: >-
            Whether the variant can currently be purchased (untracked inventory
            counts as available).
          example: true
    ErrorResponse:
      type: object
      properties:
        error:
          type: object
          required:
            - code
            - message
          properties:
            code:
              type: string
              enum:
                - invalid_client
                - invalid_scope
                - unauthorized
                - insufficient_scope
                - paid_plan_required
                - api_access_required
                - not_found
                - no_connected_store
                - conflict
                - contacts_not_ready
                - validation_failed
                - rate_limited
                - store_unavailable
              example: validation_failed
            message:
              type: string
              example: One or more fields are invalid
            details:
              type: array
              items:
                type: object
                properties:
                  field:
                    type: string
                    example: email
                  message:
                    type: string
                    example: is required
  responses:
    Unauthorized:
      description: Missing or invalid bearer token.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            error:
              code: unauthorized
              message: Bearer token is missing or invalid
    InsufficientScope:
      description: Token lacks the required scope for this endpoint.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            error:
              code: insufficient_scope
              message: Token does not have the required scope
    NotFound:
      description: >-
        The requested resource does not exist or does not belong to your
        account.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            error:
              code: not_found
              message: Not found
    ValidationFailed:
      description: One or more fields failed validation.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            error:
              code: validation_failed
              message: One or more fields are invalid
              details:
                - field: email
                  message: is required
    ProductsRateLimited:
      description: >-
        Rate limit exceeded — either Privy's API rate limit (code
        `rate_limited`, with the `X-RateLimit-*` headers) or the connected
        store's own quota passed through (code `store_rate_limited`).
        `Retry-After` carries the wait when it is known — BigCommerce's reset
        window, or a wait derived from Shopify's throttle cost payload.
      headers:
        Retry-After:
          description: Seconds to wait before retrying.
          schema:
            type: integer
          example: 15
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            error:
              code: store_rate_limited
              message: >-
                The connected store is rate limiting requests. Try again
                shortly.
    StoreUnavailable:
      description: >-
        The connected store's API could not be reached or returned an error.
        Retry shortly.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            error:
              code: store_unavailable
              message: The connected store could not be reached. Try again shortly.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API token or OAuth access token
      description: >
        Send either an API token or an OAuth access token as

        `Authorization: Bearer <token>`. See the Authentication page for
        details.

````