Create or replay a canonical Merchant shipment
curl --request POST \
--url https://api-test.drop-hub.com/v2/external/shipments \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--data '
{
"externalReference": "<string>",
"branchCode": "<string>",
"pickupLocationCode": "<string>",
"recipient": {
"name": "<string>",
"phone": "<string>",
"alternateContactName": "<string>",
"alternateContactPhone": "<string>"
},
"destination": {
"addressLine": "<string>",
"cityCode": "<string>",
"latitude": 0,
"longitude": 0
},
"declaredValue": 1,
"codAmount": 1,
"currency": "<string>",
"pickupWindowStart": "2023-11-07T05:31:56Z",
"pickupWindowEnd": "2023-11-07T05:31:56Z",
"items": [
{
"description": "<string>",
"quantity": 5000,
"weightKilograms": 123,
"lengthCentimetres": 123,
"widthCentimetres": 123,
"heightCentimetres": 123
}
],
"requirements": [
"<string>"
]
}
'import requests
url = "https://api-test.drop-hub.com/v2/external/shipments"
payload = {
"externalReference": "<string>",
"branchCode": "<string>",
"pickupLocationCode": "<string>",
"recipient": {
"name": "<string>",
"phone": "<string>",
"alternateContactName": "<string>",
"alternateContactPhone": "<string>"
},
"destination": {
"addressLine": "<string>",
"cityCode": "<string>",
"latitude": 0,
"longitude": 0
},
"declaredValue": 1,
"codAmount": 1,
"currency": "<string>",
"pickupWindowStart": "2023-11-07T05:31:56Z",
"pickupWindowEnd": "2023-11-07T05:31:56Z",
"items": [
{
"description": "<string>",
"quantity": 5000,
"weightKilograms": 123,
"lengthCentimetres": 123,
"widthCentimetres": 123,
"heightCentimetres": 123
}
],
"requirements": ["<string>"]
}
headers = {
"Idempotency-Key": "<idempotency-key>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'Idempotency-Key': '<idempotency-key>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
externalReference: '<string>',
branchCode: '<string>',
pickupLocationCode: '<string>',
recipient: {
name: '<string>',
phone: '<string>',
alternateContactName: '<string>',
alternateContactPhone: '<string>'
},
destination: {addressLine: '<string>', cityCode: '<string>', latitude: 0, longitude: 0},
declaredValue: 1,
codAmount: 1,
currency: '<string>',
pickupWindowStart: '2023-11-07T05:31:56Z',
pickupWindowEnd: '2023-11-07T05:31:56Z',
items: [
{
description: '<string>',
quantity: 5000,
weightKilograms: 123,
lengthCentimetres: 123,
widthCentimetres: 123,
heightCentimetres: 123
}
],
requirements: ['<string>']
})
};
fetch('https://api-test.drop-hub.com/v2/external/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://api-test.drop-hub.com/v2/external/shipments",
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([
'externalReference' => '<string>',
'branchCode' => '<string>',
'pickupLocationCode' => '<string>',
'recipient' => [
'name' => '<string>',
'phone' => '<string>',
'alternateContactName' => '<string>',
'alternateContactPhone' => '<string>'
],
'destination' => [
'addressLine' => '<string>',
'cityCode' => '<string>',
'latitude' => 0,
'longitude' => 0
],
'declaredValue' => 1,
'codAmount' => 1,
'currency' => '<string>',
'pickupWindowStart' => '2023-11-07T05:31:56Z',
'pickupWindowEnd' => '2023-11-07T05:31:56Z',
'items' => [
[
'description' => '<string>',
'quantity' => 5000,
'weightKilograms' => 123,
'lengthCentimetres' => 123,
'widthCentimetres' => 123,
'heightCentimetres' => 123
]
],
'requirements' => [
'<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"Idempotency-Key: <idempotency-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://api-test.drop-hub.com/v2/external/shipments"
payload := strings.NewReader("{\n \"externalReference\": \"<string>\",\n \"branchCode\": \"<string>\",\n \"pickupLocationCode\": \"<string>\",\n \"recipient\": {\n \"name\": \"<string>\",\n \"phone\": \"<string>\",\n \"alternateContactName\": \"<string>\",\n \"alternateContactPhone\": \"<string>\"\n },\n \"destination\": {\n \"addressLine\": \"<string>\",\n \"cityCode\": \"<string>\",\n \"latitude\": 0,\n \"longitude\": 0\n },\n \"declaredValue\": 1,\n \"codAmount\": 1,\n \"currency\": \"<string>\",\n \"pickupWindowStart\": \"2023-11-07T05:31:56Z\",\n \"pickupWindowEnd\": \"2023-11-07T05:31:56Z\",\n \"items\": [\n {\n \"description\": \"<string>\",\n \"quantity\": 5000,\n \"weightKilograms\": 123,\n \"lengthCentimetres\": 123,\n \"widthCentimetres\": 123,\n \"heightCentimetres\": 123\n }\n ],\n \"requirements\": [\n \"<string>\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Idempotency-Key", "<idempotency-key>")
req.Header.Add("Authorization", "Bearer <token>")
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://api-test.drop-hub.com/v2/external/shipments")
.header("Idempotency-Key", "<idempotency-key>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"externalReference\": \"<string>\",\n \"branchCode\": \"<string>\",\n \"pickupLocationCode\": \"<string>\",\n \"recipient\": {\n \"name\": \"<string>\",\n \"phone\": \"<string>\",\n \"alternateContactName\": \"<string>\",\n \"alternateContactPhone\": \"<string>\"\n },\n \"destination\": {\n \"addressLine\": \"<string>\",\n \"cityCode\": \"<string>\",\n \"latitude\": 0,\n \"longitude\": 0\n },\n \"declaredValue\": 1,\n \"codAmount\": 1,\n \"currency\": \"<string>\",\n \"pickupWindowStart\": \"2023-11-07T05:31:56Z\",\n \"pickupWindowEnd\": \"2023-11-07T05:31:56Z\",\n \"items\": [\n {\n \"description\": \"<string>\",\n \"quantity\": 5000,\n \"weightKilograms\": 123,\n \"lengthCentimetres\": 123,\n \"widthCentimetres\": 123,\n \"heightCentimetres\": 123\n }\n ],\n \"requirements\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-test.drop-hub.com/v2/external/shipments")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"externalReference\": \"<string>\",\n \"branchCode\": \"<string>\",\n \"pickupLocationCode\": \"<string>\",\n \"recipient\": {\n \"name\": \"<string>\",\n \"phone\": \"<string>\",\n \"alternateContactName\": \"<string>\",\n \"alternateContactPhone\": \"<string>\"\n },\n \"destination\": {\n \"addressLine\": \"<string>\",\n \"cityCode\": \"<string>\",\n \"latitude\": 0,\n \"longitude\": 0\n },\n \"declaredValue\": 1,\n \"codAmount\": 1,\n \"currency\": \"<string>\",\n \"pickupWindowStart\": \"2023-11-07T05:31:56Z\",\n \"pickupWindowEnd\": \"2023-11-07T05:31:56Z\",\n \"items\": [\n {\n \"description\": \"<string>\",\n \"quantity\": 5000,\n \"weightKilograms\": 123,\n \"lengthCentimetres\": 123,\n \"widthCentimetres\": 123,\n \"heightCentimetres\": 123\n }\n ],\n \"requirements\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"shipmentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"shipmentNumber": "<string>",
"externalReference": "<string>",
"state": "PENDING_APPROVAL",
"recipientName": "<string>",
"maskedRecipientPhone": "<string>",
"totalWeightKilograms": 123,
"declaredValue": 123,
"codAmount": 123,
"currency": "<string>",
"paymentMethod": "PREPAID",
"pickupWindowStart": "2023-11-07T05:31:56Z",
"pickupWindowEnd": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"approvedAt": "2023-11-07T05:31:56Z",
"version": 1,
"destination": {
"addressLine": "<string>",
"cityCode": "<string>",
"latitude": 0,
"longitude": 0
},
"pickup": {
"addressLine": "<string>",
"cityCode": "<string>",
"latitude": 0,
"longitude": 0
},
"items": [
{
"description": "<string>",
"quantity": 5000,
"weightKilograms": 123,
"lengthCentimetres": 1,
"widthCentimetres": 1,
"heightCentimetres": 1
}
],
"requirements": [
"<string>"
],
"timelineMedia": [
{
"mediaAssetId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"purpose": "SHIPMENT_CREATION_EVIDENCE",
"sortOrder": 49
}
]
}{
"shipmentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"shipmentNumber": "<string>",
"externalReference": "<string>",
"state": "PENDING_APPROVAL",
"recipientName": "<string>",
"maskedRecipientPhone": "<string>",
"totalWeightKilograms": 123,
"declaredValue": 123,
"codAmount": 123,
"currency": "<string>",
"paymentMethod": "PREPAID",
"pickupWindowStart": "2023-11-07T05:31:56Z",
"pickupWindowEnd": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"approvedAt": "2023-11-07T05:31:56Z",
"version": 1,
"destination": {
"addressLine": "<string>",
"cityCode": "<string>",
"latitude": 0,
"longitude": 0
},
"pickup": {
"addressLine": "<string>",
"cityCode": "<string>",
"latitude": 0,
"longitude": 0
},
"items": [
{
"description": "<string>",
"quantity": 5000,
"weightKilograms": 123,
"lengthCentimetres": 1,
"widthCentimetres": 1,
"heightCentimetres": 1
}
],
"requirements": [
"<string>"
],
"timelineMedia": [
{
"mediaAssetId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"purpose": "SHIPMENT_CREATION_EVIDENCE",
"sortOrder": 49
}
]
}{
"type": "https://api.drop-hub.com/problems/access-denied",
"title": "Access denied",
"status": 403,
"detail": "Access to this resource is denied.",
"instance": "/v2/external/shipments/018f2d8a-1f00-7000-8000-000000000206",
"code": "ACCESS_DENIED",
"timestamp": "2026-08-22T18:30:00Z",
"correlationId": "018f2d8a-1f00-7000-8000-000000000207",
"requestId": "018f2d8a-1f00-7000-8000-000000000208"
}{
"type": "https://api.drop-hub.com/problems/authentication-required",
"title": "Authentication required",
"status": 401,
"detail": "Authentication is required for this resource.",
"instance": "/v2/external/shipments/018f2d8a-1f00-7000-8000-000000000206",
"code": "AUTHENTICATION_REQUIRED",
"timestamp": "2026-08-22T18:30:00Z",
"correlationId": "018f2d8a-1f00-7000-8000-000000000207",
"requestId": "018f2d8a-1f00-7000-8000-000000000208"
}{
"type": "https://api.drop-hub.com/problems/access-denied",
"title": "Access denied",
"status": 403,
"detail": "Access to this resource is denied.",
"instance": "/v2/external/shipments/018f2d8a-1f00-7000-8000-000000000206",
"code": "ACCESS_DENIED",
"timestamp": "2026-08-22T18:30:00Z",
"correlationId": "018f2d8a-1f00-7000-8000-000000000207",
"requestId": "018f2d8a-1f00-7000-8000-000000000208"
}{
"type": "https://api.drop-hub.com/problems/access-denied",
"title": "Access denied",
"status": 403,
"detail": "Access to this resource is denied.",
"instance": "/v2/external/shipments/018f2d8a-1f00-7000-8000-000000000206",
"code": "ACCESS_DENIED",
"timestamp": "2026-08-22T18:30:00Z",
"correlationId": "018f2d8a-1f00-7000-8000-000000000207",
"requestId": "018f2d8a-1f00-7000-8000-000000000208"
}{
"type": "https://api.drop-hub.com/problems/access-denied",
"title": "Access denied",
"status": 403,
"detail": "Access to this resource is denied.",
"instance": "/v2/external/shipments/018f2d8a-1f00-7000-8000-000000000206",
"code": "ACCESS_DENIED",
"timestamp": "2026-08-22T18:30:00Z",
"correlationId": "018f2d8a-1f00-7000-8000-000000000207",
"requestId": "018f2d8a-1f00-7000-8000-000000000208"
}{
"type": "https://api.drop-hub.com/problems/access-denied",
"title": "Access denied",
"status": 403,
"detail": "Access to this resource is denied.",
"instance": "/v2/external/shipments/018f2d8a-1f00-7000-8000-000000000206",
"code": "ACCESS_DENIED",
"timestamp": "2026-08-22T18:30:00Z",
"correlationId": "018f2d8a-1f00-7000-8000-000000000207",
"requestId": "018f2d8a-1f00-7000-8000-000000000208"
}{
"type": "https://api.drop-hub.com/problems/access-denied",
"title": "Access denied",
"status": 403,
"detail": "Access to this resource is denied.",
"instance": "/v2/external/shipments/018f2d8a-1f00-7000-8000-000000000206",
"code": "ACCESS_DENIED",
"timestamp": "2026-08-22T18:30:00Z",
"correlationId": "018f2d8a-1f00-7000-8000-000000000207",
"requestId": "018f2d8a-1f00-7000-8000-000000000208"
}External Shipments
Create or replay a canonical Merchant shipment
Resolves the authoritative route, internally selects an eligible service and driver, and freezes the merchant commercial terms. Carrier identity and scoring are never merchant inputs. externalReference is unique per Merchant company.
POST
/
v2
/
external
/
shipments
Create or replay a canonical Merchant shipment
curl --request POST \
--url https://api-test.drop-hub.com/v2/external/shipments \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--data '
{
"externalReference": "<string>",
"branchCode": "<string>",
"pickupLocationCode": "<string>",
"recipient": {
"name": "<string>",
"phone": "<string>",
"alternateContactName": "<string>",
"alternateContactPhone": "<string>"
},
"destination": {
"addressLine": "<string>",
"cityCode": "<string>",
"latitude": 0,
"longitude": 0
},
"declaredValue": 1,
"codAmount": 1,
"currency": "<string>",
"pickupWindowStart": "2023-11-07T05:31:56Z",
"pickupWindowEnd": "2023-11-07T05:31:56Z",
"items": [
{
"description": "<string>",
"quantity": 5000,
"weightKilograms": 123,
"lengthCentimetres": 123,
"widthCentimetres": 123,
"heightCentimetres": 123
}
],
"requirements": [
"<string>"
]
}
'import requests
url = "https://api-test.drop-hub.com/v2/external/shipments"
payload = {
"externalReference": "<string>",
"branchCode": "<string>",
"pickupLocationCode": "<string>",
"recipient": {
"name": "<string>",
"phone": "<string>",
"alternateContactName": "<string>",
"alternateContactPhone": "<string>"
},
"destination": {
"addressLine": "<string>",
"cityCode": "<string>",
"latitude": 0,
"longitude": 0
},
"declaredValue": 1,
"codAmount": 1,
"currency": "<string>",
"pickupWindowStart": "2023-11-07T05:31:56Z",
"pickupWindowEnd": "2023-11-07T05:31:56Z",
"items": [
{
"description": "<string>",
"quantity": 5000,
"weightKilograms": 123,
"lengthCentimetres": 123,
"widthCentimetres": 123,
"heightCentimetres": 123
}
],
"requirements": ["<string>"]
}
headers = {
"Idempotency-Key": "<idempotency-key>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'Idempotency-Key': '<idempotency-key>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
externalReference: '<string>',
branchCode: '<string>',
pickupLocationCode: '<string>',
recipient: {
name: '<string>',
phone: '<string>',
alternateContactName: '<string>',
alternateContactPhone: '<string>'
},
destination: {addressLine: '<string>', cityCode: '<string>', latitude: 0, longitude: 0},
declaredValue: 1,
codAmount: 1,
currency: '<string>',
pickupWindowStart: '2023-11-07T05:31:56Z',
pickupWindowEnd: '2023-11-07T05:31:56Z',
items: [
{
description: '<string>',
quantity: 5000,
weightKilograms: 123,
lengthCentimetres: 123,
widthCentimetres: 123,
heightCentimetres: 123
}
],
requirements: ['<string>']
})
};
fetch('https://api-test.drop-hub.com/v2/external/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://api-test.drop-hub.com/v2/external/shipments",
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([
'externalReference' => '<string>',
'branchCode' => '<string>',
'pickupLocationCode' => '<string>',
'recipient' => [
'name' => '<string>',
'phone' => '<string>',
'alternateContactName' => '<string>',
'alternateContactPhone' => '<string>'
],
'destination' => [
'addressLine' => '<string>',
'cityCode' => '<string>',
'latitude' => 0,
'longitude' => 0
],
'declaredValue' => 1,
'codAmount' => 1,
'currency' => '<string>',
'pickupWindowStart' => '2023-11-07T05:31:56Z',
'pickupWindowEnd' => '2023-11-07T05:31:56Z',
'items' => [
[
'description' => '<string>',
'quantity' => 5000,
'weightKilograms' => 123,
'lengthCentimetres' => 123,
'widthCentimetres' => 123,
'heightCentimetres' => 123
]
],
'requirements' => [
'<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"Idempotency-Key: <idempotency-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://api-test.drop-hub.com/v2/external/shipments"
payload := strings.NewReader("{\n \"externalReference\": \"<string>\",\n \"branchCode\": \"<string>\",\n \"pickupLocationCode\": \"<string>\",\n \"recipient\": {\n \"name\": \"<string>\",\n \"phone\": \"<string>\",\n \"alternateContactName\": \"<string>\",\n \"alternateContactPhone\": \"<string>\"\n },\n \"destination\": {\n \"addressLine\": \"<string>\",\n \"cityCode\": \"<string>\",\n \"latitude\": 0,\n \"longitude\": 0\n },\n \"declaredValue\": 1,\n \"codAmount\": 1,\n \"currency\": \"<string>\",\n \"pickupWindowStart\": \"2023-11-07T05:31:56Z\",\n \"pickupWindowEnd\": \"2023-11-07T05:31:56Z\",\n \"items\": [\n {\n \"description\": \"<string>\",\n \"quantity\": 5000,\n \"weightKilograms\": 123,\n \"lengthCentimetres\": 123,\n \"widthCentimetres\": 123,\n \"heightCentimetres\": 123\n }\n ],\n \"requirements\": [\n \"<string>\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Idempotency-Key", "<idempotency-key>")
req.Header.Add("Authorization", "Bearer <token>")
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://api-test.drop-hub.com/v2/external/shipments")
.header("Idempotency-Key", "<idempotency-key>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"externalReference\": \"<string>\",\n \"branchCode\": \"<string>\",\n \"pickupLocationCode\": \"<string>\",\n \"recipient\": {\n \"name\": \"<string>\",\n \"phone\": \"<string>\",\n \"alternateContactName\": \"<string>\",\n \"alternateContactPhone\": \"<string>\"\n },\n \"destination\": {\n \"addressLine\": \"<string>\",\n \"cityCode\": \"<string>\",\n \"latitude\": 0,\n \"longitude\": 0\n },\n \"declaredValue\": 1,\n \"codAmount\": 1,\n \"currency\": \"<string>\",\n \"pickupWindowStart\": \"2023-11-07T05:31:56Z\",\n \"pickupWindowEnd\": \"2023-11-07T05:31:56Z\",\n \"items\": [\n {\n \"description\": \"<string>\",\n \"quantity\": 5000,\n \"weightKilograms\": 123,\n \"lengthCentimetres\": 123,\n \"widthCentimetres\": 123,\n \"heightCentimetres\": 123\n }\n ],\n \"requirements\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-test.drop-hub.com/v2/external/shipments")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"externalReference\": \"<string>\",\n \"branchCode\": \"<string>\",\n \"pickupLocationCode\": \"<string>\",\n \"recipient\": {\n \"name\": \"<string>\",\n \"phone\": \"<string>\",\n \"alternateContactName\": \"<string>\",\n \"alternateContactPhone\": \"<string>\"\n },\n \"destination\": {\n \"addressLine\": \"<string>\",\n \"cityCode\": \"<string>\",\n \"latitude\": 0,\n \"longitude\": 0\n },\n \"declaredValue\": 1,\n \"codAmount\": 1,\n \"currency\": \"<string>\",\n \"pickupWindowStart\": \"2023-11-07T05:31:56Z\",\n \"pickupWindowEnd\": \"2023-11-07T05:31:56Z\",\n \"items\": [\n {\n \"description\": \"<string>\",\n \"quantity\": 5000,\n \"weightKilograms\": 123,\n \"lengthCentimetres\": 123,\n \"widthCentimetres\": 123,\n \"heightCentimetres\": 123\n }\n ],\n \"requirements\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"shipmentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"shipmentNumber": "<string>",
"externalReference": "<string>",
"state": "PENDING_APPROVAL",
"recipientName": "<string>",
"maskedRecipientPhone": "<string>",
"totalWeightKilograms": 123,
"declaredValue": 123,
"codAmount": 123,
"currency": "<string>",
"paymentMethod": "PREPAID",
"pickupWindowStart": "2023-11-07T05:31:56Z",
"pickupWindowEnd": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"approvedAt": "2023-11-07T05:31:56Z",
"version": 1,
"destination": {
"addressLine": "<string>",
"cityCode": "<string>",
"latitude": 0,
"longitude": 0
},
"pickup": {
"addressLine": "<string>",
"cityCode": "<string>",
"latitude": 0,
"longitude": 0
},
"items": [
{
"description": "<string>",
"quantity": 5000,
"weightKilograms": 123,
"lengthCentimetres": 1,
"widthCentimetres": 1,
"heightCentimetres": 1
}
],
"requirements": [
"<string>"
],
"timelineMedia": [
{
"mediaAssetId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"purpose": "SHIPMENT_CREATION_EVIDENCE",
"sortOrder": 49
}
]
}{
"shipmentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"shipmentNumber": "<string>",
"externalReference": "<string>",
"state": "PENDING_APPROVAL",
"recipientName": "<string>",
"maskedRecipientPhone": "<string>",
"totalWeightKilograms": 123,
"declaredValue": 123,
"codAmount": 123,
"currency": "<string>",
"paymentMethod": "PREPAID",
"pickupWindowStart": "2023-11-07T05:31:56Z",
"pickupWindowEnd": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"approvedAt": "2023-11-07T05:31:56Z",
"version": 1,
"destination": {
"addressLine": "<string>",
"cityCode": "<string>",
"latitude": 0,
"longitude": 0
},
"pickup": {
"addressLine": "<string>",
"cityCode": "<string>",
"latitude": 0,
"longitude": 0
},
"items": [
{
"description": "<string>",
"quantity": 5000,
"weightKilograms": 123,
"lengthCentimetres": 1,
"widthCentimetres": 1,
"heightCentimetres": 1
}
],
"requirements": [
"<string>"
],
"timelineMedia": [
{
"mediaAssetId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"purpose": "SHIPMENT_CREATION_EVIDENCE",
"sortOrder": 49
}
]
}{
"type": "https://api.drop-hub.com/problems/access-denied",
"title": "Access denied",
"status": 403,
"detail": "Access to this resource is denied.",
"instance": "/v2/external/shipments/018f2d8a-1f00-7000-8000-000000000206",
"code": "ACCESS_DENIED",
"timestamp": "2026-08-22T18:30:00Z",
"correlationId": "018f2d8a-1f00-7000-8000-000000000207",
"requestId": "018f2d8a-1f00-7000-8000-000000000208"
}{
"type": "https://api.drop-hub.com/problems/authentication-required",
"title": "Authentication required",
"status": 401,
"detail": "Authentication is required for this resource.",
"instance": "/v2/external/shipments/018f2d8a-1f00-7000-8000-000000000206",
"code": "AUTHENTICATION_REQUIRED",
"timestamp": "2026-08-22T18:30:00Z",
"correlationId": "018f2d8a-1f00-7000-8000-000000000207",
"requestId": "018f2d8a-1f00-7000-8000-000000000208"
}{
"type": "https://api.drop-hub.com/problems/access-denied",
"title": "Access denied",
"status": 403,
"detail": "Access to this resource is denied.",
"instance": "/v2/external/shipments/018f2d8a-1f00-7000-8000-000000000206",
"code": "ACCESS_DENIED",
"timestamp": "2026-08-22T18:30:00Z",
"correlationId": "018f2d8a-1f00-7000-8000-000000000207",
"requestId": "018f2d8a-1f00-7000-8000-000000000208"
}{
"type": "https://api.drop-hub.com/problems/access-denied",
"title": "Access denied",
"status": 403,
"detail": "Access to this resource is denied.",
"instance": "/v2/external/shipments/018f2d8a-1f00-7000-8000-000000000206",
"code": "ACCESS_DENIED",
"timestamp": "2026-08-22T18:30:00Z",
"correlationId": "018f2d8a-1f00-7000-8000-000000000207",
"requestId": "018f2d8a-1f00-7000-8000-000000000208"
}{
"type": "https://api.drop-hub.com/problems/access-denied",
"title": "Access denied",
"status": 403,
"detail": "Access to this resource is denied.",
"instance": "/v2/external/shipments/018f2d8a-1f00-7000-8000-000000000206",
"code": "ACCESS_DENIED",
"timestamp": "2026-08-22T18:30:00Z",
"correlationId": "018f2d8a-1f00-7000-8000-000000000207",
"requestId": "018f2d8a-1f00-7000-8000-000000000208"
}{
"type": "https://api.drop-hub.com/problems/access-denied",
"title": "Access denied",
"status": 403,
"detail": "Access to this resource is denied.",
"instance": "/v2/external/shipments/018f2d8a-1f00-7000-8000-000000000206",
"code": "ACCESS_DENIED",
"timestamp": "2026-08-22T18:30:00Z",
"correlationId": "018f2d8a-1f00-7000-8000-000000000207",
"requestId": "018f2d8a-1f00-7000-8000-000000000208"
}{
"type": "https://api.drop-hub.com/problems/access-denied",
"title": "Access denied",
"status": 403,
"detail": "Access to this resource is denied.",
"instance": "/v2/external/shipments/018f2d8a-1f00-7000-8000-000000000206",
"code": "ACCESS_DENIED",
"timestamp": "2026-08-22T18:30:00Z",
"correlationId": "018f2d8a-1f00-7000-8000-000000000207",
"requestId": "018f2d8a-1f00-7000-8000-000000000208"
}Authorizations
OAuth 2.0 client-credentials flow for external machine-to-machine integrations.
Headers
Preferred response language when a localized representation is available.
Maximum string length:
64Example:
"en"
Caller-generated key scoped by the operation, Merchant company, and OAuth client; an exact replay returns the original result.
Required string length:
16 - 128Example:
"merchant-order-20260822-0001"
Body
application/json
Required string length:
1 - 128Pattern:
^[A-Z0-9][A-Z0-9_-]{1,63}$Pattern:
^[A-Z0-9][A-Z0-9_-]{1,63}$Show child attributes
Show child attributes
Show child attributes
Show child attributes
Required range:
x >= 0Required range:
x >= 0Required string length:
3Pattern:
^[A-Z]{3}$Available options:
PREPAID, COD Required array length:
1 - 100 elementsShow child attributes
Show child attributes
Maximum array length:
20Pattern:
^[A-Z][A-Z0-9_]{1,47}$Response
Merchant-safe canonical shipment
Maximum string length:
128Available options:
PENDING_APPROVAL, READY_FOR_DISPATCH, OFFERED, ACCEPTED, DISPATCH_UNRESOLVED, PICKED_UP, OUT_FOR_DELIVERY, DELIVERED, DELIVERY_FAILED, CANCELLED Only the final four digits are visible.
Available options:
PREPAID, COD Required range:
x >= 0Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Existing READY assets attached only to the resulting shipment.created event.
Maximum array length:
10Show child attributes
Show child attributes
⌘I