> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.usglobalmail.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.usglobalmail.com/_mcp/server.

# Get single shipment

GET https://api.usglobalmail.com/v1/shipments/{id}

Read-only details of one shipment, including its packed mail items

Reference: https://docs.usglobalmail.com/api/api-reference/shipments/get

## Authentication

- `Authorization` header (bearer token, required) — Your API key, sent as `Authorization: Bearer usgmk_live_…` in production or `usgmk_test_…` in the sandbox.

## Servers

- `https://api.usglobalmail.com` (Production, default)
- `https://api-sandbox.usglobalmail.com` (Sandbox)

## Request

### Path parameters

- `id` (string, required)

## Response

### 200

- `id` (string, required) — Shipment id (UUID).
- `type` (enum, required)
  - Allowed values: `shipment`, `return_to_sender`, `check_deposit`, `pickup`
- `status` (enum, required) — Customer-facing status group — `in_progress` covers every internal workflow state between request and shipment.
  - Allowed values: `shipped`, `in_progress`, `payment_failed`, `rejected`
- `item_count` (integer, required) — Number of mail items packed into the request.
- `created_on` (datetime, required) — When the request was made.
- `is_expedited` (boolean, required)
- `is_insured` (boolean, required)
- `declared_value` (double, required) — Total declared customs value of the packed items, in USD.
- `mail_items` (list of ShipmentDetailDtoMailItemsItems, required)
- `tracking_number` (string, optional, nullable) — Carrier tracking number, once the shipment is on its way.
- `service_name` (string, optional, nullable) — Carrier service used (e.g. "FedEx International Priority").
- `destination` (ShipmentDetailDtoDestination, optional, nullable) — Where it ships to. Only present for `shipment` and `check_deposit` types — returns go back to the sender and pickups happen at the facility.
- `requested_ship_date` (datetime, optional, nullable) — The ship-out date the customer asked for.
- `deposit_check_slip_company_name` (string, optional, nullable) — `check_deposit` only.
- `instructions` (string, optional, nullable) — Packing instructions given when the request was made.
- `insured_amount` (double, optional, nullable) — Insured value in USD. Null when the shipment is not insured.
- `reject_reason` (string, optional, nullable) — Why the request was rejected. Null unless `status` is `rejected`.

## Errors

### 400 Bad Request Error

Bad request.

- `type` (string, required)
- `title` (string, required)
- `status` (integer, required)
- `code` (string, required)
- `request_id` (string, required)
- `detail` (string, optional)
- `instance` (string, optional)
- `errors` (list of ProblemDetailsDtoErrorsItems, optional)

### 401 Unauthorized Error

Authentication is required or the API key is invalid.

- `type` (string, required)
- `title` (string, required)
- `status` (integer, required)
- `code` (string, required)
- `request_id` (string, required)
- `detail` (string, optional)
- `instance` (string, optional)
- `errors` (list of ProblemDetailsDtoErrorsItems, optional)

### 403 Forbidden Error

You are not permitted to perform this action.

- `type` (string, required)
- `title` (string, required)
- `status` (integer, required)
- `code` (string, required)
- `request_id` (string, required)
- `detail` (string, optional)
- `instance` (string, optional)
- `errors` (list of ProblemDetailsDtoErrorsItems, optional)

### 404 Not Found Error

Resource not found.

- `type` (string, required)
- `title` (string, required)
- `status` (integer, required)
- `code` (string, required)
- `request_id` (string, required)
- `detail` (string, optional)
- `instance` (string, optional)
- `errors` (list of ProblemDetailsDtoErrorsItems, optional)

### 409 Conflict Error

The request conflicts with the current state of the resource.

- `type` (string, required)
- `title` (string, required)
- `status` (integer, required)
- `code` (string, required)
- `request_id` (string, required)
- `detail` (string, optional)
- `instance` (string, optional)
- `errors` (list of ProblemDetailsDtoErrorsItems, optional)

### 422 Unprocessable Entity Error

Validation failed.

