Drivenbox Shipping API

Documentación / Idempotencia

Idempotencia

Cómo evitar guías duplicadas. Léalo antes de crear en producción.

Lea esto antes de crear en producción. El courier upstream no es idempotente y cada creación exitosa genera una guía real y cobrable. Un reintento ciego tras un corte de red puede generar un segundo envío que su cliente paga.

La clave representa el intento lógico

No la petición HTTP. Esa distinción es toda la mecánica:

Idempotency-Key: drivenbox-order:1234:shipment:1

La plataforma no interpreta el formato: aplica idempotencia por workspace y endpoint. El formato es una convención suya.

Qué puede recibir

RespuestaSignificadoQué hacer
201Guía creadaGuarde el tracking.
200 + Idempotent-ReplayedReintento de una creación previaTrátelo igual que un 201. No cree otra.
202EncoladaConsulte /v1/operations/{id}.
409 idempotency_conflictMisma clave, cuerpo distintoBug suyo. Registre y alerte.
409 operation_in_progressResultado sin confirmarNo reintente. Ver abajo.

Resultado sin confirmar

{
  "error": {
    "code": "operation_in_progress",
    "details": { "reason": "unknown_outcome", "operation_id": "op_..." }
  }
}

La solicitud salió hacia el courier y puede haber creado una guía real, pero la respuesta se perdió. La clave queda reclamada de forma permanente, así que un reintento con la misma clave recibe este mismo error en lugar de crear una segunda guía.

Consulte la operación hasta que se resuelva:

Verificado: cincuenta peticiones simultáneas con la misma clave producen exactamente una guía.