Order shipments
curl --request GET \
--url https://partners.dekhq.com/api/partners/v1/orders/shipments \
--header 'Authorization: Basic <encoded-value>'import requests
url = "https://partners.dekhq.com/api/partners/v1/orders/shipments"
headers = {"Authorization": "Basic <encoded-value>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};
fetch('https://partners.dekhq.com/api/partners/v1/orders/shipments', 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://partners.dekhq.com/api/partners/v1/orders/shipments",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>"
],
]);
$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://partners.dekhq.com/api/partners/v1/orders/shipments"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Basic <encoded-value>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://partners.dekhq.com/api/partners/v1/orders/shipments")
.header("Authorization", "Basic <encoded-value>")
.asString();require 'uri'
require 'net/http'
url = URI("https://partners.dekhq.com/api/partners/v1/orders/shipments")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic <encoded-value>'
response = http.request(request)
puts response.read_body{
"shipments": [
{
"purchaseOrderNumber": "PO-10042",
"complete": true,
"salesOrders": [
{
"salesOrderNumber": "SO-58817",
"complete": true,
"locations": [
{
"id": 1,
"complete": true,
"shipFromAddress": {
"address1": "100 Example Ave",
"city": "Springfield",
"region": "IL",
"postalCode": "62701",
"country": "US"
},
"shipToAddress": {
"address1": "200 Sample St",
"address2": "Suite 300",
"city": "Riverton",
"region": "WY",
"postalCode": "82501",
"country": "US"
},
"packages": [
{
"id": 1,
"trackingNumber": "1Z999AA10123456784",
"shipmentDate": "2026-02-12T18:00:00Z",
"carrier": "UPS",
"shipmentMethod": "Ground",
"weight": 12.5,
"weightUOM": "Pounds"
}
]
}
]
}
]
}
]
}{
"error": "Invalid id or password"
}{
"error": "Credential not permitted for scope: order_status"
}{
"error": "Rate limit exceeded"
}{
"error": "Internal error"
}API Reference
Order shipments
Shipments for your orders, with addresses and package tracking. Only orders for the clients your credential is linked to. At most 5,000 orders.
GET
/
api
/
partners
/
v1
/
orders
/
shipments
Order shipments
curl --request GET \
--url https://partners.dekhq.com/api/partners/v1/orders/shipments \
--header 'Authorization: Basic <encoded-value>'import requests
url = "https://partners.dekhq.com/api/partners/v1/orders/shipments"
headers = {"Authorization": "Basic <encoded-value>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};
fetch('https://partners.dekhq.com/api/partners/v1/orders/shipments', 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://partners.dekhq.com/api/partners/v1/orders/shipments",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>"
],
]);
$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://partners.dekhq.com/api/partners/v1/orders/shipments"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Basic <encoded-value>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://partners.dekhq.com/api/partners/v1/orders/shipments")
.header("Authorization", "Basic <encoded-value>")
.asString();require 'uri'
require 'net/http'
url = URI("https://partners.dekhq.com/api/partners/v1/orders/shipments")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic <encoded-value>'
response = http.request(request)
puts response.read_body{
"shipments": [
{
"purchaseOrderNumber": "PO-10042",
"complete": true,
"salesOrders": [
{
"salesOrderNumber": "SO-58817",
"complete": true,
"locations": [
{
"id": 1,
"complete": true,
"shipFromAddress": {
"address1": "100 Example Ave",
"city": "Springfield",
"region": "IL",
"postalCode": "62701",
"country": "US"
},
"shipToAddress": {
"address1": "200 Sample St",
"address2": "Suite 300",
"city": "Riverton",
"region": "WY",
"postalCode": "82501",
"country": "US"
},
"packages": [
{
"id": 1,
"trackingNumber": "1Z999AA10123456784",
"shipmentDate": "2026-02-12T18:00:00Z",
"carrier": "UPS",
"shipmentMethod": "Ground",
"weight": 12.5,
"weightUOM": "Pounds"
}
]
}
]
}
]
}
]
}{
"error": "Invalid id or password"
}{
"error": "Credential not permitted for scope: order_status"
}{
"error": "Rate limit exceeded"
}{
"error": "Internal error"
}Authorizations
Your DEKHQ partner id and password.
Query Parameters
1 = PO number, 2 = sales order number, 3 = shipped since shipmentDateTimeStamp. Other values return an empty list.
Available options:
1, 2, 3 PO number (queryType 1) or sales order number (queryType 2).
ISO 8601 time; queryType 3 returns shipments since then.
Response
Matching shipments.
Show child attributes
Show child attributes