Addresses

List Addresses

Lists the sender addresses saved to the account.

GET /courier/v1/addresses

Example Request

cURL

curl -X GET 'https://use.api.co.id/courier/v1/addresses' \
  -H 'x-api-co-id: YOUR_API_KEY'

JavaScript

const res = await fetch('https://use.api.co.id/courier/v1/addresses', {
  method: 'GET',
  headers: {
    'x-api-co-id': 'YOUR_API_KEY',
  },
});
const data = await res.json();

Python

import requests

res = requests.get(
    "https://use.api.co.id/courier/v1/addresses",
    headers={"x-api-co-id": "YOUR_API_KEY"},
)
data = res.json()

Example Response

{
  "is_success": true,
  "message": "OK",
  "data": [
    {
      "id": "adr_7b1c",
      "label": "Gudang Utama",
      "contact_name": "Budi",
      "contact_phone": "0899...",
      "province_code": "33",
      "city_code": "3374",
      "district_code": "3374010",
      "address_line": "Jl. Pemuda No. 1",
      "postal_code": "50139",
      "is_default": true
    }
  ]
}

Create Address

Saves a new sender address. The address can be used as sender_address_id in Shipping Rates and orders.

POST /courier/v1/addresses

Request Body

Parameter	Type	Required	Description
label	string	yes	Address name, e.g. "Gudang Utama".
contact_name	string	yes	Sender contact name.
contact_phone	string	yes	Sender phone number.
province_code	string	yes	Province code.
city_code	string	yes	City/regency code.
district_code	string	yes	District code (must be served by a courier).
address_line	string	yes	Full address.
postal_code	string	no	Postal code.
is_default	boolean	no	Set as the default address.

Example Request

cURL

curl -X POST 'https://use.api.co.id/courier/v1/addresses' \
  -H 'x-api-co-id: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "label": "Gudang Utama",
    "contact_name": "Budi",
    "contact_phone": "08990000000",
    "province_code": "33",
    "city_code": "3374",
    "district_code": "3374010",
    "address_line": "Jl. Pemuda No. 1",
    "postal_code": "50139",
    "is_default": true
}'

JavaScript

const res = await fetch('https://use.api.co.id/courier/v1/addresses', {
  method: 'POST',
  headers: {
    'x-api-co-id': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "label": "Gudang Utama",
    "contact_name": "Budi",
    "contact_phone": "08990000000",
    "province_code": "33",
    "city_code": "3374",
    "district_code": "3374010",
    "address_line": "Jl. Pemuda No. 1",
    "postal_code": "50139",
    "is_default": true
}),
});
const data = await res.json();

Python

import requests

res = requests.post(
    "https://use.api.co.id/courier/v1/addresses",
    json={"label":"Gudang Utama","contact_name":"Budi","contact_phone":"08990000000","province_code":"33","city_code":"3374","district_code":"3374010","address_line":"Jl. Pemuda No. 1","postal_code":"50139","is_default":true},
    headers={"x-api-co-id": "YOUR_API_KEY"},
)
data = res.json()

Example Response

{
  "is_success": true,
  "message": "Alamat berhasil dibuat.",
  "data": { "id": "adr_7b1c" }
}

Try it out

tip

Use your sandbox Test Key to try these endpoints without creating real shipments or charges. See Sandbox.

• GET/courier/v1/addressesList Addresses
• POST/courier/v1/addressesCreate Address