Couriers & Locations
List Couriers
Returns the list of active couriers, with each courier's COD support and shipping methods (sender_types).
GET /courier/v1/couriers
Example Request
- cURL
- JavaScript
- Python
curl -X GET 'https://use.api.co.id/courier/v1/couriers' \
-H 'x-api-co-id: YOUR_API_KEY'
const res = await fetch('https://use.api.co.id/courier/v1/couriers', {
method: 'GET',
headers: {
'x-api-co-id': 'YOUR_API_KEY',
},
});
const data = await res.json();
import requests
res = requests.get(
"https://use.api.co.id/courier/v1/couriers",
headers={"x-api-co-id": "YOUR_API_KEY"},
)
data = res.json()
Example Response
{
"is_success": true,
"message": "OK",
"data": [
{ "code": "ninja", "name": "Ninja Xpress", "logo": "https://use.api.co.id/assets/couriers/ninja.png", "cod": false, "sender_types": ["picked up"] },
{ "code": "sicepat", "name": "Sicepat Express", "logo": "https://use.api.co.id/assets/couriers/sicepat.png", "cod": true, "sender_types": ["dropped", "picked up"] }
]
}
Provinces
Lists all provinces.
GET /courier/v1/locations/provinces
Example Request
- cURL
- JavaScript
- Python
curl -X GET 'https://use.api.co.id/courier/v1/locations/provinces' \
-H 'x-api-co-id: YOUR_API_KEY'
const res = await fetch('https://use.api.co.id/courier/v1/locations/provinces', {
method: 'GET',
headers: {
'x-api-co-id': 'YOUR_API_KEY',
},
});
const data = await res.json();
import requests
res = requests.get(
"https://use.api.co.id/courier/v1/locations/provinces",
headers={"x-api-co-id": "YOUR_API_KEY"},
)
data = res.json()
Example Response
{
"is_success": true,
"message": "OK",
"data": [
{ "code": "33", "name": "Jawa Tengah" }
]
}
Cities / Regencies
Lists the cities/regencies in a province.
GET /courier/v1/locations/cities
Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
province | string | yes | Province code. |
Example Request
- cURL
- JavaScript
- Python
curl -X GET 'https://use.api.co.id/courier/v1/locations/cities?province=33' \
-H 'x-api-co-id: YOUR_API_KEY'
const res = await fetch('https://use.api.co.id/courier/v1/locations/cities?province=33', {
method: 'GET',
headers: {
'x-api-co-id': 'YOUR_API_KEY',
},
});
const data = await res.json();
import requests
res = requests.get(
"https://use.api.co.id/courier/v1/locations/cities",
params={"province":"33"},
headers={"x-api-co-id": "YOUR_API_KEY"},
)
data = res.json()
Example Response
{
"is_success": true,
"message": "OK",
"data": [
{ "code": "3374", "name": "Kota Semarang" }
]
}
Districts
Lists the districts in a city/regency. The code here is what you use for origin_district_code / destination_district_code in Shipping Rates.
GET /courier/v1/locations/districts
Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
city | string | yes | City/regency code. |
Example Request
- cURL
- JavaScript
- Python
curl -X GET 'https://use.api.co.id/courier/v1/locations/districts?city=3374' \
-H 'x-api-co-id: YOUR_API_KEY'
const res = await fetch('https://use.api.co.id/courier/v1/locations/districts?city=3374', {
method: 'GET',
headers: {
'x-api-co-id': 'YOUR_API_KEY',
},
});
const data = await res.json();
import requests
res = requests.get(
"https://use.api.co.id/courier/v1/locations/districts",
params={"city":"3374"},
headers={"x-api-co-id": "YOUR_API_KEY"},
)
data = res.json()
Example Response
{
"is_success": true,
"message": "OK",
"data": [
{ "code": "3374010", "name": "Semarang Tengah" }
]
}
Try it out
- GET/courier/v1/couriersList Couriers
- GET/courier/v1/locations/provincesProvinces
- GET/courier/v1/locations/citiesCities / Regencies
- GET/courier/v1/locations/districtsDistricts
Was this page helpful?