MTN Group Product API is one of 148 APIs that MTN Group publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Product. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes
2 operations
across 2 paths,
and defines 46 schemas.
It is described by OpenAPI 3.2.0, at version 4.0.0.
Requests are made against a single base URL, https://serverRoot/tmf-api/productInventory/v4/.
The identity and technical contract details declared by the specification.
RelatedParty
object
Related Entity reference. A related party defines party or party role linked to a specific entity.
8 properties
2 required
Price
object
Provides all amounts (tax included, duty free, tax rate), used currency and percentage to apply for Price Alteration.
9 properties
UsageConsumptionGroup
object
Group of relevant entitlements and their consumption details at any give point in time.
7 properties
ProductTerm
object
Description of a productTerm linked to this product. This represent a commitment with a duration
9 properties
PriceAlteration
object
Is an amount, usually of money, that modifies the price charged for an order item.
13 properties
2 required
ResourceRef
object
8 properties
1 required
AttachmentRefOrValue
object
An attachment by value or by reference.
4 properties
ProductTermCharacteristicValue
object
A ProductTermCharacteristicValue object is used to define a set of attributes, each of which can be assigned to a corresponding set of attributes in a ProductT…
2 properties
ServiceStatusType
string
Service status. SVMAPPING:SERVICETREV.SERVICESTATUSCODE. Refer to RT perestapi.SERVICESTATUSCODE
ProductSpecificationCharacteristicValue
object
A ProductSpecificationCharacteristicValue object is used to define a set of attributes, each of which can be assigned to a corresponding set of attributes in a…
3 properties
BillingAccountRef
object
BillingAccount reference. A BillingAccount is a detailed description of a bill structure.
7 properties
1 required
CharacteristicRef
object
Describes a given characteristic of an object or entity through a name/value pair.
4 properties
2 required
PaginationRef
object
Query results and paging details.
5 properties
ProductSpecificationCharacteristic
object
A characteristic quality or distinctive feature of a ProductSpecification.
6 properties
Bucket
object
Describes allocation consumption details
4 properties
GeographicAddress
object
Structured textual way of describing how to find a Property for service installation
17 properties
Product
object
A product offering procured by a customer or other interested party playing a party role. A product is realized as one or more service(s) and / or resource(s).
2 properties
Error
object
Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
8 properties
2 required
AgreementItemRef
object
Agreement reference. An agreement represents a contract or arrangement, either written or verbal and sometimes enforceable by law, such as a service level agre…
8 properties
1 required
TimePeriod
object
A period of time, either as a deadline (endDateTime only) a startDateTime only, or both
2 properties
RelatedPlaceRefOrValue
object
Related Entity reference. A related place defines a place described by reference or by value linked to a specific entity. The polymorphic attributes @type, @sc…
8 properties
1 required
ServiceSpecCharRelationship
object
An aggregation, migration, substitution, dependency or exclusivity relationship between/among serviceSpecCharacteristics.
2 properties
ServiceSpecification
object
ServiceSpecification is a class that offers characteristics to describe a type of service. Functionally, it acts as a template by which Services may be instant…
4 properties
Characteristic
object
Describes a given characteristic of an object or entity through a name/value pair.
10 properties
2 required
Limits
object
The entitlement consumption limits will only be shown when there are limit tracker companions active on the instance for this service.
5 properties
ProductTermCharacteristic
object
A characteristic quality or distinctive feature of a ProductRefOrValue.
2 properties
CategoryRef
object
The category for grouping recommendations
4 properties
1 required
ServiceSpecCharacteristic
object
This class represents the key features of this service specification. For example, bandwidth is a characteristic of many different types of services; if bandwi…
3 properties
SharePool
object
The pool name will only be shown when SVMAPPING:ENTITLEMENTTREV.SUBCATEGORY = SHAREABLE and the table display name (from customer DA) that keeps the list of co…
2 properties
ServiceSpecCharacteristicValue
object
A ServiceSpecCharacteristicValue object is used to define a set of attributes, each of which can be assigned to a corresponding set of attributes in a ServiceS…
2 properties
ServiceRef
object
Service reference, for when Service is used by other entities
14 properties
1 required
ProductPrice
object
An amount, usually of money, that represents the actual price paid by a Customer for a purchase, a rent or a lease of a Product. The price is valid for a defin…
15 properties
2 required
TaxItem
object
A tax item is created for each tax rate and tax type used in the bill.
3 properties
ProductRefOrValue
object
A product to be created defined by value or existing defined by reference. The polymorphic attributes @type, @schemaLocation & @referredType are related to the…
33 properties
Quantity
object
An amount in a given unit
2 properties
ProductRelationship
object
Linked products to the one instantiate, such as [bundled] if the product is a bundle and you want to describe the bundled products inside this bundle; [reliesO…
5 properties
2 required
SummaryOfChange
object
Summary of change
2 properties
ProductOfferingRef
object
ProductOffering reference. A product offering represents entities that are orderable from the provider of the catalog, this resource includes pricing informati…
11 properties
1 required
Money
object
A base / value business entity used to represent money
2 properties
TargetProductSchema
object
The reference object to the schema and type of target product which is described by product specification
3 properties
2 required
ProductSpecificationRef
object
Product specification reference: A ProductSpecification is a detailed description of a tangible or intangible object made available externally in the form of a…
11 properties
1 required
ProductOfferingPriceRef
object
ProductPriceOffering reference. An amount, usually of money, that is asked for or allowed when a ProductOffering is bought, rented, or leased
7 properties
1 required
ProductStatusType
string
Possible values for the status of the product
RelatedProductOrderItem
object
RelatedProductOrderItem (ProductOrder item) .The product order item which triggered product creation/change/termination.
9 properties
2 required
UsageConsumption
object
Entitlement consumption details the balances and the allocations at any give point in time.
6 properties
The full machine-readable OpenAPI contract behind this narrative.
Other APIs MTN Group publishes across the network.
