Drivenbox Shipping API

Documentación / Inicio rápido

Inicio rápido

De cero a su primera guía simulada.

Todo este recorrido usa una credencial dbs_test_, que siempre opera contra el courier simulado. No puede generar una guía real ni un cargo.

1. Cree un workspace

Uno por e-commerce. Es idempotente por external_reference.

curl -X POST $API/v1/workspaces \
  -H "Authorization: Bearer $KEY" -H "Content-Type: application/json" \
  -d '{"name":"Tienda demo","external_reference":"store_123"}'

2. Conecte una cuenta de courier

curl -X POST $API/v1/courier-connections \
  -H "Authorization: Bearer $KEY" -H "Content-Type: application/json" \
  -d '{"workspace_id":"ws_...","provider_code":"mock",
       "display_name":"Cuenta de pruebas",
       "credentials":{"username":"demo@example.com","password":"demo"}}'

3. Busque agencias

curl "$API/v1/agencies?courier_connection_id=ccn_...&search=lima" \
  -H "Authorization: Bearer $KEY"

4. Cree la guía

Con Idempotency-Key desde el primer día: es el hábito que evita duplicados cuando llegue a producción.

curl -X POST $API/v1/shipments \
  -H "Authorization: Bearer $KEY" \
  -H "Idempotency-Key: mi-pedido-1234-intento-1" \
  -H "Content-Type: application/json" \
  -d @envio.json

5. Rastree y descargue el rótulo

curl "$API/v1/shipments/shp_.../tracking" -H "Authorization: Bearer $KEY"
curl "$API/v1/shipments/shp_.../documents/label" -H "Authorization: Bearer $KEY" -o rotulo.pdf

6. Ensaye el caso difícil

Antes de pasar a producción, ejecute el escenario de respuesta perdida. Es el que rompe integraciones. Cómo invocarlo.