Comviva

Introduction

The Customer Product Order API enables customers and API integrators to manage product orders seamlessly across various channels including web, telecom, and in-store. It facilitates the acceptance, validation, and initiation of orders for decomposition, supporting a wide range of order scenarios such as new orders, modifications (amendments), terminations, cancellations, suspensions, and resumptions.
The Product Ordering API provides a standardized mechanism for placing a product order with all of the necessary order parameters. The API consists of a simple set of operations that interact with CRM/Order Negotiation systems in a consistent manner. A product order is created based on a product offer that is defined in a catalog. The product offer identifies the product or set of products that are available to a customer, and includes characteristics such as pricing, product options and market. This API provide a task based resource to request order cancellation.
The product order references the product offer and identifies any specific requests made by the customer.
Product Order resource 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 and vice versa. Main Product Order attributes are its identifier, state, priority category (mass market, Enterprise, etc.) related dates (start, completion, etc.), related billing account, related parties and order items. Main Order Items (aka order lines) attributes are the ordered offering and product characteristics with the related action to be performed (e.g. add or delete the products), state, location information for delivery, order item price and price alteration.

**Product Order API performs the following operations on product order** :

- Retrieval of a product order or a collection of product orders depending on filter criteria -Partial update of a product order (including updating rules) 
- Creation of a product order (including default values and creation rules) 
- Deletion of product order (for administration purposes) -Notification of events on product order.

**cancelProductOrder resource This resource is used to request a product order cancellation. Product Order API performs the following operations on product order**:

- Retrieval of a cancel product order or a collection of cancel product orders 
- Creation of a cancel product order -Notification of events on cancel product order.

**Key Features**:

1. **Acceptance and Validation: The API allows for the acceptance and validation of orders against catalog offers, ensuring accuracy and compliance with business rules.
2. **Order Decomposition: Orders can be initiated for decomposition, streamlining the process for further processing and fulfillment.
3. **Order Scenarios: Handles diverse order scenarios including new orders, modifications, terminations, cancellations, suspensions, and resumptions, catering to various customer needs and requests.
4. **Data Structure: Utilizes the TMF622 data model for structured order entry and management, enhancing data consistency and interoperability.
5. **Order State Management: Manages order states based on order progress, providing visibility and control throughout the order lifecycle.

**Usage Guidelines**:

**Authorization**: Access to the API requires a JWT token with appropriate permissions, including the ability to manage orders and access catalog data.
**Customization**: Developers can define business rules within the API for order validation, credit checks, and other customizations, influencing the API's response and behavior.
**Integration**: Seamlessly integrates with external systems as part of the business fulfillment plan, supporting portfolio ID generation and external validations.
**Performance**: The API is optimized for performance, ensuring efficient processing of orders and delivering a seamless user experience across channels.


Customer Order

Submit Order

Cancel Order

Get Order

Get Cancel Order

Get Customer Profile

Submit Dunning Orders

The Customer Service / Resource Order (CSO) API provides a standardized mechanism for managing Service and Resource Orders, enabling seamless integration between internal Customer Order Management systems and Service Order Management systems. This API facilitates actions such as decomposing Customer Orders, validating Service and Resource Orders against catalog definitions, and supporting network activation and CLR creation.

The Service Order API provides a standardized mechanism for managing Service Order, a type of order which can be used to place an order between internal Customer Order management system to service order management system or between a service provider and a partner and vice versa.

**Service Order resource**: A service order will describe a list of service order items. A service order item references an action on an existing or future service. By service, we designed Customer Facing Service (CFS) as well as Resource Facing Service (RFS). From a component perspective, a service order should be available from:

 - A Service Orchestration Component (and it could mix CFS and RFS)
 - An Infrastructure Control & Management component (and it would have only RFS)

    **Key Feature**:

    -   Decompose Customer Orders into Service and Resource Orders.
    -   Validate Service and Resource Orders with catalog definitions.
    -   Support network activation and CLR creation.
    -   Enable actions including ADD, MODIFY, DELETE, CANCEL, and NOCHANGE.
    -   Provide operations such as POST, PATCH, GET, and DELETE for order management.
    -   Require a login token for authorization.
    -   Compare Service and Resource Orders with catalog definitions.
    -   Process applications in real-time.
    -   Support order scenarios like New, Modification, Termination, Amendment, Cancel, Suspend, and Resume.
    -  Integrate Network Operations Center (NOC) functionalities.

**Usage Guidelines**:

   - **Authorization**: Access to the service requires a JWT token with appropriate permissions. Login tokens are necessary for secure authentication and authorization. 
   - **Customization**: Developers can influence the response of this component by defining business rules within the order creation process and catalog validation.
   - **Performance**: The API is optimized for real-time processing, ensuring efficient handling of requests for a seamless user experience.


Service Order

A Service Order Management API refers to a set of endpoints or functions within a software system that handle various management tasks related to service orders. Service order management involves activities such as creating, updating, tracking and completing service orders, as well as managing their status and associated information. The API would provide the means to perform these actions programmatically.

Submit Service Order

A Service Order Query API likely refers to an endpoint or functionality within a software system that allows users to query and retrieve information related to service orders.

Get Service Order

The Customer Product Inventory (CPI) API is designed to streamline customer product inventory management across various domains such as self-care, customer management, billing, and order entry systems. It provides a standardized mechanism for creating, updating, and retrieving product representations in the inventory, ensuring real-time updates and integration capabilities with other systems.
The Product Inventory Management API provides standardized mechanism for product inventory management such as creation, update and retrieval of the representation of a product in the inventory. It also allows the notification of events related to product lifecycle.

**Key Features**:

1. **Real-Time Updates**: Maintain accurate and up-to-date customer inventory information through real-time updates.
2. **Integration Capabilities**: Seamlessly integrate with billing, self-care, reporting, and other systems for comprehensive inventory management.
3. **Search and Filter Options**: Utilize search and filter functionalities to easily locate specific products or services within the inventory.
4. **Support for Change Order Requests**: Facilitate the management of change order requests by leveraging real-time updates and integration capabilities.
5. **Event Notification**: Receive notifications for events related to product lifecycle changes, ensuring proactive management of inventory.
6. **User Token Authorization**: Access to the CPI API requires a user token with appropriate permissions, ensuring secure and authorized access.
7. **Role-Based Access Control**: Implement role-based access control to manage user permissions and data security effectively.
8. **Scalability and Performance**: Designed for scalability and optimized performance to handle large volumes of data and transactions efficiently.

