curl
curl -O -J https://api.urbnbox.com/api/vendor/v1/shipments/csv-templateimport requests
resp = requests.get('https://api.urbnbox.com/api/vendor/v1/shipments/csv-template')
with open('urbnbox-shipments-template.csv', 'wb') as f:
f.write(resp.content)
print('Template saved.')const fs = require('fs');
const https = require('https');
https.get('https://api.urbnbox.com/api/vendor/v1/shipments/csv-template', (res) => {
res.pipe(fs.createWriteStream('urbnbox-shipments-template.csv'));
res.on('end', () => console.log('Template saved.'));
});<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://portal.urbnbox.io/api/vendor/v1/shipments/csv-template",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$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://portal.urbnbox.io/api/vendor/v1/shipments/csv-template"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://portal.urbnbox.io/api/vendor/v1/shipments/csv-template")
.asString();require 'uri'
require 'net/http'
url = URI("https://portal.urbnbox.io/api/vendor/v1/shipments/csv-template")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_bodyexternal_reference,recipient_name,recipient_phone,origin_city,destination_city,weight_tier
SHIP-001,Alice Mwangi,0712345678,Nairobi,Mombasa,small
SHIP-002,Bob Otieno,0798765432,Kisumu,Nairobi,mediumPickup-point shipments (Vendor API)
Download shipments CSV template
Returns urbnbox-shipments-template.csv — a pre-formatted CSV with correct headers and two example rows. No authentication required. Fill it in, then POST to /api/vendor/v1/shipments/import-csv.
Column order (do not change):
| # | Column | Required | Notes |
|---|---|---|---|
| 1 | external_reference | Yes | Your shipment ID — used for idempotency |
| 2 | recipient_name | Yes | Full name of recipient |
| 3 | recipient_phone | Yes | Kenyan number (07xx or +254xx) |
| 4 | origin_city | Yes | e.g. Nairobi |
| 5 | destination_city | Yes | e.g. Mombasa |
| 6 | weight_tier | Yes | small, medium, or large |
Weight tiers: small = up to 5 kg · medium = 5–15 kg · large = 15–30 kg
Example file contents:
external_reference,recipient_name,recipient_phone,origin_city,destination_city,weight_tier
SHIP-001,Alice Mwangi,0712345678,Nairobi,Mombasa,small
SHIP-002,Bob Otieno,0798765432,Kisumu,Nairobi,medium
GET
/
api
/
vendor
/
v1
/
shipments
/
csv-template
curl
curl -O -J https://api.urbnbox.com/api/vendor/v1/shipments/csv-templateimport requests
resp = requests.get('https://api.urbnbox.com/api/vendor/v1/shipments/csv-template')
with open('urbnbox-shipments-template.csv', 'wb') as f:
f.write(resp.content)
print('Template saved.')const fs = require('fs');
const https = require('https');
https.get('https://api.urbnbox.com/api/vendor/v1/shipments/csv-template', (res) => {
res.pipe(fs.createWriteStream('urbnbox-shipments-template.csv'));
res.on('end', () => console.log('Template saved.'));
});<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://portal.urbnbox.io/api/vendor/v1/shipments/csv-template",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$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://portal.urbnbox.io/api/vendor/v1/shipments/csv-template"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://portal.urbnbox.io/api/vendor/v1/shipments/csv-template")
.asString();require 'uri'
require 'net/http'
url = URI("https://portal.urbnbox.io/api/vendor/v1/shipments/csv-template")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_bodyexternal_reference,recipient_name,recipient_phone,origin_city,destination_city,weight_tier
SHIP-001,Alice Mwangi,0712345678,Nairobi,Mombasa,small
SHIP-002,Bob Otieno,0798765432,Kisumu,Nairobi,mediumResponse
200 - text/csv
CSV template file — save and open in Excel or Google Sheets
The response is of type string.