TMF622 Inbound API – Product Ordering Management
Intro
This system exposes an inbound REST API compliant with the TMF622 – Product Ordering Management API (opens in a new tab) specification provided by TM Forum.
It serves as the primary integration point for external client systems that initiate and manage product orders.
All API endpoints follow the structure and payload formats defined in the TMF622 standard. No proprietary extensions are applied. However, the API is customizable by clients to match specific integration needs. Customization details are described in the dedicated section: Order Fetcher and Order Service.
Supported Endpoints
The table below lists the supported TMF622 endpoints, their purpose, and links to sample requests and responses included in the documentation.
| Method | Endpoint | Description | Sample Reference |
|---|---|---|---|
| POST | /productOrder | Creates a new product order | Create Order |
| GET | /productOrder/{id} | Retrieves details of a specific order | Get Order |
| PATCH | /productOrder/{id} | Updates an existing product order partially | Patch Order |
| POST | /cancelProductOrder | Submits a formal cancellation request | Cancel Order |
HTTP Status Codes
The API uses standard HTTP status codes, including but not limited to:
200 OK– Successful retrieval or update201 Created– Resource successfully created204 No Content– Successful operation without response body400 Bad Request– Invalid or incomplete input404 Not Found– Resource not found500 Internal Server Error– Unexpected system error