Operar · Incidencias
Consulta la política antes de reportar.
Cada red admite categorías, estados y condiciones distintas. El contrato las hace explícitas para evitar promesas ambiguas.
GET
shipments:read/v1/shipments/{shipment_id}/incident-policyDescubre categorías y estados admitidos
Revisa available, categories,allowed_statuses, conditions yreason_code justo antes de mostrar la acción.
curl --request GET \
--url "$API_BASE_URL/v1/shipments/$SHIPMENT_ID/incident-policy" \
--header "Authorization: Bearer $SENDINGBAY_API_TOKEN"POST
shipments:write/v1/shipments/{shipment_id}/incidentsEnvía un reporte idempotente
Usa una categoría publicada y una descripción breve. No incluyas credenciales, documentación completa ni datos personales que no sean imprescindibles para resolver el caso.
curl --request POST \
--url "$API_BASE_URL/v1/shipments/$SHIPMENT_ID/incidents" \
--header "Authorization: Bearer $SENDINGBAY_API_TOKEN" \
--header "Content-Type: application/json" \
--header "Idempotency-Key: incidencia-order-1000-v1" \
--data '{
"category": "damage",
"description": "Embalaje dañado durante el transporte",
"customer_reference": "INC-1000"
}'GET
shipments:read/v1/shipments/{shipment_id}/incidentsConsulta sin recuperar el texto
El listado paginado y el detalle/incidents/{incident_id} contienen identificadores, categoría, estado, referencias y fechas. La descripción no se incluye en respuestas, consola interna, auditoría ni webhooks.
curl --request GET \
--url "$API_BASE_URL/v1/shipments/$SHIPMENT_ID/incidents?limit=100" \
--header "Authorization: Bearer $SENDINGBAY_API_TOKEN"| Estado | Significado |
|---|---|
submitted | El proveedor aceptó el reporte, sin confirmar su tramitación. |
processing | La red confirmó que el caso está en gestión. |
resolved | La red confirmó la resolución. |
rejected | La red rechazó o no admite el caso. |
unknown | No puede determinarse el estado externo con seguridad. |