**Usage Guidelines**:

**Authorization**: Access to the CPI API requires a user token with specific permissions, ensuring secure and authorized access.
**Integration**: Integrate the CPI API with billing, self-care, reporting, and other systems for seamless inventory management across domains.
**Performance**: The API is optimized for performance, enabling efficient processing of requests and delivering a seamless user experience.


Customer Product Inventory

Submit Product Inventory

Get Product Inventory

The Customer Service and Resource Inventory (CSI) API is a powerful tool for managing real-time updates to customer inventories across self-care portals, customer interfaces, and network systems. It offers integration capabilities with billing, self-care functionalities, and reporting tools, providing a seamless experience for managing service instances, especially during change order requests. \n" +
The Service Inventory API can be called by the Service Order Management to create a new service instance/ update an existing service instance in the Service Inventory.\n" +
Service resource Service is an abstract base class for defining the Service hierarchy. All Services are characterized as either being possibly visible and usable by a Customer or not. This gives rise to the two subclasses of Service: CustomerFacingService and ResourceFacingService.\n" +
Service Inventory API performs the following operations on service : Retrieve a service or a collection of services depending on filter criteria Partial update of a service (including updating rules) Create a service (including default values and creation rules and for administration users only) Delete a service (for administration users only) Notification of events on service\n" +

**Key Features**:

1.  **Real-Time Inventory Updates**: Maintain an accurate representation of customer inventories with real-time updates for services and resources.\n" +
2.  **Integration Capabilities**: Integrate seamlessly with billing, self-care, and reporting systems to ensure data consistency and synchronization.\n" +
3.  **Search and Filter Options**: Enable users to easily search and filter service instances for efficient inventory management.
4.  **Change Order Requests**: Facilitate the process of raising change order requests by leveraging real-time updates and integration capabilities.
5.  **Event Notifications**: Receive notifications for events related to the product lifecycle, enhancing proactive management of inventory changes.
6.  **User Token Authorization**: Access to the CSI API requires a user token with appropriate permissions, ensuring secure and authorized access.
7.  **Scalability and Performance**: Designed for scalability to handle large volumes of services and resources, with optimized performance for efficient processing.
8.  **Reporting Capabilities**: Provide comprehensive reporting functionalities for monitoring inventory levels, trends, and usage patterns.

**Usage Guidelines**:

**Authorization**: Access to the CSI API requires a user token with specific permissions, ensuring secure and authorized access.
**Integration**: Integrate the CSI API with billing, self-care, reporting, and other systems for seamless inventory management.
**Performance**: The API is optimized for performance, ensuring efficient processing of requests to deliver a seamless user experience.


Customer Service Inventory

Get Service Inventory

Submit Service Inventory

The Task Management Service provides a comprehensive set of REST APIs designed for effective task and process oversight. These APIs empower users to access vital information, including pending tasks, process instances, attribute details, and checklists. By offering dedicated endpoints for tasks retrieval, completion, attribute fetching, and dynamic updates, users can ensure smooth task execution and flexibility. 

Moreover, the service enhances workflow visibility with APIs for task checklist display and management, facilitating organized task handling. Additionally, the ability to fetch flow trace details for the customer order view page provides users with a comprehensive view of order processing, supporting informed decision-making and streamlined order management workflows.

**Key Features:**
1. **Task Viewing and Management:** Users can view, edit, and complete tasks directly through the API, streamlining task management processes.
2. **User Access Control:** Access to the API is restricted to users with appropriate permissions, ensuring data security and authorized task handling.
3. **Order Status and Flow Trace:** In addition to task management, users can also view order status and flow trace details, gaining insights into order processing stages.
4. **Manual Task Handling:** The API supports manual task management, allowing users to assign tasks based on business rules and complete tasks assigned against orders.
5. **IDP Integration:** User identity and access management are seamlessly integrated, leveraging user IDP details for authentication and authorization.
6. **Quick Response Time:** The API is optimized for quick response times, ensuring a seamless user experience with efficient task handling and data retrieval.

**Usage Guidelines:**
- **Authorization:** Access to the Task Management API requires a JWT token with appropriate permissions, ensuring secure and authorized task handling.
- **Customization:** Developers can customize the API response by defining business rules within the application, enhancing task management capabilities.
- **Performance:** The API is optimized for performance, delivering quick response times for task viewing, editing, and completion, as well as order status and flow trace retrieval.


Task Management

Retrieves process instance details through various methods

Get Process Details

Processes task closure requests based on serviceRequestId, cpoId and installBaseId

Task Closure Service

Displays and manages tasks by retrieving attributes, updating task status, closing tasks, and fetching task data based on specified filters.

Get Task Details

The Task Checklist API facilitates structured task management by defining checklists that must be completed within specified workflows. It ensures that agents follow predefined steps and activities before closing tasks, enhancing organization, efficiency, and task completion accuracy.

**Key Responsibilities:**
1. **Master Data Configuration:** Checklists are defined based on master data configuration, ensuring consistency and accuracy..
2. **Task Completion Requirement:** Agents must perform and confirm checklist items before closing tasks, ensuring task completeness and quality.
3. **TODO Activities:** Checklists act as TODO lists, guiding agents through required actions and tasks.
4. **Reminder List:** Serves as a reminder list, prompting agents to capture and complete specified activities.
5. **Task-Level Checklists:** Checklists can be defined at the task level, allowing customization for different tasks and workflows.

**Business Processes Supported:**
- **Task Completion Workflow:** Enforces completion of specific checklist items before closing tasks, ensuring compliance and quality.
- **Task Progress Tracking:** Tracks checklist status (e.g., Pending, Work in Progress, Completed, Rejected, Not Applicable) for effective task management and monitoring.

