j
No Results
Search Tips:
- Please consider misspellings
- Try different search keywords
Newer Version Available
Communications Cloud TM Forum API Release Notes
TM Forum 620 Product Catalog Management API
Delete a catalog
Make a DELETE request to the /catalog resource.
Required request parameter: id
New response body: Catalog Response
Delete a category
Make a DELETE request to the /category resource.
Required request parameter: id
New response body: Category Response
Delete a product offering
Make a DELETE request to the /productOffering resource.
Required request parameter: id
New response body: Product Offering Response
Delete a product offering price
Make a DELETE request to the /productOfferingPrice resource.
Required request parameter: id
New response body: Product Offering Price Response
Delete a product specification
Make a DELETE request to the /productSpecification resource.
Required request parameter: id
New response body: Product Specification Response
NOTE:
Prior to Winter '24, the results for the response payload for TMF GET API operations for 2 TMF 620 resources (Product Specification and Product Offering) varied based on the channel (EPC Designer or TMF API) used for creating the records.
This issue is addressed by ensuring that the results from the response of GET API operations remain the same - irrespective of the input channel that was created. This aligns with the Salesforce vision for supporting Omni Channel behavior for all customer journeys.
From this release, GET response now (after the change) includes all picklist values in the picklist, as well as the selected (or default) value.
TM Forum 637 Product Inventory Management API
Get inventory of the products
Make a GET request to the new /product resource.
New request parameters: offset, limit, and fields
New response body: Product Inventory Read Response
Get a product using the record ID
Make a GET request to the new /product resource.
New request parameters: id
New response body: Product Inventory Read Response
Deprecated Resources, Sub-resources, and Fields
To align the API interface specifications with their implementations in Communications Cloud, the documentation of API specifications (mentioned on the Reference tab) is updated. Certain optional entities and their attributes are no longer mentioned in the API specifications and are deprecated. Users need to ensure that the incoming payloads for the API adhere to these specifications.
Deprecated Entities and Attributes for TM Forum 620 Product Catalog Management API
These resources and sub-resources are deprecated.
- BundledProductOfferingPriceRelationship
- PricingLogicAlgorithm
- MarketSegmentRef
- POPAlteration
- ProductOfferingPriceRelationship
- ProductSpecificationCharacteristicRelationship
- PlaceRef
- ResourceCandidateRef
- ResourceSpecificationRef
- ServiceCandidateRef
- ServiceSpecificationRef
- SLARef
These fields are deprecated for the respective resources and sub-resources.
| Resource/Sub-resource |
Fields Deprecated |
|---|---|
| Money |
@schemaLocation |
| Catalog_RelatedParty |
@baseType |
| @schemaLocation |
|
| ProductSpecification_relatedParty |
@referredType |
| ProductPriceValue |
@baseType |
| @schemaLocation |
|
| @type |
|
| CharacteristicValueSpecification |
@baseType |
| @schemaLocation |
|
| @type |
|
| BundledProductOffering |
href |
| lifecycleStatus |
|
| @baseType |
|
| @schemaLocation |
|
| @type |
|
| BundledProductOfferingOption |
@baseType |
| @schemaLocation |
|
| @type |
|
| ProductOfferingRelationship |
@baseType |
| @schemaLocation |
|
| @type |
|
| role |
|
| validFor |
|
| @referredType |
|
| BundledProductSpecification |
@baseType |
| @schemaLocation |
|
| @type |
|
| ProductOfferingTerm |
@baseType |
| @schemaLocation |
|
| @type |
|
| ProductSpecification |
@baseType |
| @schemaLocation |
|
| @type |
|
| ProductSpecificationCharacteristic |
id |
| configurable |
|
| extensible |
|
| isUnique |
|
| maxCardinality |
|
| minCardinality |
|
| regex |
|
| productSpecCharRelationship |
|
| validFor |
|
| @baseType |
|
| @schemaLocation |
|
| @type |
|
| @valueSchemaLocation |
|
| ProdOffering-ProductSpecificationCharacteristicValueUse |
id |
| description |
|
| maxCardinality |
|
| minCardinality |
|
| name |
|
| valueType |
|
| productSpecCharacteristicValue |
|
| items |
|
| productSpecification |
|
| @baseType |
|
| @schemaLocation |
|
| @type |
|
| ProductSpecificationRelationship |
validFor |
| @baseType |
|
| @schemaLocation |
|
| @type |
|
| @referredType |
|
| AgreementRef |
@baseType |
| @schemaLocation |
|
| @referredType |
|
| AttachmentRefOrValue |
content |
| mimeType |
|
| size |
|
| validFor |
|
| @type |
|
| @baseType |
|
| @schemaLocation |
|
| @referredType |
|
| Catalog_CategoryRef |
@type |
| @baseType |
|
| @schemaLocation |
|
| @referredType |
|
| version |
|
| ChannelRef |
@baseType |
| @schemaLocation |
|
| id |
|
| href |
|
| name |
|
| Category_Ref |
version |
| @baseType |
|
| @schemaLocation |
|
| @referredType |
|
| ProductOfferingPrice |
id |
| href |
|
| lastUpdate |
|
| description |
|
| recurringChargePeriodLength |
|
| version |
|
| constraint |
|
| priceAlteration |
|
| unitOfMeasure |
|
| @baseType |
|
| @schemaLocation |
|
| @referredType |
|
| @type |
|
| ProductOfferingRef |
@baseType |
| @schemaLocation |
|
| @referredType |
|
| ProductSpecificationRef |
href |
| name |
|
| version |
|
| targetProductSchema |
|
| @baseType |
|
| @schemaLocation |
|
| @type |
|
| @referredType |
|
| Catalog_Create |
catalogType |
| lastUpdate |
|
| version |
|
| @baseType |
|
| @schemaLocation |
|
| Category_Create |
@baseType |
| @schemaLocation |
|
| ProductOffering_Create |
lastUpdate |
| statusReason |
|
| agreement |
|
| channel |
|
| marketSegment |
|
| place |
|
| resourceCandidate |
|
| serviceCandidate |
|
| serviceLevelAgreement |
|
| @baseType |
|
| @schemaLocation |
|
| @type |
|
| ProductSpecification_Create |
brand |
| isBundle |
|
| lastUpdate |
|
| productSpecCharacteristic |
|
| resourceSpecification |
|
| serviceSpecification |
|
| @baseType |
|
| @schemaLocation |
|
| @type |
|
| ProductOfferingPrice_Create |
isBundle |
| percentage |
|
| recurringChargePeriodLength |
|
| version |
|
| bundledPopRelationship |
|
| constraint |
|
| place |
|
| popRelationship |
|
| pricingLogicAlgorithm |
|
| prodSpecCharValueUse |
|
| tax |
|
| unitOfMeasure |
|
| @baseType |
|
| @schemaLocation |
|
| @type |
|
| Catalog_Update |
statusReason |
| agreement |
|
| channel |
|
| marketSegment |
|
| place |
|
| resourceCandidate |
|
| serviceCandidate |
|
| serviceLevelAgreement |
|
| @schemaLocation |
|
| ProductSpecification_Update |
brand |
| isBundle |
|
| resourceSpecification |
|
| serviceSpecification |
|
| @schemaLocation |
|
| ProductOfferingPrice_Update |
isBundle |
| percentage |
|
| recurringChargePeriodLength |
|
| version |
|
| bundledPopRelationship |
|
| constraint |
|
| place |
|
| popRelationship |
|
| pricingLogicAlgorithm |
|
| prodSpecCharValueUse |
|
| tax |
|
| unitOfMeasure |
|
| @schemaLocation |
Deprecated Entities and Attributes for TM Forum 621 Trouble Ticket API
These fields are deprecated for the resources and sub-resources.
- @baseType
- @schemaLocation
- @type
Deprecated Entities and Attributes for TM Forum 622 Product Ordering API
These resources and sub-resources are deprecated.
- AgreementItemRef
- AgreementRef
- AppointmentRef
- BillingAccountRef
- Characteristic
- EntityRef
- Money
- Note
- OrderItemActionType
- OrderItemRelationship
- OrderPrice
- OrderTerm
- PaymentRef
- Price
- PriceAlteration
- Product
- ProductOfferingPriceRef
- ProductOfferingQualificationItemRef
- ProductOfferingQualificationRef
- ProductOfferingRef
- ProductOrderItem
- ProductOrderItemStateType
- ProductOrderRef
- ProductOrderStateType
- ProductPrice
- ProductRef
- ProductRefOrValue
- ProductRelationship
- ProductSpecificationRef
- ProductStatusType
- ProductTerm
- Quantity
- QuoteItemRef
- QuoteRef
- RelatedChannel
- RelatedParty
- RelatedPlaceRefOrValue
- RelatedProductOrderItem
- ResourceRef
- ServiceRef
- TargetProductSchema
- TaskStateType
- TimePeriod
- EventSubscription
- EventSubscriptionInput
These fields are deprecated for the respective resources and sub-resources.
| Resource/Sub-resource | Fields Deprecated |
|---|---|
| ProductOrder | cancellationDate |
| cancellationReason | |
| category | |
| completionDate | |
| expectedCompletionDate | |
| notificationContact | |
| priority | |
| agreement | |
| billingAccount | |
| orderTotalPrice | |
| payment | |
| productOfferingQualification | |
| quote | |
| @baseType | |
| @schemaLocation | |
| @type | |
| ProductOrder_Create | state |
| orderDate | |
| Error | href |
| role | |
| @type | |
| RelatedEntity | href |
| role | |
| @type | |
| TroubleTicketRelationship | href |
| name | |
| @baseType | |
| @schemaLocation | |
| @type |