Conector de Redes
OpenAPIAPI v0.1.0
Explorar documentación

Operar · Recuperación

Errores estables para tomar decisiones seguras.

Las respuestas conocidas usan Problem Details. Tu integración debe decidir por code, no por el texto descriptivo ni por un mensaje del transportista.

Formato de respuesta

El contenido usa application/problem+json y contienetype, title, status,detail, code ycorrelation_id. Los fallos de esquema añadenerrors con la ubicación de cada campo.

Error de validación
HTTP/1.1 422 Unprocessable Entity
Content-Type: application/problem+json
X-Correlation-ID: a751b655-d2a5-418d-9131-e18bf7693ee5

{
  "type": "https://docs.sendingbay.com/problems/validation_error",
  "title": "Petición no válida",
  "status": 422,
  "detail": "Uno o más campos no cumplen el contrato",
  "code": "validation_error",
  "correlation_id": "a751b655-d2a5-418d-9131-e18bf7693ee5",
  "errors": [{
    "location": ["body", "packages"],
    "message": "List should have at least 1 item after validation, not 0",
    "error_type": "too_short"
  }]
}

Estrategia de recuperación

401/403/404/422

Corrige o autoriza

Revisa credenciales, permisos o contenido. Si cambia la intención de envío, genera una clave de idempotencia nueva.

409/429/503

Espera y reintenta

Sólo cuando la acción indicada lo permita. Respeta Retry-After, aplica backoff y conserva la misma clave.

carrier_operation_uncertain

Detén y concilia

No repitas el alta. Conserva la evidencia y solicita conciliación a SendingBay.

Catálogo para clientes

Estos códigos forman el contrato funcional actual. El texto dedetail puede aportar contexto, pero no debe controlar la lógica de tu aplicación.

CódigoHTTPAcción recomendada
authentication_required401Envía una credencial Bearer.
invalid_credential401Renueva o revisa la credencial del ambiente.
insufficient_scope403Solicita el scope requerido.
carrier_connection_not_found404Verifica una conexión habilitada para tu cliente.
shipment_not_found404Verifica el id; no permite inferir envíos de otro cliente.
article_mapping_not_found422Consulta los artículos de la conexión.
carrier_service_not_contracted422La constancia contractual vigente excluye ese servicio; consulta con SendingBay o la red.
origin_mapping_not_found422Quita origin_code o consulta los orígenes habilitados.
shipment_option_not_available422Quita la opción o revisa artículo y conexión.
shipment_restriction_violation422Ajusta destino, bultos, medidas o datos obligatorios.
shipment_modification_unavailable422Consulta de nuevo la política y limita el cambio a los campos admitidos.
incident_reporting_unavailable422Consulta la política y usa una categoría admitida para ese envío.
reverse_logistics_operation_not_found404Verifica el resultado dentro de tu cliente y no repitas con otra clave.
reverse_logistics_unavailable422Consulta la política: la conexión, red o instantánea no admite la devolución.
validation_error422Corrige los campos enumerados en errors.
invalid_tracking_cursor422Reinicia sin cursor o usa el de la página anterior.
carrier_request_rejected422Corrige la petición según el detalle sanitizado.
carrier_capability_unavailable422La capacidad no está habilitada para esa conexión y ambiente.
carrier_location_request_rejected422Corrige los filtros según la restricción publicada para la red.
pudo_point_unavailable422Vuelve a buscar y pide al usuario que seleccione otro punto.
idempotency_conflict409Recupera la petición original o usa una clave nueva para otra intención.
idempotency_in_progress409Espera Retry-After y consulta antes de repetir.
rate_limit_exceeded429Espera Retry-After sin cambiar la clave.
carrier_adapter_not_found503Reintenta según el estado comunicado por soporte.
carrier_credentials_unavailable503Conserva la clave y usa backoff si soporte confirma disponibilidad.
carrier_location_service_unavailable503Aplica backoff y conserva correlation_id si persiste.
carrier_operation_uncertain503No reintentes; conserva correlation_id y, si existe, X-Reconciliation-ID.
service_unavailable503Aplica backoff e informa correlation_id si persiste.
internal_error500Informa correlation_id a soporte.

Qué enviar a soporte

  • X-Correlation-ID y, si existe,X-Reconciliation-ID.
  • Fecha y hora UTC, ambiente y endpoint utilizado.
  • Código estable y estado HTTP recibido.
  • Tu referencia externa, sin credenciales ni datos personales.
Volver al recorrido

Revisa el contrato de creación y consulta.

Ir a envíos →