**Key Features:**
1. **Checklist Definition:** Defined based on master data configuration, ensuring consistency and accuracy across tasks.
2. **Task Completion Requirement:** Agents must complete checklist items before closing tasks, ensuring thoroughness and compliance.
3. **Task-Level Customization:** Checklists can be customized for different tasks and workflows, enhancing flexibility and adaptability.
4. **Checklist Status Tracking:** Tracks checklist status in real time, providing visibility into task progress and completion.
5. **Authorization:** Access requires a valid login token, ensuring secure and authorized usage.
6. **Customization:** Developers can define business rules within the Task Checklist API, enhancing functionality and adaptability.
7. **Performance Optimization:** Optimized for timely response and efficient processing, delivering a seamless user experience.

**Usage Guidelines:**
- **Authorization:** Access requires a valid login token with appropriate permissions.
- **Customization:** Developers can define task-specific checklists and business rules within the API, enhancing functionality and flexibility.
- **Performance:** Optimized for efficient processing and timely response within expected timeframes.

**Example Business Process:**
- While closing a network task, agents must complete checklists such as "Connect Last Mile with POP Port" and "Connect Last Mile with CPE" to ensure task completeness and compliance.


Task Checklist API

The Service Request Management API is a powerful tool for managing non-commercial orders and customer requests across self-care portals and customer interfaces. It allows users to create and update requests, integrates seamlessly with external systems, and facilitates the management of change order requests.

The Service Request API provides a standardized client interface to Trouble Ticket Management Systems for creating, tracking, and managing trouble tickets as a result of an issue or problem identified by a customer or another system.

The API supports the ability to send requests to create a new trouble ticket specifying the nature and severity of the trouble or issue as well as all necessary related information.The API also includes mechanisms to search for and update existing trouble tickets. Notifications are defined to provide information when a trouble ticket has been updated, including status changes. A basic set of states of a trouble ticket has been specified(as an example) to handle trouble ticket lifecycle management.

Trouble Ticketing API manages trouble ticket resource: A trouble ticket represents a record, or an issue raised by the requestor that needs to be solved, used for reporting and managing the resolution of problems, incidents, or requests. Main trouble ticket attributes are its description, severity, type, related dates (creation, expected resolution, resolution), state and related information (change reason and change date), related parties (originator, owner, reviser, etc.), related entities (product, product order, customer bill), and notes.

**Key Features:**

- 	**Managing Non-Commercial Orders**: The API supports the creation and management of non-commercial orders.
- 	**Integration with External Systems**: Integrate seamlessly with Northbound and Southbound applications for data synchronization and updates.
- 	**Customer and Self-Care Interfaces**: Provide a standardized client interface for customers and self-care portals to create and manage service requests.
- 	**Change Order Requests**: Facilitate the process of raising change order requests and managing their lifecycle.
- 	**Business Process Management**: Enable the creation and management of different customer requests through customizable business processes.
- 	**Real-Time Updates**: Capture each customer request in real-time, ensuring accurate and up-to-date information.
-   **Update Notifications**: Receive notifications for events such as trouble ticket state changes or updates to keep users informed.

**Usage Guidelines**:

   -  **Authorization**: Access to the service requires a login token with specific permissions, ensuring secure and authorized access. 
   -  **Integration**: Integrate the API with Northbound and Southbound applications for data synchronization and updates.
   -  **Performance**: The API is optimized for performance, ensuring efficient processing of requests to deliver a seamless user experience.


Service Request

The Trouble Ticket Command refers to a set of actions and directives within a Trouble Ticket Controller system. It allows authorized personnel to initiate, modify, or oversee the lifecycle of reported issues or incidents. This command permits users to create new tickets, assign them to appropriate teams or individuals, update ticket details, and track progress. Additionally, it facilitates communication between support teams and users, ensuring transparency and efficient problem resolution. The Trouble Ticket Command is an essential feature for maintaining order, accountability, and effective collaboration in issue management processes.

Submit Service Request

The Trouble Ticket Query API enables retrieving trouble ticket information from a system. It supports filtering by parameters like status, priority, and assignee, as well as sorting and pagination. By making a GET request to /trouble-tickets, you can receive a JSON array of ticket objects with details such as ID, title, description, status, priority, assignee, creation date, and last update. This data helps monitor and manage tickets effectively. 

Get Service Request

**Description**:

The Order Rule Service API manages, retrieves, and dynamically loads rules based on criteria, facilitating active rule management and integration with a RuleEngine for effective business logic implementation and decision-making. It enables real-time rule execution based on provided facts, ensuring rules are up to date and dynamically applied.

**Key Features**:

1.	**Rule Definition Input**: Allows providing input parameters as per rule definitions.
2.	**Dynamic Rule Loading**: Loads rules into a rule kia session, returning specific results based on facts.
3.	**REST API Access**: Deployed rules can be accessed via a REST API.
4.	**Rule Engine Integration**: Enables updating and deploying rules via the RuleEngine, accessible through the REST API.
5.	**Business Rule Types**: Supports various rules like Task Allocation, Attribute Restrictions, and Portfolio ID definition.
6.	**Rule Versioning**: Allows duplication of rules, defaulting to draft versions, and publishing modified rules as Active rules via the REST API.
7.	**Access Control**: Requires login access for API usage.
8.	**Customization**: Developers define rules based on business requirements, specifying conditions for rule execution.
9.	**Real-time Results**: Provides results almost instantly, ensuring efficient decision-making.

**Usage Guidelines**:

-	**Authorization**: Access to the service requires login credentials with appropriate permissions.
-	**Customization**: Developers can define, update, and delete rules as needed for business logic customization.
-	**Performance**: Optimized for real-time rule execution, delivering efficient processing and quick results.


Rule Service

Get Rule

Get Rules For UI

Create / Update Rules

**Description**: 

The Rule Engine API serves as the decision-making core of our application, enabling automated and consistent application of business logic. It manages rules, evaluates data based on these rules, and guides application actions accordingly, reducing manual work and errors.

**Key Responsibilities**:

1.  **Rule Management**: Manages rules and their definitions, ensuring availability and accessibility.
2.	**Dynamic Rule Application**: Dynamically applies rules based on provided conditions, influencing decision-making.
3.	**Decision Guidance**: Provides outputs based on rule evaluation, guiding application actions and processes.

**Business Processes Supported**:

