Create a checkout session
curl --request POST \
--url https://portal.urbnbox.io/api/partner/v1/checkout-sessions \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"external_order_id": "<string>",
"space_id": "<string>",
"client_name": "<string>",
"phone": "<string>",
"starts_at": "2023-12-25",
"ends_at": "2023-12-25",
"amount_kes": 1
}
'import requests
url = "https://portal.urbnbox.io/api/partner/v1/checkout-sessions"
payload = {
"external_order_id": "<string>",
"space_id": "<string>",
"client_name": "<string>",
"phone": "<string>",
"starts_at": "2023-12-25",
"ends_at": "2023-12-25",
"amount_kes": 1
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
external_order_id: '<string>',
space_id: '<string>',
client_name: '<string>',
phone: '<string>',
starts_at: '2023-12-25',
ends_at: '2023-12-25',
amount_kes: 1
})
};
fetch('https://portal.urbnbox.io/api/partner/v1/checkout-sessions', 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://portal.urbnbox.io/api/partner/v1/checkout-sessions",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'external_order_id' => '<string>',
'space_id' => '<string>',
'client_name' => '<string>',
'phone' => '<string>',
'starts_at' => '2023-12-25',
'ends_at' => '2023-12-25',
'amount_kes' => 1
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://portal.urbnbox.io/api/partner/v1/checkout-sessions"
payload := strings.NewReader("{\n \"external_order_id\": \"<string>\",\n \"space_id\": \"<string>\",\n \"client_name\": \"<string>\",\n \"phone\": \"<string>\",\n \"starts_at\": \"2023-12-25\",\n \"ends_at\": \"2023-12-25\",\n \"amount_kes\": 1\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://portal.urbnbox.io/api/partner/v1/checkout-sessions")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"external_order_id\": \"<string>\",\n \"space_id\": \"<string>\",\n \"client_name\": \"<string>\",\n \"phone\": \"<string>\",\n \"starts_at\": \"2023-12-25\",\n \"ends_at\": \"2023-12-25\",\n \"amount_kes\": 1\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://portal.urbnbox.io/api/partner/v1/checkout-sessions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"external_order_id\": \"<string>\",\n \"space_id\": \"<string>\",\n \"client_name\": \"<string>\",\n \"phone\": \"<string>\",\n \"starts_at\": \"2023-12-25\",\n \"ends_at\": \"2023-12-25\",\n \"amount_kes\": 1\n}"
response = http.request(request)
puts response.read_body{
"ID": "<string>",
"PartnerID": "<string>",
"Status": "<string>",
"CreatedAt": "2023-11-07T05:31:56Z",
"UpdatedAt": "2023-11-07T05:31:56Z",
"ExpiresAt": "2023-11-07T05:31:56Z",
"ExternalOrderID": "<string>",
"SpaceID": "<string>",
"ClientName": "<string>",
"Phone": "<string>",
"StartsAt": "2023-11-07T05:31:56Z",
"EndsAt": "2023-11-07T05:31:56Z",
"AmountCents": 123,
"IdempotencyKey": "<string>"
}<string><string><string><string>Pickup-point shipments (Partner API)
Create a checkout session
Creates a partner checkout session and holds a locker. Supply an Idempotency-Key when retrying a request.
POST
/
api
/
partner
/
v1
/
checkout-sessions
Create a checkout session
curl --request POST \
--url https://portal.urbnbox.io/api/partner/v1/checkout-sessions \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"external_order_id": "<string>",
"space_id": "<string>",
"client_name": "<string>",
"phone": "<string>",
"starts_at": "2023-12-25",
"ends_at": "2023-12-25",
"amount_kes": 1
}
'import requests
url = "https://portal.urbnbox.io/api/partner/v1/checkout-sessions"
payload = {
"external_order_id": "<string>",
"space_id": "<string>",
"client_name": "<string>",
"phone": "<string>",
"starts_at": "2023-12-25",
"ends_at": "2023-12-25",
"amount_kes": 1
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
external_order_id: '<string>',
space_id: '<string>',
client_name: '<string>',
phone: '<string>',
starts_at: '2023-12-25',
ends_at: '2023-12-25',
amount_kes: 1
})
};
fetch('https://portal.urbnbox.io/api/partner/v1/checkout-sessions', 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://portal.urbnbox.io/api/partner/v1/checkout-sessions",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'external_order_id' => '<string>',
'space_id' => '<string>',
'client_name' => '<string>',
'phone' => '<string>',
'starts_at' => '2023-12-25',
'ends_at' => '2023-12-25',
'amount_kes' => 1
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://portal.urbnbox.io/api/partner/v1/checkout-sessions"
payload := strings.NewReader("{\n \"external_order_id\": \"<string>\",\n \"space_id\": \"<string>\",\n \"client_name\": \"<string>\",\n \"phone\": \"<string>\",\n \"starts_at\": \"2023-12-25\",\n \"ends_at\": \"2023-12-25\",\n \"amount_kes\": 1\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://portal.urbnbox.io/api/partner/v1/checkout-sessions")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"external_order_id\": \"<string>\",\n \"space_id\": \"<string>\",\n \"client_name\": \"<string>\",\n \"phone\": \"<string>\",\n \"starts_at\": \"2023-12-25\",\n \"ends_at\": \"2023-12-25\",\n \"amount_kes\": 1\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://portal.urbnbox.io/api/partner/v1/checkout-sessions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"external_order_id\": \"<string>\",\n \"space_id\": \"<string>\",\n \"client_name\": \"<string>\",\n \"phone\": \"<string>\",\n \"starts_at\": \"2023-12-25\",\n \"ends_at\": \"2023-12-25\",\n \"amount_kes\": 1\n}"
response = http.request(request)
puts response.read_body{
"ID": "<string>",
"PartnerID": "<string>",
"Status": "<string>",
"CreatedAt": "2023-11-07T05:31:56Z",
"UpdatedAt": "2023-11-07T05:31:56Z",
"ExpiresAt": "2023-11-07T05:31:56Z",
"ExternalOrderID": "<string>",
"SpaceID": "<string>",
"ClientName": "<string>",
"Phone": "<string>",
"StartsAt": "2023-11-07T05:31:56Z",
"EndsAt": "2023-11-07T05:31:56Z",
"AmountCents": 123,
"IdempotencyKey": "<string>"
}<string><string><string><string>Authorizations
Partner key. Shipment creation requires a secret key.
Headers
Stable key used to prevent duplicate sessions.
Body
application/json
Response
Checkout session created.