Overview

• The TMF679 API provides a standardized mechanism for service providers to implement efficient, consistent, and interoperable processes for determining Product Ordering Qualification. This is a process of verifying whether a specific product or service can be ordered by a customer based on various criteria such as availability, eligibility, location, and customer profile.

• Using TMF679 API you can perform these operations for product offerings.
  • Retrieve the list of product offerings.
  • Check product availability and eligibility for product ordering qualification.

important: Starting from the Winter ’27 release, only the Direct Access option will be supported. The MuleSoft gateway option will be deprecated, and customers must update their integrations to use the Connect/Apex REST endpoints for continued access to the inbound APIs.

Assumptions

It is assumed that you have completed the following.

• Enabling Access to Industry APIs
• Ensuring that the required licenses and data packs are installed. For more information.

Sequence of Operations

Following block diagram provides a sequence of operations involved.

NOTE:

• For mandatory fields and resource mappings, refer TMF679 Resource Mappings.

Use Cases

QueryProductOfferingQualification

Consider you want to retrieve and display products for a specified catalog, category, or subcategory.

Sample URL

https://vlocity-1f5-dev-ed.develop.my.salesforce.com/services/data/v63.0/connect/comms/productofferingqualification/v5/queryProductOfferingQualification/

This operation uses RLM's Products List (POST) API.

Sample Request

{
    "category" : {
        "id" : "0ZGxx0000000001GAA",
        "name" : "Laptops",
        "@type" : "CategoryRef"
    },
    "relatedParty" : [
        {
            "role" : "account",
            "@type" : "relatedParty",
            "partyOrPartyRole" : {
                "id" : "001xx000003GYiBAAW",
                "name" : "Sales Rep Luke Accoun",
                "@type" : "account",
                "@referredType" : "Account"
            }
        }
    ]
}

Sample Response

status 200
{
    "effectiveQualificationDate": "2024-10-29T05:13:08.238Z",
    "createdDate": "2024-10-29T05:13:08.238Z",
    "state": "Done",
    "relatedParty": [
        {
            "role": "account",
            "partyOrPartyRole": {
                "id": "001xx000003GYiBAAW",
                "href": "/services/data/v60.0/sobjects/Account/001xx000003GYiBAAW",
                "name": "Sales Rep Luke Accoun",
                "@type": "Account",
                "@referredType": "PartyOrPartyRoleRef"
            }
        }
    ],
    "category": {
        "id": "0ZGxx0000000001GAA",
        "href": "/services/data/v60.0/sobjects/ProductCategory/0ZGxx0000000001GAA",
        "name": "Laptops",
        "@type": "CategoryRef"
    },
    "qualifiedProductOfferingItem": [
        {
            "product": {
                "id": "1",
                "productSpecification": {
                    "id": "01txx0000006i2WAAQ",
                    "href": "/services/data/v60.0/sobjects/Product2/01txx0000006i2WAAQ",
                    "name": "Laptop",
                    "@type": "ProductSpecificationRef"
                },
                "@type": "Product"
            },
            "@type": "QueryProductOfferingQualificationItem"
        },
        {
            "product": {
                "id": "2",
                "productSpecification": {
                    "id": "01txx0000006i2XAAQ",
                    "href": "/services/data/v60.0/sobjects/Product2/01txx0000006i2XAAQ",
                    "name": "Laptop Basic Bundle",
                    "@type": "ProductSpecificationRef"
                },
                "@type": "Product"
            },
            "@type": "QueryProductOfferingQualificationItem"
        },
        {
            "product": {
                "id": "3",
                "productSpecification": {
                    "id": "01txx0000006i2ZAAQ",
                    "href": "/services/data/v60.0/sobjects/Product2/01txx0000006i2ZAAQ",
                    "name": "Laptop Pro Bundle",
                    "@type": "ProductSpecificationRef"
                },
                "@type": "Product"
            },
            "@type": "QueryProductOfferingQualificationItem"
        },
        {
            "product": {
                "id": "4",
                "productSpecification": {
                    "id": "01txx0000006i39AAA",
                    "href": "/services/data/v60.0/sobjects/Product2/01txx0000006i39AAA",
                    "name": "Laptop Productivity Bundle",
                    "@type": "ProductSpecificationRef"
                },
                "@type": "Product"
            },
            "@type": "QueryProductOfferingQualificationItem"
        }
    ],
    "@type": "QueryProductOfferingQualification"
}

CheckProductOfferingQualification

Consider you want to check product offering qualification.

Sample URL

https://vlocity-1f5-dev-ed.develop.my.salesforce.com/services/data/v63.0connect/comms/productofferingqualification/v5/checkProductOfferingQualification/

This operation uses RLM's Qualification (POST) API.

Sample Request

{
  "checkProductOfferingQualificationItem": [
    {
      "expectedActivationDate": "2021-09-01T14:21:03.352Z",
      "productOffering": {
        "id": "01txx0000006i2WAAQ",
        "name": "Antivirus"
      },
      "action": "add",
      "id": "1"
    }
  ],
  "relatedParty": [
    {
      "role": "requester",
      "partyOrPartyRole": {
        "id": "001xx000003GYiBAAW",
        "name": "Sales Rep Luke Account",
        "@type": "AccountRef",
        "@referredType": "AccountRef"
      }
    }
  ]
}

Sample Response

status 200
{
    "creationDate": "2024-10-29T05:04:16.180Z",
    "state": "done",
    "checkProductOfferingQualificationItem": [
        {
            "id": "1",
            "href": "/connect/comms/customermanagement/${version}/customer/1",
            "qualificationItemResult": "green",
            "state": "done",
            "productOffering": {
                "id": "01txx0000006i2WAAQ",
                "href": "https://host:port/productCatalogManagement/v5/productOffering/01txx0000006i2WAAQ",
                "name": "Antivirus"
            },
            "@type": "CheckProductOfferingQualificationItem"
        }
    ],
    "relatedParty": [
        {
            "role": "requester",
            "partyOrPartyRole": {
                "id": "001xx000003GYiBAAW",
                "href": "https://host:port/partyManagement/v5/individual/001xx000003GYiBAAW",
                "@type": "AccountRef",
                "@referredType": "Individual"
            }
        }
    ],
    "@type": "CheckProductOfferingQualification"
}