-	**serviceOrderEditRules**: This rule ensures that only relevant sections of a service/resource order are editable based on the current order status, enhancing data integrity and order management efficiency.
-	**enrichOrderCharacteristics**: Automatically adds or deletes default characteristics in product order items, ensuring completeness, accuracy, and readiness for further processing.
-	**portfolioIdGenerationRules**: Utilizes defined calculations and algorithms to generate unique portfolio IDs, facilitating bundled offer management and system efficiency.
-	**cancelOrderBusinessService**: A key component in a customer-centric order management process, aligning business needs with customer expectations and operational efficiencies.
-	**omQuantityRules**: Enhances order processing granularity and customer experience by converting offer items into multiple order line items.
-	**productOfferingQualificationService**: Ensures efficient order processing and decision-making by correctly passing required data based on order type to the qualification service.
-	**jeopardyRules**: Manages errors or exceptions during order processing, addressing and resolving issues efficiently.
-	**taskAllocationRule**: Allocates tasks to users based on skill set, geography, and group criteria.
-	**dispatch**: Identifies resource or service order items for dispatch, optimizing dispatch planning and execution.
-	**portability**: Streamlines the portability process, enhancing customer experience and operational efficiency.
-	**bulkJeopardy**: Automates recovery steps for bulk orders facing specific errors, improving fault recovery efficiency.

**Key Features**:

1.	**Rule Status Management**: Rules are accessed via the Rule Engine once deployed or when their status is active.
2.	**Rule Definition**: Developers define rules using "when" and "then" conditions.
3.	**Decision-Making Integration**: Inputs are provided, and the Rule Engine outputs decisions based on rule evaluations.
4.	**Rule Deployment**: Rules are deployed into the Rule Engine via REST API, changing their status to active upon deployment.
5.	**Authorization**: Access requires a JWT token for authentication and authorization.
6.	**Customization**: Developers can update rule conditions to customize rule behavior.
7.	**Real-time Updates**: Rules and decisions are updated in real time, ensuring responsiveness and accuracy.

**Usage Guidelines**:

-	**Authorization**: Access requires a JWT token with appropriate permissions.
-	**Customization**: Developers can influence rule behavior by updating rule conditions.
-	**Performance**: Optimized for real-time updates and efficient decision-making processes.


Order Rule Engine

User Role Permission

The Communication Management API is a powerful tool designed to facilitate efficient communication processes within your application. It enables users to define notification templates and send messages via SMS, WhatsApp, and email to both customers and internal teams. By leveraging event-based triggers and templates, users can streamline communication workflows, ensuring timely and targeted messaging.

**Key Features**:

-  **Notification Template Management**: Define and manage notification templates for consistent messaging across different communication channels.
-  **Multi-Channel Messaging**: Send messages via email, WhatsApp, and SMS to reach audiences effectively across various platforms.
-  **Template-Based Communication**: Utilize predefined templates for communication creation, ensuring standardized and branded messaging.
-  **Event-Based Communication**: Trigger communication events based on specific milestones or events, enhancing automation and targeted messaging.
-  **Real-Time Processing**: Process communication requests in real time, ensuring timely delivery and responsiveness.\n" +
-  **Integration Capabilities**: Integrate the API with other systems and services using event triggers or REST APIs for seamless communication management.
-  **Audience Targeting**: Target communications to specific recipients, including customers, internal teams, and user groups, based on predefined criteria.
-  **Automation and Scheduling**: Automate communication processes and schedule messages for optimal delivery and engagement.
-  **Reporting and Analytics**: Track communication performance metrics, including delivery rates, open rates, and response rates, for analysis and optimization.
-  **Authorization and Security**: Access to the API requires JWT token authentication with appropriate permissions, ensuring data security and authorized usage.

**Usage Guidelines**:

- **Authorization**: Access to the Communication Management API requires a JWT token with appropriate permissions, ensuring secure and authorized communication handling.
- **Customization**: Developers can customize communication templates and rules within the API to align with business requirements and branding guidelines.
- **Performance**: The API is optimized for real-time processing and performance, delivering efficient communication workflows and a seamless user experience.


Communication Management

Get Communication

Submit Communication

Notification Service

The Project Plan API within the Order Management System enables the definition and communication of important milestones to customers, facilitating transparency, tracking, and timely delivery of complex orders. It integrates with master data configuration, compares flow trace data with major milestones, and generates project plans that can be shared online via email or offline in formats like Excel or PowerPoint.

**Key Responsibilities:**
1. **Master Data Configuration:** Defines project milestones and configurations in the master data setup.
2. **Flow Trace Comparison:** Compares Flow Trace data with major milestones to determine start and end times for activities.
3. **Business Process Integration:** Supports B2B business processes and allows manual initiation by agents.
4. **Communication Channels:** Sends project plans to customers online via email or offline in Excel or PowerPoint formats.
5. **Authorization:** Requires valid login permissions for access and usage.
6. **Customization:** Allows developers to define business rules and configurations for project planning.
7. **Performance Optimization:** Optimized for efficient processing and generation of project plans.
8. **Async Generation:** Generates project plans asynchronously, taking input data and generating plans in the background.
9. **Output Formats:** Supports output formats such as email, PowerPoint, and online viewing for project plans.
10. **Transparency and Tracking:** Enhances transparency and tracking of complex orders by communicating important milestones to customers.

**Usage Guidelines:**
- **Authorization:** Access requires valid login permissions.
- **Input and Output Formats:** Input data can be processed to generate project plans in various output formats.
- **Integration:** Integrates with master data, flow trace data, and business processes to generate accurate and informative project plans.


Project Plan Service

Fetches Project plan based on OrderId and provides service for Project Plan

Submit Project Plan

Jeopardy Handling is the process of handling errors / exception occurred during any step / stage of Order Processing within the Order Management system. The Order Management System can encounter errors / exceptions related to systems / services being down or data related issues. The Jeopardy Handling system will handle these errors and allow the users of the Operations team to resubmit the data to finish the Order Processing.

Fallout Management

The Jeopardy API is a crucial component designed to handle errors and exceptions encountered during Order Processing within the Order Management system. It leverages jeopardy rules and an action resolver library to effectively manage and resolve these errors, ensuring smooth and uninterrupted processing of orders.

**Key Responsibilities**:

