Sandbox

Sandbox (Test Mode)

Sandbox membiarkan Anda mengintegrasikan Courier API tanpa risiko: pakai Test Key Anda, endpoint & base URL sama persis dengan live, tapi semua panggilan kurir dijalankan ke mock dan saldo memakai dompet palsu. Tidak ada pengiriman sungguhan, tidak ada biaya sungguhan.

Cara pakai

1. Ambil Test Key di dashboard (kartu "Sandbox (Test) Key").
2. Kirim key itu di header x-api-co-id — persis seperti live.
3. Jalankan alur normal: buat alamat → cek ongkir → order. Semuanya ter-isolasi dari data live.

Yang berbeda di sandbox

• Cek ongkir gratis — tidak ada biaya Rp 5.
• Dompet seed — saldo sandbox mulai dari sekitar Rp 1.000.000 dan berkurang tiap order; endpoint mengembalikan 402 bila saldo habis.
• Auto-advance — order sandbox otomatis maju waiting → shipping → delivered dalam beberapa detik, jadi Anda melihat urutan webhook penuh tanpa melakukan apa-apa.
• Trigger manual — paksa event apa pun (problem/returned/failed/cancelled) lewat endpoint trigger.
• Webhook ditandai — setiap payload webhook sandbox membawa "sandbox": true (mirip livemode:false Stripe) supaya handler Anda bisa membedakan.
• Data referensi sama — daftar kurir & lokasi dipakai bersama (bukan data khusus sandbox).

info

Test Key dan Live Key benar-benar terpisah: mustahil membuat order sungguhan dengan Test Key, dan data sandbox tidak pernah muncul di daftar order live Anda.

Sandbox: Trigger Event

Hanya mode sandbox. Paksa satu event siklus pada order sandbox agar webhook yang sesuai terkirim — untuk menguji handler Anda tanpa menunggu.

POST /courier/v1/sandbox/orders/{id}/trigger

Body

Parameter	Tipe	Wajib	Keterangan
event	string	ya	Salah satu: shipping, delivered, problem, returned, cancelled, failed.

Contoh Request

cURL

curl -X POST 'https://use.api.co.id/courier/v1/sandbox/orders/{id}/trigger' \
  -H 'x-api-co-id: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "event": "delivered"
}'

JavaScript

const res = await fetch('https://use.api.co.id/courier/v1/sandbox/orders/{id}/trigger', {
  method: 'POST',
  headers: {
    'x-api-co-id': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "event": "delivered"
}),
});
const data = await res.json();

Python

import requests

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

Contoh Response

{
  "is_success": true,
  "message": "OK",
  "data": { "id": "ord_3a9f", "status": "completed", "event": "delivered" }
}

• Hanya berlaku untuk order is_sandbox; order live → 404.
• Order yang sudah berstatus akhir (delivered/cancelled/returned) tidak dapat diubah lagi.

Coba langsung

tip

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

• POST/courier/v1/sandbox/orders/{id}/triggerSandbox: Trigger Event