List All Shipping Agencies — Ship Quote API Reference

This endpoint returns every agency record stored in the database, regardless of activation state. It is the primary way to inspect which carriers are configured, review their capability rules, and confirm that apiConfig and supplements are set correctly before running a rate comparison.

The rate comparison engine (POST /api/v1/rates/compareByPostalCode) automatically considers only active agencies. This listing endpoint intentionally returns all agencies — including inactive ones — so you can audit the full set without a separate lookup.

Endpoint

GET /api/v1/agencies

Response

A successful request returns HTTP 200 OK with a JSON array of agency objects. Each item in the array has the same shape as the object returned by POST /api/v1/agencies.

[]

array

Array of agency objects.

Show Agency object fields

string

MongoDB ObjectId of the agency.

name

string

Title-cased human-readable agency name (e.g. "Dachser", "Mrw").

code

string

Normalised slug derived from name (e.g. "dachser", "mrw"). Unique across all agencies.

type

string

Rate sourcing strategy: "static", "api", or "hybrid".

active

boolean

true if the agency is included in rate comparison results.

rules

object

Routing and capability rules for the agency.

Show rules fields

hasAndaluciaRule

boolean

Whether special Andalusia pricing is applied.

supportsPallets

boolean

Whether the agency handles pallet shipments.

supportsParcels

boolean

Whether the agency handles parcel shipments.

coverage

array of strings

Geographic scope: ["national"], ["international"], or ["national", "international"].

supplements

object

Pricing supplements applied on top of the base rate.

Show supplements.fuelSurcharge fields

fuelSurcharge.enabled

boolean

Whether the fuel surcharge is active.

fuelSurcharge.type

string

"percentage" or "fixed".

fuelSurcharge.value

number

Surcharge amount (percentage points or fixed euro value).

apiConfig

object

Carrier API connection details. Present on "api" and "hybrid" agencies.

Show apiConfig fields

baseUrlApi

string

Base URL of the carrier’s external API.

timeout

number

Request timeout in milliseconds.

apiKey

string

Authentication key for the carrier API.

endpoints

object

Show endpoints fields

quotations

string

Path for quotation requests.

transportOrders

string

Path for transport order creation.

createdAt

string

ISO 8601 creation timestamp.

updatedAt

string

ISO 8601 last-update timestamp.

Examples

The request below retrieves every configured agency, including those that have been deactivated.

curl -X GET "http://localhost:3000/api/v1/agencies"

Error Responses

404 Not Found

object

Returned when no agency documents exist in the database.

{
  "message": "Agencies not found"
}

500 Internal Server Error

object

Returned on unexpected database or server errors.

{
  "message": "Error internal server"
}

Rates

Agencies

Locations

Pallets & Zones

List All Shipping Agencies — Ship Quote API Reference

Endpoint

Response

Examples

Error Responses

Build docs developers (and LLMs) love

Rates

Agencies

Locations

Pallets & Zones

Documentation Index

​Endpoint

​Response

​Examples

​Error Responses

Build docs developers (and LLMs) love

Endpoint

Response

Examples

Error Responses