1. Overview

B2ctelco Tmf Webservices Documentation

1.1. Version information

Version : 3.0.0

1.2. URI scheme

Host : hostname
BasePath : /b2ctelcotmfwebservices/v3

1.3. Tags

  • Product Catalog Management : Catalog Management API

1.4. Produces

  • application/json

2. Security

2.1. oauth2_password

Type : oauth2
Flow : password
Token URL : https://regression-utils.prod.tro.b2c.ydev.hybris.com:9002/authorizationserver/oauth/token

Name

basic

2.2. oauth2_client_credentials

Type : oauth2
Flow : application
Token URL : https://regression-utils.prod.tro.b2c.ydev.hybris.com:9002/authorizationserver/oauth/token

Name

extended

3. Resources

3.1. Product Catalog Management

Catalog Management API

3.1.1. Retrieves a list of 'ProductOffering'

GET /productOffering
Description

This operation retrieves a list of product offering entities

Parameters
Type Name Description Schema

Query

@baseType
optional

For filtering: Immediate base (class) type of the product offering

string

Query

@schemaLocation
optional

For filtering: A link to the schema describing this product offering

string

Query

@type
optional

For filtering: Class type of the product offering

string

Query

agreement.@referredType
optional

For filtering: class type of the referred Agreement

string

Query

agreement.name
optional

For filtering: Name of the agreement

string

Query

attachment.@baseType
optional

For filtering: The immediate base class type of the attachment

string

Query

attachment.@schemaLocation
optional

For filtering: A link to the schema describing this attachment entity

string

Query

attachment.@type
optional

For filtering: the class type of the Attachment

string

Query

attachment.mimeType
optional

For filtering: Attachment mime type such as extension file for video, picture and document

string

Query

attachment.type
optional

For filtering: Attachment type such as video, picture

string

Query

attachment.url
optional

For filtering: Uniform Resource Locator, is a web page address (a subset of URI)

string

Query

baseSiteId
optional

Identifier of the BaseSite

string

Query

bundledProductOffering.lifecycleStatus
optional

For filtering: Used to indicate the current lifecycle status

string

Query

bundledProductOffering.name
optional

For filtering: Name of the BundledProductOffering

string

Query

category.@referredType
optional

For filtering: the class type of the referred Category

string

Query

category.name
optional

For filtering: Name of the category

string

Query

category.version
optional

For filtering: Category version

string

Query

channel.@referredType
optional

For filtering: (Class) type of the referred channel like DistributionChannel, SalesChannel and so on

string

Query

channel.name
optional

For filtering: Name of the channel

string

Query

facetSearchOption.id
optional

For filtering by facet options. The identifier of the facet search option.

< string > array(multi)

Query

fields
optional

Comma separated properties to display in response

string

Query

isBundle
optional

For filtering: isBundle determines whether a productOffering represents a single productOffering (false), or a bundle of productOfferings (true).

boolean

Query

lastUpdate
optional

For filtering: Date and time of the last update

string(date-time)

Query

lifecycleStatus
optional

For filtering: Used to indicate the current lifecycle status

string

Query

limit
optional

Requested number of resources to be provided in response requested by client.

integer(int32)

Query

marketSegment.@referredType
optional

For filtering: (Class) type of the referred market segment

string

Query

marketSegment.name
optional

For filtering: Name of the market segment

string

Query

name
optional

For filtering: Name of the productOffering

string

Query

offeringGroup.id
optional

For filtering: Id of the productOfferingGroup

string

Query

offset
optional

Requested index for start of resources to be provided in response requested by client.

integer(int32)

Query

parentBundledProductOffering.id
optional

For filtering: Id of the parentBundledProductOffering

string

Query

place.@referredType
optional

For filtering: class type of the referred Place object

string

Query

place.address
optional

For filtering: A string characterizing an address (for instance a formatted address or an identifier taken from an address database or an address API).

string

Query

place.name
optional

For filtering: A user-friendly name for the place, such as "Paris Store", "London Store", "Main Home"

string

Query

place.role
optional

For filtering: Role of the place (for instance: 'home delivery', 'shop retrieval')

string

Query

prodSpecCharValueUse.maxCardinality
optional

