TMF622 v5 Product Ordering Management API
The Product Ordering API (TMF622) 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 offering that is defined in a catalog. The product offering identifies the product or set of products that are available to a customer, and includes characteristics such as pricing, product options and market.
- For TMF Open API release and specification version, see Industry API Version.
- For resource mappings, see TMF622 v5 Resource Mappings.
- For use cases, see TMF622 v5 Use Cases.
These addon licenses, permissions, and preferences are required to use TMF622 v5 API.
Addon Licenses
- Communication Cloud Addon
- RevenueLifecycleManagementAddOn
- RevSubscriptionManagementAddOn
- SubscriptionManagementToCPQConnector
Platform Licenses
- RevenueLifecycleManagement
- RevSubscriptionManagement
- SubscriberLifecycleManagement
- SubscriptionManagementToCPQConnector
User Licenses
- ContextService Admin Psl (Permset License)
- ContextService Runtime Psl (Permset License)
- Revenue Lifecycle Management User (Permset License)
- Subscriber Lifecycle Management (Permset License)
- Subscription Management Partner User (Permset License)
- Subscription Management User (Permset License)
Org Preferences
- CoreCPQEnabled. Ensure to set visibility for the Admin profile to see it in the layout
- CorePricingPreference
- EnhancedCommerceOrders
- ContextDefinitionsEnabled
- NewOrderSaveBehaviour
- Minimum set of permissions to use Orchestration Designtime and Runtime
- Permission: DFOCommonOrchestrator (Pilot)
- Enable Fulfillment Workspace and Plan Viewer
- Assign Permission Set License to User → Access Actionable Relationship Center
- To configure and run callouts these permissions are required.
- IndustriesIntegrationFwk: access integration provider definitions in setup.
- IndustriesIntegOrchPilot: To access integration provider definitions in run-time.
TMF622 v5 API uses the following URL format:
{https://MyDomainLoginUrl}/services/data/v63.0/connect/comms/productOrderingManagement/v5/productOrder.
To access and use the TMF622 v5 API:
- Read and accept the terms and conditions of usage. See Accept Terms and Enable Access.
- Authorize and use a connected app and an OAuth 2.0 authorization flow. See Authorize Access.
- Trigger the API call. Refer the above section for sample URL.
- Use the TMF622 v5 API available resources. See TMF622 v5 Resource Mappings.
- Use the TMF622 v5 API endpoints. See TMF622 v5 API Endpoints.