Update URL after checkout

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

SecurityBasicAuth
Request
query Parameters
access_token
required
string

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

Example: access_token=725431a1-d5bc-11e5-a28b-8b0e09a93f05
order_id
required
integer

The order ID that the cPanel Market provider assigned.

Example: order_id=123456
provider
required
string

The cPanel Market provider's name.

Example: provider=cPStore
url_after_checkout
required
string <url>

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

Example: url_after_checkout=http://checkout.example.com
Responses
200

HTTP Request was successful.

Response Schema: application/json
apiversion
integer

The version of the API.

func
string

The name of the method called.

module
string

The name of the module called.

object
get/Market/set_url_after_checkout
Request samples
uapi --output=jsonpretty \
  --user=username \
  Market \
  set_url_after_checkout \
  provider='cPStore' \
  access_token='725431a1-d5bc-11e5-a28b-8b0e09a93f05' \
  order_id='123456' \
  url_after_checkout='http://checkout.example.com'
Response samples
application/json
{
  • "apiversion": 3,
  • "func": "set_url_after_checkout",
  • "module": "Market",
  • "result": {
    • "data": {
      • "error_type": "This is an error."
      },
    • "errors": null,
    • "messages": null,
    • "metadata": { },
    • "status": 1,
    • "warnings": null
    }
}