For filtering: The maximum number of instances a CharacteristicValue can take on. For example, zero to five phone numbers in a group calling plan, where five is the value for the maxCardinality.

integer(int32)

Query

prodSpecCharValueUse.minCardinality
optional

For filtering: The minimum number of instances a CharacteristicValue can take on. For example, zero to five phone numbers in a group calling plan, where zero is the value for the minCardinality.

integer(int32)

Query

prodSpecCharValueUse.name
optional

For filtering: Name of the associated productSpecCharacteristic

string

Query

prodSpecCharValueUse.valueType
optional

For filtering: A kind of value that the characteristic can take on, such as numeric, text and so forth

string

Query

productOfferingPrice.@baseType
optional

For filtering: the immediate base class of product offering price

string

Query

productOfferingPrice.@schemaLocation
optional

For filtering: hyperlink reference to the product offering price schema

string

Query

productOfferingPrice.@type
optional

For filtering: The class type of the product offering price

string

Query

productOfferingPrice.isBundle
optional

For filtering: a flag indicating if this product offering price is bundle (composite) or not

boolean

Query

productOfferingPrice.name
optional

For filtering: Name of the productOfferingPrice

string

Query

productOfferingPrice.place.id
optional

For filtering: Identifier of the place for which product offering has prices available

string

Query

productOfferingPrice.priceType
optional

For filtering: Indicates the price type: recurring, one time, usage

string

Query

productOfferingPrice.recurringChargePeriod
optional

For filtering: Could be month, week…

string

Query

productOfferingPrice.relatedParty.id
optional

For filtering: Identifier of the related party for which the price applies.

string

Query

productOfferingPrice.unitOfMeasure
optional

For filtering: Could be minutes, GB…

string

Query

productOfferingPrice.version
optional

For filtering: ProductOffering version

string

Query

productOfferingTerm.@schemaLocation
optional

For filtering: A link to the schema describing this product offering term

string

Query

productOfferingTerm.@type
optional

For filtering: The class type of ProductOfferingTerm

string

Query

productOfferingTerm.name
optional

For filtering: Name of the productOfferingTerm

string

Query

productSpecification.@referredType
optional

For filtering: class type of referred Product Specification

string

Query

productSpecification.name
optional

For filtering: Name of the product specification

string

Query

productSpecification.version
optional

For filtering: Version of the product specification

string

Query

resourceCandidate.@referredType
optional

For filtering: The Class type of referred Resource Candidate

string

Query

resourceCandidate.name
optional

For filtering: Name of the resource candidate

string

Query

resourceCandidate.version
optional

For filtering: Version of the resource candidate

string

Query

serviceCandidate.@referredType
optional

For filtering: The Class type of referred Service Candidate

string

Query

serviceCandidate.name
optional

For filtering: Name of the service candidate

string

Query

serviceCandidate.version
optional

For filtering: Version of the service candidate

string

Query

serviceLevelAgreement.@referredType
optional

For filtering: class type of referred Service Level Agreement

string

Query

serviceLevelAgreement.name
optional

For filtering: Name of the service level agreement

string

Query

sort
optional

For sorting: The options the product offerings can be sorted by.

< string > array(multi)

Query

validFor.endDateTime
optional

For filtering: An instant of time, ending at the TimePeriod.

string(date-time)

Query

validFor.startDateTime
optional

For filtering: An instant of time, starting at the TimePeriod

string(date-time)

Query

version
optional

For filtering: ProductOffering version

string
Responses
HTTP Code Description Schema

200

Ok

< ProductOffering > array

400

Bad Request

Error

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

Error

405

Method Not Allowed

Error

500

Internal Server Error

Error
Produces

  • application/json;charset=utf-8

Security
Type Name

oauth2

oauth2_client_credentials

oauth2

oauth2_password

3.1.2. Retrieves a 'ProductOffering' by Id

GET /productOffering/{id}
Description

This operation retrieves a product offering entity using its unique ID

Parameters
Type Name Description Schema

Path

id
required

Identifier of the Product Offering

string

Query

baseSiteId
optional

Identifier of the BaseSite

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body

string

Query

priceContext.place.id
optional

