Get external merchant shipment

curl --request GET \
  --url https://api-test.drop-hub.com/v2/external/shipments/{shipmentId} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api-test.drop-hub.com/v2/external/shipments/{shipmentId}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api-test.drop-hub.com/v2/external/shipments/{shipmentId}', 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/{shipmentId}",
  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: Bearer <token>"
  ],
]);

$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://api-test.drop-hub.com/v2/external/shipments/{shipmentId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api-test.drop-hub.com/v2/external/shipments/{shipmentId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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
    }
  ]
}

{
  "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"
}

GET

external

shipments

{shipmentId}

Get external merchant shipment

curl --request GET \
  --url https://api-test.drop-hub.com/v2/external/shipments/{shipmentId} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api-test.drop-hub.com/v2/external/shipments/{shipmentId}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api-test.drop-hub.com/v2/external/shipments/{shipmentId}', 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/{shipmentId}",
  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: Bearer <token>"
  ],
]);

$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://api-test.drop-hub.com/v2/external/shipments/{shipmentId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api-test.drop-hub.com/v2/external/shipments/{shipmentId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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
    }
  ]
}

{
  "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"
}

Authorizations

Authorization

string

header

required

OAuth 2.0 client-credentials flow for external machine-to-machine integrations.

Headers

Accept-Language

string

Preferred response language when a localized representation is available.

Maximum string length: 64

Example:

"en"

Path Parameters

shipmentId

string<uuid>

required

Response

Merchant-safe canonical shipment

shipmentId

string<uuid>

required

shipmentNumber

string

required

externalReference

string | null

required

Maximum string length: 128

state

enum<string>

required

Available options:

PENDING_APPROVAL,

READY_FOR_DISPATCH,

OFFERED,

ACCEPTED,

DISPATCH_UNRESOLVED,

PICKED_UP,

OUT_FOR_DELIVERY,

DELIVERED,

DELIVERY_FAILED,

CANCELLED

recipientName

string

required

maskedRecipientPhone

string

required

Only the final four digits are visible.

totalWeightKilograms

number

required

declaredValue

number

required

codAmount

number

required

currency

string

required

paymentMethod

enum<string>

required

Available options:

PREPAID,

COD

pickupWindowStart

string<date-time>

required

pickupWindowEnd

string<date-time>

required

createdAt

string<date-time>

required

approvedAt

string<date-time> | null

required

version

integer<int64>

required

Required range: x >= 0

destination

object

required

Show child attributes

pickup

object | null

required

Show child attributes

items

object[]

required

Show child attributes

requirements

string[]

required

timelineMedia

object[]

Existing READY assets attached only to the resulting shipment.created event.

Maximum array length: 10

Show child attributes

⌘I

Getting Started

Authentication

Shipments

Events

Request semantics

API reference

Get external merchant shipment

Authorizations

Headers

Path Parameters

Response