Order

Buat Order

Membuat order pengiriman dari sebuah quote_id. Ongkir dipotong dari saldo saat order dibuat.

POST /courier/v1/orders

Body

Parameter	Tipe	Wajib	Keterangan
quote_id	string	ya	Dari respons Cek Ongkir.
courier_code	string	ya	Kode kurir yang dipilih dari daftar tarif.
service_code	string	ya	Kode layanan yang dipilih dari daftar tarif.
recipient_name	string	ya	Nama penerima (3–30 karakter).
recipient_phone	string	ya	Telepon penerima (maks 20 karakter).
recipient_address	string	ya	Alamat penerima (maks 500 karakter).
product_name	string	ya	Nama produk (maks 100 karakter).
product_price	integer	ya	Harga produk (min 1).
quantity	integer	tidak	Jumlah item (default 1).
insurance	boolean	tidak	Sertakan asuransi.
note	string	tidak	Catatan untuk kurir.
picked_up_time	string	ya	Waktu penjemputan (ISO 8601).

Contoh Request

cURL

curl -X POST 'https://use.api.co.id/courier/v1/orders' \
  -H 'x-api-co-id: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "quote_id": "qt_9f2a7c1b8e3d4a5f",
    "courier_code": "ninja",
    "service_code": "STANDARD",
    "recipient_name": "Siti Rahma",
    "recipient_phone": "08120000000",
    "recipient_address": "Jl. Merdeka No. 45, Jakarta Pusat",
    "product_name": "Kaos Katun",
    "product_price": 90000,
    "quantity": 1,
    "insurance": false,
    "note": "Titip ke satpam",
    "picked_up_time": "2026-08-08T09:00:00+07:00"
}'

JavaScript

const res = await fetch('https://use.api.co.id/courier/v1/orders', {
  method: 'POST',
  headers: {
    'x-api-co-id': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "quote_id": "qt_9f2a7c1b8e3d4a5f",
    "courier_code": "ninja",
    "service_code": "STANDARD",
    "recipient_name": "Siti Rahma",
    "recipient_phone": "08120000000",
    "recipient_address": "Jl. Merdeka No. 45, Jakarta Pusat",
    "product_name": "Kaos Katun",
    "product_price": 90000,
    "quantity": 1,
    "insurance": false,
    "note": "Titip ke satpam",
    "picked_up_time": "2026-08-08T09:00:00+07:00"
}),
});
const data = await res.json();

Python

import requests

res = requests.post(
    "https://use.api.co.id/courier/v1/orders",
    json={"quote_id":"qt_9f2a7c1b8e3d4a5f","courier_code":"ninja","service_code":"STANDARD","recipient_name":"Siti Rahma","recipient_phone":"08120000000","recipient_address":"Jl. Merdeka No. 45, Jakarta Pusat","product_name":"Kaos Katun","product_price":90000,"quantity":1,"insurance":false,"note":"Titip ke satpam","picked_up_time":"2026-08-08T09:00:00+07:00"},
    headers={"x-api-co-id": "YOUR_API_KEY"},
)
data = res.json()

Contoh Response

{
  "is_success": true,
  "message": "Order berhasil dibuat.",
  "data": {
    "id": "ord_3a9f",
    "resi": "TRK00012345",
    "no_order": "INV-20260808-0001",
    "status": "processing",
    "courier_code": "ninja",
    "courier_service": "Standard",
    "shipping_price": 12000,
    "handling_fee": 2000,
    "insurance_cost": 0,
    "charged_amount": 14000,
    "is_cod": false,
    "cod_amount": 0,
    "weight_gram": 1000,
    "recipient_name": "Siti Rahma",
    "recipient_phone": "08120000000",
    "product_name": "Kaos Katun",
    "created_at": "2026-08-07T14:03:00+07:00",
    "completed_at": null
  }
}

info

COD segera hadir. Kirim order sebagai non-COD; field COD (is_cod, cod_amount) selalu bernilai nol untuk saat ini.

Daftar Order

Daftar order dengan paginasi.

GET /courier/v1/orders

Query Parameter

Parameter	Tipe	Wajib	Keterangan
page	integer	tidak	Halaman (default 1).
per_page	integer	tidak	Item per halaman.

Contoh Request

cURL

curl -X GET 'https://use.api.co.id/courier/v1/orders?page=1&per_page=20' \
  -H 'x-api-co-id: YOUR_API_KEY'

JavaScript

const res = await fetch('https://use.api.co.id/courier/v1/orders?page=1&per_page=20', {
  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/orders",
    params={"page":"1","per_page":"20"},
    headers={"x-api-co-id": "YOUR_API_KEY"},
)
data = res.json()

Contoh Response

{
  "is_success": true,
  "message": "OK",
  "data": [
    { "id": "ord_3a9f", "resi": "TRK00012345", "no_order": "INV-20260808-0001", "status": "processing", "charged_amount": 14000 }
  ],
  "paging": { "page": 1, "per_page": 20, "total": 1 }
}

Detail Order

Detail satu order berdasarkan ID.

GET /courier/v1/orders/{id}

Contoh Request

cURL

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

JavaScript

const res = await fetch('https://use.api.co.id/courier/v1/orders/{id}', {
  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/orders/{id}",
    headers={"x-api-co-id": "YOUR_API_KEY"},
)
data = res.json()

Contoh Response

{
  "is_success": true,
  "message": "OK",
  "data": {
    "id": "ord_3a9f",
    "resi": "TRK00012345",
    "no_order": "INV-20260808-0001",
    "status": "processing",
    "courier_code": "ninja",
    "courier_service": "Standard",
    "shipping_price": 12000,
    "handling_fee": 2000,
    "insurance_cost": 0,
    "charged_amount": 14000,
    "is_cod": false,
    "cod_amount": 0,
    "weight_gram": 1000,
    "recipient_name": "Siti Rahma",
    "recipient_phone": "08120000000",
    "product_name": "Kaos Katun",
    "created_at": "2026-08-07T14:03:00+07:00",
    "completed_at": null
  }
}

Batalkan Order

Membatalkan order yang belum dijemput. Ongkir dikembalikan ke saldo bila memenuhi syarat.

POST /courier/v1/orders/{id}/cancel

Contoh Request

cURL

curl -X POST 'https://use.api.co.id/courier/v1/orders/{id}/cancel' \
  -H 'x-api-co-id: YOUR_API_KEY'

JavaScript

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

Python

import requests

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

Contoh Response

{
  "is_success": true,
  "message": "Order berhasil dibatalkan.",
  "data": { "id": "ord_3a9f", "status": "cancelled" }
}

peringatan

Order yang sudah dijemput kurir tidak dapat dibatalkan lewat API. Pastikan ID benar sebelum memanggil endpoint ini.

Coba langsung

tip

Pakai Test Key sandbox untuk mencoba endpoint ini tanpa membuat pengiriman atau biaya sungguhan. Lihat Sandbox.

• GET/courier/v1/ordersList Orders
• POST/courier/v1/ordersCreate Order
• GET/courier/v1/orders/{id}Order Detail
• POST/courier/v1/orders/{id}/cancelCancel Order