Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Zuora Catalog Groups API

A catalog group is used to group a list of product rate plans with a specific grade.

Zuora Catalog Groups API is one of 80 APIs that Zuora publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Catalog Groups. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 5 operations across 2 paths, and defines 8 schemas. It is described by OpenAPI 2.0, at version 2023-12-15.

5 operations 2 paths 8 schemas 1 DELETE2 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 2.0
API Version
2023-12-15
Resource Areas
1

Paths & Operations 5

Across 2 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Catalog Groups 5

A catalog group is used to group a list of product rate plans with a specific grade.

POST
/v1/catalog-groups
Create a catalog group
POST_CreateCatalogGroup 8 params → 200
GET
/v1/catalog-groups
List all catalog groups
GET_ListAllCatalogGroups 8 params → 200
GET
/v1/catalog-groups/{catalog-group-key}
Retrieve a catalog group
GET_RetrieveCatalogGroup 7 params → 200
PUT
/v1/catalog-groups/{catalog-group-key}
Update a catalog group
PUT_UpdateCatalogGroup 8 params → 200
DELETE
/v1/catalog-groups/{catalog-group-key}
Delete a catalog group
DELETE_CatalogGroup 7 params → 200

Schemas 8

The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are GETCatalogGroupProductRatePlanResponse (8 properties), CatalogGroupResponse (6 properties), CommonResponseType (3 properties), ListAllCatalogGroupsResponse (2 properties). Each schema is shown below with its type and property counts.

ListAllCatalogGroupsResponse
object
2 properties
GETCatalogGroupProductRatePlanResponse
object
8 properties
CommonResponseType
object
3 properties
POSTorPUTCatalogGroupAddProductRatePlan
PUTCatalogGroupRemoveProductRatePlan
PUTCatalogGroup
POSTCatalogGroupRequest
CatalogGroupResponse
object
6 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zuora-catalog-groups-api-openapi.yml Raw ↑

Other APIs Zuora publishes across the network.

Zuora V1 API
Zuora Accounting Codes API
Zuora Accounting Periods API
Zuora Accounts API
Zuora Actions API
Zuora Aggregate Queries API
Zuora API Health API
Zuora Attachments API
Zuora Bill Run API
Zuora Bill Run Health API
Zuora Billing Documents API
Zuora Billing Preview Run API