PRprivy
Products

Get a product collection

Changed on

Retrieve one collection (Shopify) or category (BigCommerce) of your connected store by its store id, the id a purchase_history segment condition's collection filter holds.

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

Required scope: products_read

get/product_collections/{id}

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).

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

The collection.

Example response

{
  "data": {
    "id": 421123456789,
    "handle": "summer-collection",
    "title": "Summer Collection"
  }
}

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