v1

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

Create shopping cart

This function creates a shopping cart with which the system sends an order to the cPanel Store. Typically, the system will send shopping cart orders for SSL certificates to UAPI’s Market::request_ssl_certificates function.

get/Market/create_shopping_cart

Query parameters

access_tokenstring uuid required
Example:1a676e6f-99fc-11e6-9ab6-e60a769b73bc

The access token to connect to the provider.

itemstring[] required

The items to add to the shopping cart.

Note:

The value is a JSON string.

This object has one required key, product_id, which is a string.

The other keys/values in this object vary depending on the provider.

providerstring required
Example:cPStore

The cPanel Market provider’s name.

url_after_checkoutstring url required
Example:http://www.example.com/thenextplace

The location to which the provider directs the user after the checkout process is complete.

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": "create_shopping_cart",
  "module": "Market",
  "result": {
    "data": {
      "checkout_url": "http://www.example.com/checkout",
      "order_id": "8765309"
    },
    "status": 1
  }
}