Identifier of the place for which product offering has prices available

string

Query

priceContext.processType.id
optional

For filtering by the process type of the product offering price.

< string > array(multi)

Query

priceContext.relatedParty.id
optional

For filtering: Identifier of the related party for which the price applies.

string
Responses
HTTP Code Description Schema

200

Ok

< ProductOffering > array

400

Bad Request

Error

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

Error

500

Internal Server Error

Error
Produces

  • application/json;charset=utf-8

Security
Type Name

oauth2

oauth2_client_credentials

oauth2

oauth2_password

4. Definitions

4.1. AgreementRef

Agreement reference. An agreement represents a contract or arrangement, either written or verbal and sometimes enforceable by law, such as a service level agreement or a customer price agreement. An agreement involves a number of other business entities, such as products, services, and resources and/or their specifications.

Name Description Schema

@referredType
optional

class type of the referred Agreement

string

href
optional

Reference of the agreement

string

id
optional

Identifier of the agreement

string

name
optional

Name of the agreement

string

4.2. Attachment

Media items configured for a product offering (images, videos).

Name Description Schema

@baseType
optional

The immediate base class type of the attachment

string

@schemaLocation
optional

A link to the schema describing this attachment entity

string

@type
optional

the class type of the Attachment

string

description
optional

A narrative text describing the content of the attachment

string

href
optional

Not Sent.Reference of the attachment.

string

id
optional

Unique identifier of the attachment

string

mimeType
optional

Attachment mime type such as extension file for video, picture and document

string

type
optional

Attachment type format.

string

url
optional

Uniform Resource Locator, is a web page address (a subset of URI)

string

validFor
optional

Not Sent.

TimePeriod

4.3. BundledPopRelationship

this object represents a bundle relationship from a bundle product offering (parent) to a simple product offering (child). A simple product offering may participate in more than one bundle relationships.

Name Description Schema

@type
optional

(Class) type of the associated product offering

string

href
optional

hyperlink reference of the associated product offering

string

id
optional

Unique identifier of the associated product offering

string

name
optional

Name of the associated product offering

string

4.4. BundledProductOffering

A type of ProductOffering that belongs to a grouping of ProductOfferings made available to the market. It inherits of all attributes of ProductOffering.

Name Description Schema

bundledProductOffering
optional

Not Sent

< BundledProductOffering > array

href
optional

Unique reference of the ProductOffering.

string

id
optional

Product Offering Id.

string

lifecycleStatus
optional

Used to indicate the current lifecycle status(approved/checked/unapproved).

string

name
optional

Name of the ProductOffering.

string

4.5. CategoryRef

Category reference. The category resource is used to group product offerings, service and resource candidates in logical containers. Categories can contain other categories and/or product offerings.

Name Description Schema

@referredType
optional

The class type of the referred Category

string

href
optional

Not Sent.Unique reference of the category.

string

id
optional

Unique reference of the category

string

name
optional

Name of the category

string

type
optional

Category type, can be Category,VariantCategory or VariantValueCategory.

string

version
optional

Not Sent.Category version.

string

4.6. ChannelRef

Channel reference. The channel defines the channel for selling product offerings.

Name Description Schema

@referredType
optional

(Class) type of the referred channel

string

href
optional

Not Sent.Reference of the channel.

string

id
optional

Unique identifier of the channel

string

name
optional

Not Sent

string

4.7. ConstraintRef

Constraint reference. The Constraint resource represents a policy/rule applied to an entity or entity spec.

Name Description Schema

@referredType
optional

The (class) type of the referred constraint

string

href
optional

Hyperlink reference to the target constraint

string

id
optional

reference id to the target constraint

string

name
optional

Name given to the constraint

string

version
optional

constraint version

string

4.8. Cycle

Represents the billing cycle.

Name Description Schema

cycleEnd
optional

Ending cycle.

integer(int32)

cycleStart
optional

Starting cycle.

integer(int32)

4.9. Error

Name Description Schema

code
required

An integer coding the error type. This is given to caller so he can translate them if required.

integer(int32)

description
optional

(optional) A long localized error description if needed. It can contain precise information about which parameter is missing, or what are the identifier acceptable values.

