The product API from MEF — 2 operation(s) for product.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/mef-product-api"curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
openapi: 3.2.0
info:
title: Mef Product API
version: '1.0'
description: 'Operations tagged product across 2 of this provider''s published API definitions: mef-lso-cantata-product-inventory-management-openapi.yml, mef-lso-sonata-product-inventory-management-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://{serverBase}/mefApi/cantata/productInventory/v2/
variables:
serverBase:
description: The base of Seller's URL.
default: mplify.net
- url: https://{serverBase}/mefApi/sonata/productInventory/v8/
variables:
serverBase:
description: The base of Seller's URL.
default: mplify.net
tags:
- name: product
paths:
/product:
get:
tags:
- product
summary: List or find Product objects
description: This operation lists or finds Product entities
operationId: listProduct
parameters:
- name: status
in: query
description: The status of the product
required: false
schema:
$ref: '#/components/schemas/MEFProductStatusType'
- name: productSpecificationId
in: query
description: A reference to a product spec by id
required: false
schema:
type: string
- name: productOfferingId
in: query
description: A reference to a product offering by id
required: false
schema:
type: string
- name: externalId
in: query
description: A reference to the externalId provided in the order
required: false
schema:
type: string
- name: geographicAddressId
in: query
description: A Geographic Address identifier which is associated to the product
required: false
schema:
type: string
- name: geographicSiteId
in: query
description: A site identifier which is associated to the product
required: false
schema:
type: string
- name: relatedProductId
in: query
description: 'This criteria allows to retrieve all Product records with a Product Relationship to a specified Product.
E.g. All Products related to Product with ID 5'
required: false
schema:
type: string
- name: billingAccountId
in: query
description: The Billing Account associated with the Product.
required: false
schema:
type: string
- name: productOrderId
in: query
description: Identifies Product Order associated with the Product
required: false
schema:
type: string
- name: startDate.lt
in: query
description: Less than the date that is the initial install date for the Product
required: false
schema:
type: string
format: date-time
- name: startDate.gt
in: query
description: Greater than the date that is the initial install date for the Product
required: false
schema:
type: string
format: date-time
- name: lastUpdateDate.lt
in: query
description: Less than date that the last change affecting this Product was completed
required: false
schema:
type: string
format: date-time
- name: lastUpdateDate.gt
in: query
description: Greater than the date that the last change affecting this Product was completed
required: false
schema:
type: string
format: date-time
- name: buyerId
in: query
description: The unique identifier of the organization that is acting as the a Buyer. MUST be specified in the request only when the requester represents more than one Buyer.
required: false
schema:
type: string
- name: sellerId
in: query
description: The unique identifier of the organization that is acting as the Seller. MUST be specified in the request only when responding entity represents more than one Seller.
required: false
schema:
type: string
- name: offset
in: query
description: Requested index for start of item to be provided in response requested by client. Note that the index starts with "0".
required: false
schema:
type: integer
format: int32
- name: limit
in: query
description: Requested number of items to be provided in response requested by client
required: false
schema:
type: integer
format: int32
responses:
'200':
description: OK. (https://tools.ietf.org/html/rfc7231#section-6.3.1)
headers:
X-Pagination-Throttled:
description: 'Used to indicate that result page was throttled to maximum possible size and there are additional results that can be fetched
'
schema:
type: boolean
X-Total-Count:
description: 'The total number of matching items. E.g. if there are 50 matching items in total, but the request has offset=10 and limit=10, then the X-Total-Count is 50.
'
schema:
type: integer
X-Result-Count:
description: The number of items included in the response
schema:
type: integer
content:
application/json;charset=utf-8:
schema:
type: array
items:
$ref: '#/components/schemas/MEFProduct_Find'
'400':
description: Bad Request
content:
application/json;charset=utf-8:
schema:
$ref: '#/components/schemas/Error400'
'401':
description: Unauthorized
content:
application/json;charset=utf-8:
schema:
$ref: '#/components/schemas/Error401'
'403':
description: Forbidden
content:
application/json;charset=utf-8:
schema:
$ref: '#/components/schemas/Error403'
'422':
description: Unprocessable entity due to the business validation problems
content:
application/json;charset=utf-8:
schema:
type: array
items:
$ref: '#/components/schemas/Error422'
'500':
description: Internal Server Error
content:
application/json;charset=utf-8:
schema:
$ref: '#/components/schemas/Error500'
servers:
- url: https://{serverBase}/mefApi/cantata/productInventory/v2/
variables:
serverBase:
description: The base of Seller's URL.
default: mplify.net
/product/{id}:
get:
tags:
- product
summary: Retrieves a Product by ID
description: This operation retrieves a Product entity.
operationId: retrieveProduct
parameters:
- name: id
in: path
description: Identifier of the Product
required: true
schema:
type: string
- name: buyerId
in: query
description: The unique identifier of the organization that is acting as the a Buyer. MUST be specified in the request only when the requester represents more than one Buyer.
required: false
schema:
type: string
- name: sellerId
in: query
description: The unique identifier of the organization that is acting as the Seller. MUST be specified in the request only when responding entity represents more than one Seller.
required: false
schema:
type: string
responses:
'200':
description: OK. (https://tools.ietf.org/html/rfc7231#section-6.3.1)
content:
application/json;charset=utf-8:
schema:
$ref: '#/components/schemas/MEFProduct'
'400':
description: Bad Request
content:
application/json;charset=utf-8:
schema:
$ref: '#/components/schemas/Error400'
'401':
description: Unauthorized
content:
application/json;charset=utf-8:
schema:
$ref: '#/components/schemas/Error401'
'403':
description: Forbidden
content:
application/json;charset=utf-8:
schema:
$ref: '#/components/schemas/Error403'
'404':
description: Not Found
content:
application/json;charset=utf-8:
schema:
$ref: '#/components/schemas/Error404'
'500':
description: Internal Server Error
content:
application/json;charset=utf-8:
schema:
$ref: '#/components/schemas/Error500'
servers:
- url: https://{serverBase}/mefApi/cantata/productInventory/v2/
variables:
serverBase:
description: The base of Seller's URL.
default: mplify.net
components:
schemas:
TimeUnit:
description: 'Represents a unit of time.
'
type: string
enum:
- seconds
- minutes
- businessHours
- calendarHours
- businessDays
- calendarDays
- months
- years
RelatedPlaceRefOrQuery:
description: Allows pointing to a place by referring to a GeographicAddress, GeographicSite, or providing GeographicAddress by value. It also provides additional information like the `role` the place plays for given Product and `contact` needed access to this place.
type: object
properties:
place:
$ref: '#/components/schemas/PlaceRefOrQuery'
role:
description: Role of this place. The values that can be specified here are described by Product Specification (e.g. "INSTALL_LOCATION").
type: string
contact:
description: The person to call to get access to this place in case such access is required to complete the evaluation of this POQ Item.
type: array
items:
$ref: '#/components/schemas/ContactInformation'
required:
- place
- role
ProductRelationship:
description: A relationship to existing Product. The requirements for usage for given Product are described in the Product Specification.
type: object
properties:
relationshipType:
description: Specifies the type (nature) of the relationship to the related Product. The nature of required relationships vary for Products of different types. For example, a UNI or ENNI Product may not have any relationships, but an Access E-Line may have two mandatory relationships (related to the UNI on one end and the ENNI on the other). More complex Products such as multipoint IP or Firewall Products may have more complex relationships. As a result, the allowed and mandatory `relationshipType` values are defined in the Product Specification.
type: string
id:
description: unique identifier
type: string
href:
description: Hyperlink of the referenced product
type: string
required:
- id
- relationshipType
MEFProductOrderItemRef:
description: A reference to a ProductOrder item
type: object
properties:
productOrderHref:
description: Reference of the related ProductOrder.
type: string
productOrderItemId:
description: Id of an Item within the Product Order
type: string
productOrderId:
description: Unique identifier of a ProductOrder.
type: string
required:
- productOrderId
- productOrderItemId
ContactInformation:
description: 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. Seller Contact Information) or by the Buyer.
type: object
properties:
number:
description: Phone number
type: string
emailAddress:
description: Email address
type: string
postalAddress:
description: Identifies the postal address of the person or office to be contacted.
$ref: '#/components/schemas/FieldedAddressRepresentation'
organization:
description: The organization or company that the contact belongs to
type: string
name:
description: Name of the contact
type: string
numberExtension:
description: Phone number extension
type: string
required:
- emailAddress
- name
- number
PlaceRefOrQuery:
description: A place described by reference to a Geographic Address, Geographic Site or by Geographic Address Representations.
type: object
discriminator:
propertyName: '@type'
mapping:
GeographicAddressRef: '#/components/schemas/GeographicAddressRef'
GeographicSiteRef: '#/components/schemas/GeographicSiteRef'
GeographicAddress_Query: '#/components/schemas/GeographicAddress_Query'
oneOf:
- $ref: '#/components/schemas/GeographicAddressRef'
- $ref: '#/components/schemas/GeographicSiteRef'
- $ref: '#/components/schemas/GeographicAddress_Query'
GeographicAddressRef:
description: 'A reference to a Geographic Address resource available through Address Validation API.
'
type: object
properties:
href:
description: 'Hyperlink to the referenced Address. Hyperlink MAY be used by the Seller in responses. Hyperlink MUST be ignored by the Seller in case it is provided by the Buyer in a request.
'
type: string
id:
description: Identifier of the referenced Geographic Address. This identifier is assigned during a successful address validation request (Geographic Address Management API)
type: string
'@type':
description: Used to unambiguously designate the class type when using `oneOf`
type: string
enum:
- GeographicAddressRef
required:
- '@type'
- id
Error403Code:
description: 'This code indicates that the server understood
the request but refuses to authorize it because
of one of the following error codes:
- accessDenied: Access denied
- forbiddenRequester: Forbidden requester
- tooManyUsers: Too many users'
type: string
enum:
- accessDenied
- forbiddenRequester
- tooManyUsers
MEFProductStatusChange:
description: Holds the reached status, reasons and associated date the Product Order status changed, populated by the Seller.
type: object
properties:
changeReason:
description: The reason why the status changed.
type: string
changeDate:
description: The date and time the status changed.
type: string
format: date-time
status:
description: Status of the product
$ref: '#/components/schemas/MEFProductStatusType'
required:
- changeDate
- status
Duration:
description: A Duration in a given unit of time e.g. 3 hours, or 5 days.
type: object
properties:
amount:
description: Duration (number of seconds, minutes, hours, etc.)
type: integer
minimum: 0
units:
description: Time unit enumerated
$ref: '#/components/schemas/TimeUnit'
required:
- amount
- units
MEFProductStatusType:
description: 'Possible values for the status of a MEF product
| name | MEF 81 name |
| --------------------------- | --------------------------- |
| `active` | ACTIVE |
| `active.pendingChange` | ACTIVE_PENDING_CHANGE |
| `pendingTerminate` | ACTIVE_PENDING_TERMINATE |
| `cancelled` | CANCELLED |
| `pendingActive` | PENDING |
| `suspended` | SUSPENDED |
| `suspendedPendingTerminate` | SUSPENDED_PENDING_TERMINATE |
| `terminated` | TERMINATED |'
type: string
enum:
- active
- active.pendingChange
- cancelled
- pendingActive
- pendingTerminate
- suspended
- suspendedPendingTerminate
- terminated
MEFProductConfiguration:
description: MEFProductConfiguration is used as an extension point for MEF specific product/service payload. The `@type` attribute is used as a discriminator
type: object
properties:
'@type':
description: The name of the type, defined in the JSON schema specified above, for the product that is the subject of the POQ Request. The named type must be a subclass of MEFProductConfiguration.
type: string
required:
- '@type'
discriminator:
propertyName: '@type'
LabelRepresentation:
description: A unique identifier controlled by a generally accepted independent administrative authority that specifies a fixed geographical location.
type: object
properties:
label:
description: The unique reference to a Geographic Address assigned by the Administrative Authority.
type: string
administrativeAuthority:
description: The organization or standard from the organization that administers this Geographic Address Label ensuring it is unique within the Administrative Authority.
type: string
language:
description: The language in which the label is expressed. Based on ISO 639:2023
type: string
minLength: 2
maxLength: 2
required:
- administrativeAuthority
- label
FieldedAddressRepresentation:
description: 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" is one field, "street name" is another field, etc.
type: object
properties:
streetNr:
description: Number identifying a specific property on a public street. It may be combined with streetNrLast for ranged addresses.
type: string
streetNrSuffix:
description: The first street number suffix (in a street number range) or the suffix for the street number if there is no range
type: string
streetNrLast:
description: Last number in a range of street numbers allocated to an Address
type: string
streetNrLastSuffix:
description: Last street number suffix for a ranged Address
type: string
streetPreDirection:
description: The direction of the street that appears before the Street Name
type: string
streetName:
description: Name of the street or other street type
type: string
streetType:
description: The type of street (e.g., alley, avenue, boulevard, brae, crescent, drive, highway, lane, terrace, parade, place, tarn, way, wharf)
type: string
streetPostDirection:
description: A modifier denoting a relative direction that appears after the Street Name.
type: string
poBox:
description: Number identifying a specific location in a post office.
type: string
locality:
description: An area of defined or undefined boundaries within a local authority or other legislatively defined area.
type: string
city:
description: City in which the Address is located.
type: string
postcode:
description: A descriptor for a postal delivery area used to speed and simplify the delivery of mail (also known as zip code)
type: string
postcodeExtension:
description: 'The extension used on a postal code. Note: there are different use codes for this attribute depending upon the country.'
type: string
stateOrProvince:
description: The State or Province in which the Address is located.
type: string
countryCode:
description: Country in which the Address is located, defined using two characters as defined in ISO 3166
type: string
minLength: 2
maxLength: 2
subUnit:
description: The Sub Unit represented as a list. This is a list to allow complex sub-unit information such as SUITE 42 ROOM A
type: array
items:
$ref: '#/components/schemas/SubUnit'
buildingName:
description: 'The well-known name of a building that is located at this Address (e.g., where there is one Address for a campus).
'
type: string
privateStreetNumber:
description: Street number on a private street within the Address.
type: string
privateStreetName:
description: Private streets internal to a property (e.g., a university) may have internal names that are not recorded by the land title office.
type: string
language:
description: The language in which the address is expressed. It MUST use the ISO 639:2023 two letter code 639:2023
type: string
minLength: 2
maxLength: 2
Error401Code:
description: 'One of the following error codes:
- missingCredentials: No credentials provided.
- invalidCredentials: Provided credentials are invalid or expired'
type: string
enum:
- missingCredentials
- invalidCredentials
ProductSpecificationRef:
description: A reference to a structured set of well-defined technical attributes and/or behaviors that are used to construct a Product Offering for sale to a market.
type: object
properties:
href:
description: 'Hyperlink to a Product Specification in Sellers catalog. In case Seller is not providing a catalog API this field is not used. The catalog is provided by the Seller to the Buyer during onboarding.
'
type: string
id:
description: Unique identifier of the product specification
type: string
required:
- id
Error400:
description: Bad Request. (https://tools.ietf.org/html/rfc7231#section-6.5.1)
allOf:
- $ref: '#/components/schemas/Error'
- type: object
properties:
code:
description: 'One of the following error codes:
- missingQueryParameter: The URI is missing a required query-string parameter
- missingQueryValue: The URI is missing a required query-string parameter value
- invalidQuery: The query section of the URI is invalid.
- invalidBody: The request has an invalid body'
$ref: '#/components/schemas/Error400Code'
required:
- code
MEFProduct_Find:
description: Class used to provide product overview retrieved in GET (by list) operation
type: object
properties:
productSpecification:
description: A reference to a Product Specification of the Product
$ref: '#/components/schemas/ProductSpecificationRef'
place:
description: A list of locations that are related to the Product. For example an installation location
type: array
items:
$ref: '#/components/schemas/RelatedPlaceRefOrQuery'
productOffering:
description: A particular Product Offering defines the technical and commercial attributes and behaviors of a Product.
$ref: '#/components/schemas/ProductOfferingRef'
lastUpdateDate:
description: Latest date when the product has been updated.
type: string
format: date-time
externalId:
description: This identifier is optionally provided during the product ordering and stored for informative purpose in the seller inventory
type: string
productRelationship:
description: A list of references to existing products that are related to the Product.
type: array
items:
$ref: '#/components/schemas/ProductRelationship'
id:
description: Unique identifier of the product
type: string
href:
description: Reference of the product
type: string
billingAccount:
description: The Billing Account associated with the Product
$ref: '#/components/schemas/MEFBillingAccountRef'
productOrderItem:
description: The Product Order Item of the associated Product order that resulted in the creation of this Product.
type: array
items:
$ref: '#/components/schemas/MEFProductOrderItemRef'
startDate:
description: The date from which the product starts
type: string
format: date-time
status:
description: The lifecycle status of the product.
$ref: '#/components/schemas/MEFProductStatusType'
required:
- id
- status
Error500:
description: Internal Server Error. (https://tools.ietf.org/html/rfc7231#section-6.6.1)
allOf:
- $ref: '#/components/schemas/Error'
- type: object
properties:
code:
description: 'The following error code:
- internalError: Internal server error - the server encountered an unexpected condition that prevented it from fulfilling the request.'
type: string
enum:
- internalError
required:
- code
GeographicSiteRef:
description: 'A reference to a Geographic Site resource available through Service Site API
'
type: object
properties:
href:
description: 'Hyperlink to the referenced Site. Hyperlink MAY be used by the Seller in responses. Hyperlink MUST be ignored by the Seller in case it is provided by the Buyer in a request.
'
type: string
id:
description: Identifier of the referenced Geographic Site.
type: string
'@type':
description: Used to unambiguously designate the class type when using `oneOf`
type: string
enum:
- GeographicSiteRef
required:
- '@type'
- id
MEFBillingAccountRef:
description: A reference to the Buyer's Billing Account
type: object
properties:
id:
description: Identifies the buyer's billing account to which the recurring and non-recurring charges for this order or order item will be billed. Required if the Buyer has more than one Billing Account with the Seller and for all new Product Orders.
type: string
required:
- id
Price:
description: Provides all amounts (tax included, duty-free, tax rate) and used currency of a Price
type: object
properties:
taxRate:
description: 'Price Tax Rate. Unit: [%]. E.g. value 16 stand for 16% tax.'
type: number
format: float
taxIncludedAmount:
description: All taxes included amount (expressed in the given currency)
$ref: '#/components/schemas/Money'
dutyFreeAmount:
description: All taxes excluded amount (expressed in the given currency)
$ref: '#/components/schemas/Money'
required:
- dutyFreeAmount
Error400Code:
description: 'One of the following error codes:
- missingQueryParameter: The URI is missing a required query-string parameter
- missingQueryValue: The URI is missing a required query-string parameter value
- invalidQuery: The query section of the URI is invalid.
- invalidBody: The request has an invalid body'
type: string
enum:
- missingQueryParameter
- missingQueryValue
- invalidQuery
- invalidBody
MEFProduct:
description: A product is realized as one or more service(s) and / or resource(s).
type: object
properties:
id:
description: Unique identifier of the product
type: string
href:
description: Reference of the product
type: string
startDate:
description: Is the date from which the product starts. Start date is when the product is active for the first time (when the install in the product order has been processed).
type: string
format: date-time
externalId:
description: Buyer identifier of the product
type: string
status:
description: The lifecycle status of the product.
$ref: '#/components/schemas/MEFProductStatusType'
statusChange:
description: status change for the Product
type: array
items:
$ref: '#/components/schemas/MEFProductStatusChange'
lastUpdateDate:
description: Latest date when the product has been updated.
type: string
format: date-time
agreementName:
description: Name of the agreement. The name is unique between the Buyer and the Seller.
type: string
productSpecification:
description: A reference to a Product Specification of the Product
$ref: '#/components/schemas/ProductSpecificationRef'
place:
description: A list of locations that are related to the Product. For example an installation location
type: array
items:
$ref: '#/components/schemas/RelatedPlaceRefOrQuery'
productOffering:
description: A particular Product Offering defines the technical and commercial attributes and behaviors of a Product.
$ref: '#/components/schemas/ProductOfferingRef'
relatedContactInformation:
description: Party playing a role for this Product
type: array
items:
$ref: '#/components/schemas/RelatedContactInformation'
billingAccount:
description: The Billing Account associated with the Product
$ref: '#/components/schemas/MEFBillingAccountRef'
productOrderItem:
description: The Product Order Item of the associated Product order that resulted in the creation of this Product.
type: array
items:
$ref: '#/components/schemas/MEFProductOrderItemRef'
productTerm:
description: Term of the Product
type: array
items:
$ref: '#/components/schemas/MEFItemTerm'
terminationDate:
description: Is the date when the product was terminated. Termination date (commercial) is when the product has been terminated (when the disconnect in the product order has been processed).
type: string
format: date-time
productConfiguration:
description: MEFProductConfiguration is used to specify the MEF specific product payload.
$ref: '#/components/schemas/MEFProductConfiguration'
productRelationship:
description: A list of references to existing products that are related to the Product.
type: array
items:
$ref: '#/components/schemas/ProductRelationship'
productPrice:
description: A list of Prices associated with the Product
type: array
items:
$ref: '#/components/schemas/ProductPrice'
required:
- id
- startDate
- status
- statusChange
GeographicPointRepresentation:
description: 'A GeographicPointRepresentation defines a geographic point through coordinates.
'
type: object
properties:
spatialRef:
description: The spatial reference system used to determine the coordinates. The system used and the value of this field are to be agreed during the onboarding process.
type: string
latitude:
description: The latitude exp
# --- truncated at 32 KB (44 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/mef/refs/heads/main/openapi/mef-product-api-openapi.yml