1.	**Jeopardy Rules Execution**: Calls jeopardy rules and triggers the action resolver library based on rule definitions to resolve jeopardy events.
2.	**Jeopardy Event Handling**: Receives jeopardy events, creates jeopardy projections, and initiates the action resolver process for swift resolution.
3.	**Data Update**: Updates the database with resolved jeopardy actions and maintains data integrity throughout the process.
4.	**Event Management**: Manages jeopardy events through RESTful API endpoints, facilitating real-time updates and integration with other system components.
5.	**Authorization**: Requires a valid login token for accessing and utilizing the Jeopardy API securely.

**Usage Guidelines**:

-	**Authorization**: Access to the API requires a valid login token with appropriate permissions.
-	**Input Parameters**: Input parameters include error code, application name, and jeopardy error details for precise action resolution.
-	**Integration**: Integrates seamlessly with jeopardy rules, action resolver processes, and system events for real-time updates and resolution.
-	**Customization**: Developers can customize jeopardy handling by defining and updating jeopardy rules and action resolver logic as per business requirements.
-	**Performance**: The API is optimized for real-time updates and efficient processing, ensuring minimal disruption to order processing workflows.


Fallout Service

The Jeopardy Consumer API is a comprehensive set of interfaces designed to handle jeopardy events within the system efficiently. It executes jeopardy rules, recalls and reformulates activities based on defined rules, and triggers action resolver processes to resolve jeopardy issues promptly. This API ensures that jeopardy events are managed effectively, allowing the system to recover from errors and continue with order processing seamlessly.

**Key Responsibilities**:

1.	**Jeopardy Rules Execution**: Calls jeopardy rules and invokes the action resolver library based on rule definitions.
2.	**Jeopardy Event Handling**: Recalls jeopardy rules, reformulates activities, and creates jeopardy projections to address issues.
3.	**Action Resolver Processing**: Triggers action resolver processes to resolve jeopardy events and ensure smooth system operations.
4.	**Event Management**: Manages jeopardy events through RESTful API endpoints, allowing for easy integration with other components.
5.	**Error Resolution**: Takes jeopardy errors as input and resolves actions accordingly to mitigate jeopardy impact.
6.	**Attributes Update**: Updates characteristics, status, and other attributes as part of the jeopardy resolution process.
7.	**Event Actions**: Performs actions such as updating status, re-raising events, and assigning BPMN processes to handle jeopardy cases effectively.
8.	**Authorization**: Requires a valid login token for accessing and utilizing the Jeopardy Consumer API securely.

**Usage Guidelines**:

-	**Authorization**: Access to the API requires valid login credentials and appropriate permissions.
-	**Input Parameters**: Input parameters include error code, application name, and jeopardy error details.
-	**Integration**: Integrates seamlessly with jeopardy rules, action resolver processes, and system components to resolve jeopardy events efficiently.
-	**Customization**: Developers can customize jeopardy handling by defining and updating jeopardy rules, actions, and resolutions.


Jeopardy Consumer

The Holiday Service API provides functionality related to holiday calendars, allowing users to manage, retrieve, and interact with holiday data for various organizations and regions. It categorizes holidays based on different criteria, such as national holidays, religious holidays, or observances, providing accurate and up-to-date holiday information for applications and systems.

**Key Responsibilities**:

1.	**Master Data Configuration**: Defines holiday calendars based on organization, country, holiday type, day off, and region, ensuring accuracy and relevance.
2.	**End Date Calculation**: Calculates end dates by adding Turnaround Time (TAT), considering weekend offs, and accounting for regional holidays within specified regions.
3.	**ISO 8601 Duration Format**: Accepts duration input in ISO 8601 format (<PnYnMnDTnHnMnS>), allowing precise calculation of end dates based on years, months, days, hours, minutes, and seconds.
4.	**Holiday Inclusion in TAT**: Captures all holidays and incorporates them into TAT calculations to determine end dates accurately.
5.	**REST API Integration**: Accesses the Holiday Service API functionalities via REST API for seamless integration and usage.
6.	**Authorization**: Requires a valid login token for secure and authorized access to the service.
7.	**Customization**: Developers can define holiday calendars based on specific criteria, enhancing customization and flexibility.

**Usage Guidelines**:

-	**Authorization**: Access requires a valid login token with appropriate permissions.
-	**Customization**: Developers can define holiday calendars and configure parameters such as TAT and holiday types within the API.
-	**Performance**: Optimized for efficient processing of requests, ensuring accurate calculation of end dates based on holiday calendars and TAT.

**Example Usage**:

- Developers can define holiday calendars using master data configuration, specifying holiday types, day-offs, and regions, and utilize the API to calculate end dates for tasks or orders based on defined TAT and holiday considerations.


Holiday Calendar Service

The "Create Holiday Calendar API" is an interface that enables users or systems to programmatically create and customize holiday calendars.

Create Holiday Calendar

The "Create Weekend Calendar API" is an interface designed to allow users or systems to programmatically create and customize weekend calendars.

Create Weekend Calendar

The "Fetch TAT (Turnaround Time) Details API" is an interface designed to retrieve detailed information about turnaround times within a system or application.

Get End Date

The "Fetch Calendar Details API" is an interface designed to retrieve detailed information about a holiday calendar from a system or application.

Get Calendar

The "Delete Calendar API" is an interface designed to allow users or systems to remove a holiday calendar or specific calendar configurations from a system or application.

Delete Calendar

Trouble Ticket Query Application

Order Management

Production

Sandbox