string

infoURL
optional

(optional) A URL to online documentation that provides more information about the error.

string

message
required

A short localized string that describes the error.

string

4.10. IndexedProductOffering

IndexedProductOffering subtype of the ProductOffering entity.

Polymorphism : Composition

Name Description Schema

@baseType
optional

Immediate base (class) type of the product offering

string

@schemaLocation
optional

A link to the schema describing this product offering

string

@type
optional

Class type of the product offering

string

agreement
optional

Not Sent

< AgreementRef > array

attachment
optional

Media items configured for a product offering (images, videos).

< Attachment > array

baseProduct
optional

Base product of a variant.

ProductOfferingRef

bundledProductOffering
optional

List of children product offering reference (sent only for bundled product offerings).

< BundledProductOffering > array

category
optional

< CategoryRef > array

channel
optional

Not Sent

< ChannelRef > array

classificationAttributeValueUse
optional

The list of classification attributes defined for the ProductOffering.

< ProdSpecCharValueUse > array

description
optional

Description of the ProductOffering.

string

facetSearchOption
optional

Represents the facet search value field name and value used for filtering.

< FacetSearchOption > array

href
optional

Reference of the ProductOffering.

string

id
optional

Unique identifier of the ProductOffering.

string

isBundle
optional

isBundle determines whether a productOffering represents a simple product Offering (false), or a bundled product offering(true).If false, then a productSpecification will be returned, but the bundledProductOfferings will be absent or empty and vice-versa if isBundle is true.
Example : false

boolean

isInStock
optional

Flag to indicate if the product is in stock or not.

boolean

isSellable
optional

A flag indicating if this product offering can be sold as stand-alone or not. If this flag is false it indicates that the offer can only be sold within a bundled product offering.

boolean

lastUpdate
optional

Date and time of the last update.

string(date-time)

lifecycleStatus
optional

Used to indicate the current product offering approval status (approved/check/unapproved).

string

marketSegment
optional

Not Sent.

< MarketSegmentRef > array

name
optional

Name of the ProductOffering.

string

offeringGroup
optional

List of containing offering groups (sent only for BundleProductOfferings).

< OfferingGroup > array

parentBundleProductOffering
optional

A list of BundledProductOffering representing all parents of the offering.

< BundledProductOffering > array

place
optional

Not Sent

< PlaceRef > array

priceContext
optional

Price context list.

< PriceContext > array

prodSpecCharValueUse
optional

The list of Product Specification Characteristic Values defined for the ProductOffering.

< ProdSpecCharValueUse > array

productOfferingPrice
optional

< ProductOfferingPrice > array

productOfferingTerm
optional

not sent

< ProductOfferingTerm > array

productSpecification
optional

ProductSpecificationRef

rating
optional

Rating of the product offering.

string

resourceCandidate
optional

Not Sent

ResourceCandidateRef

serviceCandidate
optional

Not Sent

ServiceCandidateRef

serviceLevelAgreement
optional

Not Sent

SLARef

validFor
optional

The period for which the productOffering is valid (online date - offline date).

TimePeriod

variantOption
optional

Variant options, in case of a variant product offering.

< VariantOption > array

variantProductOffering
optional

List of variants of the product offering.

< ProductOfferingRef > array

version
optional

Not Sent.Product offering version.

string

4.11. MarketSegmentRef

provides references to the corresponding market segment as target of product offerings. A market segment is grouping of Parties, GeographicAreas, SalesChannels, and so forth.

Name Description Schema

@referredType
optional

(Class) type of the referred market segment

string

href
optional

Reference of the market segment

string

id
optional

Unique identifier of the market segment

string

name
optional

Name of the market segment

string

4.12. Money

A base / value business entity used to represent money.

Name Description Schema

unit
required

Currency (ISO4217 norm uses 3 letters to define the currency).

string

value
required

A positive floating point number

string

4.13. OfferingGroup

Represents a product offering group entity.

Name Description Schema

childProductOffering
optional

List of containing product offerings.

< BundledProductOffering > array

id
required

Unique identifier of the offering group.

string

name
optional

Name of the offering group.

string

4.14. PlaceRef

