PRprivy
Products

List a product's collections

Changed on

Retrieve the collections (Shopify) or categories (BigCommerce) one product of your connected store belongs to, by its store product id.

Uses the same cursor pagination as /v1/product_collections. total_count is null on Shopify stores, which do not report it. The title and handle filters of /v1/product_collections 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/products/{id}/collections

Request

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

Path parameters

idinteger required

The store's product id (returned as id in product 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 product's collections.

Example response

{
  "data": [
    {
      "id": 421123456789,
      "handle": "summer-collection",
      "title": "Summer Collection"
    }
  ],
  "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