<p class="slate-p" placeholder="Type / for widgets">The Order Management API provides a comprehensive suite of functionalities designed to streamline and automate the order lifecycle for telecom and other industries. This set of APIs enables efficient handling of customer orders from initiation to fulfillment, ensuring accurate execution and real-time updates across various systems. The APIs are built on a microservices architecture, promoting modularity, scalability, and seamless integration with legacy and modern systems.</p><p class="slate-p" placeholder="Type / for widgets"></p><h3 class="slate-h3">Key Features:</h3><ol class="slate-ol"><li class="slate-li"><div style="position:relative"><span style="color:var(--tw-prose-bold)" class="slate-color"><strong style="color:var(--tw-prose-bold)" class="slate-bold">Order Capture</strong></span>: Accepts orders from various channels including web, telemarketing, mobile, in-store, and call centers.</div></li><li class="slate-li"><div style="position:relative"><span style="color:var(--tw-prose-bold)" class="slate-color"><strong style="color:var(--tw-prose-bold)" class="slate-bold">Order Validation</strong></span>: Ensures orders meet predefined criteria before processing, validating against product catalogs and business rules.</div></li><li class="slate-li"><div style="position:relative"><span style="color:var(--tw-prose-bold)" class="slate-color"><strong style="color:var(--tw-prose-bold)" class="slate-bold">Order Decomposition</strong></span>: Breaks down complex customer orders into manageable service and resource components for efficient processing.</div></li><li class="slate-li"><div style="position:relative"><span style="color:var(--tw-prose-bold)" class="slate-color"><strong style="color:var(--tw-prose-bold)" class="slate-bold">Lifecycle Management</strong></span>: Manages the state of orders through stages like new, modify, terminate, suspend, and resume.</div></li><li class="slate-li"><div style="position:relative"><span style="color:var(--tw-prose-bold)" class="slate-color"><strong style="color:var(--tw-prose-bold)" class="slate-bold">Fulfillment and Monitoring</strong></span>: Executes order fulfillment processes and monitors progress to ensure timely and accurate delivery.</div></li><li class="slate-li"><div style="position:relative"><span style="color:var(--tw-prose-bold)" class="slate-color"><strong style="color:var(--tw-prose-bold)" class="slate-bold">Real-Time Updates</strong></span>: Provides real-time status updates and notifications to keep stakeholders informed throughout the order lifecycle.</div></li><li class="slate-li"><div style="position:relative"><span style="color:var(--tw-prose-bold)" class="slate-color"><strong style="color:var(--tw-prose-bold)" class="slate-bold">Seamless Integration</strong></span>: Connects with external systems and services through standardized APIs, ensuring smooth data flow and interoperability.</div></li><li class="slate-li"><div style="position:relative"><span style="color:var(--tw-prose-bold)" class="slate-color"><strong style="color:var(--tw-prose-bold)" class="slate-bold">Catalog-Driven Processes</strong></span>: Leverages a comprehensive product catalog to drive order configurations, pricing, and validation.</div></li></ol><p class="slate-p" placeholder="Type / for widgets"></p><h3 class="slate-h3">Benefits:</h3><ul class="slate-ul"><li class="slate-li"><div style="position:relative"><span style="color:var(--tw-prose-bold)" class="slate-color"><strong style="color:var(--tw-prose-bold)" class="slate-bold">Efficiency</strong></span>: Automates repetitive tasks and streamlines order processing to reduce manual effort and errors.</div></li><li class="slate-li"><div style="position:relative"><span style="color:var(--tw-prose-bold)" class="slate-color"><strong style="color:var(--tw-prose-bold)" class="slate-bold">Accuracy</strong></span>: Ensures high order accuracy through stringent validation and decomposition processes.</div></li><li class="slate-li"><div style="position:relative"><span style="color:var(--tw-prose-bold)" class="slate-color"><strong style="color:var(--tw-prose-bold)" class="slate-bold">Customer Satisfaction</strong></span>: Enhances customer experience by providing timely and transparent order updates.</div></li><li class="slate-li"><div style="position:relative"><span style="color:var(--tw-prose-bold)" class="slate-color"><strong style="color:var(--tw-prose-bold)" class="slate-bold">Scalability</strong></span>: Supports high volumes of orders with a scalable microservices architecture.</div></li><li class="slate-li"><div style="position:relative"><span style="color:var(--tw-prose-bold)" class="slate-color"><strong style="color:var(--tw-prose-bold)" class="slate-bold">Flexibility</strong></span>: Adapts to various business models and order scenarios with customizable workflows and business rules.</div></li><li class="slate-li"><div style="position:relative"><span style="color:var(--tw-prose-bold)" class="slate-color"><strong style="color:var(--tw-prose-bold)" class="slate-bold">Integration</strong></span>: Easily integrates with legacy systems, third-party applications, and modern IT infrastructure.</div></li></ul><p class="slate-p" placeholder="Type / for widgets"></p><h3 class="slate-h3">API Overview </h3><p class="slate-p" placeholder="Type / for widgets">The Order Management API supports various operations to manage the order lifecycle effectively. Key operations include:</p><ul class="slate-ul"><li class="slate-li"><div style="position:relative"><strong class="slate-bold">Create Order (POST)</strong>: Initiates a new order with customer details and product configurations.</div></li><li class="slate-li"><div style="position:relative"><strong class="slate-bold">Update Order (PATCH)</strong>: Modifies existing partial or specific section in orders based on customer requests or business needs.</div></li><li class="slate-li"><div style="position:relative"><strong class="slate-bold">Update Order (PUT)</strong>: Modifies existing full orders based on customer requests or business needs.</div></li><li class="slate-li"><div style="position:relative"><strong class="slate-bold">Retrieve Order (GET)</strong>: Fetches order details, including status and history, for tracking and monitoring.</div></li><li class="slate-li"><div style="position:relative"><strong class="slate-bold">Delete Order (DELETE)</strong>: Cancels an order that is no longer required, updating all relevant systems.</div></li></ul><p class="slate-p" placeholder="Type / for widgets"></p><h3 class="slate-h3">Getting Started:</h3><p class="slate-p" placeholder="Type / for widgets">To start using the Order Management API, follow these steps:</p><ol class="slate-ol"><li class="slate-li"><div style="position:relative"><a href="https://developers.bluemarble.comviva.com/commerce-journey/introduction-overview/authentication-and-authorization-1" target="_self">Authentication</a>: Obtain an API key or access token for secure access.</div></li><li class="slate-li"><div style="position:relative"><span style="color:var(--tw-prose-bold)" class="slate-color"><strong style="color:var(--tw-prose-bold)" class="slate-bold">API Endpoints</strong></span>: Use the provided endpoints to interact with the API for various order management operations.</div></li><li class="slate-li"><div style="position:relative"><span style="color:var(--tw-prose-bold)" class="slate-color"><strong style="color:var(--tw-prose-bold)" class="slate-bold">Request and Response Formats</strong></span>: Follow the standard request and response formats, typically JSON, for seamless integration.</div></li><li class="slate-li"><div style="position:relative"><span style="color:var(--tw-prose-bold)" class="slate-color"><strong style="color:var(--tw-prose-bold)" class="slate-bold">Error Handling</strong></span>: Implement error handling mechanisms to manage API responses and exceptions effectively.</div></li></ol><p class="slate-p" placeholder="Type / for widgets">For detailed information on each endpoint, including parameters, request and response examples, and error codes, refer to the specific sections in this documentation.</p><p class="slate-p" placeholder="Type / for widgets">

