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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Kin Lane

Chat with Kin

AI assistant · trained on my blog

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 304 schemas. It is described by OpenAPI 3.0.1, at version 5.0.0.

Requests are made against a single base URL, https://serverRoot/productCatalogManagement/v5/.

62 operations 62 paths 304 schemas 62 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
5.0.0
Server
https://serverRoot/productCatalogManagement/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 ProductOfferingPriceAttributeValueChangeEvent
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 ProductSpecificationAttributeValueChangeEvent
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 TroubleTicketSpecificationAttributeValueChangeEvent
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 304

The contract defines 304 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.

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

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 agreementSpecification API
AE Profile APIs.io
TM Forum billFormat API
AE Profile APIs.io
TM Forum billingAccount API
AE Profile APIs.io
TM Forum billingCycleSpecification API
AE Profile APIs.io
TM Forum billPresentationMedia API
AE Profile APIs.io
TM Forum cancelProductOrder API
AE Profile APIs.io
TM Forum cancelServiceOrder 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 exportJob 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