Place reference. Place defines the places where the products are sold or delivered.

Name Description Schema

@referredType
optional

class type of the referred Place object

string

address
optional

A string characterizing an address (for instance a formatted address or an identifier taken from an address database or an address API).

string

geoLocationUrl
optional

A url providing a map for localizing the place

string

href
optional

Unique reference of the place

string

id
optional

Unique identifier of the place

string

name
optional

A user-friendly name for the place, such as "Paris Store", "London Store", "Main Home"

string

role
optional

Role of the place (for instance: 'home delivery', 'shop retrieval')

string

4.15. PoRelationshipRef

PoRelationshipRef reference. The PoRelationshipRef defines the affectedProductOffering and requiredProductOfferings of price for selling product offerings.

Name Description Schema

@referredType
optional

(Class) type of the referred productOffering

string

bpoId
optional

Id of the BPO where current POP is defined in case the current BPO is a price override

string

href
optional

Reference of the productOffering

string

id
optional

Unique identifier of the productOffering.

string

name
optional

Name of the productOffering.

string

poAttributeType
optional

PoAttributeType of the PoRelationshipRef

enum (AFFECTED_PRODUCT, REQUIRED_PRODUCT)

4.16. PopRelationship

product offering relationship

Name Description Schema

@type
optional

(Class) type of the associated product offering

string

href
optional

hyperlink reference of the associated product offering

string

id
optional

Unique identifier of the associated product offering

string

name
optional

Name of the associated product offering

string

relationshipType
optional

type of the relationship, for example override, discount, etc.

string

4.17. PriceContext

Represents the context in which the product offering price is available to customer.

Name Description Schema

channel
optional

< ChannelRef > array

id
optional

Price context’s identifier.

string

isPriceOverride
optional

A flag indicating if the price is defined directly for a simple product offering, or for a product offering bought as part of a bundled product offering.
Example : false

boolean

place
optional

Place references where the products are sold or delivered.

< PlaceRef > array

poRelationship
optional

Represents the product offering affected, or required by the price. This field is used for bundle product offerings.

< PoRelationshipRef > array

priority
optional

The priority.

integer(int32)

processType
optional

Represents the purchasing flows for which the price is applicable.

< ProcessType > array

productOfferingPrice
optional

Product offering price reference.

ProductOfferingPriceRef

productOfferingTerm
optional

< ProductOfferingTerm > array

relatedParty
optional

RelatedPartyRef

validFor
optional

The period for which the productOfferingPrice is valid.

TimePeriod

4.18. PricingLogicAlgorithm

The PricingLogicAlgorithm entity represents an instantiation of an interface specification to external rating function (without a modeled bahavior in SID). Some of the parameters of the interface definiition may be already set (such as price per unit) and some may be gathered during the rating process from the event (such as call duration) or from ProductCharacteristicValues (such as assigned bandwidth)

Name Description Schema

@type
optional

The class type of this PLA

string

description
optional

Description of the PLA

string

href
optional

hyperlink reference of this PLA

string

id
optional

unique id of the PLA

string

name
optional

Name given to the PLA

string

plaSpecId
optional

id of corresponding PLA specification

string

validFor
optional

The period for which the PLA is valid

TimePeriod

4.19. ProcessType

Process type. It could be ACQUISITION, RETENTION, CHANGE TARIFF

Name Description Schema

@schemaLocation
optional

A link to the schema describing the ProcessType

string

@type
optional

Indicated the type of the ProcessType

string

href
optional

Reference of the Process Type.

string

id
optional

Process Type id.

string

4.20. ProdSpecCharValueUse

A use of the ProdSpecCharacteristicValue by a ProductOffering to which additional properties (attributes) apply or override the properties of similar properties contained in ProdSpecCharacteristicValue. It should be noted that characteristics which their value(s) addressed by this object must exist in corresponding product specification. The available characteristic values for a ProductSpecCharacteristic in a Product specification can be modified at the ProductOffering level. For example, a characteristic 'Color' might have values White, Blue, Green, and Red. But, the list of values can be restricted to e.g. White and Blue in an associated product offering. It should be noted that the list of values in 'ProdSpecCharValueUse' is a strict subset of the list of values as defined in the corresponding product specification characteristics.