- `type` (string, required)
- `title` (string, required)
- `status` (integer, required)
- `code` (string, required)
- `request_id` (string, required)
- `detail` (string, optional)
- `instance` (string, optional)
- `errors` (list of ProblemDetailsDtoErrorsItems, optional)

### 429 Too Many Requests Error

Rate limit exceeded.

- `type` (string, required)
- `title` (string, required)
- `status` (integer, required)
- `code` (string, required)
- `request_id` (string, required)
- `detail` (string, optional)
- `instance` (string, optional)
- `errors` (list of ProblemDetailsDtoErrorsItems, optional)

### 500 Internal Server Error

Internal error.

- `type` (string, required)
- `title` (string, required)
- `status` (integer, required)
- `code` (string, required)
- `request_id` (string, required)
- `detail` (string, optional)
- `instance` (string, optional)
- `errors` (list of ProblemDetailsDtoErrorsItems, optional)

## Types

### ShipmentDetailDtoMailItemsItems

- `id` (string, required) — Mail item id (numeric string).
- `mail_type` (string, required)
- `sender_name` (string, optional, nullable)
- `arrival_date` (datetime, optional, nullable) — When the item arrived at the facility.
- `envelope_image_url` (string, optional, nullable) — Photo of the item/envelope.

### ShipmentDetailDtoDestination

Where it ships to. Only present for `shipment` and `check_deposit` types — returns go back to the sender and pickups happen at the facility.

- `name` (string, optional, nullable) — Recipient name on the address.
- `line1` (string, optional, nullable)
- `line2` (string, optional, nullable)
- `city` (string, optional, nullable)
- `state` (string, optional, nullable)
- `postal_code` (string, optional, nullable)
- `country` (string, optional, nullable)

### ProblemDetailsDtoErrorsItems

- `field` (string, required)
- `message` (string, required)
- `code` (string, optional)

## Examples

**Request**

```json
{}
```

**Response**

```json
{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "type": "shipment",
  "status": "shipped",
  "item_count": 3,
  "created_on": "2024-04-15T10:15:00Z",
  "is_expedited": true,
  "is_insured": true,
  "declared_value": 300,
  "mail_items": [
    {
      "id": "1023456789",
      "mail_type": "package",
      "sender_name": "Amazon",
      "arrival_date": "2024-04-10T08:30:00Z",
      "envelope_image_url": "https://usglobalmail.com/images/mailitems/1023456789.jpg"
    },
    {
      "id": "1023456790",
      "mail_type": "letter",
      "sender_name": "Bank of America",
      "arrival_date": "2024-04-12T11:45:00Z",
      "envelope_image_url": "https://usglobalmail.com/images/mailitems/1023456790.jpg"
    },
    {
      "id": "1023456791",
      "mail_type": "magazine",
      "sender_name": "National Geographic",
      "arrival_date": "2024-04-13T09:00:00Z",
      "envelope_image_url": null
    }
  ],
  "tracking_number": "9400110898825022579493",
  "service_name": "FedEx International Priority",
  "destination": {
    "name": "John Doe",
    "line1": "123 Maple Street",
    "line2": "Apt 4B",
    "city": "Springfield",
    "state": "IL",
    "postal_code": "62704",
    "country": "US"
  },
  "requested_ship_date": "2024-04-20T14:00:00Z",
  "deposit_check_slip_company_name": null,
  "instructions": "Please handle with care and deliver between 9am-5pm.",
  "insured_amount": 250,
  "reject_reason": null
}
```

**SDK Code**

```python
import requests

url = "https://api.usglobalmail.com/v1/shipments/id"

payload = {}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.json())
```

```javascript
const url = 'https://api.usglobalmail.com/v1/shipments/id';
const options = {
  method: 'GET',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.usglobalmail.com/v1/shipments/id"

	payload := strings.NewReader("{}")

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

	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(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.usglobalmail.com/v1/shipments/id")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{}"

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.usglobalmail.com/v1/shipments/id")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.usglobalmail.com/v1/shipments/id', [
  'body' => '{}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.usglobalmail.com/v1/shipments/id");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = [] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api.usglobalmail.com/v1/shipments/id")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```