How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
TM Forum

TM Forum notification listener API

Notifications for Resource Lifecycle and event notifications

Documentation Provider Profile APIs.io OpenAPI GitHub

TM Forum notification listener API is one of 38 APIs that TM Forum publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include notification listener. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 62 operations across 62 paths, and defines 317 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against 5 base URLs: https://serverRoot/productCatalogManagement/v5/, {apiRoot}/tmf-api/troubleTicket/v5/, https://serverRoot, {apiRoot}/tmf-api/customer/v5/, https://serverRoot/partyManagement/v5/.

62 operations 62 paths 317 schemas 62 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Servers
https://serverRoot/productCatalogManagement/v5/
{apiRoot}/tmf-api/troubleTicket/v5/
https://serverRoot
{apiRoot}/tmf-api/customer/v5/
https://serverRoot/partyManagement/v5/
Resource Areas
1

Paths & Operations 62

Across 62 paths, the API surfaces 62 operations — 62 POST. Each is listed below with its method, path, parameters, and response codes.

notification listener 62

Notifications for Resource Lifecycle and event notifications

POST
/listener/categoryAttributeValueChangeEvent
TM Forum Client Listener for Entity CategoryAttributeValueChangeEvent
categoryAttributeValueChangeEvent body → 204default
POST
/listener/categoryCreateEvent
TM Forum Client Listener for Entity CategoryCreateEvent
categoryCreateEvent body → 204default
POST
/listener/categoryDeleteEvent
TM Forum Client Listener for Entity CategoryDeleteEvent
categoryDeleteEvent body → 204default
POST
/listener/categoryStateChangeEvent
TM Forum Client Listener for Entity CategoryStateChangeEvent
categoryStateChangeEvent body → 204default
POST
/listener/exportJobCreateEvent
TM Forum Client Listener for Entity ExportJobCreateEvent
exportJobCreateEvent body → 204default
POST
/listener/exportJobStateChangeEvent
TM Forum Client Listener for Entity ExportJobStateChangeEvent
exportJobStateChangeEvent body → 204default
POST
/listener/importJobCreateEvent
TM Forum Client Listener for Entity ImportJobCreateEvent
importJobCreateEvent body → 204default
POST
/listener/importJobStateChangeEvent
TM Forum Client Listener for Entity ImportJobStateChangeEvent
importJobStateChangeEvent body → 204default
POST
/listener/productCatalogAttributeValueChangeEvent
TM Forum Client Listener for Entity ProductCatalogAttributeValueChangeEvent
productCatalogAttributeValueChangeEvent body → 204default
POST
/listener/productCatalogCreateEvent
TM Forum Client Listener for Entity ProductCatalogCreateEvent
productCatalogCreateEvent body → 204default
POST
/listener/productCatalogDeleteEvent
TM Forum Client Listener for Entity ProductCatalogDeleteEvent
productCatalogDeleteEvent body → 204default
POST
/listener/productCatalogStateChangeEvent
TM Forum Client Listener for Entity ProductCatalogStateChangeEvent
productCatalogStateChangeEvent body → 204default
POST
/listener/productOfferingAttributeValueChangeEvent
TM Forum Client Listener for Entity ProductOfferingAttributeValueChangeEvent
productOfferingAttributeValueChangeEvent body → 204default
POST
/listener/productOfferingCreateEvent
TM Forum Client Listener for Entity ProductOfferingCreateEvent
productOfferingCreateEvent body → 204default
POST
/listener/productOfferingDeleteEvent
TM Forum Client Listener for Entity ProductOfferingDeleteEvent
productOfferingDeleteEvent body → 204default
POST
/listener/productOfferingPriceAttributeValueChangeEvent
TM Forum Client Listener for Entity ProductOfferingPriceAttributeValueChangeEven…
productOfferingPriceAttributeValueChangeEvent body → 204default
POST
/listener/productOfferingPriceCreateEvent
TM Forum Client Listener for Entity ProductOfferingPriceCreateEvent
productOfferingPriceCreateEvent body → 204default
POST
/listener/productOfferingPriceDeleteEvent
TM Forum Client Listener for Entity ProductOfferingPriceDeleteEvent
productOfferingPriceDeleteEvent body → 204default
POST
/listener/productOfferingPriceStateChangeEvent
TM Forum Client Listener for Entity ProductOfferingPriceStateChangeEvent
productOfferingPriceStateChangeEvent body → 204default
POST
/listener/productOfferingStateChangeEvent
TM Forum Client Listener for Entity ProductOfferingStateChangeEvent
productOfferingStateChangeEvent body → 204default
POST
/listener/productSpecificationAttributeValueChangeEvent
TM Forum Client Listener for Entity ProductSpecificationAttributeValueChangeEven…
productSpecificationAttributeValueChangeEvent body → 204default
POST
/listener/productSpecificationCreateEvent
TM Forum Client Listener for Entity ProductSpecificationCreateEvent
productSpecificationCreateEvent body → 204default
POST
/listener/productSpecificationDeleteEvent
TM Forum Client Listener for Entity ProductSpecificationDeleteEvent
productSpecificationDeleteEvent body → 204default
POST
/listener/productSpecificationStateChangeEvent
TM Forum Client Listener for Entity ProductSpecificationStateChangeEvent
productSpecificationStateChangeEvent body → 204default
POST
/listener/troubleTicketAttributeValueChangeEvent
TM Forum Client Listener for Entity TroubleTicketAttributeValueChangeEvent
troubleTicketAttributeValueChangeEvent body → 204default
POST
/listener/troubleTicketCreateEvent
TM Forum Client Listener for Entity TroubleTicketCreateEvent
troubleTicketCreateEvent body → 204default
POST
/listener/troubleTicketDeleteEvent
TM Forum Client Listener for Entity TroubleTicketDeleteEvent
troubleTicketDeleteEvent body → 204default
POST
/listener/troubleTicketInformationRequiredEvent
TM Forum Client Listener for Entity TroubleTicketInformationRequiredEvent
troubleTicketInformationRequiredEvent body → 204default
POST
/listener/troubleTicketResolvedEvent
TM Forum Client Listener for Entity TroubleTicketResolvedEvent
troubleTicketResolvedEvent body → 204default
POST
/listener/troubleTicketSpecificationAttributeValueChangeEvent
TM Forum Client Listener for Entity TroubleTicketSpecificationAttributeValueChan…
troubleTicketSpecificationAttributeValueChangeEvent body → 204default
POST
/listener/troubleTicketSpecificationCreateEvent
TM Forum Client Listener for Entity TroubleTicketSpecificationCreateEvent
troubleTicketSpecificationCreateEvent body → 204default
POST
/listener/troubleTicketSpecificationDeleteEvent
TM Forum Client Listener for Entity TroubleTicketSpecificationDeleteEvent
troubleTicketSpecificationDeleteEvent body → 204default
POST
/listener/troubleTicketSpecificationStatusChangeEvent
TM Forum Client Listener for Entity TroubleTicketSpecificationStatusChangeEvent
troubleTicketSpecificationStatusChangeEvent body → 204default
POST
/listener/troubleTicketStatusChangeEvent
TM Forum Client Listener for Entity TroubleTicketStatusChangeEvent
troubleTicketStatusChangeEvent body → 204default
POST
/listener/cancelProductOrderCreateEvent
TM Forum Client Listener for Entity CancelProductOrderCreateEvent
cancelProductOrderCreateEvent body → 204default
POST
/listener/cancelProductOrderInformationRequiredEvent
TM Forum Client Listener for Entity CancelProductOrderInformationRequiredEvent
cancelProductOrderInformationRequiredEvent body → 204default
POST
/listener/cancelProductOrderStateChangeEvent
TM Forum Client Listener for Entity CancelProductOrderStateChangeEvent
cancelProductOrderStateChangeEvent body → 204default
POST
/listener/productOrderAttributeValueChangeEvent
TM Forum Client Listener for Entity ProductOrderAttributeValueChangeEvent
productOrderAttributeValueChangeEvent body → 204default
POST
/listener/productOrderCreateEvent
TM Forum Client Listener for Entity ProductOrderCreateEvent
productOrderCreateEvent body → 204default
POST
/listener/productOrderDeleteEvent
TM Forum Client Listener for Entity ProductOrderDeleteEvent
productOrderDeleteEvent body → 204default
POST
/listener/productOrderErrorMessageEvent
TM Forum Client Listener for Entity ProductOrderErrorMessageEvent
productOrderErrorMessageEvent body → 204default
POST
/listener/productOrderInformationRequiredEvent
TM Forum Client Listener for Entity ProductOrderInformationRequiredEvent
productOrderInformationRequiredEvent body → 204default
POST
/listener/productOrderJeopardyAlertEvent
TM Forum Client Listener for Entity ProductOrderJeopardyAlertEvent
productOrderJeopardyAlertEvent body → 204default
POST
/listener/productOrderMilestoneEvent
TM Forum Client Listener for Entity ProductOrderMilestoneEvent
productOrderMilestoneEvent body → 204default
POST
/listener/productOrderStateChangeEvent
TM Forum Client Listener for Entity ProductOrderStateChangeEvent
productOrderStateChangeEvent body → 204default
POST
/listener/customerAttributeValueChangeEvent
TM Forum Client Listener for Entity CustomerAttributeValueChangeEvent
customerAttributeValueChangeEvent body → 204default
POST
/listener/customerCreateEvent
TM Forum Client Listener for Entity CustomerCreateEvent
customerCreateEvent body → 204default
POST
/listener/customerDeleteEvent
TM Forum Client Listener for Entity CustomerDeleteEvent
customerDeleteEvent body → 204default
POST
/listener/customerStateChangeEvent
TM Forum Client Listener for Entity CustomerStateChangeEvent
customerStateChangeEvent body → 204default
POST
/listener/individualAttributeValueChangeEvent
TM Forum Client Listener for Entity IndividualAttributeValueChangeEvent
individualAttributeValueChangeEvent body → 204default
POST
/listener/individualCreateEvent
TM Forum Client Listener for Entity IndividualCreateEvent
individualCreateEvent body → 204default
POST
/listener/individualDeleteEvent
TM Forum Client Listener for Entity IndividualDeleteEvent
individualDeleteEvent body → 204default
POST
/listener/individualStateChangeEvent
TM Forum Client Listener for Entity IndividualStateChangeEvent
individualStateChangeEvent body → 204default
POST
/listener/organizationAttributeValueChangeEvent
TM Forum Client Listener for Entity OrganizationAttributeValueChangeEvent
organizationAttributeValueChangeEvent body → 204default
POST
/listener/organizationCreateEvent
TM Forum Client Listener for Entity OrganizationCreateEvent
organizationCreateEvent body → 204default
POST
/listener/organizationDeleteEvent
TM Forum Client Listener for Entity OrganizationDeleteEvent
organizationDeleteEvent body → 204default
POST
/listener/organizationStateChangeEvent
TM Forum Client Listener for Entity OrganizationStateChangeEvent
organizationStateChangeEvent body → 204default
POST
/listener/productAttributeValueChangeEvent
TM Forum Client Listener for Entity ProductAttributeValueChangeEvent
productAttributeValueChangeEvent body → 204default
POST
/listener/productCreateEvent
TM Forum Client Listener for Entity ProductCreateEvent
productCreateEvent body → 204default
POST
/listener/productDeleteEvent
TM Forum Client Listener for Entity ProductDeleteEvent
productDeleteEvent body → 204default
POST
/listener/productProductBatchEvent
TM Forum Client Listener for Entity ProductProductBatchEvent
productProductBatchEvent body → 204default
POST
/listener/productStateChangeEvent
TM Forum Client Listener for Entity ProductStateChangeEvent
productStateChangeEvent body → 204default

