MEF Product Order 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
4 operations
across 2 paths,
and defines 58 schemas.
It is described by OpenAPI 3.2.0, at version 1.0.
Requests are made against 2 base URLs: https://{serverBase}/mefApi/cantata/productOrderingManagement/v6/, https://{serverBase}/mefApi/sonata/productOrderingManagement/v11/.
The identity and technical contract details declared by the specification.
RelatedPlaceRefOrQueryWithSubUnit
object
Allows pointing to a place by referring a GeographicAddress, GeographicSite, or providing GeographicAddress by value. It also provides additional information l…
4 properties
2 required
TimeUnit
string
Represents a unit of time.
ProductRelationship
object
A relationship to an existing Product. The requirements for usage for given Product are described in the Product Specification.
3 properties
2 required
MEFProductOrderStateChange
object
Holds the State notification reasons and associated date the State changed, populated by the server
3 properties
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
ContactInformation
object
Contact data for a person or organization that is involved in the product offering qualification. In a given context it is always specified by the Seller (e.g.…
6 properties
3 required
PlaceRefOrQuery
object
A place described by reference to Geographic Address, Geographic Site or by Geographic Address Representations.
GeographicAddressRef
object
A reference to a Geographic Address resource available through Address Validation API.
3 properties
2 required
MEFProductOrderItem_Common
object
An identified part of the order. A product order is decomposed into one or more order items. This type holds the attributes common to request and response repr…
17 properties
4 required
Duration
object
A Duration in a given unit of time e.g. 3 hours, or 5 days.
2 properties
2 required
TerminationError
object
This indicates an error that caused an Item to be terminated. The code and propertyPath should be used like in Error422.
3 properties
MEFOrderItemCoordinatedAction
object
The interval after the completion of one or more related Order Items that this Order Item can be started or completed
3 properties
3 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…
MEFProductConfiguration
object
MEFProductConfiguration is used as an extension point for MEF specific product/service payload. The @type attribute is used as a discriminator
1 property
1 required
LabelRepresentation
object
A unique identifier controlled by a generally accepted independent administrative authority that specifies a fixed geographical location.
3 properties
2 required
ProductOfferingQualificationItemRef
object
It's a productOfferingQualification item that has been executed previously.
4 properties
2 required
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
MEFMilestone
object
Milestones associated to the Product Order Item. Set by the Seller when a Milestone occurs.
3 properties
2 required
Error401Code
string
One of the following error codes: - missingCredentials: No credentials provided. - invalidCredentials: Provided credentials are invalid or expired
ProductOrder_Update
object
A request initiated by the Buyer to update Product Order and/or Product
5 properties
Error400
Bad Request. (https://tools.ietf.org/html/rfc7231section-6.5.1)
MEFProductRefOrValueOrder
object
Used by the Buyer to point to existing and/or describe the desired shape of the product. In case of add action - only productConfiguration MUST be specified. F…
6 properties
MEFProductOrderStateType
string
Possible values for the state of the Product Order The following mapping has been used between MEFProductOrderStateType and MEF 57.2: | state | MEF 57.2 name |…
OrderItemRelationship
object
The relationship between Product Order Items in the Product Order.
2 properties
2 required
Error500
Internal Server Error. (https://tools.ietf.org/html/rfc7231section-6.6.1)
GeographicSiteRef
object
A reference to a Geographic Site resource available through Service Site API
3 properties
2 required
MEFBillingAccountRef
object
A reference to the Buyer's Billing Account
1 property
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…
GeographicPointRepresentation
object
A GeographicPointRepresentation defines a geographic point through coordinates.
4 properties
3 required
MEFProductOrderChargeRef
object
A reference to a Charge instance
2 properties
1 required
MEFBuyerSellerType
string
Indicates if the note is from Buyer or Seller.
MEFProductActionType
string
Action to be performed on the Product that the Order Item refers to. | ProductActionType | MEF 57.2 | | ----------------- | ---------- | | add | INSTALL | | mo…
MEFProductOrderItem_Update
object
An updatable representation of the Product Order Item.
5 properties
1 required
MEFProductOrderItem_Create
ProductOrder_Find
object
Structure to define GET without id response. A list of productOrder matching request criteria. Provides Product order summary view.
7 properties
3 required
Error401
Unauthorized. (https://tools.ietf.org/html/rfc7235section-3.1)
SubUnit
object
Allows for sub unit identification
2 properties
2 required
MEFOrderItemCoordinationDependencyType
string
Possible values of the Order Item Coordination Dependency | OrderItemCoordinationDependencyType | MEF 57.2 | Description | |-----------------------------------…
MEFQuoteItemRef
object
It's a Quote item that has been executed previously.
3 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…
Error501
Not Implemented. Used in case Seller is not supporting an optional operation (https://tools.ietf.org/html/rfc7231section-6.6.2)
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
GeographicAddress_Query
object
A list of representations being a subset of Geographic Address entity. This is to be used when providing a list of representations to validate or search for a…
5 properties
1 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
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…
Error422
Unprocessable entity due to a business validation problem. (https://tools.ietf.org/html/rfc4918section-11.2)
Error404
Resource for the requested path not found. (https://tools.ietf.org/html/rfc7231section-6.5.4)
ProductOfferingRef
object
A reference to a Product Offering offered by the Seller to the Buyer. A Product Offering contains the commercial and technical details of a Product sold by a p…
2 properties
1 required
ProductOrder_Common
object
A Product Order is a type of order which can be used to place an order between a customer and a service provider or between a service provider and a partner an…
4 properties
1 required
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)
Error409
Conflict (https://datatracker.ietf.org/doc/html/rfc7231section-6.5.8)
MEFItemTerm
object
The term of the Item
5 properties
3 required
MEFProductOrderItemStateChange
object
Holds the State notification reasons and associated date the State changed, populated by the server
3 properties
MEFProductOrderItemStateType
string
Possible values for the state of the Product Order Item The following mapping has been used between MEFProductOrderItemStateType and MEF 57.2: | state | MEF 57…
FormattedAddressRepresentation
object
A freeform text representation agreed to by the Buyer and Seller.
2 properties
1 required
The full machine-readable OpenAPI contract behind this narrative.
Other APIs MEF publishes across the network.
