| name | flexport-upgrade-migration |
| description | Migrate between Flexport API versions (v1 to v2, Logistics API versions).
Use when upgrading API version headers, handling deprecated endpoints,
or migrating from legacy Flexport API patterns.
Trigger: "upgrade flexport", "flexport API version", "flexport migration".
|
| allowed-tools | Read, Write, Edit, Bash(npm:*), Grep |
| version | 1.6.0 |
| license | MIT |
| author | Jeremy Longshore <jeremy@intentsolutions.io> |
| tags | ["saas","logistics","flexport"] |
| compatibility | Designed for Claude Code |
Flexport Upgrade & Migration
Overview
Guide for migrating between Flexport API versions. The main API uses Flexport-Version header (currently 2). The Logistics API has dated versions (2023-10, 2024-04). Breaking changes are versioned -- old versions remain available during deprecation windows.
Instructions
Step 1: Identify Current API Usage
grep -rn "Flexport-Version\|api.flexport.com\|logistics-api.flexport.com" src/ --include="*.ts" --include="*.py"
grep -rn "Flexport-Version" src/ --include="*.ts"
Step 2: API v1 to v2 Migration
| Change | v1 | v2 |
|---|
| Header | Flexport-Version: 1 | Flexport-Version: 2 |
| Response wrapper | { "_object": "Shipment", ... } | { "data": { ... } } |
| Pagination | { "next": "/shipments?page=2" } | { "data": { "records": [], "total_count": N } } |
| Error format | { "errors": [...] } | { "error": { "code": "...", "message": "..." } } |
| Date format | Mixed | ISO 8601 consistently |
const res = await fetch(`${BASE}/shipments`, { headers: { 'Flexport-Version': '1' } });
const { _object, id, status } = await res.json();
res = (, { : { : } });
{ data } = res.();
data..( .(s., s.));