Skip to Content
FastracDocs
API reference

List couriers

GET
/b2b/courier/all

Returns the couriers you can quote, with branding for your checkout UI. Use code as courierCode in Get shipping rates. A courier is usable only when isOperational is true (the courier is enabled and has at least one enabled service).

Requires the READ_SHIPPING_RATES permission. Results are cached for up to 15 minutes.

Authorization

bearerAuth
headerAuthorizationBearer <token>

An access token from the OAuth2 client-credentials grant. Exchange your API key (client_id + client_secret) at the token endpoint and send Authorization: Bearer <access_token>.

Query Parameters

type?string

Only couriers that offer this type. EXPRESS is accepted as an alias of REGULAR. Case-insensitive.

Value in"INSTANT""REGULAR""EXPRESS"
search?string

Filter by courier name or code.

isEnabled?string

Only enabled (true, 1) or disabled (false, 0) couriers. Omit for both.

Value in"true""false""1""0"

Response Body

Couriers matching the filters.

application/json
  1. response
statusCode*integer
message*string
data*array<>
Example Request
curl -X GET 'https://sandbox-api.fastrac.example/b2b/courier/all'
Example Response
{  "statusCode": 200,  "message": "Couriers retrieved successfully.",  "data": [    {      "code": "JNE",      "name": "JNE",      "isEnabled": true,      "hasEnabledServices": true,      "isOperational": true,      "logoUrl": "https://cdn.fastrac.example/couriers/jne.png",      "logoUrlBw": "https://cdn.fastrac.example/couriers/jne-bw.png",      "logoSquareUrl": "https://cdn.fastrac.example/couriers/jne-square.png",      "bgColor": "#0B3C8C",      "supportedCourierTypes": [        "REGULAR"      ]    },    {      "code": "LALAMOVE",      "name": "Lalamove",      "isEnabled": true,      "hasEnabledServices": true,      "isOperational": true,      "logoUrl": "https://cdn.fastrac.example/couriers/lalamove.png",      "logoUrlBw": null,      "logoSquareUrl": null,      "bgColor": "#F16622",      "supportedCourierTypes": [        "INSTANT"      ]    }  ]}

Was this page helpful?