Name Description Schema

description
optional

A narrative that explains in detail what the productSpecCharacteristic is.

string

maxCardinality
optional

Not Sent

integer(int32)

minCardinality
optional

Not Sent

integer(int32)

name
optional

Not Sent

string

productSpecCharacteristicValue
optional

< ProductSpecCharacteristicValue > array

productSpecification
optional

ProductSpecificationRef

validFor
optional

Not Sent

TimePeriod

valueType
optional

Not Sent

string

4.21. ProductOffering

Represents entities that are orderable from the provider of the catalog, this resource includes pricing information.

Name Description Schema

@baseType
optional

Immediate base (class) type of the product offering

string

@schemaLocation
optional

A link to the schema describing this product offering

string

@type
optional

Class type of the product offering

string

agreement
optional

Not Sent

< AgreementRef > array

attachment
optional

Media items configured for a product offering (images, videos).

< Attachment > array

baseProduct
optional

Base product of a variant.

ProductOfferingRef

bundledProductOffering
optional

List of children product offering reference (sent only for bundled product offerings).

< BundledProductOffering > array

category
optional

< CategoryRef > array

channel
optional

Not Sent

< ChannelRef > array

classificationAttributeValueUse
optional

The list of classification attributes defined for the ProductOffering.

< ProdSpecCharValueUse > array

description
optional

Description of the ProductOffering.

string

href
optional

Reference of the ProductOffering.

string

id
optional

Unique identifier of the ProductOffering.

string

isBundle
optional

isBundle determines whether a productOffering represents a simple product Offering (false), or a bundled product offering(true).If false, then a productSpecification will be returned, but the bundledProductOfferings will be absent or empty and vice-versa if isBundle is true.
Example : false

boolean

isSellable
optional

A flag indicating if this product offering can be sold as stand-alone or not. If this flag is false it indicates that the offer can only be sold within a bundled product offering.

boolean

lastUpdate
optional

Date and time of the last update.

string(date-time)

lifecycleStatus
optional

Used to indicate the current product offering approval status (approved/check/unapproved).

string

marketSegment
optional

Not Sent.

< MarketSegmentRef > array

name
optional

Name of the ProductOffering.

string

offeringGroup
optional

List of containing offering groups (sent only for BundleProductOfferings).

< OfferingGroup > array

parentBundleProductOffering
optional

A list of BundledProductOffering representing all parents of the offering.

< BundledProductOffering > array

place
optional

Not Sent

< PlaceRef > array

priceContext
optional

Price context list.

< PriceContext > array

prodSpecCharValueUse
optional

The list of Product Specification Characteristic Values defined for the ProductOffering.

< ProdSpecCharValueUse > array

productOfferingPrice
optional

< ProductOfferingPrice > array

productOfferingTerm
optional

not sent

< ProductOfferingTerm > array

productSpecification
optional

ProductSpecificationRef

rating
optional

Rating of the product offering.

string

resourceCandidate
optional

Not Sent

ResourceCandidateRef

serviceCandidate
optional

Not Sent

ServiceCandidateRef

serviceLevelAgreement
optional

Not Sent

SLARef

validFor
optional

The period for which the productOffering is valid (online date - offline date).

TimePeriod

variantOption
optional

Variant options, in case of a variant product offering.

< VariantOption > array

variantProductOffering
optional

List of variants of the product offering.

< ProductOfferingRef > array

version
optional

Not Sent.Product offering version.

string

4.22. ProductOfferingPrice

Is based on both the basic cost to develop and produce products and the enterprises policy on revenue targets. This price may be further revised through discounting (productOfferPriceAlteration). The price, applied for a productOffering may also be influenced by the productOfferingTerm, the customer selected, eg: a productOffering can be offered with multiple terms, like commitment periods for the contract. The price may be influenced by this productOfferingTerm. A productOffering may be cheaper with a 24 month commitment than with a 12 month commitment.

Name Description Schema

@schemaLocation
optional

hyperlink reference to the schema describing this resource

string

@type
optional

The class type of this Product offering price

string

bundledPop
optional

Represents the contained prices (charges), for a composed price.

