ApiParcels
Compare carrier accounts for a destination (coverage + fees + recommend cheapest)
AuthorizationBearer <token>
Project API key, fc_live_…. Keep keys out of public client code. The trusted Cloud playground accepts credentials temporarily in memory.
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
curl -X POST "https://example.com/carrier-accounts/quotes" \ -H "Content-Type: application/json" \ -d '{ "state": "string", "deliveryType": "home" }'{ "data": { "destination": { "stateCode": "string", "cityName": "string", "resolved": { "method": "string", "confidence": 0, "autoAccept": true, "alternatives": [ { "stateCode": "string", "cityName": "string", "score": 0 } ] } }, "quotes": [ { "accountId": "string", "courierId": "string", "provider": "string", "name": "string", "available": true, "reason": "unresolvable_geo", "amount": 0, "matched": "city", "fees": { "stopdesk": 0, "home": 0, "return": 0, "exchange": 0 }, "suggestedPickupId": "string", "suggestedDestinations": [ { "stateCode": "string", "cityName": "string", "distanceKm": 0, "pickupId": "string" } ], "capabilities": { "create": true, "cancel": true, "edit": true, "labels": true, "webhooks": true, "validate": true, "autoValidates": true, "canOpenPackage": true, "canExchange": true, "remarks": true, "requestReturn": true, "requestNewAttempt": true } } ], "recommended": { "accountId": "string", "amount": 0, "suggestedPickupId": "string" } }}Resolve one destination across every carrier account in a single call POST
Prices one address against all connected carriers at once. Prefer this over calling the per-account resolve in a loop: it answers in two queries and one metered request regardless of how many accounts a project has.
Resolve home/stopdesk fee for a destination (city → state → flat defaults) GET
Next Page