</p><p class="slate-p" placeholder="Type / for widgets"></p>

The Order Management API provides a comprehensive suite of functionalities designed to streamline and automate the order lifecycle for telecom and other industries. This set of APIs enables efficient handling of customer orders from initiation to fulfillment, ensuring accurate execution and real-time updates across various systems. The APIs are built on a microservices architecture, promoting modularity, scalability, and seamless integration with legacy and modern systems.

The Order Management API supports various operations to manage the order lifecycle effectively. Key operations include:

To start using the Order Management API, follow these steps:

For detailed information on each endpoint, including parameters, request and response examples, and error codes, refer to the specific sections in this documentation.

<p class="slate-p " >The Customer Product Order API enables customers and API integrators to manage product orders seamlessly across various channels including web, telecom, and in-store. It facilitates the acceptance, validation, and initiation of orders for decomposition, supporting a wide range of order scenarios such as new orders, modifications (amendments), terminations, cancellations, suspensions, and resumptions.
The Product Ordering API provides a standardized mechanism for placing a product order with all of the necessary order parameters. The API consists of a simple set of operations that interact with CRM/Order Negotiation systems in a consistent manner. A product order is created based on a product offer that is defined in a catalog. The product offer identifies the product or set of products that are available to a customer, and includes characteristics such as pricing, product options and market. This API provide a task based resource to request order cancellation.
The product order references the product offer and identifies any specific requests made by the customer.
Product Order resource 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 and vice versa. Main Product Order attributes are its identifier, state, priority category (mass market, Enterprise, etc.) related dates (start, completion, etc.), related billing account, related parties and order items. Main Order Items (aka order lines) attributes are the ordered offering and product characteristics with the related action to be performed (e.g. add or delete the products), state, location information for delivery, order item price and price alteration.</p><p class="slate-p " ><strong class="slate-bold">Product Order API performs the following operations on product order</strong> :</p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Retrieval of a product order or a collection of product orders depending on filter criteria -Partial update of a product order (including updating rules)</div></li><li class="slate-li " ><div style="position:relative">Creation of a product order (including default values and creation rules)</div></li><li class="slate-li " ><div style="position:relative">Deletion of product order (for administration purposes) -Notification of events on product order.</div></li></ul><p class="slate-p " ><strong class="slate-bold">Cancel Product Order </strong></p><p class="slate-p " >     This resource is used to request a product order cancellation. </p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Retrieval of a cancel product order or a collection of cancel product orders</div></li><li class="slate-li " ><div style="position:relative">Creation of a cancel product order -Notification of events on cancel product order.</div></li></ul><p class="slate-p " ><strong class="slate-bold">Key Features</strong>:</p><ol class="slate-ol " ><li class="slate-li " ><div style="position:relative">**Acceptance and Validation: The API allows for the acceptance and validation of orders against catalog offers, ensuring accuracy and compliance with business rules.</div></li><li class="slate-li " ><div style="position:relative">**Order Decomposition: Orders can be initiated for decomposition, streamlining the process for further processing and fulfillment.</div></li><li class="slate-li " ><div style="position:relative">**Order Scenarios: Handles diverse order scenarios including new orders, modifications, terminations, cancellations, suspensions, and resumptions, catering to various customer needs and requests.</div></li><li class="slate-li " ><div style="position:relative">**Data Structure: Utilizes the TMF622 data model for structured order entry and management, enhancing data consistency and interoperability.</div></li><li class="slate-li " ><div style="position:relative">**Order State Management: Manages order states based on order progress, providing visibility and control throughout the order lifecycle.</div></li></ol><p class="slate-p " ><strong class="slate-bold">Usage Guidelines</strong>:</p><p class="slate-p " ><strong class="slate-bold">Authorization</strong>: Access to the API requires a JWT token with appropriate permissions, including the ability to manage orders and access catalog data.
<strong class="slate-bold">Customization</strong>: Developers can define business rules within the API for order validation, credit checks, and other customizations, influencing the API&apos;s response and behavior.
<strong class="slate-bold">Integration</strong>: Seamlessly integrates with external systems as part of the business fulfillment plan, supporting portfolio ID generation and external validations.
<strong class="slate-bold">Performance</strong>: The API is optimized for performance, ensuring efficient processing of orders and delivering a seamless user experience across channels.</p><p class="slate-p " ></p><p class="slate-p " ></p>

The Customer Product Order API enables customers and API integrators to manage product orders seamlessly across various channels including web, telecom, and in-store. It facilitates the acceptance, validation, and initiation of orders for decomposition, supporting a wide range of order scenarios such as new orders, modifications (amendments), terminations, cancellations, suspensions, and resumptions.
The Product Ordering API provides a standardized mechanism for placing a product order with all of the necessary order parameters. The API consists of a simple set of operations that interact with CRM/Order Negotiation systems in a consistent manner. A product order is created based on a product offer that is defined in a catalog. The product offer identifies the product or set of products that are available to a customer, and includes characteristics such as pricing, product options and market. This API provide a task based resource to request order cancellation.
The product order references the product offer and identifies any specific requests made by the customer.
Product Order resource 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 and vice versa. Main Product Order attributes are its identifier, state, priority category (mass market, Enterprise, etc.) related dates (start, completion, etc.), related billing account, related parties and order items. Main Order Items (aka order lines) attributes are the ordered offering and product characteristics with the related action to be performed (e.g. add or delete the products), state, location information for delivery, order item price and price alteration.

Product Order API performs the following operations on product order

     This resource is used to request a product order cancellation. 

: Access to the API requires a JWT token with appropriate permissions, including the ability to manage orders and access catalog data.