< ProductOfferingPrice > array

bundledPopRelationship
optional

not sent

< BundledPopRelationship > array

constraint
optional

not sent

< ConstraintRef > array

cycle
optional

Represents the start time, and end time of the recurring cycle (the first 3 months) . If empty, the cycle is the entire recurring period.

Cycle

description
optional

Description of the productOfferingPrice

string

href
optional

Reference of the ProductOfferingPrice

string

id
optional

unique id of this resource

string

isBundle
optional

A flag indicating if this ProductOfferingPrice is composite (bundle) or not

boolean

lastUpdate
optional

not sent

string(date-time)

lifecycleStatus
optional

not sent

string

name
optional

Name of the productOfferingPrice

string

percentage
optional

Percentage to apply for ProdOfferPriceAlteration (Discount).

number(float)

place
optional

not sent

< PlaceRef > array

popRelationship
optional

not sent

< PopRelationship > array

price
optional

The amount of money that characterizes the price.

Money

priceEvent
optional

The price event

string

priceType
optional

A category that describes the price, such as recurring, discount, allowance, penalty, and so forth.

string

pricingLogicAlgorithm
optional

not sent

< PricingLogicAlgorithm > array

prodSpecCharValueUse
optional

not sent

< ProdSpecCharValueUse > array

productOfferingTerm
optional

not sent

< ProductOfferingTerm > array

recurringChargePeriodLength
optional

not sent

integer(int32)

recurringChargePeriodType
optional

not sent

string

tax
optional

not sent

< Tax > array

tierEnd
optional

Tier end of usage charge.

integer(int32)

tierStart
optional

Tier start of usage charge.

integer(int32)

unitOfMeasure
optional

A number and unit representing how many (for instance 1 dozen) of an ProductOffering is available at the offered price. Its meaning depends on the priceType. It could be a price, a rate, or a discount.

Quantity

usageChargeType
optional

The type of the usage charge

string

usageUnit
optional

Usage unit applicable for the price.

UsageUnit

validFor
optional

not sent

TimePeriod

version
optional

not sent

string

4.23. ProductOfferingPriceRef

ProductPriceOffering reference. An amount, usually of money, that is asked for or allowed when a ProductOffering is bought, rented, or leased.

Name Description Schema

@referredType
optional

(Class) type of the referred ProductOfferingPrice

string

@schemaLocation
optional

Hyperlink reference to the schema describing this resource

string

href
optional

Reference of the ProductOfferingPrice.

string

id
optional

Reference id of the ProductOfferingPrice.

string

name
optional

Name of the ProductOfferingPrice.

string

4.24. ProductOfferingRecommendationRef

ProductOfferingRecommendationRef subtype of the ProductOfferingRef entity.

Polymorphism : Composition

Name Description Schema

@referredType
optional

Type (class) of the product offering

string

@type
optional

Type (class) of the product offering

string

href
optional

Reference of the product offering

string

id
required

Unique identifier of the product offering

string

image
optional

Thumbnail image of the product offering

Attachment

name
optional

Name of the product offering

string

productOfferingTerm
optional

< ProductOfferingTermRef > array

variantOption
optional

Variant options, in case of a variant product offering.

< VariantOption > array

4.25. ProductOfferingRef

ProductOffering reference. A product offering represents entities that are orderable from the provider of the catalog, this resource includes pricing information.

Name Description Schema

@referredType
optional

Type (class) of the product offering

string

@type
optional

Type (class) of the product offering

string

href
optional

Reference of the product offering

string

id
required

Unique identifier of the product offering

string

image
optional

Thumbnail image of the product offering

Attachment

name
optional

Name of the product offering

string

variantOption
optional

Variant options, in case of a variant product offering.

< VariantOption > array

4.26. ProductOfferingTerm

A condition under which a ProductOffering is made available to Customers. For instance, a productOffering can be offered with multiple commitment periods.

Name Description Schema

@schemaLocation
optional

A link to the schema describing this product offering term

string

@type
optional

The class type of ProductOfferingTerm

string

description
optional

Not Sent.Description of the productOfferingTerm

string

duration
optional

Duration of the productOfferingTerm

Quantity

id
optional

