CPcpanel
Market
Market Integration

Retrieve product information

This function retrieves product information for the specified product name, including the product ID, redirect path, and redirect URLs for successful and failed purchases.

get/Market/get_product_info

Request

  • Base URL
    https://cpanel-server.tld:2083/execute
  • Auth
    HTTP basic

Query parameters

product_namestring required
Example:cpanel-ssl

The name of the product for which to retrieve information.

Response

HTTP Request was successful.

apiversioninteger

The version of the API.

funcstring

The name of the method called.

modulestring

The name of the module called.

Example response

{
  "apiversion": 3,
  "func": "get_product_info",
  "module": "Market",
  "result": {
    "data": {
      "product_id": "123456",
      "redirect_path": "/frontend/jupiter/store/purchase_cpanel-ssl_completion.html",
      "redirect_url_failure": "https://hostname.example.com:2083/cpsessXXXXXXXXXX/frontend/jupiter/store/purchase_cpanel-ssl_completion.html?domain=example.com&successful_purchase=0",
      "redirect_url_success": "https://hostname.example.com:2083/cpsessXXXXXXXXXX/frontend/jupiter/store/purchase_cpanel-ssl_completion.html?domain=example.com&successful_purchase=1"
    },
    "status": 1
  }
}

Changes

No recorded changes to this operation across all 5 revisions of this API.