Retrieve Simplified Product Checkout Catalog
curl --request GET \
--url https://api.byteful.com/1.0/public/user/checkout/catalog \
--header 'X-API-Private-Key: <api-key>' \
--header 'X-API-Public-Key: <api-key>'import requests
url = "https://api.byteful.com/1.0/public/user/checkout/catalog"
headers = {
"X-API-Private-Key": "<api-key>",
"X-API-Public-Key": "<api-key>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {'X-API-Private-Key': '<api-key>', 'X-API-Public-Key': '<api-key>'}
};
fetch('https://api.byteful.com/1.0/public/user/checkout/catalog', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.byteful.com/1.0/public/user/checkout/catalog",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-Private-Key: <api-key>",
"X-API-Public-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.byteful.com/1.0/public/user/checkout/catalog"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Private-Key", "<api-key>")
req.Header.Add("X-API-Public-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.byteful.com/1.0/public/user/checkout/catalog")
.header("X-API-Private-Key", "<api-key>")
.header("X-API-Public-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.byteful.com/1.0/public/user/checkout/catalog")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Private-Key"] = '<api-key>'
request["X-API-Public-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"data": {
"datacenter_us": {
"country_id": "us",
"product_cycle_options": [
"1:month",
"3:month",
"1:year"
],
"product_is_available": true,
"product_is_per_ip": true,
"product_name": "Datacenter Proxies [US]",
"product_protocol": "ipv4",
"product_stock": 10,
"product_type": "datacenter"
},
"isp_gb": {
"country_id": "gb",
"product_cycle_options": [
"1:month",
"3:month",
"1:year"
],
"product_is_available": true,
"product_is_per_ip": true,
"product_name": "Static Residential ISP Proxies [GB]",
"product_protocol": "ipv4",
"product_stock": 181,
"product_type": "isp"
}
},
"message": "Checkout catalog successfully retrieved."
}Checkout
Retrieve Simplified Product Checkout Catalog
This endpoint returns a simplified product list that is both visible and enabled for API checkouts. It helps clients to quickly identify and purchase available products without any search or pagination parameters. Ideal for basic API-based purchasing.
GET
/
public
/
user
/
checkout
/
catalog
Retrieve Simplified Product Checkout Catalog
curl --request GET \
--url https://api.byteful.com/1.0/public/user/checkout/catalog \
--header 'X-API-Private-Key: <api-key>' \
--header 'X-API-Public-Key: <api-key>'import requests
url = "https://api.byteful.com/1.0/public/user/checkout/catalog"
headers = {
"X-API-Private-Key": "<api-key>",
"X-API-Public-Key": "<api-key>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {'X-API-Private-Key': '<api-key>', 'X-API-Public-Key': '<api-key>'}
};
fetch('https://api.byteful.com/1.0/public/user/checkout/catalog', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.byteful.com/1.0/public/user/checkout/catalog",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-Private-Key: <api-key>",
"X-API-Public-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.byteful.com/1.0/public/user/checkout/catalog"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Private-Key", "<api-key>")
req.Header.Add("X-API-Public-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.byteful.com/1.0/public/user/checkout/catalog")
.header("X-API-Private-Key", "<api-key>")
.header("X-API-Public-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.byteful.com/1.0/public/user/checkout/catalog")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Private-Key"] = '<api-key>'
request["X-API-Public-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"data": {
"datacenter_us": {
"country_id": "us",
"product_cycle_options": [
"1:month",
"3:month",
"1:year"
],
"product_is_available": true,
"product_is_per_ip": true,
"product_name": "Datacenter Proxies [US]",
"product_protocol": "ipv4",
"product_stock": 10,
"product_type": "datacenter"
},
"isp_gb": {
"country_id": "gb",
"product_cycle_options": [
"1:month",
"3:month",
"1:year"
],
"product_is_available": true,
"product_is_per_ip": true,
"product_name": "Static Residential ISP Proxies [GB]",
"product_protocol": "ipv4",
"product_stock": 181,
"product_type": "isp"
}
},
"message": "Checkout catalog successfully retrieved."
}Authorizations
Private API key for user-level authentication.
Public API key for user-level authentication.
Response
200 - application/json
Successfully retrieved the simplified checkout catalog.
Object containing available products keyed by product ID
Show child attributes
Show child attributes
Example:
{
"datacenter_us": {
"country_id": "us",
"product_cycle_options": ["1:month", "3:month", "1:year"],
"product_is_available": true,
"product_is_per_ip": true,
"product_name": "Datacenter Proxies [US]",
"product_protocol": "ipv4",
"product_stock": 10,
"product_type": "datacenter"
},
"isp_gb": {
"country_id": "gb",
"product_cycle_options": ["1:month", "3:month", "1:year"],
"product_is_available": true,
"product_is_per_ip": true,
"product_name": "Static Residential ISP Proxies [GB]",
"product_protocol": "ipv4",
"product_stock": 181,
"product_type": "isp"
}
}
A success message.
Example:
"Checkout catalog successfully retrieved."
⌘I