Id of the productOfferingTerm

string

name
optional

Name of the productOfferingTerm

string

validFor
optional

Not Sent.The period for which the productOfferingterm is valid

TimePeriod

4.27. ProductSpecCharacteristicValue

A number or text that can be assigned to a ProductSpecCharacteristic.

Name Description Schema

@schemaLocation
optional

Hyperlink reference to schema describing this object

string

@type
optional

The class type of the characteristic value

string

isDefault
optional

Not Sent

boolean

rangeInterval
optional

Not Sent

string

regex
optional

Not Sent

string

unitOfMeasure
optional

Could be minutes, GB…

string

validFor
optional

Not Sent

TimePeriod

value
optional

The value of characteristic.The type of value is determined by ‘valueType’ characteristic.

string

valueFrom
optional

Not Sent

string

valueTo
optional

Not Sent

string

valueType
optional

A kind of value that the characteristic can take on, such as numeric, string, boolean.

string

4.28. ProductSpecificationRef

Product specification reference: A ProductSpecification is a detailed description of a tangible or intangible object made available externally in the form of a ProductOffering to customers or other parties playing a party role.

Name Description Schema

@referredType
optional

class type of referred Product Specification

string

href
optional

Reference of the product specification.(Not supported yet)

string

id
optional

Unique identifier of the product specification

string

name
optional

Name of the product specification

string

version
optional

Version of the product specification API (Not supported yet)

string

4.29. Quantity

Description of a quantity like for the Duration attribute

Name Description Schema

amount
required

A value for the quantity

number(float)

units
required

A unit associated with the quantity (for example months)

string

4.30. RelatedPartyRef

RelatedParty reference. A related party defines party or party role linked to a specific entity.

Name Description Schema

@referredType
optional

The class type of referred party/party role reference

string

href
optional

Reference of the related party, could be a party reference or a party role reference

string

id
optional

Unique identifier of a related party

string

name
optional

Name of the related party

string

role
optional

Role of the related party.

string

validFor
optional

Validity period of the related party

TimePeriod

4.31. ResourceCandidateRef

ResourceCandidate reference: A resource candidate is an entity that makes a ResourceSpecification available to a catalog.

Name Description Schema

@referredType
optional

The Class type of referred Resource Candidate

string

href
optional

Reference of the resource candidate

string

id
optional

Unique identifier of the resource candidate

string

name
optional

Name of the resource candidate

string

version
optional

Version of the resource candidate

string

4.32. SLARef

ServiceLevelAgreement reference: A service level agreement (SLA) is a type of agreement that represents a formal negotiated agreement between two parties designed to create a common understanding about products, services, priorities, responsibilities, and so forth. The SLA is a set of appropriate procedures and targets formally or informally agreed between parties in order to achieve and maintain specified Quality of Service.

Name Description Schema

@referredType
optional

class type of referred Service Level Agreement

string

href
optional

Reference of the service level agreement

string

id
optional

Unique identifier of service level agreement

string

name
optional

Name of the service level agreement

string

4.33. ServiceCandidateRef

ServiceCandidate reference. ServiceCandidate is an entity that makes a ServiceSpecification available to a catalog.

Name Description Schema

@referredType
optional

The Class type of referred Service Candidate

string

href
optional

Unique reference of the service candidate

string

id
optional

Unique identifier of the service candidate

string

name
optional

Name of the service candidate

string

version
optional

Version of the service candidate

string

4.34. Tax

An amount of money levied on the price of a Product by a legislative body.

Name Description Schema

taxAmount
optional

tax amount

Money

taxCategory
optional

A categorization of the tax rate.

Money

taxRate
optional

Tax rate

number(float)

4.35. TimePeriod

A time period described through 2 dates

Name Schema

endDateTime
optional

string(date-time)

startDateTime
optional

string(date-time)

4.36. UsageUnit

Represents a usage unit.

Name Description Schema

id
optional

Unique identifier of the usageUnit

string

name
optional

Name of the usageUnit.

string

4.37. VariantOption

Variant characteristics.

Name Description Schema

id
optional

Unique reference of the variant option

string

variantCategory
required

Variant Category.

string

variantValue
required

Variant Value.

string