Sign in

v1

latestOpenAPI 3.0.2cPanel License2026-08-06657427.1 MB
Market
Market Integration

Update URL after checkout

This function updates the URL to which a provider sends a user after they check out.

get/Market/set_url_after_checkout

Query parameters

access_tokenstring required
Example:725431a1-d5bc-11e5-a28b-8b0e09a93f05

The access token for the session to the cPanel Market provider.

order_idinteger required
Example:123456

The order ID that the cPanel Market provider assigned.

providerstring required
Example:cPStore

The cPanel Market provider's name.

url_after_checkoutstring url required
Example:http://checkout.example.com

The URL to send the browser after the user checks out.

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": "set_url_after_checkout",
  "module": "Market",
  "result": {
    "data": {
      "error_type": "This is an error."
    },
    "status": 1
  }
}