TM Forum quote API
The quote API from TM Forum — 2 operation(s) for quote.
TM Forum quote 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 quote. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes 5 operations across 2 paths, and defines 40 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/.
5 operations
2 paths
40 schemas
1 DELETE2 GET1 PATCH1 POST
Metadata
The identity and technical contract details declared by the specification.
Paths & Operations 5
Across 2 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 1 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.
quote 5
GET
/quote
List or find Quote objects
POST
/quote
Creates a Quote
GET
/quote/{id}
Retrieves a Quote by ID
PATCH
/quote/{id}
Updates partially a Quote
DELETE
/quote/{id}
Deletes a Quote
Schemas 40
The contract defines 40 schemas that model the data the API accepts and returns. The most detailed are ProductRefOrValue (29 properties), Quote (26 properties), Quote_Update (23 properties), Quote_Create (19 properties). Each schema is shown below with its type and property counts.
ResourceRef
object
8 properties
1 required
Error
object
Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
8 properties
2 required
Quote
object
Quote can be used to negotiate service and product acquisition or modification between a customer and a service provider. Quote contain list of quote items, a…
26 properties
1 required
PriceAlteration
object
Is an amount, usually of money, that modifies the price charged for an order item.
12 properties
2 required
ContactMedium
object
Indicates the contact medium that could be used to contact the party.
7 properties
Authorization
object
If special discount or special product offering price or specific condition need an approval for ISP sale representative it is described here.
9 properties
ProductOfferingQualificationItemRef
object
It's a productOfferingQualification item that has been executed previously.
10 properties
2 required
TargetProductSchema
object
The reference object to the schema and type of target product which is described by product specification
3 properties
2 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…
12 properties
2 required
QuoteStateType
string
Possible values for the state of the quote
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
Quote_Create
object
Quote can be used to negotiate service and product acquisition or modification between a customer and a service provider. Quote contain list of quote items, a…
19 properties
1 required
QuoteItem
object
A quote items describe an action to be performed on a productOffering or a product in order to get pricing elements and condition.
18 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
TimePeriod
object
A period of time, either as a deadline (endDateTime only) a startDateTime only, or both
2 properties
MediumCharacteristic
object
Describes the contact medium characteristics that could be used to contact a party (an individual or an organization)
14 properties
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…
7 properties
1 required
QuoteItemRelationship
object
Used to describe relationship between quote item. These relationship could have an impact on pricing and conditions
5 properties
Price
object
Provides all amounts (tax included, duty free, tax rate), used currency and percentage to apply for Price Alteration.
7 properties
Any
Note
object
Extra information about a given entity
7 properties
2 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…
29 properties
ProductTerm
object
Description of a productTerm linked to this product. This represent a commitment with a duration
7 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
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
Money
object
A base / value business entity used to represent money
2 properties
Quote_Update
object
Quote can be used to negotiate service and product acquisition or modification between a customer and a service provider. Quote contain list of quote items, a…
23 properties
1 required
Characteristic
object
Describes a given characteristic of an object or entity through a name/value pair.
6 properties
2 required
BillingAccountRef
object
BillingAccount reference. A BillingAccount is a detailed description of a bill structure.
7 properties
1 required
ProductStatusType
string
Possible values for the status of the product
AttachmentRefOrValue
object
An attachment by value or by reference. For AttachmentRefOrValue, the attribute type,schemaLocation and referredType are related to the contained entity and no…
14 properties
QuotePrice
object
Description of price and discount awarded
11 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…
9 properties
1 required
ProductOfferingQualificationRef
object
It's a productOfferingQualification that has been executed previously
7 properties
1 required
AppointmentRef
object
Refers an appointment, such as a Customer presentation or internal meeting or site visit
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…
7 properties
1 required
RelatedProductOrderItem
object
RelatedProductOrderItem (ProductOrder item) .The product order item which triggered product creation/change/termination.
9 properties
2 required
ServiceRef
object
Service reference, for when Service is used by other entities
7 properties
1 required
RelatedParty
object
Related Entity reference. A related party defines party or party role linked to a specific entity.
8 properties
2 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from TM Forum 12
Other APIs TM Forum publishes across the network.
TM Forum agreement API
TM Forum agreementSpecification API
TM Forum billFormat API
TM Forum billingAccount API
TM Forum billingCycleSpecification API
TM Forum billPresentationMedia API
TM Forum cancelProductOrder API
TM Forum cancelServiceOrder API
TM Forum category API
TM Forum customer API
TM Forum events subscription API
TM Forum exportJob API
#quote