Retrieve a shipment
curl --request GET \
--url https://portal.urbnbox.io/api/partner/v1/shipments/{id} \
--header 'X-API-Key: <api-key>'import requests
url = "https://portal.urbnbox.io/api/partner/v1/shipments/{id}"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://portal.urbnbox.io/api/partner/v1/shipments/{id}', 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/shipments/{id}",
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-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://portal.urbnbox.io/api/partner/v1/shipments/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-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://portal.urbnbox.io/api/partner/v1/shipments/{id}")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://portal.urbnbox.io/api/partner/v1/shipments/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"id": "<string>",
"tracking_token": "<string>",
"tracking_url": "<string>",
"status": "<string>",
"origin_locker": {
"name": "<string>",
"city": "<string>",
"address": "<string>"
},
"destination_locker": {
"name": "<string>",
"city": "<string>",
"address": "<string>"
},
"fee_breakdown": {
"origin_locker_fee_kes": 123,
"destination_locker_fee_kes": 123,
"transit_rider_fee_kes": 123,
"platform_fee_kes": 123,
"total_kes": 123
}
}<string><string><string><string>Pickup-point shipments (Partner API)
Retrieve a shipment
Returns a shipment owned by the authenticated partner.
GET
/
api
/
partner
/
v1
/
shipments
/
{id}
Retrieve a shipment
curl --request GET \
--url https://portal.urbnbox.io/api/partner/v1/shipments/{id} \
--header 'X-API-Key: <api-key>'import requests
url = "https://portal.urbnbox.io/api/partner/v1/shipments/{id}"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://portal.urbnbox.io/api/partner/v1/shipments/{id}', 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/shipments/{id}",
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-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://portal.urbnbox.io/api/partner/v1/shipments/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-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://portal.urbnbox.io/api/partner/v1/shipments/{id}")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://portal.urbnbox.io/api/partner/v1/shipments/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"id": "<string>",
"tracking_token": "<string>",
"tracking_url": "<string>",
"status": "<string>",
"origin_locker": {
"name": "<string>",
"city": "<string>",
"address": "<string>"
},
"destination_locker": {
"name": "<string>",
"city": "<string>",
"address": "<string>"
},
"fee_breakdown": {
"origin_locker_fee_kes": 123,
"destination_locker_fee_kes": 123,
"transit_rider_fee_kes": 123,
"platform_fee_kes": 123,
"total_kes": 123
}
}<string><string><string><string>Authorizations
Partner key. Shipment creation requires a secret key.
Path Parameters
Shipment ID returned during creation.