Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

TM Forum cancelProductOrder API

Operations for CancelProductOrder Resource

TM Forum cancelProductOrder API is one of 38 APIs that TM Forum publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include cancelProductOrder. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 3 operations across 2 paths, and defines 14 schemas. It is described by OpenAPI 3.0.1, at version 5.0.0.

Requests are made against a single base URL, https://serverRoot/productCatalogManagement/v5/.

3 operations 2 paths 14 schemas 2 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
5.0.0
Server
https://serverRoot/productCatalogManagement/v5/
Resource Areas
1

Paths & Operations 3

Across 2 paths, the API surfaces 3 operations — 2 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

cancelProductOrder 3

Operations for CancelProductOrder Resource

GET
/cancelProductOrder
TM Forum List or Find CancelProductOrder Objects
listCancelProductOrder 3 params → 200400401403404405500501
POST
/cancelProductOrder
TM Forum Creates a CancelProductOrder
createCancelProductOrder 1 param body → 201202400401403404405409
GET
/cancelProductOrder/{id}
TM Forum Retrieves a CancelProductOrder by ID
retrieveCancelProductOrder 2 params → 200400401403404405500501

Schemas 14

The contract defines 14 schemas that model the data the API accepts and returns. The most detailed are Extensible (3 properties), Extensible_FVO (3 properties), Addressable (2 properties), Addressable_FVO (1 property). Each schema is shown below with its type and property counts.

CancelProductOrder
EntityRef_FVO
TaskStateType
string
Possible values for the state of a task
Entity_FVO
object
Base entity schema for use in TMForum Open-APIs. Property.
Addressable
object
Base schema for adressable entities
2 properties
Error
Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
Entity
object
Base entity schema for use in TMForum Open-APIs. Property.
Addressable_FVO
object
Base schema for adressable entities
1 property
Extensible_FVO
object
Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
3 properties 1 required
Extensible
object
Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
3 properties 1 required
EntityRef
ProductOrderRef_FVO
object
A reference to an existing Product Order.
CancelProductOrder_FVO
ProductOrderRef
object
A reference to an existing Product Order.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

tm-forum-cancelproductorder-api-openapi.yml Raw ↑

Other APIs TM Forum publishes across the network.

TM Forum agreement API
TM Forum agreementSpecification API
TM Forum billFormat API
TM Forum billingAccount API
TM Forum billingCycleSpecification API
TM Forum billPresentationMedia API
TM Forum cancelServiceOrder API
TM Forum category API
TM Forum customer API
TM Forum events subscription API
TM Forum exportJob API
TM Forum financialAccount API