: Developers can define business rules within the API for order validation, credit checks, and other customizations, influencing the API's response and behavior.


: Seamlessly integrates with external systems as part of the business fulfillment plan, supporting portfolio ID generation and external validations.


: The API is optimized for performance, ensuring efficient processing of orders and delivering a seamless user experience across channels.

<p class="slate-p " ></p><p class="slate-p " >Submit Customer Order refers to the process where a customer&apos;s request for a product is formally placed into the Order Management System. This action triggers the Order created event which initiate the order validation process to ensure the order is processed efficiently and accurately according to the specified requirements.

<strong class="slate-bold">Customer Order API performs the following operations on product order</strong> :</p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Create Customer Order</div></li><li class="slate-li " ><div style="position:relative">Update Customer Order</div></li><li class="slate-li " ><div style="position:relative">Update Item</div></li></ul><p class="slate-p " ></p><p class="slate-p " ></p>

Submit Customer Order refers to the process where a customer's request for a product is formally placed into the Order Management System. This action triggers the Order created event which initiate the order validation process to ensure the order is processed efficiently and accurately according to the specified requirements.



Customer Order API performs the following operations on product order

<p class="slate-p " >This operation fully updates a customer order entity using the PUT operation. Initiated from the Order Management UI, it modifies the customer order. Once the customer order is updated in the database, it generates an event for status updates. This operation is also invoked during the AMENDMENT process.

</p><div class="slate-div"></div><p class="slate-p " ></p><p class="slate-p " ></p><div class="slate-div"></div><p class="slate-p " ></p><p class="slate-p " ></p>

This operation fully updates a customer order entity using the PUT operation. Initiated from the Order Management UI, it modifies the customer order. Once the customer order is updated in the database, it generates an event for status updates. This operation is also invoked during the AMENDMENT process.



Update Product Order

A string.The unique identifier associated with a Customer Purchase Order (CPO)

cpoId

A date tme (DateTime). Date when the product order was cancelled.

cancellationDate

CancellationReason is the specific explanation for the cancellation of a ProductOrderRequest

cancellationReason

A date time (DateTime). Effective delivery date amended by the provider.

completionDate

expectedCompletionDate typically represents the anticipated date for Request completion

expectedCompletionDate

A string. Contact attached to the order to send back information regarding this
order.

notificationContact

orderDate represents the timestamp when the order was placed for products

orderDate

A date time (DateTime). Requested delivery date from the requestors perspective.

requestedCompletionDate

A date time (DateTime). the preferred initiation date for a requested productOrder

requestedStartDate

A date time (DateTime).The date on which the ordered product was actually initiated or commenced 

actualStartDate

A product order state type (ProductOrderStateType). State of the order: described in
the state-machine diagram.

state

Status represents the current stage of a requested productOrder.

status

A list of related parties. Related Entity reference A related party defines party or party role linked to a specific entity.

relatedParty

href

A string. ID given by the consumer to facilitate searches

externalId

A string.Description is a narrative text describing the content of the ProductOrderRequest

description

A string. Used to categorize the order, useful for the OM system, such as:
Broadband, TVOption.

createdBy

 The date and time when the ProductOrderRequest was initially created

createdDateTime

LastModifiedBy indicates the entity who made last modifications to the ProductOrder

lastModifiedBy

LastModifiedDateTime indicates the date and time when the ProductOrderRequest was last modified

lastModifiedDateTime

offerContainers

portfolioContainers

This is signature field generated for individual promotion that can be applied in cart for individual offer container

signature

 A unique identifier for the original order that forms the basis for subsequent amendments

baseProductOrderId

Identifier assigned to a request for amending or modifying a specific product order

amendProductOrderId

orderType

A string.OrderId is a unique identifier assigned to a specific  ProductOrder

A list of quote references,It's a Quote that has been executed previously.

quote

A list of agreement references (AgreementRef [*]). A reference to an agreement defined in the context of the product order.

agreement

A list of related channels (RelatedChannel [*]). Related channel to another entity. May be online web, mobile app, social ,etc.

channel

A list of notes (Note [*]). Extra information about a given entity.

note

A list of payment referencesIf an immediate payment has been done at the product order submission, the payment information are captured and stored in the order.

payment

A list of product order items (ProductOrderItem [1..*]). An identified part of the order. A product order is decomposed into one or more order items.

productOrderItem

A list of order prices. An amount, usually of money, that represents the actual price paid by the Customer for this item or this order.

orderTotalPrice

A list of product offering qualification references  It's a productOfferingQualification that has been executed previously.

productOfferingQualification

The account of the customer who has placed the order for a product

customerAccount

A billing account reference (BillingAccountRef). A BillingAccount is a detailed description of a bill structure.

billingAccount

billingAccountList

OrderAmendmentFlag indicates whether any modifications or changes have been applied to the original order

isAmendOrder

Boolean value true to  notify whether order is amend with cancel or not by default false.

isAmendOrderWithCancel

ValidatedPOQFlag is an indicator signaling the validation status of a Purchase Order Quantity (POQ) within a process

isValidatedPOQ

A distinct identifier linked to orders from external sources, facilitating tracking and integration

externalOrderReferenceNumber

ExternalOrderId is a unique identifier assigned to orders from external sources for effective tracking and management

externalOrderId

This is the market segment(s) for which this particular metaExtension will be applicable

marketSegment

 List of Characteristics Additional attributes

additionalAttributes

list of promotions to store instances of the Promotion

promotions

List of the Non recurring price adjustment.

nonRecurringPriceAdjustment

customerOrderType for B2B or B2C indentification

customerOrderType

The jeopardyFlag is a boolean indicator used to signal and handle critical situations in the ProductOrderRequest

jeopardyFlag

Visible Flag refers to the visibility status of an element or feature in the ProductOrderRequest

visibleFlag

Large Order flag decide if Order is large Order and it has more Line Items that predefined number of line items

isLargeOrder

A string.OrderId is a unique identifier assigned to a specific  for Parent Order Id for Large Order

parentOrderId

A string.The unique identifier associated with a Customer Purchase Order (CPO) for Parent Order Id for Large Order

parentCpoId

list of subOrders MetaData for large Order

Sections