Introduction
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.
Key Features:
- Order Capture: Accepts orders from various channels including web, telemarketing, mobile, in-store, and call centers.
- Order Validation: Ensures orders meet predefined criteria before processing, validating against product catalogs and business rules.
- Order Decomposition: Breaks down complex customer orders into manageable service and resource components for efficient processing.
- Lifecycle Management: Manages the state of orders through stages like new, modify, terminate, suspend, and resume.
- Fulfillment and Monitoring: Executes order fulfillment processes and monitors progress to ensure timely and accurate delivery.
- Real-Time Updates: Provides real-time status updates and notifications to keep stakeholders informed throughout the order lifecycle.
- Seamless Integration: Connects with external systems and services through standardized APIs, ensuring smooth data flow and interoperability.
- Catalog-Driven Processes: Leverages a comprehensive product catalog to drive order configurations, pricing, and validation.
Benefits:
- Efficiency: Automates repetitive tasks and streamlines order processing to reduce manual effort and errors.
- Accuracy: Ensures high order accuracy through stringent validation and decomposition processes.
- Customer Satisfaction: Enhances customer experience by providing timely and transparent order updates.
- Scalability: Supports high volumes of orders with a scalable microservices architecture.
- Flexibility: Adapts to various business models and order scenarios with customizable workflows and business rules.
- Integration: Easily integrates with legacy systems, third-party applications, and modern IT infrastructure.
API Overview
The Order Management API supports various operations to manage the order lifecycle effectively. Key operations include:
- Create Order (POST): Initiates a new order with customer details and product configurations.
- Update Order (PATCH): Modifies existing partial or specific section in orders based on customer requests or business needs.
- Update Order (PUT): Modifies existing full orders based on customer requests or business needs.
- Retrieve Order (GET): Fetches order details, including status and history, for tracking and monitoring.
- Delete Order (DELETE): Cancels an order that is no longer required, updating all relevant systems.
Getting Started:
To start using the Order Management API, follow these steps:
- Authentication: Obtain an API key or access token for secure access.
- API Endpoints: Use the provided endpoints to interact with the API for various order management operations.
- Request and Response Formats: Follow the standard request and response formats, typically JSON, for seamless integration.
- Error Handling: Implement error handling mechanisms to manage API responses and exceptions effectively.
For detailed information on each endpoint, including parameters, request and response examples, and error codes, refer to the specific sections in this documentation.
What made this section unhelpful for you?
Customer Order
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.
Cancel Product Order
This resource is used to request a product order cancellation.
- 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:
- **Acceptance and Validation: The API allows for the acceptance and validation of orders against catalog offers, ensuring accuracy and compliance with business rules.
- **Order Decomposition: Orders can be initiated for decomposition, streamlining the process for further processing and fulfillment.
- **Order Scenarios: Handles diverse order scenarios including new orders, modifications, terminations, cancellations, suspensions, and resumptions, catering to various customer needs and requests.
- **Data Structure: Utilizes the TMF622 data model for structured order entry and management, enhancing data consistency and interoperability.
- **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.
What made this section unhelpful for you?
Base URL
Production:
https://int-spring25.comviva.com/
https://int-spring25.comviva.com/OrderGenerator/v4
https://int-spring25.comviva.com/customerOrder/management/v4
https://int-spring25.comviva.com/serviceOrdering/management/v4
https://int-spring25.comviva.com/om-som-adapter/v4
https://int-spring25.comviva.com/productInventory/management/v4
https://int-spring25.comviva.com/serviceInventory/management/v4
https://int-spring25.comviva.com/task-management/v4
https://int-spring25.comviva.com/troubleTicket/query/v4
https://int-spring25.comviva.com/rules/v4
https://int-spring25.comviva.com/communicationManagement/v4
https://int-spring25.comviva.com/project-plan/v4
https://int-spring25.comviva.com/jeopardyApi/v4
https://int-spring25.comviva.com/holidayService/v4
Sandbox:
https://int-spring25.comviva.com/
What made this section unhelpful for you?
Submit Order
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 :
- Create Customer Order
- Update Customer Order
- Update Item
What made this section unhelpful for you?
Update Product Order
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.
Header Parameters
Unique identifier for tracking the transaction.
Identifier for correlating related requests and responses.
Source channel or origin of the request.
Identifier of the associated tenant or customer.
Path Parameters
Uniquely Identifier ID
Body Parameters
A string.The unique identifier associated with a Customer Purchase Order (CPO)
A date tme (DateTime). Date when the product order was cancelled.
CancellationReason is the specific explanation for the cancellation of a ProductOrderRequest
A date time (DateTime). Effective delivery date amended by the provider.
expectedCompletionDate typically represents the anticipated date for Request completion
A string. Contact attached to the order to send back information regarding this order.
orderDate represents the timestamp when the order was placed for products
A date time (DateTime). Requested delivery date from the requestors perspective.
A date time (DateTime). the preferred initiation date for a requested productOrder
A date time (DateTime).The date on which the ordered product was actually initiated or commenced
A product order state type (ProductOrderStateType). State of the order: described in the state-machine diagram.
ACKNOWLEDGEDREJECTEDPENDINGHELDIN_PROGRESSCONFIRMEDCANCELLEDACTIVECOMPLETEDFAILED... 5 other enums
Status represents the current stage of a requested productOrder.
A list of related parties. Related Entity reference A related party defines party or party role linked to a specific entity.
Show child attributes
A string. Hyperlink to access the order
A string. ID given by the consumer to facilitate searches
A string.Description is a narrative text describing the content of the ProductOrderRequest
A string. Used to categorize the order, useful for the OM system, such as: Broadband, TVOption.
CreatedBy identifies the entity responsible for creating the ProductOrderRequest
The date and time when the ProductOrderRequest was initially created
LastModifiedBy indicates the entity who made last modifications to the ProductOrder
LastModifiedDateTime indicates the date and time when the ProductOrderRequest was last modified
List of Offer Container details
Show child attributes
List of Portfolio Container details
Show child attributes
This is signature field generated for individual promotion that can be applied in cart for individual offer container
Show child attributes
A unique identifier for the original order that forms the basis for subsequent amendments
Identifier assigned to a request for amending or modifying a specific product order
Type or category of the order.
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.
Show child attributes
A list of agreement references (AgreementRef [*]). A reference to an agreement defined in the context of the product order.
Show child attributes
A list of related channels (RelatedChannel [*]). Related channel to another entity. May be online web, mobile app, social ,etc.
Show child attributes
A list of notes (Note [*]). Extra information about a given entity.
Show child attributes
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.
Show child attributes
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.
Show child attributes
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.
Show child attributes
A list of product offering qualification references It's a productOfferingQualification that has been executed previously.
Show child attributes
The account of the customer who has placed the order for a product
Show child attributes
A billing account reference (BillingAccountRef). A BillingAccount is a detailed description of a bill structure.
Show child attributes
A billing account reference (BillingAccountRef). A BillingAccount is a detailed description of a bill structure.
Show child attributes
OrderAmendmentFlag indicates whether any modifications or changes have been applied to the original order
Boolean value true to notify whether order is amend with cancel or not by default false.
ValidatedPOQFlag is an indicator signaling the validation status of a Purchase Order Quantity (POQ) within a process
A distinct identifier linked to orders from external sources, facilitating tracking and integration
ExternalOrderId is a unique identifier assigned to orders from external sources for effective tracking and management
This is the market segment(s) for which this particular metaExtension will be applicable
Show child attributes
List of Characteristics Additional attributes
Show child attributes
list of promotions to store instances of the Promotion
Show child attributes
List of the Non recurring price adjustment.
Show child attributes
customerOrderType for B2B or B2C indentification
The jeopardyFlag is a boolean indicator used to signal and handle critical situations in the ProductOrderRequest
Visible Flag refers to the visibility status of an element or feature in the ProductOrderRequest
Large Order flag decide if Order is large Order and it has more Line Items that predefined number of line items
A string.OrderId is a unique identifier assigned to a specific for Parent Order Id for Large Order
A string.The unique identifier associated with a Customer Purchase Order (CPO) for Parent Order Id for Large Order
list of subOrders MetaData for large Order
Show child attributes
priority indicates request in which should be addressed for escalation, with values such as High,Medium, or Low
A string.processingPriority indicates request in which productOrder should be addressed, with values such as High,Medium, or Low
A List of module vs topic name mapping for priority processing
Show child attributes
The portabilityOrder attribute is an essential tool for maintaining a structured and organized approach to portability.
Response
Response Attributes
A string.The unique identifier associated with a Customer Purchase Order (CPO)
A date time (DateTime). Date when the product order was cancelled.
CancellationReason is the specific explanation for the cancellation of a ProductOrderRequest
A date time (DateTime). Effective delivery date amended by the provider.
expectedCompletionDate typically represents the anticipated date for Request completion
A string. Contact attached to the order to send back information regarding this order.
orderDate represents the timestamp when the order was placed for products
A date time (DateTime). Requested delivery date from the requestors perspective.
A date time (DateTime). the preferred initiation date for a requested productOrder
A date time (DateTime).The date on which the ordered product was actually initiated or commenced
A product order state type (ProductOrderStateType). State of the order: described in the state-machine diagram.
ACKNOWLEDGEDREJECTEDPENDINGHELDIN_PROGRESSCONFIRMEDCANCELLEDACTIVECOMPLETEDFAILED... 5 other enums
Status represents the current stage of a requested productOrder.
A list of related parties. Related Entity reference A related party defines party or party role linked to a specific entity.
Show child attributes
A string. Hyperlink to access the order
A string. ID given by the consumer to facilitate searches
A string.Description is a narrative text describing the content of the ProductOrderRequest
A string. Used to categorize the order, useful for the OM system, such as: Broadband, TVOption.
CreatedBy identifies the entity responsible for creating the ProductOrderRequest
The date and time when the ProductOrderRequest was initially created
LastModifiedBy indicates the entity who made last modifications to the ProductOrder
LastModifiedDateTime indicates the date and time when the ProductOrderRequest was last modified
List of Offer Container details
Show child attributes
List of Portfolio Container details
Show child attributes
This is signature field generated for individual promotion that can be applied in cart for individual offer container
Show child attributes
A unique identifier for the original order that forms the basis for subsequent amendments
Identifier assigned to a request for amending or modifying a specific product order
Type or category of the order.
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.
Show child attributes
A list of agreement references (AgreementRef [*]). A reference to an agreement defined in the context of the product order.
Show child attributes
A list of related channels (RelatedChannel [*]). Related channel to another entity. May be online web, mobile app, social ,etc.
Show child attributes
A list of notes (Note [*]). Extra information about a given entity.
Show child attributes
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.
Show child attributes
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.
Show child attributes
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.
Show child attributes
A list of product offering qualification references It's a productOfferingQualification that has been executed previously.
Show child attributes
The account of the customer who has placed the order for a product
Show child attributes
A billing account reference (BillingAccountRef). A BillingAccount is a detailed description of a bill structure.
Show child attributes
A billing account reference (BillingAccountRef). A BillingAccount is a detailed description of a bill structure.
Show child attributes
OrderAmendmentFlag indicates whether any modifications or changes have been applied to the original order
Boolean value true to notify whether order is amend with cancel or not by default false.
ValidatedPOQFlag is an indicator signaling the validation status of a Purchase Order Quantity (POQ) within a process
A distinct identifier linked to orders from external sources, facilitating tracking and integration
ExternalOrderId is a unique identifier assigned to orders from external sources for effective tracking and management
This is the market segment(s) for which this particular metaExtension will be applicable
Show child attributes
List of Characteristics Additional attributes
Show child attributes
list of promotions to store instances of the Promotion
Show child attributes
List of the Non recurring price adjustment.
Show child attributes
customerOrderType for B2B or B2C indentification
The jeopardyFlag is a boolean indicator used to signal and handle critical situations in the ProductOrderRequest
Visible Flag refers to the visibility status of an element or feature in the ProductOrderRequest
Large Order flag decide if Order is large Order and it has more Line Items that predefined number of line items
A string.OrderId is a unique identifier assigned to a specific for Parent Order Id for Large Order
A string.The unique identifier associated with a Customer Purchase Order (CPO) for Parent Order Id for Large Order
list of subOrders MetaData for large Order
Show child attributes
priority indicates request in which should be addressed for escalation, with values such as High,Medium, or Low
A string.processingPriority indicates request in which productOrder should be addressed, with values such as High,Medium, or Low
A List of module vs topic name mapping for priority processing
Show child attributes
The portabilityOrder attribute is an essential tool for maintaining a structured and organized approach to portability.
Response Attributes
A Date,Error creation date and time
A String,A error code provides specific error code which occurred
A error,A error reason provides the specific reason why error occurred
Error message,A error message provides the specific message which occurred
Error stacktrace,A error stacktrace provides the stacktrace for error occurred
Response Attributes
A Date,Error creation date and time
A String,A error code provides specific error code which occurred
A error,A error reason provides the specific reason why error occurred
Error message,A error message provides the specific message which occurred
Error stacktrace,A error stacktrace provides the stacktrace for error occurred
Response Attributes
A Date,Error creation date and time
A String,A error code provides specific error code which occurred
A error,A error reason provides the specific reason why error occurred
Error message,A error message provides the specific message which occurred
Error stacktrace,A error stacktrace provides the stacktrace for error occurred
Response Attributes
A Date,Error creation date and time
A String,A error code provides specific error code which occurred
A error,A error reason provides the specific reason why error occurred
Error message,A error message provides the specific message which occurred
Error stacktrace,A error stacktrace provides the stacktrace for error occurred
Response Attributes
A numeric or alphanumeric code that represents a specific error or issue encountered during an operation.
A human-readable message that provides additional details about the error. It offers context and information to help users or developers understand what went wrong
A timestamp indicating when the error occurred, typically in a standardized format such as ISO 8601. It helps with debugging and tracking issues over time
An HTTP status code that indicates the outcome of the request or operation. Common examples include 200 (OK), 404 (Not Found), or 500 (Internal Server Error).
The URL or endpoint that was accessed when the error occurred. It specifies the location of the request that led to the error.
Response Attributes
A Date,Error creation date and time
A String,A error code provides specific error code which occurred
A error,A error reason provides the specific reason why error occurred
Error message,A error message provides the specific message which occurred
Error stacktrace,A error stacktrace provides the stacktrace for error occurred
Response Attributes
A Date,Error creation date and time
A String,A error code provides specific error code which occurred
A error,A error reason provides the specific reason why error occurred
Error message,A error message provides the specific message which occurred
Error stacktrace,A error stacktrace provides the stacktrace for error occurred
Response Attributes
A Date,Error creation date and time
A String,A error code provides specific error code which occurred
A error,A error reason provides the specific reason why error occurred
Error message,A error message provides the specific message which occurred
Error stacktrace,A error stacktrace provides the stacktrace for error occurred
What made this section unhelpful for you?
Response
{
"cpoId": "CPO2477328421161597NQ575",
"cancellationDate": "2023-10-19T10:42:41.257Z",
"cancellationReason": "Termination",
"completionDate": "2023-10-19T10:42:41.257Z",
"expectedCompletionDate": "2023-10-19T10:42:41.257Z",
"notificationContact": "example.rnp@gmail.com",
"orderDate": "2023-10-19T10:42:41.257Z",
"requestedCompletionDate": "2023-10-19T10:42:41.257Z",
"requestedStartDate": "2023-10-19T10:42:41.257Z",
"actualStartDate": "2023-10-19T10:42:41.257Z",
"state": "FAILED",
"status": "Provisioning - Failed",
"relatedParty": [
{
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account",
"role": "OM_DATA_MANAGER",
"type": "Individual Party",
"baseType": "ProductOfferingPrice",
"referredType": "BillingAccount",
"schemaLocation": "RelatedParty Collection",
"contactMedium": [
{
"baseType": "ProductOfferingPrice",
"type": "Individual Party",
"schemaLocation": "ContactMedium Collection",
"preferred": false,
"mediumType": "url",
"validFor": {
"startDateTime": "2023-08-11T09:17:41.866Z",
"endDateTime": "2023-08-11T09:17:41.866Z"
},
"characteristic": {
"baseType": "ProductOfferingPrice",
"type": "Individual Party",
"schemaLocation": "Contact Characteristics Collection",
"addressId": "#234",
"city": "Bengalore",
"contactType": "phone",
"country": "India",
"emailAddress": "example.@gmail.com",
"faxNumber": "212-111-2222",
"phoneNumber": "9856876322",
"postCode": "560064",
"socialNetworkId": "LinkedIn",
"stateOrProvince": "karnataka",
"street1": "RMZ Galleria",
"street2": "Office Block",
"houseNo": "56"
}
}
]
}
],
"href": "/product-inventory",
"externalId": "881a6d15-bcbe-4372-b48a-41cba29f4806",
"description": "example = find details for product Order Request",
"category": "Broadband",
"createdBy": "intadmin1",
"createdDateTime": "2023-10-19T10:42:41.257Z",
"lastModifiedBy": "intadmin1",
"lastModifiedDateTime": "",
"offerContainers": [
{
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account",
"processContext": "ACQ",
"lineOfBusiness": "mobile",
"category": {
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account",
"version": null
},
"state": "ACKNOWLEDGED",
"status": "Completed",
"productOrderItemsRefs": [
{
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account"
}
],
"externalOfferContainerId": "880",
"externalOfferContainerReferenceNumber": "880A",
"additionalAttributes": [
{
"name": "MSISDN",
"valueType": "String",
"value": "55738231121",
"action": "ADD",
"validationStatus": "PASSED",
"createdBy": "admin",
"lastModifiedBy": "system",
"lastModifiedDateTime": "2023-10-19T10:42:41.257Z",
"createdDateTime": "2023-10-19T10:42:41.257Z",
"enrichmentDetail": {
"description": "Description of character",
"specType": "ServiceSpecification",
"referenceId": "data_service_specification_001",
"valueType": "List",
"minCardinality": null,
"maxCardinality": 1,
"characteristicValues": [
{
"valueType": "String",
"value": "True",
"validFor": {
"startDateTime": "2023-08-11T09:17:41.866Z",
"endDateTime": "2023-08-11T09:17:41.866Z"
},
"default": false,
"rangeInterval": "closedTop",
"regex": null,
"unitOfMeasure": "GB"
}
],
"validFor": {
"startDateTime": "2023-08-11T09:17:41.866Z",
"endDateTime": "2023-08-11T09:17:41.866Z"
},
"format": "String",
"length": 5,
"decimalValue": 0.767,
"tooltipValue": "Additional Information",
"visibleLine": "1",
"unique": false,
"extensible": false,
"configurable": false,
"displaySequence": 1,
"isVisible": false,
"configurationStage": "Product Offer Level",
"regex": "\"expression\": \"^[0-9]{9,13}$\",\n\"message\": \"Please enter a valid phone number\""
},
"errorDetails": [
{
"errorCode": "ERR-BM-OM-OV-OE-101",
"errorMessage": "Exception in Order Enrichment Process, Product Inventory Not Present"
}
],
"dynamicAttributes": [
{
"attributeName": "Data Throttling",
"attributeValue": "55738231121",
"attributeType": "String",
"lastModifiedDateTime": "2023-10-19T10:42:41.257Z",
"lastModifiedBy": "omui admin"
}
],
"isNetworkImpacting": false,
"isCharacteristicAmended": false
}
],
"promotions": [
{
"category": "Managed SDWAN Service",
"id": "automation_promotion-pm_20eewvb",
"internalLifecycleStatus": "Test",
"description": "Promotion",
"lifeCycleStatus": "Test",
"name": "Automation_Promotion_678new",
"priority": 2,
"promoApplicationLevel": "cart",
"signature": "cartSignature",
"type": "Promotion",
"promotionAction": {
"actionCardinality": null,
"actionObjectId": "bm-samsung-product-bundle",
"actionType": "Add Product",
"actionValue": 2,
"applicationDuration": 1,
"cartItemId": "5432373c-6f65-46f8-a8b5-879a8df5b576",
"id": "pa_j6w82",
"maxActionValue": "3",
"priceId": "op_0nwf2jj",
"priceType": "recurring",
"priority": 4,
"recurringChargePeriodType": "Month"
},
"promotionClassification": "exclusive",
"coupon": {
"id": "54765",
"code": "MY_COUPON_CODE",
"coupon": false
},
"validFor": {
"startDateTime": "2023-08-11T09:17:41.866Z",
"endDateTime": "2023-08-11T09:17:41.866Z"
}
}
],
"offerContainerTotalPrice": [
{
"description": "Order Price Details",
"name": "robin_rf",
"recurringChargePeriod": "Monthly",
"priceType": "recurring",
"recurringChargePeriodLength": 1,
"offset": 3,
"tax": [
{
"taxType": "GST",
"externalID": "464bf14d-7373-4937-a73b-28217ac07528",
"id": "tax_automationtest-tx_bv8y95w",
"validFor": {
"startDateTime": "2023-08-11T09:17:41.866Z",
"endDateTime": "2023-08-11T09:17:41.866Z"
},
"@baseType": "Tax",
"@type": "Individual Type",
"taxAmount": {
"unit": "inr",
"value": 1000
},
"taxCategory": "Indian",
"taxRate": 20,
"name": "Tax_Automationtest",
"displayName": "Tax details",
"definesExemption": false,
"additionalAttributes": [
{
"name": "MSISDN",
"valueType": "String",
"value": "55738231121",
"action": "ADD",
"validationStatus": "PASSED",
"createdBy": "admin",
"lastModifiedBy": "system",
"lastModifiedDateTime": "2023-10-19T10:42:41.257Z",
"createdDateTime": "2023-10-19T10:42:41.257Z",
"enrichmentDetail": {
"description": "Description of character",
"specType": "ServiceSpecification",
"referenceId": "data_service_specification_001",
"valueType": "List",
"minCardinality": null,
"maxCardinality": 1,
"characteristicValues": [],
"validFor": {},
"format": "String",
"length": 5,
"decimalValue": 0.767,
"tooltipValue": "Additional Information",
"visibleLine": "1",
"unique": false,
"extensible": false,
"configurable": false,
"displaySequence": 1,
"isVisible": false,
"configurationStage": "Product Offer Level",
"regex": "\"expression\": \"^[0-9]{9,13}$\",\n\"message\": \"Please enter a valid phone number\""
},
"errorDetails": [
""
],
"dynamicAttributes": [
""
],
"isNetworkImpacting": false,
"isCharacteristicAmended": false
}
]
}
],
"priceId": "op_0nwf2jj",
"priceSubType": "recurring",
"unitOfMeasure": "INR",
"@baseType": "OrderPrice",
"@schemaLocation": "OrderPrice Collection",
"price": {
"percentage": 10,
"taxRate": 10,
"actionCardinality": 10,
"taxAmount": 10,
"@baseType": "Price",
"@type": "Price",
"dutyFreeAmount": {
"unit": "inr",
"value": 1000
},
"taxIncludedAmount": {
"unit": "inr",
"value": 1000
},
"@schemaLocation": "Price Collection",
"dutyFreeAlteredAmount": {
"unit": "inr",
"value": 1000
},
"taxIncludedAlteredAmount": {
"unit": "inr",
"value": 1000
},
"changeAmount": {
"unit": "inr",
"value": 1000
},
"discount": {
"unit": "inr",
"value": 1000
},
"amountPayable": {
"unit": "inr",
"value": 1000
},
"taxFixed": {
"unit": "inr",
"value": 1000
}
},
"@type": "OrderPrice",
"priceAlteration": [
{
"applicationDuration": 3,
"description": "Price Alteration Details",
"name": "ServiceOrder",
"priceAlterationType": "Discount",
"priceType": "recurring",
"priority": 2,
"recurringChargePeriod": "Month",
"referenceId": "data_service_specification_001",
"unitOfMeasure": "INR",
"@baseType": "PriceAlteration",
"@schemaLocation": "PriceAlteration Collection",
"@type": "recurring",
"price": {
"percentage": 10,
"taxRate": 10,
"actionCardinality": 10,
"taxAmount": 10,
"@baseType": "Price",
"@type": "Price",
"dutyFreeAmount": {
"unit": "inr",
"value": 1000
},
"taxIncludedAmount": {
"unit": "inr",
"value": 1000
},
"@schemaLocation": "Price Collection",
"dutyFreeAlteredAmount": {
"unit": "inr",
"value": 1000
},
"taxIncludedAlteredAmount": {
"unit": "inr",
"value": 1000
},
"changeAmount": {
"unit": "inr",
"value": 1000
},
"discount": {
"unit": "inr",
"value": 1000
},
"amountPayable": {
"unit": "inr",
"value": 1000
},
"taxFixed": {
"unit": "inr",
"value": 1000
}
},
"productOfferingPrice": {
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account",
"@baseType": "ProductOfferingPrice",
"@referredType": "ProductOfferingPrice Type",
"@schemaLocation": "ProductOfferingPrice Collection",
"@type": "individual Type"
}
}
],
"productOfferingPrice": {
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account",
"@baseType": "ProductOfferingPrice",
"@referredType": "ProductOfferingPrice Type",
"@schemaLocation": "ProductOfferingPrice Collection",
"@type": "individual Type"
},
"itemPriceRelationship": [
{
"priceId": "P465",
"relationshipType": "FIXED_PRICE"
}
],
"validFor": {
"endDateTime": "2023-10-19T10:42:41.257Z",
"startDateTime": "2023-10-19T10:42:41.257Z"
},
"isDownPaymentRequired": false,
"minimumDownPaymentAmount": null,
"isAgreementBased": false,
"offsetParameter": {
"numberofBlock": 2,
"totalAllowanceSelectionCount": 4,
"isCalenderBased": true,
"discountType": "FIXED_PRICE",
"billingDiscountExternalRef": "BD2024-123456",
"discountValue": 10,
"allowedDiscount": [
{
"block": 1,
"allowedSelectionCount": null,
"allowedSelectionPeriod": "2022-08-08 13:09:00.612Z",
"selectedDiscountPeriod": "2022-08-08 13:09:00.612Z"
}
]
},
"code": "PC_de716bb0",
"externalId": "prepaidplan_a-1_price_2-0_v1||123",
"id": "9a058452-d5c7-4ec2-9f3d-1ecc34d120ee",
"specCharacteristics": [
{
"name": "SMS Allowance",
"value": "50SMS",
"valueType": "String"
}
],
"isProrated": false,
"isArrears": false
}
]
}
],
"portfolioContainers": [
{
"id": "BP11697629618916537",
"name": "",
"productOrderItemsRefs": [
{
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account"
}
],
"sort": 1
}
],
"signature": {
"context": "174be0d306a3bab87c1266f4b4d1f534c5a302aedda36ff0f64d695cd581eeb7",
"cart": "4db162ebf6ee34d11293b9aa7e8f8a512061de318ed5187cd1cb75f5c0a2c198"
},
"baseProductOrderId": "3e934f5f-4fb7-4e01-a33d-4bd7c33f5828",
"amendProductOrderId": "3e934f5f-4fb7-4e01-a33d-4bd7c33f5828",
"orderType": "NEW",
"id": "881a6d15-bcbe-4372-b48a-41cba29f4806",
"quote": [
{
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account"
}
],
"agreement": [
{
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account",
"agreementItemId": "agreement_083774",
"agreementProductOfferingPrice": [
{
"id": "bm_jio_cardinality_price",
"price": {
"unit": "inr",
"value": 1000
}
}
],
"@baseType": "ProductOfferingPrice",
"@schemaLocation": "Agreement Collection",
"characteristic": [
{
"name": "MSISDN",
"valueType": "String",
"value": "55738231121",
"action": "ADD",
"validationStatus": "PASSED",
"createdBy": "admin",
"lastModifiedBy": "system",
"lastModifiedDateTime": "2023-10-19T10:42:41.257Z",
"createdDateTime": "2023-10-19T10:42:41.257Z",
"enrichmentDetail": {
"description": "Description of character",
"specType": "ServiceSpecification",
"referenceId": "data_service_specification_001",
"valueType": "List",
"minCardinality": null,
"maxCardinality": 1,
"characteristicValues": [
{
"valueType": "String",
"value": "True",
"validFor": {
"startDateTime": "2023-08-11T09:17:41.866Z",
"endDateTime": "2023-08-11T09:17:41.866Z"
},
"default": false,
"rangeInterval": "closedTop",
"regex": null,
"unitOfMeasure": "GB"
}
],
"validFor": {
"startDateTime": "2023-08-11T09:17:41.866Z",
"endDateTime": "2023-08-11T09:17:41.866Z"
},
"format": "String",
"length": 5,
"decimalValue": 0.767,
"tooltipValue": "Additional Information",
"visibleLine": "1",
"unique": false,
"extensible": false,
"configurable": false,
"displaySequence": 1,
"isVisible": false,
"configurationStage": "Product Offer Level",
"regex": "\"expression\": \"^[0-9]{9,13}$\",\n\"message\": \"Please enter a valid phone number\""
},
"errorDetails": [
{
"errorCode": "ERR-BM-OM-OV-OE-101",
"errorMessage": "Exception in Order Enrichment Process, Product Inventory Not Present"
}
],
"dynamicAttributes": [
{
"attributeName": "Data Throttling",
"attributeValue": "55738231121",
"attributeType": "String",
"lastModifiedDateTime": "2023-10-19T10:42:41.257Z",
"lastModifiedBy": "omui admin"
}
],
"isNetworkImpacting": false,
"isCharacteristicAmended": false
}
],
"@referredType": "BillingAccount",
"@type": "serviceOrder"
}
],
"channel": [
{
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account",
"role": "ServiceAddress"
}
],
"note": [
{
"id": "45",
"author": "Jack smith",
"createdDateTime": "2023-10-19T10:42:41.257Z",
"lastModifiedDateTime": "2023-10-19T10:42:41.257Z",
"system": "CHECKOUT",
"text": "This is quite important, please approach me as soon as possible"
}
],
"payment": [
{
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account",
"method": "CashPayment",
"token": "64bf14d-7373-4937-a73b-28217ac07528",
"receiptId": "P011276",
"paymentDate": "2023-10-19T10:42:41.257Z",
"transactionAmount": "2000",
"transactionId": "123123124112",
"transactionCurrency": "USD"
}
],
"productOrderItem": [
{
"id": "1",
"sort": 1,
"quantity": 1,
"action": "ADD",
"state": "ACKNOWLEDGED",
"status": "Order Validation - Completed",
"productOrderItemType": "New Order",
"productOrderItemSubType": "NEW_ORDER",
"installBaseId": "BP1686636408708199",
"actualStartDate": "2023-10-19T10:42:41.257Z",
"completionDate": "2023-10-19T10:42:41.257Z",
"expectedCompletionDate": "2023-10-19T10:42:41.257Z",
"requestedCompletionDate": "2023-10-19T10:42:41.257Z",
"errorDetails": [
{
"errorCode": "ERR-BM-OM-OV-OE-101",
"errorMessage": "Exception in Order Enrichment Process, Product Inventory Not Present"
}
],
"parentBundleOfferId": "1001359",
"parentBundleInstallBaseId": "BP1691740391567152",
"lastModifiedBy": "2023-10-19T10:42:41.257Z",
"lastModifiedDateTime": "2023-10-19T10:42:41.257Z",
"processFlag": "COMSOM",
"externalProductOrderItemId": "880",
"externalProductOrderItemReferenceNumber": "880A",
"workflowFlag": "Combined",
"payment": [
{
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account",
"method": "CashPayment",
"token": "64bf14d-7373-4937-a73b-28217ac07528",
"receiptId": "P011276",
"paymentDate": "2023-10-19T10:42:41.257Z",
"transactionAmount": "2000",
"transactionId": "123123124112",
"transactionCurrency": "USD"
}
],
"appointment": {
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account",
"description": "Description of AppointmentRef"
},
"appointmentList": [
{
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account",
"description": "Description of AppointmentRef"
}
],
"itemTerm": [
{
"description": "Description for OrderTerm",
"name": "atrribute 2",
"duration": "12.0",
"durationUnit": "MONTH"
}
],
"productOfferingQualificationItem": {
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account",
"productOfferingQualificationHref": "/api/catalog-projection/v1/productOfferingPrice/bluemarble_unlimited_10gb_12mth_rc_001",
"productOfferingQualificationId": "bluemarble_unlimited_10gb_12mth_rc_001",
"productOfferingQualificationName": "BlueMarble Unlimited - 10GB - 12 Months - RC"
},
"productOrderItemRelationship": [
{
"id": "SO1686577779836872",
"relationshipType": "Dependency",
"siteId": "admin_123"
}
],
"quoteItem": {
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account",
"quoteHref": "mobile",
"quoteId": "123",
"quoteName": "quote_ir"
},
"itemPrice": [
{
"description": "Order Price Details",
"name": "robin_rf",
"recurringChargePeriod": "Monthly",
"priceType": "recurring",
"recurringChargePeriodLength": 1,
"offset": 3,
"tax": [
{
"taxType": "GST",
"externalID": "464bf14d-7373-4937-a73b-28217ac07528",
"id": "tax_automationtest-tx_bv8y95w",
"validFor": {
"startDateTime": "2023-08-11T09:17:41.866Z",
"endDateTime": "2023-08-11T09:17:41.866Z"
},
"@baseType": "Tax",
"@type": "Individual Type",
"taxAmount": {
"unit": "inr",
"value": 1000
},
"taxCategory": "Indian",
"taxRate": 20,
"name": "Tax_Automationtest",
"displayName": "Tax details",
"definesExemption": false,
"additionalAttributes": [
{
"name": "MSISDN",
"valueType": "String",
"value": "55738231121",
"action": "ADD",
"validationStatus": "PASSED",
"createdBy": "admin",
"lastModifiedBy": "system",
"lastModifiedDateTime": "2023-10-19T10:42:41.257Z",
"createdDateTime": "2023-10-19T10:42:41.257Z",
"enrichmentDetail": {
"description": "Description of character",
"specType": "ServiceSpecification",
"referenceId": "data_service_specification_001",
"valueType": "List",
"minCardinality": null,
"maxCardinality": 1,
"characteristicValues": [],
"validFor": {},
"format": "String",
"length": 5,
"decimalValue": 0.767,
"tooltipValue": "Additional Information",
"visibleLine": "1",
"unique": false,
"extensible": false,
"configurable": false,
"displaySequence": 1,
"isVisible": false,
"configurationStage": "Product Offer Level",
"regex": "\"expression\": \"^[0-9]{9,13}$\",\n\"message\": \"Please enter a valid phone number\""
},
"errorDetails": [
""
],
"dynamicAttributes": [
""
],
"isNetworkImpacting": false,
"isCharacteristicAmended": false
}
]
}
],
"priceId": "op_0nwf2jj",
"priceSubType": "recurring",
"unitOfMeasure": "INR",
"@baseType": "OrderPrice",
"@schemaLocation": "OrderPrice Collection",
"price": {
"percentage": 10,
"taxRate": 10,
"actionCardinality": 10,
"taxAmount": 10,
"@baseType": "Price",
"@type": "Price",
"dutyFreeAmount": {
"unit": "inr",
"value": 1000
},
"taxIncludedAmount": {
"unit": "inr",
"value": 1000
},
"@schemaLocation": "Price Collection",
"dutyFreeAlteredAmount": {
"unit": "inr",
"value": 1000
},
"taxIncludedAlteredAmount": {
"unit": "inr",
"value": 1000
},
"changeAmount": {
"unit": "inr",
"value": 1000
},
"discount": {
"unit": "inr",
"value": 1000
},
"amountPayable": {
"unit": "inr",
"value": 1000
},
"taxFixed": {
"unit": "inr",
"value": 1000
}
},
"@type": "OrderPrice",
"priceAlteration": [
{
"applicationDuration": 3,
"description": "Price Alteration Details",
"name": "ServiceOrder",
"priceAlterationType": "Discount",
"priceType": "recurring",
"priority": 2,
"recurringChargePeriod": "Month",
"referenceId": "data_service_specification_001",
"unitOfMeasure": "INR",
"@baseType": "PriceAlteration",
"@schemaLocation": "PriceAlteration Collection",
"@type": "recurring",
"price": {
"percentage": 10,
"taxRate": 10,
"actionCardinality": 10,
"taxAmount": 10,
"@baseType": "Price",
"@type": "Price",
"dutyFreeAmount": {
"unit": "inr",
"value": 1000
},
"taxIncludedAmount": {
"unit": "inr",
"value": 1000
},
"@schemaLocation": "Price Collection",
"dutyFreeAlteredAmount": {
"unit": "inr",
"value": 1000
},
"taxIncludedAlteredAmount": {
"unit": "inr",
"value": 1000
},
"changeAmount": {
"unit": "inr",
"value": 1000
},
"discount": {
"unit": "inr",
"value": 1000
},
"amountPayable": {
"unit": "inr",
"value": 1000
},
"taxFixed": {
"unit": "inr",
"value": 1000
}
},
"productOfferingPrice": {
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account",
"@baseType": "ProductOfferingPrice",
"@referredType": "ProductOfferingPrice Type",
"@schemaLocation": "ProductOfferingPrice Collection",
"@type": "individual Type"
}
}
],
"productOfferingPrice": {
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account",
"@baseType": "ProductOfferingPrice",
"@referredType": "ProductOfferingPrice Type",
"@schemaLocation": "ProductOfferingPrice Collection",
"@type": "individual Type"
},
"itemPriceRelationship": [
{
"priceId": "P465",
"relationshipType": "FIXED_PRICE"
}
],
"validFor": {
"endDateTime": "2023-10-19T10:42:41.257Z",
"startDateTime": "2023-10-19T10:42:41.257Z"
},
"isDownPaymentRequired": false,
"minimumDownPaymentAmount": null,
"isAgreementBased": false,
"offsetParameter": {
"numberofBlock": 2,
"totalAllowanceSelectionCount": 4,
"isCalenderBased": true,
"discountType": "FIXED_PRICE",
"billingDiscountExternalRef": "BD2024-123456",
"discountValue": 10,
"allowedDiscount": [
{
"block": 1,
"allowedSelectionCount": null,
"allowedSelectionPeriod": "2022-08-08 13:09:00.612Z",
"selectedDiscountPeriod": "2022-08-08 13:09:00.612Z"
}
]
},
"code": "PC_de716bb0",
"externalId": "prepaidplan_a-1_price_2-0_v1||123",
"id": "9a058452-d5c7-4ec2-9f3d-1ecc34d120ee",
"specCharacteristics": [
{
"name": "SMS Allowance",
"value": "50SMS",
"valueType": "String"
}
],
"isProrated": false,
"isArrears": false
}
],
"qualification": [
{
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account"
}
],
"billingAccount": {
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account",
"dynamicAttributes": [
{
"attributeName": "Data Throttling",
"attributeValue": "55738231121",
"attributeType": "String",
"lastModifiedDateTime": "2023-10-19T10:42:41.257Z",
"lastModifiedBy": "omui admin"
}
],
"financeSettlementRef": [
{
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account"
}
],
"paymentMethodRef": [
{
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account"
}
],
"itemPriceRef": [
{
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account"
}
],
"@baseType": "ProductOfferingPrice",
"@type": "Individual Party",
"@schemaLocation": "BillingAccount",
"@referredType": "BillingAccount"
},
"billingAccountList": [
{
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account",
"dynamicAttributes": [
{
"attributeName": "Data Throttling",
"attributeValue": "55738231121",
"attributeType": "String",
"lastModifiedDateTime": "2023-10-19T10:42:41.257Z",
"lastModifiedBy": "omui admin"
}
],
"financeSettlementRef": [
{
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account"
}
],
"paymentMethodRef": [
{
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account"
}
],
"itemPriceRef": [
{
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account"
}
],
"@baseType": "ProductOfferingPrice",
"@type": "Individual Party",
"@schemaLocation": "BillingAccount",
"@referredType": "BillingAccount"
}
],
"productOffering": {
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account",
"externalID": "464bf14d-7373-4937-a73b-28217ac07528",
"owningSystem": "BlueMarble",
"owningSystemID": "owning system1001",
"relatedSystemName": "relatedsystem1001",
"referenceId": "data_service_specification_001",
"version": "1",
"status": "Closed",
"category": {
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account",
"version": null
},
"metaExtension": {
"dataSet": [
{
"name": "MobileOfferOM",
"genericData": {
"schemaRef": "OrderManagementOffer",
"valueSet": {}
},
"languages": [
{
"locale": "en-GB",
"name": "ENGLISH-IND, ENGLISH-US"
}
],
"channels": [
{
"id": "bo_lov_saleschannel_retail",
"name": "Retail"
}
],
"marketSegments": [
{
"id": "7894820397708LH425643",
"name": "Retail"
}
]
}
]
},
"productType": "Subscription",
"productLine": "Postpaid",
"offerClassification": "bo_lov_offerclassification_primary",
"@referredType": " BillingAccount ",
"@schemaLocation": "ProductOffering Collection",
"@type": "CFS",
"isAssetable": false
},
"product": {
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account",
"description": "find details for product Order",
"orderDate": "2023-10-19T10:42:41.257Z",
"productSerialNumber": "1",
"startDate": "2023-10-19T10:42:41.257Z",
"terminationDate": "2023-10-19T10:42:41.257Z",
"status": "CREATED",
"isBundle": false,
"isCustomerVisible": true,
"place": [
{
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account",
"role": "ServiceAddress",
"locationId": "LRW245",
"flag": "ACTIVE",
"fullAddress": "RMZ Galleria Office BLock,Yelahanka New Town",
"streetNr": "52",
"streetNrSuffix": "153",
"streetNrLast": "754",
"streetNrLastSuffix": "5765",
"streetName": "Pell Street",
"streetType": "Street",
"streetSuffix": "52",
"postCode": "SE85ES",
"locality": "London",
"city": "Pune",
"stateOrProvince": "England",
"country": "United Kingdom",
"geoLocationRefOrValue": {
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account",
"geometryType": "Point",
"accuracy": "100 meters",
"spatialRef": "WGS 84",
"type": "ProductOfferingPrice",
"schemaLocation": "Geolocation Collection",
"geometry": [
{
"latitude": "13.3379° N",
"longitude": "77.1173° E",
"geographicDatum": "NAVD88"
}
]
},
"geographicSubAddress": [
{
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account",
"type": "SubUnit",
"subUnitType": "Apartment",
"subUnitNumber": "1234",
"levelType": "Floor",
"levelNumber": "2",
"buildingName": "Acme Corporation Building",
"privateStreetNumber": "123",
"privateStreetName": "Main Street"
}
],
"serviceability": [
{
"id": "sms_service_specification_001",
"type": "CFS",
"attributes": {
"category": "enterprise",
"availability": {
"key": "PRODUCT_CODE",
"value": "6767453"
},
"items": [
""
]
}
}
],
"contactDetails": [
{
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account",
"role": "OM_DATA_MANAGER",
"type": "Individual Party",
"baseType": "ProductOfferingPrice",
"referredType": "BillingAccount",
"schemaLocation": "RelatedParty Collection",
"contactMedium": [
{
"baseType": "ProductOfferingPrice",
"type": "Individual Party",
"schemaLocation": "ContactMedium Collection",
"preferred": false,
"mediumType": "url",
"validFor": {},
"characteristic": {}
}
]
}
]
}
],
"productCharacteristic": [
{
"name": "MSISDN",
"valueType": "String",
"value": "55738231121",
"action": "ADD",
"validationStatus": "PASSED",
"createdBy": "admin",
"lastModifiedBy": "system",
"lastModifiedDateTime": "2023-10-19T10:42:41.257Z",
"createdDateTime": "2023-10-19T10:42:41.257Z",
"enrichmentDetail": {
"description": "Description of character",
"specType": "ServiceSpecification",
"referenceId": "data_service_specification_001",
"valueType": "List",
"minCardinality": null,
"maxCardinality": 1,
"characteristicValues": [
{
"valueType": "String",
"value": "True",
"validFor": {
"startDateTime": "2023-08-11T09:17:41.866Z",
"endDateTime": "2023-08-11T09:17:41.866Z"
},
"default": false,
"rangeInterval": "closedTop",
"regex": null,
"unitOfMeasure": "GB"
}
],
"validFor": {
"startDateTime": "2023-08-11T09:17:41.866Z",
"endDateTime": "2023-08-11T09:17:41.866Z"
},
"format": "String",
"length": 5,
"decimalValue": 0.767,
"tooltipValue": "Additional Information",
"visibleLine": "1",
"unique": false,
"extensible": false,
"configurable": false,
"displaySequence": 1,
"isVisible": false,
"configurationStage": "Product Offer Level",
"regex": "\"expression\": \"^[0-9]{9,13}$\",\n\"message\": \"Please enter a valid phone number\""
},
"errorDetails": [
{
"errorCode": "ERR-BM-OM-OV-OE-101",
"errorMessage": "Exception in Order Enrichment Process, Product Inventory Not Present"
}
],
"dynamicAttributes": [
{
"attributeName": "Data Throttling",
"attributeValue": "55738231121",
"attributeType": "String",
"lastModifiedDateTime": "2023-10-19T10:42:41.257Z",
"lastModifiedBy": "omui admin"
}
],
"isNetworkImpacting": false,
"isCharacteristicAmended": false
}
],
"agreement": [
{
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account",
"agreementItemId": "agreement_083774",
"agreementProductOfferingPrice": [
{
"id": "bm_jio_cardinality_price",
"price": {
"unit": "inr",
"value": 1000
}
}
],
"@baseType": "ProductOfferingPrice",
"@schemaLocation": "Agreement Collection",
"characteristic": [
{
"name": "MSISDN",
"valueType": "String",
"value": "55738231121",
"action": "ADD",
"validationStatus": "PASSED",
"createdBy": "admin",
"lastModifiedBy": "system",
"lastModifiedDateTime": "2023-10-19T10:42:41.257Z",
"createdDateTime": "2023-10-19T10:42:41.257Z",
"enrichmentDetail": {
"description": "Description of character",
"specType": "ServiceSpecification",
"referenceId": "data_service_specification_001",
"valueType": "List",
"minCardinality": null,
"maxCardinality": 1,
"characteristicValues": [
""
],
"validFor": {
"startDateTime": "2023-08-11T09:17:41.866Z",
"endDateTime": "2023-08-11T09:17:41.866Z"
},
"format": "String",
"length": 5,
"decimalValue": 0.767,
"tooltipValue": "Additional Information",
"visibleLine": "1",
"unique": false,
"extensible": false,
"configurable": false,
"displaySequence": 1,
"isVisible": false,
"configurationStage": "Product Offer Level",
"regex": "\"expression\": \"^[0-9]{9,13}$\",\n\"message\": \"Please enter a valid phone number\""
},
"errorDetails": [
{
"errorCode": "ERR-BM-OM-OV-OE-101",
"errorMessage": "Exception in Order Enrichment Process, Product Inventory Not Present"
}
],
"dynamicAttributes": [
{
"attributeName": "Data Throttling",
"attributeValue": "55738231121",
"attributeType": "String",
"lastModifiedDateTime": "2023-10-19T10:42:41.257Z",
"lastModifiedBy": "omui admin"
}
],
"isNetworkImpacting": false,
"isCharacteristicAmended": false
}
],
"@referredType": "BillingAccount",
"@type": "serviceOrder"
}
],
"productOffering": {
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account",
"externalID": "464bf14d-7373-4937-a73b-28217ac07528",
"owningSystem": "BlueMarble",
"owningSystemID": "owning system1001",
"relatedSystemName": "relatedsystem1001",
"referenceId": "data_service_specification_001",
"version": "1",
"status": "Closed",
"category": {
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account",
"version": null
},
"metaExtension": {
"dataSet": [
{
"name": "MobileOfferOM",
"genericData": {
"schemaRef": "OrderManagementOffer",
"valueSet": {}
},
"languages": [
{
"locale": "en-GB",
"name": "ENGLISH-IND, ENGLISH-US"
}
],
"channels": [
{
"id": "bo_lov_saleschannel_retail",
"name": "Retail"
}
],
"marketSegments": [
{
"id": "7894820397708LH425643",
"name": "Retail"
}
]
}
]
},
"productType": "Subscription",
"productLine": "Postpaid",
"offerClassification": "bo_lov_offerclassification_primary",
"@referredType": " BillingAccount ",
"@schemaLocation": "ProductOffering Collection",
"@type": "CFS",
"isAssetable": false
},
"billingAccount": {
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account",
"dynamicAttributes": [
{
"attributeName": "Data Throttling",
"attributeValue": "55738231121",
"attributeType": "String",
"lastModifiedDateTime": "2023-10-19T10:42:41.257Z",
"lastModifiedBy": "omui admin"
}
],
"financeSettlementRef": [
{
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account"
}
],
"paymentMethodRef": [
{
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account"
}
],
"itemPriceRef": [
{
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account"
}
],
"@baseType": "ProductOfferingPrice",
"@type": "Individual Party",
"@schemaLocation": "BillingAccount",
"@referredType": "BillingAccount"
},
"billingAccountList": [
{
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account",
"dynamicAttributes": [
{
"attributeName": "Data Throttling",
"attributeValue": "55738231121",
"attributeType": "String",
"lastModifiedDateTime": "2023-10-19T10:42:41.257Z",
"lastModifiedBy": "omui admin"
}
],
"financeSettlementRef": [
{
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account"
}
],
"paymentMethodRef": [
{
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account"
}
],
"itemPriceRef": [
{
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account"
}
],
"@baseType": "ProductOfferingPrice",
"@type": "Individual Party",
"@schemaLocation": "BillingAccount",
"@referredType": "BillingAccount"
}
],
"relatedParty": [
{
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account",
"role": "OM_DATA_MANAGER",
"type": "Individual Party",
"baseType": "ProductOfferingPrice",
"referredType": "BillingAccount",
"schemaLocation": "RelatedParty Collection",
"contactMedium": [
{
"baseType": "ProductOfferingPrice",
"type": "Individual Party",
"schemaLocation": "ContactMedium Collection",
"preferred": false,
"mediumType": "url",
"validFor": {
"startDateTime": "2023-08-11T09:17:41.866Z",
"endDateTime": "2023-08-11T09:17:41.866Z"
},
"characteristic": {
"baseType": "ProductOfferingPrice",
"type": "Individual Party",
"schemaLocation": "Contact Characteristics Collection",
"addressId": "#234",
"city": "Bengalore",
"contactType": "phone",
"country": "India",
"emailAddress": "example.@gmail.com",
"faxNumber": "212-111-2222",
"phoneNumber": "9856876322",
"postCode": "560064",
"socialNetworkId": "LinkedIn",
"stateOrProvince": "karnataka",
"street1": "RMZ Galleria",
"street2": "Office Block",
"houseNo": "56"
}
}
]
}
],
"productPrice": [
{
"description": "find details for product price",
"name": "Mobile Postpaid - Product Specification",
"offset": null,
"priceId": "1",
"priceType": "Onetime",
"recurringChargePeriod": "string",
"recurringChargePeriodLength": null,
"unitOfMeasure": "",
"tax": [
{
"taxType": "GST",
"externalID": "464bf14d-7373-4937-a73b-28217ac07528",
"id": "tax_automationtest-tx_bv8y95w",
"validFor": {
"startDateTime": "2023-08-11T09:17:41.866Z",
"endDateTime": "2023-08-11T09:17:41.866Z"
},
"@baseType": "Tax",
"@type": "Individual Type",
"taxAmount": {
"unit": "inr",
"value": 1000
},
"taxCategory": "Indian",
"taxRate": 20,
"name": "Tax_Automationtest",
"displayName": "Tax details",
"definesExemption": false,
"additionalAttributes": [
{
"name": "MSISDN",
"valueType": "String",
"value": "55738231121",
"action": "ADD",
"validationStatus": "PASSED",
"createdBy": "admin",
"lastModifiedBy": "system",
"lastModifiedDateTime": "2023-10-19T10:42:41.257Z",
"createdDateTime": "2023-10-19T10:42:41.257Z",
"enrichmentDetail": {},
"errorDetails": [],
"dynamicAttributes": [],
"isNetworkImpacting": false,
"isCharacteristicAmended": false
}
]
}
],
"priceSubType": "",
"isDownPaymentRequired": false,
"minimumDownPaymentAmount": null,
"id": "4cd250d9-e00e-4396-853b-2b244f0758dc",
"externalId": "string",
"@baseType": "ProductPrice",
"@schemaLocation": "price point collection",
"@type": "ProductPrice",
"itemPriceRelationship": [
{
"priceId": "P465",
"relationshipType": "FIXED_PRICE"
}
],
"price": {
"percentage": 10,
"taxRate": 10,
"actionCardinality": 10,
"taxAmount": 10,
"@baseType": "Price",
"@type": "Price",
"dutyFreeAmount": {
"unit": "inr",
"value": 1000
},
"taxIncludedAmount": {
"unit": "inr",
"value": 1000
},
"@schemaLocation": "Price Collection",
"dutyFreeAlteredAmount": {
"unit": "inr",
"value": 1000
},
"taxIncludedAlteredAmount": {
"unit": "inr",
"value": 1000
},
"changeAmount": {
"unit": "inr",
"value": 1000
},
"discount": {
"unit": "inr",
"value": 1000
},
"amountPayable": {
"unit": "inr",
"value": 1000
},
"taxFixed": {
"unit": "inr",
"value": 1000
}
},
"priceAlteration": [
{
"applicationDuration": 3,
"description": "Price Alteration Details",
"name": "ServiceOrder",
"priceAlterationType": "Discount",
"priceType": "recurring",
"priority": 2,
"recurringChargePeriod": "Month",
"referenceId": "data_service_specification_001",
"unitOfMeasure": "INR",
"@baseType": "PriceAlteration",
"@schemaLocation": "PriceAlteration Collection",
"@type": "recurring",
"price": {
"percentage": 10,
"taxRate": 10,
"actionCardinality": 10,
"taxAmount": 10,
"@baseType": "Price",
"@type": "Price",
"dutyFreeAmount": {
"unit": "inr",
"value": 1000
},
"taxIncludedAmount": {
"unit": "inr",
"value": 1000
},
"@schemaLocation": "Price Collection",
"dutyFreeAlteredAmount": {
"unit": "inr",
"value": 1000
},
"taxIncludedAlteredAmount": {
"unit": "inr",
"value": 1000
},
"changeAmount": {
"unit": "inr",
"value": 1000
},
"discount": {
"unit": "inr",
"value": 1000
},
"amountPayable": {
"unit": "inr",
"value": 1000
},
"taxFixed": {
"unit": "inr",
"value": 1000
}
},
"productOfferingPrice": {
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account",
"@baseType": "ProductOfferingPrice",
"@referredType": "ProductOfferingPrice Type",
"@schemaLocation": "ProductOfferingPrice Collection",
"@type": "individual Type"
}
}
],
"productOfferingPrice": {
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account",
"@baseType": "ProductOfferingPrice",
"@referredType": "ProductOfferingPrice Type",
"@schemaLocation": "ProductOfferingPrice Collection",
"@type": "individual Type"
},
"offsetParameter": {
"numberofBlock": 2,
"totalAllowanceSelectionCount": 4,
"isCalenderBased": true,
"discountType": "FIXED_PRICE",
"billingDiscountExternalRef": "BD2024-123456",
"discountValue": 10,
"allowedDiscount": [
{
"block": 1,
"allowedSelectionCount": null,
"allowedSelectionPeriod": "2022-08-08 13:09:00.612Z",
"selectedDiscountPeriod": "2022-08-08 13:09:00.612Z"
}
]
},
"isAgreementBased": true,
"code": "401 UNAUTHORIZED",
"specCharacteristics": [
{
"name": "SMS Allowance",
"value": "50SMS",
"valueType": "String"
}
],
"isProrated": false,
"isArrears": false,
"validFor": {
"startDateTime": "2023-08-11T09:17:41.866Z",
"endDateTime": "2023-08-11T09:17:41.866Z"
}
}
],
"productOrderItem": [
{
"orderItemAction": "ADD",
"orderItemId": "1",
"productOrderHref": "string",
"productOrderId": "557ae80c-b612-48f0-a57e-cd3a0eb1dc2c",
"role": "ServiceAddress"
}
],
"productSpecification": {
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account",
"externalId": "464bf14d-7373-4937-a73b-28217ac07528",
"externalName": "",
"owningSystem": "BlueMarble",
"owningSystemID": "owning system1001",
"relatedSystemName": "relatedsystem1001",
"status": "Open",
"referenceId": "data_service_specification_001",
"version": "1",
"metaExtension": {
"dataSet": [
{
"name": "MobileOfferOM",
"genericData": {
"schemaRef": "OrderManagementOffer",
"valueSet": {}
},
"languages": [
{
"locale": "en-GB",
"name": "ENGLISH-IND, ENGLISH-US"
}
],
"channels": [
{
"id": "bo_lov_saleschannel_retail",
"name": "Retail"
}
],
"marketSegments": [
{
"id": "7894820397708LH425643",
"name": "Retail"
}
]
}
]
},
"@type": "CFS",
"@referredType": " BillingAccount ",
"@schemaLocation": "ServiceSpecification Collection"
},
"productTerm": [
{
"description": "description for ProductTerm",
"name": "addItemThroughRules",
"durationUnit": "MONTH",
"duration": "12.0",
"validFor": {
"startDateTime": "2023-08-11T09:17:41.866Z",
"endDateTime": "2023-08-11T09:17:41.866Z"
}
}
],
"realizingResource": [
{
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account",
"value": "6767453"
}
],
"realizingService": [
{
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account"
}
],
"productRelationship": [
{
"relationshipType": "dependecy",
"product": ""
}
],
"reasonCode": "DUNNING",
"actionCode": "ACTION 2",
"checkoutData": [
{
"sectionId": "address",
"steps": [
{
"fields": [
{
"name": "Bill Format",
"value": "pdf"
}
],
"stepId": "billingAddressDetails",
"stepUId": "86c5e62d-f176-4434-b56c-bf7234429f1d",
"options": [
{
"name": "Bill Format",
"value": "pdf",
"fields": []
}
],
"offerContainerId": "5432373c-6f65-46f8-a8b5-879a8df5b576",
"cartItemId": "4a885452-ca92-45b8-933c-d35ad1b2e827",
"sequence": "0",
"groupByLevel": false,
"stepDataRefChoice": false,
"orderMgmtMapping": [
{
"fieldMapping": [],
"orderObjectPath": ""
}
]
}
],
"sectionUId": "5ba4aea8-184c-4d88-9906-143998869677"
}
],
"productLineCategory": "bm-postpaid-highend",
"parentBundleId": "bm-postpaid-highend"
},
"note": [
{
"id": "45",
"author": "Jack smith",
"createdDateTime": "2023-10-19T10:42:41.257Z",
"lastModifiedDateTime": "2023-10-19T10:42:41.257Z",
"system": "CHECKOUT",
"text": "This is quite important, please approach me as soon as possible"
}
],
"portability": {
"description": "find details for Portability",
"requestType": "PORT_IN",
"portingDate": "2023-10-19T10:42:41.257Z",
"portingApprovalDate": "2023-10-19T10:42:41.257Z",
"portingStatus": "COMPLETED",
"donorProvider": "",
"donorNumber": "20240",
"donorContractId": "70098909000",
"donorCustomerName": "intadmin",
"donorCustomerAddress": {
"id": "c63784c1-1d57-4b31-b61e-900db2d8f6e7",
"href": "/product-management/serviceSpecification/?id%3Dsms_service_specification_001%26version%3D1",
"name": "SMS - Service Specification",
"role": "ServiceAddress",
"locationId": "LRW245",
"flag": "ACTIVE",
"fullAddress": "RMZ Galleria Office BLock,Yelahanka New Town",
"streetNr": "52",
"streetNrSuffix": "153",
"streetNrLast": "754",
"streetNrLastSuffix": "5765",
"streetName": "Pell Street",
"streetType": "Street",
"streetSuffix": "52",
"postCode": "SE85ES",
"locality": "London",
"city": "Pune",
"stateOrProvince": "England",
"country": "United Kingdom",
"geoLocationRefOrValue": {
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account",
"geometryType": "Point",
"accuracy": "100 meters",
"spatialRef": "WGS 84",
"type": "ProductOfferingPrice",
"schemaLocation": "Geolocation Collection",
"geometry": [
{
"latitude": "13.3379° N",
"longitude": "77.1173° E",
"geographicDatum": "NAVD88"
}
]
},
"geographicSubAddress": [
{
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account",
"type": "SubUnit",
"subUnitType": "Apartment",
"subUnitNumber": "1234",
"levelType": "Floor",
"levelNumber": "2",
"buildingName": "Acme Corporation Building",
"privateStreetNumber": "123",
"privateStreetName": "Main Street"
}
],
"serviceability": [
{
"id": "sms_service_specification_001",
"type": "CFS",
"attributes": {
"category": "enterprise",
"availability": {
"key": "PRODUCT_CODE",
"value": "6767453"
},
"items": [
{
"key": "PRODUCT_CODE",
"value": "6767453"
}
]
}
}
],
"contactDetails": [
{
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account",
"role": "OM_DATA_MANAGER",
"type": "Individual Party",
"baseType": "ProductOfferingPrice",
"referredType": "BillingAccount",
"schemaLocation": "RelatedParty Collection",
"contactMedium": [
{
"baseType": "ProductOfferingPrice",
"type": "Individual Party",
"schemaLocation": "ContactMedium Collection",
"preferred": false,
"mediumType": "url",
"validFor": {
"startDateTime": "2023-08-11T09:17:41.866Z",
"endDateTime": "2023-08-11T09:17:41.866Z"
},
"characteristic": {
"baseType": "ProductOfferingPrice",
"type": "Individual Party",
"schemaLocation": "Contact Characteristics Collection",
"addressId": "#234",
"city": "Bengalore",
"contactType": "phone",
"country": "India",
"emailAddress": "example.@gmail.com",
"faxNumber": "212-111-2222",
"phoneNumber": "9856876322",
"postCode": "560064",
"socialNetworkId": "LinkedIn",
"stateOrProvince": "karnataka",
"street1": "RMZ Galleria",
"street2": "Office Block",
"houseNo": "56"
}
}
]
}
]
},
"additionalCharacteristics": [
{
"attributeName": "Data Throttling",
"attributeValue": "55738231121",
"attributeType": "String",
"lastModifiedDateTime": "2023-10-19T10:42:41.257Z",
"lastModifiedBy": "omui admin"
}
],
"createdBy": "om_admin",
"createdDateTime": "2023-10-19T10:42:41.257Z",
"lastModifiedBy": "om_admin",
"lastModifiedDateTime": "2023-10-19T10:42:41.257Z"
},
"isOfferAmended": false,
"portfolioDetails": {
"portfolioId": "BP1698224881607424",
"productLineCategory": "bm-postpaid-highend",
"offerContainerCategory": "bm-postpaid-highend",
"href": "https://host:port/paymentManagement/v4/cashPayment/2365",
"childProduct": [
{
"childProductOrderItemId": "9be74937-4927-4924-b2bb-d7a4dd401f1a",
"childInstallBaseId": "RUM1660733938024415",
"childSpecificationName": "Fiber Port",
"childCpoId": "CPO7894820397708LH425",
"inventory": false,
"state": "ACTIVE"
}
],
"parentProduct": {
"parentProductOrderItemId": "e2346",
"parentInstallBaseId": "BP1698224881533778",
"parentSpecificationName": "Mobile Postpaid - Product Specification",
"inventory": false,
"parentCpoId": "CPO7894820397708LH425",
"state": "ACTIVE"
}
},
"promotions": [
{
"category": "Managed SDWAN Service",
"id": "automation_promotion-pm_20eewvb",
"internalLifecycleStatus": "Test",
"description": "Promotion",
"lifeCycleStatus": "Test",
"name": "Automation_Promotion_678new",
"priority": 2,
"promoApplicationLevel": "cart",
"signature": "cartSignature",
"type": "Promotion",
"promotionAction": {
"actionCardinality": null,
"actionObjectId": "bm-samsung-product-bundle",
"actionType": "Add Product",
"actionValue": 2,
"applicationDuration": 1,
"cartItemId": "5432373c-6f65-46f8-a8b5-879a8df5b576",
"id": "pa_j6w82",
"maxActionValue": "3",
"priceId": "op_0nwf2jj",
"priceType": "recurring",
"priority": 4,
"recurringChargePeriodType": "Month"
},
"promotionClassification": "exclusive",
"coupon": {
"id": "54765",
"code": "MY_COUPON_CODE",
"coupon": false
},
"validFor": {
"startDateTime": "2023-08-11T09:17:41.866Z",
"endDateTime": "2023-08-11T09:17:41.866Z"
}
}
],
"additionalAttributes": [
{
"name": "MSISDN",
"valueType": "String",
"value": "55738231121",
"action": "ADD",
"validationStatus": "PASSED",
"createdBy": "admin",
"lastModifiedBy": "system",
"lastModifiedDateTime": "2023-10-19T10:42:41.257Z",
"createdDateTime": "2023-10-19T10:42:41.257Z",
"enrichmentDetail": {
"description": "Description of character",
"specType": "ServiceSpecification",
"referenceId": "data_service_specification_001",
"valueType": "List",
"minCardinality": null,
"maxCardinality": 1,
"characteristicValues": [
{
"valueType": "String",
"value": "True",
"validFor": {
"startDateTime": "2023-08-11T09:17:41.866Z",
"endDateTime": "2023-08-11T09:17:41.866Z"
},
"default": false,
"rangeInterval": "closedTop",
"regex": null,
"unitOfMeasure": "GB"
}
],
"validFor": {
"startDateTime": "2023-08-11T09:17:41.866Z",
"endDateTime": "2023-08-11T09:17:41.866Z"
},
"format": "String",
"length": 5,
"decimalValue": 0.767,
"tooltipValue": "Additional Information",
"visibleLine": "1",
"unique": false,
"extensible": false,
"configurable": false,
"displaySequence": 1,
"isVisible": false,
"configurationStage": "Product Offer Level",
"regex": "\"expression\": \"^[0-9]{9,13}$\",\n\"message\": \"Please enter a valid phone number\""
},
"errorDetails": [
{
"errorCode": "ERR-BM-OM-OV-OE-101",
"errorMessage": "Exception in Order Enrichment Process, Product Inventory Not Present"
}
],
"dynamicAttributes": [
{
"attributeName": "Data Throttling",
"attributeValue": "55738231121",
"attributeType": "String",
"lastModifiedDateTime": "2023-10-19T10:42:41.257Z",
"lastModifiedBy": "omui admin"
}
],
"isNetworkImpacting": false,
"isCharacteristicAmended": false
}
],
"productFeasibility": {
"validTill": {
"endDateTime": "2023-10-19T10:42:41.257Z",
"startDateTime": "2023-10-19T10:42:41.257Z"
},
"remark": "remark",
"approvedBy": "System",
"qualified": false,
"attributes": [
{
"name": "attribute_fa",
"value": "50SMS",
"valueType": "string,number,boolean",
"array": false,
"viewOnly": false,
"quantityBased": false
}
]
},
"dueDateJeopardyCategory": true,
"expDueDateJeopardyCategory": false,
"checkoutProductDetails": {
"type": "quote",
"associatedOCId": "",
"associatedCIId": "",
"associatedSiteId": "",
"source": "",
"externalId": "464bf14d-7373-4937-a73b-28217ac07528",
"overridePrice": 10,
"additionalAttributes": [
{
"name": "Order Level",
"value": "43654"
}
]
},
"bypassCharpoValidation": false,
"resourceAllocation": false,
"baseInstallBaseId": "BP1691740391567152",
"parallelInstallBaseId": "RUM1660733938024419",
"baseServiceTermination": false,
"isAmendOrderItem": false,
"isPreviousOrderItemState": true
}
],
"orderTotalPrice": [
{
"description": "Order Price Details",
"name": "robin_rf",
"recurringChargePeriod": "Monthly",
"priceType": "recurring",
"recurringChargePeriodLength": 1,
"offset": 3,
"tax": [
{
"taxType": "GST",
"externalID": "464bf14d-7373-4937-a73b-28217ac07528",
"id": "tax_automationtest-tx_bv8y95w",
"validFor": {
"startDateTime": "2023-08-11T09:17:41.866Z",
"endDateTime": "2023-08-11T09:17:41.866Z"
},
"@baseType": "Tax",
"@type": "Individual Type",
"taxAmount": {
"unit": "inr",
"value": 1000
},
"taxCategory": "Indian",
"taxRate": 20,
"name": "Tax_Automationtest",
"displayName": "Tax details",
"definesExemption": false,
"additionalAttributes": [
{
"name": "MSISDN",
"valueType": "String",
"value": "55738231121",
"action": "ADD",
"validationStatus": "PASSED",
"createdBy": "admin",
"lastModifiedBy": "system",
"lastModifiedDateTime": "2023-10-19T10:42:41.257Z",
"createdDateTime": "2023-10-19T10:42:41.257Z",
"enrichmentDetail": {
"description": "Description of character",
"specType": "ServiceSpecification",
"referenceId": "data_service_specification_001",
"valueType": "List",
"minCardinality": null,
"maxCardinality": 1,
"characteristicValues": [
{
"valueType": "String",
"value": "True",
"validFor": {},
"default": false,
"rangeInterval": "closedTop",
"regex": null,
"unitOfMeasure": "GB"
}
],
"validFor": {
"startDateTime": "2023-08-11T09:17:41.866Z",
"endDateTime": "2023-08-11T09:17:41.866Z"
},
"format": "String",
"length": 5,
"decimalValue": 0.767,
"tooltipValue": "Additional Information",
"visibleLine": "1",
"unique": false,
"extensible": false,
"configurable": false,
"displaySequence": 1,
"isVisible": false,
"configurationStage": "Product Offer Level",
"regex": "\"expression\": \"^[0-9]{9,13}$\",\n\"message\": \"Please enter a valid phone number\""
},
"errorDetails": [
{
"errorCode": "ERR-BM-OM-OV-OE-101",
"errorMessage": "Exception in Order Enrichment Process, Product Inventory Not Present"
}
],
"dynamicAttributes": [
{
"attributeName": "Data Throttling",
"attributeValue": "55738231121",
"attributeType": "String",
"lastModifiedDateTime": "2023-10-19T10:42:41.257Z",
"lastModifiedBy": "omui admin"
}
],
"isNetworkImpacting": false,
"isCharacteristicAmended": false
}
]
}
],
"priceId": "op_0nwf2jj",
"priceSubType": "recurring",
"unitOfMeasure": "INR",
"@baseType": "OrderPrice",
"@schemaLocation": "OrderPrice Collection",
"price": {
"percentage": 10,
"taxRate": 10,
"actionCardinality": 10,
"taxAmount": 10,
"@baseType": "Price",
"@type": "Price",
"dutyFreeAmount": {
"unit": "inr",
"value": 1000
},
"taxIncludedAmount": {
"unit": "inr",
"value": 1000
},
"@schemaLocation": "Price Collection",
"dutyFreeAlteredAmount": {
"unit": "inr",
"value": 1000
},
"taxIncludedAlteredAmount": {
"unit": "inr",
"value": 1000
},
"changeAmount": {
"unit": "inr",
"value": 1000
},
"discount": {
"unit": "inr",
"value": 1000
},
"amountPayable": {
"unit": "inr",
"value": 1000
},
"taxFixed": {
"unit": "inr",
"value": 1000
}
},
"@type": "OrderPrice",
"priceAlteration": [
{
"applicationDuration": 3,
"description": "Price Alteration Details",
"name": "ServiceOrder",
"priceAlterationType": "Discount",
"priceType": "recurring",
"priority": 2,
"recurringChargePeriod": "Month",
"referenceId": "data_service_specification_001",
"unitOfMeasure": "INR",
"@baseType": "PriceAlteration",
"@schemaLocation": "PriceAlteration Collection",
"@type": "recurring",
"price": {
"percentage": 10,
"taxRate": 10,
"actionCardinality": 10,
"taxAmount": 10,
"@baseType": "Price",
"@type": "Price",
"dutyFreeAmount": {
"unit": "inr",
"value": 1000
},
"taxIncludedAmount": {
"unit": "inr",
"value": 1000
},
"@schemaLocation": "Price Collection",
"dutyFreeAlteredAmount": {
"unit": "inr",
"value": 1000
},
"taxIncludedAlteredAmount": {
"unit": "inr",
"value": 1000
},
"changeAmount": {
"unit": "inr",
"value": 1000
},
"discount": {
"unit": "inr",
"value": 1000
},
"amountPayable": {
"unit": "inr",
"value": 1000
},
"taxFixed": {
"unit": "inr",
"value": 1000
}
},
"productOfferingPrice": {
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account",
"@baseType": "ProductOfferingPrice",
"@referredType": "ProductOfferingPrice Type",
"@schemaLocation": "ProductOfferingPrice Collection",
"@type": "individual Type"
}
}
],
"productOfferingPrice": {
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account",
"@baseType": "ProductOfferingPrice",
"@referredType": "ProductOfferingPrice Type",
"@schemaLocation": "ProductOfferingPrice Collection",
"@type": "individual Type"
},
"itemPriceRelationship": [
{
"priceId": "P465",
"relationshipType": "FIXED_PRICE"
}
],
"validFor": {
"endDateTime": "2023-10-19T10:42:41.257Z",
"startDateTime": "2023-10-19T10:42:41.257Z"
},
"isDownPaymentRequired": false,
"minimumDownPaymentAmount": null,
"isAgreementBased": false,
"offsetParameter": {
"numberofBlock": 2,
"totalAllowanceSelectionCount": 4,
"isCalenderBased": true,
"discountType": "FIXED_PRICE",
"billingDiscountExternalRef": "BD2024-123456",
"discountValue": 10,
"allowedDiscount": [
{
"block": 1,
"allowedSelectionCount": null,
"allowedSelectionPeriod": "2022-08-08 13:09:00.612Z",
"selectedDiscountPeriod": "2022-08-08 13:09:00.612Z"
}
]
},
"code": "PC_de716bb0",
"externalId": "prepaidplan_a-1_price_2-0_v1||123",
"id": "9a058452-d5c7-4ec2-9f3d-1ecc34d120ee",
"specCharacteristics": [
{
"name": "SMS Allowance",
"value": "50SMS",
"valueType": "String"
}
],
"isProrated": false,
"isArrears": false
}
],
"productOfferingQualification": [
{
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account"
}
],
"customerAccount": {
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account",
"dynamicAttributes": [
{
"attributeName": "Data Throttling",
"attributeValue": "55738231121",
"attributeType": "String",
"lastModifiedDateTime": "2023-10-19T10:42:41.257Z",
"lastModifiedBy": "omui admin"
}
],
"partyRef": [
{
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account"
}
],
"partyRoleRef": [
{
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account"
}
],
"aggrementRef": [
{
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account"
}
],
"paymentMethodRef": [
{
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account"
}
]
},
"billingAccount": {
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account",
"dynamicAttributes": [
{
"attributeName": "Data Throttling",
"attributeValue": "55738231121",
"attributeType": "String",
"lastModifiedDateTime": "2023-10-19T10:42:41.257Z",
"lastModifiedBy": "omui admin"
}
],
"financeSettlementRef": [
{
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account"
}
],
"paymentMethodRef": [
{
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account"
}
],
"itemPriceRef": [
{
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account"
}
],
"@baseType": "ProductOfferingPrice",
"@type": "Individual Party",
"@schemaLocation": "BillingAccount",
"@referredType": "BillingAccount"
},
"billingAccountList": [
{
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account",
"dynamicAttributes": [
{
"attributeName": "Data Throttling",
"attributeValue": "55738231121",
"attributeType": "String",
"lastModifiedDateTime": "2023-10-19T10:42:41.257Z",
"lastModifiedBy": "omui admin"
}
],
"financeSettlementRef": [
{
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account"
}
],
"paymentMethodRef": [
{
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account"
}
],
"itemPriceRef": [
{
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account"
}
],
"@baseType": "ProductOfferingPrice",
"@type": "Individual Party",
"@schemaLocation": "BillingAccount",
"@referredType": "BillingAccount"
}
],
"isAmendOrder": false,
"isAmendOrderWithCancel": false,
"isValidatedPOQ": false,
"externalOrderReferenceNumber": "879A",
"externalOrderId": "464bf14d-7373-4937-a73b-28217ac07528",
"marketSegment": {
"id": "7894820397708LH425643",
"name": "Retail"
},
"additionalAttributes": [
{
"name": "MSISDN",
"valueType": "String",
"value": "55738231121",
"action": "ADD",
"validationStatus": "PASSED",
"createdBy": "admin",
"lastModifiedBy": "system",
"lastModifiedDateTime": "2023-10-19T10:42:41.257Z",
"createdDateTime": "2023-10-19T10:42:41.257Z",
"enrichmentDetail": {
"description": "Description of character",
"specType": "ServiceSpecification",
"referenceId": "data_service_specification_001",
"valueType": "List",
"minCardinality": null,
"maxCardinality": 1,
"characteristicValues": [
{
"valueType": "String",
"value": "True",
"validFor": {
"startDateTime": "2023-08-11T09:17:41.866Z",
"endDateTime": "2023-08-11T09:17:41.866Z"
},
"default": false,
"rangeInterval": "closedTop",
"regex": null,
"unitOfMeasure": "GB"
}
],
"validFor": {
"startDateTime": "2023-08-11T09:17:41.866Z",
"endDateTime": "2023-08-11T09:17:41.866Z"
},
"format": "String",
"length": 5,
"decimalValue": 0.767,
"tooltipValue": "Additional Information",
"visibleLine": "1",
"unique": false,
"extensible": false,
"configurable": false,
"displaySequence": 1,
"isVisible": false,
"configurationStage": "Product Offer Level",
"regex": "\"expression\": \"^[0-9]{9,13}$\",\n\"message\": \"Please enter a valid phone number\""
},
"errorDetails": [
{
"errorCode": "ERR-BM-OM-OV-OE-101",
"errorMessage": "Exception in Order Enrichment Process, Product Inventory Not Present"
}
],
"dynamicAttributes": [
{
"attributeName": "Data Throttling",
"attributeValue": "55738231121",
"attributeType": "String",
"lastModifiedDateTime": "2023-10-19T10:42:41.257Z",
"lastModifiedBy": "omui admin"
}
],
"isNetworkImpacting": false,
"isCharacteristicAmended": false
}
],
"promotions": [
{
"category": "Managed SDWAN Service",
"id": "automation_promotion-pm_20eewvb",
"internalLifecycleStatus": "Test",
"description": "Promotion",
"lifeCycleStatus": "Test",
"name": "Automation_Promotion_678new",
"priority": 2,
"promoApplicationLevel": "cart",
"signature": "cartSignature",
"type": "Promotion",
"promotionAction": {
"actionCardinality": null,
"actionObjectId": "bm-samsung-product-bundle",
"actionType": "Add Product",
"actionValue": 2,
"applicationDuration": 1,
"cartItemId": "5432373c-6f65-46f8-a8b5-879a8df5b576",
"id": "pa_j6w82",
"maxActionValue": "3",
"priceId": "op_0nwf2jj",
"priceType": "recurring",
"priority": 4,
"recurringChargePeriodType": "Month"
},
"promotionClassification": "exclusive",
"coupon": {
"id": "54765",
"code": "MY_COUPON_CODE",
"coupon": false
},
"validFor": {
"startDateTime": "2023-08-11T09:17:41.866Z",
"endDateTime": "2023-08-11T09:17:41.866Z"
}
}
],
"nonRecurringPriceAdjustment": [
{
"id": "c63784c1-1d57-4b31-b61e-900db2d8f6e7",
"amount": null,
"details": [
{
"name": "SMS Allowance",
"value": "50SMS"
}
],
"name": "SMS Allowance",
"referenceId": "data_service_specification_001",
"type": "Physical"
}
],
"customerOrderType": "NEW",
"jeopardyFlag": false,
"visibleFlag": "yes,no",
"isLargeOrder": false,
"parentOrderId": "881a6d15-bcbe-4372-b48a-41cba29f4806",
"parentCpoId": "CPO2477328421161597NQ575",
"subOrderMetaData": [
{
"subOrderId": "1",
"state": "COMPLETED",
"status": "Provisioning - Completed",
"subOrderCpoId": "CPO2477328421161597NQ575",
"productSubOrderItemRef": [
{
"productSubOrderItemId": "3e934f5f-4fb7-4e01-a33d-4bd7c33f5828",
"installbaseId": "BP1686636408708199",
"productName": "Mobile",
"productOrderItemType": "New Order"
}
]
}
],
"priority": "HIGHEST, LOW",
"processingPriority": "High",
"priorityRelayTopics": [
{
"moduleName": "",
"relayTopicName": "",
"prioritySequence": "",
"processingPriority": ""
}
],
"isPortabilityOrder": false
}What made this section unhelpful for you?
Update Partial Product Order
The "Patch Existing ProductOrder" API in a product order system allows for partial updates or modifications to an existing product order using the PATCH operation. This API updates the details of the existing customer order and generates corresponding events, such as productOrderItemUpdate and status Updated.
Header Parameters
Unique identifier for tracking the transaction.
Identifier for correlating related requests and responses.
Source channel or origin of the request.
Identifier of the associated tenant or customer.
Path Parameters
Uniquely Identifier ID
Body Parameters
A string.The unique identifier associated with a Customer Purchase Order (CPO)
A date time (DateTime). Date when the product order was cancelled.
CancellationReason is the specific explanation for the cancellation of a ProductOrderRequest
A date time (DateTime). Effective delivery date amended by the provider.
expectedCompletionDate typically represents the anticipated date for Request completion
A string. Contact attached to the order to send back information regarding this order.
orderDate represents the timestamp when the order was placed for products
A date time (DateTime). Requested delivery date from the requestors perspective.
A date time (DateTime). the preferred initiation date for a requested productOrder
A date time (DateTime).The date on which the ordered product was actually initiated or commenced
A product order state type (ProductOrderStateType). State of the order: described in the state-machine diagram.
ACKNOWLEDGEDREJECTEDPENDINGHELDIN_PROGRESSCONFIRMEDCANCELLEDACTIVECOMPLETEDFAILED... 5 other enums
Status represents the current stage of a requested productOrder.
A list of related parties. Related Entity reference A related party defines party or party role linked to a specific entity.
Show child attributes
A string. Hyperlink to access the order
A string. ID given by the consumer to facilitate searches
A string.Description is a narrative text describing the content of the ProductOrderRequest
A string. Used to categorize the order, useful for the OM system, such as: Broadband, TVOption.
CreatedBy identifies the entity responsible for creating the ProductOrderRequest
The date and time when the ProductOrderRequest was initially created
LastModifiedBy indicates the entity who made last modifications to the ProductOrder
LastModifiedDateTime indicates the date and time when the ProductOrderRequest was last modified
List of Offer Container details
Show child attributes
List of Portfolio Container details
Show child attributes
This is signature field generated for individual promotion that can be applied in cart for individual offer container
Show child attributes
A unique identifier for the original order that forms the basis for subsequent amendments
Identifier assigned to a request for amending or modifying a specific product order
Type or category of the order.
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.
Show child attributes
A list of agreement references (AgreementRef [*]). A reference to an agreement defined in the context of the product order.
Show child attributes
A list of related channels (RelatedChannel [*]). Related channel to another entity. May be online web, mobile app, social ,etc.
Show child attributes
A list of notes (Note [*]). Extra information about a given entity.
Show child attributes
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.
Show child attributes
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.
Show child attributes
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.
Show child attributes
A list of product offering qualification references It's a productOfferingQualification that has been executed previously.
Show child attributes
The account of the customer who has placed the order for a product
Show child attributes
A billing account reference (BillingAccountRef). A BillingAccount is a detailed description of a bill structure.
Show child attributes
A billing account reference (BillingAccountRef). A BillingAccount is a detailed description of a bill structure.
Show child attributes
OrderAmendmentFlag indicates whether any modifications or changes have been applied to the original order
Boolean value true to notify whether order is amend with cancel or not by default false.
ValidatedPOQFlag is an indicator signaling the validation status of a Purchase Order Quantity (POQ) within a process
A distinct identifier linked to orders from external sources, facilitating tracking and integration
ExternalOrderId is a unique identifier assigned to orders from external sources for effective tracking and management
This is the market segment(s) for which this particular metaExtension will be applicable
Show child attributes
List of Characteristics Additional attributes
Show child attributes
list of promotions to store instances of the Promotion
Show child attributes
List of the Non recurring price adjustment.
Show child attributes
customerOrderType for B2B or B2C indentification
The jeopardyFlag is a boolean indicator used to signal and handle critical situations in the ProductOrderRequest
Visible Flag refers to the visibility status of an element or feature in the ProductOrderRequest
Large Order flag decide if Order is large Order and it has more Line Items that predefined number of line items
A string.OrderId is a unique identifier assigned to a specific for Parent Order Id for Large Order
A string.The unique identifier associated with a Customer Purchase Order (CPO) for Parent Order Id for Large Order
list of subOrders MetaData for large Order
Show child attributes
priority indicates request in which should be addressed for escalation, with values such as High,Medium, or Low
A string.processingPriority indicates request in which productOrder should be addressed, with values such as High,Medium, or Low
A List of module vs topic name mapping for priority processing
Show child attributes
The portabilityOrder attribute is an essential tool for maintaining a structured and organized approach to portability.
Response
Response Attributes
A string.The unique identifier associated with a Customer Purchase Order (CPO)
A date time (DateTime). Date when the product order was cancelled.
CancellationReason is the specific explanation for the cancellation of a ProductOrderRequest
A date time (DateTime). Effective delivery date amended by the provider.
expectedCompletionDate typically represents the anticipated date for Request completion
A string. Contact attached to the order to send back information regarding this order.
orderDate represents the timestamp when the order was placed for products
A date time (DateTime). Requested delivery date from the requestors perspective.
A date time (DateTime). the preferred initiation date for a requested productOrder
A date time (DateTime).The date on which the ordered product was actually initiated or commenced
A product order state type (ProductOrderStateType). State of the order: described in the state-machine diagram.
ACKNOWLEDGEDREJECTEDPENDINGHELDIN_PROGRESSCONFIRMEDCANCELLEDACTIVECOMPLETEDFAILED... 5 other enums
Status represents the current stage of a requested productOrder.
A list of related parties. Related Entity reference A related party defines party or party role linked to a specific entity.
Show child attributes
A string. Hyperlink to access the order
A string. ID given by the consumer to facilitate searches
A string.Description is a narrative text describing the content of the ProductOrderRequest
A string. Used to categorize the order, useful for the OM system, such as: Broadband, TVOption.
CreatedBy identifies the entity responsible for creating the ProductOrderRequest
The date and time when the ProductOrderRequest was initially created
LastModifiedBy indicates the entity who made last modifications to the ProductOrder
LastModifiedDateTime indicates the date and time when the ProductOrderRequest was last modified
List of Offer Container details
Show child attributes
List of Portfolio Container details
Show child attributes
This is signature field generated for individual promotion that can be applied in cart for individual offer container
Show child attributes
A unique identifier for the original order that forms the basis for subsequent amendments
Identifier assigned to a request for amending or modifying a specific product order
Type or category of the order.
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.
Show child attributes
A list of agreement references (AgreementRef [*]). A reference to an agreement defined in the context of the product order.
Show child attributes
A list of related channels (RelatedChannel [*]). Related channel to another entity. May be online web, mobile app, social ,etc.
Show child attributes
A list of notes (Note [*]). Extra information about a given entity.
Show child attributes
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.
Show child attributes
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.
Show child attributes
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.
Show child attributes
A list of product offering qualification references It's a productOfferingQualification that has been executed previously.
Show child attributes
The account of the customer who has placed the order for a product
Show child attributes
A billing account reference (BillingAccountRef). A BillingAccount is a detailed description of a bill structure.
Show child attributes
A billing account reference (BillingAccountRef). A BillingAccount is a detailed description of a bill structure.
Show child attributes
OrderAmendmentFlag indicates whether any modifications or changes have been applied to the original order
Boolean value true to notify whether order is amend with cancel or not by default false.
ValidatedPOQFlag is an indicator signaling the validation status of a Purchase Order Quantity (POQ) within a process
A distinct identifier linked to orders from external sources, facilitating tracking and integration
ExternalOrderId is a unique identifier assigned to orders from external sources for effective tracking and management
This is the market segment(s) for which this particular metaExtension will be applicable
Show child attributes
List of Characteristics Additional attributes
Show child attributes
list of promotions to store instances of the Promotion
Show child attributes
List of the Non recurring price adjustment.
Show child attributes
customerOrderType for B2B or B2C indentification
The jeopardyFlag is a boolean indicator used to signal and handle critical situations in the ProductOrderRequest
Visible Flag refers to the visibility status of an element or feature in the ProductOrderRequest
Large Order flag decide if Order is large Order and it has more Line Items that predefined number of line items
A string.OrderId is a unique identifier assigned to a specific for Parent Order Id for Large Order
A string.The unique identifier associated with a Customer Purchase Order (CPO) for Parent Order Id for Large Order
list of subOrders MetaData for large Order
Show child attributes
priority indicates request in which should be addressed for escalation, with values such as High,Medium, or Low
A string.processingPriority indicates request in which productOrder should be addressed, with values such as High,Medium, or Low
A List of module vs topic name mapping for priority processing
Show child attributes
The portabilityOrder attribute is an essential tool for maintaining a structured and organized approach to portability.
Response Attributes
A Date,Error creation date and time
A String,A error code provides specific error code which occurred
A error,A error reason provides the specific reason why error occurred
Error message,A error message provides the specific message which occurred
Error stacktrace,A error stacktrace provides the stacktrace for error occurred
Response Attributes
A Date,Error creation date and time
A String,A error code provides specific error code which occurred
A error,A error reason provides the specific reason why error occurred
Error message,A error message provides the specific message which occurred
Error stacktrace,A error stacktrace provides the stacktrace for error occurred
Response Attributes
A Date,Error creation date and time
A String,A error code provides specific error code which occurred
A error,A error reason provides the specific reason why error occurred
Error message,A error message provides the specific message which occurred
Error stacktrace,A error stacktrace provides the stacktrace for error occurred
Response Attributes
A Date,Error creation date and time
A String,A error code provides specific error code which occurred
A error,A error reason provides the specific reason why error occurred
Error message,A error message provides the specific message which occurred
Error stacktrace,A error stacktrace provides the stacktrace for error occurred
Response Attributes
A numeric or alphanumeric code that represents a specific error or issue encountered during an operation.
A human-readable message that provides additional details about the error. It offers context and information to help users or developers understand what went wrong
A timestamp indicating when the error occurred, typically in a standardized format such as ISO 8601. It helps with debugging and tracking issues over time
An HTTP status code that indicates the outcome of the request or operation. Common examples include 200 (OK), 404 (Not Found), or 500 (Internal Server Error).
The URL or endpoint that was accessed when the error occurred. It specifies the location of the request that led to the error.
Response Attributes
A Date,Error creation date and time
A String,A error code provides specific error code which occurred
A error,A error reason provides the specific reason why error occurred
Error message,A error message provides the specific message which occurred
Error stacktrace,A error stacktrace provides the stacktrace for error occurred
Response Attributes
A Date,Error creation date and time
A String,A error code provides specific error code which occurred
A error,A error reason provides the specific reason why error occurred
Error message,A error message provides the specific message which occurred
Error stacktrace,A error stacktrace provides the stacktrace for error occurred
Response Attributes
A Date,Error creation date and time
A String,A error code provides specific error code which occurred
A error,A error reason provides the specific reason why error occurred
Error message,A error message provides the specific message which occurred
Error stacktrace,A error stacktrace provides the stacktrace for error occurred
What made this section unhelpful for you?
Response
{
"cpoId": "CPO2477328421161597NQ575",
"cancellationDate": "2023-10-19T10:42:41.257Z",
"cancellationReason": "Termination",
"completionDate": "2023-10-19T10:42:41.257Z",
"expectedCompletionDate": "2023-10-19T10:42:41.257Z",
"notificationContact": "example.rnp@gmail.com",
"orderDate": "2023-10-19T10:42:41.257Z",
"requestedCompletionDate": "2023-10-19T10:42:41.257Z",
"requestedStartDate": "2023-10-19T10:42:41.257Z",
"actualStartDate": "2023-10-19T10:42:41.257Z",
"state": "FAILED",
"status": "Provisioning - Failed",
"relatedParty": [
{
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account",
"role": "OM_DATA_MANAGER",
"type": "Individual Party",
"baseType": "ProductOfferingPrice",
"referredType": "BillingAccount",
"schemaLocation": "RelatedParty Collection",
"contactMedium": [
{
"baseType": "ProductOfferingPrice",
"type": "Individual Party",
"schemaLocation": "ContactMedium Collection",
"preferred": false,
"mediumType": "url",
"validFor": {
"startDateTime": "2023-08-11T09:17:41.866Z",
"endDateTime": "2023-08-11T09:17:41.866Z"
},
"characteristic": {
"baseType": "ProductOfferingPrice",
"type": "Individual Party",
"schemaLocation": "Contact Characteristics Collection",
"addressId": "#234",
"city": "Bengalore",
"contactType": "phone",
"country": "India",
"emailAddress": "example.@gmail.com",
"faxNumber": "212-111-2222",
"phoneNumber": "9856876322",
"postCode": "560064",
"socialNetworkId": "LinkedIn",
"stateOrProvince": "karnataka",
"street1": "RMZ Galleria",
"street2": "Office Block",
"houseNo": "56"
}
}
]
}
],
"href": "/product-inventory",
"externalId": "881a6d15-bcbe-4372-b48a-41cba29f4806",
"description": "example = find details for product Order Request",
"category": "Broadband",
"createdBy": "intadmin1",
"createdDateTime": "2023-10-19T10:42:41.257Z",
"lastModifiedBy": "intadmin1",
"lastModifiedDateTime": "",
"offerContainers": [
{
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account",
"processContext": "ACQ",
"lineOfBusiness": "mobile",
"category": {
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account",
"version": null
},
"state": "ACKNOWLEDGED",
"status": "Completed",
"productOrderItemsRefs": [
{
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account"
}
],
"externalOfferContainerId": "880",
"externalOfferContainerReferenceNumber": "880A",
"additionalAttributes": [
{
"name": "MSISDN",
"valueType": "String",
"value": "55738231121",
"action": "ADD",
"validationStatus": "PASSED",
"createdBy": "admin",
"lastModifiedBy": "system",
"lastModifiedDateTime": "2023-10-19T10:42:41.257Z",
"createdDateTime": "2023-10-19T10:42:41.257Z",
"enrichmentDetail": {
"description": "Description of character",
"specType": "ServiceSpecification",
"referenceId": "data_service_specification_001",
"valueType": "List",
"minCardinality": null,
"maxCardinality": 1,
"characteristicValues": [
{
"valueType": "String",
"value": "True",
"validFor": {
"startDateTime": "2023-08-11T09:17:41.866Z",
"endDateTime": "2023-08-11T09:17:41.866Z"
},
"default": false,
"rangeInterval": "closedTop",
"regex": null,
"unitOfMeasure": "GB"
}
],
"validFor": {
"startDateTime": "2023-08-11T09:17:41.866Z",
"endDateTime": "2023-08-11T09:17:41.866Z"
},
"format": "String",
"length": 5,
"decimalValue": 0.767,
"tooltipValue": "Additional Information",
"visibleLine": "1",
"unique": false,
"extensible": false,
"configurable": false,
"displaySequence": 1,
"isVisible": false,
"configurationStage": "Product Offer Level",
"regex": "\"expression\": \"^[0-9]{9,13}$\",\n\"message\": \"Please enter a valid phone number\""
},
"errorDetails": [
{
"errorCode": "ERR-BM-OM-OV-OE-101",
"errorMessage": "Exception in Order Enrichment Process, Product Inventory Not Present"
}
],
"dynamicAttributes": [
{
"attributeName": "Data Throttling",
"attributeValue": "55738231121",
"attributeType": "String",
"lastModifiedDateTime": "2023-10-19T10:42:41.257Z",
"lastModifiedBy": "omui admin"
}
],
"isNetworkImpacting": false,
"isCharacteristicAmended": false
}
],
"promotions": [
{
"category": "Managed SDWAN Service",
"id": "automation_promotion-pm_20eewvb",
"internalLifecycleStatus": "Test",
"description": "Promotion",
"lifeCycleStatus": "Test",
"name": "Automation_Promotion_678new",
"priority": 2,
"promoApplicationLevel": "cart",
"signature": "cartSignature",
"type": "Promotion",
"promotionAction": {
"actionCardinality": null,
"actionObjectId": "bm-samsung-product-bundle",
"actionType": "Add Product",
"actionValue": 2,
"applicationDuration": 1,
"cartItemId": "5432373c-6f65-46f8-a8b5-879a8df5b576",
"id": "pa_j6w82",
"maxActionValue": "3",
"priceId": "op_0nwf2jj",
"priceType": "recurring",
"priority": 4,
"recurringChargePeriodType": "Month"
},
"promotionClassification": "exclusive",
"coupon": {
"id": "54765",
"code": "MY_COUPON_CODE",
"coupon": false
},
"validFor": {
"startDateTime": "2023-08-11T09:17:41.866Z",
"endDateTime": "2023-08-11T09:17:41.866Z"
}
}
],
"offerContainerTotalPrice": [
{
"description": "Order Price Details",
"name": "robin_rf",
"recurringChargePeriod": "Monthly",
"priceType": "recurring",
"recurringChargePeriodLength": 1,
"offset": 3,
"tax": [
{
"taxType": "GST",
"externalID": "464bf14d-7373-4937-a73b-28217ac07528",
"id": "tax_automationtest-tx_bv8y95w",
"validFor": {
"startDateTime": "2023-08-11T09:17:41.866Z",
"endDateTime": "2023-08-11T09:17:41.866Z"
},
"@baseType": "Tax",
"@type": "Individual Type",
"taxAmount": {
"unit": "inr",
"value": 1000
},
"taxCategory": "Indian",
"taxRate": 20,
"name": "Tax_Automationtest",
"displayName": "Tax details",
"definesExemption": false,
"additionalAttributes": [
{
"name": "MSISDN",
"valueType": "String",
"value": "55738231121",
"action": "ADD",
"validationStatus": "PASSED",
"createdBy": "admin",
"lastModifiedBy": "system",
"lastModifiedDateTime": "2023-10-19T10:42:41.257Z",
"createdDateTime": "2023-10-19T10:42:41.257Z",
"enrichmentDetail": {
"description": "Description of character",
"specType": "ServiceSpecification",
"referenceId": "data_service_specification_001",
"valueType": "List",
"minCardinality": null,
"maxCardinality": 1,
"characteristicValues": [],
"validFor": {},
"format": "String",
"length": 5,
"decimalValue": 0.767,
"tooltipValue": "Additional Information",
"visibleLine": "1",
"unique": false,
"extensible": false,
"configurable": false,
"displaySequence": 1,
"isVisible": false,
"configurationStage": "Product Offer Level",
"regex": "\"expression\": \"^[0-9]{9,13}$\",\n\"message\": \"Please enter a valid phone number\""
},
"errorDetails": [
""
],
"dynamicAttributes": [
""
],
"isNetworkImpacting": false,
"isCharacteristicAmended": false
}
]
}
],
"priceId": "op_0nwf2jj",
"priceSubType": "recurring",
"unitOfMeasure": "INR",
"@baseType": "OrderPrice",
"@schemaLocation": "OrderPrice Collection",
"price": {
"percentage": 10,
"taxRate": 10,
"actionCardinality": 10,
"taxAmount": 10,
"@baseType": "Price",
"@type": "Price",
"dutyFreeAmount": {
"unit": "inr",
"value": 1000
},
"taxIncludedAmount": {
"unit": "inr",
"value": 1000
},
"@schemaLocation": "Price Collection",
"dutyFreeAlteredAmount": {
"unit": "inr",
"value": 1000
},
"taxIncludedAlteredAmount": {
"unit": "inr",
"value": 1000
},
"changeAmount": {
"unit": "inr",
"value": 1000
},
"discount": {
"unit": "inr",
"value": 1000
},
"amountPayable": {
"unit": "inr",
"value": 1000
},
"taxFixed": {
"unit": "inr",
"value": 1000
}
},
"@type": "OrderPrice",
"priceAlteration": [
{
"applicationDuration": 3,
"description": "Price Alteration Details",
"name": "ServiceOrder",
"priceAlterationType": "Discount",
"priceType": "recurring",
"priority": 2,
"recurringChargePeriod": "Month",
"referenceId": "data_service_specification_001",
"unitOfMeasure": "INR",
"@baseType": "PriceAlteration",
"@schemaLocation": "PriceAlteration Collection",
"@type": "recurring",
"price": {
"percentage": 10,
"taxRate": 10,
"actionCardinality": 10,
"taxAmount": 10,
"@baseType": "Price",
"@type": "Price",
"dutyFreeAmount": {
"unit": "inr",
"value": 1000
},
"taxIncludedAmount": {
"unit": "inr",
"value": 1000
},
"@schemaLocation": "Price Collection",
"dutyFreeAlteredAmount": {
"unit": "inr",
"value": 1000
},
"taxIncludedAlteredAmount": {
"unit": "inr",
"value": 1000
},
"changeAmount": {
"unit": "inr",
"value": 1000
},
"discount": {
"unit": "inr",
"value": 1000
},
"amountPayable": {
"unit": "inr",
"value": 1000
},
"taxFixed": {
"unit": "inr",
"value": 1000
}
},
"productOfferingPrice": {
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account",
"@baseType": "ProductOfferingPrice",
"@referredType": "ProductOfferingPrice Type",
"@schemaLocation": "ProductOfferingPrice Collection",
"@type": "individual Type"
}
}
],
"productOfferingPrice": {
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account",
"@baseType": "ProductOfferingPrice",
"@referredType": "ProductOfferingPrice Type",
"@schemaLocation": "ProductOfferingPrice Collection",
"@type": "individual Type"
},
"itemPriceRelationship": [
{
"priceId": "P465",
"relationshipType": "FIXED_PRICE"
}
],
"validFor": {
"endDateTime": "2023-10-19T10:42:41.257Z",
"startDateTime": "2023-10-19T10:42:41.257Z"
},
"isDownPaymentRequired": false,
"minimumDownPaymentAmount": null,
"isAgreementBased": false,
"offsetParameter": {
"numberofBlock": 2,
"totalAllowanceSelectionCount": 4,
"isCalenderBased": true,
"discountType": "FIXED_PRICE",
"billingDiscountExternalRef": "BD2024-123456",
"discountValue": 10,
"allowedDiscount": [
{
"block": 1,
"allowedSelectionCount": null,
"allowedSelectionPeriod": "2022-08-08 13:09:00.612Z",
"selectedDiscountPeriod": "2022-08-08 13:09:00.612Z"
}
]
},
"code": "PC_de716bb0",
"externalId": "prepaidplan_a-1_price_2-0_v1||123",
"id": "9a058452-d5c7-4ec2-9f3d-1ecc34d120ee",
"specCharacteristics": [
{
"name": "SMS Allowance",
"value": "50SMS",
"valueType": "String"
}
],
"isProrated": false,
"isArrears": false
}
]
}
],
"portfolioContainers": [
{
"id": "BP11697629618916537",
"name": "",
"productOrderItemsRefs": [
{
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account"
}
],
"sort": 1
}
],
"signature": {
"context": "174be0d306a3bab87c1266f4b4d1f534c5a302aedda36ff0f64d695cd581eeb7",
"cart": "4db162ebf6ee34d11293b9aa7e8f8a512061de318ed5187cd1cb75f5c0a2c198"
},
"baseProductOrderId": "3e934f5f-4fb7-4e01-a33d-4bd7c33f5828",
"amendProductOrderId": "3e934f5f-4fb7-4e01-a33d-4bd7c33f5828",
"orderType": "NEW",
"id": "881a6d15-bcbe-4372-b48a-41cba29f4806",
"quote": [
{
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account"
}
],
"agreement": [
{
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account",
"agreementItemId": "agreement_083774",
"agreementProductOfferingPrice": [
{
"id": "bm_jio_cardinality_price",
"price": {
"unit": "inr",
"value": 1000
}
}
],
"@baseType": "ProductOfferingPrice",
"@schemaLocation": "Agreement Collection",
"characteristic": [
{
"name": "MSISDN",
"valueType": "String",
"value": "55738231121",
"action": "ADD",
"validationStatus": "PASSED",
"createdBy": "admin",
"lastModifiedBy": "system",
"lastModifiedDateTime": "2023-10-19T10:42:41.257Z",
"createdDateTime": "2023-10-19T10:42:41.257Z",
"enrichmentDetail": {
"description": "Description of character",
"specType": "ServiceSpecification",
"referenceId": "data_service_specification_001",
"valueType": "List",
"minCardinality": null,
"maxCardinality": 1,
"characteristicValues": [
{
"valueType": "String",
"value": "True",
"validFor": {
"startDateTime": "2023-08-11T09:17:41.866Z",
"endDateTime": "2023-08-11T09:17:41.866Z"
},
"default": false,
"rangeInterval": "closedTop",
"regex": null,
"unitOfMeasure": "GB"
}
],
"validFor": {
"startDateTime": "2023-08-11T09:17:41.866Z",
"endDateTime": "2023-08-11T09:17:41.866Z"
},
"format": "String",
"length": 5,
"decimalValue": 0.767,
"tooltipValue": "Additional Information",
"visibleLine": "1",
"unique": false,
"extensible": false,
"configurable": false,
"displaySequence": 1,
"isVisible": false,
"configurationStage": "Product Offer Level",
"regex": "\"expression\": \"^[0-9]{9,13}$\",\n\"message\": \"Please enter a valid phone number\""
},
"errorDetails": [
{
"errorCode": "ERR-BM-OM-OV-OE-101",
"errorMessage": "Exception in Order Enrichment Process, Product Inventory Not Present"
}
],
"dynamicAttributes": [
{
"attributeName": "Data Throttling",
"attributeValue": "55738231121",
"attributeType": "String",
"lastModifiedDateTime": "2023-10-19T10:42:41.257Z",
"lastModifiedBy": "omui admin"
}
],
"isNetworkImpacting": false,
"isCharacteristicAmended": false
}
],
"@referredType": "BillingAccount",
"@type": "serviceOrder"
}
],
"channel": [
{
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account",
"role": "ServiceAddress"
}
],
"note": [
{
"id": "45",
"author": "Jack smith",
"createdDateTime": "2023-10-19T10:42:41.257Z",
"lastModifiedDateTime": "2023-10-19T10:42:41.257Z",
"system": "CHECKOUT",
"text": "This is quite important, please approach me as soon as possible"
}
],
"payment": [
{
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account",
"method": "CashPayment",
"token": "64bf14d-7373-4937-a73b-28217ac07528",
"receiptId": "P011276",
"paymentDate": "2023-10-19T10:42:41.257Z",
"transactionAmount": "2000",
"transactionId": "123123124112",
"transactionCurrency": "USD"
}
],
"productOrderItem": [
{
"id": "1",
"sort": 1,
"quantity": 1,
"action": "ADD",
"state": "ACKNOWLEDGED",
"status": "Order Validation - Completed",
"productOrderItemType": "New Order",
"productOrderItemSubType": "NEW_ORDER",
"installBaseId": "BP1686636408708199",
"actualStartDate": "2023-10-19T10:42:41.257Z",
"completionDate": "2023-10-19T10:42:41.257Z",
"expectedCompletionDate": "2023-10-19T10:42:41.257Z",
"requestedCompletionDate": "2023-10-19T10:42:41.257Z",
"errorDetails": [
{
"errorCode": "ERR-BM-OM-OV-OE-101",
"errorMessage": "Exception in Order Enrichment Process, Product Inventory Not Present"
}
],
"parentBundleOfferId": "1001359",
"parentBundleInstallBaseId": "BP1691740391567152",
"lastModifiedBy": "2023-10-19T10:42:41.257Z",
"lastModifiedDateTime": "2023-10-19T10:42:41.257Z",
"processFlag": "COMSOM",
"externalProductOrderItemId": "880",
"externalProductOrderItemReferenceNumber": "880A",
"workflowFlag": "Combined",
"payment": [
{
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account",
"method": "CashPayment",
"token": "64bf14d-7373-4937-a73b-28217ac07528",
"receiptId": "P011276",
"paymentDate": "2023-10-19T10:42:41.257Z",
"transactionAmount": "2000",
"transactionId": "123123124112",
"transactionCurrency": "USD"
}
],
"appointment": {
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account",
"description": "Description of AppointmentRef"
},
"appointmentList": [
{
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account",
"description": "Description of AppointmentRef"
}
],
"itemTerm": [
{
"description": "Description for OrderTerm",
"name": "atrribute 2",
"duration": "12.0",
"durationUnit": "MONTH"
}
],
"productOfferingQualificationItem": {
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account",
"productOfferingQualificationHref": "/api/catalog-projection/v1/productOfferingPrice/bluemarble_unlimited_10gb_12mth_rc_001",
"productOfferingQualificationId": "bluemarble_unlimited_10gb_12mth_rc_001",
"productOfferingQualificationName": "BlueMarble Unlimited - 10GB - 12 Months - RC"
},
"productOrderItemRelationship": [
{
"id": "SO1686577779836872",
"relationshipType": "Dependency",
"siteId": "admin_123"
}
],
"quoteItem": {
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account",
"quoteHref": "mobile",
"quoteId": "123",
"quoteName": "quote_ir"
},
"itemPrice": [
{
"description": "Order Price Details",
"name": "robin_rf",
"recurringChargePeriod": "Monthly",
"priceType": "recurring",
"recurringChargePeriodLength": 1,
"offset": 3,
"tax": [
{
"taxType": "GST",
"externalID": "464bf14d-7373-4937-a73b-28217ac07528",
"id": "tax_automationtest-tx_bv8y95w",
"validFor": {
"startDateTime": "2023-08-11T09:17:41.866Z",
"endDateTime": "2023-08-11T09:17:41.866Z"
},
"@baseType": "Tax",
"@type": "Individual Type",
"taxAmount": {
"unit": "inr",
"value": 1000
},
"taxCategory": "Indian",
"taxRate": 20,
"name": "Tax_Automationtest",
"displayName": "Tax details",
"definesExemption": false,
"additionalAttributes": [
{
"name": "MSISDN",
"valueType": "String",
"value": "55738231121",
"action": "ADD",
"validationStatus": "PASSED",
"createdBy": "admin",
"lastModifiedBy": "system",
"lastModifiedDateTime": "2023-10-19T10:42:41.257Z",
"createdDateTime": "2023-10-19T10:42:41.257Z",
"enrichmentDetail": {
"description": "Description of character",
"specType": "ServiceSpecification",
"referenceId": "data_service_specification_001",
"valueType": "List",
"minCardinality": null,
"maxCardinality": 1,
"characteristicValues": [],
"validFor": {},
"format": "String",
"length": 5,
"decimalValue": 0.767,
"tooltipValue": "Additional Information",
"visibleLine": "1",
"unique": false,
"extensible": false,
"configurable": false,
"displaySequence": 1,
"isVisible": false,
"configurationStage": "Product Offer Level",
"regex": "\"expression\": \"^[0-9]{9,13}$\",\n\"message\": \"Please enter a valid phone number\""
},
"errorDetails": [
""
],
"dynamicAttributes": [
""
],
"isNetworkImpacting": false,
"isCharacteristicAmended": false
}
]
}
],
"priceId": "op_0nwf2jj",
"priceSubType": "recurring",
"unitOfMeasure": "INR",
"@baseType": "OrderPrice",
"@schemaLocation": "OrderPrice Collection",
"price": {
"percentage": 10,
"taxRate": 10,
"actionCardinality": 10,
"taxAmount": 10,
"@baseType": "Price",
"@type": "Price",
"dutyFreeAmount": {
"unit": "inr",
"value": 1000
},
"taxIncludedAmount": {
"unit": "inr",
"value": 1000
},
"@schemaLocation": "Price Collection",
"dutyFreeAlteredAmount": {
"unit": "inr",
"value": 1000
},
"taxIncludedAlteredAmount": {
"unit": "inr",
"value": 1000
},
"changeAmount": {
"unit": "inr",
"value": 1000
},
"discount": {
"unit": "inr",
"value": 1000
},
"amountPayable": {
"unit": "inr",
"value": 1000
},
"taxFixed": {
"unit": "inr",
"value": 1000
}
},
"@type": "OrderPrice",
"priceAlteration": [
{
"applicationDuration": 3,
"description": "Price Alteration Details",
"name": "ServiceOrder",
"priceAlterationType": "Discount",
"priceType": "recurring",
"priority": 2,
"recurringChargePeriod": "Month",
"referenceId": "data_service_specification_001",
"unitOfMeasure": "INR",
"@baseType": "PriceAlteration",
"@schemaLocation": "PriceAlteration Collection",
"@type": "recurring",
"price": {
"percentage": 10,
"taxRate": 10,
"actionCardinality": 10,
"taxAmount": 10,
"@baseType": "Price",
"@type": "Price",
"dutyFreeAmount": {
"unit": "inr",
"value": 1000
},
"taxIncludedAmount": {
"unit": "inr",
"value": 1000
},
"@schemaLocation": "Price Collection",
"dutyFreeAlteredAmount": {
"unit": "inr",
"value": 1000
},
"taxIncludedAlteredAmount": {
"unit": "inr",
"value": 1000
},
"changeAmount": {
"unit": "inr",
"value": 1000
},
"discount": {
"unit": "inr",
"value": 1000
},
"amountPayable": {
"unit": "inr",
"value": 1000
},
"taxFixed": {
"unit": "inr",
"value": 1000
}
},
"productOfferingPrice": {
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account",
"@baseType": "ProductOfferingPrice",
"@referredType": "ProductOfferingPrice Type",
"@schemaLocation": "ProductOfferingPrice Collection",
"@type": "individual Type"
}
}
],
"productOfferingPrice": {
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account",
"@baseType": "ProductOfferingPrice",
"@referredType": "ProductOfferingPrice Type",
"@schemaLocation": "ProductOfferingPrice Collection",
"@type": "individual Type"
},
"itemPriceRelationship": [
{
"priceId": "P465",
"relationshipType": "FIXED_PRICE"
}
],
"validFor": {
"endDateTime": "2023-10-19T10:42:41.257Z",
"startDateTime": "2023-10-19T10:42:41.257Z"
},
"isDownPaymentRequired": false,
"minimumDownPaymentAmount": null,
"isAgreementBased": false,
"offsetParameter": {
"numberofBlock": 2,
"totalAllowanceSelectionCount": 4,
"isCalenderBased": true,
"discountType": "FIXED_PRICE",
"billingDiscountExternalRef": "BD2024-123456",
"discountValue": 10,
"allowedDiscount": [
{
"block": 1,
"allowedSelectionCount": null,
"allowedSelectionPeriod": "2022-08-08 13:09:00.612Z",
"selectedDiscountPeriod": "2022-08-08 13:09:00.612Z"
}
]
},
"code": "PC_de716bb0",
"externalId": "prepaidplan_a-1_price_2-0_v1||123",
"id": "9a058452-d5c7-4ec2-9f3d-1ecc34d120ee",
"specCharacteristics": [
{
"name": "SMS Allowance",
"value": "50SMS",
"valueType": "String"
}
],
"isProrated": false,
"isArrears": false
}
],
"qualification": [
{
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account"
}
],
"billingAccount": {
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account",
"dynamicAttributes": [
{
"attributeName": "Data Throttling",
"attributeValue": "55738231121",
"attributeType": "String",
"lastModifiedDateTime": "2023-10-19T10:42:41.257Z",
"lastModifiedBy": "omui admin"
}
],
"financeSettlementRef": [
{
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account"
}
],
"paymentMethodRef": [
{
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account"
}
],
"itemPriceRef": [
{
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account"
}
],
"@baseType": "ProductOfferingPrice",
"@type": "Individual Party",
"@schemaLocation": "BillingAccount",
"@referredType": "BillingAccount"
},
"billingAccountList": [
{
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account",
"dynamicAttributes": [
{
"attributeName": "Data Throttling",
"attributeValue": "55738231121",
"attributeType": "String",
"lastModifiedDateTime": "2023-10-19T10:42:41.257Z",
"lastModifiedBy": "omui admin"
}
],
"financeSettlementRef": [
{
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account"
}
],
"paymentMethodRef": [
{
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account"
}
],
"itemPriceRef": [
{
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account"
}
],
"@baseType": "ProductOfferingPrice",
"@type": "Individual Party",
"@schemaLocation": "BillingAccount",
"@referredType": "BillingAccount"
}
],
"productOffering": {
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account",
"externalID": "464bf14d-7373-4937-a73b-28217ac07528",
"owningSystem": "BlueMarble",
"owningSystemID": "owning system1001",
"relatedSystemName": "relatedsystem1001",
"referenceId": "data_service_specification_001",
"version": "1",
"status": "Closed",
"category": {
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account",
"version": null
},
"metaExtension": {
"dataSet": [
{
"name": "MobileOfferOM",
"genericData": {
"schemaRef": "OrderManagementOffer",
"valueSet": {}
},
"languages": [
{
"locale": "en-GB",
"name": "ENGLISH-IND, ENGLISH-US"
}
],
"channels": [
{
"id": "bo_lov_saleschannel_retail",
"name": "Retail"
}
],
"marketSegments": [
{
"id": "7894820397708LH425643",
"name": "Retail"
}
]
}
]
},
"productType": "Subscription",
"productLine": "Postpaid",
"offerClassification": "bo_lov_offerclassification_primary",
"@referredType": " BillingAccount ",
"@schemaLocation": "ProductOffering Collection",
"@type": "CFS",
"isAssetable": false
},
"product": {
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account",
"description": "find details for product Order",
"orderDate": "2023-10-19T10:42:41.257Z",
"productSerialNumber": "1",
"startDate": "2023-10-19T10:42:41.257Z",
"terminationDate": "2023-10-19T10:42:41.257Z",
"status": "CREATED",
"isBundle": false,
"isCustomerVisible": true,
"place": [
{
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account",
"role": "ServiceAddress",
"locationId": "LRW245",
"flag": "ACTIVE",
"fullAddress": "RMZ Galleria Office BLock,Yelahanka New Town",
"streetNr": "52",
"streetNrSuffix": "153",
"streetNrLast": "754",
"streetNrLastSuffix": "5765",
"streetName": "Pell Street",
"streetType": "Street",
"streetSuffix": "52",
"postCode": "SE85ES",
"locality": "London",
"city": "Pune",
"stateOrProvince": "England",
"country": "United Kingdom",
"geoLocationRefOrValue": {
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account",
"geometryType": "Point",
"accuracy": "100 meters",
"spatialRef": "WGS 84",
"type": "ProductOfferingPrice",
"schemaLocation": "Geolocation Collection",
"geometry": [
{
"latitude": "13.3379° N",
"longitude": "77.1173° E",
"geographicDatum": "NAVD88"
}
]
},
"geographicSubAddress": [
{
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account",
"type": "SubUnit",
"subUnitType": "Apartment",
"subUnitNumber": "1234",
"levelType": "Floor",
"levelNumber": "2",
"buildingName": "Acme Corporation Building",
"privateStreetNumber": "123",
"privateStreetName": "Main Street"
}
],
"serviceability": [
{
"id": "sms_service_specification_001",
"type": "CFS",
"attributes": {
"category": "enterprise",
"availability": {
"key": "PRODUCT_CODE",
"value": "6767453"
},
"items": [
""
]
}
}
],
"contactDetails": [
{
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account",
"role": "OM_DATA_MANAGER",
"type": "Individual Party",
"baseType": "ProductOfferingPrice",
"referredType": "BillingAccount",
"schemaLocation": "RelatedParty Collection",
"contactMedium": [
{
"baseType": "ProductOfferingPrice",
"type": "Individual Party",
"schemaLocation": "ContactMedium Collection",
"preferred": false,
"mediumType": "url",
"validFor": {},
"characteristic": {}
}
]
}
]
}
],
"productCharacteristic": [
{
"name": "MSISDN",
"valueType": "String",
"value": "55738231121",
"action": "ADD",
"validationStatus": "PASSED",
"createdBy": "admin",
"lastModifiedBy": "system",
"lastModifiedDateTime": "2023-10-19T10:42:41.257Z",
"createdDateTime": "2023-10-19T10:42:41.257Z",
"enrichmentDetail": {
"description": "Description of character",
"specType": "ServiceSpecification",
"referenceId": "data_service_specification_001",
"valueType": "List",
"minCardinality": null,
"maxCardinality": 1,
"characteristicValues": [
{
"valueType": "String",
"value": "True",
"validFor": {
"startDateTime": "2023-08-11T09:17:41.866Z",
"endDateTime": "2023-08-11T09:17:41.866Z"
},
"default": false,
"rangeInterval": "closedTop",
"regex": null,
"unitOfMeasure": "GB"
}
],
"validFor": {
"startDateTime": "2023-08-11T09:17:41.866Z",
"endDateTime": "2023-08-11T09:17:41.866Z"
},
"format": "String",
"length": 5,
"decimalValue": 0.767,
"tooltipValue": "Additional Information",
"visibleLine": "1",
"unique": false,
"extensible": false,
"configurable": false,
"displaySequence": 1,
"isVisible": false,
"configurationStage": "Product Offer Level",
"regex": "\"expression\": \"^[0-9]{9,13}$\",\n\"message\": \"Please enter a valid phone number\""
},
"errorDetails": [
{
"errorCode": "ERR-BM-OM-OV-OE-101",
"errorMessage": "Exception in Order Enrichment Process, Product Inventory Not Present"
}
],
"dynamicAttributes": [
{
"attributeName": "Data Throttling",
"attributeValue": "55738231121",
"attributeType": "String",
"lastModifiedDateTime": "2023-10-19T10:42:41.257Z",
"lastModifiedBy": "omui admin"
}
],
"isNetworkImpacting": false,
"isCharacteristicAmended": false
}
],
"agreement": [
{
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account",
"agreementItemId": "agreement_083774",
"agreementProductOfferingPrice": [
{
"id": "bm_jio_cardinality_price",
"price": {
"unit": "inr",
"value": 1000
}
}
],
"@baseType": "ProductOfferingPrice",
"@schemaLocation": "Agreement Collection",
"characteristic": [
{
"name": "MSISDN",
"valueType": "String",
"value": "55738231121",
"action": "ADD",
"validationStatus": "PASSED",
"createdBy": "admin",
"lastModifiedBy": "system",
"lastModifiedDateTime": "2023-10-19T10:42:41.257Z",
"createdDateTime": "2023-10-19T10:42:41.257Z",
"enrichmentDetail": {
"description": "Description of character",
"specType": "ServiceSpecification",
"referenceId": "data_service_specification_001",
"valueType": "List",
"minCardinality": null,
"maxCardinality": 1,
"characteristicValues": [
""
],
"validFor": {
"startDateTime": "2023-08-11T09:17:41.866Z",
"endDateTime": "2023-08-11T09:17:41.866Z"
},
"format": "String",
"length": 5,
"decimalValue": 0.767,
"tooltipValue": "Additional Information",
"visibleLine": "1",
"unique": false,
"extensible": false,
"configurable": false,
"displaySequence": 1,
"isVisible": false,
"configurationStage": "Product Offer Level",
"regex": "\"expression\": \"^[0-9]{9,13}$\",\n\"message\": \"Please enter a valid phone number\""
},
"errorDetails": [
{
"errorCode": "ERR-BM-OM-OV-OE-101",
"errorMessage": "Exception in Order Enrichment Process, Product Inventory Not Present"
}
],
"dynamicAttributes": [
{
"attributeName": "Data Throttling",
"attributeValue": "55738231121",
"attributeType": "String",
"lastModifiedDateTime": "2023-10-19T10:42:41.257Z",
"lastModifiedBy": "omui admin"
}
],
"isNetworkImpacting": false,
"isCharacteristicAmended": false
}
],
"@referredType": "BillingAccount",
"@type": "serviceOrder"
}
],
"productOffering": {
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account",
"externalID": "464bf14d-7373-4937-a73b-28217ac07528",
"owningSystem": "BlueMarble",
"owningSystemID": "owning system1001",
"relatedSystemName": "relatedsystem1001",
"referenceId": "data_service_specification_001",
"version": "1",
"status": "Closed",
"category": {
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account",
"version": null
},
"metaExtension": {
"dataSet": [
{
"name": "MobileOfferOM",
"genericData": {
"schemaRef": "OrderManagementOffer",
"valueSet": {}
},
"languages": [
{
"locale": "en-GB",
"name": "ENGLISH-IND, ENGLISH-US"
}
],
"channels": [
{
"id": "bo_lov_saleschannel_retail",
"name": "Retail"
}
],
"marketSegments": [
{
"id": "7894820397708LH425643",
"name": "Retail"
}
]
}
]
},
"productType": "Subscription",
"productLine": "Postpaid",
"offerClassification": "bo_lov_offerclassification_primary",
"@referredType": " BillingAccount ",
"@schemaLocation": "ProductOffering Collection",
"@type": "CFS",
"isAssetable": false
},
"billingAccount": {
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account",
"dynamicAttributes": [
{
"attributeName": "Data Throttling",
"attributeValue": "55738231121",
"attributeType": "String",
"lastModifiedDateTime": "2023-10-19T10:42:41.257Z",
"lastModifiedBy": "omui admin"
}
],
"financeSettlementRef": [
{
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account"
}
],
"paymentMethodRef": [
{
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account"
}
],
"itemPriceRef": [
{
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account"
}
],
"@baseType": "ProductOfferingPrice",
"@type": "Individual Party",
"@schemaLocation": "BillingAccount",
"@referredType": "BillingAccount"
},
"billingAccountList": [
{
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account",
"dynamicAttributes": [
{
"attributeName": "Data Throttling",
"attributeValue": "55738231121",
"attributeType": "String",
"lastModifiedDateTime": "2023-10-19T10:42:41.257Z",
"lastModifiedBy": "omui admin"
}
],
"financeSettlementRef": [
{
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account"
}
],
"paymentMethodRef": [
{
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account"
}
],
"itemPriceRef": [
{
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account"
}
],
"@baseType": "ProductOfferingPrice",
"@type": "Individual Party",
"@schemaLocation": "BillingAccount",
"@referredType": "BillingAccount"
}
],
"relatedParty": [
{
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account",
"role": "OM_DATA_MANAGER",
"type": "Individual Party",
"baseType": "ProductOfferingPrice",
"referredType": "BillingAccount",
"schemaLocation": "RelatedParty Collection",
"contactMedium": [
{
"baseType": "ProductOfferingPrice",
"type": "Individual Party",
"schemaLocation": "ContactMedium Collection",
"preferred": false,
"mediumType": "url",
"validFor": {
"startDateTime": "2023-08-11T09:17:41.866Z",
"endDateTime": "2023-08-11T09:17:41.866Z"
},
"characteristic": {
"baseType": "ProductOfferingPrice",
"type": "Individual Party",
"schemaLocation": "Contact Characteristics Collection",
"addressId": "#234",
"city": "Bengalore",
"contactType": "phone",
"country": "India",
"emailAddress": "example.@gmail.com",
"faxNumber": "212-111-2222",
"phoneNumber": "9856876322",
"postCode": "560064",
"socialNetworkId": "LinkedIn",
"stateOrProvince": "karnataka",
"street1": "RMZ Galleria",
"street2": "Office Block",
"houseNo": "56"
}
}
]
}
],
"productPrice": [
{
"description": "find details for product price",
"name": "Mobile Postpaid - Product Specification",
"offset": null,
"priceId": "1",
"priceType": "Onetime",
"recurringChargePeriod": "string",
"recurringChargePeriodLength": null,
"unitOfMeasure": "",
"tax": [
{
"taxType": "GST",
"externalID": "464bf14d-7373-4937-a73b-28217ac07528",
"id": "tax_automationtest-tx_bv8y95w",
"validFor": {
"startDateTime": "2023-08-11T09:17:41.866Z",
"endDateTime": "2023-08-11T09:17:41.866Z"
},
"@baseType": "Tax",
"@type": "Individual Type",
"taxAmount": {
"unit": "inr",
"value": 1000
},
"taxCategory": "Indian",
"taxRate": 20,
"name": "Tax_Automationtest",
"displayName": "Tax details",
"definesExemption": false,
"additionalAttributes": [
{
"name": "MSISDN",
"valueType": "String",
"value": "55738231121",
"action": "ADD",
"validationStatus": "PASSED",
"createdBy": "admin",
"lastModifiedBy": "system",
"lastModifiedDateTime": "2023-10-19T10:42:41.257Z",
"createdDateTime": "2023-10-19T10:42:41.257Z",
"enrichmentDetail": {},
"errorDetails": [],
"dynamicAttributes": [],
"isNetworkImpacting": false,
"isCharacteristicAmended": false
}
]
}
],
"priceSubType": "",
"isDownPaymentRequired": false,
"minimumDownPaymentAmount": null,
"id": "4cd250d9-e00e-4396-853b-2b244f0758dc",
"externalId": "string",
"@baseType": "ProductPrice",
"@schemaLocation": "price point collection",
"@type": "ProductPrice",
"itemPriceRelationship": [
{
"priceId": "P465",
"relationshipType": "FIXED_PRICE"
}
],
"price": {
"percentage": 10,
"taxRate": 10,
"actionCardinality": 10,
"taxAmount": 10,
"@baseType": "Price",
"@type": "Price",
"dutyFreeAmount": {
"unit": "inr",
"value": 1000
},
"taxIncludedAmount": {
"unit": "inr",
"value": 1000
},
"@schemaLocation": "Price Collection",
"dutyFreeAlteredAmount": {
"unit": "inr",
"value": 1000
},
"taxIncludedAlteredAmount": {
"unit": "inr",
"value": 1000
},
"changeAmount": {
"unit": "inr",
"value": 1000
},
"discount": {
"unit": "inr",
"value": 1000
},
"amountPayable": {
"unit": "inr",
"value": 1000
},
"taxFixed": {
"unit": "inr",
"value": 1000
}
},
"priceAlteration": [
{
"applicationDuration": 3,
"description": "Price Alteration Details",
"name": "ServiceOrder",
"priceAlterationType": "Discount",
"priceType": "recurring",
"priority": 2,
"recurringChargePeriod": "Month",
"referenceId": "data_service_specification_001",
"unitOfMeasure": "INR",
"@baseType": "PriceAlteration",
"@schemaLocation": "PriceAlteration Collection",
"@type": "recurring",
"price": {
"percentage": 10,
"taxRate": 10,
"actionCardinality": 10,
"taxAmount": 10,
"@baseType": "Price",
"@type": "Price",
"dutyFreeAmount": {
"unit": "inr",
"value": 1000
},
"taxIncludedAmount": {
"unit": "inr",
"value": 1000
},
"@schemaLocation": "Price Collection",
"dutyFreeAlteredAmount": {
"unit": "inr",
"value": 1000
},
"taxIncludedAlteredAmount": {
"unit": "inr",
"value": 1000
},
"changeAmount": {
"unit": "inr",
"value": 1000
},
"discount": {
"unit": "inr",
"value": 1000
},
"amountPayable": {
"unit": "inr",
"value": 1000
},
"taxFixed": {
"unit": "inr",
"value": 1000
}
},
"productOfferingPrice": {
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account",
"@baseType": "ProductOfferingPrice",
"@referredType": "ProductOfferingPrice Type",
"@schemaLocation": "ProductOfferingPrice Collection",
"@type": "individual Type"
}
}
],
"productOfferingPrice": {
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account",
"@baseType": "ProductOfferingPrice",
"@referredType": "ProductOfferingPrice Type",
"@schemaLocation": "ProductOfferingPrice Collection",
"@type": "individual Type"
},
"offsetParameter": {
"numberofBlock": 2,
"totalAllowanceSelectionCount": 4,
"isCalenderBased": true,
"discountType": "FIXED_PRICE",
"billingDiscountExternalRef": "BD2024-123456",
"discountValue": 10,
"allowedDiscount": [
{
"block": 1,
"allowedSelectionCount": null,
"allowedSelectionPeriod": "2022-08-08 13:09:00.612Z",
"selectedDiscountPeriod": "2022-08-08 13:09:00.612Z"
}
]
},
"isAgreementBased": true,
"code": "401 UNAUTHORIZED",
"specCharacteristics": [
{
"name": "SMS Allowance",
"value": "50SMS",
"valueType": "String"
}
],
"isProrated": false,
"isArrears": false,
"validFor": {
"startDateTime": "2023-08-11T09:17:41.866Z",
"endDateTime": "2023-08-11T09:17:41.866Z"
}
}
],
"productOrderItem": [
{
"orderItemAction": "ADD",
"orderItemId": "1",
"productOrderHref": "string",
"productOrderId": "557ae80c-b612-48f0-a57e-cd3a0eb1dc2c",
"role": "ServiceAddress"
}
],
"productSpecification": {
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account",
"externalId": "464bf14d-7373-4937-a73b-28217ac07528",
"externalName": "",
"owningSystem": "BlueMarble",
"owningSystemID": "owning system1001",
"relatedSystemName": "relatedsystem1001",
"status": "Open",
"referenceId": "data_service_specification_001",
"version": "1",
"metaExtension": {
"dataSet": [
{
"name": "MobileOfferOM",
"genericData": {
"schemaRef": "OrderManagementOffer",
"valueSet": {}
},
"languages": [
{
"locale": "en-GB",
"name": "ENGLISH-IND, ENGLISH-US"
}
],
"channels": [
{
"id": "bo_lov_saleschannel_retail",
"name": "Retail"
}
],
"marketSegments": [
{
"id": "7894820397708LH425643",
"name": "Retail"
}
]
}
]
},
"@type": "CFS",
"@referredType": " BillingAccount ",
"@schemaLocation": "ServiceSpecification Collection"
},
"productTerm": [
{
"description": "description for ProductTerm",
"name": "addItemThroughRules",
"durationUnit": "MONTH",
"duration": "12.0",
"validFor": {
"startDateTime": "2023-08-11T09:17:41.866Z",
"endDateTime": "2023-08-11T09:17:41.866Z"
}
}
],
"realizingResource": [
{
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account",
"value": "6767453"
}
],
"realizingService": [
{
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account"
}
],
"productRelationship": [
{
"relationshipType": "dependecy",
"product": ""
}
],
"reasonCode": "DUNNING",
"actionCode": "ACTION 2",
"checkoutData": [
{
"sectionId": "address",
"steps": [
{
"fields": [
{
"name": "Bill Format",
"value": "pdf"
}
],
"stepId": "billingAddressDetails",
"stepUId": "86c5e62d-f176-4434-b56c-bf7234429f1d",
"options": [
{
"name": "Bill Format",
"value": "pdf",
"fields": []
}
],
"offerContainerId": "5432373c-6f65-46f8-a8b5-879a8df5b576",
"cartItemId": "4a885452-ca92-45b8-933c-d35ad1b2e827",
"sequence": "0",
"groupByLevel": false,
"stepDataRefChoice": false,
"orderMgmtMapping": [
{
"fieldMapping": [],
"orderObjectPath": ""
}
]
}
],
"sectionUId": "5ba4aea8-184c-4d88-9906-143998869677"
}
],
"productLineCategory": "bm-postpaid-highend",
"parentBundleId": "bm-postpaid-highend"
},
"note": [
{
"id": "45",
"author": "Jack smith",
"createdDateTime": "2023-10-19T10:42:41.257Z",
"lastModifiedDateTime": "2023-10-19T10:42:41.257Z",
"system": "CHECKOUT",
"text": "This is quite important, please approach me as soon as possible"
}
],
"portability": {
"description": "find details for Portability",
"requestType": "PORT_IN",
"portingDate": "2023-10-19T10:42:41.257Z",
"portingApprovalDate": "2023-10-19T10:42:41.257Z",
"portingStatus": "COMPLETED",
"donorProvider": "",
"donorNumber": "20240",
"donorContractId": "70098909000",
"donorCustomerName": "intadmin",
"donorCustomerAddress": {
"id": "c63784c1-1d57-4b31-b61e-900db2d8f6e7",
"href": "/product-management/serviceSpecification/?id%3Dsms_service_specification_001%26version%3D1",
"name": "SMS - Service Specification",
"role": "ServiceAddress",
"locationId": "LRW245",
"flag": "ACTIVE",
"fullAddress": "RMZ Galleria Office BLock,Yelahanka New Town",
"streetNr": "52",
"streetNrSuffix": "153",
"streetNrLast": "754",
"streetNrLastSuffix": "5765",
"streetName": "Pell Street",
"streetType": "Street",
"streetSuffix": "52",
"postCode": "SE85ES",
"locality": "London",
"city": "Pune",
"stateOrProvince": "England",
"country": "United Kingdom",
"geoLocationRefOrValue": {
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account",
"geometryType": "Point",
"accuracy": "100 meters",
"spatialRef": "WGS 84",
"type": "ProductOfferingPrice",
"schemaLocation": "Geolocation Collection",
"geometry": [
{
"latitude": "13.3379° N",
"longitude": "77.1173° E",
"geographicDatum": "NAVD88"
}
]
},
"geographicSubAddress": [
{
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account",
"type": "SubUnit",
"subUnitType": "Apartment",
"subUnitNumber": "1234",
"levelType": "Floor",
"levelNumber": "2",
"buildingName": "Acme Corporation Building",
"privateStreetNumber": "123",
"privateStreetName": "Main Street"
}
],
"serviceability": [
{
"id": "sms_service_specification_001",
"type": "CFS",
"attributes": {
"category": "enterprise",
"availability": {
"key": "PRODUCT_CODE",
"value": "6767453"
},
"items": [
{
"key": "PRODUCT_CODE",
"value": "6767453"
}
]
}
}
],
"contactDetails": [
{
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account",
"role": "OM_DATA_MANAGER",
"type": "Individual Party",
"baseType": "ProductOfferingPrice",
"referredType": "BillingAccount",
"schemaLocation": "RelatedParty Collection",
"contactMedium": [
{
"baseType": "ProductOfferingPrice",
"type": "Individual Party",
"schemaLocation": "ContactMedium Collection",
"preferred": false,
"mediumType": "url",
"validFor": {
"startDateTime": "2023-08-11T09:17:41.866Z",
"endDateTime": "2023-08-11T09:17:41.866Z"
},
"characteristic": {
"baseType": "ProductOfferingPrice",
"type": "Individual Party",
"schemaLocation": "Contact Characteristics Collection",
"addressId": "#234",
"city": "Bengalore",
"contactType": "phone",
"country": "India",
"emailAddress": "example.@gmail.com",
"faxNumber": "212-111-2222",
"phoneNumber": "9856876322",
"postCode": "560064",
"socialNetworkId": "LinkedIn",
"stateOrProvince": "karnataka",
"street1": "RMZ Galleria",
"street2": "Office Block",
"houseNo": "56"
}
}
]
}
]
},
"additionalCharacteristics": [
{
"attributeName": "Data Throttling",
"attributeValue": "55738231121",
"attributeType": "String",
"lastModifiedDateTime": "2023-10-19T10:42:41.257Z",
"lastModifiedBy": "omui admin"
}
],
"createdBy": "om_admin",
"createdDateTime": "2023-10-19T10:42:41.257Z",
"lastModifiedBy": "om_admin",
"lastModifiedDateTime": "2023-10-19T10:42:41.257Z"
},
"isOfferAmended": false,
"portfolioDetails": {
"portfolioId": "BP1698224881607424",
"productLineCategory": "bm-postpaid-highend",
"offerContainerCategory": "bm-postpaid-highend",
"href": "https://host:port/paymentManagement/v4/cashPayment/2365",
"childProduct": [
{
"childProductOrderItemId": "9be74937-4927-4924-b2bb-d7a4dd401f1a",
"childInstallBaseId": "RUM1660733938024415",
"childSpecificationName": "Fiber Port",
"childCpoId": "CPO7894820397708LH425",
"inventory": false,
"state": "ACTIVE"
}
],
"parentProduct": {
"parentProductOrderItemId": "e2346",
"parentInstallBaseId": "BP1698224881533778",
"parentSpecificationName": "Mobile Postpaid - Product Specification",
"inventory": false,
"parentCpoId": "CPO7894820397708LH425",
"state": "ACTIVE"
}
},
"promotions": [
{
"category": "Managed SDWAN Service",
"id": "automation_promotion-pm_20eewvb",
"internalLifecycleStatus": "Test",
"description": "Promotion",
"lifeCycleStatus": "Test",
"name": "Automation_Promotion_678new",
"priority": 2,
"promoApplicationLevel": "cart",
"signature": "cartSignature",
"type": "Promotion",
"promotionAction": {
"actionCardinality": null,
"actionObjectId": "bm-samsung-product-bundle",
"actionType": "Add Product",
"actionValue": 2,
"applicationDuration": 1,
"cartItemId": "5432373c-6f65-46f8-a8b5-879a8df5b576",
"id": "pa_j6w82",
"maxActionValue": "3",
"priceId": "op_0nwf2jj",
"priceType": "recurring",
"priority": 4,
"recurringChargePeriodType": "Month"
},
"promotionClassification": "exclusive",
"coupon": {
"id": "54765",
"code": "MY_COUPON_CODE",
"coupon": false
},
"validFor": {
"startDateTime": "2023-08-11T09:17:41.866Z",
"endDateTime": "2023-08-11T09:17:41.866Z"
}
}
],
"additionalAttributes": [
{
"name": "MSISDN",
"valueType": "String",
"value": "55738231121",
"action": "ADD",
"validationStatus": "PASSED",
"createdBy": "admin",
"lastModifiedBy": "system",
"lastModifiedDateTime": "2023-10-19T10:42:41.257Z",
"createdDateTime": "2023-10-19T10:42:41.257Z",
"enrichmentDetail": {
"description": "Description of character",
"specType": "ServiceSpecification",
"referenceId": "data_service_specification_001",
"valueType": "List",
"minCardinality": null,
"maxCardinality": 1,
"characteristicValues": [
{
"valueType": "String",
"value": "True",
"validFor": {
"startDateTime": "2023-08-11T09:17:41.866Z",
"endDateTime": "2023-08-11T09:17:41.866Z"
},
"default": false,
"rangeInterval": "closedTop",
"regex": null,
"unitOfMeasure": "GB"
}
],
"validFor": {
"startDateTime": "2023-08-11T09:17:41.866Z",
"endDateTime": "2023-08-11T09:17:41.866Z"
},
"format": "String",
"length": 5,
"decimalValue": 0.767,
"tooltipValue": "Additional Information",
"visibleLine": "1",
"unique": false,
"extensible": false,
"configurable": false,
"displaySequence": 1,
"isVisible": false,
"configurationStage": "Product Offer Level",
"regex": "\"expression\": \"^[0-9]{9,13}$\",\n\"message\": \"Please enter a valid phone number\""
},
"errorDetails": [
{
"errorCode": "ERR-BM-OM-OV-OE-101",
"errorMessage": "Exception in Order Enrichment Process, Product Inventory Not Present"
}
],
"dynamicAttributes": [
{
"attributeName": "Data Throttling",
"attributeValue": "55738231121",
"attributeType": "String",
"lastModifiedDateTime": "2023-10-19T10:42:41.257Z",
"lastModifiedBy": "omui admin"
}
],
"isNetworkImpacting": false,
"isCharacteristicAmended": false
}
],
"productFeasibility": {
"validTill": {
"endDateTime": "2023-10-19T10:42:41.257Z",
"startDateTime": "2023-10-19T10:42:41.257Z"
},
"remark": "remark",
"approvedBy": "System",
"qualified": false,
"attributes": [
{
"name": "attribute_fa",
"value": "50SMS",
"valueType": "string,number,boolean",
"array": false,
"viewOnly": false,
"quantityBased": false
}
]
},
"dueDateJeopardyCategory": true,
"expDueDateJeopardyCategory": false,
"checkoutProductDetails": {
"type": "quote",
"associatedOCId": "",
"associatedCIId": "",
"associatedSiteId": "",
"source": "",
"externalId": "464bf14d-7373-4937-a73b-28217ac07528",
"overridePrice": 10,
"additionalAttributes": [
{
"name": "Order Level",
"value": "43654"
}
]
},
"bypassCharpoValidation": false,
"resourceAllocation": false,
"baseInstallBaseId": "BP1691740391567152",
"parallelInstallBaseId": "RUM1660733938024419",
"baseServiceTermination": false,
"isAmendOrderItem": false,
"isPreviousOrderItemState": true
}
],
"orderTotalPrice": [
{
"description": "Order Price Details",
"name": "robin_rf",
"recurringChargePeriod": "Monthly",
"priceType": "recurring",
"recurringChargePeriodLength": 1,
"offset": 3,
"tax": [
{
"taxType": "GST",
"externalID": "464bf14d-7373-4937-a73b-28217ac07528",
"id": "tax_automationtest-tx_bv8y95w",
"validFor": {
"startDateTime": "2023-08-11T09:17:41.866Z",
"endDateTime": "2023-08-11T09:17:41.866Z"
},
"@baseType": "Tax",
"@type": "Individual Type",
"taxAmount": {
"unit": "inr",
"value": 1000
},
"taxCategory": "Indian",
"taxRate": 20,
"name": "Tax_Automationtest",
"displayName": "Tax details",
"definesExemption": false,
"additionalAttributes": [
{
"name": "MSISDN",
"valueType": "String",
"value": "55738231121",
"action": "ADD",
"validationStatus": "PASSED",
"createdBy": "admin",
"lastModifiedBy": "system",
"lastModifiedDateTime": "2023-10-19T10:42:41.257Z",
"createdDateTime": "2023-10-19T10:42:41.257Z",
"enrichmentDetail": {
"description": "Description of character",
"specType": "ServiceSpecification",
"referenceId": "data_service_specification_001",
"valueType": "List",
"minCardinality": null,
"maxCardinality": 1,
"characteristicValues": [
{
"valueType": "String",
"value": "True",
"validFor": {},
"default": false,
"rangeInterval": "closedTop",
"regex": null,
"unitOfMeasure": "GB"
}
],
"validFor": {
"startDateTime": "2023-08-11T09:17:41.866Z",
"endDateTime": "2023-08-11T09:17:41.866Z"
},
"format": "String",
"length": 5,
"decimalValue": 0.767,
"tooltipValue": "Additional Information",
"visibleLine": "1",
"unique": false,
"extensible": false,
"configurable": false,
"displaySequence": 1,
"isVisible": false,
"configurationStage": "Product Offer Level",
"regex": "\"expression\": \"^[0-9]{9,13}$\",\n\"message\": \"Please enter a valid phone number\""
},
"errorDetails": [
{
"errorCode": "ERR-BM-OM-OV-OE-101",
"errorMessage": "Exception in Order Enrichment Process, Product Inventory Not Present"
}
],
"dynamicAttributes": [
{
"attributeName": "Data Throttling",
"attributeValue": "55738231121",
"attributeType": "String",
"lastModifiedDateTime": "2023-10-19T10:42:41.257Z",
"lastModifiedBy": "omui admin"
}
],
"isNetworkImpacting": false,
"isCharacteristicAmended": false
}
]
}
],
"priceId": "op_0nwf2jj",
"priceSubType": "recurring",
"unitOfMeasure": "INR",
"@baseType": "OrderPrice",
"@schemaLocation": "OrderPrice Collection",
"price": {
"percentage": 10,
"taxRate": 10,
"actionCardinality": 10,
"taxAmount": 10,
"@baseType": "Price",
"@type": "Price",
"dutyFreeAmount": {
"unit": "inr",
"value": 1000
},
"taxIncludedAmount": {
"unit": "inr",
"value": 1000
},
"@schemaLocation": "Price Collection",
"dutyFreeAlteredAmount": {
"unit": "inr",
"value": 1000
},
"taxIncludedAlteredAmount": {
"unit": "inr",
"value": 1000
},
"changeAmount": {
"unit": "inr",
"value": 1000
},
"discount": {
"unit": "inr",
"value": 1000
},
"amountPayable": {
"unit": "inr",
"value": 1000
},
"taxFixed": {
"unit": "inr",
"value": 1000
}
},
"@type": "OrderPrice",
"priceAlteration": [
{
"applicationDuration": 3,
"description": "Price Alteration Details",
"name": "ServiceOrder",
"priceAlterationType": "Discount",
"priceType": "recurring",
"priority": 2,
"recurringChargePeriod": "Month",
"referenceId": "data_service_specification_001",
"unitOfMeasure": "INR",
"@baseType": "PriceAlteration",
"@schemaLocation": "PriceAlteration Collection",
"@type": "recurring",
"price": {
"percentage": 10,
"taxRate": 10,
"actionCardinality": 10,
"taxAmount": 10,
"@baseType": "Price",
"@type": "Price",
"dutyFreeAmount": {
"unit": "inr",
"value": 1000
},
"taxIncludedAmount": {
"unit": "inr",
"value": 1000
},
"@schemaLocation": "Price Collection",
"dutyFreeAlteredAmount": {
"unit": "inr",
"value": 1000
},
"taxIncludedAlteredAmount": {
"unit": "inr",
"value": 1000
},
"changeAmount": {
"unit": "inr",
"value": 1000
},
"discount": {
"unit": "inr",
"value": 1000
},
"amountPayable": {
"unit": "inr",
"value": 1000
},
"taxFixed": {
"unit": "inr",
"value": 1000
}
},
"productOfferingPrice": {
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account",
"@baseType": "ProductOfferingPrice",
"@referredType": "ProductOfferingPrice Type",
"@schemaLocation": "ProductOfferingPrice Collection",
"@type": "individual Type"
}
}
],
"productOfferingPrice": {
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account",
"@baseType": "ProductOfferingPrice",
"@referredType": "ProductOfferingPrice Type",
"@schemaLocation": "ProductOfferingPrice Collection",
"@type": "individual Type"
},
"itemPriceRelationship": [
{
"priceId": "P465",
"relationshipType": "FIXED_PRICE"
}
],
"validFor": {
"endDateTime": "2023-10-19T10:42:41.257Z",
"startDateTime": "2023-10-19T10:42:41.257Z"
},
"isDownPaymentRequired": false,
"minimumDownPaymentAmount": null,
"isAgreementBased": false,
"offsetParameter": {
"numberofBlock": 2,
"totalAllowanceSelectionCount": 4,
"isCalenderBased": true,
"discountType": "FIXED_PRICE",
"billingDiscountExternalRef": "BD2024-123456",
"discountValue": 10,
"allowedDiscount": [
{
"block": 1,
"allowedSelectionCount": null,
"allowedSelectionPeriod": "2022-08-08 13:09:00.612Z",
"selectedDiscountPeriod": "2022-08-08 13:09:00.612Z"
}
]
},
"code": "PC_de716bb0",
"externalId": "prepaidplan_a-1_price_2-0_v1||123",
"id": "9a058452-d5c7-4ec2-9f3d-1ecc34d120ee",
"specCharacteristics": [
{
"name": "SMS Allowance",
"value": "50SMS",
"valueType": "String"
}
],
"isProrated": false,
"isArrears": false
}
],
"productOfferingQualification": [
{
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account"
}
],
"customerAccount": {
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account",
"dynamicAttributes": [
{
"attributeName": "Data Throttling",
"attributeValue": "55738231121",
"attributeType": "String",
"lastModifiedDateTime": "2023-10-19T10:42:41.257Z",
"lastModifiedBy": "omui admin"
}
],
"partyRef": [
{
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account"
}
],
"partyRoleRef": [
{
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account"
}
],
"aggrementRef": [
{
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account"
}
],
"paymentMethodRef": [
{
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account"
}
]
},
"billingAccount": {
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account",
"dynamicAttributes": [
{
"attributeName": "Data Throttling",
"attributeValue": "55738231121",
"attributeType": "String",
"lastModifiedDateTime": "2023-10-19T10:42:41.257Z",
"lastModifiedBy": "omui admin"
}
],
"financeSettlementRef": [
{
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account"
}
],
"paymentMethodRef": [
{
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account"
}
],
"itemPriceRef": [
{
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account"
}
],
"@baseType": "ProductOfferingPrice",
"@type": "Individual Party",
"@schemaLocation": "BillingAccount",
"@referredType": "BillingAccount"
},
"billingAccountList": [
{
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account",
"dynamicAttributes": [
{
"attributeName": "Data Throttling",
"attributeValue": "55738231121",
"attributeType": "String",
"lastModifiedDateTime": "2023-10-19T10:42:41.257Z",
"lastModifiedBy": "omui admin"
}
],
"financeSettlementRef": [
{
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account"
}
],
"paymentMethodRef": [
{
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account"
}
],
"itemPriceRef": [
{
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account"
}
],
"@baseType": "ProductOfferingPrice",
"@type": "Individual Party",
"@schemaLocation": "BillingAccount",
"@referredType": "BillingAccount"
}
],
"isAmendOrder": false,
"isAmendOrderWithCancel": false,
"isValidatedPOQ": false,
"externalOrderReferenceNumber": "879A",
"externalOrderId": "464bf14d-7373-4937-a73b-28217ac07528",
"marketSegment": {
"id": "7894820397708LH425643",
"name": "Retail"
},
"additionalAttributes": [
{
"name": "MSISDN",
"valueType": "String",
"value": "55738231121",
"action": "ADD",
"validationStatus": "PASSED",
"createdBy": "admin",
"lastModifiedBy": "system",
"lastModifiedDateTime": "2023-10-19T10:42:41.257Z",
"createdDateTime": "2023-10-19T10:42:41.257Z",
"enrichmentDetail": {
"description": "Description of character",
"specType": "ServiceSpecification",
"referenceId": "data_service_specification_001",
"valueType": "List",
"minCardinality": null,
"maxCardinality": 1,
"characteristicValues": [
{
"valueType": "String",
"value": "True",
"validFor": {
"startDateTime": "2023-08-11T09:17:41.866Z",
"endDateTime": "2023-08-11T09:17:41.866Z"
},
"default": false,
"rangeInterval": "closedTop",
"regex": null,
"unitOfMeasure": "GB"
}
],
"validFor": {
"startDateTime": "2023-08-11T09:17:41.866Z",
"endDateTime": "2023-08-11T09:17:41.866Z"
},
"format": "String",
"length": 5,
"decimalValue": 0.767,
"tooltipValue": "Additional Information",
"visibleLine": "1",
"unique": false,
"extensible": false,
"configurable": false,
"displaySequence": 1,
"isVisible": false,
"configurationStage": "Product Offer Level",
"regex": "\"expression\": \"^[0-9]{9,13}$\",\n\"message\": \"Please enter a valid phone number\""
},
"errorDetails": [
{
"errorCode": "ERR-BM-OM-OV-OE-101",
"errorMessage": "Exception in Order Enrichment Process, Product Inventory Not Present"
}
],
"dynamicAttributes": [
{
"attributeName": "Data Throttling",
"attributeValue": "55738231121",
"attributeType": "String",
"lastModifiedDateTime": "2023-10-19T10:42:41.257Z",
"lastModifiedBy": "omui admin"
}
],
"isNetworkImpacting": false,
"isCharacteristicAmended": false
}
],
"promotions": [
{
"category": "Managed SDWAN Service",
"id": "automation_promotion-pm_20eewvb",
"internalLifecycleStatus": "Test",
"description": "Promotion",
"lifeCycleStatus": "Test",
"name": "Automation_Promotion_678new",
"priority": 2,
"promoApplicationLevel": "cart",
"signature": "cartSignature",
"type": "Promotion",
"promotionAction": {
"actionCardinality": null,
"actionObjectId": "bm-samsung-product-bundle",
"actionType": "Add Product",
"actionValue": 2,
"applicationDuration": 1,
"cartItemId": "5432373c-6f65-46f8-a8b5-879a8df5b576",
"id": "pa_j6w82",
"maxActionValue": "3",
"priceId": "op_0nwf2jj",
"priceType": "recurring",
"priority": 4,
"recurringChargePeriodType": "Month"
},
"promotionClassification": "exclusive",
"coupon": {
"id": "54765",
"code": "MY_COUPON_CODE",
"coupon": false
},
"validFor": {
"startDateTime": "2023-08-11T09:17:41.866Z",
"endDateTime": "2023-08-11T09:17:41.866Z"
}
}
],
"nonRecurringPriceAdjustment": [
{
"id": "c63784c1-1d57-4b31-b61e-900db2d8f6e7",
"amount": null,
"details": [
{
"name": "SMS Allowance",
"value": "50SMS"
}
],
"name": "SMS Allowance",
"referenceId": "data_service_specification_001",
"type": "Physical"
}
],
"customerOrderType": "NEW",
"jeopardyFlag": false,
"visibleFlag": "yes,no",
"isLargeOrder": false,
"parentOrderId": "881a6d15-bcbe-4372-b48a-41cba29f4806",
"parentCpoId": "CPO2477328421161597NQ575",
"subOrderMetaData": [
{
"subOrderId": "1",
"state": "COMPLETED",
"status": "Provisioning - Completed",
"subOrderCpoId": "CPO2477328421161597NQ575",
"productSubOrderItemRef": [
{
"productSubOrderItemId": "3e934f5f-4fb7-4e01-a33d-4bd7c33f5828",
"installbaseId": "BP1686636408708199",
"productName": "Mobile",
"productOrderItemType": "New Order"
}
]
}
],
"priority": "HIGHEST, LOW",
"processingPriority": "High",
"priorityRelayTopics": [
{
"moduleName": "",
"relayTopicName": "",
"prioritySequence": "",
"processingPriority": ""
}
],
"isPortabilityOrder": false
}What made this section unhelpful for you?
Create Product Order
This method oversees the initiation of a fresh customer order using POST operation. It manages incoming requests, configures the customer order with suitable status and metadata, stores it persistently, and triggers an event for subsequent actions. Moreover, it adeptly addresses potential exceptions that may arise during the creation process, ensuring thorough error handling and logging. Invocations of this method originate from either the Order Generator Service or the quote-management module. It performs initial validation on incoming requests, verifying the presence of ProductOrderItem with unique IDs. Subsequently, the API persists the Customer Order in MongoDB and initiates an event for subsequent processing, including decomposition and fulfillment
Header Parameters
Unique identifier for tracking the transaction.
Identifier for correlating related requests and responses.
Source channel or origin of the request.
Identifier of the associated tenant or customer.
Body Parameters
A string.The unique identifier associated with a Customer Purchase Order (CPO)
A date time (DateTime). Date when the product order was cancelled.
CancellationReason is the specific explanation for the cancellation of a ProductOrderRequest
A date time (DateTime). Effective delivery date amended by the provider.
expectedCompletionDate typically represents the anticipated date for Request completion
A string. Contact attached to the order to send back information regarding this order.
orderDate represents the timestamp when the order was placed for products
A date time (DateTime). Requested delivery date from the requestors perspective.
A date time (DateTime). the preferred initiation date for a requested productOrder
A date time (DateTime).The date on which the ordered product was actually initiated or commenced
A product order state type (ProductOrderStateType). State of the order: described in the state-machine diagram.
ACKNOWLEDGEDREJECTEDPENDINGHELDIN_PROGRESSCONFIRMEDCANCELLEDACTIVECOMPLETEDFAILED... 5 other enums
Status represents the current stage of a requested productOrder.
A list of related parties. Related Entity reference A related party defines party or party role linked to a specific entity.
Show child attributes
A string. Hyperlink to access the order
A string. ID given by the consumer to facilitate searches
A string.Description is a narrative text describing the content of the ProductOrderRequest
A string. Used to categorize the order, useful for the OM system, such as: Broadband, TVOption.
CreatedBy identifies the entity responsible for creating the ProductOrderRequest
The date and time when the ProductOrderRequest was initially created
LastModifiedBy indicates the entity who made last modifications to the ProductOrder
LastModifiedDateTime indicates the date and time when the ProductOrderRequest was last modified
List of Offer Container details
Show child attributes
List of Portfolio Container details
Show child attributes
This is signature field generated for individual promotion that can be applied in cart for individual offer container
Show child attributes
A unique identifier for the original order that forms the basis for subsequent amendments
Identifier assigned to a request for amending or modifying a specific product order
Type or category of the order.
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.
Show child attributes
A list of agreement references (AgreementRef [*]). A reference to an agreement defined in the context of the product order.
Show child attributes
A list of related channels (RelatedChannel [*]). Related channel to another entity. May be online web, mobile app, social ,etc.
Show child attributes
A list of notes (Note [*]). Extra information about a given entity.
Show child attributes
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.
Show child attributes
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.
Show child attributes
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.
Show child attributes
A list of product offering qualification references It's a productOfferingQualification that has been executed previously.
Show child attributes
The account of the customer who has placed the order for a product
Show child attributes
A billing account reference (BillingAccountRef). A BillingAccount is a detailed description of a bill structure.
Show child attributes
A billing account reference (BillingAccountRef). A BillingAccount is a detailed description of a bill structure.
Show child attributes
OrderAmendmentFlag indicates whether any modifications or changes have been applied to the original order
Boolean value true to notify whether order is amend with cancel or not by default false.
ValidatedPOQFlag is an indicator signaling the validation status of a Purchase Order Quantity (POQ) within a process
A distinct identifier linked to orders from external sources, facilitating tracking and integration
ExternalOrderId is a unique identifier assigned to orders from external sources for effective tracking and management
This is the market segment(s) for which this particular metaExtension will be applicable
Show child attributes
List of Characteristics Additional attributes
Show child attributes
list of promotions to store instances of the Promotion
Show child attributes
List of the Non recurring price adjustment.
Show child attributes
customerOrderType for B2B or B2C indentification
The jeopardyFlag is a boolean indicator used to signal and handle critical situations in the ProductOrderRequest
Visible Flag refers to the visibility status of an element or feature in the ProductOrderRequest
Large Order flag decide if Order is large Order and it has more Line Items that predefined number of line items
A string.OrderId is a unique identifier assigned to a specific for Parent Order Id for Large Order
A string.The unique identifier associated with a Customer Purchase Order (CPO) for Parent Order Id for Large Order
list of subOrders MetaData for large Order
Show child attributes
priority indicates request in which should be addressed for escalation, with values such as High,Medium, or Low
A string.processingPriority indicates request in which productOrder should be addressed, with values such as High,Medium, or Low
A List of module vs topic name mapping for priority processing
Show child attributes
The portabilityOrder attribute is an essential tool for maintaining a structured and organized approach to portability.
Response
Response Attributes
A string.The unique identifier associated with a Customer Purchase Order (CPO)
A date time (DateTime). Date when the product order was cancelled.
CancellationReason is the specific explanation for the cancellation of a ProductOrderRequest
A date time (DateTime). Effective delivery date amended by the provider.
expectedCompletionDate typically represents the anticipated date for Request completion
A string. Contact attached to the order to send back information regarding this order.
orderDate represents the timestamp when the order was placed for products
A date time (DateTime). Requested delivery date from the requestors perspective.
A date time (DateTime). the preferred initiation date for a requested productOrder
A date time (DateTime).The date on which the ordered product was actually initiated or commenced
A product order state type (ProductOrderStateType). State of the order: described in the state-machine diagram.
ACKNOWLEDGEDREJECTEDPENDINGHELDIN_PROGRESSCONFIRMEDCANCELLEDACTIVECOMPLETEDFAILED... 5 other enums
Status represents the current stage of a requested productOrder.
A list of related parties. Related Entity reference A related party defines party or party role linked to a specific entity.
Show child attributes
A string. Hyperlink to access the order
A string. ID given by the consumer to facilitate searches
A string.Description is a narrative text describing the content of the ProductOrderRequest
A string. Used to categorize the order, useful for the OM system, such as: Broadband, TVOption.
CreatedBy identifies the entity responsible for creating the ProductOrderRequest
The date and time when the ProductOrderRequest was initially created
LastModifiedBy indicates the entity who made last modifications to the ProductOrder
LastModifiedDateTime indicates the date and time when the ProductOrderRequest was last modified
List of Offer Container details
Show child attributes
List of Portfolio Container details
Show child attributes
This is signature field generated for individual promotion that can be applied in cart for individual offer container
Show child attributes
A unique identifier for the original order that forms the basis for subsequent amendments
Identifier assigned to a request for amending or modifying a specific product order
Type or category of the order.
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.
Show child attributes
A list of agreement references (AgreementRef [*]). A reference to an agreement defined in the context of the product order.
Show child attributes
A list of related channels (RelatedChannel [*]). Related channel to another entity. May be online web, mobile app, social ,etc.
Show child attributes
A list of notes (Note [*]). Extra information about a given entity.
Show child attributes
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.
Show child attributes
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.
Show child attributes
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.
Show child attributes
A list of product offering qualification references It's a productOfferingQualification that has been executed previously.
Show child attributes
The account of the customer who has placed the order for a product
Show child attributes
A billing account reference (BillingAccountRef). A BillingAccount is a detailed description of a bill structure.
Show child attributes
A billing account reference (BillingAccountRef). A BillingAccount is a detailed description of a bill structure.
Show child attributes
OrderAmendmentFlag indicates whether any modifications or changes have been applied to the original order
Boolean value true to notify whether order is amend with cancel or not by default false.
ValidatedPOQFlag is an indicator signaling the validation status of a Purchase Order Quantity (POQ) within a process
A distinct identifier linked to orders from external sources, facilitating tracking and integration
ExternalOrderId is a unique identifier assigned to orders from external sources for effective tracking and management
This is the market segment(s) for which this particular metaExtension will be applicable
Show child attributes
List of Characteristics Additional attributes
Show child attributes
list of promotions to store instances of the Promotion
Show child attributes
List of the Non recurring price adjustment.
Show child attributes
customerOrderType for B2B or B2C indentification
The jeopardyFlag is a boolean indicator used to signal and handle critical situations in the ProductOrderRequest
Visible Flag refers to the visibility status of an element or feature in the ProductOrderRequest
Large Order flag decide if Order is large Order and it has more Line Items that predefined number of line items
A string.OrderId is a unique identifier assigned to a specific for Parent Order Id for Large Order
A string.The unique identifier associated with a Customer Purchase Order (CPO) for Parent Order Id for Large Order
list of subOrders MetaData for large Order
Show child attributes
priority indicates request in which should be addressed for escalation, with values such as High,Medium, or Low
A string.processingPriority indicates request in which productOrder should be addressed, with values such as High,Medium, or Low
A List of module vs topic name mapping for priority processing
Show child attributes
The portabilityOrder attribute is an essential tool for maintaining a structured and organized approach to portability.
Response Attributes
A Date,Error creation date and time
A String,A error code provides specific error code which occurred
A error,A error reason provides the specific reason why error occurred
Error message,A error message provides the specific message which occurred
Error stacktrace,A error stacktrace provides the stacktrace for error occurred
Response Attributes
A Date,Error creation date and time
A String,A error code provides specific error code which occurred
A error,A error reason provides the specific reason why error occurred
Error message,A error message provides the specific message which occurred
Error stacktrace,A error stacktrace provides the stacktrace for error occurred
Response Attributes
A Date,Error creation date and time
A String,A error code provides specific error code which occurred
A error,A error reason provides the specific reason why error occurred
Error message,A error message provides the specific message which occurred
Error stacktrace,A error stacktrace provides the stacktrace for error occurred
Response Attributes
A Date,Error creation date and time
A String,A error code provides specific error code which occurred
A error,A error reason provides the specific reason why error occurred
Error message,A error message provides the specific message which occurred
Error stacktrace,A error stacktrace provides the stacktrace for error occurred
Response Attributes
A numeric or alphanumeric code that represents a specific error or issue encountered during an operation.
A human-readable message that provides additional details about the error. It offers context and information to help users or developers understand what went wrong
A timestamp indicating when the error occurred, typically in a standardized format such as ISO 8601. It helps with debugging and tracking issues over time
An HTTP status code that indicates the outcome of the request or operation. Common examples include 200 (OK), 404 (Not Found), or 500 (Internal Server Error).
The URL or endpoint that was accessed when the error occurred. It specifies the location of the request that led to the error.
Response Attributes
A Date,Error creation date and time
A String,A error code provides specific error code which occurred
A error,A error reason provides the specific reason why error occurred
Error message,A error message provides the specific message which occurred
Error stacktrace,A error stacktrace provides the stacktrace for error occurred
Response Attributes
A Date,Error creation date and time
A String,A error code provides specific error code which occurred
A error,A error reason provides the specific reason why error occurred
Error message,A error message provides the specific message which occurred
Error stacktrace,A error stacktrace provides the stacktrace for error occurred
Response Attributes
A Date,Error creation date and time
A String,A error code provides specific error code which occurred
A error,A error reason provides the specific reason why error occurred
Error message,A error message provides the specific message which occurred
Error stacktrace,A error stacktrace provides the stacktrace for error occurred
What made this section unhelpful for you?
Response
{
"cpoId": "CPO2477328421161597NQ575",
"cancellationDate": "2023-10-19T10:42:41.257Z",
"cancellationReason": "Termination",
"completionDate": "2023-10-19T10:42:41.257Z",
"expectedCompletionDate": "2023-10-19T10:42:41.257Z",
"notificationContact": "example.rnp@gmail.com",
"orderDate": "2023-10-19T10:42:41.257Z",
"requestedCompletionDate": "2023-10-19T10:42:41.257Z",
"requestedStartDate": "2023-10-19T10:42:41.257Z",
"actualStartDate": "2023-10-19T10:42:41.257Z",
"state": "FAILED",
"status": "Provisioning - Failed",
"relatedParty": [
{
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account",
"role": "OM_DATA_MANAGER",
"type": "Individual Party",
"baseType": "ProductOfferingPrice",
"referredType": "BillingAccount",
"schemaLocation": "RelatedParty Collection",
"contactMedium": [
{
"baseType": "ProductOfferingPrice",
"type": "Individual Party",
"schemaLocation": "ContactMedium Collection",
"preferred": false,
"mediumType": "url",
"validFor": {
"startDateTime": "2023-08-11T09:17:41.866Z",
"endDateTime": "2023-08-11T09:17:41.866Z"
},
"characteristic": {
"baseType": "ProductOfferingPrice",
"type": "Individual Party",
"schemaLocation": "Contact Characteristics Collection",
"addressId": "#234",
"city": "Bengalore",
"contactType": "phone",
"country": "India",
"emailAddress": "example.@gmail.com",
"faxNumber": "212-111-2222",
"phoneNumber": "9856876322",
"postCode": "560064",
"socialNetworkId": "LinkedIn",
"stateOrProvince": "karnataka",
"street1": "RMZ Galleria",
"street2": "Office Block",
"houseNo": "56"
}
}
]
}
],
"href": "/product-inventory",
"externalId": "881a6d15-bcbe-4372-b48a-41cba29f4806",
"description": "example = find details for product Order Request",
"category": "Broadband",
"createdBy": "intadmin1",
"createdDateTime": "2023-10-19T10:42:41.257Z",
"lastModifiedBy": "intadmin1",
"lastModifiedDateTime": "",
"offerContainers": [
{
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account",
"processContext": "ACQ",
"lineOfBusiness": "mobile",
"category": {
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account",
"version": null
},
"state": "ACKNOWLEDGED",
"status": "Completed",
"productOrderItemsRefs": [
{
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account"
}
],
"externalOfferContainerId": "880",
"externalOfferContainerReferenceNumber": "880A",
"additionalAttributes": [
{
"name": "MSISDN",
"valueType": "String",
"value": "55738231121",
"action": "ADD",
"validationStatus": "PASSED",
"createdBy": "admin",
"lastModifiedBy": "system",
"lastModifiedDateTime": "2023-10-19T10:42:41.257Z",
"createdDateTime": "2023-10-19T10:42:41.257Z",
"enrichmentDetail": {
"description": "Description of character",
"specType": "ServiceSpecification",
"referenceId": "data_service_specification_001",
"valueType": "List",
"minCardinality": null,
"maxCardinality": 1,
"characteristicValues": [
{
"valueType": "String",
"value": "True",
"validFor": {
"startDateTime": "2023-08-11T09:17:41.866Z",
"endDateTime": "2023-08-11T09:17:41.866Z"
},
"default": false,
"rangeInterval": "closedTop",
"regex": null,
"unitOfMeasure": "GB"
}
],
"validFor": {
"startDateTime": "2023-08-11T09:17:41.866Z",
"endDateTime": "2023-08-11T09:17:41.866Z"
},
"format": "String",
"length": 5,
"decimalValue": 0.767,
"tooltipValue": "Additional Information",
"visibleLine": "1",
"unique": false,
"extensible": false,
"configurable": false,
"displaySequence": 1,
"isVisible": false,
"configurationStage": "Product Offer Level",
"regex": "\"expression\": \"^[0-9]{9,13}$\",\n\"message\": \"Please enter a valid phone number\""
},
"errorDetails": [
{
"errorCode": "ERR-BM-OM-OV-OE-101",
"errorMessage": "Exception in Order Enrichment Process, Product Inventory Not Present"
}
],
"dynamicAttributes": [
{
"attributeName": "Data Throttling",
"attributeValue": "55738231121",
"attributeType": "String",
"lastModifiedDateTime": "2023-10-19T10:42:41.257Z",
"lastModifiedBy": "omui admin"
}
],
"isNetworkImpacting": false,
"isCharacteristicAmended": false
}
],
"promotions": [
{
"category": "Managed SDWAN Service",
"id": "automation_promotion-pm_20eewvb",
"internalLifecycleStatus": "Test",
"description": "Promotion",
"lifeCycleStatus": "Test",
"name": "Automation_Promotion_678new",
"priority": 2,
"promoApplicationLevel": "cart",
"signature": "cartSignature",
"type": "Promotion",
"promotionAction": {
"actionCardinality": null,
"actionObjectId": "bm-samsung-product-bundle",
"actionType": "Add Product",
"actionValue": 2,
"applicationDuration": 1,
"cartItemId": "5432373c-6f65-46f8-a8b5-879a8df5b576",
"id": "pa_j6w82",
"maxActionValue": "3",
"priceId": "op_0nwf2jj",
"priceType": "recurring",
"priority": 4,
"recurringChargePeriodType": "Month"
},
"promotionClassification": "exclusive",
"coupon": {
"id": "54765",
"code": "MY_COUPON_CODE",
"coupon": false
},
"validFor": {
"startDateTime": "2023-08-11T09:17:41.866Z",
"endDateTime": "2023-08-11T09:17:41.866Z"
}
}
],
"offerContainerTotalPrice": [
{
"description": "Order Price Details",
"name": "robin_rf",
"recurringChargePeriod": "Monthly",
"priceType": "recurring",
"recurringChargePeriodLength": 1,
"offset": 3,
"tax": [
{
"taxType": "GST",
"externalID": "464bf14d-7373-4937-a73b-28217ac07528",
"id": "tax_automationtest-tx_bv8y95w",
"validFor": {
"startDateTime": "2023-08-11T09:17:41.866Z",
"endDateTime": "2023-08-11T09:17:41.866Z"
},
"@baseType": "Tax",
"@type": "Individual Type",
"taxAmount": {
"unit": "inr",
"value": 1000
},
"taxCategory": "Indian",
"taxRate": 20,
"name": "Tax_Automationtest",
"displayName": "Tax details",
"definesExemption": false,
"additionalAttributes": [
{
"name": "MSISDN",
"valueType": "String",
"value": "55738231121",
"action": "ADD",
"validationStatus": "PASSED",
"createdBy": "admin",
"lastModifiedBy": "system",
"lastModifiedDateTime": "2023-10-19T10:42:41.257Z",
"createdDateTime": "2023-10-19T10:42:41.257Z",
"enrichmentDetail": {
"description": "Description of character",
"specType": "ServiceSpecification",
"referenceId": "data_service_specification_001",
"valueType": "List",
"minCardinality": null,
"maxCardinality": 1,
"characteristicValues": [],
"validFor": {},
"format": "String",
"length": 5,
"decimalValue": 0.767,
"tooltipValue": "Additional Information",
"visibleLine": "1",
"unique": false,
"extensible": false,
"configurable": false,
"displaySequence": 1,
"isVisible": false,
"configurationStage": "Product Offer Level",
"regex": "\"expression\": \"^[0-9]{9,13}$\",\n\"message\": \"Please enter a valid phone number\""
},
"errorDetails": [
""
],
"dynamicAttributes": [
""
],
"isNetworkImpacting": false,
"isCharacteristicAmended": false
}
]
}
],
"priceId": "op_0nwf2jj",
"priceSubType": "recurring",
"unitOfMeasure": "INR",
"@baseType": "OrderPrice",
"@schemaLocation": "OrderPrice Collection",
"price": {
"percentage": 10,
"taxRate": 10,
"actionCardinality": 10,
"taxAmount": 10,
"@baseType": "Price",
"@type": "Price",
"dutyFreeAmount": {
"unit": "inr",
"value": 1000
},
"taxIncludedAmount": {
"unit": "inr",
"value": 1000
},
"@schemaLocation": "Price Collection",
"dutyFreeAlteredAmount": {
"unit": "inr",
"value": 1000
},
"taxIncludedAlteredAmount": {
"unit": "inr",
"value": 1000
},
"changeAmount": {
"unit": "inr",
"value": 1000
},
"discount": {
"unit": "inr",
"value": 1000
},
"amountPayable": {
"unit": "inr",
"value": 1000
},
"taxFixed": {
"unit": "inr",
"value": 1000
}
},
"@type": "OrderPrice",
"priceAlteration": [
{
"applicationDuration": 3,
"description": "Price Alteration Details",
"name": "ServiceOrder",
"priceAlterationType": "Discount",
"priceType": "recurring",
"priority": 2,
"recurringChargePeriod": "Month",
"referenceId": "data_service_specification_001",
"unitOfMeasure": "INR",
"@baseType": "PriceAlteration",
"@schemaLocation": "PriceAlteration Collection",
"@type": "recurring",
"price": {
"percentage": 10,
"taxRate": 10,
"actionCardinality": 10,
"taxAmount": 10,
"@baseType": "Price",
"@type": "Price",
"dutyFreeAmount": {
"unit": "inr",
"value": 1000
},
"taxIncludedAmount": {
"unit": "inr",
"value": 1000
},
"@schemaLocation": "Price Collection",
"dutyFreeAlteredAmount": {
"unit": "inr",
"value": 1000
},
"taxIncludedAlteredAmount": {
"unit": "inr",
"value": 1000
},
"changeAmount": {
"unit": "inr",
"value": 1000
},
"discount": {
"unit": "inr",
"value": 1000
},
"amountPayable": {
"unit": "inr",
"value": 1000
},
"taxFixed": {
"unit": "inr",
"value": 1000
}
},
"productOfferingPrice": {
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account",
"@baseType": "ProductOfferingPrice",
"@referredType": "ProductOfferingPrice Type",
"@schemaLocation": "ProductOfferingPrice Collection",
"@type": "individual Type"
}
}
],
"productOfferingPrice": {
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account",
"@baseType": "ProductOfferingPrice",
"@referredType": "ProductOfferingPrice Type",
"@schemaLocation": "ProductOfferingPrice Collection",
"@type": "individual Type"
},
"itemPriceRelationship": [
{
"priceId": "P465",
"relationshipType": "FIXED_PRICE"
}
],
"validFor": {
"endDateTime": "2023-10-19T10:42:41.257Z",
"startDateTime": "2023-10-19T10:42:41.257Z"
},
"isDownPaymentRequired": false,
"minimumDownPaymentAmount": null,
"isAgreementBased": false,
"offsetParameter": {
"numberofBlock": 2,
"totalAllowanceSelectionCount": 4,
"isCalenderBased": true,
"discountType": "FIXED_PRICE",
"billingDiscountExternalRef": "BD2024-123456",
"discountValue": 10,
"allowedDiscount": [
{
"block": 1,
"allowedSelectionCount": null,
"allowedSelectionPeriod": "2022-08-08 13:09:00.612Z",
"selectedDiscountPeriod": "2022-08-08 13:09:00.612Z"
}
]
},
"code": "PC_de716bb0",
"externalId": "prepaidplan_a-1_price_2-0_v1||123",
"id": "9a058452-d5c7-4ec2-9f3d-1ecc34d120ee",
"specCharacteristics": [
{
"name": "SMS Allowance",
"value": "50SMS",
"valueType": "String"
}
],
"isProrated": false,
"isArrears": false
}
]
}
],
"portfolioContainers": [
{
"id": "BP11697629618916537",
"name": "",
"productOrderItemsRefs": [
{
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account"
}
],
"sort": 1
}
],
"signature": {
"context": "174be0d306a3bab87c1266f4b4d1f534c5a302aedda36ff0f64d695cd581eeb7",
"cart": "4db162ebf6ee34d11293b9aa7e8f8a512061de318ed5187cd1cb75f5c0a2c198"
},
"baseProductOrderId": "3e934f5f-4fb7-4e01-a33d-4bd7c33f5828",
"amendProductOrderId": "3e934f5f-4fb7-4e01-a33d-4bd7c33f5828",
"orderType": "NEW",
"id": "881a6d15-bcbe-4372-b48a-41cba29f4806",
"quote": [
{
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account"
}
],
"agreement": [
{
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account",
"agreementItemId": "agreement_083774",
"agreementProductOfferingPrice": [
{
"id": "bm_jio_cardinality_price",
"price": {
"unit": "inr",
"value": 1000
}
}
],
"@baseType": "ProductOfferingPrice",
"@schemaLocation": "Agreement Collection",
"characteristic": [
{
"name": "MSISDN",
"valueType": "String",
"value": "55738231121",
"action": "ADD",
"validationStatus": "PASSED",
"createdBy": "admin",
"lastModifiedBy": "system",
"lastModifiedDateTime": "2023-10-19T10:42:41.257Z",
"createdDateTime": "2023-10-19T10:42:41.257Z",
"enrichmentDetail": {
"description": "Description of character",
"specType": "ServiceSpecification",
"referenceId": "data_service_specification_001",
"valueType": "List",
"minCardinality": null,
"maxCardinality": 1,
"characteristicValues": [
{
"valueType": "String",
"value": "True",
"validFor": {
"startDateTime": "2023-08-11T09:17:41.866Z",
"endDateTime": "2023-08-11T09:17:41.866Z"
},
"default": false,
"rangeInterval": "closedTop",
"regex": null,
"unitOfMeasure": "GB"
}
],
"validFor": {
"startDateTime": "2023-08-11T09:17:41.866Z",
"endDateTime": "2023-08-11T09:17:41.866Z"
},
"format": "String",
"length": 5,
"decimalValue": 0.767,
"tooltipValue": "Additional Information",
"visibleLine": "1",
"unique": false,
"extensible": false,
"configurable": false,
"displaySequence": 1,
"isVisible": false,
"configurationStage": "Product Offer Level",
"regex": "\"expression\": \"^[0-9]{9,13}$\",\n\"message\": \"Please enter a valid phone number\""
},
"errorDetails": [
{
"errorCode": "ERR-BM-OM-OV-OE-101",
"errorMessage": "Exception in Order Enrichment Process, Product Inventory Not Present"
}
],
"dynamicAttributes": [
{
"attributeName": "Data Throttling",
"attributeValue": "55738231121",
"attributeType": "String",
"lastModifiedDateTime": "2023-10-19T10:42:41.257Z",
"lastModifiedBy": "omui admin"
}
],
"isNetworkImpacting": false,
"isCharacteristicAmended": false
}
],
"@referredType": "BillingAccount",
"@type": "serviceOrder"
}
],
"channel": [
{
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account",
"role": "ServiceAddress"
}
],
"note": [
{
"id": "45",
"author": "Jack smith",
"createdDateTime": "2023-10-19T10:42:41.257Z",
"lastModifiedDateTime": "2023-10-19T10:42:41.257Z",
"system": "CHECKOUT",
"text": "This is quite important, please approach me as soon as possible"
}
],
"payment": [
{
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account",
"method": "CashPayment",
"token": "64bf14d-7373-4937-a73b-28217ac07528",
"receiptId": "P011276",
"paymentDate": "2023-10-19T10:42:41.257Z",
"transactionAmount": "2000",
"transactionId": "123123124112",
"transactionCurrency": "USD"
}
],
"productOrderItem": [
{
"id": "1",
"sort": 1,
"quantity": 1,
"action": "ADD",
"state": "ACKNOWLEDGED",
"status": "Order Validation - Completed",
"productOrderItemType": "New Order",
"productOrderItemSubType": "NEW_ORDER",
"installBaseId": "BP1686636408708199",
"actualStartDate": "2023-10-19T10:42:41.257Z",
"completionDate": "2023-10-19T10:42:41.257Z",
"expectedCompletionDate": "2023-10-19T10:42:41.257Z",
"requestedCompletionDate": "2023-10-19T10:42:41.257Z",
"errorDetails": [
{
"errorCode": "ERR-BM-OM-OV-OE-101",
"errorMessage": "Exception in Order Enrichment Process, Product Inventory Not Present"
}
],
"parentBundleOfferId": "1001359",
"parentBundleInstallBaseId": "BP1691740391567152",
"lastModifiedBy": "2023-10-19T10:42:41.257Z",
"lastModifiedDateTime": "2023-10-19T10:42:41.257Z",
"processFlag": "COMSOM",
"externalProductOrderItemId": "880",
"externalProductOrderItemReferenceNumber": "880A",
"workflowFlag": "Combined",
"payment": [
{
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account",
"method": "CashPayment",
"token": "64bf14d-7373-4937-a73b-28217ac07528",
"receiptId": "P011276",
"paymentDate": "2023-10-19T10:42:41.257Z",
"transactionAmount": "2000",
"transactionId": "123123124112",
"transactionCurrency": "USD"
}
],
"appointment": {
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account",
"description": "Description of AppointmentRef"
},
"appointmentList": [
{
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account",
"description": "Description of AppointmentRef"
}
],
"itemTerm": [
{
"description": "Description for OrderTerm",
"name": "atrribute 2",
"duration": "12.0",
"durationUnit": "MONTH"
}
],
"productOfferingQualificationItem": {
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account",
"productOfferingQualificationHref": "/api/catalog-projection/v1/productOfferingPrice/bluemarble_unlimited_10gb_12mth_rc_001",
"productOfferingQualificationId": "bluemarble_unlimited_10gb_12mth_rc_001",
"productOfferingQualificationName": "BlueMarble Unlimited - 10GB - 12 Months - RC"
},
"productOrderItemRelationship": [
{
"id": "SO1686577779836872",
"relationshipType": "Dependency",
"siteId": "admin_123"
}
],
"quoteItem": {
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account",
"quoteHref": "mobile",
"quoteId": "123",
"quoteName": "quote_ir"
},
"itemPrice": [
{
"description": "Order Price Details",
"name": "robin_rf",
"recurringChargePeriod": "Monthly",
"priceType": "recurring",
"recurringChargePeriodLength": 1,
"offset": 3,
"tax": [
{
"taxType": "GST",
"externalID": "464bf14d-7373-4937-a73b-28217ac07528",
"id": "tax_automationtest-tx_bv8y95w",
"validFor": {
"startDateTime": "2023-08-11T09:17:41.866Z",
"endDateTime": "2023-08-11T09:17:41.866Z"
},
"@baseType": "Tax",
"@type": "Individual Type",
"taxAmount": {
"unit": "inr",
"value": 1000
},
"taxCategory": "Indian",
"taxRate": 20,
"name": "Tax_Automationtest",
"displayName": "Tax details",
"definesExemption": false,
"additionalAttributes": [
{
"name": "MSISDN",
"valueType": "String",
"value": "55738231121",
"action": "ADD",
"validationStatus": "PASSED",
"createdBy": "admin",
"lastModifiedBy": "system",
"lastModifiedDateTime": "2023-10-19T10:42:41.257Z",
"createdDateTime": "2023-10-19T10:42:41.257Z",
"enrichmentDetail": {
"description": "Description of character",
"specType": "ServiceSpecification",
"referenceId": "data_service_specification_001",
"valueType": "List",
"minCardinality": null,
"maxCardinality": 1,
"characteristicValues": [],
"validFor": {},
"format": "String",
"length": 5,
"decimalValue": 0.767,
"tooltipValue": "Additional Information",
"visibleLine": "1",
"unique": false,
"extensible": false,
"configurable": false,
"displaySequence": 1,
"isVisible": false,
"configurationStage": "Product Offer Level",
"regex": "\"expression\": \"^[0-9]{9,13}$\",\n\"message\": \"Please enter a valid phone number\""
},
"errorDetails": [
""
],
"dynamicAttributes": [
""
],
"isNetworkImpacting": false,
"isCharacteristicAmended": false
}
]
}
],
"priceId": "op_0nwf2jj",
"priceSubType": "recurring",
"unitOfMeasure": "INR",
"@baseType": "OrderPrice",
"@schemaLocation": "OrderPrice Collection",
"price": {
"percentage": 10,
"taxRate": 10,
"actionCardinality": 10,
"taxAmount": 10,
"@baseType": "Price",
"@type": "Price",
"dutyFreeAmount": {
"unit": "inr",
"value": 1000
},
"taxIncludedAmount": {
"unit": "inr",
"value": 1000
},
"@schemaLocation": "Price Collection",
"dutyFreeAlteredAmount": {
"unit": "inr",
"value": 1000
},
"taxIncludedAlteredAmount": {
"unit": "inr",
"value": 1000
},
"changeAmount": {
"unit": "inr",
"value": 1000
},
"discount": {
"unit": "inr",
"value": 1000
},
"amountPayable": {
"unit": "inr",
"value": 1000
},
"taxFixed": {
"unit": "inr",
"value": 1000
}
},
"@type": "OrderPrice",
"priceAlteration": [
{
"applicationDuration": 3,
"description": "Price Alteration Details",
"name": "ServiceOrder",
"priceAlterationType": "Discount",
"priceType": "recurring",
"priority": 2,
"recurringChargePeriod": "Month",
"referenceId": "data_service_specification_001",
"unitOfMeasure": "INR",
"@baseType": "PriceAlteration",
"@schemaLocation": "PriceAlteration Collection",
"@type": "recurring",
"price": {
"percentage": 10,
"taxRate": 10,
"actionCardinality": 10,
"taxAmount": 10,
"@baseType": "Price",
"@type": "Price",
"dutyFreeAmount": {
"unit": "inr",
"value": 1000
},
"taxIncludedAmount": {
"unit": "inr",
"value": 1000
},
"@schemaLocation": "Price Collection",
"dutyFreeAlteredAmount": {
"unit": "inr",
"value": 1000
},
"taxIncludedAlteredAmount": {
"unit": "inr",
"value": 1000
},
"changeAmount": {
"unit": "inr",
"value": 1000
},
"discount": {
"unit": "inr",
"value": 1000
},
"amountPayable": {
"unit": "inr",
"value": 1000
},
"taxFixed": {
"unit": "inr",
"value": 1000
}
},
"productOfferingPrice": {
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account",
"@baseType": "ProductOfferingPrice",
"@referredType": "ProductOfferingPrice Type",
"@schemaLocation": "ProductOfferingPrice Collection",
"@type": "individual Type"
}
}
],
"productOfferingPrice": {
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account",
"@baseType": "ProductOfferingPrice",
"@referredType": "ProductOfferingPrice Type",
"@schemaLocation": "ProductOfferingPrice Collection",
"@type": "individual Type"
},
"itemPriceRelationship": [
{
"priceId": "P465",
"relationshipType": "FIXED_PRICE"
}
],
"validFor": {
"endDateTime": "2023-10-19T10:42:41.257Z",
"startDateTime": "2023-10-19T10:42:41.257Z"
},
"isDownPaymentRequired": false,
"minimumDownPaymentAmount": null,
"isAgreementBased": false,
"offsetParameter": {
"numberofBlock": 2,
"totalAllowanceSelectionCount": 4,
"isCalenderBased": true,
"discountType": "FIXED_PRICE",
"billingDiscountExternalRef": "BD2024-123456",
"discountValue": 10,
"allowedDiscount": [
{
"block": 1,
"allowedSelectionCount": null,
"allowedSelectionPeriod": "2022-08-08 13:09:00.612Z",
"selectedDiscountPeriod": "2022-08-08 13:09:00.612Z"
}
]
},
"code": "PC_de716bb0",
"externalId": "prepaidplan_a-1_price_2-0_v1||123",
"id": "9a058452-d5c7-4ec2-9f3d-1ecc34d120ee",
"specCharacteristics": [
{
"name": "SMS Allowance",
"value": "50SMS",
"valueType": "String"
}
],
"isProrated": false,
"isArrears": false
}
],
"qualification": [
{
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account"
}
],
"billingAccount": {
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account",
"dynamicAttributes": [
{
"attributeName": "Data Throttling",
"attributeValue": "55738231121",
"attributeType": "String",
"lastModifiedDateTime": "2023-10-19T10:42:41.257Z",
"lastModifiedBy": "omui admin"
}
],
"financeSettlementRef": [
{
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account"
}
],
"paymentMethodRef": [
{
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account"
}
],
"itemPriceRef": [
{
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account"
}
],
"@baseType": "ProductOfferingPrice",
"@type": "Individual Party",
"@schemaLocation": "BillingAccount",
"@referredType": "BillingAccount"
},
"billingAccountList": [
{
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account",
"dynamicAttributes": [
{
"attributeName": "Data Throttling",
"attributeValue": "55738231121",
"attributeType": "String",
"lastModifiedDateTime": "2023-10-19T10:42:41.257Z",
"lastModifiedBy": "omui admin"
}
],
"financeSettlementRef": [
{
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account"
}
],
"paymentMethodRef": [
{
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account"
}
],
"itemPriceRef": [
{
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account"
}
],
"@baseType": "ProductOfferingPrice",
"@type": "Individual Party",
"@schemaLocation": "BillingAccount",
"@referredType": "BillingAccount"
}
],
"productOffering": {
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account",
"externalID": "464bf14d-7373-4937-a73b-28217ac07528",
"owningSystem": "BlueMarble",
"owningSystemID": "owning system1001",
"relatedSystemName": "relatedsystem1001",
"referenceId": "data_service_specification_001",
"version": "1",
"status": "Closed",
"category": {
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account",
"version": null
},
"metaExtension": {
"dataSet": [
{
"name": "MobileOfferOM",
"genericData": {
"schemaRef": "OrderManagementOffer",
"valueSet": {}
},
"languages": [
{
"locale": "en-GB",
"name": "ENGLISH-IND, ENGLISH-US"
}
],
"channels": [
{
"id": "bo_lov_saleschannel_retail",
"name": "Retail"
}
],
"marketSegments": [
{
"id": "7894820397708LH425643",
"name": "Retail"
}
]
}
]
},
"productType": "Subscription",
"productLine": "Postpaid",
"offerClassification": "bo_lov_offerclassification_primary",
"@referredType": " BillingAccount ",
"@schemaLocation": "ProductOffering Collection",
"@type": "CFS",
"isAssetable": false
},
"product": {
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account",
"description": "find details for product Order",
"orderDate": "2023-10-19T10:42:41.257Z",
"productSerialNumber": "1",
"startDate": "2023-10-19T10:42:41.257Z",
"terminationDate": "2023-10-19T10:42:41.257Z",
"status": "CREATED",
"isBundle": false,
"isCustomerVisible": true,
"place": [
{
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account",
"role": "ServiceAddress",
"locationId": "LRW245",
"flag": "ACTIVE",
"fullAddress": "RMZ Galleria Office BLock,Yelahanka New Town",
"streetNr": "52",
"streetNrSuffix": "153",
"streetNrLast": "754",
"streetNrLastSuffix": "5765",
"streetName": "Pell Street",
"streetType": "Street",
"streetSuffix": "52",
"postCode": "SE85ES",
"locality": "London",
"city": "Pune",
"stateOrProvince": "England",
"country": "United Kingdom",
"geoLocationRefOrValue": {
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account",
"geometryType": "Point",
"accuracy": "100 meters",
"spatialRef": "WGS 84",
"type": "ProductOfferingPrice",
"schemaLocation": "Geolocation Collection",
"geometry": [
{
"latitude": "13.3379° N",
"longitude": "77.1173° E",
"geographicDatum": "NAVD88"
}
]
},
"geographicSubAddress": [
{
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account",
"type": "SubUnit",
"subUnitType": "Apartment",
"subUnitNumber": "1234",
"levelType": "Floor",
"levelNumber": "2",
"buildingName": "Acme Corporation Building",
"privateStreetNumber": "123",
"privateStreetName": "Main Street"
}
],
"serviceability": [
{
"id": "sms_service_specification_001",
"type": "CFS",
"attributes": {
"category": "enterprise",
"availability": {
"key": "PRODUCT_CODE",
"value": "6767453"
},
"items": [
""
]
}
}
],
"contactDetails": [
{
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account",
"role": "OM_DATA_MANAGER",
"type": "Individual Party",
"baseType": "ProductOfferingPrice",
"referredType": "BillingAccount",
"schemaLocation": "RelatedParty Collection",
"contactMedium": [
{
"baseType": "ProductOfferingPrice",
"type": "Individual Party",
"schemaLocation": "ContactMedium Collection",
"preferred": false,
"mediumType": "url",
"validFor": {},
"characteristic": {}
}
]
}
]
}
],
"productCharacteristic": [
{
"name": "MSISDN",
"valueType": "String",
"value": "55738231121",
"action": "ADD",
"validationStatus": "PASSED",
"createdBy": "admin",
"lastModifiedBy": "system",
"lastModifiedDateTime": "2023-10-19T10:42:41.257Z",
"createdDateTime": "2023-10-19T10:42:41.257Z",
"enrichmentDetail": {
"description": "Description of character",
"specType": "ServiceSpecification",
"referenceId": "data_service_specification_001",
"valueType": "List",
"minCardinality": null,
"maxCardinality": 1,
"characteristicValues": [
{
"valueType": "String",
"value": "True",
"validFor": {
"startDateTime": "2023-08-11T09:17:41.866Z",
"endDateTime": "2023-08-11T09:17:41.866Z"
},
"default": false,
"rangeInterval": "closedTop",
"regex": null,
"unitOfMeasure": "GB"
}
],
"validFor": {
"startDateTime": "2023-08-11T09:17:41.866Z",
"endDateTime": "2023-08-11T09:17:41.866Z"
},
"format": "String",
"length": 5,
"decimalValue": 0.767,
"tooltipValue": "Additional Information",
"visibleLine": "1",
"unique": false,
"extensible": false,
"configurable": false,
"displaySequence": 1,
"isVisible": false,
"configurationStage": "Product Offer Level",
"regex": "\"expression\": \"^[0-9]{9,13}$\",\n\"message\": \"Please enter a valid phone number\""
},
"errorDetails": [
{
"errorCode": "ERR-BM-OM-OV-OE-101",
"errorMessage": "Exception in Order Enrichment Process, Product Inventory Not Present"
}
],
"dynamicAttributes": [
{
"attributeName": "Data Throttling",
"attributeValue": "55738231121",
"attributeType": "String",
"lastModifiedDateTime": "2023-10-19T10:42:41.257Z",
"lastModifiedBy": "omui admin"
}
],
"isNetworkImpacting": false,
"isCharacteristicAmended": false
}
],
"agreement": [
{
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account",
"agreementItemId": "agreement_083774",
"agreementProductOfferingPrice": [
{
"id": "bm_jio_cardinality_price",
"price": {
"unit": "inr",
"value": 1000
}
}
],
"@baseType": "ProductOfferingPrice",
"@schemaLocation": "Agreement Collection",
"characteristic": [
{
"name": "MSISDN",
"valueType": "String",
"value": "55738231121",
"action": "ADD",
"validationStatus": "PASSED",
"createdBy": "admin",
"lastModifiedBy": "system",
"lastModifiedDateTime": "2023-10-19T10:42:41.257Z",
"createdDateTime": "2023-10-19T10:42:41.257Z",
"enrichmentDetail": {
"description": "Description of character",
"specType": "ServiceSpecification",
"referenceId": "data_service_specification_001",
"valueType": "List",
"minCardinality": null,
"maxCardinality": 1,
"characteristicValues": [
""
],
"validFor": {
"startDateTime": "2023-08-11T09:17:41.866Z",
"endDateTime": "2023-08-11T09:17:41.866Z"
},
"format": "String",
"length": 5,
"decimalValue": 0.767,
"tooltipValue": "Additional Information",
"visibleLine": "1",
"unique": false,
"extensible": false,
"configurable": false,
"displaySequence": 1,
"isVisible": false,
"configurationStage": "Product Offer Level",
"regex": "\"expression\": \"^[0-9]{9,13}$\",\n\"message\": \"Please enter a valid phone number\""
},
"errorDetails": [
{
"errorCode": "ERR-BM-OM-OV-OE-101",
"errorMessage": "Exception in Order Enrichment Process, Product Inventory Not Present"
}
],
"dynamicAttributes": [
{
"attributeName": "Data Throttling",
"attributeValue": "55738231121",
"attributeType": "String",
"lastModifiedDateTime": "2023-10-19T10:42:41.257Z",
"lastModifiedBy": "omui admin"
}
],
"isNetworkImpacting": false,
"isCharacteristicAmended": false
}
],
"@referredType": "BillingAccount",
"@type": "serviceOrder"
}
],
"productOffering": {
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account",
"externalID": "464bf14d-7373-4937-a73b-28217ac07528",
"owningSystem": "BlueMarble",
"owningSystemID": "owning system1001",
"relatedSystemName": "relatedsystem1001",
"referenceId": "data_service_specification_001",
"version": "1",
"status": "Closed",
"category": {
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account",
"version": null
},
"metaExtension": {
"dataSet": [
{
"name": "MobileOfferOM",
"genericData": {
"schemaRef": "OrderManagementOffer",
"valueSet": {}
},
"languages": [
{
"locale": "en-GB",
"name": "ENGLISH-IND, ENGLISH-US"
}
],
"channels": [
{
"id": "bo_lov_saleschannel_retail",
"name": "Retail"
}
],
"marketSegments": [
{
"id": "7894820397708LH425643",
"name": "Retail"
}
]
}
]
},
"productType": "Subscription",
"productLine": "Postpaid",
"offerClassification": "bo_lov_offerclassification_primary",
"@referredType": " BillingAccount ",
"@schemaLocation": "ProductOffering Collection",
"@type": "CFS",
"isAssetable": false
},
"billingAccount": {
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account",
"dynamicAttributes": [
{
"attributeName": "Data Throttling",
"attributeValue": "55738231121",
"attributeType": "String",
"lastModifiedDateTime": "2023-10-19T10:42:41.257Z",
"lastModifiedBy": "omui admin"
}
],
"financeSettlementRef": [
{
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account"
}
],
"paymentMethodRef": [
{
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account"
}
],
"itemPriceRef": [
{
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account"
}
],
"@baseType": "ProductOfferingPrice",
"@type": "Individual Party",
"@schemaLocation": "BillingAccount",
"@referredType": "BillingAccount"
},
"billingAccountList": [
{
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account",
"dynamicAttributes": [
{
"attributeName": "Data Throttling",
"attributeValue": "55738231121",
"attributeType": "String",
"lastModifiedDateTime": "2023-10-19T10:42:41.257Z",
"lastModifiedBy": "omui admin"
}
],
"financeSettlementRef": [
{
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account"
}
],
"paymentMethodRef": [
{
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account"
}
],
"itemPriceRef": [
{
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account"
}
],
"@baseType": "ProductOfferingPrice",
"@type": "Individual Party",
"@schemaLocation": "BillingAccount",
"@referredType": "BillingAccount"
}
],
"relatedParty": [
{
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account",
"role": "OM_DATA_MANAGER",
"type": "Individual Party",
"baseType": "ProductOfferingPrice",
"referredType": "BillingAccount",
"schemaLocation": "RelatedParty Collection",
"contactMedium": [
{
"baseType": "ProductOfferingPrice",
"type": "Individual Party",
"schemaLocation": "ContactMedium Collection",
"preferred": false,
"mediumType": "url",
"validFor": {
"startDateTime": "2023-08-11T09:17:41.866Z",
"endDateTime": "2023-08-11T09:17:41.866Z"
},
"characteristic": {
"baseType": "ProductOfferingPrice",
"type": "Individual Party",
"schemaLocation": "Contact Characteristics Collection",
"addressId": "#234",
"city": "Bengalore",
"contactType": "phone",
"country": "India",
"emailAddress": "example.@gmail.com",
"faxNumber": "212-111-2222",
"phoneNumber": "9856876322",
"postCode": "560064",
"socialNetworkId": "LinkedIn",
"stateOrProvince": "karnataka",
"street1": "RMZ Galleria",
"street2": "Office Block",
"houseNo": "56"
}
}
]
}
],
"productPrice": [
{
"description": "find details for product price",
"name": "Mobile Postpaid - Product Specification",
"offset": null,
"priceId": "1",
"priceType": "Onetime",
"recurringChargePeriod": "string",
"recurringChargePeriodLength": null,
"unitOfMeasure": "",
"tax": [
{
"taxType": "GST",
"externalID": "464bf14d-7373-4937-a73b-28217ac07528",
"id": "tax_automationtest-tx_bv8y95w",
"validFor": {
"startDateTime": "2023-08-11T09:17:41.866Z",
"endDateTime": "2023-08-11T09:17:41.866Z"
},
"@baseType": "Tax",
"@type": "Individual Type",
"taxAmount": {
"unit": "inr",
"value": 1000
},
"taxCategory": "Indian",
"taxRate": 20,
"name": "Tax_Automationtest",
"displayName": "Tax details",
"definesExemption": false,
"additionalAttributes": [
{
"name": "MSISDN",
"valueType": "String",
"value": "55738231121",
"action": "ADD",
"validationStatus": "PASSED",
"createdBy": "admin",
"lastModifiedBy": "system",
"lastModifiedDateTime": "2023-10-19T10:42:41.257Z",
"createdDateTime": "2023-10-19T10:42:41.257Z",
"enrichmentDetail": {},
"errorDetails": [],
"dynamicAttributes": [],
"isNetworkImpacting": false,
"isCharacteristicAmended": false
}
]
}
],
"priceSubType": "",
"isDownPaymentRequired": false,
"minimumDownPaymentAmount": null,
"id": "4cd250d9-e00e-4396-853b-2b244f0758dc",
"externalId": "string",
"@baseType": "ProductPrice",
"@schemaLocation": "price point collection",
"@type": "ProductPrice",
"itemPriceRelationship": [
{
"priceId": "P465",
"relationshipType": "FIXED_PRICE"
}
],
"price": {
"percentage": 10,
"taxRate": 10,
"actionCardinality": 10,
"taxAmount": 10,
"@baseType": "Price",
"@type": "Price",
"dutyFreeAmount": {
"unit": "inr",
"value": 1000
},
"taxIncludedAmount": {
"unit": "inr",
"value": 1000
},
"@schemaLocation": "Price Collection",
"dutyFreeAlteredAmount": {
"unit": "inr",
"value": 1000
},
"taxIncludedAlteredAmount": {
"unit": "inr",
"value": 1000
},
"changeAmount": {
"unit": "inr",
"value": 1000
},
"discount": {
"unit": "inr",
"value": 1000
},
"amountPayable": {
"unit": "inr",
"value": 1000
},
"taxFixed": {
"unit": "inr",
"value": 1000
}
},
"priceAlteration": [
{
"applicationDuration": 3,
"description": "Price Alteration Details",
"name": "ServiceOrder",
"priceAlterationType": "Discount",
"priceType": "recurring",
"priority": 2,
"recurringChargePeriod": "Month",
"referenceId": "data_service_specification_001",
"unitOfMeasure": "INR",
"@baseType": "PriceAlteration",
"@schemaLocation": "PriceAlteration Collection",
"@type": "recurring",
"price": {
"percentage": 10,
"taxRate": 10,
"actionCardinality": 10,
"taxAmount": 10,
"@baseType": "Price",
"@type": "Price",
"dutyFreeAmount": {
"unit": "inr",
"value": 1000
},
"taxIncludedAmount": {
"unit": "inr",
"value": 1000
},
"@schemaLocation": "Price Collection",
"dutyFreeAlteredAmount": {
"unit": "inr",
"value": 1000
},
"taxIncludedAlteredAmount": {
"unit": "inr",
"value": 1000
},
"changeAmount": {
"unit": "inr",
"value": 1000
},
"discount": {
"unit": "inr",
"value": 1000
},
"amountPayable": {
"unit": "inr",
"value": 1000
},
"taxFixed": {
"unit": "inr",
"value": 1000
}
},
"productOfferingPrice": {
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account",
"@baseType": "ProductOfferingPrice",
"@referredType": "ProductOfferingPrice Type",
"@schemaLocation": "ProductOfferingPrice Collection",
"@type": "individual Type"
}
}
],
"productOfferingPrice": {
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account",
"@baseType": "ProductOfferingPrice",
"@referredType": "ProductOfferingPrice Type",
"@schemaLocation": "ProductOfferingPrice Collection",
"@type": "individual Type"
},
"offsetParameter": {
"numberofBlock": 2,
"totalAllowanceSelectionCount": 4,
"isCalenderBased": true,
"discountType": "FIXED_PRICE",
"billingDiscountExternalRef": "BD2024-123456",
"discountValue": 10,
"allowedDiscount": [
{
"block": 1,
"allowedSelectionCount": null,
"allowedSelectionPeriod": "2022-08-08 13:09:00.612Z",
"selectedDiscountPeriod": "2022-08-08 13:09:00.612Z"
}
]
},
"isAgreementBased": true,
"code": "401 UNAUTHORIZED",
"specCharacteristics": [
{
"name": "SMS Allowance",
"value": "50SMS",
"valueType": "String"
}
],
"isProrated": false,
"isArrears": false,
"validFor": {
"startDateTime": "2023-08-11T09:17:41.866Z",
"endDateTime": "2023-08-11T09:17:41.866Z"
}
}
],
"productOrderItem": [
{
"orderItemAction": "ADD",
"orderItemId": "1",
"productOrderHref": "string",
"productOrderId": "557ae80c-b612-48f0-a57e-cd3a0eb1dc2c",
"role": "ServiceAddress"
}
],
"productSpecification": {
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account",
"externalId": "464bf14d-7373-4937-a73b-28217ac07528",
"externalName": "",
"owningSystem": "BlueMarble",
"owningSystemID": "owning system1001",
"relatedSystemName": "relatedsystem1001",
"status": "Open",
"referenceId": "data_service_specification_001",
"version": "1",
"metaExtension": {
"dataSet": [
{
"name": "MobileOfferOM",
"genericData": {
"schemaRef": "OrderManagementOffer",
"valueSet": {}
},
"languages": [
{
"locale": "en-GB",
"name": "ENGLISH-IND, ENGLISH-US"
}
],
"channels": [
{
"id": "bo_lov_saleschannel_retail",
"name": "Retail"
}
],
"marketSegments": [
{
"id": "7894820397708LH425643",
"name": "Retail"
}
]
}
]
},
"@type": "CFS",
"@referredType": " BillingAccount ",
"@schemaLocation": "ServiceSpecification Collection"
},
"productTerm": [
{
"description": "description for ProductTerm",
"name": "addItemThroughRules",
"durationUnit": "MONTH",
"duration": "12.0",
"validFor": {
"startDateTime": "2023-08-11T09:17:41.866Z",
"endDateTime": "2023-08-11T09:17:41.866Z"
}
}
],
"realizingResource": [
{
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account",
"value": "6767453"
}
],
"realizingService": [
{
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account"
}
],
"productRelationship": [
{
"relationshipType": "dependecy",
"product": ""
}
],
"reasonCode": "DUNNING",
"actionCode": "ACTION 2",
"checkoutData": [
{
"sectionId": "address",
"steps": [
{
"fields": [
{
"name": "Bill Format",
"value": "pdf"
}
],
"stepId": "billingAddressDetails",
"stepUId": "86c5e62d-f176-4434-b56c-bf7234429f1d",
"options": [
{
"name": "Bill Format",
"value": "pdf",
"fields": []
}
],
"offerContainerId": "5432373c-6f65-46f8-a8b5-879a8df5b576",
"cartItemId": "4a885452-ca92-45b8-933c-d35ad1b2e827",
"sequence": "0",
"groupByLevel": false,
"stepDataRefChoice": false,
"orderMgmtMapping": [
{
"fieldMapping": [],
"orderObjectPath": ""
}
]
}
],
"sectionUId": "5ba4aea8-184c-4d88-9906-143998869677"
}
],
"productLineCategory": "bm-postpaid-highend",
"parentBundleId": "bm-postpaid-highend"
},
"note": [
{
"id": "45",
"author": "Jack smith",
"createdDateTime": "2023-10-19T10:42:41.257Z",
"lastModifiedDateTime": "2023-10-19T10:42:41.257Z",
"system": "CHECKOUT",
"text": "This is quite important, please approach me as soon as possible"
}
],
"portability": {
"description": "find details for Portability",
"requestType": "PORT_IN",
"portingDate": "2023-10-19T10:42:41.257Z",
"portingApprovalDate": "2023-10-19T10:42:41.257Z",
"portingStatus": "COMPLETED",
"donorProvider": "",
"donorNumber": "20240",
"donorContractId": "70098909000",
"donorCustomerName": "intadmin",
"donorCustomerAddress": {
"id": "c63784c1-1d57-4b31-b61e-900db2d8f6e7",
"href": "/product-management/serviceSpecification/?id%3Dsms_service_specification_001%26version%3D1",
"name": "SMS - Service Specification",
"role": "ServiceAddress",
"locationId": "LRW245",
"flag": "ACTIVE",
"fullAddress": "RMZ Galleria Office BLock,Yelahanka New Town",
"streetNr": "52",
"streetNrSuffix": "153",
"streetNrLast": "754",
"streetNrLastSuffix": "5765",
"streetName": "Pell Street",
"streetType": "Street",
"streetSuffix": "52",
"postCode": "SE85ES",
"locality": "London",
"city": "Pune",
"stateOrProvince": "England",
"country": "United Kingdom",
"geoLocationRefOrValue": {
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account",
"geometryType": "Point",
"accuracy": "100 meters",
"spatialRef": "WGS 84",
"type": "ProductOfferingPrice",
"schemaLocation": "Geolocation Collection",
"geometry": [
{
"latitude": "13.3379° N",
"longitude": "77.1173° E",
"geographicDatum": "NAVD88"
}
]
},
"geographicSubAddress": [
{
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account",
"type": "SubUnit",
"subUnitType": "Apartment",
"subUnitNumber": "1234",
"levelType": "Floor",
"levelNumber": "2",
"buildingName": "Acme Corporation Building",
"privateStreetNumber": "123",
"privateStreetName": "Main Street"
}
],
"serviceability": [
{
"id": "sms_service_specification_001",
"type": "CFS",
"attributes": {
"category": "enterprise",
"availability": {
"key": "PRODUCT_CODE",
"value": "6767453"
},
"items": [
{
"key": "PRODUCT_CODE",
"value": "6767453"
}
]
}
}
],
"contactDetails": [
{
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account",
"role": "OM_DATA_MANAGER",
"type": "Individual Party",
"baseType": "ProductOfferingPrice",
"referredType": "BillingAccount",
"schemaLocation": "RelatedParty Collection",
"contactMedium": [
{
"baseType": "ProductOfferingPrice",
"type": "Individual Party",
"schemaLocation": "ContactMedium Collection",
"preferred": false,
"mediumType": "url",
"validFor": {
"startDateTime": "2023-08-11T09:17:41.866Z",
"endDateTime": "2023-08-11T09:17:41.866Z"
},
"characteristic": {
"baseType": "ProductOfferingPrice",
"type": "Individual Party",
"schemaLocation": "Contact Characteristics Collection",
"addressId": "#234",
"city": "Bengalore",
"contactType": "phone",
"country": "India",
"emailAddress": "example.@gmail.com",
"faxNumber": "212-111-2222",
"phoneNumber": "9856876322",
"postCode": "560064",
"socialNetworkId": "LinkedIn",
"stateOrProvince": "karnataka",
"street1": "RMZ Galleria",
"street2": "Office Block",
"houseNo": "56"
}
}
]
}
]
},
"additionalCharacteristics": [
{
"attributeName": "Data Throttling",
"attributeValue": "55738231121",
"attributeType": "String",
"lastModifiedDateTime": "2023-10-19T10:42:41.257Z",
"lastModifiedBy": "omui admin"
}
],
"createdBy": "om_admin",
"createdDateTime": "2023-10-19T10:42:41.257Z",
"lastModifiedBy": "om_admin",
"lastModifiedDateTime": "2023-10-19T10:42:41.257Z"
},
"isOfferAmended": false,
"portfolioDetails": {
"portfolioId": "BP1698224881607424",
"productLineCategory": "bm-postpaid-highend",
"offerContainerCategory": "bm-postpaid-highend",
"href": "https://host:port/paymentManagement/v4/cashPayment/2365",
"childProduct": [
{
"childProductOrderItemId": "9be74937-4927-4924-b2bb-d7a4dd401f1a",
"childInstallBaseId": "RUM1660733938024415",
"childSpecificationName": "Fiber Port",
"childCpoId": "CPO7894820397708LH425",
"inventory": false,
"state": "ACTIVE"
}
],
"parentProduct": {
"parentProductOrderItemId": "e2346",
"parentInstallBaseId": "BP1698224881533778",
"parentSpecificationName": "Mobile Postpaid - Product Specification",
"inventory": false,
"parentCpoId": "CPO7894820397708LH425",
"state": "ACTIVE"
}
},
"promotions": [
{
"category": "Managed SDWAN Service",
"id": "automation_promotion-pm_20eewvb",
"internalLifecycleStatus": "Test",
"description": "Promotion",
"lifeCycleStatus": "Test",
"name": "Automation_Promotion_678new",
"priority": 2,
"promoApplicationLevel": "cart",
"signature": "cartSignature",
"type": "Promotion",
"promotionAction": {
"actionCardinality": null,
"actionObjectId": "bm-samsung-product-bundle",
"actionType": "Add Product",
"actionValue": 2,
"applicationDuration": 1,
"cartItemId": "5432373c-6f65-46f8-a8b5-879a8df5b576",
"id": "pa_j6w82",
"maxActionValue": "3",
"priceId": "op_0nwf2jj",
"priceType": "recurring",
"priority": 4,
"recurringChargePeriodType": "Month"
},
"promotionClassification": "exclusive",
"coupon": {
"id": "54765",
"code": "MY_COUPON_CODE",
"coupon": false
},
"validFor": {
"startDateTime": "2023-08-11T09:17:41.866Z",
"endDateTime": "2023-08-11T09:17:41.866Z"
}
}
],
"additionalAttributes": [
{
"name": "MSISDN",
"valueType": "String",
"value": "55738231121",
"action": "ADD",
"validationStatus": "PASSED",
"createdBy": "admin",
"lastModifiedBy": "system",
"lastModifiedDateTime": "2023-10-19T10:42:41.257Z",
"createdDateTime": "2023-10-19T10:42:41.257Z",
"enrichmentDetail": {
"description": "Description of character",
"specType": "ServiceSpecification",
"referenceId": "data_service_specification_001",
"valueType": "List",
"minCardinality": null,
"maxCardinality": 1,
"characteristicValues": [
{
"valueType": "String",
"value": "True",
"validFor": {
"startDateTime": "2023-08-11T09:17:41.866Z",
"endDateTime": "2023-08-11T09:17:41.866Z"
},
"default": false,
"rangeInterval": "closedTop",
"regex": null,
"unitOfMeasure": "GB"
}
],
"validFor": {
"startDateTime": "2023-08-11T09:17:41.866Z",
"endDateTime": "2023-08-11T09:17:41.866Z"
},
"format": "String",
"length": 5,
"decimalValue": 0.767,
"tooltipValue": "Additional Information",
"visibleLine": "1",
"unique": false,
"extensible": false,
"configurable": false,
"displaySequence": 1,
"isVisible": false,
"configurationStage": "Product Offer Level",
"regex": "\"expression\": \"^[0-9]{9,13}$\",\n\"message\": \"Please enter a valid phone number\""
},
"errorDetails": [
{
"errorCode": "ERR-BM-OM-OV-OE-101",
"errorMessage": "Exception in Order Enrichment Process, Product Inventory Not Present"
}
],
"dynamicAttributes": [
{
"attributeName": "Data Throttling",
"attributeValue": "55738231121",
"attributeType": "String",
"lastModifiedDateTime": "2023-10-19T10:42:41.257Z",
"lastModifiedBy": "omui admin"
}
],
"isNetworkImpacting": false,
"isCharacteristicAmended": false
}
],
"productFeasibility": {
"validTill": {
"endDateTime": "2023-10-19T10:42:41.257Z",
"startDateTime": "2023-10-19T10:42:41.257Z"
},
"remark": "remark",
"approvedBy": "System",
"qualified": false,
"attributes": [
{
"name": "attribute_fa",
"value": "50SMS",
"valueType": "string,number,boolean",
"array": false,
"viewOnly": false,
"quantityBased": false
}
]
},
"dueDateJeopardyCategory": true,
"expDueDateJeopardyCategory": false,
"checkoutProductDetails": {
"type": "quote",
"associatedOCId": "",
"associatedCIId": "",
"associatedSiteId": "",
"source": "",
"externalId": "464bf14d-7373-4937-a73b-28217ac07528",
"overridePrice": 10,
"additionalAttributes": [
{
"name": "Order Level",
"value": "43654"
}
]
},
"bypassCharpoValidation": false,
"resourceAllocation": false,
"baseInstallBaseId": "BP1691740391567152",
"parallelInstallBaseId": "RUM1660733938024419",
"baseServiceTermination": false,
"isAmendOrderItem": false,
"isPreviousOrderItemState": true
}
],
"orderTotalPrice": [
{
"description": "Order Price Details",
"name": "robin_rf",
"recurringChargePeriod": "Monthly",
"priceType": "recurring",
"recurringChargePeriodLength": 1,
"offset": 3,
"tax": [
{
"taxType": "GST",
"externalID": "464bf14d-7373-4937-a73b-28217ac07528",
"id": "tax_automationtest-tx_bv8y95w",
"validFor": {
"startDateTime": "2023-08-11T09:17:41.866Z",
"endDateTime": "2023-08-11T09:17:41.866Z"
},
"@baseType": "Tax",
"@type": "Individual Type",
"taxAmount": {
"unit": "inr",
"value": 1000
},
"taxCategory": "Indian",
"taxRate": 20,
"name": "Tax_Automationtest",
"displayName": "Tax details",
"definesExemption": false,
"additionalAttributes": [
{
"name": "MSISDN",
"valueType": "String",
"value": "55738231121",
"action": "ADD",
"validationStatus": "PASSED",
"createdBy": "admin",
"lastModifiedBy": "system",
"lastModifiedDateTime": "2023-10-19T10:42:41.257Z",
"createdDateTime": "2023-10-19T10:42:41.257Z",
"enrichmentDetail": {
"description": "Description of character",
"specType": "ServiceSpecification",
"referenceId": "data_service_specification_001",
"valueType": "List",
"minCardinality": null,
"maxCardinality": 1,
"characteristicValues": [
{
"valueType": "String",
"value": "True",
"validFor": {},
"default": false,
"rangeInterval": "closedTop",
"regex": null,
"unitOfMeasure": "GB"
}
],
"validFor": {
"startDateTime": "2023-08-11T09:17:41.866Z",
"endDateTime": "2023-08-11T09:17:41.866Z"
},
"format": "String",
"length": 5,
"decimalValue": 0.767,
"tooltipValue": "Additional Information",
"visibleLine": "1",
"unique": false,
"extensible": false,
"configurable": false,
"displaySequence": 1,
"isVisible": false,
"configurationStage": "Product Offer Level",
"regex": "\"expression\": \"^[0-9]{9,13}$\",\n\"message\": \"Please enter a valid phone number\""
},
"errorDetails": [
{
"errorCode": "ERR-BM-OM-OV-OE-101",
"errorMessage": "Exception in Order Enrichment Process, Product Inventory Not Present"
}
],
"dynamicAttributes": [
{
"attributeName": "Data Throttling",
"attributeValue": "55738231121",
"attributeType": "String",
"lastModifiedDateTime": "2023-10-19T10:42:41.257Z",
"lastModifiedBy": "omui admin"
}
],
"isNetworkImpacting": false,
"isCharacteristicAmended": false
}
]
}
],
"priceId": "op_0nwf2jj",
"priceSubType": "recurring",
"unitOfMeasure": "INR",
"@baseType": "OrderPrice",
"@schemaLocation": "OrderPrice Collection",
"price": {
"percentage": 10,
"taxRate": 10,
"actionCardinality": 10,
"taxAmount": 10,
"@baseType": "Price",
"@type": "Price",
"dutyFreeAmount": {
"unit": "inr",
"value": 1000
},
"taxIncludedAmount": {
"unit": "inr",
"value": 1000
},
"@schemaLocation": "Price Collection",
"dutyFreeAlteredAmount": {
"unit": "inr",
"value": 1000
},
"taxIncludedAlteredAmount": {
"unit": "inr",
"value": 1000
},
"changeAmount": {
"unit": "inr",
"value": 1000
},
"discount": {
"unit": "inr",
"value": 1000
},
"amountPayable": {
"unit": "inr",
"value": 1000
},
"taxFixed": {
"unit": "inr",
"value": 1000
}
},
"@type": "OrderPrice",
"priceAlteration": [
{
"applicationDuration": 3,
"description": "Price Alteration Details",
"name": "ServiceOrder",
"priceAlterationType": "Discount",
"priceType": "recurring",
"priority": 2,
"recurringChargePeriod": "Month",
"referenceId": "data_service_specification_001",
"unitOfMeasure": "INR",
"@baseType": "PriceAlteration",
"@schemaLocation": "PriceAlteration Collection",
"@type": "recurring",
"price": {
"percentage": 10,
"taxRate": 10,
"actionCardinality": 10,
"taxAmount": 10,
"@baseType": "Price",
"@type": "Price",
"dutyFreeAmount": {
"unit": "inr",
"value": 1000
},
"taxIncludedAmount": {
"unit": "inr",
"value": 1000
},
"@schemaLocation": "Price Collection",
"dutyFreeAlteredAmount": {
"unit": "inr",
"value": 1000
},
"taxIncludedAlteredAmount": {
"unit": "inr",
"value": 1000
},
"changeAmount": {
"unit": "inr",
"value": 1000
},
"discount": {
"unit": "inr",
"value": 1000
},
"amountPayable": {
"unit": "inr",
"value": 1000
},
"taxFixed": {
"unit": "inr",
"value": 1000
}
},
"productOfferingPrice": {
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account",
"@baseType": "ProductOfferingPrice",
"@referredType": "ProductOfferingPrice Type",
"@schemaLocation": "ProductOfferingPrice Collection",
"@type": "individual Type"
}
}
],
"productOfferingPrice": {
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account",
"@baseType": "ProductOfferingPrice",
"@referredType": "ProductOfferingPrice Type",
"@schemaLocation": "ProductOfferingPrice Collection",
"@type": "individual Type"
},
"itemPriceRelationship": [
{
"priceId": "P465",
"relationshipType": "FIXED_PRICE"
}
],
"validFor": {
"endDateTime": "2023-10-19T10:42:41.257Z",
"startDateTime": "2023-10-19T10:42:41.257Z"
},
"isDownPaymentRequired": false,
"minimumDownPaymentAmount": null,
"isAgreementBased": false,
"offsetParameter": {
"numberofBlock": 2,
"totalAllowanceSelectionCount": 4,
"isCalenderBased": true,
"discountType": "FIXED_PRICE",
"billingDiscountExternalRef": "BD2024-123456",
"discountValue": 10,
"allowedDiscount": [
{
"block": 1,
"allowedSelectionCount": null,
"allowedSelectionPeriod": "2022-08-08 13:09:00.612Z",
"selectedDiscountPeriod": "2022-08-08 13:09:00.612Z"
}
]
},
"code": "PC_de716bb0",
"externalId": "prepaidplan_a-1_price_2-0_v1||123",
"id": "9a058452-d5c7-4ec2-9f3d-1ecc34d120ee",
"specCharacteristics": [
{
"name": "SMS Allowance",
"value": "50SMS",
"valueType": "String"
}
],
"isProrated": false,
"isArrears": false
}
],
"productOfferingQualification": [
{
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account"
}
],
"customerAccount": {
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account",
"dynamicAttributes": [
{
"attributeName": "Data Throttling",
"attributeValue": "55738231121",
"attributeType": "String",
"lastModifiedDateTime": "2023-10-19T10:42:41.257Z",
"lastModifiedBy": "omui admin"
}
],
"partyRef": [
{
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account"
}
],
"partyRoleRef": [
{
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account"
}
],
"aggrementRef": [
{
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account"
}
],
"paymentMethodRef": [
{
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account"
}
]
},
"billingAccount": {
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account",
"dynamicAttributes": [
{
"attributeName": "Data Throttling",
"attributeValue": "55738231121",
"attributeType": "String",
"lastModifiedDateTime": "2023-10-19T10:42:41.257Z",
"lastModifiedBy": "omui admin"
}
],
"financeSettlementRef": [
{
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account"
}
],
"paymentMethodRef": [
{
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account"
}
],
"itemPriceRef": [
{
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account"
}
],
"@baseType": "ProductOfferingPrice",
"@type": "Individual Party",
"@schemaLocation": "BillingAccount",
"@referredType": "BillingAccount"
},
"billingAccountList": [
{
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account",
"dynamicAttributes": [
{
"attributeName": "Data Throttling",
"attributeValue": "55738231121",
"attributeType": "String",
"lastModifiedDateTime": "2023-10-19T10:42:41.257Z",
"lastModifiedBy": "omui admin"
}
],
"financeSettlementRef": [
{
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account"
}
],
"paymentMethodRef": [
{
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account"
}
],
"itemPriceRef": [
{
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account"
}
],
"@baseType": "ProductOfferingPrice",
"@type": "Individual Party",
"@schemaLocation": "BillingAccount",
"@referredType": "BillingAccount"
}
],
"isAmendOrder": false,
"isAmendOrderWithCancel": false,
"isValidatedPOQ": false,
"externalOrderReferenceNumber": "879A",
"externalOrderId": "464bf14d-7373-4937-a73b-28217ac07528",
"marketSegment": {
"id": "7894820397708LH425643",
"name": "Retail"
},
"additionalAttributes": [
{
"name": "MSISDN",
"valueType": "String",
"value": "55738231121",
"action": "ADD",
"validationStatus": "PASSED",
"createdBy": "admin",
"lastModifiedBy": "system",
"lastModifiedDateTime": "2023-10-19T10:42:41.257Z",
"createdDateTime": "2023-10-19T10:42:41.257Z",
"enrichmentDetail": {
"description": "Description of character",
"specType": "ServiceSpecification",
"referenceId": "data_service_specification_001",
"valueType": "List",
"minCardinality": null,
"maxCardinality": 1,
"characteristicValues": [
{
"valueType": "String",
"value": "True",
"validFor": {
"startDateTime": "2023-08-11T09:17:41.866Z",
"endDateTime": "2023-08-11T09:17:41.866Z"
},
"default": false,
"rangeInterval": "closedTop",
"regex": null,
"unitOfMeasure": "GB"
}
],
"validFor": {
"startDateTime": "2023-08-11T09:17:41.866Z",
"endDateTime": "2023-08-11T09:17:41.866Z"
},
"format": "String",
"length": 5,
"decimalValue": 0.767,
"tooltipValue": "Additional Information",
"visibleLine": "1",
"unique": false,
"extensible": false,
"configurable": false,
"displaySequence": 1,
"isVisible": false,
"configurationStage": "Product Offer Level",
"regex": "\"expression\": \"^[0-9]{9,13}$\",\n\"message\": \"Please enter a valid phone number\""
},
"errorDetails": [
{
"errorCode": "ERR-BM-OM-OV-OE-101",
"errorMessage": "Exception in Order Enrichment Process, Product Inventory Not Present"
}
],
"dynamicAttributes": [
{
"attributeName": "Data Throttling",
"attributeValue": "55738231121",
"attributeType": "String",
"lastModifiedDateTime": "2023-10-19T10:42:41.257Z",
"lastModifiedBy": "omui admin"
}
],
"isNetworkImpacting": false,
"isCharacteristicAmended": false
}
],
"promotions": [
{
"category": "Managed SDWAN Service",
"id": "automation_promotion-pm_20eewvb",
"internalLifecycleStatus": "Test",
"description": "Promotion",
"lifeCycleStatus": "Test",
"name": "Automation_Promotion_678new",
"priority": 2,
"promoApplicationLevel": "cart",
"signature": "cartSignature",
"type": "Promotion",
"promotionAction": {
"actionCardinality": null,
"actionObjectId": "bm-samsung-product-bundle",
"actionType": "Add Product",
"actionValue": 2,
"applicationDuration": 1,
"cartItemId": "5432373c-6f65-46f8-a8b5-879a8df5b576",
"id": "pa_j6w82",
"maxActionValue": "3",
"priceId": "op_0nwf2jj",
"priceType": "recurring",
"priority": 4,
"recurringChargePeriodType": "Month"
},
"promotionClassification": "exclusive",
"coupon": {
"id": "54765",
"code": "MY_COUPON_CODE",
"coupon": false
},
"validFor": {
"startDateTime": "2023-08-11T09:17:41.866Z",
"endDateTime": "2023-08-11T09:17:41.866Z"
}
}
],
"nonRecurringPriceAdjustment": [
{
"id": "c63784c1-1d57-4b31-b61e-900db2d8f6e7",
"amount": null,
"details": [
{
"name": "SMS Allowance",
"value": "50SMS"
}
],
"name": "SMS Allowance",
"referenceId": "data_service_specification_001",
"type": "Physical"
}
],
"customerOrderType": "NEW",
"jeopardyFlag": false,
"visibleFlag": "yes,no",
"isLargeOrder": false,
"parentOrderId": "881a6d15-bcbe-4372-b48a-41cba29f4806",
"parentCpoId": "CPO2477328421161597NQ575",
"subOrderMetaData": [
{
"subOrderId": "1",
"state": "COMPLETED",
"status": "Provisioning - Completed",
"subOrderCpoId": "CPO2477328421161597NQ575",
"productSubOrderItemRef": [
{
"productSubOrderItemId": "3e934f5f-4fb7-4e01-a33d-4bd7c33f5828",
"installbaseId": "BP1686636408708199",
"productName": "Mobile",
"productOrderItemType": "New Order"
}
]
}
],
"priority": "HIGHEST, LOW",
"processingPriority": "High",
"priorityRelayTopics": [
{
"moduleName": "",
"relayTopicName": "",
"prioritySequence": "",
"processingPriority": ""
}
],
"isPortabilityOrder": false
}What made this section unhelpful for you?
Update Item Price
In a product order system, the API denotes an endpoint or function enabling users to perform partial updates or alterations to the pricing details of a particular item within an already-existing product order.
Header Parameters
Unique identifier for tracking the transaction.
Identifier for correlating related requests and responses.
Source channel or origin of the request.
Identifier of the associated tenant or customer.
Path Parameters
Uniquely Identifier ID
"ProductOrderItemId" likely refers to a unique identifier assigned to a specific item within a product order.
Body Parameters
ADDMODIFYDELETENO_CHANGEA list of order prices (OrderPrice [*]). An amount, usually of money,that represents the actual price paid by the Customer for this item or this order.
Show child attributes
Response
Response Attributes
A Date,Error creation date and time
A String,A error code provides specific error code which occurred
A error,A error reason provides the specific reason why error occurred
Error message,A error message provides the specific message which occurred
Error stacktrace,A error stacktrace provides the stacktrace for error occurred
Response Attributes
A Date,Error creation date and time
A String,A error code provides specific error code which occurred
A error,A error reason provides the specific reason why error occurred
Error message,A error message provides the specific message which occurred
Error stacktrace,A error stacktrace provides the stacktrace for error occurred
Response Attributes
A Date,Error creation date and time
A String,A error code provides specific error code which occurred
A error,A error reason provides the specific reason why error occurred
Error message,A error message provides the specific message which occurred
Error stacktrace,A error stacktrace provides the stacktrace for error occurred
Response Attributes
A Date,Error creation date and time
A String,A error code provides specific error code which occurred
A error,A error reason provides the specific reason why error occurred
Error message,A error message provides the specific message which occurred
Error stacktrace,A error stacktrace provides the stacktrace for error occurred
Response Attributes
A numeric or alphanumeric code that represents a specific error or issue encountered during an operation.
A human-readable message that provides additional details about the error. It offers context and information to help users or developers understand what went wrong
A timestamp indicating when the error occurred, typically in a standardized format such as ISO 8601. It helps with debugging and tracking issues over time
An HTTP status code that indicates the outcome of the request or operation. Common examples include 200 (OK), 404 (Not Found), or 500 (Internal Server Error).
The URL or endpoint that was accessed when the error occurred. It specifies the location of the request that led to the error.
Response Attributes
A Date,Error creation date and time
A String,A error code provides specific error code which occurred
A error,A error reason provides the specific reason why error occurred
Error message,A error message provides the specific message which occurred
Error stacktrace,A error stacktrace provides the stacktrace for error occurred
Response Attributes
A Date,Error creation date and time
A String,A error code provides specific error code which occurred
A error,A error reason provides the specific reason why error occurred
Error message,A error message provides the specific message which occurred
Error stacktrace,A error stacktrace provides the stacktrace for error occurred
Response Attributes
A Date,Error creation date and time
A String,A error code provides specific error code which occurred
A error,A error reason provides the specific reason why error occurred
Error message,A error message provides the specific message which occurred
Error stacktrace,A error stacktrace provides the stacktrace for error occurred
What made this section unhelpful for you?
Response
ProductOrderItemPrice Updated SuccessfullyWhat made this section unhelpful for you?
Update Item
This API represents an endpoint or function facilitating partial updates or modifications to a specific item within an existing product order using PATCH operation. This process initiates product inventory update events designed to update details like status and characteristics. Invoked by the fulfillment and decomposition modules, the API ensures the accurate updating of item-level details within the customer order.
Header Parameters
Unique identifier for tracking the transaction.
Identifier for correlating related requests and responses.
Source channel or origin of the request.
Identifier of the associated tenant or customer.
Path Parameters
Uniquely Identifier ID
"ProductOrderItemId" likely refers to a unique identifier assigned to a specific item within a product order.
Body Parameters
Identifier for the install base or equipment associated with the order item.
The current state or condition of the order item.
ACKNOWLEDGEDREJECTEDPENDINGHELDIN_PROGRESSCANCELLEDACTIVATEDCOMPLETEDFAILEDCONFIRMED... 4 other enums
The overall status or progress of the order item.
Specific characteristics or attributes of the product related to the order item.
Show child attributes
The anticipated date when the order item is expected to be completed.
The date when the completion of the order item was requested.
Additional notes or comments related to the order item.
Show child attributes
Information about parties or entities related to the order item.
Show child attributes
A physical or virtual location associated with the order item.
Show child attributes
Portability is the seamless transferability and adaptability of something across diverse platforms
Show child attributes
PortfolioDetails encapsulates comprehensive attributes and information about items within a portfolio
Show child attributes
A product offering reference (ProductOfferingRef). A product offering represents entities that are orderable from the provider of the catalog, this resource includes pricing information.
Show child attributes
A product specification reference (ProductSpecificationRef). A ProductSpecification is a detailed description of a tangible or intangible object made available externally in the form of a ProductOffering to customers or other parties playing a party role.
Show child attributes
Details about any errors or issues related to the order item.
Show child attributes
Identifier for the parent bundle offer associated with the order item.
Identifier for the install base of the parent bundle.
The user or entity that last modified the order item.
The date and time when the order item was last modified.
A flag indicating whether a specific process or action should be performed.
A flag indicating whether the order item is part of a workflow process.
Information about promotions or discounts associated with the order item.
Show child attributes
Response
Response Attributes
A Date,Error creation date and time
A String,A error code provides specific error code which occurred
A error,A error reason provides the specific reason why error occurred
Error message,A error message provides the specific message which occurred
Error stacktrace,A error stacktrace provides the stacktrace for error occurred
Response Attributes
A Date,Error creation date and time
A String,A error code provides specific error code which occurred
A error,A error reason provides the specific reason why error occurred
Error message,A error message provides the specific message which occurred
Error stacktrace,A error stacktrace provides the stacktrace for error occurred
Response Attributes
A Date,Error creation date and time
A String,A error code provides specific error code which occurred
A error,A error reason provides the specific reason why error occurred
Error message,A error message provides the specific message which occurred
Error stacktrace,A error stacktrace provides the stacktrace for error occurred
Response Attributes
A Date,Error creation date and time
A String,A error code provides specific error code which occurred
A error,A error reason provides the specific reason why error occurred
Error message,A error message provides the specific message which occurred
Error stacktrace,A error stacktrace provides the stacktrace for error occurred
Response Attributes
A numeric or alphanumeric code that represents a specific error or issue encountered during an operation.
A human-readable message that provides additional details about the error. It offers context and information to help users or developers understand what went wrong
A timestamp indicating when the error occurred, typically in a standardized format such as ISO 8601. It helps with debugging and tracking issues over time
An HTTP status code that indicates the outcome of the request or operation. Common examples include 200 (OK), 404 (Not Found), or 500 (Internal Server Error).
The URL or endpoint that was accessed when the error occurred. It specifies the location of the request that led to the error.
Response Attributes
A Date,Error creation date and time
A String,A error code provides specific error code which occurred
A error,A error reason provides the specific reason why error occurred
Error message,A error message provides the specific message which occurred
Error stacktrace,A error stacktrace provides the stacktrace for error occurred
Response Attributes
A Date,Error creation date and time
A String,A error code provides specific error code which occurred
A error,A error reason provides the specific reason why error occurred
Error message,A error message provides the specific message which occurred
Error stacktrace,A error stacktrace provides the stacktrace for error occurred
Response Attributes
A Date,Error creation date and time
A String,A error code provides specific error code which occurred
A error,A error reason provides the specific reason why error occurred
Error message,A error message provides the specific message which occurred
Error stacktrace,A error stacktrace provides the stacktrace for error occurred
What made this section unhelpful for you?
Response
ProductOrderItem Updated SuccessfullyWhat made this section unhelpful for you?
Confirm Product Order
The 'Confirm Existing ProductOrder' API within a product order system is an endpoint or function utilized to confirm or finalize an existing product order through the PATCH operation. Additionally, it triggers an event signaling to other modules that validation is successful and initiates further Order Management processing. Furthermore, this API updates the order status in the Customer Order.
Header Parameters
Unique identifier for tracking the transaction.
Identifier for correlating related requests and responses.
Source channel or origin of the request.
Identifier of the associated tenant or customer.
Path Parameters
Uniquely Identifier ID
Body Parameters
Identifier for the customer purchase order (CPO) associated with the order.
Order Validation Confirm typically refers to a step or process in order management where the validation of an order is confirmed.
Show child attributes
Response
Response Attributes
A Date,Error creation date and time
A String,A error code provides specific error code which occurred
A error,A error reason provides the specific reason why error occurred
Error message,A error message provides the specific message which occurred
Error stacktrace,A error stacktrace provides the stacktrace for error occurred
Response Attributes
A Date,Error creation date and time
A String,A error code provides specific error code which occurred
A error,A error reason provides the specific reason why error occurred
Error message,A error message provides the specific message which occurred
Error stacktrace,A error stacktrace provides the stacktrace for error occurred
Response Attributes
A Date,Error creation date and time
A String,A error code provides specific error code which occurred
A error,A error reason provides the specific reason why error occurred
Error message,A error message provides the specific message which occurred
Error stacktrace,A error stacktrace provides the stacktrace for error occurred
Response Attributes
A Date,Error creation date and time
A String,A error code provides specific error code which occurred
A error,A error reason provides the specific reason why error occurred
Error message,A error message provides the specific message which occurred
Error stacktrace,A error stacktrace provides the stacktrace for error occurred
Response Attributes
A numeric or alphanumeric code that represents a specific error or issue encountered during an operation.
A human-readable message that provides additional details about the error. It offers context and information to help users or developers understand what went wrong
A timestamp indicating when the error occurred, typically in a standardized format such as ISO 8601. It helps with debugging and tracking issues over time
An HTTP status code that indicates the outcome of the request or operation. Common examples include 200 (OK), 404 (Not Found), or 500 (Internal Server Error).
The URL or endpoint that was accessed when the error occurred. It specifies the location of the request that led to the error.
Response Attributes
A Date,Error creation date and time
A String,A error code provides specific error code which occurred
A error,A error reason provides the specific reason why error occurred
Error message,A error message provides the specific message which occurred
Error stacktrace,A error stacktrace provides the stacktrace for error occurred
Response Attributes
A Date,Error creation date and time
A String,A error code provides specific error code which occurred
A error,A error reason provides the specific reason why error occurred
Error message,A error message provides the specific message which occurred
Error stacktrace,A error stacktrace provides the stacktrace for error occurred
Response Attributes
A Date,Error creation date and time
A String,A error code provides specific error code which occurred
A error,A error reason provides the specific reason why error occurred
Error message,A error message provides the specific message which occurred
Error stacktrace,A error stacktrace provides the stacktrace for error occurred
What made this section unhelpful for you?
Response
ProductOrder Confirmed SuccessfullyWhat made this section unhelpful for you?
Update Portfolio Containers
This request is employed to append the visible flag and portfolioContainers object to pre-existing customer orders, as per the provided page and size parameters. This action supersedes the current portfolioContainers object for all qualifying customer orders.
Header Parameters
Unique identifier for tracking the transaction.
Identifier for correlating related requests and responses.
Source channel or origin of the request.
Identifier of the associated tenant or customer.
Response
Response Attributes
The current status of the OfferContainer such as Open,In_Progress,Resolved or Closed
message: A human-readable description of the error
Response Attributes
A Date,Error creation date and time
A String,A error code provides specific error code which occurred
A error,A error reason provides the specific reason why error occurred
Error message,A error message provides the specific message which occurred
Error stacktrace,A error stacktrace provides the stacktrace for error occurred
Response Attributes
A Date,Error creation date and time
A String,A error code provides specific error code which occurred
A error,A error reason provides the specific reason why error occurred
Error message,A error message provides the specific message which occurred
Error stacktrace,A error stacktrace provides the stacktrace for error occurred
Response Attributes
A Date,Error creation date and time
A String,A error code provides specific error code which occurred
A error,A error reason provides the specific reason why error occurred
Error message,A error message provides the specific message which occurred
Error stacktrace,A error stacktrace provides the stacktrace for error occurred
Response Attributes
A Date,Error creation date and time
A String,A error code provides specific error code which occurred
A error,A error reason provides the specific reason why error occurred
Error message,A error message provides the specific message which occurred
Error stacktrace,A error stacktrace provides the stacktrace for error occurred
Response Attributes
A numeric or alphanumeric code that represents a specific error or issue encountered during an operation.
A human-readable message that provides additional details about the error. It offers context and information to help users or developers understand what went wrong
A timestamp indicating when the error occurred, typically in a standardized format such as ISO 8601. It helps with debugging and tracking issues over time
An HTTP status code that indicates the outcome of the request or operation. Common examples include 200 (OK), 404 (Not Found), or 500 (Internal Server Error).
The URL or endpoint that was accessed when the error occurred. It specifies the location of the request that led to the error.
Response Attributes
A Date,Error creation date and time
A String,A error code provides specific error code which occurred
A error,A error reason provides the specific reason why error occurred
Error message,A error message provides the specific message which occurred
Error stacktrace,A error stacktrace provides the stacktrace for error occurred
Response Attributes
A Date,Error creation date and time
A String,A error code provides specific error code which occurred
A error,A error reason provides the specific reason why error occurred
Error message,A error message provides the specific message which occurred
Error stacktrace,A error stacktrace provides the stacktrace for error occurred
Response Attributes
A Date,Error creation date and time
A String,A error code provides specific error code which occurred
A error,A error reason provides the specific reason why error occurred
Error message,A error message provides the specific message which occurred
Error stacktrace,A error stacktrace provides the stacktrace for error occurred
What made this section unhelpful for you?
Response
{
"status": "Completed",
"message": "You are not authorized to access this resource. Please log in and try again"
}What made this section unhelpful for you?
Update Jeopardy Flag
This API within a product order system denotes an endpoint or function enabling the update of the jeopardy flag (true/false) for a customer order based on any open jeopardy associated with the order ID. Upon closure of the respective jeopardy, the flag is updated to false
Header Parameters
Unique identifier for tracking the transaction.
Identifier for correlating related requests and responses.
Source channel or origin of the request.
Identifier of the associated tenant or customer.
Query Parameters
Uniquely Identifier ID
The "CPO ID" refers to the unique identifier assigned to a specific Customer Purchase Order.
a "JeopardyFlag" might indicate that an order is facing potential issues
Response
Response Attributes
A string.The unique identifier associated with a Customer Purchase Order (CPO)
A date time (DateTime). Date when the product order was cancelled.
CancellationReason is the specific explanation for the cancellation of a ProductOrderRequest
A date time (DateTime). Effective delivery date amended by the provider.
expectedCompletionDate typically represents the anticipated date for Request completion
A string. Contact attached to the order to send back information regarding this order.
orderDate represents the timestamp when the order was placed for products
A date time (DateTime). Requested delivery date from the requestors perspective.
A date time (DateTime). the preferred initiation date for a requested productOrder
A date time (DateTime).The date on which the ordered product was actually initiated or commenced
A product order state type (ProductOrderStateType). State of the order: described in the state-machine diagram.
ACKNOWLEDGEDREJECTEDPENDINGHELDIN_PROGRESSCONFIRMEDCANCELLEDACTIVECOMPLETEDFAILED... 5 other enums
Status represents the current stage of a requested productOrder.
A list of related parties. Related Entity reference A related party defines party or party role linked to a specific entity.
Show child attributes
A string. Hyperlink to access the order
A string. ID given by the consumer to facilitate searches
A string.Description is a narrative text describing the content of the ProductOrderRequest
A string. Used to categorize the order, useful for the OM system, such as: Broadband, TVOption.
CreatedBy identifies the entity responsible for creating the ProductOrderRequest
The date and time when the ProductOrderRequest was initially created
LastModifiedBy indicates the entity who made last modifications to the ProductOrder
LastModifiedDateTime indicates the date and time when the ProductOrderRequest was last modified
List of Offer Container details
Show child attributes
List of Portfolio Container details
Show child attributes
This is signature field generated for individual promotion that can be applied in cart for individual offer container
Show child attributes
A unique identifier for the original order that forms the basis for subsequent amendments
Identifier assigned to a request for amending or modifying a specific product order
Type or category of the order.
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.
Show child attributes
A list of agreement references (AgreementRef [*]). A reference to an agreement defined in the context of the product order.
Show child attributes
A list of related channels (RelatedChannel [*]). Related channel to another entity. May be online web, mobile app, social ,etc.
Show child attributes
A list of notes (Note [*]). Extra information about a given entity.
Show child attributes
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.
Show child attributes
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.
Show child attributes
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.
Show child attributes
A list of product offering qualification references It's a productOfferingQualification that has been executed previously.
Show child attributes
The account of the customer who has placed the order for a product
Show child attributes
A billing account reference (BillingAccountRef). A BillingAccount is a detailed description of a bill structure.
Show child attributes
A billing account reference (BillingAccountRef). A BillingAccount is a detailed description of a bill structure.
Show child attributes
OrderAmendmentFlag indicates whether any modifications or changes have been applied to the original order
Boolean value true to notify whether order is amend with cancel or not by default false.
ValidatedPOQFlag is an indicator signaling the validation status of a Purchase Order Quantity (POQ) within a process
A distinct identifier linked to orders from external sources, facilitating tracking and integration
ExternalOrderId is a unique identifier assigned to orders from external sources for effective tracking and management
This is the market segment(s) for which this particular metaExtension will be applicable
Show child attributes
List of Characteristics Additional attributes
Show child attributes
list of promotions to store instances of the Promotion
Show child attributes
List of the Non recurring price adjustment.
Show child attributes
customerOrderType for B2B or B2C indentification
The jeopardyFlag is a boolean indicator used to signal and handle critical situations in the ProductOrderRequest
Visible Flag refers to the visibility status of an element or feature in the ProductOrderRequest
Large Order flag decide if Order is large Order and it has more Line Items that predefined number of line items
A string.OrderId is a unique identifier assigned to a specific for Parent Order Id for Large Order
A string.The unique identifier associated with a Customer Purchase Order (CPO) for Parent Order Id for Large Order
list of subOrders MetaData for large Order
Show child attributes
priority indicates request in which should be addressed for escalation, with values such as High,Medium, or Low
A string.processingPriority indicates request in which productOrder should be addressed, with values such as High,Medium, or Low
A List of module vs topic name mapping for priority processing
Show child attributes
The portabilityOrder attribute is an essential tool for maintaining a structured and organized approach to portability.
Response Attributes
A Date,Error creation date and time
A String,A error code provides specific error code which occurred
A error,A error reason provides the specific reason why error occurred
Error message,A error message provides the specific message which occurred
Error stacktrace,A error stacktrace provides the stacktrace for error occurred
Response Attributes
A Date,Error creation date and time
A String,A error code provides specific error code which occurred
A error,A error reason provides the specific reason why error occurred
Error message,A error message provides the specific message which occurred
Error stacktrace,A error stacktrace provides the stacktrace for error occurred
Response Attributes
A Date,Error creation date and time
A String,A error code provides specific error code which occurred
A error,A error reason provides the specific reason why error occurred
Error message,A error message provides the specific message which occurred
Error stacktrace,A error stacktrace provides the stacktrace for error occurred
Response Attributes
A Date,Error creation date and time
A String,A error code provides specific error code which occurred
A error,A error reason provides the specific reason why error occurred
Error message,A error message provides the specific message which occurred
Error stacktrace,A error stacktrace provides the stacktrace for error occurred
Response Attributes
A numeric or alphanumeric code that represents a specific error or issue encountered during an operation.
A human-readable message that provides additional details about the error. It offers context and information to help users or developers understand what went wrong
A timestamp indicating when the error occurred, typically in a standardized format such as ISO 8601. It helps with debugging and tracking issues over time
An HTTP status code that indicates the outcome of the request or operation. Common examples include 200 (OK), 404 (Not Found), or 500 (Internal Server Error).
The URL or endpoint that was accessed when the error occurred. It specifies the location of the request that led to the error.
Response Attributes
A Date,Error creation date and time
A String,A error code provides specific error code which occurred
A error,A error reason provides the specific reason why error occurred
Error message,A error message provides the specific message which occurred
Error stacktrace,A error stacktrace provides the stacktrace for error occurred
Response Attributes
A Date,Error creation date and time
A String,A error code provides specific error code which occurred
A error,A error reason provides the specific reason why error occurred
Error message,A error message provides the specific message which occurred
Error stacktrace,A error stacktrace provides the stacktrace for error occurred
Response Attributes
A Date,Error creation date and time
A String,A error code provides specific error code which occurred
A error,A error reason provides the specific reason why error occurred
Error message,A error message provides the specific message which occurred
Error stacktrace,A error stacktrace provides the stacktrace for error occurred
What made this section unhelpful for you?
Response
{
"cpoId": "CPO2477328421161597NQ575",
"cancellationDate": "2023-10-19T10:42:41.257Z",
"cancellationReason": "Termination",
"completionDate": "2023-10-19T10:42:41.257Z",
"expectedCompletionDate": "2023-10-19T10:42:41.257Z",
"notificationContact": "example.rnp@gmail.com",
"orderDate": "2023-10-19T10:42:41.257Z",
"requestedCompletionDate": "2023-10-19T10:42:41.257Z",
"requestedStartDate": "2023-10-19T10:42:41.257Z",
"actualStartDate": "2023-10-19T10:42:41.257Z",
"state": "FAILED",
"status": "Provisioning - Failed",
"relatedParty": [
{
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account",
"role": "OM_DATA_MANAGER",
"type": "Individual Party",
"baseType": "ProductOfferingPrice",
"referredType": "BillingAccount",
"schemaLocation": "RelatedParty Collection",
"contactMedium": [
{
"baseType": "ProductOfferingPrice",
"type": "Individual Party",
"schemaLocation": "ContactMedium Collection",
"preferred": false,
"mediumType": "url",
"validFor": {
"startDateTime": "2023-08-11T09:17:41.866Z",
"endDateTime": "2023-08-11T09:17:41.866Z"
},
"characteristic": {
"baseType": "ProductOfferingPrice",
"type": "Individual Party",
"schemaLocation": "Contact Characteristics Collection",
"addressId": "#234",
"city": "Bengalore",
"contactType": "phone",
"country": "India",
"emailAddress": "example.@gmail.com",
"faxNumber": "212-111-2222",
"phoneNumber": "9856876322",
"postCode": "560064",
"socialNetworkId": "LinkedIn",
"stateOrProvince": "karnataka",
"street1": "RMZ Galleria",
"street2": "Office Block",
"houseNo": "56"
}
}
]
}
],
"href": "/product-inventory",
"externalId": "881a6d15-bcbe-4372-b48a-41cba29f4806",
"description": "example = find details for product Order Request",
"category": "Broadband",
"createdBy": "intadmin1",
"createdDateTime": "2023-10-19T10:42:41.257Z",
"lastModifiedBy": "intadmin1",
"lastModifiedDateTime": "",
"offerContainers": [
{
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account",
"processContext": "ACQ",
"lineOfBusiness": "mobile",
"category": {
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account",
"version": null
},
"state": "ACKNOWLEDGED",
"status": "Completed",
"productOrderItemsRefs": [
{
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account"
}
],
"externalOfferContainerId": "880",
"externalOfferContainerReferenceNumber": "880A",
"additionalAttributes": [
{
"name": "MSISDN",
"valueType": "String",
"value": "55738231121",
"action": "ADD",
"validationStatus": "PASSED",
"createdBy": "admin",
"lastModifiedBy": "system",
"lastModifiedDateTime": "2023-10-19T10:42:41.257Z",
"createdDateTime": "2023-10-19T10:42:41.257Z",
"enrichmentDetail": {
"description": "Description of character",
"specType": "ServiceSpecification",
"referenceId": "data_service_specification_001",
"valueType": "List",
"minCardinality": null,
"maxCardinality": 1,
"characteristicValues": [
{
"valueType": "String",
"value": "True",
"validFor": {
"startDateTime": "2023-08-11T09:17:41.866Z",
"endDateTime": "2023-08-11T09:17:41.866Z"
},
"default": false,
"rangeInterval": "closedTop",
"regex": null,
"unitOfMeasure": "GB"
}
],
"validFor": {
"startDateTime": "2023-08-11T09:17:41.866Z",
"endDateTime": "2023-08-11T09:17:41.866Z"
},
"format": "String",
"length": 5,
"decimalValue": 0.767,
"tooltipValue": "Additional Information",
"visibleLine": "1",
"unique": false,
"extensible": false,
"configurable": false,
"displaySequence": 1,
"isVisible": false,
"configurationStage": "Product Offer Level",
"regex": "\"expression\": \"^[0-9]{9,13}$\",\n\"message\": \"Please enter a valid phone number\""
},
"errorDetails": [
{
"errorCode": "ERR-BM-OM-OV-OE-101",
"errorMessage": "Exception in Order Enrichment Process, Product Inventory Not Present"
}
],
"dynamicAttributes": [
{
"attributeName": "Data Throttling",
"attributeValue": "55738231121",
"attributeType": "String",
"lastModifiedDateTime": "2023-10-19T10:42:41.257Z",
"lastModifiedBy": "omui admin"
}
],
"isNetworkImpacting": false,
"isCharacteristicAmended": false
}
],
"promotions": [
{
"category": "Managed SDWAN Service",
"id": "automation_promotion-pm_20eewvb",
"internalLifecycleStatus": "Test",
"description": "Promotion",
"lifeCycleStatus": "Test",
"name": "Automation_Promotion_678new",
"priority": 2,
"promoApplicationLevel": "cart",
"signature": "cartSignature",
"type": "Promotion",
"promotionAction": {
"actionCardinality": null,
"actionObjectId": "bm-samsung-product-bundle",
"actionType": "Add Product",
"actionValue": 2,
"applicationDuration": 1,
"cartItemId": "5432373c-6f65-46f8-a8b5-879a8df5b576",
"id": "pa_j6w82",
"maxActionValue": "3",
"priceId": "op_0nwf2jj",
"priceType": "recurring",
"priority": 4,
"recurringChargePeriodType": "Month"
},
"promotionClassification": "exclusive",
"coupon": {
"id": "54765",
"code": "MY_COUPON_CODE",
"coupon": false
},
"validFor": {
"startDateTime": "2023-08-11T09:17:41.866Z",
"endDateTime": "2023-08-11T09:17:41.866Z"
}
}
],
"offerContainerTotalPrice": [
{
"description": "Order Price Details",
"name": "robin_rf",
"recurringChargePeriod": "Monthly",
"priceType": "recurring",
"recurringChargePeriodLength": 1,
"offset": 3,
"tax": [
{
"taxType": "GST",
"externalID": "464bf14d-7373-4937-a73b-28217ac07528",
"id": "tax_automationtest-tx_bv8y95w",
"validFor": {
"startDateTime": "2023-08-11T09:17:41.866Z",
"endDateTime": "2023-08-11T09:17:41.866Z"
},
"@baseType": "Tax",
"@type": "Individual Type",
"taxAmount": {
"unit": "inr",
"value": 1000
},
"taxCategory": "Indian",
"taxRate": 20,
"name": "Tax_Automationtest",
"displayName": "Tax details",
"definesExemption": false,
"additionalAttributes": [
{
"name": "MSISDN",
"valueType": "String",
"value": "55738231121",
"action": "ADD",
"validationStatus": "PASSED",
"createdBy": "admin",
"lastModifiedBy": "system",
"lastModifiedDateTime": "2023-10-19T10:42:41.257Z",
"createdDateTime": "2023-10-19T10:42:41.257Z",
"enrichmentDetail": {
"description": "Description of character",
"specType": "ServiceSpecification",
"referenceId": "data_service_specification_001",
"valueType": "List",
"minCardinality": null,
"maxCardinality": 1,
"characteristicValues": [],
"validFor": {},
"format": "String",
"length": 5,
"decimalValue": 0.767,
"tooltipValue": "Additional Information",
"visibleLine": "1",
"unique": false,
"extensible": false,
"configurable": false,
"displaySequence": 1,
"isVisible": false,
"configurationStage": "Product Offer Level",
"regex": "\"expression\": \"^[0-9]{9,13}$\",\n\"message\": \"Please enter a valid phone number\""
},
"errorDetails": [
""
],
"dynamicAttributes": [
""
],
"isNetworkImpacting": false,
"isCharacteristicAmended": false
}
]
}
],
"priceId": "op_0nwf2jj",
"priceSubType": "recurring",
"unitOfMeasure": "INR",
"@baseType": "OrderPrice",
"@schemaLocation": "OrderPrice Collection",
"price": {
"percentage": 10,
"taxRate": 10,
"actionCardinality": 10,
"taxAmount": 10,
"@baseType": "Price",
"@type": "Price",
"dutyFreeAmount": {
"unit": "inr",
"value": 1000
},
"taxIncludedAmount": {
"unit": "inr",
"value": 1000
},
"@schemaLocation": "Price Collection",
"dutyFreeAlteredAmount": {
"unit": "inr",
"value": 1000
},
"taxIncludedAlteredAmount": {
"unit": "inr",
"value": 1000
},
"changeAmount": {
"unit": "inr",
"value": 1000
},
"discount": {
"unit": "inr",
"value": 1000
},
"amountPayable": {
"unit": "inr",
"value": 1000
},
"taxFixed": {
"unit": "inr",
"value": 1000
}
},
"@type": "OrderPrice",
"priceAlteration": [
{
"applicationDuration": 3,
"description": "Price Alteration Details",
"name": "ServiceOrder",
"priceAlterationType": "Discount",
"priceType": "recurring",
"priority": 2,
"recurringChargePeriod": "Month",
"referenceId": "data_service_specification_001",
"unitOfMeasure": "INR",
"@baseType": "PriceAlteration",
"@schemaLocation": "PriceAlteration Collection",
"@type": "recurring",
"price": {
"percentage": 10,
"taxRate": 10,
"actionCardinality": 10,
"taxAmount": 10,
"@baseType": "Price",
"@type": "Price",
"dutyFreeAmount": {
"unit": "inr",
"value": 1000
},
"taxIncludedAmount": {
"unit": "inr",
"value": 1000
},
"@schemaLocation": "Price Collection",
"dutyFreeAlteredAmount": {
"unit": "inr",
"value": 1000
},
"taxIncludedAlteredAmount": {
"unit": "inr",
"value": 1000
},
"changeAmount": {
"unit": "inr",
"value": 1000
},
"discount": {
"unit": "inr",
"value": 1000
},
"amountPayable": {
"unit": "inr",
"value": 1000
},
"taxFixed": {
"unit": "inr",
"value": 1000
}
},
"productOfferingPrice": {
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account",
"@baseType": "ProductOfferingPrice",
"@referredType": "ProductOfferingPrice Type",
"@schemaLocation": "ProductOfferingPrice Collection",
"@type": "individual Type"
}
}
],
"productOfferingPrice": {
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account",
"@baseType": "ProductOfferingPrice",
"@referredType": "ProductOfferingPrice Type",
"@schemaLocation": "ProductOfferingPrice Collection",
"@type": "individual Type"
},
"itemPriceRelationship": [
{
"priceId": "P465",
"relationshipType": "FIXED_PRICE"
}
],
"validFor": {
"endDateTime": "2023-10-19T10:42:41.257Z",
"startDateTime": "2023-10-19T10:42:41.257Z"
},
"isDownPaymentRequired": false,
"minimumDownPaymentAmount": null,
"isAgreementBased": false,
"offsetParameter": {
"numberofBlock": 2,
"totalAllowanceSelectionCount": 4,
"isCalenderBased": true,
"discountType": "FIXED_PRICE",
"billingDiscountExternalRef": "BD2024-123456",
"discountValue": 10,
"allowedDiscount": [
{
"block": 1,
"allowedSelectionCount": null,
"allowedSelectionPeriod": "2022-08-08 13:09:00.612Z",
"selectedDiscountPeriod": "2022-08-08 13:09:00.612Z"
}
]
},
"code": "PC_de716bb0",
"externalId": "prepaidplan_a-1_price_2-0_v1||123",
"id": "9a058452-d5c7-4ec2-9f3d-1ecc34d120ee",
"specCharacteristics": [
{
"name": "SMS Allowance",
"value": "50SMS",
"valueType": "String"
}
],
"isProrated": false,
"isArrears": false
}
]
}
],
"portfolioContainers": [
{
"id": "BP11697629618916537",
"name": "",
"productOrderItemsRefs": [
{
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account"
}
],
"sort": 1
}
],
"signature": {
"context": "174be0d306a3bab87c1266f4b4d1f534c5a302aedda36ff0f64d695cd581eeb7",
"cart": "4db162ebf6ee34d11293b9aa7e8f8a512061de318ed5187cd1cb75f5c0a2c198"
},
"baseProductOrderId": "3e934f5f-4fb7-4e01-a33d-4bd7c33f5828",
"amendProductOrderId": "3e934f5f-4fb7-4e01-a33d-4bd7c33f5828",
"orderType": "NEW",
"id": "881a6d15-bcbe-4372-b48a-41cba29f4806",
"quote": [
{
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account"
}
],
"agreement": [
{
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account",
"agreementItemId": "agreement_083774",
"agreementProductOfferingPrice": [
{
"id": "bm_jio_cardinality_price",
"price": {
"unit": "inr",
"value": 1000
}
}
],
"@baseType": "ProductOfferingPrice",
"@schemaLocation": "Agreement Collection",
"characteristic": [
{
"name": "MSISDN",
"valueType": "String",
"value": "55738231121",
"action": "ADD",
"validationStatus": "PASSED",
"createdBy": "admin",
"lastModifiedBy": "system",
"lastModifiedDateTime": "2023-10-19T10:42:41.257Z",
"createdDateTime": "2023-10-19T10:42:41.257Z",
"enrichmentDetail": {
"description": "Description of character",
"specType": "ServiceSpecification",
"referenceId": "data_service_specification_001",
"valueType": "List",
"minCardinality": null,
"maxCardinality": 1,
"characteristicValues": [
{
"valueType": "String",
"value": "True",
"validFor": {
"startDateTime": "2023-08-11T09:17:41.866Z",
"endDateTime": "2023-08-11T09:17:41.866Z"
},
"default": false,
"rangeInterval": "closedTop",
"regex": null,
"unitOfMeasure": "GB"
}
],
"validFor": {
"startDateTime": "2023-08-11T09:17:41.866Z",
"endDateTime": "2023-08-11T09:17:41.866Z"
},
"format": "String",
"length": 5,
"decimalValue": 0.767,
"tooltipValue": "Additional Information",
"visibleLine": "1",
"unique": false,
"extensible": false,
"configurable": false,
"displaySequence": 1,
"isVisible": false,
"configurationStage": "Product Offer Level",
"regex": "\"expression\": \"^[0-9]{9,13}$\",\n\"message\": \"Please enter a valid phone number\""
},
"errorDetails": [
{
"errorCode": "ERR-BM-OM-OV-OE-101",
"errorMessage": "Exception in Order Enrichment Process, Product Inventory Not Present"
}
],
"dynamicAttributes": [
{
"attributeName": "Data Throttling",
"attributeValue": "55738231121",
"attributeType": "String",
"lastModifiedDateTime": "2023-10-19T10:42:41.257Z",
"lastModifiedBy": "omui admin"
}
],
"isNetworkImpacting": false,
"isCharacteristicAmended": false
}
],
"@referredType": "BillingAccount",
"@type": "serviceOrder"
}
],
"channel": [
{
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account",
"role": "ServiceAddress"
}
],
"note": [
{
"id": "45",
"author": "Jack smith",
"createdDateTime": "2023-10-19T10:42:41.257Z",
"lastModifiedDateTime": "2023-10-19T10:42:41.257Z",
"system": "CHECKOUT",
"text": "This is quite important, please approach me as soon as possible"
}
],
"payment": [
{
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account",
"method": "CashPayment",
"token": "64bf14d-7373-4937-a73b-28217ac07528",
"receiptId": "P011276",
"paymentDate": "2023-10-19T10:42:41.257Z",
"transactionAmount": "2000",
"transactionId": "123123124112",
"transactionCurrency": "USD"
}
],
"productOrderItem": [
{
"id": "1",
"sort": 1,
"quantity": 1,
"action": "ADD",
"state": "ACKNOWLEDGED",
"status": "Order Validation - Completed",
"productOrderItemType": "New Order",
"productOrderItemSubType": "NEW_ORDER",
"installBaseId": "BP1686636408708199",
"actualStartDate": "2023-10-19T10:42:41.257Z",
"completionDate": "2023-10-19T10:42:41.257Z",
"expectedCompletionDate": "2023-10-19T10:42:41.257Z",
"requestedCompletionDate": "2023-10-19T10:42:41.257Z",
"errorDetails": [
{
"errorCode": "ERR-BM-OM-OV-OE-101",
"errorMessage": "Exception in Order Enrichment Process, Product Inventory Not Present"
}
],
"parentBundleOfferId": "1001359",
"parentBundleInstallBaseId": "BP1691740391567152",
"lastModifiedBy": "2023-10-19T10:42:41.257Z",
"lastModifiedDateTime": "2023-10-19T10:42:41.257Z",
"processFlag": "COMSOM",
"externalProductOrderItemId": "880",
"externalProductOrderItemReferenceNumber": "880A",
"workflowFlag": "Combined",
"payment": [
{
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account",
"method": "CashPayment",
"token": "64bf14d-7373-4937-a73b-28217ac07528",
"receiptId": "P011276",
"paymentDate": "2023-10-19T10:42:41.257Z",
"transactionAmount": "2000",
"transactionId": "123123124112",
"transactionCurrency": "USD"
}
],
"appointment": {
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account",
"description": "Description of AppointmentRef"
},
"appointmentList": [
{
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account",
"description": "Description of AppointmentRef"
}
],
"itemTerm": [
{
"description": "Description for OrderTerm",
"name": "atrribute 2",
"duration": "12.0",
"durationUnit": "MONTH"
}
],
"productOfferingQualificationItem": {
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account",
"productOfferingQualificationHref": "/api/catalog-projection/v1/productOfferingPrice/bluemarble_unlimited_10gb_12mth_rc_001",
"productOfferingQualificationId": "bluemarble_unlimited_10gb_12mth_rc_001",
"productOfferingQualificationName": "BlueMarble Unlimited - 10GB - 12 Months - RC"
},
"productOrderItemRelationship": [
{
"id": "SO1686577779836872",
"relationshipType": "Dependency",
"siteId": "admin_123"
}
],
"quoteItem": {
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account",
"quoteHref": "mobile",
"quoteId": "123",
"quoteName": "quote_ir"
},
"itemPrice": [
{
"description": "Order Price Details",
"name": "robin_rf",
"recurringChargePeriod": "Monthly",
"priceType": "recurring",
"recurringChargePeriodLength": 1,
"offset": 3,
"tax": [
{
"taxType": "GST",
"externalID": "464bf14d-7373-4937-a73b-28217ac07528",
"id": "tax_automationtest-tx_bv8y95w",
"validFor": {
"startDateTime": "2023-08-11T09:17:41.866Z",
"endDateTime": "2023-08-11T09:17:41.866Z"
},
"@baseType": "Tax",
"@type": "Individual Type",
"taxAmount": {
"unit": "inr",
"value": 1000
},
"taxCategory": "Indian",
"taxRate": 20,
"name": "Tax_Automationtest",
"displayName": "Tax details",
"definesExemption": false,
"additionalAttributes": [
{
"name": "MSISDN",
"valueType": "String",
"value": "55738231121",
"action": "ADD",
"validationStatus": "PASSED",
"createdBy": "admin",
"lastModifiedBy": "system",
"lastModifiedDateTime": "2023-10-19T10:42:41.257Z",
"createdDateTime": "2023-10-19T10:42:41.257Z",
"enrichmentDetail": {
"description": "Description of character",
"specType": "ServiceSpecification",
"referenceId": "data_service_specification_001",
"valueType": "List",
"minCardinality": null,
"maxCardinality": 1,
"characteristicValues": [],
"validFor": {},
"format": "String",
"length": 5,
"decimalValue": 0.767,
"tooltipValue": "Additional Information",
"visibleLine": "1",
"unique": false,
"extensible": false,
"configurable": false,
"displaySequence": 1,
"isVisible": false,
"configurationStage": "Product Offer Level",
"regex": "\"expression\": \"^[0-9]{9,13}$\",\n\"message\": \"Please enter a valid phone number\""
},
"errorDetails": [
""
],
"dynamicAttributes": [
""
],
"isNetworkImpacting": false,
"isCharacteristicAmended": false
}
]
}
],
"priceId": "op_0nwf2jj",
"priceSubType": "recurring",
"unitOfMeasure": "INR",
"@baseType": "OrderPrice",
"@schemaLocation": "OrderPrice Collection",
"price": {
"percentage": 10,
"taxRate": 10,
"actionCardinality": 10,
"taxAmount": 10,
"@baseType": "Price",
"@type": "Price",
"dutyFreeAmount": {
"unit": "inr",
"value": 1000
},
"taxIncludedAmount": {
"unit": "inr",
"value": 1000
},
"@schemaLocation": "Price Collection",
"dutyFreeAlteredAmount": {
"unit": "inr",
"value": 1000
},
"taxIncludedAlteredAmount": {
"unit": "inr",
"value": 1000
},
"changeAmount": {
"unit": "inr",
"value": 1000
},
"discount": {
"unit": "inr",
"value": 1000
},
"amountPayable": {
"unit": "inr",
"value": 1000
},
"taxFixed": {
"unit": "inr",
"value": 1000
}
},
"@type": "OrderPrice",
"priceAlteration": [
{
"applicationDuration": 3,
"description": "Price Alteration Details",
"name": "ServiceOrder",
"priceAlterationType": "Discount",
"priceType": "recurring",
"priority": 2,
"recurringChargePeriod": "Month",
"referenceId": "data_service_specification_001",
"unitOfMeasure": "INR",
"@baseType": "PriceAlteration",
"@schemaLocation": "PriceAlteration Collection",
"@type": "recurring",
"price": {
"percentage": 10,
"taxRate": 10,
"actionCardinality": 10,
"taxAmount": 10,
"@baseType": "Price",
"@type": "Price",
"dutyFreeAmount": {
"unit": "inr",
"value": 1000
},
"taxIncludedAmount": {
"unit": "inr",
"value": 1000
},
"@schemaLocation": "Price Collection",
"dutyFreeAlteredAmount": {
"unit": "inr",
"value": 1000
},
"taxIncludedAlteredAmount": {
"unit": "inr",
"value": 1000
},
"changeAmount": {
"unit": "inr",
"value": 1000
},
"discount": {
"unit": "inr",
"value": 1000
},
"amountPayable": {
"unit": "inr",
"value": 1000
},
"taxFixed": {
"unit": "inr",
"value": 1000
}
},
"productOfferingPrice": {
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account",
"@baseType": "ProductOfferingPrice",
"@referredType": "ProductOfferingPrice Type",
"@schemaLocation": "ProductOfferingPrice Collection",
"@type": "individual Type"
}
}
],
"productOfferingPrice": {
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account",
"@baseType": "ProductOfferingPrice",
"@referredType": "ProductOfferingPrice Type",
"@schemaLocation": "ProductOfferingPrice Collection",
"@type": "individual Type"
},
"itemPriceRelationship": [
{
"priceId": "P465",
"relationshipType": "FIXED_PRICE"
}
],
"validFor": {
"endDateTime": "2023-10-19T10:42:41.257Z",
"startDateTime": "2023-10-19T10:42:41.257Z"
},
"isDownPaymentRequired": false,
"minimumDownPaymentAmount": null,
"isAgreementBased": false,
"offsetParameter": {
"numberofBlock": 2,
"totalAllowanceSelectionCount": 4,
"isCalenderBased": true,
"discountType": "FIXED_PRICE",
"billingDiscountExternalRef": "BD2024-123456",
"discountValue": 10,
"allowedDiscount": [
{
"block": 1,
"allowedSelectionCount": null,
"allowedSelectionPeriod": "2022-08-08 13:09:00.612Z",
"selectedDiscountPeriod": "2022-08-08 13:09:00.612Z"
}
]
},
"code": "PC_de716bb0",
"externalId": "prepaidplan_a-1_price_2-0_v1||123",
"id": "9a058452-d5c7-4ec2-9f3d-1ecc34d120ee",
"specCharacteristics": [
{
"name": "SMS Allowance",
"value": "50SMS",
"valueType": "String"
}
],
"isProrated": false,
"isArrears": false
}
],
"qualification": [
{
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account"
}
],
"billingAccount": {
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account",
"dynamicAttributes": [
{
"attributeName": "Data Throttling",
"attributeValue": "55738231121",
"attributeType": "String",
"lastModifiedDateTime": "2023-10-19T10:42:41.257Z",
"lastModifiedBy": "omui admin"
}
],
"financeSettlementRef": [
{
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account"
}
],
"paymentMethodRef": [
{
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account"
}
],
"itemPriceRef": [
{
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account"
}
],
"@baseType": "ProductOfferingPrice",
"@type": "Individual Party",
"@schemaLocation": "BillingAccount",
"@referredType": "BillingAccount"
},
"billingAccountList": [
{
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account",
"dynamicAttributes": [
{
"attributeName": "Data Throttling",
"attributeValue": "55738231121",
"attributeType": "String",
"lastModifiedDateTime": "2023-10-19T10:42:41.257Z",
"lastModifiedBy": "omui admin"
}
],
"financeSettlementRef": [
{
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account"
}
],
"paymentMethodRef": [
{
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account"
}
],
"itemPriceRef": [
{
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account"
}
],
"@baseType": "ProductOfferingPrice",
"@type": "Individual Party",
"@schemaLocation": "BillingAccount",
"@referredType": "BillingAccount"
}
],
"productOffering": {
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account",
"externalID": "464bf14d-7373-4937-a73b-28217ac07528",
"owningSystem": "BlueMarble",
"owningSystemID": "owning system1001",
"relatedSystemName": "relatedsystem1001",
"referenceId": "data_service_specification_001",
"version": "1",
"status": "Closed",
"category": {
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account",
"version": null
},
"metaExtension": {
"dataSet": [
{
"name": "MobileOfferOM",
"genericData": {
"schemaRef": "OrderManagementOffer",
"valueSet": {}
},
"languages": [
{
"locale": "en-GB",
"name": "ENGLISH-IND, ENGLISH-US"
}
],
"channels": [
{
"id": "bo_lov_saleschannel_retail",
"name": "Retail"
}
],
"marketSegments": [
{
"id": "7894820397708LH425643",
"name": "Retail"
}
]
}
]
},
"productType": "Subscription",
"productLine": "Postpaid",
"offerClassification": "bo_lov_offerclassification_primary",
"@referredType": " BillingAccount ",
"@schemaLocation": "ProductOffering Collection",
"@type": "CFS",
"isAssetable": false
},
"product": {
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account",
"description": "find details for product Order",
"orderDate": "2023-10-19T10:42:41.257Z",
"productSerialNumber": "1",
"startDate": "2023-10-19T10:42:41.257Z",
"terminationDate": "2023-10-19T10:42:41.257Z",
"status": "CREATED",
"isBundle": false,
"isCustomerVisible": true,
"place": [
{
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account",
"role": "ServiceAddress",
"locationId": "LRW245",
"flag": "ACTIVE",
"fullAddress": "RMZ Galleria Office BLock,Yelahanka New Town",
"streetNr": "52",
"streetNrSuffix": "153",
"streetNrLast": "754",
"streetNrLastSuffix": "5765",
"streetName": "Pell Street",
"streetType": "Street",
"streetSuffix": "52",
"postCode": "SE85ES",
"locality": "London",
"city": "Pune",
"stateOrProvince": "England",
"country": "United Kingdom",
"geoLocationRefOrValue": {
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account",
"geometryType": "Point",
"accuracy": "100 meters",
"spatialRef": "WGS 84",
"type": "ProductOfferingPrice",
"schemaLocation": "Geolocation Collection",
"geometry": [
{
"latitude": "13.3379° N",
"longitude": "77.1173° E",
"geographicDatum": "NAVD88"
}
]
},
"geographicSubAddress": [
{
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account",
"type": "SubUnit",
"subUnitType": "Apartment",
"subUnitNumber": "1234",
"levelType": "Floor",
"levelNumber": "2",
"buildingName": "Acme Corporation Building",
"privateStreetNumber": "123",
"privateStreetName": "Main Street"
}
],
"serviceability": [
{
"id": "sms_service_specification_001",
"type": "CFS",
"attributes": {
"category": "enterprise",
"availability": {
"key": "PRODUCT_CODE",
"value": "6767453"
},
"items": [
""
]
}
}
],
"contactDetails": [
{
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account",
"role": "OM_DATA_MANAGER",
"type": "Individual Party",
"baseType": "ProductOfferingPrice",
"referredType": "BillingAccount",
"schemaLocation": "RelatedParty Collection",
"contactMedium": [
{
"baseType": "ProductOfferingPrice",
"type": "Individual Party",
"schemaLocation": "ContactMedium Collection",
"preferred": false,
"mediumType": "url",
"validFor": {},
"characteristic": {}
}
]
}
]
}
],
"productCharacteristic": [
{
"name": "MSISDN",
"valueType": "String",
"value": "55738231121",
"action": "ADD",
"validationStatus": "PASSED",
"createdBy": "admin",
"lastModifiedBy": "system",
"lastModifiedDateTime": "2023-10-19T10:42:41.257Z",
"createdDateTime": "2023-10-19T10:42:41.257Z",
"enrichmentDetail": {
"description": "Description of character",
"specType": "ServiceSpecification",
"referenceId": "data_service_specification_001",
"valueType": "List",
"minCardinality": null,
"maxCardinality": 1,
"characteristicValues": [
{
"valueType": "String",
"value": "True",
"validFor": {
"startDateTime": "2023-08-11T09:17:41.866Z",
"endDateTime": "2023-08-11T09:17:41.866Z"
},
"default": false,
"rangeInterval": "closedTop",
"regex": null,
"unitOfMeasure": "GB"
}
],
"validFor": {
"startDateTime": "2023-08-11T09:17:41.866Z",
"endDateTime": "2023-08-11T09:17:41.866Z"
},
"format": "String",
"length": 5,
"decimalValue": 0.767,
"tooltipValue": "Additional Information",
"visibleLine": "1",
"unique": false,
"extensible": false,
"configurable": false,
"displaySequence": 1,
"isVisible": false,
"configurationStage": "Product Offer Level",
"regex": "\"expression\": \"^[0-9]{9,13}$\",\n\"message\": \"Please enter a valid phone number\""
},
"errorDetails": [
{
"errorCode": "ERR-BM-OM-OV-OE-101",
"errorMessage": "Exception in Order Enrichment Process, Product Inventory Not Present"
}
],
"dynamicAttributes": [
{
"attributeName": "Data Throttling",
"attributeValue": "55738231121",
"attributeType": "String",
"lastModifiedDateTime": "2023-10-19T10:42:41.257Z",
"lastModifiedBy": "omui admin"
}
],
"isNetworkImpacting": false,
"isCharacteristicAmended": false
}
],
"agreement": [
{
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account",
"agreementItemId": "agreement_083774",
"agreementProductOfferingPrice": [
{
"id": "bm_jio_cardinality_price",
"price": {
"unit": "inr",
"value": 1000
}
}
],
"@baseType": "ProductOfferingPrice",
"@schemaLocation": "Agreement Collection",
"characteristic": [
{
"name": "MSISDN",
"valueType": "String",
"value": "55738231121",
"action": "ADD",
"validationStatus": "PASSED",
"createdBy": "admin",
"lastModifiedBy": "system",
"lastModifiedDateTime": "2023-10-19T10:42:41.257Z",
"createdDateTime": "2023-10-19T10:42:41.257Z",
"enrichmentDetail": {
"description": "Description of character",
"specType": "ServiceSpecification",
"referenceId": "data_service_specification_001",
"valueType": "List",
"minCardinality": null,
"maxCardinality": 1,
"characteristicValues": [
""
],
"validFor": {
"startDateTime": "2023-08-11T09:17:41.866Z",
"endDateTime": "2023-08-11T09:17:41.866Z"
},
"format": "String",
"length": 5,
"decimalValue": 0.767,
"tooltipValue": "Additional Information",
"visibleLine": "1",
"unique": false,
"extensible": false,
"configurable": false,
"displaySequence": 1,
"isVisible": false,
"configurationStage": "Product Offer Level",
"regex": "\"expression\": \"^[0-9]{9,13}$\",\n\"message\": \"Please enter a valid phone number\""
},
"errorDetails": [
{
"errorCode": "ERR-BM-OM-OV-OE-101",
"errorMessage": "Exception in Order Enrichment Process, Product Inventory Not Present"
}
],
"dynamicAttributes": [
{
"attributeName": "Data Throttling",
"attributeValue": "55738231121",
"attributeType": "String",
"lastModifiedDateTime": "2023-10-19T10:42:41.257Z",
"lastModifiedBy": "omui admin"
}
],
"isNetworkImpacting": false,
"isCharacteristicAmended": false
}
],
"@referredType": "BillingAccount",
"@type": "serviceOrder"
}
],
"productOffering": {
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account",
"externalID": "464bf14d-7373-4937-a73b-28217ac07528",
"owningSystem": "BlueMarble",
"owningSystemID": "owning system1001",
"relatedSystemName": "relatedsystem1001",
"referenceId": "data_service_specification_001",
"version": "1",
"status": "Closed",
"category": {
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account",
"version": null
},
"metaExtension": {
"dataSet": [
{
"name": "MobileOfferOM",
"genericData": {
"schemaRef": "OrderManagementOffer",
"valueSet": {}
},
"languages": [
{
"locale": "en-GB",
"name": "ENGLISH-IND, ENGLISH-US"
}
],
"channels": [
{
"id": "bo_lov_saleschannel_retail",
"name": "Retail"
}
],
"marketSegments": [
{
"id": "7894820397708LH425643",
"name": "Retail"
}
]
}
]
},
"productType": "Subscription",
"productLine": "Postpaid",
"offerClassification": "bo_lov_offerclassification_primary",
"@referredType": " BillingAccount ",
"@schemaLocation": "ProductOffering Collection",
"@type": "CFS",
"isAssetable": false
},
"billingAccount": {
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account",
"dynamicAttributes": [
{
"attributeName": "Data Throttling",
"attributeValue": "55738231121",
"attributeType": "String",
"lastModifiedDateTime": "2023-10-19T10:42:41.257Z",
"lastModifiedBy": "omui admin"
}
],
"financeSettlementRef": [
{
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account"
}
],
"paymentMethodRef": [
{
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account"
}
],
"itemPriceRef": [
{
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account"
}
],
"@baseType": "ProductOfferingPrice",
"@type": "Individual Party",
"@schemaLocation": "BillingAccount",
"@referredType": "BillingAccount"
},
"billingAccountList": [
{
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account",
"dynamicAttributes": [
{
"attributeName": "Data Throttling",
"attributeValue": "55738231121",
"attributeType": "String",
"lastModifiedDateTime": "2023-10-19T10:42:41.257Z",
"lastModifiedBy": "omui admin"
}
],
"financeSettlementRef": [
{
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account"
}
],
"paymentMethodRef": [
{
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account"
}
],
"itemPriceRef": [
{
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account"
}
],
"@baseType": "ProductOfferingPrice",
"@type": "Individual Party",
"@schemaLocation": "BillingAccount",
"@referredType": "BillingAccount"
}
],
"relatedParty": [
{
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account",
"role": "OM_DATA_MANAGER",
"type": "Individual Party",
"baseType": "ProductOfferingPrice",
"referredType": "BillingAccount",
"schemaLocation": "RelatedParty Collection",
"contactMedium": [
{
"baseType": "ProductOfferingPrice",
"type": "Individual Party",
"schemaLocation": "ContactMedium Collection",
"preferred": false,
"mediumType": "url",
"validFor": {
"startDateTime": "2023-08-11T09:17:41.866Z",
"endDateTime": "2023-08-11T09:17:41.866Z"
},
"characteristic": {
"baseType": "ProductOfferingPrice",
"type": "Individual Party",
"schemaLocation": "Contact Characteristics Collection",
"addressId": "#234",
"city": "Bengalore",
"contactType": "phone",
"country": "India",
"emailAddress": "example.@gmail.com",
"faxNumber": "212-111-2222",
"phoneNumber": "9856876322",
"postCode": "560064",
"socialNetworkId": "LinkedIn",
"stateOrProvince": "karnataka",
"street1": "RMZ Galleria",
"street2": "Office Block",
"houseNo": "56"
}
}
]
}
],
"productPrice": [
{
"description": "find details for product price",
"name": "Mobile Postpaid - Product Specification",
"offset": null,
"priceId": "1",
"priceType": "Onetime",
"recurringChargePeriod": "string",
"recurringChargePeriodLength": null,
"unitOfMeasure": "",
"tax": [
{
"taxType": "GST",
"externalID": "464bf14d-7373-4937-a73b-28217ac07528",
"id": "tax_automationtest-tx_bv8y95w",
"validFor": {
"startDateTime": "2023-08-11T09:17:41.866Z",
"endDateTime": "2023-08-11T09:17:41.866Z"
},
"@baseType": "Tax",
"@type": "Individual Type",
"taxAmount": {
"unit": "inr",
"value": 1000
},
"taxCategory": "Indian",
"taxRate": 20,
"name": "Tax_Automationtest",
"displayName": "Tax details",
"definesExemption": false,
"additionalAttributes": [
{
"name": "MSISDN",
"valueType": "String",
"value": "55738231121",
"action": "ADD",
"validationStatus": "PASSED",
"createdBy": "admin",
"lastModifiedBy": "system",
"lastModifiedDateTime": "2023-10-19T10:42:41.257Z",
"createdDateTime": "2023-10-19T10:42:41.257Z",
"enrichmentDetail": {},
"errorDetails": [],
"dynamicAttributes": [],
"isNetworkImpacting": false,
"isCharacteristicAmended": false
}
]
}
],
"priceSubType": "",
"isDownPaymentRequired": false,
"minimumDownPaymentAmount": null,
"id": "4cd250d9-e00e-4396-853b-2b244f0758dc",
"externalId": "string",
"@baseType": "ProductPrice",
"@schemaLocation": "price point collection",
"@type": "ProductPrice",
"itemPriceRelationship": [
{
"priceId": "P465",
"relationshipType": "FIXED_PRICE"
}
],
"price": {
"percentage": 10,
"taxRate": 10,
"actionCardinality": 10,
"taxAmount": 10,
"@baseType": "Price",
"@type": "Price",
"dutyFreeAmount": {
"unit": "inr",
"value": 1000
},
"taxIncludedAmount": {
"unit": "inr",
"value": 1000
},
"@schemaLocation": "Price Collection",
"dutyFreeAlteredAmount": {
"unit": "inr",
"value": 1000
},
"taxIncludedAlteredAmount": {
"unit": "inr",
"value": 1000
},
"changeAmount": {
"unit": "inr",
"value": 1000
},
"discount": {
"unit": "inr",
"value": 1000
},
"amountPayable": {
"unit": "inr",
"value": 1000
},
"taxFixed": {
"unit": "inr",
"value": 1000
}
},
"priceAlteration": [
{
"applicationDuration": 3,
"description": "Price Alteration Details",
"name": "ServiceOrder",
"priceAlterationType": "Discount",
"priceType": "recurring",
"priority": 2,
"recurringChargePeriod": "Month",
"referenceId": "data_service_specification_001",
"unitOfMeasure": "INR",
"@baseType": "PriceAlteration",
"@schemaLocation": "PriceAlteration Collection",
"@type": "recurring",
"price": {
"percentage": 10,
"taxRate": 10,
"actionCardinality": 10,
"taxAmount": 10,
"@baseType": "Price",
"@type": "Price",
"dutyFreeAmount": {
"unit": "inr",
"value": 1000
},
"taxIncludedAmount": {
"unit": "inr",
"value": 1000
},
"@schemaLocation": "Price Collection",
"dutyFreeAlteredAmount": {
"unit": "inr",
"value": 1000
},
"taxIncludedAlteredAmount": {
"unit": "inr",
"value": 1000
},
"changeAmount": {
"unit": "inr",
"value": 1000
},
"discount": {
"unit": "inr",
"value": 1000
},
"amountPayable": {
"unit": "inr",
"value": 1000
},
"taxFixed": {
"unit": "inr",
"value": 1000
}
},
"productOfferingPrice": {
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account",
"@baseType": "ProductOfferingPrice",
"@referredType": "ProductOfferingPrice Type",
"@schemaLocation": "ProductOfferingPrice Collection",
"@type": "individual Type"
}
}
],
"productOfferingPrice": {
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account",
"@baseType": "ProductOfferingPrice",
"@referredType": "ProductOfferingPrice Type",
"@schemaLocation": "ProductOfferingPrice Collection",
"@type": "individual Type"
},
"offsetParameter": {
"numberofBlock": 2,
"totalAllowanceSelectionCount": 4,
"isCalenderBased": true,
"discountType": "FIXED_PRICE",
"billingDiscountExternalRef": "BD2024-123456",
"discountValue": 10,
"allowedDiscount": [
{
"block": 1,
"allowedSelectionCount": null,
"allowedSelectionPeriod": "2022-08-08 13:09:00.612Z",
"selectedDiscountPeriod": "2022-08-08 13:09:00.612Z"
}
]
},
"isAgreementBased": true,
"code": "401 UNAUTHORIZED",
"specCharacteristics": [
{
"name": "SMS Allowance",
"value": "50SMS",
"valueType": "String"
}
],
"isProrated": false,
"isArrears": false,
"validFor": {
"startDateTime": "2023-08-11T09:17:41.866Z",
"endDateTime": "2023-08-11T09:17:41.866Z"
}
}
],
"productOrderItem": [
{
"orderItemAction": "ADD",
"orderItemId": "1",
"productOrderHref": "string",
"productOrderId": "557ae80c-b612-48f0-a57e-cd3a0eb1dc2c",
"role": "ServiceAddress"
}
],
"productSpecification": {
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account",
"externalId": "464bf14d-7373-4937-a73b-28217ac07528",
"externalName": "",
"owningSystem": "BlueMarble",
"owningSystemID": "owning system1001",
"relatedSystemName": "relatedsystem1001",
"status": "Open",
"referenceId": "data_service_specification_001",
"version": "1",
"metaExtension": {
"dataSet": [
{
"name": "MobileOfferOM",
"genericData": {
"schemaRef": "OrderManagementOffer",
"valueSet": {}
},
"languages": [
{
"locale": "en-GB",
"name": "ENGLISH-IND, ENGLISH-US"
}
],
"channels": [
{
"id": "bo_lov_saleschannel_retail",
"name": "Retail"
}
],
"marketSegments": [
{
"id": "7894820397708LH425643",
"name": "Retail"
}
]
}
]
},
"@type": "CFS",
"@referredType": " BillingAccount ",
"@schemaLocation": "ServiceSpecification Collection"
},
"productTerm": [
{
"description": "description for ProductTerm",
"name": "addItemThroughRules",
"durationUnit": "MONTH",
"duration": "12.0",
"validFor": {
"startDateTime": "2023-08-11T09:17:41.866Z",
"endDateTime": "2023-08-11T09:17:41.866Z"
}
}
],
"realizingResource": [
{
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account",
"value": "6767453"
}
],
"realizingService": [
{
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account"
}
],
"productRelationship": [
{
"relationshipType": "dependecy",
"product": ""
}
],
"reasonCode": "DUNNING",
"actionCode": "ACTION 2",
"checkoutData": [
{
"sectionId": "address",
"steps": [
{
"fields": [
{
"name": "Bill Format",
"value": "pdf"
}
],
"stepId": "billingAddressDetails",
"stepUId": "86c5e62d-f176-4434-b56c-bf7234429f1d",
"options": [
{
"name": "Bill Format",
"value": "pdf",
"fields": []
}
],
"offerContainerId": "5432373c-6f65-46f8-a8b5-879a8df5b576",
"cartItemId": "4a885452-ca92-45b8-933c-d35ad1b2e827",
"sequence": "0",
"groupByLevel": false,
"stepDataRefChoice": false,
"orderMgmtMapping": [
{
"fieldMapping": [],
"orderObjectPath": ""
}
]
}
],
"sectionUId": "5ba4aea8-184c-4d88-9906-143998869677"
}
],
"productLineCategory": "bm-postpaid-highend",
"parentBundleId": "bm-postpaid-highend"
},
"note": [
{
"id": "45",
"author": "Jack smith",
"createdDateTime": "2023-10-19T10:42:41.257Z",
"lastModifiedDateTime": "2023-10-19T10:42:41.257Z",
"system": "CHECKOUT",
"text": "This is quite important, please approach me as soon as possible"
}
],
"portability": {
"description": "find details for Portability",
"requestType": "PORT_IN",
"portingDate": "2023-10-19T10:42:41.257Z",
"portingApprovalDate": "2023-10-19T10:42:41.257Z",
"portingStatus": "COMPLETED",
"donorProvider": "",
"donorNumber": "20240",
"donorContractId": "70098909000",
"donorCustomerName": "intadmin",
"donorCustomerAddress": {
"id": "c63784c1-1d57-4b31-b61e-900db2d8f6e7",
"href": "/product-management/serviceSpecification/?id%3Dsms_service_specification_001%26version%3D1",
"name": "SMS - Service Specification",
"role": "ServiceAddress",
"locationId": "LRW245",
"flag": "ACTIVE",
"fullAddress": "RMZ Galleria Office BLock,Yelahanka New Town",
"streetNr": "52",
"streetNrSuffix": "153",
"streetNrLast": "754",
"streetNrLastSuffix": "5765",
"streetName": "Pell Street",
"streetType": "Street",
"streetSuffix": "52",
"postCode": "SE85ES",
"locality": "London",
"city": "Pune",
"stateOrProvince": "England",
"country": "United Kingdom",
"geoLocationRefOrValue": {
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account",
"geometryType": "Point",
"accuracy": "100 meters",
"spatialRef": "WGS 84",
"type": "ProductOfferingPrice",
"schemaLocation": "Geolocation Collection",
"geometry": [
{
"latitude": "13.3379° N",
"longitude": "77.1173° E",
"geographicDatum": "NAVD88"
}
]
},
"geographicSubAddress": [
{
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account",
"type": "SubUnit",
"subUnitType": "Apartment",
"subUnitNumber": "1234",
"levelType": "Floor",
"levelNumber": "2",
"buildingName": "Acme Corporation Building",
"privateStreetNumber": "123",
"privateStreetName": "Main Street"
}
],
"serviceability": [
{
"id": "sms_service_specification_001",
"type": "CFS",
"attributes": {
"category": "enterprise",
"availability": {
"key": "PRODUCT_CODE",
"value": "6767453"
},
"items": [
{
"key": "PRODUCT_CODE",
"value": "6767453"
}
]
}
}
],
"contactDetails": [
{
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account",
"role": "OM_DATA_MANAGER",
"type": "Individual Party",
"baseType": "ProductOfferingPrice",
"referredType": "BillingAccount",
"schemaLocation": "RelatedParty Collection",
"contactMedium": [
{
"baseType": "ProductOfferingPrice",
"type": "Individual Party",
"schemaLocation": "ContactMedium Collection",
"preferred": false,
"mediumType": "url",
"validFor": {
"startDateTime": "2023-08-11T09:17:41.866Z",
"endDateTime": "2023-08-11T09:17:41.866Z"
},
"characteristic": {
"baseType": "ProductOfferingPrice",
"type": "Individual Party",
"schemaLocation": "Contact Characteristics Collection",
"addressId": "#234",
"city": "Bengalore",
"contactType": "phone",
"country": "India",
"emailAddress": "example.@gmail.com",
"faxNumber": "212-111-2222",
"phoneNumber": "9856876322",
"postCode": "560064",
"socialNetworkId": "LinkedIn",
"stateOrProvince": "karnataka",
"street1": "RMZ Galleria",
"street2": "Office Block",
"houseNo": "56"
}
}
]
}
]
},
"additionalCharacteristics": [
{
"attributeName": "Data Throttling",
"attributeValue": "55738231121",
"attributeType": "String",
"lastModifiedDateTime": "2023-10-19T10:42:41.257Z",
"lastModifiedBy": "omui admin"
}
],
"createdBy": "om_admin",
"createdDateTime": "2023-10-19T10:42:41.257Z",
"lastModifiedBy": "om_admin",
"lastModifiedDateTime": "2023-10-19T10:42:41.257Z"
},
"isOfferAmended": false,
"portfolioDetails": {
"portfolioId": "BP1698224881607424",
"productLineCategory": "bm-postpaid-highend",
"offerContainerCategory": "bm-postpaid-highend",
"href": "https://host:port/paymentManagement/v4/cashPayment/2365",
"childProduct": [
{
"childProductOrderItemId": "9be74937-4927-4924-b2bb-d7a4dd401f1a",
"childInstallBaseId": "RUM1660733938024415",
"childSpecificationName": "Fiber Port",
"childCpoId": "CPO7894820397708LH425",
"inventory": false,
"state": "ACTIVE"
}
],
"parentProduct": {
"parentProductOrderItemId": "e2346",
"parentInstallBaseId": "BP1698224881533778",
"parentSpecificationName": "Mobile Postpaid - Product Specification",
"inventory": false,
"parentCpoId": "CPO7894820397708LH425",
"state": "ACTIVE"
}
},
"promotions": [
{
"category": "Managed SDWAN Service",
"id": "automation_promotion-pm_20eewvb",
"internalLifecycleStatus": "Test",
"description": "Promotion",
"lifeCycleStatus": "Test",
"name": "Automation_Promotion_678new",
"priority": 2,
"promoApplicationLevel": "cart",
"signature": "cartSignature",
"type": "Promotion",
"promotionAction": {
"actionCardinality": null,
"actionObjectId": "bm-samsung-product-bundle",
"actionType": "Add Product",
"actionValue": 2,
"applicationDuration": 1,
"cartItemId": "5432373c-6f65-46f8-a8b5-879a8df5b576",
"id": "pa_j6w82",
"maxActionValue": "3",
"priceId": "op_0nwf2jj",
"priceType": "recurring",
"priority": 4,
"recurringChargePeriodType": "Month"
},
"promotionClassification": "exclusive",
"coupon": {
"id": "54765",
"code": "MY_COUPON_CODE",
"coupon": false
},
"validFor": {
"startDateTime": "2023-08-11T09:17:41.866Z",
"endDateTime": "2023-08-11T09:17:41.866Z"
}
}
],
"additionalAttributes": [
{
"name": "MSISDN",
"valueType": "String",
"value": "55738231121",
"action": "ADD",
"validationStatus": "PASSED",
"createdBy": "admin",
"lastModifiedBy": "system",
"lastModifiedDateTime": "2023-10-19T10:42:41.257Z",
"createdDateTime": "2023-10-19T10:42:41.257Z",
"enrichmentDetail": {
"description": "Description of character",
"specType": "ServiceSpecification",
"referenceId": "data_service_specification_001",
"valueType": "List",
"minCardinality": null,
"maxCardinality": 1,
"characteristicValues": [
{
"valueType": "String",
"value": "True",
"validFor": {
"startDateTime": "2023-08-11T09:17:41.866Z",
"endDateTime": "2023-08-11T09:17:41.866Z"
},
"default": false,
"rangeInterval": "closedTop",
"regex": null,
"unitOfMeasure": "GB"
}
],
"validFor": {
"startDateTime": "2023-08-11T09:17:41.866Z",
"endDateTime": "2023-08-11T09:17:41.866Z"
},
"format": "String",
"length": 5,
"decimalValue": 0.767,
"tooltipValue": "Additional Information",
"visibleLine": "1",
"unique": false,
"extensible": false,
"configurable": false,
"displaySequence": 1,
"isVisible": false,
"configurationStage": "Product Offer Level",
"regex": "\"expression\": \"^[0-9]{9,13}$\",\n\"message\": \"Please enter a valid phone number\""
},
"errorDetails": [
{
"errorCode": "ERR-BM-OM-OV-OE-101",
"errorMessage": "Exception in Order Enrichment Process, Product Inventory Not Present"
}
],
"dynamicAttributes": [
{
"attributeName": "Data Throttling",
"attributeValue": "55738231121",
"attributeType": "String",
"lastModifiedDateTime": "2023-10-19T10:42:41.257Z",
"lastModifiedBy": "omui admin"
}
],
"isNetworkImpacting": false,
"isCharacteristicAmended": false
}
],
"productFeasibility": {
"validTill": {
"endDateTime": "2023-10-19T10:42:41.257Z",
"startDateTime": "2023-10-19T10:42:41.257Z"
},
"remark": "remark",
"approvedBy": "System",
"qualified": false,
"attributes": [
{
"name": "attribute_fa",
"value": "50SMS",
"valueType": "string,number,boolean",
"array": false,
"viewOnly": false,
"quantityBased": false
}
]
},
"dueDateJeopardyCategory": true,
"expDueDateJeopardyCategory": false,
"checkoutProductDetails": {
"type": "quote",
"associatedOCId": "",
"associatedCIId": "",
"associatedSiteId": "",
"source": "",
"externalId": "464bf14d-7373-4937-a73b-28217ac07528",
"overridePrice": 10,
"additionalAttributes": [
{
"name": "Order Level",
"value": "43654"
}
]
},
"bypassCharpoValidation": false,
"resourceAllocation": false,
"baseInstallBaseId": "BP1691740391567152",
"parallelInstallBaseId": "RUM1660733938024419",
"baseServiceTermination": false,
"isAmendOrderItem": false,
"isPreviousOrderItemState": true
}
],
"orderTotalPrice": [
{
"description": "Order Price Details",
"name": "robin_rf",
"recurringChargePeriod": "Monthly",
"priceType": "recurring",
"recurringChargePeriodLength": 1,
"offset": 3,
"tax": [
{
"taxType": "GST",
"externalID": "464bf14d-7373-4937-a73b-28217ac07528",
"id": "tax_automationtest-tx_bv8y95w",
"validFor": {
"startDateTime": "2023-08-11T09:17:41.866Z",
"endDateTime": "2023-08-11T09:17:41.866Z"
},
"@baseType": "Tax",
"@type": "Individual Type",
"taxAmount": {
"unit": "inr",
"value": 1000
},
"taxCategory": "Indian",
"taxRate": 20,
"name": "Tax_Automationtest",
"displayName": "Tax details",
"definesExemption": false,
"additionalAttributes": [
{
"name": "MSISDN",
"valueType": "String",
"value": "55738231121",
"action": "ADD",
"validationStatus": "PASSED",
"createdBy": "admin",
"lastModifiedBy": "system",
"lastModifiedDateTime": "2023-10-19T10:42:41.257Z",
"createdDateTime": "2023-10-19T10:42:41.257Z",
"enrichmentDetail": {
"description": "Description of character",
"specType": "ServiceSpecification",
"referenceId": "data_service_specification_001",
"valueType": "List",
"minCardinality": null,
"maxCardinality": 1,
"characteristicValues": [
{
"valueType": "String",
"value": "True",
"validFor": {},
"default": false,
"rangeInterval": "closedTop",
"regex": null,
"unitOfMeasure": "GB"
}
],
"validFor": {
"startDateTime": "2023-08-11T09:17:41.866Z",
"endDateTime": "2023-08-11T09:17:41.866Z"
},
"format": "String",
"length": 5,
"decimalValue": 0.767,
"tooltipValue": "Additional Information",
"visibleLine": "1",
"unique": false,
"extensible": false,
"configurable": false,
"displaySequence": 1,
"isVisible": false,
"configurationStage": "Product Offer Level",
"regex": "\"expression\": \"^[0-9]{9,13}$\",\n\"message\": \"Please enter a valid phone number\""
},
"errorDetails": [
{
"errorCode": "ERR-BM-OM-OV-OE-101",
"errorMessage": "Exception in Order Enrichment Process, Product Inventory Not Present"
}
],
"dynamicAttributes": [
{
"attributeName": "Data Throttling",
"attributeValue": "55738231121",
"attributeType": "String",
"lastModifiedDateTime": "2023-10-19T10:42:41.257Z",
"lastModifiedBy": "omui admin"
}
],
"isNetworkImpacting": false,
"isCharacteristicAmended": false
}
]
}
],
"priceId": "op_0nwf2jj",
"priceSubType": "recurring",
"unitOfMeasure": "INR",
"@baseType": "OrderPrice",
"@schemaLocation": "OrderPrice Collection",
"price": {
"percentage": 10,
"taxRate": 10,
"actionCardinality": 10,
"taxAmount": 10,
"@baseType": "Price",
"@type": "Price",
"dutyFreeAmount": {
"unit": "inr",
"value": 1000
},
"taxIncludedAmount": {
"unit": "inr",
"value": 1000
},
"@schemaLocation": "Price Collection",
"dutyFreeAlteredAmount": {
"unit": "inr",
"value": 1000
},
"taxIncludedAlteredAmount": {
"unit": "inr",
"value": 1000
},
"changeAmount": {
"unit": "inr",
"value": 1000
},
"discount": {
"unit": "inr",
"value": 1000
},
"amountPayable": {
"unit": "inr",
"value": 1000
},
"taxFixed": {
"unit": "inr",
"value": 1000
}
},
"@type": "OrderPrice",
"priceAlteration": [
{
"applicationDuration": 3,
"description": "Price Alteration Details",
"name": "ServiceOrder",
"priceAlterationType": "Discount",
"priceType": "recurring",
"priority": 2,
"recurringChargePeriod": "Month",
"referenceId": "data_service_specification_001",
"unitOfMeasure": "INR",
"@baseType": "PriceAlteration",
"@schemaLocation": "PriceAlteration Collection",
"@type": "recurring",
"price": {
"percentage": 10,
"taxRate": 10,
"actionCardinality": 10,
"taxAmount": 10,
"@baseType": "Price",
"@type": "Price",
"dutyFreeAmount": {
"unit": "inr",
"value": 1000
},
"taxIncludedAmount": {
"unit": "inr",
"value": 1000
},
"@schemaLocation": "Price Collection",
"dutyFreeAlteredAmount": {
"unit": "inr",
"value": 1000
},
"taxIncludedAlteredAmount": {
"unit": "inr",
"value": 1000
},
"changeAmount": {
"unit": "inr",
"value": 1000
},
"discount": {
"unit": "inr",
"value": 1000
},
"amountPayable": {
"unit": "inr",
"value": 1000
},
"taxFixed": {
"unit": "inr",
"value": 1000
}
},
"productOfferingPrice": {
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account",
"@baseType": "ProductOfferingPrice",
"@referredType": "ProductOfferingPrice Type",
"@schemaLocation": "ProductOfferingPrice Collection",
"@type": "individual Type"
}
}
],
"productOfferingPrice": {
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account",
"@baseType": "ProductOfferingPrice",
"@referredType": "ProductOfferingPrice Type",
"@schemaLocation": "ProductOfferingPrice Collection",
"@type": "individual Type"
},
"itemPriceRelationship": [
{
"priceId": "P465",
"relationshipType": "FIXED_PRICE"
}
],
"validFor": {
"endDateTime": "2023-10-19T10:42:41.257Z",
"startDateTime": "2023-10-19T10:42:41.257Z"
},
"isDownPaymentRequired": false,
"minimumDownPaymentAmount": null,
"isAgreementBased": false,
"offsetParameter": {
"numberofBlock": 2,
"totalAllowanceSelectionCount": 4,
"isCalenderBased": true,
"discountType": "FIXED_PRICE",
"billingDiscountExternalRef": "BD2024-123456",
"discountValue": 10,
"allowedDiscount": [
{
"block": 1,
"allowedSelectionCount": null,
"allowedSelectionPeriod": "2022-08-08 13:09:00.612Z",
"selectedDiscountPeriod": "2022-08-08 13:09:00.612Z"
}
]
},
"code": "PC_de716bb0",
"externalId": "prepaidplan_a-1_price_2-0_v1||123",
"id": "9a058452-d5c7-4ec2-9f3d-1ecc34d120ee",
"specCharacteristics": [
{
"name": "SMS Allowance",
"value": "50SMS",
"valueType": "String"
}
],
"isProrated": false,
"isArrears": false
}
],
"productOfferingQualification": [
{
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account"
}
],
"customerAccount": {
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account",
"dynamicAttributes": [
{
"attributeName": "Data Throttling",
"attributeValue": "55738231121",
"attributeType": "String",
"lastModifiedDateTime": "2023-10-19T10:42:41.257Z",
"lastModifiedBy": "omui admin"
}
],
"partyRef": [
{
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account"
}
],
"partyRoleRef": [
{
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account"
}
],
"aggrementRef": [
{
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account"
}
],
"paymentMethodRef": [
{
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account"
}
]
},
"billingAccount": {
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account",
"dynamicAttributes": [
{
"attributeName": "Data Throttling",
"attributeValue": "55738231121",
"attributeType": "String",
"lastModifiedDateTime": "2023-10-19T10:42:41.257Z",
"lastModifiedBy": "omui admin"
}
],
"financeSettlementRef": [
{
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account"
}
],
"paymentMethodRef": [
{
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account"
}
],
"itemPriceRef": [
{
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account"
}
],
"@baseType": "ProductOfferingPrice",
"@type": "Individual Party",
"@schemaLocation": "BillingAccount",
"@referredType": "BillingAccount"
},
"billingAccountList": [
{
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account",
"dynamicAttributes": [
{
"attributeName": "Data Throttling",
"attributeValue": "55738231121",
"attributeType": "String",
"lastModifiedDateTime": "2023-10-19T10:42:41.257Z",
"lastModifiedBy": "omui admin"
}
],
"financeSettlementRef": [
{
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account"
}
],
"paymentMethodRef": [
{
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account"
}
],
"itemPriceRef": [
{
"id": "BA_109",
"href": "/product-inventory",
"name": "Sameer Billing Account"
}
],
"@baseType": "ProductOfferingPrice",
"@type": "Individual Party",
"@schemaLocation": "BillingAccount",
"@referredType": "BillingAccount"
}
],
"isAmendOrder": false,
"isAmendOrderWithCancel": false,
"isValidatedPOQ": false,
"externalOrderReferenceNumber": "879A",
"externalOrderId": "464bf14d-7373-4937-a73b-28217ac07528",
"marketSegment": {
"id": "7894820397708LH425643",
"name": "Retail"
},
"additionalAttributes": [
{
"name": "MSISDN",
"valueType": "String",
"value": "55738231121",
"action": "ADD",
"validationStatus": "PASSED",
"createdBy": "admin",
"lastModifiedBy": "system",
"lastModifiedDateTime": "2023-10-19T10:42:41.257Z",
"createdDateTime": "2023-10-19T10:42:41.257Z",
"enrichmentDetail": {
"description": "Description of character",
"specType": "ServiceSpecification",
"referenceId": "data_service_specification_001",
"valueType": "List",
"minCardinality": null,
"maxCardinality": 1,
"characteristicValues": [
{
"valueType": "String",
"value": "True",
"validFor": {
"startDateTime": "2023-08-11T09:17:41.866Z",
"endDateTime": "2023-08-11T09:17:41.866Z"
},
"default": false,
"rangeInterval": "closedTop",
"regex": null,
"unitOfMeasure": "GB"
}
],
"validFor": {
"startDateTime": "2023-08-11T09:17:41.866Z",
"endDateTime": "2023-08-11T09:17:41.866Z"
},
"format": "String",
"length": 5,
"decimalValue": 0.767,
"tooltipValue": "Additional Information",
"visibleLine": "1",
"unique": false,
"extensible": false,
"configurable": false,
"displaySequence": 1,
"isVisible": false,
"configurationStage": "Product Offer Level",
"regex": "\"expression\": \"^[0-9]{9,13}$\",\n\"message\": \"Please enter a valid phone number\""
},
"errorDetails": [
{
"errorCode": "ERR-BM-OM-OV-OE-101",
"errorMessage": "Exception in Order Enrichment Process, Product Inventory Not Present"
}
],
"dynamicAttributes": [
{
"attributeName": "Data Throttling",
"attributeValue": "55738231121",
"attributeType": "String",
"lastModifiedDateTime": "2023-10-19T10:42:41.257Z",
"lastModifiedBy": "omui admin"
}
],
"isNetworkImpacting": false,
"isCharacteristicAmended": false
}
],
"promotions": [
{
"category": "Managed SDWAN Service",
"id": "automation_promotion-pm_20eewvb",
"internalLifecycleStatus": "Test",
"description": "Promotion",
"lifeCycleStatus": "Test",
"name": "Automation_Promotion_678new",
"priority": 2,
"promoApplicationLevel": "cart",
"signature": "cartSignature",
"type": "Promotion",
"promotionAction": {
"actionCardinality": null,
"actionObjectId": "bm-samsung-product-bundle",
"actionType": "Add Product",
"actionValue": 2,
"applicationDuration": 1,
"cartItemId": "5432373c-6f65-46f8-a8b5-879a8df5b576",
"id": "pa_j6w82",
"maxActionValue": "3",
"priceId": "op_0nwf2jj",
"priceType": "recurring",
"priority": 4,
"recurringChargePeriodType": "Month"
},
"promotionClassification": "exclusive",
"coupon": {
"id": "54765",
"code": "MY_COUPON_CODE",
"coupon": false
},
"validFor": {
"startDateTime": "2023-08-11T09:17:41.866Z",
"endDateTime": "2023-08-11T09:17:41.866Z"
}
}
],
"nonRecurringPriceAdjustment": [
{
"id": "c63784c1-1d57-4b31-b61e-900db2d8f6e7",
"amount": null,
"details": [
{
"name": "SMS Allowance",
"value": "50SMS"
}
],
"name": "SMS Allowance",
"referenceId": "data_service_specification_001",
"type": "Physical"
}
],
"customerOrderType": "NEW",
"jeopardyFlag": false,
"visibleFlag": "yes,no",
"isLargeOrder": false,
"parentOrderId": "881a6d15-bcbe-4372-b48a-41cba29f4806",
"parentCpoId": "CPO2477328421161597NQ575",
"subOrderMetaData": [
{
"subOrderId": "1",
"state": "COMPLETED",
"status": "Provisioning - Completed",
"subOrderCpoId": "CPO2477328421161597NQ575",
"productSubOrderItemRef": [
{
"productSubOrderItemId": "3e934f5f-4fb7-4e01-a33d-4bd7c33f5828",
"installbaseId": "BP1686636408708199",
"productName": "Mobile",
"productOrderItemType": "New Order"
}
]
}
],
"priority": "HIGHEST, LOW",
"processingPriority": "High",
"priorityRelayTopics": [
{
"moduleName": "",
"relayTopicName": "",
"prioritySequence": "",
"processingPriority": ""
}
],
"isPortabilityOrder": false
}What made this section unhelpful for you?
Update External IDs
This operation updates external OMS details such as external IDs and reference IDs at the order level, productOrderItem level, as well as the offerContainer level.
Header Parameters
Unique identifier for tracking the transaction.
Identifier for correlating related requests and responses.
Source channel or origin of the request.
Identifier of the associated tenant or customer.
Path Parameters
Uniquely Identifier ID
Body Parameters
Identifier or reference for the purchase order (PO) item associated with the OMS. This attribute is used to specify the specific item within the order that requires processing or management by the OMS.
Show child attributes
Information or data related to an offer container within the OMS. An offer container typically represents a bundle, package, or group of products or services offered together. This attribute may include details about the contents of the offer container.
Show child attributes
An external reference number or code associated with the order. This identifier is often used for tracking and integration purposes between external systems and the OMS.
A unique identifier for the order within the external system. It helps link the order in the OMS with the corresponding order in the external system.
Response
Response Attributes
Identifier or reference for the purchase order (PO) item associated with the OMS. This attribute is used to specify the specific item within the order that requires processing or management by the OMS.
Show child attributes
Information or data related to an offer container within the OMS. An offer container typically represents a bundle, package, or group of products or services offered together. This attribute may include details about the contents of the offer container.
Show child attributes
An external reference number or code associated with the order. This identifier is often used for tracking and integration purposes between external systems and the OMS.
A unique identifier for the order within the external system. It helps link the order in the OMS with the corresponding order in the external system.
Response Attributes
A Date,Error creation date and time
A String,A error code provides specific error code which occurred
A error,A error reason provides the specific reason why error occurred
Error message,A error message provides the specific message which occurred
Error stacktrace,A error stacktrace provides the stacktrace for error occurred
Response Attributes
A Date,Error creation date and time
A String,A error code provides specific error code which occurred
A error,A error reason provides the specific reason why error occurred
Error message,A error message provides the specific message which occurred
Error stacktrace,A error stacktrace provides the stacktrace for error occurred
Response Attributes
A Date,Error creation date and time
A String,A error code provides specific error code which occurred
A error,A error reason provides the specific reason why error occurred
Error message,A error message provides the specific message which occurred
Error stacktrace,A error stacktrace provides the stacktrace for error occurred
Response Attributes
A Date,Error creation date and time
A String,A error code provides specific error code which occurred
A error,A error reason provides the specific reason why error occurred
Error message,A error message provides the specific message which occurred
Error stacktrace,A error stacktrace provides the stacktrace for error occurred
Response Attributes
A numeric or alphanumeric code that represents a specific error or issue encountered during an operation.
A human-readable message that provides additional details about the error. It offers context and information to help users or developers understand what went wrong
A timestamp indicating when the error occurred, typically in a standardized format such as ISO 8601. It helps with debugging and tracking issues over time
An HTTP status code that indicates the outcome of the request or operation. Common examples include 200 (OK), 404 (Not Found), or 500 (Internal Server Error).
The URL or endpoint that was accessed when the error occurred. It specifies the location of the request that led to the error.
Response Attributes
A Date,Error creation date and time
A String,A error code provides specific error code which occurred
A error,A error reason provides the specific reason why error occurred
Error message,A error message provides the specific message which occurred
Error stacktrace,A error stacktrace provides the stacktrace for error occurred
Response Attributes
A Date,Error creation date and time
A String,A error code provides specific error code which occurred
A error,A error reason provides the specific reason why error occurred
Error message,A error message provides the specific message which occurred
Error stacktrace,A error stacktrace provides the stacktrace for error occurred
Response Attributes
A Date,Error creation date and time
A String,A error code provides specific error code which occurred
A error,A error reason provides the specific reason why error occurred
Error message,A error message provides the specific message which occurred
Error stacktrace,A error stacktrace provides the stacktrace for error occurred
What made this section unhelpful for you?
Response
{
"poItemIDWithOMS": [
{
"id": "",
"externalProductOrderItemId": "880",
"externalProductOrderItemReferenceNumber": "880A"
}
],
"offerContainerWithOMS": [
{
"id": "",
"externalOfferContainerId": "880",
"externalOfferContainerReferenceNumber": "880A"
}
],
"externalOrderReferenceNumber": "879A",
"externalOrderId": "879"
}What made this section unhelpful for you?
Update Meta Extension
This API within a product order system denotes an endpoint or function enabling the modification of metaExtensionProductOrder. This API retrieves offering IDs, obtains the latest metaextension from the catalogPSR product adapter service, and subsequently updates the corresponding metaextension in the customer order.
Header Parameters
Unique identifier for tracking the transaction.
Identifier for correlating related requests and responses.
Source channel or origin of the request.
Identifier of the associated tenant or customer.
Body Parameters
Response
Response Attributes
A Date,Error creation date and time
A String,A error code provides specific error code which occurred
A error,A error reason provides the specific reason why error occurred
Error message,A error message provides the specific message which occurred
Error stacktrace,A error stacktrace provides the stacktrace for error occurred
Response Attributes
A Date,Error creation date and time
A String,A error code provides specific error code which occurred
A error,A error reason provides the specific reason why error occurred
Error message,A error message provides the specific message which occurred
Error stacktrace,A error stacktrace provides the stacktrace for error occurred
Response Attributes
A Date,Error creation date and time
A String,A error code provides specific error code which occurred
A error,A error reason provides the specific reason why error occurred
Error message,A error message provides the specific message which occurred
Error stacktrace,A error stacktrace provides the stacktrace for error occurred
Response Attributes
A Date,Error creation date and time
A String,A error code provides specific error code which occurred
A error,A error reason provides the specific reason why error occurred
Error message,A error message provides the specific message which occurred
Error stacktrace,A error stacktrace provides the stacktrace for error occurred
Response Attributes
A numeric or alphanumeric code that represents a specific error or issue encountered during an operation.
A human-readable message that provides additional details about the error. It offers context and information to help users or developers understand what went wrong
A timestamp indicating when the error occurred, typically in a standardized format such as ISO 8601. It helps with debugging and tracking issues over time
An HTTP status code that indicates the outcome of the request or operation. Common examples include 200 (OK), 404 (Not Found), or 500 (Internal Server Error).
The URL or endpoint that was accessed when the error occurred. It specifies the location of the request that led to the error.
Response Attributes
A Date,Error creation date and time
A String,A error code provides specific error code which occurred
A error,A error reason provides the specific reason why error occurred
Error message,A error message provides the specific message which occurred
Error stacktrace,A error stacktrace provides the stacktrace for error occurred
Response Attributes
A Date,Error creation date and time
A String,A error code provides specific error code which occurred
A error,A error reason provides the specific reason why error occurred
Error message,A error message provides the specific message which occurred
Error stacktrace,A error stacktrace provides the stacktrace for error occurred
Response Attributes
A Date,Error creation date and time
A String,A error code provides specific error code which occurred
A error,A error reason provides the specific reason why error occurred
Error message,A error message provides the specific message which occurred
Error stacktrace,A error stacktrace provides the stacktrace for error occurred
What made this section unhelpful for you?
Response
metaExtension ProductOrder Updated SuccessfullyWhat made this section unhelpful for you?
Cancel Order
Cancelling a product order involves the process of voiding or revoking an existing order, typically initiated by the customer or the system itself due to various reasons such as customer request, inventory unavailability, or business policy changes.
The Cancel Order API performs below operations on Product Order:
- Retrieval of a cancel product order
- Creation of a cancel product order
Get Order
The "Get Order" method is a query-based operation that enables users to access comprehensive details pertaining to a particular order. It is typically implemented as an API endpoint or function within the order management system.
This Get Order API performs following operations:
- Retrieve Product Order based on Filters
- Retrieve Offer Containers based on Filters.
Get Cancel Order
The "Get Cancel Order" service retrieves detailed information about canceled orders, including order ID, cancellation reason, and timestamp. It enables order management experts to efficiently track and analyze canceled orders for improved decision-making and process optimization.
Get Cancel Order API performs belwo operations:
- Retrieve Cancel PO
- Retrieve Cancel PO list
Get Customer Profile
"Get Customer Profile" is a service within order management systems that retrieves comprehensive information about a customer, including their purchase history, preferences, contact details, and any relevant demographic data.
Get Customer Profile API performs following operation:
- Retrieve Customer Profile using different filter
Submit Dunning Orders
"Submit Dunning Orders" is a process in order management that involves the automated submission of orders to a dunning system for handling overdue payments. This functionality assists in managing collections by automatically generating and processing orders for customers with outstanding payments, facilitating efficient debt recovery processes.
Submit Dunning Order performs following operations:
- Submit Dunning Order
- Update Dunning Order
Service Order
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.
Base URL
Production:
https://int-spring25.comviva.com/
https://int-spring25.comviva.com/OrderGenerator/v4
https://int-spring25.comviva.com/customerOrder/management/v4
https://int-spring25.comviva.com/serviceOrdering/management/v4
https://int-spring25.comviva.com/om-som-adapter/v4
https://int-spring25.comviva.com/productInventory/management/v4
https://int-spring25.comviva.com/serviceInventory/management/v4
https://int-spring25.comviva.com/task-management/v4
https://int-spring25.comviva.com/troubleTicket/query/v4
https://int-spring25.comviva.com/rules/v4
https://int-spring25.comviva.com/communicationManagement/v4
https://int-spring25.comviva.com/project-plan/v4
https://int-spring25.comviva.com/jeopardyApi/v4
https://int-spring25.comviva.com/holidayService/v4
Sandbox:
https://int-spring25.comviva.com/
Customer Product Inventory
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:
- Real-Time Updates: Maintain accurate and up-to-date customer inventory information through real-time updates.
- Integration Capabilities: Seamlessly integrate with billing, self-care, reporting, and other systems for comprehensive inventory management.
- Search and Filter Options: Utilize search and filter functionalities to easily locate specific products or services within the inventory.
- Support for Change Order Requests: Facilitate the management of change order requests by leveraging real-time updates and integration capabilities.
- Event Notification: Receive notifications for events related to product lifecycle changes, ensuring proactive management of inventory.
- User Token Authorization: Access to the CPI API requires a user token with appropriate permissions, ensuring secure and authorized access.
- Role-Based Access Control: Implement role-based access control to manage user permissions and data security effectively.
- 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.
Base URL
Production:
https://int-spring25.comviva.com/
https://int-spring25.comviva.com/OrderGenerator/v4
https://int-spring25.comviva.com/customerOrder/management/v4
https://int-spring25.comviva.com/serviceOrdering/management/v4
https://int-spring25.comviva.com/om-som-adapter/v4
https://int-spring25.comviva.com/productInventory/management/v4
https://int-spring25.comviva.com/serviceInventory/management/v4
https://int-spring25.comviva.com/task-management/v4
https://int-spring25.comviva.com/troubleTicket/query/v4
https://int-spring25.comviva.com/rules/v4
https://int-spring25.comviva.com/communicationManagement/v4
https://int-spring25.comviva.com/project-plan/v4
https://int-spring25.comviva.com/jeopardyApi/v4
https://int-spring25.comviva.com/holidayService/v4
Sandbox:
https://int-spring25.comviva.com/
Customer Service 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:
Real-Time Inventory Updates: Maintain an accurate representation of customer inventories with real-time updates for services and resources.\n" +
Integration Capabilities: Integrate seamlessly with billing, self-care, and reporting systems to ensure data consistency and synchronization.\n" +
Search and Filter Options: Enable users to easily search and filter service instances for efficient inventory management.
Change Order Requests: Facilitate the process of raising change order requests by leveraging real-time updates and integration capabilities.
Event Notifications: Receive notifications for events related to the product lifecycle, enhancing proactive management of inventory changes.
User Token Authorization: Access to the CSI API requires a user token with appropriate permissions, ensuring secure and authorized access.
Scalability and Performance: Designed for scalability to handle large volumes of services and resources, with optimized performance for efficient processing.
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.
Base URL
Production:
https://int-spring25.comviva.com/
https://int-spring25.comviva.com/OrderGenerator/v4
https://int-spring25.comviva.com/customerOrder/management/v4
https://int-spring25.comviva.com/serviceOrdering/management/v4
https://int-spring25.comviva.com/om-som-adapter/v4
https://int-spring25.comviva.com/productInventory/management/v4
https://int-spring25.comviva.com/serviceInventory/management/v4
https://int-spring25.comviva.com/task-management/v4
https://int-spring25.comviva.com/troubleTicket/query/v4
https://int-spring25.comviva.com/rules/v4
https://int-spring25.comviva.com/communicationManagement/v4
https://int-spring25.comviva.com/project-plan/v4
https://int-spring25.comviva.com/jeopardyApi/v4
https://int-spring25.comviva.com/holidayService/v4
Sandbox:
https://int-spring25.comviva.com/
Task Management
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:
- Task Viewing and Management: Users can view, edit, and complete tasks directly through the API, streamlining task management processes.
- User Access Control: Access to the API is restricted to users with appropriate permissions, ensuring data security and authorized task handling.
- 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.
- Manual Task Handling: The API supports manual task management, allowing users to assign tasks based on business rules and complete tasks assigned against orders.
- IDP Integration: User identity and access management are seamlessly integrated, leveraging user IDP details for authentication and authorization.
- 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.
Base URL
Production:
https://int-spring25.comviva.com/
https://int-spring25.comviva.com/OrderGenerator/v4
https://int-spring25.comviva.com/customerOrder/management/v4
https://int-spring25.comviva.com/serviceOrdering/management/v4
https://int-spring25.comviva.com/om-som-adapter/v4
https://int-spring25.comviva.com/productInventory/management/v4
https://int-spring25.comviva.com/serviceInventory/management/v4
https://int-spring25.comviva.com/task-management/v4
https://int-spring25.comviva.com/troubleTicket/query/v4
https://int-spring25.comviva.com/rules/v4
https://int-spring25.comviva.com/communicationManagement/v4
https://int-spring25.comviva.com/project-plan/v4
https://int-spring25.comviva.com/jeopardyApi/v4
https://int-spring25.comviva.com/holidayService/v4
Sandbox:
https://int-spring25.comviva.com/
Service Request
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.
Base URL
Production:
https://int-spring25.comviva.com/
https://int-spring25.comviva.com/OrderGenerator/v4
https://int-spring25.comviva.com/customerOrder/management/v4
https://int-spring25.comviva.com/serviceOrdering/management/v4
https://int-spring25.comviva.com/om-som-adapter/v4
https://int-spring25.comviva.com/productInventory/management/v4
https://int-spring25.comviva.com/serviceInventory/management/v4
https://int-spring25.comviva.com/task-management/v4
https://int-spring25.comviva.com/troubleTicket/query/v4
https://int-spring25.comviva.com/rules/v4
https://int-spring25.comviva.com/communicationManagement/v4
https://int-spring25.comviva.com/project-plan/v4
https://int-spring25.comviva.com/jeopardyApi/v4
https://int-spring25.comviva.com/holidayService/v4
Sandbox:
https://int-spring25.comviva.com/
Rule Service
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:
Rule Definition Input: Allows providing input parameters as per rule definitions.
Dynamic Rule Loading: Loads rules into a rule kia session, returning specific results based on facts.
REST API Access: Deployed rules can be accessed via a REST API.
Rule Engine Integration: Enables updating and deploying rules via the RuleEngine, accessible through the REST API.
Business Rule Types: Supports various rules like Task Allocation, Attribute Restrictions, and Portfolio ID definition.
Rule Versioning: Allows duplication of rules, defaulting to draft versions, and publishing modified rules as Active rules via the REST API.
Access Control: Requires login access for API usage.
Customization: Developers define rules based on business requirements, specifying conditions for rule execution.
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.
Base URL
Production:
https://int-spring25.comviva.com/
https://int-spring25.comviva.com/OrderGenerator/v4
https://int-spring25.comviva.com/customerOrder/management/v4
https://int-spring25.comviva.com/serviceOrdering/management/v4
https://int-spring25.comviva.com/om-som-adapter/v4
https://int-spring25.comviva.com/productInventory/management/v4
https://int-spring25.comviva.com/serviceInventory/management/v4
https://int-spring25.comviva.com/task-management/v4
https://int-spring25.comviva.com/troubleTicket/query/v4
https://int-spring25.comviva.com/rules/v4
https://int-spring25.comviva.com/communicationManagement/v4
https://int-spring25.comviva.com/project-plan/v4
https://int-spring25.comviva.com/jeopardyApi/v4
https://int-spring25.comviva.com/holidayService/v4
Sandbox:
https://int-spring25.comviva.com/
Communication Management
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.
Base URL
Production:
https://int-spring25.comviva.com/
https://int-spring25.comviva.com/OrderGenerator/v4
https://int-spring25.comviva.com/customerOrder/management/v4
https://int-spring25.comviva.com/serviceOrdering/management/v4
https://int-spring25.comviva.com/om-som-adapter/v4
https://int-spring25.comviva.com/productInventory/management/v4
https://int-spring25.comviva.com/serviceInventory/management/v4
https://int-spring25.comviva.com/task-management/v4
https://int-spring25.comviva.com/troubleTicket/query/v4
https://int-spring25.comviva.com/rules/v4
https://int-spring25.comviva.com/communicationManagement/v4
https://int-spring25.comviva.com/project-plan/v4
https://int-spring25.comviva.com/jeopardyApi/v4
https://int-spring25.comviva.com/holidayService/v4
Sandbox:
https://int-spring25.comviva.com/
Project Plan 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:
Master Data Configuration: Defines project milestones and configurations in the master data setup.
Flow Trace Comparison: Compares Flow Trace data with major milestones to determine start and end times for activities.
Business Process Integration: Supports B2B business processes and allows manual initiation by agents.
Communication Channels: Sends project plans to customers online via email or offline in Excel or PowerPoint formats.
Authorization: Requires valid login permissions for access and usage.
Customization: Allows developers to define business rules and configurations for project planning.
Performance Optimization: Optimized for efficient processing and generation of project plans.
Async Generation: Generates project plans asynchronously, taking input data and generating plans in the background.
Output Formats: Supports output formats such as email, PowerPoint, and online viewing for project plans.
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.
Base URL
Production:
https://int-spring25.comviva.com/
https://int-spring25.comviva.com/OrderGenerator/v4
https://int-spring25.comviva.com/customerOrder/management/v4
https://int-spring25.comviva.com/serviceOrdering/management/v4
https://int-spring25.comviva.com/om-som-adapter/v4
https://int-spring25.comviva.com/productInventory/management/v4
https://int-spring25.comviva.com/serviceInventory/management/v4
https://int-spring25.comviva.com/task-management/v4
https://int-spring25.comviva.com/troubleTicket/query/v4
https://int-spring25.comviva.com/rules/v4
https://int-spring25.comviva.com/communicationManagement/v4
https://int-spring25.comviva.com/project-plan/v4
https://int-spring25.comviva.com/jeopardyApi/v4
https://int-spring25.comviva.com/holidayService/v4
Sandbox:
https://int-spring25.comviva.com/
Fallout Management
Fallout 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.
The system is raising red flag in orders if any fallout/jeopardy is raised in the order so that corrective action can be taken up by teams or system to ensure order are not impacted. The system is monitoring below parameters like: System/Process fallout: As application is processing the request and if any fallout happen during processing the request, then the system will be calling jeopardy library to self-heal fallout like - Retry - Set Default value - Repush the event - Reprocess the request. Task Delays: the system will be monitoring the manual/external tasks to ensure timely completion of the activity. If any delay happens then the system raise jeopardy event and send escalation email to respective team to fast track delivery. Requested Due Date / Expected Completion Date: The system is monitory order to be completed within customer requested/expected date. If order is delayed, then the system will raise jeopardy. Hold Order: once order is put on hold then the system will stop processing on this order and the system will raise jeopardy why jeopardy is raised so that respective teams can do needful to resume order back.
Holiday Calendar Service
The Holiday Service 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 Features:
- Define Holiday Calendars: Define holiday calendars based on organization, region, and weekend offs.
- Retrieve Holiday Calendars: Get holiday calendar details based on organization and region.
- Calculate End Date: Calculate end dates based on start dates and business Turnaround Time (TAT).
- Delete Holiday Calendars: Remove holiday calendars as needed.
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.
Base URL
Production:
https://int-spring25.comviva.com/
https://int-spring25.comviva.com/OrderGenerator/v4
https://int-spring25.comviva.com/customerOrder/management/v4
https://int-spring25.comviva.com/serviceOrdering/management/v4
https://int-spring25.comviva.com/om-som-adapter/v4
https://int-spring25.comviva.com/productInventory/management/v4
https://int-spring25.comviva.com/serviceInventory/management/v4
https://int-spring25.comviva.com/task-management/v4
https://int-spring25.comviva.com/troubleTicket/query/v4
https://int-spring25.comviva.com/rules/v4
https://int-spring25.comviva.com/communicationManagement/v4
https://int-spring25.comviva.com/project-plan/v4
https://int-spring25.comviva.com/jeopardyApi/v4
https://int-spring25.comviva.com/holidayService/v4
Sandbox:
https://int-spring25.comviva.com/