/productOffering/{id}

patch https://productcatalog.ppe.amdocs-dbs.cloud/productOffering/{id}

Updates an existing ProductOffering based on ID. Follwoing validations are applied:

if productOfferingPrice array is present, each element will be validated with it's 'ref' attribute (price must exist)
- Note - creating a basic productOfferingPrice as part of the ProductOffering payload is currently not supported. Will be implemented as part of a future release
If ProductSpecification is provided, it will be validated with it's 'ref' attribute in ProductSpecification microservice (product specification must exist)
If 'billing' part of the payload is provided, tenantApi will be used to retrieve the billing configuration:
- If no configuration present, error will be thrown
- If configuration is present, billing payload will be sent to Billing GW for processing

Path Params

json

required

Body Params

@baseType

string

When sub-classing, this defines the super-class

@schemaLocation

string

A URI to a JSON-Schema file that defines additional attributes and relationships

@type

string

Defaults to ProductOffering

When sub-classing, this defines the sub-class Extensible name

agreement

array of objects

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.

agreement

attachment

array of objects

Complements the description of an element (for instance a product) through video, pictures...

attachment

bundledProductOffering

array of objects

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

bundledProductOffering

category

channel

array of objects

The channel defines the channel for selling product offerings.

channel

description

string

Description of the productOffering

dictionary

object

an object that contains the localizable fields and their equivalents in each of the supported languages.

href

string

required

Reference of the ProductOffering

string

required

Unique identifier of the productOffering

isBundle

boolean

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

isSelective

boolean

isSelective determines whether a productOffering can have a set of ProductOfferings that serve as choices that can be selected in the context of it.

isSellable

boolean

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

lastUpdate

date-time

Date and time of the last update

lifecycleStatus

string

Used to indicate the current lifecycle status

lineOfBusiness

object

A line of business represents the business segment to which the products belong

marketSegment

array of objects

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

marketSegment

name

string

required

Name of the productOffering

offerType

string

Defaults to Plan

ProductOffering type: Plan or Add-on

place

array of objects

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

place

prodSpecCharValueUse

array of objects

A use of the ProductSpecificationCharacteristicValue by a ProductOffering to which additional properties (attributes) apply or override the properties of similar properties contained in ProductSpecificationCharacteristicValue. 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 ProductSpecificationCharacteristic 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 'ProductSpecificationCharacteristicValueUse' is a strict subset of the list of values as defined in the corresponding product specification characteristics.

prodSpecCharValueUse

productOfferingCharacteristic

array of objects

A use of the ProductOfferingCharacteristicValue by a ProductOffering to which additional properties (attributes) apply or override the properties of similar properties contained in ProductSpecificationCharacteristicValue. 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 ProductSpecificationCharacteristic 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 'ProductSpecificationCharacteristicValueUse' is a strict subset of the list of values as defined in the corresponding product specification characteristics.

productOfferingCharacteristic

productOfferingPrice

array of objects

An amount, usually of money, that is asked for or allowed when a ProductOffering is bought, rented, or leased. The price is valid for a defined period of time and may not represent the actual price paid by a customer.

productOfferingPrice

productOfferingRelationship

array of objects

A relationship between this product offering and other product offerings.

productOfferingRelationship

productOfferingTerm

array of objects

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

productOfferingTerm

productSpecification

object

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.

resourceCandidate

object

ResourceCandidate is an entity that makes a resource specification available to a catalog. A ResourceCandidate and its associated resource specification may be published - made visible - in any number of resource catalogs, or in none.

selectiveness

object

Represents the acceptable range for the total number of choice selections that must be made when the ProductOffering is ordered

serviceCandidate

object

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

serviceLevelAgreement

object

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.

statusReason

string

A string providing a complementary information on the value of the lifecycle status attribute.

testUsers

array of arrays

The testing users that have access to the product offering when its lifecycleStatus is In Test

testUsers

validFor

object

A period of time, either as a deadline (endDateTime only) a startDateTime only, or both

version

number

ProductOffering version

Headers

CatalogRequestId

string

required

an ID of a Draft catalog request.

authorization

string

required

Responses

200

Offer Updated

500

Internal server error