Get product groups

Get all product groups for up- and downgrades.

^{Required permissions: product-group:read}

GET /catalogue/product-groups

cURL

cURL

curl -X GET \
 /catalogue/product-groups \
 --header "Authorization: Bearer <token>"

import requests

url = "https://coreapi.io/catalogue/product-groups"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://coreapi.io/catalogue/product-groups', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://coreapi.io/catalogue/product-groups",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

200

{
  "data": [
    {
      "id": "ad8f1c2c-3b1c-4b0a-8b0a-0b0b0b0b0b0b",
      "name": "SaaS Packages",
      "enabled": true,
      "forceSameBillingInterval": false,
      "memberships": [
        {
          "id": "ad8f1c2c-3b1c-4b0a-8b0a-0b0b0b0b0b0b",
          "product": "<unknown>",
          "pricePlans": [
            "<unknown>"
          ],
          "position": 123,
          "label": "Pro",
          "upgradeable": true,
          "downgradeable": true
        }
      ],
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "meta": {
    "pagination": {
      "totalItems": 123,
      "itemsPerPage": 123,
      "currentPage": 123,
      "lastPage": 123
    }
  }
}

Get all product groups for up- and downgrades.

​

Use Cases

• List all available product groups
• Display upgrade/downgrade configurations in admin UI
• Verify product group setup before enabling self-service changes

Product Groups Guide

Learn how to set up product groups for self-service upgrades

Autorisierungen

Authorization · string · header · erforderlich

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Abfrageparameter

page · integer · Standard: 1

The collection page number

Antwort

200 - application/json

ProductGroup collection

data · object[]

Show child attributes

meta · object

Show child attributes