Aria gained conformance certification from TM Forum for this API in December 2021.
TMF620 Product Catalog Management API provides:
- A method of creating and retrieving a Product Specification, which is a detailed description of a service, from Aria Billing Cloud. These Services can then be made available externally through an association with a Product Offering (an Aria Plan) to customers or other parties.
- A method to create, update, retrieve and delete a Product Offering within Aria Billing Cloud which comprises of a plan and associated services or a non-subscription offering. These offerings, including pricing information, are orderable from the catalog.
- A method to create, update, retrieve and delete a Product Offering Price in Aria Billing Cloud’s rate schedule for a plan.
The full API specification for TMF620 can be found on the TM Forum site: TMF620 Product Catalog Management API User Guide v4.1.0 | TM Forum
The Tables below show the API mandated resource along with mandated operations for conformance.
ProductSpecification
| Operation | Mandatory/Optional | Comments |
|---|---|---|
| GET | M |
Response Status Code 200 if successful |
| Response Status Code 404 if not found | ||
| POST | M | Status Code 201 if resource created |
ProductSpecification Operations
- Create a Product Specification
- This operation creates a service offering within Aria Billing Cloud’s product catalog.
- Retrieve Product Specificatio
- This operation retrieves a list of service offerings from Aria Cres
- Retrieve Product Specification by filters
- This operation retrieves service offerings based on a variety of filter conditions from Aria Billing Cloud.
ProductOffering
| Operation | Mandatory/Optional | Comments |
|---|---|---|
| GET | M |
Response Status Code 200 if successful |
| Response Status Code 404 if not found | ||
| POST | M | Status Code 201 if resource created |
| PATCH | M | Response Status Code 200 if successful |
| DELETE | M | Response Status Code 204 if successful |
ProductOffering Operations
- Create Product Offering
- This operation creates a plan, the product offering, within Aria Billing Cloud.
- Retrieve Product Offering by filters
- This operation retrieves a plan based on a variety of filter conditions from Aria Billing Cloud.
- Update Product Offering
- This operation updates a plan, the product offering, in Aria Billing Cloud.
- Delete Product Offering
- This operation marks a plan as inactive in Aria Billing Cloud to maintain auditability.
ProductOfferingPrice
| Operation | Mandatory/Optional | Comments |
|---|---|---|
| GET | M |
Response Status Code 200 if successful |
| Response Status Code 404 if not found | ||
| POST | M | Status Code 201 if resource created |
| PATCH | M | Response Status Code 200 if successful |
| DELETE | M | Response Status Code 204 if successful |