Conector de Redes
OpenAPIAPI v0.1.0
Explorar documentación

Operar · Modificaciones

Pregunta primero; modifica sólo lo que la red admite.

La política se calcula para cada envío, conexión, ambiente y estado. No asumas que dos transportistas permiten los mismos cambios.

GET/v1/shipments/{shipment_id}/modification-policy
shipments:read

Consulta la política actual

Haz esta consulta inmediatamente antes de mostrar o enviar un cambio. Revisa available, editable_fields, los estados admitidos y reason_code. La política puede cambiar cuando avanza el envío.

Consultar política
curl --request GET \
  --url "$API_BASE_URL/v1/shipments/$SHIPMENT_ID/modification-policy" \
  --header "Authorization: Bearer $SENDINGBAY_API_TOKEN"
Respuesta de ejemplo
{
  "shipment_id": "94fd60e9-3b61-4d2e-bf14-bebd25e3aab1",
  "available": true,
  "current_status": "created",
  "editable_fields": ["external_reference", "package_weights_kg"],
  "allowed_statuses": ["accepted", "created"],
  "reason_code": null,
  "conditions": ["No se puede cambiar la cantidad de bultos; solo su peso."]
}

Cuando no esté disponible, reason_code será uno de: capability_not_enabled, carrier_not_implemented, shipment_snapshot_unavailable, status_not_editable o no_editable_fields.

POST/v1/shipments/{shipment_id}/modifications
shipments:write

Aplica una modificación idempotente

Puedes enviar el destinatario completo, un peso por cada bulto existente o una nueva referencia externa, siempre que aparezcan eneditable_fields. No se permite agregar ni quitar bultos.

Modificar referencia y pesos
curl --request POST \
  --url "$API_BASE_URL/v1/shipments/$SHIPMENT_ID/modifications" \
  --header "Authorization: Bearer $SENDINGBAY_API_TOKEN" \
  --header "Content-Type: application/json" \
  --header "Idempotency-Key: correccion-pedido-1000-v1" \
  --data '{
    "external_reference": "ORDER-1000-CORRECTED",
    "package_weights_kg": [1.5]
  }'

Evidencia disponible por red

RedRestricción conocida
CorreosSoporte confirmado por proveedor; campos y ventana dependen del producto y estado.
SendingSoporte confirmado; alcance sujeto a la cuenta contratada.
GLSSoporte parcial: solo se confirmó una modificación limitada de peso.
OntimeEvidencia histórica parcial; requiere recertificación.

Consulta también el catálogo vivo. Que el proveedor documente una operación no significa que el adaptador del Conector esté habilitado.

Siguiente lectura

Recupera cada rechazo por su código estable.

Ir a errores →