TMF637 v4 Product Inventory Management

GET List Products

GET /product

Retrieves a list of products with specified fields and based on filtering, if any.

Parameters

• fields (query, string) Provide required attributes here in a comma seperated manner. Supported fields :- name, isBundle, isCustomerVisible, description, status, productSerialNumber
• status (query, string) Filter based on the status of the product
• name (query, string) Filter based on the name of the product.
• productSerialNumber (query, string) Filter based on the serial number for the product.
• description (query, string) Filter based on the description of the product.
• offset (query, string) Specifies the requested index for the start of the resources to be included in the response.
• limit (query, string) Specifies the requested number of the resources to be included in the response.
• Authorization (header, string, required) Specifies the bearer token to use for the authentication of request.
• Namespace (header, string) Specifies the namespace to use with the URL path.
• Domain-Name (header, string, required) Specifies the domain name to use with the URL path received from the userinfo API.

Responses

• 200 Successfully retrieved a list of products.

  Media type: application/json. Schema: array of Product.

  Array of Product.

  Example

  [
    {
        "isBundle": "false",
        "isCustomerVisible": true,
        "productSpecification": {
            "id": "01tDp000000Ogk5IAC",
            "name": "Cisco Firepower789"
        },
        "productOffering": {
            "id": "01tDp000000Ogk0IAC",
            "name": "Cisco Firepower789"
        },
        "description": "New DESC",
        "id": "99394f76-7187-c384-b50a-de213527ecd9",
        "name": "Testing Asset",
        "productSerialNumber": "123",
        "status": "Ready for review",
        "relatedParty": [
            {
                "name": "Testing Asset",
                "@referredType": "Account",
                "id": "CC2134256"
            }
        ],
        "billingAccount": {
            "id": "001Dp000002RdyXIAS",
            "name": "TMForum"
        },
        "href": "/services/apexrest/vlocity_cmt/tmforum/productopenapi/v1/product/99394f76-7187-c384-b50a-de213527ecd9",
        "productPrice": [
            {
                "priceType": "One-time",
                "price": {
                    "taxIncludedAmount": {
                        "value": 0.00000
                    }
                },
                "name": "a3GDp000000LbKU"
            }
        ],
        "productCharacteristic": [
            {
                "name": "B2CCmex_ATTR_DATA_CHAR",
                "value": "50 GB",
                "valueType": "Text"
            },
            {
                "name": "B2CCmex_ATTR_HASDISCOUNT_CHAR",
                "value": "true",
                "valueType": "Checkbox"
            },
            {
                "name": "B2CCmex_ATTR_MMS",
                "value": "20",
                "valueType": "Number"
            },
            {
                "name": "B2CCmex_ATTR_PAYMENT_OPTION_CHAR",
                "value": "Postpaid",
                "valueType": "Picklist"
            },
            {
                "name": "B2CCmex_ATTR_SMS_CHAR",
                "value": "500",
                "valueType": "Text"
            },
            {
                "name": "B2CCmex_ATTR_TANGIBLE_CHAR",
                "value": "false",
                "valueType": "Checkbox"
            },
            {
                "name": "B2CCmex_ATTR_VOICE_CHAR",
                "value": "500",
                "valueType": "Text"
            }
        ]
    },
    {
        "description": "hey",
        "id": "ed5feda3-b2fe-f590-c253-cd3ad81eae40",
        "name": "New Asset",
        "productSerialNumber": "112233",
        "status": "Active",
        "relatedParty": [
            {
                "id": "CC213425",
                "name": "Pyramid Construction Inc.",
                "@referredType": "Account"
            }
        ],
        "href": "/services/apexrest/vlocity_cmt/tmforum/productopenapi/v1/product/ed5feda3-b2fe-f590-c253-cd3ad81eae40"
    },
    {
        "isBundle": "false",
        "isCustomerVisible": true,
        "productSpecification": {
            "id": "01tDp000000Ogk5IAC",
            "name": "Cisco Firepower789"
        },
        "productOffering": {
            "id": "01tDp000000OgkAIAS",
            "name": "Cisco Firepower789"
        },
        "orderDate": "2019-05-03",
        "productOrderItem": [
            {
                "productOrderId": "00000100",
                "orderItemAction": "Add",
                "orderItemId": "0000000001"
            }
        ],
        "description": "new desc",
        "id": "1b55a381-1782-56d6-a90a-2030798d6e4b",
        "name": "TMForum",
        "productSerialNumber": "xyz",
        "startDate": "2024-05-05",
        "status": "Active",
        "relatedParty": [
            {
                "id": "CD451791",
                "name": "Test Sh1",
                "@referredType": "Account"
            }
        ],
        "billingAccount": {
            "id": "001Dp000002RdyXIAS",
            "name": "TMForum"
        },
        "href": "/services/apexrest/vlocity_cmt/tmforum/productopenapi/v1/product/1b55a381-1782-56d6-a90a-2030798d6e4b",
        "productPrice": [
            {
                "priceType": "One-time",
                "price": {
                    "taxIncludedAmount": {
                        "value": 0.00000
                    }
                },
                "name": "a3GDp000000LbKe"
            }
        ],
        "productCharacteristic": [
            {
                "name": "B2CCmex_ATTR_DATA_CHAR",
                "value": "25 GB",
                "valueType": "Text"
            },
            {
                "name": "B2CCmex_ATTR_HASDISCOUNT_CHAR",
                "value": "false",
                "valueType": "Checkbox"
            },
            {
                "name": "B2CCmex_ATTR_MMS",
                "valueType": "Number"
            },
            {
                "name": "B2CCmex_ATTR_PAYMENT_OPTION_CHAR",
                "value": "Prepaid",
                "valueType": "Picklist"
            },
            {
                "name": "B2CCmex_ATTR_SMS_CHAR",
                "value": "500",
                "valueType": "Text"
            },
            {
                "name": "B2CCmex_ATTR_TANGIBLE_CHAR",
                "value": "false",
                "valueType": "Checkbox"
            },
            {
                "name": "B2CCmex_ATTR_VOICE_CHAR",
                "value": "500",
                "valueType": "Text"
            }
        ]
    }
  ]

• 404 Resource not found.

  Media type: application/json. Schema: Error.

  Example

  code: NOT_FOUND
  reason: There are no matching resource.
  message: There are no data in system or not data for specified filters.

• 500 Internal Server Error.

  Media type: application/json. Schema: Error.

  Example

  code: "500"
  reason: Internal Server Error