Schemas 317

The contract defines 317 schemas that model the data the API accepts and returns. The most detailed are OtherNameIndividual (12 properties), EntityRelationship (11 properties), LanguageAbility (8 properties), Skill (5 properties). Each schema is shown below with its type and property counts.

AttachmentRefOrValue
object
The polymorphic attributes @type, @schemaLocation & @referredType are related to the Attachment entity and not the AttachmentRefOrValue class itself
ImportJobStateChangeEvent
ProductSpecificationStateChangeEvent
EntityRef
BundledGroupProductOffering
ExportJob
ProductSpecificationDeleteEvent
PricingLogicAlgorithm
ProductOfferingDeleteEventPayload
object
ProductOfferingDeleteEventPayload generic structure
1 property
ProductCatalogAttributeValueChangeEventPayload
object
ProductCatalogAttributeValueChangeEventPayload generic structure
1 property
CategoryAttributeValueChangeEvent
ExportJobStateChangeEventPayload
object
ExportJobStateChangeEventPayload generic structure
1 property
ResourceCandidateRef
CategoryCreateEvent
ProductOfferingPriceStateChangeEvent
Entity
object
Base entity schema for use in TMForum Open-APIs. Property.
ImportJobCreateEventPayload
object
ImportJobCreateEventPayload generic structure
1 property
ProductOfferingDeleteEvent
BundledProductOfferingOption
ProductOfferingPriceAttributeValueChangeEvent
ExternalIdentifier
Extensible
object
Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
3 properties 1 required
ProductOfferingPriceCreateEvent
SLARef
object
ServiceLevelAgreement reference: A service level agreement (SLA) is a type of agreement that represents a formal negotiated agreement between two parties desig…
ProductOfferingPriceAttributeValueChangeEventPayload
object
ProductOfferingPriceAttributeValueChangeEventPayload generic structure
1 property
RelatedPartyRefOrPartyRoleRef
ImportJobStateChangeEventPayload
object
ImportJobStateChangeEventPayload generic structure
1 property
ProductOfferingTerm
Event
ServiceCandidateRef
ProductOfferingRef
ProductCatalogCreateEvent
ProductOfferingPriceRef
Attachment
ProductOfferingPriceRefOrValue
object
The polymorphic attributes @type, @schemaLocation & @referredType are related to the ProductOfferingPrice entity and not the ProductOfferingPriceRefOrValue cla…
ProductSpecificationCreateEventPayload
object
ProductSpecificationCreateEventPayload generic structure
1 property
PlaceRef
object
Place reference.
ProductOfferingStateChangeEventPayload
object
ProductOfferingStateChangeEventPayload generic structure
1 property
AgreementRef
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…
PartyRefOrPartyRoleRef
object
CharacteristicValueSpecification
CharacteristicRelationship
TimePeriod
object
A period of time, either as a deadline (endDateTime only) a startDateTime only, or both
2 properties
ProductOffering
CategoryDeleteEventPayload
object
CategoryDeleteEventPayload generic structure
1 property
ServiceSpecificationRef
ChannelRef
object
The channel to which the resource reference to. e.g. channel for selling product offerings, channel for opening a trouble ticket etc..
ProductSpecification
PartyRoleRef
ProductOfferingAttributeValueChangeEvent
CategoryCreateEventPayload
object
CategoryCreateEventPayload generic structure
1 property
IntentSpecificationRef
object
PartyRef
object
A Party reference
ProductOfferingPriceDeleteEventPayload
object
ProductOfferingPriceDeleteEventPayload generic structure
1 property
ProductCatalogAttributeValueChangeEvent
BundledGroupProductOfferingOption
CategoryDeleteEvent
ProductSpecificationCreateEvent
ProductOfferingCreateEvent
ProductOfferingPriceRelationship
Catalog
CategoryStateChangeEventPayload
object
CategoryStateChangeEventPayload generic structure
1 property
TargetProductSchema
object
The reference object to the schema and type of target product which is described by product specification
2 properties
ProductCatalogStateChangeEvent
ProductOfferingPriceDeleteEvent
BundledProductOfferingPriceRelationship
ProductSpecificationCharacteristicValueUse
ResourceSpecificationRef
JobStateType
string
Valid values for the state of a batch job (e.g. catalog import)
CharacteristicSpecificationRelationship
Error
Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
BundledProductOffering
ProductCatalog
CategoryRef
ProductOfferingCreateEventPayload
object
ProductOfferingCreateEventPayload generic structure
1 property
ImportJobCreateEvent
Category
ProductSpecificationDeleteEventPayload
object
ProductSpecificationDeleteEventPayload generic structure
1 property
CharacteristicSpecification
ProductOfferingStateChangeEvent
Addressable
object
Base schema for adressable entities
2 properties
ProductSpecificationAttributeValueChangeEventPayload
object
ProductSpecificationAttributeValueChangeEventPayload generic structure
1 property
ProductCatalogCreateEventPayload
object
ProductCatalogCreateEventPayload generic structure
1 property
Money
object
A base / value business entity used to represent money
2 properties
ProductSpecificationAttributeValueChangeEvent
ExportJobStateChangeEvent
ProductOfferingPriceStateChangeEventPayload
object
ProductOfferingPriceStateChangeEventPayload generic structure
1 property
ExportJobCreateEvent
ProductSpecificationRef
Characteristic
BundledProductSpecification
ProductOfferingPrice
TaxItem
Quantity
object
An amount in a given unit
2 properties
CategoryAttributeValueChangeEventPayload
object
CategoryAttributeValueChangeEventPayload generic structure
1 property
MarketSegmentRef
object
provides references to the corresponding market segment as target of product offerings. A market segment is grouping of Parties, GeographicAreas, SalesChannels…
AttachmentRef
ProductOfferingAttributeValueChangeEventPayload
object
ProductOfferingAttributeValueChangeEventPayload generic structure
1 property
AllowedProductAction
ProductSpecificationRelationship
ImportJob
PolicyRef
Duration
object
A time interval in a given unit of time
2 properties
ExportJobCreateEventPayload
object
ExportJobCreateEventPayload generic structure
1 property
ProductOfferingPriceCreateEventPayload
object
ProductOfferingPriceCreateEventPayload generic structure
1 property
ProductCatalogStateChangeEventPayload
object
ProductCatalogStateChangeEventPayload generic structure
1 property
ProductSpecificationStateChangeEventPayload
object
ProductSpecificationStateChangeEventPayload generic structure
1 property
ProductOfferingRelationship
CategoryStateChangeEvent
ProductCatalogDeleteEvent
ProductCatalogDeleteEventPayload
object
ProductCatalogDeleteEventPayload generic structure
1 property
Addressable_2
object
Base schema for addressable entities
2 properties
TroubleTicketDeleteEvent
TroubleTicketSpecification
TroubleTicket
TroubleTicketAttributeValueChangeEventPayload
object
TroubleTicketAttributeValueChangeEventPayload generic structure
1 property
TroubleTicketSpecificationRef
Note
TroubleTicketSpecificationStatusChangeEvent
TroubleTicketResolvedEventPayload
object
TroubleTicketResolvedEventPayload generic structure
1 property
TroubleTicketRef
object
reference to an TroubleTicket object
Event_2
TroubleTicketInformationRequiredEventPayload
object
TroubleTicketInformationRequiredEventPayload generic structure
2 properties
Characteristic_2
JsonPatch
object
A JSONPatch document as defined by RFC 6902
4 properties 2 required
StatusChange
Attachment_2
TroubleTicketSpecificationCreateEvent
TroubleTicketSpecificationAttributeValueChangeEventPayload
object
TroubleTicketSpecificationAttributeValueChangeEventPayload generic structure
1 property
TroubleTicketStatusType
string
Possible values for the status of the trouble ticket
TroubleTicketCreateEventPayload
object
TroubleTicketCreateEventPayload generic structure
1 property
TroubleTicketInformationRequiredEvent
TroubleTicketSpecificationDeleteEvent
TroubleTicketRelationship
CharacteristicValueSpecification_2
TroubleTicketCreateEvent
TroubleTicketResolvedEvent
TroubleTicketSpecificationDeleteEventPayload
object
TroubleTicketSpecificationDeleteEventPayload generic structure
1 property
TroubleTicketStatusChangeEvent
RelatedEntity
TroubleTicketSpecificationAttributeValueChangeEvent
TroubleTicketSpecificationStatusChangeEventPayload
object
TroubleTicketSpecificationStatusChangeEventPayload generic structure
1 property
TroubleTicketDeleteEventPayload
object
TroubleTicketDeleteEventPayload generic structure
1 property
CharacteristicSpecification_2
TroubleTicketAttributeValueChangeEvent
TroubleTicketSpecificationCreateEventPayload
object
TroubleTicketSpecificationCreateEventPayload generic structure
1 property
TroubleTicketStatusChangeEventPayload
object
TroubleTicketStatusChangeEventPayload generic structure
1 property
HourPeriod
ProductOrderItemStateType
string
Possible values for the state of the product order item
Party
ProductTerm
ProductOrderJeopardyAlertEvent
IndividualStateType
string
Valid values for the lifecycle state of the individual
GeographicLocationRef
object
CancelProductOrderRef
object
A reference to an existing Product Order Cancel request
PartyOrPartyRole
object
Milestone
OrganizationChildRelationship
ProductOrderItem
GeographicSiteRelationship
GeographicLocationRefOrValue
object
The polymorphic attributes @type, @schemaLocation & @referredType are related to the GeographicLocation entity and not the GeographicLocationRefOrValue class i…
ServiceRef
object
Service reference, for when Service is used by other entities.
ProductOrderRef
object
A reference to an existing Product Order.
RelatedOrderItem
GeographicLocation
ProductOrderDeleteEventPayload
object
ProductOrder Delete
1 property
AgreementItemRef
CancelProductOrderCreateEventPayload
object
CancelProductOrderCreateEventPayload
1 property
OtherNameOrganization
GeographicSubAddress
IndividualIdentification
ProductOrderErrorMessageEvent
OrganizationStateType
string
Valid values for the lifecycle state of the organization
CreditProfile
InitialProductOrderStateType
string
Possible values for the requested initial state of the order from client- by default acknowledged is considered
ProductOrderCreateEventPayload
object
ProductOrderCreateEventPayload
1 property
ProductOrderStateChangeEventPayload
object
ProductOrderStateChangeEventPayload generic structure
1 property
PriceAlteration
JeopardyAlert
RelatedChannel
CalendarPeriod
ProductOfferingRef_2
ProductStatusType
string
Possible values for the status of the product
ProductOrderAttributeValueChangeEvent
PartyRoleSpecificationRef
object
Party role specification reference. A party role specification gives additional details on the part played by a party in a given context.
PaymentMethodRef
object
PaymentMethod reference. A payment method defines a specific mean of payment (e.g direct debit).
ProductOrderErrorMessage
ProductOrderJeopardyAlertPayload
object
ProductOrderJeopardyAlertPayload generic structure
1 property
Producer
object
RelatedPlaceRefOrValue
OrderTerm
ProductOrderCreateEvent
GeographicSubAddressUnit
ErrorMessage
TaxDefinition
OrderRelationship
ProductOrderItemRef
ProductOrderDeleteEvent
ProductOrderStateChangeEvent
QuoteRef
object
Quote reference. It's a Quote that has been executed previously.
BillingAccountRef
ProductOrderMilestone
ProductRef
object
A Product reference
ItemActionType
string
action to be performed on the entity managed by the item
OrganizationIdentification
Skill
object
Skills evaluated for an individual with a level and possibly with a limited validity when an obsolescence is defined (Ex: the first-aid certificate first level…
5 properties
CancelProductOrderStateChangeEventPayload
object
CancelProductOrderStateChangeEventPayload generic structure
1 property
Disability
object
Lack or inadequate strength or ability.
3 properties
OtherNameIndividual
object
Keeps track of other names, for example the old name of a woman before marriage or an artist name.
12 properties
PlaceRefOrValue
object
The polymorphic attributes @type, @schemaLocation & @referredType are related to the Place entity and not the PlaceRefOrValue class itself
ProductRelationship
ProductOrderErrorMessagePayload
object
ProductOrderErrorMessagePayload generic structure
1 property
Product
ProductOrderInformationRequiredEvent
ProductOrderStateType
string
Possible values for the state of the order
CancelProductOrderCreateEvent
CancelProductOrderInformationRequiredEvent
TaxExemptionCertificate
IntentRef
object
Intent reference, for when Intent is used by other entities
ResourceRef
object
Resource reference, for when Resource is used by other entities.
PaymentRef
object
If an immediate payment has been done at the product order submission, the payment information are captured and stored (as a reference) in the order.
ContactMedium
ProductOrderAttributeValueChangePayload
object
ProductOrderAttributeValueChangePayload generic structure
1 property
ProductPrice
CancelProductOrderStateChangeEvent
GeographicAddress
ExpressionLanguageEnum
string
Possible values for the serialized Expression language of an intent or Intent report
PartyRole
CancelProductOrderInformationRequiredEventPayload
object
CancelProductOrderInformationRequiredEventPayload generic structure
2 properties
Price
ProductOrderInformationRequiredEventPayload
object
ProductOrderInformationRequiredEventPayload generic structure
2 properties
TaskStateType
string
Possible values for the state of a task
EntityRelationship
object
A uni-directionmal relationship from this entity to a target entity instance
11 properties
Individual
BusinessPartner
object
When business partner is the BusinessPartner
Supplier
object
When business partner is the Supplier
StandardIdentifier
OrganizationParentRelationship
Organization
OrganizationRef
object
Consumer
object
ProductRefOrValue
object
The polymorphic attributes @type, @schemaLocation & @referredType are related to the Product entity and not the ProductRefOrValue class itself
ProductOfferingQualificationRef
object
A productOfferingQualification that has been executed previously
Expression
Characteristic_3
Intent
AccountRef
object
Account reference. A account may be a party account or a financial account.
PartyCreditProfile
CancelProductOrder
QuoteItemRef
ProductOrder
RelatedPartyOrPartyRole
ProductOfferingQualificationItemRef
ProductOrderMilestonePayload
object
ProductOrderMilestonePayload generic structure
1 property
ProductOrderMilestoneEvent
LanguageAbility
object
Ability of an individual to understand or converse in a language.
8 properties
AppointmentRef
OrderItemRelationship
GeographicSite
ProductOrderJeopardyAlert
OrderPrice
Place
object
Place reference.
IntentRefOrValue
object
Intent Ref (if Intent already exists) or Value (if Intent be created or its details be presented)
CustomerAttributeValueChangeEvent
Addressable_3
object
Base schema for addressable entities
2 properties
Party_2
PartyOrPartyRole_2
object
Event_3
Characteristic_4
Attachment_3
CustomerDeleteEvent
Customer
object
AgreementRef_2
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…
CustomerStateChangeEventPayload
object
The event data structure
1 property
ContactMedium_2
CustomerDeleteEventPayload
object
The event data structure
1 property
CustomerStateChangeEvent
CustomerAttributeValueChangeEventPayload
object
The event data structure
1 property
PartyRole_2
CustomerCreateEventPayload
object
The event data structure
1 property
CustomerCreateEvent
Party_3
IndividualStateChangeEvent
IndividualDeleteEventPayload
object
IndividualDeleteEventPayload generic structure
1 property
OrganizationCreateEventPayload
object
OrganizationCreateEventPayload generic structure
1 property
OrganizationDeleteEvent
OrganizationCreateEvent
IndividualDeleteEvent
IndividualAttributeValueChangeEvent
OrganizationAttributeValueChangeEventPayload
object
OrganizationAttributeValueChangeEventPayload generic structure
1 property
OrganizationDeleteEventPayload
object
OrganizationDeleteEventPayload generic structure
1 property
OrganizationAttributeValueChangeEvent
IndividualCreateEventPayload
object
IndividualCreateEventPayload generic structure
1 property
ContactMedium_3
PartyRole_3
IndividualStateChangeEventPayload
object
IndividualStateChangeEventPayload generic structure
1 property
Characteristic_5
OrganizationStateChangeEventPayload
object
OrganizationStateChangeEventPayload generic structure
1 property
IndividualCreateEvent
IndividualAttributeValueChangeEventPayload
object
IndividualAttributeValueChangeEventPayload generic structure
1 property
OrganizationStateChangeEvent
ProductDeleteEvent
ProductStateChangeEvent
ProductCreateEvent
Party_4
ProductAttributeValueChangeEvent
ProductBatchEvent
ProductAttributeValueChangePayload
object
ProductAttributeValueChangePayload generic structure
1 property
ProductOfferingRef_3
ProductStateChangeEventPayload
object
ProductStateChangeEventPayload generic structure
1 property
Product_2
ProductBatchEventPayload
object
ProductBatchEventPayload
1 property
ProductDeleteEventPayload
object
Product Delete
1 property
PartyRole_4
ProductCreateEventPayload
object
ProductCreateEventPayload
1 property
Characteristic_6
Intent_2

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

tm-forum-notification-listener-api-openapi.yml Raw ↑

Other APIs TM Forum publishes across the network.

TM Forum Agreement API
AE Profile APIs.io
TM Forum Agreement Specification API
AE Profile APIs.io
TM Forum Bill Format API
AE Profile APIs.io
TM Forum Billing Cycle Specification API
AE Profile APIs.io
TM Forum Bill Presentation Media API
AE Profile APIs.io
TM Forum Cancel Product Order API
AE Profile APIs.io
TM Forum Cancel Service Order API
AE Profile APIs.io
TM Forum Category API
AE Profile APIs.io
TM Forum Customer API
AE Profile APIs.io
TM Forum events subscription API
AE Profile APIs.io
TM Forum Individual API
AE Profile APIs.io
TM Forum notification listeners (client side) API
AE Profile APIs.io
#notification listener
← Back to T APIs
API Details
ID
tm-forum:tm-forum-notification-listener-api
Server
https://serverRoot/productCatalogManagement/v5/
Docs
https://www.tmforum.org/resources/specification/tmf620-product-catalog-management-api-rest-specification-r17-5-0/
Provider
TM Forum
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=tm-forum-notification-listener-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/tm-forum-notification-listener-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of TM Forum notification listener API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.