MEF Product Offering API is one of 54 APIs that MEF publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes
2 operations
across 2 paths,
and defines 48 schemas.
It is described by OpenAPI 3.2.0, at version 4.0.1.
Requests are made against 2 base URLs: http://{serverBase}/mefApi/cantata/productCatalog/v4/, http://{serverBase}/mefApi/sonata/productCatalog/v4/.
The identity and technical contract details declared by the specification.
Context
object
Context that is defined as a two-dimensional vector of Business Function and Product Action.
2 properties
1 required
TimeUnit
string
Represents a unit of time.
PlaceRelationshipConstraint
object
Allows definition and constraining of PlaceRelationship that can be specified for the ordered Product.
4 properties
4 required
ProductRelationshipConstraint
object
Allows definition and constraining of Product Relationship that can be specified for the ordered Product.
5 properties
5 required
ProductCategoryRef
object
Represents the reference to Category
2 properties
1 required
ProductOfferingPrice
object
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 discou…
11 properties
5 required
Note
object
Extra information about a given entity. Only useful in processes involving human interaction. Not applicable for the automated process.
5 properties
5 required
ProductOfferingContextualInfo
object
Used for the cases when the schema must be differentiated per the defined Context, where Context is built as a pair - a Business Function (e.g. Quote) and Prod…
2 properties
2 required
Region
object
Specifies a region
4 properties
1 required
Duration
object
A Duration in a given unit of time e.g. 3 hours, or 5 days.
2 properties
2 required
Error403Code
string
This code indicates that the server understood the request but refuses to authorize it because of one of the following error codes: - accessDenied: Access deni…
PriceModifier
object
The Price Modifier allows specifying promotional (via Price Modifier Deal Reference) and/or volume based pricing discounts. For example, if only Minimum Quanti…
8 properties
3 required
DataSizeUnit
string
The unit of measure in the data size.
FieldedAddressRepresentation
object
A type of Address that has a discrete field and value for each type of boundary or identifier down to the lowest level of detail. For example "street number" i…
20 properties
SchemaRefOrValue
object
Reference to the JSON schema location or the exact value of the JSON schema. Note: One of the properties must be provided i.e. schemaLocation or schema.
2 properties
Error401Code
string
One of the following error codes: - missingCredentials: No credentials provided. - invalidCredentials: Provided credentials are invalid or expired
Error400
Bad Request. (https://tools.ietf.org/html/rfc7231section-6.5.1)
ProductSpecificationRef
object
Product Specification reference.
2 properties
1 required
Error500
Internal Server Error. (https://tools.ietf.org/html/rfc7231section-6.6.1)
Price
object
Provides all amounts (tax included, duty-free, tax rate) and used currency of a Price
3 properties
1 required
Error400Code
string
One of the following error codes: - missingQueryParameter: The URI is missing a required query-string parameter - missingQueryValue: The URI is missing a requi…
AttachmentValue
object
Complements the description of an element (for instance a product) through video, pictures...
8 properties
5 required
MEFByteSize
object
A size represented by value and Byte units
2 properties
2 required
ProductActionMask
string
Action that could be applied to the Product (or future product) during the execution of the Business Function. Value 'all' is the wildcard - stands for any act…
MEFBuyerSellerType
string
An enumeration with buyer and seller values.
MEFPriceType
string
Indicates if the price is for recurring or non-recurring charges.
BusinessFunctionMask
string
Business Function that could be executed for the given Product accordingly to LSO Cantata/Sonata IRPs. Value 'all' is the wildcard - stands for any action.
Error401
Unauthorized. (https://tools.ietf.org/html/rfc7235section-3.1)
SubUnit
object
Allows for sub unit identification
2 properties
2 required
ProductMilestoneDefinition
object
Allows specifying the different stages of the Product provisioning process.
2 properties
2 required
MEFEndOfTermAction
string
The action the Seller will take once the term expires. Roll indicates that the Product's contract will continue on a rolling basis for the duration of the Roll…
RelatedContactInformation
object
Contact data for a person or organization that is involved in a given context. It is specified by the Seller (e.g. Seller Contact Information) or by the Buyer.
7 properties
4 required
ProductOfferingLifecycleStatusTransition
object
The Date and Time that the next Product Offering Status transition is planned to occur, or have occurred.
3 properties
2 required
Error
object
Standard Class used to describe API response error Not intended to be used directly. The code in the HTTP header is used as a discriminator for the type of err…
3 properties
1 required
ProductOfferingLifecycleStatusType
string
| Name | Mplify 127.1 Name | Description | | ------------ | ----------------- | -------------------------------------------------------------------------------…
Money
object
A base/value business entity used to represent money
2 properties
2 required
Error422
Unprocessable entity due to a business validation problem. (https://tools.ietf.org/html/rfc4918section-11.2)
Error422Code
string
One of the following error codes: - missingProperty: The property the Seller has expected is not present in the payload - invalidValue: The property has an inc…
Error404
Resource for the requested path not found. (https://tools.ietf.org/html/rfc7231section-6.5.4)
Error403
Forbidden. This code indicates that the server understood the request but refuses to authorize it. (https://tools.ietf.org/html/rfc7231section-6.5.3)
ProductOfferingBundleRelationship
object
The Product Offering Bundle Relationship defines the set of Product Offerings that comprise a Product Offering Bundle, along with the ability to specify the mi…
4 properties
4 required
MEFItemTerm
object
The definition of the Term.
5 properties
3 required
TimePeriod
object
A period of time, either as a deadline (endDateTime only) a startDateTime only, or both.
2 properties
ProductOffering_Common
object
The Product Offering represents the Products launched from a Seller's Product Catalog.
14 properties
ProductOfferingRef
object
ProductOffering reference. A product offering represents entities that are launched from the provider of the catalog.
2 properties
1 required
The full machine-readable OpenAPI contract behind this narrative.
Other APIs MEF publishes across the network.
