MTN TMF637 Product Inventory is one of 119 APIs that MTN Group publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include TM Forum, TMF637, and South Africa. The published artifact set on APIs.io includes API documentation, an API reference, and an OpenAPI specification.
This API exposes
2 operations
across 2 paths,
and defines 64 schemas.
It is described by OpenAPI 2.0, at version 4.0.0.
Requests are made against the base URL https://api.mtn.com/tmf-api/productInventory/v4.
The identity and technical contract details declared by the specification.
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
AttachmentRefOrValue
object
An attachment by value or by reference.
4 properties
BillingAccountRef
object
BillingAccount reference. A BillingAccount is a detailed description of a bill structure.
7 properties
1 required
Bucket
object
Describes allocation consumption details
4 properties
CategoryRef
object
The category for grouping recommendations
4 properties
1 required
Characteristic
object
Describes a given characteristic of an object or entity through a name/value pair.
10 properties
2 required
CharacteristicRef
object
Describes a given characteristic of an object or entity through a name/value pair.
4 properties
2 required
EntityRef
object
Entity reference schema to be use for all entityRef class.
7 properties
1 required
GeographicAddress
object
Structured textual way of describing how to find a Property for service installation
17 properties
Money
object
A base / value business entity used to represent money
2 properties
PaginationRef
object
Query results and paging details.
5 properties
Place
object
Place reference. Place defines the places where the products are sold or delivered.
6 properties
PlaceRef
object
Place reference. PlaceRef defines the placeRefs where the products are sold or delivered.
7 properties
1 required
Price
object
Provides all amounts (tax included, duty free, tax rate), used currency and percentage to apply for Price Alteration.
9 properties
PriceAlteration
object
Is an amount, usually of money, that modifies the price charged for an order item.
13 properties
2 required
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
Product_Create
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).…
26 properties
1 required
Product_Update
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).…
26 properties
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
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
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
ProductRef
object
7 properties
1 required
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
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
ProductSpecificationCharacteristic
object
A characteristic quality or distinctive feature of a ProductSpecification.
6 properties
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
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
ProductStatusType
string
Possible values for the status of the product
ProductTerm
object
Description of a productTerm linked to this product. This represent a commitment with a duration
9 properties
ProductTermCharacteristic
object
A characteristic quality or distinctive feature of a ProductRefOrValue.
2 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
Quantity
object
An amount in a given unit
2 properties
RelatedParty
object
Related Entity reference. A related party defines party or party role linked to a specific entity.
8 properties
2 required
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
RelatedProductOrderItem
object
RelatedProductOrderItem (ProductOrder item) .The product order item which triggered product creation/change/termination.
9 properties
2 required
ResourceRef
object
8 properties
1 required
ServiceRef
object
Service reference, for when Service is used by other entities
14 properties
1 required
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
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
ServiceSpecCharRelationship
object
An aggregation, migration, substitution, dependency or exclusivity relationship between/among serviceSpecCharacteristics.
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
ServiceStatusType
string
Service status. SVMAPPING:SERVICETREV.SERVICESTATUSCODE. Refer to RT perestapi.SERVICESTATUSCODE
SummaryOfChange
object
Summary of change
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
TaxItem
object
A tax item is created for each tax rate and tax type used in the bill.
3 properties
TimePeriod
object
A period of time, either as a deadline (endDateTime only) a startDateTime only, or both
2 properties
EventSubscription
object
Sets the communication endpoint address the service instance must use to deliver notification information
3 properties
2 required
EventSubscriptionInput
object
Sets the communication endpoint address the service instance must use to deliver notification information
2 properties
1 required
ProductCreateEvent
object
The notification data structure
12 properties
ProductCreateEventPayload
object
The event data structure
1 property
ProductAttributeValueChangeEvent
object
The notification data structure
11 properties
ProductAttributeValueChangeEventPayload
object
The event data structure
1 property
ProductStateChangeEvent
object
The notification data structure
12 properties
ProductStateChangeEventPayload
object
The event data structure
1 property
ProductBatchEvent
object
The notification data structure
12 properties
ProductBatchEventPayload
object
The event data structure
1 property
ProductDeleteEvent
object
The notification data structure
12 properties
ProductDeleteEventPayload
object
The event data structure
1 property
UsageConsumptionGroup
object
Group of relevant entitlements and their consumption details at any give point in time.
7 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
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
UsageConsumption
object
Entitlement consumption details the balances and the allocations at any give point in time.
6 properties
Error
object
Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
8 properties
2 required
The full machine-readable OpenAPI contract behind this narrative.
Other APIs MTN Group publishes across the network.
